@genrwork/laravel-i18next 0.1.0 → 0.1.1

package/dist/shared/{create-i18n-WsDK4Z8L.cjs → create-i18n-DI7Eog6O.cjs}

@@ -1,6 +1,26 @@
 'use strict';
 
 var i18next = require('i18next');
+var demand = require('./demand-sbjTXVnl.cjs');
+
+/**
+ * The modules lazy loaders (`import.meta.glob()` functions) have already
+ * resolved, keyed by the loader itself. Loading a language file is the one
+ * asynchronous step of translating; once a loader has been awaited, its
+ * module never changes, so every later read of it can be synchronous. That is
+ * what lets `preloadI18n()` load translations during page resolution --
+ * before anything renders -- and lets `createI18n()` and the backend read
+ * them without waiting, so a render never has to suspend.
+ *
+ * Module scoped on purpose, so it is shared by every i18next instance of the
+ * process: a server keeps one copy of each catalog across requests.
+ */ const modules = new WeakMap();
+function getCachedModule(loader) {
+    return modules.get(loader);
+}
+function setCachedModule(loader, module) {
+    modules.set(loader, module);
+}
 
 /**
  * Normalize a `LocaleFileSources` (a single `LocaleFiles` map, or an ordered
@@ -138,6 +158,9 @@ var i18next = require('i18next');
  * module; eager files (`import.meta.glob(..., { eager: true })`) resolve to a
  * module directly; a plain object (hand-built maps, tests) is wrapped as a
  * module's `default`.
+ *
+ * A loader that was awaited before resolves to its module directly, from the
+ * cache (see `src/utils/cache.ts`): reading it is synchronous from then on.
  */ function toModule(entry) {
     const type = Object.prototype.toString.call(entry);
     if (type === '[object Promise]' || type === '[object Module]') {
@@ -148,8 +171,14 @@ var i18next = require('i18next');
             default: entry
         };
     }
-    if (type === '[object Function]') {
-        return entry();
+    if (typeof entry === 'function') {
+        const loader = entry;
+        const cached = getCachedModule(loader);
+        if (cached) return cached;
+        return Promise.resolve(loader()).then((module)=>{
+            setCachedModule(loader, module);
+            return module;
+        });
     }
     return undefined;
 }
@@ -244,335 +273,36 @@ function isPromiseLike(value) {
 }
 LaravelBackend.type = 'backend';
 
-/* eslint-disable */ /**
- * Get the index to use for pluralization.
- * The plural rules are derived from code of the Zend Framework.
- *
- * @category    Zend
- * @package     Zend_Locale
- * @public      https://github.com/zendframework/zf1/blob/master/library/Zend/Translate/Plural.php
- * @copyright   2005-2015 Zend Technologies USA Inc. http://www.zend.com
- * @license     http://framework.zend.com/license     New BSD License
- *
- * @param  {String}  locale
- * @param  {Number}  number
- * @return {Number}
- */ function getPluralIndex(locale, number) {
-    locale = locale.replace('-', '_');
-    if (locale === 'pt_BR') {
-        // temporary set a locale for brazilian
-        locale = 'xbr';
-    }
-    if (locale.length > 3) {
-        locale = locale.substring(0, locale.lastIndexOf('_'));
-    }
-    switch(locale){
-        case 'az':
-        case 'bo':
-        case 'dz':
-        case 'id':
-        case 'ja':
-        case 'jv':
-        case 'ka':
-        case 'km':
-        case 'kn':
-        case 'ko':
-        case 'ms':
-        case 'th':
-        case 'tr':
-        case 'vi':
-        case 'zh':
-            return 0;
-        case 'af':
-        case 'bn':
-        case 'bg':
-        case 'ca':
-        case 'da':
-        case 'de':
-        case 'el':
-        case 'en':
-        case 'eo':
-        case 'es':
-        case 'et':
-        case 'eu':
-        case 'fa':
-        case 'fi':
-        case 'fo':
-        case 'fur':
-        case 'fy':
-        case 'gl':
-        case 'gu':
-        case 'ha':
-        case 'he':
-        case 'hu':
-        case 'is':
-        case 'it':
-        case 'ku':
-        case 'lb':
-        case 'ml':
-        case 'mn':
-        case 'mr':
-        case 'nah':
-        case 'nb':
-        case 'ne':
-        case 'nl':
-        case 'nn':
-        case 'no':
-        case 'om':
-        case 'or':
-        case 'pa':
-        case 'pap':
-        case 'ps':
-        case 'pt':
-        case 'so':
-        case 'sq':
-        case 'sv':
-        case 'sw':
-        case 'ta':
-        case 'te':
-        case 'tk':
-        case 'ur':
-        case 'zu':
-            return number === 1 ? 0 : 1;
-        case 'am':
-        case 'bh':
-        case 'fil':
-        case 'fr':
-        case 'gun':
-        case 'hi':
-        case 'ln':
-        case 'mg':
-        case 'nso':
-        case 'xbr':
-        case 'ti':
-        case 'wa':
-            return number === 0 || number === 1 ? 0 : 1;
-        case 'be':
-        case 'bs':
-        case 'hr':
-        case 'ru':
-        case 'sr':
-        case 'uk':
-            return number % 10 === 1 && number % 100 !== 11 ? 0 : number % 10 >= 2 && number % 10 <= 4 && (number % 100 < 10 || number % 100 >= 20) ? 1 : 2;
-        case 'cs':
-        case 'sk':
-            return number === 1 ? 0 : number >= 2 && number <= 4 ? 1 : 2;
-        case 'ga':
-            return number === 1 ? 0 : number === 2 ? 1 : 2;
-        case 'lt':
-            return number % 10 === 1 && number % 100 !== 11 ? 0 : number % 10 >= 2 && (number % 100 < 10 || number % 100 >= 20) ? 1 : 2;
-        case 'sl':
-            return number % 100 === 1 ? 0 : number % 100 === 2 ? 1 : number % 100 === 3 || number % 100 === 4 ? 2 : 3;
-        case 'mk':
-            return number % 10 === 1 ? 0 : 1;
-        case 'mt':
-            return number === 1 ? 0 : number === 0 || number % 100 > 1 && number % 100 < 11 ? 1 : number % 100 > 10 && number % 100 < 20 ? 2 : 3;
-        case 'lv':
-            return number === 0 ? 0 : number % 10 === 1 && number % 100 !== 11 ? 1 : 2;
-        case 'pl':
-            return number === 1 ? 0 : number % 10 >= 2 && number % 10 <= 4 && (number % 100 < 12 || number % 100 > 14) ? 1 : 2;
-        case 'cy':
-            return number === 1 ? 0 : number === 2 ? 1 : number === 8 || number === 11 ? 2 : 3;
-        case 'ro':
-            return number === 1 ? 0 : number === 0 || number % 100 > 0 && number % 100 < 20 ? 1 : 2;
-        case 'ar':
-            return number === 0 ? 0 : number === 1 ? 1 : number === 2 ? 2 : number >= 3 && number <= 10 ? 3 : number >= 11 && number <= 99 ? 4 : 5;
-        default:
-            return 0;
-    }
-}
-
 /**
- * Select a proper translation string based on the given number,
- * using the same rules as Laravel's `trans_choice()`.
+ * The i18next options Laravel translations need. `createI18n()` applies them;
+ * pass them to `init()` yourself when you set i18next up by hand.
  *
- * @param message
- * @param number
- * @param locale
- */ function pluralization(message, number, locale) {
-    let segments = message.split('|');
-    const extracted = extract(segments, number);
-    if (extracted !== null) {
-        return extracted.trim();
+ * - no key or namespace separator: Laravel keys are flat and contain dots
+ *   and colons (`auth.failed`, `Email:`);
+ * - an empty message counts as missing and falls back to the next language;
+ * - no escaping of interpolated values: React, Vue and Svelte already escape
+ *   what they render, and Laravel's `:name` replacements were never escaped.
+ */ const laravelOptions = {
+    keySeparator: false,
+    nsSeparator: false,
+    returnEmptyString: false,
+    interpolation: {
+        escapeValue: false
     }
-    segments = stripConditions(segments);
-    const pluralIndex = getPluralIndex(locale, number);
-    return segments.length === 1 || !segments[pluralIndex] ? segments[0] : segments[pluralIndex];
-}
+};
 /**
- * Extract a translation string using inline conditions.
- *
- * @param segments
- * @param number
- */ function extract(segments, number) {
-    for (const segment of segments){
-        const result = extractFromString(segment, number);
-        if (result !== null) return result;
-    }
-    return null;
-}
-/**
- * Get the translation string if the condition matches.
- *
- * @param part
- * @param number
- */ function extractFromString(part, number) {
-    const matches = part.match(/^[{[]([^,{}[\]]*),?([^{}[\]]*)[}\]]([\s\S]*)/);
-    if (!matches) return null;
-    const [, from, to, value] = matches;
-    if ((from === '*' || number >= parseFloat(from)) && (to === '*' || number <= parseFloat(to))) {
-        return value;
-    }
-    return from && parseFloat(from) === number ? value : null;
-}
-/**
- * Strip the inline conditions from each segment, just leaving the text.
- *
- * @param segments
- */ function stripConditions(segments) {
-    return segments.map((part)=>part.replace(/^[{[]([^[\]{}]*)[}\]]/, ''));
-}
-
-/**
- * Make the place-holder replacements on a line, the Laravel way:
- * `:name` as is, `:NAME` upper-cased and `:Name` capitalized.
- *
- * @param message
- * @param replacements
- */ function replacer(message, replacements) {
-    if (!replacements) return message;
-    const patterns = Object.entries(replacements).flatMap(([key, value])=>[
-            {
-                pattern: new RegExp(`:${key}`, 'g'),
-                replacement: value.toString()
-            },
-            {
-                pattern: new RegExp(`:${key.toUpperCase()}`, 'g'),
-                replacement: value.toString().toUpperCase()
-            },
-            {
-                pattern: new RegExp(`:${capitalize(key)}`, 'g'),
-                replacement: capitalize(value.toString())
-            }
-        ]);
-    return patterns.reduce((result, { pattern, replacement })=>result.replace(pattern, replacement), message);
-}
-/**
- * Capitalizing string.
- *
- * @param str
- */ function capitalize(str) {
-    return str ? str[0].toUpperCase() + str.slice(1) : '';
-}
-
-/**
- * i18next `t()` options that are not Laravel replacements. Use the `replace`
- * option to pass replacements having one of these names.
- */ const I18NEXT_OPTIONS = new Set([
-    'appendNamespaceToMissingKey',
-    'applyPostProcessor',
-    'context',
-    'fallbackLng',
-    'i18nResolved',
-    'interpolation',
-    'joinArrays',
-    'keyPrefix',
-    'keySeparator',
-    'lng',
-    'lngs',
-    'missingKeyNoValueFallbackToKey',
-    'ns',
-    'nsSeparator',
-    'nest',
-    'ordinal',
-    'postProcess',
-    'replace',
-    'returnDetails',
-    'returnObjects',
-    'scopeNs',
-    'skipInterpolation'
-]);
-function getReplacements(options) {
-    const fromReplace = options.replace !== null && typeof options.replace === 'object';
-    const source = fromReplace ? options.replace : options;
-    const replacements = {};
-    Object.entries(source).forEach(([key, value])=>{
-        if (typeof value !== 'string' && typeof value !== 'number') return;
-        // A numeric count selects the plural form, it is replaced after pluralization.
-        if (key === 'count' && typeof value === 'number') return;
-        if (!fromReplace && (I18NEXT_OPTIONS.has(key) || key.startsWith('defaultValue'))) return;
-        replacements[key] = value;
+ * Register the `uppercase`, `lowercase` and `capitalize` interpolation formats.
+ * The Vite plugin writes Laravel's `:NAME` as `{{name, uppercase}}` and `:Name`
+ * as `{{name, capitalize}}`; call this once the instance is initialized.
+ */ function registerCaseFormats(instance) {
+    const formatter = instance.services.formatter;
+    formatter === null || formatter === void 0 ? void 0 : formatter.add('uppercase', (value)=>String(value).toUpperCase());
+    formatter === null || formatter === void 0 ? void 0 : formatter.add('lowercase', (value)=>String(value).toLowerCase());
+    formatter === null || formatter === void 0 ? void 0 : formatter.add('capitalize', (value)=>{
+        const text = String(value);
+        return text ? text[0].toUpperCase() + text.slice(1) : text;
     });
-    return replacements;
 }
-/**
- * i18next format plugin translating the way Laravel does:
- *
- * - flat keys (`auth.failed`, `Welcome, :name!`), no key or namespace separators;
- * - `:name`, `:NAME` and `:Name` replacements instead of `{{name}}` interpolation and `$t()` nesting;
- * - a numeric `count` selects the message with Laravel's `trans_choice()` rules
- *   (`one|many`, `{0} none|[1,19] some|[20,*] many`) instead of `_one`/`_other` suffixed keys;
- * - empty messages fall back to the next language.
- */ class LaravelFormat {
-    init(i18next) {
-        this.i18next = i18next;
-        // Laravel keys contain dots and colons: disable the separators, unless given to `init()`.
-        const options = i18next.options;
-        if (options.userDefinedKeySeparator === undefined) options.keySeparator = false;
-        if (options.userDefinedNsSeparator === undefined) options.nsSeparator = false;
-    }
-    getResource(language, namespace, key) {
-        var _a;
-        const value = (_a = this.i18next) === null || _a === void 0 ? void 0 : _a.getResource(language, namespace, key, {
-            keySeparator: false,
-            ignoreJSONStructure: false
-        });
-        return value || undefined;
-    }
-    addLookupKeys(finalKeys) {
-        return finalKeys;
-    }
-    parse(message, options, language, namespace, _key, info) {
-        if (typeof message !== 'string') return message;
-        const replacements = getReplacements(options);
-        const translated = replacer(message, replacements);
-        const count = options.count;
-        if (typeof count !== 'number') return translated;
-        return replacer(pluralization(translated, count, this.getPluralLocale(language, namespace, info)), {
-            ...replacements,
-            count: count.toString()
-        });
-    }
-    /**
-     * The language the message actually resolved in, so pluralization always
-     * matches the text being pluralized -- never merely a language that has
-     * translations for the namespace, which is not the same thing once several
-     * sources can contribute to one namespace (see LaravelBackend): a single
-     * unrelated key from a higher-priority source is enough to make
-     * `hasResourceBundle(language, namespace)` true for a namespace whose
-     * actual message still came from the fallback language.
-     *
-     * i18next passes the language the lookup succeeded at as `resolved.usedLng`
-     * in `parse()`'s 6th argument (`extendTranslation()` in i18next's own
-     * `translator.js`); prefer it. Older i18next in the `>=24` peer range that
-     * does not pass it falls back to a heuristic: the current language when it
-     * has translations for the namespace, else the fallback language.
-     */ getPluralLocale(language, namespace, info) {
-        var _a;
-        const usedLng = (_a = info === null || info === void 0 ? void 0 : info.resolved) === null || _a === void 0 ? void 0 : _a.usedLng;
-        if (usedLng) return usedLng;
-        if (!this.i18next || !language || this.i18next.hasResourceBundle(language, namespace)) return language;
-        const [fallbackLanguage] = this.i18next.services.languageUtils.getFallbackCodes(this.i18next.options.fallbackLng, language);
-        return fallbackLanguage !== null && fallbackLanguage !== void 0 ? fallbackLanguage : language;
-    }
-    constructor(){
-        this.type = 'i18nFormat';
-        /**
-         * Non-string translations (e.g. an empty PHP array) are returned as is.
-         */ this.handleAsObject = false;
-    }
-}
-LaravelFormat.type = 'i18nFormat';
 
 /**
  * Locale of the `<html lang="">` attribute (set by Laravel's `app.blade.php`), or `en`.
@@ -610,26 +340,39 @@ LaravelFormat.type = 'i18nFormat';
     return ()=>instance.off('languageChanged', setDocumentLang);
 }
 /**
- * Create an i18next instance translating Laravel language files: the default
+ * Create an i18next instance reading Laravel language files as i18next JSON: the default
  * namespace from `lang/{locale}.json`, and one namespace per `lang/{locale}/{namespace}.json`
- * file (generated by the Vite plugin, or hand-written).
+ * file (converted from PHP by the Vite plugin, or hand-written the i18next way).
  *
  * With eager files, every known namespace of the locale and fallback locale is
  * preloaded synchronously, so a first render never has to wait for translations.
- * With lazy files, namespaces are loaded on demand as components request them.
+ *
+ * With lazy files, only the namespaces the evaluated modules declared are loaded
+ * up front (see `declareNamespaces()`), plus the default one; any other is loaded
+ * when a component first asks for it, which suspends until it arrives. Loaded
+ * beforehand with `preloadI18n()` -- or `withI18nPreload()` around the page
+ * resolver -- the up front ones are already in memory, so the instance is ready
+ * synchronously and neither the first render nor a later page ever waits.
  */ function createI18n({ files, locale, fallbackLocale }) {
     const instance = i18next.createInstance();
     const sources = toSources(files);
-    const namespaces = recognizer(sources).getAllNamespaces();
+    const known = recognizer(sources).getAllNamespaces();
     const resolvedLocale = locale || documentLocale();
     const resolvedFallbackLocale = fallbackLocale || documentLocale();
     const eager = isEagerSources(sources);
-    instance.use(LaravelBackend).use(LaravelFormat).init({
+    const namespaces = eager ? known : Array.from(new Set([
+        DEFAULT_NAMESPACE,
+        ...demand.getDeclaredNamespaces()
+    ])).filter((namespace)=>known.includes(namespace));
+    instance.use(LaravelBackend).init({
+        ...laravelOptions,
         lng: resolvedLocale,
         fallbackLng: resolvedFallbackLocale,
         initAsync: false,
-        ns: namespaces.length > 0 ? namespaces : undefined,
-        preload: eager ? Array.from(new Set([
+        ...namespaces.length > 0 ? {
+            ns: namespaces
+        } : {},
+        preload: namespaces.length > 0 ? Array.from(new Set([
             resolvedLocale,
             resolvedFallbackLocale
         ])) : undefined,
@@ -637,11 +380,18 @@ LaravelFormat.type = 'i18nFormat';
             files: sources
         }
     });
+    registerCaseFormats(instance);
+    demand.trackInstance(instance);
     return instance;
 }
 
+exports.DEFAULT_NAMESPACE = DEFAULT_NAMESPACE;
 exports.LaravelBackend = LaravelBackend;
-exports.LaravelFormat = LaravelFormat;
 exports.createI18n = createI18n;
 exports.documentLocale = documentLocale;
+exports.laravelOptions = laravelOptions;
+exports.recognizer = recognizer;
+exports.registerCaseFormats = registerCaseFormats;
+exports.resolver = resolver;
 exports.syncDocumentLang = syncDocumentLang;
+exports.toSources = toSources;