clawdy 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @clawdy/openclaw-channel
+ *
+ * OpenClaw channel plugin that enables outbound push messaging from OpenClaw
+ * instances to the Clawdy Gateway. When OpenClaw wants to proactively send a
+ * message (scheduled, cron, heartbeat, agent-initiated), this plugin POSTs to
+ * the Clawdy Gateway's callback endpoint for delivery via web dashboard, Slack,
+ * Telegram, or other configured channels.
+ *
+ * ## Configuration (openclaw.json)
+ *
+ * ```json
+ * {
+ *   "channels": {
+ *     "clawdy": {
+ *       "enabled": true,
+ *       "callbackUrl": "https://gateway.clawdy.app/api/openclaw/callback",
+ *       "callbackSecret": "<per-machine-secret>"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ## Targets
+ *
+ * The plugin supports the following target formats in the `to` field:
+ *
+ * - `web:default`       — Deliver to the machine owner's web dashboard
+ * - `slack:default`     — Deliver via the owner's linked Slack workspace
+ * - `telegram:default`  — Deliver via the owner's linked Telegram bot
+ * - `web:<userId>`      — Deliver to a specific user's web dashboard
+ * - `slack:<teamId>`    — Deliver to a specific Slack workspace
+ * - `telegram:<chatId>` — Deliver to a specific Telegram chat
+ *
+ * Using `:default` targets is recommended — the Clawdy Gateway resolves the
+ * actual destination from the user's gateway link configuration in the database.
+ */
+/**
+ * OpenClaw Plugin API — passed to the register function.
+ */
+interface OpenClawPluginApi {
+    registerChannel(opts: {
+        plugin: unknown;
+    }): void;
+}
+/**
+ * Entry point called by OpenClaw's plugin loader.
+ * Registers the Clawdy channel plugin.
+ */
+export default function register(api: OpenClawPluginApi): void;
+export {};

package/dist/index.js

@@ -0,0 +1,211 @@
+"use strict";
+/**
+ * @clawdy/openclaw-channel
+ *
+ * OpenClaw channel plugin that enables outbound push messaging from OpenClaw
+ * instances to the Clawdy Gateway. When OpenClaw wants to proactively send a
+ * message (scheduled, cron, heartbeat, agent-initiated), this plugin POSTs to
+ * the Clawdy Gateway's callback endpoint for delivery via web dashboard, Slack,
+ * Telegram, or other configured channels.
+ *
+ * ## Configuration (openclaw.json)
+ *
+ * ```json
+ * {
+ *   "channels": {
+ *     "clawdy": {
+ *       "enabled": true,
+ *       "callbackUrl": "https://gateway.clawdy.app/api/openclaw/callback",
+ *       "callbackSecret": "<per-machine-secret>"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ## Targets
+ *
+ * The plugin supports the following target formats in the `to` field:
+ *
+ * - `web:default`       — Deliver to the machine owner's web dashboard
+ * - `slack:default`     — Deliver via the owner's linked Slack workspace
+ * - `telegram:default`  — Deliver via the owner's linked Telegram bot
+ * - `web:<userId>`      — Deliver to a specific user's web dashboard
+ * - `slack:<teamId>`    — Deliver to a specific Slack workspace
+ * - `telegram:<chatId>` — Deliver to a specific Telegram chat
+ *
+ * Using `:default` targets is recommended — the Clawdy Gateway resolves the
+ * actual destination from the user's gateway link configuration in the database.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = register;
+// ─── Helpers ───────────────────────────────────────────────────────────────
+/**
+ * Resolve the Clawdy channel account from the OpenClaw config.
+ */
+function resolveAccount(cfg, accountId) {
+    const channels = cfg.channels;
+    const clawdyCfg = channels?.clawdy;
+    if (!clawdyCfg) {
+        return {
+            accountId: accountId ?? "default",
+            callbackUrl: "",
+            callbackSecret: "",
+        };
+    }
+    return {
+        accountId: accountId ?? "default",
+        callbackUrl: clawdyCfg.callbackUrl ?? "",
+        callbackSecret: clawdyCfg.callbackSecret ?? "",
+    };
+}
+/**
+ * Get the machine's public IP for identification.
+ * Falls back to empty string if not detectable.
+ */
+async function getMachineIp() {
+    try {
+        const res = await fetch("https://api.ipify.org?format=text", {
+            signal: AbortSignal.timeout(5_000),
+        });
+        if (res.ok) {
+            return (await res.text()).trim();
+        }
+    }
+    catch {
+        // Ignore — non-critical
+    }
+    return "";
+}
+// Cache the machine IP to avoid repeated lookups
+let cachedMachineIp = null;
+async function getCachedMachineIp() {
+    if (cachedMachineIp !== null)
+        return cachedMachineIp;
+    cachedMachineIp = await getMachineIp();
+    return cachedMachineIp;
+}
+/**
+ * Send a callback to the Clawdy Gateway.
+ */
+async function sendCallback(account, payload) {
+    if (!account.callbackUrl) {
+        return {
+            ok: false,
+            channel: "clawdy",
+            error: "No callbackUrl configured in channels.clawdy",
+        };
+    }
+    if (!account.callbackSecret) {
+        return {
+            ok: false,
+            channel: "clawdy",
+            error: "No callbackSecret configured in channels.clawdy",
+        };
+    }
+    const machineIp = await getCachedMachineIp();
+    const callbackUrl = account.callbackUrl.replace(/\/+$/, "") + "/api/openclaw/callback";
+    const res = await fetch(callbackUrl, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+            "X-Proxy-Secret": account.callbackSecret,
+            "X-Machine-IP": machineIp,
+        },
+        body: JSON.stringify({
+            to: payload.to,
+            text: payload.text,
+            mediaUrl: payload.mediaUrl,
+            messageId: payload.messageId ?? crypto.randomUUID(),
+        }),
+        signal: AbortSignal.timeout(30_000),
+    });
+    if (!res.ok) {
+        const errorBody = await res.text().catch(() => "");
+        return {
+            ok: false,
+            channel: "clawdy",
+            error: `Callback failed: ${res.status} — ${errorBody.slice(0, 200)}`,
+        };
+    }
+    const data = await res.json().catch(() => ({}));
+    return {
+        ok: true,
+        channel: "clawdy",
+        messageId: data.messageId ?? payload.messageId,
+    };
+}
+// ─── Channel Plugin ────────────────────────────────────────────────────────
+const clawdyPlugin = {
+    id: "clawdy",
+    meta: {
+        id: "clawdy",
+        label: "Clawdy",
+        selectionLabel: "Clawdy (Push Gateway)",
+        docsPath: "/channels/clawdy",
+        blurb: "Send messages to the Clawdy Gateway for delivery via web dashboard, Slack, Telegram, and more.",
+        aliases: ["clawdy-gateway"],
+    },
+    capabilities: {
+        chatTypes: ["direct"],
+    },
+    config: {
+        listAccountIds: (cfg) => {
+            const channels = cfg.channels;
+            if (channels?.clawdy)
+                return ["default"];
+            return [];
+        },
+        resolveAccount: (cfg, accountId) => {
+            return resolveAccount(cfg, accountId);
+        },
+    },
+    outbound: {
+        deliveryMode: "direct",
+        /**
+         * Send a text message to a target via the Clawdy Gateway.
+         */
+        sendText: async (ctx) => {
+            const account = resolveAccount(ctx.cfg, ctx.accountId);
+            return sendCallback(account, {
+                to: ctx.to,
+                text: ctx.text,
+            });
+        },
+        /**
+         * Send a media message to a target via the Clawdy Gateway.
+         */
+        sendMedia: async (ctx) => {
+            const account = resolveAccount(ctx.cfg, ctx.accountId);
+            return sendCallback(account, {
+                to: ctx.to,
+                text: ctx.text,
+                mediaUrl: ctx.mediaUrl,
+            });
+        },
+    },
+    gateway: {
+        /**
+         * Called when the Clawdy channel starts.
+         * Logs activation and caches the machine IP.
+         */
+        startAccount: async (ctx) => {
+            const ip = await getCachedMachineIp();
+            console.log(`[clawdy-channel] Started. Callback URL: ${ctx.account.callbackUrl || "(not set)"}. Machine IP: ${ip || "(unknown)"}`);
+        },
+        /**
+         * Called when the Clawdy channel stops.
+         */
+        stopAccount: async () => {
+            console.log("[clawdy-channel] Stopped.");
+            cachedMachineIp = null;
+        },
+    },
+};
+// ─── Plugin Registration ───────────────────────────────────────────────────
+/**
+ * Entry point called by OpenClaw's plugin loader.
+ * Registers the Clawdy channel plugin.
+ */
+function register(api) {
+    api.registerChannel({ plugin: clawdyPlugin });
+}

package/openclaw.plugin.json

@@ -0,0 +1,6 @@
+{
+  "id": "clawdy",
+  "name": "Clawdy Channel",
+  "version": "1.0.0",
+  "description": "Clawdy push messaging channel — enables OpenClaw to send outbound messages (scheduled, cron, heartbeat) to the Clawdy Gateway for delivery via web dashboard, Slack, Telegram, and more."
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "clawdy",
+  "version": "0.0.1",
+  "description": "OpenClaw channel plugin for Clawdy — enables outbound push messaging from OpenClaw instances to the Clawdy Gateway",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "openclaw.plugin.json"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "pack": "npm run clean && npm run build && npm pack",
+    "publish:npm": "npm run clean && npm run build && npm publish --access public"
+  },
+  "keywords": [
+    "openclaw",
+    "clawdy",
+    "channel",
+    "plugin",
+    "gateway"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/heyclawdy/clawdy"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}