feat: v13 safety alerts channel and mention raid protection

#9073 djs

src/managers/AutoModerationRuleManager.js

@@ -58,6 +58,7 @@ class AutoModerationRuleManager extends CachedManager {
    * @property {string[]} [allowList] The substrings that will be exempt from triggering
    * {@link AutoModerationRuleTriggerType.KEYWORD} and {@link AutoModerationRuleTriggerType.KEYWORD_PRESET}
    * @property {?number} [mentionTotalLimit] The total number of role & user mentions allowed per message
+   * @property {boolean} [mentionRaidProtectionEnabled] Whether to automatically detect mention raids
    */
 
   /**
@@ -125,6 +126,7 @@ class AutoModerationRuleManager extends CachedManager {
           ),
           allow_list: triggerMetadata.allowList,
           mention_total_limit: triggerMetadata.mentionTotalLimit,
+          mention_raid_protection_enabled: triggerMetadata.mentionRaidProtectionEnabled,
         },
         actions: actions.map(action => ({
           type: typeof action.type === 'number' ? action.type : AutoModerationActionTypes[action.type],
@@ -186,6 +188,7 @@ class AutoModerationRuleManager extends CachedManager {
             ),
             allow_list: triggerMetadata.allowList,
             mention_total_limit: triggerMetadata.mentionTotalLimit,
+            mention_raid_protection_enabled: triggerMetadata.mentionRaidProtectionEnabled,
           },
           actions: actions?.map(action => ({
             type: typeof action.type === 'number' ? action.type : AutoModerationActionTypes[action.type],

src/structures/AutoModerationRule.js

@@ -73,6 +73,7 @@ class AutoModerationRule extends Base {
        * @property {string[]} allowList The substrings that will be exempt from triggering
        * {@link AutoModerationRuleTriggerTypes.KEYWORD} and {@link AutoModerationRuleTriggerTypes.KEYWORD_PRESET}
        * @property {?number} mentionTotalLimit The total number of role & user mentions allowed per message
+       * @property {boolean} mentionRaidProtectionEnabled Whether mention raid protection is enabled
        */
 
       /**
@@ -85,6 +86,7 @@ class AutoModerationRule extends Base {
         presets: data.trigger_metadata.presets?.map(preset => AutoModerationRuleKeywordPresetTypes[preset]) ?? [],
         allowList: data.trigger_metadata.allow_list ?? [],
         mentionTotalLimit: data.trigger_metadata.mention_total_limit ?? null,
+        mentionRaidProtectionEnabled: data.trigger_metadata.mention_raid_protection_enabled ?? false,
       };
     }
 
@@ -234,6 +236,17 @@ class AutoModerationRule extends Base {
     return this.edit({ triggerMetadata: { mentionTotalLimit }, reason });
   }
 
+  /**
+   * Sets whether to enable mention raid protection for this auto moderation rule.
+   * @param {boolean} mentionRaidProtectionEnabled
+   * Whether to enable mention raid protection for this auto moderation rule
+   * @param {string} [reason] The reason for changing the mention raid protection of this auto moderation rule
+   * @returns {Promise<AutoModerationRule>}
+   */
+  setMentionRaidProtectionEnabled(mentionRaidProtectionEnabled, reason) {
+    return this.edit({ triggerMetadata: { ...this.triggerMetadata, mentionRaidProtectionEnabled }, reason });
+  }
+
   /**
    * Sets the actions for this auto moderation rule.
    * @param {AutoModerationActionOptions[]} actions The actions of this auto moderation rule

src/structures/Guild.js

@@ -450,6 +450,16 @@ class Guild extends AnonymousGuild {
       this.preferredLocale = data.preferred_locale;
     }
 
+    if ('safety_alerts_channel_id' in data) {
+      /**
+       * The safety alerts channel's id for the guild
+       * @type {?Snowflake}
+       */
+      this.safetyAlertsChannelId = data.safety_alerts_channel_id;
+    } else {
+      this.safetyAlertsChannelId ??= null;
+    }
+
     if (data.channels) {
       this.channels.cache.clear();
       for (const rawChannel of data.channels) {
@@ -585,6 +595,15 @@ class Guild extends AnonymousGuild {
     return this.client.channels.resolve(this.systemChannelId);
   }
 
+  /**
+   * Safety alerts channel for this guild
+   * @type {?TextChannel}
+   * @readonly
+   */
+  get safetyAlertsChannel() {
+    return this.client.channels.resolve(this.safetyAlertsChannelId);
+  }
+
   /**
    * Widget channel for this guild.
    * @type {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel)}
@@ -877,6 +896,7 @@ class Guild extends AnonymousGuild {
    * @property {?TextChannelResolvable} [rulesChannel] The rules channel of the guild
    * @property {?TextChannelResolvable} [publicUpdatesChannel] The community updates channel of the guild
    * @property {?string} [preferredLocale] The preferred locale of the guild
+   * @property {?TextChannelResolvable} [safetyAlertsChannel] The safety alerts channel of the guild
    * @property {boolean} [premiumProgressBarEnabled] Whether the guild's premium progress bar is enabled
    * @property {?string} [description] The discovery description of the guild
    * @property {Features[]} [features] The features of the guild
@@ -966,6 +986,9 @@ class Guild extends AnonymousGuild {
       _data.description = data.description;
     }
     if (typeof data.preferredLocale !== 'undefined') _data.preferred_locale = data.preferredLocale;
+    if (typeof data.safetyAlertsChannel !== 'undefined') {
+      _data.safety_alerts_channel_id = this.client.channels.resolveId(data.safetyAlertsChannel);
+    }
     if ('premiumProgressBarEnabled' in data) {
       _data.premium_progress_bar_enabled = data.premiumProgressBarEnabled;
     }
@@ -1311,6 +1334,21 @@ class Guild extends AnonymousGuild {
     return this.edit({ preferredLocale }, reason);
   }
 
+  /**
+   * Edits the safety alerts channel of the guild.
+   * @param {?TextChannelResolvable} safetyAlertsChannel The new safety alerts channel
+   * @param {string} [reason] Reason for changing the guild's safety alerts channel
+   * @returns {Promise<Guild>}
+   * @example
+   * // Edit the guild safety alerts channel
+   * guild.setSafetyAlertsChannel(channel)
+   *  .then(updated => console.log(`Updated guild safety alerts channel to ${guild.safetyAlertsChannel.name}`))
+   *  .catch(console.error);
+   */
+  setSafetyAlertsChannel(safetyAlertsChannel, reason) {
+    return this.edit({ safetyAlertsChannel }, reason);
+  }
+
   /**
    * Edits the enabled state of the guild's premium progress bar.
    * @param {boolean} [enabled=true] The new enabled state of the guild's premium progress bar

typings/index.d.ts

@@ -1363,6 +1363,8 @@ export class Guild extends AnonymousGuild {
   public roles: RoleManager;
   public readonly rulesChannel: TextChannel | null;
   public rulesChannelId: Snowflake | null;
+  public readonly safetyAlertsChannel: TextChannel | null;
+  public safetyAlertsChannelId: Snowflake | null;
   public scheduledEvents: GuildScheduledEventManager;
   public readonly shard: WebSocketShard;
   public shardId: number;
@@ -1426,6 +1428,7 @@ export class Guild extends AnonymousGuild {
   /** @deprecated Use {@link RoleManager.setPositions} instead */
   public setRolePositions(rolePositions: readonly RolePosition[]): Promise<Guild>;
   public setRulesChannel(rulesChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>;
+  public setSafetyAlertsChannel(safetyAlertsChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>;
   public setSplash(splash: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>;
   public setSystemChannel(systemChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>;
   public setSystemChannelFlags(systemChannelFlags: SystemChannelFlagsResolvable, reason?: string): Promise<Guild>;
@@ -5149,6 +5152,10 @@ export class AutoModerationRule extends Base {
   public setRegexPatterns(regexPatterns: string[], reason?: string): Promise<AutoModerationRule>;
   public setPresets(presets: AutoModerationRuleKeywordPresetType[], reason?: string): Promise<AutoModerationRule>;
   public setAllowList(allowList: string[], reason?: string): Promise<AutoModerationRule>;
+  public setMentionRaidProtectionEnabled(
+    mentionRaidProtectionEnabled: boolean,
+    reason?: string,
+  ): Promise<AutoModerationRule>;
   public setMentionTotalLimit(mentionTotalLimit: number, reason?: string): Promise<AutoModerationRule>;
   public setActions(actions: AutoModerationActionOptions[], reason?: string): Promise<AutoModerationRule>;
   public setEnabled(enabled?: boolean, reason?: string): Promise<AutoModerationRule>;
@@ -5229,6 +5236,7 @@ export interface AutoModerationTriggerMetadata {
   regexPatterns: string[];
   presets: (AutoModerationRuleKeywordPresetType | AutoModerationRuleKeywordPresetTypes)[];
   allowList: string[];
+  mentionRaidProtectionEnabled: boolean;
   mentionTotalLimit: number | null;
 }
 
@@ -6120,6 +6128,7 @@ export interface GuildEditData {
   rulesChannel?: TextChannelResolvable | null;
   publicUpdatesChannel?: TextChannelResolvable | null;
   preferredLocale?: string | null;
+  safetyAlertsChannel?: TextChannelResolvable | null;
   premiumProgressBarEnabled?: boolean;
   description?: string | null;
   features?: GuildFeatures[];