cognova 0.2.6 → 0.2.8

package/.output/server/node_modules/discord.js/src/structures/ApplicationCommand.js

@@ -1,639 +0,0 @@
-'use strict';
-
-const { DiscordSnowflake } = require('@sapphire/snowflake');
-const { ApplicationCommandOptionType } = require('discord-api-types/v10');
-const isEqual = require('fast-deep-equal');
-const Base = require('./Base');
-const ApplicationCommandPermissionsManager = require('../managers/ApplicationCommandPermissionsManager');
-const PermissionsBitField = require('../util/PermissionsBitField');
-
-/**
- * Represents an application command.
- * @extends {Base}
- */
-class ApplicationCommand extends Base {
-  constructor(client, data, guild, guildId) {
-    super(client);
-
-    /**
-     * The command's id
-     * @type {Snowflake}
-     */
-    this.id = data.id;
-
-    /**
-     * The parent application's id
-     * @type {Snowflake}
-     */
-    this.applicationId = data.application_id;
-
-    /**
-     * The guild this command is part of
-     * @type {?Guild}
-     */
-    this.guild = guild ?? null;
-
-    /**
-     * The guild's id this command is part of, this may be non-null when `guild` is `null` if the command
-     * was fetched from the `ApplicationCommandManager`
-     * @type {?Snowflake}
-     */
-    this.guildId = guild?.id ?? guildId ?? null;
-
-    /**
-     * The manager for permissions of this command on its guild or arbitrary guilds when the command is global
-     * @type {ApplicationCommandPermissionsManager}
-     */
-    this.permissions = new ApplicationCommandPermissionsManager(this);
-
-    /**
-     * The type of this application command
-     * @type {ApplicationCommandType}
-     */
-    this.type = data.type;
-
-    /**
-     * Whether this command is age-restricted (18+)
-     * @type {boolean}
-     */
-    this.nsfw = data.nsfw ?? false;
-
-    this._patch(data);
-  }
-
-  _patch(data) {
-    if ('name' in data) {
-      /**
-       * The name of this command
-       * @type {string}
-       */
-      this.name = data.name;
-    }
-
-    if ('name_localizations' in data) {
-      /**
-       * The name localizations for this command
-       * @type {?LocalizationMap}
-       */
-      this.nameLocalizations = data.name_localizations;
-    } else {
-      this.nameLocalizations ??= null;
-    }
-
-    if ('name_localized' in data) {
-      /**
-       * The localized name for this command
-       * @type {?string}
-       */
-      this.nameLocalized = data.name_localized;
-    } else {
-      this.nameLocalized ??= null;
-    }
-
-    if ('description' in data) {
-      /**
-       * The description of this command
-       * @type {string}
-       */
-      this.description = data.description;
-    }
-
-    if ('description_localizations' in data) {
-      /**
-       * The description localizations for this command
-       * @type {?LocalizationMap}
-       */
-      this.descriptionLocalizations = data.description_localizations;
-    } else {
-      this.descriptionLocalizations ??= null;
-    }
-
-    if ('description_localized' in data) {
-      /**
-       * The localized description for this command
-       * @type {?string}
-       */
-      this.descriptionLocalized = data.description_localized;
-    } else {
-      this.descriptionLocalized ??= null;
-    }
-
-    if ('options' in data) {
-      /**
-       * The options of this command
-       * @type {ApplicationCommandOption[]}
-       */
-      this.options = data.options.map(option => this.constructor.transformOption(option, true));
-    } else {
-      this.options ??= [];
-    }
-
-    if ('default_member_permissions' in data) {
-      /**
-       * The default bitfield used to determine whether this command be used in a guild
-       * @type {?Readonly<PermissionsBitField>}
-       */
-      this.defaultMemberPermissions = data.default_member_permissions
-        ? new PermissionsBitField(BigInt(data.default_member_permissions)).freeze()
-        : null;
-    } else {
-      this.defaultMemberPermissions ??= null;
-    }
-
-    if ('dm_permission' in data) {
-      /**
-       * Whether the command can be used in DMs
-       * <info>This property is always `null` on guild commands</info>
-       * @type {?boolean}
-       * @deprecated Use {@link ApplicationCommand#contexts} instead.
-       */
-      this.dmPermission = data.dm_permission;
-    } else {
-      this.dmPermission ??= null;
-    }
-
-    if ('integration_types' in data) {
-      /**
-       * Installation context(s) where the command is available
-       * <info>Only for globally-scoped commands</info>
-       * @type {?ApplicationIntegrationType[]}
-       */
-      this.integrationTypes = data.integration_types;
-    } else {
-      this.integrationTypes ??= null;
-    }
-
-    if ('contexts' in data) {
-      /**
-       * Interaction context(s) where the command can be used
-       * <info>Only for globally-scoped commands</info>
-       * @type {?InteractionContextType[]}
-       */
-      this.contexts = data.contexts;
-    } else {
-      this.contexts ??= null;
-    }
-
-    if ('handler' in data) {
-      /**
-       * Determines whether the interaction is handled by the app's interactions handler or by Discord.
-       * <info>Only available for {@link ApplicationCommandType.PrimaryEntryPoint} commands on
-       * applications with the {@link ApplicationFlags.Embedded} flag (i.e, those that have an Activity)</info>
-       * @type {?EntryPointCommandHandlerType}
-       */
-      this.handler = data.handler;
-    } else {
-      this.handler ??= null;
-    }
-
-    if ('version' in data) {
-      /**
-       * Autoincrementing version identifier updated during substantial record changes
-       * @type {Snowflake}
-       */
-      this.version = data.version;
-    }
-  }
-
-  /**
-   * The timestamp the command was created at
-   * @type {number}
-   * @readonly
-   */
-  get createdTimestamp() {
-    return DiscordSnowflake.timestampFrom(this.id);
-  }
-
-  /**
-   * The time the command was created at
-   * @type {Date}
-   * @readonly
-   */
-  get createdAt() {
-    return new Date(this.createdTimestamp);
-  }
-
-  /**
-   * The manager that this command belongs to
-   * @type {ApplicationCommandManager}
-   * @readonly
-   */
-  get manager() {
-    return (this.guild ?? this.client.application).commands;
-  }
-
-  /**
-   * Data for creating or editing an application command.
-   * @typedef {Object} ApplicationCommandData
-   * @property {string} name The name of the command, must be in all lowercase if type is
-   * {@link ApplicationCommandType.ChatInput}
-   * @property {LocalizationMap} [nameLocalizations] The localizations for the command name
-   * @property {string} description The description of the command,
-   * if type is {@link ApplicationCommandType.ChatInput} or {@link ApplicationCommandType.PrimaryEntryPoint}
-   * @property {boolean} [nsfw] Whether the command is age-restricted
-   * @property {LocalizationMap} [descriptionLocalizations] The localizations for the command description,
-   * if type is {@link ApplicationCommandType.ChatInput} or {@link ApplicationCommandType.PrimaryEntryPoint}
-   * @property {ApplicationCommandType} [type=ApplicationCommandType.ChatInput] The type of the command
-   * @property {ApplicationCommandOptionData[]} [options] Options for the command
-   * @property {?PermissionResolvable} [defaultMemberPermissions] The bitfield used to determine the default permissions
-   * a member needs in order to run the command
-   * @property {boolean} [dmPermission] Whether the command is enabled in DMs
-   * @property {ApplicationIntegrationType[]} [integrationTypes] Installation contexts where the command is available
-   * @property {InteractionContextType[]} [contexts] Interaction contexts where the command can be used
-   * @property {EntryPointCommandHandlerType} [handler] Whether the interaction is handled by the app's
-   * interactions handler or by Discord.
-   */
-
-  /**
-   * An option for an application command or subcommand.
-   * <info>In addition to the listed properties, when used as a parameter,
-   * API style `snake_case` properties can be used for compatibility with generators like `@discordjs/builders`.</info>
-   * <warn>Note that providing a value for the `camelCase` counterpart for any `snake_case` property
-   * will discard the provided `snake_case` property.</warn>
-   * @typedef {Object} ApplicationCommandOptionData
-   * @property {ApplicationCommandOptionType} type The type of the option
-   * @property {string} name The name of the option
-   * @property {LocalizationMap} [nameLocalizations] The name localizations for the option
-   * @property {string} description The description of the option
-   * @property {LocalizationMap} [descriptionLocalizations] The description localizations for the option
-   * @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a
-   * {@link ApplicationCommandOptionType.String}, {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {boolean} [required] Whether the option is required
-   * @property {ApplicationCommandOptionChoiceData[]} [choices] The choices of the option for the user to pick from
-   * @property {ApplicationCommandOptionData[]} [options] Additional options if this option is a subcommand (group)
-   * @property {ChannelType[]} [channelTypes] When the option type is channel,
-   * the allowed types of channels that can be selected
-   * @property {number} [minValue] The minimum value for an {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {number} [maxValue] The maximum value for an {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {number} [minLength] The minimum length for an {@link ApplicationCommandOptionType.String} option
-   * (maximum of `6000`)
-   * @property {number} [maxLength] The maximum length for an {@link ApplicationCommandOptionType.String} option
-   * (maximum of `6000`)
-   */
-
-  /**
-   * @typedef {Object} ApplicationCommandOptionChoiceData
-   * @property {string} name The name of the choice
-   * @property {LocalizationMap} [nameLocalizations] The localized names for this choice
-   * @property {string|number} value The value of the choice
-   */
-
-  /**
-   * Edits this application command.
-   * @param {Partial<ApplicationCommandData>} data The data to update the command with
-   * @returns {Promise<ApplicationCommand>}
-   * @example
-   * // Edit the description of this command
-   * command.edit({
-   *   description: 'New description',
-   * })
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
-  edit(data) {
-    return this.manager.edit(this, data, this.guildId);
-  }
-
-  /**
-   * Edits the name of this ApplicationCommand
-   * @param {string} name The new name of the command
-   * @returns {Promise<ApplicationCommand>}
-   */
-  setName(name) {
-    return this.edit({ name });
-  }
-
-  /**
-   * Edits the localized names of this ApplicationCommand
-   * @param {LocalizationMap} nameLocalizations The new localized names for the command
-   * @returns {Promise<ApplicationCommand>}
-   * @example
-   * // Edit the name localizations of this command
-   * command.setNameLocalizations({
-   *   'en-GB': 'test',
-   *   'pt-BR': 'teste',
-   * })
-   *   .then(console.log)
-   *   .catch(console.error)
-   */
-  setNameLocalizations(nameLocalizations) {
-    return this.edit({ nameLocalizations });
-  }
-
-  /**
-   * Edits the description of this ApplicationCommand
-   * @param {string} description The new description of the command
-   * @returns {Promise<ApplicationCommand>}
-   */
-  setDescription(description) {
-    return this.edit({ description });
-  }
-
-  /**
-   * Edits the localized descriptions of this ApplicationCommand
-   * @param {LocalizationMap} descriptionLocalizations The new localized descriptions for the command
-   * @returns {Promise<ApplicationCommand>}
-   * @example
-   * // Edit the description localizations of this command
-   * command.setDescriptionLocalizations({
-   *   'en-GB': 'A test command',
-   *   'pt-BR': 'Um comando de teste',
-   * })
-   *   .then(console.log)
-   *   .catch(console.error)
-   */
-  setDescriptionLocalizations(descriptionLocalizations) {
-    return this.edit({ descriptionLocalizations });
-  }
-
-  /**
-   * Edits the default member permissions of this ApplicationCommand
-   * @param {?PermissionResolvable} defaultMemberPermissions The default member permissions required to run this command
-   * @returns {Promise<ApplicationCommand>}
-   */
-  setDefaultMemberPermissions(defaultMemberPermissions) {
-    return this.edit({ defaultMemberPermissions });
-  }
-
-  /**
-   * Edits the DM permission of this ApplicationCommand
-   * @param {boolean} [dmPermission=true] Whether the command can be used in DMs
-   * @returns {Promise<ApplicationCommand>}
-   */
-  setDMPermission(dmPermission = true) {
-    return this.edit({ dmPermission });
-  }
-
-  /**
-   * Edits the options of this ApplicationCommand
-   * @param {ApplicationCommandOptionData[]} options The options to set for this command
-   * @returns {Promise<ApplicationCommand>}
-   */
-  setOptions(options) {
-    return this.edit({ options });
-  }
-
-  /**
-   * Deletes this command.
-   * @returns {Promise<ApplicationCommand>}
-   * @example
-   * // Delete this command
-   * command.delete()
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
-  delete() {
-    return this.manager.delete(this, this.guildId);
-  }
-
-  /**
-   * Whether this command equals another command. It compares all properties, so for most operations
-   * it is advisable to just compare `command.id === command2.id` as it is much faster and is often
-   * what most users need.
-   * @param {ApplicationCommand|ApplicationCommandData|APIApplicationCommand} command The command to compare with
-   * @param {boolean} [enforceOptionOrder=false] Whether to strictly check that options and choices are in the same
-   * order in the array <info>The client may not always respect this ordering!</info>
-   * @returns {boolean}
-   */
-  equals(command, enforceOptionOrder = false) {
-    // If given an id, check if the id matches
-    if (command.id && this.id !== command.id) return false;
-
-    let defaultMemberPermissions = null;
-    let dmPermission = command.dmPermission ?? command.dm_permission;
-
-    if ('default_member_permissions' in command) {
-      defaultMemberPermissions = command.default_member_permissions
-        ? new PermissionsBitField(BigInt(command.default_member_permissions)).bitfield
-        : null;
-    }
-
-    if ('defaultMemberPermissions' in command) {
-      defaultMemberPermissions =
-        command.defaultMemberPermissions !== null
-          ? new PermissionsBitField(command.defaultMemberPermissions).bitfield
-          : null;
-    }
-
-    // Check top level parameters
-    if (
-      command.name !== this.name ||
-      ('description' in command && command.description !== this.description) ||
-      ('version' in command && command.version !== this.version) ||
-      (command.type && command.type !== this.type) ||
-      ('nsfw' in command && command.nsfw !== this.nsfw) ||
-      // Future proof for options being nullable
-      // TODO: remove ?? 0 on each when nullable
-      (command.options?.length ?? 0) !== (this.options?.length ?? 0) ||
-      defaultMemberPermissions !== (this.defaultMemberPermissions?.bitfield ?? null) ||
-      (dmPermission !== undefined && dmPermission !== this.dmPermission) ||
-      !isEqual(command.nameLocalizations ?? command.name_localizations ?? {}, this.nameLocalizations ?? {}) ||
-      !isEqual(
-        command.descriptionLocalizations ?? command.description_localizations ?? {},
-        this.descriptionLocalizations ?? {},
-      ) ||
-      !isEqual(command.integrationTypes ?? command.integration_types ?? [], this.integrationTypes ?? []) ||
-      !isEqual(command.contexts ?? [], this.contexts ?? []) ||
-      ('handler' in command && command.handler !== this.handler)
-    ) {
-      return false;
-    }
-
-    if (command.options) {
-      return this.constructor.optionsEqual(this.options, command.options, enforceOptionOrder);
-    }
-    return true;
-  }
-
-  /**
-   * Recursively checks that all options for an {@link ApplicationCommand} are equal to the provided options.
-   * In most cases it is better to compare using {@link ApplicationCommand#equals}
-   * @param {ApplicationCommandOptionData[]} existing The options on the existing command,
-   * should be {@link ApplicationCommand#options}
-   * @param {ApplicationCommandOptionData[]|APIApplicationCommandOption[]} options The options to compare against
-   * @param {boolean} [enforceOptionOrder=false] Whether to strictly check that options and choices are in the same
-   * order in the array <info>The client may not always respect this ordering!</info>
-   * @returns {boolean}
-   */
-  static optionsEqual(existing, options, enforceOptionOrder = false) {
-    if (existing.length !== options.length) return false;
-    if (enforceOptionOrder) {
-      return existing.every((option, index) => this._optionEquals(option, options[index], enforceOptionOrder));
-    }
-    const newOptions = new Map(options.map(option => [option.name, option]));
-    for (const option of existing) {
-      const foundOption = newOptions.get(option.name);
-      if (!foundOption || !this._optionEquals(option, foundOption)) return false;
-    }
-    return true;
-  }
-
-  /**
-   * Checks that an option for an {@link ApplicationCommand} is equal to the provided option
-   * In most cases it is better to compare using {@link ApplicationCommand#equals}
-   * @param {ApplicationCommandOptionData} existing The option on the existing command,
-   * should be from {@link ApplicationCommand#options}
-   * @param {ApplicationCommandOptionData|APIApplicationCommandOption} option The option to compare against
-   * @param {boolean} [enforceOptionOrder=false] Whether to strictly check that options or choices are in the same
-   * order in their array <info>The client may not always respect this ordering!</info>
-   * @returns {boolean}
-   * @private
-   */
-  static _optionEquals(existing, option, enforceOptionOrder = false) {
-    if (
-      option.name !== existing.name ||
-      option.type !== existing.type ||
-      option.description !== existing.description ||
-      option.autocomplete !== existing.autocomplete ||
-      (option.required ??
-        ([ApplicationCommandOptionType.Subcommand, ApplicationCommandOptionType.SubcommandGroup].includes(option.type)
-          ? undefined
-          : false)) !== existing.required ||
-      option.choices?.length !== existing.choices?.length ||
-      option.options?.length !== existing.options?.length ||
-      (option.channelTypes ?? option.channel_types)?.length !== existing.channelTypes?.length ||
-      (option.minValue ?? option.min_value) !== existing.minValue ||
-      (option.maxValue ?? option.max_value) !== existing.maxValue ||
-      (option.minLength ?? option.min_length) !== existing.minLength ||
-      (option.maxLength ?? option.max_length) !== existing.maxLength ||
-      !isEqual(option.nameLocalizations ?? option.name_localizations ?? {}, existing.nameLocalizations ?? {}) ||
-      !isEqual(
-        option.descriptionLocalizations ?? option.description_localizations ?? {},
-        existing.descriptionLocalizations ?? {},
-      )
-    ) {
-      return false;
-    }
-
-    if (existing.choices) {
-      if (
-        enforceOptionOrder &&
-        !existing.choices.every(
-          (choice, index) =>
-            choice.name === option.choices[index].name &&
-            choice.value === option.choices[index].value &&
-            isEqual(
-              choice.nameLocalizations ?? {},
-              option.choices[index].nameLocalizations ?? option.choices[index].name_localizations ?? {},
-            ),
-        )
-      ) {
-        return false;
-      }
-      if (!enforceOptionOrder) {
-        const newChoices = new Map(option.choices.map(choice => [choice.name, choice]));
-        for (const choice of existing.choices) {
-          const foundChoice = newChoices.get(choice.name);
-          if (!foundChoice || foundChoice.value !== choice.value) return false;
-        }
-      }
-    }
-
-    if (existing.channelTypes) {
-      const newTypes = option.channelTypes ?? option.channel_types;
-      for (const type of existing.channelTypes) {
-        if (!newTypes.includes(type)) return false;
-      }
-    }
-
-    if (existing.options) {
-      return this.optionsEqual(existing.options, option.options, enforceOptionOrder);
-    }
-    return true;
-  }
-
-  /**
-   * An option for an application command or subcommand.
-   * @typedef {Object} ApplicationCommandOption
-   * @property {ApplicationCommandOptionType} type The type of the option
-   * @property {string} name The name of the option
-   * @property {LocalizationMap} [nameLocalizations] The localizations for the option name
-   * @property {string} [nameLocalized] The localized name for this option
-   * @property {string} description The description of the option
-   * @property {LocalizationMap} [descriptionLocalizations] The localizations for the option description
-   * @property {string} [descriptionLocalized] The localized description for this option
-   * @property {boolean} [required] Whether the option is required
-   * @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a
-   * {@link ApplicationCommandOptionType.String}, {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {ApplicationCommandOptionChoice[]} [choices] The choices of the option for the user to pick from
-   * @property {ApplicationCommandOption[]} [options] Additional options if this option is a subcommand (group)
-   * @property {ApplicationCommandOptionAllowedChannelTypes[]} [channelTypes] When the option type is channel,
-   * the allowed types of channels that can be selected
-   * @property {number} [minValue] The minimum value for an {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {number} [maxValue] The maximum value for an {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {number} [minLength] The minimum length for an {@link ApplicationCommandOptionType.String} option
-   * (maximum of `6000`)
-   * @property {number} [maxLength] The maximum length for an {@link ApplicationCommandOptionType.String} option
-   * (maximum of `6000`)
-   */
-
-  /**
-   * A choice for an application command option.
-   * @typedef {Object} ApplicationCommandOptionChoice
-   * @property {string} name The name of the choice
-   * @property {?string} nameLocalized The localized name of the choice in the provided locale, if any
-   * @property {?Object<string, string>} [nameLocalizations] The localized names for this choice
-   * @property {string|number} value The value of the choice
-   */
-
-  /**
-   * Transforms an {@link ApplicationCommandOptionData} object into something that can be used with the API.
-   * @param {ApplicationCommandOptionData|ApplicationCommandOption} option The option to transform
-   * @param {boolean} [received] Whether this option has been received from Discord
-   * @returns {APIApplicationCommandOption}
-   * @private
-   */
-  static transformOption(option, received) {
-    const channelTypesKey = received ? 'channelTypes' : 'channel_types';
-    const minValueKey = received ? 'minValue' : 'min_value';
-    const maxValueKey = received ? 'maxValue' : 'max_value';
-    const minLengthKey = received ? 'minLength' : 'min_length';
-    const maxLengthKey = received ? 'maxLength' : 'max_length';
-    const nameLocalizationsKey = received ? 'nameLocalizations' : 'name_localizations';
-    const nameLocalizedKey = received ? 'nameLocalized' : 'name_localized';
-    const descriptionLocalizationsKey = received ? 'descriptionLocalizations' : 'description_localizations';
-    const descriptionLocalizedKey = received ? 'descriptionLocalized' : 'description_localized';
-    return {
-      type: option.type,
-      name: option.name,
-      [nameLocalizationsKey]: option.nameLocalizations ?? option.name_localizations,
-      [nameLocalizedKey]: option.nameLocalized ?? option.name_localized,
-      description: option.description,
-      [descriptionLocalizationsKey]: option.descriptionLocalizations ?? option.description_localizations,
-      [descriptionLocalizedKey]: option.descriptionLocalized ?? option.description_localized,
-      required:
-        option.required ??
-        (option.type === ApplicationCommandOptionType.Subcommand ||
-        option.type === ApplicationCommandOptionType.SubcommandGroup
-          ? undefined
-          : false),
-      autocomplete: option.autocomplete,
-      choices: option.choices?.map(choice => ({
-        name: choice.name,
-        [nameLocalizedKey]: choice.nameLocalized ?? choice.name_localized,
-        [nameLocalizationsKey]: choice.nameLocalizations ?? choice.name_localizations,
-        value: choice.value,
-      })),
-      options: option.options?.map(opt => this.transformOption(opt, received)),
-      [channelTypesKey]: option.channelTypes ?? option.channel_types,
-      [minValueKey]: option.minValue ?? option.min_value,
-      [maxValueKey]: option.maxValue ?? option.max_value,
-      [minLengthKey]: option.minLength ?? option.min_length,
-      [maxLengthKey]: option.maxLength ?? option.max_length,
-    };
-  }
-}
-
-module.exports = ApplicationCommand;
-
-/* eslint-disable max-len */
-/**
- * @external ApplicationCommandOptionAllowedChannelTypes
- * @see {@link https://discord.js.org/docs/packages/builders/stable/ApplicationCommandOptionAllowedChannelTypes:TypeAlias}
- */