@ovencord/discord.js 14.16.3

package/src/util/Partials.ts

@@ -0,0 +1,50 @@
+
+import { createEnum  } from './Enums.js';
+
+/**
+ * The enumeration for partials.
+ * ```js
+ * import { Client, Partials } from '@ovencord/discord.js';
+ *
+ * const client = new Client({
+ *   intents: [
+ *     // Intents...
+ *   ],
+ *   partials: [
+ *     Partials.User, // We want to receive uncached users!
+ *     Partials.Message // We want to receive uncached messages!
+ *   ]
+ * });
+ * ```
+ *
+ * @typedef {Object} Partials
+ * @property {number} User The partial to receive uncached users.
+ * @property {number} Channel The partial to receive uncached channels.
+ * <info>This is required to receive direct messages!</info>
+ * @property {number} GuildMember The partial to receive uncached guild members.
+ * @property {number} Message The partial to receive uncached messages.
+ * @property {number} Reaction The partial to receive uncached reactions.
+ * @property {number} GuildScheduledEvent The partial to receive uncached guild scheduled events.
+ * @property {number} ThreadMember The partial to receive uncached thread members.
+ * @property {number} Poll The partial to receive uncached polls.
+ * @property {number} PollAnswer The partial to receive uncached poll answers.
+ * @property {number} SoundboardSound The partial to receive uncached soundboard sounds.
+ */
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {Partials}
+ * @ignore
+ */
+exports.Partials = createEnum([
+  'User',
+  'Channel',
+  'GuildMember',
+  'Message',
+  'Reaction',
+  'GuildScheduledEvent',
+  'ThreadMember',
+  'Poll',
+  'PollAnswer',
+  'SoundboardSound',
+]);

package/src/util/PermissionsBitField.ts

@@ -0,0 +1,113 @@
+import { PermissionFlagsBits  } from 'discord-api-types/v10';
+import { BitField  } from './BitField.js';
+
+/**
+ * Data structure that makes it easy to interact with a permission bitfield. All {@link GuildMember}s have a set of
+ * permissions in their guild, and each channel in the guild may also have {@link PermissionOverwrites} for the member
+ * that override their default permissions.
+ *
+ * @extends {BitField}
+ */
+export class PermissionsBitField extends BitField {
+  /**
+   * Numeric permission flags.
+   *
+   * @type {PermissionFlagsBits}
+   * @memberof PermissionsBitField
+   * @see {@link https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags}
+   */
+  static Flags = PermissionFlagsBits;
+
+  /**
+   * Bitfield representing every permission combined
+   *
+   * @type {bigint}
+   * @memberof PermissionsBitField
+   */
+
+  // eslint-disable-next-line unicor
+  static All = Object.values(PermissionFlagsBits).reduce((all, perm) => all | perm, 0n);
+
+  /**
+   * Bitfield representing the default permissions for users
+   *
+   * @type {bigint}
+   * @memberof PermissionsBitField
+   */
+  static Default = BigInt(104_324_673);
+
+  /**
+   * Bitfield representing the permissions required for moderators of stage channels
+   *
+   * @type {bigint}
+   * @memberof PermissionsBitField
+   */
+  static StageModerator =
+    PermissionFlagsBits.ManageChannels | PermissionFlagsBits.MuteMembers | PermissionFlagsBits.MoveMembers;
+
+  /**
+   * @type {bigint}
+   * @memberof PermissionsBitField
+   * @private
+   */
+  static DefaultBit = BigInt(0);
+
+  /**
+   * Bitfield of the packed bits
+   *
+   * @type {bigint}
+   * @name PermissionsBitField#bitfield
+   */
+
+  /**
+   * Data that can be resolved to give a permission number. This can be:
+   * - A string (see {@link PermissionsBitField.Flags})
+   * - A permission number
+   * - An instance of {@link PermissionsBitField}
+   * - An Array of PermissionResolvable
+   *
+   * @typedef {string|bigint|PermissionsBitField|PermissionResolvable[]} PermissionResolvable
+   */
+
+  /**
+   * Gets all given bits that are missing from the bitfield.
+   *
+   * @param {BitFieldResolvable} bits Bit(s) to check for
+   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
+   * @returns {string[]}
+   */
+  missing(bits, checkAdmin = true) {
+    return checkAdmin && this.has(PermissionFlagsBits.Administrator) ? [] : super.missing(bits);
+  }
+
+  /**
+   * Checks whether the bitfield has a permission, or any of multiple permissions.
+   *
+   * @param {PermissionResolvable} permission Permission(s) to check for
+   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
+   * @returns {boolean}
+   */
+  any(permission, checkAdmin = true) {
+    return (checkAdmin && super.has(PermissionFlagsBits.Administrator)) || super.any(permission);
+  }
+
+  /**
+   * Checks whether the bitfield has a permission, or multiple permissions.
+   *
+   * @param {PermissionResolvable} permission Permission(s) to check for
+   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
+   * @returns {boolean}
+   */
+  has(permission, checkAdmin = true) {
+    return (checkAdmin && super.has(PermissionFlagsBits.Administrator)) || super.has(permission);
+  }
+
+  /**
+   * Gets an {@link Array} of bitfield names based on the permissions available.
+   *
+   * @returns {string[]}
+   */
+  toArray() {
+    return super.toArray(false);
+  }
+}

package/src/util/RoleFlagsBitField.ts

@@ -0,0 +1,26 @@
+/* eslint-disable jsdoc/check-values */
+
+import { RoleFlags  } from 'discord-api-types/v10';
+import { BitField  } from './BitField.js';
+
+/**
+ * Data structure that makes it easy to interact with a {@link Role#flags} bitfield.
+ *
+ * @extends {BitField}
+ */
+export class RoleFlagsBitField extends BitField {
+  /**
+   * Numeric role flags.
+   *
+   * @type {RoleFlags}
+   * @memberof RoleFlagsBitField
+   */
+  static Flags = RoleFlags;
+}
+
+/**
+ * @name RoleFlagsBitField
+ * @kind constructor
+ * @memberof RoleFlagsBitField
+ * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
+ */

package/src/util/SKUFlagsBitField.ts

@@ -0,0 +1,26 @@
+/* eslint-disable jsdoc/check-values */
+
+import { SKUFlags  } from 'discord-api-types/v10';
+import { BitField  } from './BitField.js';
+
+/**
+ * Data structure that makes it easy to interact with an {@link SKU#flags} bitfield.
+ *
+ * @extends {BitField}
+ */
+export class SKUFlagsBitField extends BitField {
+  /**
+   * Numeric SKU flags.
+   *
+   * @type {SKUFlags}
+   * @memberof SKUFlagsBitField
+   */
+  static Flags = SKUFlags;
+}
+
+/**
+ * @name SKUFlagsBitField
+ * @kind constructor
+ * @memberof SKUFlagsBitField
+ * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
+ */

package/src/util/ShardEvents.ts

@@ -0,0 +1,26 @@
+
+/**
+ * @typedef {Object} ShardEvents
+ * @property {string} Death death
+ * @property {string} Disconnect disconnect
+ * @property {string} Error error
+ * @property {string} Message message
+ * @property {string} Ready ready
+ * @property {string} Resume resume
+ * @property {string} Spawn spawn
+ */
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {ShardEvents}
+ * @ignore
+ */
+exports.ShardEvents = {
+  Death: 'death',
+  Disconnect: 'disconnect',
+  Error: 'error',
+  Message: 'message',
+  Ready: 'ready',
+  Resume: 'resume',
+  Spawn: 'spawn',
+};

package/src/util/Status.ts

@@ -0,0 +1,16 @@
+
+import { createEnum  } from './Enums.js';
+
+/**
+ * @typedef {Object} Status
+ * @property {number} Ready ready
+ * @property {number} Idle idle
+ * @property {number} WaitingForGuilds waiting for guilds
+ */
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {Status}
+ * @ignore
+ */
+exports.Status = createEnum(['Ready', 'Idle', 'WaitingForGuilds']);