feat: onboarding mode, edit method, audit log events

Author: almeidx

packages/discord.js/src/structures/Guild.js

@@ -871,6 +871,70 @@ class Guild extends AnonymousGuild {
     return this.client.actions.GuildUpdate.handle(data).updated;
   }
 
+  /**
+   * Options used to edit the guild onboarding.
+   * @typedef {Object} GuildOnboardingEditOptions
+   * @property {GuildOnboardingPromptData[]} prompts The prompts shown during onboarding
+   * and in customize community
+   * @property {ChannelResolvable[]} defaultChannels The channels that new members get opted into automatically
+   * @property {boolean} enabled Whether the onboarding is enabled
+   * @property {GuildOnboardingMode} mode The mode to edit the guild onboarding with
+   * @property {string} [reason] The reason for editing the guild onboarding
+   */
+
+  /**
+   * Data for editing a guild onboarding prompt.
+   * @typedef {Object} GuildOnboardingPromptData
+   * @property {string} title The title for the prompt
+   * @property {boolean} singleSelect Whether users are limited to selecting one option for the prompt
+   * @property {boolean} required Whether the prompt is required before a user completes the onboarding flow
+   * @property {boolean} inOnboarding Whether the prompt is present in the onboarding flow
+   * @property {GuildOnboardingPromptType} type The type of the prompt
+   * @property {GuildOnboardingPromptOptionData[]} options The options available within the prompt
+   */
+
+  /**
+   * Data for editing a guild onboarding prompt option.
+   * @typedef {Object} GuildOnboardingPromptOptionData
+   * @property {ChannelResolvable[]} channels The channels a member is added to when the option is selected
+   * @property {RoleResolvable[]} roles The roles assigned to a member when the option is selected
+   * @property {string} title The title of the option
+   * @property {string} description The description of the option
+   * @property {EmojiIdentifierResolvable} emoji The emoji of the option
+   */
+
+  /**
+   * Edits the guild onboarding data for this guild.
+   * @param {GuildOnboardingEditOptions} options The options to provide
+   * @returns {Promise<GuildOnboarding>}
+   */
+  async editOnboarding(options) {
+    const newData = await this.client.rest.put(`/guilds/${this.id}/onboarding`, {
+      body: {
+        prompts: options.prompts.map(prompt => ({
+          title: prompt.title,
+          single_select: prompt.singleSelect,
+          required: prompt.required,
+          in_onboarding: prompt.inOnboarding,
+          type: prompt.type,
+          options: prompt.options.map(option => ({
+            channel_ids: option.channels.map(c => this.channels.resolveId(c)),
+            role_ids: option.roles.map(r => this.roles.resolveId(r)),
+            title: option.title,
+            description: option.description,
+            emoji: this.emojis.resolveIdentifier(option.emoji),
+          })),
+        })),
+        default_channel_ids: options.defaultChannels.map(c => this.channels.resolveId(c)),
+        enabled: options.enabled,
+        mode: options.mode,
+      },
+      reason: options.reason,
+    });
+
+    return new GuildOnboarding(this.client, newData);
+  }
+
   /**
    * Welcome channel data
    * @typedef {Object} WelcomeChannelData

packages/discord.js/src/structures/GuildAuditLogsEntry.js

@@ -3,6 +3,7 @@
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const { AuditLogOptionsType, AuditLogEvent } = require('discord-api-types/v10');
 const AutoModerationRule = require('./AutoModerationRule');
+const { GuildOnboardingPrompt } = require('./GuildOnboardingPrompt.js');
 const { GuildScheduledEvent } = require('./GuildScheduledEvent');
 const Integration = require('./Integration');
 const Invite = require('./Invite');
@@ -29,6 +30,8 @@ const Targets = {
   Thread: 'Thread',
   ApplicationCommand: 'ApplicationCommand',
   AutoModeration: 'AutoModeration',
+  GuildOnboarding: 'GuildOnboarding',
+  GuildOnboardingPrompt: 'GuildOnboardingPrompt',
   Unknown: 'Unknown',
 };
 
@@ -49,10 +52,11 @@ const Targets = {
  * * A thread
  * * An application command
  * * An auto moderation rule
+ * * A guild onboarding prompt
  * * An object with an id key if target was deleted or fake entity
  * * An object where the keys represent either the new value or the old value
  * @typedef {?(Object|Guild|BaseChannel|User|Role|Invite|Webhook|GuildEmoji|Message|Integration|StageInstance|Sticker|
- * GuildScheduledEvent|ApplicationCommand|AutoModerationRule)} AuditLogEntryTarget
+ * GuildScheduledEvent|ApplicationCommand|AutoModerationRule|GuildOnboarding|GuildOnboardingPrompt)} AuditLogEntryTarget
  */
 
 /**
@@ -80,6 +84,7 @@ const Targets = {
  * * Thread
  * * GuildScheduledEvent
  * * ApplicationCommandPermission
+ * * GuildOnboardingPrompt
  * @typedef {string} AuditLogTargetType
  */
 
@@ -238,7 +243,6 @@ class GuildAuditLogsEntry {
         this.extra = {
           autoModerationRuleName: data.options.auto_moderation_rule_name,
           autoModerationRuleTriggerType: data.options.auto_moderation_rule_trigger_type,
-          channel: guild.client.channels.cache.get(data.options?.channel_id) ?? { id: data.options?.channel_id },
         };
         break;
 
@@ -391,6 +395,26 @@ class GuildAuditLogsEntry {
           ),
           guild,
         );
+    } else if (targetType === Targets.GuildOnboardingPrompt) {
+      this.target = new GuildOnboardingPrompt(
+        guild.client,
+        this.changes.reduce(
+          (o, c) => {
+            o[c.key] = c.new ?? c.old;
+            return o;
+          },
+          { id: data.target_id },
+        ),
+        guild.id,
+      );
+    } else if (targetType === Targets.GuildOnboarding) {
+      this.target = this.changes.reduce(
+        (o, c) => {
+          o[c.key] = c.new ?? c.old;
+          return o;
+        },
+        { id: data.target_id },
+      );
     } else if (data.target_id) {
       this.target = guild[`${targetType.toLowerCase()}s`]?.cache.get(data.target_id) ?? { id: data.target_id };
     }
@@ -417,6 +441,8 @@ class GuildAuditLogsEntry {
     if (target < 120) return Targets.Thread;
     if (target < 130) return Targets.ApplicationCommand;
     if (target >= 140 && target < 150) return Targets.AutoModeration;
+    if (target >= 163 && target <= 165) return Targets.GuildOnboardingPrompt;
+    if (target >= 160 && target < 170) return Targets.GuildOnboarding;
     return Targets.Unknown;
   }
 
@@ -444,6 +470,10 @@ class GuildAuditLogsEntry {
         AuditLogEvent.ThreadCreate,
         AuditLogEvent.AutoModerationRuleCreate,
         AuditLogEvent.AutoModerationBlockMessage,
+        // AuditLogEvent.OnboardingQuestionCreate,
+        // AuditLogEvent.OnboardingCreate,
+        163,
+        166,
       ].includes(action)
     ) {
       return 'Create';
@@ -470,6 +500,8 @@ class GuildAuditLogsEntry {
         AuditLogEvent.GuildScheduledEventDelete,
         AuditLogEvent.ThreadDelete,
         AuditLogEvent.AutoModerationRuleDelete,
+        // AuditLogEvent.OnboardingQuestionDelete,
+        165,
       ].includes(action)
     ) {
       return 'Delete';
@@ -494,6 +526,10 @@ class GuildAuditLogsEntry {
         AuditLogEvent.ThreadUpdate,
         AuditLogEvent.ApplicationCommandPermissionUpdate,
         AuditLogEvent.AutoModerationRuleUpdate,
+        // AuditLogEvent.OnboardingQuestionUpdate,
+        // AuditLogEvent.OnboardingUpdate,
+        164,
+        167,
       ].includes(action)
     ) {
       return 'Update';

packages/discord.js/src/structures/GuildOnboarding.js

@@ -43,6 +43,12 @@ class GuildOnboarding extends Base {
      * @type {boolean}
      */
     this.enabled = data.enabled;
+
+    /**
+     * The mode of this onboarding
+     * @type {GuildOnboardingMode}
+     */
+    this.mode = data.mode;
   }
 
   /**

packages/discord.js/src/util/APITypes.js

@@ -310,6 +310,11 @@
  * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/GuildNSFWLevel}
  */
 
+/**
+ * @external GuildOnboardingMode
+ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/GuildOnboardingMode}
+ */
+
 /**
  * @external GuildOnboardingPromptType
  * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/GuildOnboardingPromptType}

packages/discord.js/typings/index.d.ts

@@ -1350,6 +1350,7 @@ export class Guild extends AnonymousGuild {
   public delete(): Promise<Guild>;
   public discoverySplashURL(options?: ImageURLOptions): string | null;
   public edit(options: GuildEditOptions): Promise<Guild>;
+  public editOnboarding(options: GuildOnboardingEditOptions): Promise<GuildOnboarding>;
   public editWelcomeScreen(options: WelcomeScreenEditOptions): Promise<WelcomeScreen>;
   public equals(guild: Guild): boolean;
   public fetchAuditLogs<T extends GuildAuditLogsResolvable = null>(
@@ -1574,6 +1575,7 @@ export class GuildOnboarding extends Base {
   public prompts: Collection<Snowflake, GuildOnboardingPrompt>;
   public defaultChannels: Collection<Snowflake, GuildChannel>;
   public enabled: boolean;
+  public mode: any;
 }
 
 export class GuildOnboardingPrompt extends Base {
@@ -5349,6 +5351,11 @@ interface GuildAuditLogsTypes {
   [AuditLogEvent.AutoModerationBlockMessage]: ['AutoModerationRule', 'Create'];
   [AuditLogEvent.AutoModerationFlagToChannel]: ['AutoModerationRule', 'Create'];
   [AuditLogEvent.AutoModerationUserCommunicationDisabled]: ['AutoModerationRule', 'Create'];
+  [163]: ['GuildOnboardingPrompt', 'Create'];
+  [164]: ['GuildOnboardingPrompt', 'Update'];
+  [165]: ['GuildOnboardingPrompt', 'Delete'];
+  [166]: ['GuildOnboarding', 'Create'];
+  [167]: ['GuildOnboarding', 'Update'];
 }
 
 export type GuildAuditLogsActionType = GuildAuditLogsTypes[keyof GuildAuditLogsTypes][1] | 'All';
@@ -5411,6 +5418,7 @@ export interface GuildAuditLogsEntryTargetField<TActionType extends GuildAuditLo
   GuildScheduledEvent: GuildScheduledEvent;
   ApplicationCommand: ApplicationCommand | { id: Snowflake };
   AutoModerationRule: AutoModerationRule;
+  GuildOnboardingPrompt: GuildOnboardingPrompt;
 }
 
 export interface GuildAuditLogsFetchOptions<T extends GuildAuditLogsResolvable> {
@@ -5674,6 +5682,31 @@ export type GuildTemplateResolvable = string;
 
 export type GuildVoiceChannelResolvable = VoiceBasedChannel | Snowflake;
 
+export interface GuildOnboardingEditOptions {
+  prompts: GuildOnboardingPromptData[];
+  defaultChannels: ChannelResolvable[];
+  enabled: boolean;
+  mode: any;
+  reason?: string;
+}
+
+export interface GuildOnboardingPromptData {
+  title: string;
+  singleSelect: boolean;
+  required: boolean;
+  inOnboarding: boolean;
+  type: any;
+  options: GuildOnboardingPromptOptionData[];
+}
+
+export interface GuildOnboardingPromptOptionData {
+  channels: ChannelResolvable[];
+  roles: RoleResolvable[];
+  title: string;
+  description: string;
+  emoji: EmojiIdentifierResolvable;
+}
+
 export interface GuildOnboardingPromptOptionEmoji {
   id: Snowflake | null;
   name: string | null;