use-intl 3.0.0-beta.2 → 3.0.0-rc.5

package/dist/createIntl-34d4281e.js

@@ -1,592 +0,0 @@
-'use strict';
-
-var IntlMessageFormat = require('intl-messageformat');
-var React = require('react');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var IntlMessageFormat__default = /*#__PURE__*/_interopDefaultLegacy(IntlMessageFormat);
-
-function _extends() {
-  _extends = Object.assign ? Object.assign.bind() : function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
-    }
-    return target;
-  };
-  return _extends.apply(this, arguments);
-}
-function _inheritsLoose(subClass, superClass) {
-  subClass.prototype = Object.create(superClass.prototype);
-  subClass.prototype.constructor = subClass;
-  _setPrototypeOf(subClass, superClass);
-}
-function _getPrototypeOf(o) {
-  _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) {
-    return o.__proto__ || Object.getPrototypeOf(o);
-  };
-  return _getPrototypeOf(o);
-}
-function _setPrototypeOf(o, p) {
-  _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) {
-    o.__proto__ = p;
-    return o;
-  };
-  return _setPrototypeOf(o, p);
-}
-function _isNativeReflectConstruct() {
-  if (typeof Reflect === "undefined" || !Reflect.construct) return false;
-  if (Reflect.construct.sham) return false;
-  if (typeof Proxy === "function") return true;
-  try {
-    Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {}));
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
-function _construct(Parent, args, Class) {
-  if (_isNativeReflectConstruct()) {
-    _construct = Reflect.construct.bind();
-  } else {
-    _construct = function _construct(Parent, args, Class) {
-      var a = [null];
-      a.push.apply(a, args);
-      var Constructor = Function.bind.apply(Parent, a);
-      var instance = new Constructor();
-      if (Class) _setPrototypeOf(instance, Class.prototype);
-      return instance;
-    };
-  }
-  return _construct.apply(null, arguments);
-}
-function _isNativeFunction(fn) {
-  return Function.toString.call(fn).indexOf("[native code]") !== -1;
-}
-function _wrapNativeSuper(Class) {
-  var _cache = typeof Map === "function" ? new Map() : undefined;
-  _wrapNativeSuper = function _wrapNativeSuper(Class) {
-    if (Class === null || !_isNativeFunction(Class)) return Class;
-    if (typeof Class !== "function") {
-      throw new TypeError("Super expression must either be null or a function");
-    }
-    if (typeof _cache !== "undefined") {
-      if (_cache.has(Class)) return _cache.get(Class);
-      _cache.set(Class, Wrapper);
-    }
-    function Wrapper() {
-      return _construct(Class, arguments, _getPrototypeOf(this).constructor);
-    }
-    Wrapper.prototype = Object.create(Class.prototype, {
-      constructor: {
-        value: Wrapper,
-        enumerable: false,
-        writable: true,
-        configurable: true
-      }
-    });
-    return _setPrototypeOf(Wrapper, Class);
-  };
-  return _wrapNativeSuper(Class);
-}
-function _objectWithoutPropertiesLoose(source, excluded) {
-  if (source == null) return {};
-  var target = {};
-  var sourceKeys = Object.keys(source);
-  var key, i;
-  for (i = 0; i < sourceKeys.length; i++) {
-    key = sourceKeys[i];
-    if (excluded.indexOf(key) >= 0) continue;
-    target[key] = source[key];
-  }
-  return target;
-}
-
-exports.IntlErrorCode = void 0;
-(function (IntlErrorCode) {
-  IntlErrorCode["MISSING_MESSAGE"] = "MISSING_MESSAGE";
-  IntlErrorCode["MISSING_FORMAT"] = "MISSING_FORMAT";
-  IntlErrorCode["INSUFFICIENT_PATH"] = "INSUFFICIENT_PATH";
-  IntlErrorCode["INVALID_MESSAGE"] = "INVALID_MESSAGE";
-  IntlErrorCode["INVALID_KEY"] = "INVALID_KEY";
-  IntlErrorCode["FORMATTING_ERROR"] = "FORMATTING_ERROR";
-})(exports.IntlErrorCode || (exports.IntlErrorCode = {}));
-var IntlError = /*#__PURE__*/function (_Error) {
-  _inheritsLoose(IntlError, _Error);
-  function IntlError(code, originalMessage) {
-    var _this;
-    var message = code;
-    if (originalMessage) {
-      message += ': ' + originalMessage;
-    }
-    _this = _Error.call(this, message) || this;
-    _this.code = void 0;
-    _this.originalMessage = void 0;
-    _this.code = code;
-    if (originalMessage) {
-      _this.originalMessage = originalMessage;
-    }
-    return _this;
-  }
-  return IntlError;
-}( /*#__PURE__*/_wrapNativeSuper(Error));
-
-function setTimeZoneInFormats(formats, timeZone) {
-  if (!formats) return formats;
-  // The only way to set a time zone with `intl-messageformat` is to merge it into the formats
-  // https://github.com/formatjs/formatjs/blob/8256c5271505cf2606e48e3c97ecdd16ede4f1b5/packages/intl/src/message.ts#L15
-  return Object.keys(formats).reduce(function (acc, key) {
-    acc[key] = _extends({
-      timeZone: timeZone
-    }, formats[key]);
-    return acc;
-  }, {});
-}
-/**
- * `intl-messageformat` uses separate keys for `date` and `time`, but there's
- * only one native API: `Intl.DateTimeFormat`. Additionally you might want to
- * include both a time and a date in a value, therefore the separation doesn't
- * seem so useful. We offer a single `dateTime` namespace instead, but we have
- * to convert the format before `intl-messageformat` can be used.
- */
-function convertFormatsToIntlMessageFormat(formats, timeZone) {
-  var formatsWithTimeZone = timeZone ? _extends({}, formats, {
-    dateTime: setTimeZoneInFormats(formats.dateTime, timeZone)
-  }) : formats;
-  var mfDateDefaults = IntlMessageFormat__default["default"].formats.date;
-  var defaultDateFormats = timeZone ? setTimeZoneInFormats(mfDateDefaults, timeZone) : mfDateDefaults;
-  var mfTimeDefaults = IntlMessageFormat__default["default"].formats.time;
-  var defaultTimeFormats = timeZone ? setTimeZoneInFormats(mfTimeDefaults, timeZone) : mfTimeDefaults;
-  return _extends({}, formatsWithTimeZone, {
-    date: _extends({}, defaultDateFormats, formatsWithTimeZone == null ? void 0 : formatsWithTimeZone.dateTime),
-    time: _extends({}, defaultTimeFormats, formatsWithTimeZone == null ? void 0 : formatsWithTimeZone.dateTime)
-  });
-}
-
-/**
- * Contains defaults that are used for all entry points into the core.
- * See also `InitializedIntlConfiguration`.
- */
-function defaultGetMessageFallback(props) {
-  return [props.namespace, props.key].filter(function (part) {
-    return part != null;
-  }).join('.');
-}
-function defaultOnError(error) {
-  console.error(error);
-}
-
-function resolvePath(messages, key, namespace) {
-  if (!messages) {
-    throw new Error("No messages available at `" + namespace + "`." );
-  }
-  var message = messages;
-  key.split('.').forEach(function (part) {
-    var next = message[part];
-    if (part == null || next == null) {
-      throw new Error("Could not resolve `" + key + "` in " + (namespace ? "`" + namespace + "`" : 'messages') + "." );
-    }
-    message = next;
-  });
-  return message;
-}
-function prepareTranslationValues(values) {
-  if (Object.keys(values).length === 0) return undefined;
-  // Workaround for https://github.com/formatjs/formatjs/issues/1467
-  var transformedValues = {};
-  Object.keys(values).forEach(function (key) {
-    var index = 0;
-    var value = values[key];
-    var transformed;
-    if (typeof value === 'function') {
-      transformed = function transformed(chunks) {
-        var result = value(chunks);
-        return React.isValidElement(result) ? React.cloneElement(result, {
-          key: key + index++
-        }) : result;
-      };
-    } else {
-      transformed = value;
-    }
-    transformedValues[key] = transformed;
-  });
-  return transformedValues;
-}
-function getMessagesOrError(_ref) {
-  var messages = _ref.messages,
-    namespace = _ref.namespace,
-    _ref$onError = _ref.onError,
-    onError = _ref$onError === void 0 ? defaultOnError : _ref$onError;
-  try {
-    if (!messages) {
-      throw new Error("development" !== 'production' ? "No messages were configured on the provider." : undefined);
-    }
-    var retrievedMessages = namespace ? resolvePath(messages, namespace) : messages;
-    if (!retrievedMessages) {
-      throw new Error("development" !== 'production' ? "No messages for namespace `" + namespace + "` found." : undefined);
-    }
-    return retrievedMessages;
-  } catch (error) {
-    var intlError = new IntlError(exports.IntlErrorCode.MISSING_MESSAGE, error.message);
-    onError(intlError);
-    return intlError;
-  }
-}
-function getPlainMessage(candidate, values) {
-  if (values) return undefined;
-  var unescapedMessage = candidate.replace(/'([{}])/gi, '$1');
-  // Placeholders can be in the message if there are default values,
-  // or if the user has forgotten to provide values. In the latter
-  // case we need to compile the message to receive an error.
-  var hasPlaceholders = /<|{/.test(unescapedMessage);
-  if (!hasPlaceholders) {
-    return unescapedMessage;
-  }
-  return undefined;
-}
-function createBaseTranslator(config) {
-  var messagesOrError = getMessagesOrError({
-    messages: config.messages,
-    namespace: config.namespace,
-    onError: config.onError
-  });
-  return createBaseTranslatorImpl(_extends({}, config, {
-    messagesOrError: messagesOrError
-  }));
-}
-function createBaseTranslatorImpl(_ref2) {
-  var defaultTranslationValues = _ref2.defaultTranslationValues,
-    globalFormats = _ref2.formats,
-    _ref2$getMessageFallb = _ref2.getMessageFallback,
-    getMessageFallback = _ref2$getMessageFallb === void 0 ? defaultGetMessageFallback : _ref2$getMessageFallb,
-    locale = _ref2.locale,
-    messageFormatCache = _ref2.messageFormatCache,
-    messagesOrError = _ref2.messagesOrError,
-    namespace = _ref2.namespace,
-    onError = _ref2.onError,
-    timeZone = _ref2.timeZone;
-  function getFallbackFromErrorAndNotify(key, code, message) {
-    var error = new IntlError(code, message);
-    onError(error);
-    return getMessageFallback({
-      error: error,
-      key: key,
-      namespace: namespace
-    });
-  }
-  function translateBaseFn( /** Use a dot to indicate a level of nesting (e.g. `namespace.nestedLabel`). */
-  key, /** Key value pairs for values to interpolate into the message. */
-  values, /** Provide custom formats for numbers, dates and times. */
-  formats) {
-    if (messagesOrError instanceof IntlError) {
-      // We have already warned about this during render
-      return getMessageFallback({
-        error: messagesOrError,
-        key: key,
-        namespace: namespace
-      });
-    }
-    var messages = messagesOrError;
-    var message;
-    try {
-      message = resolvePath(messages, key, namespace);
-    } catch (error) {
-      return getFallbackFromErrorAndNotify(key, exports.IntlErrorCode.MISSING_MESSAGE, error.message);
-    }
-    function joinPath(parts) {
-      return parts.filter(function (part) {
-        return part != null;
-      }).join('.');
-    }
-    var cacheKey = joinPath([locale, namespace, key, String(message)]);
-    var messageFormat;
-    if (messageFormatCache != null && messageFormatCache.has(cacheKey)) {
-      messageFormat = messageFormatCache.get(cacheKey);
-    } else {
-      if (typeof message === 'object') {
-        var code, errorMessage;
-        if (Array.isArray(message)) {
-          code = exports.IntlErrorCode.INVALID_MESSAGE;
-          {
-            errorMessage = "Message at `" + joinPath([namespace, key]) + "` resolved to an array, but only strings are supported. See https://next-intl-docs.vercel.app/docs/usage/messages#arrays-of-messages";
-          }
-        } else {
-          code = exports.IntlErrorCode.INSUFFICIENT_PATH;
-          {
-            errorMessage = "Message at `" + joinPath([namespace, key]) + "` resolved to an object, but only strings are supported. Use a `.` to retrieve nested messages. See https://next-intl-docs.vercel.app/docs/usage/messages#structuring-messages";
-          }
-        }
-        return getFallbackFromErrorAndNotify(key, code, errorMessage);
-      }
-      // Hot path that avoids creating an `IntlMessageFormat` instance
-      var plainMessage = getPlainMessage(message, values);
-      if (plainMessage) return plainMessage;
-      try {
-        messageFormat = new IntlMessageFormat__default["default"](message, locale, convertFormatsToIntlMessageFormat(_extends({}, globalFormats, formats), timeZone));
-      } catch (error) {
-        return getFallbackFromErrorAndNotify(key, exports.IntlErrorCode.INVALID_MESSAGE, error.message);
-      }
-      messageFormatCache == null ? void 0 : messageFormatCache.set(cacheKey, messageFormat);
-    }
-    try {
-      var formattedMessage = messageFormat.format(
-      // @ts-ignore `intl-messageformat` expects a different format
-      // for rich text elements since a recent minor update. This
-      // needs to be evaluated in detail, possibly also in regards
-      // to be able to format to parts.
-      prepareTranslationValues(_extends({}, defaultTranslationValues, values)));
-      if (formattedMessage == null) {
-        throw new Error("development" !== 'production' ? "Unable to format `" + key + "` in " + (namespace ? "namespace `" + namespace + "`" : 'messages') : undefined);
-      }
-      // Limit the function signature to return strings or React elements
-      return React.isValidElement(formattedMessage) ||
-      // Arrays of React elements
-      Array.isArray(formattedMessage) || typeof formattedMessage === 'string' ? formattedMessage : String(formattedMessage);
-    } catch (error) {
-      return getFallbackFromErrorAndNotify(key, exports.IntlErrorCode.FORMATTING_ERROR, error.message);
-    }
-  }
-  function translateFn( /** Use a dot to indicate a level of nesting (e.g. `namespace.nestedLabel`). */
-  key, /** Key value pairs for values to interpolate into the message. */
-  values, /** Provide custom formats for numbers, dates and times. */
-  formats) {
-    var result = translateBaseFn(key, values, formats);
-    if (typeof result !== 'string') {
-      return getFallbackFromErrorAndNotify(key, exports.IntlErrorCode.INVALID_MESSAGE, "The message `" + key + "` in " + (namespace ? "namespace `" + namespace + "`" : 'messages') + " didn't resolve to a string. If you want to format rich text, use `t.rich` instead." );
-    }
-    return result;
-  }
-  translateFn.rich = translateBaseFn;
-  translateFn.raw = function ( /** Use a dot to indicate a level of nesting (e.g. `namespace.nestedLabel`). */
-  key) {
-    if (messagesOrError instanceof IntlError) {
-      // We have already warned about this during render
-      return getMessageFallback({
-        error: messagesOrError,
-        key: key,
-        namespace: namespace
-      });
-    }
-    var messages = messagesOrError;
-    try {
-      return resolvePath(messages, key, namespace);
-    } catch (error) {
-      return getFallbackFromErrorAndNotify(key, exports.IntlErrorCode.MISSING_MESSAGE, error.message);
-    }
-  };
-  return translateFn;
-}
-
-/**
- * For the strictly typed messages to work we have to wrap the namespace into
- * a mandatory prefix. See https://stackoverflow.com/a/71529575/343045
- */
-function resolveNamespace(namespace, namespacePrefix) {
-  return namespace === namespacePrefix ? undefined : namespace.slice((namespacePrefix + '.').length);
-}
-
-var MINUTE = 60;
-var HOUR = MINUTE * 60;
-var DAY = HOUR * 24;
-var WEEK = DAY * 7;
-var MONTH = DAY * (365 / 12); // Approximation
-var YEAR = DAY * 365;
-function getRelativeTimeFormatConfig(seconds) {
-  var absValue = Math.abs(seconds);
-  var value, unit;
-  // We have to round the resulting values, as `Intl.RelativeTimeFormat`
-  // will include fractions like '2.1 hours ago'.
-  if (absValue < MINUTE) {
-    unit = 'second';
-    value = Math.round(seconds);
-  } else if (absValue < HOUR) {
-    unit = 'minute';
-    value = Math.round(seconds / MINUTE);
-  } else if (absValue < DAY) {
-    unit = 'hour';
-    value = Math.round(seconds / HOUR);
-  } else if (absValue < WEEK) {
-    unit = 'day';
-    value = Math.round(seconds / DAY);
-  } else if (absValue < MONTH) {
-    unit = 'week';
-    value = Math.round(seconds / WEEK);
-  } else if (absValue < YEAR) {
-    unit = 'month';
-    value = Math.round(seconds / MONTH);
-  } else {
-    unit = 'year';
-    value = Math.round(seconds / YEAR);
-  }
-  return {
-    value: value,
-    unit: unit
-  };
-}
-function createFormatter(_ref) {
-  var formats = _ref.formats,
-    locale = _ref.locale,
-    globalNow = _ref.now,
-    _ref$onError = _ref.onError,
-    onError = _ref$onError === void 0 ? defaultOnError : _ref$onError,
-    timeZone = _ref.timeZone;
-  function resolveFormatOrOptions(typeFormats, formatOrOptions) {
-    var options;
-    if (typeof formatOrOptions === 'string') {
-      var formatName = formatOrOptions;
-      options = typeFormats == null ? void 0 : typeFormats[formatName];
-      if (!options) {
-        var error = new IntlError(exports.IntlErrorCode.MISSING_FORMAT, "Format `" + formatName + "` is not available. You can configure it on the provider or provide custom options." );
-        onError(error);
-        throw error;
-      }
-    } else {
-      options = formatOrOptions;
-    }
-    return options;
-  }
-  function getFormattedValue(value, formatOrOptions, typeFormats, formatter) {
-    var options;
-    try {
-      options = resolveFormatOrOptions(typeFormats, formatOrOptions);
-    } catch (error) {
-      return String(value);
-    }
-    try {
-      return formatter(options);
-    } catch (error) {
-      onError(new IntlError(exports.IntlErrorCode.FORMATTING_ERROR, error.message));
-      return String(value);
-    }
-  }
-  function dateTime( /** If a number is supplied, this is interpreted as a UTC timestamp. */
-  value,
-  /** If a time zone is supplied, the `value` is converted to that time zone.
-   * Otherwise the user time zone will be used. */
-  formatOrOptions) {
-    return getFormattedValue(value, formatOrOptions, formats == null ? void 0 : formats.dateTime, function (options) {
-      var _options;
-      if (timeZone && !((_options = options) != null && _options.timeZone)) {
-        options = _extends({}, options, {
-          timeZone: timeZone
-        });
-      }
-      return new Intl.DateTimeFormat(locale, options).format(value);
-    });
-  }
-  function number(value, formatOrOptions) {
-    return getFormattedValue(value, formatOrOptions, formats == null ? void 0 : formats.number, function (options) {
-      return new Intl.NumberFormat(locale, options).format(value);
-    });
-  }
-  function relativeTime( /** The date time that needs to be formatted. */
-  date, /** The reference point in time to which `date` will be formatted in relation to.  */
-  now) {
-    try {
-      if (!now) {
-        if (globalNow) {
-          now = globalNow;
-        } else {
-          throw new Error("development" !== 'production' ? "The `now` parameter wasn't provided and there was no global fallback configured on the provider." : undefined);
-        }
-      }
-      var dateDate = date instanceof Date ? date : new Date(date);
-      var nowDate = now instanceof Date ? now : new Date(now);
-      var seconds = (dateDate.getTime() - nowDate.getTime()) / 1000;
-      var _getRelativeTimeForma = getRelativeTimeFormatConfig(seconds),
-        unit = _getRelativeTimeForma.unit,
-        value = _getRelativeTimeForma.value;
-      return new Intl.RelativeTimeFormat(locale, {
-        numeric: 'auto'
-      }).format(value, unit);
-    } catch (error) {
-      onError(new IntlError(exports.IntlErrorCode.FORMATTING_ERROR, error.message));
-      return String(date);
-    }
-  }
-  function list(value, formatOrOptions) {
-    return getFormattedValue(value, formatOrOptions, formats == null ? void 0 : formats.list, function (options) {
-      return new Intl.ListFormat(locale, options).format(value);
-    });
-  }
-  return {
-    dateTime: dateTime,
-    number: number,
-    relativeTime: relativeTime,
-    list: list
-  };
-}
-
-function validateMessagesSegment(messages, invalidKeyLabels, parentPath) {
-  Object.entries(messages).forEach(function (_ref) {
-    var key = _ref[0],
-      messageOrMessages = _ref[1];
-    if (key.includes('.')) {
-      var keyLabel = key;
-      if (parentPath) keyLabel += " (at " + parentPath + ")";
-      invalidKeyLabels.push(keyLabel);
-    }
-    if (messageOrMessages != null && typeof messageOrMessages === 'object') {
-      validateMessagesSegment(messageOrMessages, invalidKeyLabels, [parentPath, key].filter(function (part) {
-        return part != null;
-      }).join('.'));
-    }
-  });
-}
-function validateMessages(messages, onError) {
-  var invalidKeyLabels = [];
-  validateMessagesSegment(messages, invalidKeyLabels);
-  if (invalidKeyLabels.length > 0) {
-    onError(new IntlError(exports.IntlErrorCode.INVALID_KEY, "Namespace keys can not contain the character \".\" as this is used to express nesting. Please remove it or replace it with another character.\n\nInvalid " + (invalidKeyLabels.length === 1 ? 'key' : 'keys') + ": " + invalidKeyLabels.join(', ') + "\n\nIf you're migrating from a flat structure, you can convert your messages as follows:\n\nimport {set} from \"lodash\";\n\nconst input = {\n  \"one.one\": \"1.1\",\n  \"one.two\": \"1.2\",\n  \"two.one.one\": \"2.1.1\"\n};\n\nconst output = Object.entries(input).reduce(\n  (acc, [key, value]) => set(acc, key, value),\n  {}\n);\n\n// Output:\n//\n// {\n//   \"one\": {\n//     \"one\": \"1.1\",\n//     \"two\": \"1.2\"\n//   },\n//   \"two\": {\n//     \"one\": {\n//       \"one\": \"2.1.1\"\n//     }\n//   }\n// }\n" ));
-  }
-}
-
-var _excluded = ["getMessageFallback", "messages", "onError"];
-/**
- * Enhances the incoming props with defaults.
- */
-function initializeConfig(_ref) {
-  var getMessageFallback = _ref.getMessageFallback,
-    messages = _ref.messages,
-    onError = _ref.onError,
-    rest = _objectWithoutPropertiesLoose(_ref, _excluded);
-  var finalOnError = onError || defaultOnError;
-  var finalGetMessageFallback = getMessageFallback || defaultGetMessageFallback;
-  {
-    if (messages) {
-      validateMessages(messages, finalOnError);
-    }
-  }
-  return _extends({}, rest, {
-    messages: messages,
-    onError: finalOnError,
-    getMessageFallback: finalGetMessageFallback
-  });
-}
-
-/** @deprecated Switch to `createFormatter` */
-function createIntl() {
-  var formatter = createFormatter.apply(void 0, arguments);
-  return {
-    formatDateTime: formatter.dateTime,
-    formatNumber: formatter.number,
-    formatRelativeTime: formatter.relativeTime
-  };
-}
-
-exports.IntlError = IntlError;
-exports._extends = _extends;
-exports._objectWithoutPropertiesLoose = _objectWithoutPropertiesLoose;
-exports.createBaseTranslator = createBaseTranslator;
-exports.createFormatter = createFormatter;
-exports.createIntl = createIntl;
-exports.defaultGetMessageFallback = defaultGetMessageFallback;
-exports.defaultOnError = defaultOnError;
-exports.initializeConfig = initializeConfig;
-exports.resolveNamespace = resolveNamespace;
-//# sourceMappingURL=createIntl-34d4281e.js.map