@sapphire/plugin-i18next 3.0.2-next.f0bab02.0 → 3.1.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@sapphire/plugin-i18next@3.1.0](https://github.com/sapphiredev/plugins/compare/@sapphire/plugin-i18next@3.0.1...@sapphire/plugin-i18next@3.1.0) - (2022-10-16)
+
+## 🐛 Bug Fixes
+
+- **i18next:** Update dependencies ([98e3313](https://github.com/sapphiredev/plugins/commit/98e3313c6bdf279d8301a4d6705a4b40f6767929))
+
+## 🚀 Features
+
+- **plugin-i18next:** Add `applyLocalizedBuilder` and `createSelectMenuChoiceName` to help registering localized commands (#372) ([6deee87](https://github.com/sapphiredev/plugins/commit/6deee87c6dee3af2d5f7c02d39d9aa03b480d65f))
+
 # [@sapphire/plugin-i18next@3.0.1](https://github.com/sapphiredev/plugins/compare/@sapphire/plugin-i18next@3.0.0...@sapphire/plugin-i18next@3.0.1) - (2022-10-02)
 
 ## 🐛 Bug Fixes

package/dist/index.mjs

@@ -2,6 +2,11 @@ import mod from "./index.js";
 
 export default mod;
 export const InternationalizationHandler = mod.InternationalizationHandler;
+export const applyDescriptionLocalizedBuilder = mod.applyDescriptionLocalizedBuilder;
+export const applyLocalizedBuilder = mod.applyLocalizedBuilder;
+export const applyNameLocalizedBuilder = mod.applyNameLocalizedBuilder;
+export const createLocalizedChoice = mod.createLocalizedChoice;
 export const fetchLanguage = mod.fetchLanguage;
 export const fetchT = mod.fetchT;
+export const getLocalizedData = mod.getLocalizedData;
 export const resolveKey = mod.resolveKey;

package/dist/lib/functions.d.ts

@@ -1,6 +1,7 @@
-import type { NonNullObject } from '@sapphire/utilities';
+import { type NonNullObject } from '@sapphire/utilities';
+import { APIApplicationCommandOptionChoice } from 'discord-api-types/v10';
 import type { StringMap, TFunctionKeys, TFunctionResult, TOptions } from 'i18next';
-import type { Target } from './types';
+import type { 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,
@@ -30,4 +31,106 @@ export declare function fetchT(target: Target): Promise<import("i18next").TFunct
  * @returns The data that `key` held, processed by i18next.
  */
 export declare function resolveKey<TResult extends TFunctionResult = string, TKeys extends TFunctionKeys = string, TInterpolationMap extends NonNullObject = StringMap>(target: Target, key: TKeys | TKeys[], options?: TOptions<TInterpolationMap>): Promise<TResult>;
+/**
+ * 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(key: TFunctionKeys): 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>(builder: T, key: TFunctionKeys): 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>(builder: T, key: TFunctionKeys): 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>(builder: T, ...params: [root: string] | [name: TFunctionKeys, description: TFunctionKeys]): 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>(key: TFunctionKeys, options: Omit<APIApplicationCommandOptionChoice<ValueType>, 'name' | 'name_localizations'>): APIApplicationCommandOptionChoice<ValueType>;
 //# sourceMappingURL=functions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../src/lib/functions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,KAAK,EAA+B,MAAM,EAAE,MAAM,SAAS,CAAC;AAEnE;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA6B7D;AAED;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,MAAM,wCAE1C;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC/B,OAAO,SAAS,eAAe,GAAG,MAAM,EACxC,KAAK,SAAS,aAAa,GAAG,MAAM,EACpC,iBAAiB,SAAS,aAAa,GAAG,SAAS,EAClD,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAE/F"}
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../src/lib/functions.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,iCAAiC,EAA6B,MAAM,uBAAuB,CAAC;AAErG,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,KAAK,EACX,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,wCAE1C;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC/B,OAAO,SAAS,eAAe,GAAG,MAAM,EACxC,KAAK,SAAS,aAAa,GAAG,MAAM,EACpC,iBAAiB,SAAS,aAAa,GAAG,SAAS,EAClD,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAE/F;AAmDD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CAQlE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,eAAe,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,KAGlG;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,CAAC,SAAS,sBAAsB,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,KAGhH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,6BAA6B,EAC5E,OAAO,EAAE,CAAC,EACV,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,CAAC,GAC3E,CAAC,CAQH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,GAAG,MAAM,GAAG,MAAM,EAChE,GAAG,EAAE,aAAa,EAClB,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,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveKey = exports.fetchT = exports.fetchLanguage = void 0;
+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 v10_1 = require("discord-api-types/v10");
 const discord_js_1 = require("discord.js");
 /**
  * Retrieves the language name for a specific target, using {@link InternationalizationHandler.fetchLanguage}.
@@ -71,4 +73,165 @@ 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(v10_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

package/dist/lib/functions.js.map

@@ -1 +1 @@
-{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../src/lib/functions.ts"],"names":[],"mappings":";;;AAAA,6CAA6C;AAE7C,2CAAiG;AAIjG;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC3C,uBAAuB;IACvB,IAAI,MAAM,YAAY,mCAAsB,IAAI,MAAM,YAAY,wCAA2B,EAAE;QAC9F,OAAO,eAAe,CAAC;YACtB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,sBAAsB,EAAE,MAAM,CAAC,WAAW;YAC1C,iBAAiB,EAAE,MAAM,CAAC,MAAM;SAChC,CAAC,CAAC;KACH;IAED,kBAAkB;IAClB,IAAI,MAAM,YAAY,oBAAO,EAAE;QAC9B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;KAC9F;IAED,gBAAgB;IAChB,IAAI,MAAM,YAAY,kBAAK,EAAE;QAC5B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;KACrE;IAED,oBAAoB;IACpB,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE;QACzB,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;KACrE;IAED,4BAA4B;IAC5B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;AAC9E,CAAC;AA7BD,sCA6BC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,MAAc;IAC1C,OAAO,kBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACzD,CAAC;AAFD,wBAEC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,UAAU,CAI9B,MAAc,EAAE,GAAoB,EAAE,OAAqC;IAC5E,OAAO,kBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,OAAO,EAAE,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AAC1H,CAAC;AAND,gCAMC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAAC,OAAoC;IAClE,MAAM,IAAI,GAAG,MAAM,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACzD,OAAO,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,eAAe,IAAI,kBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC;AAChG,CAAC"}
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../src/lib/functions.ts"],"names":[],"mappings":";;;AAAA,6CAA6C;AAC7C,mDAA+D;AAC/D,+CAAqG;AACrG,2CAAiG;AAWjG;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC3C,uBAAuB;IACvB,IAAI,MAAM,YAAY,mCAAsB,IAAI,MAAM,YAAY,wCAA2B,EAAE;QAC9F,OAAO,eAAe,CAAC;YACtB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,sBAAsB,EAAE,MAAM,CAAC,WAAW;YAC1C,iBAAiB,EAAE,MAAM,CAAC,MAAM;SAChC,CAAC,CAAC;KACH;IAED,kBAAkB;IAClB,IAAI,MAAM,YAAY,oBAAO,EAAE;QAC9B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;KAC9F;IAED,gBAAgB;IAChB,IAAI,MAAM,YAAY,kBAAK,EAAE;QAC5B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;KACrE;IAED,oBAAoB;IACpB,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE;QACzB,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;KACrE;IAED,4BAA4B;IAC5B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;AAC9E,CAAC;AA7BD,sCA6BC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,MAAc;IAC1C,OAAO,kBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACzD,CAAC;AAFD,wBAEC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,UAAU,CAI9B,MAAc,EAAE,GAAoB,EAAE,OAAqC;IAC5E,OAAO,kBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,OAAO,EAAE,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AAC1H,CAAC;AAND,gCAMC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAAC,OAAoC;IAClE,MAAM,IAAI,GAAG,MAAM,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACzD,OAAO,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,eAAe,IAAI,kBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC;AAChG,CAAC;AAED,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,YAAM,CAAC,CAA8B,CAAC;AAEvF,SAAS,wBAAwB,CAAC,QAAgB;IACjD,OAAO,kBAAkB,CAAC,GAAG,CAAC,QAAwB,CAAC,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE;IAC5B,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,kBAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAElD,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,EAAE;QAC/B,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE;YACtC,OAAO,CAAC,WAAW,CAAC,4BAA4B,EAAE;gBACjD,IAAI,EAAE,oBAAoB;gBAC1B,MAAM,EAAE,IAAI,MAAM,yBAAyB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE;aAChE,CAAC,CAAC;YAEH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,SAAS;KACT;IAED,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE;IAC7B,MAAM,aAAa,GAAG,kBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC;IAEpE,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,EAAE;QAC7C,MAAM,IAAI,SAAS,CAAC,uCAAuC,aAAa,+BAA+B,CAAC,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;KAClI;IAED,MAAM,QAAQ,GAAG,UAAU,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjD,IAAI,QAAQ,EAAE;QACb,OAAO,QAAQ,CAAC;KAChB;IAED,MAAM,IAAI,SAAS,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,GAAkB;IAClD,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAE/B,OAAO;QACN,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC;QACpB,aAAa,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACzF,CAAC;AACH,CAAC;AARD,4CAQC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CAA4B,OAAU,EAAE,GAAkB;IAClG,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AACjF,CAAC;AAHD,8DAGC;AAED;;;;;GAKG;AACH,SAAgB,gCAAgC,CAAmC,OAAU,EAAE,GAAkB;IAChH,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,2BAA2B,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AAC/F,CAAC;AAHD,4EAGC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,qBAAqB,CACpC,OAAU,EACV,GAAG,MAA0E;IAE7E,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,GACpC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAuB,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,aAA8B,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAElH,yBAAyB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,gCAAgC,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAE7D,OAAO,OAAO,CAAC;AAChB,CAAC;AAXD,sDAWC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,qBAAqB,CACpC,GAAkB,EAClB,OAA0F;IAE1F,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAErC,OAAO;QACN,GAAG,OAAO;QACV,IAAI,EAAE,MAAM,CAAC,KAAK;QAClB,kBAAkB,EAAE,MAAM,CAAC,aAAa;KACxC,CAAC;AACH,CAAC;AAXD,sDAWC"}

package/dist/lib/types.d.ts

@@ -1,6 +1,7 @@
 import type { Awaitable } from '@sapphire/utilities';
 import type { Backend } from '@skyra/i18next-backend';
 import type { WatchOptions } from 'chokidar';
+import type { LocalizationMap } from 'discord-api-types/v10';
 import type { BaseCommandInteraction, Guild, Interaction, Message, MessageComponentInteraction, StageChannel, StoreChannel, User, VoiceChannel } from 'discord.js';
 import type { InitOptions } from 'i18next';
 /**
@@ -121,6 +122,19 @@ export interface I18nextFormatters {
     name: string;
     format(value: any, lng: string | undefined, options: any): string;
 }
+export interface LocalizedData {
+    value: string;
+    localizations: LocalizationMap;
+}
+export interface BuilderWithName {
+    setName(name: string): this;
+    setNameLocalizations(localizedNames: LocalizationMap | null): this;
+}
+export interface BuilderWithDescription {
+    setDescription(description: string): this;
+    setDescriptionLocalizations(localizedDescriptions: LocalizationMap | null): this;
+}
+export declare type BuilderWithNameAndDescription = BuilderWithName & BuilderWithDescription;
 export declare type ChannelTarget = Message | DiscordChannel;
 export declare type Target = BaseCommandInteraction | ChannelTarget | Guild | MessageComponentInteraction;
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EACX,sBAAsB,EACtB,KAAK,EACL,WAAW,EACX,OAAO,EACP,2BAA2B,EAC3B,YAAY,EACZ,YAAY,EACZ,IAAI,EACJ,YAAY,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;;GAIG;AACH,oBAAY,cAAc,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAErG;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAEpD;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEjC;;;;OAIG;IACH,GAAG,CAAC,EAAE,UAAU,CAAC;IAEjB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACnF;AAED,oBAAY,uBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AACzD,oBAAY,cAAc,GAAG,uBAAuB,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C,wHAAwH;IACxH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,6EAA6E;IAC7E,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,oDAAoD;IACpD,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,sBAAsB,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACpD,iBAAiB,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAiC;IACjD,IAAI,CAAC,EAAE,2BAA2B,CAAC;CACnC;AAED,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;CAClE;AAED,oBAAY,aAAa,GAAG,OAAO,GAAG,cAAc,CAAC;AACrD,oBAAY,MAAM,GAAG,sBAAsB,GAAG,aAAa,GAAG,KAAK,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,KAAK,EACX,sBAAsB,EACtB,KAAK,EACL,WAAW,EACX,OAAO,EACP,2BAA2B,EAC3B,YAAY,EACZ,YAAY,EACZ,IAAI,EACJ,YAAY,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;;GAIG;AACH,oBAAY,cAAc,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAErG;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAEpD;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEjC;;;;OAIG;IACH,GAAG,CAAC,EAAE,UAAU,CAAC;IAEjB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACnF;AAED,oBAAY,uBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AACzD,oBAAY,cAAc,GAAG,uBAAuB,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C,wHAAwH;IACxH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,6EAA6E;IAC7E,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,oDAAoD;IACpD,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,sBAAsB,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACpD,iBAAiB,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAiC;IACjD,IAAI,CAAC,EAAE,2BAA2B,CAAC;CACnC;AAED,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;CAClE;AAED,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,eAAe,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC/B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oBAAoB,CAAC,cAAc,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI,CAAC;CACnE;AAED,MAAM,WAAW,sBAAsB;IACtC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,2BAA2B,CAAC,qBAAqB,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI,CAAC;CACjF;AAED,oBAAY,6BAA6B,GAAG,eAAe,GAAG,sBAAsB,CAAC;AACrF,oBAAY,aAAa,GAAG,OAAO,GAAG,cAAc,CAAC;AACrD,oBAAY,MAAM,GAAG,sBAAsB,GAAG,aAAa,GAAG,KAAK,GAAG,2BAA2B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/plugin-i18next",
-  "version": "3.0.2-next.f0bab02.0",
+  "version": "3.1.0",
   "description": "Plugin for @sapphire/framework to support i18next.",
   "author": "@sapphire",
   "license": "MIT",
@@ -80,7 +80,7 @@
   "devDependencies": {
     "@favware/cliff-jumper": "^1.8.8",
     "gen-esm-wrapper": "^1.1.3",
-    "typedoc": "^0.23.15",
+    "typedoc": "^0.23.16",
     "typedoc-json-parser": "^6.0.0",
     "typescript": "^4.8.4"
   }