@sapphire/plugin-subcommands 3.1.2-next.94a182e.0 → 3.2.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@sapphire/plugin-subcommands@3.2.0](https://github.com/sapphiredev/plugins/compare/@sapphire/plugin-subcommands@3.1.1...@sapphire/plugin-subcommands@3.2.0) - (2022-08-29)
+
+## 🚀 Features
+
+- **subcommands:** Add default error listeners (#343) ([7f36686](https://github.com/sapphiredev/plugins/commit/7f3668689e5c7e664bca16e3cd6a36ea803b6a9c))
+
 # [@sapphire/plugin-subcommands@3.1.1](https://github.com/sapphiredev/plugins/compare/@sapphire/plugin-subcommands@3.1.0...@sapphire/plugin-subcommands@3.1.1) - (2022-08-21)
 
 ## 🐛 Bug Fixes

package/README.md

@@ -42,6 +42,21 @@ npm install @sapphire/plugin-subcommands @sapphire/framework @sapphire/utilities
 
 ## Usage
 
+Start by importing the registration file in your project to use the plugins error loggers:
+
+**JavaScript**
+
+```js
+require('@sapphire/plugin-subcommands/register');
+```
+
+**TypeScript**
+
+```typescript
+import '@sapphire/plugin-subcommands/register';
+```
+
+Then, you can create new subcommands by extending the Subcommand class.
 _With TypeScript:_
 
 ```typescript

package/dist/index.d.ts

@@ -1,4 +1,14 @@
 export * from './lib/Subcommand';
 export * from './lib/SubcommandMappings';
 export * from './lib/types/Events';
+declare module 'discord.js' {
+    interface ClientOptions {
+        /**
+         * If Plugin-subcommand to load pre-included subcommand error event listeners that log any encountered errors to the {@link SapphireClient.logger} instance
+         * @since 3.1.2
+         * @default true
+         */
+        loadSubcommandErrorListeners?: boolean;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,QAAQ,YAAY,CAAC;IAC3B,UAAU,aAAa;QACtB;;;;WAIG;QACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;KACvC;CACD"}

package/dist/listeners/pluginChatInputSubcommandError.d.ts

@@ -0,0 +1,7 @@
+import { Listener } from '@sapphire/framework';
+import { ChatInputSubcommandErrorPayload, SubcommandPluginEvents } from '../lib/types/Events';
+export declare class PluginListener extends Listener<typeof SubcommandPluginEvents.ChatInputSubcommandError> {
+    constructor(context: Listener.Context);
+    run(error: unknown, context: ChatInputSubcommandErrorPayload): void;
+}
+//# sourceMappingURL=pluginChatInputSubcommandError.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pluginChatInputSubcommandError.d.ts","sourceRoot":"","sources":["../../src/listeners/pluginChatInputSubcommandError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,+BAA+B,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE9F,qBAAa,cAAe,SAAQ,QAAQ,CAAC,OAAO,sBAAsB,CAAC,wBAAwB,CAAC;gBAChF,OAAO,EAAE,QAAQ,CAAC,OAAO;IAIrC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,+BAA+B;CAInE"}

package/dist/listeners/pluginChatInputSubcommandError.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginListener = void 0;
+const framework_1 = require("@sapphire/framework");
+const Events_1 = require("../lib/types/Events");
+class PluginListener extends framework_1.Listener {
+    constructor(context) {
+        super(context, { event: Events_1.SubcommandPluginEvents.ChatInputSubcommandError });
+    }
+    run(error, context) {
+        const { name, location } = context.command;
+        this.container.logger.error(`Encountered error on chat input subcommand "${name}" at path "${location.full}"`, error);
+    }
+}
+exports.PluginListener = PluginListener;
+//# sourceMappingURL=pluginChatInputSubcommandError.js.map

package/dist/listeners/pluginChatInputSubcommandError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginChatInputSubcommandError.js","sourceRoot":"","sources":["../../src/listeners/pluginChatInputSubcommandError.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAC/C,gDAA8F;AAE9F,MAAa,cAAe,SAAQ,oBAAgE;IACnG,YAAmB,OAAyB;QAC3C,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,+BAAsB,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,GAAG,CAAC,KAAc,EAAE,OAAwC;QAClE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAC3C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,cAAc,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;IACvH,CAAC;CACD;AATD,wCASC"}

package/dist/listeners/pluginChatInputSubcommandMissingHandler.d.ts

@@ -0,0 +1,9 @@
+import { Listener } from '@sapphire/framework';
+import type { Message } from 'discord.js';
+import type { SubcommandMappingMethod } from '../lib/SubcommandMappings';
+import { MessageSubcommandErrorPayload, SubcommandPluginEvents } from '../lib/types/Events';
+export declare class PluginListener extends Listener<typeof SubcommandPluginEvents.SubcommandMappingIsMissingMessageCommandHandler> {
+    constructor(context: Listener.Context);
+    run(_: Message, subcommand: SubcommandMappingMethod, context: MessageSubcommandErrorPayload): void;
+}
+//# sourceMappingURL=pluginChatInputSubcommandMissingHandler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pluginChatInputSubcommandMissingHandler.d.ts","sourceRoot":"","sources":["../../src/listeners/pluginChatInputSubcommandMissingHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE5F,qBAAa,cAAe,SAAQ,QAAQ,CAAC,OAAO,sBAAsB,CAAC,+CAA+C,CAAC;gBACvG,OAAO,EAAE,QAAQ,CAAC,OAAO;IAIrC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,OAAO,EAAE,6BAA6B;CAIlG"}

package/dist/listeners/pluginChatInputSubcommandMissingHandler.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginListener = void 0;
+const framework_1 = require("@sapphire/framework");
+const Events_1 = require("../lib/types/Events");
+class PluginListener extends framework_1.Listener {
+    constructor(context) {
+        super(context, { event: Events_1.SubcommandPluginEvents.SubcommandMappingIsMissingMessageCommandHandler });
+    }
+    run(_, subcommand, context) {
+        const { name, location } = context.command;
+        this.container.logger.error(`Encountered a missing mapping on message subcommand "${name}" at "${location.full}"`, subcommand);
+    }
+}
+exports.PluginListener = PluginListener;
+//# sourceMappingURL=pluginChatInputSubcommandMissingHandler.js.map

package/dist/listeners/pluginChatInputSubcommandMissingHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginChatInputSubcommandMissingHandler.js","sourceRoot":"","sources":["../../src/listeners/pluginChatInputSubcommandMissingHandler.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAG/C,gDAA4F;AAE5F,MAAa,cAAe,SAAQ,oBAAuF;IAC1H,YAAmB,OAAyB;QAC3C,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,+BAAsB,CAAC,+CAA+C,EAAE,CAAC,CAAC;IACnG,CAAC;IAEM,GAAG,CAAC,CAAU,EAAE,UAAmC,EAAE,OAAsC;QACjG,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAC3C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,wDAAwD,IAAI,SAAS,QAAQ,CAAC,IAAI,GAAG,EAAE,UAAU,CAAC,CAAC;IAChI,CAAC;CACD;AATD,wCASC"}

package/dist/listeners/pluginMessageSubcommandError.d.ts

@@ -0,0 +1,7 @@
+import { Listener } from '@sapphire/framework';
+import { MessageSubcommandErrorPayload, SubcommandPluginEvents } from '../lib/types/Events';
+export declare class PluginListener extends Listener<typeof SubcommandPluginEvents.MessageSubcommandError> {
+    constructor(context: Listener.Context);
+    run(error: unknown, context: MessageSubcommandErrorPayload): void;
+}
+//# sourceMappingURL=pluginMessageSubcommandError.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pluginMessageSubcommandError.d.ts","sourceRoot":"","sources":["../../src/listeners/pluginMessageSubcommandError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE5F,qBAAa,cAAe,SAAQ,QAAQ,CAAC,OAAO,sBAAsB,CAAC,sBAAsB,CAAC;gBAC9E,OAAO,EAAE,QAAQ,CAAC,OAAO;IAIrC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,6BAA6B;CAIjE"}

package/dist/listeners/pluginMessageSubcommandError.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginListener = void 0;
+const framework_1 = require("@sapphire/framework");
+const Events_1 = require("../lib/types/Events");
+class PluginListener extends framework_1.Listener {
+    constructor(context) {
+        super(context, { event: Events_1.SubcommandPluginEvents.MessageSubcommandError });
+    }
+    run(error, context) {
+        const { name, location } = context.command;
+        this.container.logger.error(`Encountered error on message subcommand "${name}" at path "${location.full}"`, error);
+    }
+}
+exports.PluginListener = PluginListener;
+//# sourceMappingURL=pluginMessageSubcommandError.js.map

package/dist/listeners/pluginMessageSubcommandError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginMessageSubcommandError.js","sourceRoot":"","sources":["../../src/listeners/pluginMessageSubcommandError.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAC/C,gDAA4F;AAE5F,MAAa,cAAe,SAAQ,oBAA8D;IACjG,YAAmB,OAAyB;QAC3C,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,+BAAsB,CAAC,sBAAsB,EAAE,CAAC,CAAC;IAC1E,CAAC;IAEM,GAAG,CAAC,KAAc,EAAE,OAAsC;QAChE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAC3C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,IAAI,cAAc,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;IACpH,CAAC;CACD;AATD,wCASC"}

package/dist/listeners/pluginMessageSubcommandMissingHandler.d.ts

@@ -0,0 +1,8 @@
+import { ChatInputCommand, Listener } from '@sapphire/framework';
+import type { SubcommandMappingMethod } from '../lib/SubcommandMappings';
+import { ChatInputSubcommandErrorPayload, SubcommandPluginEvents } from '../lib/types/Events';
+export declare class PluginListener extends Listener<typeof SubcommandPluginEvents.SubcommandMappingIsMissingChatInputCommandHandler> {
+    constructor(context: Listener.Context);
+    run(_: ChatInputCommand.Interaction, subcommand: SubcommandMappingMethod, context: ChatInputSubcommandErrorPayload): void;
+}
+//# sourceMappingURL=pluginMessageSubcommandMissingHandler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pluginMessageSubcommandMissingHandler.d.ts","sourceRoot":"","sources":["../../src/listeners/pluginMessageSubcommandMissingHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,+BAA+B,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE9F,qBAAa,cAAe,SAAQ,QAAQ,CAAC,OAAO,sBAAsB,CAAC,iDAAiD,CAAC;gBACzG,OAAO,EAAE,QAAQ,CAAC,OAAO;IAIrC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,WAAW,EAAE,UAAU,EAAE,uBAAuB,EAAE,OAAO,EAAE,+BAA+B;CAIzH"}

package/dist/listeners/pluginMessageSubcommandMissingHandler.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginListener = void 0;
+const framework_1 = require("@sapphire/framework");
+const Events_1 = require("../lib/types/Events");
+class PluginListener extends framework_1.Listener {
+    constructor(context) {
+        super(context, { event: Events_1.SubcommandPluginEvents.SubcommandMappingIsMissingChatInputCommandHandler });
+    }
+    run(_, subcommand, context) {
+        const { name, location } = context.command;
+        this.container.logger.error(`Encountered a missing mapping on chat input subcommand "${name}" at "${location.full}"`, subcommand);
+    }
+}
+exports.PluginListener = PluginListener;
+//# sourceMappingURL=pluginMessageSubcommandMissingHandler.js.map

package/dist/listeners/pluginMessageSubcommandMissingHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginMessageSubcommandMissingHandler.js","sourceRoot":"","sources":["../../src/listeners/pluginMessageSubcommandMissingHandler.ts"],"names":[],"mappings":";;;AAAA,mDAAiE;AAEjE,gDAA8F;AAE9F,MAAa,cAAe,SAAQ,oBAAyF;IAC5H,YAAmB,OAAyB;QAC3C,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,+BAAsB,CAAC,iDAAiD,EAAE,CAAC,CAAC;IACrG,CAAC;IAEM,GAAG,CAAC,CAA+B,EAAE,UAAmC,EAAE,OAAwC;QACxH,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAC3C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,2DAA2D,IAAI,SAAS,QAAQ,CAAC,IAAI,GAAG,EAAE,UAAU,CAAC,CAAC;IACnI,CAAC;CACD;AATD,wCASC"}

package/dist/register.d.ts

@@ -0,0 +1,13 @@
+import { Plugin, postInitialization, SapphireClient } from '@sapphire/framework';
+import type { ClientOptions } from 'discord.js';
+import './index';
+/**
+ * @since 3.1.2
+ */
+export declare class SubcommandsPlugin extends Plugin {
+    /**
+     * @since 3.1.2
+     */
+    static [postInitialization](this: SapphireClient, options: ClientOptions): void;
+}
+//# sourceMappingURL=register.d.ts.map

package/dist/register.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,SAAS,CAAC;AAEjB;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,MAAM;IAC5C;;OAEG;WACW,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI;CAKtF"}

package/dist/register.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubcommandsPlugin = void 0;
+const framework_1 = require("@sapphire/framework");
+const path_1 = require("path");
+require("./index");
+/**
+ * @since 3.1.2
+ */
+class SubcommandsPlugin extends framework_1.Plugin {
+    /**
+     * @since 3.1.2
+     */
+    static [framework_1.postInitialization](options) {
+        if (options.loadSubcommandErrorListeners !== false) {
+            this.stores.get('listeners').registerPath((0, path_1.join)(__dirname, 'listeners'));
+        }
+    }
+}
+exports.SubcommandsPlugin = SubcommandsPlugin;
+framework_1.SapphireClient.plugins.registerPostInitializationHook(SubcommandsPlugin[framework_1.postInitialization], 'Subcommand-PostInitialization');
+//# sourceMappingURL=register.js.map

package/dist/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,mDAAiF;AAEjF,+BAA4B;AAC5B,mBAAiB;AAEjB;;GAEG;AACH,MAAa,iBAAkB,SAAQ,kBAAM;IAC5C;;OAEG;IACI,MAAM,CAAC,CAAC,8BAAkB,CAAC,CAAuB,OAAsB;QAC9E,IAAI,OAAO,CAAC,4BAA4B,KAAK,KAAK,EAAE;YACnD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;SACxE;IACF,CAAC;CACD;AATD,8CASC;AAED,0BAAc,CAAC,OAAO,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,8BAAkB,CAAC,EAAE,+BAA+B,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/plugin-subcommands",
-  "version": "3.1.2-next.94a182e.0",
+  "version": "3.2.0",
   "description": "Plugin for @sapphire/framework that adds support for subcommands.",
   "author": "@sapphire",
   "license": "MIT",
@@ -12,9 +12,18 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./register": {
+      "import": "./register.mjs",
+      "require": "./register.js",
+      "types": "./register.d.ts"
     }
   },
-  "sideEffects": false,
+  "sideEffects": [
+    "./dist/register.js",
+    "./register.js",
+    "./register.mjs"
+  ],
   "homepage": "https://github.com/sapphiredev/plugins/tree/main/packages/subcommands",
   "scripts": {
     "lint": "eslint src --ext ts --fix",
@@ -36,7 +45,8 @@
   "files": [
     "dist/**/*.js*",
     "dist/**/*.mjs*",
-    "dist/**/*.d*"
+    "dist/**/*.d*",
+    "./register.*"
   ],
   "engines": {
     "node": ">=v14.0.0",

package/register.d.ts

@@ -0,0 +1 @@
+export * from './dist/register';

package/register.js

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const tslib = require('tslib');
+
+tslib.__exportStar(require('./dist/register.js'), exports);

package/register.mjs

@@ -0,0 +1 @@
+export * from './dist/register.mjs';