i18next 21.2.5 → 21.3.2

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 21.3.2
+
+- formatter typescript declarations [1679](https://github.com/i18next/i18next/pull/1679)
+
+## 21.3.1
+
+- get rid of internal isDummy check to prevent react-native issue [1675](https://github.com/i18next/i18next/issues/1675)
+
+## 21.3.0
+
+- adds support for formats provided by Intl API (number, currency, datetime, relativedate, list)
+
+## 21.2.6
+
+- optimize do skip natural language detection also if user provided nsSeparator option is passed via direct options
+
 ## 21.2.5
 
 - do skip natural language detection also if user provided nsSeparator option is passed [1665](https://github.com/i18next/i18next/issues/1665)

package/dist/cjs/i18next.js

@@ -8,6 +8,7 @@ var _possibleConstructorReturn = require('@babel/runtime/helpers/possibleConstru
 var _getPrototypeOf = require('@babel/runtime/helpers/getPrototypeOf');
 var _assertThisInitialized = require('@babel/runtime/helpers/assertThisInitialized');
 var _inherits = require('@babel/runtime/helpers/inherits');
+var _slicedToArray = require('@babel/runtime/helpers/slicedToArray');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -19,6 +20,7 @@ var _possibleConstructorReturn__default = /*#__PURE__*/_interopDefaultLegacy(_po
 var _getPrototypeOf__default = /*#__PURE__*/_interopDefaultLegacy(_getPrototypeOf);
 var _assertThisInitialized__default = /*#__PURE__*/_interopDefaultLegacy(_assertThisInitialized);
 var _inherits__default = /*#__PURE__*/_interopDefaultLegacy(_inherits);
+var _slicedToArray__default = /*#__PURE__*/_interopDefaultLegacy(_slicedToArray);
 
 var consoleLogger = {
   type: 'logger',
@@ -608,7 +610,7 @@ var Translator = function (_EventEmitter) {
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
       var namespaces = options.ns || this.options.defaultNS;
       var wouldCheckForNsInKey = nsSeparator && key.indexOf(nsSeparator) > -1;
-      var seemsNaturalLanguage = !this.options.userDefinedKeySeparator && !this.options.userDefinedNsSeparator && !options.keySeparator && !looksLikeObjectPath(key, nsSeparator, keySeparator);
+      var seemsNaturalLanguage = !this.options.userDefinedKeySeparator && !options.keySeparator && !this.options.userDefinedNsSeparator && !options.nsSeparator && !looksLikeObjectPath(key, nsSeparator, keySeparator);
 
       if (wouldCheckForNsInKey && !seemsNaturalLanguage) {
         var m = key.match(this.interpolator.nestingRegexp);
@@ -1627,6 +1629,124 @@ var Interpolator = function () {
   return Interpolator;
 }();
 
+function parseFormatStr(formatStr) {
+  var formatName = formatStr.toLowerCase();
+  var formatOptions = {};
+
+  if (formatStr.indexOf('(') > -1) {
+    var p = formatStr.split('(');
+    formatName = p[0].toLowerCase();
+    var 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 {
+      var opts = optStr.split(';');
+      opts.forEach(function (opt) {
+        if (!opt) return;
+
+        var _opt$split = opt.split(':'),
+            _opt$split2 = _slicedToArray__default['default'](_opt$split, 2),
+            key = _opt$split2[0],
+            val = _opt$split2[1];
+
+        if (val.trim() === 'false') formatOptions[key.trim()] = false;
+        if (val.trim() === 'true') formatOptions[key.trim()] = true;
+        if (!isNaN(val.trim())) formatOptions[key.trim()] = parseInt(val.trim(), 10);
+        if (!formatOptions[key.trim()]) formatOptions[key.trim()] = val.trim();
+      });
+    }
+  }
+
+  return {
+    formatName: formatName,
+    formatOptions: formatOptions
+  };
+}
+
+var Formatter = function () {
+  function Formatter() {
+    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+
+    _classCallCheck__default['default'](this, Formatter);
+
+    this.logger = baseLogger.create('formatter');
+    this.options = options;
+    this.formats = {
+      number: function number(val, lng, options) {
+        return new Intl.NumberFormat(lng, options).format(val);
+      },
+      currency: function currency(val, lng, options) {
+        return new Intl.NumberFormat(lng, _objectSpread__default['default']({}, options, {
+          style: 'currency'
+        })).format(val);
+      },
+      datetime: function datetime(val, lng, options) {
+        return new Intl.DateTimeFormat(lng, _objectSpread__default['default']({}, options)).format(val);
+      },
+      relativetime: function relativetime(val, lng, options) {
+        return new Intl.RelativeTimeFormat(lng, _objectSpread__default['default']({}, options)).format(val, options.range || 'day');
+      },
+      list: function list(val, lng, options) {
+        return new Intl.ListFormat(lng, _objectSpread__default['default']({}, options)).format(val);
+      }
+    };
+    this.init(options);
+  }
+
+  _createClass__default['default'](Formatter, [{
+    key: "init",
+    value: function init(services) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+        interpolation: {}
+      };
+      var iOpts = options.interpolation;
+      this.formatSeparator = iOpts.formatSeparator ? iOpts.formatSeparator : iOpts.formatSeparator || ',';
+    }
+  }, {
+    key: "add",
+    value: function add(name, fc) {
+      this.formats[name] = fc;
+    }
+  }, {
+    key: "format",
+    value: function format(value, _format, lng, options) {
+      var _this = this;
+
+      var formats = _format.split(this.formatSeparator);
+
+      var result = formats.reduce(function (mem, f) {
+        var _parseFormatStr = parseFormatStr(f),
+            formatName = _parseFormatStr.formatName,
+            formatOptions = _parseFormatStr.formatOptions;
+
+        if (_this.formats[formatName]) {
+          var formatted = mem;
+
+          try {
+            var valOptions = options && options.formatParams && options.formatParams[options.interpolationkey] || {};
+            var l = valOptions.locale || valOptions.lng || options.locale || options.lng || lng;
+            formatted = _this.formats[formatName](mem, l, _objectSpread__default['default']({}, formatOptions, options, valOptions));
+          } catch (error) {
+            _this.logger.warn(error);
+          }
+
+          return formatted;
+        } else {
+          _this.logger.warn("there was no format function for ".concat(formatName));
+        }
+
+        return mem;
+      }, value);
+      return result;
+    }
+  }]);
+
+  return Formatter;
+}();
+
 function remove(arr, what) {
   var found = arr.indexOf(what);
 
@@ -1996,7 +2116,8 @@ var I18n = function (_EventEmitter) {
         }
       }
 
-      this.options = _objectSpread__default['default']({}, get(), this.options, transformOptions(options));
+      var defOpts = get();
+      this.options = _objectSpread__default['default']({}, defOpts, this.options, transformOptions(options));
 
       if (options.keySeparator !== undefined) {
         this.options.userDefinedKeySeparator = options.keySeparator;
@@ -2006,9 +2127,6 @@ var I18n = function (_EventEmitter) {
         this.options.userDefinedNsSeparator = options.nsSeparator;
       }
 
-      this.format = this.options.interpolation.format;
-      if (!callback) callback = noop;
-
       function createClassOnDemand(ClassOrObject) {
         if (!ClassOrObject) return null;
         if (typeof ClassOrObject === 'function') return new ClassOrObject();
@@ -2022,6 +2140,14 @@ var I18n = function (_EventEmitter) {
           baseLogger.init(null, this.options);
         }
 
+        var formatter;
+
+        if (this.modules.formatter) {
+          formatter = this.modules.formatter;
+        } else if (typeof Intl !== 'undefined') {
+          formatter = Formatter;
+        }
+
         var lu = new LanguageUtil(this.options);
         this.store = new ResourceStore(this.options.resources, this.options);
         var s = this.services;
@@ -2033,6 +2159,13 @@ var I18n = function (_EventEmitter) {
           compatibilityJSON: this.options.compatibilityJSON,
           simplifyPluralSuffix: this.options.simplifyPluralSuffix
         });
+
+        if (formatter && this.options.interpolation.format === defOpts.interpolation.format) {
+          s.formatter = createClassOnDemand(formatter);
+          s.formatter.init(s, this.options);
+          this.options.interpolation.format = s.formatter.format.bind(s.formatter);
+        }
+
         s.interpolator = new Interpolator(this.options);
         s.utils = {
           hasLoadedNamespace: this.hasLoadedNamespace.bind(this)
@@ -2069,6 +2202,9 @@ var I18n = function (_EventEmitter) {
         });
       }
 
+      this.format = this.options.interpolation.format;
+      if (!callback) callback = noop;
+
       if (this.options.fallbackLng && !this.services.languageDetector && !this.options.lng) {
         var codes = this.services.languageUtils.getFallbackCodes(this.options.fallbackLng);
         if (codes.length > 0 && codes[0] !== 'dev') this.options.lng = codes[0];
@@ -2206,6 +2342,10 @@ var I18n = function (_EventEmitter) {
         postProcessor.addPostProcessor(module);
       }
 
+      if (module.type === 'formatter') {
+        this.modules.formatter = module;
+      }
+
       if (module.type === '3rdParty') {
         this.modules.external.push(module);
       }

package/dist/esm/i18next.bundled.js

@@ -117,6 +117,62 @@ function _possibleConstructorReturn(self, call) {
   return _assertThisInitialized(self);
 }
 
+function _slicedToArray(arr, i) {
+  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+
+function _arrayWithHoles(arr) {
+  if (Array.isArray(arr)) return arr;
+}
+
+function _iterableToArrayLimit(arr, i) {
+  if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return;
+  var _arr = [];
+  var _n = true;
+  var _d = false;
+  var _e = undefined;
+
+  try {
+    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
+      _arr.push(_s.value);
+
+      if (i && _arr.length === i) break;
+    }
+  } catch (err) {
+    _d = true;
+    _e = err;
+  } finally {
+    try {
+      if (!_n && _i["return"] != null) _i["return"]();
+    } finally {
+      if (_d) throw _e;
+    }
+  }
+
+  return _arr;
+}
+
+function _unsupportedIterableToArray(o, minLen) {
+  if (!o) return;
+  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+  var n = Object.prototype.toString.call(o).slice(8, -1);
+  if (n === "Object" && o.constructor) n = o.constructor.name;
+  if (n === "Map" || n === "Set") return Array.from(o);
+  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+
+function _arrayLikeToArray(arr, len) {
+  if (len == null || len > arr.length) len = arr.length;
+
+  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
+
+  return arr2;
+}
+
+function _nonIterableRest() {
+  throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+
 var consoleLogger = {
   type: 'logger',
   log: function log(args) {
@@ -705,7 +761,7 @@ var Translator = function (_EventEmitter) {
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
       var namespaces = options.ns || this.options.defaultNS;
       var wouldCheckForNsInKey = nsSeparator && key.indexOf(nsSeparator) > -1;
-      var seemsNaturalLanguage = !this.options.userDefinedKeySeparator && !this.options.userDefinedNsSeparator && !options.keySeparator && !looksLikeObjectPath(key, nsSeparator, keySeparator);
+      var seemsNaturalLanguage = !this.options.userDefinedKeySeparator && !options.keySeparator && !this.options.userDefinedNsSeparator && !options.nsSeparator && !looksLikeObjectPath(key, nsSeparator, keySeparator);
 
       if (wouldCheckForNsInKey && !seemsNaturalLanguage) {
         var m = key.match(this.interpolator.nestingRegexp);
@@ -1724,6 +1780,124 @@ var Interpolator = function () {
   return Interpolator;
 }();
 
+function parseFormatStr(formatStr) {
+  var formatName = formatStr.toLowerCase();
+  var formatOptions = {};
+
+  if (formatStr.indexOf('(') > -1) {
+    var p = formatStr.split('(');
+    formatName = p[0].toLowerCase();
+    var 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 {
+      var opts = optStr.split(';');
+      opts.forEach(function (opt) {
+        if (!opt) return;
+
+        var _opt$split = opt.split(':'),
+            _opt$split2 = _slicedToArray(_opt$split, 2),
+            key = _opt$split2[0],
+            val = _opt$split2[1];
+
+        if (val.trim() === 'false') formatOptions[key.trim()] = false;
+        if (val.trim() === 'true') formatOptions[key.trim()] = true;
+        if (!isNaN(val.trim())) formatOptions[key.trim()] = parseInt(val.trim(), 10);
+        if (!formatOptions[key.trim()]) formatOptions[key.trim()] = val.trim();
+      });
+    }
+  }
+
+  return {
+    formatName: formatName,
+    formatOptions: formatOptions
+  };
+}
+
+var Formatter = function () {
+  function Formatter() {
+    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+
+    _classCallCheck(this, Formatter);
+
+    this.logger = baseLogger.create('formatter');
+    this.options = options;
+    this.formats = {
+      number: function number(val, lng, options) {
+        return new Intl.NumberFormat(lng, options).format(val);
+      },
+      currency: function currency(val, lng, options) {
+        return new Intl.NumberFormat(lng, _objectSpread({}, options, {
+          style: 'currency'
+        })).format(val);
+      },
+      datetime: function datetime(val, lng, options) {
+        return new Intl.DateTimeFormat(lng, _objectSpread({}, options)).format(val);
+      },
+      relativetime: function relativetime(val, lng, options) {
+        return new Intl.RelativeTimeFormat(lng, _objectSpread({}, options)).format(val, options.range || 'day');
+      },
+      list: function list(val, lng, options) {
+        return new Intl.ListFormat(lng, _objectSpread({}, options)).format(val);
+      }
+    };
+    this.init(options);
+  }
+
+  _createClass(Formatter, [{
+    key: "init",
+    value: function init(services) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+        interpolation: {}
+      };
+      var iOpts = options.interpolation;
+      this.formatSeparator = iOpts.formatSeparator ? iOpts.formatSeparator : iOpts.formatSeparator || ',';
+    }
+  }, {
+    key: "add",
+    value: function add(name, fc) {
+      this.formats[name] = fc;
+    }
+  }, {
+    key: "format",
+    value: function format(value, _format, lng, options) {
+      var _this = this;
+
+      var formats = _format.split(this.formatSeparator);
+
+      var result = formats.reduce(function (mem, f) {
+        var _parseFormatStr = parseFormatStr(f),
+            formatName = _parseFormatStr.formatName,
+            formatOptions = _parseFormatStr.formatOptions;
+
+        if (_this.formats[formatName]) {
+          var formatted = mem;
+
+          try {
+            var valOptions = options && options.formatParams && options.formatParams[options.interpolationkey] || {};
+            var l = valOptions.locale || valOptions.lng || options.locale || options.lng || lng;
+            formatted = _this.formats[formatName](mem, l, _objectSpread({}, formatOptions, options, valOptions));
+          } catch (error) {
+            _this.logger.warn(error);
+          }
+
+          return formatted;
+        } else {
+          _this.logger.warn("there was no format function for ".concat(formatName));
+        }
+
+        return mem;
+      }, value);
+      return result;
+    }
+  }]);
+
+  return Formatter;
+}();
+
 function remove(arr, what) {
   var found = arr.indexOf(what);
 
@@ -2093,7 +2267,8 @@ var I18n = function (_EventEmitter) {
         }
       }
 
-      this.options = _objectSpread({}, get(), this.options, transformOptions(options));
+      var defOpts = get();
+      this.options = _objectSpread({}, defOpts, this.options, transformOptions(options));
 
       if (options.keySeparator !== undefined) {
         this.options.userDefinedKeySeparator = options.keySeparator;
@@ -2103,9 +2278,6 @@ var I18n = function (_EventEmitter) {
         this.options.userDefinedNsSeparator = options.nsSeparator;
       }
 
-      this.format = this.options.interpolation.format;
-      if (!callback) callback = noop;
-
       function createClassOnDemand(ClassOrObject) {
         if (!ClassOrObject) return null;
         if (typeof ClassOrObject === 'function') return new ClassOrObject();
@@ -2119,6 +2291,14 @@ var I18n = function (_EventEmitter) {
           baseLogger.init(null, this.options);
         }
 
+        var formatter;
+
+        if (this.modules.formatter) {
+          formatter = this.modules.formatter;
+        } else if (typeof Intl !== 'undefined') {
+          formatter = Formatter;
+        }
+
         var lu = new LanguageUtil(this.options);
         this.store = new ResourceStore(this.options.resources, this.options);
         var s = this.services;
@@ -2130,6 +2310,13 @@ var I18n = function (_EventEmitter) {
           compatibilityJSON: this.options.compatibilityJSON,
           simplifyPluralSuffix: this.options.simplifyPluralSuffix
         });
+
+        if (formatter && this.options.interpolation.format === defOpts.interpolation.format) {
+          s.formatter = createClassOnDemand(formatter);
+          s.formatter.init(s, this.options);
+          this.options.interpolation.format = s.formatter.format.bind(s.formatter);
+        }
+
         s.interpolator = new Interpolator(this.options);
         s.utils = {
           hasLoadedNamespace: this.hasLoadedNamespace.bind(this)
@@ -2166,6 +2353,9 @@ var I18n = function (_EventEmitter) {
         });
       }
 
+      this.format = this.options.interpolation.format;
+      if (!callback) callback = noop;
+
       if (this.options.fallbackLng && !this.services.languageDetector && !this.options.lng) {
         var codes = this.services.languageUtils.getFallbackCodes(this.options.fallbackLng);
         if (codes.length > 0 && codes[0] !== 'dev') this.options.lng = codes[0];
@@ -2303,6 +2493,10 @@ var I18n = function (_EventEmitter) {
         postProcessor.addPostProcessor(module);
       }
 
+      if (module.type === 'formatter') {
+        this.modules.formatter = module;
+      }
+
       if (module.type === '3rdParty') {
         this.modules.external.push(module);
       }