@helyx/module-reactionroles 1.0.11 → 1.0.14

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @helyx/module-reactionroles
 
+## 1.0.14
+
+### Patch Changes
+
+- Remove the Reaction Roles command root now that the dashboard Panels workspace owns panel creation and management.
+
+## 1.0.13
+
+### Patch Changes
+
+- Consolidate the module database migration history into a clean one-file baseline for the planned database rebuild.
+
+## 1.0.12
+
+### Patch Changes
+
+- Updated dependencies [26b4c3e]
+  - @helyx/module-manifest@0.7.0
+  - @helyx/sdk@0.8.0
+
 ## 1.0.11
 
 ### Patch Changes

package/dist/index.js

@@ -90,98 +90,6 @@ export const reactionRolesModule = defineModule({
     },
     records: reactionRoleRecords,
     interactions: {
-        commands: [
-            {
-                name: "reaction-role",
-                description: "Create and manage Helyx role panels.",
-                registration: "global",
-                contexts: ["guild"],
-                integrationTypes: ["guild_install"],
-                subcommands: [
-                    {
-                        name: "create",
-                        description: "Open the guided Reaction Roles builder.",
-                        permissionId: "reactionroles.create",
-                        options: [
-                            {
-                                type: "channel",
-                                name: "channel",
-                                description: "Prefill the destination channel.",
-                                channelTypes: ["guild_text", "guild_announcement"],
-                            },
-                            {
-                                type: "string",
-                                name: "style",
-                                description: "Prefill the public message style.",
-                                choices: [
-                                    { name: "Text", value: "text" },
-                                    { name: "Embed", value: "embed" },
-                                ],
-                            },
-                            {
-                                type: "string",
-                                name: "control",
-                                description: "Prefill how members choose roles.",
-                                choices: [
-                                    { name: "Buttons", value: "buttons" },
-                                    { name: "Dropdown", value: "dropdown" },
-                                    { name: "Emoji reactions", value: "reactions" },
-                                ],
-                            },
-                            {
-                                type: "boolean",
-                                name: "one-role-only",
-                                description: "Allow each member to hold only one role from this panel.",
-                            },
-                            {
-                                type: "boolean",
-                                name: "persistent-reactions",
-                                description: "Keep member reactions visible and synchronised with roles.",
-                            },
-                        ],
-                        rateLimit: { scope: "user", limit: 5, windowSeconds: 60 },
-                        execute: startCreate,
-                    },
-                    {
-                        name: "edit",
-                        description: "Edit an existing role panel.",
-                        permissionId: "reactionroles.manage",
-                        options: [
-                            referenceOption(),
-                            {
-                                type: "boolean",
-                                name: "persistent-reactions",
-                                description: "Keep member reactions visible and synchronised with roles.",
-                            },
-                        ],
-                        autocomplete: autocompletePanelReference,
-                        execute: startEdit,
-                    },
-                    {
-                        name: "list",
-                        description: "List the active and degraded role panels.",
-                        permissionId: "reactionroles.manage",
-                        execute: listPanels,
-                    },
-                    {
-                        name: "repair",
-                        description: "Revalidate and repair a role panel.",
-                        permissionId: "reactionroles.manage",
-                        options: [referenceOption()],
-                        autocomplete: autocompletePanelReference,
-                        execute: repairPanel,
-                    },
-                    {
-                        name: "delete",
-                        description: "Delete a role panel without changing member roles.",
-                        permissionId: "reactionroles.delete",
-                        options: [referenceOption()],
-                        autocomplete: autocompletePanelReference,
-                        execute: prepareDelete,
-                    },
-                ],
-            },
-        ],
         buttons: [
             {
                 customId: COMPONENT_IDS.continueDraft,
@@ -427,43 +335,6 @@ export const reactionRolesModule = defineModule({
     },
     health: () => ({ status: healthStatus, message: healthMessage }),
 });
-async function startCreate(context) {
-    const guildId = requireGuild(context);
-    const channel = context.getChannelOption("channel");
-    const style = context.getStringOption("style");
-    const control = context.getStringOption("control");
-    const sessions = sessionService(context.services);
-    const nextState = {
-        mode: "create",
-        selectionMode: context.getBooleanOption("one-role-only") === true
-            ? "one_only"
-            : "multiple",
-        persistentReactions: context.getBooleanOption("persistent-reactions") !== false,
-        ...(channel ? { channelId: channel.id } : {}),
-        ...(style ? { messageStyle: requiredStyle([style]) } : {}),
-        ...(control ? { controlType: requiredControl([control]) } : {}),
-    };
-    const existing = await sessions.getFor(guildId, context.userId, PANEL_PURPOSE);
-    if (existing) {
-        await sessions.update({
-            sessionId: existing.sessionId,
-            state: { ...existing.state, pendingReplacement: nextState },
-            expectedVersion: existing.version,
-            expiresAt: expiresAt(),
-        });
-        await context.reply(existingDraftResponse());
-        return;
-    }
-    await sessions.create({
-        guildId,
-        userId: context.userId,
-        purpose: PANEL_PURPOSE,
-        state: nextState,
-        expiresAt: expiresAt(),
-        replace: true,
-    });
-    await context.showModal(basicModal(defaultsFromSessionState(nextState)));
-}
 async function continueDraft(context) {
     const guildId = requireGuild(context);
     const session = await sessionService(context.services).getFor(guildId, context.userId, PANEL_PURPOSE);
@@ -520,108 +391,6 @@ async function keepDraft(context) {
         },
     });
 }
-async function startEdit(context) {
-    const guildId = requireGuild(context);
-    const panel = await findPanelReference(context.services, guildId, context.getStringOption("reference"));
-    const persistentReactions = context.getBooleanOption("persistent-reactions");
-    const draft = persistentReactions === null
-        ? panel
-        : validatePanelDraft({ ...panel, persistentReactions });
-    await sessionService(context.services).create({
-        guildId,
-        userId: context.userId,
-        purpose: PANEL_PURPOSE,
-        state: {
-            mode: "edit",
-            panelId: panel.panelId,
-            expectedRevision: panel.revision,
-            draft: serializeDraft(draft),
-        },
-        expiresAt: expiresAt(),
-        replace: true,
-    });
-    await context.showModal(basicModal(draft, true));
-}
-async function listPanels(context) {
-    const guildId = requireGuild(context);
-    const result = await panels.repository(context.services).list({
-        guildId,
-        limit: 10,
-    });
-    await context.reply({
-        ephemeral: true,
-        componentsV2: {
-            text: [
-                {
-                    content: result.panels.length === 0
-                        ? "No Reaction Roles panels have been created."
-                        : result.panels
-                            .map((panel) => `**${panel.title}** · \`${panel.panelId}\` · ${panel.status} · revision ${panel.revision}`)
-                            .join("\n"),
-                },
-            ],
-        },
-        allowedUserMentionIds: [],
-    });
-}
-async function repairPanel(context) {
-    const guildId = requireGuild(context);
-    await context.deferReply?.(true);
-    const panel = await findPanelReference(context.services, guildId, context.getStringOption("reference"));
-    const repaired = await panels.repair(interactionMutationContext(context, guildId), panel.panelId, panel.revision, false);
-    await context.reply({
-        ephemeral: true,
-        componentsV2: {
-            text: [
-                {
-                    content: `Role panel **${repaired.title}** is active at revision ${repaired.revision}.`,
-                },
-            ],
-        },
-        allowedUserMentionIds: [],
-    });
-}
-async function prepareDelete(context) {
-    const guildId = requireGuild(context);
-    const panel = await findPanelReference(context.services, guildId, context.getStringOption("reference"));
-    await sessionService(context.services).create({
-        guildId,
-        userId: context.userId,
-        purpose: PANEL_PURPOSE,
-        state: {
-            mode: "delete",
-            panelId: panel.panelId,
-            expectedRevision: panel.revision,
-        },
-        expiresAt: expiresAt(),
-        replace: true,
-    });
-    await context.reply({
-        ephemeral: true,
-        componentsV2: {
-            text: [
-                {
-                    content: `Delete **${panel.title}**? Helyx will try to remove its panel message. Existing member roles will not change.`,
-                },
-            ],
-        },
-        buttons: [
-            {
-                type: "button",
-                customId: COMPONENT_IDS.deleteConfirm,
-                label: "Delete role panel",
-                style: "danger",
-            },
-            {
-                type: "button",
-                customId: COMPONENT_IDS.cancel,
-                label: "Keep role panel",
-                style: "secondary",
-            },
-        ],
-        allowedUserMentionIds: [],
-    });
-}
 async function saveBasicDraft(context) {
     const guildId = requireGuild(context);
     const sessions = sessionService(context.services);
@@ -1199,39 +968,6 @@ function basicModal(panel, editing = false) {
         ],
     };
 }
-function existingDraftResponse() {
-    return {
-        ephemeral: true,
-        componentsV2: {
-            text: [
-                {
-                    content: "You already have a Reaction Roles draft. Continue it or replace it with a new draft.",
-                },
-            ],
-        },
-        buttons: [
-            {
-                type: "button",
-                customId: COMPONENT_IDS.continueDraft,
-                label: "Continue draft",
-                style: "primary",
-            },
-            {
-                type: "button",
-                customId: COMPONENT_IDS.replaceDraft,
-                label: "Replace draft",
-                style: "danger",
-            },
-            {
-                type: "button",
-                customId: COMPONENT_IDS.keepDraft,
-                label: "Cancel",
-                style: "secondary",
-            },
-        ],
-        allowedUserMentionIds: [],
-    };
-}
 function defaultsFromSessionState(state) {
     return {
         ...(typeof state.channelId === "string"
@@ -1397,62 +1133,6 @@ function interactionMutationContext(context, guildId) {
         addChannelMessageReaction: (channelId, messageId, emojiIdentifier) => context.addChannelMessageReaction(channelId, messageId, emojiIdentifier),
     };
 }
-async function findPanelReference(services, guildId, value) {
-    const reference = value?.trim();
-    if (!reference)
-        throw new Error("Role panel reference is required");
-    const panel = await panels.repository(services).findById(guildId, reference);
-    if (!panel)
-        throw new Error("Role panel was not found");
-    return panel;
-}
-async function autocompletePanelReference(context) {
-    if (!context.serverId || context.focusedOptionName !== "reference") {
-        await context.respond([]);
-        return;
-    }
-    const query = context.focusedValue.trim().normalize("NFKC").toLowerCase();
-    const repository = panels.repository(context.services);
-    const choices = [];
-    let cursor;
-    for (let pageNumber = 0; pageNumber < 5 && choices.length < 25; pageNumber += 1) {
-        const page = await repository.listReferences({
-            guildId: context.serverId,
-            ...(cursor ? { cursor } : {}),
-            limit: query ? 100 : 25,
-        });
-        for (const panel of page.panels) {
-            if (panel.status === "deleting")
-                continue;
-            const searchable = `${panel.title} ${panel.panelId} ${panel.status}`.toLowerCase();
-            if (query && !searchable.includes(query))
-                continue;
-            const title = panel.title.replaceAll(/\s+/gu, " ").trim();
-            const suffix = `${panel.status} · ${panel.panelId.slice(0, 8)}`;
-            choices.push({
-                name: `${title.slice(0, Math.max(1, 97 - suffix.length))} · ${suffix}`,
-                value: panel.panelId,
-            });
-            if (choices.length === 25)
-                break;
-        }
-        if (!query || !page.nextCursor)
-            break;
-        cursor = page.nextCursor;
-    }
-    await context.respond(choices);
-}
-function referenceOption() {
-    return {
-        type: "string",
-        name: "reference",
-        description: "Panel reference shown by /reaction-role list.",
-        required: true,
-        minLength: 1,
-        maxLength: 100,
-        autocomplete: true,
-    };
-}
 function sessionService(services) {
     return services.get(HELYX_SERVICE_NAMES.sessions);
 }

package/manifest.json

@@ -3,7 +3,7 @@
   "releaseStatus": "live",
   "id": "helyx.reactionroles",
   "name": "Reaction Roles",
-  "version": "1.0.11",
+  "version": "1.0.14",
   "description": "Let members select approved roles themselves.",
   "entry": "./dist/index.js",
   "framework": "^0.1.0",
@@ -283,10 +283,31 @@
           }
         ]
       }
-    ]
+    ],
+    "workspace": {
+      "type": "managed_resources_v1",
+      "settings": [
+        {
+          "resources": ["panels"],
+          "mode": "create-only"
+        }
+      ],
+      "tabs": [
+        {
+          "id": "panels",
+          "label": "Panels",
+          "panels": [
+            {
+              "resources": ["panels"],
+              "mode": "list-only"
+            }
+          ]
+        }
+      ]
+    }
   },
   "contributions": {
-    "commands": ["reaction-role"],
+    "commands": [],
     "events": [
       "discord.channel-delete",
       "discord.channel-update",

package/migrations/0001_reactionroles_foundation.sql

@@ -1,3 +1,5 @@
+-- Baseline source: 0001_reactionroles_foundation.sql
+
 CREATE TABLE IF NOT EXISTS reactionroles_panels (
   panel_id text PRIMARY KEY,
   guild_id text NOT NULL,
@@ -106,3 +108,61 @@ CREATE UNIQUE INDEX IF NOT EXISTS reactionroles_cleanup_message_reason_idx
     message_id,
     reason
   );
+
+-- Baseline source: 0002_cleanup_retry_order.sql
+
+UPDATE reactionroles_message_cleanup
+SET next_attempt_at = created_at
+WHERE next_attempt_at IS NULL;
+
+ALTER TABLE reactionroles_message_cleanup
+  ALTER COLUMN next_attempt_at SET NOT NULL;
+
+-- Baseline source: 0003_persistent_reactions.sql
+
+ALTER TABLE reactionroles_panels
+  ADD COLUMN IF NOT EXISTS persistent_reactions boolean NOT NULL DEFAULT true;
+
+DO $$
+DECLARE
+  constraint_name text;
+BEGIN
+  FOR constraint_name IN
+    SELECT conname
+    FROM pg_constraint
+    WHERE conrelid = 'reactionroles_panels'::regclass
+      AND contype = 'c'
+      AND conname <> 'reactionroles_panels_reaction_selection_check'
+      AND pg_get_constraintdef(oid) LIKE '%control_type%reactions%selection_mode%'
+  LOOP
+    EXECUTE format(
+      'ALTER TABLE reactionroles_panels DROP CONSTRAINT %I',
+      constraint_name
+    );
+  END LOOP;
+
+  IF NOT EXISTS (
+    SELECT 1
+    FROM pg_constraint
+    WHERE conrelid = 'reactionroles_panels'::regclass
+      AND conname = 'reactionroles_panels_reaction_selection_check'
+  ) THEN
+    ALTER TABLE reactionroles_panels
+      ADD CONSTRAINT reactionroles_panels_reaction_selection_check
+      CHECK (
+        control_type <> 'reactions'
+        OR selection_mode <> 'one_only'
+        OR persistent_reactions = false
+      );
+  END IF;
+END
+$$;
+
+-- Baseline source: 0004_entry_lookup_indexes.sql
+
+CREATE INDEX IF NOT EXISTS reactionroles_entries_role_panel_idx
+  ON reactionroles_entries (role_id, panel_id);
+
+CREATE INDEX IF NOT EXISTS reactionroles_entries_emoji_panel_idx
+  ON reactionroles_entries (emoji_id, panel_id)
+  WHERE emoji_id IS NOT NULL;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helyx/module-reactionroles",
-  "version": "1.0.11",
+  "version": "1.0.14",
   "description": "Configurable self-service Discord role panels for Helyx.",
   "keywords": [
     "helyx",
@@ -49,7 +49,7 @@
     "build": "tsc -b"
   },
   "dependencies": {
-    "@helyx/module-manifest": ">=0.6.0 <0.7.0",
-    "@helyx/sdk": ">=0.7.0 <0.8.0"
+    "@helyx/module-manifest": ">=0.7.0 <0.8.0",
+    "@helyx/sdk": ">=0.8.4 <0.9.0"
   }
 }

package/migrations/0002_cleanup_retry_order.sql

@@ -1,6 +0,0 @@
-UPDATE reactionroles_message_cleanup
-SET next_attempt_at = created_at
-WHERE next_attempt_at IS NULL;
-
-ALTER TABLE reactionroles_message_cleanup
-  ALTER COLUMN next_attempt_at SET NOT NULL;

package/migrations/0003_persistent_reactions.sql

@@ -1,37 +0,0 @@
-ALTER TABLE reactionroles_panels
-  ADD COLUMN IF NOT EXISTS persistent_reactions boolean NOT NULL DEFAULT true;
-
-DO $$
-DECLARE
-  constraint_name text;
-BEGIN
-  FOR constraint_name IN
-    SELECT conname
-    FROM pg_constraint
-    WHERE conrelid = 'reactionroles_panels'::regclass
-      AND contype = 'c'
-      AND conname <> 'reactionroles_panels_reaction_selection_check'
-      AND pg_get_constraintdef(oid) LIKE '%control_type%reactions%selection_mode%'
-  LOOP
-    EXECUTE format(
-      'ALTER TABLE reactionroles_panels DROP CONSTRAINT %I',
-      constraint_name
-    );
-  END LOOP;
-
-  IF NOT EXISTS (
-    SELECT 1
-    FROM pg_constraint
-    WHERE conrelid = 'reactionroles_panels'::regclass
-      AND conname = 'reactionroles_panels_reaction_selection_check'
-  ) THEN
-    ALTER TABLE reactionroles_panels
-      ADD CONSTRAINT reactionroles_panels_reaction_selection_check
-      CHECK (
-        control_type <> 'reactions'
-        OR selection_mode <> 'one_only'
-        OR persistent_reactions = false
-      );
-  END IF;
-END
-$$;

package/migrations/0004_entry_lookup_indexes.sql

@@ -1,6 +0,0 @@
-CREATE INDEX IF NOT EXISTS reactionroles_entries_role_panel_idx
-  ON reactionroles_entries (role_id, panel_id);
-
-CREATE INDEX IF NOT EXISTS reactionroles_entries_emoji_panel_idx
-  ON reactionroles_entries (emoji_id, panel_id)
-  WHERE emoji_id IS NOT NULL;