@workclaw/openclaw-workclaw 1.0.0

package/src/outbound/index.ts

@@ -0,0 +1,183 @@
+import type { OpenClawConfig } from 'openclaw/plugin-sdk'
+import type { OpenclawWorkclawConfig, OpenclawWorkclawSendResult } from '../types.js'
+import { resolveAccountByUserIdAndAgentId, resolveOpenclawWorkclawAccount } from '../accounts.js'
+
+import { isLocalMediaSource, resolveLocalPath, uploadLocalMedia } from '../media/upload.js'
+import { getOpenclawWorkclawLogger } from '../runtime.js'
+import {
+  sendOpenclawWorkclawOutboundMessage,
+} from './workclaw-sender.js'
+
+/**
+ * 根据 target (userId) 和可选的 agentId 查找匹配的账户
+ * 如果同时提供 userId 和 agentId，走 O(1) 查找
+ * 否则遍历所有账户，查找 userId 等于 target 的账户
+ */
+function findAccountIdByTarget(
+  cfg: OpenClawConfig,
+  target: string,
+  agentId?: string | number,
+): string | undefined {
+  // O(1) 查找：userId + agentId 唯一确定一个账户
+  if (agentId !== undefined && agentId !== null) {
+    return resolveAccountByUserIdAndAgentId(cfg, target, String(agentId)) ?? undefined
+  }
+
+  // 遍历：只有 userId 时，无法唯一确定账户（一个 userId 对应多个 agentId）
+  // 需要通过 bindings 或其他方式 resolve，这里暂不支持
+  return undefined
+}
+
+export interface SendOpenclawWorkclawMessageParams {
+  cfg: OpenClawConfig
+  to: string
+  text: string
+  mediaUrl?: string
+  replyToMessageId?: string
+  accountId?: string
+  openConversationId?: string
+  agentId?: string | number
+  /**
+   * 消息类型：
+   * - "reply": 回复消息（用户触发）
+   * - "push": 主动推送（定时任务触发）
+   */
+  messageType?: 'reply' | 'push'
+  msgType?: string
+  last?: boolean
+}
+
+async function resolveMediaUrl(
+  mediaUrl: string | undefined,
+  config: OpenclawWorkclawConfig,
+): Promise<string | undefined> {
+  if (!mediaUrl)
+    return undefined
+  if (!isLocalMediaSource(mediaUrl))
+    return mediaUrl
+
+  const uploadUrl = config.uploadUrl
+  if (!uploadUrl) {
+    throw new Error('uploadUrl not configured for local mediaUrl')
+  }
+
+  const filePath = resolveLocalPath(mediaUrl)
+
+  if (typeof config.mediaMaxMb === 'number' && config.mediaMaxMb > 0) {
+    const { stat } = await import('node:fs/promises')
+    const stats = await stat(filePath)
+    const maxBytes = config.mediaMaxMb * 1024 * 1024
+    if (stats.size > maxBytes) {
+      throw new Error(`mediaUrl exceeds limit (${config.mediaMaxMb} MB)`)
+    }
+  }
+
+  return uploadLocalMedia({
+    uploadUrl,
+    filePath,
+    uploadFieldName: config.uploadFieldName,
+    uploadHeaders: config.uploadHeaders as Record<string, string> | undefined,
+    uploadFormFields: config.uploadFormFields as
+    | Record<string, string | number | boolean>
+    | undefined,
+    uploadResponseUrlPath: config.uploadResponseUrlPath,
+    requestTimeout: config.requestTimeout ?? 30000,
+    allowInsecureTls: config.allowInsecureTls,
+  })
+}
+
+export async function sendMessageOpenclawWorkclaw(
+  params: SendOpenclawWorkclawMessageParams,
+): Promise<OpenclawWorkclawSendResult> {
+  const { cfg, to, text, mediaUrl, replyToMessageId, accountId, openConversationId, agentId, messageType, msgType, last }
+    = params
+
+  // 如果没有指定 messageType，根据是否有 replyToMessageId 来判断
+  // - 有 replyToMessageId: 回复消息
+  // - 没有 replyToMessageId: 主动推送
+  const resolvedMessageType = messageType ?? (replyToMessageId ? 'reply' : 'push')
+
+  // 如果没有指定 accountId，尝试根据 target (to) 和 agentId 查找匹配的账户
+  let resolvedAccountId = accountId
+  if (!resolvedAccountId) {
+    const foundAccountId = findAccountIdByTarget(cfg, to, agentId)
+    if (foundAccountId) {
+      resolvedAccountId = foundAccountId
+    }
+  }
+
+  if (!resolvedAccountId) {
+    throw new Error('无法确定账户ID')
+  }
+
+  const account = resolveOpenclawWorkclawAccount({ cfg, accountId: resolvedAccountId })
+  if (!account.configured) {
+    throw new Error(`OpenclawWorkclaw account "${account.accountId}" not configured`)
+  }
+
+  const resolvedMediaUrl = await resolveMediaUrl(mediaUrl, account.config)
+
+  // 优先使用传入的 openConversationId，其次从 cfg 中直接读取（绕过 account.config 快照问题）
+  // 这样可以获取到运行时动态保存的 openConversationId
+  interface ChannelWithAccounts { accounts?: Record<string, any>, openConversationId?: string }
+  const cfgChannel = (cfg.channels?.['openclaw-workclaw'] as unknown as ChannelWithAccounts) ?? {}
+  const cfgAccounts = cfgChannel.accounts ?? {}
+  const cfgAccount = cfgAccounts[resolvedAccountId] ?? {}
+  const cfgOpenConversationId = cfgAccount?.openConversationId ?? cfgChannel?.openConversationId
+  const effectiveOpenConversationId = openConversationId ?? cfgOpenConversationId
+  getOpenclawWorkclawLogger().info(`sendMessageOpenclawWorkclaw - resolvedAccountId: ${resolvedAccountId}, openConversationId param: ${openConversationId}, cfgOpenConversationId: ${cfgOpenConversationId}, effectiveOpenConversationId: ${effectiveOpenConversationId}, messageType: ${resolvedMessageType}, replyToMessageId: ${replyToMessageId}`)
+
+  // 使用 appKey 作为缓存键，让所有账户共享同一个 token
+  const tokenCacheKey = account.config.appKey || account.accountId
+  const result = await sendOpenclawWorkclawOutboundMessage({
+    cacheKey: tokenCacheKey,
+    to,
+    text,
+    msgType,
+    mediaUrl: resolvedMediaUrl,
+    replyToMessageId,
+    openConversationId: effectiveOpenConversationId,
+    agentId,
+    config: account.config,
+    messageType: resolvedMessageType,
+    last,
+  })
+  return {
+    messageId: result.messageId,
+    chatId: to,
+  }
+}
+
+export async function getMessageOpenclawWorkclaw(_params: {
+  cfg: OpenClawConfig
+  messageId: string
+  accountId?: string
+}): Promise<null> {
+  return null
+}
+
+/**
+ * 发送主动推送消息（定时任务使用）
+ * 使用 pushEndpoint 配置的端口
+ */
+export async function sendPushMessageOpenclawWorkclaw(
+  params: Omit<SendOpenclawWorkclawMessageParams, 'messageType'>,
+): Promise<OpenclawWorkclawSendResult> {
+  return sendMessageOpenclawWorkclaw({
+    ...params,
+    messageType: 'push',
+  })
+}
+
+/**
+ * 发送回复消息（用户触发）
+ * 使用 replyEndpoint 配置的端口
+ */
+export async function sendReplyMessageOpenclawWorkclaw(
+  params: Omit<SendOpenclawWorkclawMessageParams, 'messageType'>,
+): Promise<OpenclawWorkclawSendResult> {
+  return sendMessageOpenclawWorkclaw({
+    ...params,
+    messageType: 'reply',
+  })
+}

package/src/outbound/workclaw-sender.ts

@@ -0,0 +1,157 @@
+import type { OpenclawWorkclawConnectionConfig } from '../connection/workclaw-client.js'
+import type { OpenclawWorkclawFullAccountConfig } from '../types.js'
+import {
+  resolveOpenclawWorkclawMessage,
+  sendOpenclawWorkclawMessage,
+  sendOpenclawWorkclawReplyMessage as sendWorkclawReplyToMessage,
+
+} from '../connection/workclaw-client.js'
+import { getOpenclawWorkclawLogger } from '../runtime.js'
+
+export interface WorkClawSenderParams {
+  cacheKey: string
+  to: string
+  text: string
+  mediaUrl?: string
+  replyToMessageId?: string
+  openConversationId?: string
+  agentId?: string | number
+  config: OpenclawWorkclawFullAccountConfig
+  /**
+   * 消息类型：
+   * - "reply": 回复消息（用户触发）
+   * - "push": 主动推送（定时任务触发）
+   */
+  messageType?: 'reply' | 'push'
+  msgType?: string
+  last?: boolean
+}
+
+export async function sendOpenclawWorkclawOutboundMessage(
+  params: WorkClawSenderParams,
+): Promise<{ messageId: string }> {
+  const {
+    cacheKey,
+    to,
+    mediaUrl,
+    replyToMessageId,
+    openConversationId,
+    agentId,
+    config,
+    messageType = 'reply',
+    last,
+  } = params
+
+  let msgType = params.msgType
+  let content = params.text
+
+  // 优先级: 传入参数 > 配置
+  const resolvedAgentId = agentId ?? config.agentId
+
+  if (resolvedAgentId === undefined || resolvedAgentId === null || String(resolvedAgentId).trim() === '') {
+    throw new Error(
+      'agentId is required for sending messages. '
+      + 'Please create an account via cloud platform command or configure accounts in openclaw.json',
+    )
+  }
+
+  if (!msgType) {
+    ({ msgType, content } = resolveOpenclawWorkclawMessage(content, mediaUrl))
+  }
+
+  // msgType 转换为 "1"（文本）或其他类型码
+  const messageTypeCode = msgType === 'text' ? '1' : msgType
+
+  // 构建 OpenclawWorkclawConnectionConfig（短名格式，用于 connection 模块）
+  const workclawConfig: OpenclawWorkclawConnectionConfig = {
+    baseUrl: config.baseUrl ?? '',
+    appKey: config.appKey ?? '',
+    appSecret: config.appSecret ?? '',
+    localIp: config.localIp,
+    allowInsecureTls: config.allowInsecureTls,
+    requestTimeout: config.requestTimeout,
+  }
+
+  // 解析 userId 作为 receiveId（优先使用配置中保存的原始 userId）
+  // 配置中的 userId 是原始值（可能为负数），to 是绝对值（OpenClaw 要求）
+  const receiveId = config.userId ?? to
+
+  // 从配置中读取 endpoint，支持自定义
+  const replyEndpoint = config.replyEndpoint || '/open-apis/im/v1/messages/{messageId}/reply'
+  const pushEndpoint = config.pushEndpoint || '/open-apis/im/v1/messages'
+
+  if (messageType === 'reply') {
+    // 回复消息需要 replyToMessageId
+    if (!replyToMessageId) {
+      throw new Error('replyToMessageId is required for reply message')
+    }
+
+    // 优先使用传入的 openConversationId，其次使用配置中持久化的
+    const resolvedOpenConversationId = openConversationId ?? config.openConversationId
+    getOpenclawWorkclawLogger().info(`Sending reply message to messageId: ${replyToMessageId}, openConversationId: ${resolvedOpenConversationId}`)
+
+    const msgId = await sendWorkclawReplyToMessage({
+      cacheKey,
+      config: workclawConfig,
+      agentId: resolvedAgentId,
+      receiveId,
+      msgType: messageTypeCode,
+      content,
+      messageId: replyToMessageId,
+      openConversationId: resolvedOpenConversationId,
+      endpoint: replyEndpoint.replace('{messageId}', String(replyToMessageId)),
+      last,
+    })
+
+    return { messageId: msgId }
+  }
+  else {
+    // 主动推送消息
+    getOpenclawWorkclawLogger().info(` Sending proactive message`)
+
+    // 优先使用传入的 openConversationId，其次使用配置中持久化的
+    const resolvedOpenConversationId = openConversationId ?? config.openConversationId
+    getOpenclawWorkclawLogger().info(` Resolved openConversationId: ${resolvedOpenConversationId}`)
+    getOpenclawWorkclawLogger().info(` Config openConversationId: ${config.openConversationId}`)
+
+    const msgId = await sendOpenclawWorkclawMessage({
+      cacheKey,
+      config: workclawConfig,
+      agentId: resolvedAgentId,
+      receiveId,
+      msgType: messageTypeCode,
+      content,
+      openConversationId: resolvedOpenConversationId,
+      endpoint: pushEndpoint,
+      last,
+    })
+
+    return { messageId: msgId }
+  }
+}
+
+/**
+ * 发送主动推送消息（定时任务使用）
+ * POST /im/v1/messages
+ */
+export async function sendWorkClawPushMessage(
+  params: Omit<WorkClawSenderParams, 'messageType'>,
+): Promise<{ messageId: string }> {
+  return sendOpenclawWorkclawOutboundMessage({
+    ...params,
+    messageType: 'push',
+  })
+}
+
+/**
+ * 发送回复消息（用户触发）
+ * POST /im/v1/messages/{messageId}/reply
+ */
+export async function sendOpenclawWorkclawReplyMessage(
+  params: Omit<WorkClawSenderParams, 'messageType'>,
+): Promise<{ messageId: string }> {
+  return sendOpenclawWorkclawOutboundMessage({
+    ...params,
+    messageType: 'reply',
+  })
+}