react-intl 3.7.0 → 3.9.2

package/CHANGELOG.md

@@ -2,28 +2,72 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [3.7.0](https://github.com/formatjs/react-intl/compare/v3.6.2...v3.7.0) (2019-11-25)
+### [3.9.2](https://github.com/formatjs/react-intl/compare/v3.9.1...v3.9.2) (2019-12-10)
 
 
-### Features
+### Bug Fixes
 
-* Introduce support for DateTime skeleton ([568d013](https://github.com/formatjs/react-intl/commit/568d01342299135e9b049f9d4014193315fac41e))
+* add type overload for formatList, fix [#1537](https://github.com/formatjs/react-intl/issues/1537) ([6629899](https://github.com/formatjs/react-intl/commit/662989973c8d08f7972a3ba75f70b19abc507bb9))
+* fix list formatter generation types ([0e5f205](https://github.com/formatjs/react-intl/commit/0e5f2058d7cba2d886693e219f58366582f0a6ac))
 
-### [3.6.2](https://github.com/formatjs/react-intl/compare/v3.6.1...v3.6.2) (2019-11-21)
+### [3.9.1](https://github.com/formatjs/react-intl/compare/v3.9.0...v3.9.1) (2019-12-02)
 
 
 ### Bug Fixes
 
-* fix main types file path in package.json ([14048bb](https://github.com/formatjs/react-intl/commit/14048bba41a7e02a8a0669ef14aa510acb089dc9))
+* Add src to packaged tar for sourcemap ([bce9bc7](https://github.com/formatjs/react-intl/commit/bce9bc7f6e014ec5ac1d67aa5daedc9214b75297))
 
-### [3.6.1](https://github.com/formatjs/react-intl/compare/v3.6.0...v3.6.1) (2019-11-19)
+## [3.9.0](https://github.com/formatjs/react-intl/compare/v3.8.0...v3.9.0) (2019-12-02)
 
 
-### Bug Fixes
+### Features
 
-* make `id` optional in MessageDescriptor ([15ca429](https://github.com/formatjs/react-intl/commit/15ca4292faf0fd82a392c024f027196393e52124))
-* use `files` instead of .npmignore, update contributors ([b0c0fdb](https://github.com/formatjs/react-intl/commit/b0c0fdb1efa4dd9dfcf1d8c5709c5454bf242fce))
+* Upgrade intl-messageformat-parser with support for unit-width in skeleton ([4b8f09f](https://github.com/formatjs/react-intl/commit/4b8f09f567ea09c5f5b576113ed963523832f942))
 
+## [3.8.0](https://github.com/formatjs/react-intl/compare/v3.7.0...v3.8.0) (2019-12-01)
+
+
+### Features
+
+* Upgrade intl-messageformat-parser ([c12c99d](https://github.com/formatjs/react-intl/commit/c12c99dfdd8dfabf3d0103ce3c02e35b22d03be6))
+
+Following our previous release with preliminary DateTimeFormat's
+skeleton parser, this release comes with a subset of ICU NumberFormat's
+skeleton parser. The full feature set can be found [here](unicode-org/icu:docs/userguide/format_parse/numbers/skeletons.md@master).
+
+This, in combination with [intl-unified-numberformat](tc39/proposal-unified-intl-numberformat) allows you to write shorthand
+NumberFormat in your messages like `{amount, number, ::currency/CAD .00}`
+
+## [3.7.0](https://github.com/formatjs/react-intl/compare/v3.6.2...v3.7.0) (2019-11-25)
+
+
+### Features
+
+* Introduce support for DateTime skeleton ([568d013](https://github.com/formatjs/react-intl/commit/568d01342299135e9b049f9d4014193315fac41e))
+
+This bumps the version of `intl-messageformat`, thus introducing a
+subset of
+[DateTime Skeleton](https://github.com/formatjs/formatjs/tree/master/packages/intl-messageformat-parser#supported-datetime-skeleton)
+to react-intl.
+The skeleton syntax per ICU is `today is {ts, time, ::yyyyMMdd}`.
+Further documentation can be read at
+http://userguide.icu-project.org/formatparse/datetime.
+
+### [3.6.2](https://github.com/formatjs/react-intl/compare/v3.6.1...v3.6.2) (2019-11-21)
+
+
+### Bug Fixes
+
+* fix main types file path in package.json ([14048bb](https://github.com/formatjs/react-intl/commit/14048bba41a7e02a8a0669ef14aa510acb089dc9))
+
+### [3.6.1](https://github.com/formatjs/react-intl/compare/v3.6.0...v3.6.1) (2019-11-19)
+
+
+### Bug Fixes
+
+* make `id` optional in MessageDescriptor ([15ca429](https://github.com/formatjs/react-intl/commit/15ca4292faf0fd82a392c024f027196393e52124))
+* use `files` instead of .npmignore, update contributors ([b0c0fdb](https://github.com/formatjs/react-intl/commit/b0c0fdb1efa4dd9dfcf1d8c5709c5454bf242fce))
+
 ## [3.6.0](https://github.com/formatjs/react-intl/compare/v3.4.0...v3.6.0) (2019-11-12)
 
 

package/dist/components/plural.d.ts

@@ -11,7 +11,7 @@ interface Props extends FormatPluralOptions {
     many?: React.ReactNode;
     children?(value: React.ReactNode): React.ReactElement | null;
 }
-declare const _default: React.ForwardRefExoticComponent<Pick<Props, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "type" | "localeMatcher" | "format" | "value"> & {
+declare const _default: React.ForwardRefExoticComponent<Pick<Props, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "localeMatcher" | "type" | "format" | "value"> & {
     forwardedRef?: ((instance: any) => void) | React.RefObject<any> | null | undefined;
 } & React.RefAttributes<any>> & {
     WrappedComponent: React.ComponentType<Props>;

package/dist/formatters/list.d.ts

@@ -1,3 +1,2 @@
-import * as React from 'react';
 import { IntlConfig, Formatters, IntlFormatters } from '../types';
-export declare function formatList({ locale, onError }: Pick<IntlConfig, 'locale' | 'onError'>, getListFormat: Formatters['getListFormat'], values: Parameters<IntlFormatters['formatList']>[0], options?: Parameters<IntlFormatters['formatList']>[1]): string | React.ReactNode;
+export declare function formatList({ locale, onError }: Pick<IntlConfig, 'locale' | 'onError'>, getListFormat: Formatters['getListFormat'], values: Array<string>, options: Parameters<IntlFormatters['formatList']>[1]): string;

package/dist/react-intl.api.md

@@ -116,7 +116,7 @@ export const FormattedNumberParts: React.FC<Formatter['formatNumber'] & {
 // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export const FormattedPlural: React.ForwardRefExoticComponent<Pick<Props_2, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "type" | "localeMatcher" | "format" | "value"> & {
+export const FormattedPlural: React.ForwardRefExoticComponent<Pick<Props_2, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "localeMatcher" | "type" | "format" | "value"> & {
     forwardedRef?: ((instance: any) => void) | React.RefObject<any> | null | undefined;
 } & React.RefAttributes<any>> & {
     WrappedComponent: React.ComponentType<Props_2>;
@@ -245,6 +245,8 @@ export interface IntlFormatters {
     // (undocumented)
     formatHTMLMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): React.ReactNode;
     // (undocumented)
+    formatList(values: Array<string>, opts?: FormatListOptions): string;
+    // (undocumented)
     formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
     // (undocumented)
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): string;

package/dist/react-intl.d.ts

@@ -117,7 +117,7 @@ export declare const FormattedNumberParts: React.FC<Formatter['formatNumber'] &
     children(val: Intl.NumberFormatPart[]): React.ReactElement | null;
 }>;
 
-export declare const FormattedPlural: React.ForwardRefExoticComponent<Pick<Props_2, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "type" | "localeMatcher" | "format" | "value"> & {
+export declare const FormattedPlural: React.ForwardRefExoticComponent<Pick<Props_2, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "localeMatcher" | "type" | "format" | "value"> & {
     forwardedRef?: ((instance: any) => void) | React.RefObject<any> | null | undefined;
 } & React.RefAttributes<any>> & {
     WrappedComponent: React.ComponentType<Props_2>;
@@ -212,6 +212,7 @@ export declare interface IntlFormatters {
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): string;
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn>): string | React.ReactNodeArray;
     formatHTMLMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): React.ReactNode;
+    formatList(values: Array<string>, opts?: FormatListOptions): string;
     formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
 }
 
@@ -413,11 +414,6 @@ declare interface LiteralPart_2 {
     value: string;
 }
 
-declare interface LiteralPart_3 {
-    type: 'literal';
-    value: string;
-}
-
 declare type Locale = string;
 
 declare interface LocaleData<T> {
@@ -501,7 +497,7 @@ declare type ParseOptions = Options_2 & IParseOptions;
 
 declare type Part = LiteralPart | RelativeTimeFormatNumberPart;
 
-declare type Part_2 = LiteralPart_3 | ElementPart;
+declare type Part_2 = LiteralPart | ElementPart;
 
 declare const enum PART_TYPE {
     literal = 0,

package/dist/react-intl.js

@@ -222,6 +222,11 @@
 	function isPluralElement(el) {
 	  return el.type === TYPE.plural;
 	}
+	function isNumberSkeleton(el) {
+	  return !!(el && _typeof(el) === 'object' && el.type === 0
+	  /* number */
+	  );
+	}
 	function isDateTimeSkeleton(el) {
 	  return !!(el && _typeof(el) === 'object' && el.type === 1
 	  /* dateTime */
@@ -3018,11 +3023,28 @@
 	  });
 	}
 
+	var __assign$1 = undefined && undefined.__assign || function () {
+	  __assign$1 = Object.assign || function (t) {
+	    for (var s, i = 1, n = arguments.length; i < n; i++) {
+	      s = arguments[i];
+
+	      for (var p in s) {
+	        if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+	      }
+	    }
+
+	    return t;
+	  };
+
+	  return __assign$1.apply(this, arguments);
+	};
 	/**
 	 * https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
 	 * Credit: https://github.com/caridy/intl-datetimeformat-pattern/blob/master/index.js
 	 * with some tweaks
 	 */
+
+
 	var DATE_TIME_REGEX = /(?:[Eec]{1,6}|G{1,5}|[Qq]{1,5}|(?:[yYur]+|U{1,5})|[ML]{1,5}|d{1,2}|D{1,3}|F{1}|[abB]{1,5}|[hkHK]{1,2}|w{1,2}|W{1}|m{1,2}|s{1,2}|[zZOvVxX]{1,4})(?=([^']*'[^']*')*[^']*$)/g;
 	/**
 	 * Parse Date time skeleton into Intl.DateTimeFormatOptions
@@ -3177,6 +3199,221 @@
 	  return result;
 	}
 
+	function icuUnitToEcma(unit) {
+	  return unit.replace(/^(.*?)-/, '');
+	}
+
+	var FRACTION_PRECISION_REGEX = /^\.(?:(0+)(\+|#+)?)?$/g;
+	var SIGNIFICANT_PRECISION_REGEX = /^(@+)?(\+|#+)?$/g;
+
+	function parseSignificantPrecision(str) {
+	  var result = {};
+	  str.replace(SIGNIFICANT_PRECISION_REGEX, function (_, g1, g2) {
+	    // @@@ case
+	    if (typeof g2 !== 'string') {
+	      result.minimumSignificantDigits = g1.length;
+	      result.maximumSignificantDigits = g1.length;
+	    } // @@@+ case
+	    else if (g2 === '+') {
+	        result.minimumSignificantDigits = g1.length;
+	      } // .### case
+	      else if (g1[0] === '#') {
+	          result.maximumSignificantDigits = g1.length;
+	        } // .@@## or .@@@ case
+	        else {
+	            result.minimumSignificantDigits = g1.length;
+	            result.maximumSignificantDigits = g1.length + (typeof g2 === 'string' ? g2.length : 0);
+	          }
+
+	    return '';
+	  });
+	  return result;
+	}
+
+	function parseSign(str) {
+	  switch (str) {
+	    case 'sign-auto':
+	      return {
+	        signDisplay: 'auto'
+	      };
+
+	    case 'sign-accounting':
+	      return {
+	        currencySign: 'accounting'
+	      };
+
+	    case 'sign-always':
+	      return {
+	        signDisplay: 'always'
+	      };
+
+	    case 'sign-accounting-always':
+	      return {
+	        signDisplay: 'always',
+	        currencySign: 'accounting'
+	      };
+
+	    case 'sign-except-zero':
+	      return {
+	        signDisplay: 'exceptZero'
+	      };
+
+	    case 'sign-accounting-except-zero':
+	      return {
+	        signDisplay: 'exceptZero',
+	        currencySign: 'accounting'
+	      };
+
+	    case 'sign-never':
+	      return {
+	        signDisplay: 'never'
+	      };
+	  }
+	}
+
+	function parseNotationOptions(opt) {
+	  var result = {};
+	  var signOpts = parseSign(opt);
+
+	  if (signOpts) {
+	    return signOpts;
+	  }
+
+	  return result;
+	}
+	/**
+	 * https://github.com/unicode-org/icu/blob/master/docs/userguide/format_parse/numbers/skeletons.md#skeleton-stems-and-options
+	 */
+
+
+	function convertNumberSkeletonToNumberFormatOptions(tokens) {
+	  var result = {};
+
+	  for (var _i = 0, tokens_1 = tokens; _i < tokens_1.length; _i++) {
+	    var token = tokens_1[_i];
+
+	    switch (token.stem) {
+	      case 'percent':
+	        result.style = 'percent';
+	        continue;
+
+	      case 'currency':
+	        result.style = 'currency';
+	        result.currency = token.options[0];
+	        continue;
+
+	      case 'group-off':
+	        result.useGrouping = false;
+	        continue;
+
+	      case 'precision-integer':
+	        result.maximumFractionDigits = 0;
+	        continue;
+
+	      case 'measure-unit':
+	        result.style = 'unit';
+	        result.unit = icuUnitToEcma(token.options[0]);
+	        continue;
+
+	      case 'compact-short':
+	        result.notation = 'compact';
+	        result.compactDisplay = 'short';
+	        continue;
+
+	      case 'compact-long':
+	        result.notation = 'compact';
+	        result.compactDisplay = 'long';
+	        continue;
+
+	      case 'scientific':
+	        result = __assign$1(__assign$1(__assign$1({}, result), {
+	          notation: 'scientific'
+	        }), token.options.reduce(function (all, opt) {
+	          return __assign$1(__assign$1({}, all), parseNotationOptions(opt));
+	        }, {}));
+	        continue;
+
+	      case 'engineering':
+	        result = __assign$1(__assign$1(__assign$1({}, result), {
+	          notation: 'engineering'
+	        }), token.options.reduce(function (all, opt) {
+	          return __assign$1(__assign$1({}, all), parseNotationOptions(opt));
+	        }, {}));
+	        continue;
+
+	      case 'notation-simple':
+	        result.notation = 'standard';
+	        continue;
+	      // https://github.com/unicode-org/icu/blob/master/icu4c/source/i18n/unicode/unumberformatter.h
+
+	      case 'unit-width-narrow':
+	        result.currencyDisplay = 'narrowSymbol';
+	        result.unitDisplay = 'narrow';
+	        continue;
+
+	      case 'unit-width-short':
+	        result.currencyDisplay = 'code';
+	        result.unitDisplay = 'short';
+	        continue;
+
+	      case 'unit-width-full-name':
+	        result.currencyDisplay = 'name';
+	        result.unitDisplay = 'long';
+	        continue;
+
+	      case 'unit-width-iso-code':
+	        result.currencyDisplay = 'symbol';
+	        continue;
+	    } // Precision
+	    // https://github.com/unicode-org/icu/blob/master/docs/userguide/format_parse/numbers/skeletons.md#fraction-precision
+
+
+	    if (FRACTION_PRECISION_REGEX.test(token.stem)) {
+	      if (token.options.length > 1) {
+	        throw new RangeError('Fraction-precision stems only accept a single optional option');
+	      }
+
+	      token.stem.replace(FRACTION_PRECISION_REGEX, function (match, g1, g2) {
+	        // precision-integer case
+	        if (match === '.') {
+	          result.maximumFractionDigits = 0;
+	        } // .000+ case
+	        else if (g2 === '+') {
+	            result.minimumFractionDigits = g2.length;
+	          } // .### case
+	          else if (g1[0] === '#') {
+	              result.maximumFractionDigits = g1.length;
+	            } // .00## or .000 case
+	            else {
+	                result.minimumFractionDigits = g1.length;
+	                result.maximumFractionDigits = g1.length + (typeof g2 === 'string' ? g2.length : 0);
+	              }
+
+	        return '';
+	      });
+
+	      if (token.options.length) {
+	        result = __assign$1(__assign$1({}, result), parseSignificantPrecision(token.options[0]));
+	      }
+
+	      continue;
+	    }
+
+	    if (SIGNIFICANT_PRECISION_REGEX.test(token.stem)) {
+	      result = __assign$1(__assign$1({}, result), parseSignificantPrecision(token.stem));
+	      continue;
+	    }
+
+	    var signOpts = parseSign(token.stem);
+
+	    if (signOpts) {
+	      result = __assign$1(__assign$1({}, result), signOpts);
+	    }
+	  }
+
+	  return result;
+	}
+
 	function parse(input, opts) {
 	  var els = pegParse(input, opts);
 
@@ -3417,7 +3654,7 @@
 	    }
 
 	    if (isNumberElement(el)) {
-	      var style = typeof el.style === 'string' ? formats.number[el.style] : undefined;
+	      var style = typeof el.style === 'string' ? formats.number[el.style] : isNumberSkeleton(el.style) ? convertNumberSkeletonToNumberFormatOptions(el.style.tokens) : undefined;
 	      result.push({
 	        type: 0
 	        /* literal */
@@ -3612,8 +3849,8 @@
 	Copyrights licensed under the New BSD License.
 	See the accompanying LICENSE file for terms.
 	*/
-	var __assign$1 = undefined && undefined.__assign || function () {
-	  __assign$1 = Object.assign || function (t) {
+	var __assign$2 = undefined && undefined.__assign || function () {
+	  __assign$2 = Object.assign || function (t) {
 	    for (var s, i = 1, n = arguments.length; i < n; i++) {
 	      s = arguments[i];
 
@@ -3625,7 +3862,7 @@
 	    return t;
 	  };
 
-	  return __assign$1.apply(this, arguments);
+	  return __assign$2.apply(this, arguments);
 	};
 
 	function mergeConfig(c1, c2) {
@@ -3633,8 +3870,8 @@
 	    return c1;
 	  }
 
-	  return __assign$1(__assign$1(__assign$1({}, c1 || {}), c2 || {}), Object.keys(c1).reduce(function (all, k) {
-	    all[k] = __assign$1(__assign$1({}, c1[k]), c2[k] || {});
+	  return __assign$2(__assign$2(__assign$2({}, c1 || {}), c2 || {}), Object.keys(c1).reduce(function (all, k) {
+	    all[k] = __assign$2(__assign$2({}, c1[k]), c2[k] || {});
 	    return all;
 	  }, {}));
 	}
@@ -3647,7 +3884,7 @@
 	  return Object.keys(defaultConfig).reduce(function (all, k) {
 	    all[k] = mergeConfig(defaultConfig[k], configs[k]);
 	    return all;
-	  }, __assign$1({}, defaultConfig));
+	  }, __assign$2({}, defaultConfig));
 	}
 
 	function createDefaultFormatters(cache) {
@@ -4800,7 +5037,7 @@
 	  for (var i = 0; i < len; i++) {
 	    var key = aKeys[i];
 
-	    if (objA[key] !== objB[key]) {
+	    if (objA[key] !== objB[key] || !Object.prototype.hasOwnProperty.call(objB, key)) {
 	      return false;
 	    }
 	  }