@helyx/module-reactionroles 1.0.1

package/dist/records.d.ts

@@ -0,0 +1,288 @@
+import type { ModuleRecordService, ModuleRecordWriteValue } from "@helyx/sdk";
+import type { CanonicalEmoji, PanelButtonStyle, PanelControlType, PanelDraft, PanelMessageStyle, PanelSelectionMode } from "./builder.js";
+export declare const reactionRoleRecords: {
+    readonly panels: {
+        readonly table: "reactionroles_panels";
+        readonly fields: {
+            readonly panel_id: {
+                readonly type: "string";
+            };
+            readonly guild_id: {
+                readonly type: "string";
+            };
+            readonly channel_id: {
+                readonly type: "string";
+            };
+            readonly message_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly title: {
+                readonly type: "string";
+            };
+            readonly message_body: {
+                readonly type: "string";
+            };
+            readonly message_style: {
+                readonly type: "string";
+            };
+            readonly control_type: {
+                readonly type: "string";
+            };
+            readonly selection_mode: {
+                readonly type: "string";
+            };
+            readonly persistent_reactions: {
+                readonly type: "boolean";
+            };
+            readonly embed_colour: {
+                readonly type: "number";
+                readonly optional: true;
+            };
+            readonly dropdown_placeholder: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly status: {
+                readonly type: "string";
+            };
+            readonly revision: {
+                readonly type: "number";
+            };
+            readonly created_by_user_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly updated_by_user_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+            };
+            readonly updated_at: {
+                readonly type: "date";
+            };
+        };
+        readonly uniqueKeys: readonly [readonly ["panel_id"], readonly ["guild_id", "message_id"]];
+        readonly readableFields: readonly ["panel_id", "guild_id", "channel_id", "message_id", "title", "message_body", "message_style", "control_type", "selection_mode", "persistent_reactions", "embed_colour", "dropdown_placeholder", "status", "revision", "created_by_user_id", "updated_by_user_id", "created_at", "updated_at"];
+        readonly writableFields: readonly ["channel_id", "message_id", "title", "message_body", "message_style", "control_type", "selection_mode", "persistent_reactions", "embed_colour", "dropdown_placeholder", "status", "revision", "updated_by_user_id", "updated_at"];
+        readonly orderKeys: readonly [readonly ["updated_at", "panel_id"]];
+        readonly groupableFields: readonly ["status"];
+    };
+    readonly entries: {
+        readonly table: "reactionroles_entries";
+        readonly fields: {
+            readonly entry_id: {
+                readonly type: "string";
+            };
+            readonly panel_id: {
+                readonly type: "string";
+            };
+            readonly position: {
+                readonly type: "number";
+            };
+            readonly role_id: {
+                readonly type: "string";
+            };
+            readonly nameplate: {
+                readonly type: "string";
+            };
+            readonly emoji_kind: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly emoji_name: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly emoji_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly emoji_animated: {
+                readonly type: "boolean";
+                readonly optional: true;
+            };
+            readonly button_style: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+            };
+            readonly updated_at: {
+                readonly type: "date";
+            };
+        };
+        readonly uniqueKeys: readonly [readonly ["entry_id"], readonly ["panel_id", "position"], readonly ["panel_id", "role_id"]];
+        readonly readableFields: readonly ["entry_id", "panel_id", "position", "role_id", "nameplate", "emoji_kind", "emoji_name", "emoji_id", "emoji_animated", "button_style", "created_at", "updated_at"];
+        readonly orderKeys: readonly [readonly ["position", "entry_id"]];
+    };
+    readonly message_cleanup: {
+        readonly table: "reactionroles_message_cleanup";
+        readonly fields: {
+            readonly cleanup_id: {
+                readonly type: "string";
+            };
+            readonly guild_id: {
+                readonly type: "string";
+            };
+            readonly panel_id: {
+                readonly type: "string";
+            };
+            readonly channel_id: {
+                readonly type: "string";
+            };
+            readonly message_id: {
+                readonly type: "string";
+            };
+            readonly reason: {
+                readonly type: "string";
+            };
+            readonly attempts: {
+                readonly type: "number";
+            };
+            readonly next_attempt_at: {
+                readonly type: "date";
+            };
+            readonly created_at: {
+                readonly type: "date";
+            };
+            readonly completed_at: {
+                readonly type: "date";
+                readonly optional: true;
+            };
+        };
+        readonly uniqueKeys: readonly [readonly ["cleanup_id"], readonly ["guild_id", "channel_id", "message_id", "reason"]];
+        readonly readableFields: readonly ["cleanup_id", "guild_id", "panel_id", "channel_id", "message_id", "reason", "attempts", "next_attempt_at", "created_at", "completed_at"];
+        readonly writableFields: readonly ["attempts", "next_attempt_at", "completed_at"];
+        readonly orderKeys: readonly [readonly ["next_attempt_at", "cleanup_id"]];
+    };
+};
+export type PanelStatus = "pending" | "active" | "disabled" | "message_missing" | "needs_attention" | "cleanup_pending" | "deleting";
+export interface StoredPanel extends PanelDraft {
+    panelId: string;
+    guildId: string;
+    messageId: string | null;
+    status: PanelStatus;
+    revision: number;
+    createdByUserId: string | null;
+    updatedByUserId: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StoredPanelEntry {
+    entryId: string;
+    panelId: string;
+    position: number;
+    roleId: string;
+    nameplate: string;
+    emoji: CanonicalEmoji | null;
+    buttonStyle: PanelButtonStyle | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface PendingMessageCleanup {
+    cleanupId: string;
+    guildId: string;
+    panelId: string;
+    channelId: string;
+    messageId: string;
+    reason: "replacement" | "rollback" | "delete";
+    attempts: number;
+    nextAttemptAt: Date;
+}
+export interface PanelReference {
+    panelId: string;
+    title: string;
+    status: PanelStatus;
+    updatedAt: Date;
+}
+export declare class ReactionRolePanelRepository {
+    #private;
+    private readonly records;
+    constructor(records: ModuleRecordService);
+    create(input: {
+        panelId: string;
+        guildId: string;
+        actorUserId: string;
+        draft: PanelDraft;
+        messageId?: string;
+        entries: readonly {
+            entryId: string;
+            roleId: string;
+            nameplate: string;
+            emoji: CanonicalEmoji | null;
+            buttonStyle: PanelButtonStyle | null;
+        }[];
+        now?: Date;
+    }): Promise<boolean>;
+    update(input: {
+        panel: StoredPanel;
+        actorUserId: string;
+        draft: PanelDraft;
+        messageId?: string | null;
+        status?: PanelStatus;
+        entries: readonly {
+            entryId: string;
+            roleId: string;
+            nameplate: string;
+            emoji: CanonicalEmoji | null;
+            buttonStyle: PanelButtonStyle | null;
+        }[];
+        now?: Date;
+    }): Promise<boolean>;
+    findById(guildId: string, panelId: string): Promise<StoredPanel | null>;
+    findByMessage(guildId: string, messageId: string): Promise<StoredPanel | null>;
+    list(input: {
+        guildId: string;
+        cursor?: readonly ModuleRecordWriteValue[];
+        limit: number;
+    }): Promise<{
+        panels: readonly StoredPanel[];
+        nextCursor: readonly ModuleRecordWriteValue[] | null;
+    }>;
+    listReferences(input: {
+        guildId: string;
+        cursor?: readonly ModuleRecordWriteValue[];
+        limit: number;
+    }): Promise<{
+        panels: readonly PanelReference[];
+        nextCursor: readonly ModuleRecordWriteValue[] | null;
+    }>;
+    listByChannel(guildId: string, channelId: string, limit?: number): Promise<readonly StoredPanel[]>;
+    listByRole(guildId: string, roleId: string, limit?: number): Promise<readonly StoredPanel[]>;
+    listByEmoji(guildId: string, emojiId: string, limit?: number): Promise<readonly StoredPanel[]>;
+    listInteractive(input: {
+        status: "active" | "cleanup_pending";
+        cursor?: readonly ModuleRecordWriteValue[];
+        limit: number;
+    }): Promise<{
+        panels: readonly StoredPanel[];
+        nextCursor: readonly ModuleRecordWriteValue[] | null;
+    }>;
+    markStatus(input: {
+        panelId: string;
+        expectedRevision: number;
+        status: PanelStatus;
+        actorUserId?: string;
+        now?: Date;
+    }): Promise<boolean>;
+    remove(panelId: string, expectedRevision: number, actorUserId: string): Promise<boolean>;
+    claimDeleting(panelId: string, expectedRevision: number, actorUserId: string): Promise<boolean>;
+    deleteClaimed(panelId: string): Promise<boolean>;
+    recordCleanup(input: {
+        guildId: string;
+        panelId: string;
+        channelId: string;
+        messageId: string;
+        reason: "replacement" | "rollback" | "delete";
+        now?: Date;
+    }): Promise<boolean>;
+    listPendingCleanup(limit?: number): Promise<readonly PendingMessageCleanup[]>;
+    claimCleanup(cleanup: PendingMessageCleanup, now?: Date): Promise<PendingMessageCleanup | null>;
+    completeCleanup(cleanup: PendingMessageCleanup, now?: Date): Promise<boolean>;
+    pendingCleanupCount(panelId: string): Promise<number>;
+}
+export type { PanelControlType, PanelMessageStyle, PanelSelectionMode };