@zbruceli/openclaw-dchat 0.3.0 → 0.4.0

package/index.ts

@@ -1,5 +1,5 @@
-import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
-import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core";
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core";
 import { dchatPlugin } from "./src/channel.js";
 import { setDchatRuntime } from "./src/runtime.js";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zbruceli/openclaw-dchat",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "OpenClaw D-Chat/nMobile channel plugin — decentralized E2E encrypted messaging over the NKN relay network",
   "type": "module",
   "main": "index.ts",

package/src/channel.ts

@@ -1,19 +1,21 @@
 import {
   applyAccountNameToChannelSection,
-  buildBaseAccountStatusSnapshot,
-  buildBaseChannelStatusSummary,
   buildChannelConfigSchema,
-  collectStatusIssuesFromLastError,
-  createDefaultChannelRuntimeState,
   DEFAULT_ACCOUNT_ID,
   deleteAccountFromConfigSection,
   normalizeAccountId,
-  resolveOutboundMediaUrls,
-  resolveSenderCommandAuthorization,
   setAccountEnabledInConfigSection,
   type ChannelPlugin,
-} from "openclaw/plugin-sdk";
-import type { PluginRuntime } from "openclaw/plugin-sdk";
+  type PluginRuntime,
+} from "openclaw/plugin-sdk/core";
+import {
+  buildBaseAccountStatusSnapshot,
+  buildBaseChannelStatusSummary,
+  collectStatusIssuesFromLastError,
+  createDefaultChannelRuntimeState,
+} from "openclaw/plugin-sdk/status-helpers";
+import { resolveOutboundMediaUrls } from "openclaw/plugin-sdk/reply-payload";
+import { resolveSenderCommandAuthorization } from "openclaw/plugin-sdk/command-auth";
 
 /* ── Inline helpers that may not exist in older OpenClaw versions ── */
 
@@ -30,7 +32,7 @@ function createScopedPairingAccess(params: {
         channel: params.channel,
         accountId: resolvedAccountId,
       }),
-    upsertPairingRequest: (input: { id: string; meta?: Record<string, unknown> }) =>
+    upsertPairingRequest: (input: { id: string; meta?: Record<string, string | null | undefined> }) =>
       params.core.channel.pairing.upsertPairingRequest({
         channel: params.channel,
         accountId: resolvedAccountId,
@@ -51,7 +53,7 @@ import {
   resolveDefaultDchatAccountId,
 } from "./config-schema.js";
 import { NknBus } from "./nkn-bus.js";
-import { dchatOnboardingAdapter } from "./onboarding.js";
+import { dchatSetupWizard } from "./onboarding.js";
 import { getDchatRuntime } from "./runtime.js";
 import { SeenTracker } from "./seen-tracker.js";
 import type { ResolvedDchatAccount } from "./types.js";
@@ -92,7 +94,7 @@ function getBusForAccount(accountId: string): NknBus | undefined {
 export const dchatPlugin: ChannelPlugin<ResolvedDchatAccount> = {
   id: "dchat",
   meta,
-  onboarding: dchatOnboardingAdapter,
+  setupWizard: dchatSetupWizard,
   capabilities: {
     chatTypes: ["direct", "group"],
     media: true,
@@ -138,7 +140,7 @@ export const dchatPlugin: ChannelPlugin<ResolvedDchatAccount> = {
       name: account.name,
       enabled: account.enabled,
       configured: account.configured,
-      nknAddress: account.nknAddress ?? null,
+      publicKey: account.nknAddress ?? null,
     }),
     resolveAllowFrom: ({ cfg, accountId }) => {
       const dchatConfig = resolveDchatAccountConfig({ cfg: cfg as CoreConfig, accountId });
@@ -407,15 +409,15 @@ export const dchatPlugin: ChannelPlugin<ResolvedDchatAccount> = {
     },
     buildChannelSummary: ({ snapshot }) => ({
       ...buildBaseChannelStatusSummary(snapshot),
-      nknAddress: snapshot.nknAddress ?? null,
+      publicKey: snapshot.publicKey ?? null,
       connected: snapshot.connected ?? false,
       lastConnectedAt: snapshot.lastConnectedAt ?? null,
     }),
     buildAccountSnapshot: ({ account, runtime }) => ({
       ...buildBaseAccountStatusSnapshot({ account, runtime }),
-      nknAddress: account.nknAddress ?? null,
-      connected: (runtime as Record<string, unknown>)?.connected ?? false,
-      lastConnectedAt: (runtime as Record<string, unknown>)?.lastConnectedAt ?? null,
+      publicKey: account.nknAddress ?? null,
+      connected: Boolean(runtime?.connected),
+      lastConnectedAt: runtime?.lastConnectedAt ?? null,
     }),
     collectStatusIssues: (accounts) => collectStatusIssuesFromLastError("dchat", accounts),
   },

package/src/config-schema.ts

@@ -1,5 +1,5 @@
 import nkn from "nkn-sdk";
-import type { OpenClawConfig } from "openclaw/plugin-sdk";
+import type { OpenClawConfig } from "openclaw/plugin-sdk/core";
 import { z } from "zod";
 import type { DchatAccountConfig, ResolvedDchatAccount } from "./types.js";
 

package/src/onboarding.ts

@@ -1,13 +1,14 @@
-import type { DmPolicy } from "openclaw/plugin-sdk";
+import type { DmPolicy } from "openclaw/plugin-sdk/setup";
 import {
   addWildcardAllowFrom,
   mergeAllowFromEntries,
   formatDocsLink,
-  type ChannelOnboardingAdapter,
-  type ChannelOnboardingDmPolicy,
+  type ChannelSetupDmPolicy,
   type WizardPrompter,
-} from "openclaw/plugin-sdk";
-import { listDchatAccountIds, resolveDchatAccount, type CoreConfig } from "./config-schema.js";
+} from "openclaw/plugin-sdk/setup";
+import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup";
+import type { OpenClawConfig } from "openclaw/plugin-sdk/core";
+import { listDchatAccountIds, resolveDchatAccount, resolveDchatAccountConfig, type CoreConfig } from "./config-schema.js";
 
 const channel = "dchat" as const;
 
@@ -30,154 +31,134 @@ function setDchatDmPolicy(cfg: CoreConfig, policy: DmPolicy) {
   };
 }
 
-async function promptDchatAllowFrom(params: {
-  cfg: CoreConfig;
-  prompter: WizardPrompter;
-}): Promise<CoreConfig> {
-  const { cfg, prompter } = params;
-  const existingAllowFrom = cfg.channels?.dchat?.allowFrom ?? [];
-
-  const entry = await prompter.text({
-    message: "NKN address to allow (full public key hex)",
-    placeholder: "abc123...def456 (64-char hex NKN address)",
-    initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined,
-    validate: (value) => (String(value ?? "").trim() ? undefined : "Required"),
-  });
-
-  const parts = String(entry)
-    .split(/[\n,;]+/g)
-    .map((e) => e.trim())
-    .filter(Boolean);
-
-  const unique = mergeAllowFromEntries(existingAllowFrom, parts);
-  return {
-    ...cfg,
-    channels: {
-      ...cfg.channels,
-      dchat: {
-        ...cfg.channels?.dchat,
-        enabled: true,
-        dmPolicy: "allowlist",
-        allowFrom: unique,
-      },
-    },
-  };
-}
-
-const dmPolicy: ChannelOnboardingDmPolicy = {
+const dmPolicy: ChannelSetupDmPolicy = {
   label: "D-Chat",
   channel,
   policyKey: "channels.dchat.dmPolicy",
   allowFromKey: "channels.dchat.allowFrom",
   getCurrent: (cfg) => ((cfg as CoreConfig).channels?.dchat?.dmPolicy as DmPolicy) ?? "pairing",
   setPolicy: (cfg, policy) => setDchatDmPolicy(cfg as CoreConfig, policy),
-  promptAllowFrom: promptDchatAllowFrom,
-};
+  promptAllowFrom: async (params) => {
+    const cfg = params.cfg as CoreConfig;
+    const { prompter } = params;
+    const existingAllowFrom = cfg.channels?.dchat?.allowFrom ?? [];
 
-export const dchatOnboardingAdapter: ChannelOnboardingAdapter = {
-  channel,
-  getStatus: async ({ cfg }) => {
-    const typedCfg = cfg as CoreConfig;
-    const accountIds = listDchatAccountIds(typedCfg);
-    const anyConfigured = accountIds.some(
-      (id) => resolveDchatAccount({ cfg: typedCfg, accountId: id }).configured,
-    );
+    const entry = await prompter.text({
+      message: "NKN address to allow (full public key hex)",
+      placeholder: "abc123...def456 (64-char hex NKN address)",
+      initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined,
+      validate: (value) => (String(value ?? "").trim() ? undefined : "Required"),
+    });
+
+    const parts = String(entry)
+      .split(/[\n,;]+/g)
+      .map((e) => e.trim())
+      .filter(Boolean);
+
+    const unique = mergeAllowFromEntries(existingAllowFrom, parts);
     return {
-      channel,
-      configured: anyConfigured,
-      statusLines: [`D-Chat: ${anyConfigured ? "configured" : "needs wallet seed"}`],
-      selectionHint: anyConfigured ? "configured" : "needs seed",
+      ...cfg,
+      channels: {
+        ...cfg.channels,
+        dchat: {
+          ...cfg.channels?.dchat,
+          enabled: true,
+          dmPolicy: "allowlist",
+          allowFrom: unique,
+        },
+      },
     };
   },
-  configure: async ({ cfg, prompter, forceAllowFrom }) => {
-    let next = cfg as CoreConfig;
-    const existing = next.channels?.dchat ?? {};
-    const account = resolveDchatAccount({ cfg: next });
+};
 
-    if (!account.configured) {
-      await prompter.note(
-        [
-          "D-Chat uses the NKN relay network for decentralized E2E encrypted messaging.",
-          "You need a wallet seed (64-character hex string) to connect.",
-          "Generate one with nkn-sdk or use an existing seed from D-Chat/nMobile.",
-          `Docs: ${formatDocsLink("/channels/dchat", "channels/dchat")}`,
-        ].join("\n"),
-        "D-Chat setup",
+export const dchatSetupWizard: ChannelSetupWizard = {
+  channel,
+  status: {
+    configuredLabel: "configured",
+    unconfiguredLabel: "needs wallet seed",
+    resolveConfigured: ({ cfg }) => {
+      const typedCfg = cfg as CoreConfig;
+      const accountIds = listDchatAccountIds(typedCfg);
+      return accountIds.some(
+        (id) => resolveDchatAccount({ cfg: typedCfg, accountId: id }).configured,
       );
-    }
-
-    // Check for env var (validate same 64-hex format as prompted input)
-    const envSeed = process.env.DCHAT_SEED?.trim() || process.env.NKN_SEED?.trim();
-    if (envSeed && /^[0-9a-f]{64}$/i.test(envSeed) && !existing.seed) {
-      const useEnv = await prompter.confirm({
-        message: "NKN seed env var detected. Use env value?",
-        initialValue: true,
-      });
-      if (useEnv) {
-        next = {
-          ...next,
+    },
+    resolveStatusLines: ({ cfg, configured }) => [
+      `D-Chat: ${configured ? "configured" : "needs wallet seed"}`,
+    ],
+    resolveSelectionHint: ({ configured }) =>
+      configured ? "configured" : "needs seed",
+  },
+  introNote: {
+    title: "D-Chat setup",
+    lines: [
+      "D-Chat uses the NKN relay network for decentralized E2E encrypted messaging.",
+      "You need a wallet seed (64-character hex string) to connect.",
+      "Generate one with nkn-sdk or use an existing seed from D-Chat/nMobile.",
+      `Docs: ${formatDocsLink("/channels/dchat", "channels/dchat")}`,
+    ],
+    shouldShow: ({ cfg }) => {
+      const account = resolveDchatAccount({ cfg: cfg as CoreConfig });
+      return !account.configured;
+    },
+  },
+  envShortcut: {
+    prompt: "NKN seed env var detected. Use env value?",
+    preferredEnvVar: "DCHAT_SEED",
+    isAvailable: ({ cfg }) => {
+      const envSeed = process.env.DCHAT_SEED?.trim() || process.env.NKN_SEED?.trim();
+      const existing = (cfg as CoreConfig).channels?.dchat?.seed;
+      return Boolean(envSeed && /^[0-9a-f]{64}$/i.test(envSeed) && !existing);
+    },
+    apply: ({ cfg, accountId }) => {
+      const envSeed = (process.env.DCHAT_SEED?.trim() || process.env.NKN_SEED?.trim())!;
+      return {
+        ...cfg,
+        channels: {
+          ...(cfg as CoreConfig).channels,
+          dchat: {
+            ...(cfg as CoreConfig).channels?.dchat,
+            enabled: true,
+            seed: envSeed,
+          },
+        },
+      } as OpenClawConfig;
+    },
+  },
+  credentials: [
+    {
+      inputKey: "accessToken",
+      providerHint: "NKN",
+      credentialLabel: "wallet seed",
+      preferredEnvVar: "DCHAT_SEED",
+      envPrompt: "NKN seed env var detected. Use env value?",
+      keepPrompt: "Wallet seed already configured. Keep it?",
+      inputPrompt: "NKN wallet seed (64-char hex)",
+      inspect: ({ cfg, accountId }) => {
+        const acctCfg = resolveDchatAccountConfig({ cfg: cfg as CoreConfig, accountId });
+        const seed = acctCfg.seed?.trim();
+        return {
+          accountConfigured: Boolean(seed),
+          hasConfiguredValue: Boolean(seed),
+          resolvedValue: seed,
+        };
+      },
+      applySet: ({ cfg, accountId, resolvedValue }) => {
+        const seed = resolvedValue.trim();
+        return {
+          ...cfg,
           channels: {
-            ...next.channels,
+            ...(cfg as CoreConfig).channels,
             dchat: {
-              ...next.channels?.dchat,
+              ...(cfg as CoreConfig).channels?.dchat,
               enabled: true,
-              seed: envSeed,
+              seed,
             },
           },
-        };
-        if (forceAllowFrom) {
-          next = await promptDchatAllowFrom({ cfg: next, prompter });
-        }
-        return { cfg: next };
-      }
-    }
-
-    // Prompt for seed
-    let seed = existing.seed ?? "";
-    if (seed) {
-      const keep = await prompter.confirm({
-        message: "Wallet seed already configured. Keep it?",
-        initialValue: true,
-      });
-      if (!keep) {
-        seed = "";
-      }
-    }
-
-    if (!seed) {
-      seed = String(
-        await prompter.text({
-          message: "NKN wallet seed (64-char hex)",
-          validate: (value) => {
-            const raw = String(value ?? "").trim();
-            if (!raw) return "Required";
-            if (!/^[0-9a-f]{64}$/i.test(raw)) {
-              return "Must be a 64-character hex string";
-            }
-            return undefined;
-          },
-        }),
-      ).trim();
-    }
-
-    next = {
-      ...next,
-      channels: {
-        ...next.channels,
-        dchat: {
-          ...next.channels?.dchat,
-          enabled: true,
-          seed,
-        },
+        } as OpenClawConfig;
       },
-    };
-
-    if (forceAllowFrom) {
-      next = await promptDchatAllowFrom({ cfg: next, prompter });
-    }
-
-    return { cfg: next };
-  },
+    },
+  ],
   dmPolicy,
   disable: (cfg) => ({
     ...(cfg as CoreConfig),

package/src/runtime.ts

@@ -1,4 +1,4 @@
-import type { PluginRuntime } from "openclaw/plugin-sdk";
+import type { PluginRuntime } from "openclaw/plugin-sdk/core";
 
 let runtime: PluginRuntime | null = null;