@velliajs/discord 1.0.0

package/src/client/websocket/handlers/RESUMED.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+
+module.exports = (client, packet, shard) => {
+  const replayed = shard.sessionInfo.sequence - shard.closeSequence;
+  /**
+   * Emitted when a shard resumes successfully.
+   * @event Client#shardResume
+   * @param {number} id The shard id that resumed
+   * @param {number} replayedEvents The amount of replayed events
+   */
+  client.emit(Events.ShardResume, shard.id, replayed);
+};

package/src/client/websocket/handlers/STAGE_INSTANCE_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.StageInstanceCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/STAGE_INSTANCE_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.StageInstanceDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/STAGE_INSTANCE_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.StageInstanceUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/THREAD_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ThreadCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/THREAD_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ThreadDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/THREAD_LIST_SYNC.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ThreadListSync.handle(packet.d);
+};

package/src/client/websocket/handlers/THREAD_MEMBERS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ThreadMembersUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/THREAD_MEMBER_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ThreadMemberUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/THREAD_UPDATE.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+
+module.exports = (client, packet) => {
+  const { old, updated } = client.actions.ChannelUpdate.handle(packet.d);
+  if (old && updated) {
+    /**
+     * Emitted whenever a thread is updated - e.g. name change, archive state change, locked state change.
+     * @event Client#threadUpdate
+     * @param {ThreadChannel} oldThread The thread before the update
+     * @param {ThreadChannel} newThread The thread after the update
+     */
+    client.emit(Events.ThreadUpdate, old, updated);
+  }
+};

package/src/client/websocket/handlers/TYPING_START.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.TypingStart.handle(packet.d);
+};

package/src/client/websocket/handlers/USER_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.UserUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/VOICE_SERVER_UPDATE.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.emit('debug', `[VOICE] received voice server: ${JSON.stringify(packet)}`);
+  client.voice.onVoiceServer(packet.d);
+};

package/src/client/websocket/handlers/VOICE_STATE_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.VoiceStateUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/WEBHOOKS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.WebhooksUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/index.js

@@ -0,0 +1,64 @@
+'use strict';
+
+const handlers = Object.fromEntries([
+  ['APPLICATION_COMMAND_PERMISSIONS_UPDATE', require('./APPLICATION_COMMAND_PERMISSIONS_UPDATE')],
+  ['AUTO_MODERATION_ACTION_EXECUTION', require('./AUTO_MODERATION_ACTION_EXECUTION')],
+  ['AUTO_MODERATION_RULE_CREATE', require('./AUTO_MODERATION_RULE_CREATE')],
+  ['AUTO_MODERATION_RULE_DELETE', require('./AUTO_MODERATION_RULE_DELETE')],
+  ['AUTO_MODERATION_RULE_UPDATE', require('./AUTO_MODERATION_RULE_UPDATE')],
+  ['CHANNEL_CREATE', require('./CHANNEL_CREATE')],
+  ['CHANNEL_DELETE', require('./CHANNEL_DELETE')],
+  ['CHANNEL_PINS_UPDATE', require('./CHANNEL_PINS_UPDATE')],
+  ['CHANNEL_UPDATE', require('./CHANNEL_UPDATE')],
+  ['GUILD_AUDIT_LOG_ENTRY_CREATE', require('./GUILD_AUDIT_LOG_ENTRY_CREATE')],
+  ['GUILD_BAN_ADD', require('./GUILD_BAN_ADD')],
+  ['GUILD_BAN_REMOVE', require('./GUILD_BAN_REMOVE')],
+  ['GUILD_CREATE', require('./GUILD_CREATE')],
+  ['GUILD_DELETE', require('./GUILD_DELETE')],
+  ['GUILD_EMOJIS_UPDATE', require('./GUILD_EMOJIS_UPDATE')],
+  ['GUILD_INTEGRATIONS_UPDATE', require('./GUILD_INTEGRATIONS_UPDATE')],
+  ['GUILD_MEMBERS_CHUNK', require('./GUILD_MEMBERS_CHUNK')],
+  ['GUILD_MEMBER_ADD', require('./GUILD_MEMBER_ADD')],
+  ['GUILD_MEMBER_REMOVE', require('./GUILD_MEMBER_REMOVE')],
+  ['GUILD_MEMBER_UPDATE', require('./GUILD_MEMBER_UPDATE')],
+  ['GUILD_ROLE_CREATE', require('./GUILD_ROLE_CREATE')],
+  ['GUILD_ROLE_DELETE', require('./GUILD_ROLE_DELETE')],
+  ['GUILD_ROLE_UPDATE', require('./GUILD_ROLE_UPDATE')],
+  ['GUILD_SCHEDULED_EVENT_CREATE', require('./GUILD_SCHEDULED_EVENT_CREATE')],
+  ['GUILD_SCHEDULED_EVENT_DELETE', require('./GUILD_SCHEDULED_EVENT_DELETE')],
+  ['GUILD_SCHEDULED_EVENT_UPDATE', require('./GUILD_SCHEDULED_EVENT_UPDATE')],
+  ['GUILD_SCHEDULED_EVENT_USER_ADD', require('./GUILD_SCHEDULED_EVENT_USER_ADD')],
+  ['GUILD_SCHEDULED_EVENT_USER_REMOVE', require('./GUILD_SCHEDULED_EVENT_USER_REMOVE')],
+  ['GUILD_STICKERS_UPDATE', require('./GUILD_STICKERS_UPDATE')],
+  ['GUILD_UPDATE', require('./GUILD_UPDATE')],
+  ['INTERACTION_CREATE', require('./INTERACTION_CREATE')],
+  ['INVITE_CREATE', require('./INVITE_CREATE')],
+  ['INVITE_DELETE', require('./INVITE_DELETE')],
+  ['MESSAGE_CREATE', require('./MESSAGE_CREATE')],
+  ['MESSAGE_DELETE', require('./MESSAGE_DELETE')],
+  ['MESSAGE_DELETE_BULK', require('./MESSAGE_DELETE_BULK')],
+  ['MESSAGE_REACTION_ADD', require('./MESSAGE_REACTION_ADD')],
+  ['MESSAGE_REACTION_REMOVE', require('./MESSAGE_REACTION_REMOVE')],
+  ['MESSAGE_REACTION_REMOVE_ALL', require('./MESSAGE_REACTION_REMOVE_ALL')],
+  ['MESSAGE_REACTION_REMOVE_EMOJI', require('./MESSAGE_REACTION_REMOVE_EMOJI')],
+  ['MESSAGE_UPDATE', require('./MESSAGE_UPDATE')],
+  ['PRESENCE_UPDATE', require('./PRESENCE_UPDATE')],
+  ['READY', require('./READY')],
+  ['RESUMED', require('./RESUMED')],
+  ['STAGE_INSTANCE_CREATE', require('./STAGE_INSTANCE_CREATE')],
+  ['STAGE_INSTANCE_DELETE', require('./STAGE_INSTANCE_DELETE')],
+  ['STAGE_INSTANCE_UPDATE', require('./STAGE_INSTANCE_UPDATE')],
+  ['THREAD_CREATE', require('./THREAD_CREATE')],
+  ['THREAD_DELETE', require('./THREAD_DELETE')],
+  ['THREAD_LIST_SYNC', require('./THREAD_LIST_SYNC')],
+  ['THREAD_MEMBERS_UPDATE', require('./THREAD_MEMBERS_UPDATE')],
+  ['THREAD_MEMBER_UPDATE', require('./THREAD_MEMBER_UPDATE')],
+  ['THREAD_UPDATE', require('./THREAD_UPDATE')],
+  ['TYPING_START', require('./TYPING_START')],
+  ['USER_UPDATE', require('./USER_UPDATE')],
+  ['VOICE_SERVER_UPDATE', require('./VOICE_SERVER_UPDATE')],
+  ['VOICE_STATE_UPDATE', require('./VOICE_STATE_UPDATE')],
+  ['WEBHOOKS_UPDATE', require('./WEBHOOKS_UPDATE')],
+]);
+
+module.exports = handlers;

package/src/errors/DJSError.js

@@ -0,0 +1,48 @@
+'use strict';
+
+// Heavily inspired by node's `internal/errors` module
+const ErrorCodes = require('./ErrorCodes');
+const Messages = require('./Messages');
+
+/**
+ * Extend an error of some sort into a DiscordjsError.
+ * @param {Error} Base Base error to extend
+ * @returns {DiscordjsError}
+ * @ignore
+ */
+function makeDiscordjsError(Base) {
+  return class DiscordjsError extends Base {
+    constructor(code, ...args) {
+      super(message(code, args));
+      this.code = code;
+      Error.captureStackTrace?.(this, DiscordjsError);
+    }
+
+    get name() {
+      return `${super.name} [${this.code}]`;
+    }
+  };
+}
+
+/**
+ * Format the message for an error.
+ * @param {string} code The error code
+ * @param {Array<*>} args Arguments to pass for util format or as function args
+ * @returns {string} Formatted string
+ * @ignore
+ */
+function message(code, args) {
+  if (!(code in ErrorCodes)) throw new Error('Error code must be a valid DiscordjsErrorCodes');
+  const msg = Messages[code];
+  if (!msg) throw new Error(`No message associated with error code: ${code}.`);
+  if (typeof msg === 'function') return msg(...args);
+  if (!args?.length) return msg;
+  args.unshift(msg);
+  return String(...args);
+}
+
+module.exports = {
+  DiscordjsError: makeDiscordjsError(Error),
+  DiscordjsTypeError: makeDiscordjsError(TypeError),
+  DiscordjsRangeError: makeDiscordjsError(RangeError),
+};

package/src/errors/ErrorCodes.js

@@ -0,0 +1,319 @@
+'use strict';
+
+/**
+ * @typedef {Object} DiscordjsErrorCodes
+
+ * @property {'ClientInvalidOption'} ClientInvalidOption
+ * @property {'ClientInvalidProvidedShards'} ClientInvalidProvidedShards
+ * @property {'ClientMissingIntents'} ClientMissingIntents
+ * @property {'ClientNotReady'} ClientNotReady
+
+ * @property {'TokenInvalid'} TokenInvalid
+ * @property {'TokenMissing'} TokenMissing
+ * @property {'ApplicationCommandPermissionsTokenMissing'} ApplicationCommandPermissionsTokenMissing
+
+ * @property {'WSCloseRequested'} WSCloseRequested
+ * <warn>This property is deprecated.</warn>
+ * @property {'WSConnectionExists'} WSConnectionExists
+ * <warn>This property is deprecated.</warn>
+ * @property {'WSNotOpen'} WSNotOpen
+ * <warn>This property is deprecated.</warn>
+ * @property {'ManagerDestroyed'} ManagerDestroyed
+
+ * @property {'BitFieldInvalid'} BitFieldInvalid
+
+ * @property {'ShardingInvalid'} ShardingInvalid
+ * <warn>This property is deprecated.</warn>
+ * @property {'ShardingRequired'} ShardingRequired
+ * <warn>This property is deprecated.</warn>
+ * @property {'InvalidIntents'} InvalidIntents
+ * <warn>This property is deprecated.</warn>
+ * @property {'DisallowedIntents'} DisallowedIntents
+ * <warn>This property is deprecated.</warn>
+ * @property {'ShardingNoShards'} ShardingNoShards
+ * @property {'ShardingInProcess'} ShardingInProcess
+ * @property {'ShardingInvalidEvalBroadcast'} ShardingInvalidEvalBroadcast
+ * @property {'ShardingShardNotFound'} ShardingShardNotFound
+ * @property {'ShardingAlreadySpawned'} ShardingAlreadySpawned
+ * @property {'ShardingProcessExists'} ShardingProcessExists
+ * @property {'ShardingWorkerExists'} ShardingWorkerExists
+ * @property {'ShardingReadyTimeout'} ShardingReadyTimeout
+ * @property {'ShardingReadyDisconnected'} ShardingReadyDisconnected
+ * @property {'ShardingReadyDied'} ShardingReadyDied
+ * @property {'ShardingNoChildExists'} ShardingNoChildExists
+ * @property {'ShardingShardMiscalculation'} ShardingShardMiscalculation
+
+ * @property {'ColorRange'} ColorRange
+ * @property {'ColorConvert'} ColorConvert
+
+ * @property {'InviteOptionsMissingChannel'} InviteOptionsMissingChannel
+
+ * @property {'ButtonLabel'} ButtonLabel
+ * @property {'ButtonURL'} ButtonURL
+ * @property {'ButtonCustomId'} ButtonCustomId
+
+ * @property {'SelectMenuCustomId'} SelectMenuCustomId
+ * @property {'SelectMenuPlaceholder'} SelectMenuPlaceholder
+ * @property {'SelectOptionLabel'} SelectOptionLabel
+ * @property {'SelectOptionValue'} SelectOptionValue
+ * @property {'SelectOptionDescription'} SelectOptionDescription
+
+ * @property {'InteractionCollectorError'} InteractionCollectorError
+
+ * @property {'FileNotFound'} FileNotFound
+
+ * @property {'UserBannerNotFetched'} UserBannerNotFetched
+ * @property {'UserNoDMChannel'} UserNoDMChannel
+
+ * @property {'VoiceNotStageChannel'} VoiceNotStageChannel
+
+ * @property {'VoiceStateNotOwn'} VoiceStateNotOwn
+ * @property {'VoiceStateInvalidType'} VoiceStateInvalidType
+
+ * @property {'ReqResourceType'} ReqResourceType
+
+ * @property {'ImageFormat'} ImageFormat
+ * @property {'ImageSize'} ImageSize
+
+ * @property {'MessageBulkDeleteType'} MessageBulkDeleteType
+ * @property {'MessageNonceType'} MessageNonceType
+ * @property {'MessageContentType'} MessageContentType
+
+ * @property {'SplitMaxLen'} SplitMaxLen
+
+ * @property {'BanResolveId'} BanResolveId
+ * @property {'FetchBanResolveId'} FetchBanResolveId
+
+ * @property {'PruneDaysType'} PruneDaysType
+
+ * @property {'GuildChannelResolve'} GuildChannelResolve
+ * @property {'GuildVoiceChannelResolve'} GuildVoiceChannelResolve
+ * @property {'GuildChannelOrphan'} GuildChannelOrphan
+ * @property {'GuildChannelUnowned'} GuildChannelUnowned
+ * @property {'GuildOwned'} GuildOwned
+ * @property {'GuildMembersTimeout'} GuildMembersTimeout
+ * @property {'GuildUncachedMe'} GuildUncachedMe
+ * @property {'ChannelNotCached'} ChannelNotCached
+ * @property {'StageChannelResolve'} StageChannelResolve
+ * @property {'GuildScheduledEventResolve'} GuildScheduledEventResolve
+ * @property {'FetchOwnerId'} FetchOwnerId
+
+ * @property {'InvalidType'} InvalidType
+ * @property {'InvalidElement'} InvalidElement
+
+ * @property {'MessageThreadParent'} MessageThreadParent
+ * @property {'MessageExistingThread'} MessageExistingThread
+ * @property {'ThreadInvitableType'} ThreadInvitableType
+
+ * @property {'WebhookMessage'} WebhookMessage
+ * @property {'WebhookTokenUnavailable'} WebhookTokenUnavailable
+ * @property {'WebhookURLInvalid'} WebhookURLInvalid
+ * @property {'WebhookApplication'} WebhookApplication
+ * @property {'MessageReferenceMissing'} MessageReferenceMissing
+
+ * @property {'EmojiType'} EmojiType
+ * @property {'EmojiManaged'} EmojiManaged
+ * @property {'MissingManageGuildExpressionsPermission'} MissingManageGuildExpressionsPermission
+ * @property {'MissingManageEmojisAndStickersPermission'} MissingManageEmojisAndStickersPermission
+ * <warn>This property is deprecated. Use `MissingManageGuildExpressionsPermission` instead.</warn>
+ *
+ * @property {'NotGuildSticker'} NotGuildSticker
+
+ * @property {'ReactionResolveUser'} ReactionResolveUser
+
+ * @property {'VanityURL'} VanityURL
+
+ * @property {'InviteResolveCode'} InviteResolveCode
+
+ * @property {'InviteNotFound'} InviteNotFound
+
+ * @property {'DeleteGroupDMChannel'} DeleteGroupDMChannel
+ * @property {'FetchGroupDMChannel'} FetchGroupDMChannel
+
+ * @property {'MemberFetchNonceLength'} MemberFetchNonceLength
+
+ * @property {'GlobalCommandPermissions'} GlobalCommandPermissions
+ * @property {'GuildUncachedEntityResolve'} GuildUncachedEntityResolve
+
+ * @property {'InteractionAlreadyReplied'} InteractionAlreadyReplied
+ * @property {'InteractionNotReplied'} InteractionNotReplied
+ * @property {'InteractionEphemeralReplied'} InteractionEphemeralReplied
+ * <warn>This property is deprecated.</warn>
+
+ * @property {'CommandInteractionOptionNotFound'} CommandInteractionOptionNotFound
+ * @property {'CommandInteractionOptionType'} CommandInteractionOptionType
+ * @property {'CommandInteractionOptionEmpty'} CommandInteractionOptionEmpty
+ * @property {'CommandInteractionOptionNoSubcommand'} CommandInteractionOptionNoSubcommand
+ * @property {'CommandInteractionOptionNoSubcommandGroup'} CommandInteractionOptionNoSubcommandGroup
+ * @property {'CommandInteractionOptionInvalidChannelType'} CommandInteractionOptionInvalidChannelType
+ * @property {'AutocompleteInteractionOptionNoFocusedOption'} AutocompleteInteractionOptionNoFocusedOption
+
+ * @property {'ModalSubmitInteractionFieldNotFound'} ModalSubmitInteractionFieldNotFound
+ * @property {'ModalSubmitInteractionFieldType'} ModalSubmitInteractionFieldType
+
+ * @property {'InvalidMissingScopes'} InvalidMissingScopes
+ * @property {'InvalidScopesWithPermissions'} InvalidScopesWithPermissions
+
+ * @property {'NotImplemented'} NotImplemented
+
+ * @property {'GuildForumMessageRequired'} GuildForumMessageRequired
+
+ * @property {'SweepFilterReturn'} SweepFilterReturn
+ */
+
+const keys = [
+  'ClientInvalidOption',
+  'ClientInvalidProvidedShards',
+  'ClientMissingIntents',
+  'ClientNotReady',
+
+  'TokenInvalid',
+  'TokenMissing',
+  'ApplicationCommandPermissionsTokenMissing',
+
+  'WSCloseRequested',
+  'WSConnectionExists',
+  'WSNotOpen',
+  'ManagerDestroyed',
+
+  'BitFieldInvalid',
+
+  'ShardingInvalid',
+  'ShardingRequired',
+  'InvalidIntents',
+  'DisallowedIntents',
+  'ShardingNoShards',
+  'ShardingInProcess',
+  'ShardingInvalidEvalBroadcast',
+  'ShardingShardNotFound',
+  'ShardingAlreadySpawned',
+  'ShardingProcessExists',
+  'ShardingWorkerExists',
+  'ShardingReadyTimeout',
+  'ShardingReadyDisconnected',
+  'ShardingReadyDied',
+  'ShardingNoChildExists',
+  'ShardingShardMiscalculation',
+
+  'ColorRange',
+  'ColorConvert',
+
+  'InviteOptionsMissingChannel',
+
+  'ButtonLabel',
+  'ButtonURL',
+  'ButtonCustomId',
+
+  'SelectMenuCustomId',
+  'SelectMenuPlaceholder',
+  'SelectOptionLabel',
+  'SelectOptionValue',
+  'SelectOptionDescription',
+
+  'InteractionCollectorError',
+
+  'FileNotFound',
+
+  'UserBannerNotFetched',
+  'UserNoDMChannel',
+
+  'VoiceNotStageChannel',
+
+  'VoiceStateNotOwn',
+  'VoiceStateInvalidType',
+
+  'ReqResourceType',
+
+  'ImageFormat',
+  'ImageSize',
+
+  'MessageBulkDeleteType',
+  'MessageNonceType',
+  'MessageContentType',
+
+  'SplitMaxLen',
+
+  'BanResolveId',
+  'FetchBanResolveId',
+
+  'PruneDaysType',
+
+  'GuildChannelResolve',
+  'GuildVoiceChannelResolve',
+  'GuildChannelOrphan',
+  'GuildChannelUnowned',
+  'GuildOwned',
+  'GuildMembersTimeout',
+  'GuildUncachedMe',
+  'ChannelNotCached',
+  'StageChannelResolve',
+  'GuildScheduledEventResolve',
+  'FetchOwnerId',
+
+  'InvalidType',
+  'InvalidElement',
+
+  'MessageThreadParent',
+  'MessageExistingThread',
+  'ThreadInvitableType',
+
+  'WebhookMessage',
+  'WebhookTokenUnavailable',
+  'WebhookURLInvalid',
+  'WebhookApplication',
+  'MessageReferenceMissing',
+
+  'EmojiType',
+  'EmojiManaged',
+  'MissingManageGuildExpressionsPermission',
+  'MissingManageEmojisAndStickersPermission',
+
+  'NotGuildSticker',
+
+  'ReactionResolveUser',
+
+  'VanityURL',
+
+  'InviteResolveCode',
+
+  'InviteNotFound',
+
+  'DeleteGroupDMChannel',
+  'FetchGroupDMChannel',
+
+  'MemberFetchNonceLength',
+
+  'GlobalCommandPermissions',
+  'GuildUncachedEntityResolve',
+
+  'InteractionAlreadyReplied',
+  'InteractionNotReplied',
+  'InteractionEphemeralReplied',
+
+  'CommandInteractionOptionNotFound',
+  'CommandInteractionOptionType',
+  'CommandInteractionOptionEmpty',
+  'CommandInteractionOptionNoSubcommand',
+  'CommandInteractionOptionNoSubcommandGroup',
+  'CommandInteractionOptionInvalidChannelType',
+  'AutocompleteInteractionOptionNoFocusedOption',
+
+  'ModalSubmitInteractionFieldNotFound',
+  'ModalSubmitInteractionFieldType',
+
+  'InvalidMissingScopes',
+  'InvalidScopesWithPermissions',
+
+  'NotImplemented',
+
+  'SweepFilterReturn',
+
+  'GuildForumMessageRequired',
+];
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {DiscordjsErrorCodes}
+ * @ignore
+ */
+module.exports = Object.fromEntries(keys.map(key => [key, key]));