rol-websocket-channel 1.0.0 → 1.0.1

package/bin/rol.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+import { spawnSync } from 'node:child_process';
+
+const args = process.argv.slice(2);
+
+if (args.length === 0) {
+  printUsageAndExit(1);
+}
+
+const [command, ...rest] = args;
+
+if (command !== 'pair') {
+  printUsageAndExit(1);
+}
+
+if (rest.length === 0 || rest[0].startsWith('-')) {
+  printUsageAndExit(1);
+}
+
+const result = spawnSync('openclaw', ['admin-bridge', 'pair', ...rest], {
+  stdio: 'inherit',
+  shell: process.platform === 'win32'
+});
+
+if (result.error) {
+  process.stderr.write(`${result.error.message}\n`);
+  process.exit(1);
+}
+
+process.exit(result.status ?? 0);
+
+function printUsageAndExit(code) {
+  process.stderr.write('Usage: rol pair <key> [--endpoint <url>] [--auth <token>]\n');
+  process.exit(code);
+}

package/index.ts

@@ -30,7 +30,7 @@ interface WebSocketChannelAccount {
 // ============================================
 // 3. 全局状态
 // ============================================
-import { initializeContext } from "./src/shared/context.js";
+import { getContext, initializeContext } from "./src/shared/context.js";
 
 let pluginRuntime: any = null;
 
@@ -72,6 +72,33 @@ const WebSocketChannel: ChannelPlugin<WebSocketChannelAccount> = {
       additionalProperties: false,
       properties: {
         enabled: { type: "boolean" },
+        dmPolicy: {
+          type: "string",
+          enum: ["pairing", "allowlist", "open", "disabled"],
+        },
+        allowFrom: {
+          type: "array",
+          items: { type: "string" }
+        },
+        pairing: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            paired: { type: "boolean" },
+            pairedAt: { type: "string" },
+            pairingKeyLast4: { type: "string" },
+            userId: { type: "string" },
+            rawValue: { type: "string" }
+          }
+        },
+        apiCoreBot: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            baseUrl: { type: "string" },
+            authToken: { type: "string" }
+          }
+        },
         config: {
           type: "object",
           additionalProperties: false,
@@ -90,6 +117,10 @@ const WebSocketChannel: ChannelPlugin<WebSocketChannelAccount> = {
     },
     uiHints: {
       enabled: { label: "Enabled", description: "Enable MQTT Channel" },
+      dmPolicy: { label: "DM Policy", description: "Pairing/allowlist/open policy for direct messages" },
+      allowFrom: { label: "Allow From", description: "Allowed sender IDs when using allowlist or pairing mode" },
+      pairing: { label: "Pairing", description: "Pairing status and resolved identity info" },
+      apiCoreBot: { label: "API Core Bot", description: "Backend API endpoint and auth token used by the plugin" },
       config: { label: "Configuration", description: "MQTT connection configuration" },
       "config.enabled": { label: "Enabled", description: "Enable this configuration" },
       "config.mqttUrl": {
@@ -128,6 +159,8 @@ const WebSocketChannel: ChannelPlugin<WebSocketChannelAccount> = {
         mqttUrl: config.mqttUrl || "ws://192.168.1.23:8083/mqtt",
         mqttTopic: config.mqttTopic || "announcement/tester",
         enabled: config.enabled !== false,
+        dmPolicy: channelCfg.dmPolicy || config.groupPolicy || "open",
+        allowFrom: Array.isArray(channelCfg.allowFrom) ? channelCfg.allowFrom : [],
         groupPolicy: config.groupPolicy || "open",
       };
     },
@@ -504,6 +537,35 @@ function registerAdminBridgeCli(api: any) {
           }, null, 2) + '\n');
         }
       });
+
+    root
+      .command('pair <key>')
+      .description('Pair rol-websocket-channel and write OpenClaw configuration')
+      .option('--endpoint <url>', 'Pair exchange endpoint')
+      .option('--auth <token>', 'Authorization header value for pair exchange')
+      .action(async (key: string, options: { endpoint?: string; auth?: string }) => {
+        try {
+          const { pairWithKey } = await import('./src/admin/methods/pairing.js');
+          const result = await pairWithKey(
+            {
+              key,
+              endpoint: options.endpoint,
+              auth: options.auth
+            },
+            getContext()
+          );
+          process.stdout.write(JSON.stringify({ ok: true, result }, null, 2) + '\n');
+        } catch (error) {
+          process.exitCode = 1;
+          process.stderr.write(JSON.stringify({
+            ok: false,
+            error: {
+              message: error instanceof Error ? error.message : String(error),
+              code: (error as any)?.data?.code
+            }
+          }, null, 2) + '\n');
+        }
+      });
   }, {
     descriptors: [{
       name: 'admin-bridge',

package/message-handler.ts

@@ -10,7 +10,7 @@ import { createAgent, deleteAgent, listAgents, updateAgent } from './src/admin/m
 import { listSessions } from './src/admin/methods/sessions.js';
 import { getSession, prepareMessage, attachSkill } from './src/admin/methods/sessions-extended.js';
 import { getModels } from './src/admin/methods/models.js';
-import { updateModels } from './src/admin/methods/models-extended.js';
+import { setModel, updateModels } from './src/admin/methods/models-extended.js';
 import {
   getUsagePageSummary,
   getUsageTimeseries,
@@ -163,6 +163,13 @@ export class MessageHandler {
     });
   }
 
+  async modelsSet(data: any): Promise<any> {
+    return wrapAdminCall(async () => {
+      const context = getContext();
+      return await setModel(data, context);
+    });
+  }
+
   /**
    * 获取 usage summary
    */

package/openclaw.plugin.json

@@ -9,6 +9,52 @@
     "type": "object",
     "additionalProperties": false,
     "properties": {
+      "enabled": {
+        "type": "boolean"
+      },
+      "dmPolicy": {
+        "type": "string",
+        "enum": ["pairing", "allowlist", "open", "disabled"]
+      },
+      "allowFrom": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "pairing": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "paired": {
+            "type": "boolean"
+          },
+          "pairedAt": {
+            "type": "string"
+          },
+          "pairingKeyLast4": {
+            "type": "string"
+          },
+          "userId": {
+            "type": "string"
+          },
+          "rawValue": {
+            "type": "string"
+          }
+        }
+      },
+      "apiCoreBot": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "baseUrl": {
+            "type": "string"
+          },
+          "authToken": {
+            "type": "string"
+          }
+        }
+      },
       "channels": {
         "type": "object",
         "additionalProperties": false,
@@ -20,6 +66,49 @@
               "enabled": {
                 "type": "boolean"
               },
+              "pairing": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "paired": {
+                    "type": "boolean"
+                  },
+                  "pairedAt": {
+                    "type": "string"
+                  },
+                  "pairingKeyLast4": {
+                    "type": "string"
+                  },
+                  "userId": {
+                    "type": "string"
+                  },
+                  "rawValue": {
+                    "type": "string"
+                  }
+                }
+              },
+              "apiCoreBot": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "baseUrl": {
+                    "type": "string"
+                  },
+                  "authToken": {
+                    "type": "string"
+                  }
+                }
+              },
+              "dmPolicy": {
+                "type": "string",
+                "enum": ["pairing", "allowlist", "open", "disabled"]
+              },
+              "allowFrom": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
               "config": {
                 "type": "object",
                 "additionalProperties": false,
@@ -48,6 +137,26 @@
   },
 
   "uiHints": {
+    "enabled": {
+      "label": "Enabled",
+      "description": "Enable plugin config"
+    },
+    "pairing": {
+      "label": "Pairing",
+      "description": "Pairing status and resolved identity info"
+    },
+    "apiCoreBot": {
+      "label": "API Core Bot",
+      "description": "Backend API endpoint and auth token used by the plugin"
+    },
+    "dmPolicy": {
+      "label": "DM Policy",
+      "description": "Pairing/allowlist/open policy for direct messages"
+    },
+    "allowFrom": {
+      "label": "Allow From",
+      "description": "Allowed sender IDs when using allowlist or pairing mode"
+    },
     "channels": {
       "label": "Channels"
     },
@@ -58,6 +167,22 @@
       "label": "Enabled",
       "description": "Enable MQTT Channel"
     },
+    "channels.rol-websocket-channel.pairing": {
+      "label": "Pairing",
+      "description": "Pairing status and resolved identity info"
+    },
+    "channels.rol-websocket-channel.apiCoreBot": {
+      "label": "API Core Bot",
+      "description": "Backend API endpoint and auth token used by the plugin"
+    },
+    "channels.rol-websocket-channel.dmPolicy": {
+      "label": "DM Policy",
+      "description": "Pairing/allowlist/open policy for direct messages"
+    },
+    "channels.rol-websocket-channel.allowFrom": {
+      "label": "Allow From",
+      "description": "Allowed sender IDs when using allowlist or pairing mode"
+    },
     "channels.rol-websocket-channel.config": {
       "label": "Configuration",
       "description": "MQTT/WebSocket connection configuration"

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "rol-websocket-channel",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Unified OpenClaw plugin: MQTT Channel + Admin Bridge for remote management",
   "license": "MIT",
   "author": "nixgnehc",
   "type": "module",
+  "bin": {
+    "rol": "./bin/rol.js"
+  },
   "keywords": [
     "openclaw",
     "mqtt",

package/readme.md

@@ -1,7 +1,8 @@
 
 
 ```
-openclaw plugins install "c:\Users\admin\Desktop\openclaw-demo\rol-websocket-channel" --force
+openclaw plugins install rol-websocket-channel
+openclaw plugins install "c:\Users\admin\Desktop\openclaw-demo\websocket-channel" --force
 
 topic
 announcement/tester

package/src/admin/methods/index.ts

@@ -12,7 +12,7 @@ import {
   listMemoryFiles
 } from './memory.ts';
 import { getModels } from './models.ts';
-import { updateModels } from './models-extended.ts';
+import { setModel, updateModels } from './models-extended.ts';
 import { listSessions } from './sessions.ts';
 import { getSession, prepareMessage, attachSkill } from './sessions-extended.ts';
 import {
@@ -57,6 +57,7 @@ const methods = new Map<string, MethodHandler>([
   
   // Models
   ['models.get', getModels],
+  ['models.set', setModel],
   ['models.update', updateModels],
   
   // Usage

package/src/admin/methods/models-extended.ts

@@ -16,6 +16,7 @@ interface OpenClawConfig {
         provider?: string;
         [key: string]: any;
       };
+      models?: Record<string, any>;
       [key: string]: any;
     };
     [key: string]: any;
@@ -132,6 +133,67 @@ export const updateModels: MethodHandler = async (
   };
 };
 
+export const setModel: MethodHandler = async (
+  params,
+  context
+): Promise<JsonValue> => {
+  const objectParams = isObject(params) ? params : {};
+  const primary = pickString(objectParams.primary);
+  const provider = pickString(objectParams.provider);
+
+  if (!primary) {
+    throwModelError(
+      'MODEL_PRIMARY_REQUIRED',
+      'primary is required'
+    );
+  }
+
+  const inferredProvider = inferProviderFromPrimaryModel(primary);
+  if (!inferredProvider) {
+    throwModelError(
+      'MODEL_PRIMARY_INVALID',
+      'primary must be in provider/model format'
+    );
+  }
+
+  if (provider && provider !== inferredProvider) {
+    throwModelError(
+      'MODEL_PROVIDER_MISMATCH',
+      'provider does not match primary'
+    );
+  }
+
+  const configPath = path.join(context.openclawRoot, 'openclaw.json');
+  const config = await readJsonFile<OpenClawConfig>(configPath);
+
+  if (!isAllowedModel(config, primary)) {
+    throwModelError(
+      'MODEL_NOT_ALLOWED',
+      'model is not in allowed model options'
+    );
+  }
+
+  if (!config.agents) config.agents = {};
+  if (!config.agents.defaults) config.agents.defaults = {};
+  if (!config.agents.defaults.model) config.agents.defaults.model = {};
+
+  config.agents.defaults.model.primary = primary;
+  config.agents.defaults.model.provider = inferredProvider;
+
+  await writeJsonFile(configPath, config);
+
+  return {
+    ok: true,
+    model: {
+      primary,
+      provider: inferredProvider
+    },
+    defaults: {
+      model: config.agents.defaults.model
+    }
+  };
+};
+
 function inferProviderFromPrimaryModel(primaryModel: string): string | null {
   const slashIndex = primaryModel.indexOf('/');
   if (slashIndex <= 0) {
@@ -141,6 +203,29 @@ function inferProviderFromPrimaryModel(primaryModel: string): string | null {
   return primaryModel.slice(0, slashIndex);
 }
 
+function isAllowedModel(config: OpenClawConfig, primary: string): boolean {
+  const catalog = config.agents?.defaults?.models;
+  if (catalog && typeof catalog === 'object' && !Array.isArray(catalog)) {
+    return Object.prototype.hasOwnProperty.call(catalog, primary);
+  }
+
+  const currentPrimary = pickString(config.agents?.defaults?.model?.primary);
+  if (currentPrimary === primary) {
+    return true;
+  }
+
+  const agents = Array.isArray(config.agents?.list) ? config.agents.list : [];
+  return agents.some((agent: any) => pickString(agent?.model?.primary) === primary);
+}
+
+function throwModelError(errorCode: string, message: string): never {
+  throw new JsonRpcException(
+    JSON_RPC_ERRORS.invalidParams,
+    message,
+    { code: errorCode }
+  );
+}
+
 function pickString(value: JsonValue | undefined): string | null {
   if (typeof value !== 'string') {
     return null;

package/src/admin/methods/models.ts

@@ -6,7 +6,7 @@ import type { JsonValue, MethodHandler } from '../types.ts';
 interface OpenClawConfig {
   models?: {
     mode?: string;
-    providers?: JsonValue;
+    providers?: Record<string, any>;
   };
   agents?: {
     defaults?: {
@@ -15,6 +15,7 @@ interface OpenClawConfig {
         provider?: string;
         [key: string]: any;
       };
+      models?: Record<string, any>;
       [key: string]: any;
     };
     list?: Array<{
@@ -33,15 +34,19 @@ interface OpenClawConfig {
 export const getModels: MethodHandler = async (_params, context): Promise<JsonValue> => {
   const configPath = path.join(context.openclawRoot, 'openclaw.json');
   const config = await readJsonFile<OpenClawConfig>(configPath);
+  const agents = normalizeAgentModels(config);
+  const providers = config.models?.providers ?? {};
 
   return {
     sourceConfigFile: configPath,
     defaults: {
-      model: config.agents?.defaults?.model ?? {}
+      model: normalizeModelConfig(config.agents?.defaults?.model),
+      models: config.agents?.defaults?.models ?? {}
     },
-    agents: normalizeAgentModels(config),
+    agents,
+    modelOptions: buildModelOptions(config, providers, agents),
     modelConfigMode: config.models?.mode ?? null,
-    configuredProviders: redactSecrets(config.models?.providers ?? {})
+    configuredProviders: redactSecrets(providers)
   };
 };
 
@@ -50,7 +55,7 @@ function normalizeAgentModels(config: OpenClawConfig): JsonValue[] {
     {
       id: 'defaults',
       name: 'defaults',
-      model: config.agents?.defaults?.model ?? {}
+      model: normalizeModelConfig(config.agents?.defaults?.model)
     }
   ];
 
@@ -59,13 +64,188 @@ function normalizeAgentModels(config: OpenClawConfig): JsonValue[] {
     items.push({
       id: agent.id ?? null,
       name: agent.name ?? agent.id ?? null,
-      model: agent.model ?? {}
+      model: normalizeModelConfig(agent.model)
     });
   }
 
   return items;
 }
 
+function normalizeModelConfig(modelConfig: any): JsonValue {
+  if (!modelConfig || typeof modelConfig !== 'object' || Array.isArray(modelConfig)) {
+    return {};
+  }
+
+  const primary = pickString(modelConfig.primary);
+  const provider = pickString(modelConfig.provider);
+  const inferredProvider = primary && !provider ? inferProviderFromPrimaryModel(primary) : null;
+  return {
+    ...modelConfig,
+    ...(inferredProvider ? { provider: inferredProvider } : {})
+  };
+}
+
+function buildModelOptions(
+  config: OpenClawConfig,
+  providers: Record<string, any>,
+  agents: JsonValue[]
+): JsonValue[] {
+  const options = new Map<string, JsonValue>();
+  addCatalogModelOptions(options, providers, config.agents?.defaults?.models);
+  if (options.size === 0) {
+    addFallbackAgentModelOptions(options, providers, agents);
+  }
+  return Array.from(options.values());
+}
+
+function addCatalogModelOptions(
+  options: Map<string, JsonValue>,
+  providers: Record<string, any>,
+  catalog: Record<string, any> | undefined
+): void {
+  if (!catalog || typeof catalog !== 'object' || Array.isArray(catalog)) {
+    return;
+  }
+
+  for (const [modelId, modelConfig] of Object.entries(catalog)) {
+    const provider = inferProviderFromPrimaryModel(modelId);
+    const model = extractModelName(modelId, provider);
+    const providerConfig = provider ? providers[provider] : null;
+    const providerLabel = provider
+      ? (pickString(providerConfig?.label) ?? pickString(providerConfig?.name) ?? humanizeProviderId(provider))
+      : null;
+    const label = modelConfig && typeof modelConfig === 'object'
+      ? (pickString(modelConfig.alias) ?? pickString(modelConfig.label) ?? pickString(modelConfig.name) ?? humanizeModelId(model))
+      : humanizeModelId(model);
+
+    addModelOption(options, {
+      provider,
+      providerLabel,
+      model,
+      value: modelId,
+      label
+    });
+  }
+}
+
+function addFallbackAgentModelOptions(
+  options: Map<string, JsonValue>,
+  providers: Record<string, any>,
+  agents: JsonValue[]
+): void {
+  for (const agent of agents) {
+    if (!agent || typeof agent !== 'object' || Array.isArray(agent)) {
+      continue;
+    }
+
+    const modelConfig = agent.model;
+    if (!modelConfig || typeof modelConfig !== 'object' || Array.isArray(modelConfig)) {
+      continue;
+    }
+
+    const primary = pickString(modelConfig.primary);
+    if (!primary) {
+      continue;
+    }
+
+    const provider = pickString(modelConfig.provider) ?? inferProviderFromPrimaryModel(primary);
+    const model = extractModelName(primary, provider);
+    const providerConfig = provider ? providers[provider] : null;
+    const providerLabel = provider
+      ? (pickString(providerConfig?.label) ?? pickString(providerConfig?.name) ?? humanizeProviderId(provider))
+      : null;
+
+    addModelOption(options, {
+      provider,
+      providerLabel,
+      model,
+      value: primary,
+      label: humanizeModelId(model)
+    });
+  }
+}
+
+function addModelOption(
+  options: Map<string, JsonValue>,
+  input: {
+    provider: string | null;
+    providerLabel: string | null;
+    model: string;
+    label: string;
+    value?: string;
+  }
+): void {
+  const value = input.value ?? (input.provider ? `${input.provider}/${input.model}` : input.model);
+  if (options.has(value)) {
+    return;
+  }
+
+  options.set(value, {
+    label: input.label,
+    value,
+    provider: input.provider,
+    providerLabel: input.providerLabel,
+    model: input.model
+  });
+}
+
+function inferProviderFromPrimaryModel(primaryModel: string): string | null {
+  const slashIndex = primaryModel.indexOf('/');
+  if (slashIndex <= 0) {
+    return null;
+  }
+
+  return primaryModel.slice(0, slashIndex);
+}
+
+function extractModelName(primaryModel: string, provider: string | null): string {
+  if (provider && primaryModel.startsWith(`${provider}/`)) {
+    return primaryModel.slice(provider.length + 1);
+  }
+
+  const slashIndex = primaryModel.indexOf('/');
+  return slashIndex >= 0 ? primaryModel.slice(slashIndex + 1) : primaryModel;
+}
+
+function pickString(value: unknown): string | null {
+  if (typeof value !== 'string') {
+    return null;
+  }
+
+  const trimmed = value.trim();
+  return trimmed.length > 0 ? trimmed : null;
+}
+
+function humanizeProviderId(value: string): string {
+  const knownLabels: Record<string, string> = {
+    openai: 'OpenAI',
+    anthropic: 'Anthropic',
+    openrouter: 'OpenRouter'
+  };
+  if (knownLabels[value]) {
+    return knownLabels[value];
+  }
+
+  return value
+    .replace(/^custom[-_]/, '')
+    .split(/[-_.]+/)
+    .filter(Boolean)
+    .map(capitalizeWord)
+    .join(' ');
+}
+
+function humanizeModelId(value: string): string {
+  return value
+    .split(/[-_]+/)
+    .filter(Boolean)
+    .map((part) => (/^\d+(\.\d+)?$/.test(part) ? part : capitalizeWord(part)))
+    .join(' ');
+}
+
+function capitalizeWord(value: string): string {
+  return value.length > 0 ? `${value.charAt(0).toUpperCase()}${value.slice(1)}` : value;
+}
+
 function redactSecrets(value: JsonValue): JsonValue {
   if (Array.isArray(value)) {
     return value.map(redactSecrets);