fix(GuildScheduledEvent): Use if...else pattern and handle partials

backport #9802 djs

src/structures/GuildScheduledEvent.js

@@ -54,11 +54,16 @@ class GuildScheduledEvent extends Base {
       this.creatorId ??= null;
     }
 
+    if ('name' in data) {
       /**
        * The name of the guild scheduled event
-     * @type {string}
+       * @type {?string}
        */
       this.name = data.name;
+    } else {
+      // Only if partial.
+      this.name ??= null;
+    }
 
     if ('description' in data) {
       /**
@@ -70,37 +75,60 @@ class GuildScheduledEvent extends Base {
       this.description ??= null;
     }
 
+    if ('scheduled_start_time' in data) {
       /**
        * The timestamp the guild scheduled event will start at
        * <info>This can be potentially `null` only when it's an {@link AuditLogEntryTarget}</info>
        * @type {?number}
        */
-    this.scheduledStartTimestamp = data.scheduled_start_time ? Date.parse(data.scheduled_start_time) : null;
+      this.scheduledStartTimestamp = Date.parse(data.scheduled_start_time);
+    } else {
+      this.scheduledStartTimestamp ??= null;
+    }
 
+    if ('scheduled_end_time' in data) {
       /**
-     * The timestamp the guild scheduled event will end at,
+       * The timestamp the guild scheduled event will end at
        * or `null` if the event does not have a scheduled time to end
        * @type {?number}
        */
       this.scheduledEndTimestamp = data.scheduled_end_time ? Date.parse(data.scheduled_end_time) : null;
+    } else {
+      this.scheduledEndTimestamp ??= null;
+    }
 
+    if ('privacy_level' in data) {
       /**
        * The privacy level of the guild scheduled event
        * @type {PrivacyLevel}
        */
       this.privacyLevel = GuildScheduledEventPrivacyLevels[data.privacy_level];
+    } else {
+      // Only if partial.
+      this.privacyLevel ??= null;
+    }
 
+    if ('status' in data) {
       /**
        * The status of the guild scheduled event
        * @type {GuildScheduledEventStatus}
        */
       this.status = GuildScheduledEventStatuses[data.status];
+    } else {
+      // Only if partial.
+      this.status ??= null;
+    }
 
+    if ('entity_type' in data) {
       /**
        * The type of hosting entity associated with the scheduled event
        * @type {GuildScheduledEventEntityType}
        */
       this.entityType = GuildScheduledEventEntityTypes[data.entity_type];
+    } else {
+      // Only if partial.
+      this.entityType ??= null;
+    }
 
     if ('entity_id' in data) {
       /**
@@ -177,6 +205,15 @@ class GuildScheduledEvent extends Base {
     return this.image && this.client.rest.cdn.guildScheduledEventCover(this.id, this.image, format, size);
   }
 
+  /**
+   * Whether this guild scheduled event is partial.
+   * @type {boolean}
+   * @readonly
+   */
+  get partial() {
+    return this.name === null;
+  }
+
   /**
    * The timestamp the guild scheduled event was created at
    * @type {number}
@@ -241,6 +278,15 @@ class GuildScheduledEvent extends Base {
     return Endpoints.scheduledEvent(this.client.options.http.scheduledEvent, this.guildId, this.id);
   }
 
+  /**
+   * Fetches this guild scheduled event.
+   * @param {boolean} [force=true] Whether to skip the cache check and request the API
+   * @returns {Promise<GuildScheduledEvent>}
+   */
+  fetch(force = true) {
+    return this.guild.scheduledEvents.fetch({ guildScheduledEvent: this.id, force });
+  }
+
   /**
    * Options used to create an invite URL to a {@link GuildScheduledEvent}
    * @typedef {CreateInviteOptions} CreateGuildScheduledEventInviteURLOptions

typings/index.d.ts

@@ -1697,11 +1697,13 @@ export class GuildScheduledEvent<S extends GuildScheduledEventStatus = GuildSche
   public readonly guild: Guild | null;
   public readonly url: string;
   public readonly image: string | null;
+  public readonly partial: false;
   public coverImageURL(options?: StaticImageURLOptions): string | null;
   public createInviteURL(options?: CreateGuildScheduledEventInviteURLOptions): Promise<string>;
   public edit<T extends GuildScheduledEventSetStatusArg<S>>(
     options: GuildScheduledEventEditOptions<S, T>,
   ): Promise<GuildScheduledEvent<T>>;
+  public fetch(force?: boolean): Promise<GuildScheduledEvent<S>>;
   public delete(): Promise<GuildScheduledEvent<S>>;
   public setName(name: string, reason?: string): Promise<GuildScheduledEvent<S>>;
   public setScheduledStartTime(scheduledStartTime: DateResolvable, reason?: string): Promise<GuildScheduledEvent<S>>;
@@ -4650,7 +4652,14 @@ export type AllowedImageFormat = 'webp' | 'png' | 'jpg' | 'jpeg';
 
 export type AllowedImageSize = 16 | 32 | 56 | 64 | 96 | 128 | 256 | 300 | 512 | 600 | 1024 | 2048 | 4096;
 
-export type AllowedPartial = User | Channel | GuildMember | Message | MessageReaction;
+export type AllowedPartial =
+  | User
+  | Channel
+  | GuildMember
+  | Message
+  | MessageReaction
+  | GuildScheduledEvent
+  | ThreadMember;
 
 export type AllowedThreadTypeForNewsChannel = 'GUILD_NEWS_THREAD' | 10;
 
@@ -5482,10 +5491,13 @@ export interface ClientEvents extends BaseClientEvents {
   stickerDelete: [sticker: Sticker];
   stickerUpdate: [oldSticker: Sticker, newSticker: Sticker];
   guildScheduledEventCreate: [guildScheduledEvent: GuildScheduledEvent];
-  guildScheduledEventUpdate: [oldGuildScheduledEvent: GuildScheduledEvent, newGuildScheduledEvent: GuildScheduledEvent];
-  guildScheduledEventDelete: [guildScheduledEvent: GuildScheduledEvent];
-  guildScheduledEventUserAdd: [guildScheduledEvent: GuildScheduledEvent, user: User];
-  guildScheduledEventUserRemove: [guildScheduledEvent: GuildScheduledEvent, user: User];
+  guildScheduledEventUpdate: [
+    oldGuildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent | null,
+    newGuildScheduledEvent: GuildScheduledEvent,
+  ];
+  guildScheduledEventDelete: [guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent];
+  guildScheduledEventUserAdd: [guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent, user: User];
+  guildScheduledEventUserRemove: [guildScheduledEvent: GuildScheduledEvent, | PartialGuildScheduledEvent  user: User];
   guildAuditLogEntryCreate: [auditLogEntry: GuildAuditLogsEntry, guild: Guild];
   unhandledPacket: [packet: { t?: string; d: any }, shard: number];
   relationshipAdd: [userId: Snowflake, shouldNotify: boolean];
@@ -7143,6 +7155,9 @@ export interface PartialMessage
 
 export interface PartialMessageReaction extends Partialize<MessageReaction, 'count'> {}
 
+export interface PartialGuildScheduledEvent
+  extends Partialize<GuildScheduledEvent, 'userCount', 'status' | 'privacyLevel' | 'name' | 'entityType'> {}
+
 export interface PartialOverwriteData {
   id: Snowflake | number;
   type?: OverwriteType;