rol-websocket-channel 1.4.2 → 1.4.8

package/dist/src/admin/methods/pairing.js

@@ -1,268 +1,268 @@
-import { execFile } from 'node:child_process';
-import path from 'node:path';
-import { promisify } from 'node:util';
-import { pathExists, readJsonFile, writeJsonFile } from '../lib/fs.js';
-import { JsonRpcException, JSON_RPC_ERRORS } from '../jsonrpc.js';
-const execFileAsync = promisify(execFile);
-const DEFAULT_PLUGIN_ID = 'rol-websocket-channel';
-const DEFAULT_PRODUCTION_BASE_URL = 'https://api.deotaland.ai';
-const PAIR_ENDPOINT_PATH = '/api-core-bot/front/agent/agent/key/query';
-const GATEWAY_SERVICE = 'openclaw-gateway.service';
-export async function pairWithKey(options, context) {
-    const key = options.key.trim();
-    if (!key) {
-        throwPairingError('PAIR_KEY_REQUIRED', 'pair key is required');
-    }
-    const configPath = path.join(context.openclawRoot, 'openclaw.json');
-    const config = await loadConfig(configPath);
-    const existingMqttUrl = resolveExistingMqttUrl(config);
-    const endpoint = buildPairEndpoint(options.endpoint, config);
-    const payload = await exchangePairKey(key, endpoint, options.auth, existingMqttUrl);
-    applyPairingConfig(config, key, payload);
-    await writeJsonFile(configPath, config);
-    const restart = await restartGateway(context.projectRoot);
-    return {
-        ok: true,
-        openclawRoot: context.openclawRoot,
-        configFile: configPath,
-        pluginId: payload.pluginId,
-        pairingEndpoint: endpoint,
-        updated: [
-            'plugins.allow',
-            `plugins.entries.${payload.pluginId}`,
-            `channels.${payload.pluginId}`
-        ],
-        channel: payload.channel,
-        restart
-    };
-}
-async function loadConfig(configPath) {
-    if (!(await pathExists(configPath))) {
-        throwPairingError('PAIR_CONFIG_NOT_FOUND', `openclaw.json not found: ${configPath}`);
-    }
-    return await readJsonFile(configPath);
-}
-async function exchangePairKey(key, endpoint, authOverride, existingMqttUrl) {
-    const auth = pickString(authOverride);
-    const headers = {
-        'Content-Type': 'application/json'
-    };
-    if (auth) {
-        headers.Authorization = auth;
-    }
-    const response = await fetch(endpoint, {
-        method: 'POST',
-        headers,
-        body: JSON.stringify({ key })
-    });
-    const rawText = await response.text();
-    const payload = tryParseJson(rawText);
-    if (!response.ok) {
-        throw new JsonRpcException(JSON_RPC_ERRORS.internalError, `pair exchange failed: ${response.status}`, {
-            code: 'PAIR_EXCHANGE_FAILED',
-            endpoint,
-            status: response.status,
-            payload
-        });
-    }
-    return normalizePairingPayload(payload, endpoint, existingMqttUrl);
-}
-function normalizePairingPayload(raw, endpoint, existingMqttUrl) {
-    const root = unwrapPayload(raw);
-    const pluginId = pickString(root.pluginId) ?? DEFAULT_PLUGIN_ID;
-    const apiCoreBotValue = isRecord(root.apiCoreBot) ? root.apiCoreBot : {};
-    const channelValue = isRecord(root.channel) ? root.channel : {};
-    const apiCoreBotAuthToken = pickString(apiCoreBotValue.authToken)
-        ?? pickString(root.authToken)
-        ?? pickString(root.token);
-    const rawValue = pickString(root.value);
-    const mqttUrl = pickString(channelValue.mqttUrl)
-        ?? pickString(root.mqttUrl)
-        ?? existingMqttUrl
-        ?? null;
-    if (!mqttUrl) {
-        throwPairingError('PAIR_CHANNEL_CONFIG_INVALID', 'mqttUrl is missing from pairing payload');
-    }
-    const mqttTopic = pickString(channelValue.mqttTopic)
-        ?? pickString(root.mqttTopic)
-        ?? rawValue
-        ?? 'announcement/tester';
-    const groupPolicy = normalizeGroupPolicy(pickString(channelValue.groupPolicy)
-        ?? pickString(channelValue.dmPolicy)
-        ?? pickString(root.groupPolicy)
-        ?? pickString(root.dmPolicy)
-        ?? 'pairing');
-    return {
-        pluginId,
-        pairing: {
-            ...(rawValue ? { rawValue } : {})
-        },
-        apiCoreBot: {
-            baseUrl: pickString(apiCoreBotValue.baseUrl) ?? inferBaseUrl(endpoint),
-            ...(apiCoreBotAuthToken ? { authToken: apiCoreBotAuthToken } : {})
-        },
-        channel: {
-            mqttUrl,
-            mqttTopic,
-            groupPolicy
-        }
-    };
-}
-function applyPairingConfig(config, key, payload) {
-    if (!config.plugins)
-        config.plugins = {};
-    if (!Array.isArray(config.plugins.allow))
-        config.plugins.allow = [];
-    if (!config.plugins.allow.includes(payload.pluginId)) {
-        config.plugins.allow.push(payload.pluginId);
-    }
-    if (!config.plugins.entries || typeof config.plugins.entries !== 'object') {
-        config.plugins.entries = {};
-    }
-    const existingPluginEntry = isRecord(config.plugins.entries[payload.pluginId])
-        ? config.plugins.entries[payload.pluginId]
-        : {};
-    const existingPluginConfig = isRecord(existingPluginEntry.config) ? existingPluginEntry.config : {};
-    config.plugins.entries[payload.pluginId] = {
-        ...existingPluginEntry,
-        enabled: true,
-        config: {
-            ...existingPluginConfig,
-            pairing: {
-                paired: true,
-                pairedAt: new Date().toISOString(),
-                pairingKeyLast4: key.slice(-4),
-                ...(payload.pairing.rawValue ? { rawValue: payload.pairing.rawValue } : {})
-            },
-            apiCoreBot: {
-                ...(isRecord(existingPluginConfig.apiCoreBot) ? existingPluginConfig.apiCoreBot : {}),
-                ...(payload.apiCoreBot.authToken ? { authToken: payload.apiCoreBot.authToken } : {})
-            }
-        }
-    };
-    if (!config.channels || typeof config.channels !== 'object') {
-        config.channels = {};
-    }
-    const existingChannelEntry = isRecord(config.channels[payload.pluginId])
-        ? config.channels[payload.pluginId]
-        : {};
-    const existingChannelConfig = isRecord(existingChannelEntry.config) ? existingChannelEntry.config : {};
-    config.channels[payload.pluginId] = {
-        ...existingChannelEntry,
-        enabled: true,
-        config: {
-            ...existingChannelConfig,
-            enabled: true,
-            mqttUrl: payload.channel.mqttUrl,
-            mqttTopic: payload.channel.mqttTopic ?? existingChannelConfig.mqttTopic ?? 'announcement/tester',
-            groupPolicy: payload.channel.groupPolicy
-        }
-    };
-}
-function unwrapPayload(raw) {
-    if (isRecord(raw)) {
-        if (isRecord(raw.data)) {
-            return raw.data;
-        }
-        return raw;
-    }
-    throwPairingError('PAIR_EXCHANGE_FAILED', 'unexpected pairing payload');
-}
-function tryParseJson(raw) {
-    const trimmed = raw.trim();
-    if (!trimmed) {
-        return {};
-    }
-    try {
-        return JSON.parse(trimmed);
-    }
-    catch {
-        return raw;
-    }
-}
-function buildPairEndpoint(endpointOverride, config) {
-    const override = pickString(endpointOverride);
-    if (override) {
-        return normalizePairEndpoint(override);
-    }
-    const configured = resolveConfiguredPairingEndpoint(config);
-    return normalizePairEndpoint(configured ?? DEFAULT_PRODUCTION_BASE_URL);
-}
-function resolveConfiguredPairingEndpoint(config) {
-    const pluginEntry = isRecord(config.plugins?.entries?.[DEFAULT_PLUGIN_ID])
-        ? config.plugins?.entries?.[DEFAULT_PLUGIN_ID]
-        : {};
-    const pluginConfig = isRecord(pluginEntry.config) ? pluginEntry.config : {};
-    const channelEntry = isRecord(config.channels?.[DEFAULT_PLUGIN_ID])
-        ? config.channels?.[DEFAULT_PLUGIN_ID]
-        : {};
-    const channelConfig = isRecord(channelEntry.config) ? channelEntry.config : {};
-    return pickString(pluginConfig.pairingEndpoint)
-        ?? pickString(channelEntry.pairingEndpoint)
-        ?? pickString(channelConfig.pairingEndpoint);
-}
-function normalizePairEndpoint(value) {
-    const trimmed = value.trim().replace(/\/+$/, '');
-    try {
-        const parsed = new URL(trimmed);
-        if (!parsed.pathname || parsed.pathname === '/') {
-            return `${trimmed}${PAIR_ENDPOINT_PATH}`;
-        }
-    }
-    catch {
-        // Keep non-URL values unchanged so the eventual fetch error reports the actual input.
-    }
-    return trimmed;
-}
-function inferBaseUrl(endpoint) {
-    try {
-        const parsed = new URL(endpoint);
-        return parsed.origin;
-    }
-    catch {
-        return DEFAULT_PRODUCTION_BASE_URL;
-    }
-}
-function resolveExistingMqttUrl(config) {
-    const channelConfig = config.channels?.[DEFAULT_PLUGIN_ID]?.config;
-    if (!channelConfig || typeof channelConfig !== 'object' || Array.isArray(channelConfig)) {
-        return null;
-    }
-    return pickString(channelConfig.mqttUrl);
-}
-async function restartGateway(cwd) {
-    try {
-        await execFileAsync('systemctl', ['--user', 'restart', GATEWAY_SERVICE], { cwd });
-        return {
-            attempted: true,
-            success: true
-        };
-    }
-    catch (error) {
-        return {
-            attempted: true,
-            success: false,
-            message: error instanceof Error ? error.message : String(error),
-            stderr: typeof error?.stderr === 'string' ? error.stderr : ''
-        };
-    }
-}
-function normalizeGroupPolicy(value) {
-    if (value === 'pairing' || value === 'allowlist' || value === 'open' || value === 'disabled') {
-        return value;
-    }
-    return 'pairing';
-}
-function pickString(value) {
-    if (typeof value !== 'string') {
-        return null;
-    }
-    const trimmed = value.trim();
-    return trimmed.length > 0 ? trimmed : null;
-}
-function isRecord(value) {
-    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
-}
-function throwPairingError(code, message) {
-    throw new JsonRpcException(JSON_RPC_ERRORS.invalidParams, message, { code });
-}
+import { execFile } from 'node:child_process';
+import path from 'node:path';
+import { promisify } from 'node:util';
+import { pathExists, readJsonFile, writeJsonFile } from '../lib/fs.js';
+import { JsonRpcException, JSON_RPC_ERRORS } from '../jsonrpc.js';
+const execFileAsync = promisify(execFile);
+const DEFAULT_PLUGIN_ID = 'rol-websocket-channel';
+const DEFAULT_PRODUCTION_BASE_URL = 'https://api.deotaland.ai';
+const PAIR_ENDPOINT_PATH = '/api-core-bot/front/agent/agent/key/query';
+const GATEWAY_SERVICE = 'openclaw-gateway.service';
+export async function pairWithKey(options, context) {
+    const key = options.key.trim();
+    if (!key) {
+        throwPairingError('PAIR_KEY_REQUIRED', 'pair key is required');
+    }
+    const configPath = path.join(context.openclawRoot, 'openclaw.json');
+    const config = await loadConfig(configPath);
+    const existingMqttUrl = resolveExistingMqttUrl(config);
+    const endpoint = buildPairEndpoint(options.endpoint, config);
+    const payload = await exchangePairKey(key, endpoint, options.auth, existingMqttUrl);
+    applyPairingConfig(config, key, payload);
+    await writeJsonFile(configPath, config);
+    const restart = await restartGateway(context.projectRoot);
+    return {
+        ok: true,
+        openclawRoot: context.openclawRoot,
+        configFile: configPath,
+        pluginId: payload.pluginId,
+        pairingEndpoint: endpoint,
+        updated: [
+            'plugins.allow',
+            `plugins.entries.${payload.pluginId}`,
+            `channels.${payload.pluginId}`
+        ],
+        channel: payload.channel,
+        restart
+    };
+}
+async function loadConfig(configPath) {
+    if (!(await pathExists(configPath))) {
+        throwPairingError('PAIR_CONFIG_NOT_FOUND', `openclaw.json not found: ${configPath}`);
+    }
+    return await readJsonFile(configPath);
+}
+async function exchangePairKey(key, endpoint, authOverride, existingMqttUrl) {
+    const auth = pickString(authOverride);
+    const headers = {
+        'Content-Type': 'application/json'
+    };
+    if (auth) {
+        headers.Authorization = auth;
+    }
+    const response = await fetch(endpoint, {
+        method: 'POST',
+        headers,
+        body: JSON.stringify({ key })
+    });
+    const rawText = await response.text();
+    const payload = tryParseJson(rawText);
+    if (!response.ok) {
+        throw new JsonRpcException(JSON_RPC_ERRORS.internalError, `pair exchange failed: ${response.status}`, {
+            code: 'PAIR_EXCHANGE_FAILED',
+            endpoint,
+            status: response.status,
+            payload
+        });
+    }
+    return normalizePairingPayload(payload, endpoint, existingMqttUrl);
+}
+function normalizePairingPayload(raw, endpoint, existingMqttUrl) {
+    const root = unwrapPayload(raw);
+    const pluginId = pickString(root.pluginId) ?? DEFAULT_PLUGIN_ID;
+    const apiCoreBotValue = isRecord(root.apiCoreBot) ? root.apiCoreBot : {};
+    const channelValue = isRecord(root.channel) ? root.channel : {};
+    const apiCoreBotAuthToken = pickString(apiCoreBotValue.authToken)
+        ?? pickString(root.authToken)
+        ?? pickString(root.token);
+    const rawValue = pickString(root.value);
+    const mqttUrl = pickString(channelValue.mqttUrl)
+        ?? pickString(root.mqttUrl)
+        ?? existingMqttUrl
+        ?? null;
+    if (!mqttUrl) {
+        throwPairingError('PAIR_CHANNEL_CONFIG_INVALID', 'mqttUrl is missing from pairing payload');
+    }
+    const mqttTopic = pickString(channelValue.mqttTopic)
+        ?? pickString(root.mqttTopic)
+        ?? rawValue
+        ?? 'announcement/tester';
+    const groupPolicy = normalizeGroupPolicy(pickString(channelValue.groupPolicy)
+        ?? pickString(channelValue.dmPolicy)
+        ?? pickString(root.groupPolicy)
+        ?? pickString(root.dmPolicy)
+        ?? 'pairing');
+    return {
+        pluginId,
+        pairing: {
+            ...(rawValue ? { rawValue } : {})
+        },
+        apiCoreBot: {
+            baseUrl: pickString(apiCoreBotValue.baseUrl) ?? inferBaseUrl(endpoint),
+            ...(apiCoreBotAuthToken ? { authToken: apiCoreBotAuthToken } : {})
+        },
+        channel: {
+            mqttUrl,
+            mqttTopic,
+            groupPolicy
+        }
+    };
+}
+function applyPairingConfig(config, key, payload) {
+    if (!config.plugins)
+        config.plugins = {};
+    if (!Array.isArray(config.plugins.allow))
+        config.plugins.allow = [];
+    if (!config.plugins.allow.includes(payload.pluginId)) {
+        config.plugins.allow.push(payload.pluginId);
+    }
+    if (!config.plugins.entries || typeof config.plugins.entries !== 'object') {
+        config.plugins.entries = {};
+    }
+    const existingPluginEntry = isRecord(config.plugins.entries[payload.pluginId])
+        ? config.plugins.entries[payload.pluginId]
+        : {};
+    const existingPluginConfig = isRecord(existingPluginEntry.config) ? existingPluginEntry.config : {};
+    config.plugins.entries[payload.pluginId] = {
+        ...existingPluginEntry,
+        enabled: true,
+        config: {
+            ...existingPluginConfig,
+            pairing: {
+                paired: true,
+                pairedAt: new Date().toISOString(),
+                pairingKeyLast4: key.slice(-4),
+                ...(payload.pairing.rawValue ? { rawValue: payload.pairing.rawValue } : {})
+            },
+            apiCoreBot: {
+                ...(isRecord(existingPluginConfig.apiCoreBot) ? existingPluginConfig.apiCoreBot : {}),
+                ...(payload.apiCoreBot.authToken ? { authToken: payload.apiCoreBot.authToken } : {})
+            }
+        }
+    };
+    if (!config.channels || typeof config.channels !== 'object') {
+        config.channels = {};
+    }
+    const existingChannelEntry = isRecord(config.channels[payload.pluginId])
+        ? config.channels[payload.pluginId]
+        : {};
+    const existingChannelConfig = isRecord(existingChannelEntry.config) ? existingChannelEntry.config : {};
+    config.channels[payload.pluginId] = {
+        ...existingChannelEntry,
+        enabled: true,
+        config: {
+            ...existingChannelConfig,
+            enabled: true,
+            mqttUrl: payload.channel.mqttUrl,
+            mqttTopic: payload.channel.mqttTopic ?? existingChannelConfig.mqttTopic ?? 'announcement/tester',
+            groupPolicy: payload.channel.groupPolicy
+        }
+    };
+}
+function unwrapPayload(raw) {
+    if (isRecord(raw)) {
+        if (isRecord(raw.data)) {
+            return raw.data;
+        }
+        return raw;
+    }
+    throwPairingError('PAIR_EXCHANGE_FAILED', 'unexpected pairing payload');
+}
+function tryParseJson(raw) {
+    const trimmed = raw.trim();
+    if (!trimmed) {
+        return {};
+    }
+    try {
+        return JSON.parse(trimmed);
+    }
+    catch {
+        return raw;
+    }
+}
+function buildPairEndpoint(endpointOverride, config) {
+    const override = pickString(endpointOverride);
+    if (override) {
+        return normalizePairEndpoint(override);
+    }
+    const configured = resolveConfiguredPairingEndpoint(config);
+    return normalizePairEndpoint(configured ?? DEFAULT_PRODUCTION_BASE_URL);
+}
+function resolveConfiguredPairingEndpoint(config) {
+    const pluginEntry = isRecord(config.plugins?.entries?.[DEFAULT_PLUGIN_ID])
+        ? config.plugins?.entries?.[DEFAULT_PLUGIN_ID]
+        : {};
+    const pluginConfig = isRecord(pluginEntry.config) ? pluginEntry.config : {};
+    const channelEntry = isRecord(config.channels?.[DEFAULT_PLUGIN_ID])
+        ? config.channels?.[DEFAULT_PLUGIN_ID]
+        : {};
+    const channelConfig = isRecord(channelEntry.config) ? channelEntry.config : {};
+    return pickString(pluginConfig.pairingEndpoint)
+        ?? pickString(channelEntry.pairingEndpoint)
+        ?? pickString(channelConfig.pairingEndpoint);
+}
+function normalizePairEndpoint(value) {
+    const trimmed = value.trim().replace(/\/+$/, '');
+    try {
+        const parsed = new URL(trimmed);
+        if (!parsed.pathname || parsed.pathname === '/') {
+            return `${trimmed}${PAIR_ENDPOINT_PATH}`;
+        }
+    }
+    catch {
+        // Keep non-URL values unchanged so the eventual fetch error reports the actual input.
+    }
+    return trimmed;
+}
+function inferBaseUrl(endpoint) {
+    try {
+        const parsed = new URL(endpoint);
+        return parsed.origin;
+    }
+    catch {
+        return DEFAULT_PRODUCTION_BASE_URL;
+    }
+}
+function resolveExistingMqttUrl(config) {
+    const channelConfig = config.channels?.[DEFAULT_PLUGIN_ID]?.config;
+    if (!channelConfig || typeof channelConfig !== 'object' || Array.isArray(channelConfig)) {
+        return null;
+    }
+    return pickString(channelConfig.mqttUrl);
+}
+async function restartGateway(cwd) {
+    try {
+        await execFileAsync('systemctl', ['--user', 'restart', GATEWAY_SERVICE], { cwd });
+        return {
+            attempted: true,
+            success: true
+        };
+    }
+    catch (error) {
+        return {
+            attempted: true,
+            success: false,
+            message: error instanceof Error ? error.message : String(error),
+            stderr: typeof error?.stderr === 'string' ? error.stderr : ''
+        };
+    }
+}
+function normalizeGroupPolicy(value) {
+    if (value === 'pairing' || value === 'allowlist' || value === 'open' || value === 'disabled') {
+        return value;
+    }
+    return 'pairing';
+}
+function pickString(value) {
+    if (typeof value !== 'string') {
+        return null;
+    }
+    const trimmed = value.trim();
+    return trimmed.length > 0 ? trimmed : null;
+}
+function isRecord(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+function throwPairingError(code, message) {
+    throw new JsonRpcException(JSON_RPC_ERRORS.invalidParams, message, { code });
+}