@sapphire/plugin-i18next 6.1.1-next.eccc557.0 → 7.0.0-next.1f2cccc.0

package/dist/lib/InternationalizationHandler.js

@@ -1,271 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternationalizationHandler = void 0;
-const framework_1 = require("@sapphire/framework");
-const pieces_1 = require("@sapphire/pieces");
-const utilities_1 = require("@sapphire/utilities");
-const i18next_backend_1 = require("@skyra/i18next-backend");
-const i18next_1 = __importDefault(require("i18next"));
-const promises_1 = require("node:fs/promises");
-const node_path_1 = require("node:path");
-const node_url_1 = require("node:url");
-/**
- * A generalized class for handling `i18next` JSON files and their discovery.
- * @since 1.0.0
- */
-class InternationalizationHandler {
-    /**
-     * @param options The options that `i18next`, `@skyra/i18next-backend`, and {@link InternationalizationHandler} should use.
-     * @since 1.0.0
-     * @constructor
-     */
-    constructor(options) {
-        /**
-         * Describes whether {@link InternationalizationHandler.init} has been run and languages are loaded in {@link InternationalizationHandler.languages}.
-         * @since 1.0.0
-         */
-        Object.defineProperty(this, "languagesLoaded", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        /**
-         * A `Set` of initially loaded namespaces.
-         * @since 1.2.0
-         */
-        Object.defineProperty(this, "namespaces", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Set()
-        });
-        /**
-         * A `Map` of `i18next` language functions keyed by their language code.
-         * @since 1.0.0
-         */
-        Object.defineProperty(this, "languages", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        /**
-         * The options InternationalizationHandler was initialized with in the client.
-         * @since 1.0.0
-         */
-        Object.defineProperty(this, "options", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The director passed to `@skyra/i18next-backend`.
-         * Also used in {@link InternationalizationHandler.walkLanguageDirectory}.
-         * @since 1.2.0
-         */
-        Object.defineProperty(this, "languagesDirectory", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The backend options for `@skyra/i18next-backend` used by `i18next`.
-         * @since 1.0.0
-         */
-        Object.defineProperty(this, "backendOptions", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The method to be overridden by the developer.
-         *
-         * @note In the event that fetchLanguage is not defined or returns null / undefined, the defaulting from {@link fetchLanguage} will be used.
-         * @since 2.0.0
-         * @return A string for the desired language or null for no match.
-         * @see {@link fetchLanguage}
-         * @example
-         * ```typescript
-         * // Always use the same language (no per-guild configuration):
-         * container.i18n.fetchLanguage = () => 'en-US';
-         * ```
-         * @example
-         * ```typescript
-         * // Retrieving the language from an SQL database:
-         * container.i18n.fetchLanguage = async (context) => {
-         *   const guild = await driver.getOne('SELECT language FROM public.guild WHERE id = $1', [context.guild.id]);
-         *   return guild?.language ?? 'en-US';
-         * };
-         * ```
-         * @example
-         * ```typescript
-         * // Retrieving the language from an ORM:
-         * container.i18n.fetchLanguage = async (context) => {
-         *   const guild = await driver.getRepository(GuildEntity).findOne({ id: context.guild.id });
-         *   return guild?.language ?? 'en-US';
-         * };
-         * ```
-         * @example
-         * ```typescript
-         * // Retrieving the language on a per channel basis, e.g. per user or guild channel (ORM example but same principles apply):
-         * container.i18n.fetchLanguage = async (context) => {
-         *   const channel = await driver.getRepository(ChannelEntity).findOne({ id: context.channel.id });
-         *   return channel?.language ?? 'en-US';
-         * };
-         * ```
-         */
-        Object.defineProperty(this, "fetchLanguage", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: () => null
-        });
-        this.options = options ?? { i18next: { ignoreJSONStructure: false } };
-        const baseUserDirectory = pieces_1.container.client?.options?.baseUserDirectory instanceof node_url_1.URL
-            ? (0, node_url_1.fileURLToPath)(pieces_1.container.client?.options?.baseUserDirectory)
-            : pieces_1.container.client?.options?.baseUserDirectory;
-        this.languagesDirectory = this.options.defaultLanguageDirectory ?? (0, node_path_1.join)(baseUserDirectory ?? (0, pieces_1.getRootData)().root, 'languages');
-        const languagePaths = new Set([
-            (0, node_path_1.join)(this.languagesDirectory, '{{lng}}', '{{ns}}.json'),
-            ...(options?.backend?.paths ?? [])
-        ]);
-        this.backendOptions = {
-            paths: [...languagePaths],
-            ...this.options.backend
-        };
-        if ((0, utilities_1.isFunction)(this.options.fetchLanguage)) {
-            this.fetchLanguage = this.options.fetchLanguage;
-        }
-    }
-    /**
-     * Initializes the handler by loading in the namespaces, passing the data to i18next, and filling in the {@link InternationalizationHandler#languages}.
-     * @since 1.0.0
-     */
-    async init() {
-        const { namespaces, languages } = await this.walkRootDirectory(this.languagesDirectory);
-        const userOptions = (0, utilities_1.isFunction)(this.options.i18next) ? this.options.i18next(namespaces, languages) : this.options.i18next;
-        const ignoreJSONStructure = userOptions?.ignoreJSONStructure ?? false;
-        const skipOnVariables = userOptions?.interpolation?.skipOnVariables ?? false;
-        i18next_1.default.use(i18next_backend_1.Backend);
-        await i18next_1.default.init({
-            backend: this.backendOptions,
-            fallbackLng: this.options.defaultName ?? 'en-US',
-            initImmediate: false,
-            interpolation: {
-                escapeValue: false,
-                ...userOptions?.interpolation,
-                skipOnVariables
-            },
-            load: 'all',
-            defaultNS: 'default',
-            ns: namespaces,
-            preload: languages,
-            ...userOptions,
-            ignoreJSONStructure
-        });
-        this.namespaces = new Set(namespaces);
-        for (const item of languages) {
-            this.languages.set(item, i18next_1.default.getFixedT(item));
-        }
-        this.languagesLoaded = true;
-        const formatters = this.options.formatters ?? [];
-        for (const { name, format } of formatters) {
-            i18next_1.default.services.formatter.add(name, format);
-        }
-    }
-    /**
-     * Retrieve a raw TFunction from the passed locale.
-     * @param locale The language to be used.
-     * @since 1.0.0
-     */
-    getT(locale) {
-        if (!this.languagesLoaded)
-            throw new Error('Cannot call this method until InternationalizationHandler#init has been called');
-        const t = this.languages.get(locale);
-        if (t)
-            return t;
-        throw new ReferenceError('Invalid language provided');
-    }
-    /**
-     * Localizes a content given one or more keys and i18next options.
-     * @since 2.0.0
-     * @param locale The language to be used.
-     * @param key The key or keys to retrieve the content from.
-     * @param options The interpolation options.
-     * @see {@link https://www.i18next.com/overview/api#t}
-     * @returns The localized content.
-     */
-    format(locale, ...[key, defaultValueOrOptions, optionsOrUndefined]) {
-        if (!this.languagesLoaded)
-            throw new Error('Cannot call this method until InternationalizationHandler#init has been called');
-        const language = this.languages.get(locale);
-        if (!language)
-            throw new ReferenceError('Invalid language provided');
-        const defaultValue = typeof defaultValueOrOptions === 'string'
-            ? defaultValueOrOptions
-            : this.options.defaultMissingKey
-                ? language(this.options.defaultMissingKey, { replace: { key } })
-                : '';
-        return language(key, defaultValue, optionsOrUndefined);
-    }
-    /**
-     * @param directory The directory that should be walked.
-     * @since 3.0.0
-     */
-    async walkRootDirectory(directory) {
-        const languages = new Set();
-        const namespaces = new Set();
-        const dir = await (0, promises_1.opendir)(directory);
-        for await (const entry of dir) {
-            // If the entry is not a directory, skip:
-            if (!entry.isDirectory())
-                continue;
-            // Load the directory:
-            languages.add(entry.name);
-            for await (const namespace of this.walkLocaleDirectory((0, node_path_1.join)(dir.path, entry.name), '')) {
-                namespaces.add(namespace);
-            }
-        }
-        return { namespaces: [...namespaces], languages: [...languages] };
-    }
-    async reloadResources() {
-        const result = await framework_1.Result.fromAsync(async () => {
-            let languages = this.options.hmr?.languages;
-            let namespaces = this.options.hmr?.namespaces;
-            if (!languages || !namespaces) {
-                const languageDirectoryResult = await this.walkRootDirectory(this.languagesDirectory);
-                languages ?? (languages = languageDirectoryResult.languages);
-                namespaces ?? (namespaces = languageDirectoryResult.namespaces);
-            }
-            await i18next_1.default.reloadResources(languages, namespaces);
-            pieces_1.container.logger.info('[i18next-Plugin] Reloaded language resources.');
-        });
-        result.inspectErr((error) => pieces_1.container.logger.error('[i18next-Plugin]: Failed to reload language resources.', error));
-    }
-    /**
-     * @description Skips any files that don't end with `.json`.
-     * @param directory The directory that should be walked.
-     * @param ns The current namespace.
-     * @since 3.0.0
-     */
-    async *walkLocaleDirectory(directory, ns) {
-        const dir = await (0, promises_1.opendir)(directory);
-        for await (const entry of dir) {
-            if (entry.isDirectory()) {
-                yield* this.walkLocaleDirectory((0, node_path_1.join)(dir.path, entry.name), `${ns}${entry.name}/`);
-            }
-            else if (entry.isFile() && entry.name.endsWith('.json')) {
-                yield `${ns}${entry.name.slice(0, -5)}`;
-            }
-        }
-    }
-}
-exports.InternationalizationHandler = InternationalizationHandler;
-//# sourceMappingURL=InternationalizationHandler.js.map

package/dist/lib/InternationalizationHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"InternationalizationHandler.js","sourceRoot":"","sources":["../../src/lib/InternationalizationHandler.ts"],"names":[],"mappings":";;;;;;AAAA,mDAA6C;AAC7C,6CAA0D;AAC1D,mDAAiE;AACjE,4DAAsE;AACtE,sDASiB;AAEjB,+CAA2C;AAC3C,yCAAiC;AACjC,uCAA8C;AAG9C;;;GAGG;AACH,MAAa,2BAA2B;IAsCvC;;;;OAIG;IACH,YAAmB,OAAqC;QA1CxD;;;WAGG;QACI;;;;mBAAkB,KAAK;WAAC;QAE/B;;;WAGG;QACI;;;;mBAAa,IAAI,GAAG,EAAU;WAAC;QAEtC;;;WAGG;QACa;;;;mBAAY,IAAI,GAAG,EAAqB;WAAC;QAEzD;;;WAGG;QACa;;;;;WAAqC;QAErD;;;;WAIG;QACa;;;;;WAA2B;QAE3C;;;WAGG;QACgB;;;;;WAAgC;QAgCnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAoCG;QACI;;;;mBAAoF,GAAG,EAAE,CAAC,IAAI;WAAC;QA7DrG,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,OAAO,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE,EAAE,CAAC;QAEtE,MAAM,iBAAiB,GACtB,kBAAS,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,YAAY,cAAG;YAC1D,CAAC,CAAC,IAAA,wBAAa,EAAC,kBAAS,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC;YAC7D,CAAC,CAAC,kBAAS,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC;QAEjD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,wBAAwB,IAAI,IAAA,gBAAI,EAAC,iBAAiB,IAAI,IAAA,oBAAW,GAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAE9H,MAAM,aAAa,GAAG,IAAI,GAAG,CAAiB;YAC7C,IAAA,gBAAI,EAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,EAAE,aAAa,CAAC;YACvD,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;SAClC,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,GAAG;YACrB,KAAK,EAAE,CAAC,GAAG,aAAa,CAAC;YACzB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO;SACvB,CAAC;QAEF,IAAI,IAAA,sBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;YAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;SAChD;IACF,CAAC;IAyCD;;;OAGG;IACI,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACxF,MAAM,WAAW,GAAG,IAAA,sBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1H,MAAM,mBAAmB,GAAG,WAAW,EAAE,mBAAmB,IAAI,KAAK,CAAC;QACtE,MAAM,eAAe,GAAG,WAAW,EAAE,aAAa,EAAE,eAAe,IAAI,KAAK,CAAC;QAE7E,iBAAO,CAAC,GAAG,CAAC,yBAAO,CAAC,CAAC;QACrB,MAAM,iBAAO,CAAC,IAAI,CAAC;YAClB,OAAO,EAAE,IAAI,CAAC,cAAc;YAC5B,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO;YAChD,aAAa,EAAE,KAAK;YACpB,aAAa,EAAE;gBACd,WAAW,EAAE,KAAK;gBAClB,GAAG,WAAW,EAAE,aAAa;gBAC7B,eAAe;aACf;YACD,IAAI,EAAE,KAAK;YACX,SAAS,EAAE,SAAS;YACpB,EAAE,EAAE,UAAU;YACd,OAAO,EAAE,SAAS;YAClB,GAAG,WAAW;YACd,mBAAmB;SACnB,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;YAC7B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAE5B,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QACjD,KAAK,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,UAAU,EAAE;YAC1C,iBAAO,CAAC,QAAQ,CAAC,SAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SAC9C;IACF,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,MAAc;QACzB,IAAI,CAAC,IAAI,CAAC,eAAe;YAAE,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;QAE7H,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC;QAChB,MAAM,IAAI,cAAc,CAAC,2BAA2B,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAOZ,MAAc,EACd,GAAG,CAAC,GAAG,EAAE,qBAAqB,EAAE,kBAAkB,CAGyC;QAE3F,IAAI,CAAC,IAAI,CAAC,eAAe;YAAE,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;QAE7H,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,cAAc,CAAC,2BAA2B,CAAC,CAAC;QAErE,MAAM,YAAY,GACjB,OAAO,qBAAqB,KAAK,QAAQ;YACxC,CAAC,CAAC,qBAAqB;YACvB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB;gBAC9B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC;gBAChE,CAAC,CAAC,EAAE,CAAC;QAET,OAAO,QAAQ,CAAgC,GAAG,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,SAAmB;QACjD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QAErC,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,EAAE;YAC9B,yCAAyC;YACzC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;gBAAE,SAAS;YAEnC,sBAAsB;YACtB,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAE1B,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAA,gBAAI,EAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE;gBACvF,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;aAC1B;SACD;QAED,OAAO,EAAE,UAAU,EAAE,CAAC,GAAG,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;IACnE,CAAC;IAEM,KAAK,CAAC,eAAe;QAC3B,MAAM,MAAM,GAAG,MAAM,kBAAM,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;YAChD,IAAI,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC;YAC5C,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC;YAC9C,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,EAAE;gBAC9B,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBACtF,SAAS,KAAT,SAAS,GAAK,uBAAuB,CAAC,SAAS,EAAC;gBAChD,UAAU,KAAV,UAAU,GAAK,uBAAuB,CAAC,UAAU,EAAC;aAClD;YAED,MAAM,iBAAO,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACrD,kBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,wDAAwD,EAAE,KAAK,CAAC,CAAC,CAAC;IACvH,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,CAAC,mBAAmB,CAAC,SAAiB,EAAE,EAAU;QAC/D,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,EAAE;YAC9B,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE;gBACxB,KAAK,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAA,gBAAI,EAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;aACnF;iBAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAC1D,MAAM,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACxC;SACD;IACF,CAAC;CACD;AA9PD,kEA8PC"}

package/dist/lib/functions.d.ts

@@ -1,137 +0,0 @@
-import { type APIApplicationCommandOptionChoice } from 'discord.js';
-import type { AppendKeyPrefix, DefaultNamespace, InterpolationMap, Namespace, ParseKeys, TFunctionReturn, TFunctionReturnOptionalDetails, TOptions } from 'i18next';
-import type { $Dictionary, $SpecialObject, BuilderWithDescription, BuilderWithName, BuilderWithNameAndDescription, LocalizedData, Target } from './types';
-/**
- * Retrieves the language name for a specific target, using {@link InternationalizationHandler.fetchLanguage}.
- * If {@link InternationalizationHandler.fetchLanguage} is not defined or this function returns a nullish value,
- * then there will be a series of fallback attempts in the following descending order:
- * 1. Returns {@link Guild.preferredLocale}.
- * 2. Returns {@link InternationalizationOptions.defaultName} if no guild was provided.
- * 3. Returns `'en-US'` if nothing else was found.
- * @since 2.0.0
- * @param target The target to fetch the language from.
- * @see {@link resolveLanguage}
- * @returns The name of the language key.
- */
-export declare function fetchLanguage(target: Target): Promise<string>;
-/**
- * Retrieves the language-assigned function from i18next designated to a target's preferred language code.
- * @since 2.0.0
- * @param target The target to fetch the language from.
- * @returns The language function from i18next.
- */
-export declare function fetchT(target: Target): Promise<import("i18next").TFunction<"translation", undefined>>;
-/**
- * Resolves a key and its parameters.
- * @since 2.0.0
- * @param target The target to fetch the language key from.
- * @param key The i18next key.
- * @param options The options to be passed to TFunction.
- * @returns The data that `key` held, processed by i18next.
- */
-export declare function resolveKey<const Key extends ParseKeys<Ns, TOpt, undefined>, const TOpt extends TOptions = TOptions, Ret extends TFunctionReturn<Ns, AppendKeyPrefix<Key, undefined>, TOpt> = TOpt['returnObjects'] extends true ? $SpecialObject : string, Ns extends Namespace = DefaultNamespace, const ActualOptions extends TOpt & InterpolationMap<Ret> = TOpt & InterpolationMap<Ret>>(target: Target, ...[key, defaultValueOrOptions, optionsOrUndefined]: [key: Key | Key[], options?: ActualOptions] | [key: string | string[], options: TOpt & $Dictionary & {
-    defaultValue: string;
-}] | [key: string | string[], defaultValue: string, options?: TOpt & $Dictionary]): Promise<TFunctionReturnOptionalDetails<Ret, TOpt>>;
-/**
- * Gets the value and the localizations from a language key.
- * @param key The key to get the localizations from.
- * @returns The retrieved data.
- * @remarks This should be called **strictly** after loading the locales.
- */
-export declare function getLocalizedData<const TOpt extends TOptions = TOptions, Ns extends Namespace = DefaultNamespace, KPrefix = undefined>(key: ParseKeys<Ns, TOpt, KPrefix>): LocalizedData;
-/**
- * Applies the localized names on the builder, calling `setName` and `setNameLocalizations`.
- * @param builder The builder to apply the localizations to.
- * @param key The key to get the localizations from.
- * @returns The updated builder.
- */
-export declare function applyNameLocalizedBuilder<T extends BuilderWithName, const TOpt extends TOptions = TOptions, Ns extends Namespace = DefaultNamespace, KPrefix = undefined>(builder: T, key: ParseKeys<Ns, TOpt, KPrefix>): T;
-/**
- * Applies the localized descriptions on the builder, calling `setDescription` and `setDescriptionLocalizations`.
- * @param builder The builder to apply the localizations to.
- * @param key The key to get the localizations from.
- * @returns The updated builder.
- */
-export declare function applyDescriptionLocalizedBuilder<T extends BuilderWithDescription, const TOpt extends TOptions = TOptions, Ns extends Namespace = DefaultNamespace, KPrefix = undefined>(builder: T, key: ParseKeys<Ns, TOpt, KPrefix>): T;
-/**
- * Applies the localized names and descriptions on the builder, calling {@link applyNameLocalizedBuilder} and
- * {@link applyDescriptionLocalizedBuilder}.
- *
- * @param builder The builder to apply the localizations to.
- *
- * @param params The root key or the key for the name and description keys.
- * This needs to be either 1 or 2 parameters.
- * See examples below for more information.
- *
- * @returns The updated builder. You can chain subsequent builder methods on this.
- *
- * @remarks If only 2 parameters were passed, then this function will automatically append `Name` and `Description`
- *  to the root-key (wherein `root-key` is second parameter in the function, after `builder`)
- * passed through the second parameter.
- *
- * For example given `applyLocalizedBuilder(builder, 'userinfo')` the localized options will use the i18next keys
- * `userinfoName` and `userinfoDescription`.
- *
- * In the following example we provide all parameters and add a User Option
- * `applyLocalizedBuilder` needs either
- * @example
- * ```typescript
- * class UserInfoCommand extends Command {
- *   public registerApplicationCommands(registry: ChatInputCommand.Registry) {
- *     registry.registerChatInputCommand(
- *       (builder) =>
- *         applyLocalizedBuilder(builder, 'commands/names:userinfo', 'commands/descriptions:userinfo')
- *           .addUserOption(
- *             (input) => applyLocalizedBuilder(input, 'commands/options:userinfo-name', 'commands/options:userinfo-description').setRequired(true)
- *           )
- *     );
- *   }
- * }
- * ```
- *
- * In the following example we provide single root keys which means `Name` and `Description` get appended as mentioned above.
- * @example
- * ```typescript
- * class UserInfoCommand extends Command {
- *   public registerApplicationCommands(registry: ChatInputCommand.Registry) {
- *     registry.registerChatInputCommand(
- *       (builder) =>
- *         applyLocalizedBuilder(builder, 'commands:userinfo')
- *           .addUserOption(
- *             (input) => applyLocalizedBuilder(input, 'options:userinfo').setRequired(true)
- *           )
- *     );
- *   }
- * }
- * ```
- */
-export declare function applyLocalizedBuilder<T extends BuilderWithNameAndDescription, const TOpt extends TOptions = TOptions, Ns extends Namespace = DefaultNamespace, KPrefix = undefined>(builder: T, ...params: [root: string] | [name: ParseKeys<Ns, TOpt, KPrefix>, description: ParseKeys<Ns, TOpt, KPrefix>]): T;
-/**
- * Constructs an object that can be passed into `setChoices` for String or Number option with localized names.
- *
- * @param key The i18next key for the name of the select option name.
- * @param options The additional Select Menu options. This should _at least_ include the `value` key.
- * @returns An object with anything provided through {@link createLocalizedChoice.options} with `name` and `name_localizations` added.
- *
- * @example
- * ```typescript
- * export class TypeCommand extends Command {
- *   public override registerApplicationCommands(registry: ChatInputCommand.Registry) {
- *     registry.registerChatInputCommand((builder) =>
- *       applyLocalizedBuilder(builder, 'commands/names:type').addStringOption((option) =>
- *         applyLocalizedBuilder(option, 'commands/options:type')
- *           .setRequired(true)
- *           .setChoices(
- *             createLocalizedChoice('selects/pokemon:type-grass', { value: 'grass' }),
- *             createLocalizedChoice('selects/pokemon:type-water', { value: 'water' }),
- *             createLocalizedChoice('selects/pokemon:type-fire', { value: 'fire' }),
- *             createLocalizedChoice('selects/pokemon:type-electric', { value: 'electric' })
- *           )
- *       )
- *     );
- *   }
- * }
- * ```
- */
-export declare function createLocalizedChoice<ValueType = string | number, const TOpt extends TOptions = TOptions, Ns extends Namespace = DefaultNamespace, KPrefix = undefined>(key: ParseKeys<Ns, TOpt, KPrefix>, options: Omit<APIApplicationCommandOptionChoice<ValueType>, 'name' | 'name_localizations'>): APIApplicationCommandOptionChoice<ValueType>;
-//# sourceMappingURL=functions.d.ts.map

package/dist/lib/functions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../src/lib/functions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwD,KAAK,iCAAiC,EAAqB,MAAM,YAAY,CAAC;AAC7I,OAAO,KAAK,EACX,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,eAAe,EACf,8BAA8B,EAC9B,QAAQ,EACR,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,sBAAsB,EACtB,eAAe,EACf,6BAA6B,EAE7B,aAAa,EACb,MAAM,EACN,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA6B7D;AAED;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,MAAM,kEAE1C;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC/B,KAAK,CAAC,GAAG,SAAS,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,EAChD,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,QAAQ,EACtC,GAAG,SAAS,eAAe,CAAC,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,IAAI,GAAG,cAAc,GAAG,MAAM,EACrI,EAAE,SAAS,SAAS,GAAG,gBAAgB,EACvC,KAAK,CAAC,aAAa,SAAS,IAAI,GAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAEvF,MAAM,EAAE,MAAM,EACd,GAAG,CAAC,GAAG,EAAE,qBAAqB,EAAE,kBAAkB,CAAC,EAChD,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,GAC3C,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,GAAG,WAAW,GAAG;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,GAChF,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC,GAC7E,OAAO,CAAC,8BAA8B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CASpD;AAmDD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAAE,EAAE,SAAS,SAAS,GAAG,gBAAgB,EAAE,OAAO,GAAG,SAAS,EACpI,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,GAC/B,aAAa,CAQf;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACxC,CAAC,SAAS,eAAe,EACzB,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,QAAQ,EACtC,EAAE,SAAS,SAAS,GAAG,gBAAgB,EACvC,OAAO,GAAG,SAAS,EAClB,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,KAG9C;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC/C,CAAC,SAAS,sBAAsB,EAChC,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,QAAQ,EACtC,EAAE,SAAS,SAAS,GAAG,gBAAgB,EACvC,OAAO,GAAG,SAAS,EAClB,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,KAG9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,wBAAgB,qBAAqB,CACpC,CAAC,SAAS,6BAA6B,EACvC,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,QAAQ,EACtC,EAAE,SAAS,SAAS,GAAG,gBAAgB,EACvC,OAAO,GAAG,SAAS,EAClB,OAAO,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAU5H;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,qBAAqB,CACpC,SAAS,GAAG,MAAM,GAAG,MAAM,EAC3B,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,QAAQ,EACtC,EAAE,SAAS,SAAS,GAAG,gBAAgB,EACvC,OAAO,GAAG,SAAS,EAEnB,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,EACjC,OAAO,EAAE,IAAI,CAAC,iCAAiC,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAAC,GACxF,iCAAiC,CAAC,SAAS,CAAC,CAQ9C"}

package/dist/lib/functions.js

@@ -1,241 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLocalizedChoice = exports.applyLocalizedBuilder = exports.applyDescriptionLocalizedBuilder = exports.applyNameLocalizedBuilder = exports.getLocalizedData = exports.resolveKey = exports.fetchT = exports.fetchLanguage = void 0;
-const pieces_1 = require("@sapphire/pieces");
-const utilities_1 = require("@sapphire/utilities");
-const discord_js_1 = require("discord.js");
-/**
- * Retrieves the language name for a specific target, using {@link InternationalizationHandler.fetchLanguage}.
- * If {@link InternationalizationHandler.fetchLanguage} is not defined or this function returns a nullish value,
- * then there will be a series of fallback attempts in the following descending order:
- * 1. Returns {@link Guild.preferredLocale}.
- * 2. Returns {@link InternationalizationOptions.defaultName} if no guild was provided.
- * 3. Returns `'en-US'` if nothing else was found.
- * @since 2.0.0
- * @param target The target to fetch the language from.
- * @see {@link resolveLanguage}
- * @returns The name of the language key.
- */
-function fetchLanguage(target) {
-    // Handle Interactions:
-    if (target instanceof discord_js_1.BaseInteraction) {
-        return resolveLanguage({
-            user: target.user,
-            channel: target.channel,
-            guild: target.guild,
-            interactionGuildLocale: target.guildLocale,
-            interactionLocale: target.locale
-        });
-    }
-    // Handle Message:
-    if (target instanceof discord_js_1.Message) {
-        return resolveLanguage({ user: target.author, channel: target.channel, guild: target.guild });
-    }
-    // Handle Guild:
-    if (target instanceof discord_js_1.Guild) {
-        return resolveLanguage({ user: null, channel: null, guild: target });
-    }
-    // Handle DMChannel:
-    if (target.type === discord_js_1.ChannelType.DM) {
-        return resolveLanguage({ user: null, channel: target, guild: null });
-    }
-    // Handle any other channel:
-    return resolveLanguage({ user: null, channel: target, guild: target.guild });
-}
-exports.fetchLanguage = fetchLanguage;
-/**
- * Retrieves the language-assigned function from i18next designated to a target's preferred language code.
- * @since 2.0.0
- * @param target The target to fetch the language from.
- * @returns The language function from i18next.
- */
-async function fetchT(target) {
-    return pieces_1.container.i18n.getT(await fetchLanguage(target));
-}
-exports.fetchT = fetchT;
-/**
- * Resolves a key and its parameters.
- * @since 2.0.0
- * @param target The target to fetch the language key from.
- * @param key The i18next key.
- * @param options The options to be passed to TFunction.
- * @returns The data that `key` held, processed by i18next.
- */
-async function resolveKey(target, ...[key, defaultValueOrOptions, optionsOrUndefined]) {
-    const parsedOptions = typeof defaultValueOrOptions === 'string' ? optionsOrUndefined : defaultValueOrOptions;
-    const language = typeof parsedOptions?.lng === 'string' ? parsedOptions.lng : await fetchLanguage(target);
-    if (typeof defaultValueOrOptions === 'string') {
-        return pieces_1.container.i18n.format(language, key, defaultValueOrOptions, optionsOrUndefined);
-    }
-    return pieces_1.container.i18n.format(language, key, undefined, defaultValueOrOptions);
-}
-exports.resolveKey = resolveKey;
-/**
- * @internal
- */
-async function resolveLanguage(context) {
-    const lang = await pieces_1.container.i18n.fetchLanguage(context);
-    return lang ?? context.guild?.preferredLocale ?? pieces_1.container.i18n.options.defaultName ?? 'en-US';
-}
-const supportedLanguages = new Set(Object.values(discord_js_1.Locale));
-function isSupportedDiscordLocale(language) {
-    return supportedLanguages.has(language);
-}
-const getLocales = (0, utilities_1.lazy)(() => {
-    const locales = new Map(pieces_1.container.i18n.languages);
-    for (const [locale] of locales) {
-        if (!isSupportedDiscordLocale(locale)) {
-            process.emitWarning('Unsupported Discord locale', {
-                code: 'UNSUPPORTED_LOCALE',
-                detail: `'${locale}' needs to be one of: ${[...locales.keys()]}`
-            });
-            locales.delete(locale);
-        }
-        continue;
-    }
-    return locales;
-});
-const getDefaultT = (0, utilities_1.lazy)(() => {
-    const defaultLocale = pieces_1.container.i18n.options.defaultName ?? 'en-US';
-    if (!isSupportedDiscordLocale(defaultLocale)) {
-        throw new TypeError(`Unsupported Discord locale found:\n'${defaultLocale}' is not within the list of ${[...supportedLanguages]}`);
-    }
-    const defaultT = getLocales().get(defaultLocale);
-    if (defaultT) {
-        return defaultT;
-    }
-    throw new TypeError(`Could not find ${defaultLocale}`);
-});
-/**
- * Gets the value and the localizations from a language key.
- * @param key The key to get the localizations from.
- * @returns The retrieved data.
- * @remarks This should be called **strictly** after loading the locales.
- */
-function getLocalizedData(key) {
-    const locales = getLocales();
-    const defaultT = getDefaultT();
-    return {
-        value: defaultT(key),
-        localizations: Object.fromEntries(Array.from(locales, ([locale, t]) => [locale, t(key)]))
-    };
-}
-exports.getLocalizedData = getLocalizedData;
-/**
- * Applies the localized names on the builder, calling `setName` and `setNameLocalizations`.
- * @param builder The builder to apply the localizations to.
- * @param key The key to get the localizations from.
- * @returns The updated builder.
- */
-function applyNameLocalizedBuilder(builder, key) {
-    const result = getLocalizedData(key);
-    return builder.setName(result.value).setNameLocalizations(result.localizations);
-}
-exports.applyNameLocalizedBuilder = applyNameLocalizedBuilder;
-/**
- * Applies the localized descriptions on the builder, calling `setDescription` and `setDescriptionLocalizations`.
- * @param builder The builder to apply the localizations to.
- * @param key The key to get the localizations from.
- * @returns The updated builder.
- */
-function applyDescriptionLocalizedBuilder(builder, key) {
-    const result = getLocalizedData(key);
-    return builder.setDescription(result.value).setDescriptionLocalizations(result.localizations);
-}
-exports.applyDescriptionLocalizedBuilder = applyDescriptionLocalizedBuilder;
-/**
- * Applies the localized names and descriptions on the builder, calling {@link applyNameLocalizedBuilder} and
- * {@link applyDescriptionLocalizedBuilder}.
- *
- * @param builder The builder to apply the localizations to.
- *
- * @param params The root key or the key for the name and description keys.
- * This needs to be either 1 or 2 parameters.
- * See examples below for more information.
- *
- * @returns The updated builder. You can chain subsequent builder methods on this.
- *
- * @remarks If only 2 parameters were passed, then this function will automatically append `Name` and `Description`
- *  to the root-key (wherein `root-key` is second parameter in the function, after `builder`)
- * passed through the second parameter.
- *
- * For example given `applyLocalizedBuilder(builder, 'userinfo')` the localized options will use the i18next keys
- * `userinfoName` and `userinfoDescription`.
- *
- * In the following example we provide all parameters and add a User Option
- * `applyLocalizedBuilder` needs either
- * @example
- * ```typescript
- * class UserInfoCommand extends Command {
- *   public registerApplicationCommands(registry: ChatInputCommand.Registry) {
- *     registry.registerChatInputCommand(
- *       (builder) =>
- *         applyLocalizedBuilder(builder, 'commands/names:userinfo', 'commands/descriptions:userinfo')
- *           .addUserOption(
- *             (input) => applyLocalizedBuilder(input, 'commands/options:userinfo-name', 'commands/options:userinfo-description').setRequired(true)
- *           )
- *     );
- *   }
- * }
- * ```
- *
- * In the following example we provide single root keys which means `Name` and `Description` get appended as mentioned above.
- * @example
- * ```typescript
- * class UserInfoCommand extends Command {
- *   public registerApplicationCommands(registry: ChatInputCommand.Registry) {
- *     registry.registerChatInputCommand(
- *       (builder) =>
- *         applyLocalizedBuilder(builder, 'commands:userinfo')
- *           .addUserOption(
- *             (input) => applyLocalizedBuilder(input, 'options:userinfo').setRequired(true)
- *           )
- *     );
- *   }
- * }
- * ```
- */
-function applyLocalizedBuilder(builder, ...params) {
-    const [localeName, localeDescription] = params.length === 1 ? [`${params[0]}Name`, `${params[0]}Description`] : params;
-    applyNameLocalizedBuilder(builder, localeName);
-    applyDescriptionLocalizedBuilder(builder, localeDescription);
-    return builder;
-}
-exports.applyLocalizedBuilder = applyLocalizedBuilder;
-/**
- * Constructs an object that can be passed into `setChoices` for String or Number option with localized names.
- *
- * @param key The i18next key for the name of the select option name.
- * @param options The additional Select Menu options. This should _at least_ include the `value` key.
- * @returns An object with anything provided through {@link createLocalizedChoice.options} with `name` and `name_localizations` added.
- *
- * @example
- * ```typescript
- * export class TypeCommand extends Command {
- *   public override registerApplicationCommands(registry: ChatInputCommand.Registry) {
- *     registry.registerChatInputCommand((builder) =>
- *       applyLocalizedBuilder(builder, 'commands/names:type').addStringOption((option) =>
- *         applyLocalizedBuilder(option, 'commands/options:type')
- *           .setRequired(true)
- *           .setChoices(
- *             createLocalizedChoice('selects/pokemon:type-grass', { value: 'grass' }),
- *             createLocalizedChoice('selects/pokemon:type-water', { value: 'water' }),
- *             createLocalizedChoice('selects/pokemon:type-fire', { value: 'fire' }),
- *             createLocalizedChoice('selects/pokemon:type-electric', { value: 'electric' })
- *           )
- *       )
- *     );
- *   }
- * }
- * ```
- */
-function createLocalizedChoice(key, options) {
-    const result = getLocalizedData(key);
-    return {
-        ...options,
-        name: result.value,
-        name_localizations: result.localizations
-    };
-}
-exports.createLocalizedChoice = createLocalizedChoice;
-//# sourceMappingURL=functions.js.map