@openclaw/matrix 2026.3.12 → 2026.5.9-beta.1

package/package.json

@@ -1,20 +1,41 @@
 {
   "name": "@openclaw/matrix",
-  "version": "2026.3.12",
+  "version": "2026.5.9-beta.1",
   "description": "OpenClaw Matrix channel plugin",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openclaw/openclaw"
+  },
   "type": "module",
   "dependencies": {
-    "@mariozechner/pi-agent-core": "0.57.1",
-    "@matrix-org/matrix-sdk-crypto-nodejs": "^0.4.0",
-    "@vector-im/matrix-bot-sdk": "0.8.0-element.3",
+    "@matrix-org/matrix-sdk-crypto-nodejs": "^0.5.1",
+    "@matrix-org/matrix-sdk-crypto-wasm": "18.2.0",
+    "fake-indexeddb": "^6.2.5",
     "markdown-it": "14.1.1",
+    "matrix-js-sdk": "41.5.0-rc.0",
     "music-metadata": "^11.12.3",
-    "zod": "^4.3.6"
+    "typebox": "1.1.38"
+  },
+  "devDependencies": {
+    "@openclaw/plugin-sdk": "workspace:*",
+    "openclaw": "workspace:*"
+  },
+  "peerDependencies": {
+    "openclaw": ">=2026.5.9-beta.1"
+  },
+  "peerDependenciesMeta": {
+    "openclaw": {
+      "optional": true
+    }
   },
   "openclaw": {
     "extensions": [
       "./index.ts"
     ],
+    "setupEntry": "./setup-entry.ts",
+    "setupFeatures": {
+      "configPromotion": true
+    },
     "channel": {
       "id": "matrix",
       "label": "Matrix",
@@ -23,19 +44,64 @@
       "docsLabel": "matrix",
       "blurb": "open protocol; install the plugin to enable.",
       "order": 70,
-      "quickstartAllowFrom": true
+      "quickstartAllowFrom": true,
+      "doctorCapabilities": {
+        "dmAllowFromMode": "nestedOnly",
+        "groupModel": "sender",
+        "groupAllowFromFallbackToAllowFrom": false,
+        "warnOnEmptyGroupSenderAllowlist": true
+      },
+      "cliAddOptions": [
+        {
+          "flags": "--homeserver <url>",
+          "description": "Matrix homeserver URL"
+        },
+        {
+          "flags": "--user-id <id>",
+          "description": "Matrix user ID"
+        },
+        {
+          "flags": "--access-token <token>",
+          "description": "Matrix access token"
+        },
+        {
+          "flags": "--device-name <name>",
+          "description": "Matrix device name"
+        },
+        {
+          "flags": "--initial-sync-limit <n>",
+          "description": "Matrix initial sync limit"
+        }
+      ],
+      "persistedAuthState": {
+        "specifier": "./auth-presence",
+        "exportName": "hasAnyMatrixAuth"
+      }
     },
     "install": {
+      "clawhubSpec": "clawhub:@openclaw/matrix",
       "npmSpec": "@openclaw/matrix",
-      "localPath": "extensions/matrix",
-      "defaultChoice": "npm"
+      "defaultChoice": "clawhub",
+      "minHostVersion": ">=2026.4.10",
+      "allowInvalidConfigRecovery": true
     },
-    "releaseChecks": {
-      "rootDependencyMirrorAllowlist": [
-        "@matrix-org/matrix-sdk-crypto-nodejs",
-        "@vector-im/matrix-bot-sdk",
-        "music-metadata"
-      ]
-    }
-  }
+    "compat": {
+      "pluginApi": ">=2026.5.9-beta.1"
+    },
+    "build": {
+      "openclawVersion": "2026.5.9-beta.1"
+    },
+    "release": {
+      "publishToClawHub": true,
+      "publishToNpm": true
+    },
+    "runtimeExtensions": [
+      "./dist/index.js"
+    ],
+    "runtimeSetupEntry": "./dist/setup-entry.js"
+  },
+  "files": [
+    "dist/**",
+    "openclaw.plugin.json"
+  ]
 }

package/CHANGELOG.md

@@ -1,98 +0,0 @@
-# Changelog
-
-## 2026.3.12
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.11
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.10
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.9
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.8-beta.1
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.8
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.7
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.3
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.2
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.3.1
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.2.26
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.2.25
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.2.24
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.2.22
-
-### Changes
-
-- Version alignment with core OpenClaw release numbers.
-
-## 2026.1.14
-
-### Features
-
-- Matrix channel plugin with homeserver + user ID auth (access token or password login with device name).
-- Direct messages with pairing/allowlist/open/disabled policies and allowFrom support.
-- Group/room controls: allowlist policy, per-room config, mention gating, auto-reply, per-room skills/system prompts.
-- Threads: replyToMode controls and thread replies (off/inbound/always).
-- Messaging: text chunking, media uploads with size caps, reactions, polls, typing, and message edits/deletes.
-- Actions: read messages, list/remove reactions, pin/unpin/list pins, member info, room info.
-- Auto-join invites with allowlist support.
-- Status + probe reporting for health checks.

package/index.ts

@@ -1,22 +0,0 @@
-import type { OpenClawPluginApi } from "openclaw/plugin-sdk/matrix";
-import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/matrix";
-import { matrixPlugin } from "./src/channel.js";
-import { ensureMatrixCryptoRuntime } from "./src/matrix/deps.js";
-import { setMatrixRuntime } from "./src/runtime.js";
-
-const plugin = {
-  id: "matrix",
-  name: "Matrix",
-  description: "Matrix channel plugin (matrix-js-sdk)",
-  configSchema: emptyPluginConfigSchema(),
-  register(api: OpenClawPluginApi) {
-    setMatrixRuntime(api.runtime);
-    void ensureMatrixCryptoRuntime({ log: api.logger.info }).catch((err) => {
-      const message = err instanceof Error ? err.message : String(err);
-      api.logger.warn?.(`matrix: crypto runtime bootstrap failed: ${message}`);
-    });
-    api.registerChannel({ plugin: matrixPlugin });
-  },
-};
-
-export default plugin;

package/src/actions.ts

@@ -1,195 +0,0 @@
-import {
-  createActionGate,
-  readNumberParam,
-  readStringParam,
-  type ChannelMessageActionAdapter,
-  type ChannelMessageActionContext,
-  type ChannelMessageActionName,
-  type ChannelToolSend,
-} from "openclaw/plugin-sdk/matrix";
-import { resolveMatrixAccount } from "./matrix/accounts.js";
-import { handleMatrixAction } from "./tool-actions.js";
-import type { CoreConfig } from "./types.js";
-
-export const matrixMessageActions: ChannelMessageActionAdapter = {
-  listActions: ({ cfg }) => {
-    const account = resolveMatrixAccount({ cfg: cfg as CoreConfig });
-    if (!account.enabled || !account.configured) {
-      return [];
-    }
-    const gate = createActionGate((cfg as CoreConfig).channels?.matrix?.actions);
-    const actions = new Set<ChannelMessageActionName>(["send", "poll"]);
-    if (gate("reactions")) {
-      actions.add("react");
-      actions.add("reactions");
-    }
-    if (gate("messages")) {
-      actions.add("read");
-      actions.add("edit");
-      actions.add("delete");
-    }
-    if (gate("pins")) {
-      actions.add("pin");
-      actions.add("unpin");
-      actions.add("list-pins");
-    }
-    if (gate("memberInfo")) {
-      actions.add("member-info");
-    }
-    if (gate("channelInfo")) {
-      actions.add("channel-info");
-    }
-    return Array.from(actions);
-  },
-  supportsAction: ({ action }) => action !== "poll",
-  extractToolSend: ({ args }): ChannelToolSend | null => {
-    const action = typeof args.action === "string" ? args.action.trim() : "";
-    if (action !== "sendMessage") {
-      return null;
-    }
-    const to = typeof args.to === "string" ? args.to : undefined;
-    if (!to) {
-      return null;
-    }
-    return { to };
-  },
-  handleAction: async (ctx: ChannelMessageActionContext) => {
-    const { action, params, cfg } = ctx;
-    const resolveRoomId = () =>
-      readStringParam(params, "roomId") ??
-      readStringParam(params, "channelId") ??
-      readStringParam(params, "to", { required: true });
-
-    if (action === "send") {
-      const to = readStringParam(params, "to", { required: true });
-      const content = readStringParam(params, "message", {
-        required: true,
-        allowEmpty: true,
-      });
-      const mediaUrl = readStringParam(params, "media", { trim: false });
-      const replyTo = readStringParam(params, "replyTo");
-      const threadId = readStringParam(params, "threadId");
-      return await handleMatrixAction(
-        {
-          action: "sendMessage",
-          to,
-          content,
-          mediaUrl: mediaUrl ?? undefined,
-          replyToId: replyTo ?? undefined,
-          threadId: threadId ?? undefined,
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "react") {
-      const messageId = readStringParam(params, "messageId", { required: true });
-      const emoji = readStringParam(params, "emoji", { allowEmpty: true });
-      const remove = typeof params.remove === "boolean" ? params.remove : undefined;
-      return await handleMatrixAction(
-        {
-          action: "react",
-          roomId: resolveRoomId(),
-          messageId,
-          emoji,
-          remove,
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "reactions") {
-      const messageId = readStringParam(params, "messageId", { required: true });
-      const limit = readNumberParam(params, "limit", { integer: true });
-      return await handleMatrixAction(
-        {
-          action: "reactions",
-          roomId: resolveRoomId(),
-          messageId,
-          limit,
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "read") {
-      const limit = readNumberParam(params, "limit", { integer: true });
-      return await handleMatrixAction(
-        {
-          action: "readMessages",
-          roomId: resolveRoomId(),
-          limit,
-          before: readStringParam(params, "before"),
-          after: readStringParam(params, "after"),
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "edit") {
-      const messageId = readStringParam(params, "messageId", { required: true });
-      const content = readStringParam(params, "message", { required: true });
-      return await handleMatrixAction(
-        {
-          action: "editMessage",
-          roomId: resolveRoomId(),
-          messageId,
-          content,
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "delete") {
-      const messageId = readStringParam(params, "messageId", { required: true });
-      return await handleMatrixAction(
-        {
-          action: "deleteMessage",
-          roomId: resolveRoomId(),
-          messageId,
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "pin" || action === "unpin" || action === "list-pins") {
-      const messageId =
-        action === "list-pins"
-          ? undefined
-          : readStringParam(params, "messageId", { required: true });
-      return await handleMatrixAction(
-        {
-          action:
-            action === "pin" ? "pinMessage" : action === "unpin" ? "unpinMessage" : "listPins",
-          roomId: resolveRoomId(),
-          messageId,
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "member-info") {
-      const userId = readStringParam(params, "userId", { required: true });
-      return await handleMatrixAction(
-        {
-          action: "memberInfo",
-          userId,
-          roomId: readStringParam(params, "roomId") ?? readStringParam(params, "channelId"),
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    if (action === "channel-info") {
-      return await handleMatrixAction(
-        {
-          action: "channelInfo",
-          roomId: resolveRoomId(),
-        },
-        cfg as CoreConfig,
-      );
-    }
-
-    throw new Error(`Action ${action} is not supported for provider matrix.`);
-  },
-};

package/src/channel.directory.test.ts

@@ -1,154 +0,0 @@
-import type { PluginRuntime, RuntimeEnv } from "openclaw/plugin-sdk/matrix";
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import { matrixPlugin } from "./channel.js";
-import { setMatrixRuntime } from "./runtime.js";
-import type { CoreConfig } from "./types.js";
-
-vi.mock("@vector-im/matrix-bot-sdk", () => ({
-  ConsoleLogger: class {
-    trace = vi.fn();
-    debug = vi.fn();
-    info = vi.fn();
-    warn = vi.fn();
-    error = vi.fn();
-  },
-  MatrixClient: class {},
-  LogService: {
-    setLogger: vi.fn(),
-    warn: vi.fn(),
-    info: vi.fn(),
-    debug: vi.fn(),
-  },
-  SimpleFsStorageProvider: class {},
-  RustSdkCryptoStorageProvider: class {},
-}));
-
-describe("matrix directory", () => {
-  const runtimeEnv: RuntimeEnv = {
-    log: vi.fn(),
-    error: vi.fn(),
-    exit: vi.fn((code: number): never => {
-      throw new Error(`exit ${code}`);
-    }),
-  };
-
-  beforeEach(() => {
-    setMatrixRuntime({
-      state: {
-        resolveStateDir: (_env, homeDir) => (homeDir ?? (() => "/tmp"))(),
-      },
-    } as PluginRuntime);
-  });
-
-  it("lists peers and groups from config", async () => {
-    const cfg = {
-      channels: {
-        matrix: {
-          dm: { allowFrom: ["matrix:@alice:example.org", "bob"] },
-          groupAllowFrom: ["@dana:example.org"],
-          groups: {
-            "!room1:example.org": { users: ["@carol:example.org"] },
-            "#alias:example.org": { users: [] },
-          },
-        },
-      },
-    } as unknown as CoreConfig;
-
-    expect(matrixPlugin.directory).toBeTruthy();
-    expect(matrixPlugin.directory?.listPeers).toBeTruthy();
-    expect(matrixPlugin.directory?.listGroups).toBeTruthy();
-
-    await expect(
-      matrixPlugin.directory!.listPeers!({
-        cfg,
-        accountId: undefined,
-        query: undefined,
-        limit: undefined,
-        runtime: runtimeEnv,
-      }),
-    ).resolves.toEqual(
-      expect.arrayContaining([
-        { kind: "user", id: "user:@alice:example.org" },
-        { kind: "user", id: "bob", name: "incomplete id; expected @user:server" },
-        { kind: "user", id: "user:@carol:example.org" },
-        { kind: "user", id: "user:@dana:example.org" },
-      ]),
-    );
-
-    await expect(
-      matrixPlugin.directory!.listGroups!({
-        cfg,
-        accountId: undefined,
-        query: undefined,
-        limit: undefined,
-        runtime: runtimeEnv,
-      }),
-    ).resolves.toEqual(
-      expect.arrayContaining([
-        { kind: "group", id: "room:!room1:example.org" },
-        { kind: "group", id: "#alias:example.org" },
-      ]),
-    );
-  });
-
-  it("resolves replyToMode from account config", () => {
-    const cfg = {
-      channels: {
-        matrix: {
-          replyToMode: "off",
-          accounts: {
-            Assistant: {
-              replyToMode: "all",
-            },
-          },
-        },
-      },
-    } as unknown as CoreConfig;
-
-    expect(matrixPlugin.threading?.resolveReplyToMode).toBeTruthy();
-    expect(
-      matrixPlugin.threading?.resolveReplyToMode?.({
-        cfg,
-        accountId: "assistant",
-        chatType: "direct",
-      }),
-    ).toBe("all");
-    expect(
-      matrixPlugin.threading?.resolveReplyToMode?.({
-        cfg,
-        accountId: "default",
-        chatType: "direct",
-      }),
-    ).toBe("off");
-  });
-
-  it("resolves group mention policy from account config", () => {
-    const cfg = {
-      channels: {
-        matrix: {
-          groups: {
-            "!room:example.org": { requireMention: true },
-          },
-          accounts: {
-            Assistant: {
-              groups: {
-                "!room:example.org": { requireMention: false },
-              },
-            },
-          },
-        },
-      },
-    } as unknown as CoreConfig;
-
-    expect(matrixPlugin.groups!.resolveRequireMention!({ cfg, groupId: "!room:example.org" })).toBe(
-      true,
-    );
-    expect(
-      matrixPlugin.groups!.resolveRequireMention!({
-        cfg,
-        accountId: "assistant",
-        groupId: "!room:example.org",
-      }),
-    ).toBe(false);
-  });
-});