xernerx 4.2.0 → 4.2.1

package/dist/cjs/build/SlashCommandBuilder.js

@@ -0,0 +1,168 @@
+'use strict';
+var __createBinding =
+    (this && this.__createBinding) ||
+    (Object.create
+        ? function (o, m, k, k2) {
+              if (k2 === undefined) k2 = k;
+              var desc = Object.getOwnPropertyDescriptor(m, k);
+              if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+                  desc = {
+                      enumerable: true,
+                      get: function () {
+                          return m[k];
+                      },
+                  };
+              }
+              Object.defineProperty(o, k2, desc);
+          }
+        : function (o, m, k, k2) {
+              if (k2 === undefined) k2 = k;
+              o[k2] = m[k];
+          });
+var __setModuleDefault =
+    (this && this.__setModuleDefault) ||
+    (Object.create
+        ? function (o, v) {
+              Object.defineProperty(o, 'default', { enumerable: true, value: v });
+          }
+        : function (o, v) {
+              o['default'] = v;
+          });
+var __importStar =
+    (this && this.__importStar) ||
+    function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k in mod) if (k !== 'default' && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, '__esModule', { value: true });
+const discord_js_1 = __importStar(require('discord.js'));
+const zod_1 = require('zod');
+const XernerxError_js_1 = __importDefault(require('../tools/XernerxError.js'));
+const XernerxClient_js_1 = __importDefault(require('../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.
+ */
+class SlashCommandBuilder {
+    id;
+    data;
+    name;
+    description;
+    info;
+    category;
+    channelType;
+    cooldown;
+    ignore;
+    strict;
+    permissions;
+    args;
+    subcommands;
+    groups;
+    defer;
+    client;
+    constructor(id, options) {
+        this.id = id;
+        this.data = new discord_js_1.default.SlashCommandBuilder().setName(options.name).setDescription(options.description);
+        if (options.args && options?.args?.length > 0) {
+            this.addArgs(this.data, options.args);
+        }
+        if (options.subcommands && options?.subcommands?.length > 0) {
+            this.addSubcommands(this.data, options.subcommands);
+        }
+        if (options.groups && options?.groups?.length > 0) {
+            this.addSubcommandGroups(options.groups);
+        }
+        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.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;
+    }
+    /**
+     * TODO - update description
+     * @param interaction
+     */
+    async conditions(interaction) {}
+    /**
+     * TODO - update description
+     * @param interaction
+     */
+    async exec(interaction) {}
+    addArgs(command, args) {
+        const types = ['boolean', 'integer', 'number', 'string', 'user', 'role', 'channel', 'mentionable'];
+        for (const argument of args) {
+            if (!types.includes(argument.type.toLowerCase())) throw new XernerxError_js_1.default(`Expected one of ${types.join(', ')}, received ${argument.type} instead.`);
+            let slashArgumentType = `${argument.type.slice(0, 1).toUpperCase()}${argument.type.slice(1).toLowerCase()}`;
+            command[`add${slashArgumentType}Option`]((option) => {
+                option
+                    .setName(argument.name)
+                    .setDescription(argument.description)
+                    .setRequired(argument.required || false);
+                if (argument.choices) option.setChoices(...argument?.choices);
+                return option;
+            });
+        }
+    }
+    addSubcommands(method, subcommands) {
+        for (const subcommand of subcommands) {
+            let sub = new discord_js_1.SlashCommandSubcommandBuilder().setName(subcommand.name).setDescription(subcommand.description);
+            if (subcommand.args?.length > 0) this.addArgs(sub, subcommand.args);
+            method.addSubcommand(sub);
+        }
+    }
+    addSubcommandGroups(groups) {
+        for (const group of groups) {
+            let subcommandGroup = new discord_js_1.SlashCommandSubcommandGroupBuilder().setName(group.name).setDescription(group.description);
+            if (group.subcommands?.length > 0) this.addSubcommands(subcommandGroup, group.subcommands);
+            this.data.addSubcommandGroup(subcommandGroup);
+        }
+    }
+}
+exports.default = SlashCommandBuilder;

package/dist/cjs/client/XernerxClient.d.ts

@@ -0,0 +1,28 @@
+import { Client, Collection } from 'discord.js';
+import ExtensionBuilder from 'xernerx-extension-builder';
+import { ClientUtil } from '../utils/ClientUtil.js';
+import { ClientOptions, DiscordOptions, ExtensionOptions, HandlerOptions } from '../types/options.js';
+import { ClientCache, ClientCommands, ClientModules } from '../types/interfaces.js';
+import EventBuilder from '../build/EventBuilder.js';
+import InhibitorBuilder from '../build/InhibitorBuilder.js';
+/**
+ * @description - The Client.
+ * @param {DiscordOptions} discordOptions - The options for discord.js.
+ * @param {ClientOptions} clientOptions - The options for the Xernerx Client.
+ * @extends {Client}
+ */
+export default class XernerxClient extends Client {
+    settings: ClientOptions;
+    commands: ClientCommands;
+    cache: ClientCache;
+    modules: ClientModules;
+    util: ClientUtil;
+    handlerOptions: HandlerOptions;
+    events: Collection<string, EventBuilder>;
+    extensions: Record<string, ExtensionBuilder>;
+    inhibitors: Collection<string, InhibitorBuilder>;
+    config: object;
+    constructor(discordOptions: DiscordOptions, clientOptions: ClientOptions, config?: object);
+    register(token: string): void;
+    loadAllExtensions(options: ExtensionOptions): Promise<void>;
+}

package/dist/cjs/client/XernerxClient.js

@@ -0,0 +1,116 @@
+'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 dumfunctions_1 = require('dumfunctions');
+const ClientUtil_js_1 = require('../utils/ClientUtil.js');
+const CommandHandler_js_1 = __importDefault(require('../handlers/CommandHandler.js'));
+const EventHandler_js_1 = __importDefault(require('../handlers/EventHandler.js'));
+const InhibitorHandler_js_1 = __importDefault(require('../handlers/InhibitorHandler.js'));
+const Extensions_js_1 = __importDefault(require('../models/Extensions.js'));
+// TODO - Add commandNotFound as an event to the client.
+/**
+ * @description - The Client.
+ * @param {DiscordOptions} discordOptions - The options for discord.js.
+ * @param {ClientOptions} clientOptions - The options for the Xernerx Client.
+ * @extends {Client}
+ */
+class XernerxClient extends discord_js_1.Client {
+    settings;
+    commands;
+    cache;
+    modules;
+    util;
+    handlerOptions;
+    events;
+    extensions;
+    inhibitors;
+    config;
+    constructor(discordOptions, clientOptions, config) {
+        super(discordOptions);
+        this.settings = zod_1.z
+            .object({
+                ownerId: zod_1.z.string().or(zod_1.z.array(zod_1.z.string())).default([]),
+                permissions: zod_1.z
+                    .object({
+                        client: zod_1.z.array(zod_1.z.string()).default([]),
+                        user: zod_1.z.array(zod_1.z.string()).default([]),
+                        dm: zod_1.z.boolean().default(false),
+                    })
+                    .optional(),
+                ignore: zod_1.z
+                    .object({
+                        owner: zod_1.z.boolean().default(false),
+                        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()),
+                    })
+                    .optional(),
+                log: zod_1.z
+                    .object({
+                        ready: zod_1.z.boolean().default(false),
+                        error: zod_1.z.boolean().default(false),
+                    })
+                    .optional(),
+                cooldown: zod_1.z
+                    .object({
+                        command: zod_1.z.number().default(0),
+                        cache: zod_1.z.number().default(0),
+                    })
+                    .optional(),
+            })
+            .parse(clientOptions);
+        this.config = config || {};
+        this.commands = {
+            message: new discord_js_1.Collection(),
+            slash: new discord_js_1.Collection(),
+            context: new discord_js_1.Collection(),
+        };
+        this.events = new discord_js_1.Collection();
+        this.inhibitors = new discord_js_1.Collection();
+        this.cache = {
+            messages: new discord_js_1.Collection(),
+            cooldowns: new discord_js_1.Collection(),
+            messageCommands: new discord_js_1.Collection(),
+            slashCommands: new discord_js_1.Collection(),
+            contextCommands: new discord_js_1.Collection(),
+            commands: new discord_js_1.Collection(),
+        };
+        this.modules = {
+            commandHandler: new CommandHandler_js_1.default(this),
+            eventHandler: new EventHandler_js_1.default(this),
+            inhibitorHandler: new InhibitorHandler_js_1.default(this),
+        };
+        this.extensions = {};
+        this.util = new ClientUtil_js_1.ClientUtil(this);
+        this.handlerOptions = {};
+        if (this.settings?.log?.ready) {
+            this.once('ready', async (client) => {
+                const size = (await client.guilds.fetch()).size;
+                console.info(
+                    dumfunctions_1.Style.log(
+                        `Xernerx | ${client.user.tag} signed in watching ${size} server${size > 1 ? 's' : ''}. ${
+                            (this.handlerOptions.slash || this.handlerOptions.context)?.guildId
+                                ? `Using ${(await this.guilds.fetch((this.handlerOptions.slash || this.handlerOptions.context)?.guildId || '0')).name} as local guild.`
+                                : ''
+                        }`,
+                        { color: dumfunctions_1.Style.TextColor.Purple }
+                    )
+                );
+            });
+        }
+    }
+    register(token) {
+        this.login(token);
+    }
+    loadAllExtensions(options) {
+        const extensions = new Extensions_js_1.default(this);
+        return extensions.load(options.extensions, options.logging || false);
+    }
+}
+exports.default = XernerxClient;

package/dist/cjs/handlers/CommandHandler.d.ts

@@ -0,0 +1,27 @@
+import XernerxClient from '../client/XernerxClient.js';
+import { Handler } from './Handler.js';
+import { ContextCommandHandlerOptions, MessageCommandHandlerOptions, SlashCommandHandlerOptions } from '../types/options.js';
+/**
+ * @description - The command handler.
+ * @param {XernerxClient} client - The XernerxClient.
+ */
+export default class CommandHandler {
+    client: XernerxClient;
+    handler: Handler;
+    constructor(client: XernerxClient);
+    /**
+     * @description - The message command loader.
+     * @param {MessageCommandOptions} options - message command loader options.
+     */
+    loadAllMessageCommands(options: MessageCommandHandlerOptions): void;
+    /**
+     * @description - The slash command loader.
+     * @param {SlashCommandOptions} options - slash command loader options.
+     */
+    loadAllSlashCommands(options: SlashCommandHandlerOptions): void;
+    /**
+     * @description - The context command loader.
+     * @param {ContextCommandOptions} options - context command loader options.
+     */
+    loadAllContextCommands(options: ContextCommandHandlerOptions): void;
+}

package/dist/cjs/handlers/CommandHandler.js

@@ -0,0 +1,45 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+const Handler_js_1 = require('./Handler.js');
+const Events_js_1 = require('../models/Events.js');
+/**
+ * @description - The command handler.
+ * @param {XernerxClient} client - The XernerxClient.
+ */
+class CommandHandler {
+    client;
+    handler;
+    constructor(client) {
+        this.client = client;
+        this.handler = new Handler_js_1.Handler(client);
+        new Events_js_1.CommandsDeploy(this.client).deploy();
+    }
+    /**
+     * @description - The message command loader.
+     * @param {MessageCommandOptions} options - message command loader options.
+     */
+    loadAllMessageCommands(options) {
+        this.handler.loadAllMessageCommands(options);
+        const events = new Events_js_1.MessageCommandEvents(this.client);
+        events.messageCreate();
+        events.messageUpdate();
+        events.messageDelete();
+    }
+    /**
+     * @description - The slash command loader.
+     * @param {SlashCommandOptions} options - slash command loader options.
+     */
+    loadAllSlashCommands(options) {
+        this.handler.loadAllSlashCommands(options);
+        new Events_js_1.SlashCommandEvents(this.client).slashCreate();
+    }
+    /**
+     * @description - The context command loader.
+     * @param {ContextCommandOptions} options - context command loader options.
+     */
+    loadAllContextCommands(options) {
+        this.handler.loadAllContextCommands(options);
+        new Events_js_1.ContextCommandEvents(this.client).contextCreate();
+    }
+}
+exports.default = CommandHandler;

package/dist/cjs/handlers/EventHandler.d.ts

@@ -0,0 +1,13 @@
+import XernerxClient from '../client/XernerxClient.js';
+import { EventHandlerOptions } from '../types/options.js';
+import { Handler } from './Handler.js';
+export default class EventHandler {
+    client: XernerxClient;
+    handler: Handler;
+    constructor(client: XernerxClient);
+    /**
+     * @description - The event loader
+     * @param {EventLoadOptions} options - message command options
+     */
+    loadAllEvents(options: EventHandlerOptions): void;
+}

package/dist/cjs/handlers/EventHandler.js

@@ -0,0 +1,19 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+const Handler_js_1 = require('./Handler.js');
+class EventHandler {
+    client;
+    handler;
+    constructor(client) {
+        this.client = client;
+        this.handler = new Handler_js_1.Handler(client);
+    }
+    /**
+     * @description - The event loader
+     * @param {EventLoadOptions} options - message command options
+     */
+    loadAllEvents(options) {
+        return this.handler.loadAllEvents(options);
+    }
+}
+exports.default = EventHandler;

package/dist/cjs/handlers/Handler.d.ts

@@ -0,0 +1,57 @@
+import XernerxClient from '../client/XernerxClient.js';
+import { ContextCommandHandlerOptions, EventHandlerOptions, InhibitorHandlerOptions, MessageCommandHandlerOptions, SlashCommandHandlerOptions } from '../types/options.js';
+/**
+ * @description - The Handler class.
+ * @param {XernerxClient} client - The XernerxClient.
+ */
+export declare class Handler {
+    private client;
+    commands: object[];
+    readyTimestamp: number;
+    constructor(client: XernerxClient);
+    /**
+     * @description - The loader for the message commands.
+     * @param {MessageCommandOptions} options - The options for the message command loader.
+     */
+    loadAllMessageCommands(options: MessageCommandHandlerOptions): void;
+    /**
+     * @description - The loader for the slash commands.
+     * @param {SlashCommandOptions} options - The options for the slash command loader.
+     */
+    loadAllSlashCommands(options: SlashCommandHandlerOptions): void;
+    /**
+     * @description - The loader for the context commands.
+     * @param {ContextCommandOptions} options - The options for the context command loader.
+     */
+    loadAllContextCommands(options: ContextCommandHandlerOptions): void;
+    /**
+     * @description - The loader for the events.
+     * @param {EventLoadOptions} options - The options for the event loader.
+     */
+    loadAllEvents(options: EventHandlerOptions): void;
+    /**
+     * @description - The loader for the inhibitors.
+     * @param {InhibitorLoadOptions} options - The options for the inhibitor loader.
+     */
+    loadAllInhibitors(options: InhibitorHandlerOptions): void;
+    /**
+     * @description - a reader for directories
+     * @param {string} dir - the directory to look for.
+     * @returns array of files.
+     */
+    private readdir;
+    /**
+     * @description file loader.
+     * @param {string} dir - the directory.
+     * @param {string} file - the file in the directory.
+     * @param {string} type - the type of file.
+     * @returns undefined
+     */
+    private load;
+    /**
+     * @description the event emitter to emit all events.
+     * @param {object} event - the event to be emitted.
+     * @returns void
+     */
+    private emitter;
+}