@workclaw/openclaw-workchat 1.0.0 → 1.0.4

package/src/channel.ts

@@ -1,282 +1,282 @@
-import type { ChannelGatewayContext, ChannelPlugin, OpenClawConfig } from "openclaw/plugin-sdk";
-
-import type { ResolvedWorkChatAccount } from "./auth/accounts.js";
-import {
-  listWorkChatAccountIds,
-  resolveWorkChatAccount,
-} from "./auth/accounts.js";
-import {
-  startWorkChatLoginWithQr,
-  waitForWorkChatLogin,
-} from "./auth/login-qr.js";
-import type { WorkChatQrStartResult, WorkChatQrWaitResult } from "./auth/login-qr.js";
-import { pushWorkChatMessage, replyWorkChatMessage } from "./messaging/send.js";
-import { logger } from "./util/logger.js";
-
-/**
- * Resolve the effective account for an outbound message when the caller did
- * not provide one. With a single bound account it is used directly; multiple
- * accounts require the explicit id (target resolution is ambiguous).
- */
-function resolveOutboundAccount(cfg: OpenClawConfig, accountId?: string | null): ResolvedWorkChatAccount {
-  const allIds = listWorkChatAccountIds(cfg);
-  if (allIds.length === 0) {
-    throw new Error(
-      "workchat: no accounts registered — scan the binding QR code first (`openclaw channels login --channel openclaw-workchat`)",
-    );
-  }
-  const targetId = accountId?.trim() ?? allIds[0];
-  return resolveWorkChatAccount(cfg, targetId);
-}
-
-export const workchatPlugin: ChannelPlugin<ResolvedWorkChatAccount> = {
-  id: "openclaw-workchat",
-  meta: {
-    id: "openclaw-workchat",
-    label: "openclaw-workchat",
-    selectionLabel: "openclaw-workchat (WebSocket)",
-    docsPath: "/channels/openclaw-workchat",
-    docsLabel: "openclaw-workchat",
-    blurb: "WorkChat open-platform channel: binding QR upstream, reply/push downstream; appKey auth.",
-    order: 80,
-  },
-  gatewayMethods: ["web.login.start", "web.login.wait"],
-  configSchema: {
-    schema: {
-      type: "object",
-      additionalProperties: false,
-      properties: {},
-    },
-  },
-  capabilities: {
-    chatTypes: ["direct"],
-    media: true,
-    blockStreaming: true,
-  },
-  streaming: {
-    blockStreamingCoalesceDefaults: {
-      minChars: 200,
-      idleMs: 3000,
-    },
-  },
-  messaging: {
-    targetResolver: {
-      // WorkChat cloud user ids are numeric strings; treat any non-empty
-      // digit-run as a direct ID and skip directory lookup.
-      looksLikeId: (raw) => /^\d{4,}$/.test(raw.trim()),
-    },
-  },
-  agentPrompt: {
-    messageToolHints: () => [
-      "To send a message to the current WorkChat user, use the message tool with action='send'. You do not need to specify 'to' — the current conversation recipient is used automatically.",
-      "IMPORTANT: When creating a cron job (scheduled task) for the current WorkChat user, you MUST set delivery.to to the user's WorkChat ID (the numeric ID from the current conversation) AND set delivery.accountId to the current AccountId. Without an explicit 'to', the cron delivery will fail with 'requires target'. Without an explicit 'accountId', the message may be sent from the wrong bot account. Example: delivery: { mode: 'announce', channel: 'openclaw-workchat', to: '<current_user_id>', accountId: '<current_AccountId>' }.",
-      "IMPORTANT: When sending media, set 'media' to a URL the WorkChat platform can fetch (an HTTPS URL). Local file paths are not supported by the WorkChat send API yet — include the link in the message text instead.",
-    ],
-  },
-  reload: { configPrefixes: ["channels.openclaw-workchat"] },
-  config: {
-    listAccountIds: (cfg) => listWorkChatAccountIds(cfg),
-    resolveAccount: (cfg, accountId) => resolveWorkChatAccount(cfg, accountId),
-    isConfigured: (account) => account.configured,
-    describeAccount: (account) => ({
-      accountId: account.accountId,
-      name: account.name,
-      enabled: account.enabled,
-      configured: account.configured,
-    }),
-  },
-  outbound: {
-    deliveryMode: "direct",
-    textChunkLimit: 4000,
-    sendText: async (ctx) => {
-      const account = resolveOutboundAccount(ctx.cfg, ctx.accountId);
-      const replyToId = ctx.replyToId?.trim();
-      const result = replyToId
-        ? await replyWorkChatMessage({
-            account,
-            to: ctx.to,
-            text: ctx.text,
-            replyToMessageId: replyToId,
-          })
-        : await pushWorkChatMessage({
-            account,
-            to: ctx.to,
-            text: ctx.text,
-          });
-      return { channel: "openclaw-workchat", messageId: result.messageId };
-    },
-    sendMedia: async (ctx) => {
-      // Media sends degrade to a text message carrying the media URL until the
-      // platform media-upload API is confirmed.
-      const account = resolveOutboundAccount(ctx.cfg, ctx.accountId);
-      const text = ctx.text?.trim() ? ctx.text : ctx.mediaUrl ?? "";
-      const result = await pushWorkChatMessage({
-        account,
-        to: ctx.to,
-        text,
-      });
-      return { channel: "openclaw-workchat", messageId: result.messageId };
-    },
-  },
-  status: {
-    defaultRuntime: {
-      accountId: "",
-      lastError: null,
-      lastInboundAt: null,
-      lastOutboundAt: null,
-    },
-    collectStatusIssues: () => [],
-    buildChannelSummary: ({ snapshot }) => ({
-      configured: snapshot.configured ?? false,
-      lastError: snapshot.lastError ?? null,
-      lastInboundAt: snapshot.lastInboundAt ?? null,
-      lastOutboundAt: snapshot.lastOutboundAt ?? null,
-    }),
-    buildAccountSnapshot: ({ account, runtime }) => ({
-      ...runtime,
-      accountId: account.accountId,
-      name: account.name,
-      enabled: account.enabled,
-      configured: account.configured,
-    }),
-  },
-  gateway: {
-    startAccount: async (ctx: ChannelGatewayContext<ResolvedWorkChatAccount>) => {
-      logger.debug(`startAccount entry`);
-      if (!ctx) {
-        logger.warn(`gateway.startAccount: called with undefined ctx, skipping`);
-        return;
-      }
-      const account = ctx.account;
-      const aLog = logger.withAccount(account.accountId);
-      aLog.info(`starting workchat websocket monitor`);
-
-      if (!account.configured) {
-        aLog.error(`account not configured`);
-        ctx.log?.error?.(
-          `[${account.accountId}] workchat not configured — missing WORKCHAT_API_KEY/WORKCHAT_APP_SECRET`,
-        );
-        ctx.setStatus?.({ accountId: account.accountId, running: false });
-        throw new Error("workchat not configured: missing appKey/appSecret");
-      }
-
-      // The gateway injects the channel runtime surface per-call (task-scoped). We require it:
-      // it carries reply/routing/session helpers used by processOneFrame.
-      if (!ctx.channelRuntime) {
-        const msg = `ctx.channelRuntime missing — host too old or plugin SDK contract violated`;
-        aLog.error(msg);
-        ctx.log?.error?.(`[${account.accountId}] ${msg}`);
-        ctx.setStatus?.({ accountId: account.accountId, running: false });
-        throw new Error(msg);
-      }
-
-      const { monitorWorkChatProvider } = await import("./monitor/monitor.js");
-      return monitorWorkChatProvider({
-        apiOpts: {
-          baseUrl: account.baseUrl,
-          appKey: account.appKey,
-          appSecret: account.appSecret,
-          timeoutMs: account.requestTimeout,
-          allowInsecureTls: account.allowInsecureTls,
-        },
-        accountId: account.accountId,
-        account,
-        config: ctx.cfg,
-        runtime: ctx.runtime,
-        channelRuntime: ctx.channelRuntime as unknown as import("openclaw/plugin-sdk").PluginRuntime["channel"],
-        abortSignal: ctx.abortSignal,
-        setStatus: ctx.setStatus,
-      });
-    },
-    stopAccount: async (ctx: ChannelGatewayContext<ResolvedWorkChatAccount>) => {
-      // The WebSocket monitor exits via its abortSignal; nothing extra to do.
-      const account = ctx.account;
-      logger.withAccount(account.accountId).info(`stopAccount`);
-      ctx.setStatus?.({ accountId: account.accountId, running: false });
-    },
-    /**
-     * WorkChat 绑定二维码：由网关 RPC (web.login.start / web.login.wait) 调用。
-     * 用户在 WorkChat 平台扫码创建/绑定智能体；完成后平台推送
-     * AGENT_CREATED/INIT_AGENT，插件持久化 agentId/userId。
-     */
-    loginWithQrStart: async ({ accountId, force, verbose }) => {
-      void force;
-      void verbose;
-      // The gateway adapter has no cfg in scope here — read the live config
-      // from disk (the gateway's own config, same file triggerWorkChatChannelReload
-      // writes to) so the ${WORKCHAT_API_KEY} placeholder is resolved by the host.
-      const { loadConfig } = await import("openclaw/plugin-sdk/config-runtime");
-      const cfg = loadConfig() as OpenClawConfig;
-      const account = resolveWorkChatAccount(cfg, accountId ?? "default");
-      const result: WorkChatQrStartResult = await startWorkChatLoginWithQr({
-        baseUrl: account.baseUrl,
-        appKey: account.appKey,
-        appSecret: account.appSecret,
-      });
-      return {
-        qrDataUrl: result.qrcodeUrl,
-        message: result.message,
-        sessionKey: result.sessionKey,
-      } as { qrDataUrl?: string; message: string };
-    },
-    loginWithQrWait: async (params) => {
-      // sessionKey is forwarded by the client after loginWithQrStart (runtime param extension).
-      const sessionKey = (params as { sessionKey?: string }).sessionKey || params.accountId || "";
-      const result: WorkChatQrWaitResult = await waitForWorkChatLogin({
-        sessionKey,
-        timeoutMs: params.timeoutMs,
-      });
-      return {
-        connected: result.connected,
-        message: result.message,
-        accountId: result.accountId,
-        agentId: result.agentId,
-      } as { connected: boolean; message: string };
-    },
-  },
-  auth: {
-    login: async ({ cfg, accountId, verbose, runtime }) => {
-      const account = resolveWorkChatAccount(cfg, accountId);
-
-      const log = (msg: string) => {
-        runtime?.log?.(msg);
-      };
-
-      log(`正在启动...`);
-      const startResult: WorkChatQrStartResult = await startWorkChatLoginWithQr({
-        baseUrl: account.baseUrl,
-        appKey: account.appKey,
-        appSecret: account.appSecret,
-      });
-
-      if (!startResult.qrcodeUrl) {
-        logger.warn(
-          `auth.login: failed to get QR code accountId=${account.accountId} message=${startResult.message}`,
-        );
-        log(startResult.message);
-        throw new Error(startResult.message);
-      }
-
-      log(`\n请在 WorkChat 平台扫描以下二维码，以继续绑定：\n`);
-      const { displayQRCode } = await import("./auth/login-qr-terminal.js");
-      await displayQRCode(startResult.qrcodeUrl!);
-
-      const loginTimeoutMs = 480_000;
-      log(`\n正在等待操作...\n`);
-
-      const waitResult: WorkChatQrWaitResult = await waitForWorkChatLogin({
-        sessionKey: startResult.sessionKey,
-        timeoutMs: loginTimeoutMs,
-      });
-
-      if (waitResult.connected) {
-        log(`\n已将此 OpenClaw 绑定到 WorkChat。`);
-      } else {
-        logger.warn(
-          `auth.login: binding did not complete accountId=${account.accountId} message=${waitResult.message}`,
-        );
-        throw new Error(waitResult.message);
-      }
-    },
-  },
-};
+import type { ChannelGatewayContext, ChannelPlugin, OpenClawConfig } from "openclaw/plugin-sdk";
+
+import type { ResolvedWorkChatAccount } from "./auth/accounts.js";
+import {
+  listWorkChatAccountIds,
+  resolveWorkChatAccount,
+} from "./auth/accounts.js";
+import {
+  startWorkChatLoginWithQr,
+  waitForWorkChatLogin,
+} from "./auth/login-qr.js";
+import type { WorkChatQrStartResult, WorkChatQrWaitResult } from "./auth/login-qr.js";
+import { pushWorkChatMessage, replyWorkChatMessage } from "./messaging/send.js";
+import { logger } from "./util/logger.js";
+
+/**
+ * Resolve the effective account for an outbound message when the caller did
+ * not provide one. With a single bound account it is used directly; multiple
+ * accounts require the explicit id (target resolution is ambiguous).
+ */
+function resolveOutboundAccount(cfg: OpenClawConfig, accountId?: string | null): ResolvedWorkChatAccount {
+  const allIds = listWorkChatAccountIds(cfg);
+  if (allIds.length === 0) {
+    throw new Error(
+      "workchat: no accounts registered — scan the binding QR code first (`openclaw channels login --channel openclaw-workchat`)",
+    );
+  }
+  const targetId = accountId?.trim() ?? allIds[0];
+  return resolveWorkChatAccount(cfg, targetId);
+}
+
+export const workchatPlugin: ChannelPlugin<ResolvedWorkChatAccount> = {
+  id: "openclaw-workchat",
+  meta: {
+    id: "openclaw-workchat",
+    label: "openclaw-workchat",
+    selectionLabel: "openclaw-workchat (WebSocket)",
+    docsPath: "/channels/openclaw-workchat",
+    docsLabel: "openclaw-workchat",
+    blurb: "WorkChat open-platform channel: binding QR upstream, reply/push downstream; appKey auth.",
+    order: 80,
+  },
+  gatewayMethods: ["web.login.start", "web.login.wait"],
+  configSchema: {
+    schema: {
+      type: "object",
+      additionalProperties: false,
+      properties: {},
+    },
+  },
+  capabilities: {
+    chatTypes: ["direct"],
+    media: true,
+    blockStreaming: true,
+  },
+  streaming: {
+    blockStreamingCoalesceDefaults: {
+      minChars: 200,
+      idleMs: 3000,
+    },
+  },
+  messaging: {
+    targetResolver: {
+      // WorkChat cloud user ids are numeric strings; treat any non-empty
+      // digit-run as a direct ID and skip directory lookup.
+      looksLikeId: (raw) => /^\d{4,}$/.test(raw.trim()),
+    },
+  },
+  agentPrompt: {
+    messageToolHints: () => [
+      "To send a message to the current WorkChat user, use the message tool with action='send'. You do not need to specify 'to' — the current conversation recipient is used automatically.",
+      "IMPORTANT: When creating a cron job (scheduled task) for the current WorkChat user, you MUST set delivery.to to the user's WorkChat ID (the numeric ID from the current conversation) AND set delivery.accountId to the current AccountId. Without an explicit 'to', the cron delivery will fail with 'requires target'. Without an explicit 'accountId', the message may be sent from the wrong bot account. Example: delivery: { mode: 'announce', channel: 'openclaw-workchat', to: '<current_user_id>', accountId: '<current_AccountId>' }.",
+      "IMPORTANT: When sending media, set 'media' to a URL the WorkChat platform can fetch (an HTTPS URL). Local file paths are not supported by the WorkChat send API yet — include the link in the message text instead.",
+    ],
+  },
+  reload: { configPrefixes: ["channels.openclaw-workchat"] },
+  config: {
+    listAccountIds: (cfg) => listWorkChatAccountIds(cfg),
+    resolveAccount: (cfg, accountId) => resolveWorkChatAccount(cfg, accountId),
+    isConfigured: (account) => account.configured,
+    describeAccount: (account) => ({
+      accountId: account.accountId,
+      name: account.name,
+      enabled: account.enabled,
+      configured: account.configured,
+    }),
+  },
+  outbound: {
+    deliveryMode: "direct",
+    textChunkLimit: 4000,
+    sendText: async (ctx) => {
+      const account = resolveOutboundAccount(ctx.cfg, ctx.accountId);
+      const replyToId = ctx.replyToId?.trim();
+      const result = replyToId
+        ? await replyWorkChatMessage({
+            account,
+            to: ctx.to,
+            text: ctx.text,
+            replyToMessageId: replyToId,
+          })
+        : await pushWorkChatMessage({
+            account,
+            to: ctx.to,
+            text: ctx.text,
+          });
+      return { channel: "openclaw-workchat", messageId: result.messageId };
+    },
+    sendMedia: async (ctx) => {
+      // Media sends degrade to a text message carrying the media URL until the
+      // platform media-upload API is confirmed.
+      const account = resolveOutboundAccount(ctx.cfg, ctx.accountId);
+      const text = ctx.text?.trim() ? ctx.text : ctx.mediaUrl ?? "";
+      const result = await pushWorkChatMessage({
+        account,
+        to: ctx.to,
+        text,
+      });
+      return { channel: "openclaw-workchat", messageId: result.messageId };
+    },
+  },
+  status: {
+    defaultRuntime: {
+      accountId: "",
+      lastError: null,
+      lastInboundAt: null,
+      lastOutboundAt: null,
+    },
+    collectStatusIssues: () => [],
+    buildChannelSummary: ({ snapshot }) => ({
+      configured: snapshot.configured ?? false,
+      lastError: snapshot.lastError ?? null,
+      lastInboundAt: snapshot.lastInboundAt ?? null,
+      lastOutboundAt: snapshot.lastOutboundAt ?? null,
+    }),
+    buildAccountSnapshot: ({ account, runtime }) => ({
+      ...runtime,
+      accountId: account.accountId,
+      name: account.name,
+      enabled: account.enabled,
+      configured: account.configured,
+    }),
+  },
+  gateway: {
+    startAccount: async (ctx: ChannelGatewayContext<ResolvedWorkChatAccount>) => {
+      logger.debug(`startAccount entry`);
+      if (!ctx) {
+        logger.warn(`gateway.startAccount: called with undefined ctx, skipping`);
+        return;
+      }
+      const account = ctx.account;
+      const aLog = logger.withAccount(account.accountId);
+      aLog.info(`starting workchat websocket monitor`);
+
+      if (!account.configured) {
+        aLog.error(`account not configured`);
+        ctx.log?.error?.(
+          `[${account.accountId}] workchat not configured — missing WORKCHAT_API_KEY/WORKCHAT_APP_SECRET`,
+        );
+        ctx.setStatus?.({ accountId: account.accountId, running: false });
+        throw new Error("workchat not configured: missing appKey/appSecret");
+      }
+
+      // The gateway injects the channel runtime surface per-call (task-scoped). We require it:
+      // it carries reply/routing/session helpers used by processOneFrame.
+      if (!ctx.channelRuntime) {
+        const msg = `ctx.channelRuntime missing — host too old or plugin SDK contract violated`;
+        aLog.error(msg);
+        ctx.log?.error?.(`[${account.accountId}] ${msg}`);
+        ctx.setStatus?.({ accountId: account.accountId, running: false });
+        throw new Error(msg);
+      }
+
+      const { monitorWorkChatProvider } = await import("./monitor/monitor.js");
+      return monitorWorkChatProvider({
+        apiOpts: {
+          baseUrl: account.baseUrl,
+          appKey: account.appKey,
+          appSecret: account.appSecret,
+          timeoutMs: account.requestTimeout,
+          allowInsecureTls: account.allowInsecureTls,
+        },
+        accountId: account.accountId,
+        account,
+        config: ctx.cfg,
+        runtime: ctx.runtime,
+        channelRuntime: ctx.channelRuntime as unknown as import("openclaw/plugin-sdk").PluginRuntime["channel"],
+        abortSignal: ctx.abortSignal,
+        setStatus: ctx.setStatus,
+      });
+    },
+    stopAccount: async (ctx: ChannelGatewayContext<ResolvedWorkChatAccount>) => {
+      // The WebSocket monitor exits via its abortSignal; nothing extra to do.
+      const account = ctx.account;
+      logger.withAccount(account.accountId).info(`stopAccount`);
+      ctx.setStatus?.({ accountId: account.accountId, running: false });
+    },
+    /**
+     * WorkChat 绑定二维码：由网关 RPC (web.login.start / web.login.wait) 调用。
+     * 用户在 WorkChat 平台扫码创建/绑定智能体；完成后平台推送
+     * AGENT_CREATED/INIT_AGENT，插件持久化 agentId/userId。
+     */
+    loginWithQrStart: async ({ accountId, force, verbose }) => {
+      void force;
+      void verbose;
+      // The gateway adapter has no cfg in scope here — read the live config
+      // from disk (the gateway's own config, same file triggerWorkChatChannelReload
+      // writes to) so the ${WORKCHAT_API_KEY} placeholder is resolved by the host.
+      const { loadConfig } = await import("openclaw/plugin-sdk/config-runtime");
+      const cfg = loadConfig() as OpenClawConfig;
+      const account = resolveWorkChatAccount(cfg, accountId ?? "default");
+      const result: WorkChatQrStartResult = await startWorkChatLoginWithQr({
+        baseUrl: account.baseUrl,
+        appKey: account.appKey,
+        appSecret: account.appSecret,
+      });
+      return {
+        qrDataUrl: result.qrcodeUrl,
+        message: result.message,
+        sessionKey: result.sessionKey,
+      } as { qrDataUrl?: string; message: string };
+    },
+    loginWithQrWait: async (params) => {
+      // sessionKey is forwarded by the client after loginWithQrStart (runtime param extension).
+      const sessionKey = (params as { sessionKey?: string }).sessionKey || params.accountId || "";
+      const result: WorkChatQrWaitResult = await waitForWorkChatLogin({
+        sessionKey,
+        timeoutMs: params.timeoutMs,
+      });
+      return {
+        connected: result.connected,
+        message: result.message,
+        accountId: result.accountId,
+        agentId: result.agentId,
+      } as { connected: boolean; message: string };
+    },
+  },
+  auth: {
+    login: async ({ cfg, accountId, verbose, runtime }) => {
+      const account = resolveWorkChatAccount(cfg, accountId);
+
+      const log = (msg: string) => {
+        runtime?.log?.(msg);
+      };
+
+      log(`正在启动...`);
+      const startResult: WorkChatQrStartResult = await startWorkChatLoginWithQr({
+        baseUrl: account.baseUrl,
+        appKey: account.appKey,
+        appSecret: account.appSecret,
+      });
+
+      if (!startResult.qrcodeUrl) {
+        logger.warn(
+          `auth.login: failed to get QR code accountId=${account.accountId} message=${startResult.message}`,
+        );
+        log(startResult.message);
+        throw new Error(startResult.message);
+      }
+
+      log(`\n请在 WorkChat 平台扫描以下二维码，以继续绑定：\n`);
+      const { displayQRCode } = await import("./auth/login-qr-terminal.js");
+      await displayQRCode(startResult.qrcodeUrl!);
+
+      const loginTimeoutMs = 480_000;
+      log(`\n正在等待操作...\n`);
+
+      const waitResult: WorkChatQrWaitResult = await waitForWorkChatLogin({
+        sessionKey: startResult.sessionKey,
+        timeoutMs: loginTimeoutMs,
+      });
+
+      if (waitResult.connected) {
+        log(`\n已将此 OpenClaw 绑定到 WorkChat。`);
+      } else {
+        logger.warn(
+          `auth.login: binding did not complete accountId=${account.accountId} message=${waitResult.message}`,
+        );
+        throw new Error(waitResult.message);
+      }
+    },
+  },
+};