@cored-im/openclaw-plugin 0.1.0 → 0.1.1

package/README.md

@@ -8,7 +8,9 @@
 
 [中文](./README.zh.md) | English
 
-Cored IM channel plugin for OpenClaw. Connects a Cored bot to OpenClaw's AI agent pipeline so you can chat with your agent through Cored.
+Cored is a secure, self-hosted productivity platform for teams, integrating instant messaging, organizational structures, video conferencing, and file storage.
+
+Cored IM channel plugin for OpenClaw. Connects a Cored bot to OpenClaw's AI agent pipeline so you can chat with your agent through Cored. See the [Setup Tutorial](https://coredim.com/docs/admin/bots/openclaw) for how to connect Cored to OpenClaw.
 
 ## Features
 
@@ -50,7 +52,7 @@ Or manually edit `~/.openclaw/openclaw.json`:
     "cored": {
       "appId": "your_app_id",
       "appSecret": "your_app_secret",
-      "backendUrl": "http://your-cored-backend:21000"
+      "backendUrl": "https://your-backend-url.com"
     }
   }
 }
@@ -70,13 +72,13 @@ openclaw gateway restart
     "cored": {
       "appId": "111111",
       "appSecret": "secret-1",
-      "backendUrl": "http://backend-1:21000",
+      "backendUrl": "https://your-backend-url.com",
       "accounts": {
         "bot2": {
           "enabled": true,
           "appId": "222222",
           "appSecret": "secret-2",
-          "backendUrl": "http://backend-2:21000"
+          "backendUrl": "https://your-backend-url.com"
         }
       }
     }

package/README.zh.md

@@ -8,7 +8,9 @@
 
 中文 | [English](./README.md)
 
- IM 频道插件，用于 OpenClaw。将机器人接入 OpenClaw 的 AI Agent 管线，通过与 Agent 对话。
+Cored 是一个安全、可自托管的团队协作平台，集成了即时通讯、组织架构、音视频会议和文件存储等功能。
+
+ IM 频道插件，用于 OpenClaw。将机器人接入 OpenClaw 的 AI Agent 管线，通过与 Agent 对话。请参阅[配置教程](https://coredim.com/docs/admin/bots/openclaw)了解如何将连接到 OpenClaw。
 
 ## 功能
 
@@ -50,7 +52,7 @@ openclaw channels add --channel cored
     "cored": {
       "appId": "your_app_id",
       "appSecret": "your_app_secret",
-      "backendUrl": "http://your-cored-backend:21000"
+      "backendUrl": "https://your-backend-url.com"
     }
   }
 }
@@ -70,13 +72,13 @@ openclaw gateway restart
     "cored": {
       "appId": "111111",
       "appSecret": "secret-1",
-      "backendUrl": "http://backend-1:21000",
+      "backendUrl": "https://your-backend-url.com",
       "accounts": {
         "bot2": {
           "enabled": true,
           "appId": "222222",
           "appSecret": "secret-2",
-          "backendUrl": "http://backend-2:21000"
+          "backendUrl": "https://your-backend-url.com"
         }
       }
     }

package/openclaw.plugin.json

@@ -0,0 +1,60 @@
+{
+  "id": "openclaw-cored",
+  "name": "Cored Channel",
+  "version": "0.1.0",
+  "channels": ["cored"],
+  "configSchema": {
+    "type": "object",
+    "properties": {
+      "appId": {
+        "type": "string",
+        "description": "Cored application ID"
+      },
+      "appSecret": {
+        "type": "string",
+        "description": "Cored application secret"
+      },
+      "backendUrl": {
+        "type": "string",
+        "description": "Cored backend URL (e.g., https://your-backend-url.com)"
+      },
+      "enableEncryption": {
+        "type": "boolean",
+        "description": "Enable message encryption",
+        "default": true
+      },
+      "requestTimeout": {
+        "type": "number",
+        "description": "Request timeout in milliseconds",
+        "default": 30000
+      },
+      "requireMention": {
+        "type": "boolean",
+        "description": "Require @mention in group chats before responding",
+        "default": true
+      },
+      "accounts": {
+        "type": "object",
+        "description": "Multi-account configuration",
+        "additionalProperties": {
+          "type": "object",
+          "properties": {
+            "appId": { "type": "string" },
+            "appSecret": { "type": "string" },
+            "backendUrl": { "type": "string" },
+            "enableEncryption": { "type": "boolean" },
+            "requestTimeout": { "type": "number" },
+            "requireMention": { "type": "boolean" },
+            "enabled": { "type": "boolean", "default": true }
+          },
+          "required": ["appId", "appSecret", "backendUrl"]
+        }
+      }
+    }
+  },
+  "uiHints": {
+    "appId": { "label": "App ID" },
+    "appSecret": { "label": "App Secret", "sensitive": true },
+    "backendUrl": { "label": "Backend URL", "placeholder": "https://your-backend-url.com" }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cored-im/openclaw-plugin",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Cored IM channel plugin for OpenClaw",
   "author": "Cored Limited",
   "type": "module",
@@ -22,7 +22,8 @@
   "sideEffects": false,
   "files": [
     "dist",
-    "src"
+    "src",
+    "openclaw.plugin.json"
   ],
   "openclaw": {
     "extensions": [

package/src/config.test.ts

@@ -54,7 +54,7 @@ describe("resolveAccountConfig", () => {
         cored: {
           appId: "app_1",
           appSecret: "secret_1",
-          backendUrl: "https://api.cored.im",
+          backendUrl: "https://your-backend-url.com",
         },
       },
     };
@@ -64,7 +64,7 @@ describe("resolveAccountConfig", () => {
       enabled: true,
       appId: "app_1",
       appSecret: "secret_1",
-      backendUrl: "https://api.cored.im",
+      backendUrl: "https://your-backend-url.com",
       enableEncryption: true,
       requestTimeout: 30_000,
       requireMention: true,
@@ -102,13 +102,13 @@ describe("resolveAccountConfig", () => {
 
     process.env.CORED_APP_ID = "env_app";
     process.env.CORED_APP_SECRET = "env_secret";
-    process.env.CORED_BACKEND_URL = "http://env.cored.im";
+    process.env.CORED_BACKEND_URL = "https://your-backend-url.com";
 
     try {
       const account = resolveAccountConfig({});
       expect(account.appId).toBe("env_app");
       expect(account.appSecret).toBe("env_secret");
-      expect(account.backendUrl).toBe("http://env.cored.im");
+      expect(account.backendUrl).toBe("https://your-backend-url.com");
     } finally {
       if (origId === undefined) delete process.env.CORED_APP_ID;
       else process.env.CORED_APP_ID = origId;
@@ -213,7 +213,7 @@ describe("resolveAndValidateAccountConfig", () => {
         cored: {
           appId: "app_1",
           appSecret: "secret_1",
-          backendUrl: "https://api.cored.im",
+          backendUrl: "https://your-backend-url.com",
         },
       },
     };

package/src/messaging/inbound.test.ts

@@ -29,7 +29,7 @@ function makeAccount(
     enabled: true,
     appId: "app_test",
     appSecret: "secret",
-    backendUrl: "https://api.cored.test",
+    backendUrl: "https://your-backend-url.com",
     enableEncryption: true,
     requestTimeout: 30_000,
     requireMention: true,