feat(Error): port DJS error module with TypeScript compatibility

Author: fourcolverleaf

src/structures/errors/DiscordHttpsError.ts

@@ -0,0 +1,53 @@
+// reference => https://github.com/discordjs/discord.js/blob/main/packages/discord.js/src/errors/DJSError.js
+
+import { DiscordHttpsErrorCodes } from "./ErrorCode.js";
+import { Messages } from "./ErrorMessage.js";
+
+/**
+ * Extend an error of some sort into a DiscordHttpsError.
+ *
+ * @param {Error} Base Base error to extend
+ * @ignore
+ */
+function makeDiscordHttpsError<T extends new (...a: any[]) => Error>(Base: T) {
+  return class DiscordHttpsError extends Base {
+    public readonly code: DiscordHttpsErrorCodes;
+    // A mixin class must have a constructor with a single rest parameter of type 'any[]'
+    constructor(...[code, ...args]: any[]) {
+      super(formatMessage(code as DiscordHttpsErrorCodes, args));
+      this.code = code;
+      Error.captureStackTrace?.(this, DiscordHttpsError);
+    }
+
+    override get name(): string {
+      return `${super.name} [${this.code}]`;
+    }
+  };
+}
+
+/**
+ * Format the message for an error.
+ *
+ * @param code The error code
+ * @param args Arguments to pass for util format or as function args
+ * @returns Formatted string
+ * @ignore
+ */
+
+function formatMessage(code: DiscordHttpsErrorCodes, args: any[]): string {
+  if (!(code in DiscordHttpsErrorCodes)) {
+    throw new Error("Error code must be a valid DiscordHttpsErrorCodes");
+  }
+  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);
+}
+
+export const DiscordHttpsError = makeDiscordHttpsError(Error);
+export const DiscordjsTypeError = makeDiscordHttpsError(TypeError);
+export const DiscordjsRangeError = makeDiscordHttpsError(RangeError);

src/structures/errors/ErrorCode.ts

@@ -0,0 +1,138 @@
+// reference => https://github.com/discordjs/discord.js/blob/main/packages/discord.js/src/errors/ErrorCodes.js
+
+/**
+ * Enum of DiscordHttps error codes.
+ */
+
+export enum DiscordHttpsErrorCodes {
+  ClientInvalidOption = "ClientInvalidOption",
+  ClientInvalidProvidedShards = "ClientInvalidProvidedShards",
+  ClientMissingIntents = "ClientMissingIntents",
+  ClientNotReady = "ClientNotReady",
+
+  TokenInvalid = "TokenInvalid",
+  TokenMissing = "TokenMissing",
+  ApplicationCommandPermissionsTokenMissing = "ApplicationCommandPermissionsTokenMissing",
+
+  BitFieldInvalid = "BitFieldInvalid",
+
+  ShardingNoShards = "ShardingNoShards",
+  ShardingInProcess = "ShardingInProcess",
+  ShardingInvalidEvalBroadcast = "ShardingInvalidEvalBroadcast",
+  ShardingShardNotFound = "ShardingShardNotFound",
+  ShardingAlreadySpawned = "ShardingAlreadySpawned",
+  ShardingProcessExists = "ShardingProcessExists",
+  ShardingWorkerExists = "ShardingWorkerExists",
+  ShardingReadyTimeout = "ShardingReadyTimeout",
+  ShardingReadyDisconnected = "ShardingReadyDisconnected",
+  ShardingReadyDied = "ShardingReadyDied",
+  ShardingNoChildExists = "ShardingNoChildExists",
+  ShardingShardMiscalculation = "ShardingShardMiscalculation",
+
+  ColorRange = "ColorRange",
+  ColorConvert = "ColorConvert",
+
+  InviteOptionsMissingChannel = "InviteOptionsMissingChannel",
+
+  InteractionCollectorError = "InteractionCollectorError",
+
+  FileNotFound = "FileNotFound",
+
+  UserNoDMChannel = "UserNoDMChannel",
+
+  VoiceNotStageChannel = "VoiceNotStageChannel",
+  VoiceStateNotOwn = "VoiceStateNotOwn",
+  VoiceStateInvalidType = "VoiceStateInvalidType",
+
+  ReqResourceType = "ReqResourceType",
+
+  MessageBulkDeleteType = "MessageBulkDeleteType",
+  MessageContentType = "MessageContentType",
+  MessageNonceRequired = "MessageNonceRequired",
+  MessageNonceType = "MessageNonceType",
+
+  BanResolveId = "BanResolveId",
+  FetchBanResolveId = "FetchBanResolveId",
+
+  PruneDaysType = "PruneDaysType",
+
+  GuildChannelResolve = "GuildChannelResolve",
+  GuildVoiceChannelResolve = "GuildVoiceChannelResolve",
+  GuildChannelOrphan = "GuildChannelOrphan",
+  GuildChannelUnowned = "GuildChannelUnowned",
+  GuildOwned = "GuildOwned",
+  GuildMembersTimeout = "GuildMembersTimeout",
+  GuildSoundboardSoundsTimeout = "GuildSoundboardSoundsTimeout",
+  GuildUncachedMe = "GuildUncachedMe",
+  ChannelNotCached = "ChannelNotCached",
+  StageChannelResolve = "StageChannelResolve",
+  GuildScheduledEventResolve = "GuildScheduledEventResolve",
+  FetchOwnerId = "FetchOwnerId",
+
+  InvalidType = "InvalidType",
+  InvalidElement = "InvalidElement",
+
+  MessageThreadParent = "MessageThreadParent",
+  MessageExistingThread = "MessageExistingThread",
+  ThreadInvitableType = "ThreadInvitableType",
+  NotAThreadOfParent = "NotAThreadOfParent",
+
+  WebhookMessage = "WebhookMessage",
+  WebhookTokenUnavailable = "WebhookTokenUnavailable",
+  WebhookURLInvalid = "WebhookURLInvalid",
+  WebhookApplication = "WebhookApplication",
+
+  MessageReferenceMissing = "MessageReferenceMissing",
+
+  EmojiType = "EmojiType",
+  EmojiManaged = "EmojiManaged",
+  MissingManageGuildExpressionsPermission = "MissingManageGuildExpressionsPermission",
+
+  NotGuildSoundboardSound = "NotGuildSoundboardSound",
+  NotGuildSticker = "NotGuildSticker",
+
+  ReactionResolveUser = "ReactionResolveUser",
+
+  InviteResolveCode = "InviteResolveCode",
+  InviteNotFound = "InviteNotFound",
+
+  DeleteGroupDMChannel = "DeleteGroupDMChannel",
+  FetchGroupDMChannel = "FetchGroupDMChannel",
+
+  MemberFetchNonceLength = "MemberFetchNonceLength",
+
+  GlobalCommandPermissions = "GlobalCommandPermissions",
+  GuildUncachedEntityResolve = "GuildUncachedEntityResolve",
+
+  InteractionAlreadyReplied = "InteractionAlreadyReplied",
+  InteractionNotReplied = "InteractionNotReplied",
+
+  CommandInteractionOptionNotFound = "CommandInteractionOptionNotFound",
+  CommandInteractionOptionType = "CommandInteractionOptionType",
+  CommandInteractionOptionEmpty = "CommandInteractionOptionEmpty",
+  CommandInteractionOptionNoSubcommand = "CommandInteractionOptionNoSubcommand",
+  CommandInteractionOptionNoSubcommandGroup = "CommandInteractionOptionNoSubcommandGroup",
+  CommandInteractionOptionInvalidChannelType = "CommandInteractionOptionInvalidChannelType",
+  AutocompleteInteractionOptionNoFocusedOption = "AutocompleteInteractionOptionNoFocusedOption",
+
+  ModalSubmitInteractionFieldNotFound = "ModalSubmitInteractionFieldNotFound",
+  ModalSubmitInteractionFieldType = "ModalSubmitInteractionFieldType",
+
+  InvalidMissingScopes = "InvalidMissingScopes",
+  InvalidScopesWithPermissions = "InvalidScopesWithPermissions",
+
+  NotImplemented = "NotImplemented",
+
+  SweepFilterReturn = "SweepFilterReturn",
+
+  GuildForumMessageRequired = "GuildForumMessageRequired",
+
+  EntitlementCreateInvalidOwner = "EntitlementCreateInvalidOwner",
+
+  BulkBanUsersOptionEmpty = "BulkBanUsersOptionEmpty",
+
+  PollAlreadyExpired = "PollAlreadyExpired",
+
+  PermissionOverwritesTypeMandatory = "PermissionOverwritesTypeMandatory",
+  PermissionOverwritesTypeMismatch = "PermissionOverwritesTypeMismatch",
+}