vimcord 1.0.54 → 1.0.56

package/dist/index.d.mts

@@ -113,7 +113,9 @@ interface BaseCommandConfig<T extends CommandType> {
     /** Log whenever a command is executed? @defaultValue true */
     logExecution?: boolean;
     /** Executed before the main command logic */
-    beforeExecute?: (...args: BaseCommandParameters<T>) => any;
+    beforeExecute?: (ctx: {
+        cancel: () => void;
+    }, ...args: BaseCommandParameters<T>) => any;
     /** The main command function that will be executed */
     execute?: (...args: BaseCommandParameters<T>) => any;
     /** Executed after successful execution */
@@ -381,7 +383,9 @@ interface EventConfig<T extends keyof ClientEvents> {
     /** Rate limiting options */
     rateLimit?: EventRateLimitOptions<T>;
     /** Before event execution */
-    beforeExecute?: (...args: EventParameters<T>) => any;
+    beforeExecute?: (ctx: {
+        cancel: () => void;
+    }, ...args: EventParameters<T>) => any;
     /** The function that will be executed */
     execute?: (...args: EventParameters<T>) => any;
     /** After successful execution */
@@ -401,7 +405,9 @@ declare class EventBuilder<T extends keyof ClientEvents = keyof ClientEvents> im
     metadata: EventMetadata | undefined;
     deployment: EventDeployment | undefined;
     rateLimit: EventRateLimitOptions<T> | undefined;
-    beforeExecute: ((client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
+    beforeExecute: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
     execute: ((client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
     afterExecute: ((result: any, client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
     onError: ((error: Error, client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
@@ -952,7 +958,9 @@ declare const createContextCommandConfig: (options?: {
         onRateLimit?: ((client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     } | undefined;
     logExecution?: boolean | undefined;
-    beforeExecute?: ((client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
+    beforeExecute?: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     execute?: ((client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     afterExecute?: ((result: any, client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     onMissingPermissions?: ((results: CommandPermissionResults, client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
@@ -1317,7 +1325,9 @@ declare const createPrefixCommandConfig: (options?: {
         onRateLimit?: ((client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     } | undefined;
     logExecution?: boolean | undefined;
-    beforeExecute?: ((client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
+    beforeExecute?: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     execute?: ((client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     afterExecute?: ((result: any, client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     onMissingPermissions?: ((results: CommandPermissionResults, client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
@@ -1667,7 +1677,9 @@ declare const createSlashCommandConfig: (options?: {
         onRateLimit?: ((client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     } | undefined;
     logExecution?: boolean | undefined;
-    beforeExecute?: ((client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
+    beforeExecute?: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     execute?: ((client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     afterExecute?: ((result: any, client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     onMissingPermissions?: ((results: CommandPermissionResults, client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;

package/dist/index.d.ts

@@ -113,7 +113,9 @@ interface BaseCommandConfig<T extends CommandType> {
     /** Log whenever a command is executed? @defaultValue true */
     logExecution?: boolean;
     /** Executed before the main command logic */
-    beforeExecute?: (...args: BaseCommandParameters<T>) => any;
+    beforeExecute?: (ctx: {
+        cancel: () => void;
+    }, ...args: BaseCommandParameters<T>) => any;
     /** The main command function that will be executed */
     execute?: (...args: BaseCommandParameters<T>) => any;
     /** Executed after successful execution */
@@ -381,7 +383,9 @@ interface EventConfig<T extends keyof ClientEvents> {
     /** Rate limiting options */
     rateLimit?: EventRateLimitOptions<T>;
     /** Before event execution */
-    beforeExecute?: (...args: EventParameters<T>) => any;
+    beforeExecute?: (ctx: {
+        cancel: () => void;
+    }, ...args: EventParameters<T>) => any;
     /** The function that will be executed */
     execute?: (...args: EventParameters<T>) => any;
     /** After successful execution */
@@ -401,7 +405,9 @@ declare class EventBuilder<T extends keyof ClientEvents = keyof ClientEvents> im
     metadata: EventMetadata | undefined;
     deployment: EventDeployment | undefined;
     rateLimit: EventRateLimitOptions<T> | undefined;
-    beforeExecute: ((client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
+    beforeExecute: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
     execute: ((client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
     afterExecute: ((result: any, client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
     onError: ((error: Error, client: Vimcord<true>, ...args: ClientEvents[T]) => any) | undefined;
@@ -952,7 +958,9 @@ declare const createContextCommandConfig: (options?: {
         onRateLimit?: ((client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     } | undefined;
     logExecution?: boolean | undefined;
-    beforeExecute?: ((client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
+    beforeExecute?: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     execute?: ((client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     afterExecute?: ((result: any, client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
     onMissingPermissions?: ((results: CommandPermissionResults, client: Vimcord<true>, interaction: discord_js.ContextMenuCommandInteraction<discord_js.CacheType>) => any) | undefined;
@@ -1317,7 +1325,9 @@ declare const createPrefixCommandConfig: (options?: {
         onRateLimit?: ((client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     } | undefined;
     logExecution?: boolean | undefined;
-    beforeExecute?: ((client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
+    beforeExecute?: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     execute?: ((client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     afterExecute?: ((result: any, client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
     onMissingPermissions?: ((results: CommandPermissionResults, client: Vimcord<true>, message: discord_js.Message<boolean>) => any) | undefined;
@@ -1667,7 +1677,9 @@ declare const createSlashCommandConfig: (options?: {
         onRateLimit?: ((client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     } | undefined;
     logExecution?: boolean | undefined;
-    beforeExecute?: ((client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
+    beforeExecute?: ((ctx: {
+        cancel: () => void;
+    }, client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     execute?: ((client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     afterExecute?: ((result: any, client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;
     onMissingPermissions?: ((results: CommandPermissionResults, client: Vimcord<true>, interaction: discord_js.ChatInputCommandInteraction<discord_js.CacheType>) => any) | undefined;

package/dist/index.js

@@ -204,6 +204,8 @@ var BaseCommandBuilder = class {
   async run(client, ...args) {
     const config = this.resolveConfig(client);
     const ctx = this.extractContext(args);
+    let canceled = false;
+    const cancel = () => canceled = true;
     try {
       if (!config.enabled) {
         return await config.onUsedWhenDisabled?.(...args);
@@ -218,7 +220,10 @@ var BaseCommandBuilder = class {
       if (!await this.checkConditions(config, ...args)) {
         return await config.onConditionsNotMet?.(...args);
       }
-      await config.beforeExecute?.(...args);
+      if (config.beforeExecute) {
+        await config.beforeExecute?.({ cancel }, ...args);
+        if (canceled) return;
+      }
       if (config.logExecution !== false) {
         const cmdName = this.options.name || this.builder?.name || "Unknown";
         const location = ctx.guild ? `${ctx.guild.name} (${ctx.guild.id})` : "Direct Messages";
@@ -668,6 +673,8 @@ var EventBuilder = class _EventBuilder {
     return results.every(Boolean);
   }
   async executeEvent(...args) {
+    let canceled = false;
+    const cancel = () => canceled = true;
     try {
       if (!this.enabled) {
         return;
@@ -683,7 +690,8 @@ var EventBuilder = class _EventBuilder {
         return;
       }
       if (this.beforeExecute) {
-        await this.beforeExecute(...args);
+        await this.beforeExecute({ cancel }, ...args);
+        if (canceled) return;
       }
       const result = await this.execute?.(...args);
       if (this.afterExecute) {
@@ -1693,7 +1701,7 @@ var VimcordErrorHandler = class {
 import chalk2 from "chalk";
 
 // package.json
-var version = "1.0.54";
+var version = "1.0.55";
 
 // src/client/vimcord.logger.ts
 var clientLoggerFactory = (client) => new Logger({ prefixEmoji: "\u26A1", prefix: `vimcord (i${client.clientId})` }).extend({