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

package/dist/cjs/lib/InternationalizationHandler.cjs

@@ -0,0 +1,236 @@
+'use strict';
+
+var framework = require('@sapphire/framework');
+var pieces = require('@sapphire/pieces');
+var utilities = require('@sapphire/utilities');
+var i18nextBackend = require('@skyra/i18next-backend');
+var i18next = require('i18next');
+var promises = require('fs/promises');
+var path = require('path');
+var url = require('url');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var i18next__default = /*#__PURE__*/_interopDefault(i18next);
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var _InternationalizationHandler = 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
+     */
+    __publicField(this, "languagesLoaded", false);
+    /**
+     * A `Set` of initially loaded namespaces.
+     * @since 1.2.0
+     */
+    __publicField(this, "namespaces", /* @__PURE__ */ new Set());
+    /**
+     * A `Map` of `i18next` language functions keyed by their language code.
+     * @since 1.0.0
+     */
+    __publicField(this, "languages", /* @__PURE__ */ new Map());
+    /**
+     * The options InternationalizationHandler was initialized with in the client.
+     * @since 1.0.0
+     */
+    __publicField(this, "options");
+    /**
+     * The director passed to `@skyra/i18next-backend`.
+     * Also used in {@link InternationalizationHandler.walkLanguageDirectory}.
+     * @since 1.2.0
+     */
+    __publicField(this, "languagesDirectory");
+    /**
+     * The backend options for `@skyra/i18next-backend` used by `i18next`.
+     * @since 1.0.0
+     */
+    __publicField(this, "backendOptions");
+    /**
+     * 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';
+     * };
+     * ```
+     */
+    __publicField(this, "fetchLanguage", /* @__PURE__ */ __name(() => null, "fetchLanguage"));
+    this.options = options ?? { i18next: { ignoreJSONStructure: false } };
+    const baseUserDirectory = pieces.container.client?.options?.baseUserDirectory instanceof url.URL ? url.fileURLToPath(pieces.container.client?.options?.baseUserDirectory) : pieces.container.client?.options?.baseUserDirectory;
+    this.languagesDirectory = this.options.defaultLanguageDirectory ?? path.join(baseUserDirectory ?? pieces.getRootData().root, "languages");
+    const languagePaths = /* @__PURE__ */ new Set([
+      path.join(this.languagesDirectory, "{{lng}}", "{{ns}}.json"),
+      //
+      ...options?.backend?.paths ?? []
+    ]);
+    this.backendOptions = {
+      paths: [...languagePaths],
+      ...this.options.backend
+    };
+    if (utilities.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 = utilities.isFunction(this.options.i18next) ? this.options.i18next(namespaces, languages) : this.options.i18next;
+    const ignoreJSONStructure = userOptions?.ignoreJSONStructure ?? false;
+    const skipOnVariables = userOptions?.interpolation?.skipOnVariables ?? false;
+    i18next__default.default.use(i18nextBackend.Backend);
+    await i18next__default.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__default.default.getFixedT(item));
+    }
+    this.languagesLoaded = true;
+    const formatters = this.options.formatters ?? [];
+    for (const { name, format } of formatters) {
+      i18next__default.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 = /* @__PURE__ */ new Set();
+    const namespaces = /* @__PURE__ */ new Set();
+    const dir = await promises.opendir(directory);
+    for await (const entry of dir) {
+      if (!entry.isDirectory())
+        continue;
+      languages.add(entry.name);
+      for await (const namespace of this.walkLocaleDirectory(path.join(dir.path, entry.name), "")) {
+        namespaces.add(namespace);
+      }
+    }
+    return { namespaces: [...namespaces], languages: [...languages] };
+  }
+  async reloadResources() {
+    const result = await framework.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 ??= languageDirectoryResult.languages;
+        namespaces ??= languageDirectoryResult.namespaces;
+      }
+      await i18next__default.default.reloadResources(languages, namespaces);
+      pieces.container.logger.info("[i18next-Plugin] Reloaded language resources.");
+    });
+    result.inspectErr((error) => pieces.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 promises.opendir(directory);
+    for await (const entry of dir) {
+      if (entry.isDirectory()) {
+        yield* this.walkLocaleDirectory(path.join(dir.path, entry.name), `${ns}${entry.name}/`);
+      } else if (entry.isFile() && entry.name.endsWith(".json")) {
+        yield `${ns}${entry.name.slice(0, -5)}`;
+      }
+    }
+  }
+};
+__name(_InternationalizationHandler, "InternationalizationHandler");
+var InternationalizationHandler = _InternationalizationHandler;
+
+exports.InternationalizationHandler = InternationalizationHandler;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=InternationalizationHandler.cjs.map

package/dist/cjs/lib/InternationalizationHandler.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/InternationalizationHandler.ts"],"names":[],"mappings":";;;;;;;;;AAAA,SAAS,cAAc;AACvB,SAAS,WAAW,mBAAmB;AACvC,SAAS,kBAAkC;AAC3C,SAAS,eAAoC;AAC7C,OAAO,aASA;AAEP,SAAS,eAAe;AACxB,SAAS,YAAY;AACrB,SAAS,KAAK,qBAAqB;AAO5B,IAAM,+BAAN,MAAM,6BAA4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA2CjC,YAAY,SAAuC;AAtC1D;AAAA;AAAA;AAAA;AAAA,wBAAO,mBAAkB;AAMzB;AAAA;AAAA;AAAA;AAAA,wBAAO,cAAa,oBAAI,IAAY;AAMpC;AAAA;AAAA;AAAA;AAAA,wBAAgB,aAAY,oBAAI,IAAuB;AAMvD;AAAA;AAAA;AAAA;AAAA,wBAAgB;AAOhB;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAgB;AAMhB;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAqEnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAO,iBAAoF,6BAAM,MAAN;AA7D1F,SAAK,UAAU,WAAW,EAAE,SAAS,EAAE,qBAAqB,MAAM,EAAE;AAEpE,UAAM,oBACL,UAAU,QAAQ,SAAS,6BAA6B,MACrD,cAAc,UAAU,QAAQ,SAAS,iBAAiB,IAC1D,UAAU,QAAQ,SAAS;AAE/B,SAAK,qBAAqB,KAAK,QAAQ,4BAA4B,KAAK,qBAAqB,YAAY,EAAE,MAAM,WAAW;AAE5H,UAAM,gBAAgB,oBAAI,IAAoB;AAAA,MAC7C,KAAK,KAAK,oBAAoB,WAAW,aAAa;AAAA;AAAA,MACtD,GAAI,SAAS,SAAS,SAAS,CAAC;AAAA,IACjC,CAAC;AAED,SAAK,iBAAiB;AAAA,MACrB,OAAO,CAAC,GAAG,aAAa;AAAA,MACxB,GAAG,KAAK,QAAQ;AAAA,IACjB;AAEA,QAAI,WAAW,KAAK,QAAQ,aAAa,GAAG;AAC3C,WAAK,gBAAgB,KAAK,QAAQ;AAAA,IACnC;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA,EA6CA,MAAa,OAAO;AACnB,UAAM,EAAE,YAAY,UAAU,IAAI,MAAM,KAAK,kBAAkB,KAAK,kBAAkB;AACtF,UAAM,cAAc,WAAW,KAAK,QAAQ,OAAO,IAAI,KAAK,QAAQ,QAAQ,YAAY,SAAS,IAAI,KAAK,QAAQ;AAClH,UAAM,sBAAsB,aAAa,uBAAuB;AAChE,UAAM,kBAAkB,aAAa,eAAe,mBAAmB;AAEvE,YAAQ,IAAI,OAAO;AACnB,UAAM,QAAQ,KAAK;AAAA,MAClB,SAAS,KAAK;AAAA,MACd,aAAa,KAAK,QAAQ,eAAe;AAAA,MACzC,eAAe;AAAA,MACf,eAAe;AAAA,QACd,aAAa;AAAA,QACb,GAAG,aAAa;AAAA,QAChB;AAAA,MACD;AAAA,MACA,MAAM;AAAA,MACN,WAAW;AAAA,MACX,IAAI;AAAA,MACJ,SAAS;AAAA,MACT,GAAG;AAAA,MACH;AAAA,IACD,CAAC;AAED,SAAK,aAAa,IAAI,IAAI,UAAU;AACpC,eAAW,QAAQ,WAAW;AAC7B,WAAK,UAAU,IAAI,MAAM,QAAQ,UAAU,IAAI,CAAC;AAAA,IACjD;AACA,SAAK,kBAAkB;AAEvB,UAAM,aAAa,KAAK,QAAQ,cAAc,CAAC;AAC/C,eAAW,EAAE,MAAM,OAAO,KAAK,YAAY;AAC1C,cAAQ,SAAS,UAAW,IAAI,MAAM,MAAM;AAAA,IAC7C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,KAAK,QAAgB;AAC3B,QAAI,CAAC,KAAK;AAAiB,YAAM,IAAI,MAAM,gFAAgF;AAE3H,UAAM,IAAI,KAAK,UAAU,IAAI,MAAM;AACnC,QAAI;AAAG,aAAO;AACd,UAAM,IAAI,eAAe,2BAA2B;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWO,OAON,WACG,CAAC,KAAK,uBAAuB,kBAAkB,GAIN;AAC5C,QAAI,CAAC,KAAK;AAAiB,YAAM,IAAI,MAAM,gFAAgF;AAE3H,UAAM,WAAW,KAAK,UAAU,IAAI,MAAM;AAC1C,QAAI,CAAC;AAAU,YAAM,IAAI,eAAe,2BAA2B;AAEnE,UAAM,eACL,OAAO,0BAA0B,WAC9B,wBACA,KAAK,QAAQ,oBACX,SAAS,KAAK,QAAQ,mBAAmB,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,IAC7D;AAEN,WAAO,SAAwC,KAAK,cAAc,kBAAkB;AAAA,EACrF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAa,kBAAkB,WAAqB;AACnD,UAAM,YAAY,oBAAI,IAAY;AAClC,UAAM,aAAa,oBAAI,IAAY;AAEnC,UAAM,MAAM,MAAM,QAAQ,SAAS;AACnC,qBAAiB,SAAS,KAAK;AAE9B,UAAI,CAAC,MAAM,YAAY;AAAG;AAG1B,gBAAU,IAAI,MAAM,IAAI;AAExB,uBAAiB,aAAa,KAAK,oBAAoB,KAAK,IAAI,MAAM,MAAM,IAAI,GAAG,EAAE,GAAG;AACvF,mBAAW,IAAI,SAAS;AAAA,MACzB;AAAA,IACD;AAEA,WAAO,EAAE,YAAY,CAAC,GAAG,UAAU,GAAG,WAAW,CAAC,GAAG,SAAS,EAAE;AAAA,EACjE;AAAA,EAEA,MAAa,kBAAkB;AAC9B,UAAM,SAAS,MAAM,OAAO,UAAU,YAAY;AACjD,UAAI,YAAY,KAAK,QAAQ,KAAK;AAClC,UAAI,aAAa,KAAK,QAAQ,KAAK;AACnC,UAAI,CAAC,aAAa,CAAC,YAAY;AAC9B,cAAM,0BAA0B,MAAM,KAAK,kBAAkB,KAAK,kBAAkB;AACpF,sBAAc,wBAAwB;AACtC,uBAAe,wBAAwB;AAAA,MACxC;AAEA,YAAM,QAAQ,gBAAgB,WAAW,UAAU;AACnD,gBAAU,OAAO,KAAK,+CAA+C;AAAA,IACtE,CAAC;AAED,WAAO,WAAW,CAAC,UAAU,UAAU,OAAO,MAAM,0DAA0D,KAAK,CAAC;AAAA,EACrH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAe,oBAAoB,WAAmB,IAAoC;AACzF,UAAM,MAAM,MAAM,QAAQ,SAAS;AACnC,qBAAiB,SAAS,KAAK;AAC9B,UAAI,MAAM,YAAY,GAAG;AACxB,eAAO,KAAK,oBAAoB,KAAK,IAAI,MAAM,MAAM,IAAI,GAAG,GAAG,EAAE,GAAG,MAAM,IAAI,GAAG;AAAA,MAClF,WAAW,MAAM,OAAO,KAAK,MAAM,KAAK,SAAS,OAAO,GAAG;AAC1D,cAAM,GAAG,EAAE,GAAG,MAAM,KAAK,MAAM,GAAG,EAAE,CAAC;AAAA,MACtC;AAAA,IACD;AAAA,EACD;AACD;AA9PyC;AAAlC,IAAM,8BAAN","sourcesContent":["import { Result } from '@sapphire/framework';\nimport { container, getRootData } from '@sapphire/pieces';\nimport { isFunction, type Awaitable } from '@sapphire/utilities';\nimport { Backend, type PathResolvable } from '@skyra/i18next-backend';\nimport i18next, {\n\ttype AppendKeyPrefix,\n\ttype InterpolationMap,\n\ttype Namespace,\n\ttype ParseKeys,\n\ttype TFunction,\n\ttype TFunctionReturn,\n\ttype TFunctionReturnOptionalDetails,\n\ttype TOptions\n} from 'i18next';\nimport type { PathLike } from 'node:fs';\nimport { opendir } from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { URL, fileURLToPath } from 'node:url';\nimport type { $Dictionary, InternationalizationContext, InternationalizationOptions } from './types';\n\n/**\n * A generalized class for handling `i18next` JSON files and their discovery.\n * @since 1.0.0\n */\nexport class InternationalizationHandler {\n\t/**\n\t * Describes whether {@link InternationalizationHandler.init} has been run and languages are loaded in {@link InternationalizationHandler.languages}.\n\t * @since 1.0.0\n\t */\n\tpublic languagesLoaded = false;\n\n\t/**\n\t * A `Set` of initially loaded namespaces.\n\t * @since 1.2.0\n\t */\n\tpublic namespaces = new Set<string>();\n\n\t/**\n\t * A `Map` of `i18next` language functions keyed by their language code.\n\t * @since 1.0.0\n\t */\n\tpublic readonly languages = new Map<string, TFunction>();\n\n\t/**\n\t * The options InternationalizationHandler was initialized with in the client.\n\t * @since 1.0.0\n\t */\n\tpublic readonly options: InternationalizationOptions;\n\n\t/**\n\t * The director passed to `@skyra/i18next-backend`.\n\t * Also used in {@link InternationalizationHandler.walkLanguageDirectory}.\n\t * @since 1.2.0\n\t */\n\tpublic readonly languagesDirectory: string;\n\n\t/**\n\t * The backend options for `@skyra/i18next-backend` used by `i18next`.\n\t * @since 1.0.0\n\t */\n\tprotected readonly backendOptions: Backend.Options;\n\n\t/**\n\t * @param options The options that `i18next`, `@skyra/i18next-backend`, and {@link InternationalizationHandler} should use.\n\t * @since 1.0.0\n\t * @constructor\n\t */\n\tpublic constructor(options?: InternationalizationOptions) {\n\t\tthis.options = options ?? { i18next: { ignoreJSONStructure: false } };\n\n\t\tconst baseUserDirectory =\n\t\t\tcontainer.client?.options?.baseUserDirectory instanceof URL\n\t\t\t\t? fileURLToPath(container.client?.options?.baseUserDirectory)\n\t\t\t\t: container.client?.options?.baseUserDirectory;\n\n\t\tthis.languagesDirectory = this.options.defaultLanguageDirectory ?? join(baseUserDirectory ?? getRootData().root, 'languages');\n\n\t\tconst languagePaths = new Set<PathResolvable>([\n\t\t\tjoin(this.languagesDirectory, '{{lng}}', '{{ns}}.json'), //\n\t\t\t...(options?.backend?.paths ?? [])\n\t\t]);\n\n\t\tthis.backendOptions = {\n\t\t\tpaths: [...languagePaths],\n\t\t\t...this.options.backend\n\t\t};\n\n\t\tif (isFunction(this.options.fetchLanguage)) {\n\t\t\tthis.fetchLanguage = this.options.fetchLanguage;\n\t\t}\n\t}\n\n\t/**\n\t * The method to be overridden by the developer.\n\t *\n\t * @note In the event that fetchLanguage is not defined or returns null / undefined, the defaulting from {@link fetchLanguage} will be used.\n\t * @since 2.0.0\n\t * @return A string for the desired language or null for no match.\n\t * @see {@link fetchLanguage}\n\t * @example\n\t * ```typescript\n\t * // Always use the same language (no per-guild configuration):\n\t * container.i18n.fetchLanguage = () => 'en-US';\n\t * ```\n\t * @example\n\t * ```typescript\n\t * // Retrieving the language from an SQL database:\n\t * container.i18n.fetchLanguage = async (context) => {\n\t *   const guild = await driver.getOne('SELECT language FROM public.guild WHERE id = $1', [context.guild.id]);\n\t *   return guild?.language ?? 'en-US';\n\t * };\n\t * ```\n\t * @example\n\t * ```typescript\n\t * // Retrieving the language from an ORM:\n\t * container.i18n.fetchLanguage = async (context) => {\n\t *   const guild = await driver.getRepository(GuildEntity).findOne({ id: context.guild.id });\n\t *   return guild?.language ?? 'en-US';\n\t * };\n\t * ```\n\t * @example\n\t * ```typescript\n\t * // Retrieving the language on a per channel basis, e.g. per user or guild channel (ORM example but same principles apply):\n\t * container.i18n.fetchLanguage = async (context) => {\n\t *   const channel = await driver.getRepository(ChannelEntity).findOne({ id: context.channel.id });\n\t *   return channel?.language ?? 'en-US';\n\t * };\n\t * ```\n\t */\n\tpublic fetchLanguage: (context: InternationalizationContext) => Awaitable<string | null> = () => null;\n\n\t/**\n\t * Initializes the handler by loading in the namespaces, passing the data to i18next, and filling in the {@link InternationalizationHandler#languages}.\n\t * @since 1.0.0\n\t */\n\tpublic async init() {\n\t\tconst { namespaces, languages } = await this.walkRootDirectory(this.languagesDirectory);\n\t\tconst userOptions = isFunction(this.options.i18next) ? this.options.i18next(namespaces, languages) : this.options.i18next;\n\t\tconst ignoreJSONStructure = userOptions?.ignoreJSONStructure ?? false;\n\t\tconst skipOnVariables = userOptions?.interpolation?.skipOnVariables ?? false;\n\n\t\ti18next.use(Backend);\n\t\tawait i18next.init({\n\t\t\tbackend: this.backendOptions,\n\t\t\tfallbackLng: this.options.defaultName ?? 'en-US',\n\t\t\tinitImmediate: false,\n\t\t\tinterpolation: {\n\t\t\t\tescapeValue: false,\n\t\t\t\t...userOptions?.interpolation,\n\t\t\t\tskipOnVariables\n\t\t\t},\n\t\t\tload: 'all',\n\t\t\tdefaultNS: 'default',\n\t\t\tns: namespaces,\n\t\t\tpreload: languages,\n\t\t\t...userOptions,\n\t\t\tignoreJSONStructure\n\t\t});\n\n\t\tthis.namespaces = new Set(namespaces);\n\t\tfor (const item of languages) {\n\t\t\tthis.languages.set(item, i18next.getFixedT(item));\n\t\t}\n\t\tthis.languagesLoaded = true;\n\n\t\tconst formatters = this.options.formatters ?? [];\n\t\tfor (const { name, format } of formatters) {\n\t\t\ti18next.services.formatter!.add(name, format);\n\t\t}\n\t}\n\n\t/**\n\t * Retrieve a raw TFunction from the passed locale.\n\t * @param locale The language to be used.\n\t * @since 1.0.0\n\t */\n\tpublic getT(locale: string) {\n\t\tif (!this.languagesLoaded) throw new Error('Cannot call this method until InternationalizationHandler#init has been called');\n\n\t\tconst t = this.languages.get(locale);\n\t\tif (t) return t;\n\t\tthrow new ReferenceError('Invalid language provided');\n\t}\n\n\t/**\n\t * Localizes a content given one or more keys and i18next options.\n\t * @since 2.0.0\n\t * @param locale The language to be used.\n\t * @param key The key or keys to retrieve the content from.\n\t * @param options The interpolation options.\n\t * @see {@link https://www.i18next.com/overview/api#t}\n\t * @returns The localized content.\n\t */\n\tpublic format<\n\t\tconst Key extends ParseKeys<Ns, TOpt, undefined>,\n\t\tconst TOpt extends TOptions,\n\t\tNs extends Namespace,\n\t\tRet extends TFunctionReturn<Ns, AppendKeyPrefix<Key, undefined>, TOpt>,\n\t\tconst ActualOptions extends TOpt & InterpolationMap<Ret> = TOpt & InterpolationMap<Ret>\n\t>(\n\t\tlocale: string,\n\t\t...[key, defaultValueOrOptions, optionsOrUndefined]:\n\t\t\t| [key: Key | Key[], options?: ActualOptions]\n\t\t\t| [key: string | string[], options: TOpt & $Dictionary & { defaultValue: string }]\n\t\t\t| [key: string | string[], defaultValue: string | undefined, options?: TOpt & $Dictionary]\n\t): TFunctionReturnOptionalDetails<Ret, TOpt> {\n\t\tif (!this.languagesLoaded) throw new Error('Cannot call this method until InternationalizationHandler#init has been called');\n\n\t\tconst language = this.languages.get(locale);\n\t\tif (!language) throw new ReferenceError('Invalid language provided');\n\n\t\tconst defaultValue =\n\t\t\ttypeof defaultValueOrOptions === 'string'\n\t\t\t\t? defaultValueOrOptions\n\t\t\t\t: this.options.defaultMissingKey\n\t\t\t\t  ? language(this.options.defaultMissingKey, { replace: { key } })\n\t\t\t\t  : '';\n\n\t\treturn language<Key, TOpt, Ret, ActualOptions>(key, defaultValue, optionsOrUndefined);\n\t}\n\n\t/**\n\t * @param directory The directory that should be walked.\n\t * @since 3.0.0\n\t */\n\tpublic async walkRootDirectory(directory: PathLike) {\n\t\tconst languages = new Set<string>();\n\t\tconst namespaces = new Set<string>();\n\n\t\tconst dir = await opendir(directory);\n\t\tfor await (const entry of dir) {\n\t\t\t// If the entry is not a directory, skip:\n\t\t\tif (!entry.isDirectory()) continue;\n\n\t\t\t// Load the directory:\n\t\t\tlanguages.add(entry.name);\n\n\t\t\tfor await (const namespace of this.walkLocaleDirectory(join(dir.path, entry.name), '')) {\n\t\t\t\tnamespaces.add(namespace);\n\t\t\t}\n\t\t}\n\n\t\treturn { namespaces: [...namespaces], languages: [...languages] };\n\t}\n\n\tpublic async reloadResources() {\n\t\tconst result = await Result.fromAsync(async () => {\n\t\t\tlet languages = this.options.hmr?.languages;\n\t\t\tlet namespaces = this.options.hmr?.namespaces;\n\t\t\tif (!languages || !namespaces) {\n\t\t\t\tconst languageDirectoryResult = await this.walkRootDirectory(this.languagesDirectory);\n\t\t\t\tlanguages ??= languageDirectoryResult.languages;\n\t\t\t\tnamespaces ??= languageDirectoryResult.namespaces;\n\t\t\t}\n\n\t\t\tawait i18next.reloadResources(languages, namespaces);\n\t\t\tcontainer.logger.info('[i18next-Plugin] Reloaded language resources.');\n\t\t});\n\n\t\tresult.inspectErr((error) => container.logger.error('[i18next-Plugin]: Failed to reload language resources.', error));\n\t}\n\n\t/**\n\t * @description Skips any files that don't end with `.json`.\n\t * @param directory The directory that should be walked.\n\t * @param ns The current namespace.\n\t * @since 3.0.0\n\t */\n\tprivate async *walkLocaleDirectory(directory: string, ns: string): AsyncGenerator<string> {\n\t\tconst dir = await opendir(directory);\n\t\tfor await (const entry of dir) {\n\t\t\tif (entry.isDirectory()) {\n\t\t\t\tyield* this.walkLocaleDirectory(join(dir.path, entry.name), `${ns}${entry.name}/`);\n\t\t\t} else if (entry.isFile() && entry.name.endsWith('.json')) {\n\t\t\t\tyield `${ns}${entry.name.slice(0, -5)}`;\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/cjs/lib/functions.cjs

@@ -0,0 +1,125 @@
+'use strict';
+
+var pieces = require('@sapphire/pieces');
+var utilities = require('@sapphire/utilities');
+var discord_js = require('discord.js');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function fetchLanguage(target) {
+  if (target instanceof discord_js.BaseInteraction) {
+    return resolveLanguage({
+      user: target.user,
+      channel: target.channel,
+      guild: target.guild,
+      interactionGuildLocale: target.guildLocale,
+      interactionLocale: target.locale
+    });
+  }
+  if (target instanceof discord_js.Message) {
+    return resolveLanguage({ user: target.author, channel: target.channel, guild: target.guild });
+  }
+  if (target instanceof discord_js.Guild) {
+    return resolveLanguage({ user: null, channel: null, guild: target });
+  }
+  if (target.type === discord_js.ChannelType.DM) {
+    return resolveLanguage({ user: null, channel: target, guild: null });
+  }
+  return resolveLanguage({ user: null, channel: target, guild: target.guild });
+}
+__name(fetchLanguage, "fetchLanguage");
+async function fetchT(target) {
+  return pieces.container.i18n.getT(await fetchLanguage(target));
+}
+__name(fetchT, "fetchT");
+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.container.i18n.format(language, key, defaultValueOrOptions, optionsOrUndefined);
+  }
+  return pieces.container.i18n.format(language, key, void 0, defaultValueOrOptions);
+}
+__name(resolveKey, "resolveKey");
+async function resolveLanguage(context) {
+  const lang = await pieces.container.i18n.fetchLanguage(context);
+  return lang ?? context.guild?.preferredLocale ?? pieces.container.i18n.options.defaultName ?? "en-US";
+}
+__name(resolveLanguage, "resolveLanguage");
+var supportedLanguages = new Set(Object.values(discord_js.Locale));
+function isSupportedDiscordLocale(language) {
+  return supportedLanguages.has(language);
+}
+__name(isSupportedDiscordLocale, "isSupportedDiscordLocale");
+var getLocales = utilities.lazy(() => {
+  const locales = new Map(pieces.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;
+});
+var getDefaultT = utilities.lazy(() => {
+  const defaultLocale = pieces.container.i18n.options.defaultName ?? "en-US";
+  if (!isSupportedDiscordLocale(defaultLocale)) {
+    throw new TypeError(`Unsupported Discord locale found:
+'${defaultLocale}' is not within the list of ${[...supportedLanguages]}`);
+  }
+  const defaultT = getLocales().get(defaultLocale);
+  if (defaultT) {
+    return defaultT;
+  }
+  throw new TypeError(`Could not find ${defaultLocale}`);
+});
+function getLocalizedData(key) {
+  const locales = getLocales();
+  const defaultT = getDefaultT();
+  return {
+    value: defaultT(key),
+    localizations: Object.fromEntries(Array.from(locales, ([locale, t]) => [locale, t(key)]))
+  };
+}
+__name(getLocalizedData, "getLocalizedData");
+function applyNameLocalizedBuilder(builder, key) {
+  const result = getLocalizedData(key);
+  return builder.setName(result.value).setNameLocalizations(result.localizations);
+}
+__name(applyNameLocalizedBuilder, "applyNameLocalizedBuilder");
+function applyDescriptionLocalizedBuilder(builder, key) {
+  const result = getLocalizedData(key);
+  return builder.setDescription(result.value).setDescriptionLocalizations(result.localizations);
+}
+__name(applyDescriptionLocalizedBuilder, "applyDescriptionLocalizedBuilder");
+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;
+}
+__name(applyLocalizedBuilder, "applyLocalizedBuilder");
+function createLocalizedChoice(key, options) {
+  const result = getLocalizedData(key);
+  return {
+    ...options,
+    name: result.value,
+    name_localizations: result.localizations
+  };
+}
+__name(createLocalizedChoice, "createLocalizedChoice");
+
+exports.applyDescriptionLocalizedBuilder = applyDescriptionLocalizedBuilder;
+exports.applyLocalizedBuilder = applyLocalizedBuilder;
+exports.applyNameLocalizedBuilder = applyNameLocalizedBuilder;
+exports.createLocalizedChoice = createLocalizedChoice;
+exports.fetchLanguage = fetchLanguage;
+exports.fetchT = fetchT;
+exports.getLocalizedData = getLocalizedData;
+exports.resolveKey = resolveKey;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=functions.cjs.map

package/dist/cjs/lib/functions.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/functions.ts"],"names":[],"mappings":";;;;AAAA,SAAS,iBAAiB;AAC1B,SAAS,YAAY;AACrB,SAAS,iBAAiB,aAAa,OAAO,QAAQ,eAA0E;AAkCzH,SAAS,cAAc,QAAiC;AAE9D,MAAI,kBAAkB,iBAAiB;AACtC,WAAO,gBAAgB;AAAA,MACtB,MAAM,OAAO;AAAA,MACb,SAAS,OAAO;AAAA,MAChB,OAAO,OAAO;AAAA,MACd,wBAAwB,OAAO;AAAA,MAC/B,mBAAmB,OAAO;AAAA,IAC3B,CAAC;AAAA,EACF;AAGA,MAAI,kBAAkB,SAAS;AAC9B,WAAO,gBAAgB,EAAE,MAAM,OAAO,QAAQ,SAAS,OAAO,SAAS,OAAO,OAAO,MAAM,CAAC;AAAA,EAC7F;AAGA,MAAI,kBAAkB,OAAO;AAC5B,WAAO,gBAAgB,EAAE,MAAM,MAAM,SAAS,MAAM,OAAO,OAAO,CAAC;AAAA,EACpE;AAGA,MAAI,OAAO,SAAS,YAAY,IAAI;AACnC,WAAO,gBAAgB,EAAE,MAAM,MAAM,SAAS,QAAQ,OAAO,KAAK,CAAC;AAAA,EACpE;AAGA,SAAO,gBAAgB,EAAE,MAAM,MAAM,SAAS,QAAQ,OAAO,OAAO,MAAM,CAAC;AAC5E;AA7BgB;AAqChB,eAAsB,OAAO,QAAgB;AAC5C,SAAO,UAAU,KAAK,KAAK,MAAM,cAAc,MAAM,CAAC;AACvD;AAFsB;AAYtB,eAAsB,WAOrB,WACG,CAAC,KAAK,uBAAuB,kBAAkB,GAIG;AACrD,QAAM,gBAAgB,OAAO,0BAA0B,WAAW,qBAAqB;AACvF,QAAM,WAAW,OAAO,eAAe,QAAQ,WAAW,cAAc,MAAM,MAAM,cAAc,MAAM;AAExG,MAAI,OAAO,0BAA0B,UAAU;AAC9C,WAAO,UAAU,KAAK,OAA0C,UAAU,KAAK,uBAAuB,kBAAkB;AAAA,EACzH;AAEA,SAAO,UAAU,KAAK,OAA0C,UAAU,KAAK,QAAW,qBAAqB;AAChH;AArBsB;AA0BtB,eAAe,gBAAgB,SAAuD;AACrF,QAAM,OAAO,MAAM,UAAU,KAAK,cAAc,OAAO;AACvD,SAAO,QAAQ,QAAQ,OAAO,mBAAmB,UAAU,KAAK,QAAQ,eAAe;AACxF;AAHe;AAKf,IAAM,qBAAqB,IAAI,IAAI,OAAO,OAAO,MAAM,CAAC;AAExD,SAAS,yBAAyB,UAA4C;AAC7E,SAAO,mBAAmB,IAAI,QAAwB;AACvD;AAFS;AAIT,IAAM,aAAa,KAAK,MAAM;AAC7B,QAAM,UAAU,IAAI,IAAI,UAAU,KAAK,SAAS;AAEhD,aAAW,CAAC,MAAM,KAAK,SAAS;AAC/B,QAAI,CAAC,yBAAyB,MAAM,GAAG;AACtC,cAAQ,YAAY,8BAA8B;AAAA,QACjD,MAAM;AAAA,QACN,QAAQ,IAAI,MAAM,yBAAyB,CAAC,GAAG,QAAQ,KAAK,CAAC,CAAC;AAAA,MAC/D,CAAC;AAED,cAAQ,OAAO,MAAM;AAAA,IACtB;AAEA;AAAA,EACD;AAEA,SAAO;AACR,CAAC;AAED,IAAM,cAAc,KAAK,MAAM;AAC9B,QAAM,gBAAgB,UAAU,KAAK,QAAQ,eAAe;AAE5D,MAAI,CAAC,yBAAyB,aAAa,GAAG;AAC7C,UAAM,IAAI,UAAU;AAAA,GAAuC,aAAa,+BAA+B,CAAC,GAAG,kBAAkB,CAAC,EAAE;AAAA,EACjI;AAEA,QAAM,WAAW,WAAW,EAAE,IAAI,aAAa;AAE/C,MAAI,UAAU;AACb,WAAO;AAAA,EACR;AAEA,QAAM,IAAI,UAAU,kBAAkB,aAAa,EAAE;AACtD,CAAC;AAQM,SAAS,iBACf,KACgB;AAChB,QAAM,UAAU,WAAW;AAC3B,QAAM,WAAW,YAAY;AAE7B,SAAO;AAAA,IACN,OAAO,SAAS,GAAG;AAAA,IACnB,eAAe,OAAO,YAAY,MAAM,KAAK,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAAA,EACzF;AACD;AAVgB;AAkBT,SAAS,0BAKd,SAAY,KAAmC;AAChD,QAAM,SAAS,iBAAiB,GAAG;AACnC,SAAO,QAAQ,QAAQ,OAAO,KAAK,EAAE,qBAAqB,OAAO,aAAa;AAC/E;AARgB;AAgBT,SAAS,iCAKd,SAAY,KAAmC;AAChD,QAAM,SAAS,iBAAiB,GAAG;AACnC,SAAO,QAAQ,eAAe,OAAO,KAAK,EAAE,4BAA4B,OAAO,aAAa;AAC7F;AARgB;AA8DT,SAAS,sBAKd,YAAe,QAA6G;AAG7H,QAAM,CAAC,YAAY,iBAAiB,IACnC,OAAO,WAAW,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,QAAyB,GAAG,OAAO,CAAC,CAAC,aAA8B,IAAI;AAE3G,4BAA0B,SAAS,UAAU;AAC7C,mCAAiC,SAAS,iBAAiB;AAE3D,SAAO;AACR;AAfgB;AA4CT,SAAS,sBAMf,KACA,SAC+C;AAC/C,QAAM,SAAS,iBAAiB,GAAG;AAEnC,SAAO;AAAA,IACN,GAAG;AAAA,IACH,MAAM,OAAO;AAAA,IACb,oBAAoB,OAAO;AAAA,EAC5B;AACD;AAhBgB","sourcesContent":["import { container } from '@sapphire/pieces';\nimport { lazy } from '@sapphire/utilities';\nimport { BaseInteraction, ChannelType, Guild, Locale, Message, type APIApplicationCommandOptionChoice, type LocaleString } from 'discord.js';\nimport type {\n\tAppendKeyPrefix,\n\tDefaultNamespace,\n\tInterpolationMap,\n\tNamespace,\n\tParseKeys,\n\tTFunctionReturn,\n\tTFunctionReturnOptionalDetails,\n\tTOptions\n} from 'i18next';\nimport type {\n\t$Dictionary,\n\t$SpecialObject,\n\tBuilderWithDescription,\n\tBuilderWithName,\n\tBuilderWithNameAndDescription,\n\tInternationalizationContext,\n\tLocalizedData,\n\tTarget\n} from './types';\n\n/**\n * Retrieves the language name for a specific target, using {@link InternationalizationHandler.fetchLanguage}.\n * If {@link InternationalizationHandler.fetchLanguage} is not defined or this function returns a nullish value,\n * then there will be a series of fallback attempts in the following descending order:\n * 1. Returns {@link Guild.preferredLocale}.\n * 2. Returns {@link InternationalizationOptions.defaultName} if no guild was provided.\n * 3. Returns `'en-US'` if nothing else was found.\n * @since 2.0.0\n * @param target The target to fetch the language from.\n * @see {@link resolveLanguage}\n * @returns The name of the language key.\n */\nexport function fetchLanguage(target: Target): Promise<string> {\n\t// Handle Interactions:\n\tif (target instanceof BaseInteraction) {\n\t\treturn resolveLanguage({\n\t\t\tuser: target.user,\n\t\t\tchannel: target.channel,\n\t\t\tguild: target.guild,\n\t\t\tinteractionGuildLocale: target.guildLocale,\n\t\t\tinteractionLocale: target.locale\n\t\t});\n\t}\n\n\t// Handle Message:\n\tif (target instanceof Message) {\n\t\treturn resolveLanguage({ user: target.author, channel: target.channel, guild: target.guild });\n\t}\n\n\t// Handle Guild:\n\tif (target instanceof Guild) {\n\t\treturn resolveLanguage({ user: null, channel: null, guild: target });\n\t}\n\n\t// Handle DMChannel:\n\tif (target.type === ChannelType.DM) {\n\t\treturn resolveLanguage({ user: null, channel: target, guild: null });\n\t}\n\n\t// Handle any other channel:\n\treturn resolveLanguage({ user: null, channel: target, guild: target.guild });\n}\n\n/**\n * Retrieves the language-assigned function from i18next designated to a target's preferred language code.\n * @since 2.0.0\n * @param target The target to fetch the language from.\n * @returns The language function from i18next.\n */\nexport async function fetchT(target: Target) {\n\treturn container.i18n.getT(await fetchLanguage(target));\n}\n\n/**\n * Resolves a key and its parameters.\n * @since 2.0.0\n * @param target The target to fetch the language key from.\n * @param key The i18next key.\n * @param options The options to be passed to TFunction.\n * @returns The data that `key` held, processed by i18next.\n */\nexport async function resolveKey<\n\tconst Key extends ParseKeys<Ns, TOpt, undefined>,\n\tconst TOpt extends TOptions = TOptions,\n\tRet extends TFunctionReturn<Ns, AppendKeyPrefix<Key, undefined>, TOpt> = TOpt['returnObjects'] extends true ? $SpecialObject : string,\n\tNs extends Namespace = DefaultNamespace,\n\tconst ActualOptions extends TOpt & InterpolationMap<Ret> = TOpt & InterpolationMap<Ret>\n>(\n\ttarget: Target,\n\t...[key, defaultValueOrOptions, optionsOrUndefined]:\n\t\t| [key: Key | Key[], options?: ActualOptions]\n\t\t| [key: string | string[], options: TOpt & $Dictionary & { defaultValue: string }]\n\t\t| [key: string | string[], defaultValue: string, options?: TOpt & $Dictionary]\n): Promise<TFunctionReturnOptionalDetails<Ret, TOpt>> {\n\tconst parsedOptions = typeof defaultValueOrOptions === 'string' ? optionsOrUndefined : defaultValueOrOptions;\n\tconst language = typeof parsedOptions?.lng === 'string' ? parsedOptions.lng : await fetchLanguage(target);\n\n\tif (typeof defaultValueOrOptions === 'string') {\n\t\treturn container.i18n.format<Key, TOpt, Ns, Ret, ActualOptions>(language, key, defaultValueOrOptions, optionsOrUndefined);\n\t}\n\n\treturn container.i18n.format<Key, TOpt, Ns, Ret, ActualOptions>(language, key, undefined, defaultValueOrOptions);\n}\n\n/**\n * @internal\n */\nasync function resolveLanguage(context: InternationalizationContext): Promise<string> {\n\tconst lang = await container.i18n.fetchLanguage(context);\n\treturn lang ?? context.guild?.preferredLocale ?? container.i18n.options.defaultName ?? 'en-US';\n}\n\nconst supportedLanguages = new Set(Object.values(Locale)) as ReadonlySet<LocaleString>;\n\nfunction isSupportedDiscordLocale(language: string): language is LocaleString {\n\treturn supportedLanguages.has(language as LocaleString);\n}\n\nconst getLocales = lazy(() => {\n\tconst locales = new Map(container.i18n.languages);\n\n\tfor (const [locale] of locales) {\n\t\tif (!isSupportedDiscordLocale(locale)) {\n\t\t\tprocess.emitWarning('Unsupported Discord locale', {\n\t\t\t\tcode: 'UNSUPPORTED_LOCALE',\n\t\t\t\tdetail: `'${locale}' needs to be one of: ${[...locales.keys()]}`\n\t\t\t});\n\n\t\t\tlocales.delete(locale);\n\t\t}\n\n\t\tcontinue;\n\t}\n\n\treturn locales;\n});\n\nconst getDefaultT = lazy(() => {\n\tconst defaultLocale = container.i18n.options.defaultName ?? 'en-US';\n\n\tif (!isSupportedDiscordLocale(defaultLocale)) {\n\t\tthrow new TypeError(`Unsupported Discord locale found:\\n'${defaultLocale}' is not within the list of ${[...supportedLanguages]}`);\n\t}\n\n\tconst defaultT = getLocales().get(defaultLocale);\n\n\tif (defaultT) {\n\t\treturn defaultT;\n\t}\n\n\tthrow new TypeError(`Could not find ${defaultLocale}`);\n});\n\n/**\n * Gets the value and the localizations from a language key.\n * @param key The key to get the localizations from.\n * @returns The retrieved data.\n * @remarks This should be called **strictly** after loading the locales.\n */\nexport function getLocalizedData<const TOpt extends TOptions = TOptions, Ns extends Namespace = DefaultNamespace, KPrefix = undefined>(\n\tkey: ParseKeys<Ns, TOpt, KPrefix>\n): LocalizedData {\n\tconst locales = getLocales();\n\tconst defaultT = getDefaultT();\n\n\treturn {\n\t\tvalue: defaultT(key),\n\t\tlocalizations: Object.fromEntries(Array.from(locales, ([locale, t]) => [locale, t(key)]))\n\t};\n}\n\n/**\n * Applies the localized names on the builder, calling `setName` and `setNameLocalizations`.\n * @param builder The builder to apply the localizations to.\n * @param key The key to get the localizations from.\n * @returns The updated builder.\n */\nexport function applyNameLocalizedBuilder<\n\tT extends BuilderWithName,\n\tconst TOpt extends TOptions = TOptions,\n\tNs extends Namespace = DefaultNamespace,\n\tKPrefix = undefined\n>(builder: T, key: ParseKeys<Ns, TOpt, KPrefix>) {\n\tconst result = getLocalizedData(key);\n\treturn builder.setName(result.value).setNameLocalizations(result.localizations);\n}\n\n/**\n * Applies the localized descriptions on the builder, calling `setDescription` and `setDescriptionLocalizations`.\n * @param builder The builder to apply the localizations to.\n * @param key The key to get the localizations from.\n * @returns The updated builder.\n */\nexport function applyDescriptionLocalizedBuilder<\n\tT extends BuilderWithDescription,\n\tconst TOpt extends TOptions = TOptions,\n\tNs extends Namespace = DefaultNamespace,\n\tKPrefix = undefined\n>(builder: T, key: ParseKeys<Ns, TOpt, KPrefix>) {\n\tconst result = getLocalizedData(key);\n\treturn builder.setDescription(result.value).setDescriptionLocalizations(result.localizations);\n}\n\n/**\n * Applies the localized names and descriptions on the builder, calling {@link applyNameLocalizedBuilder} and\n * {@link applyDescriptionLocalizedBuilder}.\n *\n * @param builder The builder to apply the localizations to.\n *\n * @param params The root key or the key for the name and description keys.\n * This needs to be either 1 or 2 parameters.\n * See examples below for more information.\n *\n * @returns The updated builder. You can chain subsequent builder methods on this.\n *\n * @remarks If only 2 parameters were passed, then this function will automatically append `Name` and `Description`\n *  to the root-key (wherein `root-key` is second parameter in the function, after `builder`)\n * passed through the second parameter.\n *\n * For example given `applyLocalizedBuilder(builder, 'userinfo')` the localized options will use the i18next keys\n * `userinfoName` and `userinfoDescription`.\n *\n * In the following example we provide all parameters and add a User Option\n * `applyLocalizedBuilder` needs either\n * @example\n * ```typescript\n * class UserInfoCommand extends Command {\n *   public registerApplicationCommands(registry: ChatInputCommand.Registry) {\n *     registry.registerChatInputCommand(\n *       (builder) =>\n *         applyLocalizedBuilder(builder, 'commands/names:userinfo', 'commands/descriptions:userinfo')\n *           .addUserOption(\n *             (input) => applyLocalizedBuilder(input, 'commands/options:userinfo-name', 'commands/options:userinfo-description').setRequired(true)\n *           )\n *     );\n *   }\n * }\n * ```\n *\n * In the following example we provide single root keys which means `Name` and `Description` get appended as mentioned above.\n * @example\n * ```typescript\n * class UserInfoCommand extends Command {\n *   public registerApplicationCommands(registry: ChatInputCommand.Registry) {\n *     registry.registerChatInputCommand(\n *       (builder) =>\n *         applyLocalizedBuilder(builder, 'commands:userinfo')\n *           .addUserOption(\n *             (input) => applyLocalizedBuilder(input, 'options:userinfo').setRequired(true)\n *           )\n *     );\n *   }\n * }\n * ```\n */\nexport function applyLocalizedBuilder<\n\tT extends BuilderWithNameAndDescription,\n\tconst TOpt extends TOptions = TOptions,\n\tNs extends Namespace = DefaultNamespace,\n\tKPrefix = undefined\n>(builder: T, ...params: [root: string] | [name: ParseKeys<Ns, TOpt, KPrefix>, description: ParseKeys<Ns, TOpt, KPrefix>]): T {\n\ttype LocalKeysType = ParseKeys<Ns, TOpt, KPrefix>;\n\n\tconst [localeName, localeDescription] =\n\t\tparams.length === 1 ? [`${params[0]}Name` as LocalKeysType, `${params[0]}Description` as LocalKeysType] : params;\n\n\tapplyNameLocalizedBuilder(builder, localeName);\n\tapplyDescriptionLocalizedBuilder(builder, localeDescription);\n\n\treturn builder;\n}\n\n/**\n * Constructs an object that can be passed into `setChoices` for String or Number option with localized names.\n *\n * @param key The i18next key for the name of the select option name.\n * @param options The additional Select Menu options. This should _at least_ include the `value` key.\n * @returns An object with anything provided through {@link createLocalizedChoice.options} with `name` and `name_localizations` added.\n *\n * @example\n * ```typescript\n * export class TypeCommand extends Command {\n *   public override registerApplicationCommands(registry: ChatInputCommand.Registry) {\n *     registry.registerChatInputCommand((builder) =>\n *       applyLocalizedBuilder(builder, 'commands/names:type').addStringOption((option) =>\n *         applyLocalizedBuilder(option, 'commands/options:type')\n *           .setRequired(true)\n *           .setChoices(\n *             createLocalizedChoice('selects/pokemon:type-grass', { value: 'grass' }),\n *             createLocalizedChoice('selects/pokemon:type-water', { value: 'water' }),\n *             createLocalizedChoice('selects/pokemon:type-fire', { value: 'fire' }),\n *             createLocalizedChoice('selects/pokemon:type-electric', { value: 'electric' })\n *           )\n *       )\n *     );\n *   }\n * }\n * ```\n */\nexport function createLocalizedChoice<\n\tValueType = string | number,\n\tconst TOpt extends TOptions = TOptions,\n\tNs extends Namespace = DefaultNamespace,\n\tKPrefix = undefined\n>(\n\tkey: ParseKeys<Ns, TOpt, KPrefix>,\n\toptions: Omit<APIApplicationCommandOptionChoice<ValueType>, 'name' | 'name_localizations'>\n): APIApplicationCommandOptionChoice<ValueType> {\n\tconst result = getLocalizedData(key);\n\n\treturn {\n\t\t...options,\n\t\tname: result.value,\n\t\tname_localizations: result.localizations\n\t};\n}\n"]}

package/dist/cjs/lib/types.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=types.cjs.map

package/dist/cjs/lib/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/cjs/register.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+var framework = require('@sapphire/framework');
+var chokidar = require('chokidar');
+var index_cjs = require('./index.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var _I18nextPlugin = class _I18nextPlugin extends framework.Plugin {
+  static [framework.preGenericsInitialization](options) {
+    framework.container.i18n = new index_cjs.InternationalizationHandler(options.i18n);
+  }
+  static async [framework.preLogin]() {
+    await framework.container.i18n.init();
+  }
+  static [framework.postLogin]() {
+    if (this.options.i18n?.hmr?.enabled) {
+      framework.container.logger.info("[i18next-Plugin]: HMR enabled. Watching for languages changes.");
+      const hmr = chokidar.watch(framework.container.i18n.languagesDirectory, this.options.i18n.hmr.options);
+      for (const event of ["change", "unlink"])
+        hmr.on(event, () => framework.container.i18n.reloadResources());
+    }
+  }
+};
+__name(_I18nextPlugin, "I18nextPlugin");
+var I18nextPlugin = _I18nextPlugin;
+framework.SapphireClient.plugins.registerPostInitializationHook(I18nextPlugin[framework.preGenericsInitialization], "I18next-PreGenericsInitialization");
+framework.SapphireClient.plugins.registerPreLoginHook(I18nextPlugin[framework.preLogin], "I18next-PreLogin");
+framework.SapphireClient.plugins.registerPostLoginHook(I18nextPlugin[framework.postLogin], "I18next-PostLogin");
+
+exports.I18nextPlugin = I18nextPlugin;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=register.cjs.map

package/dist/cjs/register.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/register.ts"],"names":[],"mappings":";;;;AAAA,SAAS,QAAQ,gBAAgB,WAAW,WAAW,2BAA2B,gBAAgB;AAClG,SAAS,aAAa;AAEtB,SAAS,mCAAmC;AAErC,IAAM,iBAAN,MAAM,uBAAsB,OAAO;AAAA,EACzC,QAAe,yBAAyB,EAAwB,SAA8B;AAC7F,cAAU,OAAO,IAAI,4BAA4B,QAAQ,IAAI;AAAA,EAC9D;AAAA,EAEA,cAAqB,QAAQ,IAAuC;AACnE,UAAM,UAAU,KAAK,KAAK;AAAA,EAC3B;AAAA,EAEA,QAAe,SAAS,IAA8B;AACrD,QAAI,KAAK,QAAQ,MAAM,KAAK,SAAS;AACpC,gBAAU,OAAO,KAAK,gEAAgE;AACtF,YAAM,MAAM,MAAM,UAAU,KAAK,oBAAoB,KAAK,QAAQ,KAAK,IAAI,OAAO;AAElF,iBAAW,SAAS,CAAC,UAAU,QAAQ;AAAG,YAAI,GAAG,OAAO,MAAM,UAAU,KAAK,gBAAgB,CAAC;AAAA,IAC/F;AAAA,EACD;AACD;AAjB0C;AAAnC,IAAM,gBAAN;AAmBP,eAAe,QAAQ,+BAA+B,cAAc,yBAAyB,GAAG,mCAAmC;AACnI,eAAe,QAAQ,qBAAqB,cAAc,QAAQ,GAAG,kBAAkB;AACvF,eAAe,QAAQ,sBAAsB,cAAc,SAAS,GAAG,mBAAmB","sourcesContent":["import { Plugin, SapphireClient, container, postLogin, preGenericsInitialization, preLogin } from '@sapphire/framework';\nimport { watch } from 'chokidar';\nimport type { ClientOptions } from 'discord.js';\nimport { InternationalizationHandler } from './index';\n\nexport class I18nextPlugin extends Plugin {\n\tpublic static [preGenericsInitialization](this: SapphireClient, options: ClientOptions): void {\n\t\tcontainer.i18n = new InternationalizationHandler(options.i18n);\n\t}\n\n\tpublic static async [preLogin](this: SapphireClient): Promise<void> {\n\t\tawait container.i18n.init();\n\t}\n\n\tpublic static [postLogin](this: SapphireClient): void {\n\t\tif (this.options.i18n?.hmr?.enabled) {\n\t\t\tcontainer.logger.info('[i18next-Plugin]: HMR enabled. Watching for languages changes.');\n\t\t\tconst hmr = watch(container.i18n.languagesDirectory, this.options.i18n.hmr.options);\n\n\t\t\tfor (const event of ['change', 'unlink']) hmr.on(event, () => container.i18n.reloadResources());\n\t\t}\n\t}\n}\n\nSapphireClient.plugins.registerPostInitializationHook(I18nextPlugin[preGenericsInitialization], 'I18next-PreGenericsInitialization');\nSapphireClient.plugins.registerPreLoginHook(I18nextPlugin[preLogin], 'I18next-PreLogin');\nSapphireClient.plugins.registerPostLoginHook(I18nextPlugin[postLogin], 'I18next-PostLogin');\n"]}

package/dist/cjs/register.d.ts

@@ -0,0 +1,10 @@
+import { Plugin, preGenericsInitialization, SapphireClient, preLogin, postLogin } from '@sapphire/framework';
+import { ClientOptions } from 'discord.js';
+
+declare class I18nextPlugin extends Plugin {
+    static [preGenericsInitialization](this: SapphireClient, options: ClientOptions): void;
+    static [preLogin](this: SapphireClient): Promise<void>;
+    static [postLogin](this: SapphireClient): void;
+}
+
+export { I18nextPlugin };

package/dist/esm/chunk-6QB3UK4Q.mjs

@@ -0,0 +1,11 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+export { __name, __publicField };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=chunk-6QB3UK4Q.mjs.map

package/dist/esm/chunk-6QB3UK4Q.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}