xernerx 3.4.2 → 3.5.0

package/dist/validators/CommandValidations.js

@@ -1,185 +1,183 @@
-import { Message } from 'discord.js';
-import { CommandType } from '../types/enums.js';
-function getUser(from) {
-    if (from instanceof Message)
-        return from.author;
-    else
-        return from.user;
-}
-export default function commandValidation(action, command, client, res = false) {
-    let user = getUser(action);
-    if ((command.ignoreOwner || client.settings.ignoreOwner) && client.util.isOwner(user.id))
-        return res;
-    else if (inCooldown(user, client, command, action))
-        return true;
-    else if (command.owner && !client.util.isOwner(user.id)) {
-        res = true;
-        emit(client, action, command, 'Not an owner', client.settings.ownerId);
-    }
-    else if (command.channelType?.length > 0 || command.channelType) {
-        if (!Array.isArray(command.channelType))
-            command.channelType = [command.channelType];
-        if (!command?.channelType?.includes(action.channel?.type)) {
-            res = true;
-            emit(client, action, command, 'Not the correct channel', command.channelType);
-        }
-    }
-    else if (command.channels?.length > 0 && !command.channels.includes(action.channel?.id)) {
-        res = true;
-        emit(client, action, command, 'Not a whitelisted channel', command.channels);
-    }
-    else if (command.guilds?.length > 0 && !command.guilds.includes(action.guild?.id)) {
-        res = true;
-        emit(client, action, command, 'Not a whitelisted guild', command.guilds);
-    }
-    else if (command.channelType && command.channelType !== action.channel?.type) {
-        res = true;
-        emit(client, action, command, 'Not the correct type of channel', command.channelType);
-    }
-    else if (action?.guild && (command.userPermissions || client.settings.userPermissions)) {
-        const permissions = command.userPermissions ||
-            client?.settings?.userPermissions?.push(...handlerPermissions(client, command.commandType, 'user')), missing = [];
-        if (Array.isArray(permissions))
-            permissions.map((permission) => {
-                if (!(action.member?.permissions).has(permission)) {
-                    missing.push(permission);
-                }
-            });
-        if (missing.length > 0) {
-            res = true;
-            emit(client, action, command, 'Missing User Permissions', missing);
-        }
-    }
-    else if (action?.guild && (command.clientPermissions || client.settings.clientPermissions)) {
-        const permissions = command.clientPermissions ||
-            client?.settings?.clientPermissions?.push(...handlerPermissions(client, command.commandType, 'client')), missing = [];
-        if (Array.isArray(permissions))
-            permissions.map((permission) => {
-                if (!(action.member?.permissions).has(permission)) {
-                    missing.push(permission);
-                }
-            });
-        if (missing.length > 0) {
-            res = true;
-            emit(client, action, command, 'Missing Client Permissions', missing);
-        }
-    }
-    return res;
-}
-function emit(client, action, command, reason, extra) {
-    return client.emit('commandBlock', action, command, reason, extra);
-}
-function inCooldown(user, client, command, action) {
-    let res = false, downs = {};
-    const { cooldowns, messageCommands, slashCommands, contextCommands, commands } = client.cache;
-    if (command.commandType === CommandType.MessageCommand && client.handlerOptions.message.cooldown) {
-        if (messageCommands.has(user.id)) {
-            const usr = messageCommands.get(user.id);
-            usr.timeRemaining = usr.endsAt - Date.now();
-            downs.message = usr;
-            res = true;
-        }
-        if (!messageCommands.has(user.id)) {
-            messageCommands.set(user.id, toCooldown(action, command, client.handlerOptions.message.cooldown, user.id));
-            setInterval(() => {
-                messageCommands.delete(user.id);
-            }, client.handlerOptions.message.cooldown);
-        }
-    }
-    if (command.commandType === CommandType.SlashCommand && client.handlerOptions.slash.cooldown) {
-        if (slashCommands.has(user.id)) {
-            const usr = slashCommands.get(user.id);
-            usr.timeRemaining = usr.endsAt - Date.now();
-            downs.slash = usr;
-            res = true;
-        }
-        if (!slashCommands.has(user.id)) {
-            slashCommands.set(user.id, toCooldown(action, command, client.handlerOptions.slash.cooldown, user.id));
-            setInterval(() => {
-                slashCommands.delete(user.id);
-            }, client.handlerOptions.slash.cooldown);
-        }
-    }
-    if (command.commandType === CommandType.ContextCommand && client.handlerOptions.context.cooldown) {
-        if (contextCommands.has(user.id)) {
-            const usr = contextCommands.get(user.id);
-            usr.timeRemaining = usr.endsAt - Date.now();
-            downs.context = usr;
-            res = true;
-        }
-        if (!contextCommands.has(user.id)) {
-            contextCommands.set(user.id, toCooldown(action, command, client.handlerOptions.context.cooldown, user.id));
-            setInterval(() => {
-                contextCommands.delete(user.id);
-            }, client.handlerOptions.context.cooldown);
-        }
-    }
-    if (client.settings?.cooldown?.default) {
-        if (cooldowns.has(user.id)) {
-            const usr = cooldowns.get(user.id);
-            usr.timeRemaining = usr.endsAt - Date.now();
-            downs.default = usr;
-            res = true;
-        }
-        if (!cooldowns.has(user.id)) {
-            cooldowns.set(user.id, toCooldown(action, command, client.settings.cooldown.default, user.id));
-            setInterval(() => {
-                cooldowns.delete(user.id);
-            }, client.settings.cooldown.default);
-        }
-    }
-    if (command.cooldown) {
-        const name = user.id + '-' + (command.data?.name || command?.name) + '-' + command.commandType;
-        if (commands.has(name)) {
-            const usr = commands.get(name);
-            usr.timeRemaining = usr.endsAt - Date.now();
-            downs.command = usr;
-            res = true;
-        }
-        if (!commands.has(name)) {
-            commands.set(name, toCooldown(action, command, command.cooldown, name));
-            setInterval(() => {
-                commands.delete(name);
-            }, command.cooldown);
-        }
-    }
-    if (Object.keys(downs).length > 0)
-        client.emit('commandCooldown', action, command, downs);
-    return res;
-}
-function toCooldown(action, command, cooldown, name) {
-    let user = getUser(action);
-    return {
-        name,
-        id: user.id,
-        tag: user.tag,
-        commandType: command.commandType,
-        commandName: command?.data?.name || command?.name,
-        guildId: action?.guild?.id,
-        channelId: action?.channel?.id,
-        startsAt: Number(Date.now()),
-        endsAt: Number(Date.now()) + cooldown,
-    };
-}
-function handlerPermissions(client, commandType, type) {
-    let permissions = [];
-    if (commandType === CommandType.MessageCommand) {
-        if (type === 'user')
-            permissions = client.handlerOptions.message?.userPermissions || [];
-        else if (type === 'client')
-            permissions = client.handlerOptions.message?.clientPermissions || [];
-    }
-    else if (commandType === CommandType.SlashCommand) {
-        if (type === 'user')
-            permissions = client.handlerOptions.slash?.userPermissions || [];
-        else if (type === 'client')
-            permissions = client.handlerOptions.slash?.clientPermissions || [];
-    }
-    else if (commandType === CommandType.ContextCommand) {
-        if (type === 'user')
-            permissions = client.handlerOptions.context?.userPermissions || [];
-        else if (type === 'client')
-            permissions = client.handlerOptions.context?.clientPermissions || [];
-    }
-    return permissions;
-}
+import { Message } from 'discord.js';
+import { CommandType } from '../types/enums.js';
+function getUser(from) {
+    if (from instanceof Message)
+        return from.author;
+    else
+        return from.user;
+}
+export default function commandValidation(action, command, client, res = false) {
+    let user = getUser(action);
+    if ((command.ignoreOwner || client.settings.ignore?.owner) && client.util.isOwner(user.id))
+        return res;
+    else if (inCooldown(user, client, command, action))
+        return true;
+    else if (command.owner && !client.util.isOwner(user.id)) {
+        res = true;
+        emit(client, action, command, 'Not an owner', client.settings.ownerId);
+    }
+    else if (command.channelType?.length > 0 || command.channelType) {
+        if (!Array.isArray(command.channelType))
+            command.channelType = [command.channelType];
+        if (!command?.channelType?.includes(action.channel?.type)) {
+            res = true;
+            emit(client, action, command, 'Not the correct channel', command.channelType);
+        }
+    }
+    else if (command.channels?.length > 0 && !command.channels.includes(action.channel?.id)) {
+        res = true;
+        emit(client, action, command, 'Not a whitelisted channel', command.channels);
+    }
+    else if (command.guilds?.length > 0 && !command.guilds.includes(action.guild?.id)) {
+        res = true;
+        emit(client, action, command, 'Not a whitelisted guild', command.guilds);
+    }
+    else if (command.channelType && command.channelType !== action.channel?.type) {
+        res = true;
+        emit(client, action, command, 'Not the correct type of channel', command.channelType);
+    }
+    else if (action?.guild && (command.permissions?.user || client.settings.permissions?.user)) {
+        const permissions = command.permissions?.user || client?.settings?.permissions?.user?.push(...handlerPermissions(client, command.commandType, 'user')), missing = [];
+        if (Array.isArray(permissions))
+            permissions.map((permission) => {
+                if (!(action.member?.permissions).has(permission)) {
+                    missing.push(permission);
+                }
+            });
+        if (missing.length > 0) {
+            res = true;
+            emit(client, action, command, 'Missing User Permissions', missing);
+        }
+    }
+    else if (action?.guild && (command.permissions?.client || client.settings.permissions?.client)) {
+        const permissions = command.permissions?.client || client?.settings?.permissions?.client?.push(...handlerPermissions(client, command.commandType, 'client')), missing = [];
+        if (Array.isArray(permissions))
+            permissions.map((permission) => {
+                if (!(action.member?.permissions).has(permission)) {
+                    missing.push(permission);
+                }
+            });
+        if (missing.length > 0) {
+            res = true;
+            emit(client, action, command, 'Missing Client Permissions', missing);
+        }
+    }
+    return res;
+}
+function emit(client, action, command, reason, extra) {
+    return client.emit('commandBlock', action, command, reason, extra);
+}
+function inCooldown(user, client, command, action) {
+    let res = false, downs = {};
+    const { cooldowns, messageCommands, slashCommands, contextCommands, commands } = client.cache;
+    if (command.commandType === CommandType.MessageCommand && client.handlerOptions.message.cooldown) {
+        if (messageCommands.has(user.id)) {
+            const usr = messageCommands.get(user.id);
+            usr.timeRemaining = usr.endsAt - Date.now();
+            downs.message = usr;
+            res = true;
+        }
+        if (!messageCommands.has(user.id)) {
+            messageCommands.set(user.id, toCooldown(action, command, client.handlerOptions.message.cooldown, user.id));
+            setInterval(() => {
+                messageCommands.delete(user.id);
+            }, client.handlerOptions.message.cooldown);
+        }
+    }
+    if (command.commandType === CommandType.SlashCommand && client.handlerOptions.slash.cooldown) {
+        if (slashCommands.has(user.id)) {
+            const usr = slashCommands.get(user.id);
+            usr.timeRemaining = usr.endsAt - Date.now();
+            downs.slash = usr;
+            res = true;
+        }
+        if (!slashCommands.has(user.id)) {
+            slashCommands.set(user.id, toCooldown(action, command, client.handlerOptions.slash.cooldown, user.id));
+            setInterval(() => {
+                slashCommands.delete(user.id);
+            }, client.handlerOptions.slash.cooldown);
+        }
+    }
+    if (command.commandType === CommandType.ContextCommand && client.handlerOptions.context.cooldown) {
+        if (contextCommands.has(user.id)) {
+            const usr = contextCommands.get(user.id);
+            usr.timeRemaining = usr.endsAt - Date.now();
+            downs.context = usr;
+            res = true;
+        }
+        if (!contextCommands.has(user.id)) {
+            contextCommands.set(user.id, toCooldown(action, command, client.handlerOptions.context.cooldown, user.id));
+            setInterval(() => {
+                contextCommands.delete(user.id);
+            }, client.handlerOptions.context.cooldown);
+        }
+    }
+    if (client.settings?.cooldown?.default) {
+        if (cooldowns.has(user.id)) {
+            const usr = cooldowns.get(user.id);
+            usr.timeRemaining = usr.endsAt - Date.now();
+            downs.default = usr;
+            res = true;
+        }
+        if (!cooldowns.has(user.id)) {
+            cooldowns.set(user.id, toCooldown(action, command, client.settings.cooldown.default, user.id));
+            setInterval(() => {
+                cooldowns.delete(user.id);
+            }, client.settings.cooldown.default);
+        }
+    }
+    if (command.cooldown) {
+        const name = user.id + '-' + (command.data?.name || command?.name) + '-' + command.commandType;
+        if (commands.has(name)) {
+            const usr = commands.get(name);
+            usr.timeRemaining = usr.endsAt - Date.now();
+            downs.command = usr;
+            res = true;
+        }
+        if (!commands.has(name)) {
+            commands.set(name, toCooldown(action, command, command.cooldown, name));
+            setInterval(() => {
+                commands.delete(name);
+            }, command.cooldown);
+        }
+    }
+    if (Object.keys(downs).length > 0)
+        client.emit('commandCooldown', action, command, downs);
+    return res;
+}
+function toCooldown(action, command, cooldown, name) {
+    let user = getUser(action);
+    return {
+        name,
+        id: user.id,
+        tag: user.tag,
+        commandType: command.commandType,
+        commandName: command?.data?.name || command?.name,
+        guildId: action?.guild?.id,
+        channelId: action?.channel?.id,
+        startsAt: Number(Date.now()),
+        endsAt: Number(Date.now()) + cooldown,
+    };
+}
+function handlerPermissions(client, commandType, type) {
+    let permissions = [];
+    if (commandType === CommandType.MessageCommand) {
+        if (type === 'user')
+            permissions = client.handlerOptions.message?.userPermissions || [];
+        else if (type === 'client')
+            permissions = client.handlerOptions.message?.clientPermissions || [];
+    }
+    else if (commandType === CommandType.SlashCommand) {
+        if (type === 'user')
+            permissions = client.handlerOptions.slash?.userPermissions || [];
+        else if (type === 'client')
+            permissions = client.handlerOptions.slash?.clientPermissions || [];
+    }
+    else if (commandType === CommandType.ContextCommand) {
+        if (type === 'user')
+            permissions = client.handlerOptions.context?.userPermissions || [];
+        else if (type === 'client')
+            permissions = client.handlerOptions.context?.clientPermissions || [];
+    }
+    return permissions;
+}

package/dist/validators/InhibitorValidations.js

@@ -1,42 +1,42 @@
-import { InhibitorType } from '../types/enums.js';
-export class InhibitorValidation {
-    client;
-    action;
-    command;
-    inhibited;
-    constructor(client, action, command) {
-        this.client = client;
-        this.action = action;
-        this.command = command;
-        this.inhibited = {};
-    }
-    async inhibit() {
-        for (const inhibitor of this.client.inhibitors) {
-            const inhibit = inhibitor[1];
-            if (inhibit)
-                this.inhibited[inhibit.name] = await inhibit.check(this.action, this.args(this.action, inhibit.type));
-        }
-        for (const inhibit of Object.values(this.inhibited)) {
-            if (inhibit)
-                return this.inhibited;
-        }
-    }
-    args(action, type) {
-        if (type === InhibitorType.Channel)
-            return action.channel;
-        if (type === InhibitorType.User)
-            return action.author || action.user;
-        if (type === InhibitorType.Guild)
-            return action.guild;
-        if (type === InhibitorType.Member)
-            return action.member;
-        // if (type === InhibitorType.Command)
-        // 	return this.client.util.getAllCommands().filter(this.command.name);
-        // if (type === InhibitorType.MessageCommand)
-        // 	return this.client.util.getAllMessageCommands().find(this.command.name);
-        // if (type === InhibitorType.SlashCommand)
-        // 	return this.client.util.getAllSlashCommands().find(this.command.name);
-        // if (type === InhibitorType.ContextCommand)
-        // 	return this.client.util.getAllContextCommands().find(this.command.name);
-    }
-}
+import { InhibitorType } from '../types/enums.js';
+export class InhibitorValidation {
+    client;
+    action;
+    command;
+    inhibited;
+    constructor(client, action, command) {
+        this.client = client;
+        this.action = action;
+        this.command = command;
+        this.inhibited = {};
+    }
+    async inhibit() {
+        for (const inhibitor of this.client.inhibitors) {
+            const inhibit = inhibitor[1];
+            if (inhibit)
+                this.inhibited[inhibit.name] = await inhibit.check(this.action, this.args(this.action, inhibit.type));
+        }
+        for (const inhibit of Object.values(this.inhibited)) {
+            if (inhibit)
+                return this.inhibited;
+        }
+    }
+    args(action, type) {
+        if (type === InhibitorType.Channel)
+            return action.channel;
+        if (type === InhibitorType.User)
+            return action.author || action.user;
+        if (type === InhibitorType.Guild)
+            return action.guild;
+        if (type === InhibitorType.Member)
+            return action.member;
+        // if (type === InhibitorType.Command)
+        // 	return this.client.util.getAllCommands().filter(this.command.name);
+        // if (type === InhibitorType.MessageCommand)
+        // 	return this.client.util.getAllMessageCommands().find(this.command.name);
+        // if (type === InhibitorType.SlashCommand)
+        // 	return this.client.util.getAllSlashCommands().find(this.command.name);
+        // if (type === InhibitorType.ContextCommand)
+        // 	return this.client.util.getAllContextCommands().find(this.command.name);
+    }
+}

package/dist/validators/Shapes.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,41 +1,56 @@
 {
-	"name": "xernerx",
-	"version": "3.4.2",
-	"type": "module",
-	"description": "A bot framework for discord.js.",
-	"main": "dist/main.js",
-	"keywords": [
-		"discord.js",
-		"discord",
-		"framework"
-	],
-	"author": "Dummi",
-	"license": "MIT",
-	"homepage": "https://xernerx.github.io/xernerx/home.html",
-	"packageManager": "npm@8.5.5",
-	"scripts": {
-		"start": "npm i && npm fund && npm audit fix --force && npm link && tsc -w",
-		"patch": "npm run build && tsc && git add . && npm run commit && npm version patch && npm publish && git push",
-		"minor": "npm run build && tsc && git add . && npm run commit && npm version minor && npm publish && git push",
-		"major": "npm run build && tsc && git add . && npm run commit && npm version major && npm publish && git push",
-		"site": "git add docs && npm run commit && git push",
-		"commit": "node ../.scripts/commit.js",
-		"build": "node ../.scripts/rewritePackage.js"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/xernerx/xernerx.git"
-	},
-	"bugs": {
-		"url": "https://github.com/xernerx/xernerx/issues"
-	},
-	"dependencies": {
-		"@sapphire/shapeshift": "^3.8.1",
-		"discord.js": "^14.7.0",
-		"dumfunctions": "^2.0.0",
-		"xernerx-extension-builder": "^0.0.2"
-	},
-	"devDependencies": {
-		"typescript": "^4.9.4"
-	}
+    "name": "xernerx",
+    "version": "3.5.0",
+    "type": "module",
+    "description": "A bot framework for discord.js.",
+    "main": "dist/main.js",
+    "keywords": [
+        "discord.js",
+        "discord",
+        "framework",
+        "mjs",
+        "esm",
+        "cjs",
+        "ts"
+    ],
+    "author": "Dummi",
+    "license": "MIT",
+    "homepage": "https://xernerx.github.io/xernerx/home.html",
+    "packageManager": "npm@8.5.5",
+    "exports": {
+        "import": "./dist/main.js",
+        "require": "./dist/main.cjs",
+        "types": "./types",
+        "node": null,
+        "default": null
+    },
+    "scripts": {
+        "start": "npm i && npm fund && npm audit fix --force && npm link && tsc -w",
+        "patch": "npm run write && git add . && npm run commit && npm version patch && npm publish && git push",
+        "minor": "npm run write && git add . && npm run commit && npm version minor && npm publish && git push",
+        "major": "npm run write && git add . && npm run commit && npm version major && npm publish && git push",
+        "site": "git add docs && npm run commit && git push",
+        "commit": "node ../.scripts/commit.js",
+        "write": "npm run build && node ../.scripts/rewritePackage.js ",
+        "build": "tsc && npx tsup src/main.ts && npx prettier --write src types"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/xernerx/xernerx.git"
+    },
+    "bugs": {
+        "url": "https://github.com/xernerx/xernerx/issues"
+    },
+    "dependencies": {
+        "@sapphire/shapeshift": "^3.8.1",
+        "discord.js": "^14.7.0",
+        "dumfunctions": "^2.0.0",
+        "xernerx-extension-builder": "^0.0.2",
+        "zod": "^3.20.6"
+    },
+    "devDependencies": {
+        "prettier": "^2.8.4",
+        "tsup": "^6.6.0",
+        "typescript": "^4.9.5"
+    }
 }

package/types/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>;
+}