weixin-agent-sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,60 @@
+//#region src/agent/interface.d.ts
+/**
+ * Agent interface — any AI backend that can handle a chat message.
+ *
+ * Implement this interface to connect WeChat to your own AI service.
+ * The WeChat bridge calls `chat()` for each inbound message and sends
+ * the returned response back to the user.
+ */
+interface Agent {
+  /** Process a single message and return a reply. */
+  chat(request: ChatRequest): Promise<ChatResponse>;
+}
+interface ChatRequest {
+  /** Conversation / user identifier. Use this to maintain per-user context. */
+  conversationId: string;
+  /** Text content of the message. */
+  text: string;
+  /** Attached media file (image, audio, video, or generic file). */
+  media?: {
+    type: "image" | "audio" | "video" | "file"; /** Local file path (already downloaded and decrypted). */
+    filePath: string; /** MIME type, e.g. "image/jpeg", "audio/wav". */
+    mimeType: string; /** Original filename (available for file attachments). */
+    fileName?: string;
+  };
+}
+interface ChatResponse {
+  /** Reply text (may contain markdown — will be converted to plain text before sending). */
+  text?: string;
+  /** Reply media file. */
+  media?: {
+    type: "image" | "video" | "file"; /** Local file path or HTTPS URL. */
+    url: string; /** Filename hint (for file attachments). */
+    fileName?: string;
+  };
+}
+//#endregion
+//#region src/bot.d.ts
+type LoginOptions = {
+  /** Override the API base URL. */baseUrl?: string; /** Log callback (defaults to console.log). */
+  log?: (msg: string) => void;
+};
+type StartOptions = {
+  /** Account ID to use. Auto-selects the first registered account if omitted. */accountId?: string; /** AbortSignal to stop the bot. */
+  abortSignal?: AbortSignal; /** Log callback (defaults to console.log). */
+  log?: (msg: string) => void;
+};
+/**
+ * Interactive QR-code login. Prints the QR code to the terminal and waits
+ * for the user to scan it with WeChat.
+ *
+ * Returns the normalized account ID on success.
+ */
+declare function login(opts?: LoginOptions): Promise<string>;
+/**
+ * Start the bot — long-polls for new messages and dispatches them to the agent.
+ * Blocks until the abort signal fires or an unrecoverable error occurs.
+ */
+declare function start(agent: Agent, opts?: StartOptions): Promise<void>;
+//#endregion
+export { type Agent, type ChatRequest, type ChatResponse, type LoginOptions, type StartOptions, login, start };