@notenoughupdates/discord-akairo - npm Package Compare versions

Comparing version 9.1.3-dev.1655295899.4b4497b to 9.1.3-dev.1655341685.1230a9d

dist/package.json

 {
     "name": "@notenoughupdates/discord-akairo",
-    "version": "9.1.3-dev.1655295899.4b4497b",
+    "version": "9.1.3-dev.1655341685.1230a9d",
     "description": "A highly customizable bot framework for Discord.js.",
@@ -5,0 +5,0 @@ "main": "./dist/src/index.js",

dist/src/struct/commands/arguments/Argument.js

@@ -153,3 +153,5 @@ "use strict";
                 }
-                return Flag_js_1.Flag.cancel();
+                if (!promptOptions.time)
+                    return Flag_js_1.Flag.cancel();
+                return Flag_js_1.Flag.timeout(promptOptions.time);
             }
@@ -156,0 +158,0 @@ if (promptOptions.breakout) {

dist/src/struct/commands/CommandHandler.js

@@ -765,2 +765,6 @@ "use strict";
             }
+            else if (Flag_js_1.Flag.is(args, Flag_js_1.FlagType.Timeout)) {
+                this.emit(Constants_js_1.CommandHandlerEvents.COMMAND_TIMEOUT, message, command, args.time);
+                return true;
+            }
             else if (Flag_js_1.Flag.is(args, Flag_js_1.FlagType.Retry)) {
@@ -767,0 +771,0 @@ this.emit(Constants_js_1.CommandHandlerEvents.COMMAND_BREAKOUT, message, command, args.message);

dist/src/struct/commands/Flag.d.ts

@@ -11,2 +11,8 @@ import type { Message } from "discord.js";
     /**
+     * Order waiting time .
+     *
+     * Only exists if {@link type} is {@link FlagType.Timeout}.
+     */
+    time: T extends FlagType.Timeout ? number : never;
+    /**
      * Message to handle.
@@ -49,2 +55,3 @@ *
     private constructor();
+    private constructor();
     /**
@@ -55,2 +62,6 @@ * Creates a flag that cancels the command.
     /**
+     * Create a flag that cancels the command because of the timeout
+     */
+    static timeout(time: number): Flag<FlagType.Timeout>;
+    /**
      * Creates a flag that retries with another input.
@@ -78,2 +89,3 @@ * @param message - Message to handle.
     static is(value: unknown, type: FlagType.Cancel): value is Flag<FlagType.Cancel>;
+    static is(value: unknown, type: FlagType.Timeout): value is Flag<FlagType.Timeout>;
     static is(value: unknown, type: FlagType.Continue): value is Flag<FlagType.Continue>;
@@ -85,2 +97,3 @@ static is(value: unknown, type: FlagType.Fail): value is Flag<FlagType.Fail>;
     Cancel = "cancel",
+    Timeout = "timeout",
     Retry = "retry",
@@ -87,0 +100,0 @@ Fail = "fail",

dist/src/struct/commands/Flag.js

@@ -19,2 +19,8 @@ "use strict";
     /**
+     * Create a flag that cancels the command because of the timeout
+     */
+    static timeout(time) {
+        return new Flag(FlagType.Timeout, { time });
+    }
+    /**
      * Creates a flag that retries with another input.
@@ -50,2 +56,3 @@ * @param message - Message to handle.
     FlagType["Cancel"] = "cancel";
+    FlagType["Timeout"] = "timeout";
     FlagType["Retry"] = "retry";
@@ -52,0 +59,0 @@ FlagType["Fail"] = "fail";

dist/src/typings/events.d.ts

@@ -46,2 +46,9 @@ import type { ChatInputCommandInteraction, ClientEvents, ContextMenuCommandInteraction, Message } from "discord.js";
     /**
+     * Emitted when a command is cancelled because of a timeout.
+     * @param message - Message sent.
+     * @param command - Command executed.
+     * @param time - Timeout in milliseconds.
+     */
+    commandTimeout: [message: Message, command: Command, time: number];
+    /**
      * Emitted when a command finishes execution.
@@ -48,0 +55,0 @@ * @param message - Message sent.

dist/src/util/Constants.d.ts

@@ -76,2 +76,3 @@ export declare enum ArgumentMatches {
     COMMAND_CANCELLED = "commandCancelled",
+    COMMAND_TIMEOUT = "commandTimeout",
     COMMAND_FINISHED = "commandFinished",
@@ -78,0 +79,0 @@ COMMAND_INVALID = "commandInvalid",

dist/src/util/Constants.js

@@ -83,2 +83,3 @@ "use strict";
     CommandHandlerEvents["COMMAND_CANCELLED"] = "commandCancelled";
+    CommandHandlerEvents["COMMAND_TIMEOUT"] = "commandTimeout";
     CommandHandlerEvents["COMMAND_FINISHED"] = "commandFinished";
@@ -85,0 +86,0 @@ CommandHandlerEvents["COMMAND_INVALID"] = "commandInvalid";

dist/src/util/Util.js

@@ -177,2 +177,3 @@ "use strict";
 exports.isStringArrayStringOrFunc = isStringArrayStringOrFunc;
+/* eslint-disable @typescript-eslint/ban-types, func-names */
 /**
@@ -183,3 +184,2 @@ * Defines an abstract method to a class to produce a runtime error.
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 function patchAbstract(Class, method) {
@@ -190,5 +190,4 @@ Object.defineProperty(Class.prototype, method, {
         writable: true,
-        // eslint-disable-next-line func-names
         value: function () {
-            throw new AkairoError_js_1.AkairoError("NOT_IMPLEMENTED", Class.name, method);
+            throw new AkairoError_js_1.AkairoError("NOT_IMPLEMENTED", this.constructor.name, method);
         }
@@ -198,2 +197,3 @@ });
 exports.patchAbstract = patchAbstract;
+/* eslint-enable @typescript-eslint/ban-types, func-names */
 //# sourceMappingURL=Util.js.map

package.json

 {
 	"name": "@notenoughupdates/discord-akairo",
-	"version": "9.1.3-dev.1655295899.4b4497b",
+	"version": "9.1.3-dev.1655341685.1230a9d",
 	"description": "A highly customizable bot framework for Discord.js.",
@@ -5,0 +5,0 @@ "main": "./dist/src/index.js",

src/struct/commands/arguments/Argument.ts

@@ -314,4 +314,4 @@ import type {
 				}
-
-				return Flag.cancel();
+				if (!promptOptions.time) return Flag.cancel();
+				return Flag.timeout(promptOptions.time);
 			}
@@ -318,0 +318,0 @@

src/struct/commands/CommandHandler.ts

@@ -1025,2 +1025,5 @@ import {
 				return true;
+			} else if (Flag.is(args, FlagType.Timeout)) {
+				this.emit(CommandHandlerEvents.COMMAND_TIMEOUT, message, command, args.time);
+				return true;
 			} else if (Flag.is(args, FlagType.Retry)) {
@@ -1027,0 +1030,0 @@ this.emit(CommandHandlerEvents.COMMAND_BREAKOUT, message, command, args.message);

src/struct/commands/Flag.ts

@@ -13,2 +13,9 @@ import type { Message } from "discord.js";
 	/**
+	 * Order waiting time .
+	 *
+	 * Only exists if {@link type} is {@link FlagType.Timeout}.
+	 */
+	public declare time: T extends FlagType.Timeout ? number : never;
+
+	/**
 	 * Message to handle.
@@ -53,6 +60,10 @@ *
 	private constructor(type: T & FlagType.Cancel);
+	private constructor(type: T & FlagType.Timeout, data?: FlagTimeoutData);
 	private constructor(type: T & FlagType.Retry, data?: FlagRetryData);
 	private constructor(type: T & FlagType.Fail, data?: FlagFailData);
 	private constructor(type: T & FlagType.Continue, data?: FlagContinueData);
-	private constructor(type: T, data: Record<string, never> | FlagRetryData | FlagFailData | FlagContinueData = {}) {
+	private constructor(
+		type: T,
+		data: Record<string, never> | FlagTimeoutData | FlagRetryData | FlagFailData | FlagContinueData = {}
+	) {
 		this.type = type;
@@ -70,2 +81,9 @@ Object.assign(this, data);
 	/**
+	 * Create a flag that cancels the command because of the timeout
+	 */
+	public static timeout(time: number): Flag<FlagType.Timeout> {
+		return new Flag(FlagType.Timeout, { time });
+	}
+
+	/**
 	 * Creates a flag that retries with another input.
@@ -102,2 +120,3 @@ * @param message - Message to handle.
 	public static is(value: unknown, type: FlagType.Cancel): value is Flag<FlagType.Cancel>;
+	public static is(value: unknown, type: FlagType.Timeout): value is Flag<FlagType.Timeout>;
 	public static is(value: unknown, type: FlagType.Continue): value is Flag<FlagType.Continue>;
@@ -113,2 +132,3 @@ public static is(value: unknown, type: FlagType.Fail): value is Flag<FlagType.Fail>;
 	Cancel = "cancel",
+	Timeout = "timeout",
 	Retry = "retry",
@@ -119,2 +139,6 @@ Fail = "fail",
 
+interface FlagTimeoutData {
+	time: number;
+}
+
 interface FlagRetryData {
@@ -121,0 +145,0 @@ message: Message;

src/typings/events.ts

@@ -52,2 +52,10 @@ import type { ChatInputCommandInteraction, ClientEvents, ContextMenuCommandInteraction, Message } from "discord.js";
 	/**
+	 * Emitted when a command is cancelled because of a timeout.
+	 * @param message - Message sent.
+	 * @param command - Command executed.
+	 * @param time - Timeout in milliseconds.
+	 */
+	commandTimeout: [message: Message, command: Command, time: number];
+
+	/**
 	 * Emitted when a command finishes execution.
@@ -54,0 +62,0 @@ * @param message - Message sent.

src/util/Constants.ts

@@ -79,2 +79,3 @@ export enum ArgumentMatches {
 	COMMAND_CANCELLED = "commandCancelled",
+	COMMAND_TIMEOUT = "commandTimeout",
 	COMMAND_FINISHED = "commandFinished",
@@ -81,0 +82,0 @@ COMMAND_INVALID = "commandInvalid",

src/util/Util.ts

@@ -184,2 +184,3 @@ import EventEmitter from "node:events";
 
+/* eslint-disable @typescript-eslint/ban-types, func-names */
 /**
@@ -190,3 +191,2 @@ * Defines an abstract method to a class to produce a runtime error.
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 export function patchAbstract(Class: Function, method: string): void {
@@ -197,7 +197,7 @@ Object.defineProperty(Class.prototype, method, {
 		writable: true,
-		// eslint-disable-next-line func-names
 		value: function () {
-			throw new AkairoError("NOT_IMPLEMENTED", Class.name, method);
+			throw new AkairoError("NOT_IMPLEMENTED", this.constructor.name, method);
 		}
 	});
 }
+/* eslint-enable @typescript-eslint/ban-types, func-names */

No alert changes

Improved metrics

Total package byte prevSize

44301482

increased by0.01%

Lines of code

29554

increased by0.23%

No dependency changes