@bajoseek/openclaw-bajoseek 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bajoseek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,170 @@
+# Bajoseek OpenClaw Plugin
+
+[中文文档](./README_zh.md)
+
+A channel plugin for [OpenClaw](https://github.com/openclaw/openclaw) that connects AI assistants to the Bajoseek App via WebSocket.
+
+## Compatibility
+
+| OpenClaw Version | Support |
+|---|---|
+| 3.24+ (new Plugin SDK) | Fully supported — uses `ChannelSetupWizard` |
+| 3.13 (legacy Plugin SDK) | Fully supported — uses `ChannelOnboardingAdapter` |
+
+The plugin detects the OpenClaw version at runtime and automatically loads the appropriate setup adapter.
+
+## Features
+
+- **Real-time WebSocket Communication** — Bidirectional messaging between OpenClaw AI agents and Bajoseek users
+- **Block Streaming** — Progressive chunked response delivery for better responsiveness on long replies
+- **Auto-Reconnect** — Exponential backoff reconnection (1s → 2s → 5s → 10s → 30s → 60s)
+- **Per-User Message Queue** — Isolated queues per user (max 20 messages/user, 10 concurrent users)
+- **Heartbeat** — Periodic ping every 30 seconds to keep connections alive
+- **Multi-Account** — Run multiple Bajoseek bot accounts from a single OpenClaw instance
+- **3-Level Token Fallback** — Config file → token file → environment variable
+
+## Quick Start
+
+### Install
+
+```bash
+npm install @bajoseek/openclaw-bajoseek
+```
+
+### Configure
+
+Set environment variables:
+
+```bash
+export BAJOSEEK_BOT_ID="your-bot-id"
+export BAJOSEEK_TOKEN="your-token"
+```
+
+Or add to your OpenClaw config file:
+
+```yaml
+channels:
+  bajoseek:
+    enabled: true
+    botId: "your-bot-id"
+    token: "your-token"
+```
+
+### Interactive Setup
+
+Run the OpenClaw onboard wizard — it will guide you through BotID, Token, WebSocket URL, and block streaming options.
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Description |
+|---|---|
+| `BAJOSEEK_BOT_ID` | Bot ID (default account only) |
+| `BAJOSEEK_TOKEN` | Auth token (default account only) |
+
+### Config Fields
+
+| Field | Type | Default | Description |
+|---|---|---|---|
+| `enabled` | boolean | `true` | Enable/disable channel |
+| `botId` | string | — | Bajoseek bot ID |
+| `token` | string | — | Auth token |
+| `tokenFile` | string | — | Path to file containing token |
+| `wsUrl` | string | `wss://ws.bajoseek.com` | WebSocket server URL |
+| `allowFrom` | string[] | `["*"]` | Message source allowlist |
+| `blockStreaming` | boolean | `true` | Enable chunked streaming |
+| `name` | string | — | Account display name |
+
+### Multi-Account
+
+```yaml
+channels:
+  bajoseek:
+    enabled: true
+    botId: "default-bot-id"
+    token: "default-token"
+    accounts:
+      staging:
+        botId: "staging-bot-id"
+        token: "staging-token"
+        wsUrl: "wss://staging.bajoseek.com"
+      production:
+        botId: "prod-bot-id"
+        tokenFile: "/secrets/bajoseek-token"
+```
+
+## WebSocket Protocol
+
+### Inbound (Server → Plugin)
+
+| Type | Fields | Description |
+|---|---|---|
+| `message` | `messageId`, `userId`, `conversationId`, `text`, `timestamp` | User message |
+| `pong` | — | Heartbeat response |
+| `error` | `code`, `message` | Server error |
+
+### Outbound (Plugin → Server)
+
+| Type | Fields | Description |
+|---|---|---|
+| `stream_chunk` | `conversationId`, `text` | Partial response (non-final) |
+| `stream_end` | `conversationId`, `text` | Final response block |
+| `reply` | `to`, `text`, `replyToId?` | Direct reply message |
+| `ping` | — | Heartbeat |
+
+### Authentication
+
+WebSocket upgrade headers:
+- `X-Bot-Id: <botId>`
+- `Authorization: Bearer <token>`
+
+### Target Address Format
+
+```
+bajoseek:user:<userId>
+```
+
+Accepted inputs: `bajoseek:user:alice`, `user:alice`, or `alice`.
+
+## Channel Capabilities
+
+| Capability | Support |
+|---|---|
+| Direct Messages | Yes |
+| Group Chat | No |
+| Media | No |
+| Reactions | No |
+| Threads | No |
+| Block Streaming | Yes |
+
+## Development
+
+### Build
+
+```bash
+npm run build    # Compile TypeScript
+npm run dev      # Watch mode
+```
+
+### Project Structure
+
+```
+index.ts              # Plugin entry point (register pattern, compatible with both versions)
+setup-entry.ts        # Setup-only entry point
+src/
+  channel.ts          # ChannelPlugin implementation (dynamically loads setupWizard / onboarding)
+  gateway.ts          # WebSocket connection & message dispatch
+  outbound.ts         # Message sending utilities
+  config.ts           # Account config resolution (3-level token fallback)
+  runtime.ts          # Plugin runtime singleton
+  onboarding.ts       # Legacy ChannelOnboardingAdapter (OpenClaw 3.13)
+  setup-surface.ts    # Interactive ChannelSetupWizard (OpenClaw 3.24+)
+  setup-core.ts       # CLI setup adapter (OpenClaw 3.24+)
+  sdk-compat.ts       # SDK compatibility layer (local config helpers)
+  types.ts            # TypeScript interfaces
+```
+
+## License
+
+MIT

package/index.ts

@@ -1,25 +1,35 @@
-import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
-import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+/**
+ * Plugin entry point — 插件主入口
+ *
+ * Compatible with both old (3.13) and new (3.24+) OpenClaw versions.
+ * 兼容新旧版 OpenClaw。
+ *
+ * Uses the `register(api)` pattern which both versions' loaders support:
+ * 使用两个版本的加载器都支持的 `register(api)` 模式：
+ *   - New (3.24+): loader calls `register` (same as `defineChannelPluginEntry` produces).
+ *     新版加载器调用 `register`（与 `defineChannelPluginEntry` 产出一致）。
+ *   - Old (3.13):  loader calls `register` or `activate`.
+ *     旧版加载器调用 `register` 或 `activate`。
+ */
 
 import { bajoseekPlugin } from "./src/channel.js";
 import { setBajoseekRuntime } from "./src/runtime.js";
 
-const plugin = {
-  id: "bajoseek",
-  name: "Bajoseek",
-  description: "Bajoseek channel plugin",
-  configSchema: emptyPluginConfigSchema(),
-  register(api: OpenClawPluginApi) {
-    setBajoseekRuntime(api.runtime);
-    api.registerChannel({ plugin: bajoseekPlugin });
-  },
-};
-
-export default plugin;
-
+/* ── Public re-exports / 公共再导出 ── */
 export { bajoseekPlugin } from "./src/channel.js";
 export { setBajoseekRuntime, getBajoseekRuntime } from "./src/runtime.js";
 export * from "./src/types.js";
 export * from "./src/config.js";
 export * from "./src/gateway.js";
 export * from "./src/outbound.js";
+
+/* ── Default export — register pattern / 默认导出——register 模式 ── */
+export default {
+  id: "bajoseek",
+  name: "Bajoseek",
+  description: "Bajoseek channel plugin",
+  register(api: any) {
+    setBajoseekRuntime(api.runtime);
+    api.registerChannel(bajoseekPlugin);
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bajoseek/openclaw-bajoseek",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Bajoseek channel plugin for OpenClaw — connect AI assistants to Bajoseek via WebSocket",
   "type": "module",
   "main": "dist/index.js",
@@ -8,7 +8,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bajoseek/openclaw-bajoseek"
+    "url": "https://github.com/bajoseek/openclaw-bajoseek.git"
   },
   "keywords": [
     "openclaw",
@@ -22,6 +22,7 @@
     "dist",
     "src",
     "index.ts",
+    "setup-entry.ts",
     "tsconfig.json",
     "openclaw.plugin.json"
   ],
@@ -29,7 +30,21 @@
     "id": "bajoseek",
     "extensions": [
       "./index.ts"
-    ]
+    ],
+    "setupEntry": "./setup-entry.ts",
+    "channel": {
+      "id": "bajoseek",
+      "label": "Bajoseek",
+      "selectionLabel": "Bajoseek",
+      "docsPath": "/docs/channels/bajoseek",
+      "blurb": "Connect to Bajoseek App via WebSocket",
+      "order": 60
+    }
+  },
+  "scripts": {
+    "build": "tsc || true",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "ws": "^8.18.0"
@@ -44,9 +59,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "build": "tsc || true",
-    "dev": "tsc --watch"
   }
-}
+}

package/setup-entry.ts

@@ -0,0 +1,13 @@
+/**
+ * Setup-only entry point — Setup 专用入口
+ *
+ * Used by OpenClaw when only the interactive setup wizard is needed.
+ * 当 OpenClaw 仅需要交互式配置向导时使用此入口。
+ *
+ * Returns `{ plugin }` — the shape both old and new versions expect.
+ * 返回 `{ plugin }`——新旧版本都期望的结构。
+ */
+
+import { bajoseekPlugin } from "./src/channel.js";
+
+export default { plugin: bajoseekPlugin };