@sapphire/decorators 4.0.2 → 4.1.0-next.365a53a.0

package/README.md

@@ -86,6 +86,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://gitlab.com/DavidPH/"><img src="https://avatars.githubusercontent.com/u/44669930?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=DavidPHH" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/apps/renovate"><img src="https://avatars.githubusercontent.com/in/2740?v=4?s=100" width="100px;" alt=""/><br /><sub><b>renovate[bot]</b></sub></a><br /><a href="#maintenance-renovate[bot]" title="Maintenance">🚧</a></td>
     <td align="center"><a href="https://renovate.whitesourcesoftware.com/"><img src="https://avatars.githubusercontent.com/u/25180681?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WhiteSource Renovate</b></sub></a><br /><a href="#maintenance-renovate-bot" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://fc5570.me/"><img src="https://avatars.githubusercontent.com/u/68158483?v=4?s=100" width="100px;" alt=""/><br /><sub><b>FC</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=FC5570" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Tokipudi"><img src="https://avatars.githubusercontent.com/u/29551076?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jérémy de Saint Denis</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=Tokipudi" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/ItsMrCube"><img src="https://avatars.githubusercontent.com/u/25201357?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MrCube</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=ItsMrCube" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/bitomic"><img src="https://avatars.githubusercontent.com/u/35199700?v=4?s=100" width="100px;" alt=""/><br /><sub><b>bitomic</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=bitomic" title="Code">💻</a></td>
   </tr>
 </table>
 

package/dist/index.js

@@ -1,8 +1,218 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./base-decorators"), exports);
-(0, tslib_1.__exportStar)(require("./djs-decorators"), exports);
-(0, tslib_1.__exportStar)(require("./piece-decorators"), exports);
-(0, tslib_1.__exportStar)(require("./utils"), exports);
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __reExport = (target, module2, copyDefault, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
+        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+  }
+  return target;
+};
+var __toCommonJS = /* @__PURE__ */ ((cache) => {
+  return (module2, temp) => {
+    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
+  };
+})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  ApplyOptions: () => ApplyOptions,
+  DecoratorIdentifiers: () => DecoratorIdentifiers,
+  Enumerable: () => Enumerable,
+  EnumerableMethod: () => EnumerableMethod,
+  RequiresClientPermissions: () => RequiresClientPermissions,
+  RequiresDMContext: () => RequiresDMContext,
+  RequiresGuildContext: () => RequiresGuildContext,
+  RequiresUserPermissions: () => RequiresUserPermissions,
+  createClassDecorator: () => createClassDecorator,
+  createFunctionPrecondition: () => createFunctionPrecondition,
+  createMethodDecorator: () => createMethodDecorator,
+  createProxy: () => createProxy
+});
+
+// src/utils.ts
+function createMethodDecorator(fn) {
+  return fn;
+}
+__name(createMethodDecorator, "createMethodDecorator");
+function createClassDecorator(fn) {
+  return fn;
+}
+__name(createClassDecorator, "createClassDecorator");
+function createFunctionPrecondition(precondition, fallback = () => void 0) {
+  return createMethodDecorator((_target, _propertyKey, descriptor) => {
+    const method = descriptor.value;
+    if (!method)
+      throw new Error("Function preconditions require a [[value]].");
+    if (typeof method !== "function")
+      throw new Error("Function preconditions can only be applied to functions.");
+    descriptor.value = /* @__PURE__ */ __name(async function descriptorValue(...args) {
+      const canRun = await precondition(...args);
+      return canRun ? method.call(this, ...args) : fallback.call(this, ...args);
+    }, "descriptorValue");
+  });
+}
+__name(createFunctionPrecondition, "createFunctionPrecondition");
+function createProxy(target, handler) {
+  return new Proxy(target, {
+    ...handler,
+    get: (target2, property) => {
+      const value = Reflect.get(target2, property);
+      return typeof value === "function" ? (...args) => value.apply(target2, args) : value;
+    }
+  });
+}
+__name(createProxy, "createProxy");
+
+// src/base-decorators.ts
+function Enumerable(value) {
+  return (target, key) => {
+    Reflect.defineProperty(target, key, {
+      enumerable: value,
+      set(val) {
+        Reflect.defineProperty(this, key, {
+          configurable: true,
+          enumerable: value,
+          value: val,
+          writable: true
+        });
+      }
+    });
+  };
+}
+__name(Enumerable, "Enumerable");
+function EnumerableMethod(value) {
+  return createMethodDecorator((_target, _propertyKey, descriptor) => {
+    descriptor.enumerable = value;
+  });
+}
+__name(EnumerableMethod, "EnumerableMethod");
+
+// src/djs-decorators.ts
+var import_discord = require("@sapphire/discord.js-utilities");
+var import_framework = require("@sapphire/framework");
+var import_discord2 = require("discord.js");
+var DecoratorIdentifiers = /* @__PURE__ */ ((DecoratorIdentifiers2) => {
+  DecoratorIdentifiers2["RequiresClientPermissionsGuildOnly"] = "requiresClientPermissionsGuildOnly";
+  DecoratorIdentifiers2["RequiresClientPermissionsMissingPermissions"] = "requiresClientPermissionsMissingPermissions";
+  DecoratorIdentifiers2["RequiresUserPermissionsGuildOnly"] = "requiresUserPermissionsGuildOnly";
+  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 RequiresClientPermissions = /* @__PURE__ */ __name((...permissionsResolvable) => {
+  const resolved = new import_discord2.Permissions(permissionsResolvable);
+  const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);
+  return createFunctionPrecondition((message) => {
+    if (resolvedIncludesServerPermissions && (0, import_discord.isDMChannel)(message.channel)) {
+      throw new import_framework.UserError({
+        identifier: "requiresClientPermissionsGuildOnly" /* RequiresClientPermissionsGuildOnly */,
+        message: "Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs"
+      });
+    }
+    if ((0, import_discord.isGuildBasedChannel)(message.channel)) {
+      const missingPermissions = message.channel.permissionsFor(message.guild.me).missing(resolved);
+      if (missingPermissions.length) {
+        throw new import_framework.UserError({
+          identifier: "requiresClientPermissionsMissingPermissions" /* RequiresClientPermissionsMissingPermissions */,
+          message: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,
+          context: {
+            missing: missingPermissions
+          }
+        });
+      }
+    }
+    return true;
+  });
+}, "RequiresClientPermissions");
+var RequiresUserPermissions = /* @__PURE__ */ __name((...permissionsResolvable) => {
+  const resolved = new import_discord2.Permissions(permissionsResolvable);
+  const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);
+  return createFunctionPrecondition((message) => {
+    if (resolvedIncludesServerPermissions && (0, import_discord.isDMChannel)(message.channel)) {
+      throw new import_framework.UserError({
+        identifier: "requiresUserPermissionsGuildOnly" /* RequiresUserPermissionsGuildOnly */,
+        message: "Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs"
+      });
+    }
+    if ((0, import_discord.isGuildBasedChannel)(message.channel)) {
+      const missingPermissions = message.channel.permissionsFor(message.member).missing(resolved);
+      if (missingPermissions.length) {
+        throw new import_framework.UserError({
+          identifier: "requiresUserPermissionsMissingPermissions" /* RequiresUserPermissionsMissingPermissions */,
+          message: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,
+          context: {
+            missing: missingPermissions
+          }
+        });
+      }
+    }
+    return true;
+  });
+}, "RequiresUserPermissions");
+function RequiresGuildContext(fallback = () => void 0) {
+  return createFunctionPrecondition((message) => message.guild !== null, fallback);
+}
+__name(RequiresGuildContext, "RequiresGuildContext");
+function RequiresDMContext(fallback = () => void 0) {
+  return createFunctionPrecondition((message) => message.guild === null, fallback);
+}
+__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
+    })
+  }));
+}
+__name(ApplyOptions, "ApplyOptions");
+module.exports = __toCommonJS(src_exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ApplyOptions,
+  DecoratorIdentifiers,
+  Enumerable,
+  EnumerableMethod,
+  RequiresClientPermissions,
+  RequiresDMContext,
+  RequiresGuildContext,
+  RequiresUserPermissions,
+  createClassDecorator,
+  createFunctionPrecondition,
+  createMethodDecorator,
+  createProxy
+});
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iEAAkC;AAClC,gEAAiC;AACjC,kEAAmC;AACnC,uDAAwB"}
+{"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 const 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;;;ACiCO,+BAA+B,IAAsC;AAC3E,SAAO;AAAA;AADQ;AAST,8BAA0E,IAA+B;AAC/G,SAAO;AAAA;AADQ;AA8BT,oCAAoC,cAAoC,WAA6B,MAAY,QAA4B;AACnJ,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,UAAM,SAAS,WAAW;AAC1B,QAAI,CAAC;AAAQ,YAAM,IAAI,MAAM;AAC7B,QAAI,OAAO,WAAW;AAAY,YAAM,IAAI,MAAM;AAElD,eAAW,QAAQ,yDAAiE,MAAa;AAChG,YAAM,SAAS,MAAM,aAAa,GAAG;AACrC,aAAO,SAAS,OAAO,KAAK,MAAM,GAAG,QAAQ,SAAS,KAAK,MAAM,GAAG;AAAA,OAFlD;AAAA;AAAA;AANL;AAoBT,qBAAuC,QAAW,SAA0C;AAClG,SAAO,IAAI,MAAM,QAAQ;AAAA,OACrB;AAAA,IACH,KAAK,CAAC,SAAQ,aAAa;AAC1B,YAAM,QAAQ,QAAQ,IAAI,SAAQ;AAClC,aAAO,OAAO,UAAU,aAAa,IAAI,SAA6B,MAAM,MAAM,SAAQ,QAAQ;AAAA;AAAA;AAAA;AALrF;;;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;AAAA;AAAA;AAAA;AAAA;AATC;AAoBT,0BAA0B,OAAgB;AAChD,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,eAAW,aAAa;AAAA;AAAA;AAFV;;;AC3BhB,qBAAiD;AACjD,uBAA0B;AAC1B,sBAA2D;AAGpD,IAAW,uBAAX,kBAAW,0BAAX;AACN,gEAAqC;AACrC,yEAA8C;AAC9C,8DAAmC;AACnC,uEAA4C;AAJ3B;AAAA;AAOlB,IAAM,yBAAyB,IAAI,4BAClC,CAAC,IAAI,4BAAY;AAAA,EAEhB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,GACE,WAAW,4BAAY;AAG3B,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;AAAA,GACE,WAAW,4BAAY;AA0CpB,IAAM,4BAA4B,2BAAI,0BAAmE;AAC/G,QAAM,WAAW,IAAI,4BAAY;AACjC,QAAM,oCAAoC,QAAQ,SAAS,WAAW,uBAAuB;AAE7F,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,gCAAY,QAAQ,UAAU;AACtE,YAAM,IAAI,2BAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA;AAAA;AAIX,QAAI,wCAAoB,QAAQ,UAAU;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,IAAK,QAAQ;AAEtF,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,2BAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,yEAAyE;AAAA,UAClF,SAAS;AAAA,YACR,SAAS;AAAA;AAAA;AAAA;AAAA;AAMb,WAAO;AAAA;AAAA,GA1BgC;AAqElC,IAAM,0BAA0B,2BAAI,0BAAmE;AAC7G,QAAM,WAAW,IAAI,4BAAY;AACjC,QAAM,oCAAoC,QAAQ,SAAS,WAAW,2BAA2B;AAEjG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,gCAAY,QAAQ,UAAU;AACtE,YAAM,IAAI,2BAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA;AAAA;AAIX,QAAI,wCAAoB,QAAQ,UAAU;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,QAAS,QAAQ;AAEnF,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,2BAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,+EAA+E;AAAA,UACxF,SAAS;AAAA,YACR,SAAS;AAAA;AAAA;AAAA;AAAA;AAMb,WAAO;AAAA;AAAA,GA1B8B;AAmChC,8BAA8B,WAA6B,MAAY,QAA4B;AACzG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM;AAAA;AADjE;AAST,2BAA2B,WAA6B,MAAY,QAA4B;AACtG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM;AAAA;AADjE;;;AC/LhB,wBAAsC;AAmD/B,sBAA+C,aAAsF;AAC3I,SAAO,qBAAqB,CAAC,WAC5B,YAAY,QAAQ;AAAA,IACnB,WAAW,CAAC,MAAM,CAAC,SAAS,cAAc,QACzC,IAAI,KAAK,SAAS;AAAA,SACd;AAAA,SACC,OAAO,gBAAgB,aAAa,YAAY,EAAE,wCAAW,aAAa;AAAA;AAAA;AAAA;AANnE;","names":[]}

package/dist/index.mjs

@@ -1,15 +1,177 @@
-import mod from "./index.js";
-
-export default mod;
-export const ApplyOptions = mod.ApplyOptions;
-export const DecoratorIdentifiers = mod.DecoratorIdentifiers;
-export const Enumerable = mod.Enumerable;
-export const EnumerableMethod = mod.EnumerableMethod;
-export const RequiresClientPermissions = mod.RequiresClientPermissions;
-export const RequiresDMContext = mod.RequiresDMContext;
-export const RequiresGuildContext = mod.RequiresGuildContext;
-export const RequiresUserPermissions = mod.RequiresUserPermissions;
-export const createClassDecorator = mod.createClassDecorator;
-export const createFunctionPrecondition = mod.createFunctionPrecondition;
-export const createMethodDecorator = mod.createMethodDecorator;
-export const createProxy = mod.createProxy;
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/utils.ts
+function createMethodDecorator(fn) {
+  return fn;
+}
+__name(createMethodDecorator, "createMethodDecorator");
+function createClassDecorator(fn) {
+  return fn;
+}
+__name(createClassDecorator, "createClassDecorator");
+function createFunctionPrecondition(precondition, fallback = () => void 0) {
+  return createMethodDecorator((_target, _propertyKey, descriptor) => {
+    const method = descriptor.value;
+    if (!method)
+      throw new Error("Function preconditions require a [[value]].");
+    if (typeof method !== "function")
+      throw new Error("Function preconditions can only be applied to functions.");
+    descriptor.value = /* @__PURE__ */ __name(async function descriptorValue(...args) {
+      const canRun = await precondition(...args);
+      return canRun ? method.call(this, ...args) : fallback.call(this, ...args);
+    }, "descriptorValue");
+  });
+}
+__name(createFunctionPrecondition, "createFunctionPrecondition");
+function createProxy(target, handler) {
+  return new Proxy(target, {
+    ...handler,
+    get: (target2, property) => {
+      const value = Reflect.get(target2, property);
+      return typeof value === "function" ? (...args) => value.apply(target2, args) : value;
+    }
+  });
+}
+__name(createProxy, "createProxy");
+
+// src/base-decorators.ts
+function Enumerable(value) {
+  return (target, key) => {
+    Reflect.defineProperty(target, key, {
+      enumerable: value,
+      set(val) {
+        Reflect.defineProperty(this, key, {
+          configurable: true,
+          enumerable: value,
+          value: val,
+          writable: true
+        });
+      }
+    });
+  };
+}
+__name(Enumerable, "Enumerable");
+function EnumerableMethod(value) {
+  return createMethodDecorator((_target, _propertyKey, descriptor) => {
+    descriptor.enumerable = value;
+  });
+}
+__name(EnumerableMethod, "EnumerableMethod");
+
+// src/djs-decorators.ts
+import { isDMChannel, isGuildBasedChannel } from "@sapphire/discord.js-utilities";
+import { UserError } from "@sapphire/framework";
+import { Permissions } from "discord.js";
+var DecoratorIdentifiers = /* @__PURE__ */ ((DecoratorIdentifiers2) => {
+  DecoratorIdentifiers2["RequiresClientPermissionsGuildOnly"] = "requiresClientPermissionsGuildOnly";
+  DecoratorIdentifiers2["RequiresClientPermissionsMissingPermissions"] = "requiresClientPermissionsMissingPermissions";
+  DecoratorIdentifiers2["RequiresUserPermissionsGuildOnly"] = "requiresUserPermissionsGuildOnly";
+  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 RequiresClientPermissions = /* @__PURE__ */ __name((...permissionsResolvable) => {
+  const resolved = new Permissions(permissionsResolvable);
+  const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);
+  return createFunctionPrecondition((message) => {
+    if (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {
+      throw new UserError({
+        identifier: "requiresClientPermissionsGuildOnly" /* RequiresClientPermissionsGuildOnly */,
+        message: "Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs"
+      });
+    }
+    if (isGuildBasedChannel(message.channel)) {
+      const missingPermissions = message.channel.permissionsFor(message.guild.me).missing(resolved);
+      if (missingPermissions.length) {
+        throw new UserError({
+          identifier: "requiresClientPermissionsMissingPermissions" /* RequiresClientPermissionsMissingPermissions */,
+          message: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,
+          context: {
+            missing: missingPermissions
+          }
+        });
+      }
+    }
+    return true;
+  });
+}, "RequiresClientPermissions");
+var RequiresUserPermissions = /* @__PURE__ */ __name((...permissionsResolvable) => {
+  const resolved = new Permissions(permissionsResolvable);
+  const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);
+  return createFunctionPrecondition((message) => {
+    if (resolvedIncludesServerPermissions && isDMChannel(message.channel)) {
+      throw new UserError({
+        identifier: "requiresUserPermissionsGuildOnly" /* RequiresUserPermissionsGuildOnly */,
+        message: "Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs"
+      });
+    }
+    if (isGuildBasedChannel(message.channel)) {
+      const missingPermissions = message.channel.permissionsFor(message.member).missing(resolved);
+      if (missingPermissions.length) {
+        throw new UserError({
+          identifier: "requiresUserPermissionsMissingPermissions" /* RequiresUserPermissionsMissingPermissions */,
+          message: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,
+          context: {
+            missing: missingPermissions
+          }
+        });
+      }
+    }
+    return true;
+  });
+}, "RequiresUserPermissions");
+function RequiresGuildContext(fallback = () => void 0) {
+  return createFunctionPrecondition((message) => message.guild !== null, fallback);
+}
+__name(RequiresGuildContext, "RequiresGuildContext");
+function RequiresDMContext(fallback = () => void 0) {
+  return createFunctionPrecondition((message) => message.guild === null, fallback);
+}
+__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
+    })
+  }));
+}
+__name(ApplyOptions, "ApplyOptions");
+export {
+  ApplyOptions,
+  DecoratorIdentifiers,
+  Enumerable,
+  EnumerableMethod,
+  RequiresClientPermissions,
+  RequiresDMContext,
+  RequiresGuildContext,
+  RequiresUserPermissions,
+  createClassDecorator,
+  createFunctionPrecondition,
+  createMethodDecorator,
+  createProxy
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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 const 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;AAAA;AADQ;AAST,8BAA0E,IAA+B;AAC/G,SAAO;AAAA;AADQ;AA8BT,oCAAoC,cAAoC,WAA6B,MAAY,QAA4B;AACnJ,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,UAAM,SAAS,WAAW;AAC1B,QAAI,CAAC;AAAQ,YAAM,IAAI,MAAM;AAC7B,QAAI,OAAO,WAAW;AAAY,YAAM,IAAI,MAAM;AAElD,eAAW,QAAQ,yDAAiE,MAAa;AAChG,YAAM,SAAS,MAAM,aAAa,GAAG;AACrC,aAAO,SAAS,OAAO,KAAK,MAAM,GAAG,QAAQ,SAAS,KAAK,MAAM,GAAG;AAAA,OAFlD;AAAA;AAAA;AANL;AAoBT,qBAAuC,QAAW,SAA0C;AAClG,SAAO,IAAI,MAAM,QAAQ;AAAA,OACrB;AAAA,IACH,KAAK,CAAC,SAAQ,aAAa;AAC1B,YAAM,QAAQ,QAAQ,IAAI,SAAQ;AAClC,aAAO,OAAO,UAAU,aAAa,IAAI,SAA6B,MAAM,MAAM,SAAQ,QAAQ;AAAA;AAAA;AAAA;AALrF;;;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;AAAA;AAAA;AAAA;AAAA;AATC;AAoBT,0BAA0B,OAAgB;AAChD,SAAO,sBAAsB,CAAC,SAAS,cAAc,eAAe;AACnE,eAAW,aAAa;AAAA;AAAA;AAFV;;;AC3BhB;AACA;AACA;AAGO,IAAW,uBAAX,kBAAW,0BAAX;AACN,gEAAqC;AACrC,yEAA8C;AAC9C,8DAAmC;AACnC,uEAA4C;AAJ3B;AAAA;AAOlB,IAAM,yBAAyB,IAAI,YAClC,CAAC,IAAI,YAAY;AAAA,EAEhB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,GACE,WAAW,YAAY;AAG3B,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;AAAA,GACE,WAAW,YAAY;AA0CpB,IAAM,4BAA4B,2BAAI,0BAAmE;AAC/G,QAAM,WAAW,IAAI,YAAY;AACjC,QAAM,oCAAoC,QAAQ,SAAS,WAAW,uBAAuB;AAE7F,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,YAAY,QAAQ,UAAU;AACtE,YAAM,IAAI,UAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA;AAAA;AAIX,QAAI,oBAAoB,QAAQ,UAAU;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,MAAO,IAAK,QAAQ;AAEtF,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,UAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,yEAAyE;AAAA,UAClF,SAAS;AAAA,YACR,SAAS;AAAA;AAAA;AAAA;AAAA;AAMb,WAAO;AAAA;AAAA,GA1BgC;AAqElC,IAAM,0BAA0B,2BAAI,0BAAmE;AAC7G,QAAM,WAAW,IAAI,YAAY;AACjC,QAAM,oCAAoC,QAAQ,SAAS,WAAW,2BAA2B;AAEjG,SAAO,2BAA2B,CAAC,YAAqB;AACvD,QAAI,qCAAqC,YAAY,QAAQ,UAAU;AACtE,YAAM,IAAI,UAAU;AAAA,QACnB,YAAY;AAAA,QACZ,SAAS;AAAA;AAAA;AAIX,QAAI,oBAAoB,QAAQ,UAAU;AACzC,YAAM,qBAAqB,QAAQ,QAAQ,eAAe,QAAQ,QAAS,QAAQ;AAEnF,UAAI,mBAAmB,QAAQ;AAC9B,cAAM,IAAI,UAAU;AAAA,UACnB,YAAY;AAAA,UACZ,SAAS,+EAA+E;AAAA,UACxF,SAAS;AAAA,YACR,SAAS;AAAA;AAAA;AAAA;AAAA;AAMb,WAAO;AAAA;AAAA,GA1B8B;AAmChC,8BAA8B,WAA6B,MAAY,QAA4B;AACzG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM;AAAA;AADjE;AAST,2BAA2B,WAA6B,MAAY,QAA4B;AACtG,SAAO,2BAA2B,CAAC,YAAqB,QAAQ,UAAU,MAAM;AAAA;AADjE;;;AC/LhB;AAmDO,sBAA+C,aAAsF;AAC3I,SAAO,qBAAqB,CAAC,WAC5B,YAAY,QAAQ;AAAA,IACnB,WAAW,CAAC,MAAM,CAAC,SAAS,cAAc,QACzC,IAAI,KAAK,SAAS;AAAA,SACd;AAAA,SACC,OAAO,gBAAgB,aAAa,YAAY,EAAE,WAAW,aAAa;AAAA;AAAA;AAAA;AANnE;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapphire/decorators",
-	"version": "4.0.2",
+	"version": "4.1.0-next.365a53a.0",
 	"description": "Useful TypeScript decorators for Sapphire Framework Discord bots",
 	"author": "@sapphire",
 	"license": "MIT",
@@ -16,17 +16,17 @@
 	"scripts": {
 		"test": "jest",
 		"lint": "eslint src tests --ext ts --fix -c ../../.eslintrc",
-		"build": "tsc -b src && gen-esm-wrapper dist/index.js dist/index.mjs",
+		"build": "tsup && tsc -b src",
 		"prepublishOnly": "yarn build"
 	},
 	"dependencies": {
 		"tslib": "^2.3.1"
 	},
 	"devDependencies": {
-		"@sapphire/discord-utilities": "^2.6.0",
-		"@sapphire/discord.js-utilities": "^4.4.0",
-		"@sapphire/ratelimits": "^2.1.12",
-		"@sapphire/utilities": "^3.2.1"
+		"@sapphire/discord-utilities": "^2.7.0-next.365a53a.0",
+		"@sapphire/discord.js-utilities": "^4.5.0-next.365a53a.0",
+		"@sapphire/ratelimits": "^2.2.0-next.365a53a.0",
+		"@sapphire/utilities": "^3.3.0-next.365a53a.0"
 	},
 	"repository": {
 		"type": "git",
@@ -57,5 +57,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "d08c59c9b1459615d80036499d8aab2c98585e8e"
+	"gitHead": "365a53a5517a01a0926cf28a83c96b63f32ed9f8"
 }

package/dist/base-decorators.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnumerableMethod = exports.Enumerable = void 0;
-const utils_1 = require("./utils");
-/**
- * Decorator that sets the enumerable property of a class field to the desired value.
- * @param value Whether the property should be enumerable or not
- */
-function Enumerable(value) {
-    return (target, key) => {
-        Reflect.defineProperty(target, key, {
-            enumerable: value,
-            set(val) {
-                Reflect.defineProperty(this, key, {
-                    configurable: true,
-                    enumerable: value,
-                    value: val,
-                    writable: true
-                });
-            }
-        });
-    };
-}
-exports.Enumerable = Enumerable;
-/**
- * Decorator that sets the enumerable property of a class method to the desired value.
- * @param value Whether the method should be enumerable or not
- */
-function EnumerableMethod(value) {
-    return (0, utils_1.createMethodDecorator)((_target, _propertyKey, descriptor) => {
-        descriptor.enumerable = value;
-    });
-}
-exports.EnumerableMethod = EnumerableMethod;
-//# sourceMappingURL=base-decorators.js.map

package/dist/base-decorators.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base-decorators.js","sourceRoot":"","sources":["../src/base-decorators.ts"],"names":[],"mappings":";;;AACA,mCAAgD;AAEhD;;;GAGG;AACH,SAAgB,UAAU,CAAC,KAAc;IACxC,OAAO,CAAC,MAAe,EAAE,GAAW,EAAE,EAAE;QACvC,OAAO,CAAC,cAAc,CAAC,MAAuB,EAAE,GAAG,EAAE;YACpD,UAAU,EAAE,KAAK;YACjB,GAAG,CAAgB,GAAY;gBAC9B,OAAO,CAAC,cAAc,CAAC,IAAqB,EAAE,GAAG,EAAE;oBAClD,YAAY,EAAE,IAAI;oBAClB,UAAU,EAAE,KAAK;oBACjB,KAAK,EAAE,GAAG;oBACV,QAAQ,EAAE,IAAI;iBACd,CAAC,CAAC;YACJ,CAAC;SACD,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAdD,gCAcC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAc;IAC9C,OAAO,IAAA,6BAAqB,EAAC,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE;QAClE,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC;IAC/B,CAAC,CAAC,CAAC;AACJ,CAAC;AAJD,4CAIC"}

package/dist/djs-decorators.js

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiresDMContext = exports.RequiresGuildContext = exports.RequiresUserPermissions = exports.RequiresClientPermissions = exports.DecoratorIdentifiers = void 0;
-const discord_js_utilities_1 = require("@sapphire/discord.js-utilities");
-const framework_1 = require("@sapphire/framework");
-const discord_js_1 = require("discord.js");
-const utils_1 = require("./utils");
-var DecoratorIdentifiers;
-(function (DecoratorIdentifiers) {
-    DecoratorIdentifiers["RequiresClientPermissionsGuildOnly"] = "requiresClientPermissionsGuildOnly";
-    DecoratorIdentifiers["RequiresClientPermissionsMissingPermissions"] = "requiresClientPermissionsMissingPermissions";
-    DecoratorIdentifiers["RequiresUserPermissionsGuildOnly"] = "requiresUserPermissionsGuildOnly";
-    DecoratorIdentifiers["RequiresUserPermissionsMissingPermissions"] = "requiresUserPermissionsMissingPermissions";
-})(DecoratorIdentifiers = exports.DecoratorIdentifiers || (exports.DecoratorIdentifiers = {}));
-const DMAvailablePermissions = new discord_js_1.Permissions(~new discord_js_1.Permissions([
-    //
-    'ADD_REACTIONS',
-    'ATTACH_FILES',
-    'EMBED_LINKS',
-    'READ_MESSAGE_HISTORY',
-    'SEND_MESSAGES',
-    'USE_EXTERNAL_EMOJIS',
-    'VIEW_CHANNEL'
-]).bitfield & discord_js_1.Permissions.ALL);
-const DMAvailableUserPermissions = new discord_js_1.Permissions(~new discord_js_1.Permissions([
-    'ADD_REACTIONS',
-    'ATTACH_FILES',
-    'EMBED_LINKS',
-    'READ_MESSAGE_HISTORY',
-    'SEND_MESSAGES',
-    'USE_EXTERNAL_EMOJIS',
-    'VIEW_CHANNEL',
-    'USE_EXTERNAL_STICKERS',
-    'MENTION_EVERYONE'
-]).bitfield & discord_js_1.Permissions.ALL);
-/**
- * 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!');
- * 	}
- * }
- * ```
- */
-const RequiresClientPermissions = (...permissionsResolvable) => {
-    const resolved = new discord_js_1.Permissions(permissionsResolvable);
-    const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailablePermissions.bitfield);
-    return (0, utils_1.createFunctionPrecondition)((message) => {
-        if (resolvedIncludesServerPermissions && (0, discord_js_utilities_1.isDMChannel)(message.channel)) {
-            throw new framework_1.UserError({
-                identifier: "requiresClientPermissionsGuildOnly" /* RequiresClientPermissionsGuildOnly */,
-                message: 'Sorry, but that command can only be used in a server because I do not have sufficient permissions in DMs'
-            });
-        }
-        if ((0, discord_js_utilities_1.isGuildBasedChannel)(message.channel)) {
-            const missingPermissions = message.channel.permissionsFor(message.guild.me).missing(resolved);
-            if (missingPermissions.length) {
-                throw new framework_1.UserError({
-                    identifier: "requiresClientPermissionsMissingPermissions" /* RequiresClientPermissionsMissingPermissions */,
-                    message: `Sorry, but I am not allowed to do that. I am missing the permissions: ${missingPermissions}`,
-                    context: {
-                        missing: missingPermissions
-                    }
-                });
-            }
-        }
-        return true;
-    });
-};
-exports.RequiresClientPermissions = RequiresClientPermissions;
-/**
- * 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!');
- * 	}
- * }
- * ```
- */
-const RequiresUserPermissions = (...permissionsResolvable) => {
-    const resolved = new discord_js_1.Permissions(permissionsResolvable);
-    const resolvedIncludesServerPermissions = Boolean(resolved.bitfield & DMAvailableUserPermissions.bitfield);
-    return (0, utils_1.createFunctionPrecondition)((message) => {
-        if (resolvedIncludesServerPermissions && (0, discord_js_utilities_1.isDMChannel)(message.channel)) {
-            throw new framework_1.UserError({
-                identifier: "requiresUserPermissionsGuildOnly" /* RequiresUserPermissionsGuildOnly */,
-                message: 'Sorry, but that command can only be used in a server because you do not have sufficient permissions in DMs'
-            });
-        }
-        if ((0, discord_js_utilities_1.isGuildBasedChannel)(message.channel)) {
-            const missingPermissions = message.channel.permissionsFor(message.member).missing(resolved);
-            if (missingPermissions.length) {
-                throw new framework_1.UserError({
-                    identifier: "requiresUserPermissionsMissingPermissions" /* RequiresUserPermissionsMissingPermissions */,
-                    message: `Sorry, but you are not allowed to do that. You are missing the permissions: ${missingPermissions}`,
-                    context: {
-                        missing: missingPermissions
-                    }
-                });
-            }
-        }
-        return true;
-    });
-};
-exports.RequiresUserPermissions = RequiresUserPermissions;
-/**
- * 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`
- */
-function RequiresGuildContext(fallback = () => undefined) {
-    return (0, utils_1.createFunctionPrecondition)((message) => message.guild !== null, fallback);
-}
-exports.RequiresGuildContext = RequiresGuildContext;
-/**
- * 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`
- */
-function RequiresDMContext(fallback = () => undefined) {
-    return (0, utils_1.createFunctionPrecondition)((message) => message.guild === null, fallback);
-}
-exports.RequiresDMContext = RequiresDMContext;
-//# sourceMappingURL=djs-decorators.js.map

package/dist/djs-decorators.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"djs-decorators.js","sourceRoot":"","sources":["../src/djs-decorators.ts"],"names":[],"mappings":";;;AAAA,yEAAkF;AAClF,mDAAgD;AAChD,2CAAwE;AACxE,mCAAuE;AAEvE,IAAkB,oBAKjB;AALD,WAAkB,oBAAoB;IACrC,iGAAyE,CAAA;IACzE,mHAA2F,CAAA;IAC3F,6FAAqE,CAAA;IACrE,+GAAuF,CAAA;AACxF,CAAC,EALiB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAKrC;AAED,MAAM,sBAAsB,GAAG,IAAI,wBAAW,CAC7C,CAAC,IAAI,wBAAW,CAAC;IAChB,EAAE;IACF,eAAe;IACf,cAAc;IACd,aAAa;IACb,sBAAsB;IACtB,eAAe;IACf,qBAAqB;IACrB,cAAc;CACd,CAAC,CAAC,QAAQ,GAAG,wBAAW,CAAC,GAAG,CAC7B,CAAC;AAEF,MAAM,0BAA0B,GAAG,IAAI,wBAAW,CACjD,CAAC,IAAI,wBAAW,CAAC;IAChB,eAAe;IACf,cAAc;IACd,aAAa;IACb,sBAAsB;IACtB,eAAe;IACf,qBAAqB;IACrB,cAAc;IACd,uBAAuB;IACvB,kBAAkB;CAClB,CAAC,CAAC,QAAQ,GAAG,wBAAW,CAAC,GAAG,CAC7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACI,MAAM,yBAAyB,GAAG,CAAC,GAAG,qBAA6C,EAAmB,EAAE;IAC9G,MAAM,QAAQ,GAAG,IAAI,wBAAW,CAAC,qBAAqB,CAAC,CAAC;IACxD,MAAM,iCAAiC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEvG,OAAO,IAAA,kCAA0B,EAAC,CAAC,OAAgB,EAAE,EAAE;QACtD,IAAI,iCAAiC,IAAI,IAAA,kCAAW,EAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtE,MAAM,IAAI,qBAAS,CAAC;gBACnB,UAAU,+EAAyD;gBACnE,OAAO,EAAE,0GAA0G;aACnH,CAAC,CAAC;SACH;QAED,IAAI,IAAA,0CAAmB,EAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACzC,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,KAAM,CAAC,EAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEhG,IAAI,kBAAkB,CAAC,MAAM,EAAE;gBAC9B,MAAM,IAAI,qBAAS,CAAC;oBACnB,UAAU,iGAAkE;oBAC5E,OAAO,EAAE,yEAAyE,kBAAkB,EAAE;oBACtG,OAAO,EAAE;wBACR,OAAO,EAAE,kBAAkB;qBAC3B;iBACD,CAAC,CAAC;aACH;SACD;QAED,OAAO,IAAI,CAAC;IACb,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AA5BW,QAAA,yBAAyB,6BA4BpC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACI,MAAM,uBAAuB,GAAG,CAAC,GAAG,qBAA6C,EAAmB,EAAE;IAC5G,MAAM,QAAQ,GAAG,IAAI,wBAAW,CAAC,qBAAqB,CAAC,CAAC;IACxD,MAAM,iCAAiC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAE3G,OAAO,IAAA,kCAA0B,EAAC,CAAC,OAAgB,EAAE,EAAE;QACtD,IAAI,iCAAiC,IAAI,IAAA,kCAAW,EAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtE,MAAM,IAAI,qBAAS,CAAC;gBACnB,UAAU,2EAAuD;gBACjE,OAAO,EAAE,4GAA4G;aACrH,CAAC,CAAC;SACH;QAED,IAAI,IAAA,0CAAmB,EAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACzC,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAE7F,IAAI,kBAAkB,CAAC,MAAM,EAAE;gBAC9B,MAAM,IAAI,qBAAS,CAAC;oBACnB,UAAU,6FAAgE;oBAC1E,OAAO,EAAE,+EAA+E,kBAAkB,EAAE;oBAC5G,OAAO,EAAE;wBACR,OAAO,EAAE,kBAAkB;qBAC3B;iBACD,CAAC,CAAC;aACH;SACD;QAED,OAAO,IAAI,CAAC;IACb,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AA5BW,QAAA,uBAAuB,2BA4BlC;AAEF;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,WAA6B,GAAS,EAAE,CAAC,SAAS;IACtF,OAAO,IAAA,kCAA0B,EAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC3F,CAAC;AAFD,oDAEC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,WAA6B,GAAS,EAAE,CAAC,SAAS;IACnF,OAAO,IAAA,kCAA0B,EAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC3F,CAAC;AAFD,8CAEC"}

package/dist/piece-decorators.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplyOptions = void 0;
-const framework_1 = require("@sapphire/framework");
-const utils_1 = require("./utils");
-/**
- * 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
- *   }
- * }
- * ```
- */
-function ApplyOptions(optionsOrFn) {
-    return (0, utils_1.createClassDecorator)((target) => (0, utils_1.createProxy)(target, {
-        construct: (ctor, [context, baseOptions = {}]) => new ctor(context, {
-            ...baseOptions,
-            ...(typeof optionsOrFn === 'function' ? optionsOrFn({ container: framework_1.container, context }) : optionsOrFn)
-        })
-    }));
-}
-exports.ApplyOptions = ApplyOptions;
-//# sourceMappingURL=piece-decorators.js.map

package/dist/piece-decorators.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"piece-decorators.js","sourceRoot":"","sources":["../src/piece-decorators.ts"],"names":[],"mappings":";;;AAAA,mDAA4D;AAG5D,mCAA4D;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,SAAgB,YAAY,CAA0B,WAAoE;IACzH,OAAO,IAAA,4BAAoB,EAAC,CAAC,MAAwD,EAAE,EAAE,CACxF,IAAA,mBAAW,EAAC,MAAM,EAAE;QACnB,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,GAAG,EAAE,CAAiC,EAAE,EAAE,CAChF,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,WAAW;YACd,GAAG,CAAC,OAAO,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,SAAS,EAAT,qBAAS,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;SAC1F,CAAC;KACH,CAAC,CACF,CAAC;AACH,CAAC;AAVD,oCAUC"}

package/dist/utils.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProxy = exports.createFunctionPrecondition = exports.createClassDecorator = exports.createMethodDecorator = void 0;
-/**
- * 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
- */
-function createMethodDecorator(fn) {
-    return fn;
-}
-exports.createMethodDecorator = createMethodDecorator;
-/**
- * Utility to make a class decorator with lighter syntax and inferred types.
- * @param fn The class to decorate
- * @see {@link ApplyOptions}
- */
-function createClassDecorator(fn) {
-    return fn;
-}
-exports.createClassDecorator = createClassDecorator;
-/**
- * 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
- */
-function createFunctionPrecondition(precondition, fallback = () => undefined) {
-    return createMethodDecorator((_target, _propertyKey, descriptor) => {
-        const method = descriptor.value;
-        if (!method)
-            throw new Error('Function preconditions require a [[value]].');
-        if (typeof method !== 'function')
-            throw new Error('Function preconditions can only be applied to functions.');
-        descriptor.value = async function descriptorValue(...args) {
-            const canRun = await precondition(...args);
-            return canRun ? method.call(this, ...args) : fallback.call(this, ...args);
-        };
-    });
-}
-exports.createFunctionPrecondition = createFunctionPrecondition;
-/**
- * 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
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-function createProxy(target, handler) {
-    return new Proxy(target, {
-        ...handler,
-        get: (target, property) => {
-            const value = Reflect.get(target, property);
-            return typeof value === 'function' ? (...args) => value.apply(target, args) : value;
-        }
-    });
-}
-exports.createProxy = createProxy;
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAoBA;;;;;;;;;;;;GAYG;AACH,SAAgB,qBAAqB,CAAC,EAAmB;IACxD,OAAO,EAAE,CAAC;AACX,CAAC;AAFD,sDAEC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAA6C,EAAa;IAC7F,OAAO,EAAE,CAAC;AACX,CAAC;AAFD,oDAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,0BAA0B,CAAC,YAAkC,EAAE,WAA6B,GAAS,EAAE,CAAC,SAAS;IAChI,OAAO,qBAAqB,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE;QAClE,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC;QAChC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAC5E,IAAI,OAAO,MAAM,KAAK,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAE9G,UAAU,CAAC,KAAK,GAAG,KAAK,UAAU,eAAe,CAAgC,GAAG,IAAW;YAC9F,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC;YAC3C,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3E,CAAyB,CAAC;IAC3B,CAAC,CAAC,CAAC;AACJ,CAAC;AAXD,gEAWC;AAED;;;;;GAKG;AACH,wDAAwD;AACxD,SAAgB,WAAW,CAAmB,MAAS,EAAE,OAAqC;IAC7F,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACxB,GAAG,OAAO;QACV,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC5C,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,IAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACzG,CAAC;KACD,CAAC,CAAC;AACJ,CAAC;AARD,kCAQC"}