@ovencord/discord.js 14.16.3

package/src/structures/GuildOnboardingPrompt.ts

@@ -0,0 +1,93 @@
+import { Collection  } from '@ovencord/collection';
+import { Base  } from './Base.js';
+import { GuildOnboardingPromptOption  } from './GuildOnboardingPromptOption.js';
+
+/**
+ * Represents the data of a prompt of a guilds onboarding.
+ *
+ * @extends {Base}
+ */
+export class GuildOnboardingPrompt extends Base {
+  public client: any;
+  public guildId: any;
+  public id: any;
+  public options: any;
+  public title: any;
+  public singleSelect: any;
+  public required: any;
+  public inOnboarding: any;
+  public type: any;
+  constructor(client, data, guildId) {
+    super(client);
+
+    /**
+     * The id of the guild this onboarding prompt is from
+     *
+     * @type {Snowflake}
+     */
+    this.guildId = guildId;
+
+    /**
+     * The id of the prompt
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    /**
+     * The options available within the prompt
+     *
+     * @type {Collection<Snowflake, GuildOnboardingPromptOption>}
+     */
+    this.options = data.options.reduce(
+      (options, option) => options.set(option.id, new GuildOnboardingPromptOption(client, option, guildId)),
+      new Collection(),
+    );
+
+    /**
+     * The title of the prompt
+     *
+     * @type {string}
+     */
+    this.title = data.title;
+
+    /**
+     * Whether users are limited to selecting one option for the prompt
+     *
+     * @type {boolean}
+     */
+    this.singleSelect = data.single_select;
+
+    /**
+     * Whether the prompt is required before a user completes the onboarding flow
+     *
+     * @type {boolean}
+     */
+    this.required = data.required;
+
+    /**
+     * Whether the prompt is present in the onboarding flow.
+     * If `false`, the prompt will only appear in the Channels & Roles tab
+     *
+     * @type {boolean}
+     */
+    this.inOnboarding = data.in_onboarding;
+
+    /**
+     * The type of the prompt
+     *
+     * @type {GuildOnboardingPromptType}
+     */
+    this.type = data.type;
+  }
+
+  /**
+   * The guild this onboarding prompt is from
+   *
+   * @type {Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.cache.get(this.guildId);
+  }
+}

package/src/structures/GuildOnboardingPromptOption.ts

@@ -0,0 +1,100 @@
+import { Collection  } from '@ovencord/collection';
+import { Base  } from './Base.js';
+import { Emoji  } from './Emoji.js';
+
+/**
+ * Represents the data of an option from a prompt of a guilds onboarding.
+ *
+ * @extends {Base}
+ */
+export class GuildOnboardingPromptOption extends Base {
+  public client: any;
+  public guildId: any;
+  public id: any;
+  public channels: any;
+  public roles: any;
+  public _emoji: any;
+  public title: any;
+  public description: any;
+  constructor(client, data, guildId) {
+    super(client);
+
+    /**
+     * The id of the guild this onboarding prompt option is from
+     *
+     * @type {Snowflake}
+     */
+    this.guildId = guildId;
+
+    const guild = this.guild;
+
+    /**
+     * The id of the option
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    /**
+     * The channels a member is added to when the option is selected
+     *
+     * @type {Collection<Snowflake, GuildChannel>}
+     */
+    this.channels = data.channel_ids.reduce(
+      (channels, channelId) => channels.set(channelId, guild.channels.cache.get(channelId)),
+      new Collection(),
+    );
+
+    /**
+     * The roles assigned to a member when the option is selected
+     *
+     * @type {Collection<Snowflake, Role>}
+     */
+    this.roles = data.role_ids.reduce(
+      (roles, roleId) => roles.set(roleId, guild.roles.cache.get(roleId)),
+      new Collection(),
+    );
+
+    /**
+     * The raw emoji of the option
+     *
+     * @type {APIPartialEmoji}
+     * @private
+     */
+    this._emoji = data.emoji;
+
+    /**
+     * The title of the option
+     *
+     * @type {string}
+     */
+    this.title = data.title;
+
+    /**
+     * The description of the option
+     *
+     * @type {?string}
+     */
+    this.description = data.description;
+  }
+
+  /**
+   * The guild this onboarding prompt option is from
+   *
+   * @type {Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.cache.get(this.guildId);
+  }
+
+  /**
+   * The emoji of this onboarding prompt option
+   *
+   * @type {?(GuildEmoji|Emoji)}
+   */
+  get emoji() {
+    if (!this._emoji.id && !this._emoji.name) return null;
+    return this.guild.emojis.cache.get(this._emoji.id) ?? new Emoji(this.client, this._emoji);
+  }
+}

package/src/structures/GuildPreview.ts

@@ -0,0 +1,218 @@
+import { Collection  } from '@ovencord/collection';
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Routes  } from 'discord-api-types/v10';
+import { Base  } from './Base.js';
+import { GuildPreviewEmoji  } from './GuildPreviewEmoji.js';
+import { Sticker  } from './Sticker.js';
+
+/**
+ * Represents the data about the guild any bot can preview, connected to the specified guild.
+ *
+ * @extends {Base}
+ */
+export class GuildPreview extends Base {
+  public client: any;
+  public id: any;
+  public name: any;
+  public features: any;
+  public approximateMemberCount: any;
+  public approximatePresenceCount: any;
+  public description: any;
+  public emojis: any;
+  public stickers: any;
+  constructor(client, data) {
+    super(client);
+
+    if (!data) return;
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    /**
+     * The id of this guild
+     *
+     * @type {string}
+     */
+    this.id = data.id;
+
+    if ('name' in data) {
+      /**
+       * The name of this guild
+       *
+       * @type {string}
+       */
+      this.name = data.name;
+    }
+
+    if ('icon' in data) {
+      /**
+       * The icon of this guild
+       *
+       * @type {?string}
+       */
+      this.icon = data.icon;
+    }
+
+    if ('splash' in data) {
+      /**
+       * The splash icon of this guild
+       *
+       * @type {?string}
+       */
+      this.splash = data.splash;
+    }
+
+    if ('discovery_splash' in data) {
+      /**
+       * The discovery splash icon of this guild
+       *
+       * @type {?string}
+       */
+      this.discoverySplash = data.discovery_splash;
+    }
+
+    if ('features' in data) {
+      /**
+       * An array of enabled guild features
+       *
+       * @type {GuildFeature[]}
+       */
+      this.features = data.features;
+    }
+
+    if ('approximate_member_count' in data) {
+      /**
+       * The approximate count of members in this guild
+       *
+       * @type {number}
+       */
+      this.approximateMemberCount = data.approximate_member_count;
+    }
+
+    if ('approximate_presence_count' in data) {
+      /**
+       * The approximate count of online members in this guild
+       *
+       * @type {number}
+       */
+      this.approximatePresenceCount = data.approximate_presence_count;
+    }
+
+    if ('description' in data) {
+      /**
+       * The description for this guild
+       *
+       * @type {?string}
+       */
+      this.description = data.description;
+    } else {
+      this.description ??= null;
+    }
+
+    if (this.emojis) {
+      this.emojis.clear();
+    } else {
+      /**
+       * Collection of emojis belonging to this guild
+       *
+       * @type {Collection<Snowflake, GuildPreviewEmoji>}
+       */
+      this.emojis = new Collection();
+    }
+
+    for (const emoji of data.emojis) {
+      this.emojis.set(emoji.id, new GuildPreviewEmoji(this.client, emoji, this));
+    }
+
+    /**
+     * Collection of stickers belonging to this guild
+     *
+     * @type {Collection<Snowflake, Sticker>}
+     */
+    this.stickers = data.stickers.reduce(
+      (stickers, sticker) => stickers.set(sticker.id, new Sticker(this.client, sticker)),
+      new Collection(),
+    );
+  }
+
+  /**
+   * The timestamp this guild was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time this guild was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The URL to this guild's splash.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  splashURL(options = {}) {
+    return this.splash && this.client.rest.cdn.splash(this.id, this.splash, options);
+  }
+
+  /**
+   * The URL to this guild's discovery splash.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  discoverySplashURL(options = {}) {
+    return this.discoverySplash && this.client.rest.cdn.discoverySplash(this.id, this.discoverySplash, options);
+  }
+
+  /**
+   * The URL to this guild's icon.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  iconURL(options = {}) {
+    return this.icon && this.client.rest.cdn.icon(this.id, this.icon, options);
+  }
+
+  /**
+   * Fetches this guild.
+   *
+   * @returns {Promise<GuildPreview>}
+   */
+  async fetch() {
+    const data = await this.client.rest.get(Routes.guildPreview(this.id));
+    this._patch(data);
+    return this;
+  }
+
+  /**
+   * When concatenated with a string, this automatically returns the guild's name instead of the Guild object.
+   *
+   * @returns {string}
+   * @example
+   * // Logs: Hello from My Guild!
+   * console.log(`Hello from ${previewGuild}!`);
+   */
+  toString() {
+    return this.name;
+  }
+
+  toJSON() {
+    const json = super.toJSON();
+    json.iconURL = this.iconURL();
+    json.splashURL = this.splashURL();
+    return json;
+  }
+}

package/src/structures/GuildPreviewEmoji.ts

@@ -0,0 +1,28 @@
+import { BaseGuildEmoji  } from './BaseGuildEmoji.js';
+
+/**
+ * Represents an instance of an emoji belonging to a public guild obtained through Discord's preview endpoint.
+ *
+ * @extends {BaseGuildEmoji}
+ */
+export class GuildPreviewEmoji extends BaseGuildEmoji {
+  public client: any;
+  public roles: any;
+  /**
+   * The public guild this emoji is part of
+   *
+   * @type {GuildPreview}
+   * @name GuildPreviewEmoji#guild
+   */
+
+  constructor(client, data, guild) {
+    super(client, data, guild);
+
+    /**
+     * The roles this emoji is active for
+     *
+     * @type {Snowflake[]}
+     */
+    this.roles = data.roles;
+  }
+}