olvid-channel 0.0.0-a0

package/SKILL.md

@@ -0,0 +1,4 @@
+---
+name: olvid-channel
+description: Add a native Olvid channel in OpenClaw.
+---

package/index.ts

@@ -0,0 +1,177 @@
+import {
+  type OpenClawPluginApi,
+  buildChannelConfigSchema,
+  type ChannelPlugin,
+  setAccountEnabledInConfigSection, deleteAccountFromConfigSection, DEFAULT_ACCOUNT_ID, ChannelAccountSnapshot,
+  emptyPluginConfigSchema
+} from "openclaw/plugin-sdk";
+import {
+  listOlvidAccountIds,
+  resolveDefaultOlvidAccountId,
+  ResolvedOlvidAccount,
+  resolveOlvidAccount
+} from "./src/accounts";
+import {OlvidConfigSchema} from "./src/config-schema";
+import {CoreConfig} from "./src/types";
+import {getOlvidRuntime, setOlvidRuntime} from "./src/runtime";
+import {sendMessageOlvid} from "./src/send";
+import {monitorOlvidProvider} from "./src/monitor";
+import {olvidOnboardingAdapter} from "./src/onboarding";
+
+let olvidPlugin: ChannelPlugin<ResolvedOlvidAccount> = {
+  id: "olvid",
+  meta: {
+    id: "olvid",
+    label: "Olvid",
+    selectionLabel: "Olvid (Daemon)",
+    docsPath: "/channels/olvid",
+    docsLabel: "olvid",
+    blurb: "Securely exchange with your bot with authenticated e2e encryption",
+    order: 65,
+    quickstartAllowFrom: true,
+  },
+  capabilities: {
+    chatTypes: ["direct", "group"],
+    media: true,
+    reactions: true,
+    threads: false,
+    reply: true,
+    nativeCommands: false,
+    blockStreaming: true
+  },
+  reload: { configPrefixes: ["channels.olvid"] },
+  configSchema: buildChannelConfigSchema(OlvidConfigSchema),
+  onboarding: olvidOnboardingAdapter,
+  config: {
+    listAccountIds: (cfg) => listOlvidAccountIds(cfg as CoreConfig),
+    resolveAccount: (cfg, accountId) => resolveOlvidAccount({ cfg: cfg as CoreConfig, accountId }),
+    defaultAccountId: (cfg) => resolveDefaultOlvidAccountId(cfg as CoreConfig),
+    setAccountEnabled: ({ cfg, accountId, enabled }) =>
+        setAccountEnabledInConfigSection({
+          cfg,
+          sectionKey: "olvid",
+          accountId,
+          enabled,
+          allowTopLevel: true,
+        }),
+    deleteAccount: ({ cfg, accountId }) =>
+        deleteAccountFromConfigSection({
+          cfg,
+          sectionKey: "olvid",
+          accountId,
+          clearBaseFields: ["clientKey", "daemonUrl", "name"],
+        }),
+    isConfigured: (account) => Boolean(account.clientKey && account.daemonUrl),
+    describeAccount: (account) => ({
+      accountId: account.accountId,
+      name: account.name,
+      enabled: account.enabled,
+      configured: Boolean(account.clientKey && account.daemonUrl),
+      clientKeySource: account.clientKeySource,
+      daemonUrl: account.daemonUrl,
+    }),
+  },
+  outbound: {
+    deliveryMode: "direct",
+    chunker: (text: string, limit: number): string[] => {
+        return getOlvidRuntime().channel.text.chunkMarkdownText(text, limit);
+    },
+    chunkerMode: "markdown",
+    textChunkLimit: 4000,
+    sendText: async ({ to, text, accountId, replyToId }) => {
+      const result = await sendMessageOlvid(to, text, {
+        accountId: accountId ?? undefined,
+        replyTo: replyToId ?? undefined,
+      });
+      return { channel: "olvid", ...result };
+    },
+    sendMedia: async ({ to, text, mediaUrl, accountId, replyToId }) => {
+      const result = await sendMessageOlvid(to, text, {
+        accountId: accountId ?? undefined,
+        replyTo: replyToId ?? undefined,
+        mediaUrls: mediaUrl ? [mediaUrl] : undefined,
+      });
+      return { channel: "olvid", ...result };
+    },
+  },
+  status: {
+    defaultRuntime: {
+      accountId: DEFAULT_ACCOUNT_ID,
+      running: false,
+      connected: false,
+      lastConnectedAt: null,
+      lastDisconnect: null,
+      lastStartAt: null,
+      lastStopAt: null,
+      lastError: null,
+    },
+    buildChannelSummary: ({ snapshot }) => ({
+      configured: snapshot.configured ?? false,
+      running: snapshot.running ?? false,
+      connected: snapshot.connected ?? false,
+      lastStartAt: snapshot.lastStartAt ?? null,
+      lastStopAt: snapshot.lastStopAt ?? null,
+      lastError: snapshot.lastError ?? null,
+      baseUrl: snapshot.baseUrl ?? null,
+      probe: snapshot.probe,
+      lastProbeAt: snapshot.lastProbeAt ?? null,
+    }),
+    buildAccountSnapshot: ({ account, runtime }) => {
+      return {
+        accountId: account.accountId,
+        name: account.name,
+        enabled: account.enabled,
+        configured: Boolean(account.clientKey && account.daemonUrl),
+        clientKeySource: account.clientKeySource,
+        baseUrl: account.daemonUrl,
+        connected: runtime?.connected ?? false,
+        lastConnectedAt: runtime?.lastConnectedAt ?? null,
+        lastDisconnect: runtime?.lastDisconnect ?? null,
+        lastStartAt: runtime?.lastStartAt ?? null,
+        lastStopAt: runtime?.lastStopAt ?? null,
+        lastError: runtime?.lastError ?? null,
+        lastInboundAt: runtime?.lastInboundAt ?? null,
+        lastOutboundAt: runtime?.lastOutboundAt ?? null,
+      };
+    },
+  },
+  gateway: {
+    startAccount: async (ctx) => {
+      const account = ctx.account;
+      if (!account.daemonUrl || !account.clientKey) {
+        throw new Error(`Olvid not configuration is invalid`);
+      }
+      ctx.setStatus({
+        accountId: account.accountId,
+        baseUrl: account.daemonUrl,
+        botTokenSource: account.clientKeySource,
+        lastStartAt: Date.now(),
+      });
+      ctx.log?.info(`[${account.accountId}] starting channel`);
+      return monitorOlvidProvider({
+        accountId: account.accountId,
+        config: ctx.cfg as CoreConfig,
+        runtime: ctx.runtime,
+        abortSignal: ctx.abortSignal,
+        statusSink: (patch: Partial<ChannelAccountSnapshot>) =>
+            ctx.setStatus({ accountId: ctx.accountId, ...patch }),
+      });
+    },
+    stopAccount: async (ctx) => {
+      ctx.setStatus({ accountId: ctx.accountId, lastStopAt: Date.now() });
+    },
+  }
+}
+
+const plugin: {id: string, name: string, description: string, configSchema: unknown, register: (api: OpenClawPluginApi) => void} = {
+  id: "olvid",
+  name: "Olvid",
+  description: "Olvid channel plugin",
+  configSchema: emptyPluginConfigSchema(),
+  register(api: OpenClawPluginApi) {
+    setOlvidRuntime(api.runtime);
+    api.registerChannel(olvidPlugin);
+  }
+}
+
+export default plugin;

package/openclaw.plugin.json

@@ -0,0 +1,29 @@
+{
+  "id": "olvid-channel",
+  "channels": ["olvid"],
+  "name": "Olvid Channel",
+  "openclaw": {
+    "extensions": ["./index.ts"],
+    "channel": {
+      "id": "olvid",
+      "label": "olvid",
+      "selectionLabel": "Olvid (Daemon)",
+      "docsPath": "/channels/olvid",
+      "docsLabel": "olvid",
+      "blurb": "Trust your agent with authenticated e2e encryption.",
+      "order": 35
+    }
+  },
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "daemonUrl": { "type": "string", "default": "http://localhost:50051" },
+      "clientKey": { "type": "string" }
+    }
+  },
+  "uiHints": {
+    "daemonUrl": { "label": "Daemon Url", "placeholder": "http://localhost:50051" },
+    "clientKey": { "label": "Client Key", "sensitive": true }
+  }
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "olvid-channel",
+  "version": "0.0.0a0",
+  "description": "Olvid native channel for OpenClaw.",
+  "type": "module",
+  "dependencies": {
+    "@olvid/bot-node": "^1.5.0",
+    "zod": "^4.3.6"
+  },
+  "peerDependencies": {
+    "openclaw": "^2026.2.1"
+  },
+  "keywords": [
+    "openclaw",
+    "channel",
+    "olvid"
+  ],
+  "author": "bot@olvid.io",
+  "openclaw": {
+    "extensions": ["./index.ts"],
+    "channel": {
+      "id": "olvid",
+      "label": "olvid",
+      "selectionLabel": "Olvid (Daemon)",
+      "docsPath": "/channels/olvid",
+      "docsLabel": "olvid",
+      "blurb": "Trust your agent with authenticated e2e encryption.",
+      "order": 35
+    },
+    "install": {
+      "npmSpec": "olvid-channel",
+      "localPath": "extensions/olvid",
+      "defaultChoice": "npm"
+    }
+  }
+}

package/pub/SKILL.md

@@ -0,0 +1,4 @@
+---
+name: olvid-channel
+description: Add a native Olvid channel in OpenClaw.
+---

package/pub/index.ts

@@ -0,0 +1,177 @@
+import {
+  type OpenClawPluginApi,
+  buildChannelConfigSchema,
+  type ChannelPlugin,
+  setAccountEnabledInConfigSection, deleteAccountFromConfigSection, DEFAULT_ACCOUNT_ID, ChannelAccountSnapshot,
+  emptyPluginConfigSchema
+} from "openclaw/plugin-sdk";
+import {
+  listOlvidAccountIds,
+  resolveDefaultOlvidAccountId,
+  ResolvedOlvidAccount,
+  resolveOlvidAccount
+} from "./src/accounts";
+import {OlvidConfigSchema} from "./src/config-schema";
+import {CoreConfig} from "./src/types";
+import {getOlvidRuntime, setOlvidRuntime} from "./src/runtime";
+import {sendMessageOlvid} from "./src/send";
+import {monitorOlvidProvider} from "./src/monitor";
+import {olvidOnboardingAdapter} from "./src/onboarding";
+
+let olvidPlugin: ChannelPlugin<ResolvedOlvidAccount> = {
+  id: "olvid",
+  meta: {
+    id: "olvid",
+    label: "Olvid",
+    selectionLabel: "Olvid (Daemon)",
+    docsPath: "/channels/olvid",
+    docsLabel: "olvid",
+    blurb: "Securely exchange with your bot with authenticated e2e encryption",
+    order: 65,
+    quickstartAllowFrom: true,
+  },
+  capabilities: {
+    chatTypes: ["direct", "group"],
+    media: true,
+    reactions: true,
+    threads: false,
+    reply: true,
+    nativeCommands: false,
+    blockStreaming: true
+  },
+  reload: { configPrefixes: ["channels.olvid"] },
+  configSchema: buildChannelConfigSchema(OlvidConfigSchema),
+  onboarding: olvidOnboardingAdapter,
+  config: {
+    listAccountIds: (cfg) => listOlvidAccountIds(cfg as CoreConfig),
+    resolveAccount: (cfg, accountId) => resolveOlvidAccount({ cfg: cfg as CoreConfig, accountId }),
+    defaultAccountId: (cfg) => resolveDefaultOlvidAccountId(cfg as CoreConfig),
+    setAccountEnabled: ({ cfg, accountId, enabled }) =>
+        setAccountEnabledInConfigSection({
+          cfg,
+          sectionKey: "olvid",
+          accountId,
+          enabled,
+          allowTopLevel: true,
+        }),
+    deleteAccount: ({ cfg, accountId }) =>
+        deleteAccountFromConfigSection({
+          cfg,
+          sectionKey: "olvid",
+          accountId,
+          clearBaseFields: ["clientKey", "daemonUrl", "name"],
+        }),
+    isConfigured: (account) => Boolean(account.clientKey && account.daemonUrl),
+    describeAccount: (account) => ({
+      accountId: account.accountId,
+      name: account.name,
+      enabled: account.enabled,
+      configured: Boolean(account.clientKey && account.daemonUrl),
+      clientKeySource: account.clientKeySource,
+      daemonUrl: account.daemonUrl,
+    }),
+  },
+  outbound: {
+    deliveryMode: "direct",
+    chunker: (text: string, limit: number): string[] => {
+        return getOlvidRuntime().channel.text.chunkMarkdownText(text, limit);
+    },
+    chunkerMode: "markdown",
+    textChunkLimit: 4000,
+    sendText: async ({ to, text, accountId, replyToId }) => {
+      const result = await sendMessageOlvid(to, text, {
+        accountId: accountId ?? undefined,
+        replyTo: replyToId ?? undefined,
+      });
+      return { channel: "olvid", ...result };
+    },
+    sendMedia: async ({ to, text, mediaUrl, accountId, replyToId }) => {
+      const result = await sendMessageOlvid(to, text, {
+        accountId: accountId ?? undefined,
+        replyTo: replyToId ?? undefined,
+        mediaUrls: mediaUrl ? [mediaUrl] : undefined,
+      });
+      return { channel: "olvid", ...result };
+    },
+  },
+  status: {
+    defaultRuntime: {
+      accountId: DEFAULT_ACCOUNT_ID,
+      running: false,
+      connected: false,
+      lastConnectedAt: null,
+      lastDisconnect: null,
+      lastStartAt: null,
+      lastStopAt: null,
+      lastError: null,
+    },
+    buildChannelSummary: ({ snapshot }) => ({
+      configured: snapshot.configured ?? false,
+      running: snapshot.running ?? false,
+      connected: snapshot.connected ?? false,
+      lastStartAt: snapshot.lastStartAt ?? null,
+      lastStopAt: snapshot.lastStopAt ?? null,
+      lastError: snapshot.lastError ?? null,
+      baseUrl: snapshot.baseUrl ?? null,
+      probe: snapshot.probe,
+      lastProbeAt: snapshot.lastProbeAt ?? null,
+    }),
+    buildAccountSnapshot: ({ account, runtime }) => {
+      return {
+        accountId: account.accountId,
+        name: account.name,
+        enabled: account.enabled,
+        configured: Boolean(account.clientKey && account.daemonUrl),
+        clientKeySource: account.clientKeySource,
+        baseUrl: account.daemonUrl,
+        connected: runtime?.connected ?? false,
+        lastConnectedAt: runtime?.lastConnectedAt ?? null,
+        lastDisconnect: runtime?.lastDisconnect ?? null,
+        lastStartAt: runtime?.lastStartAt ?? null,
+        lastStopAt: runtime?.lastStopAt ?? null,
+        lastError: runtime?.lastError ?? null,
+        lastInboundAt: runtime?.lastInboundAt ?? null,
+        lastOutboundAt: runtime?.lastOutboundAt ?? null,
+      };
+    },
+  },
+  gateway: {
+    startAccount: async (ctx) => {
+      const account = ctx.account;
+      if (!account.daemonUrl || !account.clientKey) {
+        throw new Error(`Olvid not configuration is invalid`);
+      }
+      ctx.setStatus({
+        accountId: account.accountId,
+        baseUrl: account.daemonUrl,
+        botTokenSource: account.clientKeySource,
+        lastStartAt: Date.now(),
+      });
+      ctx.log?.info(`[${account.accountId}] starting channel`);
+      return monitorOlvidProvider({
+        accountId: account.accountId,
+        config: ctx.cfg as CoreConfig,
+        runtime: ctx.runtime,
+        abortSignal: ctx.abortSignal,
+        statusSink: (patch: Partial<ChannelAccountSnapshot>) =>
+            ctx.setStatus({ accountId: ctx.accountId, ...patch }),
+      });
+    },
+    stopAccount: async (ctx) => {
+      ctx.setStatus({ accountId: ctx.accountId, lastStopAt: Date.now() });
+    },
+  }
+}
+
+const plugin: {id: string, name: string, description: string, configSchema: unknown, register: (api: OpenClawPluginApi) => void} = {
+  id: "olvid",
+  name: "Olvid",
+  description: "Olvid channel plugin",
+  configSchema: emptyPluginConfigSchema(),
+  register(api: OpenClawPluginApi) {
+    setOlvidRuntime(api.runtime);
+    api.registerChannel(olvidPlugin);
+  }
+}
+
+export default plugin;

package/pub/openclaw.plugin.json

@@ -0,0 +1,29 @@
+{
+  "id": "olvid",
+  "channels": ["olvid"],
+  "name": "Olvid Channel",
+  "openclaw": {
+    "extensions": ["./index.ts"],
+    "channel": {
+      "id": "olvid",
+      "label": "olvid",
+      "selectionLabel": "Olvid (Daemon)",
+      "docsPath": "/channels/olvid",
+      "docsLabel": "olvid",
+      "blurb": "Trust your agent with authenticated e2e encryption.",
+      "order": 35
+    }
+  },
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "daemonUrl": { "type": "string", "default": "http://localhost:50051" },
+      "clientKey": { "type": "string" }
+    }
+  },
+  "uiHints": {
+    "daemonUrl": { "label": "Daemon Url", "placeholder": "http://localhost:50051" },
+    "clientKey": { "label": "Client Key", "sensitive": true }
+  }
+}

package/pub/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "openclaw-channel-olvid",
+  "version": "0.0.6",
+  "description": "Olvid native channel for OpenClaw.",
+  "type": "module",
+  "dependencies": {
+    "@olvid/bot-node": "^1.5.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "openclaw": "==2026.2.1"
+  },
+  "keywords": [
+    "openclaw",
+    "channel",
+    "olvid"
+  ],
+  "author": "bot@olvid.io",
+  "openclaw": {
+    "extensions": ["./index.ts"],
+    "channel": {
+      "id": "olvid",
+      "label": "olvid",
+      "selectionLabel": "Olvid (Daemon)",
+      "docsPath": "/channels/olvid",
+      "docsLabel": "olvid",
+      "blurb": "Trust your agent with authenticated e2e encryption.",
+      "order": 35
+    },
+    "install": {
+      "npmSpec": "openclaw-channel-olvid",
+      "localPath": "extensions/olvid",
+      "defaultChoice": "npm"
+    }
+  }
+}

package/pub/src/accounts.ts

@@ -0,0 +1,111 @@
+import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk";
+import type { CoreConfig, OlvidAccountConfig } from "./types.js";
+
+export type OlvidClientKeySource = "env" | "config" | "none";
+export type OlvidDaemonUrlSource = "env" | "config" | "none";
+
+export type ResolvedOlvidAccount = {
+  accountId: string;
+  enabled: boolean;
+  name?: string;
+  clientKey?: string;
+  daemonUrl?: string;
+  clientKeySource: OlvidClientKeySource;
+  daemonUrlSource: OlvidDaemonUrlSource;
+  config: OlvidAccountConfig;
+  oncharPrefixes?: string[];
+  requireMention?: boolean;
+  textChunkLimit?: number;
+  blockStreaming?: boolean;
+  blockStreamingCoalesce?: OlvidAccountConfig["blockStreamingCoalesce"];
+};
+
+function listConfiguredAccountIds(cfg: CoreConfig): string[] {
+  const accounts = cfg.channels?.olvid?.accounts;
+  if (!accounts || typeof accounts !== "object") {
+    return [];
+  }
+  return Object.keys(accounts).filter(Boolean);
+}
+
+export function listOlvidAccountIds(cfg: CoreConfig): string[] {
+  const ids = listConfiguredAccountIds(cfg);
+  if (ids.length === 0) {
+    return [DEFAULT_ACCOUNT_ID];
+  }
+  return ids.sort((a, b) => a.localeCompare(b));
+}
+
+export function resolveDefaultOlvidAccountId(cfg: CoreConfig): string {
+  const ids = listOlvidAccountIds(cfg);
+  if (ids.includes(DEFAULT_ACCOUNT_ID)) {
+    return DEFAULT_ACCOUNT_ID;
+  }
+  return ids[0] ?? DEFAULT_ACCOUNT_ID;
+}
+
+function resolveAccountConfig(cfg: CoreConfig, accountId: string): OlvidAccountConfig | undefined {
+  const accounts = cfg.channels?.olvid?.accounts;
+  if (!accounts || typeof accounts !== "object") {
+    return undefined;
+  }
+  return accounts[accountId] as ResolvedOlvidAccount | undefined;
+}
+
+function mergeOlvidAccountConfig(cfg: CoreConfig, accountId: string): OlvidAccountConfig {
+  const { accounts: _ignored, ...base } = (cfg.channels?.olvid ?? {}) as OlvidAccountConfig & {
+    accounts?: unknown;
+  };
+  const account = resolveAccountConfig(cfg, accountId) ?? {};
+  return { ...base, ...account };
+}
+
+export function resolveOlvidAccount(params: {
+  cfg: CoreConfig;
+  accountId?: string | null;
+}): ResolvedOlvidAccount {
+  const accountId = normalizeAccountId(params.accountId);
+  const baseEnabled = params.cfg.channels?.olvid?.enabled !== false;
+  const merged = mergeOlvidAccountConfig(params.cfg, accountId);
+  const accountEnabled = merged.enabled !== false;
+  const enabled = baseEnabled && accountEnabled;
+
+  const allowEnv = accountId === DEFAULT_ACCOUNT_ID;
+  const envClientKey = allowEnv ? process.env.OLVID_CLIENT_KEY?.trim() : undefined;
+  const envDaemonUrl = allowEnv ? process.env.OLVID_DAEMON_TARGET?.trim() : undefined;
+  const configClientKey = merged.clientKey?.trim();
+  const configDaemonUrl = merged.daemonUrl?.trim();
+  const clientKey = configClientKey || envClientKey;
+  const daemonUrl = configDaemonUrl || envDaemonUrl;
+
+  const clientKeySource: OlvidClientKeySource = configClientKey
+    ? "config"
+    : envClientKey
+      ? "env"
+      : "none";
+  const daemonUrlSource: OlvidDaemonUrlSource = configDaemonUrl
+    ? "config"
+    : envDaemonUrl
+      ? "env"
+      : "none";
+
+  return {
+    accountId,
+    enabled,
+    name: merged.name?.trim() || undefined,
+    clientKey,
+    daemonUrl,
+    clientKeySource: clientKeySource,
+    daemonUrlSource: daemonUrlSource,
+    config: merged,
+    textChunkLimit: merged.textChunkLimit,
+    blockStreaming: merged.blockStreaming,
+    blockStreamingCoalesce: merged.blockStreamingCoalesce,
+  };
+}
+
+export function listEnabledOlvidAccounts(cfg: CoreConfig): ResolvedOlvidAccount[] {
+  return listOlvidAccountIds(cfg)
+    .map((accountId) => resolveOlvidAccount({ cfg, accountId }))
+    .filter((account) => account.enabled);
+}

package/pub/src/config-schema.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+
+export const OlvidAccountSchema = z
+  .object({
+    name: z.string().optional(),
+    enabled: z.boolean().optional(),
+    daemonUrl: z.string().optional(),
+    clientKey: z.string().optional(),
+  })
+  .strict();
+
+export const OlvidConfigSchema = OlvidAccountSchema.extend({
+  accounts: z.record(z.string(), OlvidAccountSchema.optional()).optional(),
+});