@aigne/afs-wecom 1.11.0-beta.12

package/dist/index.cjs

@@ -0,0 +1,286 @@
+const require_client = require('./client.cjs');
+const require_decorate = require('./_virtual/_@oxc-project_runtime@0.108.0/helpers/decorate.cjs');
+let _aigne_afs_provider = require("@aigne/afs/provider");
+let _aigne_afs_messaging = require("@aigne/afs-messaging");
+
+//#region src/index.ts
+var AFSWeCom = class extends _aigne_afs_messaging.BaseMessageProvider {
+	static manifest() {
+		return {
+			name: "wecom",
+			description: "WeChat Work (企业微信) messaging — webhook or bot API with auto token refresh.\n- Webhook mode for simple group notifications\n- Bot mode with corp credentials for bidirectional messaging\n- Path: /:bot/conversations/:convId/messages/:msgId",
+			uriTemplate: "wecom://{corpId}",
+			category: "messaging",
+			schema: {
+				type: "object",
+				properties: {
+					corpId: {
+						type: "string",
+						description: "WeChat Work Corp ID"
+					},
+					corpSecret: {
+						type: "string",
+						description: "WeChat Work Corp Secret",
+						sensitive: true
+					},
+					agentId: {
+						type: "string",
+						description: "Agent ID for bot mode"
+					},
+					webhook: {
+						type: "string",
+						description: "Webhook key for outbound-only mode",
+						sensitive: true
+					}
+				}
+			},
+			tags: [
+				"wecom",
+				"wechat-work",
+				"messaging",
+				"chat",
+				"enterprise"
+			],
+			capabilityTags: [
+				"read-write",
+				"crud",
+				"search",
+				"auth:token",
+				"remote",
+				"http",
+				"real-time",
+				"rate-limited"
+			],
+			security: {
+				riskLevel: "external",
+				resourceAccess: ["internet"],
+				notes: ["Connects to WeChat Work API — requires corp credentials or webhook key"]
+			},
+			capabilities: { network: {
+				egress: true,
+				allowedDomains: ["qyapi.weixin.qq.com"]
+			} }
+		};
+	}
+	static treeSchema() {
+		return {
+			operations: [
+				"list",
+				"read",
+				"exec",
+				"stat",
+				"explain"
+			],
+			tree: {
+				"/": {
+					kind: "messaging:root",
+					operations: ["list", "exec"],
+					actions: [
+						"add-bot",
+						"remove-bot",
+						"process-event"
+					]
+				},
+				"/{bot}": {
+					kind: "messaging:bot",
+					operations: ["list", "read"]
+				},
+				"/{bot}/ctl": {
+					kind: "messaging:status",
+					operations: ["read"]
+				},
+				"/{bot}/conversations": {
+					kind: "messaging:conversations",
+					operations: ["list"]
+				},
+				"/{bot}/conversations/{convId}": {
+					kind: "messaging:conversation",
+					operations: ["list"]
+				},
+				"/{bot}/conversations/{convId}/messages": {
+					kind: "messaging:messages",
+					operations: ["list", "exec"],
+					actions: ["send"]
+				},
+				"/{bot}/conversations/{convId}/messages/{msgId}": {
+					kind: "messaging:message",
+					operations: ["read"]
+				}
+			},
+			auth: {
+				type: "custom",
+				env: ["WECOM_CORP_ID", "WECOM_CORP_SECRET"]
+			},
+			bestFor: [
+				"enterprise messaging",
+				"workflow alerts",
+				"team notifications"
+			],
+			notFor: ["file storage", "database queries"]
+		};
+	}
+	providerName = "wecom";
+	eventPrefix = "wecom";
+	constructor(options) {
+		let bots;
+		if (options.bots) bots = options.bots;
+		else {
+			if (!options.webhook && !options.corpId) throw new Error("AFSWeCom requires either webhook or corpId");
+			bots = [{
+				name: "default",
+				webhook: options.webhook,
+				corpId: options.corpId,
+				corpSecret: options.corpSecret,
+				agentId: options.agentId,
+				conversations: options.conversations ?? [],
+				apiBase: options.apiBase
+			}];
+		}
+		super({
+			bots,
+			bufferSize: options.bufferSize
+		});
+	}
+	getMessageCapabilities() {
+		return {
+			formats: {
+				send: ["text"],
+				receive: ["text"]
+			},
+			maxMessageLength: 2048,
+			features: {
+				edit: false,
+				delete: false,
+				reply: false,
+				thread: false,
+				reaction: false,
+				inlineKeyboard: false
+			},
+			limits: { messagesPerSecond: 5 }
+		};
+	}
+	createBotClient(config) {
+		const webhook = config.webhook;
+		const corpId = config.corpId;
+		const corpSecret = config.corpSecret;
+		const agentId = config.agentId;
+		const apiBase = config.apiBase;
+		if (corpId && corpSecret && agentId) return require_client.WeComClient.bot({
+			corpId,
+			corpSecret,
+			agentId,
+			apiBase
+		});
+		if (webhook) return require_client.WeComClient.webhook(webhook, { apiBase });
+		throw new Error(`WeCom bot "${config.name}" requires webhook or corpId+corpSecret+agentId`);
+	}
+	async sendMessage(client, convId, text, _opts) {
+		const wc = client;
+		if (wc.mode === "bot") return { messageId: (await wc.sendMessage(convId, text)).msgId };
+		await wc.sendWebhook(text);
+		return { messageId: String(Date.now()) };
+	}
+	async sendTypingIndicator(_client, _convId) {}
+	normalizeMessage(raw) {
+		const msg = raw;
+		return {
+			id: String(msg.MsgId ?? msg.msgId ?? "0"),
+			text: String(msg.Content ?? msg.content ?? ""),
+			from: this.normalizeSender({ id: msg.FromUserName ?? msg.fromUser }),
+			timestamp: Number(msg.CreateTime ?? msg.createTime ?? Math.floor(Date.now() / 1e3)),
+			conversationId: String(msg.conversationId ?? ""),
+			platform: { agentId: msg.AgentID ?? msg.agentId }
+		};
+	}
+	normalizeSender(raw) {
+		return {
+			id: String(raw.id ?? "0"),
+			name: String(raw.name ?? raw.id ?? ""),
+			isBot: raw.isBot
+		};
+	}
+	async listRootActions(_ctx) {
+		return { data: [
+			this.buildEntry("/.actions/add-bot", { meta: { description: "Add a bot instance at runtime" } }),
+			this.buildEntry("/.actions/remove-bot", { meta: { description: "Remove a bot instance" } }),
+			this.buildEntry("/.actions/process-event", { meta: { description: "Process an incoming WeCom callback event" } })
+		] };
+	}
+	async execProcessEvent(_ctx, args) {
+		this._processEvent(args);
+		return {
+			success: true,
+			data: { ok: true }
+		};
+	}
+	/** Process a WeCom callback event — delegates to emitMessageReceived(). */
+	_processEvent(payload) {
+		const parsed = require_client.WeComClient.parseEvent(payload);
+		if (!parsed) return;
+		const { text, msgId, fromUser, createTime } = parsed;
+		const botName = payload.botName ?? this._botOrder[0] ?? "default";
+		this.emitMessageReceived(botName, {
+			id: msgId,
+			text,
+			from: {
+				id: fromUser,
+				name: fromUser
+			},
+			timestamp: createTime,
+			conversationId: String(payload.conversationId ?? payload.ChatId ?? payload.chatId ?? ""),
+			platform: { agentId: payload.AgentID ?? payload.agentId }
+		});
+	}
+	/** Add a conversation to a bot. Defaults to first bot. */
+	addConversation(convId, botName) {
+		const name = botName ?? this._botOrder[0];
+		if (!name) return;
+		const convs = this._botConversations.get(name);
+		if (!convs || convs.has(convId)) return;
+		convs.add(convId);
+		const buffers = this._botBuffers.get(name);
+		if (buffers && !buffers.has(convId)) buffers.set(convId, []);
+	}
+	/** Remove a conversation from a bot. */
+	removeConversation(convId, botName) {
+		const name = botName ?? this._botOrder[0];
+		if (!name) return;
+		const convs = this._botConversations.get(name);
+		if (convs) convs.delete(convId);
+		const buffers = this._botBuffers.get(name);
+		if (buffers) buffers.delete(convId);
+	}
+	/** Add a message to the ring buffer directly. Public for testing/conformance. */
+	_addToBuffer(convId, msg) {
+		const botName = this._botOrder[0] ?? "default";
+		const convs = this._botConversations.get(botName);
+		if (convs && !convs.has(convId)) convs.add(convId);
+		let botBuffers = this._botBuffers.get(botName);
+		if (!botBuffers) {
+			botBuffers = /* @__PURE__ */ new Map();
+			this._botBuffers.set(botName, botBuffers);
+		}
+		let buffer = botBuffers.get(convId);
+		if (!buffer) {
+			buffer = [];
+			botBuffers.set(convId, buffer);
+		}
+		buffer.push({
+			id: msg.msgId,
+			text: msg.content,
+			from: {
+				id: msg.fromUser,
+				name: msg.fromUser
+			},
+			timestamp: msg.createTime ?? Math.floor(Date.now() / 1e3),
+			conversationId: convId,
+			platform: {}
+		});
+		while (buffer.length > this._bufferSize) buffer.shift();
+	}
+};
+require_decorate.__decorate([(0, _aigne_afs_provider.Actions)("/")], AFSWeCom.prototype, "listRootActions", null);
+require_decorate.__decorate([_aigne_afs_provider.Actions.Exec("/", "process-event")], AFSWeCom.prototype, "execProcessEvent", null);
+
+//#endregion
+exports.AFSWeCom = AFSWeCom;

package/dist/index.d.cts

@@ -0,0 +1,104 @@
+import { WeComClient, WeComEvent, WeComParsedEvent } from "./client.cjs";
+import { AFSExecResult, AFSListResult, ProviderTreeSchema } from "@aigne/afs";
+import { RouteContext } from "@aigne/afs/provider";
+import { BaseMessageProvider, BotConfig, BufferedMessage, MessageCapabilities, MessageSender, SendOptions } from "@aigne/afs-messaging";
+
+//#region src/index.d.ts
+interface AFSWeComOptions {
+  /** Multi-bot config */
+  bots?: Array<{
+    name: string; /** Webhook key (outbound only) */
+    webhook?: string; /** Corp ID for bot mode */
+    corpId?: string; /** Corp secret for bot mode */
+    corpSecret?: string; /** Agent ID for bot mode */
+    agentId?: number;
+    conversations?: string[];
+    apiBase?: string;
+  }>;
+  /** Single-bot shorthand: webhook key (outbound only) */
+  webhook?: string;
+  /** Single-bot shorthand: corp ID */
+  corpId?: string;
+  /** Single-bot shorthand: corp secret */
+  corpSecret?: string;
+  /** Single-bot shorthand: agent ID */
+  agentId?: number;
+  /** Single-bot shorthand: conversation IDs to monitor */
+  conversations?: string[];
+  apiBase?: string;
+  bufferSize?: number;
+}
+declare class AFSWeCom extends BaseMessageProvider {
+  static manifest(): {
+    name: string;
+    description: string;
+    uriTemplate: string;
+    category: string;
+    schema: {
+      type: string;
+      properties: {
+        corpId: {
+          type: string;
+          description: string;
+        };
+        corpSecret: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+        agentId: {
+          type: string;
+          description: string;
+        };
+        webhook: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+      };
+    };
+    tags: string[];
+    capabilityTags: string[];
+    security: {
+      riskLevel: string;
+      resourceAccess: string[];
+      notes: string[];
+    };
+    capabilities: {
+      network: {
+        egress: boolean;
+        allowedDomains: string[];
+      };
+    };
+  };
+  static treeSchema(): ProviderTreeSchema;
+  readonly providerName = "wecom";
+  readonly eventPrefix = "wecom";
+  constructor(options: AFSWeComOptions);
+  getMessageCapabilities(): MessageCapabilities;
+  createBotClient(config: BotConfig): WeComClient;
+  sendMessage(client: unknown, convId: string, text: string, _opts?: SendOptions): Promise<{
+    messageId: string;
+  }>;
+  sendTypingIndicator(_client: unknown, _convId: string): Promise<void>;
+  normalizeMessage(raw: Record<string, unknown>): BufferedMessage;
+  normalizeSender(raw: Record<string, unknown>): MessageSender;
+  listRootActions(_ctx: RouteContext): Promise<AFSListResult>;
+  execProcessEvent(_ctx: RouteContext, args: Record<string, unknown>): Promise<AFSExecResult>;
+  /** Process a WeCom callback event — delegates to emitMessageReceived(). */
+  _processEvent(payload: any): void;
+  /** Add a conversation to a bot. Defaults to first bot. */
+  addConversation(convId: string, botName?: string): void;
+  /** Remove a conversation from a bot. */
+  removeConversation(convId: string, botName?: string): void;
+  /** Add a message to the ring buffer directly. Public for testing/conformance. */
+  _addToBuffer(convId: string, msg: {
+    msgId: string;
+    content: string;
+    fromUser: string;
+    createTime?: number;
+  }): void;
+}
+//#endregion
+export { AFSWeCom, AFSWeComOptions, type WeComClient, type WeComEvent, type WeComParsedEvent };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;UAoCiB,eAAA;EA6BJ;EA3BX,IAAA,GAAO,KAAA;IACL,IAAA,UAqEmB;IAnEnB,OAAA,WA6HwB;IA3HxB,MAAA,WAgJkC;IA9IlC,UAAA,WAmKC;IAjKD,OAAA;IACA,aAAA;IACA,OAAA;EAAA;EA6L6C;EA1L/C,OAAA;EAqMmD;EAnMnD,MAAA;EAqNQ;EAnNR,UAAA;EAqNW;EAnNX,OAAA;EAO4B;EAL5B,aAAA;EACA,OAAA;EACA,UAAA;AAAA;AAAA,cAGW,QAAA,SAAiB,mBAAA;EAAA,OACrB,QAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA0CA,UAAA,CAAA,GAAc,kBAAA;EAAA,SA6BZ,YAAA;EAAA,SACA,WAAA;cAEG,OAAA,EAAS,eAAA;EA0BrB,sBAAA,CAAA,GAA0B,mBAAA;EAqB1B,eAAA,CAAgB,MAAA,EAAQ,SAAA,GAAY,WAAA;EAgB9B,WAAA,CACJ,MAAA,WACA,MAAA,UACA,IAAA,UACA,KAAA,GAAQ,WAAA,GACP,OAAA;IAAU,SAAA;EAAA;EAaP,mBAAA,CAAoB,OAAA,WAAkB,OAAA,WAAkB,OAAA;EAE9D,gBAAA,CAAiB,GAAA,EAAK,MAAA,oBAA0B,eAAA;EAehD,eAAA,CAAgB,GAAA,EAAK,MAAA,oBAA0B,aAAA;EAWzC,eAAA,CAAgB,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,aAAA;EAiB7C,gBAAA,CACJ,IAAA,EAAM,YAAA,EACN,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA9CW;EAsDtB,aAAA,CAAc,OAAA;EAtDkC;EA0EhD,eAAA,CAAgB,MAAA,UAAgB,OAAA;EA3DX;EAwErB,kBAAA,CAAmB,MAAA,UAAgB,OAAA;EAxEY;EAkF/C,YAAA,CACE,MAAA,UACA,GAAA;IACE,KAAA;IACA,OAAA;IACA,QAAA;IACA,UAAA;EAAA;AAAA"}

package/dist/index.d.mts

@@ -0,0 +1,104 @@
+import { WeComClient, WeComEvent, WeComParsedEvent } from "./client.mjs";
+import { RouteContext } from "@aigne/afs/provider";
+import { BaseMessageProvider, BotConfig, BufferedMessage, MessageCapabilities, MessageSender, SendOptions } from "@aigne/afs-messaging";
+import { AFSExecResult, AFSListResult, ProviderTreeSchema } from "@aigne/afs";
+
+//#region src/index.d.ts
+interface AFSWeComOptions {
+  /** Multi-bot config */
+  bots?: Array<{
+    name: string; /** Webhook key (outbound only) */
+    webhook?: string; /** Corp ID for bot mode */
+    corpId?: string; /** Corp secret for bot mode */
+    corpSecret?: string; /** Agent ID for bot mode */
+    agentId?: number;
+    conversations?: string[];
+    apiBase?: string;
+  }>;
+  /** Single-bot shorthand: webhook key (outbound only) */
+  webhook?: string;
+  /** Single-bot shorthand: corp ID */
+  corpId?: string;
+  /** Single-bot shorthand: corp secret */
+  corpSecret?: string;
+  /** Single-bot shorthand: agent ID */
+  agentId?: number;
+  /** Single-bot shorthand: conversation IDs to monitor */
+  conversations?: string[];
+  apiBase?: string;
+  bufferSize?: number;
+}
+declare class AFSWeCom extends BaseMessageProvider {
+  static manifest(): {
+    name: string;
+    description: string;
+    uriTemplate: string;
+    category: string;
+    schema: {
+      type: string;
+      properties: {
+        corpId: {
+          type: string;
+          description: string;
+        };
+        corpSecret: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+        agentId: {
+          type: string;
+          description: string;
+        };
+        webhook: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+      };
+    };
+    tags: string[];
+    capabilityTags: string[];
+    security: {
+      riskLevel: string;
+      resourceAccess: string[];
+      notes: string[];
+    };
+    capabilities: {
+      network: {
+        egress: boolean;
+        allowedDomains: string[];
+      };
+    };
+  };
+  static treeSchema(): ProviderTreeSchema;
+  readonly providerName = "wecom";
+  readonly eventPrefix = "wecom";
+  constructor(options: AFSWeComOptions);
+  getMessageCapabilities(): MessageCapabilities;
+  createBotClient(config: BotConfig): WeComClient;
+  sendMessage(client: unknown, convId: string, text: string, _opts?: SendOptions): Promise<{
+    messageId: string;
+  }>;
+  sendTypingIndicator(_client: unknown, _convId: string): Promise<void>;
+  normalizeMessage(raw: Record<string, unknown>): BufferedMessage;
+  normalizeSender(raw: Record<string, unknown>): MessageSender;
+  listRootActions(_ctx: RouteContext): Promise<AFSListResult>;
+  execProcessEvent(_ctx: RouteContext, args: Record<string, unknown>): Promise<AFSExecResult>;
+  /** Process a WeCom callback event — delegates to emitMessageReceived(). */
+  _processEvent(payload: any): void;
+  /** Add a conversation to a bot. Defaults to first bot. */
+  addConversation(convId: string, botName?: string): void;
+  /** Remove a conversation from a bot. */
+  removeConversation(convId: string, botName?: string): void;
+  /** Add a message to the ring buffer directly. Public for testing/conformance. */
+  _addToBuffer(convId: string, msg: {
+    msgId: string;
+    content: string;
+    fromUser: string;
+    createTime?: number;
+  }): void;
+}
+//#endregion
+export { AFSWeCom, AFSWeComOptions, type WeComClient, type WeComEvent, type WeComParsedEvent };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;UAoCiB,eAAA;EA6BJ;EA3BX,IAAA,GAAO,KAAA;IACL,IAAA,UAqEmB;IAnEnB,OAAA,WA6HwB;IA3HxB,MAAA,WAgJkC;IA9IlC,UAAA,WAmKC;IAjKD,OAAA;IACA,aAAA;IACA,OAAA;EAAA;EA6L6C;EA1L/C,OAAA;EAqMmD;EAnMnD,MAAA;EAqNQ;EAnNR,UAAA;EAqNW;EAnNX,OAAA;EAO4B;EAL5B,aAAA;EACA,OAAA;EACA,UAAA;AAAA;AAAA,cAGW,QAAA,SAAiB,mBAAA;EAAA,OACrB,QAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA0CA,UAAA,CAAA,GAAc,kBAAA;EAAA,SA6BZ,YAAA;EAAA,SACA,WAAA;cAEG,OAAA,EAAS,eAAA;EA0BrB,sBAAA,CAAA,GAA0B,mBAAA;EAqB1B,eAAA,CAAgB,MAAA,EAAQ,SAAA,GAAY,WAAA;EAgB9B,WAAA,CACJ,MAAA,WACA,MAAA,UACA,IAAA,UACA,KAAA,GAAQ,WAAA,GACP,OAAA;IAAU,SAAA;EAAA;EAaP,mBAAA,CAAoB,OAAA,WAAkB,OAAA,WAAkB,OAAA;EAE9D,gBAAA,CAAiB,GAAA,EAAK,MAAA,oBAA0B,eAAA;EAehD,eAAA,CAAgB,GAAA,EAAK,MAAA,oBAA0B,aAAA;EAWzC,eAAA,CAAgB,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,aAAA;EAiB7C,gBAAA,CACJ,IAAA,EAAM,YAAA,EACN,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA9CW;EAsDtB,aAAA,CAAc,OAAA;EAtDkC;EA0EhD,eAAA,CAAgB,MAAA,UAAgB,OAAA;EA3DX;EAwErB,kBAAA,CAAmB,MAAA,UAAgB,OAAA;EAxEY;EAkF/C,YAAA,CACE,MAAA,UACA,GAAA;IACE,KAAA;IACA,OAAA;IACA,QAAA;IACA,UAAA;EAAA;AAAA"}