discord-sb.js 1.0.0

package/src/structures/StickerPack.js

@@ -0,0 +1,95 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const Base = require('./Base');
+const { Sticker } = require('./Sticker');
+const SnowflakeUtil = require('../util/SnowflakeUtil');
+
+/**
+ * Represents a pack of standard stickers.
+ * @extends {Base}
+ */
+class StickerPack extends Base {
+  constructor(client, pack) {
+    super(client);
+    /**
+     * The Sticker pack's id
+     * @type {Snowflake}
+     */
+    this.id = pack.id;
+
+    /**
+     * The stickers in the pack
+     * @type {Collection<Snowflake, Sticker>}
+     */
+    this.stickers = new Collection(pack.stickers.map(s => [s.id, new Sticker(client, s)]));
+
+    /**
+     * The name of the sticker pack
+     * @type {string}
+     */
+    this.name = pack.name;
+
+    /**
+     * The id of the pack's SKU
+     * @type {Snowflake}
+     */
+    this.skuId = pack.sku_id;
+
+    /**
+     * The id of a sticker in the pack which is shown as the pack's icon
+     * @type {?Snowflake}
+     */
+    this.coverStickerId = pack.cover_sticker_id ?? null;
+
+    /**
+     * The description of the sticker pack
+     * @type {string}
+     */
+    this.description = pack.description;
+
+    /**
+     * The id of the sticker pack's banner image
+     * @type {?Snowflake}
+     */
+    this.bannerId = pack.banner_asset_id ?? null;
+  }
+
+  /**
+   * The timestamp the sticker was created at
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return SnowflakeUtil.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the sticker was created at
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The sticker which is shown as the pack's icon
+   * @type {?Sticker}
+   * @readonly
+   */
+  get coverSticker() {
+    return this.coverStickerId && this.stickers.get(this.coverStickerId);
+  }
+
+  /**
+   * The URL to this sticker pack's banner.
+   * @param {StaticImageURLOptions} [options={}] Options for the Image URL
+   * @returns {?string}
+   */
+  bannerURL({ format, size } = {}) {
+    return this.bannerId && this.client.rest.cdn.StickerPackBanner(this.bannerId, format, size);
+  }
+}
+
+module.exports = StickerPack;

package/src/structures/StoreChannel.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const GuildChannel = require('./GuildChannel');
+
+/**
+ * Represents a guild store channel on Discord.
+ * <warn>Store channels have been removed from Discord. See
+ * [Self-serve Game Selling Deprecation](https://support-dev.discord.com/hc/en-us/articles/6309018858647)
+ * for more information.</warn>
+ * @extends {GuildChannel}
+ */
+class StoreChannel extends GuildChannel {
+  constructor(guild, data, client) {
+    super(guild, data, client);
+
+    /**
+     * If the guild considers this channel NSFW
+     * @type {boolean}
+     */
+    this.nsfw = Boolean(data.nsfw);
+  }
+
+  _patch(data) {
+    super._patch(data);
+
+    if ('nsfw' in data) {
+      this.nsfw = Boolean(data.nsfw);
+    }
+  }
+
+  /**
+   * Creates an invite to this guild channel.
+   * @param {CreateInviteOptions} [options={}] The options for creating the invite
+   * @returns {Promise<Invite>}
+   * @example
+   * // Create an invite to a channel
+   * channel.createInvite()
+   *   .then(invite => console.log(`Created an invite with a code of ${invite.code}`))
+   *   .catch(console.error);
+   */
+  createInvite(options) {
+    return this.guild.invites.create(this.id, options);
+  }
+
+  /**
+   * Fetches a collection of invites to this guild channel.
+   * Resolves with a collection mapping invites by their codes.
+   * @param {boolean} [cache=true] Whether or not to cache the fetched invites
+   * @returns {Promise<Collection<string, Invite>>}
+   */
+  fetchInvites(cache = true) {
+    return this.guild.invites.fetch({ channelId: this.id, cache });
+  }
+}
+
+module.exports = StoreChannel;

package/src/structures/Team.js

@@ -0,0 +1,118 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const Base = require('./Base');
+const TeamMember = require('./TeamMember');
+const SnowflakeUtil = require('../util/SnowflakeUtil');
+
+/**
+ * Represents a Client OAuth2 Application Team.
+ * @extends {Base}
+ */
+class Team extends Base {
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+
+  _patch(data) {
+    /**
+     * The Team's id
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    if ('name' in data) {
+      /**
+       * The name of the Team
+       * @type {string}
+       */
+      this.name = data.name;
+    }
+
+    if ('icon' in data) {
+      /**
+       * The Team's icon hash
+       * @type {?string}
+       */
+      this.icon = data.icon;
+    } else {
+      this.icon ??= null;
+    }
+
+    if ('owner_user_id' in data) {
+      /**
+       * The Team's owner id
+       * @type {?Snowflake}
+       */
+      this.ownerId = data.owner_user_id;
+    } else {
+      this.ownerId ??= null;
+    }
+    /**
+     * The Team's members
+     * @type {Collection<Snowflake, TeamMember>}
+     */
+    this.members = new Collection();
+
+    for (const memberData of data.members) {
+      const member = new TeamMember(this, memberData);
+      this.members.set(member.id, member);
+    }
+  }
+
+  /**
+   * The owner of this team
+   * @type {?TeamMember}
+   * @readonly
+   */
+  get owner() {
+    return this.members.get(this.ownerId) ?? null;
+  }
+
+  /**
+   * The timestamp the team was created at
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return SnowflakeUtil.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the team was created at
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * A link to the team's icon.
+   * @param {StaticImageURLOptions} [options={}] Options for the Image URL
+   * @returns {?string}
+   */
+  iconURL({ format, size } = {}) {
+    if (!this.icon) return null;
+    return this.client.rest.cdn.TeamIcon(this.id, this.icon, { format, size });
+  }
+
+  /**
+   * When concatenated with a string, this automatically returns the Team's name instead of the
+   * Team object.
+   * @returns {string}
+   * @example
+   * // Logs: Team name: My Team
+   * console.log(`Team name: ${team}`);
+   */
+  toString() {
+    return this.name;
+  }
+
+  toJSON() {
+    return super.toJSON({ createdTimestamp: true });
+  }
+}
+
+module.exports = Team;

package/src/structures/TeamMember.js

@@ -0,0 +1,80 @@
+'use strict';
+
+const Base = require('./Base');
+const { MembershipStates } = require('../util/Constants');
+
+/**
+ * Represents a Client OAuth2 Application Team Member.
+ * @extends {Base}
+ */
+class TeamMember extends Base {
+  constructor(team, data) {
+    super(team.client);
+
+    /**
+     * The Team this member is part of
+     * @type {Team}
+     */
+    this.team = team;
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('permissions' in data) {
+      /**
+       * The permissions this Team Member has with regard to the team
+       * @type {string[]}
+       * @deprecated Use {@link TeamMember#role} instead.
+       */
+      this.permissions = data.permissions;
+    }
+
+    if ('role' in data) {
+      /**
+       * The role of this Team Member
+       * @type {TeamMemberRole}
+       */
+      this.role = data.role;
+    }
+
+    if ('membership_state' in data) {
+      /**
+       * The permissions this Team Member has with regard to the team
+       * @type {MembershipState}
+       */
+      this.membershipState = MembershipStates[data.membership_state];
+    }
+
+    if ('user' in data) {
+      /**
+       * The user for this Team Member
+       * @type {User}
+       */
+      this.user = this.client.users._add(data.user);
+    }
+  }
+
+  /**
+   * The Team Member's id
+   * @type {Snowflake}
+   * @readonly
+   */
+  get id() {
+    return this.user.id;
+  }
+
+  /**
+   * When concatenated with a string, this automatically returns the team member's mention instead of the
+   * TeamMember object.
+   * @returns {string}
+   * @example
+   * // Logs: Team Member's mention: <@123456789012345678>
+   * console.log(`Team Member's mention: ${teamMember}`);
+   */
+  toString() {
+    return this.user.toString();
+  }
+}
+
+module.exports = TeamMember;

package/src/structures/TextChannel.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const BaseGuildTextChannel = require('./BaseGuildTextChannel');
+
+/**
+ * Represents a guild text channel on Discord.
+ * @extends {BaseGuildTextChannel}
+ */
+class TextChannel extends BaseGuildTextChannel {
+  _patch(data) {
+    super._patch(data);
+
+    if ('rate_limit_per_user' in data) {
+      /**
+       * The rate limit per user (slowmode) for this channel in seconds
+       * @type {number}
+       */
+      this.rateLimitPerUser = data.rate_limit_per_user;
+    }
+  }
+
+  /**
+   * Sets the rate limit per user (slowmode) for this channel.
+   * @param {number} rateLimitPerUser The new rate limit in seconds
+   * @param {string} [reason] Reason for changing the channel's rate limit
+   * @returns {Promise<TextChannel>}
+   */
+  setRateLimitPerUser(rateLimitPerUser, reason) {
+    return this.edit({ rateLimitPerUser }, reason);
+  }
+}
+
+module.exports = TextChannel;

package/src/structures/TextDisplayComponent.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const BaseMessageComponent = require('./BaseMessageComponent');
+const { MessageComponentTypes } = require('../util/Constants');
+
+class TextDisplayComponent extends BaseMessageComponent {
+  /**
+   * @property {String} [content] Text that will be displayed similar to a message
+   */
+
+  /**
+   * @param {TextDisplayComponent | APITextDisplayComponent} [data={}] The data
+   */
+  constructor(data = {}) {
+    super({ type: 'TEXT_DISPLAY' });
+
+    this.setup(data);
+  }
+
+  setup(data) {
+    super.setup(data);
+    /**
+     * Text that will be displayed similar to a message
+     * @type {String}
+     */
+    this.content = data.content ?? null;
+  }
+
+  /**
+   * @returns {APITextDisplayComponent}
+   */
+  toJSON() {
+    return {
+      type: MessageComponentTypes[this.type],
+      content: this.content,
+    };
+  }
+}
+
+module.exports = TextDisplayComponent;

package/src/structures/TextInputComponent.js

@@ -0,0 +1,132 @@
+'use strict';
+
+const BaseMessageComponent = require('./BaseMessageComponent');
+const { RangeError } = require('../errors');
+const { TextInputStyles, MessageComponentTypes } = require('../util/Constants');
+const Util = require('../util/Util');
+
+/**
+ * Represents a text input component in a modal
+ * @extends {BaseMessageComponent}
+ */
+
+class TextInputComponent extends BaseMessageComponent {
+  /**
+   * @typedef {BaseMessageComponentOptions} TextInputComponentOptions
+   * @property {string} [customId] A unique string to be sent in the interaction when submitted
+   * @property {string} [label] The text to be displayed above this text input component
+   * @property {number} [maxLength] Maximum length of text that can be entered
+   * @property {number} [minLength] Minimum length of text required to be entered
+   * @property {string} [placeholder] Custom placeholder text to display when no text is entered
+   * @property {boolean} [required] Whether or not this text input component is required
+   * @property {TextInputStyleResolvable} [style] The style of this text input component
+   * @property {string} [value] Value of this text input component
+   */
+
+  /**
+   * @param {TextInputComponent|TextInputComponentOptions} [data={}] TextInputComponent to clone or raw data
+   */
+  constructor(data = {}) {
+    super({ type: 'TEXT_INPUT' });
+
+    this.setup(data);
+  }
+
+  setup(data) {
+    super.setup(data);
+    /**
+     * A unique string to be sent in the interaction when submitted
+     * @type {?string}
+     */
+    this.customId = data.custom_id ?? data.customId ?? null;
+
+    /**
+     * The text to be displayed above this text input component
+     * @type {?string}
+     */
+    this.label = data.label ?? null;
+
+    /**
+     * Maximum length of text that can be entered
+     * @type {?number}
+     */
+    this.maxLength = data.max_length ?? data.maxLength ?? null;
+
+    /**
+     * Minimum length of text required to be entered
+     * @type {?string}
+     */
+    this.minLength = data.min_length ?? data.minLength ?? null;
+
+    /**
+     * Custom placeholder text to display when no text is entered
+     * @type {?string}
+     */
+    this.placeholder = data.placeholder ?? null;
+
+    /**
+     * Whether or not this text input component is required
+     * @type {?boolean}
+     */
+    this.required = data.required ?? false;
+
+    /**
+     * The style of this text input component
+     * @type {?TextInputStyle}
+     */
+    this.style = data.style ? TextInputComponent.resolveStyle(data.style) : null;
+
+    /**
+     * Value of this text input component
+     * @type {?string}
+     */
+    this.value = data.value ?? null;
+  }
+
+  /**
+   * Sets the value of this text input component
+   * @param {string} value Value of this text input component
+   * @returns {TextInputComponent}
+   */
+  setValue(value) {
+    this.value = Util.verifyString(value, RangeError, 'TEXT_INPUT_VALUE');
+    return this;
+  }
+
+  /**
+   * Transforms the text input component into a plain object
+   * @returns {APITextInput} The raw data of this text input component
+   */
+  toJSON() {
+    return {
+      custom_id: this.customId,
+      label: this.label,
+      max_length: this.maxLength,
+      min_length: this.minLength,
+      placeholder: this.placeholder,
+      required: this.required,
+      style: TextInputStyles[this.style],
+      type: MessageComponentTypes[this.type],
+      value: this.value,
+    };
+  }
+
+  /**
+   * Data that can be resolved to a TextInputStyle. This can be
+   * * TextInputStyle
+   * * number
+   * @typedef {number|TextInputStyle} TextInputStyleResolvable
+   */
+
+  /**
+   * Resolves the style of a text input component
+   * @param {TextInputStyleResolvable} style The style to resolve
+   * @returns {TextInputStyle}
+   * @private
+   */
+  static resolveStyle(style) {
+    return typeof style === 'string' ? style : TextInputStyles[style];
+  }
+}
+
+module.exports = TextInputComponent;