@workclaw/openclaw-workclaw 1.0.0 → 1.0.11

package/src/tools/openclaw-workclaw-cron/api/index.ts

@@ -1,326 +1,326 @@
-/**
- * 智小途定时任务工具 - 后端接口封装
- */
-
-import type { OpenClawPluginApi } from 'openclaw/plugin-sdk'
-import type { OpenclawWorkclawConnectionConfig } from '../../../connection/workclaw-client.js'
-import { resolveOpenclawWorkclawAccount } from '../../../accounts.js'
-import { doFetchJson, getOpenclawWorkclawAccessToken, normalizeBaseUrl } from '../../../connection/workclaw-client.js'
-
-const DEFAULT_MAX_RETRIES = 3
-const DEFAULT_RETRY_DELAY_MS = 1000
-
-/**
- * 睡眠函数
- */
-function sleep(ms: number): Promise<void> {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}
-
-/**
- * 带重试机制的 fetch 调用
- */
-async function fetchWithRetry<T>(
-  fetchFn: () => Promise<T>,
-  options: {
-    maxRetries?: number
-    retryDelayMs?: number
-    retryableErrors?: string[]
-  } = {},
-): Promise<{ data?: T, error?: string, attempts: number }> {
-  const maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES
-  const retryDelayMs = options.retryDelayMs ?? DEFAULT_RETRY_DELAY_MS
-  const retryableErrors = options.retryableErrors ?? [
-    'ECONNREFUSED',
-    'ETIMEDOUT',
-    'ENOTFOUND',
-    'ENETUNREACH',
-    'EAI_AGAIN',
-  ]
-
-  let lastError: string = ''
-  let attempts = 0
-
-  for (let i = 0; i <= maxRetries; i++) {
-    attempts = i + 1
-    try {
-      const data = await fetchFn()
-      return { data, attempts }
+/**
+ * 智小途定时任务工具 - 后端接口封装
+ */
+
+import type { OpenClawPluginApi } from 'openclaw/plugin-sdk'
+import type { OpenclawWorkclawConnectionConfig } from '../../../connection/workclaw-client.js'
+import { resolveOpenclawWorkclawAccount } from '../../../accounts.js'
+import { doFetchJson, getOpenclawWorkclawAccessToken, normalizeBaseUrl } from '../../../connection/workclaw-client.js'
+
+const DEFAULT_MAX_RETRIES = 3
+const DEFAULT_RETRY_DELAY_MS = 1000
+
+/**
+ * 睡眠函数
+ */
+function sleep(ms: number): Promise<void> {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+/**
+ * 带重试机制的 fetch 调用
+ */
+async function fetchWithRetry<T>(
+  fetchFn: () => Promise<T>,
+  options: {
+    maxRetries?: number
+    retryDelayMs?: number
+    retryableErrors?: string[]
+  } = {},
+): Promise<{ data?: T, error?: string, attempts: number }> {
+  const maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES
+  const retryDelayMs = options.retryDelayMs ?? DEFAULT_RETRY_DELAY_MS
+  const retryableErrors = options.retryableErrors ?? [
+    'ECONNREFUSED',
+    'ETIMEDOUT',
+    'ENOTFOUND',
+    'ENETUNREACH',
+    'EAI_AGAIN',
+  ]
+
+  let lastError: string = ''
+  let attempts = 0
+
+  for (let i = 0; i <= maxRetries; i++) {
+    attempts = i + 1
+    try {
+      const data = await fetchFn()
+      return { data, attempts }
     }
-    catch (error: any) {
-      lastError = error.message || String(error)
-
-      const isRetryable = retryableErrors.some(
-        e => lastError.toLowerCase().includes(e.toLowerCase()),
-      )
-
-      if (i < maxRetries && isRetryable) {
-        const delay = retryDelayMs * 2 ** i
-        await sleep(delay)
-        continue
-      }
-
-      break
-    }
-  }
-
-  return { error: lastError, attempts }
-}
-
-/**
- * 脱敏日志输出（隐藏敏感字段）
- */
-function sanitizePayload(payload: Record<string, any>): Record<string, any> {
-  const sensitiveFields = [
-    'password',
-    'secret',
-    'token',
-    'authorization',
-    'appSecret',
-    'appSecret',
-  ]
-
-  const sanitized: Record<string, any> = {}
-  for (const [key, value] of Object.entries(payload)) {
-    const lowerKey = key.toLowerCase()
-    if (sensitiveFields.some(f => lowerKey.includes(f))) {
-      sanitized[key] = '***'
+    catch (error: any) {
+      lastError = error.message || String(error)
+
+      const isRetryable = retryableErrors.some(
+        e => lastError.toLowerCase().includes(e.toLowerCase()),
+      )
+
+      if (i < maxRetries && isRetryable) {
+        const delay = retryDelayMs * 2 ** i
+        await sleep(delay)
+        continue
+      }
+
+      break
     }
-    else if (typeof value === 'object' && value !== null) {
-      sanitized[key] = sanitizePayload(value as Record<string, any>)
+  }
+
+  return { error: lastError, attempts }
+}
+
+/**
+ * 脱敏日志输出（隐藏敏感字段）
+ */
+function sanitizePayload(payload: Record<string, any>): Record<string, any> {
+  const sensitiveFields = [
+    'password',
+    'secret',
+    'token',
+    'authorization',
+    'appSecret',
+    'appSecret',
+  ]
+
+  const sanitized: Record<string, any> = {}
+  for (const [key, value] of Object.entries(payload)) {
+    const lowerKey = key.toLowerCase()
+    if (sensitiveFields.some(f => lowerKey.includes(f))) {
+      sanitized[key] = '***'
+    }
+    else if (typeof value === 'object' && value !== null) {
+      sanitized[key] = sanitizePayload(value as Record<string, any>)
+    }
+    else {
+      sanitized[key] = value
+    }
+  }
+  return sanitized
+}
+
+/**
+ * 调用后端 API 的通用方法
+ * @param api - OpenClaw API 实例
+ * @param accountId - 账户 ID
+ * @param path - API 路径
+ * @param payload - 请求体
+ * @param options - 可选配置
+ * @returns 接口调用结果
+ */
+export async function callBackendApi(
+  api: OpenClawPluginApi,
+  accountId: string,
+  path: string,
+  payload: Record<string, any>,
+  options: {
+    maxRetries?: number
+  } = {},
+): Promise<{ success: boolean, data?: any, error?: string, attempts?: number }> {
+  try {
+    const account = resolveOpenclawWorkclawAccount({
+      cfg: api.config,
+      accountId,
+    })
+
+    if (!account.configured) {
+      api.logger.error(`[智小途-定时任务] 账户未配置 accountId=${accountId}`)
+      return { success: false, error: 'Account not configured' }
+    }
+
+    const accConfig = account.config as any
+    const tokenCacheKey = accConfig.appKey || accountId
+    const baseUrl = normalizeBaseUrl(accConfig.baseUrl)
+
+    api.logger.info(`[智小途-定时任务] 正在获取认证 token，accountId=${accountId}`)
+
+    const token = await getOpenclawWorkclawAccessToken(tokenCacheKey, {
+      baseUrl: accConfig.baseUrl,
+      appKey: accConfig.appKey,
+      appSecret: accConfig.appSecret,
+      allowInsecureTls: accConfig.allowInsecureTls,
+      requestTimeout: accConfig.requestTimeout,
+    } as OpenclawWorkclawConnectionConfig)
+
+    const requestUrl = `${baseUrl}/open-apis${path}`
+    const sanitizedPayload = sanitizePayload(payload)
+    api.logger.info(`[智小途-定时任务] 调用接口 ${requestUrl}`)
+    api.logger.info(`[智小途-定时任务] 请求参数 ${JSON.stringify(sanitizedPayload)}`)
+
+    const maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES
+
+    const fetchResult = await fetchWithRetry(
+      () =>
+        doFetchJson(
+          requestUrl,
+          {
+            method: 'POST',
+            headers: {
+              'Content-Type': 'application/json',
+              'Authorization': `Bearer ${token}`,
+            },
+            body: JSON.stringify(payload),
+          },
+          accConfig.allowInsecureTls,
+          accConfig.requestTimeout,
+        ),
+      { maxRetries },
+    )
+
+    if (fetchResult.error) {
+      api.logger.error(`[智小途-定时任务] 接口调用失败（已重试 ${fetchResult.attempts} 次）: ${fetchResult.error}`)
+      return { success: false, error: fetchResult.error, attempts: fetchResult.attempts }
     }
-    else {
-      sanitized[key] = value
-    }
-  }
-  return sanitized
-}
-
-/**
- * 调用后端 API 的通用方法
- * @param api - OpenClaw API 实例
- * @param accountId - 账户 ID
- * @param path - API 路径
- * @param payload - 请求体
- * @param options - 可选配置
- * @returns 接口调用结果
- */
-export async function callBackendApi(
-  api: OpenClawPluginApi,
-  accountId: string,
-  path: string,
-  payload: Record<string, any>,
-  options: {
-    maxRetries?: number
-  } = {},
-): Promise<{ success: boolean, data?: any, error?: string, attempts?: number }> {
-  try {
-    const account = resolveOpenclawWorkclawAccount({
-      cfg: api.config,
-      accountId,
-    })
-
-    if (!account.configured) {
-      api.logger.error(`[智小途-定时任务] 账户未配置 accountId=${accountId}`)
-      return { success: false, error: 'Account not configured' }
-    }
-
-    const accConfig = account.config as any
-    const tokenCacheKey = accConfig.appKey || accountId
-    const baseUrl = normalizeBaseUrl(accConfig.baseUrl)
-
-    api.logger.info(`[智小途-定时任务] 正在获取认证 token，accountId=${accountId}`)
-
-    const token = await getOpenclawWorkclawAccessToken(tokenCacheKey, {
-      baseUrl: accConfig.baseUrl,
-      appKey: accConfig.appKey,
-      appSecret: accConfig.appSecret,
-      allowInsecureTls: accConfig.allowInsecureTls,
-      requestTimeout: accConfig.requestTimeout,
-    } as OpenclawWorkclawConnectionConfig)
-
-    const requestUrl = `${baseUrl}/open-apis${path}`
-    const sanitizedPayload = sanitizePayload(payload)
-    api.logger.info(`[智小途-定时任务] 调用接口 ${requestUrl}`)
-    api.logger.info(`[智小途-定时任务] 请求参数 ${JSON.stringify(sanitizedPayload)}`)
-
-    const maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES
-
-    const fetchResult = await fetchWithRetry(
-      () =>
-        doFetchJson(
-          requestUrl,
-          {
-            method: 'POST',
-            headers: {
-              'Content-Type': 'application/json',
-              'Authorization': `Bearer ${token}`,
-            },
-            body: JSON.stringify(payload),
-          },
-          accConfig.allowInsecureTls,
-          accConfig.requestTimeout,
-        ),
-      { maxRetries },
-    )
-
-    if (fetchResult.error) {
-      api.logger.error(`[智小途-定时任务] 接口调用失败（已重试 ${fetchResult.attempts} 次）: ${fetchResult.error}`)
-      return { success: false, error: fetchResult.error, attempts: fetchResult.attempts }
-    }
-
-    const data = fetchResult.data
-    api.logger.info(`[智小途-定时任务] 接口响应（尝试 ${fetchResult.attempts} 次）: ${JSON.stringify(data)}`)
-
-    if (data?.code === 200 || data?.code === 0) {
-      return { success: true, data, attempts: fetchResult.attempts }
+
+    const data = fetchResult.data
+    api.logger.info(`[智小途-定时任务] 接口响应（尝试 ${fetchResult.attempts} 次）: ${JSON.stringify(data)}`)
+
+    if (data?.code === 200 || data?.code === 0) {
+      return { success: true, data, attempts: fetchResult.attempts }
     }
-    else {
-      const errorMsg = data?.message || data?.msg || 'Unknown error'
-      api.logger.error(`[智小途-定时任务] 接口返回错误 ${errorMsg}`)
-      return { success: false, error: errorMsg }
-    }
+    else {
+      const errorMsg = data?.message || data?.msg || 'Unknown error'
+      api.logger.error(`[智小途-定时任务] 接口返回错误 ${errorMsg}`)
+      return { success: false, error: errorMsg }
+    }
+  }
+  catch (error: any) {
+    api.logger.error(`[智小途-定时任务] 接口调用异常 ${error.message}`)
+    return { success: false, error: error.message }
   }
-  catch (error: any) {
-    api.logger.error(`[智小途-定时任务] 接口调用异常 ${error.message}`)
-    return { success: false, error: error.message }
-  }
-}
-
-/**
- * 调用新增定时任务接口
- */
-export async function callCronJobAdd(
-  api: OpenClawPluginApi,
-  accountId: string,
-  payload: {
-    jobId: string
-    name: string
-    kind: 'cron'
-    expr?: string
-    message: string
-    messageId?: string
-  },
-): Promise<{ success: boolean, data?: any, error?: string }> {
-  api.logger.info(`[智小途-定时任务] 新增定时任务 jobId=${payload.jobId} name=${payload.name}`)
-
-  const result = await callBackendApi(api, accountId, '/cron/job/add', {
-    clawJobId: payload.jobId,
-    name: payload.name,
-    kind: payload.kind,
-    expr: payload.expr || '',
-    message: payload.message,
-    agentId: payload.messageId || '0',
-  })
-
-  return { success: result.success, data: result.data, error: result.error }
-}
-
-/**
- * 调用删除定时任务接口
- */
-export async function callCronJobRemove(
-  api: OpenClawPluginApi,
-  accountId: string,
-  payload: {
-    jobId: string
-  },
-): Promise<{ success: boolean, data?: any, error?: string }> {
-  api.logger.info(`[智小途-定时任务] 删除定时任务 jobId=${payload.jobId}`)
-
-  const result = await callBackendApi(api, accountId, '/cron/job/del', {
-    clawJobId: payload.jobId,
-  })
-
-  return { success: result.success, data: result.data, error: result.error }
-}
-
-/**
- * 调用更新定时任务接口
- */
-export async function callCronJobUpdate(
-  api: OpenClawPluginApi,
-  accountId: string,
-  payload: {
-    jobId: string
-    name: string
-    kind: 'cron'
-    expr?: string
-    message: string
-    agentId?: string
-  },
-): Promise<{ success: boolean, data?: any, error?: string }> {
-  api.logger.info(`[智小途-定时任务] 更新定时任务 jobId=${payload.jobId} name=${payload.name} agentId=${payload.agentId}`)
-
-  const result = await callBackendApi(api, accountId, '/cron/job/update', {
-    clawJobId: payload.jobId,
-    name: payload.name,
-    kind: payload.kind,
-    expr: payload.expr || '',
-    message: payload.message,
-    agentId: payload.agentId || '0',
-  })
-
-  return { success: result.success, data: result.data, error: result.error }
-}
-
-/**
- * 调用启用定时任务接口
- */
-export async function callCronJobEnabled(
-  api: OpenClawPluginApi,
-  accountId: string,
-  payload: {
-    jobId: string
-  },
-): Promise<{ success: boolean, data?: any, error?: string }> {
-  api.logger.info(`[智小途-定时任务] 启用定时任务 jobId=${payload.jobId}`)
-
-  const result = await callBackendApi(api, accountId, '/cron/job/enabled', {
-    clawJobId: payload.jobId,
-  })
-
-  return { success: result.success, data: result.data, error: result.error }
-}
-
-/**
- * 调用禁用定时任务接口
- */
-export async function callCronJobDisabled(
-  api: OpenClawPluginApi,
-  accountId: string,
-  payload: {
-    jobId: string
-  },
-): Promise<{ success: boolean, data?: any, error?: string }> {
-  api.logger.info(`[智小途-定时任务] 禁用定时任务 jobId=${payload.jobId}`)
-
-  const result = await callBackendApi(api, accountId, '/cron/job/disabled', {
-    clawJobId: payload.jobId,
-  })
-
-  return { success: result.success, data: result.data, error: result.error }
-}
-
-/**
- * 调用定时任务触发通知接口
- */
-export async function callCronJobMessage(
-  api: OpenClawPluginApi,
-  accountId: string,
-  payload: {
-    jobId: string
-    message: string
-    agentId?: string
-  },
-): Promise<{ success: boolean, data?: any, error?: string }> {
-  api.logger.info(`[智小途-定时任务] 定时任务触发通知 jobId=${payload.jobId} message=${payload.message} agentId=${payload.agentId}`)
-
-  const result = await callBackendApi(api, accountId, '/cron/job/message', {
-    clawJobId: payload.jobId,
-    message: payload.message,
-    agentId: payload.agentId || '0',
-  })
-
-  return { success: result.success, data: result.data, error: result.error }
-}
+}
+
+/**
+ * 调用新增定时任务接口
+ */
+export async function callCronJobAdd(
+  api: OpenClawPluginApi,
+  accountId: string,
+  payload: {
+    jobId: string
+    name: string
+    kind: 'cron'
+    expr?: string
+    message: string
+    messageId?: string
+  },
+): Promise<{ success: boolean, data?: any, error?: string }> {
+  api.logger.info(`[智小途-定时任务] 新增定时任务 jobId=${payload.jobId} name=${payload.name}`)
+
+  const result = await callBackendApi(api, accountId, '/cron/job/add', {
+    clawJobId: payload.jobId,
+    name: payload.name,
+    kind: payload.kind,
+    expr: payload.expr || '',
+    message: payload.message,
+    agentId: payload.messageId || '0',
+  })
+
+  return { success: result.success, data: result.data, error: result.error }
+}
+
+/**
+ * 调用删除定时任务接口
+ */
+export async function callCronJobRemove(
+  api: OpenClawPluginApi,
+  accountId: string,
+  payload: {
+    jobId: string
+  },
+): Promise<{ success: boolean, data?: any, error?: string }> {
+  api.logger.info(`[智小途-定时任务] 删除定时任务 jobId=${payload.jobId}`)
+
+  const result = await callBackendApi(api, accountId, '/cron/job/del', {
+    clawJobId: payload.jobId,
+  })
+
+  return { success: result.success, data: result.data, error: result.error }
+}
+
+/**
+ * 调用更新定时任务接口
+ */
+export async function callCronJobUpdate(
+  api: OpenClawPluginApi,
+  accountId: string,
+  payload: {
+    jobId: string
+    name: string
+    kind: 'cron'
+    expr?: string
+    message: string
+    agentId?: string
+  },
+): Promise<{ success: boolean, data?: any, error?: string }> {
+  api.logger.info(`[智小途-定时任务] 更新定时任务 jobId=${payload.jobId} name=${payload.name} agentId=${payload.agentId}`)
+
+  const result = await callBackendApi(api, accountId, '/cron/job/update', {
+    clawJobId: payload.jobId,
+    name: payload.name,
+    kind: payload.kind,
+    expr: payload.expr || '',
+    message: payload.message,
+    agentId: payload.agentId || '0',
+  })
+
+  return { success: result.success, data: result.data, error: result.error }
+}
+
+/**
+ * 调用启用定时任务接口
+ */
+export async function callCronJobEnabled(
+  api: OpenClawPluginApi,
+  accountId: string,
+  payload: {
+    jobId: string
+  },
+): Promise<{ success: boolean, data?: any, error?: string }> {
+  api.logger.info(`[智小途-定时任务] 启用定时任务 jobId=${payload.jobId}`)
+
+  const result = await callBackendApi(api, accountId, '/cron/job/enabled', {
+    clawJobId: payload.jobId,
+  })
+
+  return { success: result.success, data: result.data, error: result.error }
+}
+
+/**
+ * 调用禁用定时任务接口
+ */
+export async function callCronJobDisabled(
+  api: OpenClawPluginApi,
+  accountId: string,
+  payload: {
+    jobId: string
+  },
+): Promise<{ success: boolean, data?: any, error?: string }> {
+  api.logger.info(`[智小途-定时任务] 禁用定时任务 jobId=${payload.jobId}`)
+
+  const result = await callBackendApi(api, accountId, '/cron/job/disabled', {
+    clawJobId: payload.jobId,
+  })
+
+  return { success: result.success, data: result.data, error: result.error }
+}
+
+/**
+ * 调用定时任务触发通知接口
+ */
+export async function callCronJobMessage(
+  api: OpenClawPluginApi,
+  accountId: string,
+  payload: {
+    jobId: string
+    message: string
+    agentId?: string
+  },
+): Promise<{ success: boolean, data?: any, error?: string }> {
+  api.logger.info(`[智小途-定时任务] 定时任务触发通知 jobId=${payload.jobId} message=${payload.message} agentId=${payload.agentId}`)
+
+  const result = await callBackendApi(api, accountId, '/cron/job/message', {
+    clawJobId: payload.jobId,
+    message: payload.message,
+    agentId: payload.agentId || '0',
+  })
+
+  return { success: result.success, data: result.data, error: result.error }
+}

package/src/types.ts

@@ -50,9 +50,9 @@ export interface WorkClawAccountConfig {
 
 export type WorkClawConfig = WorkClawBaseConfig & WorkClawAccountConfig
 
-/**
+/**
  * account.config is typed as OpenclawWorkclawConfig (top-level) but at runtime
- *  also contains all OpenclawWorkclawAccountConfig fields (merged).
+ *  also contains all OpenclawWorkclawAccountConfig fields (merged).
  */
 export type OpenclawWorkclawFullAccountConfig = OpenclawWorkclawConfig & Partial<OpenclawWorkclawAccountConfig>