i18next
Version:
i18next internationalization framework
1,268 lines (1,257 loc) • 82.6 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
typeof define === 'function' && define.amd ? define(factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.i18next = factory());
})(this, (function () { 'use strict';
const isString = obj => typeof obj === 'string';
const defer = () => {
let res;
let rej;
const promise = new Promise((resolve, reject) => {
res = resolve;
rej = reject;
});
promise.resolve = res;
promise.reject = rej;
return promise;
};
const makeString = object => {
if (object == null) return '';
return '' + object;
};
const copy = (a, s, t) => {
a.forEach(m => {
if (s[m]) t[m] = s[m];
});
};
const lastOfPathSeparatorRegExp = /###/g;
const cleanKey = key => key && key.indexOf('###') > -1 ? key.replace(lastOfPathSeparatorRegExp, '.') : key;
const canNotTraverseDeeper = object => !object || isString(object);
const getLastOfPath = (object, path, Empty) => {
const stack = !isString(path) ? path : path.split('.');
let stackIndex = 0;
while (stackIndex < stack.length - 1) {
if (canNotTraverseDeeper(object)) return {};
const key = cleanKey(stack[stackIndex]);
if (!object[key] && Empty) object[key] = new Empty();
if (Object.prototype.hasOwnProperty.call(object, key)) {
object = object[key];
} else {
object = {};
}
++stackIndex;
}
if (canNotTraverseDeeper(object)) return {};
return {
obj: object,
k: cleanKey(stack[stackIndex])
};
};
const setPath = (object, path, newValue) => {
const {
obj,
k
} = getLastOfPath(object, path, Object);
if (obj !== undefined || path.length === 1) {
obj[k] = newValue;
return;
}
let e = path[path.length - 1];
let p = path.slice(0, path.length - 1);
let last = getLastOfPath(object, p, Object);
while (last.obj === undefined && p.length) {
e = `${p[p.length - 1]}.${e}`;
p = p.slice(0, p.length - 1);
last = getLastOfPath(object, p, Object);
if (last?.obj && typeof last.obj[`${last.k}.${e}`] !== 'undefined') {
last.obj = undefined;
}
}
last.obj[`${last.k}.${e}`] = newValue;
};
const pushPath = (object, path, newValue, concat) => {
const {
obj,
k
} = getLastOfPath(object, path, Object);
obj[k] = obj[k] || [];
obj[k].push(newValue);
};
const getPath = (object, path) => {
const {
obj,
k
} = getLastOfPath(object, path);
if (!obj) return undefined;
if (!Object.prototype.hasOwnProperty.call(obj, k)) return undefined;
return obj[k];
};
const getPathWithDefaults = (data, defaultData, key) => {
const value = getPath(data, key);
if (value !== undefined) {
return value;
}
return getPath(defaultData, key);
};
const deepExtend = (target, source, overwrite) => {
for (const prop in source) {
if (prop !== '__proto__' && prop !== 'constructor') {
if (prop in target) {
if (isString(target[prop]) || target[prop] instanceof String || isString(source[prop]) || source[prop] instanceof String) {
if (overwrite) target[prop] = source[prop];
} else {
deepExtend(target[prop], source[prop], overwrite);
}
} else {
target[prop] = source[prop];
}
}
}
return target;
};
const regexEscape = str => str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&');
var _entityMap = {
'&': '&',
'<': '<',
'>': '>',
'"': '"',
"'": ''',
'/': '/'
};
const escape = data => {
if (isString(data)) {
return data.replace(/[&<>"'\/]/g, s => _entityMap[s]);
}
return data;
};
class RegExpCache {
constructor(capacity) {
this.capacity = capacity;
this.regExpMap = new Map();
this.regExpQueue = [];
}
getRegExp(pattern) {
const regExpFromCache = this.regExpMap.get(pattern);
if (regExpFromCache !== undefined) {
return regExpFromCache;
}
const regExpNew = new RegExp(pattern);
if (this.regExpQueue.length === this.capacity) {
this.regExpMap.delete(this.regExpQueue.shift());
}
this.regExpMap.set(pattern, regExpNew);
this.regExpQueue.push(pattern);
return regExpNew;
}
}
const chars = [' ', ',', '?', '!', ';'];
const looksLikeObjectPathRegExpCache = new RegExpCache(20);
const looksLikeObjectPath = (key, nsSeparator, keySeparator) => {
nsSeparator = nsSeparator || '';
keySeparator = keySeparator || '';
const possibleChars = chars.filter(c => nsSeparator.indexOf(c) < 0 && keySeparator.indexOf(c) < 0);
if (possibleChars.length === 0) return true;
const r = looksLikeObjectPathRegExpCache.getRegExp(`(${possibleChars.map(c => c === '?' ? '\\?' : c).join('|')})`);
let matched = !r.test(key);
if (!matched) {
const ki = key.indexOf(keySeparator);
if (ki > 0 && !r.test(key.substring(0, ki))) {
matched = true;
}
}
return matched;
};
const deepFind = (obj, path, keySeparator = '.') => {
if (!obj) return undefined;
if (obj[path]) {
if (!Object.prototype.hasOwnProperty.call(obj, path)) return undefined;
return obj[path];
}
const tokens = path.split(keySeparator);
let current = obj;
for (let i = 0; i < tokens.length;) {
if (!current || typeof current !== 'object') {
return undefined;
}
let next;
let nextPath = '';
for (let j = i; j < tokens.length; ++j) {
if (j !== i) {
nextPath += keySeparator;
}
nextPath += tokens[j];
next = current[nextPath];
if (next !== undefined) {
if (['string', 'number', 'boolean'].indexOf(typeof next) > -1 && j < tokens.length - 1) {
continue;
}
i += j - i + 1;
break;
}
}
current = next;
}
return current;
};
const getCleanedCode = code => code?.replace('_', '-');
const consoleLogger = {
type: 'logger',
log(args) {
this.output('log', args);
},
warn(args) {
this.output('warn', args);
},
error(args) {
this.output('error', args);
},
output(type, args) {
console?.[type]?.apply?.(console, args);
}
};
class Logger {
constructor(concreteLogger, options = {}) {
this.init(concreteLogger, options);
}
init(concreteLogger, options = {}) {
this.prefix = options.prefix || 'i18next:';
this.logger = concreteLogger || consoleLogger;
this.options = options;
this.debug = options.debug;
}
log(...args) {
return this.forward(args, 'log', '', true);
}
warn(...args) {
return this.forward(args, 'warn', '', true);
}
error(...args) {
return this.forward(args, 'error', '');
}
deprecate(...args) {
return this.forward(args, 'warn', 'WARNING DEPRECATED: ', true);
}
forward(args, lvl, prefix, debugOnly) {
if (debugOnly && !this.debug) return null;
if (isString(args[0])) args[0] = `${prefix}${this.prefix} ${args[0]}`;
return this.logger[lvl](args);
}
create(moduleName) {
return new Logger(this.logger, {
...{
prefix: `${this.prefix}:${moduleName}:`
},
...this.options
});
}
clone(options) {
options = options || this.options;
options.prefix = options.prefix || this.prefix;
return new Logger(this.logger, options);
}
}
var baseLogger = new Logger();
class EventEmitter {
constructor() {
this.observers = {};
}
on(events, listener) {
events.split(' ').forEach(event => {
if (!this.observers[event]) this.observers[event] = new Map();
const numListeners = this.observers[event].get(listener) || 0;
this.observers[event].set(listener, numListeners + 1);
});
return this;
}
off(event, listener) {
if (!this.observers[event]) return;
if (!listener) {
delete this.observers[event];
return;
}
this.observers[event].delete(listener);
}
emit(event, ...args) {
if (this.observers[event]) {
const cloned = Array.from(this.observers[event].entries());
cloned.forEach(([observer, numTimesAdded]) => {
for (let i = 0; i < numTimesAdded; i++) {
observer(...args);
}
});
}
if (this.observers['*']) {
const cloned = Array.from(this.observers['*'].entries());
cloned.forEach(([observer, numTimesAdded]) => {
for (let i = 0; i < numTimesAdded; i++) {
observer.apply(observer, [event, ...args]);
}
});
}
}
}
class ResourceStore extends EventEmitter {
constructor(data, options = {
ns: ['translation'],
defaultNS: 'translation'
}) {
super();
this.data = data || {};
this.options = options;
if (this.options.keySeparator === undefined) {
this.options.keySeparator = '.';
}
if (this.options.ignoreJSONStructure === undefined) {
this.options.ignoreJSONStructure = true;
}
}
addNamespaces(ns) {
if (this.options.ns.indexOf(ns) < 0) {
this.options.ns.push(ns);
}
}
removeNamespaces(ns) {
const index = this.options.ns.indexOf(ns);
if (index > -1) {
this.options.ns.splice(index, 1);
}
}
getResource(lng, ns, key, options = {}) {
const keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
const ignoreJSONStructure = options.ignoreJSONStructure !== undefined ? options.ignoreJSONStructure : this.options.ignoreJSONStructure;
let path;
if (lng.indexOf('.') > -1) {
path = lng.split('.');
} else {
path = [lng, ns];
if (key) {
if (Array.isArray(key)) {
path.push(...key);
} else if (isString(key) && keySeparator) {
path.push(...key.split(keySeparator));
} else {
path.push(key);
}
}
}
const result = getPath(this.data, path);
if (!result && !ns && !key && lng.indexOf('.') > -1) {
lng = path[0];
ns = path[1];
key = path.slice(2).join('.');
}
if (result || !ignoreJSONStructure || !isString(key)) return result;
return deepFind(this.data?.[lng]?.[ns], key, keySeparator);
}
addResource(lng, ns, key, value, options = {
silent: false
}) {
const keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
let path = [lng, ns];
if (key) path = path.concat(keySeparator ? key.split(keySeparator) : key);
if (lng.indexOf('.') > -1) {
path = lng.split('.');
value = ns;
ns = path[1];
}
this.addNamespaces(ns);
setPath(this.data, path, value);
if (!options.silent) this.emit('added', lng, ns, key, value);
}
addResources(lng, ns, resources, options = {
silent: false
}) {
for (const m in resources) {
if (isString(resources[m]) || Array.isArray(resources[m])) this.addResource(lng, ns, m, resources[m], {
silent: true
});
}
if (!options.silent) this.emit('added', lng, ns, resources);
}
addResourceBundle(lng, ns, resources, deep, overwrite, options = {
silent: false,
skipCopy: false
}) {
let path = [lng, ns];
if (lng.indexOf('.') > -1) {
path = lng.split('.');
deep = resources;
resources = ns;
ns = path[1];
}
this.addNamespaces(ns);
let pack = getPath(this.data, path) || {};
if (!options.skipCopy) resources = JSON.parse(JSON.stringify(resources));
if (deep) {
deepExtend(pack, resources, overwrite);
} else {
pack = {
...pack,
...resources
};
}
setPath(this.data, path, pack);
if (!options.silent) this.emit('added', lng, ns, resources);
}
removeResourceBundle(lng, ns) {
if (this.hasResourceBundle(lng, ns)) {
delete this.data[lng][ns];
}
this.removeNamespaces(ns);
this.emit('removed', lng, ns);
}
hasResourceBundle(lng, ns) {
return this.getResource(lng, ns) !== undefined;
}
getResourceBundle(lng, ns) {
if (!ns) ns = this.options.defaultNS;
return this.getResource(lng, ns);
}
getDataByLanguage(lng) {
return this.data[lng];
}
hasLanguageSomeTranslations(lng) {
const data = this.getDataByLanguage(lng);
const n = data && Object.keys(data) || [];
return !!n.find(v => data[v] && Object.keys(data[v]).length > 0);
}
toJSON() {
return this.data;
}
}
var postProcessor = {
processors: {},
addPostProcessor(module) {
this.processors[module.name] = module;
},
handle(processors, value, key, options, translator) {
processors.forEach(processor => {
value = this.processors[processor]?.process(value, key, options, translator) ?? value;
});
return value;
}
};
const checkedLoadedFor = {};
const shouldHandleAsObject = res => !isString(res) && typeof res !== 'boolean' && typeof res !== 'number';
class Translator extends EventEmitter {
constructor(services, options = {}) {
super();
copy(['resourceStore', 'languageUtils', 'pluralResolver', 'interpolator', 'backendConnector', 'i18nFormat', 'utils'], services, this);
this.options = options;
if (this.options.keySeparator === undefined) {
this.options.keySeparator = '.';
}
this.logger = baseLogger.create('translator');
}
changeLanguage(lng) {
if (lng) this.language = lng;
}
exists(key, o = {
interpolation: {}
}) {
const opt = {
...o
};
if (key == null) return false;
const resolved = this.resolve(key, opt);
return resolved?.res !== undefined;
}
extractFromKey(key, opt) {
let nsSeparator = opt.nsSeparator !== undefined ? opt.nsSeparator : this.options.nsSeparator;
if (nsSeparator === undefined) nsSeparator = ':';
const keySeparator = opt.keySeparator !== undefined ? opt.keySeparator : this.options.keySeparator;
let namespaces = opt.ns || this.options.defaultNS || [];
const wouldCheckForNsInKey = nsSeparator && key.indexOf(nsSeparator) > -1;
const seemsNaturalLanguage = !this.options.userDefinedKeySeparator && !opt.keySeparator && !this.options.userDefinedNsSeparator && !opt.nsSeparator && !looksLikeObjectPath(key, nsSeparator, keySeparator);
if (wouldCheckForNsInKey && !seemsNaturalLanguage) {
const m = key.match(this.interpolator.nestingRegexp);
if (m && m.length > 0) {
return {
key,
namespaces: isString(namespaces) ? [namespaces] : namespaces
};
}
const parts = key.split(nsSeparator);
if (nsSeparator !== keySeparator || nsSeparator === keySeparator && this.options.ns.indexOf(parts[0]) > -1) namespaces = parts.shift();
key = parts.join(keySeparator);
}
return {
key,
namespaces: isString(namespaces) ? [namespaces] : namespaces
};
}
translate(keys, o, lastKey) {
let opt = typeof o === 'object' ? {
...o
} : o;
if (typeof opt !== 'object' && this.options.overloadTranslationOptionHandler) {
opt = this.options.overloadTranslationOptionHandler(arguments);
}
if (typeof options === 'object') opt = {
...opt
};
if (!opt) opt = {};
if (keys == null) return '';
if (!Array.isArray(keys)) keys = [String(keys)];
const returnDetails = opt.returnDetails !== undefined ? opt.returnDetails : this.options.returnDetails;
const keySeparator = opt.keySeparator !== undefined ? opt.keySeparator : this.options.keySeparator;
const {
key,
namespaces
} = this.extractFromKey(keys[keys.length - 1], opt);
const namespace = namespaces[namespaces.length - 1];
let nsSeparator = opt.nsSeparator !== undefined ? opt.nsSeparator : this.options.nsSeparator;
if (nsSeparator === undefined) nsSeparator = ':';
const lng = opt.lng || this.language;
const appendNamespaceToCIMode = opt.appendNamespaceToCIMode || this.options.appendNamespaceToCIMode;
if (lng?.toLowerCase() === 'cimode') {
if (appendNamespaceToCIMode) {
if (returnDetails) {
return {
res: `${namespace}${nsSeparator}${key}`,
usedKey: key,
exactUsedKey: key,
usedLng: lng,
usedNS: namespace,
usedParams: this.getUsedParamsDetails(opt)
};
}
return `${namespace}${nsSeparator}${key}`;
}
if (returnDetails) {
return {
res: key,
usedKey: key,
exactUsedKey: key,
usedLng: lng,
usedNS: namespace,
usedParams: this.getUsedParamsDetails(opt)
};
}
return key;
}
const resolved = this.resolve(keys, opt);
let res = resolved?.res;
const resUsedKey = resolved?.usedKey || key;
const resExactUsedKey = resolved?.exactUsedKey || key;
const noObject = ['[object Number]', '[object Function]', '[object RegExp]'];
const joinArrays = opt.joinArrays !== undefined ? opt.joinArrays : this.options.joinArrays;
const handleAsObjectInI18nFormat = !this.i18nFormat || this.i18nFormat.handleAsObject;
const needsPluralHandling = opt.count !== undefined && !isString(opt.count);
const hasDefaultValue = Translator.hasDefaultValue(opt);
const defaultValueSuffix = needsPluralHandling ? this.pluralResolver.getSuffix(lng, opt.count, opt) : '';
const defaultValueSuffixOrdinalFallback = opt.ordinal && needsPluralHandling ? this.pluralResolver.getSuffix(lng, opt.count, {
ordinal: false
}) : '';
const needsZeroSuffixLookup = needsPluralHandling && !opt.ordinal && opt.count === 0;
const defaultValue = needsZeroSuffixLookup && opt[`defaultValue${this.options.pluralSeparator}zero`] || opt[`defaultValue${defaultValueSuffix}`] || opt[`defaultValue${defaultValueSuffixOrdinalFallback}`] || opt.defaultValue;
let resForObjHndl = res;
if (handleAsObjectInI18nFormat && !res && hasDefaultValue) {
resForObjHndl = defaultValue;
}
const handleAsObject = shouldHandleAsObject(resForObjHndl);
const resType = Object.prototype.toString.apply(resForObjHndl);
if (handleAsObjectInI18nFormat && resForObjHndl && handleAsObject && noObject.indexOf(resType) < 0 && !(isString(joinArrays) && Array.isArray(resForObjHndl))) {
if (!opt.returnObjects && !this.options.returnObjects) {
if (!this.options.returnedObjectHandler) {
this.logger.warn('accessing an object - but returnObjects options is not enabled!');
}
const r = this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, resForObjHndl, {
...opt,
ns: namespaces
}) : `key '${key} (${this.language})' returned an object instead of string.`;
if (returnDetails) {
resolved.res = r;
resolved.usedParams = this.getUsedParamsDetails(opt);
return resolved;
}
return r;
}
if (keySeparator) {
const resTypeIsArray = Array.isArray(resForObjHndl);
const copy = resTypeIsArray ? [] : {};
const newKeyToUse = resTypeIsArray ? resExactUsedKey : resUsedKey;
for (const m in resForObjHndl) {
if (Object.prototype.hasOwnProperty.call(resForObjHndl, m)) {
const deepKey = `${newKeyToUse}${keySeparator}${m}`;
if (hasDefaultValue && !res) {
copy[m] = this.translate(deepKey, {
...opt,
defaultValue: shouldHandleAsObject(defaultValue) ? defaultValue[m] : undefined,
...{
joinArrays: false,
ns: namespaces
}
});
} else {
copy[m] = this.translate(deepKey, {
...opt,
...{
joinArrays: false,
ns: namespaces
}
});
}
if (copy[m] === deepKey) copy[m] = resForObjHndl[m];
}
}
res = copy;
}
} else if (handleAsObjectInI18nFormat && isString(joinArrays) && Array.isArray(res)) {
res = res.join(joinArrays);
if (res) res = this.extendTranslation(res, keys, opt, lastKey);
} else {
let usedDefault = false;
let usedKey = false;
if (!this.isValidLookup(res) && hasDefaultValue) {
usedDefault = true;
res = defaultValue;
}
if (!this.isValidLookup(res)) {
usedKey = true;
res = key;
}
const missingKeyNoValueFallbackToKey = opt.missingKeyNoValueFallbackToKey || this.options.missingKeyNoValueFallbackToKey;
const resForMissing = missingKeyNoValueFallbackToKey && usedKey ? undefined : res;
const updateMissing = hasDefaultValue && defaultValue !== res && this.options.updateMissing;
if (usedKey || usedDefault || updateMissing) {
this.logger.log(updateMissing ? 'updateKey' : 'missingKey', lng, namespace, key, updateMissing ? defaultValue : res);
if (keySeparator) {
const fk = this.resolve(key, {
...opt,
keySeparator: false
});
if (fk && fk.res) this.logger.warn('Seems the loaded translations were in flat JSON format instead of nested. Either set keySeparator: false on init or make sure your translations are published in nested format.');
}
let lngs = [];
const fallbackLngs = this.languageUtils.getFallbackCodes(this.options.fallbackLng, opt.lng || this.language);
if (this.options.saveMissingTo === 'fallback' && fallbackLngs && fallbackLngs[0]) {
for (let i = 0; i < fallbackLngs.length; i++) {
lngs.push(fallbackLngs[i]);
}
} else if (this.options.saveMissingTo === 'all') {
lngs = this.languageUtils.toResolveHierarchy(opt.lng || this.language);
} else {
lngs.push(opt.lng || this.language);
}
const send = (l, k, specificDefaultValue) => {
const defaultForMissing = hasDefaultValue && specificDefaultValue !== res ? specificDefaultValue : resForMissing;
if (this.options.missingKeyHandler) {
this.options.missingKeyHandler(l, namespace, k, defaultForMissing, updateMissing, opt);
} else if (this.backendConnector?.saveMissing) {
this.backendConnector.saveMissing(l, namespace, k, defaultForMissing, updateMissing, opt);
}
this.emit('missingKey', l, namespace, k, res);
};
if (this.options.saveMissing) {
if (this.options.saveMissingPlurals && needsPluralHandling) {
lngs.forEach(language => {
const suffixes = this.pluralResolver.getSuffixes(language, opt);
if (needsZeroSuffixLookup && opt[`defaultValue${this.options.pluralSeparator}zero`] && suffixes.indexOf(`${this.options.pluralSeparator}zero`) < 0) {
suffixes.push(`${this.options.pluralSeparator}zero`);
}
suffixes.forEach(suffix => {
send([language], key + suffix, opt[`defaultValue${suffix}`] || defaultValue);
});
});
} else {
send(lngs, key, defaultValue);
}
}
}
res = this.extendTranslation(res, keys, opt, resolved, lastKey);
if (usedKey && res === key && this.options.appendNamespaceToMissingKey) {
res = `${namespace}${nsSeparator}${key}`;
}
if ((usedKey || usedDefault) && this.options.parseMissingKeyHandler) {
res = this.options.parseMissingKeyHandler(this.options.appendNamespaceToMissingKey ? `${namespace}${nsSeparator}${key}` : key, usedDefault ? res : undefined, opt);
}
}
if (returnDetails) {
resolved.res = res;
resolved.usedParams = this.getUsedParamsDetails(opt);
return resolved;
}
return res;
}
extendTranslation(res, key, opt, resolved, lastKey) {
if (this.i18nFormat?.parse) {
res = this.i18nFormat.parse(res, {
...this.options.interpolation.defaultVariables,
...opt
}, opt.lng || this.language || resolved.usedLng, resolved.usedNS, resolved.usedKey, {
resolved
});
} else if (!opt.skipInterpolation) {
if (opt.interpolation) this.interpolator.init({
...opt,
...{
interpolation: {
...this.options.interpolation,
...opt.interpolation
}
}
});
const skipOnVariables = isString(res) && (opt?.interpolation?.skipOnVariables !== undefined ? opt.interpolation.skipOnVariables : this.options.interpolation.skipOnVariables);
let nestBef;
if (skipOnVariables) {
const nb = res.match(this.interpolator.nestingRegexp);
nestBef = nb && nb.length;
}
let data = opt.replace && !isString(opt.replace) ? opt.replace : opt;
if (this.options.interpolation.defaultVariables) data = {
...this.options.interpolation.defaultVariables,
...data
};
res = this.interpolator.interpolate(res, data, opt.lng || this.language || resolved.usedLng, opt);
if (skipOnVariables) {
const na = res.match(this.interpolator.nestingRegexp);
const nestAft = na && na.length;
if (nestBef < nestAft) opt.nest = false;
}
if (!opt.lng && resolved && resolved.res) opt.lng = this.language || resolved.usedLng;
if (opt.nest !== false) res = this.interpolator.nest(res, (...args) => {
if (lastKey?.[0] === args[0] && !opt.context) {
this.logger.warn(`It seems you are nesting recursively key: ${args[0]} in key: ${key[0]}`);
return null;
}
return this.translate(...args, key);
}, opt);
if (opt.interpolation) this.interpolator.reset();
}
const postProcess = opt.postProcess || this.options.postProcess;
const postProcessorNames = isString(postProcess) ? [postProcess] : postProcess;
if (res != null && postProcessorNames?.length && opt.applyPostProcessor !== false) {
res = postProcessor.handle(postProcessorNames, res, key, this.options && this.options.postProcessPassResolved ? {
i18nResolved: {
...resolved,
usedParams: this.getUsedParamsDetails(opt)
},
...opt
} : opt, this);
}
return res;
}
resolve(keys, opt = {}) {
let found;
let usedKey;
let exactUsedKey;
let usedLng;
let usedNS;
if (isString(keys)) keys = [keys];
keys.forEach(k => {
if (this.isValidLookup(found)) return;
const extracted = this.extractFromKey(k, opt);
const key = extracted.key;
usedKey = key;
let namespaces = extracted.namespaces;
if (this.options.fallbackNS) namespaces = namespaces.concat(this.options.fallbackNS);
const needsPluralHandling = opt.count !== undefined && !isString(opt.count);
const needsZeroSuffixLookup = needsPluralHandling && !opt.ordinal && opt.count === 0;
const needsContextHandling = opt.context !== undefined && (isString(opt.context) || typeof opt.context === 'number') && opt.context !== '';
const codes = opt.lngs ? opt.lngs : this.languageUtils.toResolveHierarchy(opt.lng || this.language, opt.fallbackLng);
namespaces.forEach(ns => {
if (this.isValidLookup(found)) return;
usedNS = ns;
if (!checkedLoadedFor[`${codes[0]}-${ns}`] && this.utils?.hasLoadedNamespace && !this.utils?.hasLoadedNamespace(usedNS)) {
checkedLoadedFor[`${codes[0]}-${ns}`] = true;
this.logger.warn(`key "${usedKey}" for languages "${codes.join(', ')}" won't get resolved as namespace "${usedNS}" was not yet loaded`, 'This means something IS WRONG in your setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
}
codes.forEach(code => {
if (this.isValidLookup(found)) return;
usedLng = code;
const finalKeys = [key];
if (this.i18nFormat?.addLookupKeys) {
this.i18nFormat.addLookupKeys(finalKeys, key, code, ns, opt);
} else {
let pluralSuffix;
if (needsPluralHandling) pluralSuffix = this.pluralResolver.getSuffix(code, opt.count, opt);
const zeroSuffix = `${this.options.pluralSeparator}zero`;
const ordinalPrefix = `${this.options.pluralSeparator}ordinal${this.options.pluralSeparator}`;
if (needsPluralHandling) {
finalKeys.push(key + pluralSuffix);
if (opt.ordinal && pluralSuffix.indexOf(ordinalPrefix) === 0) {
finalKeys.push(key + pluralSuffix.replace(ordinalPrefix, this.options.pluralSeparator));
}
if (needsZeroSuffixLookup) {
finalKeys.push(key + zeroSuffix);
}
}
if (needsContextHandling) {
const contextKey = `${key}${this.options.contextSeparator}${opt.context}`;
finalKeys.push(contextKey);
if (needsPluralHandling) {
finalKeys.push(contextKey + pluralSuffix);
if (opt.ordinal && pluralSuffix.indexOf(ordinalPrefix) === 0) {
finalKeys.push(contextKey + pluralSuffix.replace(ordinalPrefix, this.options.pluralSeparator));
}
if (needsZeroSuffixLookup) {
finalKeys.push(contextKey + zeroSuffix);
}
}
}
}
let possibleKey;
while (possibleKey = finalKeys.pop()) {
if (!this.isValidLookup(found)) {
exactUsedKey = possibleKey;
found = this.getResource(code, ns, possibleKey, opt);
}
}
});
});
});
return {
res: found,
usedKey,
exactUsedKey,
usedLng,
usedNS
};
}
isValidLookup(res) {
return res !== undefined && !(!this.options.returnNull && res === null) && !(!this.options.returnEmptyString && res === '');
}
getResource(code, ns, key, options = {}) {
if (this.i18nFormat?.getResource) return this.i18nFormat.getResource(code, ns, key, options);
return this.resourceStore.getResource(code, ns, key, options);
}
getUsedParamsDetails(options = {}) {
const optionsKeys = ['defaultValue', 'ordinal', 'context', 'replace', 'lng', 'lngs', 'fallbackLng', 'ns', 'keySeparator', 'nsSeparator', 'returnObjects', 'returnDetails', 'joinArrays', 'postProcess', 'interpolation'];
const useOptionsReplaceForData = options.replace && !isString(options.replace);
let data = useOptionsReplaceForData ? options.replace : options;
if (useOptionsReplaceForData && typeof options.count !== 'undefined') {
data.count = options.count;
}
if (this.options.interpolation.defaultVariables) {
data = {
...this.options.interpolation.defaultVariables,
...data
};
}
if (!useOptionsReplaceForData) {
data = {
...data
};
for (const key of optionsKeys) {
delete data[key];
}
}
return data;
}
static hasDefaultValue(options) {
const prefix = 'defaultValue';
for (const option in options) {
if (Object.prototype.hasOwnProperty.call(options, option) && prefix === option.substring(0, prefix.length) && undefined !== options[option]) {
return true;
}
}
return false;
}
}
class LanguageUtil {
constructor(options) {
this.options = options;
this.supportedLngs = this.options.supportedLngs || false;
this.logger = baseLogger.create('languageUtils');
}
getScriptPartFromCode(code) {
code = getCleanedCode(code);
if (!code || code.indexOf('-') < 0) return null;
const p = code.split('-');
if (p.length === 2) return null;
p.pop();
if (p[p.length - 1].toLowerCase() === 'x') return null;
return this.formatLanguageCode(p.join('-'));
}
getLanguagePartFromCode(code) {
code = getCleanedCode(code);
if (!code || code.indexOf('-') < 0) return code;
const p = code.split('-');
return this.formatLanguageCode(p[0]);
}
formatLanguageCode(code) {
if (isString(code) && code.indexOf('-') > -1) {
let formattedCode;
try {
formattedCode = Intl.getCanonicalLocales(code)[0];
} catch (e) {}
if (formattedCode && this.options.lowerCaseLng) {
formattedCode = formattedCode.toLowerCase();
}
if (formattedCode) return formattedCode;
if (this.options.lowerCaseLng) {
return code.toLowerCase();
}
return code;
}
return this.options.cleanCode || this.options.lowerCaseLng ? code.toLowerCase() : code;
}
isSupportedCode(code) {
if (this.options.load === 'languageOnly' || this.options.nonExplicitSupportedLngs) {
code = this.getLanguagePartFromCode(code);
}
return !this.supportedLngs || !this.supportedLngs.length || this.supportedLngs.indexOf(code) > -1;
}
getBestMatchFromCodes(codes) {
if (!codes) return null;
let found;
codes.forEach(code => {
if (found) return;
const cleanedLng = this.formatLanguageCode(code);
if (!this.options.supportedLngs || this.isSupportedCode(cleanedLng)) found = cleanedLng;
});
if (!found && this.options.supportedLngs) {
codes.forEach(code => {
if (found) return;
const lngScOnly = this.getScriptPartFromCode(code);
if (this.isSupportedCode(lngScOnly)) return found = lngScOnly;
const lngOnly = this.getLanguagePartFromCode(code);
if (this.isSupportedCode(lngOnly)) return found = lngOnly;
found = this.options.supportedLngs.find(supportedLng => {
if (supportedLng === lngOnly) return supportedLng;
if (supportedLng.indexOf('-') < 0 && lngOnly.indexOf('-') < 0) return;
if (supportedLng.indexOf('-') > 0 && lngOnly.indexOf('-') < 0 && supportedLng.substring(0, supportedLng.indexOf('-')) === lngOnly) return supportedLng;
if (supportedLng.indexOf(lngOnly) === 0 && lngOnly.length > 1) return supportedLng;
});
});
}
if (!found) found = this.getFallbackCodes(this.options.fallbackLng)[0];
return found;
}
getFallbackCodes(fallbacks, code) {
if (!fallbacks) return [];
if (typeof fallbacks === 'function') fallbacks = fallbacks(code);
if (isString(fallbacks)) fallbacks = [fallbacks];
if (Array.isArray(fallbacks)) return fallbacks;
if (!code) return fallbacks.default || [];
let found = fallbacks[code];
if (!found) found = fallbacks[this.getScriptPartFromCode(code)];
if (!found) found = fallbacks[this.formatLanguageCode(code)];
if (!found) found = fallbacks[this.getLanguagePartFromCode(code)];
if (!found) found = fallbacks.default;
return found || [];
}
toResolveHierarchy(code, fallbackCode) {
const fallbackCodes = this.getFallbackCodes((fallbackCode === false ? [] : fallbackCode) || this.options.fallbackLng || [], code);
const codes = [];
const addCode = c => {
if (!c) return;
if (this.isSupportedCode(c)) {
codes.push(c);
} else {
this.logger.warn(`rejecting language code not found in supportedLngs: ${c}`);
}
};
if (isString(code) && (code.indexOf('-') > -1 || code.indexOf('_') > -1)) {
if (this.options.load !== 'languageOnly') addCode(this.formatLanguageCode(code));
if (this.options.load !== 'languageOnly' && this.options.load !== 'currentOnly') addCode(this.getScriptPartFromCode(code));
if (this.options.load !== 'currentOnly') addCode(this.getLanguagePartFromCode(code));
} else if (isString(code)) {
addCode(this.formatLanguageCode(code));
}
fallbackCodes.forEach(fc => {
if (codes.indexOf(fc) < 0) addCode(this.formatLanguageCode(fc));
});
return codes;
}
}
const suffixesOrder = {
zero: 0,
one: 1,
two: 2,
few: 3,
many: 4,
other: 5
};
const dummyRule = {
select: count => count === 1 ? 'one' : 'other',
resolvedOptions: () => ({
pluralCategories: ['one', 'other']
})
};
class PluralResolver {
constructor(languageUtils, options = {}) {
this.languageUtils = languageUtils;
this.options = options;
this.logger = baseLogger.create('pluralResolver');
this.pluralRulesCache = {};
}
addRule(lng, obj) {
this.rules[lng] = obj;
}
clearCache() {
this.pluralRulesCache = {};
}
getRule(code, options = {}) {
const cleanedCode = getCleanedCode(code === 'dev' ? 'en' : code);
const type = options.ordinal ? 'ordinal' : 'cardinal';
const cacheKey = JSON.stringify({
cleanedCode,
type
});
if (cacheKey in this.pluralRulesCache) {
return this.pluralRulesCache[cacheKey];
}
let rule;
try {
rule = new Intl.PluralRules(cleanedCode, {
type
});
} catch (err) {
if (!Intl) {
this.logger.error('No Intl support, please use an Intl polyfill!');
return dummyRule;
}
if (!code.match(/-|_/)) return dummyRule;
const lngPart = this.languageUtils.getLanguagePartFromCode(code);
rule = this.getRule(lngPart, options);
}
this.pluralRulesCache[cacheKey] = rule;
return rule;
}
needsPlural(code, options = {}) {
let rule = this.getRule(code, options);
if (!rule) rule = this.getRule('dev', options);
return rule?.resolvedOptions().pluralCategories.length > 1;
}
getPluralFormsOfKey(code, key, options = {}) {
return this.getSuffixes(code, options).map(suffix => `${key}${suffix}`);
}
getSuffixes(code, options = {}) {
let rule = this.getRule(code, options);
if (!rule) rule = this.getRule('dev', options);
if (!rule) return [];
return rule.resolvedOptions().pluralCategories.sort((pluralCategory1, pluralCategory2) => suffixesOrder[pluralCategory1] - suffixesOrder[pluralCategory2]).map(pluralCategory => `${this.options.prepend}${options.ordinal ? `ordinal${this.options.prepend}` : ''}${pluralCategory}`);
}
getSuffix(code, count, options = {}) {
const rule = this.getRule(code, options);
if (rule) {
return `${this.options.prepend}${options.ordinal ? `ordinal${this.options.prepend}` : ''}${rule.select(count)}`;
}
this.logger.warn(`no plural rule found for: ${code}`);
return this.getSuffix('dev', count, options);
}
}
const deepFindWithDefaults = (data, defaultData, key, keySeparator = '.', ignoreJSONStructure = true) => {
let path = getPathWithDefaults(data, defaultData, key);
if (!path && ignoreJSONStructure && isString(key)) {
path = deepFind(data, key, keySeparator);
if (path === undefined) path = deepFind(defaultData, key, keySeparator);
}
return path;
};
const regexSafe = val => val.replace(/\$/g, '$$$$');
class Interpolator {
constructor(options = {}) {
this.logger = baseLogger.create('interpolator');
this.options = options;
this.format = options?.interpolation?.format || (value => value);
this.init(options);
}
init(options = {}) {
if (!options.interpolation) options.interpolation = {
escapeValue: true
};
const {
escape: escape$1,
escapeValue,
useRawValueToEscape,
prefix,
prefixEscaped,
suffix,
suffixEscaped,
formatSeparator,
unescapeSuffix,
unescapePrefix,
nestingPrefix,
nestingPrefixEscaped,
nestingSuffix,
nestingSuffixEscaped,
nestingOptionsSeparator,
maxReplaces,
alwaysFormat
} = options.interpolation;
this.escape = escape$1 !== undefined ? escape$1 : escape;
this.escapeValue = escapeValue !== undefined ? escapeValue : true;
this.useRawValueToEscape = useRawValueToEscape !== undefined ? useRawValueToEscape : false;
this.prefix = prefix ? regexEscape(prefix) : prefixEscaped || '{{';
this.suffix = suffix ? regexEscape(suffix) : suffixEscaped || '}}';
this.formatSeparator = formatSeparator || ',';
this.unescapePrefix = unescapeSuffix ? '' : unescapePrefix || '-';
this.unescapeSuffix = this.unescapePrefix ? '' : unescapeSuffix || '';
this.nestingPrefix = nestingPrefix ? regexEscape(nestingPrefix) : nestingPrefixEscaped || regexEscape('$t(');
this.nestingSuffix = nestingSuffix ? regexEscape(nestingSuffix) : nestingSuffixEscaped || regexEscape(')');
this.nestingOptionsSeparator = nestingOptionsSeparator || ',';
this.maxReplaces = maxReplaces || 1000;
this.alwaysFormat = alwaysFormat !== undefined ? alwaysFormat : false;
this.resetRegExp();
}
reset() {
if (this.options) this.init(this.options);
}
resetRegExp() {
const getOrResetRegExp = (existingRegExp, pattern) => {
if (existingRegExp?.source === pattern) {
existingRegExp.lastIndex = 0;
return existingRegExp;
}
return new RegExp(pattern, 'g');
};
this.regexp = getOrResetRegExp(this.regexp, `${this.prefix}(.+?)${this.suffix}`);
this.regexpUnescape = getOrResetRegExp(this.regexpUnescape, `${this.prefix}${this.unescapePrefix}(.+?)${this.unescapeSuffix}${this.suffix}`);
this.nestingRegexp = getOrResetRegExp(this.nestingRegexp, `${this.nestingPrefix}(.+?)${this.nestingSuffix}`);
}
interpolate(str, data, lng, options) {
let match;
let value;
let replaces;
const defaultData = this.options && this.options.interpolation && this.options.interpolation.defaultVariables || {};
const handleFormat = key => {
if (key.indexOf(this.formatSeparator) < 0) {
const path = deepFindWithDefaults(data, defaultData, key, this.options.keySeparator, this.options.ignoreJSONStructure);
return this.alwaysFormat ? this.format(path, undefined, lng, {
...options,
...data,
interpolationkey: key
}) : path;
}
const p = key.split(this.formatSeparator);
const k = p.shift().trim();
const f = p.join(this.formatSeparator).trim();
return this.format(deepFindWithDefaults(data, defaultData, k, this.options.keySeparator, this.options.ignoreJSONStructure), f, lng, {
...options,
...data,
interpolationkey: k
});
};
this.resetRegExp();
const missingInterpolationHandler = options?.missingInterpolationHandler || this.options.missingInterpolationHandler;
const skipOnVariables = options?.interpolation?.skipOnVariables !== undefined ? options.interpolation.skipOnVariables : this.options.interpolation.skipOnVariables;
const todos = [{
regex: this.regexpUnescape,
safeValue: val => regexSafe(val)
}, {
regex: this.regexp,
safeValue: val => this.escapeValue ? regexSafe(this.escape(val)) : regexSafe(val)
}];
todos.forEach(todo => {
replaces = 0;
while (match = todo.regex.exec(str)) {
const matchedVar = match[1].trim();
value = handleFormat(matchedVar);
if (value === undefined) {
if (typeof missingInterpolationHandler === 'function') {
const temp = missingInterpolationHandler(str, match, options);
value = isString(temp) ? temp : '';
} else if (options && Object.prototype.hasOwnProperty.call(options, matchedVar)) {
value = '';
} else if (skipOnVariables) {
value = match[0];
continue;
} else {
this.logger.warn(`missed to pass in variable ${matchedVar} for interpolating ${str}`);
value = '';
}
} else if (!isString(value) && !this.useRawValueToEscape) {
value = makeString(value);
}
const safeValue = todo.safeValue(value);
str = str.replace(match[0], safeValue);
if (skipOnVariables) {
todo.regex.lastIndex += value.length;
todo.regex.lastIndex -= match[0].length;
} else {
todo.regex.lastIndex = 0;
}
replaces++;
if (replaces >= this.maxReplaces) {
break;
}
}
});
return str;
}
nest(str, fc, options = {}) {
let match;
let value;
let clonedOptions;
const handleHasOptions = (key, inheritedOptions) => {
const sep = this.nestingOptionsSeparator;
if (key.indexOf(sep) < 0) return key;
const c = key.split(new RegExp(`${sep}[ ]*{`));
let optionsString = `{${c[1]}`;
key = c[0];
optionsString = this.interpolate(optionsString, clonedOptions);
const matchedSingleQuotes = optionsString.match(/'/g);
const matchedDoubleQuotes = optionsString.match(/"/g);
if ((matchedSingleQuotes?.length ?? 0) % 2 === 0 && !matchedDoubleQuotes || matchedDoubleQuotes.length % 2 !== 0) {
optionsString = optionsString.replace(/'/g, '"');
}
try {
clonedOptions = JSON.parse(optionsString);
if (inheritedOptions) clonedOptions = {
...inheritedOptions,
...clonedOptions
};
} catch (e) {
this.logger.warn(`failed parsing options string in nesting for key ${key}`, e);
return `${key}${sep}${optionsString}`;
}
if (clonedOptions.defaultValue && clonedOptions.defaultValue.indexOf(this.prefix) > -1) delete clonedOptions.defaultValue;
return key;
};
while (match = this.nestingRegexp.exec(str)) {
let formatters = [];
clonedOptions = {
...options
};
clonedOptions = clonedOptions.replace && !isString(clonedOptions.replace) ? clonedOptions.replace : clonedOptions;
clonedOptions.applyPostProcessor = false;
delete clonedOptions.defaultValue;
const keyEndIndex = /{.*}/.test(match[1]) ? match[1].lastIndexOf('}') + 1 : match[1].indexOf(this.formatSeparator);
if (keyEndIndex !== -1) {
formatters = match[1].slice(keyEndIndex).split(this.formatSeparator).map(elem => elem.trim()).filter(Boolean);
match[1] = match[1].slice(0, keyEndIndex);
}
value = fc(handleHasOptions.call(this, match[1].trim(), clonedOptions), clonedOptions);
if (value && match[0] === str && !isString(value)) return value;
if (!isString(value)) value = makeString(value);
if (!value) {
this.logger.warn(`missed to resolve ${match[1]} for nesting ${str}`);
value = '';
}
if (formatters.length) {
value = formatters.reduce((v, f) => this.format(v, f, options.lng, {
...options,
interpolationkey: match[1].trim()
}), value.trim());
}
str = str.replace(match[0], value);
this.regexp.lastIndex = 0;
}
return str;
}
}
const parseFormatStr = formatStr => {
let formatName = formatStr.toLowerCase().trim();
const formatOptions = {};
if (formatStr.indexOf('(') > -1) {
const p = formatStr.split('(');
formatName = p[0].toLowerCase().trim();
const optStr = p[1].substring(0, p[1].length - 1);
if (formatName === 'currency' && optStr.indexOf(':') < 0) {
if (!formatOptions.currency) formatOptions.currency = optStr.trim();
} else if (formatName === 'relativetime' && optStr.indexOf(':') < 0) {
if (!formatOptions.range) formatOptions.range = optStr.trim();
} else {
const opts = optStr.split(';');
opts.forEach(opt => {
if (opt) {
const [key, ...rest] = opt.split(':');
const val = rest.join(':').trim().replace(/^'+|'+$/g, '');
const trimmedKey = key.trim();
if (!formatOptions[trimmedKey]) formatOptions[trimmedKey] = val;
if (val === 'false') formatOptions[trimmedKey] = false;
if (val === 'true') formatOptions[trimmedKey] = true;
if (!isNaN(val)) formatOptions[trimmedKey] = parseInt(val, 10);