xernerx 4.2.1 → 4.3.0

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/build/ContextCommandBuilder.d.ts

@@ -3,15 +3,16 @@ import XernerxClient from '../client/XernerxClient.js';
 import { XernerxMessageContextInteraction, XernerxUserContextInteraction } from '../types/extenders.js';
 import { ContextCommandOptions } from '../types/interfaces.js';
 export default class ContextCommandBuilder {
-    id: string;
-    data: ContextMenuCommandBuilder;
-    name: string;
-    type: 'message' | 'user';
-    description: string | null | undefined;
-    info: string | null | undefined;
-    category: string | null | undefined;
-    cooldown: number | null | undefined;
-    ignore:
+    readonly id: string;
+    readonly data: ContextMenuCommandBuilder;
+    readonly name: string;
+    readonly type: 'message' | 'user';
+    readonly description: string | null | undefined;
+    readonly usage: string | null | undefined;
+    readonly info: string | null | undefined;
+    readonly category: string | null | undefined;
+    readonly cooldown: number | null | undefined;
+    readonly ignore:
         | {
               owner?: boolean | undefined;
               users?: string[] | undefined;
@@ -19,7 +20,7 @@ export default class ContextCommandBuilder {
               guilds?: string[] | undefined;
           }
         | undefined;
-    strict:
+    readonly strict:
         | {
               owner?: boolean | undefined;
               users?: string[] | undefined;
@@ -27,21 +28,21 @@ export default class ContextCommandBuilder {
               guilds?: string[] | undefined;
           }
         | undefined;
-    permissions:
+    readonly permissions:
         | {
               user?: string[] | import('../types/types.js').PermissionNames[] | undefined;
               client?: string[] | import('../types/types.js').PermissionNames[] | undefined;
               dm?: boolean | undefined;
           }
         | undefined;
-    defer:
+    readonly defer:
         | {
               reply?: boolean | undefined;
               ephemeral?: boolean | undefined;
               fetchReply?: boolean | undefined;
           }
         | undefined;
-    client: typeof XernerxClient;
+    readonly client: typeof XernerxClient;
     constructor(id: string, options: ContextCommandOptions);
     exec(interaction: XernerxUserContextInteraction | XernerxMessageContextInteraction): Promise<void>;
 }

package/dist/build/ContextCommandBuilder.js

@@ -2,19 +2,6 @@ import { ContextMenuCommandBuilder } from 'discord.js';
 import { z } from 'zod';
 import XernerxClient from '../client/XernerxClient.js';
 export default class ContextCommandBuilder {
-    id;
-    data;
-    name;
-    type;
-    description;
-    info;
-    category;
-    cooldown;
-    ignore;
-    strict;
-    permissions;
-    defer;
-    client;
     constructor(id, options) {
         this.id = id;
         this.data = new ContextMenuCommandBuilder();
@@ -27,6 +14,7 @@ export default class ContextCommandBuilder {
                 name: z.string(),
                 type: z.enum(['user', 'message']),
                 description: z.string().or(z.null()).default(null),
+                usage: z.string().or(z.null()).default(null),
                 info: z.string().or(z.null()).default(null),
                 category: z.string().or(z.null()).default(null),
                 cooldown: z.number().or(z.null()).default(null),
@@ -65,6 +53,7 @@ export default class ContextCommandBuilder {
         this.name = options.name;
         this.type = options.type;
         this.description = options.description;
+        this.usage = options.usage;
         this.info = options.info;
         this.category = options.category;
         this.cooldown = options.cooldown;

package/dist/build/EventBuilder.d.ts

@@ -7,16 +7,16 @@ import { EventType } from '../types/types.js';
  * @param {EventOptions} options - The event options.
  */
 export default class EventBuilder {
-    id: string;
-    name: EventType;
-    emitter: 'client' | 'process' | string;
-    type: 'discord' | string;
-    once: boolean;
-    client: typeof XernerxClient;
+    readonly id: string;
+    readonly name: EventType;
+    readonly emitter?: 'client' | 'process' | string;
+    readonly type?: 'discord' | string;
+    readonly once?: boolean;
+    readonly client: typeof XernerxClient;
     constructor(id: string, options: EventBuilderOptions);
     /**
      * @description run your custom event here.
      * TODO - update description
      */
-    run<T extends Array<T>>(...args: T): Promise<void>;
+    run<T>(...args: T[]): Promise<void>;
 }

package/dist/build/EventBuilder.js

@@ -7,12 +7,6 @@ import XernerxClient from '../client/XernerxClient.js';
  * @param {EventOptions} options - The event options.
  */
 export default class EventBuilder {
-    id;
-    name;
-    emitter;
-    type;
-    once;
-    client;
     constructor(id, options) {
         this.id = id;
         z.object({

package/dist/build/InhibitorBuilder.d.ts

@@ -8,10 +8,10 @@ import { XernerxMessage } from '../types/extenders.js';
  * @param {InhibitorOptions} options - The inhibitor options.
  */
 export default class InhibitorBuilder {
-    id: string;
-    name: string;
-    type: InhibitorType;
-    client: typeof XernerxClient;
+    readonly id: string;
+    readonly name: string;
+    readonly type: InhibitorType;
+    readonly client: typeof XernerxClient;
     constructor(id: string, options: InhibitorBuilderOptions);
-    check(action: XernerxInteraction | XernerxMessage, args: any): Promise<void>;
+    check<T>(action: XernerxInteraction | XernerxMessage, args: T): Promise<void>;
 }

package/dist/build/InhibitorBuilder.js

@@ -8,10 +8,6 @@ import XernerxClient from '../client/XernerxClient.js';
  * @param {InhibitorOptions} options - The inhibitor options.
  */
 export default class InhibitorBuilder {
-    id;
-    name;
-    type;
-    client;
     constructor(id, options) {
         this.id = id;
         z.object({

package/dist/build/MessageCommandBuilder.d.ts

@@ -8,6 +8,7 @@ export default class MessageCommandBuilder {
     readonly regex: RegExp | undefined;
     readonly prefix: string | string[] | undefined;
     readonly description: string | null | undefined;
+    readonly usage: string | null | undefined;
     readonly info: string | null | undefined;
     readonly separator: string | undefined;
     readonly args: import('../types/interfaces.js').MessageCommandArgumentOptions[] | undefined;

package/dist/build/MessageCommandBuilder.js

@@ -1,22 +1,6 @@
 import { z } from 'zod';
 import XernerxClient from '../client/XernerxClient.js';
 export default class MessageCommandBuilder {
-    id;
-    name;
-    aliases;
-    regex;
-    prefix;
-    description;
-    info;
-    separator;
-    args;
-    flags;
-    category;
-    cooldown;
-    ignore;
-    strict;
-    permissions;
-    client;
     constructor(id, options) {
         this.id = id;
         this.regex = options.regex;
@@ -27,6 +11,7 @@ export default class MessageCommandBuilder {
                 name: z.string(),
                 aliases: z.array(z.string()).default([]),
                 description: z.string().or(z.null()).default(null),
+                usage: z.string().or(z.null()).default(null),
                 info: z.string().or(z.null()).default(null),
                 category: z.string().or(z.null()).default(null),
                 cooldown: z.number().or(z.null()).default(null),
@@ -60,6 +45,7 @@ export default class MessageCommandBuilder {
         this.aliases = options.aliases;
         this.prefix = options.prefix;
         this.description = options.description;
+        this.usage = options.usage;
         this.info = options.info;
         this.category = options.category;
         this.cooldown = options.cooldown;

package/dist/build/SlashCommandBuilder.d.ts

@@ -3,14 +3,15 @@ import XernerxClient from '../client/XernerxClient.js';
 import { XernerxSlashInteraction } from '../types/extenders.js';
 import { SlashCommandArguments, SlashCommandOptions } from '../types/interfaces.js';
 export default class SlashCommandBuilder {
-    id: string;
-    data: Discord.SlashCommandBuilder;
-    name: string;
-    description: string;
-    info: string | null | undefined;
-    category: string | null | undefined;
-    cooldown: number | null | undefined;
-    ignore:
+    readonly id: string;
+    readonly data: Discord.SlashCommandBuilder;
+    readonly name: string;
+    readonly description: string;
+    readonly usage: string | null | undefined;
+    readonly info: string | null | undefined;
+    readonly category: string | null | undefined;
+    readonly cooldown: number | null | undefined;
+    readonly ignore:
         | {
               owner?: boolean | undefined;
               users?: string[] | undefined;
@@ -18,7 +19,7 @@ export default class SlashCommandBuilder {
               guilds?: string[] | undefined;
           }
         | undefined;
-    strict:
+    readonly strict:
         | {
               owner?: boolean | undefined;
               users?: string[] | undefined;
@@ -26,21 +27,21 @@ export default class SlashCommandBuilder {
               guilds?: string[] | undefined;
           }
         | undefined;
-    permissions:
+    readonly permissions:
         | {
               user?: string[] | import('../types/types.js').PermissionNames[] | undefined;
               client?: string[] | import('../types/types.js').PermissionNames[] | undefined;
               dm?: boolean | undefined;
           }
         | undefined;
-    defer:
+    readonly defer:
         | {
               reply?: boolean | undefined;
               ephemeral?: boolean | undefined;
               fetchReply?: boolean | undefined;
           }
         | undefined;
-    client: typeof XernerxClient;
+    readonly client: typeof XernerxClient;
     constructor(id: string, options: SlashCommandOptions);
     autocomplete<T>(interaction: XernerxSlashInteraction, focused: T, options: Array<T>): Promise<void>;
     conditions(interaction: XernerxSlashInteraction, args: SlashCommandArguments): Promise<void>;

package/dist/build/SlashCommandBuilder.js

@@ -2,18 +2,6 @@ import Discord, { SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuil
 import { z } from 'zod';
 import XernerxClient from '../client/XernerxClient.js';
 export default class SlashCommandBuilder {
-    id;
-    data;
-    name;
-    description;
-    info;
-    category;
-    cooldown;
-    ignore;
-    strict;
-    permissions;
-    defer;
-    client;
     constructor(id, options) {
         this.id = id;
         this.data = new Discord.SlashCommandBuilder();
@@ -35,6 +23,7 @@ export default class SlashCommandBuilder {
             .object({
                 name: z.string(),
                 description: z.string(),
+                usage: z.string().or(z.null()).default(null),
                 info: z.string().or(z.null()).default(null),
                 category: z.string().or(z.null()).default(null),
                 number: z.number().or(z.null()).default(null),
@@ -73,6 +62,7 @@ export default class SlashCommandBuilder {
             .parse(options);
         this.name = options.name;
         this.description = options.description;
+        this.usage = options.usage;
         this.info = options.info;
         this.category = options.category;
         this.cooldown = options.cooldown;

package/dist/client/XernerxClient.d.ts

@@ -37,7 +37,7 @@ export default class XernerxClient extends Client {
               }
             | undefined;
     };
-    readonly config: unknown;
+    readonly config: Record<string, unknown> | null;
     readonly commands: XernerxCommands;
     readonly events: Collection<string, EventBuilder>;
     readonly inhibitors: Collection<string, InhibitorBuilder>;
@@ -50,6 +50,6 @@ export default class XernerxClient extends Client {
         shardCount: number;
     };
     readonly cache: XernerxCache;
-    constructor(discordOptions: ClientOptions, xernerxOptions: XernerxOptions, config?: unknown);
+    constructor(discordOptions: ClientOptions, xernerxOptions: XernerxOptions, config?: Record<string, unknown>);
     connect(token: string): void;
 }

package/dist/client/XernerxClient.js

@@ -46,7 +46,7 @@ export default class XernerxClient extends Client {
                     .optional(),
             })
             .parse(xernerxOptions);
-        this.config = config;
+        this.config = config || null;
         this.commands = {
             message: new Collection(),
             slash: new Collection(),
@@ -64,7 +64,7 @@ export default class XernerxClient extends Client {
         };
         this.util = new ClientUtil(this);
         this.stats = {
-            guildCount: 0,
+            guildCount: this.guilds.cache.size,
             userCount: 0,
             shardId: 0,
             shardCount: 1,

package/dist/handlers/ExtensionHandler.js

@@ -8,7 +8,9 @@ export default class ExtensionHandler extends Handler {
         const active = extensions.map((extension) => {
             try {
                 if (extension.main) extension.main(this.client);
-                if (extension.await) extension.await(this.client);
+                if (extension.defer) {
+                    this.client.on('ready', (client) => extension.defer(client));
+                }
                 return extension.name;
             } catch (error) {
                 new XernerxLog(this.client).error(`An error occurred while loading ${extension.name}`, error);

package/dist/handlers/WebhookHandler.js

@@ -23,7 +23,7 @@ export default class WebhookHandler extends Handler {
     }
     async post(token) {
         const guilds = await this.client.guilds.fetch();
-        this.client.stats.guildCount = guilds.size;
+        this.client.stats.guildCount = this.client.guilds.cache.size;
         this.client.stats.userCount = (await Promise.all(guilds.map(async (guild) => (await this.client.guilds.fetch(guild.id)).memberCount))).reduce((a, b) => (a += b));
         this.client.stats.shardId = this.client.options.shards?.at(0) || 0;
         this.client.stats.shardCount = this.client.options.shardCount || this.client.options.shards?.length || 1;

package/dist/main.d.ts

@@ -10,5 +10,5 @@ export * from 'discord.js';
 export * from 'dumfunctions';
 import ExtensionBuilder from 'xernerx-extension-builder';
 import Discord from 'discord.js';
-declare const version = '4.2.1';
+declare const version = '4.2.2';
 export { XernerxClient, MessageCommandBuilder, SlashCommandBuilder, ContextCommandBuilder, EventBuilder, InhibitorBuilder, ExtensionBuilder, Discord, version, XernerxLog };

package/dist/main.js

@@ -10,5 +10,5 @@ export * from 'discord.js';
 export * from 'dumfunctions';
 import ExtensionBuilder from 'xernerx-extension-builder';
 import Discord from 'discord.js';
-const version = '4.2.1';
+const version = '4.2.2';
 export { XernerxClient, MessageCommandBuilder, SlashCommandBuilder, ContextCommandBuilder, EventBuilder, InhibitorBuilder, ExtensionBuilder, Discord, version, XernerxLog };

package/dist/types/interfaces.d.ts

@@ -116,6 +116,7 @@ export interface InhibitorHandlerOptions {
 interface CommandOptions {
     name: string;
     description?: string | null;
+    usage?: string | null;
     info?: string | null;
     category?: string | null;
     cooldown?: number | null;
@@ -217,8 +218,8 @@ export interface SlashCommandArguments {
 }
 export interface EventBuilderOptions {
     name: EventType;
-    emitter: 'discord' | 'process';
-    type: string;
+    emitter: 'client' | 'process';
+    type: 'discord';
     once: boolean;
 }
 export interface InhibitorBuilderOptions {

package/dist/utils/ClientUtil.d.ts

@@ -6,4 +6,5 @@ export default class ClientUtil extends Util {
     constructor(client: XernerxClient);
     setPresence(options: PresenceOptions): import('discord.js').ClientPresence | undefined;
     resolveChannel(query: string | Record<string, string>): Promise<import('discord.js').Channel | null>;
+    resolveGuild(query: string | Record<string, string>): Promise<import('discord.js').Guild | null>;
 }

package/dist/utils/ClientUtil.js

@@ -17,4 +17,14 @@ export default class ClientUtil extends Util {
             return null;
         }
     }
+    async resolveGuild(query) {
+        if (typeof query == 'object') query = query.id;
+        try {
+            let guild = this.client.guilds.cache.find((guild) => guild.name.toLowerCase() == query.toLowerCase()) || null;
+            if (!guild) guild = (await this.client.guilds.fetch(query)) || null;
+            return guild;
+        } catch {
+            return null;
+        }
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "xernerx",
-    "version": "4.2.1",
+    "version": "4.3.0",
     "description": "A bot framework for discord.js.",
     "main": "dist/main.js",
     "type": "module",
@@ -39,7 +39,7 @@
         "dbl-sdk": "^1.2.0",
         "discord.js": "^14.9.0",
         "dumfunctions": "^2.1.2",
-        "xernerx-extension-builder": "^0.0.12",
+        "xernerx-extension-builder": "^0.0.16",
         "zod": "^3.21.4"
     },
     "devDependencies": {

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

@@ -1,68 +0,0 @@
-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

@@ -1,97 +0,0 @@
-'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;