@workclaw/openclaw-workchat 1.0.0 → 1.0.4

package/src/api/api.ts

@@ -1,260 +1,260 @@
-import { Agent, fetch as undiciFetch } from "undici";
-
-import { DEFAULT_BASE_URL, DEFAULT_WS_URL, RequestDefaults } from "./types.js";
-import { logger } from "../util/logger.js";
-import { redactBody, redactUrl } from "../util/redact.js";
-
-export type WorkChatApiOptions = {
-  baseUrl: string;
-  appKey?: string;
-  appSecret?: string;
-  timeoutMs?: number;
-  allowInsecureTls?: boolean;
-};
-
-// ---------------------------------------------------------------------------
-// Transport
-// ---------------------------------------------------------------------------
-
-async function fetchJson<T>(params: {
-  url: string;
-  init: RequestInit;
-  timeoutMs: number;
-  allowInsecureTls?: boolean;
-}): Promise<T> {
-  const { url, init, timeoutMs, allowInsecureTls } = params;
-  const dispatcher = allowInsecureTls
-    ? new Agent({ connect: { rejectUnauthorized: false } })
-    : undefined;
-  const fetcher = allowInsecureTls ? undiciFetch : globalThis.fetch;
-  const controller = new AbortController();
-  const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
-
-  let response: any;
-  let text = "";
-  try {
-    response = await fetcher(url, {
-      ...init,
-      signal: controller.signal,
-      ...(dispatcher ? { dispatcher } : {}),
-    } as any);
-    text = await response.text().catch(() => "");
-  } finally {
-    clearTimeout(timeoutId);
-  }
-
-  let data: any = {};
-  if (text) {
-    try {
-      data = JSON.parse(text);
-    } catch {
-      data = {};
-    }
-  }
-
-  if (!response.ok) {
-    const message = data?.message || text || `HTTP ${response.status}`;
-    logger.error(`api: ${redactUrl(url)} HTTP ${response.status} ${redactBody(message)}`);
-    throw new Error(message);
-  }
-  return data as T;
-}
-
-/** POST JSON with Bearer auth. */
-export async function apiPost<T = unknown>(params: {
-  url: string;
-  token?: string;
-  body?: unknown;
-  opts: WorkChatApiOptions;
-}): Promise<T> {
-  return fetchJson<T>({
-    url: params.url,
-    timeoutMs: params.opts.timeoutMs ?? RequestDefaults.TimeoutMs,
-    allowInsecureTls: params.opts.allowInsecureTls,
-    init: {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        ...(params.token ? { Authorization: `Bearer ${params.token}` } : {}),
-      },
-      body: params.body === undefined ? undefined : JSON.stringify(params.body),
-    },
-  });
-}
-
-/** Envelope helper: unwrap { code, data } or throw with message. */
-export function unwrapEnvelope<T>(resp: { code?: number; message?: string; errMsg?: string; data?: T }): T {
-  if (resp.code !== 200) {
-    throw new Error(String(resp.message || resp.errMsg || `WorkChat API code=${resp.code}`));
-  }
-  return resp.data as T;
-}
-
-export function normalizeBaseUrl(baseUrl: string | undefined): string {
-  const raw = (baseUrl || DEFAULT_BASE_URL).trim();
-  return raw.endsWith("/") ? raw.slice(0, -1) : raw;
-}
-
-// ---------------------------------------------------------------------------
-// Access token (with cache)
-// ---------------------------------------------------------------------------
-
-interface TokenCacheEntry {
-  token: string;
-  expiresAt: number;
-  pending?: Promise<string>;
-}
-
-const tokenCache = new Map<string, TokenCacheEntry>();
-
-export function clearWorkChatTokenCache(cacheKey: string): void {
-  tokenCache.delete(cacheKey);
-}
-
-/**
- * POST {base}/authen/v1/access_token/internal with app_key/app_secret.
- * Cached per appKey with a 5-minute pre-expiry refresh and single-flight.
- */
-export async function getAccessToken(opts: WorkChatApiOptions): Promise<string> {
-  const cacheKey = opts.appKey || "default";
-  const cached = tokenCache.get(cacheKey);
-
-  if (cached?.token) {
-    const refreshAt = cached.expiresAt - 5 * 60_000;
-    if (Date.now() < refreshAt) return cached.token;
-  }
-  if (cached?.pending) return cached.pending;
-
-  if (!opts.appKey || !opts.appSecret) {
-    throw new Error(
-      "workchat: missing appKey/appSecret (check WORKCHAT_API_KEY / WORKCHAT_APP_SECRET injection)",
-    );
-  }
-
-  const pending = (async (): Promise<string> => {
-    const resp = await apiPost<{ code?: number; message?: string; data?: { accessToken?: string; expiresIn?: number } }>({
-      url: `${normalizeBaseUrl(opts.baseUrl)}/authen/v1/access_token/internal`,
-      body: { app_key: opts.appKey, app_secret: opts.appSecret },
-      opts,
-    });
-    const data = unwrapEnvelope(resp);
-    if (!data?.accessToken) throw new Error("workchat: accessToken missing in response");
-    const token = String(data.accessToken);
-    const expiresIn = Number(data.expiresIn || 0);
-    tokenCache.set(cacheKey, {
-      token,
-      expiresAt: Date.now() + (expiresIn > 0 ? expiresIn * 1000 : 0),
-    });
-    logger.info(`access token acquired tokenLen=${token.length} expiresInSec=${expiresIn}`);
-    return token;
-  })();
-
-  tokenCache.set(cacheKey, {
-    token: cached?.token || "",
-    expiresAt: cached?.expiresAt || 0,
-    pending,
-  });
-
-  try {
-    return await pending;
-  } catch (err) {
-    logger.error(`getAccessToken failed: ${String(err)}`);
-    tokenCache.delete(cacheKey);
-    throw err;
-  }
-}
-
-// ---------------------------------------------------------------------------
-// Connection open (WebSocket ticket)
-// ---------------------------------------------------------------------------
-
-/** POST {base}/open-apis/v1/connections/open — returns endpoint + ticket. */
-export async function openConnection(opts: WorkChatApiOptions & {
-  websocketUrl?: string;
-  localIp?: string;
-}): Promise<{ endpoint: string; ticket: string }> {
-  const token = await getAccessToken(opts);
-  const resp = await apiPost<{ code?: number; message?: string; data?: { endpoint?: string; ticket?: string } }>({
-    url: `${normalizeBaseUrl(opts.baseUrl)}/open-apis/v1/connections/open`,
-    token,
-    body: {
-      appKey: opts.appKey,
-      appSecret: opts.appSecret,
-      subscriptions: [
-        { type: "CALLBACK", topic: "AGENT_MESSAGE" },
-        { type: "EVENT", topic: "*" },
-        { type: "SYSTEM", topic: "*" },
-      ],
-      ...(opts.localIp ? { localIp: opts.localIp } : {}),
-    },
-    opts,
-  });
-  const data = unwrapEnvelope(resp);
-  const ticket = data?.ticket ? String(data.ticket) : "";
-  if (!ticket) throw new Error("workchat: ticket missing in connections/open response");
-
-  const endpoint = opts.websocketUrl || data.endpoint || DEFAULT_WS_URL;
-  logger.info(
-    `connection opened endpointSource=${opts.websocketUrl ? "config" : data.endpoint ? "api" : "default"} ticketLen=${ticket.length}`,
-  );
-  return { endpoint, ticket };
-}
-
-// ---------------------------------------------------------------------------
-// Messaging
-// ---------------------------------------------------------------------------
-
-/** POST {base}/open-apis/im/v1/messages — proactive push. */
-export async function sendWorkChatMessage(params: {
-  opts: WorkChatApiOptions;
-  body: import("./types.js").SendMessageReq;
-}): Promise<{ msgId: string }> {
-  const token = await getAccessToken(params.opts);
-  const resp = await apiPost<{ code?: number; message?: string; data?: { msgId?: string } }>({
-    url: `${normalizeBaseUrl(params.opts.baseUrl)}/open-apis/im/v1/messages`,
-    token,
-    body: params.body,
-    opts: params.opts,
-  });
-  const data = unwrapEnvelope(resp);
-  if (!data?.msgId) throw new Error("workchat: msgId missing in send response");
-  return { msgId: String(data.msgId) };
-}
-
-/** POST {base}/open-apis/im/v1/messages/{messageId}/reply — user-triggered reply. */
-export async function sendWorkChatReplyMessage(params: {
-  opts: WorkChatApiOptions;
-  messageId: string;
-  body: import("./types.js").SendMessageReq;
-}): Promise<{ msgId: string }> {
-  const token = await getAccessToken(params.opts);
-  const resp = await apiPost<{ code?: number; message?: string; data?: { msgId?: string } }>({
-    url: `${normalizeBaseUrl(params.opts.baseUrl)}/open-apis/im/v1/messages/${encodeURIComponent(params.messageId)}/reply`,
-    token,
-    body: params.body,
-    opts: params.opts,
-  });
-  const data = unwrapEnvelope(resp);
-  if (!data?.msgId) throw new Error("workchat: msgId missing in reply response");
-  return { msgId: String(data.msgId) };
-}
-
-// ---------------------------------------------------------------------------
-// Agent lifecycle
-// ---------------------------------------------------------------------------
-
-/** POST {base}/open-apis/instance/agent-created/status — ack local agent creation (best-effort). */
-export async function notifyAgentCreatedStatus(opts: WorkChatApiOptions, agentId: string): Promise<void> {
-  try {
-    const token = await getAccessToken(opts);
-    const resp = await apiPost<{ code?: number }>({
-      url: `${normalizeBaseUrl(opts.baseUrl)}/open-apis/instance/agent-created/status`,
-      token,
-      body: { agentId, success: true },
-      opts,
-    });
-    logger.info(`agent-created/status response code=${String(resp?.code ?? "")}`);
-  } catch (err) {
-    logger.error(`agent-created/status failed: ${String(err)}`);
-  }
-}
+import { Agent, fetch as undiciFetch } from "undici";
+
+import { DEFAULT_BASE_URL, DEFAULT_WS_URL, RequestDefaults } from "./types.js";
+import { logger } from "../util/logger.js";
+import { redactBody, redactUrl } from "../util/redact.js";
+
+export type WorkChatApiOptions = {
+  baseUrl: string;
+  appKey?: string;
+  appSecret?: string;
+  timeoutMs?: number;
+  allowInsecureTls?: boolean;
+};
+
+// ---------------------------------------------------------------------------
+// Transport
+// ---------------------------------------------------------------------------
+
+async function fetchJson<T>(params: {
+  url: string;
+  init: RequestInit;
+  timeoutMs: number;
+  allowInsecureTls?: boolean;
+}): Promise<T> {
+  const { url, init, timeoutMs, allowInsecureTls } = params;
+  const dispatcher = allowInsecureTls
+    ? new Agent({ connect: { rejectUnauthorized: false } })
+    : undefined;
+  const fetcher = allowInsecureTls ? undiciFetch : globalThis.fetch;
+  const controller = new AbortController();
+  const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
+
+  let response: any;
+  let text = "";
+  try {
+    response = await fetcher(url, {
+      ...init,
+      signal: controller.signal,
+      ...(dispatcher ? { dispatcher } : {}),
+    } as any);
+    text = await response.text().catch(() => "");
+  } finally {
+    clearTimeout(timeoutId);
+  }
+
+  let data: any = {};
+  if (text) {
+    try {
+      data = JSON.parse(text);
+    } catch {
+      data = {};
+    }
+  }
+
+  if (!response.ok) {
+    const message = data?.message || text || `HTTP ${response.status}`;
+    logger.error(`api: ${redactUrl(url)} HTTP ${response.status} ${redactBody(message)}`);
+    throw new Error(message);
+  }
+  return data as T;
+}
+
+/** POST JSON with Bearer auth. */
+export async function apiPost<T = unknown>(params: {
+  url: string;
+  token?: string;
+  body?: unknown;
+  opts: WorkChatApiOptions;
+}): Promise<T> {
+  return fetchJson<T>({
+    url: params.url,
+    timeoutMs: params.opts.timeoutMs ?? RequestDefaults.TimeoutMs,
+    allowInsecureTls: params.opts.allowInsecureTls,
+    init: {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        ...(params.token ? { Authorization: `Bearer ${params.token}` } : {}),
+      },
+      body: params.body === undefined ? undefined : JSON.stringify(params.body),
+    },
+  });
+}
+
+/** Envelope helper: unwrap { code, data } or throw with message. */
+export function unwrapEnvelope<T>(resp: { code?: number; message?: string; errMsg?: string; data?: T }): T {
+  if (resp.code !== 200) {
+    throw new Error(String(resp.message || resp.errMsg || `WorkChat API code=${resp.code}`));
+  }
+  return resp.data as T;
+}
+
+export function normalizeBaseUrl(baseUrl: string | undefined): string {
+  const raw = (baseUrl || DEFAULT_BASE_URL).trim();
+  return raw.endsWith("/") ? raw.slice(0, -1) : raw;
+}
+
+// ---------------------------------------------------------------------------
+// Access token (with cache)
+// ---------------------------------------------------------------------------
+
+interface TokenCacheEntry {
+  token: string;
+  expiresAt: number;
+  pending?: Promise<string>;
+}
+
+const tokenCache = new Map<string, TokenCacheEntry>();
+
+export function clearWorkChatTokenCache(cacheKey: string): void {
+  tokenCache.delete(cacheKey);
+}
+
+/**
+ * POST {base}/authen/v1/access_token/internal with app_key/app_secret.
+ * Cached per appKey with a 5-minute pre-expiry refresh and single-flight.
+ */
+export async function getAccessToken(opts: WorkChatApiOptions): Promise<string> {
+  const cacheKey = opts.appKey || "default";
+  const cached = tokenCache.get(cacheKey);
+
+  if (cached?.token) {
+    const refreshAt = cached.expiresAt - 5 * 60_000;
+    if (Date.now() < refreshAt) return cached.token;
+  }
+  if (cached?.pending) return cached.pending;
+
+  if (!opts.appKey || !opts.appSecret) {
+    throw new Error(
+      "workchat: missing appKey/appSecret (check WORKCHAT_API_KEY / WORKCHAT_APP_SECRET injection)",
+    );
+  }
+
+  const pending = (async (): Promise<string> => {
+    const resp = await apiPost<{ code?: number; message?: string; data?: { accessToken?: string; expiresIn?: number } }>({
+      url: `${normalizeBaseUrl(opts.baseUrl)}/authen/v1/access_token/internal`,
+      body: { app_key: opts.appKey, app_secret: opts.appSecret },
+      opts,
+    });
+    const data = unwrapEnvelope(resp);
+    if (!data?.accessToken) throw new Error("workchat: accessToken missing in response");
+    const token = String(data.accessToken);
+    const expiresIn = Number(data.expiresIn || 0);
+    tokenCache.set(cacheKey, {
+      token,
+      expiresAt: Date.now() + (expiresIn > 0 ? expiresIn * 1000 : 0),
+    });
+    logger.info(`access token acquired tokenLen=${token.length} expiresInSec=${expiresIn}`);
+    return token;
+  })();
+
+  tokenCache.set(cacheKey, {
+    token: cached?.token || "",
+    expiresAt: cached?.expiresAt || 0,
+    pending,
+  });
+
+  try {
+    return await pending;
+  } catch (err) {
+    logger.error(`getAccessToken failed: ${String(err)}`);
+    tokenCache.delete(cacheKey);
+    throw err;
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Connection open (WebSocket ticket)
+// ---------------------------------------------------------------------------
+
+/** POST {base}/open-apis/v1/connections/open — returns endpoint + ticket. */
+export async function openConnection(opts: WorkChatApiOptions & {
+  websocketUrl?: string;
+  localIp?: string;
+}): Promise<{ endpoint: string; ticket: string }> {
+  const token = await getAccessToken(opts);
+  const resp = await apiPost<{ code?: number; message?: string; data?: { endpoint?: string; ticket?: string } }>({
+    url: `${normalizeBaseUrl(opts.baseUrl)}/open-apis/v1/connections/open`,
+    token,
+    body: {
+      appKey: opts.appKey,
+      appSecret: opts.appSecret,
+      subscriptions: [
+        { type: "CALLBACK", topic: "AGENT_MESSAGE" },
+        { type: "EVENT", topic: "*" },
+        { type: "SYSTEM", topic: "*" },
+      ],
+      ...(opts.localIp ? { localIp: opts.localIp } : {}),
+    },
+    opts,
+  });
+  const data = unwrapEnvelope(resp);
+  const ticket = data?.ticket ? String(data.ticket) : "";
+  if (!ticket) throw new Error("workchat: ticket missing in connections/open response");
+
+  const endpoint = opts.websocketUrl || data.endpoint || DEFAULT_WS_URL;
+  logger.info(
+    `connection opened endpointSource=${opts.websocketUrl ? "config" : data.endpoint ? "api" : "default"} ticketLen=${ticket.length}`,
+  );
+  return { endpoint, ticket };
+}
+
+// ---------------------------------------------------------------------------
+// Messaging
+// ---------------------------------------------------------------------------
+
+/** POST {base}/open-apis/im/v1/messages — proactive push. */
+export async function sendWorkChatMessage(params: {
+  opts: WorkChatApiOptions;
+  body: import("./types.js").SendMessageReq;
+}): Promise<{ msgId: string }> {
+  const token = await getAccessToken(params.opts);
+  const resp = await apiPost<{ code?: number; message?: string; data?: { msgId?: string } }>({
+    url: `${normalizeBaseUrl(params.opts.baseUrl)}/open-apis/im/v1/messages`,
+    token,
+    body: params.body,
+    opts: params.opts,
+  });
+  const data = unwrapEnvelope(resp);
+  if (!data?.msgId) throw new Error("workchat: msgId missing in send response");
+  return { msgId: String(data.msgId) };
+}
+
+/** POST {base}/open-apis/im/v1/messages/{messageId}/reply — user-triggered reply. */
+export async function sendWorkChatReplyMessage(params: {
+  opts: WorkChatApiOptions;
+  messageId: string;
+  body: import("./types.js").SendMessageReq;
+}): Promise<{ msgId: string }> {
+  const token = await getAccessToken(params.opts);
+  const resp = await apiPost<{ code?: number; message?: string; data?: { msgId?: string } }>({
+    url: `${normalizeBaseUrl(params.opts.baseUrl)}/open-apis/im/v1/messages/${encodeURIComponent(params.messageId)}/reply`,
+    token,
+    body: params.body,
+    opts: params.opts,
+  });
+  const data = unwrapEnvelope(resp);
+  if (!data?.msgId) throw new Error("workchat: msgId missing in reply response");
+  return { msgId: String(data.msgId) };
+}
+
+// ---------------------------------------------------------------------------
+// Agent lifecycle
+// ---------------------------------------------------------------------------
+
+/** POST {base}/open-apis/instance/agent-created/status — ack local agent creation (best-effort). */
+export async function notifyAgentCreatedStatus(opts: WorkChatApiOptions, agentId: string): Promise<void> {
+  try {
+    const token = await getAccessToken(opts);
+    const resp = await apiPost<{ code?: number }>({
+      url: `${normalizeBaseUrl(opts.baseUrl)}/open-apis/instance/agent-created/status`,
+      token,
+      body: { agentId, success: true },
+      opts,
+    });
+    logger.info(`agent-created/status response code=${String(resp?.code ?? "")}`);
+  } catch (err) {
+    logger.error(`agent-created/status failed: ${String(err)}`);
+  }
+}

package/src/api/types.ts

@@ -1,56 +1,56 @@
-/**
- * WorkChat open-platform protocol types.
- *
- * Envelope (WebSocket / HTTP responses):
- *   { code, message, data, errCode?, errMsg? }
- * Frames:
- *   { specVersion, type: CALLBACK|EVENT|SYSTEM, metadata: { topic?, event?, contentType }, data }
- */
-
-/** WorkChat API base URL (prod). */
-export const DEFAULT_BASE_URL = "https://workbrain.cn/backend-api";
-
-/** WebSocket endpoint used when the open-connection API returns none. */
-export const DEFAULT_WS_URL = "wss://workbrain.cn/backend-api/open-apis/connect";
-
-/** msgType codes accepted by /open-apis/im/v1/messages. */
-export const WorkChatMsgType = {
-  Text: "1",
-  Rich: "26",
-} as const;
-
-export const RequestDefaults = {
-  TimeoutMs: 30_000,
-} as const;
-
-/** POST /open-apis/im/v1/messages request. */
-export interface SendMessageReq {
-  agentId: string | number;
-  receiveId: string | number;
-  msgType: string;
-  content: string;
-  conversationId?: string;
-  is_last?: boolean;
-}
-
-/** CALLBACK/AGENT_MESSAGE payload (data field, JSON-decoded). */
-export interface AgentMessagePayload {
-  userId?: string | number;
-  agentId?: string | number;
-  conversationId?: string;
-  msgId?: string | number;
-  message?: string | { content?: string };
-}
-
-/** EVENT/AGENT_CREATED|INIT_AGENT payload. */
-export interface AgentEventPayload {
-  id?: string | number;
-  agentId?: string | number;
-  futureId?: string | number;
-  userId?: string | number;
-  nickName?: string;
-  name?: string;
-  phone?: string;
-  status?: string;
-  introduction?: string;
-}
+/**
+ * WorkChat open-platform protocol types.
+ *
+ * Envelope (WebSocket / HTTP responses):
+ *   { code, message, data, errCode?, errMsg? }
+ * Frames:
+ *   { specVersion, type: CALLBACK|EVENT|SYSTEM, metadata: { topic?, event?, contentType }, data }
+ */
+
+/** WorkChat API base URL (prod). */
+export const DEFAULT_BASE_URL = "https://workbrain.cn/backend-api";
+
+/** WebSocket endpoint used when the open-connection API returns none. */
+export const DEFAULT_WS_URL = "wss://workbrain.cn/backend-api/open-apis/connect";
+
+/** msgType codes accepted by /open-apis/im/v1/messages. */
+export const WorkChatMsgType = {
+  Text: "1",
+  Rich: "26",
+} as const;
+
+export const RequestDefaults = {
+  TimeoutMs: 30_000,
+} as const;
+
+/** POST /open-apis/im/v1/messages request. */
+export interface SendMessageReq {
+  agentId: string | number;
+  receiveId: string | number;
+  msgType: string;
+  content: string;
+  conversationId?: string;
+  is_last?: boolean;
+}
+
+/** CALLBACK/AGENT_MESSAGE payload (data field, JSON-decoded). */
+export interface AgentMessagePayload {
+  userId?: string | number;
+  agentId?: string | number;
+  conversationId?: string;
+  msgId?: string | number;
+  message?: string | { content?: string };
+}
+
+/** EVENT/AGENT_CREATED|INIT_AGENT payload. */
+export interface AgentEventPayload {
+  id?: string | number;
+  agentId?: string | number;
+  futureId?: string | number;
+  userId?: string | number;
+  nickName?: string;
+  name?: string;
+  phone?: string;
+  status?: string;
+  introduction?: string;
+}