@workclaw/openclaw-workclaw 1.0.201 → 1.0.202

package/src/setup-api.ts

@@ -0,0 +1,3 @@
+export { workclawPlugin } from './channel.js'
+export * from './setup-core.js'
+export * from './setup-surface.js'

package/src/setup-core.ts

@@ -0,0 +1,25 @@
+import type { ChannelSetupAdapter, OpenClawConfig } from 'openclaw/plugin-sdk/setup'
+import {
+
+  DEFAULT_ACCOUNT_ID,
+
+} from 'openclaw/plugin-sdk/setup'
+import { resolveDefaultWorkclawAccountId } from './accounts.js'
+import { patchWorkclawConfig } from './setup-surface.js'
+
+export function setWorkclawNamedAccountEnabled(
+  cfg: OpenClawConfig,
+  accountId: string,
+  enabled: boolean,
+): OpenClawConfig {
+  return patchWorkclawConfig(cfg, accountId, { enabled })
+}
+
+export const workclawSetupAdapter: ChannelSetupAdapter = {
+  resolveAccountId: ({ cfg, accountId }) =>
+    accountId?.trim() || resolveDefaultWorkclawAccountId(cfg),
+  applyAccountConfig: ({ cfg, accountId }) => {
+    const isDefault = !accountId || accountId === DEFAULT_ACCOUNT_ID
+    return patchWorkclawConfig(cfg, isDefault ? DEFAULT_ACCOUNT_ID : accountId, { enabled: true })
+  },
+}

package/src/setup-surface.ts

@@ -0,0 +1,499 @@
+import type { ChannelSetupWizard, OpenClawConfig } from 'openclaw/plugin-sdk/setup'
+import type { WorkclawConfig } from './types.js'
+import {
+
+  DEFAULT_ACCOUNT_ID,
+  formatDocsLink,
+
+  patchTopLevelChannelConfigSection,
+} from 'openclaw/plugin-sdk/setup'
+import { inspectWorkclawCredentials, resolveDefaultWorkclawAccountId } from './accounts.js'
+import { doFetchJson } from './connection/workclaw-client.js'
+
+const channel = 'openclaw-workclaw' as const
+
+/**
+ * 规范化字符串值
+ */
+function normalizeString(value: unknown): string | undefined {
+  if (typeof value !== 'string') {
+    return undefined
+  }
+  const trimmed = value.trim()
+  return trimmed || undefined
+}
+
+function trimTrailingSlash(value: string): string {
+  return value.endsWith('/') ? value.slice(0, -1) : value
+}
+
+function resolveSetupApiBases(cfg: OpenClawConfig): {
+  authBaseUrl: string
+  openApiBaseUrl: string
+  allowInsecureTls?: boolean
+  requestTimeout?: number
+} {
+  const workclawCfg = cfg.channels?.['openclaw-workclaw'] as WorkclawConfig | undefined
+  const configuredBaseUrl
+    = normalizeString(workclawCfg?.baseUrl)
+      ?? normalizeString(process.env.WORKCLAW_BASE_URL)
+  const configuredAuthBaseUrl = normalizeString(process.env.WORKCLAW_AUTH_BASE_URL)
+  const configuredOpenApiBaseUrl = normalizeString(process.env.WORKCLAW_OPEN_API_BASE_URL)
+
+  const defaultAuthBaseUrl = 'https://workbrain.cn/backend-api'
+  const defaultOpenApiBaseUrl = `${defaultAuthBaseUrl}/open-apis`
+
+  const fromBaseUrl = (() => {
+    if (!configuredBaseUrl) {
+      return null
+    }
+
+    const normalized = trimTrailingSlash(configuredBaseUrl)
+    if (normalized.endsWith('/open-apis')) {
+      return {
+        authBaseUrl: normalized.slice(0, -'/open-apis'.length),
+        openApiBaseUrl: normalized,
+      }
+    }
+
+    return {
+      authBaseUrl: normalized,
+      openApiBaseUrl: `${normalized}/open-apis`,
+    }
+  })()
+
+  return {
+    authBaseUrl: trimTrailingSlash(
+      configuredAuthBaseUrl ?? fromBaseUrl?.authBaseUrl ?? defaultAuthBaseUrl,
+    ),
+    openApiBaseUrl: trimTrailingSlash(
+      configuredOpenApiBaseUrl ?? fromBaseUrl?.openApiBaseUrl ?? defaultOpenApiBaseUrl,
+    ),
+    allowInsecureTls: workclawCfg?.allowInsecureTls,
+    requestTimeout: workclawCfg?.requestTimeout,
+  }
+}
+
+/**
+ * 检查 Workclaw 是否已配置
+ */
+function isWorkclawConfigured(cfg: OpenClawConfig): boolean {
+  const workclawCfg = cfg.channels?.['openclaw-workclaw'] as WorkclawConfig | undefined
+
+  // 检查字符串值是否已配置
+  const isConfigured = (value: unknown): boolean => {
+    const asString = normalizeString(value)
+    return !!asString
+  }
+
+  const topLevelConfigured
+    = isConfigured(workclawCfg?.appKey)
+      && isConfigured(workclawCfg?.appSecret)
+
+  const accountConfigured = Object.values(workclawCfg?.accounts ?? {}).some((account) => {
+    if (!account || typeof account !== 'object') {
+      return false
+    }
+    const hasOwnAppKey = Object.prototype.hasOwnProperty.call(account, 'appKey')
+    const hasOwnAppSecret = Object.prototype.hasOwnProperty.call(account, 'appSecret')
+    const accountAppKeyConfigured = hasOwnAppKey
+      ? isConfigured((account as Record<string, unknown>).appKey)
+      : isConfigured(workclawCfg?.appKey)
+    const accountSecretConfigured = hasOwnAppSecret
+      ? isConfigured((account as Record<string, unknown>).appSecret)
+      : isConfigured(workclawCfg?.appSecret)
+    return accountAppKeyConfigured && accountSecretConfigured
+  })
+
+  return topLevelConfigured || accountConfigured
+}
+
+/**
+ * 修补 Workclaw 配置
+ */
+export function patchWorkclawConfig(
+  cfg: OpenClawConfig,
+  accountId: string,
+  patch: Record<string, unknown>,
+): OpenClawConfig {
+  const workclawCfg = cfg.channels?.['openclaw-workclaw'] as WorkclawConfig | undefined
+  if (accountId === DEFAULT_ACCOUNT_ID) {
+    return patchTopLevelChannelConfigSection({
+      cfg,
+      channel,
+      enabled: true,
+      patch,
+    })
+  }
+  const nextAccountPatch = {
+    ...(workclawCfg?.accounts?.[accountId] as Record<string, unknown> | undefined),
+    enabled: true,
+    ...patch,
+  }
+  return patchTopLevelChannelConfigSection({
+    cfg,
+    channel,
+    enabled: true,
+    patch: {
+      accounts: {
+        ...workclawCfg?.accounts,
+        [accountId]: nextAccountPatch,
+      },
+    },
+  })
+}
+
+type WizardPrompter = Parameters<NonNullable<ChannelSetupWizard['finalize']>>[0]['prompter']
+
+/**
+ * 提示凭证帮助信息
+ */
+async function noteWorkclawCredentialHelp(prompter: WizardPrompter): Promise<void> {
+  await prompter.note(
+    [
+      '智小途插件安装引导',
+      '',
+      '准备事项:',
+      '1. 访问 workbrain.cn 获取 App Key 和 App Secret',
+      '2. 确保您的账号已开通智小途服务',
+      '3. 准备好您的手机号（用于获取配置信息）',
+      '',
+      `文档: ${formatDocsLink('/channels/openclaw-workclaw', '智小途')}`,
+    ].join('\n'),
+    '智小途配置',
+  )
+}
+
+/**
+ * 提示 App Key 输入
+ */
+async function promptWorkclawAppKey(params: {
+  prompter: WizardPrompter
+  initialValue?: string
+}): Promise<string> {
+  return (
+    await params.prompter.text({
+      message: '智小途 App Key',
+      initialValue: params.initialValue,
+      validate: value => (value?.trim() ? undefined : 'App Key 不能为空'),
+    })
+  ).trim()
+}
+
+/**
+ * 提示 App Secret 输入
+ */
+async function promptWorkclawAppSecret(params: {
+  prompter: WizardPrompter
+  initialValue?: string
+}): Promise<string> {
+  return (
+    await params.prompter.text({
+      message: '智小途 App Secret',
+      initialValue: params.initialValue,
+      validate: value => (value?.trim() ? undefined : 'App Secret 不能为空'),
+    })
+  ).trim()
+}
+
+/**
+ * 提示手机号输入
+ */
+async function promptWorkclawPhone(params: {
+  prompter: WizardPrompter
+  initialValue?: string
+}): Promise<string> {
+  return (
+    await params.prompter.text({
+      message: '智小途手机号',
+      initialValue: params.initialValue,
+      validate: (value) => {
+        if (!value?.trim())
+          return '手机号不能为空'
+        if (!/^1[3-9]\d{9}$/.test(value.trim()))
+          return '请输入正确的手机号格式'
+        return undefined
+      },
+    })
+  ).trim()
+}
+
+/**
+ * 通过手机号获取 agentId 和 userId
+ */
+async function fetchAgentInfoByPhone(cfg: OpenClawConfig, appKey: string, appSecret: string, phone: string, prompter: WizardPrompter): Promise<{
+  agentId?: string
+  userId?: string
+} | null> {
+  prompter.note?.('正在通过手机号获取配置信息...', '获取配置')
+
+  try {
+    const { authBaseUrl, openApiBaseUrl, allowInsecureTls, requestTimeout }
+      = resolveSetupApiBases(cfg)
+
+    // 1. 获取 access token
+    const tokenData = await doFetchJson(
+      `${authBaseUrl}/authen/v1/access_token/internal`,
+      {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          app_key: appKey,
+          app_secret: appSecret,
+        }),
+      },
+      allowInsecureTls,
+      requestTimeout,
+    )
+
+    if (tokenData.code !== 200 || !tokenData.data?.accessToken) {
+      prompter.note?.(`获取 Token 失败: ${tokenData.message || '未知错误'}`, '获取配置')
+      return null
+    }
+
+    const accessToken = tokenData.data.accessToken
+
+    // 2. 通过手机号获取 agentId 和 userId
+    const agentData = await doFetchJson(
+      `${openApiBaseUrl}/instance/local/agentInf`,
+      {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': `Bearer ${accessToken}`,
+        },
+        body: JSON.stringify({
+          appKey,
+          phone,
+        }),
+      },
+      allowInsecureTls,
+      requestTimeout,
+    )
+
+    if (agentData.code !== 200 || !agentData.data) {
+      prompter.note?.(`获取配置信息失败: ${agentData.message || '未知错误'}`, '获取配置')
+      return null
+    }
+
+    prompter.note?.(`成功获取配置信息`, '获取配置')
+
+    return {
+      agentId: agentData.data.agentId,
+      userId: agentData.data.userId,
+    }
+  }
+  catch (error) {
+    prompter.note?.(`获取配置失败: ${(error as Error).message}`, '获取配置')
+    return null
+  }
+}
+
+/**
+ * 运行新应用流程
+ */
+async function runNewAppFlow(params: {
+  cfg: OpenClawConfig
+  prompter: WizardPrompter
+  options?: Parameters<NonNullable<ChannelSetupWizard['finalize']>>[0]['options']
+}): Promise<{ cfg: OpenClawConfig }> {
+  const { prompter } = params
+  let next = params.cfg
+
+  // 1. 显示帮助信息
+  await noteWorkclawCredentialHelp(prompter)
+
+  // 2. 获取 App Key
+  const appKey = await promptWorkclawAppKey({
+    prompter,
+    initialValue: normalizeString(process.env.WORKCLAW_APP_KEY),
+  })
+
+  // 3. 获取 App Secret
+  const appSecret = await promptWorkclawAppSecret({
+    prompter,
+    initialValue: normalizeString(process.env.WORKCLAW_APP_SECRET),
+  })
+
+  // 4. 获取手机号（通过手机号获取 agentId 和 userId）
+  const phone = await promptWorkclawPhone({
+    prompter,
+    initialValue: normalizeString(process.env.WORKCLAW_PHONE),
+  })
+
+  // 5. 配置基础信息
+  next = patchWorkclawConfig(next, DEFAULT_ACCOUNT_ID, {
+    appKey,
+    appSecret,
+    connectionMode: 'websocket',
+    enabled: true,
+  })
+
+  // 6. 通过手机号获取 agentId 和 userId
+  const agentInfo = await fetchAgentInfoByPhone(next, appKey, appSecret, phone, prompter)
+
+  if (agentInfo) {
+    // 更新配置中的 agentId 和 userId
+    const accountConfig: Record<string, unknown> = {
+      enabled: true,
+    }
+
+    if (agentInfo.agentId) {
+      accountConfig.agentId = agentInfo.agentId
+    }
+
+    if (agentInfo.userId) {
+      accountConfig.userId = agentInfo.userId
+    }
+
+    next = patchWorkclawConfig(next, DEFAULT_ACCOUNT_ID, accountConfig)
+  }
+
+  // 6. DM 策略固定为 open
+  next = patchWorkclawConfig(next, DEFAULT_ACCOUNT_ID, {
+    dmPolicy: 'open',
+    allowFrom: ['*'],
+  })
+
+  await prompter.note('智小途配置完成!', '')
+
+  return { cfg: next }
+}
+
+/**
+ * 运行编辑配置流程
+ */
+async function runEditFlow(params: {
+  cfg: OpenClawConfig
+  prompter: WizardPrompter
+  options?: Parameters<NonNullable<ChannelSetupWizard['finalize']>>[0]['options']
+}): Promise<{ cfg: OpenClawConfig } | null> {
+  const workclawCfg = params.cfg.channels?.['openclaw-workclaw'] as WorkclawConfig | undefined
+  const existingAppKey = workclawCfg?.appKey
+
+  await params.prompter.note(
+    `当前配置的 App Key: ${existingAppKey ?? '(未配置)'}`,
+    '智小途配置',
+  )
+
+  const useExisting = await params.prompter.confirm({
+    message: `使用现有的智小途配置 (App Key: ${existingAppKey})?`,
+    initialValue: true,
+  })
+
+  if (!useExisting) {
+    return runNewAppFlow(params)
+  }
+
+  await params.prompter.note('保持现有配置不变。', '')
+  return { cfg: params.cfg }
+}
+
+/**
+ * 运行凭证探测流程
+ */
+async function runProbeFlow(params: {
+  cfg: OpenClawConfig
+  prompter: WizardPrompter
+}): Promise<OpenClawConfig> {
+  const workclawCfg = params.cfg.channels?.['openclaw-workclaw'] as WorkclawConfig | undefined
+  const resolvedCredentials = inspectWorkclawCredentials(workclawCfg)
+
+  if (resolvedCredentials) {
+    try {
+      const probeResult = await resolvedCredentials()
+      params.prompter.note(
+        `智小途连接测试成功! ${probeResult.botName ? `Bot名称: ${probeResult.botName}` : ''}`,
+        '连接测试',
+      )
+    }
+    catch {
+      params.prompter.note('智小途连接测试失败，请检查配置。', '连接测试')
+    }
+  }
+
+  return params.cfg
+}
+
+export { workclawSetupAdapter } from './setup-core.js'
+
+export const workclawSetupWizard: ChannelSetupWizard = {
+  channel,
+  resolveAccountIdForConfigure: ({ accountOverride, defaultAccountId, cfg }) =>
+    (typeof accountOverride === 'string' && accountOverride.trim()
+      ? accountOverride.trim()
+      : undefined)
+    ?? resolveDefaultWorkclawAccountId(cfg)
+    ?? defaultAccountId,
+  resolveShouldPromptAccountIds: () => false,
+  status: {
+    configuredLabel: '已配置',
+    unconfiguredLabel: '需要配置',
+    configuredHint: '已配置',
+    unconfiguredHint: '需要凭证',
+    configuredScore: 2,
+    unconfiguredScore: 0,
+    resolveConfigured: ({ cfg }) => isWorkclawConfigured(cfg),
+    resolveStatusLines: async ({ cfg, configured }) => {
+      const workclawCfg = cfg.channels?.['openclaw-workclaw'] as WorkclawConfig | undefined
+      const resolvedCredentials = inspectWorkclawCredentials(workclawCfg)
+      let probeResult = null
+      if (configured && resolvedCredentials) {
+        try {
+          probeResult = await resolvedCredentials()
+        }
+        catch {}
+      }
+      if (!configured) {
+        return ['智小途: 需要 App Key 和 App Secret']
+      }
+      if (probeResult?.ok) {
+        return [`智小途: 已连接${probeResult.botName ? ` (${probeResult.botName})` : ''}`]
+      }
+      return ['智小途: 已配置 (连接未验证)']
+    },
+  },
+
+  prepare: async ({ cfg, credentialValues }) => {
+    const alreadyConfigured = isWorkclawConfigured(cfg)
+
+    if (alreadyConfigured) {
+      return {
+        credentialValues: { ...credentialValues, _flow: 'edit' },
+      }
+    }
+
+    return {
+      credentialValues: { ...credentialValues, _flow: 'new' },
+    }
+  },
+
+  credentials: [],
+
+  finalize: async ({ cfg, prompter, options, credentialValues }) => {
+    const flow = credentialValues._flow ?? 'new'
+
+    if (flow === 'edit') {
+      const result = await runEditFlow({ cfg, prompter, options })
+      if (result === null) {
+        return { cfg }
+      }
+      cfg = result.cfg
+    }
+    else {
+      cfg = (await runNewAppFlow({ cfg, prompter, options })).cfg
+    }
+
+    await runProbeFlow({ cfg, prompter })
+    return { cfg }
+  },
+
+  disable: cfg =>
+    patchTopLevelChannelConfigSection({
+      cfg,
+      channel,
+      patch: { enabled: false },
+    }),
+}