elynn-baileys 1.0.1

package/lib/Discord/types/audit-log.d.ts

@@ -0,0 +1,116 @@
+/** @module Types/AuditLog */
+import type * as Types from "./namespaced";
+import type { AuditLogActionTypes, OverwriteTypes } from "../Constants";
+import type GuildScheduledEvent from "../structures/GuildScheduledEvent";
+import type AnnouncementThreadChannel from "../structures/AnnouncementThreadChannel";
+import type PublicThreadChannel from "../structures/PublicThreadChannel";
+import type PrivateThreadChannel from "../structures/PrivateThreadChannel";
+import type User from "../structures/User";
+import type Webhook from "../structures/Webhook";
+import type Integration from "../structures/Integration";
+import type AutoModerationRule from "../structures/AutoModerationRule";
+import type AuditLogEntry from "../structures/AuditLogEntry";
+import type ApplicationCommand from "../structures/ApplicationCommand";
+
+export interface RawAuditLog {
+    application_commands: Array<Types.Applications.RawApplicationCommand>;
+    audit_log_entries: Array<RawAuditLogEntry>;
+    auto_moderation_rules: Array<Types.AutoModeration.RawAutoModerationRule>;
+    guild_scheduled_events: Array<Types.ScheduledEvents.RawScheduledEvent>;
+    integrations: Array<Types.Guilds.RawIntegration>;
+    threads: Array<Types.Channels.RawAnnouncementThreadChannel | Types.Channels.RawPublicThreadChannel | Types.Channels.RawPrivateThreadChannel>;
+    users: Array<Types.Users.RawUser>;
+    webhooks: Array<Types.Webhooks.RawWebhook>;
+}
+
+export interface AuditLog {
+    applicationCommands: Array<ApplicationCommand>;
+    autoModerationRules: Array<AutoModerationRule>;
+    entries: Array<AuditLogEntry>;
+    guildScheduledEvents: Array<GuildScheduledEvent>;
+    integrations: Array<Integration>;
+    threads: Array<AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel>;
+    users: Array<User>;
+    webhooks: Array<Webhook>;
+}
+
+export interface RawAuditLogEntry {
+    action_type: AuditLogActionTypes;
+    /** See the [audit log documentation](https://discord.com/developers/docs/resources/audit-log#audit-log-change-object) for more information. */
+    changes?: Array<StandardAuditLogChange | RoleAuditLogChange>;
+    id: string;
+    options?: RawAuditLogEntryOptions;
+    reason?: string;
+    target_id: string | null;
+    user_id: string | null;
+}
+export interface RawAuditLogEntryOptions {
+    application_id?: string;
+    auto_moderation_rule_name?: string;
+    auto_moderation_rule_trigger_type?: string;
+    channel_id?: string;
+    count?: number;
+    delete_member_days?: number;
+    id?: string;
+    integration_type?: string;
+    members_removed?: number;
+    message_id?: string;
+    role_name?: string;
+    status?: string;
+    type?: "0" | "1";
+}
+export interface AuditLogEntryOptions {
+    /** ID of the app whose permissions were targeted - valid for: `APPLICATION_COMMAND_PERMISSION_UPDATE` */
+    applicationID?: string;
+    /** Name of the auto moderation rule that was triggered - valid for: `AUTO_MODERATION_BLOCK_MESSAGE`, `AUTO_MODERATION_FLAG_TO_CHANNEL`, `AUTO_MODERATION_USER_COMMUNICATION_DISABLED` */
+    autoModerationRuleName?: string;
+    /** Trigger type of the auto moderation rule that was triggered - valid for: `AUTO_MODERATION_BLOCK_MESSAGE`, `AUTO_MODERATION_FLAG_TO_CHANNEL`, `AUTO_MODERATION_USER_COMMUNICATION_DISABLED` */
+    autoModerationRuleTriggerType?: string;
+    /** Channel in which the entities were targeted - valid for: `MEMBER_MOVE`,  `MESSAGE_PIN`, `MESSAGE_UNPIN`, `MESSAGE_DELETE`, `STAGE_INSTANCE_CREATE`, `STAGE_INSTANCE_UPDATE`, `STAGE_INSTANCE_DELETE` */
+    channelID?: string;
+    /** Number of entities that were targeted - valid for: `MESSAGE_DELETE`, `MESSAGE_BULK_DELETE`, `MEMBER_DISCONNECT`, `MEMBER_MOVE` */
+    count?: number;
+    /** Number of days after which inactive members were kicked - valid for: `MEMBER_PRUNE` */
+    deleteMemberDays?: number;
+    /** ID of the overwritten entity - valid for: `CHANNEL_OVERWRITE_CREATE`, `CHANNEL_OVERWRITE_UPDATE`, `CHANNEL_OVERWRITE_DELETE` */
+    id?: string;
+    /** The type of interaction - valid for: `MEMBER_KICK`, `MEMBER_ROLE_UPDATE` */
+    integrationType?: string;
+    /** Number of members removed by the prune - valid for: `MEMBER_PRUNE` */
+    membersRemoved?: number;
+    /** ID of the message that was targeted - valid for: `MESSAGE_PIN`, `MESSAGE_UNPIN` */
+    messageID?: string;
+    /** Name of the role if type is "0" (not present if type is "1") - valid for: `CHANNEL_OVERWRITE_CREATE`, `CHANNEL_OVERWRITE_UPDATE`, `CHANNEL_OVERWRITE_DELETE` */
+    roleName?: string;
+    /** The status set in a voice channel - valid for: `VOICE_CHANNEL_STATUS_CREATE` */
+    status?: string;
+    /** Type of overwritten entity - role ("0") or member ("1") - valid for: `CHANNEL_OVERWRITE_CREATE`, `CHANNEL_OVERWRITE_UPDATE`, `CHANNEL_OVERWRITE_DELETE` */
+    type?: `${OverwriteTypes}`;
+}
+
+export interface RawAuditLogIntegration extends Pick<Types.Guilds.RawIntegration, "id" | "name" | "type" | "account"> {
+    application_id?: string;
+}
+
+export type AuditLogChange = StandardAuditLogChange | RoleAuditLogChange;
+export interface StandardAuditLogChange {
+    key: string;
+    new_value?: unknown;
+    old_value?: unknown;
+}
+
+export interface RoleAuditLogChange {
+    key: "$add" | "$remove";
+    new_value: Array<{ id: string; name: string; }>;
+}
+
+export interface GetAuditLogOptions {
+    /** The action type to filter by. */
+    actionType?: AuditLogActionTypes;
+    /** The ID of the entry to get entries before. */
+    before?: string;
+    /** The maximum number of entries to get. */
+    limit?: number;
+    /** The ID of the user to filter by. */
+    userID?: string;
+}

package/lib/Discord/types/auto-moderation.d.ts

@@ -0,0 +1,99 @@
+/** @module Types/AutoModeration */
+import type { AutoModerationActionTypes, AutoModerationEventTypes, AutoModerationKeywordPresetTypes, AutoModerationTriggerTypes } from "../Constants";
+
+export interface RawAutoModerationRule {
+    actions: Array<RawAutoModerationAction>;
+    creator_id: string;
+    enabled: boolean;
+    event_type: AutoModerationEventTypes;
+    exempt_channels: Array<string>;
+    exempt_roles: Array<string>;
+    guild_id: string;
+    id: string;
+    name: string;
+    trigger_metadata: RawTriggerMetadata;
+    trigger_type: AutoModerationTriggerTypes;
+}
+
+export interface RawTriggerMetadata {
+    /** `KEYWORD`, `KEYWORD_PRESET`, `MEMBER_PROFILE` */
+    allow_list?: Array<string>;
+    /** `KEYWORD`, `MEMBER_PROFILE` */
+    keyword_filter?: Array<string>;
+    /** `MENTION_SPAM` */
+    mention_raid_protection_enabled?: boolean;
+    /** `MENTION_SPAM` */
+    mention_total_limit?: number;
+    /** `KEYWORD_PRESET` */
+    presets?: Array<AutoModerationKeywordPresetTypes>;
+    /** `KEYWORD`, `MEMBER_PROFILE` */
+    regex_patterns?: Array<string>;
+}
+
+export interface RawAutoModerationAction {
+    metadata: RawActionMetadata;
+    type: AutoModerationActionTypes;
+}
+
+export interface RawActionMetadata {
+    /** `SEND_ALERT_MESSAGE` */
+    channel_id?: string;
+    /** `BLOCK_MESSAGE` */
+    custom_message?: string;
+    /** `TIMEOUT` */
+    duration_seconds?: number;
+}
+
+export interface TriggerMetadata {
+    /** The keywords to allow. Valid for `KEYWORD`, `KEYWORD_PRESET` & `MEMBER_PROFILE`. `KEYWORD`, `MEMBER_PROFILE`: Max 100 total, 60 characters each. `KEYWORD_PRESET`: Max 1000 total, 60 characters each. */
+    allowList?: Array<string>;
+    /** The keywords to filter. Valid for `KEYWORD` & `MEMBER_PROFILE`. Max 1000 total, 60 characters each. */
+    keywordFilter?: Array<string>;
+    /** Whether to enable mention raid protection. Valid for `MENTION_SPAM`. */
+    mentionRaidProtectionEnabled?: boolean;
+    /** The maximum number of mentions to allow. Valid for `MENTION_SPAM`. */
+    mentionTotalLimit?: number;
+    /** The presets to use. Valid for `KEYWORD_PRESET`. */
+    presets?: Array<AutoModerationKeywordPresetTypes>;
+    /** The regular expressions to match the content against and filter. Currently only Rust flavored regex such as `Rustexp` are supported. Valid for `KEYWORD`& `MEMBER_PROFILE`. Max 10 total, 260 characters each. */
+    regexPatterns?: Array<string>;
+}
+
+export interface AutoModerationAction {
+    /** The metadata for the action. */
+    metadata: ActionMetadata;
+    /** The type of the action. */
+    type: AutoModerationActionTypes;
+}
+
+export interface ActionMetadata {
+    /** The ID of the channel to send the message to. Valid for `SEND_ALERT_MESSAGE`. */
+    channelID?: string;
+    /** The custom message to send. Valid for `BLOCK_MESSAGE`. */
+    customMessage?: string;
+    /** The duration of the timeout in seconds. Valid for `TIMEOUT`. */
+    durationSeconds?: number;
+}
+
+export interface CreateAutoModerationRuleOptions {
+    /** The actions for the rule. */
+    actions: Array<AutoModerationAction>;
+    /** If the rule is enabled. */
+    enabled?: boolean;
+    /** The event type to trigger on. */
+    eventType: AutoModerationEventTypes;
+    /** The channels to exempt from the rule. */
+    exemptChannels?: Array<string>;
+    /** The roles to exempt from the rule. */
+    exemptRoles?: Array<string>;
+    /** The name of the rule. */
+    name: string;
+    /** The reason for creating the rule. */
+    reason?: string;
+    /** The metadata to use for the trigger. */
+    triggerMetadata?: TriggerMetadata;
+    /** The type of trigger to use. */
+    triggerType: AutoModerationTriggerTypes;
+}
+
+export type EditAutoModerationRuleOptions = Partial<Pick<CreateAutoModerationRuleOptions, "name" | "eventType" | "triggerMetadata" | "actions" | "enabled" | "exemptRoles" | "exemptChannels" | "reason">>;