@satorijs/adapter-discord 4.1.3 → 4.1.4

package/src/types/audit-log.ts

@@ -0,0 +1,219 @@
+import { ApplicationCommand, AutoModerationRule, Channel, GuildScheduledEvent, integer, Integration, Internal, snowflake, User, Webhook } from '.'
+
+/** https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure */
+export interface AuditLog {
+  /** list of application commands referenced in the audit log */
+  application_commands: ApplicationCommand[]
+  /** list of audit log entries */
+  audit_log_entries: AuditLog.Entry[]
+  /** list of auto moderation rules referenced in the audit log */
+  auto_moderation_rules: AutoModerationRule[]
+  /** list of guild scheduled events referenced in the audit log */
+  guild_scheduled_events: GuildScheduledEvent[]
+  /** list of partial integration objects */
+  integrations: Partial<Integration>[]
+  /** list of threads found in the audit log* */
+  threads: Channel[]
+  /** list of users found in the audit log */
+  users: User[]
+  /** list of webhooks found in the audit log */
+  webhooks: Webhook[]
+}
+
+export namespace AuditLog {
+  /** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure */
+  export interface Entry {
+    /** id of the affected entity (webhook, user, role, etc.) */
+    target_id?: string
+    /** changes made to the target_id */
+    changes?: Change[]
+    /** the user who made the changes */
+    user_id?: snowflake
+    /** id of the entry */
+    id: snowflake
+    /** type of action that occurred */
+    action_type: Type
+    /** additional info for certain action types */
+    options?: OptionalInfo
+    /** the reason for the change (0-512 characters) */
+    reason?: string
+  }
+
+  /** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events */
+  export enum Type {
+    /** Server settings were updated */
+    GUILD_UPDATE = 1,
+    /** Channel was created */
+    CHANNEL_CREATE = 10,
+    /** Channel settings were updated */
+    CHANNEL_UPDATE = 11,
+    /** Channel was deleted */
+    CHANNEL_DELETE = 12,
+    /** Permission overwrite was added to a channel */
+    CHANNEL_OVERWRITE_CREATE = 13,
+    /** Permission overwrite was updated for a channel */
+    CHANNEL_OVERWRITE_UPDATE = 14,
+    /** Permission overwrite was deleted from a channel */
+    CHANNEL_OVERWRITE_DELETE = 15,
+    /** Member was removed from server */
+    MEMBER_KICK = 20,
+    /** Members were pruned from server */
+    MEMBER_PRUNE = 21,
+    /** Member was banned from server */
+    MEMBER_BAN_ADD = 22,
+    /** Server ban was lifted for a member */
+    MEMBER_BAN_REMOVE = 23,
+    /** Member was updated in server */
+    MEMBER_UPDATE = 24,
+    /** Member was added or removed from a role */
+    MEMBER_ROLE_UPDATE = 25,
+    /** Member was moved to a different voice channel */
+    MEMBER_MOVE = 26,
+    /** Member was disconnected from a voice channel */
+    MEMBER_DISCONNECT = 27,
+    /** Bot user was added to server */
+    BOT_ADD = 28,
+    /** Role was created */
+    ROLE_CREATE = 30,
+    /** Role was edited */
+    ROLE_UPDATE = 31,
+    /** Role was deleted */
+    ROLE_DELETE = 32,
+    /** Server invite was created */
+    INVITE_CREATE = 40,
+    /** Server invite was updated */
+    INVITE_UPDATE = 41,
+    /** Server invite was deleted */
+    INVITE_DELETE = 42,
+    /** Webhook was created */
+    WEBHOOK_CREATE = 50,
+    /** Webhook properties or channel were updated */
+    WEBHOOK_UPDATE = 51,
+    /** Webhook was deleted */
+    WEBHOOK_DELETE = 52,
+    /** Emoji was created */
+    EMOJI_CREATE = 60,
+    /** Emoji name was updated */
+    EMOJI_UPDATE = 61,
+    /** Emoji was deleted */
+    EMOJI_DELETE = 62,
+    /** Single message was deleted */
+    MESSAGE_DELETE = 72,
+    /** Multiple messages were deleted */
+    MESSAGE_BULK_DELETE = 73,
+    /** Message was pinned to a channel */
+    MESSAGE_PIN = 74,
+    /** Message was unpinned from a channel */
+    MESSAGE_UNPIN = 75,
+    /** App was added to server */
+    INTEGRATION_CREATE = 80,
+    /** App was updated (as an example, its scopes were updated) */
+    INTEGRATION_UPDATE = 81,
+    /** App was removed from server */
+    INTEGRATION_DELETE = 82,
+    /** Stage instance was created (stage channel becomes live) */
+    STAGE_INSTANCE_CREATE = 83,
+    /** Stage instance details were updated */
+    STAGE_INSTANCE_UPDATE = 84,
+    /** Stage instance was deleted (stage channel no longer live) */
+    STAGE_INSTANCE_DELETE = 85,
+    /** Sticker was created */
+    STICKER_CREATE = 90,
+    /** Sticker details were updated */
+    STICKER_UPDATE = 91,
+    /** Sticker was deleted */
+    STICKER_DELETE = 92,
+    /** Event was created */
+    GUILD_SCHEDULED_EVENT_CREATE = 100,
+    /** Event was updated */
+    GUILD_SCHEDULED_EVENT_UPDATE = 101,
+    /** Event was cancelled */
+    GUILD_SCHEDULED_EVENT_DELETE = 102,
+    /** Thread was created in a channel */
+    THREAD_CREATE = 110,
+    /** Thread was updated */
+    THREAD_UPDATE = 111,
+    /** Thread was deleted */
+    THREAD_DELETE = 112,
+    /** Permissions were updated for a command */
+    APPLICATION_COMMAND_PERMISSION_UPDATE = 121,
+    /** Auto Moderation rule was created */
+    AUTO_MODERATION_RULE_CREATE = 140,
+    /** Auto Moderation rule was updated */
+    AUTO_MODERATION_RULE_UPDATE = 141,
+    /** Auto Moderation rule was deleted */
+    AUTO_MODERATION_RULE_DELETE = 142,
+    /** Message was blocked by AutoMod */
+    AUTO_MODERATION_BLOCK_MESSAGE = 143,
+    /** Message was flagged by AutoMod */
+    AUTO_MODERATION_FLAG_TO_CHANNEL = 144,
+    /** Member was timed out by AutoMod */
+    AUTO_MODERATION_USER_COMMUNICATION_DISABLED = 145,
+  }
+
+  /** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info */
+  export interface OptionalInfo {
+    /** ID of the app whose permissions were targeted */
+    application_id: snowflake
+    /** name of the Auto Moderation rule that was triggered */
+    auto_moderation_rule_name: string
+    /** trigger type of the Auto Moderation rule that was triggered */
+    auto_moderation_rule_trigger_type: string
+    /** channel in which the entities were targeted */
+    channel_id: snowflake
+    /** number of entities that were targeted */
+    count: string
+    /** number of days after which inactive members were kicked */
+    delete_member_days: string
+    /** id of the overwritten entity */
+    id: snowflake
+    /** number of members removed by the prune */
+    members_removed: string
+    /** id of the message that was targeted */
+    message_id: snowflake
+    /** name of the role if type is "0" (not present if type is "1") */
+    role_name: string
+    /** type of overwritten entity - "0" for "role" or "1" for "member" */
+    type: string
+  }
+
+  /** https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure */
+  export interface Change {
+    /** new value of the key */
+    new_value?: any
+    /** old value of the key */
+    old_value?: any
+    /** name of audit log change key */
+    key: string
+  }
+
+  /** https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log-query-string-params */
+  export interface GetParams {
+    /** entries from a specific user ID */
+    user_id?: snowflake
+    /** entries for a specific audit log event */
+    action_type?: Type
+    /** entries that preceded a specific audit log entry ID */
+    before?: snowflake
+    /** entries that succeeded a specific audit log entry ID */
+    after?: snowflake
+    /** maximum number of entries (between 1-100) to return, defaults to 50 */
+    limit?: integer
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns an audit log object for the guild. Requires the 'VIEW_AUDIT_LOG' permission.
+     * @see https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log
+     */
+    getGuildAuditLog(guildId: snowflake, params?: AuditLog.GetParams): Promise<AuditLog>
+  }
+}
+
+Internal.define({
+  '/guilds/{guild.id}/audit-logs': {
+    GET: 'getGuildAuditLog',
+  },
+})

package/src/types/auto-moderation.ts

@@ -0,0 +1,189 @@
+import { integer, Internal, snowflake } from '.'
+
+/** @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure */
+export interface AutoModerationRule {
+  /** the id of this rule */
+  id: snowflake
+  /** the id of the guild which this rule belongs to */
+  guild_id: snowflake
+  /** the rule name */
+  name: string
+  /** the user which first created this rule */
+  creator_id: snowflake
+  /** the rule event type */
+  event_type: AutoModerationRule.EventType
+  /** the rule trigger type */
+  trigger_type: AutoModerationRule.TriggerType
+  /** the rule trigger metadata */
+  trigger_metadata: AutoModerationRule.TriggerMetadata
+  /** the actions which will execute when the rule is triggered */
+  actions: AutoModerationAction[]
+  /** whether the rule is enabled */
+  enabled: boolean
+  /** the role ids that should not be affected by the rule (Maximum of 20) */
+  exempt_roles: snowflake[]
+  /** the channel ids that should not be affected by the rule (Maximum of 50) */
+  exempt_channels: snowflake[]
+}
+
+export namespace AutoModerationRule {
+  /**
+   * Indicates in what event context a rule should be checked.
+   * @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types
+   */
+  export const enum EventType {
+    /** when a member sends or edits a message in the guild */
+    MESSAGE_SEND = 1,
+  }
+
+  /**
+   * Characterizes the type of content which can trigger the rule.
+   * @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types
+   */
+  export const enum TriggerType {
+    /** check if content contains words from a user defined list of keywords (max per guild: 3) */
+    KEYWORD = 1,
+    /** check if content represents generic spam (max per guild: 1) */
+    SPAM = 3,
+    /** check if content contains words from internal pre-defined wordsets (max per guild: 1) */
+    KEYWORD_PRESET = 4,
+    /** check if content contains more unique mentions than allowed (max per guild: 1) */
+    MENTION_SPAM = 5,
+  }
+
+  /**
+   * Additional data used to determine whether a rule should be triggered.
+   * Different fields are relevant based on the value of trigger_type.
+   * @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata
+   */
+  export interface TriggerMetadata {
+    /** associated with `KEYWORD`: substrings which will be searched for in content */
+    keyword_filter: string[]
+    /** regular expression patterns which will be matched against content (Maximum of 10) */
+    regex_patterns: string[]
+    /** associated with `KEYWORD_PRESET`: the internally pre-defined wordsets which will be searched for in content */
+    presets: KeywordPresetType[]
+    /** associated with `KEYWORD_PRESET`: substrings which will be exempt from triggering the preset trigger type */
+    allow_list: string[]
+    /** associated with `MENTION_SPAM`: total number of unique role and user mentions allowed per message (Maximum of 50)     */
+    mention_total_limit: integer
+  }
+
+  /** @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-preset-types */
+  export const enum KeywordPresetType {
+    /** Words that may be considered forms of swearing or cursing */
+    PROFANITY = 1,
+    /** Words that refer to sexually explicit behavior or activity */
+    SEXUAL_CONTEN = 2,
+    /** Personal insults or words that may be considered hate speech */
+    SLURS = 3,
+  }
+
+  /** @see https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule-json-params */
+  export interface CreateParams {
+    /** the rule name */
+    name: string
+    /** the event type */
+    event_type: EventType
+    /** the trigger type */
+    trigger_type: TriggerType
+    /** the trigger metadata */
+    trigger_metadata?: TriggerMetadata
+    /** the actions which will execute when the rule is triggered */
+    actions: AutoModerationAction[]
+    /** whether the rule is enabled (False by default) */
+    enabled?: boolean
+    /** the role ids that should not be affected by the rule (Maximum of 20) */
+    exempt_roles?: snowflake[]
+    /** the channel ids that should not be affected by the rule (Maximum of 50) */
+    exempt_channels?: snowflake[]
+  }
+}
+
+/** @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure */
+export interface AutoModerationAction {
+  /** the type of action */
+  type: AutoModerationAction.Type
+  /** additional metadata needed during execution for this specific action type */
+  metadata?: AutoModerationAction.Metadata
+}
+
+export namespace AutoModerationAction {
+  /** @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types */
+  export const enum Type {
+    /** blocks the content of a message according to the rule */
+    BLOCK_MESSAGE = 1,
+    /** logs user content to a specified channel */
+    SEND_ALERT_MESSAGE = 2,
+    /**
+     * timeout user for a specified duration
+     *
+     * A `TIMEOUT` action can only be set up for `KEYWORD` and `MENTION_SPAM` rules.
+     * The `MODERATE_MEMBERS` permission is required to use the `TIMEOUT` action type.)
+     */
+    TIMEOUT = 3,
+  }
+
+  /** @see https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata */
+  export interface Metadata {
+    /**
+     * associated with `SEND_ALERT_MESSAGE`:
+     * channel to which user content should be logged
+     */
+    channel_id?: snowflake
+    /**
+     * associated with `TIMEOUT`:
+     * timeout duration in seconds, maximum of 2419200 seconds (4 weeks)
+     */
+    duration_seconds?: integer
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Get a list of all rules currently configured for the guild.
+     * Returns a list of auto moderation rule objects for the given guild.
+     * This endpoint requires the `MANAGE_GUILD` permission.
+     * @see https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild
+     */
+    listAutoModerationRules(guildId: snowflake): Promise<AutoModerationRule[]>
+    /**
+     * Get a single rule. Returns an auto moderation rule object.
+     * This endpoint requires the `MANAGE_GUILD` permission.
+     * @see https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule
+     */
+    getAutoModerationRule(guildId: snowflake, ruleId: snowflake): Promise<AutoModerationRule>
+    /**
+     * Create a new rule. Returns an auto moderation rule on success. Fires an Auto Moderation Rule Create Gateway event.
+     * This endpoint requires the `MANAGE_GUILD` permission.
+     * @see https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule
+     */
+    createAutoModerationRule(guildId: snowflake, data: AutoModerationRule.CreateParams): Promise<AutoModerationRule>
+    /**
+     * Modify an existing rule. Returns an auto moderation rule on success.
+     * Fires an Auto Moderation Rule Update Gateway event.
+     * This endpoint requires the `MANAGE_GUILD` permission.
+     * @see https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule
+     */
+    modifyAutoModerationRule(guildId: snowflake, ruleId: snowflake, data: Partial<AutoModerationRule.CreateParams>): Promise<AutoModerationRule>
+    /**
+     * Delete a rule. Returns a 204 on success. Fires an Auto Moderation Rule Delete Gateway event.
+     * This endpoint requires the `MANAGE_GUILD` permission.
+     * @see https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule
+     */
+    deleteAutoModerationRule(guildId: snowflake, ruleId: snowflake): Promise<void>
+  }
+}
+
+Internal.define({
+  '/guilds/{guild.id}/auto-moderation/rules': {
+    GET: 'listAutoModerationRules',
+    POST: 'createAutoModerationRule',
+  },
+  '/guilds/{guild.id}/auto-moderation/rules/{rule.id}': {
+    GET: 'getAutoModerationRule',
+    PATCH: 'modifyAutoModerationRule',
+    DELETE: 'deleteAutoModerationRule',
+  },
+})

package/src/types/ban.ts

@@ -0,0 +1,92 @@
+import { integer, Internal, snowflake, User } from '.'
+
+/** https://discord.com/developers/docs/resources/guild#ban-object-ban-structure */
+export interface Ban {
+  /** the reason for the ban */
+  reason?: string
+  /** the banned user */
+  user: User
+}
+
+export namespace Ban {
+  export namespace Event {
+    /** https://discord.com/developers/docs/topics/gateway-events#guild-ban-add-guild-ban-add-event-fields */
+    export interface Add {
+      /** id of the guild */
+      guild_id: snowflake
+      /** the banned user */
+      user: User
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove-guild-ban-remove-event-fields */
+    export interface Remove {
+      /** id of the guild */
+      guild_id: snowflake
+      /** the unbanned user */
+      user: User
+    }
+  }
+
+  /** @see https://discord.com/developers/docs/resources/guild#get-guild-bans-query-string-params */
+  export interface GetParams {
+    /** number of users to return (up to maximum 1000) */
+    limit?: number
+    /** consider only users before given user id */
+    before?: snowflake
+    /** consider only users after given user id */
+    after?: snowflake
+  }
+
+  /** @see https://discord.com/developers/docs/resources/guild#create-guild-ban-json-params */
+  export interface CreateParams {
+    /** number of days to delete messages for (0-7) (deprecated) */
+    delete_message_days?: integer
+    /** number of seconds to delete messages for, between 0 and 604800 (7 days) */
+    delete_message_seconds?: integer
+  }
+}
+
+declare module './gateway' {
+  interface GatewayEvents {
+    /** user was banned from a guild */
+    GUILD_BAN_ADD: Ban.Event.Add
+    /** user was unbanned from a guild */
+    GUILD_BAN_REMOVE: Ban.Event.Remove
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns a list of ban objects for the users banned from this guild. Requires the BAN_MEMBERS permission.
+     * @see https://discord.com/developers/docs/resources/guild#get-guild-bans
+     */
+    getGuildBans(guild_id: snowflake, params: Ban.GetParams): Promise<Ban[]>
+    /**
+     * Returns a ban object for the given user or a 404 not found if the ban cannot be found. Requires the BAN_MEMBERS permission.
+     * @see https://discord.com/developers/docs/resources/guild#get-guild-ban
+     */
+    getGuildBan(guild_id: snowflake, user_id: snowflake): Promise<Ban>
+    /**
+     * Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the BAN_MEMBERS permission. Returns a 204 empty response on success. Fires a Guild Ban Add Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#create-guild-ban
+     */
+    createGuildBan(guild_id: snowflake, user_id: snowflake, params?: Ban.CreateParams): Promise<void>
+    /**
+     * Remove the ban for a user. Requires the BAN_MEMBERS permissions. Returns a 204 empty response on success. Fires a Guild Ban Remove Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#remove-guild-ban
+     */
+    removeGuildBan(guild_id: snowflake, user_id: snowflake): Promise<void>
+  }
+}
+
+Internal.define({
+  '/guilds/{guild.id}/bans': {
+    GET: 'getGuildBans',
+  },
+  '/guilds/{guild.id}/bans/{user.id}': {
+    GET: 'getGuildBan',
+    PUT: 'createGuildBan',
+    DELETE: 'removeGuildBan',
+  },
+})