xernerx 3.4.2 → 3.5.0

package/README.md

@@ -4,18 +4,18 @@ Xernerx is a class based discord.js framework. \[BETA\]
 
 ## Includes
 
-> - Slash command handler
-> - Message command handler
-> - Context command handler
-> - Event handler (with custom Events)
-> - Inhibitor handler
-> - Custom utilities
-> - Message command handles
-> - Extension support
+> -   Slash command handler
+> -   Message command handler
+> -   Context command handler
+> -   Event handler (with custom Events)
+> -   Inhibitor handler
+> -   Custom utilities
+> -   Message command handles
+> -   Extension support
 
 You can checkout the docs [here](https://xernerx.github.io/xernerx/home.html)
 
 ## Notes
 
-- Only compatible with ESM
-- TypeScript and JavaScript support
+-   Only compatible with ESM
+-   TypeScript and JavaScript support

package/dist/build/ContextCommandBuilder.js

@@ -1,88 +1,93 @@
-import { ContextMenuCommandBuilder } from 'discord.js';
-import { s } from '@sapphire/shapeshift';
-import XernerxClient from '../client/XernerxClient.js';
-/**
- * @description The command builder for context commands.
- * @param {String} id - The unique ID of the command.
- * @param {ContextCommandOptions} options - The command options.
- */
-export default class ContextCommandBuilder {
-    id;
-    data;
-    name;
-    type;
-    description;
-    info;
-    category;
-    owner;
-    channelType;
-    cooldown;
-    ignoreOwner;
-    channels;
-    guilds;
-    userPermissions;
-    clientPermissions;
-    defer;
-    client;
-    constructor(id, options) {
-        this.id = id;
-        this.data = new ContextMenuCommandBuilder();
-        if (options.name)
-            this.data.setName(options.name);
-        if (options.type)
-            this.data.setType(options.type);
-        if (options.defaultMemberPermissions)
-            this.data.setDefaultMemberPermissions(options.defaultMemberPermissions);
-        if (options.DMPermission)
-            this.data.setDMPermission(options.DMPermission);
-        if (options.nameLocalization)
-            this.data.setNameLocalization(options.nameLocalization.locale, options.nameLocalization.localizedName);
-        if (options.nameLocalizations)
-            this.data.setNameLocalizations(options.nameLocalizations);
-        s.object({
-            description: s.string.optional,
-            info: s.string.optional,
-            category: s.string.optional,
-            owner: s.boolean.optional,
-            channelType: s.union(s.number, s.array(s.number)).optional,
-            cooldown: s.number.optional,
-            ignoreOwner: s.boolean.optional,
-            channels: s.array(s.string).optional,
-            guilds: s.array(s.string).optional,
-            userPermissions: s.array(s.bigint).optional,
-            clientPermissions: s.array(s.bigint).optional,
-            defer: s.object({
-                reply: s.boolean.optional,
-                ephemeral: s.boolean.optional,
-                fetchReply: s.boolean.optional,
-            }).optional,
-        }).parse(options);
-        this.name = options.name;
-        this.type = options.type;
-        this.description = options.description;
-        this.info = options.info;
-        this.category = options.category;
-        this.owner = options.owner;
-        this.channelType = options.channelType;
-        this.cooldown = options.cooldown;
-        this.ignoreOwner = options.ignoreOwner;
-        this.channels = options.channels;
-        this.guilds = options.guilds;
-        this.userPermissions = options.userPermissions;
-        this.clientPermissions = options.clientPermissions;
-        this.defer = options.defer;
-        this.client = XernerxClient;
-        this.conditions = this.conditions;
-        this.exec = this.exec;
-    }
-    /**
-     * @param {Interaction} interaction - The Discord interaction event data.
-     * @description make any preconditions here.
-     */
-    async conditions(interaction) { }
-    /**
-     * @param {Interaction} interaction - The Discord interaction event data.
-     * @description Make your custom command here.
-     */
-    async exec(interaction) { }
-}
+import { ContextMenuCommandBuilder } from 'discord.js';
+import { z } from 'zod';
+import XernerxClient from '../client/XernerxClient.js';
+/**
+ * @description The command builder for context commands.
+ * @param {String} id - The unique ID of the command.
+ * @param {ContextCommandOptions} options - The command options.
+ */
+export default class ContextCommandBuilder {
+    id;
+    data;
+    name;
+    type;
+    description;
+    info;
+    category;
+    channelType;
+    cooldown;
+    ignore;
+    strict;
+    permissions;
+    defer;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        this.data = new ContextMenuCommandBuilder();
+        if (options.name)
+            this.data.setName(options.name);
+        if (options.type)
+            this.data.setType(options.type);
+        if (options.permissions?.users)
+            this.data.setDefaultMemberPermissions(options.permissions?.users);
+        if (options.permissions?.dm === false)
+            this.data.setDMPermission(options.permissions?.dm);
+        if (options.nameLocalizations)
+            this.data.setNameLocalizations(options.nameLocalizations);
+        z.object({
+            description: z.string(),
+            info: z.string(),
+            category: z.string(),
+            channelType: z.array(z.number()).or(z.number()),
+            cooldown: z.number(),
+            ignore: z.object({
+                owner: z.boolean(),
+                users: z.array(z.string()),
+                channels: z.array(z.string()),
+                guilds: z.array(z.string()),
+            }),
+            strict: z.object({
+                owner: z.boolean(),
+                users: z.array(z.string()),
+                channels: z.array(z.string()),
+                guilds: z.array(z.string()),
+            }),
+            permissions: z.object({
+                client: z.array(z.string()),
+                users: z.array(z.string()),
+                dm: z.boolean(),
+            }),
+            defer: z.object({
+                reply: z.boolean(),
+                ephemeral: z.boolean(),
+                fetch: z.boolean(),
+            }),
+        })
+            .deepPartial()
+            .parse(options);
+        this.name = options.name;
+        this.type = options.type;
+        this.description = options.description;
+        this.info = options.info;
+        this.category = options.category;
+        this.channelType = options.channelType;
+        this.cooldown = options.cooldown;
+        this.ignore = options.ignore;
+        this.strict = options.strict;
+        this.permissions = options.permissions;
+        this.defer = options.defer;
+        this.client = XernerxClient;
+    }
+    /**
+     * @param {Interaction} interaction - The Discord interaction event data.
+     * @description make any preconditions here.
+     * TODO - update description
+     */
+    async conditions(interaction, args) { }
+    /**
+     * @param {Interaction} interaction - The Discord interaction event data.
+     * @description Make your custom command here.
+     * TODO - update description
+     */
+    async exec(interaction, args) { }
+}

package/dist/build/EventBuilder.js

@@ -1,35 +1,34 @@
-import { s } from '@sapphire/shapeshift';
-import XernerxClient from '../client/XernerxClient.js';
-/**
- * @description - The event builder for  events.
- * @param {String} id - The unique ID of the event.
- * @param {EventOptions} options - The event options.
- */
-export default class EventBuilder {
-    id;
-    name;
-    emitter;
-    type;
-    once;
-    client;
-    constructor(id, options) {
-        this.id = id;
-        s.object({
-            name: s.string,
-            emitter: s.string.optional,
-            type: s.string.optional,
-            once: s.boolean.optional,
-        }).parse(options);
-        this.name = options.name;
-        this.emitter = options.emitter || 'client';
-        this.type = options.type || 'discord';
-        this.once = options.once || false;
-        this.client = XernerxClient;
-        this.run = this.run;
-    }
-    async run() {
-        /**
-         * @description run your custom event here.
-         */
-    }
-}
+import { z } from 'zod';
+import XernerxClient from '../client/XernerxClient.js';
+/**
+ * @description - The event builder for  events.
+ * @param {String} id - The unique ID of the event.
+ * @param {EventOptions} options - The event options.
+ */
+export default class EventBuilder {
+    id;
+    name;
+    emitter;
+    type;
+    once;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        z.object({
+            name: z.string(),
+            emitter: z.string().optional(),
+            type: z.string().optional(),
+            once: z.boolean().optional(),
+        }).parse(options);
+        this.name = options.name;
+        this.emitter = options.emitter || 'client';
+        this.type = options.type || 'discord';
+        this.once = options.once || false;
+        this.client = XernerxClient;
+    }
+    /**
+     * @description run your custom event here.
+     * TODO - update description
+     */
+    async run() { }
+}

package/dist/build/InhibitorBuilder.js

@@ -1,28 +1,27 @@
-import { s } from '@sapphire/shapeshift';
-import XernerxClient from '../client/XernerxClient.js';
-/**
- * @description - The inhibitor builder for inhibitors.
- * @param {String} id - The unique ID of the inhibitor.
- * @param {InhibitorOptions} options - The inhibitor options.
- */
-export default class InhibitorBuilder {
-    id;
-    name;
-    type;
-    client;
-    constructor(id, options) {
-        this.id = id;
-        s.object({
-            name: s.string,
-            type: s.string,
-        }).parse(options);
-        this.name = options.name;
-        this.type = options.type;
-        this.client = XernerxClient;
-        this.check = this.check;
-    }
-    /**
-     *
-     */
-    async check(interaction, args) { }
-}
+import { z } from 'zod';
+import XernerxClient from '../client/XernerxClient.js';
+/**
+ * @description - The inhibitor builder for inhibitors.
+ * @param {String} id - The unique ID of the inhibitor.
+ * @param {InhibitorOptions} options - The inhibitor options.
+ */
+export default class InhibitorBuilder {
+    id;
+    name;
+    type;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        z.object({
+            name: z.string(),
+            type: z.string(),
+        }).parse(options);
+        this.name = options.name;
+        this.type = options.type;
+        this.client = XernerxClient;
+    }
+    /**
+     * TODO - update description
+     */
+    async check(interaction, args) { }
+}

package/dist/build/MessageCommandBuilder.js

@@ -1,80 +1,90 @@
-import { s } from '@sapphire/shapeshift';
-import XernerxClient from '../client/XernerxClient.js';
-/**
- * @description - The command builder for message commands.
- * @param {String} id - The unique ID of the command.
- * @param {MessageCommandOptions} options - The command options.
- */
-export default class MessageCommandBuilder {
-    id;
-    name;
-    aliases;
-    description;
-    info;
-    category;
-    prefix;
-    regex;
-    owner;
-    channelType;
-    separator;
-    cooldown;
-    ignoreOwner;
-    channels;
-    guilds;
-    userPermissions;
-    clientPermissions;
-    args;
-    client;
-    constructor(id, options) {
-        this.id = id;
-        s.object({
-            name: s.string,
-            aliases: s.union(s.array(s.string).unique, s.string).optional,
-            description: s.string.optional,
-            info: s.string.optional,
-            category: s.string.optional,
-            prefix: s.union(s.array(s.string).unique, s.string).optional,
-            owner: s.boolean.optional,
-            channelType: s.union(s.number, s.array(s.number)).optional,
-            separator: s.string.optional,
-            cooldown: s.number.optional,
-            ignoreOwner: s.boolean.optional,
-            channels: s.array(s.string).unique.optional,
-            guilds: s.array(s.string).unique.optional,
-            userPermissions: s.array(s.bigint).unique.optional,
-            clientPermissions: s.array(s.bigint).unique.optional,
-        }).parse(options);
-        this.name = options.name;
-        this.aliases = options.aliases;
-        this.description = options.description;
-        this.info = options.info;
-        this.category = options.category;
-        this.prefix = options.prefix ? (Array.isArray(options.prefix) ? options.prefix : [options.prefix]) : [];
-        this.regex = options.regex;
-        this.owner = options.owner || false;
-        this.channelType = options.channelType;
-        this.separator = options.separator || ' ';
-        this.cooldown = options.cooldown || 0;
-        this.ignoreOwner = options.ignoreOwner || false;
-        this.channels = options.channels || [];
-        this.guilds = options.guilds || [];
-        this.userPermissions = options.userPermissions || [];
-        this.clientPermissions = options.clientPermissions || [];
-        this.args = options.args || [];
-        this.client = XernerxClient;
-        this.conditions = this.conditions;
-        this.exec = this.exec;
-    }
-    /**
-     * @param {Message} message - The Discord message event data.
-     * @param {object} args - The arguments you created.
-     * @description make any preconditions here.
-     */
-    async conditions(message, args) { }
-    /**
-     * @param {Message} message - The Discord message event data.
-     * @param {object} args - The arguments you created.
-     * @description Make your custom command here.
-     */
-    async exec(message, args) { }
-}
+import { z } from 'zod';
+import XernerxClient from '../client/XernerxClient.js';
+/**
+ * @description - The command builder for message commands.
+ * @param {String} id - The unique ID of the command.
+ * @param {MessageCommandOptions} options - The command options.
+ */
+export default class MessageCommandBuilder {
+    id;
+    name;
+    aliases;
+    separator;
+    description;
+    info;
+    category;
+    prefix;
+    regex;
+    channelType;
+    ignore;
+    strict;
+    permissions;
+    cooldown;
+    args;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        z.object({
+            name: z.string(),
+            aliases: z.array(z.string()).optional(),
+            separator: z.string().min(1).max(1).optional(),
+            description: z.string().optional(),
+            info: z.string().optional(),
+            category: z.string().optional(),
+            prefix: z.array(z.string()).or(z.string()).optional(),
+            regex: z.unknown(),
+            channelType: z.array(z.number()).or(z.number()).optional(),
+            cooldown: z.number().optional(),
+            ignore: z
+                .object({
+                owners: z.boolean().optional(),
+                users: z.array(z.string()).or(z.string()).optional(),
+                channels: z.array(z.string()).or(z.string()).optional(),
+                guilds: z.array(z.string()).or(z.string()).optional(),
+            })
+                .optional(),
+            strict: z
+                .object({
+                owners: z.boolean().optional(),
+                users: z.array(z.string()).or(z.string()).optional(),
+                channels: z.array(z.string()).or(z.string()).optional(),
+                guilds: z.array(z.string()).or(z.string()).optional(),
+            })
+                .optional(),
+            permissions: z
+                .object({
+                client: z.array(z.string()).optional(),
+                users: z.array(z.string()).optional(),
+                dm: z.boolean().optional(),
+            })
+                .optional(),
+        }).parse(options);
+        this.name = options.name;
+        this.aliases = options.aliases;
+        this.separator = options.separator || ' ';
+        this.description = options.description;
+        this.info = options.info;
+        this.category = options.category;
+        this.prefix = options.prefix ? (Array.isArray(options.prefix) ? options.prefix : [options.prefix]) : [];
+        this.regex = options.regex;
+        this.channelType = options.channelType;
+        this.ignore = options.ignore;
+        this.strict = options.strict;
+        this.permissions = options.permissions;
+        this.cooldown = options.cooldown || 0;
+        this.args = options.args || [];
+        this.client = XernerxClient;
+    }
+    /**
+     * @param {Message} message - The Discord message event data.
+     * @param {object} args - The arguments you created.
+     * @description make any preconditions here.
+     */
+    async conditions(message, args) { }
+    /**
+     * @param {Message} message - The Discord message event data.
+     * @param {object} args - The arguments you created.
+     * @description Make your custom command here.
+     */
+    async exec(message, args) { }
+}