@workclaw/openclaw-workclaw 1.0.18 → 1.0.20

package/src/connection/workclaw-client.ts

@@ -1,643 +0,0 @@
-import { Agent, fetch as undiciFetch } from "undici";
-import { getWorkclawLogger } from "../runtime.js";
-
-type WorkClawTokenCache = {
-    token: string;
-    expiresAt: number;
-};
-
-const tokenCache = new Map<string, WorkClawTokenCache>();
-
-export function clearWorkclawTokenCache(cacheKey: string): void {
-    tokenCache.delete(cacheKey);
-}
-
-export function normalizeBaseUrl(value: string | undefined): string {
-    const raw = (value || "https://open.workbrain.cn/open-apis").trim();
-    return raw.endsWith("/") ? raw.slice(0, -1) : raw;
-}
-
-function createWsEndpoint(baseUrl: string): string {
-    const wsBase = baseUrl.replace(/^https?:\/\//i, (match) =>
-        match.toLowerCase() === "https://" ? "wss://" : "ws://",
-    );
-    return `${wsBase}/v1/ws/connect`;
-}
-
-export async function doFetchJson(
-    url: string,
-    init: RequestInit,
-    allowInsecureTls?: boolean,
-    requestTimeout?: number,
-): Promise<any> {
-    const dispatcher = allowInsecureTls
-        ? new Agent({ connect: { rejectUnauthorized: false } })
-        : undefined;
-    const fetcher = allowInsecureTls ? undiciFetch : globalThis.fetch;
-    const controller = new AbortController();
-    const timeoutMs = typeof requestTimeout === "number" && requestTimeout > 0 ? requestTimeout : 30000;
-    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}`;
-        throw new Error(message);
-    }
-    return data;
-}
-
-export type WorkclawConnectionConfig = {
-    baseUrl?: string;
-    websocketUrl?: string;
-    appKey?: string;
-    appSecret?: string;
-    localIp?: string;
-    allowInsecureTls?: boolean;
-    requestTimeout?: number;
-};
-
-async function fetchAccessTokenFromServer(
-    requestUrl: string,
-    config: WorkclawConnectionConfig,
-): Promise<{ token: string; expiresAt: number }> {
-    getWorkclawLogger().info(
-        `Requesting access token url=${requestUrl} appKeyPrefix=${String(config.appKey)}... appSecretLen=${String(config.appSecret)}`,
-    );
-
-    const data = await doFetchJson(
-        requestUrl,
-        {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify({
-                app_key: config.appKey,
-                app_secret: config.appSecret,
-            }),
-        },
-        config.allowInsecureTls,
-        config.requestTimeout,
-    );
-
-    getWorkclawLogger().info(
-        `Access token response code=${String(data?.code ?? "")} errCode=${String(data?.errCode ?? "")} errMsg=${String(data?.errMsg ?? data?.message ?? "")}`,
-    );
-
-    if (data?.code !== 200 || !data?.data?.accessToken) {
-        throw new Error(
-            String(data?.message || data?.errMsg || "Failed to acquire access token"),
-        );
-    }
-
-    const token = String(data.data.accessToken);
-    const expiresIn = Number(data.data.expiresIn || 0);
-    const expiresAt = Date.now() + (expiresIn > 0 ? expiresIn * 1000 : 0);
-
-    getWorkclawLogger().info(
-        `Access token acquired tokenLen=${token.length} expiresInSec=${expiresIn} expiresAt=${new Date(expiresAt).toISOString()}`,
-    );
-
-    return { token, expiresAt };
-}
-
-export async function getWorkclawAccessToken(
-    cacheKey: string,
-    config: WorkclawConnectionConfig,
-): Promise<string> {
-    const startedAt = Date.now();
-    const baseUrl = normalizeBaseUrl(config.baseUrl);
-    const requestUrl = `${baseUrl}/authen/v1/access_token/internal`;
-    const timeoutMs =
-        typeof config.requestTimeout === "number" && config.requestTimeout > 0
-            ? config.requestTimeout
-            : 30000;
-
-    getWorkclawLogger().info(
-        `getWorkclawAccessToken start cacheKey=${cacheKey} requestUrl=${requestUrl} baseUrl=${baseUrl} allowInsecureTls=${Boolean(config.allowInsecureTls)} timeoutMs=${timeoutMs}`,
-    );
-
-    try {
-        const cached = tokenCache.get(cacheKey);
-
-        if (cached && cached.token) {
-            const now = Date.now();
-            const refreshAt = cached.expiresAt - 5 * 60 * 1000;
-            const remainingMs = cached.expiresAt - now;
-            getWorkclawLogger().info(
-                `Token cache found cacheKey=${cacheKey} expiresAt=${new Date(cached.expiresAt).toISOString()} remainingMs=${remainingMs}`,
-            );
-
-            if (now < refreshAt) {
-                getWorkclawLogger().info(
-                    `Using cached token cacheKey=${cacheKey} elapsedMs=${now - startedAt}`,
-                );
-                return cached.token;
-            }
-
-            getWorkclawLogger().info(
-                `Cached token near expiry/expired, refreshing cacheKey=${cacheKey} elapsedMs=${now - startedAt}`,
-            );
-        }
-
-        if (!config.appKey || !config.appSecret) {
-            getWorkclawLogger().error(
-                `Missing appKey/appSecret cacheKey=${cacheKey} appKey=${String(config.appKey || "") ? "present" : "missing"} appSecret=${String(config.appSecret || "") ? "present" : "missing"}`,
-            );
-            throw new Error("Missing appKey/appSecret");
-        }
-
-        const result = await fetchAccessTokenFromServer(requestUrl, config);
-        tokenCache.set(cacheKey, { token: result.token, expiresAt: result.expiresAt });
-        getWorkclawLogger().info(
-            `getWorkclawAccessToken success cacheKey=${cacheKey} elapsedMs=${Date.now() - startedAt}`,
-        );
-        return result.token;
-    } catch (error) {
-        getWorkclawLogger().error(
-            `getWorkclawAccessToken failed cacheKey=${cacheKey} requestUrl=${requestUrl} baseUrl=${baseUrl} elapsedMs=${Date.now() - startedAt} error=${String(error)}`,
-        );
-        throw error;
-    }
-}
-
-export async function openWorkclawConnection(
-    cacheKey: string,
-    config: WorkclawConnectionConfig,
-): Promise<{ endpoint: string; ticket: string }> {
-    const startedAt = Date.now();
-    const baseUrl = normalizeBaseUrl(config.baseUrl);
-    const requestUrl = `${baseUrl}/open-apis/v1/connections/open`;
-    const timeoutMs =
-        typeof config.requestTimeout === "number" && config.requestTimeout > 0
-            ? config.requestTimeout
-            : 30000;
-
-    const appKeyRaw = String(config.appKey ?? "");
-    const appSecretRaw = String(config.appSecret ?? "");
-
-    getWorkclawLogger().info(
-        `openWorkclawConnection start cacheKey=${cacheKey} baseUrl=${baseUrl} requestUrl=${requestUrl} allowInsecureTls=${Boolean(config.allowInsecureTls)} timeoutMs=${timeoutMs} localIp=${String(config.localIp ?? "")} websocketUrl=${String(config.websocketUrl ?? "")} appKeyPrefix=${appKeyRaw ? `${appKeyRaw.slice(0, 8)}...` : "missing"} appSecretLen=${appSecretRaw.length}`,
-    );
-
-    const tokenStartedAt = Date.now();
-    const token = await getWorkclawAccessToken(cacheKey, config);
-    getWorkclawLogger().info(
-        `openWorkclawConnection got access token cacheKey=${cacheKey} tokenLen=${token.length} elapsedMs=${Date.now() - tokenStartedAt}`,
-    );
-
-    const payload = {
-        appKey: config.appKey,
-        appSecret: config.appSecret,
-        subscriptions: [
-            { type: "CALLBACK", topic: "AGENT_MESSAGE" },
-            { type: "EVENT", topic: "*" },
-            { type: "SYSTEM", topic: "*" },
-        ],
-        ...(config.localIp ? { localIp: config.localIp } : {}),
-    };
-
-    getWorkclawLogger().info(
-        `Opening connection url=${requestUrl} cacheKey=${cacheKey} subscriptions=${payload.subscriptions.length}`,
-    );
-
-    const data = await doFetchJson(
-        requestUrl,
-        {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-        },
-        config.allowInsecureTls,
-        config.requestTimeout,
-    );
-
-    getWorkclawLogger().info(
-        `Open connection response code=${String(data?.code ?? "")} errCode=${String(data?.errCode ?? "")} errMsg=${String(data?.errMsg ?? data?.message ?? "")} hasTicket=${Boolean(data?.data?.ticket)} hasEndpoint=${Boolean(data?.data?.endpoint)}`,
-    );
-
-    if (data?.code !== 200 || !data?.data?.ticket) {
-        throw new Error(String(data?.message || data?.errMsg || "Failed to open connection"));
-    }
-
-    const ticket = String(data.data.ticket);
-
-    let endpointSource: "config" | "api" | "derived" = "derived";
-
-    // 优先使用配置中的 websocketUrl，其次使用 API 返回的 endpoint，最后使用默认构建的 endpoint
-    const endpoint = config.websocketUrl
-        ? ((endpointSource = "config"), String(config.websocketUrl))
-        : data?.data?.endpoint
-            ? ((endpointSource = "api"), String(data.data.endpoint))
-            : ((endpointSource = "derived"), createWsEndpoint(baseUrl));
-
-    getWorkclawLogger().info(
-        `openWorkclawConnection success cacheKey=${cacheKey} endpoint=${endpoint} endpointSource=${endpointSource} ticketLen=${ticket.length} elapsedMs=${Date.now() - startedAt}`,
-    );
-
-    return { endpoint, ticket };
-}
-
-export interface AgentInstance {
-    id: string;
-    createTime: string;
-    updateTime: string;
-    futureId: string;
-    phone: string;
-    nickName: string;
-    imageId: string;
-    level: number;
-    identity: string;
-    type: string;
-    name: string;
-    gender: string;
-    age: number | null;
-    tcId: string | null;
-    city: string | null;
-    loginType: string | null;
-    status: string;
-    publicScope: string;
-    ip: string | null;
-    phoneName: string | null;
-    tip: string | null;
-    email: string | null;
-    featureId: string | null;
-    job: string | null;
-    newUser: boolean;
-    imageKnBase: string | null;
-    recommend: string | null;
-    comment: string | null;
-    treeKnbase: string | null;
-    preferredLanguage: string;
-    timezone: string;
-    introduction: string;
-    backgroundId: string;
-    voiceId: string;
-    characterSettings: string | null;
-    personFeatures: string | null;
-    learningFeatures: string | null;
-    workFeatures: string | null;
-    socializeFeatures: string | null;
-    useKnowledge: boolean;
-    roomOnlyKnowledge: boolean;
-    roomWebSearch: boolean;
-    abilityId: string | null;
-    baiduCensoringStrategy: string | null;
-    knowledgeCheckStrategy: string | null;
-    interestTags: string | null;
-    temporaryId: string | null;
-    treeBatchNo: string | null;
-    allowJoinSpace: boolean;
-    modelId: string;
-    orgId: string | null;
-    qrCodeUrl: string | null;
-    locationPoint: {
-        x: number;
-        y: number;
-    } | null;
-    hot: string;
-    score: number;
-    professionalUser: string | null;
-    autoCreateFace: boolean;
-    liveId: string | null;
-    liveStartTime: string | null;
-    isIpAgent: number;
-    isAdopted: number;
-}
-
-/**
- * 获取智能体列表
- * POST /open-apis/instance/list
- */
-export async function getAgentInstances(
-    cacheKey: string,
-    config: WorkclawConnectionConfig
-): Promise<AgentInstance[]> {
-    const baseUrl = normalizeBaseUrl(config.baseUrl);
-    const token = await getWorkclawAccessToken(cacheKey, config);
-
-    const payload = {
-        appKey: config.appKey,
-    };
-
-    getWorkclawLogger().info(`Getting agent instances from ${baseUrl}/open-apis/instance/list`);
-    getWorkclawLogger().info(`Payload:`, JSON.stringify(payload, null, 2));
-
-    const data = await doFetchJson(
-        `${baseUrl}/open-apis/instance/list`,
-        {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-        },
-        config.allowInsecureTls,
-        config.requestTimeout,
-    );
-    getWorkclawLogger().info(`Agent instances response:`, JSON.stringify(data, null, 2));
-
-    if (data?.code !== 200 || !Array.isArray(data?.data)) {
-        throw new Error(data?.message || "Failed to get agent instances");
-    }
-
-    return data.data as AgentInstance[];
-}
-
-export type WorkClawMessageParams = {
-    cacheKey: string;
-    config: WorkclawConnectionConfig;
-    agentId: string | number;
-    receiveId: string | number;
-    msgType: string;
-    content: string;
-    openConversationId?: string;
-    replayMsgId?: string;
-    endpoint?: string;
-    last?: boolean;
-};
-
-/**
- * 发送主动消息（非回复）
- * POST /im/v1/messages
- */
-export async function sendWorkclawMessage(params: WorkClawMessageParams): Promise<string> {
-    const baseUrl = normalizeBaseUrl(params.config.baseUrl);
-    const token = await getWorkclawAccessToken(params.cacheKey, params.config);
-
-    // 主动消息参数
-    const payload: any = {
-        agentId: params.agentId,
-        receiveId: params.receiveId,
-        msgType: params.msgType,
-        content: params.content,
-    };
-
-    // 添加 last 字段（仅当为 true 时）
-    if (params.last === true) {
-        payload.is_last = true;
-    }
-
-    // openConversationId 非必填，API 字段名为 conversationId
-    if (params.openConversationId) {
-        payload.conversationId = params.openConversationId;
-    }
-
-    const endpoint = params.endpoint || "/open-apis/im/v1/messages";
-    getWorkclawLogger().info(`Sending proactive message to ${baseUrl}${endpoint}`);
-    getWorkclawLogger().info(`Payload:`, JSON.stringify(payload, null, 2));
-
-    const data = await doFetchJson(
-        `${baseUrl}${endpoint}`,
-        {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-        },
-        params.config.allowInsecureTls,
-        params.config.requestTimeout,
-    );
-    getWorkclawLogger().info(`Send message response:`, JSON.stringify(data, null, 2));
-
-    if (data?.code !== 200 || !data?.data?.msgId) {
-        throw new Error(data?.message || "Failed to send message");
-    }
-    return String(data.data.msgId);
-}
-
-/**
- * 发送回复消息
- * POST /im/v1/messages/{messageId}/reply
- */
-export async function sendWorkclawReplyMessage(params: WorkClawMessageParams & { messageId: string }): Promise<string> {
-    const baseUrl = normalizeBaseUrl(params.config.baseUrl);
-    const token = await getWorkclawAccessToken(params.cacheKey, params.config);
-
-    // 回复消息参数
-    // 注意：虽然 API 文档说不需要 openConversationId，但为了保险起见还是会传递
-    const payload: any = {
-        agentId: params.agentId,
-        receiveId: params.receiveId,
-        msgType: params.msgType,
-        content: params.content,
-    };
-
-    getWorkclawLogger().info(`Reply payload is last : ${params.last} `);
-
-    // 添加 last 字段（仅当为 true 时）
-    if (params.last === true) {
-        payload.is_last = true;
-    }
-
-    // 如果提供了 openConversationId，也添加到 payload 中（以防 API 需要）
-    if (params.openConversationId) {
-        payload.conversationId = params.openConversationId;
-        getWorkclawLogger().info(`Reply payload includes conversationId: ${params.openConversationId}`);
-    } else {
-        getWorkclawLogger().info(`Reply payload does NOT include conversationId (openConversationId is empty)`);
-    }
-
-    const endpoint = params.endpoint || `/open-apis/im/v1/messages/${params.messageId}/reply`;
-    getWorkclawLogger().info(`Sending reply message to ${baseUrl}${endpoint}`);
-    getWorkclawLogger().info(`Reply Payload:`, JSON.stringify(payload, null, 2));
-
-    const data = await doFetchJson(
-        `${baseUrl}${endpoint}`,
-        {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-        },
-        params.config.allowInsecureTls,
-        params.config.requestTimeout,
-    );
-    getWorkclawLogger().info(`Send reply response:`, JSON.stringify(data, null, 2));
-
-    if (data?.code !== 200 || !data?.data?.msgId) {
-        throw new Error(data?.message || "Failed to send reply");
-    }
-    return String(data.data.msgId);
-}
-
-export function resolveWorkclawMessage(
-    text: string,
-    mediaUrl?: string,
-): { msgType: string; content: string } {
-    if (!mediaUrl || text.trim()) {
-        return { msgType: "text", content: text };
-    }
-    const url = mediaUrl.trim();
-    const lower = url.toLowerCase();
-    const isAudio =
-        lower.endsWith(".mp3") ||
-        lower.endsWith(".wav") ||
-        lower.endsWith(".aac") ||
-        lower.endsWith(".m4a") ||
-        lower.endsWith(".ogg");
-    const payload = JSON.stringify({ url });
-    return { msgType: isAudio ? "audio" : "image", content: payload };
-}
-
-
-export interface CronJobPayload {
-    messageId: number | string;
-    planId?: number | string;
-    clawJobId: string;
-    name: string;
-    kind: string; // 'at' | 'every' | 'cron'
-    expr: string;
-    message?: string;
-}
-
-/**
- * 同步 openclaw 创建的定时任务至后端
- * POST /cron/job/add
- */
-export async function syncWorkclawCronJobToBackend(
-    cacheKey: string,
-    config: WorkclawConnectionConfig,
-    payload: CronJobPayload
-): Promise<any> {
-    const baseUrl = normalizeBaseUrl(config.baseUrl);
-    const token = await getWorkclawAccessToken(cacheKey, config);
-
-    // 尝试添加 /open-apis 前缀，以匹配其他 API 的模式 (如 getAgentInstances)
-    const requestUrl = `${baseUrl}/open-apis/cron/job/add`;
-    getWorkclawLogger().info(`Syncing cron job to ${requestUrl}`);
-    getWorkclawLogger().info(`Payload:`, JSON.stringify(payload, null, 2));
-
-    const data = await doFetchJson(
-        requestUrl,
-        {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-        },
-        config.allowInsecureTls,
-        config.requestTimeout,
-    );
-    getWorkclawLogger().info(`Sync cron job response:`, JSON.stringify(data, null, 2));
-
-    if (data?.code !== 200 && data?.code !== 0) {
-        throw new Error(data?.message || data?.msg || "Failed to sync cron job");
-    }
-    return data;
-}
-
-/**
- * 获取AppKey所对应的模型配置
- * POST /open-apis/instance/apiKey/{appKey}
- */
-export async function getWorkclawModelConfigByAppKey(
-    cacheKey: string,
-    config: WorkclawConnectionConfig
-): Promise<{
-    baseUrl: string;
-    apiKey: string;
-}> {
-    const baseUrl = normalizeBaseUrl(config.baseUrl);
-    const token = await getWorkclawAccessToken(cacheKey, config);
-    const appKey = config.appKey;
-
-    if (!appKey) {
-        throw new Error("Missing appKey for getModelKeyByAppKey");
-    }
-
-    const requestUrl = `${baseUrl}/open-apis/instance/apiKey/${appKey}`;
-    getWorkclawLogger().info(`Getting model key from ${requestUrl}`);
-
-    const data = await doFetchJson(
-        requestUrl,
-        {
-            method: "GET",
-            headers: {
-                "Content-Type": "x-www-form-urlencoded",
-                "Authorization": `Bearer ${token}`,
-            }
-        },
-        config.allowInsecureTls,
-        config.requestTimeout,
-    );
-
-    getWorkclawLogger().info(`Model key response:`, JSON.stringify(data, null, 2));
-
-    if (data?.code !== 200 || !data?.data) {
-        throw new Error(data?.message || data?.msg || "Failed to get model key");
-    }
-
-    return data.data
-}
-
-export interface CronJobMessagePayload {
-    clawJobId: string;
-    message: string;
-}
-
-/**
- * 此时定时任务触发消息至后端
- * POST /open-apis/cron/job/message
- */
-export async function sendWorkclawCronJobMessageToBackend(
-    cacheKey: string,
-    config: WorkclawConnectionConfig,
-    payload: CronJobMessagePayload
-): Promise<any> {
-    const baseUrl = normalizeBaseUrl(config.baseUrl);
-    const token = await getWorkclawAccessToken(cacheKey, config);
-
-    const requestUrl = `${baseUrl}/open-apis/cron/job/message`;
-    getWorkclawLogger().info(`Sending cron job message to ${requestUrl}`);
-    getWorkclawLogger().info(`Payload:`, JSON.stringify(payload, null, 2));
-
-    const data = await doFetchJson(
-        requestUrl,
-        {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-        },
-        config.allowInsecureTls,
-        config.requestTimeout,
-    );
-    getWorkclawLogger().info(`Send cron job message response:`, JSON.stringify(data, null, 2));
-
-    if (data?.code !== 200 && data?.code !== 0) {
-        throw new Error(data?.message || data?.msg || "Failed to send cron job message");
-    }
-    return data;
-}