@sapphire/decorators 4.3.9-next.f731c3c.0 → 5.0.0

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@sapphire/decorators@5.0.0](https://github.com/sapphiredev/utilities/compare/@sapphire/decorators@4.3.8...@sapphire/decorators@5.0.0) - (2022-08-20)
+
+## 🐛 Bug Fixes
+
+- Manually set version to 5.0.0 to cover @sapphire/framework@3.0.0 ([48e083f](https://github.com/sapphiredev/utilities/commit/48e083f9d4cbdb7e6c204ce75a6d2d387662dfae))
+- **deps:** Update all non-major dependencies ([2308bd7](https://github.com/sapphiredev/utilities/commit/2308bd74356b6b2e0c12995b25f4d8ade4803fe9))
+
+## 📝 Documentation
+
+- Add @muchnameless as a contributor ([a1221fe](https://github.com/sapphiredev/utilities/commit/a1221fea68506e99591d5d00ec552a07c26833f9))
+- Add @enxg as a contributor ([d2382f0](https://github.com/sapphiredev/utilities/commit/d2382f04e3909cb4ad11798a0a10e683f6cf5383))
+- Add @EvolutionX-10 as a contributor ([efc3a32](https://github.com/sapphiredev/utilities/commit/efc3a320a72ae258996dd62866d206c33f8d4961))
+
 # [@sapphire/decorators@4.3.7](https://github.com/sapphiredev/utilities/compare/@sapphire/decorators@4.3.6...@sapphire/decorators@4.3.7) - (2022-07-13)
 
 ## 🏠 Refactor

package/README.md

@@ -102,6 +102,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   </tr>
   <tr>
     <td align="center"><a href="https://github.com/MajesticString"><img src="https://avatars.githubusercontent.com/u/66224939?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Harry Allen</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=MajesticString" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/EvolutionX-10"><img src="https://avatars.githubusercontent.com/u/85353424?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Evo</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=EvolutionX-10" title="Code">💻</a></td>
+    <td align="center"><a href="https://enes.ovh/"><img src="https://avatars.githubusercontent.com/u/61084101?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Enes Genç</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=enxg" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/muchnameless"><img src="https://avatars.githubusercontent.com/u/12682826?v=4?s=100" width="100px;" alt=""/><br /><sub><b>muchnameless</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=muchnameless" title="Code">💻</a></td>
   </tr>
 </table>
 

package/dist/index.d.ts

@@ -1,5 +1,240 @@
-export * from './base-decorators';
-export * from './djs-decorators';
-export * from './piece-decorators';
-export * from './utils';
-//# sourceMappingURL=index.d.ts.map
+import { PermissionResolvable } from 'discord.js';
+import { Piece } from '@sapphire/framework';
+import { Container } from '@sapphire/pieces';
+
+/**
+ * Decorator that sets the enumerable property of a class field to the desired value.
+ * @param value Whether the property should be enumerable or not
+ */
+declare function Enumerable(value: boolean): (target: unknown, key: string) => void;
+/**
+ * Decorator that sets the enumerable property of a class method to the desired value.
+ * @param value Whether the method should be enumerable or not
+ */
+declare function EnumerableMethod(value: boolean): MethodDecorator;
+
+/**
+ * The function precondition interface.
+ */
+interface FunctionPrecondition {
+    /**
+     * The arguments passed to the function or class' method.
+     */
+    (...args: any[]): boolean | Promise<boolean>;
+}
+/**
+ * The fallback interface, this is called when the function precondition returns or resolves with a falsy value.
+ */
+interface FunctionFallback {
+    /**
+     * The arguments passed to the function or class' method.
+     */
+    (...args: any[]): unknown;
+}
+/**
+ * Utility to make a method decorator with lighter syntax and inferred types.
+ *
+ * ```typescript
+ * // Enumerable function
+ *	function enumerableMethod(value: boolean) {
+ *		return createMethodDecorator((_target, _propertyKey, descriptor) => {
+ *			descriptor.enumerable = value;
+ *		});
+ *	}
+ * ```
+ * @param fn The method to decorate
+ */
+declare function createMethodDecorator(fn: MethodDecorator): MethodDecorator;
+/**
+ * Utility to make a class decorator with lighter syntax and inferred types.
+ * @param fn The class to decorate
+ * @see {@link ApplyOptions}
+ */
+declare function createClassDecorator<TFunction extends (...args: any[]) => void>(fn: TFunction): ClassDecorator;
+/**
+ * Utility to make function preconditions.
+ *
+ * ```typescript
+ * // No fallback (returns undefined)
+ * function requireGuild(value: number) {
+ *   return createFunctionPrecondition((message: Message) =>
+ *     message.guild !== null
+ *   );
+ * }
+ *
+ * // With fallback
+ * function requireGuild(
+ *   value: number,
+ *   fallback: () => unknown = () => undefined
+ * ) {
+ *   return createFunctionPrecondition(
+ *     (message: Message) => message.guild !== null,
+ *     fallback
+ *   );
+ * }
+ * ```
+ * @since 1.0.0
+ * @param precondition The function that defines whether or not the function should be run, returning the returned value from fallback
+ * @param fallback The fallback value that defines what the method should return in case the precondition fails
+ */
+declare function createFunctionPrecondition(precondition: FunctionPrecondition, fallback?: FunctionFallback): MethodDecorator;
+/**
+ * Creates a new proxy to efficiently add properties to class without creating subclasses
+ * @param target The constructor of the class to modify
+ * @param handler The handler function to modify the constructor behavior for the target
+ * @hidden
+ */
+declare function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T;
+
+declare enum DecoratorIdentifiers {
+    RequiresClientPermissionsGuildOnly = "requiresClientPermissionsGuildOnly",
+    RequiresClientPermissionsMissingPermissions = "requiresClientPermissionsMissingPermissions",
+    RequiresUserPermissionsGuildOnly = "requiresUserPermissionsGuildOnly",
+    RequiresUserPermissionsMissingPermissions = "requiresUserPermissionsMissingPermissions"
+}
+/**
+ * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.
+ * @remark This decorator applies to the client that is to execute the command. For setting permissions required user of the command see {@link RequiresUserPermissions}
+ * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.
+ * @param permissionsResolvable Permissions that the method should have.
+ * @example
+ * ```typescript
+ * import { ApplyOptions, RequiresClientPermissions } from '@sapphire/decorators';
+ * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';
+ * import type { Message } from 'discord.js';
+ *
+ * (at)ApplyOptions<SubCommandPluginCommandOptions>({
+ * 	aliases: ['cws'],
+ * 	description: 'A basic command with some subcommands',
+ * 	subCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]
+ * })
+ * export default class extends SubCommandPluginCommand {
+ *     // Anyone should be able to view the result, but not modify
+ * 	public async show(message: Message) {
+ * 		return message.channel.send('Showing!');
+ * 	}
+ *
+ * 	(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.
+ * 	public async add(message: Message) {
+ * 		return message.channel.send('Adding!');
+ * 	}
+ *
+ * 	(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.
+ * 	public async remove(message: Message) {
+ * 		return message.channel.send('Removing!');
+ * 	}
+ *
+ * 	(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.
+ * 	public async reset(message: Message) {
+ * 		return message.channel.send('Resetting!');
+ * 	}
+ * }
+ * ```
+ */
+declare const RequiresClientPermissions: (...permissionsResolvable: PermissionResolvable[]) => MethodDecorator;
+/**
+ * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.
+ * @remark This decorator applies to the user of the command. For setting permissions required for the client see {@link RequiresClientPermissions}
+ * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.
+ * @param permissionsResolvable Permissions that the method should have.
+ * @example
+ * ```typescript
+ * import { ApplyOptions, RequiresUserPermissions } from '@sapphire/decorators';
+ * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';
+ * import type { Message } from 'discord.js';
+ *
+ * (at)ApplyOptions<SubCommandPluginCommandOptions>({
+ * 	aliases: ['cws'],
+ * 	description: 'A basic command with some subcommands',
+ * 	subCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]
+ * })
+ * export default class extends SubCommandPluginCommand {
+ *     // Anyone should be able to view the result, but not modify
+ * 	public async show(message: Message) {
+ * 		return message.channel.send('Showing!');
+ * 	}
+ *
+ * 	(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.
+ * 	public async add(message: Message) {
+ * 		return message.channel.send('Adding!');
+ * 	}
+ *
+ * 	(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.
+ * 	public async remove(message: Message) {
+ * 		return message.channel.send('Removing!');
+ * 	}
+ *
+ * 	(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.
+ * 	public async reset(message: Message) {
+ * 		return message.channel.send('Resetting!');
+ * 	}
+ * }
+ * ```
+ */
+declare const RequiresUserPermissions: (...permissionsResolvable: PermissionResolvable[]) => MethodDecorator;
+/**
+ * Requires the message to be run in a guild context, this decorator requires the first argument to be a `Message` instance
+ * @since 1.0.0
+ * @param fallback The fallback value passed to `createFunctionInhibitor`
+ */
+declare function RequiresGuildContext(fallback?: FunctionFallback): MethodDecorator;
+/**
+ * Requires the message to be run in a dm context, this decorator requires the first argument to be a `Message` instance
+ * @since 1.0.0
+ * @param fallback The fallback value passed to `createFunctionInhibitor`
+ */
+declare function RequiresDMContext(fallback?: FunctionFallback): MethodDecorator;
+
+/**
+ * Decorator function that applies given options to any Sapphire piece
+ * @param options The options to pass to the piece constructor
+ * @example
+ * ```typescript
+ * import { ApplyOptions } from '@sapphire/decorators';
+ * import { Command } from '@sapphire/framework';
+ * import type { Message } from 'discord.js';
+ *
+ * @ApplyOptions<Command.Options>({
+ *   description: 'ping pong',
+ *   enabled: true
+ * })
+ * export class UserCommand extends Command {
+ *   public override async messageRun(message: Message) {
+ *     const msg = await message.channel.send('Ping?');
+ *
+ *     return msg.edit(
+ *       `Pong! Client Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${msg.createdTimestamp - message.createdTimestamp}ms.`
+ *     );
+ *   }
+ * }
+ * ```
+ * @example
+ * ```typescript
+ * import { ApplyOptions } from '@sapphire/decorators';
+ * import { Listener } from '@sapphire/framework';
+ * import { GatewayDispatchEvents, GatewayMessageDeleteDispatch } from 'discord-api-types/v9';
+ *
+ * @ApplyOptions<Listener.Options>(({ container }) => ({
+ *   description: 'Handle Raw Message Delete events',
+ *   emitter: container.client.ws,
+ *   event: GatewayDispatchEvents.MessageDelete
+ * }))
+ * export class UserListener extends Listener {
+ *   public override run(data: GatewayMessageDeleteDispatch['d']): void {
+ *     if (!data.guild_id) return;
+ *
+ *     const guild = this.container.client.guilds.cache.get(data.guild_id);
+ *     if (!guild || !guild.channels.cache.has(data.channel_id)) return;
+ *
+ *     // Do something with the data
+ *   }
+ * }
+ * ```
+ */
+declare function ApplyOptions<T extends Piece.Options>(optionsOrFn: T | ((parameters: ApplyOptionsCallbackParameters) => T)): ClassDecorator;
+interface ApplyOptionsCallbackParameters {
+    container: Container;
+    context: Piece.Context;
+}
+
+export { ApplyOptions, ApplyOptionsCallbackParameters, DecoratorIdentifiers, Enumerable, EnumerableMethod, FunctionFallback, FunctionPrecondition, RequiresClientPermissions, RequiresDMContext, RequiresGuildContext, RequiresUserPermissions, createClassDecorator, createFunctionPrecondition, createMethodDecorator, createProxy };

package/dist/index.js

@@ -106,26 +106,30 @@ var DecoratorIdentifiers = /* @__PURE__ */ ((DecoratorIdentifiers2) => {
   DecoratorIdentifiers2["RequiresUserPermissionsMissingPermissions"] = "requiresUserPermissionsMissingPermissions";
   return DecoratorIdentifiers2;
 })(DecoratorIdentifiers || {});
-var DMAvailablePermissions = new import_discord2.Permissions(~new import_discord2.Permissions([
-  "ADD_REACTIONS",
-  "ATTACH_FILES",
-  "EMBED_LINKS",
-  "READ_MESSAGE_HISTORY",
-  "SEND_MESSAGES",
-  "USE_EXTERNAL_EMOJIS",
-  "VIEW_CHANNEL"
-]).bitfield & import_discord2.Permissions.ALL);
-var DMAvailableUserPermissions = new import_discord2.Permissions(~new import_discord2.Permissions([
-  "ADD_REACTIONS",
-  "ATTACH_FILES",
-  "EMBED_LINKS",
-  "READ_MESSAGE_HISTORY",
-  "SEND_MESSAGES",
-  "USE_EXTERNAL_EMOJIS",
-  "VIEW_CHANNEL",
-  "USE_EXTERNAL_STICKERS",
-  "MENTION_EVERYONE"
-]).bitfield & import_discord2.Permissions.ALL);
+var DMAvailablePermissions = new import_discord2.Permissions(
+  ~new import_discord2.Permissions([
+    "ADD_REACTIONS",
+    "ATTACH_FILES",
+    "EMBED_LINKS",
+    "READ_MESSAGE_HISTORY",
+    "SEND_MESSAGES",
+    "USE_EXTERNAL_EMOJIS",
+    "VIEW_CHANNEL"
+  ]).bitfield & import_discord2.Permissions.ALL
+);
+var DMAvailableUserPermissions = new import_discord2.Permissions(
+  ~new import_discord2.Permissions([
+    "ADD_REACTIONS",
+    "ATTACH_FILES",
+    "EMBED_LINKS",
+    "READ_MESSAGE_HISTORY",
+    "SEND_MESSAGES",
+    "USE_EXTERNAL_EMOJIS",
+    "VIEW_CHANNEL",
+    "USE_EXTERNAL_STICKERS",
+    "MENTION_EVERYONE"
+  ]).bitfield & import_discord2.Permissions.ALL
+);
 var RequiresClientPermissions = /* @__PURE__ */ __name((...permissionsResolvable) => {
   const resolved = new import_discord2.Permissions(permissionsResolvable);
   const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);
@@ -188,12 +192,14 @@ __name(RequiresDMContext, "RequiresDMContext");
 // src/piece-decorators.ts
 var import_framework2 = require("@sapphire/framework");
 function ApplyOptions(optionsOrFn) {
-  return createClassDecorator((target) => createProxy(target, {
-    construct: (ctor, [context, baseOptions = {}]) => new ctor(context, {
-      ...baseOptions,
-      ...typeof optionsOrFn === "function" ? optionsOrFn({ container: import_framework2.container, context }) : optionsOrFn
+  return createClassDecorator(
+    (target) => createProxy(target, {
+      construct: (ctor, [context, baseOptions = {}]) => new ctor(context, {
+        ...baseOptions,
+        ...typeof optionsOrFn === "function" ? optionsOrFn({ container: import_framework2.container, context }) : optionsOrFn
+      })
     })
-  }));
+  );
 }
 __name(ApplyOptions, "ApplyOptions");
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/utils.ts","../src/base-decorators.ts","../src/djs-decorators.ts","../src/piece-decorators.ts"],"sourcesContent":["export * from './base-decorators';\nexport * from './djs-decorators';\nexport * from './piece-decorators';\nexport * from './utils';\n","/**\n * The function precondition interface.\n */\nexport interface FunctionPrecondition {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): boolean | Promise<boolean>;\n}\n\n/**\n * The fallback interface, this is called when the function precondition returns or resolves with a falsy value.\n */\nexport interface FunctionFallback {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): unknown;\n}\n\n/**\n * Utility to make a method decorator with lighter syntax and inferred types.\n *\n * ```typescript\n * // Enumerable function\n *\tfunction enumerableMethod(value: boolean) {\n *\t\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n *\t\t\tdescriptor.enumerable = value;\n *\t\t});\n *\t}\n * ```\n * @param fn The method to decorate\n */\nexport function createMethodDecorator(fn: MethodDecorator): MethodDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make a class decorator with lighter syntax and inferred types.\n * @param fn The class to decorate\n * @see {@link ApplyOptions}\n */\nexport function createClassDecorator<TFunction extends (...args: any[]) => void>(fn: TFunction): ClassDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make function preconditions.\n *\n * ```typescript\n * // No fallback (returns undefined)\n * function requireGuild(value: number) {\n *   return createFunctionPrecondition((message: Message) =>\n *     message.guild !== null\n *   );\n * }\n *\n * // With fallback\n * function requireGuild(\n *   value: number,\n *   fallback: () => unknown = () => undefined\n * ) {\n *   return createFunctionPrecondition(\n *     (message: Message) => message.guild !== null,\n *     fallback\n *   );\n * }\n * ```\n * @since 1.0.0\n * @param precondition The function that defines whether or not the function should be run, returning the returned value from fallback\n * @param fallback The fallback value that defines what the method should return in case the precondition fails\n */\nexport function createFunctionPrecondition(precondition: FunctionPrecondition, fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tconst method = descriptor.value;\n\t\tif (!method) throw new Error('Function preconditions require a [[value]].');\n\t\tif (typeof method !== 'function') throw new Error('Function preconditions can only be applied to functions.');\n\n\t\tdescriptor.value = async function descriptorValue(this: (...args: any[]) => any, ...args: any[]) {\n\t\t\tconst canRun = await precondition(...args);\n\t\t\treturn canRun ? method.call(this, ...args) : fallback.call(this, ...args);\n\t\t} as unknown as undefined;\n\t});\n}\n\n/**\n * Creates a new proxy to efficiently add properties to class without creating subclasses\n * @param target The constructor of the class to modify\n * @param handler The handler function to modify the constructor behavior for the target\n * @hidden\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T {\n\treturn new Proxy(target, {\n\t\t...handler,\n\t\tget: (target, property) => {\n\t\t\tconst value = Reflect.get(target, property);\n\t\t\treturn typeof value === 'function' ? (...args: readonly unknown[]) => value.apply(target, args) : value;\n\t\t}\n\t});\n}\n","import type { NonNullObject } from '@sapphire/utilities';\nimport { createMethodDecorator } from './utils';\n\n/**\n * Decorator that sets the enumerable property of a class field to the desired value.\n * @param value Whether the property should be enumerable or not\n */\nexport function Enumerable(value: boolean) {\n\treturn (target: unknown, key: string) => {\n\t\tReflect.defineProperty(target as NonNullObject, key, {\n\t\t\tenumerable: value,\n\t\t\tset(this: unknown, val: unknown) {\n\t\t\t\tReflect.defineProperty(this as NonNullObject, key, {\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\tenumerable: value,\n\t\t\t\t\tvalue: val,\n\t\t\t\t\twritable: true\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\t};\n}\n\n/**\n * Decorator that sets the enumerable property of a class method to the desired value.\n * @param value Whether the method should be enumerable or not\n */\nexport function EnumerableMethod(value: boolean) {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tdescriptor.enumerable = value;\n\t});\n}\n","import { isDMChannel, isGuildBasedChannel } from '@sapphire/discord.js-utilities';\nimport { UserError } from '@sapphire/framework';\nimport { Message, PermissionResolvable, Permissions } from 'discord.js';\nimport { createFunctionPrecondition, FunctionFallback } from './utils';\n\nexport enum DecoratorIdentifiers {\n\tRequiresClientPermissionsGuildOnly = 'requiresClientPermissionsGuildOnly',\n\tRequiresClientPermissionsMissingPermissions = 'requiresClientPermissionsMissingPermissions',\n\tRequiresUserPermissionsGuildOnly = 'requiresUserPermissionsGuildOnly',\n\tRequiresUserPermissionsMissingPermissions = 'requiresUserPermissionsMissingPermissions'\n}\n\nconst DMAvailablePermissions = new Permissions(\n\t~new Permissions([\n\t\t//\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL'\n\t]).bitfield & Permissions.ALL\n);\n\nconst DMAvailableUserPermissions = new Permissions(\n\t~new Permissions([\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL',\n\t\t'USE_EXTERNAL_STICKERS',\n\t\t'MENTION_EVERYONE'\n\t]).bitfield & Permissions.ALL\n);\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the client that is to execute the command. For setting permissions required user of the command see {@link RequiresUserPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresClientPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresClientPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.guild!.me!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the user of the command. For setting permissions required for the client see {@link RequiresClientPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresUserPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresUserPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.member!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Requires the message to be run in a guild context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresGuildContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild !== null, fallback);\n}\n\n/**\n * Requires the message to be run in a dm context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresDMContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild === null, fallback);\n}\n","import { container, type Piece } from '@sapphire/framework';\nimport type { Container } from '@sapphire/pieces';\nimport type { Ctor } from '@sapphire/utilities';\nimport { createClassDecorator, createProxy } from './utils';\n\n/**\n * Decorator function that applies given options to any Sapphire piece\n * @param options The options to pass to the piece constructor\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Command } from '@sapphire/framework';\n * import type { Message } from 'discord.js';\n *\n * @ApplyOptions<Command.Options>({\n *   description: 'ping pong',\n *   enabled: true\n * })\n * export class UserCommand extends Command {\n *   public override async messageRun(message: Message) {\n *     const msg = await message.channel.send('Ping?');\n *\n *     return msg.edit(\n *       `Pong! Client Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${msg.createdTimestamp - message.createdTimestamp}ms.`\n *     );\n *   }\n * }\n * ```\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Listener } from '@sapphire/framework';\n * import { GatewayDispatchEvents, GatewayMessageDeleteDispatch } from 'discord-api-types/v9';\n *\n * @ApplyOptions<Listener.Options>(({ container }) => ({\n *   description: 'Handle Raw Message Delete events',\n *   emitter: container.client.ws,\n *   event: GatewayDispatchEvents.MessageDelete\n * }))\n * export class UserListener extends Listener {\n *   public override run(data: GatewayMessageDeleteDispatch['d']): void {\n *     if (!data.guild_id) return;\n *\n *     const guild = this.container.client.guilds.cache.get(data.guild_id);\n *     if (!guild || !guild.channels.cache.has(data.channel_id)) return;\n *\n *     // Do something with the data\n *   }\n * }\n * ```\n */\nexport function ApplyOptions<T extends Piece.Options>(optionsOrFn: T | ((parameters: ApplyOptionsCallbackParameters) => T)): ClassDecorator {\n\treturn createClassDecorator((target: Ctor<ConstructorParameters<typeof Piece>, Piece>) =>\n\t\tcreateProxy(target, {\n\t\t\tconstruct: (ctor, [context, baseOptions = {}]: [Piece.Context, Piece.Options]) =>\n\t\t\t\tnew ctor(context, {\n\t\t\t\t\t...baseOptions,\n\t\t\t\t\t...(typeof optionsOrFn === 'function' ? optionsOrFn({ container, context }) : optionsOrFn)\n\t\t\t\t})\n\t\t})\n\t);\n}\n\nexport interface ApplyOptionsCallbackParameters {\n\tcontainer: Container;\n\tcontext: Piece.Context;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACiCO,+BAA+B,IAAsC;AAC3E,SAAO;AACR;AAFgB;AAST,8BAA0E,IAA+B;AAC/G,SAAO;AACR;AAFgB;AA8BT,oCAAoC,cAAoC,WAA6B,MAAY,QAA4B;AACnJ,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,UAAM,SAAS,WAAW;AAC1B,QAAI,CAAC;AAAQ,YAAM,IAAI,MAAM,6CAA6C;AAC1E,QAAI,OAAO,WAAW;AAAY,YAAM,IAAI,MAAM,0DAA0D;AAE5G,eAAW,QAAQ,yDAAiE,MAAa;AAChG,YAAM,SAAS,MAAM,aAAa,GAAG,IAAI;AACzC,aAAO,SAAS,OAAO,KAAK,MAAM,GAAG,IAAI,IAAI,SAAS,KAAK,MAAM,GAAG,IAAI;AAAA,IACzE,GAHmB;AAAA,EAIpB,CAAC;AACF;AAXgB;AAoBT,qBAAuC,QAAW,SAA0C;AAClG,SAAO,IAAI,MAAM,QAAQ;AAAA,IACxB,GAAG;AAAA,IACH,KAAK,CAAC,SAAQ,aAAa;AAC1B,YAAM,QAAQ,QAAQ,IAAI,SAAQ,QAAQ;AAC1C,aAAO,OAAO,UAAU,aAAa,IAAI,SAA6B,MAAM,MAAM,SAAQ,IAAI,IAAI;AAAA,IACnG;AAAA,EACD,CAAC;AACF;AARgB;;;ACrFT,oBAAoB,OAAgB;AAC1C,SAAO,CAAC,QAAiB,QAAgB;AACxC,YAAQ,eAAe,QAAyB,KAAK;AAAA,MACpD,YAAY;AAAA,MACZ,IAAmB,KAAc;AAChC,gBAAQ,eAAe,MAAuB,KAAK;AAAA,UAClD,cAAc;AAAA,UACd,YAAY;AAAA,UACZ,OAAO;AAAA,UACP,UAAU;AAAA,QACX,CAAC;AAAA,MACF;AAAA,IACD,CAAC;AAAA,EACF;AACD;AAdgB;AAoBT,0BAA0B,OAAgB;AAChD,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,eAAW,aAAa;AAAA,EACzB,CAAC;AACF;AAJgB;;;AC3BhB,qBAAiD;AACjD,uBAA0B;AAC1B,sBAA2D;AAGpD,IAAK,uBAAL,kBAAK,0BAAL;AACN,gEAAqC;AACrC,yEAA8C;AAC9C,8DAAmC;AACnC,uEAA4C;AAJjC;AAAA;AAOZ,IAAM,yBAAyB,IAAI,4BAClC,CAAC,IAAI,4BAAY;AAAA,EAEhB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC,EAAE,WAAW,4BAAY,GAC3B;AAEA,IAAM,6BAA6B,IAAI,4BACtC,CAAC,IAAI,4BAAY;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC,EAAE,WAAW,4BAAY,GAC3B;AAyCO,IAAM,4BAA4B,2BAAI,0BAAmE;AAC/G,QAAM,WAAW,IAAI,4BAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,uBAAuB,QAAQ;AAErG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,gCAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,2BAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,QAAI,wCAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAG,EAAE,QAAQ,QAAQ;AAE9F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,2BAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,yEAAyE;AAAA,UAClF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5ByC;AAqElC,IAAM,0BAA0B,2BAAI,0BAAmE;AAC7G,QAAM,WAAW,IAAI,4BAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,2BAA2B,QAAQ;AAEzG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,gCAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,2BAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,QAAI,wCAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAE,QAAQ,QAAQ;AAE3F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,2BAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,+EAA+E;AAAA,UACxF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5BuC;AAmChC,8BAA8B,WAA6B,MAAY,QAA4B;AACzG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;AAST,2BAA2B,WAA6B,MAAY,QAA4B;AACtG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;;;AC/LhB,wBAAsC;AAmD/B,sBAA+C,aAAsF;AAC3I,SAAO,qBAAqB,CAAC,WAC5B,YAAY,QAAQ;AAAA,IACnB,WAAW,CAAC,MAAM,CAAC,SAAS,cAAc,CAAC,OAC1C,IAAI,KAAK,SAAS;AAAA,MACjB,GAAG;AAAA,MACH,GAAI,OAAO,gBAAgB,aAAa,YAAY,EAAE,wCAAW,QAAQ,CAAC,IAAI;AAAA,IAC/E,CAAC;AAAA,EACH,CAAC,CACF;AACD;AAVgB;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/utils.ts","../src/base-decorators.ts","../src/djs-decorators.ts","../src/piece-decorators.ts"],"sourcesContent":["export * from './base-decorators';\nexport * from './djs-decorators';\nexport * from './piece-decorators';\nexport * from './utils';\n","/**\n * The function precondition interface.\n */\nexport interface FunctionPrecondition {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): boolean | Promise<boolean>;\n}\n\n/**\n * The fallback interface, this is called when the function precondition returns or resolves with a falsy value.\n */\nexport interface FunctionFallback {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): unknown;\n}\n\n/**\n * Utility to make a method decorator with lighter syntax and inferred types.\n *\n * ```typescript\n * // Enumerable function\n *\tfunction enumerableMethod(value: boolean) {\n *\t\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n *\t\t\tdescriptor.enumerable = value;\n *\t\t});\n *\t}\n * ```\n * @param fn The method to decorate\n */\nexport function createMethodDecorator(fn: MethodDecorator): MethodDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make a class decorator with lighter syntax and inferred types.\n * @param fn The class to decorate\n * @see {@link ApplyOptions}\n */\nexport function createClassDecorator<TFunction extends (...args: any[]) => void>(fn: TFunction): ClassDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make function preconditions.\n *\n * ```typescript\n * // No fallback (returns undefined)\n * function requireGuild(value: number) {\n *   return createFunctionPrecondition((message: Message) =>\n *     message.guild !== null\n *   );\n * }\n *\n * // With fallback\n * function requireGuild(\n *   value: number,\n *   fallback: () => unknown = () => undefined\n * ) {\n *   return createFunctionPrecondition(\n *     (message: Message) => message.guild !== null,\n *     fallback\n *   );\n * }\n * ```\n * @since 1.0.0\n * @param precondition The function that defines whether or not the function should be run, returning the returned value from fallback\n * @param fallback The fallback value that defines what the method should return in case the precondition fails\n */\nexport function createFunctionPrecondition(precondition: FunctionPrecondition, fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tconst method = descriptor.value;\n\t\tif (!method) throw new Error('Function preconditions require a [[value]].');\n\t\tif (typeof method !== 'function') throw new Error('Function preconditions can only be applied to functions.');\n\n\t\tdescriptor.value = async function descriptorValue(this: (...args: any[]) => any, ...args: any[]) {\n\t\t\tconst canRun = await precondition(...args);\n\t\t\treturn canRun ? method.call(this, ...args) : fallback.call(this, ...args);\n\t\t} as unknown as undefined;\n\t});\n}\n\n/**\n * Creates a new proxy to efficiently add properties to class without creating subclasses\n * @param target The constructor of the class to modify\n * @param handler The handler function to modify the constructor behavior for the target\n * @hidden\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T {\n\treturn new Proxy(target, {\n\t\t...handler,\n\t\tget: (target, property) => {\n\t\t\tconst value = Reflect.get(target, property);\n\t\t\treturn typeof value === 'function' ? (...args: readonly unknown[]) => value.apply(target, args) : value;\n\t\t}\n\t});\n}\n","import type { NonNullObject } from '@sapphire/utilities';\nimport { createMethodDecorator } from './utils';\n\n/**\n * Decorator that sets the enumerable property of a class field to the desired value.\n * @param value Whether the property should be enumerable or not\n */\nexport function Enumerable(value: boolean) {\n\treturn (target: unknown, key: string) => {\n\t\tReflect.defineProperty(target as NonNullObject, key, {\n\t\t\tenumerable: value,\n\t\t\tset(this: unknown, val: unknown) {\n\t\t\t\tReflect.defineProperty(this as NonNullObject, key, {\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\tenumerable: value,\n\t\t\t\t\tvalue: val,\n\t\t\t\t\twritable: true\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\t};\n}\n\n/**\n * Decorator that sets the enumerable property of a class method to the desired value.\n * @param value Whether the method should be enumerable or not\n */\nexport function EnumerableMethod(value: boolean) {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tdescriptor.enumerable = value;\n\t});\n}\n","import { isDMChannel, isGuildBasedChannel } from '@sapphire/discord.js-utilities';\nimport { UserError } from '@sapphire/framework';\nimport { Message, PermissionResolvable, Permissions } from 'discord.js';\nimport { createFunctionPrecondition, FunctionFallback } from './utils';\n\nexport enum DecoratorIdentifiers {\n\tRequiresClientPermissionsGuildOnly = 'requiresClientPermissionsGuildOnly',\n\tRequiresClientPermissionsMissingPermissions = 'requiresClientPermissionsMissingPermissions',\n\tRequiresUserPermissionsGuildOnly = 'requiresUserPermissionsGuildOnly',\n\tRequiresUserPermissionsMissingPermissions = 'requiresUserPermissionsMissingPermissions'\n}\n\nconst DMAvailablePermissions = new Permissions(\n\t~new Permissions([\n\t\t//\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL'\n\t]).bitfield & Permissions.ALL\n);\n\nconst DMAvailableUserPermissions = new Permissions(\n\t~new Permissions([\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL',\n\t\t'USE_EXTERNAL_STICKERS',\n\t\t'MENTION_EVERYONE'\n\t]).bitfield & Permissions.ALL\n);\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the client that is to execute the command. For setting permissions required user of the command see {@link RequiresUserPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresClientPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresClientPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.guild!.me!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the user of the command. For setting permissions required for the client see {@link RequiresClientPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresUserPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresUserPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.member!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Requires the message to be run in a guild context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresGuildContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild !== null, fallback);\n}\n\n/**\n * Requires the message to be run in a dm context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresDMContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild === null, fallback);\n}\n","import { container, type Piece } from '@sapphire/framework';\nimport type { Container } from '@sapphire/pieces';\nimport type { Ctor } from '@sapphire/utilities';\nimport { createClassDecorator, createProxy } from './utils';\n\n/**\n * Decorator function that applies given options to any Sapphire piece\n * @param options The options to pass to the piece constructor\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Command } from '@sapphire/framework';\n * import type { Message } from 'discord.js';\n *\n * @ApplyOptions<Command.Options>({\n *   description: 'ping pong',\n *   enabled: true\n * })\n * export class UserCommand extends Command {\n *   public override async messageRun(message: Message) {\n *     const msg = await message.channel.send('Ping?');\n *\n *     return msg.edit(\n *       `Pong! Client Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${msg.createdTimestamp - message.createdTimestamp}ms.`\n *     );\n *   }\n * }\n * ```\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Listener } from '@sapphire/framework';\n * import { GatewayDispatchEvents, GatewayMessageDeleteDispatch } from 'discord-api-types/v9';\n *\n * @ApplyOptions<Listener.Options>(({ container }) => ({\n *   description: 'Handle Raw Message Delete events',\n *   emitter: container.client.ws,\n *   event: GatewayDispatchEvents.MessageDelete\n * }))\n * export class UserListener extends Listener {\n *   public override run(data: GatewayMessageDeleteDispatch['d']): void {\n *     if (!data.guild_id) return;\n *\n *     const guild = this.container.client.guilds.cache.get(data.guild_id);\n *     if (!guild || !guild.channels.cache.has(data.channel_id)) return;\n *\n *     // Do something with the data\n *   }\n * }\n * ```\n */\nexport function ApplyOptions<T extends Piece.Options>(optionsOrFn: T | ((parameters: ApplyOptionsCallbackParameters) => T)): ClassDecorator {\n\treturn createClassDecorator((target: Ctor<ConstructorParameters<typeof Piece>, Piece>) =>\n\t\tcreateProxy(target, {\n\t\t\tconstruct: (ctor, [context, baseOptions = {}]: [Piece.Context, Piece.Options]) =>\n\t\t\t\tnew ctor(context, {\n\t\t\t\t\t...baseOptions,\n\t\t\t\t\t...(typeof optionsOrFn === 'function' ? optionsOrFn({ container, context }) : optionsOrFn)\n\t\t\t\t})\n\t\t})\n\t);\n}\n\nexport interface ApplyOptionsCallbackParameters {\n\tcontainer: Container;\n\tcontext: Piece.Context;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACiCO,SAAS,sBAAsB,IAAsC;AAC3E,SAAO;AACR;AAFgB;AAST,SAAS,qBAAiE,IAA+B;AAC/G,SAAO;AACR;AAFgB;AA8BT,SAAS,2BAA2B,cAAoC,WAA6B,MAAY,QAA4B;AACnJ,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,UAAM,SAAS,WAAW;AAC1B,QAAI,CAAC;AAAQ,YAAM,IAAI,MAAM,6CAA6C;AAC1E,QAAI,OAAO,WAAW;AAAY,YAAM,IAAI,MAAM,0DAA0D;AAE5G,eAAW,QAAQ,sCAAe,mBAAkD,MAAa;AAChG,YAAM,SAAS,MAAM,aAAa,GAAG,IAAI;AACzC,aAAO,SAAS,OAAO,KAAK,MAAM,GAAG,IAAI,IAAI,SAAS,KAAK,MAAM,GAAG,IAAI;AAAA,IACzE,GAHmB;AAAA,EAIpB,CAAC;AACF;AAXgB;AAoBT,SAAS,YAA8B,QAAW,SAA0C;AAClG,SAAO,IAAI,MAAM,QAAQ;AAAA,IACxB,GAAG;AAAA,IACH,KAAK,CAACA,SAAQ,aAAa;AAC1B,YAAM,QAAQ,QAAQ,IAAIA,SAAQ,QAAQ;AAC1C,aAAO,OAAO,UAAU,aAAa,IAAI,SAA6B,MAAM,MAAMA,SAAQ,IAAI,IAAI;AAAA,IACnG;AAAA,EACD,CAAC;AACF;AARgB;;;ACrFT,SAAS,WAAW,OAAgB;AAC1C,SAAO,CAAC,QAAiB,QAAgB;AACxC,YAAQ,eAAe,QAAyB,KAAK;AAAA,MACpD,YAAY;AAAA,MACZ,IAAmB,KAAc;AAChC,gBAAQ,eAAe,MAAuB,KAAK;AAAA,UAClD,cAAc;AAAA,UACd,YAAY;AAAA,UACZ,OAAO;AAAA,UACP,UAAU;AAAA,QACX,CAAC;AAAA,MACF;AAAA,IACD,CAAC;AAAA,EACF;AACD;AAdgB;AAoBT,SAAS,iBAAiB,OAAgB;AAChD,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,eAAW,aAAa;AAAA,EACzB,CAAC;AACF;AAJgB;;;AC3BhB,qBAAiD;AACjD,uBAA0B;AAC1B,IAAAC,kBAA2D;AAGpD,IAAK,uBAAL,kBAAKC,0BAAL;AACN,EAAAA,sBAAA,wCAAqC;AACrC,EAAAA,sBAAA,iDAA8C;AAC9C,EAAAA,sBAAA,sCAAmC;AACnC,EAAAA,sBAAA,+CAA4C;AAJjC,SAAAA;AAAA,GAAA;AAOZ,IAAM,yBAAyB,IAAI;AAAA,EAClC,CAAC,IAAI,4BAAY;AAAA,IAEhB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,CAAC,EAAE,WAAW,4BAAY;AAC3B;AAEA,IAAM,6BAA6B,IAAI;AAAA,EACtC,CAAC,IAAI,4BAAY;AAAA,IAChB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,CAAC,EAAE,WAAW,4BAAY;AAC3B;AAyCO,IAAM,4BAA4B,2BAAI,0BAAmE;AAC/G,QAAM,WAAW,IAAI,4BAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,uBAAuB,QAAQ;AAErG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,yCAAqC,4BAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,2BAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,YAAI,oCAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAG,EAAE,QAAQ,QAAQ;AAE9F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,2BAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,yEAAyE;AAAA,UAClF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5ByC;AAqElC,IAAM,0BAA0B,2BAAI,0BAAmE;AAC7G,QAAM,WAAW,IAAI,4BAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,2BAA2B,QAAQ;AAEzG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,yCAAqC,4BAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,2BAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,YAAI,oCAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAE,QAAQ,QAAQ;AAE3F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,2BAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,+EAA+E;AAAA,UACxF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5BuC;AAmChC,SAAS,qBAAqB,WAA6B,MAAY,QAA4B;AACzG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;AAST,SAAS,kBAAkB,WAA6B,MAAY,QAA4B;AACtG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;;;AC/LhB,IAAAC,oBAAsC;AAmD/B,SAAS,aAAsC,aAAsF;AAC3I,SAAO;AAAA,IAAqB,CAAC,WAC5B,YAAY,QAAQ;AAAA,MACnB,WAAW,CAAC,MAAM,CAAC,SAAS,cAAc,CAAC,CAAC,MAC3C,IAAI,KAAK,SAAS;AAAA,QACjB,GAAG;AAAA,QACH,GAAI,OAAO,gBAAgB,aAAa,YAAY,EAAE,wCAAW,QAAQ,CAAC,IAAI;AAAA,MAC/E,CAAC;AAAA,IACH,CAAC;AAAA,EACF;AACD;AAVgB;","names":["target","import_discord","DecoratorIdentifiers","import_framework"]}

package/dist/index.mjs

@@ -70,26 +70,30 @@ var DecoratorIdentifiers = /* @__PURE__ */ ((DecoratorIdentifiers2) => {
   DecoratorIdentifiers2["RequiresUserPermissionsMissingPermissions"] = "requiresUserPermissionsMissingPermissions";
   return DecoratorIdentifiers2;
 })(DecoratorIdentifiers || {});
-var DMAvailablePermissions = new Permissions(~new Permissions([
-  "ADD_REACTIONS",
-  "ATTACH_FILES",
-  "EMBED_LINKS",
-  "READ_MESSAGE_HISTORY",
-  "SEND_MESSAGES",
-  "USE_EXTERNAL_EMOJIS",
-  "VIEW_CHANNEL"
-]).bitfield & Permissions.ALL);
-var DMAvailableUserPermissions = new Permissions(~new Permissions([
-  "ADD_REACTIONS",
-  "ATTACH_FILES",
-  "EMBED_LINKS",
-  "READ_MESSAGE_HISTORY",
-  "SEND_MESSAGES",
-  "USE_EXTERNAL_EMOJIS",
-  "VIEW_CHANNEL",
-  "USE_EXTERNAL_STICKERS",
-  "MENTION_EVERYONE"
-]).bitfield & Permissions.ALL);
+var DMAvailablePermissions = new Permissions(
+  ~new Permissions([
+    "ADD_REACTIONS",
+    "ATTACH_FILES",
+    "EMBED_LINKS",
+    "READ_MESSAGE_HISTORY",
+    "SEND_MESSAGES",
+    "USE_EXTERNAL_EMOJIS",
+    "VIEW_CHANNEL"
+  ]).bitfield & Permissions.ALL
+);
+var DMAvailableUserPermissions = new Permissions(
+  ~new Permissions([
+    "ADD_REACTIONS",
+    "ATTACH_FILES",
+    "EMBED_LINKS",
+    "READ_MESSAGE_HISTORY",
+    "SEND_MESSAGES",
+    "USE_EXTERNAL_EMOJIS",
+    "VIEW_CHANNEL",
+    "USE_EXTERNAL_STICKERS",
+    "MENTION_EVERYONE"
+  ]).bitfield & Permissions.ALL
+);
 var RequiresClientPermissions = /* @__PURE__ */ __name((...permissionsResolvable) => {
   const resolved = new Permissions(permissionsResolvable);
   const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);
@@ -152,12 +156,14 @@ __name(RequiresDMContext, "RequiresDMContext");
 // src/piece-decorators.ts
 import { container } from "@sapphire/framework";
 function ApplyOptions(optionsOrFn) {
-  return createClassDecorator((target) => createProxy(target, {
-    construct: (ctor, [context, baseOptions = {}]) => new ctor(context, {
-      ...baseOptions,
-      ...typeof optionsOrFn === "function" ? optionsOrFn({ container, context }) : optionsOrFn
+  return createClassDecorator(
+    (target) => createProxy(target, {
+      construct: (ctor, [context, baseOptions = {}]) => new ctor(context, {
+        ...baseOptions,
+        ...typeof optionsOrFn === "function" ? optionsOrFn({ container, context }) : optionsOrFn
+      })
     })
-  }));
+  );
 }
 __name(ApplyOptions, "ApplyOptions");
 export {

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/utils.ts","../src/base-decorators.ts","../src/djs-decorators.ts","../src/piece-decorators.ts"],"sourcesContent":["/**\n * The function precondition interface.\n */\nexport interface FunctionPrecondition {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): boolean | Promise<boolean>;\n}\n\n/**\n * The fallback interface, this is called when the function precondition returns or resolves with a falsy value.\n */\nexport interface FunctionFallback {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): unknown;\n}\n\n/**\n * Utility to make a method decorator with lighter syntax and inferred types.\n *\n * ```typescript\n * // Enumerable function\n *\tfunction enumerableMethod(value: boolean) {\n *\t\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n *\t\t\tdescriptor.enumerable = value;\n *\t\t});\n *\t}\n * ```\n * @param fn The method to decorate\n */\nexport function createMethodDecorator(fn: MethodDecorator): MethodDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make a class decorator with lighter syntax and inferred types.\n * @param fn The class to decorate\n * @see {@link ApplyOptions}\n */\nexport function createClassDecorator<TFunction extends (...args: any[]) => void>(fn: TFunction): ClassDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make function preconditions.\n *\n * ```typescript\n * // No fallback (returns undefined)\n * function requireGuild(value: number) {\n *   return createFunctionPrecondition((message: Message) =>\n *     message.guild !== null\n *   );\n * }\n *\n * // With fallback\n * function requireGuild(\n *   value: number,\n *   fallback: () => unknown = () => undefined\n * ) {\n *   return createFunctionPrecondition(\n *     (message: Message) => message.guild !== null,\n *     fallback\n *   );\n * }\n * ```\n * @since 1.0.0\n * @param precondition The function that defines whether or not the function should be run, returning the returned value from fallback\n * @param fallback The fallback value that defines what the method should return in case the precondition fails\n */\nexport function createFunctionPrecondition(precondition: FunctionPrecondition, fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tconst method = descriptor.value;\n\t\tif (!method) throw new Error('Function preconditions require a [[value]].');\n\t\tif (typeof method !== 'function') throw new Error('Function preconditions can only be applied to functions.');\n\n\t\tdescriptor.value = async function descriptorValue(this: (...args: any[]) => any, ...args: any[]) {\n\t\t\tconst canRun = await precondition(...args);\n\t\t\treturn canRun ? method.call(this, ...args) : fallback.call(this, ...args);\n\t\t} as unknown as undefined;\n\t});\n}\n\n/**\n * Creates a new proxy to efficiently add properties to class without creating subclasses\n * @param target The constructor of the class to modify\n * @param handler The handler function to modify the constructor behavior for the target\n * @hidden\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T {\n\treturn new Proxy(target, {\n\t\t...handler,\n\t\tget: (target, property) => {\n\t\t\tconst value = Reflect.get(target, property);\n\t\t\treturn typeof value === 'function' ? (...args: readonly unknown[]) => value.apply(target, args) : value;\n\t\t}\n\t});\n}\n","import type { NonNullObject } from '@sapphire/utilities';\nimport { createMethodDecorator } from './utils';\n\n/**\n * Decorator that sets the enumerable property of a class field to the desired value.\n * @param value Whether the property should be enumerable or not\n */\nexport function Enumerable(value: boolean) {\n\treturn (target: unknown, key: string) => {\n\t\tReflect.defineProperty(target as NonNullObject, key, {\n\t\t\tenumerable: value,\n\t\t\tset(this: unknown, val: unknown) {\n\t\t\t\tReflect.defineProperty(this as NonNullObject, key, {\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\tenumerable: value,\n\t\t\t\t\tvalue: val,\n\t\t\t\t\twritable: true\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\t};\n}\n\n/**\n * Decorator that sets the enumerable property of a class method to the desired value.\n * @param value Whether the method should be enumerable or not\n */\nexport function EnumerableMethod(value: boolean) {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tdescriptor.enumerable = value;\n\t});\n}\n","import { isDMChannel, isGuildBasedChannel } from '@sapphire/discord.js-utilities';\nimport { UserError } from '@sapphire/framework';\nimport { Message, PermissionResolvable, Permissions } from 'discord.js';\nimport { createFunctionPrecondition, FunctionFallback } from './utils';\n\nexport enum DecoratorIdentifiers {\n\tRequiresClientPermissionsGuildOnly = 'requiresClientPermissionsGuildOnly',\n\tRequiresClientPermissionsMissingPermissions = 'requiresClientPermissionsMissingPermissions',\n\tRequiresUserPermissionsGuildOnly = 'requiresUserPermissionsGuildOnly',\n\tRequiresUserPermissionsMissingPermissions = 'requiresUserPermissionsMissingPermissions'\n}\n\nconst DMAvailablePermissions = new Permissions(\n\t~new Permissions([\n\t\t//\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL'\n\t]).bitfield & Permissions.ALL\n);\n\nconst DMAvailableUserPermissions = new Permissions(\n\t~new Permissions([\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL',\n\t\t'USE_EXTERNAL_STICKERS',\n\t\t'MENTION_EVERYONE'\n\t]).bitfield & Permissions.ALL\n);\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the client that is to execute the command. For setting permissions required user of the command see {@link RequiresUserPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresClientPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresClientPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.guild!.me!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the user of the command. For setting permissions required for the client see {@link RequiresClientPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresUserPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresUserPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.member!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Requires the message to be run in a guild context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresGuildContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild !== null, fallback);\n}\n\n/**\n * Requires the message to be run in a dm context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresDMContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild === null, fallback);\n}\n","import { container, type Piece } from '@sapphire/framework';\nimport type { Container } from '@sapphire/pieces';\nimport type { Ctor } from '@sapphire/utilities';\nimport { createClassDecorator, createProxy } from './utils';\n\n/**\n * Decorator function that applies given options to any Sapphire piece\n * @param options The options to pass to the piece constructor\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Command } from '@sapphire/framework';\n * import type { Message } from 'discord.js';\n *\n * @ApplyOptions<Command.Options>({\n *   description: 'ping pong',\n *   enabled: true\n * })\n * export class UserCommand extends Command {\n *   public override async messageRun(message: Message) {\n *     const msg = await message.channel.send('Ping?');\n *\n *     return msg.edit(\n *       `Pong! Client Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${msg.createdTimestamp - message.createdTimestamp}ms.`\n *     );\n *   }\n * }\n * ```\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Listener } from '@sapphire/framework';\n * import { GatewayDispatchEvents, GatewayMessageDeleteDispatch } from 'discord-api-types/v9';\n *\n * @ApplyOptions<Listener.Options>(({ container }) => ({\n *   description: 'Handle Raw Message Delete events',\n *   emitter: container.client.ws,\n *   event: GatewayDispatchEvents.MessageDelete\n * }))\n * export class UserListener extends Listener {\n *   public override run(data: GatewayMessageDeleteDispatch['d']): void {\n *     if (!data.guild_id) return;\n *\n *     const guild = this.container.client.guilds.cache.get(data.guild_id);\n *     if (!guild || !guild.channels.cache.has(data.channel_id)) return;\n *\n *     // Do something with the data\n *   }\n * }\n * ```\n */\nexport function ApplyOptions<T extends Piece.Options>(optionsOrFn: T | ((parameters: ApplyOptionsCallbackParameters) => T)): ClassDecorator {\n\treturn createClassDecorator((target: Ctor<ConstructorParameters<typeof Piece>, Piece>) =>\n\t\tcreateProxy(target, {\n\t\t\tconstruct: (ctor, [context, baseOptions = {}]: [Piece.Context, Piece.Options]) =>\n\t\t\t\tnew ctor(context, {\n\t\t\t\t\t...baseOptions,\n\t\t\t\t\t...(typeof optionsOrFn === 'function' ? optionsOrFn({ container, context }) : optionsOrFn)\n\t\t\t\t})\n\t\t})\n\t);\n}\n\nexport interface ApplyOptionsCallbackParameters {\n\tcontainer: Container;\n\tcontext: Piece.Context;\n}\n"],"mappings":";;;;AAiCO,+BAA+B,IAAsC;AAC3E,SAAO;AACR;AAFgB;AAST,8BAA0E,IAA+B;AAC/G,SAAO;AACR;AAFgB;AA8BT,oCAAoC,cAAoC,WAA6B,MAAY,QAA4B;AACnJ,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,UAAM,SAAS,WAAW;AAC1B,QAAI,CAAC;AAAQ,YAAM,IAAI,MAAM,6CAA6C;AAC1E,QAAI,OAAO,WAAW;AAAY,YAAM,IAAI,MAAM,0DAA0D;AAE5G,eAAW,QAAQ,yDAAiE,MAAa;AAChG,YAAM,SAAS,MAAM,aAAa,GAAG,IAAI;AACzC,aAAO,SAAS,OAAO,KAAK,MAAM,GAAG,IAAI,IAAI,SAAS,KAAK,MAAM,GAAG,IAAI;AAAA,IACzE,GAHmB;AAAA,EAIpB,CAAC;AACF;AAXgB;AAoBT,qBAAuC,QAAW,SAA0C;AAClG,SAAO,IAAI,MAAM,QAAQ;AAAA,IACxB,GAAG;AAAA,IACH,KAAK,CAAC,SAAQ,aAAa;AAC1B,YAAM,QAAQ,QAAQ,IAAI,SAAQ,QAAQ;AAC1C,aAAO,OAAO,UAAU,aAAa,IAAI,SAA6B,MAAM,MAAM,SAAQ,IAAI,IAAI;AAAA,IACnG;AAAA,EACD,CAAC;AACF;AARgB;;;ACrFT,oBAAoB,OAAgB;AAC1C,SAAO,CAAC,QAAiB,QAAgB;AACxC,YAAQ,eAAe,QAAyB,KAAK;AAAA,MACpD,YAAY;AAAA,MACZ,IAAmB,KAAc;AAChC,gBAAQ,eAAe,MAAuB,KAAK;AAAA,UAClD,cAAc;AAAA,UACd,YAAY;AAAA,UACZ,OAAO;AAAA,UACP,UAAU;AAAA,QACX,CAAC;AAAA,MACF;AAAA,IACD,CAAC;AAAA,EACF;AACD;AAdgB;AAoBT,0BAA0B,OAAgB;AAChD,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,eAAW,aAAa;AAAA,EACzB,CAAC;AACF;AAJgB;;;AC3BhB;AACA;AACA;AAGO,IAAK,uBAAL,kBAAK,0BAAL;AACN,gEAAqC;AACrC,yEAA8C;AAC9C,8DAAmC;AACnC,uEAA4C;AAJjC;AAAA;AAOZ,IAAM,yBAAyB,IAAI,YAClC,CAAC,IAAI,YAAY;AAAA,EAEhB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC,EAAE,WAAW,YAAY,GAC3B;AAEA,IAAM,6BAA6B,IAAI,YACtC,CAAC,IAAI,YAAY;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC,EAAE,WAAW,YAAY,GAC3B;AAyCO,IAAM,4BAA4B,2BAAI,0BAAmE;AAC/G,QAAM,WAAW,IAAI,YAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,uBAAuB,QAAQ;AAErG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,YAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,UAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,QAAI,oBAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAG,EAAE,QAAQ,QAAQ;AAE9F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,UAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,yEAAyE;AAAA,UAClF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5ByC;AAqElC,IAAM,0BAA0B,2BAAI,0BAAmE;AAC7G,QAAM,WAAW,IAAI,YAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,2BAA2B,QAAQ;AAEzG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,YAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,UAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,QAAI,oBAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAE,QAAQ,QAAQ;AAE3F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,UAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,+EAA+E;AAAA,UACxF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5BuC;AAmChC,8BAA8B,WAA6B,MAAY,QAA4B;AACzG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;AAST,2BAA2B,WAA6B,MAAY,QAA4B;AACtG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;;;AC/LhB;AAmDO,sBAA+C,aAAsF;AAC3I,SAAO,qBAAqB,CAAC,WAC5B,YAAY,QAAQ;AAAA,IACnB,WAAW,CAAC,MAAM,CAAC,SAAS,cAAc,CAAC,OAC1C,IAAI,KAAK,SAAS;AAAA,MACjB,GAAG;AAAA,MACH,GAAI,OAAO,gBAAgB,aAAa,YAAY,EAAE,WAAW,QAAQ,CAAC,IAAI;AAAA,IAC/E,CAAC;AAAA,EACH,CAAC,CACF;AACD;AAVgB;","names":[]}
+{"version":3,"sources":["../src/utils.ts","../src/base-decorators.ts","../src/djs-decorators.ts","../src/piece-decorators.ts"],"sourcesContent":["/**\n * The function precondition interface.\n */\nexport interface FunctionPrecondition {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): boolean | Promise<boolean>;\n}\n\n/**\n * The fallback interface, this is called when the function precondition returns or resolves with a falsy value.\n */\nexport interface FunctionFallback {\n\t/**\n\t * The arguments passed to the function or class' method.\n\t */\n\t(...args: any[]): unknown;\n}\n\n/**\n * Utility to make a method decorator with lighter syntax and inferred types.\n *\n * ```typescript\n * // Enumerable function\n *\tfunction enumerableMethod(value: boolean) {\n *\t\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n *\t\t\tdescriptor.enumerable = value;\n *\t\t});\n *\t}\n * ```\n * @param fn The method to decorate\n */\nexport function createMethodDecorator(fn: MethodDecorator): MethodDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make a class decorator with lighter syntax and inferred types.\n * @param fn The class to decorate\n * @see {@link ApplyOptions}\n */\nexport function createClassDecorator<TFunction extends (...args: any[]) => void>(fn: TFunction): ClassDecorator {\n\treturn fn;\n}\n\n/**\n * Utility to make function preconditions.\n *\n * ```typescript\n * // No fallback (returns undefined)\n * function requireGuild(value: number) {\n *   return createFunctionPrecondition((message: Message) =>\n *     message.guild !== null\n *   );\n * }\n *\n * // With fallback\n * function requireGuild(\n *   value: number,\n *   fallback: () => unknown = () => undefined\n * ) {\n *   return createFunctionPrecondition(\n *     (message: Message) => message.guild !== null,\n *     fallback\n *   );\n * }\n * ```\n * @since 1.0.0\n * @param precondition The function that defines whether or not the function should be run, returning the returned value from fallback\n * @param fallback The fallback value that defines what the method should return in case the precondition fails\n */\nexport function createFunctionPrecondition(precondition: FunctionPrecondition, fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tconst method = descriptor.value;\n\t\tif (!method) throw new Error('Function preconditions require a [[value]].');\n\t\tif (typeof method !== 'function') throw new Error('Function preconditions can only be applied to functions.');\n\n\t\tdescriptor.value = async function descriptorValue(this: (...args: any[]) => any, ...args: any[]) {\n\t\t\tconst canRun = await precondition(...args);\n\t\t\treturn canRun ? method.call(this, ...args) : fallback.call(this, ...args);\n\t\t} as unknown as undefined;\n\t});\n}\n\n/**\n * Creates a new proxy to efficiently add properties to class without creating subclasses\n * @param target The constructor of the class to modify\n * @param handler The handler function to modify the constructor behavior for the target\n * @hidden\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T {\n\treturn new Proxy(target, {\n\t\t...handler,\n\t\tget: (target, property) => {\n\t\t\tconst value = Reflect.get(target, property);\n\t\t\treturn typeof value === 'function' ? (...args: readonly unknown[]) => value.apply(target, args) : value;\n\t\t}\n\t});\n}\n","import type { NonNullObject } from '@sapphire/utilities';\nimport { createMethodDecorator } from './utils';\n\n/**\n * Decorator that sets the enumerable property of a class field to the desired value.\n * @param value Whether the property should be enumerable or not\n */\nexport function Enumerable(value: boolean) {\n\treturn (target: unknown, key: string) => {\n\t\tReflect.defineProperty(target as NonNullObject, key, {\n\t\t\tenumerable: value,\n\t\t\tset(this: unknown, val: unknown) {\n\t\t\t\tReflect.defineProperty(this as NonNullObject, key, {\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\tenumerable: value,\n\t\t\t\t\tvalue: val,\n\t\t\t\t\twritable: true\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\t};\n}\n\n/**\n * Decorator that sets the enumerable property of a class method to the desired value.\n * @param value Whether the method should be enumerable or not\n */\nexport function EnumerableMethod(value: boolean) {\n\treturn createMethodDecorator((_target, _propertyKey, descriptor) => {\n\t\tdescriptor.enumerable = value;\n\t});\n}\n","import { isDMChannel, isGuildBasedChannel } from '@sapphire/discord.js-utilities';\nimport { UserError } from '@sapphire/framework';\nimport { Message, PermissionResolvable, Permissions } from 'discord.js';\nimport { createFunctionPrecondition, FunctionFallback } from './utils';\n\nexport enum DecoratorIdentifiers {\n\tRequiresClientPermissionsGuildOnly = 'requiresClientPermissionsGuildOnly',\n\tRequiresClientPermissionsMissingPermissions = 'requiresClientPermissionsMissingPermissions',\n\tRequiresUserPermissionsGuildOnly = 'requiresUserPermissionsGuildOnly',\n\tRequiresUserPermissionsMissingPermissions = 'requiresUserPermissionsMissingPermissions'\n}\n\nconst DMAvailablePermissions = new Permissions(\n\t~new Permissions([\n\t\t//\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL'\n\t]).bitfield & Permissions.ALL\n);\n\nconst DMAvailableUserPermissions = new Permissions(\n\t~new Permissions([\n\t\t'ADD_REACTIONS',\n\t\t'ATTACH_FILES',\n\t\t'EMBED_LINKS',\n\t\t'READ_MESSAGE_HISTORY',\n\t\t'SEND_MESSAGES',\n\t\t'USE_EXTERNAL_EMOJIS',\n\t\t'VIEW_CHANNEL',\n\t\t'USE_EXTERNAL_STICKERS',\n\t\t'MENTION_EVERYONE'\n\t]).bitfield & Permissions.ALL\n);\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the client that is to execute the command. For setting permissions required user of the command see {@link RequiresUserPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresClientPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresClientPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.guild!.me!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresClientPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.\n * @remark This decorator applies to the user of the command. For setting permissions required for the client see {@link RequiresClientPermissions}\n * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.\n * @param permissionsResolvable Permissions that the method should have.\n * @example\n * ```typescript\n * import { ApplyOptions, RequiresUserPermissions } from '@sapphire/decorators';\n * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';\n * import type { Message } from 'discord.js';\n *\n * (at)ApplyOptions<SubCommandPluginCommandOptions>({\n * \taliases: ['cws'],\n * \tdescription: 'A basic command with some subcommands',\n * \tsubCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]\n * })\n * export default class extends SubCommandPluginCommand {\n *     // Anyone should be able to view the result, but not modify\n * \tpublic async show(message: Message) {\n * \t\treturn message.channel.send('Showing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async add(message: Message) {\n * \t\treturn message.channel.send('Adding!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async remove(message: Message) {\n * \t\treturn message.channel.send('Removing!');\n * \t}\n *\n * \t(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.\n * \tpublic async reset(message: Message) {\n * \t\treturn message.channel.send('Resetting!');\n * \t}\n * }\n * ```\n */\nexport const RequiresUserPermissions = (...permissionsResolvable: PermissionResolvable[]): MethodDecorator => {\n\tconst resolved = new Permissions(permissionsResolvable);\n\tconst resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);\n\n\treturn createFunctionPrecondition((message: Message) => {\n\t\tif (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {\n\t\t\tthrow new UserError({\n\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsGuildOnly,\n\t\t\t\tmessage: 'Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs'\n\t\t\t});\n\t\t}\n\n\t\tif (isGuildBasedChannel(message.channel)) {\n\t\t\tconst missingPermissions = message.channel.permissionsFor(message.member!).missing(resolved);\n\n\t\t\tif (missingPermissions.length) {\n\t\t\t\tthrow new UserError({\n\t\t\t\t\tidentifier: DecoratorIdentifiers.RequiresUserPermissionsMissingPermissions,\n\t\t\t\t\tmessage: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,\n\t\t\t\t\tcontext: {\n\t\t\t\t\t\tmissing: missingPermissions\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t});\n};\n\n/**\n * Requires the message to be run in a guild context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresGuildContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild !== null, fallback);\n}\n\n/**\n * Requires the message to be run in a dm context, this decorator requires the first argument to be a `Message` instance\n * @since 1.0.0\n * @param fallback The fallback value passed to `createFunctionInhibitor`\n */\nexport function RequiresDMContext(fallback: FunctionFallback = (): void => undefined): MethodDecorator {\n\treturn createFunctionPrecondition((message: Message) => message.guild === null, fallback);\n}\n","import { container, type Piece } from '@sapphire/framework';\nimport type { Container } from '@sapphire/pieces';\nimport type { Ctor } from '@sapphire/utilities';\nimport { createClassDecorator, createProxy } from './utils';\n\n/**\n * Decorator function that applies given options to any Sapphire piece\n * @param options The options to pass to the piece constructor\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Command } from '@sapphire/framework';\n * import type { Message } from 'discord.js';\n *\n * @ApplyOptions<Command.Options>({\n *   description: 'ping pong',\n *   enabled: true\n * })\n * export class UserCommand extends Command {\n *   public override async messageRun(message: Message) {\n *     const msg = await message.channel.send('Ping?');\n *\n *     return msg.edit(\n *       `Pong! Client Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${msg.createdTimestamp - message.createdTimestamp}ms.`\n *     );\n *   }\n * }\n * ```\n * @example\n * ```typescript\n * import { ApplyOptions } from '@sapphire/decorators';\n * import { Listener } from '@sapphire/framework';\n * import { GatewayDispatchEvents, GatewayMessageDeleteDispatch } from 'discord-api-types/v9';\n *\n * @ApplyOptions<Listener.Options>(({ container }) => ({\n *   description: 'Handle Raw Message Delete events',\n *   emitter: container.client.ws,\n *   event: GatewayDispatchEvents.MessageDelete\n * }))\n * export class UserListener extends Listener {\n *   public override run(data: GatewayMessageDeleteDispatch['d']): void {\n *     if (!data.guild_id) return;\n *\n *     const guild = this.container.client.guilds.cache.get(data.guild_id);\n *     if (!guild || !guild.channels.cache.has(data.channel_id)) return;\n *\n *     // Do something with the data\n *   }\n * }\n * ```\n */\nexport function ApplyOptions<T extends Piece.Options>(optionsOrFn: T | ((parameters: ApplyOptionsCallbackParameters) => T)): ClassDecorator {\n\treturn createClassDecorator((target: Ctor<ConstructorParameters<typeof Piece>, Piece>) =>\n\t\tcreateProxy(target, {\n\t\t\tconstruct: (ctor, [context, baseOptions = {}]: [Piece.Context, Piece.Options]) =>\n\t\t\t\tnew ctor(context, {\n\t\t\t\t\t...baseOptions,\n\t\t\t\t\t...(typeof optionsOrFn === 'function' ? optionsOrFn({ container, context }) : optionsOrFn)\n\t\t\t\t})\n\t\t})\n\t);\n}\n\nexport interface ApplyOptionsCallbackParameters {\n\tcontainer: Container;\n\tcontext: Piece.Context;\n}\n"],"mappings":";;;;AAiCO,SAAS,sBAAsB,IAAsC;AAC3E,SAAO;AACR;AAFgB;AAST,SAAS,qBAAiE,IAA+B;AAC/G,SAAO;AACR;AAFgB;AA8BT,SAAS,2BAA2B,cAAoC,WAA6B,MAAY,QAA4B;AACnJ,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,UAAM,SAAS,WAAW;AAC1B,QAAI,CAAC;AAAQ,YAAM,IAAI,MAAM,6CAA6C;AAC1E,QAAI,OAAO,WAAW;AAAY,YAAM,IAAI,MAAM,0DAA0D;AAE5G,eAAW,QAAQ,sCAAe,mBAAkD,MAAa;AAChG,YAAM,SAAS,MAAM,aAAa,GAAG,IAAI;AACzC,aAAO,SAAS,OAAO,KAAK,MAAM,GAAG,IAAI,IAAI,SAAS,KAAK,MAAM,GAAG,IAAI;AAAA,IACzE,GAHmB;AAAA,EAIpB,CAAC;AACF;AAXgB;AAoBT,SAAS,YAA8B,QAAW,SAA0C;AAClG,SAAO,IAAI,MAAM,QAAQ;AAAA,IACxB,GAAG;AAAA,IACH,KAAK,CAACA,SAAQ,aAAa;AAC1B,YAAM,QAAQ,QAAQ,IAAIA,SAAQ,QAAQ;AAC1C,aAAO,OAAO,UAAU,aAAa,IAAI,SAA6B,MAAM,MAAMA,SAAQ,IAAI,IAAI;AAAA,IACnG;AAAA,EACD,CAAC;AACF;AARgB;;;ACrFT,SAAS,WAAW,OAAgB;AAC1C,SAAO,CAAC,QAAiB,QAAgB;AACxC,YAAQ,eAAe,QAAyB,KAAK;AAAA,MACpD,YAAY;AAAA,MACZ,IAAmB,KAAc;AAChC,gBAAQ,eAAe,MAAuB,KAAK;AAAA,UAClD,cAAc;AAAA,UACd,YAAY;AAAA,UACZ,OAAO;AAAA,UACP,UAAU;AAAA,QACX,CAAC;AAAA,MACF;AAAA,IACD,CAAC;AAAA,EACF;AACD;AAdgB;AAoBT,SAAS,iBAAiB,OAAgB;AAChD,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,eAAW,aAAa;AAAA,EACzB,CAAC;AACF;AAJgB;;;AC3BhB,SAAS,aAAa,2BAA2B;AACjD,SAAS,iBAAiB;AAC1B,SAAwC,mBAAmB;AAGpD,IAAK,uBAAL,kBAAKC,0BAAL;AACN,EAAAA,sBAAA,wCAAqC;AACrC,EAAAA,sBAAA,iDAA8C;AAC9C,EAAAA,sBAAA,sCAAmC;AACnC,EAAAA,sBAAA,+CAA4C;AAJjC,SAAAA;AAAA,GAAA;AAOZ,IAAM,yBAAyB,IAAI;AAAA,EAClC,CAAC,IAAI,YAAY;AAAA,IAEhB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,CAAC,EAAE,WAAW,YAAY;AAC3B;AAEA,IAAM,6BAA6B,IAAI;AAAA,EACtC,CAAC,IAAI,YAAY;AAAA,IAChB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,CAAC,EAAE,WAAW,YAAY;AAC3B;AAyCO,IAAM,4BAA4B,2BAAI,0BAAmE;AAC/G,QAAM,WAAW,IAAI,YAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,uBAAuB,QAAQ;AAErG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,YAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,UAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,QAAI,oBAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAG,EAAE,QAAQ,QAAQ;AAE9F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,UAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,yEAAyE;AAAA,UAClF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5ByC;AAqElC,IAAM,0BAA0B,2BAAI,0BAAmE;AAC7G,QAAM,WAAW,IAAI,YAAY,qBAAqB;AACtD,QAAM,oCAAoC,QAAQ,SAAS,WAAW,2BAA2B,QAAQ;AAEzG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,YAAY,QAAQ,OAAO,GAAG;AACtE,YAAM,IAAI,UAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA,MACV,CAAC;AAAA,IACF;AAEA,QAAI,oBAAoB,QAAQ,OAAO,GAAG;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,EAAE,QAAQ,QAAQ;AAE3F,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,UAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,+EAA+E;AAAA,UACxF,SAAS;AAAA,YACR,SAAS;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAEA,WAAO;AAAA,EACR,CAAC;AACF,GA5BuC;AAmChC,SAAS,qBAAqB,WAA6B,MAAY,QAA4B;AACzG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;AAST,SAAS,kBAAkB,WAA6B,MAAY,QAA4B;AACtG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM,QAAQ;AACzF;AAFgB;;;AC/LhB,SAAS,iBAA6B;AAmD/B,SAAS,aAAsC,aAAsF;AAC3I,SAAO;AAAA,IAAqB,CAAC,WAC5B,YAAY,QAAQ;AAAA,MACnB,WAAW,CAAC,MAAM,CAAC,SAAS,cAAc,CAAC,CAAC,MAC3C,IAAI,KAAK,SAAS;AAAA,QACjB,GAAG;AAAA,QACH,GAAI,OAAO,gBAAgB,aAAa,YAAY,EAAE,WAAW,QAAQ,CAAC,IAAI;AAAA,MAC/E,CAAC;AAAA,IACH,CAAC;AAAA,EACF;AACD;AAVgB;","names":["target","DecoratorIdentifiers"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/decorators",
-  "version": "4.3.9-next.f731c3c.0",
+  "version": "5.0.0",
   "description": "Useful TypeScript decorators for Sapphire Framework Discord bots",
   "author": "@sapphire",
   "license": "MIT",
@@ -16,7 +16,7 @@
   "scripts": {
     "test": "vitest run",
     "lint": "eslint src tests --ext ts --fix -c ../../.eslintrc",
-    "build": "tsup && tsc -b src",
+    "build": "tsup",
     "prepack": "yarn build",
     "bump": "cliff-jumper",
     "check-update": "cliff-jumper --dry-run"
@@ -25,14 +25,16 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@favware/cliff-jumper": "^1.8.5",
-    "@sapphire/discord-utilities": "^2.11.4",
-    "@sapphire/discord.js-utilities": "^4.11.3",
+    "@favware/cliff-jumper": "^1.8.7",
+    "@sapphire/discord-utilities": "^2.11.6",
+    "@sapphire/discord.js-utilities": "^5.0.0",
     "@sapphire/ratelimits": "^2.4.4",
-    "@sapphire/result": "^2.0.1",
-    "@sapphire/utilities": "^3.7.0",
-    "tsup": "^6.1.3",
-    "typescript": "^4.7.4"
+    "@sapphire/result": "^2.4.0",
+    "@sapphire/utilities": "^3.9.2",
+    "@vitest/coverage-c8": "^0.22.1",
+    "tsup": "^6.2.2",
+    "typescript": "^4.7.4",
+    "vitest": "^0.22.1"
   },
   "repository": {
     "type": "git",

package/dist/base-decorators.d.ts

@@ -1,11 +0,0 @@
-/**
- * Decorator that sets the enumerable property of a class field to the desired value.
- * @param value Whether the property should be enumerable or not
- */
-export declare function Enumerable(value: boolean): (target: unknown, key: string) => void;
-/**
- * Decorator that sets the enumerable property of a class method to the desired value.
- * @param value Whether the method should be enumerable or not
- */
-export declare function EnumerableMethod(value: boolean): MethodDecorator;
-//# sourceMappingURL=base-decorators.d.ts.map

package/dist/djs-decorators.d.ts

@@ -1,101 +0,0 @@
-import { PermissionResolvable } from 'discord.js';
-import { FunctionFallback } from './utils';
-export declare enum DecoratorIdentifiers {
-    RequiresClientPermissionsGuildOnly = "requiresClientPermissionsGuildOnly",
-    RequiresClientPermissionsMissingPermissions = "requiresClientPermissionsMissingPermissions",
-    RequiresUserPermissionsGuildOnly = "requiresUserPermissionsGuildOnly",
-    RequiresUserPermissionsMissingPermissions = "requiresUserPermissionsMissingPermissions"
-}
-/**
- * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.
- * @remark This decorator applies to the client that is to execute the command. For setting permissions required user of the command see {@link RequiresUserPermissions}
- * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.
- * @param permissionsResolvable Permissions that the method should have.
- * @example
- * ```typescript
- * import { ApplyOptions, RequiresClientPermissions } from '@sapphire/decorators';
- * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';
- * import type { Message } from 'discord.js';
- *
- * (at)ApplyOptions<SubCommandPluginCommandOptions>({
- * 	aliases: ['cws'],
- * 	description: 'A basic command with some subcommands',
- * 	subCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]
- * })
- * export default class extends SubCommandPluginCommand {
- *     // Anyone should be able to view the result, but not modify
- * 	public async show(message: Message) {
- * 		return message.channel.send('Showing!');
- * 	}
- *
- * 	(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.
- * 	public async add(message: Message) {
- * 		return message.channel.send('Adding!');
- * 	}
- *
- * 	(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.
- * 	public async remove(message: Message) {
- * 		return message.channel.send('Removing!');
- * 	}
- *
- * 	(at)RequiresClientPermissions('BAN_MEMBERS') // This subcommand requires the client to be able to ban members.
- * 	public async reset(message: Message) {
- * 		return message.channel.send('Resetting!');
- * 	}
- * }
- * ```
- */
-export declare const RequiresClientPermissions: (...permissionsResolvable: PermissionResolvable[]) => MethodDecorator;
-/**
- * Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions.
- * @remark This decorator applies to the user of the command. For setting permissions required for the client see {@link RequiresClientPermissions}
- * @remark This decorator makes the decorated function asynchronous, so any result should be `await`ed.
- * @param permissionsResolvable Permissions that the method should have.
- * @example
- * ```typescript
- * import { ApplyOptions, RequiresUserPermissions } from '@sapphire/decorators';
- * import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';
- * import type { Message } from 'discord.js';
- *
- * (at)ApplyOptions<SubCommandPluginCommandOptions>({
- * 	aliases: ['cws'],
- * 	description: 'A basic command with some subcommands',
- * 	subCommands: ['add', 'remove', 'reset', { input: 'show', default: true }]
- * })
- * export default class extends SubCommandPluginCommand {
- *     // Anyone should be able to view the result, but not modify
- * 	public async show(message: Message) {
- * 		return message.channel.send('Showing!');
- * 	}
- *
- * 	(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.
- * 	public async add(message: Message) {
- * 		return message.channel.send('Adding!');
- * 	}
- *
- * 	(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.
- * 	public async remove(message: Message) {
- * 		return message.channel.send('Removing!');
- * 	}
- *
- * 	(at)RequiresUserPermissions('BAN_MEMBERS') // This subcommand requires the user of the command to be able to ban members.
- * 	public async reset(message: Message) {
- * 		return message.channel.send('Resetting!');
- * 	}
- * }
- * ```
- */
-export declare const RequiresUserPermissions: (...permissionsResolvable: PermissionResolvable[]) => MethodDecorator;
-/**
- * Requires the message to be run in a guild context, this decorator requires the first argument to be a `Message` instance
- * @since 1.0.0
- * @param fallback The fallback value passed to `createFunctionInhibitor`
- */
-export declare function RequiresGuildContext(fallback?: FunctionFallback): MethodDecorator;
-/**
- * Requires the message to be run in a dm context, this decorator requires the first argument to be a `Message` instance
- * @since 1.0.0
- * @param fallback The fallback value passed to `createFunctionInhibitor`
- */
-export declare function RequiresDMContext(fallback?: FunctionFallback): MethodDecorator;
-//# sourceMappingURL=djs-decorators.d.ts.map

package/dist/piece-decorators.d.ts

@@ -1,54 +0,0 @@
-import { type Piece } from '@sapphire/framework';
-import type { Container } from '@sapphire/pieces';
-/**
- * Decorator function that applies given options to any Sapphire piece
- * @param options The options to pass to the piece constructor
- * @example
- * ```typescript
- * import { ApplyOptions } from '@sapphire/decorators';
- * import { Command } from '@sapphire/framework';
- * import type { Message } from 'discord.js';
- *
- * @ApplyOptions<Command.Options>({
- *   description: 'ping pong',
- *   enabled: true
- * })
- * export class UserCommand extends Command {
- *   public override async messageRun(message: Message) {
- *     const msg = await message.channel.send('Ping?');
- *
- *     return msg.edit(
- *       `Pong! Client Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${msg.createdTimestamp - message.createdTimestamp}ms.`
- *     );
- *   }
- * }
- * ```
- * @example
- * ```typescript
- * import { ApplyOptions } from '@sapphire/decorators';
- * import { Listener } from '@sapphire/framework';
- * import { GatewayDispatchEvents, GatewayMessageDeleteDispatch } from 'discord-api-types/v9';
- *
- * @ApplyOptions<Listener.Options>(({ container }) => ({
- *   description: 'Handle Raw Message Delete events',
- *   emitter: container.client.ws,
- *   event: GatewayDispatchEvents.MessageDelete
- * }))
- * export class UserListener extends Listener {
- *   public override run(data: GatewayMessageDeleteDispatch['d']): void {
- *     if (!data.guild_id) return;
- *
- *     const guild = this.container.client.guilds.cache.get(data.guild_id);
- *     if (!guild || !guild.channels.cache.has(data.channel_id)) return;
- *
- *     // Do something with the data
- *   }
- * }
- * ```
- */
-export declare function ApplyOptions<T extends Piece.Options>(optionsOrFn: T | ((parameters: ApplyOptionsCallbackParameters) => T)): ClassDecorator;
-export interface ApplyOptionsCallbackParameters {
-    container: Container;
-    context: Piece.Context;
-}
-//# sourceMappingURL=piece-decorators.d.ts.map

package/dist/utils.d.ts

@@ -1,73 +0,0 @@
-/**
- * The function precondition interface.
- */
-export interface FunctionPrecondition {
-    /**
-     * The arguments passed to the function or class' method.
-     */
-    (...args: any[]): boolean | Promise<boolean>;
-}
-/**
- * The fallback interface, this is called when the function precondition returns or resolves with a falsy value.
- */
-export interface FunctionFallback {
-    /**
-     * The arguments passed to the function or class' method.
-     */
-    (...args: any[]): unknown;
-}
-/**
- * Utility to make a method decorator with lighter syntax and inferred types.
- *
- * ```typescript
- * // Enumerable function
- *	function enumerableMethod(value: boolean) {
- *		return createMethodDecorator((_target, _propertyKey, descriptor) => {
- *			descriptor.enumerable = value;
- *		});
- *	}
- * ```
- * @param fn The method to decorate
- */
-export declare function createMethodDecorator(fn: MethodDecorator): MethodDecorator;
-/**
- * Utility to make a class decorator with lighter syntax and inferred types.
- * @param fn The class to decorate
- * @see {@link ApplyOptions}
- */
-export declare function createClassDecorator<TFunction extends (...args: any[]) => void>(fn: TFunction): ClassDecorator;
-/**
- * Utility to make function preconditions.
- *
- * ```typescript
- * // No fallback (returns undefined)
- * function requireGuild(value: number) {
- *   return createFunctionPrecondition((message: Message) =>
- *     message.guild !== null
- *   );
- * }
- *
- * // With fallback
- * function requireGuild(
- *   value: number,
- *   fallback: () => unknown = () => undefined
- * ) {
- *   return createFunctionPrecondition(
- *     (message: Message) => message.guild !== null,
- *     fallback
- *   );
- * }
- * ```
- * @since 1.0.0
- * @param precondition The function that defines whether or not the function should be run, returning the returned value from fallback
- * @param fallback The fallback value that defines what the method should return in case the precondition fails
- */
-export declare function createFunctionPrecondition(precondition: FunctionPrecondition, fallback?: FunctionFallback): MethodDecorator;
-/**
- * Creates a new proxy to efficiently add properties to class without creating subclasses
- * @param target The constructor of the class to modify
- * @param handler The handler function to modify the constructor behavior for the target
- * @hidden
- */
-export declare function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T;
-//# sourceMappingURL=utils.d.ts.map