@helyx/module-automod 1.0.1

package/dist/records.d.ts

@@ -0,0 +1,299 @@
+export declare const automodRecords: {
+    readonly rules: {
+        readonly table: "automod_rules";
+        readonly fields: {
+            readonly rule_id: {
+                readonly type: "string";
+            };
+            readonly guild_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly name_key: {
+                readonly type: "string";
+            };
+            readonly category: {
+                readonly type: "string";
+            };
+            readonly rule_kind: {
+                readonly type: "string";
+            };
+            readonly status: {
+                readonly type: "string";
+            };
+            readonly document_json: {
+                readonly type: "json";
+            };
+            readonly native_rule_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly native_fingerprint: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly operation_key: {
+                readonly type: "string";
+            };
+            readonly configuration_revision: {
+                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 ownedSetLimit: 100;
+        readonly uniqueKeys: readonly [readonly ["rule_id"], readonly ["guild_id", "rule_id"], readonly ["guild_id", "name_key"], readonly ["guild_id", "native_rule_id"]];
+        readonly readableFields: readonly ["rule_id", "guild_id", "name", "name_key", "category", "rule_kind", "status", "document_json", "native_rule_id", "native_fingerprint", "operation_key", "configuration_revision", "revision", "created_by_user_id", "updated_by_user_id", "created_at", "updated_at"];
+        readonly writableFields: readonly ["rule_id", "guild_id", "name", "name_key", "category", "rule_kind", "status", "document_json", "native_rule_id", "native_fingerprint", "operation_key", "configuration_revision", "revision", "created_by_user_id", "updated_by_user_id", "created_at", "updated_at"];
+        readonly orderKeys: readonly [readonly ["updated_at", "rule_id"], readonly ["name_key", "rule_id"]];
+        readonly groupableFields: readonly ["guild_id", "status", "category", "rule_kind"];
+        readonly searchableFields: readonly ["name", "name_key"];
+    };
+    readonly action_receipts: {
+        readonly table: "automod_action_receipts";
+        readonly fields: {
+            readonly receipt_id: {
+                readonly type: "string";
+            };
+            readonly guild_id: {
+                readonly type: "string";
+            };
+            readonly event_key: {
+                readonly type: "string";
+            };
+            readonly rule_id: {
+                readonly type: "string";
+            };
+            readonly rule_revision: {
+                readonly type: "number";
+            };
+            readonly configuration_revision: {
+                readonly type: "string";
+            };
+            readonly native_rule_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly source: {
+                readonly type: "string";
+            };
+            readonly detector_version: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly scoring_version: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly term_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly detection_method: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly confidence_class: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly confidence_score: {
+                readonly type: "number";
+                readonly optional: true;
+            };
+            readonly effective_threshold: {
+                readonly type: "number";
+                readonly optional: true;
+            };
+            readonly correlation_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly subject_user_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly channel_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly message_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly alert_system_message_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly action_type: {
+                readonly type: "string";
+            };
+            readonly claim_key: {
+                readonly type: "string";
+            };
+            readonly moderation_case_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly outcome: {
+                readonly type: "string";
+            };
+            readonly safe_code: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly occurred_at: {
+                readonly type: "date";
+            };
+            readonly retention_expires_at: {
+                readonly type: "date";
+            };
+            readonly created_at: {
+                readonly type: "date";
+            };
+        };
+        readonly uniqueKeys: readonly [readonly ["receipt_id"], readonly ["guild_id", "event_key"]];
+        readonly readableFields: readonly ["receipt_id", "guild_id", "event_key", "rule_id", "rule_revision", "configuration_revision", "native_rule_id", "source", "detector_version", "scoring_version", "term_id", "detection_method", "confidence_class", "confidence_score", "effective_threshold", "correlation_id", "subject_user_id", "channel_id", "message_id", "alert_system_message_id", "action_type", "claim_key", "moderation_case_id", "outcome", "safe_code", "occurred_at", "retention_expires_at", "created_at"];
+        readonly writableFields: readonly ["receipt_id", "guild_id", "event_key", "rule_id", "rule_revision", "configuration_revision", "native_rule_id", "source", "detector_version", "scoring_version", "term_id", "detection_method", "confidence_class", "confidence_score", "effective_threshold", "correlation_id", "subject_user_id", "channel_id", "message_id", "alert_system_message_id", "action_type", "claim_key", "moderation_case_id", "outcome", "safe_code", "occurred_at", "retention_expires_at", "created_at"];
+        readonly orderKeys: readonly [readonly ["occurred_at", "receipt_id"]];
+        readonly groupableFields: readonly ["outcome", "source", "action_type", "rule_id"];
+    };
+    readonly enforcement_claims: {
+        readonly table: "automod_enforcement_claims";
+        readonly fields: {
+            readonly claim_key: {
+                readonly type: "string";
+            };
+            readonly guild_id: {
+                readonly type: "string";
+            };
+            readonly rule_id: {
+                readonly type: "string";
+            };
+            readonly rule_revision: {
+                readonly type: "number";
+            };
+            readonly configuration_revision: {
+                readonly type: "string";
+            };
+            readonly subject_user_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly channel_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly message_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly category: {
+                readonly type: "string";
+            };
+            readonly action_family: {
+                readonly type: "string";
+            };
+            readonly source: {
+                readonly type: "string";
+            };
+            readonly request_fingerprint: {
+                readonly type: "string";
+            };
+            readonly moderation_case_id: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly repeat_ordinal: {
+                readonly type: "number";
+                readonly optional: true;
+            };
+            readonly selected_action: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly outcome: {
+                readonly type: "string";
+            };
+            readonly safe_code: {
+                readonly type: "string";
+                readonly optional: true;
+            };
+            readonly revision: {
+                readonly type: "number";
+            };
+            readonly occurred_at: {
+                readonly type: "date";
+            };
+            readonly settled_at: {
+                readonly type: "date";
+                readonly optional: true;
+            };
+            readonly retention_expires_at: {
+                readonly type: "date";
+            };
+            readonly created_at: {
+                readonly type: "date";
+            };
+            readonly updated_at: {
+                readonly type: "date";
+            };
+        };
+        readonly uniqueKeys: readonly [readonly ["guild_id", "claim_key"]];
+        readonly readableFields: readonly ["claim_key", "guild_id", "rule_id", "rule_revision", "configuration_revision", "subject_user_id", "channel_id", "message_id", "category", "action_family", "source", "request_fingerprint", "moderation_case_id", "repeat_ordinal", "selected_action", "outcome", "safe_code", "revision", "occurred_at", "settled_at", "retention_expires_at", "created_at", "updated_at"];
+        readonly writableFields: readonly ["claim_key", "guild_id", "rule_id", "rule_revision", "configuration_revision", "subject_user_id", "channel_id", "message_id", "category", "action_family", "source", "request_fingerprint", "moderation_case_id", "repeat_ordinal", "selected_action", "outcome", "safe_code", "revision", "occurred_at", "settled_at", "retention_expires_at", "created_at", "updated_at"];
+        readonly orderKeys: readonly [readonly ["occurred_at", "guild_id", "claim_key"]];
+        readonly groupableFields: readonly ["outcome", "source", "rule_id"];
+    };
+    readonly daily_counts: {
+        readonly table: "automod_daily_counts";
+        readonly fields: {
+            readonly guild_id: {
+                readonly type: "string";
+            };
+            readonly rule_id: {
+                readonly type: "string";
+            };
+            readonly day: {
+                readonly type: "string";
+            };
+            readonly source: {
+                readonly type: "string";
+            };
+            readonly action_type: {
+                readonly type: "string";
+            };
+            readonly observed_count: {
+                readonly type: "number";
+            };
+            readonly last_observed_at: {
+                readonly type: "date";
+            };
+        };
+        readonly uniqueKeys: readonly [readonly ["guild_id", "rule_id", "day", "source", "action_type"]];
+        readonly readableFields: readonly ["guild_id", "rule_id", "day", "source", "action_type", "observed_count", "last_observed_at"];
+        readonly writableFields: readonly ["guild_id", "rule_id", "day", "source", "action_type", "observed_count", "last_observed_at"];
+        readonly orderKeys: readonly [readonly ["day", "source", "action_type", "guild_id", "rule_id"]];
+        readonly groupableFields: readonly ["source", "action_type"];
+        readonly incrementableFields: readonly ["observed_count"];
+        readonly maximumFields: readonly ["last_observed_at"];
+    };
+};
+//# sourceMappingURL=records.d.ts.map

package/dist/records.js

@@ -0,0 +1,288 @@
+export const automodRecords = {
+    rules: {
+        table: "automod_rules",
+        fields: {
+            rule_id: { type: "string" },
+            guild_id: { type: "string" },
+            name: { type: "string" },
+            name_key: { type: "string" },
+            category: { type: "string" },
+            rule_kind: { type: "string" },
+            status: { type: "string" },
+            document_json: { type: "json" },
+            native_rule_id: { type: "string", optional: true },
+            native_fingerprint: { type: "string", optional: true },
+            operation_key: { type: "string" },
+            configuration_revision: { type: "string" },
+            revision: { type: "number" },
+            created_by_user_id: { type: "string", optional: true },
+            updated_by_user_id: { type: "string", optional: true },
+            created_at: { type: "date" },
+            updated_at: { type: "date" },
+        },
+        ownedSetLimit: 100,
+        uniqueKeys: [
+            ["rule_id"],
+            ["guild_id", "rule_id"],
+            ["guild_id", "name_key"],
+            ["guild_id", "native_rule_id"],
+        ],
+        readableFields: [
+            "rule_id",
+            "guild_id",
+            "name",
+            "name_key",
+            "category",
+            "rule_kind",
+            "status",
+            "document_json",
+            "native_rule_id",
+            "native_fingerprint",
+            "operation_key",
+            "configuration_revision",
+            "revision",
+            "created_by_user_id",
+            "updated_by_user_id",
+            "created_at",
+            "updated_at",
+        ],
+        writableFields: [
+            "rule_id",
+            "guild_id",
+            "name",
+            "name_key",
+            "category",
+            "rule_kind",
+            "status",
+            "document_json",
+            "native_rule_id",
+            "native_fingerprint",
+            "operation_key",
+            "configuration_revision",
+            "revision",
+            "created_by_user_id",
+            "updated_by_user_id",
+            "created_at",
+            "updated_at",
+        ],
+        orderKeys: [
+            ["updated_at", "rule_id"],
+            ["name_key", "rule_id"],
+        ],
+        groupableFields: ["guild_id", "status", "category", "rule_kind"],
+        searchableFields: ["name", "name_key"],
+    },
+    action_receipts: {
+        table: "automod_action_receipts",
+        fields: {
+            receipt_id: { type: "string" },
+            guild_id: { type: "string" },
+            event_key: { type: "string" },
+            rule_id: { type: "string" },
+            rule_revision: { type: "number" },
+            configuration_revision: { type: "string" },
+            native_rule_id: { type: "string", optional: true },
+            source: { type: "string" },
+            detector_version: { type: "string", optional: true },
+            scoring_version: { type: "string", optional: true },
+            term_id: { type: "string", optional: true },
+            detection_method: { type: "string", optional: true },
+            confidence_class: { type: "string", optional: true },
+            confidence_score: { type: "number", optional: true },
+            effective_threshold: { type: "number", optional: true },
+            correlation_id: { type: "string", optional: true },
+            subject_user_id: { type: "string", optional: true },
+            channel_id: { type: "string", optional: true },
+            message_id: { type: "string", optional: true },
+            alert_system_message_id: { type: "string", optional: true },
+            action_type: { type: "string" },
+            claim_key: { type: "string" },
+            moderation_case_id: { type: "string", optional: true },
+            outcome: { type: "string" },
+            safe_code: { type: "string", optional: true },
+            occurred_at: { type: "date" },
+            retention_expires_at: { type: "date" },
+            created_at: { type: "date" },
+        },
+        uniqueKeys: [["receipt_id"], ["guild_id", "event_key"]],
+        readableFields: [
+            "receipt_id",
+            "guild_id",
+            "event_key",
+            "rule_id",
+            "rule_revision",
+            "configuration_revision",
+            "native_rule_id",
+            "source",
+            "detector_version",
+            "scoring_version",
+            "term_id",
+            "detection_method",
+            "confidence_class",
+            "confidence_score",
+            "effective_threshold",
+            "correlation_id",
+            "subject_user_id",
+            "channel_id",
+            "message_id",
+            "alert_system_message_id",
+            "action_type",
+            "claim_key",
+            "moderation_case_id",
+            "outcome",
+            "safe_code",
+            "occurred_at",
+            "retention_expires_at",
+            "created_at",
+        ],
+        writableFields: [
+            "receipt_id",
+            "guild_id",
+            "event_key",
+            "rule_id",
+            "rule_revision",
+            "configuration_revision",
+            "native_rule_id",
+            "source",
+            "detector_version",
+            "scoring_version",
+            "term_id",
+            "detection_method",
+            "confidence_class",
+            "confidence_score",
+            "effective_threshold",
+            "correlation_id",
+            "subject_user_id",
+            "channel_id",
+            "message_id",
+            "alert_system_message_id",
+            "action_type",
+            "claim_key",
+            "moderation_case_id",
+            "outcome",
+            "safe_code",
+            "occurred_at",
+            "retention_expires_at",
+            "created_at",
+        ],
+        orderKeys: [["occurred_at", "receipt_id"]],
+        groupableFields: ["outcome", "source", "action_type", "rule_id"],
+    },
+    enforcement_claims: {
+        table: "automod_enforcement_claims",
+        fields: {
+            claim_key: { type: "string" },
+            guild_id: { type: "string" },
+            rule_id: { type: "string" },
+            rule_revision: { type: "number" },
+            configuration_revision: { type: "string" },
+            subject_user_id: { type: "string", optional: true },
+            channel_id: { type: "string", optional: true },
+            message_id: { type: "string", optional: true },
+            category: { type: "string" },
+            action_family: { type: "string" },
+            source: { type: "string" },
+            request_fingerprint: { type: "string" },
+            moderation_case_id: { type: "string", optional: true },
+            repeat_ordinal: { type: "number", optional: true },
+            selected_action: { type: "string", optional: true },
+            outcome: { type: "string" },
+            safe_code: { type: "string", optional: true },
+            revision: { type: "number" },
+            occurred_at: { type: "date" },
+            settled_at: { type: "date", optional: true },
+            retention_expires_at: { type: "date" },
+            created_at: { type: "date" },
+            updated_at: { type: "date" },
+        },
+        uniqueKeys: [["guild_id", "claim_key"]],
+        readableFields: [
+            "claim_key",
+            "guild_id",
+            "rule_id",
+            "rule_revision",
+            "configuration_revision",
+            "subject_user_id",
+            "channel_id",
+            "message_id",
+            "category",
+            "action_family",
+            "source",
+            "request_fingerprint",
+            "moderation_case_id",
+            "repeat_ordinal",
+            "selected_action",
+            "outcome",
+            "safe_code",
+            "revision",
+            "occurred_at",
+            "settled_at",
+            "retention_expires_at",
+            "created_at",
+            "updated_at",
+        ],
+        writableFields: [
+            "claim_key",
+            "guild_id",
+            "rule_id",
+            "rule_revision",
+            "configuration_revision",
+            "subject_user_id",
+            "channel_id",
+            "message_id",
+            "category",
+            "action_family",
+            "source",
+            "request_fingerprint",
+            "moderation_case_id",
+            "repeat_ordinal",
+            "selected_action",
+            "outcome",
+            "safe_code",
+            "revision",
+            "occurred_at",
+            "settled_at",
+            "retention_expires_at",
+            "created_at",
+            "updated_at",
+        ],
+        orderKeys: [["occurred_at", "guild_id", "claim_key"]],
+        groupableFields: ["outcome", "source", "rule_id"],
+    },
+    daily_counts: {
+        table: "automod_daily_counts",
+        fields: {
+            guild_id: { type: "string" },
+            rule_id: { type: "string" },
+            day: { type: "string" },
+            source: { type: "string" },
+            action_type: { type: "string" },
+            observed_count: { type: "number" },
+            last_observed_at: { type: "date" },
+        },
+        uniqueKeys: [["guild_id", "rule_id", "day", "source", "action_type"]],
+        readableFields: [
+            "guild_id",
+            "rule_id",
+            "day",
+            "source",
+            "action_type",
+            "observed_count",
+            "last_observed_at",
+        ],
+        writableFields: [
+            "guild_id",
+            "rule_id",
+            "day",
+            "source",
+            "action_type",
+            "observed_count",
+            "last_observed_at",
+        ],
+        orderKeys: [["day", "source", "action_type", "guild_id", "rule_id"]],
+        groupableFields: ["source", "action_type"],
+        incrementableFields: ["observed_count"],
+        maximumFields: ["last_observed_at"],
+    },
+};
+//# sourceMappingURL=records.js.map

package/dist/repository-model.d.ts

@@ -0,0 +1,54 @@
+import type { ModuleRecordValue } from "@helyx/sdk";
+import type { AutoModerationRuleDraft, AutoModerationRuleStatus } from "./domain.js";
+export declare const RULE_FIELDS: readonly ["rule_id", "guild_id", "name", "category", "rule_kind", "status", "document_json", "native_rule_id", "native_fingerprint", "operation_key", "configuration_revision", "revision", "created_by_user_id", "updated_by_user_id", "created_at", "updated_at"];
+export declare const RECEIPT_FIELDS: readonly ["receipt_id", "guild_id", "event_key", "rule_id", "rule_revision", "configuration_revision", "native_rule_id", "source", "detector_version", "scoring_version", "term_id", "detection_method", "confidence_class", "confidence_score", "effective_threshold", "correlation_id", "subject_user_id", "channel_id", "message_id", "alert_system_message_id", "action_type", "claim_key", "moderation_case_id", "outcome", "safe_code", "occurred_at", "created_at"];
+export interface StoredAutoModerationRule {
+    ruleId: string;
+    guildId: string;
+    name: string;
+    category: AutoModerationRuleDraft["category"];
+    kind: AutoModerationRuleDraft["kind"];
+    status: AutoModerationRuleStatus;
+    draft: AutoModerationRuleDraft;
+    nativeRuleId: string | null;
+    nativeFingerprint: string | null;
+    operationKey: string;
+    configurationRevision: string;
+    revision: number;
+    createdByUserId: string | null;
+    updatedByUserId: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StoredAutoModerationReceipt {
+    receiptId: string;
+    guildId: string;
+    eventKey: string;
+    ruleId: string;
+    ruleRevision: number;
+    configurationRevision: string;
+    nativeRuleId: string | null;
+    source: "native" | "enhanced";
+    detectorVersion: string | null;
+    scoringVersion: string | null;
+    termId: string | null;
+    detectionMethod: string | null;
+    confidenceClass: string | null;
+    confidenceScore: number | null;
+    effectiveThreshold: number | null;
+    correlationId: string | null;
+    subjectUserId: string | null;
+    channelId: string | null;
+    messageId: string | null;
+    alertSystemMessageId: string | null;
+    actionType: string;
+    claimKey: string;
+    moderationCaseId: string | null;
+    outcome: string;
+    safeCode: string | null;
+    occurredAt: Date;
+    createdAt: Date;
+}
+export declare function mapRule(row: Readonly<Record<string, ModuleRecordValue>>): StoredAutoModerationRule;
+export declare function mapReceipt(row: Readonly<Record<string, ModuleRecordValue>>): StoredAutoModerationReceipt;
+//# sourceMappingURL=repository-model.d.ts.map