@openclaw/synology-chat 2026.2.22

package/index.ts

@@ -0,0 +1,17 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+import { createSynologyChatPlugin } from "./src/channel.js";
+import { setSynologyRuntime } from "./src/runtime.js";
+
+const plugin = {
+  id: "synology-chat",
+  name: "Synology Chat",
+  description: "Native Synology Chat channel plugin for OpenClaw",
+  configSchema: emptyPluginConfigSchema(),
+  register(api: OpenClawPluginApi) {
+    setSynologyRuntime(api.runtime);
+    api.registerChannel({ plugin: createSynologyChatPlugin() });
+  },
+};
+
+export default plugin;

package/openclaw.plugin.json

@@ -0,0 +1,9 @@
+{
+  "id": "synology-chat",
+  "channels": ["synology-chat"],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {}
+  }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@openclaw/synology-chat",
+  "version": "2026.2.22",
+  "description": "Synology Chat channel plugin for OpenClaw",
+  "type": "module",
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "openclaw": "workspace:*"
+  },
+  "openclaw": {
+    "extensions": [
+      "./index.ts"
+    ],
+    "channel": {
+      "id": "synology-chat",
+      "label": "Synology Chat",
+      "selectionLabel": "Synology Chat (Webhook)",
+      "docsPath": "/channels/synology-chat",
+      "docsLabel": "synology-chat",
+      "blurb": "Connect your Synology NAS Chat to OpenClaw with full agent capabilities.",
+      "order": 90
+    },
+    "install": {
+      "npmSpec": "@openclaw/synology-chat",
+      "localPath": "extensions/synology-chat",
+      "defaultChoice": "npm"
+    }
+  }
+}

package/src/accounts.test.ts

@@ -0,0 +1,133 @@
+import { describe, it, expect, vi, beforeEach } from "vitest";
+import { listAccountIds, resolveAccount } from "./accounts.js";
+
+// Save and restore env vars
+const originalEnv = { ...process.env };
+
+beforeEach(() => {
+  // Clean synology-related env vars before each test
+  delete process.env.SYNOLOGY_CHAT_TOKEN;
+  delete process.env.SYNOLOGY_CHAT_INCOMING_URL;
+  delete process.env.SYNOLOGY_NAS_HOST;
+  delete process.env.SYNOLOGY_ALLOWED_USER_IDS;
+  delete process.env.SYNOLOGY_RATE_LIMIT;
+  delete process.env.OPENCLAW_BOT_NAME;
+});
+
+describe("listAccountIds", () => {
+  it("returns empty array when no channel config", () => {
+    expect(listAccountIds({})).toEqual([]);
+    expect(listAccountIds({ channels: {} })).toEqual([]);
+  });
+
+  it("returns ['default'] when base config has token", () => {
+    const cfg = { channels: { "synology-chat": { token: "abc" } } };
+    expect(listAccountIds(cfg)).toEqual(["default"]);
+  });
+
+  it("returns ['default'] when env var has token", () => {
+    process.env.SYNOLOGY_CHAT_TOKEN = "env-token";
+    const cfg = { channels: { "synology-chat": {} } };
+    expect(listAccountIds(cfg)).toEqual(["default"]);
+  });
+
+  it("returns named accounts", () => {
+    const cfg = {
+      channels: {
+        "synology-chat": {
+          accounts: { work: { token: "t1" }, home: { token: "t2" } },
+        },
+      },
+    };
+    const ids = listAccountIds(cfg);
+    expect(ids).toContain("work");
+    expect(ids).toContain("home");
+  });
+
+  it("returns default + named accounts", () => {
+    const cfg = {
+      channels: {
+        "synology-chat": {
+          token: "base-token",
+          accounts: { work: { token: "t1" } },
+        },
+      },
+    };
+    const ids = listAccountIds(cfg);
+    expect(ids).toContain("default");
+    expect(ids).toContain("work");
+  });
+});
+
+describe("resolveAccount", () => {
+  it("returns full defaults for empty config", () => {
+    const cfg = { channels: { "synology-chat": {} } };
+    const account = resolveAccount(cfg, "default");
+    expect(account.accountId).toBe("default");
+    expect(account.enabled).toBe(true);
+    expect(account.webhookPath).toBe("/webhook/synology");
+    expect(account.dmPolicy).toBe("allowlist");
+    expect(account.rateLimitPerMinute).toBe(30);
+    expect(account.botName).toBe("OpenClaw");
+  });
+
+  it("uses env var fallbacks", () => {
+    process.env.SYNOLOGY_CHAT_TOKEN = "env-tok";
+    process.env.SYNOLOGY_CHAT_INCOMING_URL = "https://nas/incoming";
+    process.env.SYNOLOGY_NAS_HOST = "192.0.2.1";
+    process.env.OPENCLAW_BOT_NAME = "TestBot";
+
+    const cfg = { channels: { "synology-chat": {} } };
+    const account = resolveAccount(cfg);
+    expect(account.token).toBe("env-tok");
+    expect(account.incomingUrl).toBe("https://nas/incoming");
+    expect(account.nasHost).toBe("192.0.2.1");
+    expect(account.botName).toBe("TestBot");
+  });
+
+  it("config overrides env vars", () => {
+    process.env.SYNOLOGY_CHAT_TOKEN = "env-tok";
+    const cfg = {
+      channels: { "synology-chat": { token: "config-tok" } },
+    };
+    const account = resolveAccount(cfg);
+    expect(account.token).toBe("config-tok");
+  });
+
+  it("account override takes priority over base config", () => {
+    const cfg = {
+      channels: {
+        "synology-chat": {
+          token: "base-tok",
+          botName: "BaseName",
+          accounts: {
+            work: { token: "work-tok", botName: "WorkBot" },
+          },
+        },
+      },
+    };
+    const account = resolveAccount(cfg, "work");
+    expect(account.token).toBe("work-tok");
+    expect(account.botName).toBe("WorkBot");
+  });
+
+  it("parses comma-separated allowedUserIds string", () => {
+    const cfg = {
+      channels: {
+        "synology-chat": { allowedUserIds: "user1, user2, user3" },
+      },
+    };
+    const account = resolveAccount(cfg);
+    expect(account.allowedUserIds).toEqual(["user1", "user2", "user3"]);
+  });
+
+  it("handles allowedUserIds as array", () => {
+    const cfg = {
+      channels: {
+        "synology-chat": { allowedUserIds: ["u1", "u2"] },
+      },
+    };
+    const account = resolveAccount(cfg);
+    expect(account.allowedUserIds).toEqual(["u1", "u2"]);
+  });
+});

package/src/accounts.ts

@@ -0,0 +1,87 @@
+/**
+ * Account resolution: reads config from channels.synology-chat,
+ * merges per-account overrides, falls back to environment variables.
+ */
+
+import type { SynologyChatChannelConfig, ResolvedSynologyChatAccount } from "./types.js";
+
+/** Extract the channel config from the full OpenClaw config object. */
+function getChannelConfig(cfg: any): SynologyChatChannelConfig | undefined {
+  return cfg?.channels?.["synology-chat"];
+}
+
+/** Parse allowedUserIds from string or array to string[]. */
+function parseAllowedUserIds(raw: string | string[] | undefined): string[] {
+  if (!raw) return [];
+  if (Array.isArray(raw)) return raw.filter(Boolean);
+  return raw
+    .split(",")
+    .map((s) => s.trim())
+    .filter(Boolean);
+}
+
+/**
+ * List all configured account IDs for this channel.
+ * Returns ["default"] if there's a base config, plus any named accounts.
+ */
+export function listAccountIds(cfg: any): string[] {
+  const channelCfg = getChannelConfig(cfg);
+  if (!channelCfg) return [];
+
+  const ids = new Set<string>();
+
+  // If base config has a token, there's a "default" account
+  const hasBaseToken = channelCfg.token || process.env.SYNOLOGY_CHAT_TOKEN;
+  if (hasBaseToken) {
+    ids.add("default");
+  }
+
+  // Named accounts
+  if (channelCfg.accounts) {
+    for (const id of Object.keys(channelCfg.accounts)) {
+      ids.add(id);
+    }
+  }
+
+  return Array.from(ids);
+}
+
+/**
+ * Resolve a specific account by ID with full defaults applied.
+ * Falls back to env vars for the "default" account.
+ */
+export function resolveAccount(cfg: any, accountId?: string | null): ResolvedSynologyChatAccount {
+  const channelCfg = getChannelConfig(cfg) ?? {};
+  const id = accountId || "default";
+
+  // Account-specific overrides (if named account exists)
+  const accountOverride = channelCfg.accounts?.[id] ?? {};
+
+  // Env var fallbacks (primarily for the "default" account)
+  const envToken = process.env.SYNOLOGY_CHAT_TOKEN ?? "";
+  const envIncomingUrl = process.env.SYNOLOGY_CHAT_INCOMING_URL ?? "";
+  const envNasHost = process.env.SYNOLOGY_NAS_HOST ?? "localhost";
+  const envAllowedUserIds = process.env.SYNOLOGY_ALLOWED_USER_IDS ?? "";
+  const envRateLimit = process.env.SYNOLOGY_RATE_LIMIT;
+  const envBotName = process.env.OPENCLAW_BOT_NAME ?? "OpenClaw";
+
+  // Merge: account override > base channel config > env var
+  return {
+    accountId: id,
+    enabled: accountOverride.enabled ?? channelCfg.enabled ?? true,
+    token: accountOverride.token ?? channelCfg.token ?? envToken,
+    incomingUrl: accountOverride.incomingUrl ?? channelCfg.incomingUrl ?? envIncomingUrl,
+    nasHost: accountOverride.nasHost ?? channelCfg.nasHost ?? envNasHost,
+    webhookPath: accountOverride.webhookPath ?? channelCfg.webhookPath ?? "/webhook/synology",
+    dmPolicy: accountOverride.dmPolicy ?? channelCfg.dmPolicy ?? "allowlist",
+    allowedUserIds: parseAllowedUserIds(
+      accountOverride.allowedUserIds ?? channelCfg.allowedUserIds ?? envAllowedUserIds,
+    ),
+    rateLimitPerMinute:
+      accountOverride.rateLimitPerMinute ??
+      channelCfg.rateLimitPerMinute ??
+      (envRateLimit ? parseInt(envRateLimit, 10) || 30 : 30),
+    botName: accountOverride.botName ?? channelCfg.botName ?? envBotName,
+    allowInsecureSsl: accountOverride.allowInsecureSsl ?? channelCfg.allowInsecureSsl ?? false,
+  };
+}

package/src/channel.test.ts

@@ -0,0 +1,340 @@
+import { describe, it, expect, vi, beforeEach } from "vitest";
+
+// Mock external dependencies
+vi.mock("openclaw/plugin-sdk", () => ({
+  DEFAULT_ACCOUNT_ID: "default",
+  setAccountEnabledInConfigSection: vi.fn((_opts: any) => ({})),
+  registerPluginHttpRoute: vi.fn(() => vi.fn()),
+  buildChannelConfigSchema: vi.fn((schema: any) => ({ schema })),
+}));
+
+vi.mock("./client.js", () => ({
+  sendMessage: vi.fn().mockResolvedValue(true),
+  sendFileUrl: vi.fn().mockResolvedValue(true),
+}));
+
+vi.mock("./webhook-handler.js", () => ({
+  createWebhookHandler: vi.fn(() => vi.fn()),
+}));
+
+vi.mock("./runtime.js", () => ({
+  getSynologyRuntime: vi.fn(() => ({
+    config: { loadConfig: vi.fn().mockResolvedValue({}) },
+    channel: {
+      reply: {
+        dispatchReplyWithBufferedBlockDispatcher: vi.fn().mockResolvedValue({
+          counts: {},
+        }),
+      },
+    },
+  })),
+}));
+
+vi.mock("zod", () => ({
+  z: {
+    object: vi.fn(() => ({
+      passthrough: vi.fn(() => ({ _type: "zod-schema" })),
+    })),
+  },
+}));
+
+const { createSynologyChatPlugin } = await import("./channel.js");
+
+describe("createSynologyChatPlugin", () => {
+  it("returns a plugin object with all required sections", () => {
+    const plugin = createSynologyChatPlugin();
+    expect(plugin.id).toBe("synology-chat");
+    expect(plugin.meta).toBeDefined();
+    expect(plugin.capabilities).toBeDefined();
+    expect(plugin.config).toBeDefined();
+    expect(plugin.security).toBeDefined();
+    expect(plugin.outbound).toBeDefined();
+    expect(plugin.gateway).toBeDefined();
+  });
+
+  describe("meta", () => {
+    it("has correct id and label", () => {
+      const plugin = createSynologyChatPlugin();
+      expect(plugin.meta.id).toBe("synology-chat");
+      expect(plugin.meta.label).toBe("Synology Chat");
+      expect(plugin.meta.docsPath).toBe("/channels/synology-chat");
+    });
+  });
+
+  describe("capabilities", () => {
+    it("supports direct chat with media", () => {
+      const plugin = createSynologyChatPlugin();
+      expect(plugin.capabilities.chatTypes).toEqual(["direct"]);
+      expect(plugin.capabilities.media).toBe(true);
+      expect(plugin.capabilities.threads).toBe(false);
+    });
+  });
+
+  describe("config", () => {
+    it("listAccountIds delegates to accounts module", () => {
+      const plugin = createSynologyChatPlugin();
+      const result = plugin.config.listAccountIds({});
+      expect(Array.isArray(result)).toBe(true);
+    });
+
+    it("resolveAccount returns account config", () => {
+      const cfg = { channels: { "synology-chat": { token: "t1" } } };
+      const plugin = createSynologyChatPlugin();
+      const account = plugin.config.resolveAccount(cfg, "default");
+      expect(account.accountId).toBe("default");
+    });
+
+    it("defaultAccountId returns 'default'", () => {
+      const plugin = createSynologyChatPlugin();
+      expect(plugin.config.defaultAccountId({})).toBe("default");
+    });
+  });
+
+  describe("security", () => {
+    it("resolveDmPolicy returns policy, allowFrom, normalizeEntry", () => {
+      const plugin = createSynologyChatPlugin();
+      const account = {
+        accountId: "default",
+        enabled: true,
+        token: "t",
+        incomingUrl: "u",
+        nasHost: "h",
+        webhookPath: "/w",
+        dmPolicy: "allowlist" as const,
+        allowedUserIds: ["user1"],
+        rateLimitPerMinute: 30,
+        botName: "Bot",
+        allowInsecureSsl: true,
+      };
+      const result = plugin.security.resolveDmPolicy({ cfg: {}, account });
+      expect(result.policy).toBe("allowlist");
+      expect(result.allowFrom).toEqual(["user1"]);
+      expect(typeof result.normalizeEntry).toBe("function");
+      expect(result.normalizeEntry("  USER1  ")).toBe("user1");
+    });
+  });
+
+  describe("pairing", () => {
+    it("has notifyApproval and normalizeAllowEntry", () => {
+      const plugin = createSynologyChatPlugin();
+      expect(plugin.pairing.idLabel).toBe("synologyChatUserId");
+      expect(typeof plugin.pairing.normalizeAllowEntry).toBe("function");
+      expect(plugin.pairing.normalizeAllowEntry("  USER1  ")).toBe("user1");
+      expect(typeof plugin.pairing.notifyApproval).toBe("function");
+    });
+  });
+
+  describe("security.collectWarnings", () => {
+    it("warns when token is missing", () => {
+      const plugin = createSynologyChatPlugin();
+      const account = {
+        accountId: "default",
+        enabled: true,
+        token: "",
+        incomingUrl: "https://nas/incoming",
+        nasHost: "h",
+        webhookPath: "/w",
+        dmPolicy: "allowlist" as const,
+        allowedUserIds: [],
+        rateLimitPerMinute: 30,
+        botName: "Bot",
+        allowInsecureSsl: false,
+      };
+      const warnings = plugin.security.collectWarnings({ account });
+      expect(warnings.some((w: string) => w.includes("token"))).toBe(true);
+    });
+
+    it("warns when allowInsecureSsl is true", () => {
+      const plugin = createSynologyChatPlugin();
+      const account = {
+        accountId: "default",
+        enabled: true,
+        token: "t",
+        incomingUrl: "https://nas/incoming",
+        nasHost: "h",
+        webhookPath: "/w",
+        dmPolicy: "allowlist" as const,
+        allowedUserIds: [],
+        rateLimitPerMinute: 30,
+        botName: "Bot",
+        allowInsecureSsl: true,
+      };
+      const warnings = plugin.security.collectWarnings({ account });
+      expect(warnings.some((w: string) => w.includes("SSL"))).toBe(true);
+    });
+
+    it("warns when dmPolicy is open", () => {
+      const plugin = createSynologyChatPlugin();
+      const account = {
+        accountId: "default",
+        enabled: true,
+        token: "t",
+        incomingUrl: "https://nas/incoming",
+        nasHost: "h",
+        webhookPath: "/w",
+        dmPolicy: "open" as const,
+        allowedUserIds: [],
+        rateLimitPerMinute: 30,
+        botName: "Bot",
+        allowInsecureSsl: false,
+      };
+      const warnings = plugin.security.collectWarnings({ account });
+      expect(warnings.some((w: string) => w.includes("open"))).toBe(true);
+    });
+
+    it("returns no warnings for fully configured account", () => {
+      const plugin = createSynologyChatPlugin();
+      const account = {
+        accountId: "default",
+        enabled: true,
+        token: "t",
+        incomingUrl: "https://nas/incoming",
+        nasHost: "h",
+        webhookPath: "/w",
+        dmPolicy: "allowlist" as const,
+        allowedUserIds: ["user1"],
+        rateLimitPerMinute: 30,
+        botName: "Bot",
+        allowInsecureSsl: false,
+      };
+      const warnings = plugin.security.collectWarnings({ account });
+      expect(warnings).toHaveLength(0);
+    });
+  });
+
+  describe("messaging", () => {
+    it("normalizeTarget strips prefix and trims", () => {
+      const plugin = createSynologyChatPlugin();
+      expect(plugin.messaging.normalizeTarget("synology-chat:123")).toBe("123");
+      expect(plugin.messaging.normalizeTarget("  456  ")).toBe("456");
+      expect(plugin.messaging.normalizeTarget("")).toBeUndefined();
+    });
+
+    it("targetResolver.looksLikeId matches numeric IDs", () => {
+      const plugin = createSynologyChatPlugin();
+      expect(plugin.messaging.targetResolver.looksLikeId("12345")).toBe(true);
+      expect(plugin.messaging.targetResolver.looksLikeId("synology-chat:99")).toBe(true);
+      expect(plugin.messaging.targetResolver.looksLikeId("notanumber")).toBe(false);
+      expect(plugin.messaging.targetResolver.looksLikeId("")).toBe(false);
+    });
+  });
+
+  describe("directory", () => {
+    it("returns empty stubs", async () => {
+      const plugin = createSynologyChatPlugin();
+      expect(await plugin.directory.self()).toBeNull();
+      expect(await plugin.directory.listPeers()).toEqual([]);
+      expect(await plugin.directory.listGroups()).toEqual([]);
+    });
+  });
+
+  describe("agentPrompt", () => {
+    it("returns formatting hints", () => {
+      const plugin = createSynologyChatPlugin();
+      const hints = plugin.agentPrompt.messageToolHints();
+      expect(Array.isArray(hints)).toBe(true);
+      expect(hints.length).toBeGreaterThan(5);
+      expect(hints.some((h: string) => h.includes("<URL|display text>"))).toBe(true);
+    });
+  });
+
+  describe("outbound", () => {
+    it("sendText throws when no incomingUrl", async () => {
+      const plugin = createSynologyChatPlugin();
+      await expect(
+        plugin.outbound.sendText({
+          account: {
+            accountId: "default",
+            enabled: true,
+            token: "t",
+            incomingUrl: "",
+            nasHost: "h",
+            webhookPath: "/w",
+            dmPolicy: "open",
+            allowedUserIds: [],
+            rateLimitPerMinute: 30,
+            botName: "Bot",
+            allowInsecureSsl: true,
+          },
+          text: "hello",
+          to: "user1",
+        }),
+      ).rejects.toThrow("not configured");
+    });
+
+    it("sendText returns OutboundDeliveryResult on success", async () => {
+      const plugin = createSynologyChatPlugin();
+      const result = await plugin.outbound.sendText({
+        account: {
+          accountId: "default",
+          enabled: true,
+          token: "t",
+          incomingUrl: "https://nas/incoming",
+          nasHost: "h",
+          webhookPath: "/w",
+          dmPolicy: "open",
+          allowedUserIds: [],
+          rateLimitPerMinute: 30,
+          botName: "Bot",
+          allowInsecureSsl: true,
+        },
+        text: "hello",
+        to: "user1",
+      });
+      expect(result.channel).toBe("synology-chat");
+      expect(result.messageId).toBeDefined();
+      expect(result.chatId).toBe("user1");
+    });
+
+    it("sendMedia throws when missing incomingUrl", async () => {
+      const plugin = createSynologyChatPlugin();
+      await expect(
+        plugin.outbound.sendMedia({
+          account: {
+            accountId: "default",
+            enabled: true,
+            token: "t",
+            incomingUrl: "",
+            nasHost: "h",
+            webhookPath: "/w",
+            dmPolicy: "open",
+            allowedUserIds: [],
+            rateLimitPerMinute: 30,
+            botName: "Bot",
+            allowInsecureSsl: true,
+          },
+          mediaUrl: "https://example.com/img.png",
+          to: "user1",
+        }),
+      ).rejects.toThrow("not configured");
+    });
+  });
+
+  describe("gateway", () => {
+    it("startAccount returns stop function for disabled account", async () => {
+      const plugin = createSynologyChatPlugin();
+      const ctx = {
+        cfg: {
+          channels: { "synology-chat": { enabled: false } },
+        },
+        accountId: "default",
+        log: { info: vi.fn(), warn: vi.fn(), error: vi.fn() },
+      };
+      const result = await plugin.gateway.startAccount(ctx);
+      expect(typeof result.stop).toBe("function");
+    });
+
+    it("startAccount returns stop function for account without token", async () => {
+      const plugin = createSynologyChatPlugin();
+      const ctx = {
+        cfg: {
+          channels: { "synology-chat": { enabled: true } },
+        },
+        accountId: "default",
+        log: { info: vi.fn(), warn: vi.fn(), error: vi.fn() },
+      };
+      const result = await plugin.gateway.startAccount(ctx);
+      expect(typeof result.stop).toBe("function");
+    });
+  });
+});