adp-openclaw 0.0.30 → 0.0.32

package/index.ts

@@ -1,7 +1,15 @@
 import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
 import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
-import { adpOpenclawPlugin } from "./src/channel.js";
+import { adpOpenclawPlugin, type AdpOpenclawChannelConfig } from "./src/channel.js";
 import { setAdpOpenclawRuntime } from "./src/runtime.js";
+import {
+  ADP_UPLOAD_TOOL_NAME,
+  ADP_UPLOAD_TOOL_SCHEMA,
+  parseAdpUploadToolParams,
+  uploadFilesToAdpEndpoint,
+  type AdpUploadToolResult,
+  type UploadedFileInfo,
+} from "./src/adp-upload-tool.js";
 
 // Export session history functions for external use
 export {
@@ -25,6 +33,57 @@ export {
   type SessionFileConfig,
 } from "./src/session-history.js";
 
+// Export ADP upload tool functions and types
+export {
+  // Tool name and schema
+  ADP_UPLOAD_TOOL_NAME,
+  ADP_UPLOAD_TOOL_SCHEMA,
+  ADP_UPLOAD_TOOL_MAX_PATHS,
+  ADP_UPLOAD_TOOL_MIN_PATHS,
+  ADP_UPLOAD_TOOL_MAX_CONCURRENCY,
+  ADP_UPLOAD_VALIDATION_MESSAGE,
+  // Main functions
+  adpUploadFile,
+  adpUploadFiles,
+  adpUploadFileWithConfig,
+  adpUploadFilesWithConfig,
+  getStorageCredential,
+  uploadFileToCos,
+  getSignedDownloadUrl,
+  resolveClientToken,
+  // Class
+  AdpUploader,
+  // Tool execution functions
+  parseAdpUploadToolParams,
+  uploadFilesToAdpEndpoint,
+  executeAdpUploadTool,
+  // Types
+  type UploadResult,
+  type AdpUploadToolParams,
+  type AdpUploadToolResult,
+  type UploadedFileInfo,
+  type AdpUploadOptions,
+  type DescribeRemoteBotStorageCredentialReq,
+  type DescribeRemoteBotStorageCredentialRsp,
+  type Credentials,
+} from "./src/adp-upload-tool.js";
+
+// Export tool result message blocks functions
+export {
+  dispatchToolResultToMessageBlocks,
+  buildToolResultSessionContentBlocks,
+  formatUploadResultForUser,
+  formatUploadResultAsMarkdown,
+  type ResourceLinkBlock,
+  type TextBlock,
+  type ContentBlock,
+  type MessageBlock,
+} from "./src/tool-result-message-blocks.js";
+
+// Helper to format tool result as JSON string
+const formatToolResultJson = (result: unknown): string => 
+  JSON.stringify(result, null, 2) ?? "upload failed";
+
 const plugin = {
   id: "adp-openclaw",
   name: "ADP OpenClaw",
@@ -33,6 +92,127 @@ const plugin = {
   register(api: OpenClawPluginApi) {
     // console.log("[adp-openclaw] register() called");
     setAdpOpenclawRuntime(api.runtime);
+    
+    // Register the ADP file upload tool
+    // This allows AI to send files to users via ADP storage
+    api.registerTool({
+      name: ADP_UPLOAD_TOOL_NAME,
+      description: 
+        "If you can see this tool description, you are connected to the ADP server. " +
+        "Use this tool to send 1-10 local files of any type (including images and documents) to the user. " +
+        "A successful call means the files were uploaded and download URLs are returned. " +
+        "Include these URLs in your response so the user can access the files. " +
+        "Parameters must be local filesystem paths only.",
+      parameters: ADP_UPLOAD_TOOL_SCHEMA,
+      async execute(toolCallId: string, params: unknown) {
+        // Get bot token from channel config
+        const getClientToken = (): string | undefined => {
+          try {
+            const cfg = api.runtime?.config?.loadConfig?.();
+            const channelCfg = cfg?.channels?.["adp-openclaw"] as AdpOpenclawChannelConfig | undefined;
+            return channelCfg?.clientToken?.trim() || process.env.ADP_OPENCLAW_CLIENT_TOKEN;
+          } catch {
+            return process.env.ADP_OPENCLAW_CLIENT_TOKEN;
+          }
+        };
+
+        // Parse and validate parameters
+        const parsed = parseAdpUploadToolParams(params);
+        if (!parsed.ok) {
+          const errorResult = {
+            ok: false,
+            error: formatToolResultJson(parsed.error),
+          };
+          api.logger.debug?.(`[${ADP_UPLOAD_TOOL_NAME}] validation failed toolCallId=${toolCallId} error=${errorResult.error}`);
+          return {
+            output: errorResult,
+            result: errorResult,
+            details: errorResult,
+            content: [{ type: "text", text: formatToolResultJson(parsed.error) }],
+            isError: true,
+          };
+        }
+
+        // Get bot token
+        const botToken = getClientToken();
+        if (!botToken) {
+          const errorResult = {
+            ok: false,
+            error: "missing bot token for file upload - please configure clientToken in adp-openclaw channel settings",
+          };
+          api.logger.debug?.(`[${ADP_UPLOAD_TOOL_NAME}] token missing toolCallId=${toolCallId} paths=${JSON.stringify(parsed.value.paths)}`);
+          return {
+            output: errorResult,
+            result: errorResult,
+            details: errorResult,
+            content: [{ type: "text", text: errorResult.error }],
+            isError: true,
+          };
+        }
+
+        // Execute upload
+        const uploadResult = await uploadFilesToAdpEndpoint(parsed.value.paths, {
+          botToken,
+          fileType: parsed.value.fileType,
+        });
+
+        if (!uploadResult.ok) {
+          const errorResult = {
+            ok: false,
+            error: formatToolResultJson(uploadResult.error),
+          };
+          api.logger.debug?.(`[${ADP_UPLOAD_TOOL_NAME}] upload failed toolCallId=${toolCallId} paths=${JSON.stringify(parsed.value.paths)} error=${errorResult.error}`);
+          return {
+            output: errorResult,
+            result: errorResult,
+            details: errorResult,
+            content: [{ type: "text", text: formatToolResultJson(uploadResult.error) }],
+            isError: true,
+          };
+        }
+
+        // Success - format result with download URLs
+        const successResult: AdpUploadToolResult = {
+          ok: true,
+          files: uploadResult.files,
+        };
+
+        api.logger.debug?.(`[${ADP_UPLOAD_TOOL_NAME}] upload success toolCallId=${toolCallId} count=${successResult.files?.length ?? 0} paths=${JSON.stringify(parsed.value.paths)}`);
+
+        // Build content with resource links and download URLs
+        const content: Array<{ type: string; uri?: string; name?: string; mimeType?: string; text?: string }> = [];
+        
+        // Add resource links for each file
+        for (const file of (successResult.files || [])) {
+          content.push({
+            type: "resource_link",
+            uri: file.uri,
+            name: file.name,
+            mimeType: file.mimeType,
+          });
+        }
+
+        // Add a text summary with download URLs for AI to include in response
+        const urlSummary = (successResult.files || [])
+          .map((f: UploadedFileInfo) => `- [${f.name}](${f.downloadUrl || f.uri})`)
+          .join("\n");
+        
+        content.push({
+          type: "text",
+          text: `Files uploaded successfully:\n${urlSummary}`,
+        });
+
+        return {
+          output: successResult,
+          result: successResult,
+          details: successResult,
+          content,
+          isError: false,
+        };
+      },
+    });
+
+    // Register the channel plugin
     api.registerChannel({ plugin: adpOpenclawPlugin });
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adp-openclaw",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "description": "ADP-OpenClaw demo channel plugin (Go WebSocket backend)",
   "type": "module",
   "dependencies": {
@@ -8,7 +8,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@types/ws": "^8.5.10"
+    "@types/node": "^20.11.0",
+    "@types/ws": "^8.5.10",
+    "typescript": "^5.9.3"
   },
   "openclaw": {
     "extensions": [

package/src/adp-upload-tool.test.ts

@@ -0,0 +1,122 @@
+/**
+ * ADP Upload Tool 测试文件
+ * 
+ * 使用方式:
+ * 
+ * 1. 使用环境变量（推荐，与插件配置一致）:
+ *    ADP_OPENCLAW_CLIENT_TOKEN=your-token npx tsx src/adp-upload-tool.test.ts <filePath>
+ * 
+ * 2. 使用命令行参数:
+ *    npx tsx src/adp-upload-tool.test.ts --token <botToken> <filePath>
+ */
+
+import { AdpUploader, getStorageCredential } from "./adp-upload-tool.js";
+
+async function main() {
+  const args = process.argv.slice(2);
+  
+  let botToken: string | undefined;
+  let filePaths: string[] = [];
+  
+  // 解析参数
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === "--token" && i + 1 < args.length) {
+      botToken = args[i + 1];
+      i++; // 跳过下一个参数
+    } else if (!args[i].startsWith("--")) {
+      filePaths.push(args[i]);
+    }
+  }
+  
+  // 如果没有通过参数传入 token，尝试从环境变量读取
+  if (!botToken) {
+    botToken = process.env.ADP_OPENCLAW_CLIENT_TOKEN;
+  }
+
+  if (filePaths.length === 0) {
+    console.log("ADP Upload Tool 测试");
+    console.log("");
+    console.log("使用方式:");
+    console.log("  1. 使用环境变量（推荐，与插件配置一致）:");
+    console.log("     ADP_OPENCLAW_CLIENT_TOKEN=your-token npx tsx src/adp-upload-tool.test.ts <filePath>");
+    console.log("");
+    console.log("  2. 使用命令行参数:");
+    console.log("     npx tsx src/adp-upload-tool.test.ts --token <botToken> <filePath>");
+    console.log("");
+    console.log("示例:");
+    console.log("  npx tsx src/adp-upload-tool.test.ts --token my-bot-token ./test.txt");
+    console.log("  ADP_OPENCLAW_CLIENT_TOKEN=my-token npx tsx src/adp-upload-tool.test.ts ./file1.txt ./file2.pdf");
+    process.exit(1);
+  }
+
+  if (!botToken) {
+    console.error("错误: 未提供 botToken");
+    console.error("请通过 --token 参数或 ADP_OPENCLAW_CLIENT_TOKEN 环境变量设置");
+    process.exit(1);
+  }
+
+  console.log("=".repeat(60));
+  console.log("ADP Upload Tool 测试");
+  console.log("=".repeat(60));
+  console.log(`Bot Token: ${botToken.substring(0, 10)}...`);
+  console.log(`文件列表: ${filePaths.join(", ")}`);
+  console.log("");
+
+  // 测试获取临时密钥
+  console.log("1. 测试获取临时密钥...");
+  try {
+    const credential = await getStorageCredential(botToken);
+    console.log("   ✓ 获取密钥成功");
+    console.log(`   - Bucket: ${credential.bucket}`);
+    console.log(`   - Region: ${credential.region}`);
+    console.log(`   - File Path: ${credential.file_path}`);
+    console.log(`   - Secret ID: ${credential.credentials.tmp_secret_id.substring(0, 10)}...`);
+    console.log(`   - 有效期至: ${new Date(credential.expired_time * 1000).toLocaleString()}`);
+    console.log("");
+  } catch (error) {
+    console.log("   ✗ 获取密钥失败");
+    console.log(`   - 错误: ${error instanceof Error ? error.message : error}`);
+    process.exit(1);
+  }
+
+  // 使用 AdpUploader 类测试上传
+  console.log("2. 使用 AdpUploader 测试上传...");
+  const uploader = new AdpUploader({ clientToken: botToken });
+  console.log(`   - 配置状态: ${uploader.isConfigured() ? "已配置" : "未配置"}`);
+  console.log(`   - Token 预览: ${uploader.getTokenPreview()}`);
+  console.log("");
+
+  if (filePaths.length === 1) {
+    // 单文件上传
+    console.log("3. 测试单文件上传...");
+    const result = await uploader.upload(filePaths[0]);
+    if (result.ok) {
+      console.log("   ✓ 上传成功");
+      console.log(`   - 下载链接: ${result.fileUrl}`);
+    } else {
+      console.log("   ✗ 上传失败");
+      console.log(`   - 错误: ${result.error}`);
+    }
+  } else {
+    // 批量上传
+    console.log("3. 测试批量上传...");
+    const results = await uploader.uploadMultiple(filePaths);
+    results.forEach((result, index) => {
+      const filePath = filePaths[index];
+      if (result.ok) {
+        console.log(`   ✓ [${filePath}] 上传成功`);
+        console.log(`     下载链接: ${result.fileUrl}`);
+      } else {
+        console.log(`   ✗ [${filePath}] 上传失败`);
+        console.log(`     错误: ${result.error}`);
+      }
+    });
+  }
+
+  console.log("");
+  console.log("=".repeat(60));
+  console.log("测试完成");
+  console.log("=".repeat(60));
+}
+
+main().catch(console.error);