@zeyiy/openclaw-channel 0.3.4

package/dist/tools.js

@@ -0,0 +1,131 @@
+import { getConnectedClient } from "./clients";
+import { sendFileToTarget, sendImageToTarget, sendTextToTarget, sendVideoToTarget } from "./media";
+import { parseTarget } from "./targets";
+import { formatSdkError } from "./utils";
+export function registerOpenIMTools(api) {
+    if (typeof api.registerTool !== "function")
+        return;
+    const ensureTargetAndClient = (params) => {
+        const target = parseTarget(params.target);
+        if (!target) {
+            return {
+                ok: false,
+                result: {
+                    content: [{ type: "text", text: "Invalid target format. Expected user:<id> or group:<id>." }],
+                },
+            };
+        }
+        const client = getConnectedClient(params.accountId);
+        if (!client) {
+            return {
+                ok: false,
+                result: {
+                    content: [{ type: "text", text: "OpenIM is not connected." }],
+                },
+            };
+        }
+        return { ok: true, target, client };
+    };
+    api.registerTool({
+        name: "openim_send_text",
+        description: "Send a text message via OpenIM. target format: user:ID or group:ID.",
+        parameters: {
+            type: "object",
+            properties: {
+                target: { type: "string", description: "user:123 or group:456" },
+                text: { type: "string", description: "Text to send" },
+                accountId: { type: "string", description: "Optional account ID. Defaults to `default` or the first connected account." },
+            },
+            required: ["target", "text"],
+        },
+        async execute(_id, params) {
+            const checked = ensureTargetAndClient(params);
+            if (!checked.ok)
+                return checked.result;
+            try {
+                await sendTextToTarget(checked.client, checked.target, params.text);
+                return { content: [{ type: "text", text: "Sent successfully" }] };
+            }
+            catch (e) {
+                return { content: [{ type: "text", text: `Send failed: ${formatSdkError(e)}` }] };
+            }
+        },
+    });
+    api.registerTool({
+        name: "openim_send_image",
+        description: "Send an image via OpenIM. `image` supports a local path or an http(s) URL.",
+        parameters: {
+            type: "object",
+            properties: {
+                target: { type: "string", description: "user:123 or group:456" },
+                image: { type: "string", description: "Local path (`file://` supported) or URL" },
+                accountId: { type: "string", description: "Optional account ID" },
+            },
+            required: ["target", "image"],
+        },
+        async execute(_id, params) {
+            const checked = ensureTargetAndClient(params);
+            if (!checked.ok)
+                return checked.result;
+            try {
+                await sendImageToTarget(checked.client, checked.target, params.image);
+                return { content: [{ type: "text", text: "Image sent successfully" }] };
+            }
+            catch (e) {
+                return { content: [{ type: "text", text: `Send failed: ${formatSdkError(e)}` }] };
+            }
+        },
+    });
+    api.registerTool({
+        name: "openim_send_video",
+        description: "Send a video via OpenIM (delivered as a file message). `video` supports a local path or URL.",
+        parameters: {
+            type: "object",
+            properties: {
+                target: { type: "string", description: "user:123 or group:456" },
+                video: { type: "string", description: "Local path (`file://` supported) or URL" },
+                name: { type: "string", description: "Optional filename (recommended for URL input)" },
+                accountId: { type: "string", description: "Optional account ID" },
+            },
+            required: ["target", "video"],
+        },
+        async execute(_id, params) {
+            const checked = ensureTargetAndClient(params);
+            if (!checked.ok)
+                return checked.result;
+            try {
+                await sendVideoToTarget(checked.client, checked.target, params.video, params.name);
+                return { content: [{ type: "text", text: "Video sent successfully as a file" }] };
+            }
+            catch (e) {
+                return { content: [{ type: "text", text: `Send failed: ${formatSdkError(e)}` }] };
+            }
+        },
+    });
+    api.registerTool({
+        name: "openim_send_file",
+        description: "Send a file via OpenIM. `file` supports a local path or URL; `name` is optional.",
+        parameters: {
+            type: "object",
+            properties: {
+                target: { type: "string", description: "user:123 or group:456" },
+                file: { type: "string", description: "Local path (`file://` supported) or URL" },
+                name: { type: "string", description: "Optional filename (recommended for URL input)" },
+                accountId: { type: "string", description: "Optional account ID" },
+            },
+            required: ["target", "file"],
+        },
+        async execute(_id, params) {
+            const checked = ensureTargetAndClient(params);
+            if (!checked.ok)
+                return checked.result;
+            try {
+                await sendFileToTarget(checked.client, checked.target, params.file, params.name);
+                return { content: [{ type: "text", text: "File sent successfully" }] };
+            }
+            catch (e) {
+                return { content: [{ type: "text", text: `Send failed: ${formatSdkError(e)}` }] };
+            }
+        },
+    });
+}

package/dist/types.d.ts

@@ -0,0 +1,96 @@
+import type { ApiService, CallbackEvent, MessageItem } from "@openim/client-sdk";
+export type ChatType = "direct" | "group";
+export interface OpenIMAccountConfig {
+    accountId: string;
+    enabled: boolean;
+    userID: string;
+    token: string;
+    wsAddr: string;
+    apiAddr: string;
+    platformID: number;
+    requireMention: boolean;
+    inboundWhitelist: string[];
+    botId?: string;
+    portalWsAddr?: string;
+}
+export interface OpenIMClientState {
+    sdk: ApiService;
+    config: OpenIMAccountConfig;
+    handlers: {
+        onRecvNewMessage: (event: CallbackEvent<MessageItem>) => void;
+        onRecvNewMessages: (event: CallbackEvent<MessageItem[]>) => void;
+        onRecvOfflineNewMessages: (event: CallbackEvent<MessageItem[]>) => void;
+    };
+}
+export interface ParsedTarget {
+    kind: "user" | "group";
+    id: string;
+}
+export interface InboundMediaItem {
+    kind: "image" | "video" | "file";
+    url?: string;
+    mimeType?: string;
+    fileName?: string;
+    size?: number;
+    snapshotUrl?: string;
+}
+export interface InboundBodyResult {
+    body: string;
+    kind: "text" | "image" | "video" | "file" | "mixed" | "unknown";
+    media?: InboundMediaItem[];
+}
+export type PortalMethod = "models.list" | "agents.list" | "agents.files.list" | "agents.files.get" | "agents.files.set" | "agents.create" | "ping";
+export interface PortalRequest {
+    id: string;
+    method: PortalMethod;
+    params: Record<string, unknown>;
+}
+export interface PortalResponse {
+    id: string;
+    result?: unknown;
+    error?: {
+        code: number;
+        message: string;
+    };
+}
+export interface PortalBridgeState {
+    ws: WebSocket | null;
+    accountId: string;
+    botId: string;
+    portalWsAddr: string;
+    reconnectTimer?: ReturnType<typeof setTimeout>;
+    heartbeatTimer?: ReturnType<typeof setInterval>;
+    stopped: boolean;
+}
+export interface ModelEntry {
+    id: string;
+    name: string;
+    provider: string;
+    contextWindow?: number;
+    reasoning?: boolean;
+    active?: boolean;
+}
+export interface AgentIdentity {
+    name?: string;
+    theme?: string;
+    emoji?: string;
+    avatar?: string;
+}
+export interface AgentSummary {
+    id: string;
+    name?: string;
+    identity?: AgentIdentity;
+    workspace?: string;
+    model?: {
+        primary?: string;
+        fallbacks?: string[];
+    };
+}
+export interface AgentFileEntry {
+    name: string;
+    path: string;
+    missing: boolean;
+    size?: number;
+    updatedAtMs?: number;
+    content?: string;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+export declare function safeStringify(value: unknown): string;
+export declare function formatSdkError(error: unknown): string;
+export declare function toFiniteNumber(value: unknown, fallback: number): number;

package/dist/utils.js

@@ -0,0 +1,31 @@
+export function safeStringify(value) {
+    try {
+        return JSON.stringify(value);
+    }
+    catch {
+        return String(value);
+    }
+}
+export function formatSdkError(error) {
+    const e = error;
+    const fields = [];
+    if (e?.event)
+        fields.push(`event=${e.event}`);
+    if (e?.errCode !== undefined)
+        fields.push(`errCode=${e.errCode}`);
+    if (e?.errMsg)
+        fields.push(`errMsg=${e.errMsg}`);
+    if (e?.operationID)
+        fields.push(`operationID=${e.operationID}`);
+    if (e?.data !== undefined && e?.data !== null)
+        fields.push(`data=${safeStringify(e.data)}`);
+    if (fields.length > 0)
+        return fields.join(", ");
+    if (e instanceof Error)
+        return e.message;
+    return safeStringify(error);
+}
+export function toFiniteNumber(value, fallback) {
+    const n = typeof value === "number" ? value : parseInt(String(value ?? ""), 10);
+    return Number.isFinite(n) ? n : fallback;
+}

package/openclaw.plugin.json

@@ -0,0 +1,116 @@
+{
+  "id": "openclaw-channel",
+  "name": "OpenIM Channel",
+  "version": "0.3.4",
+  "description": "OpenIM protocol channel for OpenClaw",
+  "author": "ZeyiY",
+  "channels": [
+    "openim"
+  ],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "enabled": {
+        "type": "boolean",
+        "default": true
+      },
+      "token": {
+        "type": "string",
+        "description": "OpenIM JWT token (used to derive userID/platformID when omitted)"
+      },
+      "wsAddr": {
+        "type": "string",
+        "description": "OpenIM WebSocket endpoint, e.g. ws://127.0.0.1:10001"
+      },
+      "apiAddr": {
+        "type": "string",
+        "description": "OpenIM API endpoint, e.g. http://127.0.0.1:10002"
+      },
+      "requireMention": {
+        "type": "boolean",
+        "default": true,
+        "description": "Whether replies in groups require mentioning the current account"
+      },
+      "inboundWhitelist": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "default": [],
+        "description": "Optional sender whitelist. When set, only direct messages from listed users or their @mentions in groups are processed."
+      },
+      "accounts": {
+        "type": "object",
+        "description": "Multi-account configuration keyed by accountId",
+        "additionalProperties": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "token": {
+              "type": "string",
+              "description": "OpenIM JWT token"
+            },
+            "wsAddr": {
+              "type": "string"
+            },
+            "apiAddr": {
+              "type": "string"
+            },
+            "requireMention": {
+              "type": "boolean",
+              "default": true
+            },
+            "inboundWhitelist": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "default": []
+            },
+            "botId": {
+              "type": "string",
+              "description": "Unique bot identifier for agent-portal WebSocket connection"
+            },
+            "portalWsAddr": {
+              "type": "string",
+              "description": "Agent-portal WebSocket endpoint, e.g. wss://portal.example.com/ws"
+            }
+          }
+        }
+      },
+      "botId": {
+        "type": "string",
+        "description": "Unique bot identifier for agent-portal WebSocket connection"
+      },
+      "portalWsAddr": {
+        "type": "string",
+        "description": "Agent-portal WebSocket endpoint, e.g. wss://portal.example.com/ws"
+      }
+    }
+  },
+  "uiHints": {
+    "token": {
+      "label": "Token",
+      "sensitive": true
+    },
+    "wsAddr": {
+      "label": "WebSocket Endpoint",
+      "placeholder": "ws://127.0.0.1:10001"
+    },
+    "apiAddr": {
+      "label": "API Endpoint",
+      "placeholder": "http://127.0.0.1:10002"
+    },
+    "requireMention": {
+      "label": "Require Mention in Group"
+    },
+    "inboundWhitelist": {
+      "label": "Inbound Sender Whitelist"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@zeyiy/openclaw-channel",
+  "version": "0.3.4",
+  "description": "OpenIM channel plugin for OpenClaw gateway (fork of @openim/openclaw-channel)",
+  "license": "AGPL-3.0-only",
+  "author": "ZeyiY",
+  "contributors": [
+    "blooming",
+    "zongzi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ZeyiY/openclaw-channel.git"
+  },
+  "homepage": "https://github.com/ZeyiY/openclaw-channel#readme",
+  "bugs": {
+    "url": "https://github.com/ZeyiY/openclaw-channel/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
+  "files": [
+    "dist",
+    "openclaw.plugin.json",
+    "README.md",
+    "README.zh-CN.md"
+  ],
+  "openclaw": {
+    "extensions": [
+      "./dist/index.js"
+    ],
+    "channel": {
+      "id": "openim",
+      "label": "OpenIM",
+      "selectionLabel": "OpenIM",
+      "docsPath": "/channels/openim",
+      "blurb": "OpenIM protocol channel via @openim/client-sdk",
+      "order": 86,
+      "aliases": [
+        "openim",
+        "im"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test:connect": "tsx scripts/test-connect.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@clack/prompts": "^1.0.0",
+    "@openim/client-sdk": "^3.8.3"
+  },
+  "peerDependencies": {
+    "clawdbot": "*",
+    "openclaw": "*"
+  },
+  "peerDependenciesMeta": {
+    "clawdbot": {
+      "optional": true
+    },
+    "openclaw": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.4.0"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}