adp-openclaw 0.0.70 → 0.0.72

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+export { getOpenClawChatHistory, listOpenClawSessions, getSessionPreviews, getChatHistoryByConversationId, resolveSessionKey, configureSessionFileReader, getSessionFileConfig, getOpenClawChatHistoryViaCli, listOpenClawSessionsViaCli, getChatHistory, listSessions, type OpenClawSession, type OpenClawMessage, type ChatHistoryResponse, type SessionsListResponse, type SessionFileConfig, } from "./src/session-history.js";
+export { 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, adpUploadFile, adpUploadFiles, adpUploadFileWithConfig, adpUploadFilesWithConfig, getStorageCredential, uploadFileToCos, resolveClientToken, AdpUploader, parseAdpUploadToolParams, uploadFilesToAdpEndpoint, executeAdpUploadTool, type UploadResult, type AdpUploadToolParams, type AdpUploadToolResult, type UploadedFileInfo, type AdpUploadOptions, type DescribeRemoteBotStorageCredentialReq, type DescribeRemoteBotStorageCredentialRsp, type Credentials, } from "./src/adp-upload-tool.js";
+export { dispatchToolResultToMessageBlocks, buildToolResultSessionContentBlocks, formatUploadResultForUser, formatUploadResultAsMarkdown, type ResourceLinkBlock, type TextBlock, type ContentBlock, type MessageBlock, } from "./src/tool-result-message-blocks.js";
+declare const plugin: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: any;
+    register(api: OpenClawPluginApi): void;
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,190 @@
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+import { adpOpenclawPlugin } from "./src/channel.js";
+import { setAdpOpenclawRuntime } from "./src/runtime.js";
+import { ADP_UPLOAD_TOOL_NAME, ADP_UPLOAD_TOOL_SCHEMA, parseAdpUploadToolParams, uploadFilesToAdpEndpoint, uploadResultEmitter, UPLOAD_RESULT_EVENT, } from "./src/adp-upload-tool.js";
+// Track whether register() has been called at least once (for log dedup)
+let _registerCallCount = 0;
+// Export session history functions for external use
+// NOTE: These are re-exported for external consumers. The session-history module
+// is heavy (uses node:child_process, node:fs) but these exports do not affect
+// register() performance since they are only loaded when actually imported by consumers.
+export { getOpenClawChatHistory, listOpenClawSessions, getSessionPreviews, getChatHistoryByConversationId, resolveSessionKey, configureSessionFileReader, getSessionFileConfig, 
+// CLI-based functions
+getOpenClawChatHistoryViaCli, listOpenClawSessionsViaCli, 
+// Auto-selecting functions
+getChatHistory, listSessions, } 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, resolveClientToken, 
+// Class
+AdpUploader, 
+// Tool execution functions
+parseAdpUploadToolParams, uploadFilesToAdpEndpoint, executeAdpUploadTool, } from "./src/adp-upload-tool.js";
+// Export tool result message blocks functions
+export { dispatchToolResultToMessageBlocks, buildToolResultSessionContentBlocks, formatUploadResultForUser, formatUploadResultAsMarkdown, } from "./src/tool-result-message-blocks.js";
+// Helper to format tool result as JSON string
+const formatToolResultJson = (result) => JSON.stringify(result, null, 2) ?? "upload failed";
+const plugin = {
+    id: "adp-openclaw",
+    name: "ADP OpenClaw",
+    description: "ADP channel plugin backed by a Go WebSocket server",
+    configSchema: emptyPluginConfigSchema(),
+    register(api) {
+        _registerCallCount++;
+        // Only log on first registration to avoid flooding logs
+        // (OpenClaw framework calls register() for each subsystem independently)
+        if (_registerCallCount === 1) {
+            api.logger.info?.("[adp-openclaw] Plugin register() called");
+            api.logger.info?.(`[adp-openclaw] Registering tool factory: ${ADP_UPLOAD_TOOL_NAME}`);
+        }
+        else {
+            api.logger.debug?.(`[adp-openclaw] Plugin register() called (call #${_registerCallCount})`);
+        }
+        setAdpOpenclawRuntime(api.runtime);
+        api.registerTool((ctx) => {
+            // Only expose this tool when the message comes from the adp-openclaw channel
+            const channel = ctx.messageChannel ?? "";
+            if (channel && channel !== "adp-openclaw") {
+                api.logger.debug?.(`[adp-openclaw] Skipping ${ADP_UPLOAD_TOOL_NAME} for channel: ${channel}`);
+                return null;
+            }
+            return {
+                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. " +
+                    "IMPORTANT: You MUST include the download URLs in your response to the user, " +
+                    "and remind the user that the download links are valid for 24 hours. " +
+                    "Parameters must be local filesystem paths only.",
+                parameters: ADP_UPLOAD_TOOL_SCHEMA,
+                async execute(toolCallId, params) {
+                    // Get bot token from channel config
+                    const getClientToken = () => {
+                        try {
+                            const cfg = api.runtime?.config?.loadConfig?.();
+                            const channelCfg = cfg?.channels?.["adp-openclaw"];
+                            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 = {
+                        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)}`);
+                    // Debug: print full downloadUrl for each file
+                    for (const file of (successResult.files || [])) {
+                        api.logger.info?.(`[${ADP_UPLOAD_TOOL_NAME}] file.downloadUrl: ${file.downloadUrl}`);
+                        api.logger.info?.(`[${ADP_UPLOAD_TOOL_NAME}] file.uri: ${file.uri}`);
+                    }
+                    // 发射上传结果事件，让 monitor.ts 能够直接获取完整的下载链接
+                    uploadResultEmitter.emit(UPLOAD_RESULT_EVENT, {
+                        toolCallId,
+                        result: successResult,
+                    });
+                    // Build content with resource links and download URLs
+                    const content = [];
+                    // Add resource links for each file
+                    for (const file of (successResult.files || [])) {
+                        content.push({
+                            type: "resource_link",
+                            uri: file.downloadUrl || file.uri, // 使用带签名的下载链接
+                            name: file.name,
+                            mimeType: file.mimeType,
+                            downloadUrl: file.downloadUrl, // 也包含 downloadUrl 字段
+                        });
+                    }
+                    // Add a text summary with download URLs for AI to include in response
+                    // 注意：URL 包含签名参数，必须完整保留，不能截断或修改
+                    const urlSummary = (successResult.files || [])
+                        .map((f) => {
+                        const url = f.downloadUrl || f.uri;
+                        // 把完整 URL 作为代码块，防止 AI 截断或修改
+                        return `- **${f.name}**: \`${url}\``;
+                    })
+                        .join("\n");
+                    api.logger.info?.(`[${ADP_UPLOAD_TOOL_NAME}] urlSummary: ${urlSummary}`);
+                    content.push({
+                        type: "text",
+                        text: `Files uploaded successfully:\n${urlSummary}\n\n⚠️ IMPORTANT: The URLs above contain authentication signatures. You MUST copy the ENTIRE URL exactly as shown (including all query parameters after the "?"). Do NOT truncate or modify the URLs in any way. The links are valid for 24 hours.`,
+                    });
+                    return {
+                        output: successResult,
+                        result: successResult,
+                        details: successResult,
+                        content,
+                        isError: false,
+                    };
+                },
+            }; // end of tool object
+        }); // end of factory function passed to registerTool
+        // Log tool registration success (only first time)
+        if (_registerCallCount === 1) {
+            api.logger.info?.(`[adp-openclaw] Tool ${ADP_UPLOAD_TOOL_NAME} registered successfully`);
+        }
+        // Register the channel plugin
+        api.registerChannel({ plugin: adpOpenclawPlugin });
+        if (_registerCallCount === 1) {
+            api.logger.info?.("[adp-openclaw] Plugin registration complete");
+        }
+    },
+};
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/src/adp-upload-tool.d.ts

@@ -0,0 +1,246 @@
+/**
+ * ADP Upload Tool
+ *
+ * 功能：
+ * 1. 通过固定接口获取预签名的上传URL和下载URL
+ * 2. 使用预签名URL直接PUT上传文件到COS
+ * 3. 返回文件下载链接
+ *
+ * 注意：机器人 token 从 adp-openclaw 插件配置的 clientToken 读取
+ */
+import { EventEmitter } from "node:events";
+import type { AdpOpenclawChannelConfig } from "./channel.js";
+/** 上传结果事件发射器，用于通知其他模块上传完成 */
+export declare const uploadResultEmitter: EventEmitter<[never]>;
+/** 上传结果事件名称 */
+export declare const UPLOAD_RESULT_EVENT = "adp-upload-result";
+/** 存储凭证请求参数 */
+export interface DescribeRemoteBotStorageCredentialReq {
+    token: string;
+    file_type?: string;
+}
+/** 临时凭证信息 */
+export interface Credentials {
+    token: string;
+    tmp_secret_id: string;
+    tmp_secret_key: string;
+}
+/** 存储凭证响应 */
+export interface DescribeRemoteBotStorageCredentialRsp {
+    credentials: Credentials;
+    expired_time: number;
+    start_time: number;
+    bucket: string;
+    region: string;
+    file_path: string;
+    upload_url: string;
+    file_url: string;
+}
+/** 上传结果 */
+export interface UploadResult {
+    ok: boolean;
+    fileUrl?: string;
+    error?: string;
+}
+/**
+ * 获取COS临时密钥
+ */
+export declare function getStorageCredential(token: string, fileType?: string): Promise<DescribeRemoteBotStorageCredentialRsp>;
+/**
+ * 上传文件到COS（使用预签名URL直接PUT上传）
+ *
+ * @param filePath - 本地文件路径
+ * @param credential - 存储凭证（包含预签名的 upload_url 和 file_url）
+ * @returns 文件下载URL
+ */
+export declare function uploadFileToCos(filePath: string, credential: DescribeRemoteBotStorageCredentialRsp): Promise<string>;
+/**
+ * 从插件配置或环境变量中获取 clientToken
+ */
+export declare function resolveClientToken(channelCfg?: AdpOpenclawChannelConfig): string | null;
+/**
+ * ADP 上传工具主函数（使用显式传入的 token）
+ *
+ * @param filePath - 要上传的本地文件路径
+ * @param botToken - 机器人 token
+ * @param fileType - 文件类型（可选）
+ * @returns 上传结果，包含下载链接或错误信息
+ */
+export declare function adpUploadFile(filePath: string, botToken: string, fileType?: string): Promise<UploadResult>;
+/**
+ * ADP 上传工具主函数（从配置读取 token）
+ *
+ * @param filePath - 要上传的本地文件路径
+ * @param channelCfg - adp-openclaw 插件配置（包含 clientToken）
+ * @param fileType - 文件类型（可选）
+ * @returns 上传结果，包含下载签名链接或错误信息
+ */
+export declare function adpUploadFileWithConfig(filePath: string, channelCfg?: AdpOpenclawChannelConfig, fileType?: string): Promise<UploadResult>;
+/**
+ * 批量上传文件（使用显式传入的 token）
+ *
+ * 注意：每个文件需要独立获取预签名URL，因为服务端为每个文件生成唯一路径
+ *
+ * @param filePaths - 要上传的本地文件路径列表
+ * @param botToken - 机器人 token
+ * @param fileType - 文件类型（可选）
+ * @returns 上传结果列表
+ */
+export declare function adpUploadFiles(filePaths: string[], botToken: string, fileType?: string): Promise<UploadResult[]>;
+/**
+ * 批量上传文件（从配置读取 token）
+ *
+ * @param filePaths - 要上传的本地文件路径列表
+ * @param channelCfg - adp-openclaw 插件配置（包含 clientToken）
+ * @param fileType - 文件类型（可选）
+ * @returns 上传结果列表
+ */
+export declare function adpUploadFilesWithConfig(filePaths: string[], channelCfg?: AdpOpenclawChannelConfig, fileType?: string): Promise<UploadResult[]>;
+/**
+ * ADP 上传工具类
+ *
+ * 封装了从 adp-openclaw 配置读取 clientToken 的逻辑
+ *
+ * @example
+ * ```typescript
+ * import { AdpUploader } from "./adp-upload-tool.js";
+ *
+ * // 从插件配置创建上传器
+ * const uploader = new AdpUploader(channelConfig);
+ *
+ * // 或者从环境变量创建（不传参数）
+ * const uploader = new AdpUploader();
+ *
+ * // 单文件上传
+ * const result = await uploader.upload("/path/to/file.pdf");
+ *
+ * // 批量上传
+ * const results = await uploader.uploadMultiple(["/path/to/file1.pdf", "/path/to/file2.png"]);
+ * ```
+ */
+export declare class AdpUploader {
+    private clientToken;
+    /**
+     * 创建 ADP 上传器实例
+     *
+     * @param channelCfg - adp-openclaw 插件配置，如果不传则从环境变量读取
+     */
+    constructor(channelCfg?: AdpOpenclawChannelConfig);
+    /**
+     * 检查是否已配置 token
+     */
+    isConfigured(): boolean;
+    /**
+     * 获取当前使用的 token（脱敏显示）
+     */
+    getTokenPreview(): string | null;
+    /**
+     * 上传单个文件
+     *
+     * @param filePath - 要上传的本地文件路径
+     * @param fileType - 文件类型（可选）
+     * @returns 上传结果
+     */
+    upload(filePath: string, fileType?: string): Promise<UploadResult>;
+    /**
+     * 批量上传文件
+     *
+     * @param filePaths - 要上传的本地文件路径列表
+     * @param fileType - 文件类型（可选）
+     * @returns 上传结果列表
+     */
+    uploadMultiple(filePaths: string[], fileType?: string): Promise<UploadResult[]>;
+}
+export declare const ADP_UPLOAD_TOOL_NAME = "adp_upload_file";
+export declare const ADP_UPLOAD_TOOL_SCHEMA: {
+    title: string;
+    type: string;
+    description: string;
+    additionalProperties: boolean;
+    required: string[];
+    properties: {
+        paths: {
+            type: string;
+            minItems: number;
+            maxItems: number;
+            description: string;
+            items: {
+                type: string;
+                minLength: number;
+                description: string;
+            };
+        };
+        fileType: {
+            type: string;
+            description: string;
+        };
+    };
+};
+export declare const ADP_UPLOAD_TOOL_MAX_PATHS = 10;
+export declare const ADP_UPLOAD_TOOL_MIN_PATHS = 1;
+export declare const ADP_UPLOAD_TOOL_MAX_CONCURRENCY = 3;
+export declare const ADP_UPLOAD_VALIDATION_MESSAGE: string;
+interface ValidationError {
+    ok: false;
+    error: {
+        code: number;
+        message: string;
+        data: {
+            field: string;
+            reason: string;
+        };
+    };
+}
+interface ValidationSuccess<T> {
+    ok: true;
+    value: T;
+}
+type ValidationResult<T> = ValidationError | ValidationSuccess<T>;
+export interface AdpUploadToolParams {
+    paths: string[];
+    fileType?: string;
+}
+/**
+ * 解析 ADP 上传工具参数
+ */
+export declare const parseAdpUploadToolParams: (params: unknown) => ValidationResult<AdpUploadToolParams>;
+/** 成功上传的文件信息 */
+export interface UploadedFileInfo {
+    uri: string;
+    name: string;
+    mimeType: string;
+    downloadUrl?: string;
+}
+/** 完整上传结果 */
+export interface AdpUploadToolResult {
+    ok: boolean;
+    files?: UploadedFileInfo[];
+    /** 预格式化的消息，AI 可以直接展示给用户（不要用代码块包装） */
+    message?: string;
+    error?: {
+        code: number;
+        message: string;
+        data?: {
+            field: string;
+            reason: string;
+        };
+    };
+}
+export interface AdpUploadOptions {
+    botToken: string;
+    fileType?: string;
+    maxConcurrency?: number;
+    requestTimeoutMs?: number;
+}
+/**
+ * 上传文件到 ADP 存储（返回兼容 kimi 格式的结果）
+ *
+ * 注意：每个文件需要独立获取预签名URL，因为服务端为每个文件生成唯一路径
+ */
+export declare const uploadFilesToAdpEndpoint: (paths: string[], options: AdpUploadOptions) => Promise<AdpUploadToolResult>;
+/**
+ * 执行 ADP 上传工具（解析参数并上传）
+ */
+export declare const executeAdpUploadTool: (params: unknown, botToken: string, options?: Partial<AdpUploadOptions>) => Promise<AdpUploadToolResult>;
+export {};
+//# sourceMappingURL=adp-upload-tool.d.ts.map