xernerx 4.2.0 → 4.2.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Dummi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Dummi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/build/ContextCommandBuilder.d.ts

@@ -0,0 +1,68 @@
+import { ContextMenuCommandBuilder, Interaction } from 'discord.js';
+import { ContextCommandOptions } from '../types/options.js';
+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: string;
+    data: ContextMenuCommandBuilder;
+    name: string;
+    type: import('@discordjs/builders').ContextMenuCommandType;
+    description: string | undefined;
+    info: string | undefined;
+    category: string | undefined;
+    channelType: number | number[] | undefined;
+    cooldown: number | undefined;
+    ignore:
+        | {
+              owner?: boolean | undefined;
+              users?: string[] | undefined;
+              channels?: string[] | undefined;
+              guilds?: string[] | undefined;
+          }
+        | undefined;
+    strict:
+        | {
+              owner?: boolean | undefined;
+              users?: string[] | undefined;
+              channels?: string[] | undefined;
+              guilds?: string[] | undefined;
+          }
+        | undefined;
+    permissions:
+        | {
+              client?: string[] | undefined;
+              users?: string[] | undefined;
+              dm?: boolean | undefined;
+          }
+        | undefined;
+    defer:
+        | {
+              /**
+               * @param {Interaction} interaction - The Discord interaction event data.
+               * @description Make your custom command here.
+               * TODO - update description
+               */
+              reply?: boolean | undefined;
+              ephemeral?: boolean | undefined;
+              fetch?: boolean | undefined;
+          }
+        | undefined;
+    client: typeof XernerxClient;
+    constructor(id: string, options: ContextCommandOptions);
+    /**
+     * @param {Interaction} interaction - The Discord interaction event data.
+     * @description make any preconditions here.
+     * TODO - update description
+     */
+    conditions(interaction: Interaction, args: any): Promise<void>;
+    /**
+     * @param {Interaction} interaction - The Discord interaction event data.
+     * @description Make your custom command here.
+     * TODO - update description
+     */
+    exec(interaction: Interaction, args: any): Promise<void>;
+}

package/dist/cjs/build/ContextCommandBuilder.js

@@ -0,0 +1,97 @@
+'use strict';
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, '__esModule', { value: true });
+const discord_js_1 = require('discord.js');
+const zod_1 = require('zod');
+const XernerxClient_js_1 = __importDefault(require('../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.
+ */
+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 discord_js_1.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);
+        zod_1.z
+            .object({
+                description: zod_1.z.string(),
+                info: zod_1.z.string(),
+                category: zod_1.z.string(),
+                channelType: zod_1.z.array(zod_1.z.number()).or(zod_1.z.number()),
+                cooldown: zod_1.z.number(),
+                ignore: zod_1.z.object({
+                    owner: zod_1.z.boolean(),
+                    users: zod_1.z.array(zod_1.z.string()),
+                    channels: zod_1.z.array(zod_1.z.string()),
+                    guilds: zod_1.z.array(zod_1.z.string()),
+                }),
+                strict: zod_1.z.object({
+                    owner: zod_1.z.boolean(),
+                    users: zod_1.z.array(zod_1.z.string()),
+                    channels: zod_1.z.array(zod_1.z.string()),
+                    guilds: zod_1.z.array(zod_1.z.string()),
+                }),
+                permissions: zod_1.z.object({
+                    client: zod_1.z.array(zod_1.z.string()),
+                    users: zod_1.z.array(zod_1.z.string()),
+                    dm: zod_1.z.boolean(),
+                }),
+                defer: zod_1.z.object({
+                    reply: zod_1.z.boolean(),
+                    ephemeral: zod_1.z.boolean(),
+                    fetch: zod_1.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_js_1.default;
+    }
+    /**
+     * @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) {}
+}
+exports.default = ContextCommandBuilder;

package/dist/cjs/build/EventBuilder.d.ts

@@ -0,0 +1,21 @@
+import XernerxClient from '../client/XernerxClient.js';
+import { EventOptions } from '../types/options.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: string;
+    name: string;
+    emitter: string;
+    type: string;
+    once: boolean;
+    client: typeof XernerxClient;
+    constructor(id: string, options: EventOptions);
+    /**
+     * @description run your custom event here.
+     * TODO - update description
+     */
+    run(): Promise<void>;
+}

package/dist/cjs/build/EventBuilder.js

@@ -0,0 +1,44 @@
+'use strict';
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, '__esModule', { value: true });
+const zod_1 = require('zod');
+const XernerxClient_js_1 = __importDefault(require('../client/XernerxClient.js'));
+/**
+ * @description - The event builder for  events.
+ * @param {String} id - The unique ID of the event.
+ * @param {EventOptions} options - The event options.
+ */
+class EventBuilder {
+    id;
+    name;
+    emitter;
+    type;
+    once;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        zod_1.z
+            .object({
+                name: zod_1.z.string(),
+                emitter: zod_1.z.string().optional(),
+                type: zod_1.z.string().optional(),
+                once: zod_1.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_js_1.default;
+    }
+    /**
+     * @description run your custom event here.
+     * TODO - update description
+     */
+    async run() {}
+}
+exports.default = EventBuilder;

package/dist/cjs/build/InhibitorBuilder.d.ts

@@ -0,0 +1,19 @@
+import XernerxClient from '../client/XernerxClient.js';
+import { InhibitorOptions, MessageArgumentOptions, SlashArgumentOptions } from '../types/options.js';
+import { XernerxInteraction, XernerxMessage } from '../types/types.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: string;
+    name: string;
+    type: import('../main.js').InhibitorType;
+    client: typeof XernerxClient;
+    constructor(id: string, options: InhibitorOptions);
+    /**
+     * TODO - update description
+     */
+    check(interaction: XernerxInteraction | XernerxMessage, args: SlashArgumentOptions | MessageArgumentOptions): Promise<void>;
+}

package/dist/cjs/build/InhibitorBuilder.js

@@ -0,0 +1,37 @@
+'use strict';
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, '__esModule', { value: true });
+const zod_1 = require('zod');
+const XernerxClient_js_1 = __importDefault(require('../client/XernerxClient.js'));
+/**
+ * @description - The inhibitor builder for inhibitors.
+ * @param {String} id - The unique ID of the inhibitor.
+ * @param {InhibitorOptions} options - The inhibitor options.
+ */
+class InhibitorBuilder {
+    id;
+    name;
+    type;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        zod_1.z
+            .object({
+                name: zod_1.z.string(),
+                type: zod_1.z.string(),
+            })
+            .parse(options);
+        this.name = options.name;
+        this.type = options.type;
+        this.client = XernerxClient_js_1.default;
+    }
+    /**
+     * TODO - update description
+     */
+    async check(interaction, args) {}
+}
+exports.default = InhibitorBuilder;

package/dist/cjs/build/MessageCommandBuilder.d.ts

@@ -0,0 +1,59 @@
+import { MessageArgumentOptions, MessageCommandOptions } from '../types/options.js';
+import XernerxClient from '../client/XernerxClient.js';
+import { XernerxMessage } from '../types/types.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: string;
+    name: string;
+    aliases: string[] | undefined;
+    separator: string;
+    description: string | undefined;
+    info: string | undefined;
+    category: string | undefined;
+    prefix: string[];
+    regex: string | undefined;
+    channelType: number[] | undefined;
+    ignore:
+        | {
+              owner?: boolean | undefined;
+              users?: string[] | undefined;
+              channels?: string[] | undefined;
+              guilds?: string[] | undefined;
+          }
+        | undefined;
+    strict:
+        | {
+              owner?: boolean | undefined;
+              users?: string[] | undefined;
+              channels?: string[] | undefined;
+              guilds?: string[] | undefined;
+          }
+        | undefined;
+    permissions:
+        | {
+              client?: string[] | undefined;
+              user?: string[] | undefined;
+              dm?: boolean | undefined;
+          }
+        | undefined;
+    cooldown: number;
+    args: MessageArgumentOptions[];
+    client: typeof XernerxClient;
+    constructor(id: string, options: MessageCommandOptions);
+    /**
+     * @param {Message} message - The Discord message event data.
+     * @param {object} args - The arguments you created.
+     * @description make any preconditions here.
+     */
+    conditions(message: XernerxMessage, args: MessageArgumentOptions): Promise<void>;
+    /**
+     * @param {Message} message - The Discord message event data.
+     * @param {object} args - The arguments you created.
+     * @description Make your custom command here.
+     */
+    exec(message: XernerxMessage, args: MessageArgumentOptions): Promise<void>;
+}

package/dist/cjs/build/MessageCommandBuilder.js

@@ -0,0 +1,100 @@
+'use strict';
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, '__esModule', { value: true });
+const zod_1 = require('zod');
+const XernerxClient_js_1 = __importDefault(require('../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.
+ */
+class MessageCommandBuilder {
+    id;
+    name;
+    aliases;
+    separator;
+    description;
+    info;
+    category;
+    prefix;
+    regex;
+    channelType;
+    ignore;
+    strict;
+    permissions;
+    cooldown;
+    args;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        zod_1.z
+            .object({
+                name: zod_1.z.string(),
+                aliases: zod_1.z.array(zod_1.z.string()).optional(),
+                separator: zod_1.z.string().min(1).max(1).optional(),
+                description: zod_1.z.string().optional(),
+                info: zod_1.z.string().optional(),
+                category: zod_1.z.string().optional(),
+                prefix: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                regex: zod_1.z.unknown(),
+                channelType: zod_1.z.array(zod_1.z.number()).or(zod_1.z.number()).optional(),
+                cooldown: zod_1.z.number().optional(),
+                ignore: zod_1.z
+                    .object({
+                        owners: zod_1.z.boolean().optional(),
+                        users: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                        channels: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                        guilds: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                    })
+                    .optional(),
+                strict: zod_1.z
+                    .object({
+                        owners: zod_1.z.boolean().optional(),
+                        users: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                        channels: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                        guilds: zod_1.z.array(zod_1.z.string()).or(zod_1.z.string()).optional(),
+                    })
+                    .optional(),
+                permissions: zod_1.z
+                    .object({
+                        client: zod_1.z.array(zod_1.z.string()).optional(),
+                        users: zod_1.z.array(zod_1.z.string()).optional(),
+                        dm: zod_1.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_js_1.default;
+    }
+    /**
+     * @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) {}
+}
+exports.default = MessageCommandBuilder;

package/dist/cjs/build/SlashCommandBuilder.d.ts

@@ -0,0 +1,64 @@
+import Discord, { Interaction } from 'discord.js';
+import { SlashCommandOptions } from '../types/options.js';
+import XernerxClient from '../client/XernerxClient.js';
+/**
+ * @description - The command builder for slash commands.
+ * @param {String} id - The unique ID of the command.
+ * @param {SlashCommandOptions} options - The command options.
+ */
+export default class SlashCommandBuilder {
+    id: string;
+    data: Discord.SlashCommandBuilder;
+    name: string;
+    description: string;
+    info: string | undefined;
+    category: string | undefined;
+    channelType: Discord.ChannelType | undefined;
+    cooldown: number | undefined;
+    ignore:
+        | {
+              owner?: boolean | undefined;
+              users?: string[] | undefined;
+              channels?: string[] | undefined;
+              guilds?: string[] | undefined;
+          }
+        | undefined;
+    strict:
+        | {
+              owner?: boolean | undefined;
+              users?: string[] | undefined;
+              channels?: string[] | undefined;
+              guilds?: string[] | undefined;
+          }
+        | undefined;
+    permissions: {
+        client?: string[] | undefined;
+        users?: string[] | undefined;
+        dm?: boolean | undefined;
+    };
+    args?: object[];
+    subcommands?: object[];
+    groups?: object[];
+    defer:
+        | {
+              reply?: boolean | undefined;
+              ephemeral?: boolean | undefined;
+              fetchReply?: boolean | undefined;
+          }
+        | undefined;
+    client: typeof XernerxClient;
+    constructor(id: string, options: SlashCommandOptions);
+    /**
+     * TODO - update description
+     * @param interaction
+     */
+    conditions(interaction: Interaction): Promise<void>;
+    /**
+     * TODO - update description
+     * @param interaction
+     */
+    exec(interaction: Interaction): Promise<void>;
+    private addArgs;
+    private addSubcommands;
+    private addSubcommandGroups;
+}