@discordjs/structures 0.2.0-dev.1769385723-323d8e757 → 0.2.0-dev.1769601701-c71228aab

package/dist/index.mjs

@@ -12,6 +12,9 @@ var kEditedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.editedTimestam
 var kArchiveTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.archiveTimestamp");
 var kStartsTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.startsTimestamp");
 var kEndsTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.endsTimestamp");
+var kCurrentPeriodStartTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.currentPeriodStartTimestamp");
+var kCurrentPeriodEndTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.currentPeriodEndTimestamp");
+var kCanceledTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.canceledTimestamp");
 var kAllow = /* @__PURE__ */ Symbol.for("djs.structures.allow");
 var kDeny = /* @__PURE__ */ Symbol.for("djs.structures.deny");
 var kBurstColors = /* @__PURE__ */ Symbol.for("djs.structures.burstColors");
@@ -134,7 +137,9 @@ var AutoModerationAction = class extends Structure {
     super(data);
   }
   /**
-   * The {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types | action type}
+   * The action type
+   *
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types}
    */
   get type() {
     return this[kData].type;
@@ -226,13 +231,17 @@ var AutoModerationRule = class extends Structure {
     return this[kData].creator_id;
   }
   /**
-   * The rule {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types | event type}
+   * The rule event type
+   *
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types}
    */
   get eventType() {
     return this[kData].event_type;
   }
   /**
-   * The rule {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types | trigger type}
+   * The rule trigger type
+   *
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types}
    */
   get triggerType() {
     return this[kData].trigger_type;
@@ -603,6 +612,21 @@ var PermissionsBitField = class extends BitField {
   }
 };
 
+// src/bitfields/SKUFlagsBitField.ts
+import { SKUFlags } from "discord-api-types/v10";
+var SKUFlagsBitField = class extends BitField {
+  static {
+    __name(this, "SKUFlagsBitField");
+  }
+  /**
+   * Numeric SKU flags.
+   */
+  static Flags = SKUFlags;
+  toJSON() {
+    return super.toJSON(true);
+  }
+};
+
 // src/channels/mixins/AppliedTagsMixin.ts
 var AppliedTagsMixin = class {
   static {
@@ -1187,6 +1211,14 @@ function isIdSet(id) {
   return typeof id === "string" || typeof id === "bigint";
 }
 __name(isIdSet, "isIdSet");
+function hasProperty(data, fieldName) {
+  return fieldName in data;
+}
+__name(hasProperty, "hasProperty");
+function isFieldSet(data, fieldName, type) {
+  return hasProperty(data, fieldName) && typeof data[fieldName] === type;
+}
+__name(isFieldSet, "isFieldSet");
 
 // src/channels/Channel.ts
 var Channel = class extends Structure {
@@ -1234,8 +1266,7 @@ var Channel = class extends Structure {
    * to null, respecting Omit behaviors
    */
   get flags() {
-    const flags = "flags" in this[kData] && typeof this[kData].flags === "number" ? this[kData].flags : null;
-    return flags ? new ChannelFlagsBitField(flags) : null;
+    return isFieldSet(this[kData], "flags", "number") ? new ChannelFlagsBitField(this[kData].flags) : null;
   }
   /**
    * The timestamp the channel was created at
@@ -3283,8 +3314,7 @@ var Attachment = class extends Structure {
    * Attachment flags combined as a bitfield
    */
   get flags() {
-    const flags = this[kData].flags;
-    return flags ? new AttachmentFlagsBitField(this[kData].flags) : null;
+    return isFieldSet(this[kData], "flags", "number") ? new AttachmentFlagsBitField(this[kData].flags) : null;
   }
 };
 
@@ -3416,8 +3446,7 @@ var Message = class extends Structure {
    * The flags of this message as a bit field
    */
   get flags() {
-    const flags = this[kData].flags;
-    return flags ? new MessageFlagsBitField(this[kData].flags) : null;
+    return isFieldSet(this[kData], "flags", "number") ? new MessageFlagsBitField(this[kData].flags) : null;
   }
   /**
    * The nonce used when sending this message.
@@ -3948,7 +3977,207 @@ var PollResults = class extends Structure {
   }
 };
 
+// src/skus/SKU.ts
+var SKU = class extends Structure {
+  static {
+    __name(this, "SKU");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each SKU
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the SKU
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * Id of the SKU
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * Type of SKU
+   *
+   * @see {@link https://discord.com/developers/docs/resources/sku#sku-object-sku-types}
+   */
+  get type() {
+    return this[kData].type;
+  }
+  /**
+   * Id of the parent application
+   */
+  get applicationId() {
+    return this[kData].application_id;
+  }
+  /**
+   * Customer-facing name of your premium offering
+   */
+  get name() {
+    return this[kData].name;
+  }
+  /**
+   * System-generated URL slug based on the SKU's name
+   */
+  get slug() {
+    return this[kData].slug;
+  }
+  /**
+   * SKU flags combined as a bitfield
+   */
+  get flags() {
+    return isFieldSet(this[kData], "flags", "number") ? new SKUFlagsBitField(this[kData].flags) : null;
+  }
+};
+
+// src/soundboards/SoundboardSound.ts
+import { DiscordSnowflake as DiscordSnowflake5 } from "@sapphire/snowflake";
+var SoundboardSound = class extends Structure {
+  static {
+    __name(this, "SoundboardSound");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each soundboard sound.
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the soundboard sound
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * The name of this sound
+   */
+  get name() {
+    return this[kData].name;
+  }
+  /**
+   * The id of this sound
+   */
+  get soundId() {
+    return this[kData].sound_id;
+  }
+  /**
+   * The volume of this sound, from 0 to 1
+   */
+  get volume() {
+    return this[kData].volume;
+  }
+  /**
+   * The id of this sound's custom emoji
+   */
+  get emojiId() {
+    return this[kData].emoji_id;
+  }
+  /**
+   * The unicode character of this sound's standard emoji
+   */
+  get emojiName() {
+    return this[kData].emoji_name;
+  }
+  /**
+   * The id of the guild this sound is in
+   */
+  get guildId() {
+    return this[kData].guild_id;
+  }
+  /**
+   * Whether this sound can be used, may be false due to loss of server boosts
+   */
+  get available() {
+    return this[kData].available;
+  }
+  /**
+   * The timestamp this sound was created at
+   *
+   * @remarks only available for guild soundboard sounds
+   */
+  get createdTimestamp() {
+    return isIdSet(this[kData].sound_id) && isIdSet(this[kData].guild_id) ? DiscordSnowflake5.timestampFrom(this[kData].sound_id) : null;
+  }
+  /**
+   * The time this sound was created at
+   *
+   * @remarks only available for guild soundboard sounds
+   */
+  get createdAt() {
+    const createdTimestamp = this.createdTimestamp;
+    return createdTimestamp ? new Date(createdTimestamp) : null;
+  }
+};
+
+// src/stageInstances/StageInstance.ts
+import { DiscordSnowflake as DiscordSnowflake6 } from "@sapphire/snowflake";
+var StageInstance = class extends Structure {
+  static {
+    __name(this, "StageInstance");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each stage instance
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the stage instance
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * The stage instance's id
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * The guild id of the associated stage channel
+   */
+  get guildId() {
+    return this[kData].guild_id;
+  }
+  /**
+   * The id of the associated stage channel
+   */
+  get channelId() {
+    return this[kData].channel_id;
+  }
+  /**
+   * The topic of the stage instance (1-120 characters)
+   */
+  get topic() {
+    return this[kData].topic;
+  }
+  /**
+   * The privacy level of the stage instance
+   */
+  get privacyLevel() {
+    return this[kData].privacy_level;
+  }
+  /**
+   * The id of the scheduled event for this stage instance
+   */
+  get guildScheduledEventId() {
+    return this[kData].guild_scheduled_event_id;
+  }
+  /**
+   * The timestamp the stage instance was created at
+   */
+  get createdTimestamp() {
+    return isIdSet(this.id) ? DiscordSnowflake6.timestampFrom(this.id) : null;
+  }
+  /**
+   * The time the stage instance was created at
+   */
+  get createdAt() {
+    const createdTimestamp = this.createdTimestamp;
+    return createdTimestamp ? new Date(createdTimestamp) : null;
+  }
+};
+
 // src/stickers/Sticker.ts
+import { DiscordSnowflake as DiscordSnowflake7 } from "@sapphire/snowflake";
 var Sticker = class extends Structure {
   static {
     __name(this, "Sticker");
@@ -4005,6 +4234,182 @@ var Sticker = class extends Structure {
   get type() {
     return this[kData].type;
   }
+  /**
+   * The timestamp the sticker was created at
+   */
+  get createdTimestamp() {
+    return isIdSet(this.id) ? DiscordSnowflake7.timestampFrom(this.id) : null;
+  }
+  /**
+   * The time the sticker was created at
+   */
+  get createdAt() {
+    const createdTimestamp = this.createdTimestamp;
+    return createdTimestamp ? new Date(createdTimestamp) : null;
+  }
+};
+
+// src/stickers/StickerPack.ts
+import { DiscordSnowflake as DiscordSnowflake8 } from "@sapphire/snowflake";
+var StickerPack = class extends Structure {
+  static {
+    __name(this, "StickerPack");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each sticker pack
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the sticker pack
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * The id of the sticker pack
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * The name of the sticker pack
+   */
+  get name() {
+    return this[kData].name;
+  }
+  /**
+   * The id of the pack's SKU
+   */
+  get skuId() {
+    return this[kData].sku_id;
+  }
+  /**
+   * The id of a sticker in the pack which is shown as the pack's icon
+   */
+  get coverStickerId() {
+    return this[kData].cover_sticker_id;
+  }
+  /**
+   * The description of the sticker pack
+   */
+  get description() {
+    return this[kData].description;
+  }
+  /**
+   * The id of the sticker pack's banner image
+   *
+   * @see {@link https://discord.com/developers/docs/reference#image-formatting}
+   */
+  get bannerAssetId() {
+    return this[kData].banner_asset_id;
+  }
+  /**
+   * The timestamp the sticker pack was created at
+   */
+  get createdTimestamp() {
+    return isIdSet(this.id) ? DiscordSnowflake8.timestampFrom(this.id) : null;
+  }
+  /**
+   * The time the sticker pack was created at
+   */
+  get createdAt() {
+    const createdTimestamp = this.createdTimestamp;
+    return createdTimestamp ? new Date(createdTimestamp) : null;
+  }
+};
+
+// src/teams/Team.ts
+import { DiscordSnowflake as DiscordSnowflake9 } from "@sapphire/snowflake";
+var Team = class extends Structure {
+  static {
+    __name(this, "Team");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each team.
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the team.
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * Hash of the image of the team's icon
+   */
+  get icon() {
+    return this[kData].icon;
+  }
+  /**
+   * The unique id of the team
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * Name of the team
+   */
+  get name() {
+    return this[kData].name;
+  }
+  /**
+   * User ID of the current team owner
+   */
+  get ownerUserId() {
+    return this[kData].owner_user_id;
+  }
+  /**
+   * The timestamp the team was created at
+   */
+  get createdTimestamp() {
+    return isIdSet(this.id) ? DiscordSnowflake9.timestampFrom(this.id) : null;
+  }
+  /**
+   * The time the team was created at
+   */
+  get createdAt() {
+    const createdTimestamp = this.createdTimestamp;
+    return createdTimestamp ? new Date(createdTimestamp) : null;
+  }
+};
+
+// src/teams/TeamMember.ts
+var TeamMember = class extends Structure {
+  static {
+    __name(this, "TeamMember");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each team member
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the team member
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * User's membership state on the team
+   *
+   * @see {@link https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum}
+   */
+  get membershipState() {
+    return this[kData].membership_state;
+  }
+  /**
+   * Id of the parent team of which they are a member
+   */
+  get teamId() {
+    return this[kData].team_id;
+  }
+  /**
+   * Role of the team member
+   *
+   * @see {@link https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types}
+   */
+  get role() {
+    return this[kData].role;
+  }
 };
 
 // src/users/AvatarDecorationData.ts
@@ -4037,7 +4442,7 @@ var AvatarDecorationData = class extends Structure {
 };
 
 // src/users/User.ts
-import { DiscordSnowflake as DiscordSnowflake5 } from "@sapphire/snowflake";
+import { DiscordSnowflake as DiscordSnowflake10 } from "@sapphire/snowflake";
 var User = class extends Structure {
   static {
     __name(this, "User");
@@ -4160,7 +4565,7 @@ var User = class extends Structure {
    * The timestamp the user was created at
    */
   get createdTimestamp() {
-    return isIdSet(this.id) ? DiscordSnowflake5.timestampFrom(this.id) : null;
+    return isIdSet(this.id) ? DiscordSnowflake10.timestampFrom(this.id) : null;
   }
   /**
    * The time the user was created at
@@ -4251,6 +4656,286 @@ var Connection = class extends Structure {
     return this[kData].visibility;
   }
 };
+
+// src/voice/VoiceState.ts
+var VoiceState = class extends Structure {
+  static {
+    __name(this, "VoiceState");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each voice state
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the voice state
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * The guild id this voice state is for
+   */
+  get guildId() {
+    return this[kData].guild_id;
+  }
+  /**
+   * The channel id this user is connected to
+   */
+  get channelId() {
+    return this[kData].channel_id;
+  }
+  /**
+   * The user id this voice state is for
+   */
+  get userId() {
+    return this[kData].user_id;
+  }
+  /**
+   * The session id for this voice state
+   */
+  get sessionId() {
+    return this[kData].session_id;
+  }
+  /**
+   * Whether this user is deafened by the server
+   */
+  get deaf() {
+    return this[kData].deaf;
+  }
+  /**
+   * Whether this user is muted by the server
+   */
+  get mute() {
+    return this[kData].mute;
+  }
+  /**
+   * Whether this user is locally deafened
+   */
+  get selfDeaf() {
+    return this[kData].self_deaf;
+  }
+  /**
+   * Whether this user is locally muted
+   */
+  get selfMute() {
+    return this[kData].self_mute;
+  }
+  /**
+   * Whether this user is streaming using "Go Live"
+   */
+  get selfStream() {
+    return this[kData].self_stream;
+  }
+  /**
+   * Whether this user's camera is enabled
+   */
+  get selfVideo() {
+    return this[kData].self_video;
+  }
+  /**
+   * Whether this user's permission to speak is denied
+   */
+  get suppress() {
+    return this[kData].suppress;
+  }
+  /**
+   * The time at which the user requested to speak
+   */
+  get requestToSpeakTimestamp() {
+    return this[kData].request_to_speak_timestamp;
+  }
+};
+
+// src/voice/VoiceRegion.ts
+var VoiceRegion = class extends Structure {
+  static {
+    __name(this, "VoiceRegion");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each voice region
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the voice region
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * Unique id for the region
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * Name of the region
+   */
+  get name() {
+    return this[kData].name;
+  }
+  /**
+   * `true` for a single server that is closest to the current user's client
+   */
+  get optimal() {
+    return this[kData].optimal;
+  }
+  /**
+   * Whether this is a deprecated voice region (avoid switching to these)
+   */
+  get deprecated() {
+    return this[kData].deprecated;
+  }
+  /**
+   * Whether this is a custom voice region (used for events/etc)
+   */
+  get custom() {
+    return this[kData].custom;
+  }
+};
+
+// src/subscriptions/Subscription.ts
+import { DiscordSnowflake as DiscordSnowflake11 } from "@sapphire/snowflake";
+var Subscription = class extends Structure {
+  static {
+    __name(this, "Subscription");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each subscription
+   */
+  static DataTemplate = {
+    set current_period_start(_) {
+    },
+    set current_period_end(_) {
+    },
+    set canceled_at(_) {
+    }
+  };
+  [kCurrentPeriodStartTimestamp] = null;
+  [kCurrentPeriodEndTimestamp] = null;
+  [kCanceledTimestamp] = null;
+  /**
+   * @param data - The raw data received from the API for the subscription
+   */
+  constructor(data) {
+    super(data);
+    this.optimizeData(data);
+  }
+  /**
+   * {@inheritDoc Structure.optimizeData}
+   */
+  optimizeData(data) {
+    const currentPeriodStartTimestamp = data.current_period_start;
+    const currentPeriodEndTimestamp = data.current_period_end;
+    const canceledTimestamp = data.canceled_at;
+    if (currentPeriodStartTimestamp) {
+      this[kCurrentPeriodStartTimestamp] = Date.parse(currentPeriodStartTimestamp);
+    }
+    if (currentPeriodEndTimestamp) {
+      this[kCurrentPeriodEndTimestamp] = Date.parse(currentPeriodEndTimestamp);
+    }
+    if (canceledTimestamp) {
+      this[kCanceledTimestamp] = Date.parse(canceledTimestamp);
+    }
+  }
+  /**
+   * The subscription's id
+   *
+   * @remarks The start of a subscription is determined by its id. When the subscription renews, its current period is updated.
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * Id of the user who is subscribed
+   */
+  get userId() {
+    return this[kData].user_id;
+  }
+  /**
+   * List of SKUs subscribed to
+   */
+  get skuIds() {
+    return this[kData].sku_ids;
+  }
+  /**
+   * List of entitlements granted for this subscription
+   */
+  get entitlementIds() {
+    return this[kData].entitlement_ids;
+  }
+  /**
+   * List of SKUs that this user will be subscribed to at renewal
+   */
+  get renewalSkuIds() {
+    return this[kData].renewal_sku_ids;
+  }
+  /**
+   * Timestamp of start of the current subscription period
+   */
+  get currentPeriodStartTimestamp() {
+    return this[kCurrentPeriodStartTimestamp];
+  }
+  /**
+   * The time at which the current subscription period will start
+   */
+  get currentPeriodStartAt() {
+    const startTimestamp = this.currentPeriodStartTimestamp;
+    return startTimestamp ? new Date(startTimestamp) : null;
+  }
+  /**
+   * Timestamp of end of the current subscription period
+   */
+  get currentPeriodEndTimestamp() {
+    return this[kCurrentPeriodEndTimestamp];
+  }
+  /**
+   * The time at which the current subscription period will end
+   */
+  get currentPeriodEndsAt() {
+    const endTimestamp = this.currentPeriodEndTimestamp;
+    return endTimestamp ? new Date(endTimestamp) : null;
+  }
+  /**
+   * The {@link SubscriptionStatus} of the current subscription
+   */
+  get status() {
+    return this[kData].status;
+  }
+  /**
+   * Timestamp when the subscription was canceled
+   */
+  get canceledTimestamp() {
+    return this[kCanceledTimestamp];
+  }
+  /**
+   * The time when the subscription was canceled
+   *
+   * @remarks This is populated when the {@link Subscription#status} transitions to {@link SubscriptionStatus.Ending}.
+   */
+  get canceledAt() {
+    const canceledTimestamp = this.canceledTimestamp;
+    return canceledTimestamp ? new Date(canceledTimestamp) : null;
+  }
+  /**
+   * ISO3166-1 alpha-2 country code of the payment source used to purchase the subscription. Missing unless queried with a private OAuth scope.
+   */
+  get country() {
+    return this[kData].country;
+  }
+  /**
+   * The timestamp the subscription was created at
+   */
+  get createdTimestamp() {
+    return isIdSet(this.id) ? DiscordSnowflake11.timestampFrom(this.id) : null;
+  }
+  /**
+   * The time the subscription was created at
+   */
+  get createdAt() {
+    const createdTimestamp = this.createdTimestamp;
+    return createdTimestamp ? new Date(createdTimestamp) : null;
+  }
+};
 export {
   ActionRowComponent,
   AnnouncementChannel,
@@ -4335,15 +5020,23 @@ export {
   ResolvedInteractionData,
   RoleSelectMenuComponent,
   RoleSubscriptionData,
+  SKU,
+  SKUFlagsBitField,
   SectionComponent,
   SelectMenuComponent,
   SelectMenuDefaultValue,
   SeparatorComponent,
+  SoundboardSound,
   StageChannel,
+  StageInstance,
   Sticker,
+  StickerPack,
   StringSelectMenuComponent,
   StringSelectMenuOption,
   Structure,
+  Subscription,
+  Team,
+  TeamMember,
   TextChannel,
   TextChannelMixin,
   TextDisplayComponent,
@@ -4357,6 +5050,8 @@ export {
   UserSelectMenuComponent,
   VoiceChannel,
   VoiceChannelMixin,
+  VoiceRegion,
+  VoiceState,
   dateToDiscordISOTimestamp,
   extendTemplate
 };