@openclaw-china/feishu 0.1.1

package/clawdbot.plugin.json

@@ -0,0 +1,29 @@
+{
+  "id": "feishu",
+  "name": "Feishu",
+  "description": "飞书/Lark 消息渠道插件",
+  "version": "0.1.0",
+  "channels": ["feishu"],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "enabled": { "type": "boolean" },
+      "appId": { "type": "string" },
+      "appSecret": { "type": "string" },
+      "connectionMode": { "type": "string", "enum": ["websocket"] },
+      "dmPolicy": { "type": "string", "enum": ["open", "pairing", "allowlist"] },
+      "groupPolicy": { "type": "string", "enum": ["open", "allowlist", "disabled"] },
+      "requireMention": { "type": "boolean" },
+      "allowFrom": { "type": "array", "items": { "type": "string" } },
+      "groupAllowFrom": { "type": "array", "items": { "type": "string" } },
+      "sendMarkdownAsCard": { "type": "boolean" },
+      "historyLimit": { "type": "integer", "minimum": 0 },
+      "textChunkLimit": { "type": "integer", "minimum": 1 }
+    }
+  },
+  "uiHints": {
+    "appId": { "label": "App ID" },
+    "appSecret": { "label": "App Secret", "sensitive": true }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,474 @@
+var __createBinding = (undefined && undefined.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (undefined && undefined.__exportStar) || function(m, exports$1) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports$1, p)) __createBinding(exports$1, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors.cjs"), exports);
+__exportStar(require("./helpers/parseUtil.cjs"), exports);
+__exportStar(require("./helpers/typeAliases.cjs"), exports);
+__exportStar(require("./helpers/util.cjs"), exports);
+__exportStar(require("./types.cjs"), exports);
+__exportStar(require("./ZodError.cjs"), exports);
+
+/**
+ * 飞书渠道配置 Schema
+ *
+ * 配置字段说明:
+ * - enabled: 是否启用该渠道
+ * - appId: 飞书应用 App ID
+ * - appSecret: 飞书应用 App Secret
+ * - connectionMode: 连接模式（仅支持 websocket）
+ * - dmPolicy: 单聊策略 (open=开放, pairing=配对, allowlist=白名单)
+ * - groupPolicy: 群聊策略 (open=开放, allowlist=白名单, disabled=禁用)
+ * - requireMention: 群聊是否需要 @机器人
+ * - allowFrom: 单聊白名单用户 ID 列表
+ * - groupAllowFrom: 群聊白名单会话 ID 列表
+ * - historyLimit: 历史消息数量限制
+ * - textChunkLimit: 文本分块大小限制
+ */
+declare const FeishuConfigSchema: undefined<{
+    /** 是否启用飞书渠道 */
+    enabled: undefined<undefined<undefined>>;
+    /** 飞书应用 App ID */
+    appId: undefined<undefined>;
+    /** 飞书应用 App Secret */
+    appSecret: undefined<undefined>;
+    /** 连接模式（暂只支持 websocket） */
+    connectionMode: undefined<undefined<undefined<["websocket"]>>>;
+    /** 单聊策略: open=开放, pairing=配对, allowlist=白名单 */
+    dmPolicy: undefined<undefined<undefined<["open", "pairing", "allowlist"]>>>;
+    /** 群聊策略: open=开放, allowlist=白名单, disabled=禁用 */
+    groupPolicy: undefined<undefined<undefined<["open", "allowlist", "disabled"]>>>;
+    /** 群聊是否需要 @机器人才响应 */
+    requireMention: undefined<undefined<undefined>>;
+    /** 单聊白名单: 允许的用户 ID 列表 */
+    allowFrom: undefined<undefined<undefined, "many">>;
+    /** 群聊白名单: 允许的会话 ID 列表 */
+    groupAllowFrom: undefined<undefined<undefined, "many">>;
+    /** 是否将 Markdown 文本以卡片形式发送 */
+    sendMarkdownAsCard: undefined<undefined<undefined>>;
+    /** 历史消息数量限制 */
+    historyLimit: undefined<undefined<undefined>>;
+    /** 文本分块大小限制 (飞书文本消息最大 4000 字符) */
+    textChunkLimit: undefined<undefined<undefined>>;
+}, "strip", undefined, {
+    enabled: boolean;
+    connectionMode: "websocket";
+    dmPolicy: "open" | "pairing" | "allowlist";
+    groupPolicy: "open" | "allowlist" | "disabled";
+    requireMention: boolean;
+    sendMarkdownAsCard: boolean;
+    historyLimit: number;
+    textChunkLimit: number;
+    appId?: string | undefined;
+    appSecret?: string | undefined;
+    allowFrom?: string[] | undefined;
+    groupAllowFrom?: string[] | undefined;
+}, {
+    enabled?: boolean | undefined;
+    appId?: string | undefined;
+    appSecret?: string | undefined;
+    connectionMode?: "websocket" | undefined;
+    dmPolicy?: "open" | "pairing" | "allowlist" | undefined;
+    groupPolicy?: "open" | "allowlist" | "disabled" | undefined;
+    requireMention?: boolean | undefined;
+    allowFrom?: string[] | undefined;
+    groupAllowFrom?: string[] | undefined;
+    sendMarkdownAsCard?: boolean | undefined;
+    historyLimit?: number | undefined;
+    textChunkLimit?: number | undefined;
+}>;
+type FeishuConfig = undefined<typeof FeishuConfigSchema>;
+
+/**
+ * 发送消息结果
+ */
+interface FeishuSendResult {
+    /** 消息 ID */
+    messageId: string;
+    /** 会话 ID */
+    chatId: string;
+}
+/**
+ * 解析后的飞书账户配置
+ * 用于 ChannelPlugin config 适配器
+ */
+interface ResolvedFeishuAccount {
+    /** 账户 ID */
+    accountId: string;
+    /** 是否启用 */
+    enabled: boolean;
+    /** 是否已配置（有凭证） */
+    configured: boolean;
+    /** 应用 ID */
+    appId?: string;
+}
+
+/**
+ * 飞书出站适配器
+ */
+
+interface OutboundConfig {
+    channels?: {
+        feishu?: FeishuConfig;
+    };
+}
+interface SendResult {
+    channel: string;
+    messageId: string;
+    chatId?: string;
+    conversationId?: string;
+}
+
+/** 默认账户 ID */
+declare const DEFAULT_ACCOUNT_ID = "default";
+interface PluginConfig {
+    channels?: {
+        feishu?: FeishuConfig;
+    };
+}
+declare const feishuPlugin: {
+    id: string;
+    meta: {
+        id: "feishu";
+        label: "Feishu";
+        selectionLabel: "Feishu/Lark (飞书)";
+        docsPath: "/channels/feishu";
+        docsLabel: "feishu";
+        blurb: "飞书/Lark 企业消息";
+        aliases: readonly ["lark"];
+        order: 70;
+    };
+    capabilities: {
+        chatTypes: readonly ["direct", "channel"];
+        media: boolean;
+        reactions: boolean;
+        threads: boolean;
+        edit: boolean;
+        reply: boolean;
+        polls: boolean;
+    };
+    configSchema: {
+        schema: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                enabled: {
+                    type: string;
+                };
+                appId: {
+                    type: string;
+                };
+                appSecret: {
+                    type: string;
+                };
+                connectionMode: {
+                    type: string;
+                    enum: string[];
+                };
+                dmPolicy: {
+                    type: string;
+                    enum: string[];
+                };
+                groupPolicy: {
+                    type: string;
+                    enum: string[];
+                };
+                requireMention: {
+                    type: string;
+                };
+                allowFrom: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                groupAllowFrom: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                sendMarkdownAsCard: {
+                    type: string;
+                };
+                historyLimit: {
+                    type: string;
+                    minimum: number;
+                };
+                textChunkLimit: {
+                    type: string;
+                    minimum: number;
+                };
+            };
+        };
+    };
+    reload: {
+        configPrefixes: string[];
+    };
+    config: {
+        listAccountIds: (_cfg: PluginConfig) => string[];
+        resolveAccount: (cfg: PluginConfig, accountId?: string) => ResolvedFeishuAccount;
+        defaultAccountId: () => string;
+        setAccountEnabled: (params: {
+            cfg: PluginConfig;
+            enabled: boolean;
+        }) => PluginConfig;
+        deleteAccount: (params: {
+            cfg: PluginConfig;
+        }) => PluginConfig;
+        isConfigured: (_account: ResolvedFeishuAccount, cfg: PluginConfig) => boolean;
+        describeAccount: (account: ResolvedFeishuAccount) => {
+            accountId: string;
+            enabled: boolean;
+            configured: boolean;
+        };
+        resolveAllowFrom: (params: {
+            cfg: PluginConfig;
+        }) => string[];
+        formatAllowFrom: (params: {
+            allowFrom: (string | number)[];
+        }) => string[];
+    };
+    security: {
+        collectWarnings: (params: {
+            cfg: PluginConfig;
+        }) => string[];
+    };
+    setup: {
+        resolveAccountId: () => string;
+        applyAccountConfig: (params: {
+            cfg: PluginConfig;
+        }) => PluginConfig;
+    };
+    outbound: {
+        deliveryMode: "direct";
+        textChunkLimit: number;
+        chunkerMode: "markdown";
+        chunker: (text: string, limit: number) => string[];
+        sendText: (params: {
+            cfg: OutboundConfig;
+            to: string;
+            text: string;
+        }) => Promise<SendResult>;
+    };
+    gateway: {
+        startAccount: (ctx: {
+            cfg: PluginConfig;
+            runtime?: unknown;
+            abortSignal?: AbortSignal;
+            accountId: string;
+            setStatus?: (status: Record<string, unknown>) => void;
+            log?: {
+                info: (msg: string) => void;
+                error: (msg: string) => void;
+            };
+        }) => Promise<void>;
+        stopAccount: (ctx: {
+            accountId: string;
+        }) => Promise<void>;
+        getStatus: () => {
+            connected: boolean;
+        };
+    };
+};
+
+/**
+ * 飞书发送消息
+ */
+
+interface SendMessageParams {
+    cfg: FeishuConfig;
+    to: string;
+    text: string;
+    receiveIdType?: "chat_id" | "open_id";
+}
+declare function sendMessageFeishu(params: SendMessageParams): Promise<FeishuSendResult>;
+
+/**
+ * 飞书插件运行时管理
+ *
+ * 提供对 Moltbot 核心运行时的访问。
+ */
+/**
+ * Moltbot 插件运行时接口
+ */
+interface PluginRuntime {
+    /** 日志函数 */
+    log?: (msg: string) => void;
+    /** 错误日志函数 */
+    error?: (msg: string) => void;
+    /** Moltbot 核心 API */
+    channel?: {
+        routing?: {
+            resolveAgentRoute?: (params: {
+                cfg: unknown;
+                channel: string;
+                peer: {
+                    kind: string;
+                    id: string;
+                };
+            }) => {
+                sessionKey: string;
+                accountId: string;
+                agentId?: string;
+            };
+        };
+        reply?: {
+            dispatchReplyFromConfig?: (params: {
+                ctx: unknown;
+                cfg: unknown;
+                dispatcher?: unknown;
+                replyOptions?: unknown;
+            }) => Promise<{
+                queuedFinal: boolean;
+                counts: {
+                    final: number;
+                };
+            }>;
+            finalizeInboundContext?: (ctx: unknown) => unknown;
+            createReplyDispatcher?: (params: unknown) => unknown;
+            createReplyDispatcherWithTyping?: (params: unknown) => {
+                dispatcher: unknown;
+                replyOptions?: unknown;
+                markDispatchIdle?: () => void;
+            };
+            resolveHumanDelayConfig?: (cfg: unknown, agentId?: string) => unknown;
+        };
+        text?: {
+            resolveTextChunkLimit?: (params: {
+                cfg: unknown;
+                channel: string;
+                defaultLimit?: number;
+            }) => number;
+            resolveChunkMode?: (cfg: unknown, channel: string) => unknown;
+            chunkTextWithMode?: (text: string, limit: number, mode: unknown) => string[];
+            chunkMarkdownText?: (text: string, limit: number) => string[];
+        };
+    };
+    system?: {
+        enqueueSystemEvent?: (message: string, options?: unknown) => void;
+    };
+    [key: string]: unknown;
+}
+/**
+ * 设置飞书插件运行时
+ */
+declare function setFeishuRuntime(next: PluginRuntime): void;
+/**
+ * 获取飞书插件运行时
+ */
+declare function getFeishuRuntime(): PluginRuntime;
+
+/**
+ * @openclaw-china/feishu
+ * 飞书渠道插件入口
+ *
+ * 导出:
+ * - feishuPlugin: ChannelPlugin 实现
+ * - sendMessageFeishu: 发送消息函数
+ * - DEFAULT_ACCOUNT_ID: 默认账户 ID
+ */
+/**
+ * Moltbot 插件 API 接口
+ *
+ * 包含：
+ * - registerChannel: 注册渠道插件
+ * - runtime: 完整的 Moltbot 运行时（包含 core API）
+ */
+interface MoltbotPluginApi {
+    registerChannel: (opts: {
+        plugin: unknown;
+    }) => void;
+    /** Moltbot 运行时，包含 channel.routing、channel.reply 等核心 API */
+    runtime?: unknown;
+    [key: string]: unknown;
+}
+
+/**
+ * 飞书插件定义
+ *
+ * 包含:
+ * - id: 插件标识符
+ * - name: 插件名称
+ * - description: 插件描述
+ * - configSchema: 配置 JSON Schema
+ * - register: 注册函数，调用 api.registerChannel 并设置 runtime
+ */
+declare const plugin: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: {
+        type: string;
+        additionalProperties: boolean;
+        properties: {
+            enabled: {
+                type: string;
+            };
+            appId: {
+                type: string;
+            };
+            appSecret: {
+                type: string;
+            };
+            connectionMode: {
+                type: string;
+                enum: string[];
+            };
+            dmPolicy: {
+                type: string;
+                enum: string[];
+            };
+            groupPolicy: {
+                type: string;
+                enum: string[];
+            };
+            requireMention: {
+                type: string;
+            };
+            allowFrom: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            groupAllowFrom: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            sendMarkdownAsCard: {
+                type: string;
+            };
+            historyLimit: {
+                type: string;
+                minimum: number;
+            };
+            textChunkLimit: {
+                type: string;
+                minimum: number;
+            };
+        };
+    };
+    /**
+     * 注册飞书渠道插件
+     *
+     * 1. 设置完整的 Moltbot 运行时（包含 core API）
+     * 2. 调用 api.registerChannel 将 feishuPlugin 注册到 Moltbot
+     */
+    register(api: MoltbotPluginApi): void;
+};
+
+export { DEFAULT_ACCOUNT_ID, type FeishuConfig, type FeishuSendResult, type MoltbotPluginApi, type ResolvedFeishuAccount, plugin as default, feishuPlugin, getFeishuRuntime, sendMessageFeishu, setFeishuRuntime };