@velliajs/discord 1.0.0

package/src/util/DataResolver.js

@@ -0,0 +1,140 @@
+'use strict';
+
+const { Buffer } = require('node:buffer');
+const fs = require('node:fs/promises');
+const path = require('node:path');
+const { fetch } = require('undici');
+const { DiscordjsError, DiscordjsTypeError, ErrorCodes } = require('../errors');
+const Invite = require('../structures/Invite');
+
+/**
+ * The DataResolver identifies different objects and tries to resolve a specific piece of information from them.
+ * @private
+ */
+class DataResolver extends null {
+  /**
+   * Data that can be resolved to give an invite code. This can be:
+   * * An invite code
+   * * An invite URL
+   * @typedef {string} InviteResolvable
+   */
+
+  /**
+   * Data that can be resolved to give a template code. This can be:
+   * * A template code
+   * * A template URL
+   * @typedef {string} GuildTemplateResolvable
+   */
+
+  /**
+   * Resolves the string to a code based on the passed regex.
+   * @param {string} data The string to resolve
+   * @param {RegExp} regex The RegExp used to extract the code
+   * @returns {string}
+   */
+  static resolveCode(data, regex) {
+    return regex.exec(data)?.[1] ?? data;
+  }
+
+  /**
+   * Resolves InviteResolvable to an invite code.
+   * @param {InviteResolvable} data The invite resolvable to resolve
+   * @returns {string}
+   */
+  static resolveInviteCode(data) {
+    return this.resolveCode(data, Invite.InvitesPattern);
+  }
+
+  /**
+   * Resolves GuildTemplateResolvable to a template code.
+   * @param {GuildTemplateResolvable} data The template resolvable to resolve
+   * @returns {string}
+   */
+  static resolveGuildTemplateCode(data) {
+    const GuildTemplate = require('../structures/GuildTemplate');
+    return this.resolveCode(data, GuildTemplate.GuildTemplatesPattern);
+  }
+
+  /**
+   * Resolves a Base64Resolvable, a string, or a BufferResolvable to a Base 64 image.
+   * @param {BufferResolvable|Base64Resolvable} image The image to be resolved
+   * @returns {Promise<?string>}
+   */
+  static async resolveImage(image) {
+    if (!image) return null;
+    if (typeof image === 'string' && image.startsWith('data:')) {
+      return image;
+    }
+    const file = await this.resolveFile(image);
+    return this.resolveBase64(file.data);
+  }
+
+  /**
+   * Data that resolves to give a Base64 string, typically for image uploading. This can be:
+   * * A Buffer
+   * * A base64 string
+   * @typedef {Buffer|string} Base64Resolvable
+   */
+
+  /**
+   * Resolves a Base64Resolvable to a Base 64 image.
+   * @param {Base64Resolvable} data The base 64 resolvable you want to resolve
+   * @returns {?string}
+   */
+  static resolveBase64(data) {
+    if (Buffer.isBuffer(data)) return `data:image/jpg;base64,${data.toString('base64')}`;
+    return data;
+  }
+
+  /**
+   * Data that can be resolved to give a Buffer. This can be:
+   * * A Buffer
+   * * The path to a local file
+   * * A URL <warn>When provided a URL, discord.js will fetch the URL internally in order to create a Buffer.
+   * This can pose a security risk when the URL has not been sanitized</warn>
+   * @typedef {string|Buffer} BufferResolvable
+   */
+
+  /**
+   * @external Stream
+   * @see {@link https://nodejs.org/api/stream.html}
+   */
+
+  /**
+   * @typedef {Object} ResolvedFile
+   * @property {Buffer} data Buffer containing the file data
+   * @property {string} [contentType] Content type of the file
+   */
+
+  /**
+   * Resolves a BufferResolvable to a Buffer.
+   * @param {BufferResolvable|Stream} resource The buffer or stream resolvable to resolve
+   * @returns {Promise<ResolvedFile>}
+   */
+  static async resolveFile(resource) {
+    if (Buffer.isBuffer(resource)) return { data: resource };
+
+    if (typeof resource[Symbol.asyncIterator] === 'function') {
+      const buffers = [];
+      for await (const data of resource) buffers.push(Buffer.from(data));
+      return { data: Buffer.concat(buffers) };
+    }
+
+    if (typeof resource === 'string') {
+      if (/^https?:\/\//.test(resource)) {
+        const res = await fetch(resource);
+        return { data: Buffer.from(await res.arrayBuffer()), contentType: res.headers.get('content-type') };
+      }
+
+      const file = path.resolve(resource);
+
+      const stats = await fs.stat(file);
+      if (!stats.isFile()) throw new DiscordjsError(ErrorCodes.FileNotFound, file);
+      return { data: await fs.readFile(file) };
+    }
+
+    throw new DiscordjsTypeError(ErrorCodes.ReqResourceType);
+  }
+}
+
+module.exports = DataResolver;

package/src/util/Enums.js

@@ -0,0 +1,13 @@
+'use strict';
+
+function createEnum(keys) {
+  const obj = {};
+  for (const [index, key] of keys.entries()) {
+    if (key === null) continue;
+    obj[key] = index;
+    obj[index] = key;
+  }
+  return obj;
+}
+
+module.exports = { createEnum };

package/src/util/Events.js

@@ -0,0 +1,160 @@
+'use strict';
+
+/**
+ * @typedef {Object} Events
+ * @property {string} ApplicationCommandPermissionsUpdate applicationCommandPermissionsUpdate
+ * @property {string} AutoModerationActionExecution autoModerationActionExecution
+ * @property {string} AutoModerationRuleCreate autoModerationRuleCreate
+ * @property {string} AutoModerationRuleDelete autoModerationRuleDelete
+ * @property {string} AutoModerationRuleUpdate autoModerationRuleUpdate
+ * @property {string} CacheSweep cacheSweep
+ * @property {string} ChannelCreate channelCreate
+ * @property {string} ChannelDelete channelDelete
+ * @property {string} ChannelPinsUpdate channelPinsUpdate
+ * @property {string} ChannelUpdate channelUpdate
+ * @property {string} ClientReady ready
+ * @property {string} Debug debug
+ * @property {string} Error error
+ * @property {string} GuildAuditLogEntryCreate guildAuditLogEntryCreate
+ * @property {string} GuildBanAdd guildBanAdd
+ * @property {string} GuildBanRemove guildBanRemove
+ * @property {string} GuildCreate guildCreate
+ * @property {string} GuildDelete guildDelete
+ * @property {string} GuildEmojiCreate emojiCreate
+ * @property {string} GuildEmojiDelete emojiDelete
+ * @property {string} GuildEmojiUpdate emojiUpdate
+ * @property {string} GuildIntegrationsUpdate guildIntegrationsUpdate
+ * @property {string} GuildMemberAdd guildMemberAdd
+ * @property {string} GuildMemberAvailable guildMemberAvailable
+ * @property {string} GuildMemberRemove guildMemberRemove
+ * @property {string} GuildMembersChunk guildMembersChunk
+ * @property {string} GuildMemberUpdate guildMemberUpdate
+ * @property {string} GuildRoleCreate roleCreate
+ * @property {string} GuildRoleDelete roleDelete
+ * @property {string} GuildRoleUpdate roleUpdate
+ * @property {string} GuildScheduledEventCreate guildScheduledEventCreate
+ * @property {string} GuildScheduledEventDelete guildScheduledEventDelete
+ * @property {string} GuildScheduledEventUpdate guildScheduledEventUpdate
+ * @property {string} GuildScheduledEventUserAdd guildScheduledEventUserAdd
+ * @property {string} GuildScheduledEventUserRemove guildScheduledEventUserRemove
+ * @property {string} GuildStickerCreate stickerCreate
+ * @property {string} GuildStickerDelete stickerDelete
+ * @property {string} GuildStickerUpdate stickerUpdate
+ * @property {string} GuildUnavailable guildUnavailable
+ * @property {string} GuildUpdate guildUpdate
+ * @property {string} InteractionCreate interactionCreate
+ * @property {string} Invalidated invalidated
+ * @property {string} InviteCreate inviteCreate
+ * @property {string} InviteDelete inviteDelete
+ * @property {string} MessageBulkDelete messageDeleteBulk
+ * @property {string} MessageCreate messageCreate
+ * @property {string} MessageDelete messageDelete
+ * @property {string} MessageReactionAdd messageReactionAdd
+ * @property {string} MessageReactionRemove messageReactionRemove
+ * @property {string} MessageReactionRemoveAll messageReactionRemoveAll
+ * @property {string} MessageReactionRemoveEmoji messageReactionRemoveEmoji
+ * @property {string} MessageUpdate messageUpdate
+ * @property {string} PresenceUpdate presenceUpdate
+ * @property {string} ShardDisconnect shardDisconnect
+ * @property {string} ShardError shardError
+ * @property {string} ShardReady shardReady
+ * @property {string} ShardReconnecting shardReconnecting
+ * @property {string} ShardResume shardResume
+ * @property {string} StageInstanceCreate stageInstanceCreate
+ * @property {string} StageInstanceDelete stageInstanceDelete
+ * @property {string} StageInstanceUpdate stageInstanceUpdate
+ * @property {string} ThreadCreate threadCreate
+ * @property {string} ThreadDelete threadDelete
+ * @property {string} ThreadListSync threadListSync
+ * @property {string} ThreadMembersUpdate threadMembersUpdate
+ * @property {string} ThreadMemberUpdate threadMemberUpdate
+ * @property {string} ThreadUpdate threadUpdate
+ * @property {string} TypingStart typingStart
+ * @property {string} UserUpdate userUpdate
+ * @property {string} VoiceServerUpdate voiceServerUpdate
+ * @property {string} VoiceStateUpdate voiceStateUpdate
+ * @property {string} Warn warn
+ * @property {string} WebhooksUpdate webhookUpdate
+ */
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {Events}
+ * @ignore
+ */
+module.exports = {
+  ApplicationCommandPermissionsUpdate: 'applicationCommandPermissionsUpdate',
+  AutoModerationActionExecution: 'autoModerationActionExecution',
+  AutoModerationRuleCreate: 'autoModerationRuleCreate',
+  AutoModerationRuleDelete: 'autoModerationRuleDelete',
+  AutoModerationRuleUpdate: 'autoModerationRuleUpdate',
+  CacheSweep: 'cacheSweep',
+  ChannelCreate: 'channelCreate',
+  ChannelDelete: 'channelDelete',
+  ChannelPinsUpdate: 'channelPinsUpdate',
+  ChannelUpdate: 'channelUpdate',
+  ClientReady: 'ready',
+  Debug: 'debug',
+  Error: 'error',
+  GuildAuditLogEntryCreate: 'guildAuditLogEntryCreate',
+  GuildBanAdd: 'guildBanAdd',
+  GuildBanRemove: 'guildBanRemove',
+  GuildCreate: 'guildCreate',
+  GuildDelete: 'guildDelete',
+  GuildEmojiCreate: 'emojiCreate',
+  GuildEmojiDelete: 'emojiDelete',
+  GuildEmojiUpdate: 'emojiUpdate',
+  GuildIntegrationsUpdate: 'guildIntegrationsUpdate',
+  GuildMemberAdd: 'guildMemberAdd',
+  GuildMemberAvailable: 'guildMemberAvailable',
+  GuildMemberRemove: 'guildMemberRemove',
+  GuildMembersChunk: 'guildMembersChunk',
+  GuildMemberUpdate: 'guildMemberUpdate',
+  GuildRoleCreate: 'roleCreate',
+  GuildRoleDelete: 'roleDelete',
+  GuildRoleUpdate: 'roleUpdate',
+  GuildScheduledEventCreate: 'guildScheduledEventCreate',
+  GuildScheduledEventDelete: 'guildScheduledEventDelete',
+  GuildScheduledEventUpdate: 'guildScheduledEventUpdate',
+  GuildScheduledEventUserAdd: 'guildScheduledEventUserAdd',
+  GuildScheduledEventUserRemove: 'guildScheduledEventUserRemove',
+  GuildStickerCreate: 'stickerCreate',
+  GuildStickerDelete: 'stickerDelete',
+  GuildStickerUpdate: 'stickerUpdate',
+  GuildUnavailable: 'guildUnavailable',
+  GuildUpdate: 'guildUpdate',
+  InteractionCreate: 'interactionCreate',
+  Invalidated: 'invalidated',
+  InviteCreate: 'inviteCreate',
+  InviteDelete: 'inviteDelete',
+  MessageBulkDelete: 'messageDeleteBulk',
+  MessageCreate: 'messageCreate',
+  MessageDelete: 'messageDelete',
+  MessageReactionAdd: 'messageReactionAdd',
+  MessageReactionRemove: 'messageReactionRemove',
+  MessageReactionRemoveAll: 'messageReactionRemoveAll',
+  MessageReactionRemoveEmoji: 'messageReactionRemoveEmoji',
+  MessageUpdate: 'messageUpdate',
+  PresenceUpdate: 'presenceUpdate',
+  Raw: 'raw',
+  ShardDisconnect: 'shardDisconnect',
+  ShardError: 'shardError',
+  ShardReady: 'shardReady',
+  ShardReconnecting: 'shardReconnecting',
+  ShardResume: 'shardResume',
+  StageInstanceCreate: 'stageInstanceCreate',
+  StageInstanceDelete: 'stageInstanceDelete',
+  StageInstanceUpdate: 'stageInstanceUpdate',
+  ThreadCreate: 'threadCreate',
+  ThreadDelete: 'threadDelete',
+  ThreadListSync: 'threadListSync',
+  ThreadMembersUpdate: 'threadMembersUpdate',
+  ThreadMemberUpdate: 'threadMemberUpdate',
+  ThreadUpdate: 'threadUpdate',
+  TypingStart: 'typingStart',
+  UserUpdate: 'userUpdate',
+  VoiceServerUpdate: 'voiceServerUpdate',
+  VoiceStateUpdate: 'voiceStateUpdate',
+  Warn: 'warn',
+  WebhooksUpdate: 'webhookUpdate',
+};