@openclaw/discord 2026.3.13 → 2026.5.1-beta.1

package/src/components.test.ts

@@ -0,0 +1,312 @@
+import { MessageFlags } from "discord-api-types/v10";
+import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
+
+let clearDiscordComponentEntries: typeof import("./components-registry.js").clearDiscordComponentEntries;
+let registerDiscordComponentEntries: typeof import("./components-registry.js").registerDiscordComponentEntries;
+let resolveDiscordComponentEntry: typeof import("./components-registry.js").resolveDiscordComponentEntry;
+let resolveDiscordComponentEntryWithPersistence: typeof import("./components-registry.js").resolveDiscordComponentEntryWithPersistence;
+let resolveDiscordModalEntry: typeof import("./components-registry.js").resolveDiscordModalEntry;
+let resolveDiscordModalEntryWithPersistence: typeof import("./components-registry.js").resolveDiscordModalEntryWithPersistence;
+let buildDiscordComponentMessage: typeof import("./components.js").buildDiscordComponentMessage;
+let buildDiscordComponentMessageFlags: typeof import("./components.js").buildDiscordComponentMessageFlags;
+let readDiscordComponentSpec: typeof import("./components.js").readDiscordComponentSpec;
+
+beforeAll(async () => {
+  ({
+    clearDiscordComponentEntries,
+    registerDiscordComponentEntries,
+    resolveDiscordComponentEntry,
+    resolveDiscordComponentEntryWithPersistence,
+    resolveDiscordModalEntry,
+    resolveDiscordModalEntryWithPersistence,
+  } = await import("./components-registry.js"));
+  ({ buildDiscordComponentMessage, buildDiscordComponentMessageFlags, readDiscordComponentSpec } =
+    await import("./components.js"));
+});
+
+describe("discord components", () => {
+  it("builds v2 containers with modal trigger", () => {
+    const spec = readDiscordComponentSpec({
+      text: "Choose a path",
+      blocks: [
+        {
+          type: "actions",
+          buttons: [{ label: "Approve", style: "success", callbackData: "codex:approve" }],
+        },
+      ],
+      modal: {
+        title: "Details",
+        callbackData: "codex:modal",
+        allowedUsers: ["discord:user-1"],
+        fields: [{ type: "text", label: "Requester" }],
+      },
+    });
+    if (!spec) {
+      throw new Error("Expected component spec to be parsed");
+    }
+
+    const result = buildDiscordComponentMessage({ spec });
+    expect(result.components).toHaveLength(1);
+    expect(result.components[0]?.isV2).toBe(true);
+    expect(buildDiscordComponentMessageFlags(result.components)).toBe(MessageFlags.IsComponentsV2);
+    expect(result.modals).toHaveLength(1);
+
+    const trigger = result.entries.find((entry) => entry.kind === "modal-trigger");
+    expect(trigger?.modalId).toBe(result.modals[0]?.id);
+    expect(result.entries.find((entry) => entry.kind === "button")?.callbackData).toBe(
+      "codex:approve",
+    );
+    expect(result.modals[0]?.callbackData).toBe("codex:modal");
+    expect(result.modals[0]?.allowedUsers).toEqual(["discord:user-1"]);
+  });
+
+  it("requires options for modal select fields", () => {
+    expect(() =>
+      readDiscordComponentSpec({
+        modal: {
+          title: "Details",
+          fields: [{ type: "select", label: "Priority" }],
+        },
+      }),
+    ).toThrow("options");
+  });
+
+  it("requires attachment references for file blocks", () => {
+    expect(() =>
+      readDiscordComponentSpec({
+        blocks: [{ type: "file", file: "https://example.com/report.pdf" }],
+      }),
+    ).toThrow("attachment://");
+    expect(() =>
+      readDiscordComponentSpec({
+        blocks: [{ type: "file", file: "attachment://" }],
+      }),
+    ).toThrow("filename");
+  });
+});
+
+describe("discord component registry", () => {
+  beforeEach(() => {
+    clearDiscordComponentEntries();
+    vi.restoreAllMocks();
+  });
+
+  const componentsRegistryModuleUrl = new URL("./components-registry.ts", import.meta.url).href;
+
+  it("registers and consumes component entries", () => {
+    registerDiscordComponentEntries({
+      entries: [{ id: "btn_1", kind: "button", label: "Confirm" }],
+      modals: [
+        {
+          id: "mdl_1",
+          title: "Details",
+          fields: [{ id: "fld_1", name: "name", label: "Name", type: "text" }],
+        },
+      ],
+      messageId: "msg_1",
+      ttlMs: 1000,
+    });
+
+    const entry = resolveDiscordComponentEntry({ id: "btn_1", consume: false });
+    expect(entry?.messageId).toBe("msg_1");
+
+    const modal = resolveDiscordModalEntry({ id: "mdl_1", consume: false });
+    expect(modal?.messageId).toBe("msg_1");
+
+    const consumed = resolveDiscordComponentEntry({ id: "btn_1" });
+    expect(consumed?.id).toBe("btn_1");
+    expect(resolveDiscordComponentEntry({ id: "btn_1" })).toBeNull();
+  });
+
+  it("consumes sibling entries from the same non-reusable component message", () => {
+    const result = buildDiscordComponentMessage({
+      spec: {
+        text: "Confirm action",
+        blocks: [
+          {
+            type: "actions",
+            buttons: [
+              { label: "Confirm", callbackData: "confirm" },
+              { label: "Cancel", callbackData: "cancel" },
+            ],
+          },
+        ],
+      },
+    });
+    const confirm = result.entries.find((entry) => entry.label === "Confirm");
+    const cancel = result.entries.find((entry) => entry.label === "Cancel");
+    expect(confirm?.consumptionGroupId).toBeTruthy();
+    expect(cancel?.consumptionGroupId).toBe(confirm?.consumptionGroupId);
+    expect(confirm?.consumptionGroupEntryIds).toEqual(
+      expect.arrayContaining([confirm?.id, cancel?.id]),
+    );
+
+    registerDiscordComponentEntries({
+      entries: result.entries,
+      modals: [],
+      messageId: "msg_1",
+      ttlMs: 1000,
+    });
+
+    const consumed = resolveDiscordComponentEntry({ id: confirm?.id ?? "" });
+    expect(consumed?.label).toBe("Confirm");
+    expect(resolveDiscordComponentEntry({ id: cancel?.id ?? "", consume: false })).toBeNull();
+  });
+
+  it("shares registry state across duplicate module instances", async () => {
+    const first = (await import(
+      `${componentsRegistryModuleUrl}?t=first-${Date.now()}`
+    )) as typeof import("./components-registry.js");
+    const second = (await import(
+      `${componentsRegistryModuleUrl}?t=second-${Date.now()}`
+    )) as typeof import("./components-registry.js");
+
+    first.clearDiscordComponentEntries();
+    first.registerDiscordComponentEntries({
+      entries: [{ id: "btn_shared", kind: "button", label: "Shared" }],
+      modals: [],
+    });
+
+    expect(second.resolveDiscordComponentEntry({ id: "btn_shared", consume: false })).toMatchObject(
+      {
+        id: "btn_shared",
+        label: "Shared",
+      },
+    );
+
+    second.clearDiscordComponentEntries();
+  });
+
+  it("persists component and modal entries when runtime state is available", async () => {
+    const componentRegister = vi.fn().mockResolvedValue(undefined);
+    const modalRegister = vi.fn().mockResolvedValue(undefined);
+    const componentLookup = vi.fn().mockResolvedValue({
+      version: 1,
+      entry: { id: "btn_persisted", kind: "button", label: "Persisted" },
+    });
+    const modalLookup = vi.fn().mockResolvedValue({
+      version: 1,
+      entry: { id: "mdl_persisted", title: "Persisted", fields: [] },
+    });
+    const componentStore = {
+      register: componentRegister,
+      lookup: componentLookup,
+      consume: vi.fn(),
+      delete: vi.fn(),
+      entries: vi.fn(),
+      clear: vi.fn(),
+    };
+    const modalStore = {
+      register: modalRegister,
+      lookup: modalLookup,
+      consume: vi.fn(),
+      delete: vi.fn(),
+      entries: vi.fn(),
+      clear: vi.fn(),
+    };
+    const openKeyedStore = vi.fn((opts: { namespace: string }) =>
+      opts.namespace === "discord.components" ? componentStore : modalStore,
+    );
+    const { setDiscordRuntime } = await import("./runtime.js");
+    setDiscordRuntime({
+      state: { openKeyedStore },
+      logging: { getChildLogger: () => ({ warn: vi.fn() }) },
+    } as never);
+
+    registerDiscordComponentEntries({
+      entries: [{ id: "btn_1", kind: "button", label: "Confirm" }],
+      modals: [{ id: "mdl_1", title: "Details", fields: [] }],
+      ttlMs: 1000,
+    });
+
+    await vi.waitFor(() => expect(componentRegister).toHaveBeenCalledTimes(1));
+    expect(componentRegister).toHaveBeenCalledWith(
+      "btn_1",
+      { version: 1, entry: expect.objectContaining({ id: "btn_1" }) },
+      { ttlMs: 1000 },
+    );
+    expect(modalRegister).toHaveBeenCalledWith(
+      "mdl_1",
+      { version: 1, entry: expect.objectContaining({ id: "mdl_1" }) },
+      { ttlMs: 1000 },
+    );
+
+    clearDiscordComponentEntries();
+    await expect(
+      resolveDiscordComponentEntryWithPersistence({ id: "btn_persisted", consume: false }),
+    ).resolves.toMatchObject({ id: "btn_persisted" });
+    await expect(
+      resolveDiscordModalEntryWithPersistence({ id: "mdl_persisted", consume: false }),
+    ).resolves.toMatchObject({ id: "mdl_persisted" });
+    expect(componentLookup).toHaveBeenCalledWith("btn_persisted");
+    expect(modalLookup).toHaveBeenCalledWith("mdl_persisted");
+    expect(openKeyedStore).toHaveBeenCalledTimes(4);
+  });
+
+  it("deletes sibling persistent component entries when a group entry is consumed", async () => {
+    const componentDelete = vi.fn().mockResolvedValue(true);
+    const componentStore = {
+      register: vi.fn(),
+      lookup: vi.fn(),
+      consume: vi.fn().mockResolvedValue({
+        version: 1,
+        entry: {
+          id: "btn_confirm",
+          kind: "button",
+          label: "Confirm",
+          consumptionGroupId: "grp_1",
+          consumptionGroupEntryIds: ["btn_confirm", "btn_cancel"],
+        },
+      }),
+      delete: componentDelete,
+    };
+    const modalStore = {
+      register: vi.fn(),
+      lookup: vi.fn(),
+      consume: vi.fn(),
+      delete: vi.fn(),
+    };
+    const openKeyedStore = vi.fn((opts: { namespace: string }) =>
+      opts.namespace === "discord.components" ? componentStore : modalStore,
+    );
+    const { setDiscordRuntime } = await import("./runtime.js");
+    setDiscordRuntime({
+      state: { openKeyedStore },
+      logging: { getChildLogger: () => ({ warn: vi.fn() }) },
+    } as never);
+
+    clearDiscordComponentEntries();
+    await expect(
+      resolveDiscordComponentEntryWithPersistence({ id: "btn_confirm" }),
+    ).resolves.toMatchObject({
+      id: "btn_confirm",
+    });
+
+    await vi.waitFor(() => expect(componentDelete).toHaveBeenCalledWith("btn_cancel"));
+    expect(componentDelete).toHaveBeenCalledWith("btn_confirm");
+  });
+
+  it("falls back to the in-memory registry when persistent state cannot open", async () => {
+    const warn = vi.fn();
+    const { setDiscordRuntime } = await import("./runtime.js");
+    setDiscordRuntime({
+      state: {
+        openKeyedStore: vi.fn(() => {
+          throw new Error("sqlite unavailable");
+        }),
+      },
+      logging: { getChildLogger: () => ({ warn }) },
+    } as never);
+
+    registerDiscordComponentEntries({
+      entries: [{ id: "btn_fallback", kind: "button", label: "Fallback" }],
+      modals: [],
+    });
+
+    expect(resolveDiscordComponentEntry({ id: "btn_fallback", consume: false })).toMatchObject({
+      id: "btn_fallback",
+      label: "Fallback",
+    });
+    expect(warn).toHaveBeenCalled();
+  });
+});

package/src/components.ts

@@ -0,0 +1,54 @@
+export {
+  DISCORD_COMPONENT_CUSTOM_ID_KEY,
+  DISCORD_MODAL_CUSTOM_ID_KEY,
+  buildDiscordComponentCustomId,
+  buildDiscordModalCustomId,
+  parseDiscordComponentCustomId,
+  parseDiscordComponentCustomIdForInteraction,
+  parseDiscordModalCustomId,
+  parseDiscordModalCustomIdForInteraction,
+} from "./component-custom-id.js";
+export {
+  buildDiscordComponentMessage,
+  buildDiscordComponentMessageFlags,
+} from "./components.builders.js";
+export {
+  DISCORD_COMPONENT_ATTACHMENT_PREFIX,
+  readDiscordComponentSpec,
+  resolveDiscordComponentAttachmentName,
+} from "./components.parse.js";
+export { DiscordFormModal, createDiscordFormModal } from "./components.modal.js";
+export type {
+  DiscordComponentBlock,
+  DiscordComponentBuildResult,
+  DiscordComponentButtonSpec,
+  DiscordComponentButtonStyle,
+  DiscordComponentEntry,
+  DiscordComponentMessageSpec,
+  DiscordComponentModalFieldType,
+  DiscordComponentSectionAccessory,
+  DiscordComponentSelectOption,
+  DiscordComponentSelectSpec,
+  DiscordComponentSelectType,
+  DiscordModalEntry,
+  DiscordModalFieldDefinition,
+  DiscordModalFieldSpec,
+  DiscordModalSpec,
+} from "./components.types.js";
+export { buildDiscordInteractiveComponents } from "./shared-interactive.js";
+export { Modal, type ComponentData } from "./internal/discord.js";
+
+export function formatDiscordComponentEventText(params: {
+  kind: "button" | "select";
+  label: string;
+  values?: string[];
+}): string {
+  if (params.kind === "button") {
+    return `Clicked "${params.label}".`;
+  }
+  const values = params.values ?? [];
+  if (values.length === 0) {
+    return `Updated "${params.label}".`;
+  }
+  return `Selected ${values.join(", ")} from "${params.label}".`;
+}

package/src/components.types.ts

@@ -0,0 +1,187 @@
+import type { TopLevelComponents } from "./internal/discord.js";
+
+export type DiscordComponentButtonStyle = "primary" | "secondary" | "success" | "danger" | "link";
+
+export type DiscordComponentSelectType = "string" | "user" | "role" | "mentionable" | "channel";
+
+export type DiscordComponentModalFieldType =
+  | "text"
+  | "checkbox"
+  | "radio"
+  | "select"
+  | "role-select"
+  | "user-select";
+
+export type DiscordComponentButtonSpec = {
+  label: string;
+  style?: DiscordComponentButtonStyle;
+  url?: string;
+  callbackData?: string;
+  /** Internal use only: bypass dynamic component ids with a fixed custom id. */
+  internalCustomId?: string;
+  emoji?: {
+    name: string;
+    id?: string;
+    animated?: boolean;
+  };
+  disabled?: boolean;
+  /** Optional allowlist of users who can interact with this button (ids or names). */
+  allowedUsers?: string[];
+};
+
+export type DiscordComponentSelectOption = {
+  label: string;
+  value: string;
+  description?: string;
+  emoji?: {
+    name: string;
+    id?: string;
+    animated?: boolean;
+  };
+  default?: boolean;
+};
+
+export type DiscordComponentSelectSpec = {
+  type?: DiscordComponentSelectType;
+  callbackData?: string;
+  placeholder?: string;
+  minValues?: number;
+  maxValues?: number;
+  options?: DiscordComponentSelectOption[];
+  allowedUsers?: string[];
+};
+
+export type DiscordComponentSectionAccessory =
+  | {
+      type: "thumbnail";
+      url: string;
+    }
+  | {
+      type: "button";
+      button: DiscordComponentButtonSpec;
+    };
+
+type DiscordComponentSeparatorSpacing = "small" | "large" | 1 | 2;
+
+export type DiscordComponentBlock =
+  | {
+      type: "text";
+      text: string;
+    }
+  | {
+      type: "section";
+      text?: string;
+      texts?: string[];
+      accessory?: DiscordComponentSectionAccessory;
+    }
+  | {
+      type: "separator";
+      spacing?: DiscordComponentSeparatorSpacing;
+      divider?: boolean;
+    }
+  | {
+      type: "actions";
+      buttons?: DiscordComponentButtonSpec[];
+      select?: DiscordComponentSelectSpec;
+    }
+  | {
+      type: "media-gallery";
+      items: Array<{ url: string; description?: string; spoiler?: boolean }>;
+    }
+  | {
+      type: "file";
+      file: `attachment://${string}`;
+      spoiler?: boolean;
+    };
+
+export type DiscordModalFieldSpec = {
+  type: DiscordComponentModalFieldType;
+  name?: string;
+  label: string;
+  description?: string;
+  placeholder?: string;
+  required?: boolean;
+  options?: DiscordComponentSelectOption[];
+  minValues?: number;
+  maxValues?: number;
+  minLength?: number;
+  maxLength?: number;
+  style?: "short" | "paragraph";
+};
+
+export type DiscordModalSpec = {
+  title: string;
+  callbackData?: string;
+  triggerLabel?: string;
+  triggerStyle?: DiscordComponentButtonStyle;
+  allowedUsers?: string[];
+  fields: DiscordModalFieldSpec[];
+};
+
+export type DiscordComponentMessageSpec = {
+  text?: string;
+  reusable?: boolean;
+  container?: {
+    accentColor?: string | number;
+    spoiler?: boolean;
+  };
+  blocks?: DiscordComponentBlock[];
+  modal?: DiscordModalSpec;
+};
+
+export type DiscordComponentEntry = {
+  id: string;
+  kind: "button" | "select" | "modal-trigger";
+  label: string;
+  callbackData?: string;
+  selectType?: DiscordComponentSelectType;
+  options?: Array<{ value: string; label: string }>;
+  modalId?: string;
+  sessionKey?: string;
+  agentId?: string;
+  accountId?: string;
+  reusable?: boolean;
+  consumptionGroupId?: string;
+  consumptionGroupEntryIds?: string[];
+  allowedUsers?: string[];
+  messageId?: string;
+  createdAt?: number;
+  expiresAt?: number;
+};
+
+export type DiscordModalFieldDefinition = {
+  id: string;
+  name: string;
+  label: string;
+  type: DiscordComponentModalFieldType;
+  description?: string;
+  placeholder?: string;
+  required?: boolean;
+  options?: DiscordComponentSelectOption[];
+  minValues?: number;
+  maxValues?: number;
+  minLength?: number;
+  maxLength?: number;
+  style?: "short" | "paragraph";
+};
+
+export type DiscordModalEntry = {
+  id: string;
+  title: string;
+  callbackData?: string;
+  fields: DiscordModalFieldDefinition[];
+  sessionKey?: string;
+  agentId?: string;
+  accountId?: string;
+  reusable?: boolean;
+  messageId?: string;
+  createdAt?: number;
+  expiresAt?: number;
+  allowedUsers?: string[];
+};
+
+export type DiscordComponentBuildResult = {
+  components: TopLevelComponents[];
+  entries: DiscordComponentEntry[];
+  modals: DiscordModalEntry[];
+};