@maincode-ai/channel-base 0.18.3

package/dist/types.d.ts

@@ -0,0 +1,101 @@
+import type { AcpBridge } from './AcpBridge.js';
+import type { ChannelBase, ChannelBaseOptions } from './ChannelBase.js';
+export type SenderPolicy = 'allowlist' | 'pairing' | 'open';
+export type SessionScope = 'user' | 'thread' | 'single';
+export type ChannelType = string;
+export type GroupPolicy = 'disabled' | 'allowlist' | 'open';
+export type DispatchMode = 'collect' | 'steer' | 'followup';
+export interface GroupConfig {
+    requireMention?: boolean;
+    dispatchMode?: DispatchMode;
+}
+export interface BlockStreamingChunkConfig {
+    /** Minimum characters before emitting a block. Default: 400. */
+    minChars?: number;
+    /** Force-emit when buffer exceeds this size. Default: 1000. */
+    maxChars?: number;
+}
+export interface BlockStreamingCoalesceConfig {
+    /** Emit buffered text after this many ms of inactivity. Default: 1500. */
+    idleMs?: number;
+}
+export interface ChannelConfig {
+    type: ChannelType;
+    token: string;
+    clientId?: string;
+    clientSecret?: string;
+    senderPolicy: SenderPolicy;
+    allowedUsers: string[];
+    sessionScope: SessionScope;
+    cwd: string;
+    approvalMode?: string;
+    instructions?: string;
+    model?: string;
+    groupPolicy: GroupPolicy;
+    groups: Record<string, GroupConfig>;
+    /** Dispatch mode for concurrent messages. Default: 'collect'. */
+    dispatchMode?: DispatchMode;
+    /** Enable block streaming — emit completed blocks as separate messages. */
+    blockStreaming?: 'on' | 'off';
+    /** Chunk size bounds for block streaming. */
+    blockStreamingChunk?: BlockStreamingChunkConfig;
+    /** Idle coalescing for block streaming. */
+    blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
+}
+export interface Attachment {
+    /** Content category. */
+    type: 'image' | 'file' | 'audio' | 'video';
+    /** Base64-encoded data (for images or small files). */
+    data?: string;
+    /** Absolute path to a local file (for large files saved to disk). */
+    filePath?: string;
+    /** MIME type (e.g. "image/jpeg", "application/pdf"). */
+    mimeType: string;
+    /** Original file name from the platform. */
+    fileName?: string;
+}
+export interface Envelope {
+    channelName: string;
+    senderId: string;
+    senderName: string;
+    chatId: string;
+    text: string;
+    threadId?: string;
+    /** Platform-specific message ID for response correlation. */
+    messageId?: string;
+    isGroup: boolean;
+    isMentioned: boolean;
+    isReplyToBot: boolean;
+    /** Text of the message being replied to (quoted/referenced message). */
+    referencedText?: string;
+    /** Base64-encoded image data (e.g. from WeChat CDN download). */
+    imageBase64?: string;
+    /** MIME type for the image (e.g. "image/jpeg", "image/png"). */
+    imageMimeType?: string;
+    /** Structured attachments (images, files, audio, video). */
+    attachments?: Attachment[];
+}
+export interface SessionTarget {
+    channelName: string;
+    senderId: string;
+    chatId: string;
+    threadId?: string;
+}
+/**
+ * A channel plugin registers a channel type and provides a factory
+ * to create adapter instances. Both built-in adapters and external
+ * plugins conform to this interface.
+ */
+export interface ChannelPlugin {
+    /** Unique channel type ID (e.g., "telegram", "tmcp-dingtalk"). */
+    channelType: string;
+    /** Human-readable name for CLI output. */
+    displayName: string;
+    /**
+     * Config fields required by this channel type, beyond the shared
+     * ChannelConfig fields. Validated at startup.
+     */
+    requiredConfigFields?: string[];
+    /** Create a channel adapter instance. */
+    createChannel(name: string, config: ChannelConfig & Record<string, unknown>, bridge: AcpBridge, options?: ChannelBaseOptions): ChannelBase;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@maincode-ai/channel-base",
+  "version": "0.18.3",
+  "description": "Base channel infrastructure for Matilda Code",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --build"
+  },
+  "dependencies": {
+    "@agentclientprotocol/sdk": "^0.14.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}