@sapphire/plugin-pattern-commands 1.1.0-next.832decb.0 → 2.0.1-next.3fe7e48.0

package/README.md

@@ -34,12 +34,13 @@ With pattern commands you can define rulesets to which the bot may respond.
 
 -   [`@sapphire/framework`](https://www.npmjs.com/package/@sapphire/framework)
 -   [`@sapphire/utilities`](https://www.npmjs.com/package/@sapphire/utilities)
+-   [`@sapphire/stopwatch`](https://www.npmjs.com/package/@sapphire/stopwatch)
 -   [`discord.js`](https://www.npmjs.com/package/discord.js)
 
 You can use the following command to install this package, or replace `npm install` with your package manager of choice.
 
 ```sh
-npm install @sapphire/plugin-pattern-commands @sapphire/framework @sapphire/utilities discord.js
+npm install @sapphire/plugin-pattern-commands @sapphire/framework @sapphire/utilities @sapphire/stopwatch discord.js
 ```
 
 ---

package/dist/lib/utils/PaternCommandEvents.d.ts

@@ -1,9 +1,59 @@
+/**
+ * Events emitted during the parsing and command run.
+ * You can use these events for debugging and logging purposes.
+ */
 export declare enum PatternCommandEvents {
+    /**
+     * Event that is emitted when the RNG doesn't love the command
+     * @param message The message where the command was triggered
+     * @param command The command's piece
+     * @param alias The alias that triggered the command
+     */
     CommandNoLuck = "patternCommandNoLuck",
+    /**
+     * Event that is emitted when an alias triggered the command but before parsing the preconditions
+     * @param payload PatternCommandRunPayload which contains message, command and alias
+     */
     PreCommandRun = "patternCommandPreRun",
+    /**
+     * Event that is emitted after the preconditions if none of them denied the command
+     * @param payload PatternCommandAcceptedPayload which contains parameters, context, message, command and alias
+     */
     CommandAccepted = "patternCommandAccepted",
+    /**
+     * Event that is emitted after the preconditions if at least one of them denied the command
+     * @param error The error of the precondition which denied the command
+     * @param payload PatternCommandDeniedPayload which contains parameters, context, message, command and alias
+     */
     CommandDenied = "patternCommandDenied",
+    /**
+     * Event that is emitted just before the command is ran
+     * @param message The message where the command was triggered
+     * @param command The command's piece
+     * @param alias The alias that triggered the command
+     */
     CommandRun = "patternCommandRun",
-    CommandSuccess = "patternCommandSuccess"
+    /**
+     * Event that is emitted if there's no error while running the command
+     * @param result The result of command's run
+     * @param command The command's piece
+     * @param alias The alias that triggered the command
+     */
+    CommandSuccess = "patternCommandSuccess",
+    /**
+     * Event that is emitted if there's an error while running the command
+     * @param error The error message which happened while the command was running
+     * @param command The command's piece
+     * @param duration The duration which indicates how long it took the command to run
+     * @param payload PatternCommandAcceptedPayload which contains parameters, context, message, command and alias
+     */
+    CommandError = "patternCommandError",
+    /**
+     * Event that is emitted if the command has finished, regardless of whether an error occurred or not
+     * @param command The command's piece
+     * @param duration The duration which indicates how long it took the command to run
+     * @param payload PatternCommandAcceptedPayload which contains parameters, context, message, command and alias
+     */
+    CommandFinished = "patternCommandFinished"
 }
 //# sourceMappingURL=PaternCommandEvents.d.ts.map

package/dist/lib/utils/PaternCommandEvents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PaternCommandEvents.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/PaternCommandEvents.ts"],"names":[],"mappings":"AAAA,oBAAY,oBAAoB;IAC/B,aAAa,yBAAyB;IACtC,aAAa,yBAAyB;IACtC,eAAe,2BAA2B;IAC1C,aAAa,yBAAyB;IACtC,UAAU,sBAAsB;IAChC,cAAc,0BAA0B;CACxC"}
+{"version":3,"file":"PaternCommandEvents.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/PaternCommandEvents.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,oBAAoB;IAC/B;;;;;OAKG;IACH,aAAa,yBAAyB;IACtC;;;OAGG;IACH,aAAa,yBAAyB;IACtC;;;OAGG;IACH,eAAe,2BAA2B;IAC1C;;;;OAIG;IACH,aAAa,yBAAyB;IACtC;;;;;OAKG;IACH,UAAU,sBAAsB;IAChC;;;;;OAKG;IACH,cAAc,0BAA0B;IACxC;;;;;;OAMG;IACH,YAAY,wBAAwB;IACpC;;;;;OAKG;IACH,eAAe,2BAA2B;CAC1C"}

package/dist/lib/utils/PaternCommandEvents.js

@@ -1,13 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PatternCommandEvents = void 0;
+/**
+ * Events emitted during the parsing and command run.
+ * You can use these events for debugging and logging purposes.
+ */
 var PatternCommandEvents;
 (function (PatternCommandEvents) {
+    /**
+     * Event that is emitted when the RNG doesn't love the command
+     * @param message The message where the command was triggered
+     * @param command The command's piece
+     * @param alias The alias that triggered the command
+     */
     PatternCommandEvents["CommandNoLuck"] = "patternCommandNoLuck";
+    /**
+     * Event that is emitted when an alias triggered the command but before parsing the preconditions
+     * @param payload PatternCommandRunPayload which contains message, command and alias
+     */
     PatternCommandEvents["PreCommandRun"] = "patternCommandPreRun";
+    /**
+     * Event that is emitted after the preconditions if none of them denied the command
+     * @param payload PatternCommandAcceptedPayload which contains parameters, context, message, command and alias
+     */
     PatternCommandEvents["CommandAccepted"] = "patternCommandAccepted";
+    /**
+     * Event that is emitted after the preconditions if at least one of them denied the command
+     * @param error The error of the precondition which denied the command
+     * @param payload PatternCommandDeniedPayload which contains parameters, context, message, command and alias
+     */
     PatternCommandEvents["CommandDenied"] = "patternCommandDenied";
+    /**
+     * Event that is emitted just before the command is ran
+     * @param message The message where the command was triggered
+     * @param command The command's piece
+     * @param alias The alias that triggered the command
+     */
     PatternCommandEvents["CommandRun"] = "patternCommandRun";
+    /**
+     * Event that is emitted if there's no error while running the command
+     * @param result The result of command's run
+     * @param command The command's piece
+     * @param alias The alias that triggered the command
+     */
     PatternCommandEvents["CommandSuccess"] = "patternCommandSuccess";
+    /**
+     * Event that is emitted if there's an error while running the command
+     * @param error The error message which happened while the command was running
+     * @param command The command's piece
+     * @param duration The duration which indicates how long it took the command to run
+     * @param payload PatternCommandAcceptedPayload which contains parameters, context, message, command and alias
+     */
+    PatternCommandEvents["CommandError"] = "patternCommandError";
+    /**
+     * Event that is emitted if the command has finished, regardless of whether an error occurred or not
+     * @param command The command's piece
+     * @param duration The duration which indicates how long it took the command to run
+     * @param payload PatternCommandAcceptedPayload which contains parameters, context, message, command and alias
+     */
+    PatternCommandEvents["CommandFinished"] = "patternCommandFinished";
 })(PatternCommandEvents = exports.PatternCommandEvents || (exports.PatternCommandEvents = {}));
 //# sourceMappingURL=PaternCommandEvents.js.map

package/dist/lib/utils/PaternCommandEvents.js.map

@@ -1 +1 @@
-{"version":3,"file":"PaternCommandEvents.js","sourceRoot":"","sources":["../../../src/lib/utils/PaternCommandEvents.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC/B,8DAAsC,CAAA;IACtC,8DAAsC,CAAA;IACtC,kEAA0C,CAAA;IAC1C,8DAAsC,CAAA;IACtC,wDAAgC,CAAA;IAChC,gEAAwC,CAAA;AACzC,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B"}
+{"version":3,"file":"PaternCommandEvents.js","sourceRoot":"","sources":["../../../src/lib/utils/PaternCommandEvents.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,oBAqDX;AArDD,WAAY,oBAAoB;IAC/B;;;;;OAKG;IACH,8DAAsC,CAAA;IACtC;;;OAGG;IACH,8DAAsC,CAAA;IACtC;;;OAGG;IACH,kEAA0C,CAAA;IAC1C;;;;OAIG;IACH,8DAAsC,CAAA;IACtC;;;;;OAKG;IACH,wDAAgC,CAAA;IAChC;;;;;OAKG;IACH,gEAAwC,CAAA;IACxC;;;;;;OAMG;IACH,4DAAoC,CAAA;IACpC;;;;;OAKG;IACH,kEAA0C,CAAA;AAC3C,CAAC,EArDW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAqD/B"}

package/dist/listeners/PluginCommandAccepted.d.ts

@@ -5,5 +5,6 @@ import type { PatternCommandAcceptedPayload } from '../lib/utils/PatternCommandI
 export declare class CommandAcceptedListener extends Listener<typeof PatternCommandEvents.CommandAccepted> {
     constructor(context: PieceContext);
     run(payload: PatternCommandAcceptedPayload): Promise<void>;
+    runPatternCommand(payload: PatternCommandAcceptedPayload): Promise<void>;
 }
 //# sourceMappingURL=PluginCommandAccepted.d.ts.map

package/dist/listeners/PluginCommandAccepted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PluginCommandAccepted.d.ts","sourceRoot":"","sources":["../../src/listeners/PluginCommandAccepted.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAE3F,qBAAa,uBAAwB,SAAQ,QAAQ,CAAC,OAAO,oBAAoB,CAAC,eAAe,CAAC;gBAC9E,OAAO,EAAE,YAAY;IAI3B,GAAG,CAAC,OAAO,EAAE,6BAA6B;CAWvD"}
+{"version":3,"file":"PluginCommandAccepted.d.ts","sourceRoot":"","sources":["../../src/listeners/PluginCommandAccepted.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAE3F,qBAAa,uBAAwB,SAAQ,QAAQ,CAAC,OAAO,oBAAoB,CAAC,eAAe,CAAC;gBAC9E,OAAO,EAAE,YAAY;IAI3B,GAAG,CAAC,OAAO,EAAE,6BAA6B;IAU1C,iBAAiB,CAAC,OAAO,EAAE,6BAA6B;CAmBrE"}

package/dist/listeners/PluginCommandAccepted.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandAcceptedListener = void 0;
 const framework_1 = require("@sapphire/framework");
+const stopwatch_1 = require("@sapphire/stopwatch");
 const PaternCommandEvents_1 = require("../lib/utils/PaternCommandEvents");
 class CommandAcceptedListener extends framework_1.Listener {
     constructor(context) {
@@ -10,14 +11,27 @@ class CommandAcceptedListener extends framework_1.Listener {
     async run(payload) {
         const { message, command, alias } = payload;
         if (command.chance > Math.round(Math.random() * 99) + 1) {
-            message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandRun, message, command, alias);
-            const result = await command.messageRun(message);
-            message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandSuccess, result, command, alias);
+            await this.runPatternCommand(payload);
         }
         else {
             message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandNoLuck, message, command, alias);
         }
     }
+    async runPatternCommand(payload) {
+        const { message, command, alias } = payload;
+        const stopwatch = new stopwatch_1.Stopwatch();
+        const result = await (0, framework_1.fromAsync)(async () => {
+            message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandRun, message, command, alias);
+            const result = await command.messageRun(message);
+            message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandSuccess, result, command, alias);
+            return result;
+        });
+        const { duration } = stopwatch.stop();
+        if ((0, framework_1.isErr)(result)) {
+            message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandError, result.error, command, duration, payload);
+        }
+        message.client.emit(PaternCommandEvents_1.PatternCommandEvents.CommandFinished, command, duration, payload);
+    }
 }
 exports.CommandAcceptedListener = CommandAcceptedListener;
 //# sourceMappingURL=PluginCommandAccepted.js.map

package/dist/listeners/PluginCommandAccepted.js.map

@@ -1 +1 @@
-{"version":3,"file":"PluginCommandAccepted.js","sourceRoot":"","sources":["../../src/listeners/PluginCommandAccepted.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAE/C,0EAAwE;AAGxE,MAAa,uBAAwB,SAAQ,oBAAqD;IACjG,YAAmB,OAAqB;QACvC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,0CAAoB,CAAC,eAAe,EAAE,CAAC,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,OAAsC;QACtD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAE5C,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE;YACxD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACjD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;SACjF;aAAM;YACN,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;SACjF;IACF,CAAC;CACD;AAhBD,0DAgBC"}
+{"version":3,"file":"PluginCommandAccepted.js","sourceRoot":"","sources":["../../src/listeners/PluginCommandAccepted.ts"],"names":[],"mappings":";;;AAAA,mDAAiE;AAEjE,mDAAgD;AAChD,0EAAwE;AAGxE,MAAa,uBAAwB,SAAQ,oBAAqD;IACjG,YAAmB,OAAqB;QACvC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,0CAAoB,CAAC,eAAe,EAAE,CAAC,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,OAAsC;QACtD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAE5C,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE;YACxD,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SACtC;aAAM;YACN,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;SACjF;IACF,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAsC;QACpE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAE5C,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAS,EAAC,KAAK,IAAI,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACjD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAEjF,OAAO,MAAM,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QACtC,IAAI,IAAA,iBAAK,EAAC,MAAM,CAAC,EAAE;YAClB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;SACjG;QAED,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAoB,CAAC,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;CACD;AAlCD,0DAkCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapphire/plugin-pattern-commands",
-	"version": "1.1.0-next.832decb.0",
+	"version": "2.0.1-next.3fe7e48.0",
 	"description": "Plugin for @sapphire/framework that adds support for pattern commands.",
 	"author": "@sapphire",
 	"license": "MIT",
@@ -65,5 +65,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "832decb947c500c3299212e4d352fa10940dba4a"
+	"gitHead": "3fe7e48a3577df6d9addc613cae74ccb07e41639"
 }