add validation for structures

quark-bot-discord · Aug 22, 2024 · 58b8d71 · 58b8d71
1 parent a5f4618
commit 58b8d71
Show file tree

Hide file tree

Showing 25 changed files with 233 additions and 3 deletions.
diff --git a/src/structures/Attachment.js b/src/structures/Attachment.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { CDN_BASE_URL, TO_JSON_TYPES_ENUM } from "../constants.js";
 import util from "util";
 
@@ -21,6 +22,13 @@ class Attachment {
    * @param {String} options.channelId The ID of the channel that this attachment belongs to.
    */
   constructor(client, data, { channelId } = {}) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof channelId !== "string")
+      throw new TypeError("GLUON: Channel ID must be a string");
+
     /**
      * The client instance.
      * @type {Client}
@@ -65,10 +73,10 @@ class Attachment {
 
     /**
      * The channel that this attachment belongs to.
-     * @type {BigInt?}
+     * @type {BigInt}
      * @private
      */
-    if (channelId) this.#_channel_id = BigInt(channelId);
+    this.#_channel_id = BigInt(channelId);
   }
 
   /**

diff --git a/src/structures/AuditLog.js b/src/structures/AuditLog.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import User from "./User.js";
 import util from "util";
@@ -30,10 +31,22 @@ class AuditLog {
    * @param {Client} client The client instance.
    * @param {Object} data Audit log data from Discord.
    * @param {Object} options Additional options for this structure.
-   * @param {Array<Object>} options.users Resolved users who are involved with the audit log entries.
+   * @param {Array<Object>?} options.users Resolved users who are involved with the audit log entries.
    * @param {String} options.guildId The ID of the guild that this audit log belongs to.
    */
   constructor(client, data, { users, guildId } = {}) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (
+      users &&
+      (!Array.isArray(users) || !users.every((u) => u instanceof Object))
+    )
+      throw new TypeError("GLUON: Users must be an array of objects");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/ButtonClick.js b/src/structures/ButtonClick.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import Interaction from "./Interaction.js";
 import Message from "./Message.js";
@@ -23,6 +24,15 @@ class ButtonClick extends Interaction {
   constructor(client, data, { guildId, channelId } = {}) {
     super(client, data);
 
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof channelId !== "string")
+      throw new TypeError("GLUON: Channel ID must be a string");
+
     this.#_client = client;
 
     /**

diff --git a/src/structures/CategoryChannel.js b/src/structures/CategoryChannel.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import Channel from "./Channel.js";
 import PermissionOverwrite from "./PermissionOverwrite.js";
@@ -22,6 +23,15 @@ class CategoryChannel {
    * @param {Boolean} options.nocache Whether this channel should be cached or not.
    */
   constructor(client, data, { guildId, nocache = false } = { nocache: false }) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Channel.js b/src/structures/Channel.js
@@ -38,6 +38,13 @@ class Channel {
    * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-structure}
    */
   constructor(client, data, { guildId } = {}) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Emoji.js b/src/structures/Emoji.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { CDN_BASE_URL, TO_JSON_TYPES_ENUM } from "../constants.js";
 import GluonCacheOptions from "../managers/GluonCacheOptions.js";
 import GuildCacheOptions from "../managers/GuildCacheOptions.js";
@@ -22,6 +23,15 @@ class Emoji {
    * @param {Boolean?} options.nocache Whether this emoji should be cached or not.
    */
   constructor(client, data, { guildId, nocache = false } = { nocache: false }) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Guild.js b/src/structures/Guild.js
@@ -64,6 +64,13 @@ class Guild {
    * @see {@link https://discord.com/developers/docs/resources/guild#guild-object}
    */
   constructor(client, data, { nocache = false } = { nocache: false }) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Interaction.js b/src/structures/Interaction.js
@@ -4,6 +4,7 @@ import TextInput from "../util/builder/textInputBuilder.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import util from "util";
 import Message from "./Message.js";
+import Client from "../Client.js";
 
 /**
  * Represents an interaction received over the gateway.
@@ -23,6 +24,11 @@ class Interaction {
    * @param {Object} data The interaction data from Discord.
    */
   constructor(client, data) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Invite.js b/src/structures/Invite.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { INVITE_BASE_URL, TO_JSON_TYPES_ENUM } from "../constants.js";
 import GluonCacheOptions from "../managers/GluonCacheOptions.js";
 import GuildCacheOptions from "../managers/GuildCacheOptions.js";
@@ -26,6 +27,15 @@ class Invite {
    * @see {@link https://discord.com/developers/docs/resources/invite#invite-object-invite-structure}
    */
   constructor(client, data, { guildId, nocache = false } = { nocache: false }) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Member.js b/src/structures/Member.js
@@ -50,6 +50,19 @@ class Member {
       nocache: false,
     },
   ) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof userId !== "string")
+      throw new TypeError("GLUON: User ID must be a string");
+    if (typeof user !== "undefined" && typeof user !== "object")
+      throw new TypeError("GLUON: User must be an object");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Message.js b/src/structures/Message.js
@@ -69,6 +69,19 @@ class Message {
       ignoreExisting: false,
     },
   ) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof channelId !== "string")
+      throw new TypeError("GLUON: Channel ID must be a string");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+    if (typeof ignoreExisting !== "boolean")
+      throw new TypeError("GLUON: Ignore existing must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/ModalResponse.js b/src/structures/ModalResponse.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import Interaction from "./Interaction.js";
 import util from "util";
@@ -17,6 +18,11 @@ class ModalResponse extends Interaction {
   constructor(client, data) {
     super(client, data);
 
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+
     /**
      * The entered modal values.
      * @type {Array<Object>}

diff --git a/src/structures/OptionSelect.js b/src/structures/OptionSelect.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import Interaction from "./Interaction.js";
 import Message from "./Message.js";
@@ -24,6 +25,20 @@ class OptionSelect extends Interaction {
   constructor(client, data, { channelId, guildId }) {
     super(client, data);
 
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof channelId !== "string")
+      throw new TypeError("GLUON: Channel ID must be a string");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+
+    /**
+     * The client instance.
+     * @type {Client}
+     * @private
+     */
     this.#_client = client;
 
     /**

diff --git a/src/structures/PermissionOverwrite.js b/src/structures/PermissionOverwrite.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import util from "util";
 
@@ -13,6 +14,11 @@ class PermissionOverwrite {
    * @param {Object} data The raw permission overwrite data.
    */
   constructor(client, data) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Poll.js b/src/structures/Poll.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import MessagePollManager from "../managers/MessagePollManager.js";
 import Emoji from "./Emoji.js";
@@ -20,6 +21,13 @@ class Poll {
    * @param {String} options.guildId The ID of the guild that this poll belongs to.
    */
   constructor(client, data, { guildId } = {}) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Reaction.js b/src/structures/Reaction.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import Emoji from "./Emoji.js";
 import util from "util";
@@ -21,6 +22,13 @@ class Reaction {
    * @see {@link https://discord.com/developers/docs/resources/channel#reaction-object-reaction-structure}
    */
   constructor(client, data, { guildId } = {}) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/Role.js b/src/structures/Role.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { CDN_BASE_URL, TO_JSON_TYPES_ENUM } from "../constants.js";
 import GluonCacheOptions from "../managers/GluonCacheOptions.js";
 import GuildCacheOptions from "../managers/GuildCacheOptions.js";
@@ -27,6 +28,15 @@ class Role {
    * @see {@link https://discord.com/developers/docs/topics/permissions#role-object-role-structure}
    */
   constructor(client, data, { guildId, nocache = false } = { nocache: false }) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/ScheduledEvent.js b/src/structures/ScheduledEvent.js
@@ -3,6 +3,7 @@ import { CDN_BASE_URL, TO_JSON_TYPES_ENUM } from "../constants.js";
 import GluonCacheOptions from "../managers/GluonCacheOptions.js";
 import GuildCacheOptions from "../managers/GuildCacheOptions.js";
 import util from "util";
+import Client from "../Client.js";
 
 /**
  * Represents an scheduled event.
@@ -31,6 +32,15 @@ class ScheduledEvent {
    * @param {Boolean?} options.nocache Whether this event should be cached or not.
    */
   constructor(client, data, { guildId, nocache = false } = { nocache: false }) {
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+    if (typeof guildId !== "string")
+      throw new TypeError("GLUON: Guild ID must be a string");
+    if (typeof nocache !== "boolean")
+      throw new TypeError("GLUON: No cache must be a boolean");
+
     /**
      * The client instance.
      * @type {Client}

diff --git a/src/structures/SlashCommand.js b/src/structures/SlashCommand.js
@@ -1,3 +1,4 @@
+import Client from "../Client.js";
 import { TO_JSON_TYPES_ENUM } from "../constants.js";
 import Interaction from "./Interaction.js";
 import util from "util";
@@ -17,6 +18,11 @@ class SlashCommand extends Interaction {
   constructor(client, data) {
     super(client, data);
 
+    if (!(client instanceof Client))
+      throw new TypeError("GLUON: Client must be an instance of Client");
+    if (typeof data !== "object")
+      throw new TypeError("GLUON: Data must be an object");
+
     /**
      * Raw slash command data from discord.
      * @type {Object?}