discord-sb.js 1.0.0

package/src/structures/Invite.js

@@ -0,0 +1,358 @@
+'use strict';
+
+const Base = require('./Base');
+const { GuildScheduledEvent } = require('./GuildScheduledEvent');
+const IntegrationApplication = require('./IntegrationApplication');
+const InviteStageInstance = require('./InviteStageInstance');
+const { Error } = require('../errors');
+const { Endpoints } = require('../util/Constants');
+const InviteFlags = require('../util/InviteFlags');
+const Permissions = require('../util/Permissions');
+
+// TODO: Convert `inviter` and `channel` in this class to a getter.
+
+/**
+ * Represents an invitation to a guild channel.
+ * @extends {Base}
+ */
+class Invite extends Base {
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+
+  _patch(data) {
+    const InviteGuild = require('./InviteGuild');
+    /**
+     * The guild the invite is for including welcome screen data if present
+     * @type {?(Guild|InviteGuild)}
+     */
+    this.guild ??= null;
+    if (data.guild) {
+      this.guild = this.client.guilds.cache.get(data.guild.id) ?? new InviteGuild(this.client, data.guild);
+    }
+
+    if ('code' in data) {
+      /**
+       * The code for this invite
+       * @type {string}
+       */
+      this.code = data.code;
+    }
+
+    if ('approximate_presence_count' in data) {
+      /**
+       * The approximate number of online members of the guild this invite is for
+       * <info>This is only available when the invite was fetched through {@link Client#fetchInvite}.</info>
+       * @type {?number}
+       */
+      this.presenceCount = data.approximate_presence_count;
+    } else {
+      this.presenceCount ??= null;
+    }
+
+    if ('approximate_member_count' in data) {
+      /**
+       * The approximate total number of members of the guild this invite is for
+       * <info>This is only available when the invite was fetched through {@link Client#fetchInvite}.</info>
+       * @type {?number}
+       */
+      this.memberCount = data.approximate_member_count;
+    } else {
+      this.memberCount ??= null;
+    }
+
+    if ('temporary' in data) {
+      /**
+       * Whether or not this invite only grants temporary membership
+       * <info>This is only available when the invite was fetched through {@link GuildInviteManager#fetch}
+       * or created through {@link GuildInviteManager#create}.</info>
+       * @type {?boolean}
+       */
+      this.temporary = data.temporary ?? null;
+    } else {
+      this.temporary ??= null;
+    }
+
+    if ('max_age' in data) {
+      /**
+       * The maximum age of the invite, in seconds, 0 if never expires
+       * <info>This is only available when the invite was fetched through {@link GuildInviteManager#fetch}
+       * or created through {@link GuildInviteManager#create}.</info>
+       * @type {?number}
+       */
+      this.maxAge = data.max_age;
+    } else {
+      this.maxAge ??= null;
+    }
+
+    if ('uses' in data) {
+      /**
+       * How many times this invite has been used
+       * <info>This is only available when the invite was fetched through {@link GuildInviteManager#fetch}
+       * or created through {@link GuildInviteManager#create}.</info>
+       * @type {?number}
+       */
+      this.uses = data.uses;
+    } else {
+      this.uses ??= null;
+    }
+
+    if ('max_uses' in data) {
+      /**
+       * The maximum uses of this invite
+       * <info>This is only available when the invite was fetched through {@link GuildInviteManager#fetch}
+       * or created through {@link GuildInviteManager#create}.</info>
+       * @type {?number}
+       */
+      this.maxUses = data.max_uses;
+    } else {
+      this.maxUses ??= null;
+    }
+
+    if ('inviter_id' in data) {
+      /**
+       * The user's id who created this invite
+       * @type {?Snowflake}
+       */
+      this.inviterId = data.inviter_id;
+      this.inviter = this.client.users.resolve(data.inviter_id);
+    } else {
+      this.inviterId ??= null;
+    }
+
+    if ('inviter' in data) {
+      /**
+       * The user who created this invite
+       * @type {?User}
+       */
+      this.inviter ??= this.client.users._add(data.inviter);
+      this.inviterId = data.inviter.id;
+    } else {
+      this.inviter ??= null;
+    }
+
+    if ('target_user' in data) {
+      /**
+       * The user whose stream to display for this voice channel stream invite
+       * @type {?User}
+       */
+      this.targetUser = this.client.users._add(data.target_user);
+    } else {
+      this.targetUser ??= null;
+    }
+
+    if ('target_application' in data) {
+      /**
+       * The embedded application to open for this voice channel embedded application invite
+       * @type {?IntegrationApplication}
+       */
+      this.targetApplication = new IntegrationApplication(this.client, data.target_application);
+    } else {
+      this.targetApplication ??= null;
+    }
+
+    /**
+     * The type of the invite target:
+     * * 1: STREAM
+     * * 2: EMBEDDED_APPLICATION
+     * * 3: ROLE_SUBSCRIPTIONS
+     * * 4: CREATOR_PAGE
+     * @typedef {number} TargetType
+     * @see {@link https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types}
+     */
+
+    if ('target_type' in data) {
+      /**
+       * The target type
+       * @type {?TargetType}
+       */
+      this.targetType = data.target_type;
+    } else {
+      this.targetType ??= null;
+    }
+
+    /**
+     * The type of the invite:
+     * * 0: GUILD
+     * * 1: GROUP_DM
+     * * 2: FRIEND
+     * @typedef {number} InviteType
+     * @see {@link https://docs.discord.food/resources/invite#invite-type}
+     */
+    if ('type' in data) {
+      /**
+       * The type of invite
+       * @type {?InviteType}
+       */
+      this.type = data.type;
+    } else {
+      this.type ??= null;
+    }
+
+    if ('channel_id' in data) {
+      /**
+       * The channel's id this invite is for
+       * @type {?Snowflake}
+       */
+      this.channelId = data.channel_id;
+      this.channel = this.client.channels.cache.get(data.channel_id);
+    }
+
+    if ('channel' in data && data.channel !== null) {
+      /**
+       * The channel this invite is for
+       * @type {?Channel}
+       */
+      this.channel ??= this.client.channels._add(data.channel, this.guild, { cache: false });
+      this.channelId ??= data.channel.id;
+    }
+
+    if ('created_at' in data) {
+      /**
+       * The timestamp this invite was created at
+       * @type {?number}
+       */
+      this.createdTimestamp = new Date(data.created_at).getTime();
+    } else {
+      this.createdTimestamp ??= null;
+    }
+
+    if ('expires_at' in data) {
+      this._expiresTimestamp = data.expires_at && Date.parse(data.expires_at);
+    } else {
+      this._expiresTimestamp ??= null;
+    }
+
+    if ('stage_instance' in data) {
+      /**
+       * The stage instance data if there is a public {@link StageInstance} in the stage channel this invite is for
+       * @type {?InviteStageInstance}
+       */
+      this.stageInstance = new InviteStageInstance(this.client, data.stage_instance, this.channel.id, this.guild.id);
+    } else {
+      this.stageInstance ??= null;
+    }
+
+    if ('guild_scheduled_event' in data) {
+      /**
+       * The guild scheduled event data if there is a {@link GuildScheduledEvent} in the channel this invite is for
+       * @type {?GuildScheduledEvent}
+       */
+      this.guildScheduledEvent = new GuildScheduledEvent(this.client, data.guild_scheduled_event);
+    } else {
+      this.guildScheduledEvent ??= null;
+    }
+
+    if ('flags' in data) {
+      /**
+       * The flags that are applied to the invite.
+       * @type {?Readonly<InviteFlags>}
+       */
+      this.flags = new InviteFlags(data.flags).freeze();
+    } else {
+      this.flags ??= new InviteFlags().freeze();
+    }
+  }
+
+  /**
+   * The time the invite was created at
+   * @type {?Date}
+   * @readonly
+   */
+  get createdAt() {
+    return this.createdTimestamp ? new Date(this.createdTimestamp) : null;
+  }
+
+  /**
+   * Whether the invite is deletable by the client user
+   * @type {boolean}
+   * @readonly
+   */
+  get deletable() {
+    const guild = this.guild;
+    if (!guild || !this.client.guilds.cache.has(guild.id)) return false;
+    if (!guild.members.me) throw new Error('GUILD_UNCACHED_ME');
+    return (
+      this.channel.permissionsFor(this.client.user).has(Permissions.FLAGS.MANAGE_CHANNELS, false) ||
+      guild.members.me.permissions.has(Permissions.FLAGS.MANAGE_GUILD)
+    );
+  }
+
+  /**
+   * The timestamp the invite will expire at
+   * @type {?number}
+   * @readonly
+   */
+  get expiresTimestamp() {
+    return (
+      this._expiresTimestamp ??
+      (this.createdTimestamp && this.maxAge ? this.createdTimestamp + this.maxAge * 1_000 : null)
+    );
+  }
+
+  /**
+   * The time the invite will expire at
+   * @type {?Date}
+   * @readonly
+   */
+  get expiresAt() {
+    const { expiresTimestamp } = this;
+    return expiresTimestamp ? new Date(expiresTimestamp) : null;
+  }
+
+  /**
+   * The URL to the invite
+   * @type {string}
+   * @readonly
+   */
+  get url() {
+    return Endpoints.invite(this.client.options.http.invite, this.code);
+  }
+
+  /**
+   * Deletes this invite.
+   * @param {string} [reason] Reason for deleting this invite
+   * @returns {Promise<Invite>}
+   */
+  async delete(reason) {
+    await this.client.api.invites[this.code].delete({ reason });
+    return this;
+  }
+
+  /**
+   * When concatenated with a string, this automatically concatenates the invite's URL instead of the object.
+   * @returns {string}
+   * @example
+   * // Logs: Invite: https://discord.gg/A1b2C3
+   * console.log(`Invite: ${invite}`);
+   */
+  toString() {
+    return this.url;
+  }
+
+  toJSON() {
+    return super.toJSON({
+      url: true,
+      expiresTimestamp: true,
+      presenceCount: false,
+      memberCount: false,
+      uses: false,
+      channel: 'channelId',
+      inviter: 'inviterId',
+      guild: 'guildId',
+    });
+  }
+
+  valueOf() {
+    return this.code;
+  }
+}
+
+/**
+ * Regular expression that globally matches Discord invite links
+ * @type {RegExp}
+ */
+Invite.INVITES_PATTERN = /discord(?:(?:app)?\.com\/invite|\.gg(?:\/invite)?)\/([\w-]{2,255})/gi;
+
+module.exports = Invite;

package/src/structures/InviteGuild.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const AnonymousGuild = require('./AnonymousGuild');
+const WelcomeScreen = require('./WelcomeScreen');
+
+/**
+ * Represents a guild received from an invite, includes welcome screen data if available.
+ * @extends {AnonymousGuild}
+ */
+class InviteGuild extends AnonymousGuild {
+  constructor(client, data) {
+    super(client, data);
+
+    /**
+     * The welcome screen for this invite guild
+     * @type {?WelcomeScreen}
+     */
+    this.welcomeScreen =
+      typeof data.welcome_screen !== 'undefined' ? new WelcomeScreen(this, data.welcome_screen) : null;
+  }
+}
+
+module.exports = InviteGuild;

package/src/structures/InviteStageInstance.js

@@ -0,0 +1,86 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const Base = require('./Base');
+
+/**
+ * Represents the data about a public {@link StageInstance} in an {@link Invite}.
+ * @extends {Base}
+ */
+class InviteStageInstance extends Base {
+  constructor(client, data, channelId, guildId) {
+    super(client);
+
+    /**
+     * The id of the stage channel this invite is for
+     * @type {Snowflake}
+     */
+    this.channelId = channelId;
+
+    /**
+     * The stage channel's guild id
+     * @type {Snowflake}
+     */
+    this.guildId = guildId;
+
+    /**
+     * The members speaking in the stage channel
+     * @type {Collection<Snowflake, GuildMember>}
+     */
+    this.members = new Collection();
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('topic' in data) {
+      /**
+       * The topic of the stage instance
+       * @type {string}
+       */
+      this.topic = data.topic;
+    }
+
+    if ('participant_count' in data) {
+      /**
+       * The number of users in the stage channel
+       * @type {number}
+       */
+      this.participantCount = data.participant_count;
+    }
+
+    if ('speaker_count' in data) {
+      /**
+       * The number of users speaking in the stage channel
+       * @type {number}
+       */
+      this.speakerCount = data.speaker_count;
+    }
+
+    this.members.clear();
+    for (const rawMember of data.members) {
+      const member = this.guild.members._add(rawMember);
+      this.members.set(member.id, member);
+    }
+  }
+
+  /**
+   * The stage channel this invite is for
+   * @type {?StageChannel}
+   * @readonly
+   */
+  get channel() {
+    return this.client.channels.resolve(this.channelId);
+  }
+
+  /**
+   * The guild of the stage channel this invite is for
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildId);
+  }
+}
+
+module.exports = InviteStageInstance;

package/src/structures/MediaChannel.js

@@ -0,0 +1,11 @@
+'use strict';
+
+const ThreadOnlyChannel = require('./ThreadOnlyChannel');
+
+/**
+ * Represents a media channel.
+ * @extends {ThreadOnlyChannel}
+ */
+class MediaChannel extends ThreadOnlyChannel {}
+
+module.exports = MediaChannel;

package/src/structures/MediaGalleryComponent.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const BaseMessageComponent = require('./BaseMessageComponent');
+const MediaGalleryItem = require('./MediaGalleryItem');
+const { MessageComponentTypes } = require('../util/Constants');
+
+class MediaGalleryComponent extends BaseMessageComponent {
+  /**
+   * @property {MediaGalleryItem[]} [items] 1 to 10 media gallery items
+   */
+
+  /**
+   * @param {MediaGalleryComponent | APIMediaGalleryComponent} [data={}] The data
+   */
+  constructor(data = {}) {
+    super({ type: 'MEDIA_GALLERY' });
+
+    this.setup(data);
+  }
+
+  setup(data) {
+    super.setup(data);
+    /**
+     * 1 to 10 media gallery items
+     * @type {MediaGalleryItem[]}
+     */
+    this.items = data.items?.map(item => new MediaGalleryItem(item)) ?? [];
+  }
+
+  /**
+   * @returns {APIMediaGalleryComponent}
+   */
+  toJSON() {
+    return {
+      type: MessageComponentTypes[this.type],
+      items: this.items.map(c => c.toJSON()),
+    };
+  }
+}
+
+module.exports = MediaGalleryComponent;

package/src/structures/MediaGalleryItem.js

@@ -0,0 +1,47 @@
+'use strict';
+
+const UnfurledMediaItem = require('./UnfurledMediaItem');
+
+class MediaGalleryItem {
+  /**
+   * @property {UnfurledMediaItem} [media] A url or attachment
+   * @property {String} [description] Alt text for the media, max 1024 characters
+   * @property {Boolean} [spoiler] Whether the media should be a spoiler (or blurred out). Defaults to false
+   */
+
+  /**
+   * @param {MediaGalleryItem | APIMediaGalleryItem} [data={}] The data
+   */
+  constructor(data = {}) {
+    /**
+     * A url or attachment
+     * @type {UnfurledMediaItem}
+     */
+    this.media = new UnfurledMediaItem(data.media);
+
+    /**
+     * Alt text for the media, max 1024 characters
+     * @type {String}
+     */
+    this.description = data.description ?? null;
+
+    /**
+     * Whether the media should be a spoiler (or blurred out). Defaults to false
+     * @type {Boolean}
+     */
+    this.spoiler = data.spoiler ?? false;
+  }
+
+  /**
+   * @returns {APIMediaGalleryItem}
+   */
+  toJSON() {
+    return {
+      media: this.media.toJSON(),
+      description: this.description,
+      spoiler: this.spoiler,
+    };
+  }
+}
+
+module.exports = MediaGalleryItem;