@relaymessenger/openclaw-plugin 0.4.3-staging.6 → 0.4.3-staging.8

package/README.md

@@ -183,3 +183,11 @@ tarball, hashes it against the lock, and checks the installed SDK's version and
 types. Production publishes carry no npm attestation (Blacksmith runners), so
 the tarball bytes are the receipt. These are artifact compatibility checks,
 not a claim of a hosted Relay deployment test.
+
+## Add Relay with `openclaw channels add relay`
+
+```bash
+openclaw channels add relay --token <RELAY_AGENT_TOKEN> --base-url https://api.relayapp.im
+```
+
+OpenClaw prints: `Relay configured.`

package/dist/src/channel.js

@@ -1,4 +1,5 @@
 import { createChatChannelPlugin, } from "openclaw/plugin-sdk/channel-core";
+import { defineChannelSetupContract } from "openclaw/plugin-sdk/channel-setup";
 import { createMessageReceiptFromOutboundResults, defineChannelMessageAdapter, } from "openclaw/plugin-sdk/channel-outbound";
 import { chunkText } from "openclaw/plugin-sdk/reply-chunking";
 import { DEFAULT_ACCOUNT_ID, listRelayAccountIds, resolveDefaultRelayAccountId, resolveRelayAccount, } from "./accounts.js";
@@ -128,6 +129,24 @@ export const relayMessageAdapter = defineChannelMessageAdapter({
         },
     },
 });
+const RELAY_MISSING_TOKEN = `relay: account "default" has no Relay Agent Token`;
+const baseRelaySetupContract = defineChannelSetupContract({
+    adapter: {
+        applyAccountConfig: ({ cfg, accountId, input }) => {
+            const core = cfg;
+            const section = { ...core.channels?.relay };
+            const patch = input;
+            const relay = accountId === DEFAULT_ACCOUNT_ID ? { ...section, ...patch } : { ...section, accounts: { ...section.accounts, [accountId]: { ...section.accounts?.[accountId], ...patch } } };
+            return { ...cfg, channels: { ...core.channels, relay } };
+        },
+    },
+    fields: {
+        token: { kind: "string", sensitive: true, cli: { flags: "--token <token>", description: "Relay Agent Token" } },
+        baseUrl: { kind: "string", cli: { flags: "--base-url <url>", description: "Relay API origin" } },
+    },
+});
+export const relaySetupContract = { ...baseRelaySetupContract, parseInput: (input) => { const result = baseRelaySetupContract.parseInput(input); if (!result.ok || typeof result.value.token !== "string" || !result.value.token.trim())
+        return { ok: false, error: RELAY_MISSING_TOKEN }; return result; } };
 export const relayChannelPlugin = createChatChannelPlugin({
     base: {
         id: RELAY_CHANNEL_ID,
@@ -144,32 +163,7 @@ export const relayChannelPlugin = createChatChannelPlugin({
             blockStreaming: false,
         },
         reload: { configPrefixes: ["channels.relay"] },
-        setup: {
-            applyAccountConfig: ({ cfg, accountId, input }) => {
-                const core = cfg;
-                const section = { ...core.channels?.relay };
-                const patch = input;
-                const relay = !accountId || accountId === DEFAULT_ACCOUNT_ID
-                    ? { ...section, ...patch }
-                    : {
-                        ...section,
-                        accounts: {
-                            ...section.accounts,
-                            [accountId]: {
-                                ...section.accounts?.[accountId],
-                                ...patch,
-                            },
-                        },
-                    };
-                return {
-                    ...cfg,
-                    channels: {
-                        ...core.channels,
-                        relay,
-                    },
-                };
-            },
-        },
+        setupContract: relaySetupContract,
         config: {
             listAccountIds: (cfg) => listRelayAccountIds(cfg),
             resolveAccount: (cfg, accountId) => resolveRelayAccount({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relaymessenger/openclaw-plugin",
-  "version": "0.4.3-staging.6",
+  "version": "0.4.3-staging.8",
   "description": "Native Relay channel plugin for OpenClaw",
   "license": "MIT",
   "type": "module",

package/src/channel.ts

@@ -6,6 +6,7 @@ import {
   type ChannelPlugin,
   type OpenClawConfig,
 } from "openclaw/plugin-sdk/channel-core";
+import { defineChannelSetupContract } from "openclaw/plugin-sdk/channel-setup";
 import {
   createMessageReceiptFromOutboundResults,
   defineChannelMessageAdapter,
@@ -187,6 +188,26 @@ export const relayMessageAdapter = defineChannelMessageAdapter({
   },
 });
 
+const RELAY_MISSING_TOKEN = `relay: account "default" has no Relay Agent Token`;
+
+const baseRelaySetupContract = defineChannelSetupContract({
+  adapter: {
+    applyAccountConfig: ({ cfg, accountId, input }: { cfg: OpenClawConfig; accountId: string; input: unknown }) => {
+      const core = cfg as RelayCoreConfig;
+      const section = { ...core.channels?.relay };
+      const patch = input as Record<string, unknown>;
+      const relay = accountId === DEFAULT_ACCOUNT_ID ? { ...section, ...patch } : { ...section, accounts: { ...section.accounts, [accountId]: { ...section.accounts?.[accountId], ...patch } } };
+      return { ...cfg, channels: { ...core.channels, relay } } as OpenClawConfig;
+    },
+  },
+  fields: {
+    token: { kind: "string", sensitive: true, cli: { flags: "--token <token>", description: "Relay Agent Token" } },
+    baseUrl: { kind: "string", cli: { flags: "--base-url <url>", description: "Relay API origin" } },
+  },
+});
+
+export const relaySetupContract = { ...baseRelaySetupContract, parseInput: (input: unknown) => { const result = baseRelaySetupContract.parseInput(input); if (!result.ok || typeof (result.value as Record<string, unknown>).token !== "string" || !((result.value as Record<string, unknown>).token as string).trim()) return { ok: false as const, error: RELAY_MISSING_TOKEN }; return result; } };
+
 export const relayChannelPlugin: ChannelPlugin<ResolvedRelayAccount> =
   createChatChannelPlugin({
     base: {
@@ -204,33 +225,7 @@ export const relayChannelPlugin: ChannelPlugin<ResolvedRelayAccount> =
         blockStreaming: false,
       },
       reload: { configPrefixes: ["channels.relay"] },
-      setup: {
-        applyAccountConfig: ({ cfg, accountId, input }) => {
-          const core = cfg as RelayCoreConfig;
-          const section = { ...core.channels?.relay };
-          const patch = input as Record<string, unknown>;
-          const relay =
-            !accountId || accountId === DEFAULT_ACCOUNT_ID
-              ? { ...section, ...patch }
-              : {
-                  ...section,
-                  accounts: {
-                    ...section.accounts,
-                    [accountId]: {
-                      ...section.accounts?.[accountId],
-                      ...patch,
-                    },
-                  },
-                };
-          return {
-            ...cfg,
-            channels: {
-              ...core.channels,
-              relay,
-            },
-          } as OpenClawConfig;
-        },
-      },
+      setupContract: relaySetupContract,
       config: {
         listAccountIds: (cfg) =>
           listRelayAccountIds(cfg as RelayCoreConfig),