@aigne/afs-dingtalk 1.11.0-beta.12

package/dist/index.cjs

@@ -0,0 +1,298 @@
+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 AFSDingTalk = class extends _aigne_afs_messaging.BaseMessageProvider {
+	static manifest() {
+		return {
+			name: "dingtalk",
+			description: "DingTalk (钉钉) messaging — webhook or bot API with auto token refresh.\n- Webhook mode for simple outbound notifications\n- Bot mode with app credentials for bidirectional messaging\n- Path: /:bot/conversations/:convId/messages/:msgId",
+			uriTemplate: "dingtalk://{appKey}",
+			category: "messaging",
+			schema: {
+				type: "object",
+				properties: {
+					appKey: {
+						type: "string",
+						description: "DingTalk App Key"
+					},
+					appSecret: {
+						type: "string",
+						description: "DingTalk App Secret",
+						sensitive: true
+					},
+					webhook: {
+						type: "string",
+						description: "Webhook access token for outbound-only mode",
+						sensitive: true
+					},
+					conversations: {
+						type: "array",
+						items: { type: "string" },
+						description: "Conversation IDs"
+					}
+				}
+			},
+			tags: [
+				"dingtalk",
+				"messaging",
+				"chat",
+				"enterprise"
+			],
+			capabilityTags: [
+				"read-write",
+				"crud",
+				"search",
+				"auth:token",
+				"remote",
+				"http",
+				"real-time",
+				"rate-limited"
+			],
+			security: {
+				riskLevel: "external",
+				resourceAccess: ["internet"],
+				notes: ["Connects to DingTalk API — requires app credentials or webhook token"]
+			},
+			capabilities: { network: {
+				egress: true,
+				allowedDomains: ["oapi.dingtalk.com", "api.dingtalk.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: ["DINGTALK_APP_KEY", "DINGTALK_APP_SECRET"]
+			},
+			bestFor: [
+				"enterprise messaging",
+				"workflow alerts",
+				"team notifications"
+			],
+			notFor: ["file storage", "database queries"]
+		};
+	}
+	providerName = "dingtalk";
+	eventPrefix = "dingtalk";
+	constructor(options) {
+		let bots;
+		if (options.bots) bots = options.bots;
+		else {
+			if (!options.webhook && !options.appKey) throw new Error("AFSDingTalk requires either webhook or appKey + appSecret");
+			bots = [{
+				name: "default",
+				webhook: options.webhook,
+				appKey: options.appKey,
+				appSecret: options.appSecret,
+				conversations: options.conversations ?? [],
+				legacyApiBase: options.legacyApiBase,
+				newApiBase: options.newApiBase
+			}];
+		}
+		super({
+			bots,
+			bufferSize: options.bufferSize
+		});
+	}
+	getMessageCapabilities() {
+		return {
+			formats: {
+				send: ["text", "markdown"],
+				receive: ["text"]
+			},
+			maxMessageLength: 2e4,
+			features: {
+				edit: false,
+				delete: false,
+				reply: false,
+				thread: false,
+				reaction: false,
+				inlineKeyboard: true
+			},
+			limits: {
+				messagesPerSecond: 20,
+				messagesPerMinute: 600
+			}
+		};
+	}
+	createBotClient(config) {
+		const webhook = config.webhook;
+		const appKey = config.appKey;
+		const appSecret = config.appSecret;
+		const legacyApiBase = config.legacyApiBase;
+		const newApiBase = config.newApiBase;
+		if (appKey && appSecret) return require_client.DingTalkClient.bot({
+			appKey,
+			appSecret,
+			legacyApiBase,
+			newApiBase
+		});
+		if (webhook) return require_client.DingTalkClient.webhook(webhook);
+		throw new Error(`DingTalk bot "${config.name}" requires webhook or appKey + appSecret`);
+	}
+	async sendMessage(client, convId, text, _opts) {
+		const dc = client;
+		if (dc.mode === "bot") {
+			await dc.sendGroupMessage(convId, text);
+			return { messageId: String(Date.now()) };
+		}
+		await dc.sendWebhook(text);
+		return { messageId: String(Date.now()) };
+	}
+	async sendTypingIndicator(_client, _convId) {}
+	normalizeMessage(raw) {
+		const msg = raw;
+		return {
+			id: String(msg.msgId ?? msg.id ?? "0"),
+			text: String(msg.content ?? msg.text?.content ?? ""),
+			from: this.normalizeSender({
+				id: msg.senderStaffId,
+				name: msg.senderNick
+			}),
+			timestamp: msg.createAt ? Math.floor(Number(msg.createAt) / 1e3) : Math.floor(Date.now() / 1e3),
+			conversationId: String(msg.conversationId ?? ""),
+			platform: {
+				conversationType: msg.conversationType,
+				msgtype: msg.msgtype
+			}
+		};
+	}
+	normalizeSender(raw) {
+		return {
+			id: String(raw.id ?? raw.senderStaffId ?? "0"),
+			name: String(raw.name ?? raw.senderNick ?? ""),
+			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 DingTalk outgoing webhook callback" } })
+		] };
+	}
+	async execProcessEvent(_ctx, args) {
+		this._processEvent(args);
+		return {
+			success: true,
+			data: { ok: true }
+		};
+	}
+	/** Process a DingTalk outgoing webhook payload — delegates to emitMessageReceived(). */
+	_processEvent(payload) {
+		const parsed = require_client.DingTalkClient.parseEvent(payload);
+		if (!parsed) return;
+		const { msgId, content, conversationId, senderStaffId, senderNick, createAt } = parsed;
+		const botName = this._botOrder[0] ?? "default";
+		this.emitMessageReceived(botName, {
+			id: msgId,
+			text: content,
+			from: {
+				id: senderStaffId,
+				name: senderNick
+			},
+			timestamp: Math.floor(createAt / 1e3),
+			conversationId,
+			platform: { conversationType: parsed.conversationType }
+		});
+	}
+	/** Add a conversation to a bot. Defaults to first bot. */
+	addConversation(conversationId, botName) {
+		const name = botName ?? this._botOrder[0];
+		if (!name) return;
+		const convs = this._botConversations.get(name);
+		if (!convs || convs.has(conversationId)) return;
+		convs.add(conversationId);
+		const buffers = this._botBuffers.get(name);
+		if (buffers && !buffers.has(conversationId)) buffers.set(conversationId, []);
+	}
+	/** Remove a conversation from a bot. */
+	removeConversation(conversationId, botName) {
+		const name = botName ?? this._botOrder[0];
+		if (!name) return;
+		const convs = this._botConversations.get(name);
+		if (convs) convs.delete(conversationId);
+		const buffers = this._botBuffers.get(name);
+		if (buffers) buffers.delete(conversationId);
+	}
+	/** Add a message to the ring buffer directly. Public for testing/conformance. */
+	_addToBuffer(conversationId, msg) {
+		const botName = this._botOrder[0] ?? "default";
+		const convs = this._botConversations.get(botName);
+		if (convs && !convs.has(conversationId)) convs.add(conversationId);
+		let botBuffers = this._botBuffers.get(botName);
+		if (!botBuffers) {
+			botBuffers = /* @__PURE__ */ new Map();
+			this._botBuffers.set(botName, botBuffers);
+		}
+		let buffer = botBuffers.get(conversationId);
+		if (!buffer) {
+			buffer = [];
+			botBuffers.set(conversationId, buffer);
+		}
+		buffer.push({
+			id: msg.msgId,
+			text: msg.content,
+			from: {
+				id: msg.senderStaffId,
+				name: msg.senderNick
+			},
+			timestamp: msg.createAt ? Math.floor(msg.createAt / 1e3) : Math.floor(Date.now() / 1e3),
+			conversationId,
+			platform: {}
+		});
+		while (buffer.length > this._bufferSize) buffer.shift();
+	}
+};
+require_decorate.__decorate([(0, _aigne_afs_provider.Actions)("/")], AFSDingTalk.prototype, "listRootActions", null);
+require_decorate.__decorate([_aigne_afs_provider.Actions.Exec("/", "process-event")], AFSDingTalk.prototype, "execProcessEvent", null);
+
+//#endregion
+exports.AFSDingTalk = AFSDingTalk;

package/dist/index.d.cts

@@ -0,0 +1,107 @@
+import { DingTalkClient, DingTalkEvent } 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 AFSDingTalkOptions {
+  /** Multi-bot config */
+  bots?: Array<{
+    name: string; /** Webhook access token (Custom Robot mode) */
+    webhook?: string; /** App key (Enterprise Internal Bot mode) */
+    appKey?: string; /** App secret (Enterprise Internal Bot mode) */
+    appSecret?: string;
+    conversations?: string[];
+    legacyApiBase?: string;
+    newApiBase?: string;
+  }>;
+  /** Single-bot shorthand: webhook access token */
+  webhook?: string;
+  /** Single-bot shorthand: app key (bot mode) */
+  appKey?: string;
+  /** Single-bot shorthand: app secret (bot mode) */
+  appSecret?: string;
+  /** Single-bot shorthand: conversation IDs */
+  conversations?: string[];
+  legacyApiBase?: string;
+  newApiBase?: string;
+  bufferSize?: number;
+}
+declare class AFSDingTalk extends BaseMessageProvider {
+  static manifest(): {
+    name: string;
+    description: string;
+    uriTemplate: string;
+    category: string;
+    schema: {
+      type: string;
+      properties: {
+        appKey: {
+          type: string;
+          description: string;
+        };
+        appSecret: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+        webhook: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+        conversations: {
+          type: string;
+          items: {
+            type: string;
+          };
+          description: string;
+        };
+      };
+    };
+    tags: string[];
+    capabilityTags: string[];
+    security: {
+      riskLevel: string;
+      resourceAccess: string[];
+      notes: string[];
+    };
+    capabilities: {
+      network: {
+        egress: boolean;
+        allowedDomains: string[];
+      };
+    };
+  };
+  static treeSchema(): ProviderTreeSchema;
+  readonly providerName = "dingtalk";
+  readonly eventPrefix = "dingtalk";
+  constructor(options: AFSDingTalkOptions);
+  getMessageCapabilities(): MessageCapabilities;
+  createBotClient(config: BotConfig): DingTalkClient;
+  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 DingTalk outgoing webhook payload — delegates to emitMessageReceived(). */
+  _processEvent(payload: any): void;
+  /** Add a conversation to a bot. Defaults to first bot. */
+  addConversation(conversationId: string, botName?: string): void;
+  /** Remove a conversation from a bot. */
+  removeConversation(conversationId: string, botName?: string): void;
+  /** Add a message to the ring buffer directly. Public for testing/conformance. */
+  _addToBuffer(conversationId: string, msg: {
+    msgId: string;
+    content: string;
+    senderStaffId: string;
+    senderNick: string;
+    createAt?: number;
+  }): void;
+}
+//#endregion
+export { AFSDingTalk, AFSDingTalkOptions, type DingTalkClient, type DingTalkEvent };
+//# 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,kBAAA;EA2BJ;EAzBX,IAAA,GAAO,KAAA;IACL,IAAA,UAuEmB;IArEnB,OAAA,WA+HwB;IA7HxB,MAAA,WAmJkC;IAjJlC,SAAA;IACA,aAAA;IACA,aAAA;IACA,UAAA;EAAA;EAsMmB;EAnMrB,OAAA;EA8M4B;EA5M5B,MAAA;EA4M2C;EA1M3C,SAAA;EA6NQ;EA3NR,aAAA;EACA,aAAA;EACA,UAAA;EACA,UAAA;AAAA;AAAA,cAGW,WAAA,SAAoB,mBAAA;EAAA,OACxB,QAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA8CA,UAAA,CAAA,GAAc,kBAAA;EAAA,SA6BZ,YAAA;EAAA,SACA,WAAA;cAEG,OAAA,EAAS,kBAAA;EA0BrB,sBAAA,CAAA,GAA0B,mBAAA;EAsB1B,eAAA,CAAgB,MAAA,EAAQ,SAAA,GAAY,cAAA;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;EAoBhD,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;EAnDX;EA2DA,aAAA,CAAc,OAAA;EA3DG;EAiFjB,eAAA,CAAgB,cAAA,UAAwB,OAAA;EA7DxC;EA0EA,kBAAA,CAAmB,cAAA,UAAwB,OAAA;EA1E3B;EAoFhB,YAAA,CACE,cAAA,UACA,GAAA;IACE,KAAA;IACA,OAAA;IACA,aAAA;IACA,UAAA;IACA,QAAA;EAAA;AAAA"}

package/dist/index.d.mts

@@ -0,0 +1,107 @@
+import { DingTalkClient, DingTalkEvent } 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 AFSDingTalkOptions {
+  /** Multi-bot config */
+  bots?: Array<{
+    name: string; /** Webhook access token (Custom Robot mode) */
+    webhook?: string; /** App key (Enterprise Internal Bot mode) */
+    appKey?: string; /** App secret (Enterprise Internal Bot mode) */
+    appSecret?: string;
+    conversations?: string[];
+    legacyApiBase?: string;
+    newApiBase?: string;
+  }>;
+  /** Single-bot shorthand: webhook access token */
+  webhook?: string;
+  /** Single-bot shorthand: app key (bot mode) */
+  appKey?: string;
+  /** Single-bot shorthand: app secret (bot mode) */
+  appSecret?: string;
+  /** Single-bot shorthand: conversation IDs */
+  conversations?: string[];
+  legacyApiBase?: string;
+  newApiBase?: string;
+  bufferSize?: number;
+}
+declare class AFSDingTalk extends BaseMessageProvider {
+  static manifest(): {
+    name: string;
+    description: string;
+    uriTemplate: string;
+    category: string;
+    schema: {
+      type: string;
+      properties: {
+        appKey: {
+          type: string;
+          description: string;
+        };
+        appSecret: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+        webhook: {
+          type: string;
+          description: string;
+          sensitive: boolean;
+        };
+        conversations: {
+          type: string;
+          items: {
+            type: string;
+          };
+          description: string;
+        };
+      };
+    };
+    tags: string[];
+    capabilityTags: string[];
+    security: {
+      riskLevel: string;
+      resourceAccess: string[];
+      notes: string[];
+    };
+    capabilities: {
+      network: {
+        egress: boolean;
+        allowedDomains: string[];
+      };
+    };
+  };
+  static treeSchema(): ProviderTreeSchema;
+  readonly providerName = "dingtalk";
+  readonly eventPrefix = "dingtalk";
+  constructor(options: AFSDingTalkOptions);
+  getMessageCapabilities(): MessageCapabilities;
+  createBotClient(config: BotConfig): DingTalkClient;
+  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 DingTalk outgoing webhook payload — delegates to emitMessageReceived(). */
+  _processEvent(payload: any): void;
+  /** Add a conversation to a bot. Defaults to first bot. */
+  addConversation(conversationId: string, botName?: string): void;
+  /** Remove a conversation from a bot. */
+  removeConversation(conversationId: string, botName?: string): void;
+  /** Add a message to the ring buffer directly. Public for testing/conformance. */
+  _addToBuffer(conversationId: string, msg: {
+    msgId: string;
+    content: string;
+    senderStaffId: string;
+    senderNick: string;
+    createAt?: number;
+  }): void;
+}
+//#endregion
+export { AFSDingTalk, AFSDingTalkOptions, type DingTalkClient, type DingTalkEvent };
+//# 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,kBAAA;EA2BJ;EAzBX,IAAA,GAAO,KAAA;IACL,IAAA,UAuEmB;IArEnB,OAAA,WA+HwB;IA7HxB,MAAA,WAmJkC;IAjJlC,SAAA;IACA,aAAA;IACA,aAAA;IACA,UAAA;EAAA;EAsMmB;EAnMrB,OAAA;EA8M4B;EA5M5B,MAAA;EA4M2C;EA1M3C,SAAA;EA6NQ;EA3NR,aAAA;EACA,aAAA;EACA,UAAA;EACA,UAAA;AAAA;AAAA,cAGW,WAAA,SAAoB,mBAAA;EAAA,OACxB,QAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA8CA,UAAA,CAAA,GAAc,kBAAA;EAAA,SA6BZ,YAAA;EAAA,SACA,WAAA;cAEG,OAAA,EAAS,kBAAA;EA0BrB,sBAAA,CAAA,GAA0B,mBAAA;EAsB1B,eAAA,CAAgB,MAAA,EAAQ,SAAA,GAAY,cAAA;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;EAoBhD,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;EAnDX;EA2DA,aAAA,CAAc,OAAA;EA3DG;EAiFjB,eAAA,CAAgB,cAAA,UAAwB,OAAA;EA7DxC;EA0EA,kBAAA,CAAmB,cAAA,UAAwB,OAAA;EA1E3B;EAoFhB,YAAA,CACE,cAAA,UACA,GAAA;IACE,KAAA;IACA,OAAA;IACA,aAAA;IACA,UAAA;IACA,QAAA;EAAA;AAAA"}