clawrelay 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clawrelay",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Channel relay plugin for OpenClaw — receives messages from an always-on relay proxy",
   "main": "src/index.ts",
   "type": "module",

package/src/channel.ts

@@ -3,6 +3,7 @@
 import type { RelayAccount, RelayInboundMessage, RelayOutboundMessage, ReplyFn } from './types.js';
 import { InboundServer } from './inbound-server.js';
 import { getRelayRuntime } from './runtime.js';
+import { relayOnboardingAdapter } from './onboarding.js';
 
 const CHANNEL_ID = 'relay' as const;
 
@@ -24,6 +25,8 @@ export function createRelayChannel(api: any) {
       aliases: ['relay'],
     },
 
+    onboarding: relayOnboardingAdapter,
+
     capabilities: {
       chatTypes: ['direct', 'group'],
       media: {

package/src/onboarding.ts

@@ -0,0 +1,251 @@
+import type {
+  ChannelOnboardingAdapter,
+  OpenClawConfig,
+  WizardPrompter,
+} from "openclaw/plugin-sdk";
+import {
+  DEFAULT_ACCOUNT_ID,
+  normalizeAccountId,
+  promptAccountId,
+} from "openclaw/plugin-sdk";
+import crypto from "node:crypto";
+
+const channel = "relay" as const;
+
+function generateAuthToken(): string {
+  const bytes = crypto.randomBytes(24);
+  return `crly_${bytes.toString("base64url")}`;
+}
+
+function setRelayAccountConfig(
+  cfg: OpenClawConfig,
+  accountId: string,
+  defaultPatch: Record<string, unknown>,
+  accountPatch: Record<string, unknown> = defaultPatch,
+): OpenClawConfig {
+  if (accountId === DEFAULT_ACCOUNT_ID) {
+    return {
+      ...cfg,
+      channels: {
+        ...cfg.channels,
+        relay: {
+          ...cfg.channels?.relay,
+          enabled: true,
+          ...defaultPatch,
+        },
+      },
+    } as OpenClawConfig;
+  }
+  return {
+    ...cfg,
+    channels: {
+      ...cfg.channels,
+      relay: {
+        ...cfg.channels?.relay,
+        enabled: true,
+        accounts: {
+          ...cfg.channels?.relay?.accounts,
+          [accountId]: {
+            ...cfg.channels?.relay?.accounts?.[accountId],
+            enabled: cfg.channels?.relay?.accounts?.[accountId]?.enabled ?? true,
+            ...accountPatch,
+          },
+        },
+      },
+    },
+  } as OpenClawConfig;
+}
+
+function listRelayAccountIds(cfg: OpenClawConfig): string[] {
+  return Object.keys((cfg.channels as any)?.relay?.accounts ?? {});
+}
+
+function resolveDefaultRelayAccountId(cfg: OpenClawConfig): string {
+  const ids = listRelayAccountIds(cfg);
+  if (ids.includes(DEFAULT_ACCOUNT_ID)) return DEFAULT_ACCOUNT_ID;
+  return ids[0] ?? DEFAULT_ACCOUNT_ID;
+}
+
+function getExistingToken(cfg: OpenClawConfig, accountId: string): string | undefined {
+  const relay = (cfg.channels as any)?.relay;
+  if (accountId === DEFAULT_ACCOUNT_ID) {
+    return relay?.authToken;
+  }
+  return relay?.accounts?.[accountId]?.authToken;
+}
+
+function getExistingPort(cfg: OpenClawConfig, accountId: string): number | undefined {
+  const relay = (cfg.channels as any)?.relay;
+  if (accountId === DEFAULT_ACCOUNT_ID) {
+    return relay?.port;
+  }
+  return relay?.accounts?.[accountId]?.port;
+}
+
+export const relayOnboardingAdapter: ChannelOnboardingAdapter = {
+  channel,
+
+  getStatus: async ({ cfg }) => {
+    const ids = listRelayAccountIds(cfg);
+    const relay = (cfg.channels as any)?.relay;
+
+    // Check default account (top-level authToken) or any named account
+    let configured = Boolean(relay?.authToken);
+    if (!configured) {
+      for (const id of ids) {
+        if (relay?.accounts?.[id]?.authToken) {
+          configured = true;
+          break;
+        }
+      }
+    }
+
+    return {
+      channel,
+      configured,
+      statusLines: [
+        `Channel Relay: ${configured ? "configured" : "needs setup"}`,
+      ],
+      selectionHint: configured
+        ? "configured"
+        : "proxy for Discord/Telegram",
+      quickstartScore: configured ? 1 : 20,
+    };
+  },
+
+  configure: async ({
+    cfg,
+    prompter,
+    accountOverrides,
+    shouldPromptAccountIds,
+  }) => {
+    await prompter.note(
+      [
+        "ClawRelay bridges Discord/Telegram to OpenClaw via a",
+        "lightweight always-on relay service. This wizard configures",
+        "the channel plugin side (auth token + port).",
+        "",
+        "You'll deploy the relay service separately afterwards.",
+      ].join("\n"),
+      "Channel Relay Setup",
+    );
+
+    // --- Account ID ---
+    const relayOverride = (accountOverrides as any).relay?.trim();
+    const defaultAccountId = resolveDefaultRelayAccountId(cfg);
+    let accountId = relayOverride
+      ? normalizeAccountId(relayOverride)
+      : defaultAccountId;
+
+    if (shouldPromptAccountIds && !relayOverride) {
+      accountId = await promptAccountId({
+        cfg,
+        prompter,
+        label: "Channel Relay",
+        currentId: accountId,
+        listAccountIds: listRelayAccountIds,
+        defaultAccountId,
+      });
+    }
+
+    let next = cfg;
+
+    // --- Auth Token ---
+    const existingToken = getExistingToken(next, accountId);
+    let authToken: string;
+
+    if (existingToken) {
+      const keepToken = await prompter.confirm({
+        message: `Auth token already set (${existingToken.slice(0, 12)}...). Keep it?`,
+        initialValue: true,
+      });
+      if (keepToken) {
+        authToken = existingToken;
+      } else {
+        authToken = await promptAuthToken(prompter);
+      }
+    } else {
+      authToken = await promptAuthToken(prompter);
+    }
+
+    // --- Port ---
+    const existingPort = getExistingPort(next, accountId);
+    let port: number;
+
+    if (existingPort) {
+      const keepPort = await prompter.confirm({
+        message: `Inbound port is ${existingPort}. Keep it?`,
+        initialValue: true,
+      });
+      if (keepPort) {
+        port = existingPort;
+      } else {
+        port = await promptPort(prompter);
+      }
+    } else {
+      port = await promptPort(prompter);
+    }
+
+    // --- Write config ---
+    next = setRelayAccountConfig(next, accountId, {
+      authToken,
+      port,
+    });
+
+    // --- Next steps ---
+    await prompter.note(
+      [
+        "Plugin configured! Now deploy the relay service.",
+        "",
+        "Required env vars for the relay service:",
+        `  DISCORD_TOKEN=<your-bot-token>`,
+        `  SANDBOX_PLUGIN_URL=ws://localhost:${port}`,
+        `  SANDBOX_AUTH_TOKEN=${authToken}`,
+        "",
+        "Quick start:",
+        `  docker run -e DISCORD_TOKEN=... -e SANDBOX_PLUGIN_URL=ws://host.docker.internal:${port} -e SANDBOX_AUTH_TOKEN=${authToken} ghcr.io/kylemclaren/clawrelay:latest`,
+        "",
+        "Docs: https://github.com/kylemclaren/clawrelay",
+      ].join("\n"),
+      "Next Steps",
+    );
+
+    return { cfg: next, accountId };
+  },
+};
+
+async function promptAuthToken(prompter: WizardPrompter): Promise<string> {
+  const generated = generateAuthToken();
+  const useGenerated = await prompter.confirm({
+    message: `Use auto-generated token? (${generated})`,
+    initialValue: true,
+  });
+
+  if (useGenerated) {
+    return generated;
+  }
+
+  const custom = await prompter.text({
+    message: "Enter your auth token",
+    validate: (value) =>
+      String(value ?? "").trim().length >= 8
+        ? undefined
+        : "Token must be at least 8 characters",
+  });
+  return String(custom).trim();
+}
+
+async function promptPort(prompter: WizardPrompter): Promise<number> {
+  const portStr = await prompter.text({
+    message: "Inbound server port",
+    initialValue: "7600",
+    validate: (value) => {
+      const n = Number(value);
+      if (!Number.isInteger(n) || n < 1 || n > 65535) {
+        return "Enter a valid port (1-65535)";
+      }
+      return undefined;
+    },
+  });
+  return Number(portStr);
+}