@helyx/module-moderation 1.0.1

package/dist/records.js

@@ -0,0 +1,303 @@
+const caseFields = {
+    case_id: { type: "string" },
+    guild_id: { type: "string" },
+    case_number: { type: "number" },
+    operation_key: { type: "string" },
+    subject_user_id: { type: "string", optional: true },
+    actor_user_id: { type: "string", optional: true },
+    source: { type: "string" },
+    source_module_id: { type: "string" },
+    source_event_id: { type: "string", optional: true },
+    action: { type: "string" },
+    reason: { type: "string" },
+    private_note: { type: "string", optional: true },
+    evidence_channel_id: { type: "string", optional: true },
+    evidence_message_id: { type: "string", optional: true },
+    related_case_id: { type: "string", optional: true },
+    requested_duration_seconds: { type: "number", optional: true },
+    delete_message_seconds: { type: "number", optional: true },
+    demote_role_ids: { type: "json" },
+    observed_action_type: { type: "string", optional: true },
+    observed_timeout_duration_seconds: { type: "number", optional: true },
+    repeat_rule_id: { type: "string", optional: true },
+    repeat_rule_revision: { type: "number", optional: true },
+    repeat_configuration_revision: { type: "string", optional: true },
+    repeat_policy_fingerprint: { type: "string", optional: true },
+    repeat_window_starts_at: { type: "date", optional: true },
+    repeat_offence_ordinal: { type: "number", optional: true },
+    repeat_offence_count: { type: "number", optional: true },
+    open_violation_thread: { type: "boolean" },
+    state: { type: "string" },
+    safe_outcome: { type: "string", optional: true },
+    revision: { type: "number" },
+    disassociated_at: { type: "date", optional: true },
+    settled_at: { type: "date", optional: true },
+    retention_expires_at: { type: "date", optional: true },
+    retention_processed_at: { type: "date", optional: true },
+    created_at: { type: "date" },
+    updated_at: { type: "date" },
+};
+const caseFieldNames = Object.keys(caseFields);
+export const moderationRecords = {
+    case_sequences: {
+        table: "moderation_case_sequences",
+        fields: {
+            guild_id: { type: "string" },
+            next_case_number: { type: "number" },
+            updated_at: { type: "date" },
+        },
+        uniqueKeys: [["guild_id"]],
+        readableFields: ["guild_id", "next_case_number", "updated_at"],
+        writableFields: ["guild_id", "next_case_number", "updated_at"],
+        incrementableFields: ["next_case_number"],
+    },
+    cases: {
+        table: "moderation_cases",
+        fields: caseFields,
+        uniqueKeys: [
+            ["case_id"],
+            ["guild_id", "case_id"],
+            ["guild_id", "case_number"],
+            ["guild_id", "source_module_id", "operation_key"],
+        ],
+        readableFields: caseFieldNames,
+        writableFields: caseFieldNames,
+        orderKeys: [["created_at", "case_id"]],
+        searchableFields: ["subject_user_id", "actor_user_id"],
+        groupableFields: ["source", "action", "state", "repeat_rule_id"],
+    },
+    case_operations: {
+        table: "moderation_case_operations",
+        fields: {
+            operation_id: { type: "string" },
+            guild_id: { type: "string" },
+            operation_key: { type: "string" },
+            case_id: { type: "string", optional: true },
+            operation_type: { type: "string" },
+            input_hash: { type: "string" },
+            outcome_code: { type: "string" },
+            outcome_revision: { type: "number", optional: true },
+            outcome_attempt_id: { type: "string", optional: true },
+            outcome_attempt_number: { type: "number", optional: true },
+            created_at: { type: "date" },
+        },
+        uniqueKeys: [["operation_id"], ["guild_id", "operation_key"]],
+        readableFields: [
+            "operation_id",
+            "guild_id",
+            "operation_key",
+            "case_id",
+            "operation_type",
+            "input_hash",
+            "outcome_code",
+            "outcome_revision",
+            "outcome_attempt_id",
+            "outcome_attempt_number",
+            "created_at",
+        ],
+        writableFields: [
+            "operation_id",
+            "guild_id",
+            "operation_key",
+            "case_id",
+            "operation_type",
+            "input_hash",
+            "outcome_code",
+            "outcome_revision",
+            "outcome_attempt_id",
+            "outcome_attempt_number",
+            "created_at",
+        ],
+        orderKeys: [["created_at", "operation_id"]],
+        groupableFields: ["operation_type", "outcome_code"],
+    },
+    action_attempts: {
+        table: "moderation_action_attempts",
+        fields: {
+            attempt_id: { type: "string" },
+            guild_id: { type: "string" },
+            case_id: { type: "string" },
+            operation_key: { type: "string" },
+            actor_user_id: { type: "string", optional: true },
+            attempt_number: { type: "number" },
+            action: { type: "string" },
+            reason: { type: "string" },
+            outcome: { type: "string" },
+            safe_code: { type: "string", optional: true },
+            removed_role_ids: { type: "json" },
+            requested_duration_seconds: { type: "number", optional: true },
+            requested_demote_role_ids: { type: "json", optional: true },
+            created_at: { type: "date" },
+            updated_at: { type: "date" },
+        },
+        uniqueKeys: [
+            ["attempt_id"],
+            ["attempt_id", "attempt_number"],
+            ["case_id", "attempt_number"],
+            ["case_id", "operation_key"],
+        ],
+        readableFields: [
+            "attempt_id",
+            "guild_id",
+            "case_id",
+            "operation_key",
+            "actor_user_id",
+            "attempt_number",
+            "action",
+            "reason",
+            "outcome",
+            "safe_code",
+            "removed_role_ids",
+            "requested_duration_seconds",
+            "requested_demote_role_ids",
+            "created_at",
+            "updated_at",
+        ],
+        writableFields: [
+            "attempt_id",
+            "guild_id",
+            "case_id",
+            "operation_key",
+            "actor_user_id",
+            "attempt_number",
+            "action",
+            "reason",
+            "outcome",
+            "safe_code",
+            "removed_role_ids",
+            "requested_duration_seconds",
+            "requested_demote_role_ids",
+            "created_at",
+            "updated_at",
+        ],
+        orderKeys: [["created_at", "attempt_id"]],
+        groupableFields: ["action", "outcome"],
+    },
+    dm_receipts: {
+        table: "moderation_dm_receipts",
+        fields: {
+            receipt_id: { type: "string" },
+            guild_id: { type: "string" },
+            case_id: { type: "string" },
+            template_revision: { type: "number" },
+            delivery_state: { type: "string" },
+            safe_code: { type: "string", optional: true },
+            message_id: { type: "string", optional: true },
+            attempted_at: { type: "date", optional: true },
+            created_at: { type: "date" },
+            updated_at: { type: "date" },
+        },
+        uniqueKeys: [["receipt_id"], ["guild_id", "case_id"]],
+        readableFields: [
+            "receipt_id",
+            "guild_id",
+            "case_id",
+            "template_revision",
+            "delivery_state",
+            "safe_code",
+            "message_id",
+            "attempted_at",
+            "created_at",
+            "updated_at",
+        ],
+        writableFields: [
+            "receipt_id",
+            "guild_id",
+            "case_id",
+            "template_revision",
+            "delivery_state",
+            "safe_code",
+            "message_id",
+            "attempted_at",
+            "created_at",
+            "updated_at",
+        ],
+        orderKeys: [["created_at", "receipt_id"]],
+        groupableFields: ["delivery_state"],
+    },
+    thread_deliveries: {
+        table: "moderation_thread_deliveries",
+        fields: {
+            delivery_id: { type: "string" },
+            guild_id: { type: "string" },
+            case_id: { type: "string" },
+            case_revision: { type: "number" },
+            operation_key: { type: "string" },
+            parent_channel_id: { type: "string", optional: true },
+            access_role_id: { type: "string", optional: true },
+            thread_id: { type: "string", optional: true },
+            control_token: { type: "string", optional: true },
+            control_message_id: { type: "string", optional: true },
+            member_state: { type: "string" },
+            evidence_state: { type: "string" },
+            opening_state: { type: "string" },
+            notification_state: { type: "string" },
+            close_state: { type: "string" },
+            resolution_state: { type: "string" },
+            attempt_count: { type: "number" },
+            fence_token: { type: "number" },
+            safe_code: { type: "string", optional: true },
+            retry_at: { type: "date", optional: true },
+            created_at: { type: "date" },
+            updated_at: { type: "date" },
+        },
+        uniqueKeys: [
+            ["delivery_id"],
+            ["guild_id", "case_id"],
+            ["guild_id", "operation_key"],
+            ["control_token"],
+        ],
+        readableFields: [
+            "delivery_id",
+            "guild_id",
+            "case_id",
+            "case_revision",
+            "operation_key",
+            "parent_channel_id",
+            "access_role_id",
+            "thread_id",
+            "control_token",
+            "control_message_id",
+            "member_state",
+            "evidence_state",
+            "opening_state",
+            "notification_state",
+            "close_state",
+            "resolution_state",
+            "attempt_count",
+            "fence_token",
+            "safe_code",
+            "retry_at",
+            "created_at",
+            "updated_at",
+        ],
+        writableFields: [
+            "delivery_id",
+            "guild_id",
+            "case_id",
+            "case_revision",
+            "operation_key",
+            "parent_channel_id",
+            "access_role_id",
+            "thread_id",
+            "control_token",
+            "control_message_id",
+            "member_state",
+            "evidence_state",
+            "opening_state",
+            "notification_state",
+            "close_state",
+            "resolution_state",
+            "attempt_count",
+            "fence_token",
+            "safe_code",
+            "retry_at",
+            "created_at",
+            "updated_at",
+        ],
+        orderKeys: [["updated_at", "delivery_id"]],
+        searchableFields: ["thread_id", "control_token"],
+        groupableFields: ["resolution_state", "close_state"],
+    },
+};
+//# sourceMappingURL=records.js.map

package/dist/repository-model.d.ts

@@ -0,0 +1,131 @@
+import type { ModuleRecordValue, ModuleRecordWriteValue } from "@helyx/sdk";
+import type { ModerationAttemptOutcome, ModerationCaseAction, ModerationCaseSource, ModerationCaseState, ModerationDeliveryState } from "./contracts.js";
+export interface StoredModerationCase {
+    caseId: string;
+    guildId: string;
+    caseNumber: number;
+    operationKey: string;
+    subjectUserId: string | null;
+    actorUserId: string | null;
+    source: ModerationCaseSource;
+    sourceModuleId: string;
+    sourceEventId: string | null;
+    action: ModerationCaseAction;
+    reason: string;
+    privateNote: string | null;
+    evidenceChannelId: string | null;
+    evidenceMessageId: string | null;
+    relatedCaseId: string | null;
+    requestedDurationSeconds: number | null;
+    deleteMessageSeconds: number | null;
+    demoteRoleIds: readonly string[];
+    observedActionType: string | null;
+    observedTimeoutDurationSeconds: number | null;
+    repeatRuleId: string | null;
+    repeatRuleRevision: number | null;
+    repeatConfigurationRevision: string | null;
+    repeatPolicyFingerprint: string | null;
+    repeatWindowStartsAt: Date | null;
+    repeatOffenceOrdinal: 1 | 2 | 3 | null;
+    repeatOffenceCount: number | null;
+    openViolationThread: boolean;
+    state: ModerationCaseState;
+    safeOutcome: string | null;
+    revision: number;
+    disassociatedAt: Date | null;
+    settledAt: Date | null;
+    retentionExpiresAt: Date | null;
+    retentionProcessedAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StoredModerationAttempt {
+    attemptId: string;
+    guildId: string;
+    caseId: string;
+    operationKey: string;
+    actorUserId: string | null;
+    attemptNumber: number;
+    action: ModerationCaseAction;
+    reason: string;
+    outcome: ModerationAttemptOutcome;
+    safeCode: string | null;
+    removedRoleIds: readonly string[];
+    requestedDurationSeconds?: number | null;
+    demoteRoleIds?: readonly string[];
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StoredModerationDmReceipt {
+    receiptId: string;
+    guildId: string;
+    caseId: string;
+    templateRevision: number;
+    deliveryState: ModerationDeliveryState;
+    safeCode: string | null;
+    messageId: string | null;
+    attemptedAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StoredModerationThreadDelivery {
+    deliveryId: string;
+    guildId: string;
+    caseId: string;
+    caseRevision: number;
+    operationKey: string;
+    parentChannelId: string | null;
+    accessRoleId: string | null;
+    threadId: string | null;
+    controlToken: string | null;
+    controlMessageId: string | null;
+    memberState: ModerationDeliveryState;
+    evidenceState: ModerationDeliveryState;
+    openingState: ModerationDeliveryState;
+    notificationState: ModerationDeliveryState;
+    closeState: ModerationDeliveryState;
+    resolutionState: "awaiting_staff" | "resolved" | "closed";
+    attemptCount: number;
+    fenceToken: number;
+    safeCode: string | null;
+    retryAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export declare const CASE_FIELDS: readonly ["case_id", "guild_id", "case_number", "operation_key", "subject_user_id", "actor_user_id", "source", "source_module_id", "source_event_id", "action", "reason", "private_note", "evidence_channel_id", "evidence_message_id", "related_case_id", "requested_duration_seconds", "delete_message_seconds", "demote_role_ids", "observed_action_type", "observed_timeout_duration_seconds", "repeat_rule_id", "repeat_rule_revision", "repeat_configuration_revision", "repeat_policy_fingerprint", "repeat_window_starts_at", "repeat_offence_ordinal", "repeat_offence_count", "open_violation_thread", "state", "safe_outcome", "revision", "disassociated_at", "settled_at", "retention_expires_at", "retention_processed_at", "created_at", "updated_at"];
+export declare const ATTEMPT_FIELDS: readonly ["attempt_id", "guild_id", "case_id", "operation_key", "actor_user_id", "attempt_number", "action", "reason", "outcome", "safe_code", "removed_role_ids", "requested_duration_seconds", "requested_demote_role_ids", "created_at", "updated_at"];
+export declare const DM_RECEIPT_FIELDS: readonly ["receipt_id", "guild_id", "case_id", "template_revision", "delivery_state", "safe_code", "message_id", "attempted_at", "created_at", "updated_at"];
+export declare const THREAD_FIELDS: readonly ["delivery_id", "guild_id", "case_id", "case_revision", "operation_key", "parent_channel_id", "access_role_id", "thread_id", "control_token", "control_message_id", "member_state", "evidence_state", "opening_state", "notification_state", "close_state", "resolution_state", "attempt_count", "fence_token", "safe_code", "retry_at", "created_at", "updated_at"];
+export declare function mapCase(row: Readonly<Record<string, ModuleRecordValue>>): StoredModerationCase;
+export declare function mapAttempt(row: Readonly<Record<string, ModuleRecordValue>>): StoredModerationAttempt;
+export declare function mapDmReceipt(row: Readonly<Record<string, ModuleRecordValue>>): StoredModerationDmReceipt;
+export declare function mapThreadDelivery(row: Readonly<Record<string, ModuleRecordValue>>): StoredModerationThreadDelivery;
+export declare function dmReceiptWrite(input: StoredModerationDmReceipt): {
+    values: Record<string, ModuleRecordWriteValue>;
+    clear: string[];
+};
+export declare function threadDeliveryWrite(input: StoredModerationThreadDelivery): {
+    values: Record<string, ModuleRecordWriteValue>;
+    clear: string[];
+};
+export declare const THREAD_PROPERTY_FIELDS: {
+    readonly caseRevision: "case_revision";
+    readonly operationKey: "operation_key";
+    readonly parentChannelId: "parent_channel_id";
+    readonly accessRoleId: "access_role_id";
+    readonly threadId: "thread_id";
+    readonly controlToken: "control_token";
+    readonly controlMessageId: "control_message_id";
+    readonly memberState: "member_state";
+    readonly evidenceState: "evidence_state";
+    readonly openingState: "opening_state";
+    readonly notificationState: "notification_state";
+    readonly closeState: "close_state";
+    readonly resolutionState: "resolution_state";
+    readonly attemptCount: "attempt_count";
+    readonly fenceToken: "fence_token";
+    readonly safeCode: "safe_code";
+    readonly retryAt: "retry_at";
+    readonly updatedAt: "updated_at";
+};
+//# sourceMappingURL=repository-model.d.ts.map