react-intl 4.2.2 → 4.5.0

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 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.
 
+## [4.5.0](https://github.com/formatjs/react-intl/compare/v4.4.0...v4.5.0) (2020-04-20)
+
+
+### Features
+
+* upgrade intl-messageformat & parser ([cbbd6cf](https://github.com/formatjs/react-intl/commit/cbbd6cf93ee6294bdfbc28af3e33227df0e621e4))
+
+## [4.4.0](https://github.com/formatjs/react-intl/compare/v4.3.1...v4.4.0) (2020-04-14)
+
+
+### Features
+
+* add `defineMessage` macro to tag single message ([8bd9ad8](https://github.com/formatjs/react-intl/commit/8bd9ad8ddf632f500f4b3e0e7786a48c227c9961))
+
+### [4.3.1](https://github.com/formatjs/react-intl/compare/v4.3.0...v4.3.1) (2020-03-28)
+
+
+### Bug Fixes
+
+* tweak FormatXMLElementFn ([a914dc0](https://github.com/formatjs/react-intl/commit/a914dc059cc8d0c04baec6a63513cb686ff6dad3))
+
+## [4.3.0](https://github.com/formatjs/react-intl/compare/v4.2.2...v4.3.0) (2020-03-26)
+
+
+### Features
+
+* **react-intl:** store original message descriptor in the error ([22531bd](https://github.com/formatjs/react-intl/commit/22531bde78e0f3846b583b5bf0e4115e872f9a54))
+
 ### [4.2.2](https://github.com/formatjs/react-intl/compare/v4.2.1...v4.2.2) (2020-03-21)
 
 

package/README.md

@@ -36,7 +36,7 @@ _(If you're looking for React Intl v1, you can find it [here][v1-docs].)_
 
 There are several [runnable examples][examples] in this Git repo, but here's a Hello World one:
 
-```js
+```tsx
 import React, {Component} from 'react';
 import ReactDOM from 'react-dom';
 import {IntlProvider, FormattedMessage} from 'react-intl';

package/dist/components/createFormattedComponent.js

@@ -54,7 +54,9 @@ exports.createFormattedDateTimePartsComponent = createFormattedDateTimePartsComp
 function createFormattedComponent(name) {
     var Component = function (props) { return (React.createElement(injectIntl_1.Context.Consumer, null, function (intl) {
         utils_1.invariantIntlContext(intl);
-        var value = props.value, children = props.children, formatProps = __rest(props, ["value", "children"]);
+        var value = props.value, children = props.children, formatProps = __rest(props
+        // TODO: fix TS type definition for localeMatcher upstream
+        , ["value", "children"]);
         // TODO: fix TS type definition for localeMatcher upstream
         var formattedValue = intl[name](value, formatProps);
         if (typeof children === 'function') {

package/dist/components/injectIntl.js

@@ -34,9 +34,8 @@ function injectIntl(WrappedComponent, options) {
         if (enforceContext) {
             utils_1.invariantIntlContext(intl);
         }
-        return (React.createElement(WrappedComponent, __assign({}, props, (_a = {},
-            _a[intlPropName] = intl,
-            _a), { ref: forwardRef ? props.forwardedRef : null })));
+        var intlProp = (_a = {}, _a[intlPropName] = intl, _a);
+        return (React.createElement(WrappedComponent, __assign({}, props, intlProp, { ref: forwardRef ? props.forwardedRef : null })));
     })); };
     WithIntl.displayName = "injectIntl(" + getDisplayName(WrappedComponent) + ")";
     WithIntl.WrappedComponent = WrappedComponent;

package/dist/components/message.d.ts

@@ -6,7 +6,7 @@ export interface Props<V extends Record<string, any> = Record<string, React.Reac
     tagName?: React.ElementType<any>;
     children?(...nodes: React.ReactNodeArray): React.ReactNode;
 }
-declare class FormattedMessage<T = React.ReactNode, V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>> extends React.Component<Props<V>> {
+declare class FormattedMessage<V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<React.ReactNode, React.ReactNode>>> extends React.Component<Props<V>> {
     static displayName: string;
     static defaultProps: {
         values: {};

package/dist/error.d.ts

@@ -1,3 +1,4 @@
+import { MessageDescriptor } from './types';
 export declare const enum ReactIntlErrorCode {
     FORMAT_ERROR = "FORMAT_ERROR",
     UNSUPPORTED_FORMATTER = "UNSUPPORTED_FORMATTER",
@@ -6,6 +7,7 @@ export declare const enum ReactIntlErrorCode {
     MISSING_TRANSLATION = "MISSING_TRANSLATION"
 }
 export declare class ReactIntlError extends Error {
-    code: ReactIntlErrorCode;
-    constructor(code: ReactIntlErrorCode, message: string, exception?: Error);
+    readonly code: ReactIntlErrorCode;
+    readonly descriptor?: MessageDescriptor;
+    constructor(code: ReactIntlErrorCode, message: string, descriptor?: MessageDescriptor, exception?: Error);
 }

package/dist/error.js

@@ -23,9 +23,10 @@ var ReactIntlErrorCode;
 })(ReactIntlErrorCode = exports.ReactIntlErrorCode || (exports.ReactIntlErrorCode = {}));
 var ReactIntlError = /** @class */ (function (_super) {
     __extends(ReactIntlError, _super);
-    function ReactIntlError(code, message, exception) {
+    function ReactIntlError(code, message, descriptor, exception) {
         var _this = _super.call(this, "[React Intl Error " + code + "] " + message + " " + (exception ? "\n" + exception.stack : '')) || this;
         _this.code = code;
+        _this.descriptor = descriptor;
         if (typeof Error.captureStackTrace === 'function') {
             Error.captureStackTrace(_this, ReactIntlError);
         }

package/dist/formatters/message.js

@@ -70,7 +70,7 @@ function formatMessage(_a, state, messageDescriptor, values) {
         }
         catch (e) {
             onError(new error_1.ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, "Error formatting message: \"" + id + "\" for locale: \"" + locale + "\"" +
-                (defaultMessage ? ', using default message as fallback.' : ''), e));
+                (defaultMessage ? ', using default message as fallback.' : ''), messageDescriptor, e));
         }
     }
     else if (!defaultMessage ||
@@ -79,7 +79,7 @@ function formatMessage(_a, state, messageDescriptor, values) {
         // when no `messages` are passed into the <IntlProvider> for the
         // default locale.
         onError(new error_1.ReactIntlError("MISSING_TRANSLATION" /* MISSING_TRANSLATION */, "Missing message: \"" + id + "\" for locale: \"" + locale + "\"" +
-            (defaultMessage ? ', using default message as fallback.' : '')));
+            (defaultMessage ? ', using default message as fallback.' : ''), messageDescriptor));
     }
     if (!formattedMessageParts && defaultMessage) {
         try {
@@ -87,12 +87,12 @@ function formatMessage(_a, state, messageDescriptor, values) {
             formattedMessageParts = formatter.format(values);
         }
         catch (e) {
-            onError(new error_1.ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, "Error formatting the default message for: \"" + id + "\"", e));
+            onError(new error_1.ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, "Error formatting the default message for: \"" + id + "\"", messageDescriptor, e));
         }
     }
     if (!formattedMessageParts) {
         onError(new error_1.ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, "Cannot format message: \"" + id + "\", " +
-            ("using message " + (message || defaultMessage ? 'source' : 'id') + " as fallback.")));
+            ("using message " + (message || defaultMessage ? 'source' : 'id') + " as fallback."), messageDescriptor));
         if (typeof message === 'string') {
             return message || defaultMessage || String(id);
         }

package/dist/formatters/relativeTime.js

@@ -3,10 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var utils_1 = require("../utils");
 var intl_messageformat_1 = require("intl-messageformat");
 var error_1 = require("../error");
-var RELATIVE_TIME_FORMAT_OPTIONS = [
-    'numeric',
-    'style',
-];
+var RELATIVE_TIME_FORMAT_OPTIONS = ['numeric', 'style'];
 function getFormatter(_a, getRelativeTimeFormat, options) {
     var locale = _a.locale, formats = _a.formats, onError = _a.onError;
     if (options === void 0) { options = {}; }

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as React from 'react';
 export * from './types';
 export declare function defineMessages<T, U extends Record<string, T>>(msgs: U): U;
+export declare function defineMessage<T>(msg: T): T;
 import { CustomFormatConfig } from './types';
 import { UnifiedNumberFormatOptions } from '@formatjs/intl-unified-numberformat';
 import { IntlListFormatOptions } from '@formatjs/intl-listformat';

package/dist/index.js

@@ -4,6 +4,10 @@ function defineMessages(msgs) {
     return msgs;
 }
 exports.defineMessages = defineMessages;
+function defineMessage(msg) {
+    return msg;
+}
+exports.defineMessage = defineMessage;
 var createFormattedComponent_1 = require("./components/createFormattedComponent");
 var injectIntl_1 = require("./components/injectIntl");
 exports.injectIntl = injectIntl_1.default;

package/dist/react-intl.api.md

@@ -4,7 +4,7 @@
 
 ```ts
 
-import * as React from 'react';
+import * as React_2 from 'react';
 
 // Warning: (ae-forgotten-export) The symbol "OptionalIntlConfig" needs to be exported by the entry point index.d.ts
 //
@@ -30,6 +30,9 @@ export interface CustomFormats extends Partial<Formats> {
     relative?: Record<string, IntlRelativeTimeFormatOptions>;
 }
 
+// @public (undocumented)
+export function defineMessage<T>(msg: T): T;
+
 // @public (undocumented)
 export function defineMessages<T, U extends Record<string, T>>(msgs: U): U;
 
@@ -58,24 +61,24 @@ export type FormatPluralOptions = Exclude<Intl.PluralRulesOptions, 'localeMatche
 export type FormatRelativeTimeOptions = Exclude<IntlRelativeTimeFormatOptions, 'localeMatcher'> & CustomFormatConfig;
 
 // @public (undocumented)
-export const FormattedDate: React.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
+export const FormattedDate: React_2.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
     value: string | number | Date | undefined;
 }>;
 
 // @public (undocumented)
-export const FormattedDateParts: React.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
+export const FormattedDateParts: React_2.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
     value: string | number | Date | undefined;
-    children(val: Intl.DateTimeFormatPart[]): React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null;
+    children(val: Intl.DateTimeFormatPart[]): React_2.ReactElement<any, string | ((props: any) => React_2.ReactElement<any, string | any | (new (props: any) => React_2.Component<any, any, any>)> | null) | (new (props: any) => React_2.Component<any, any, any>)> | null;
 }>;
 
 // @public (undocumented)
-export const FormattedDisplayName: React.FC<DisplayNamesOptions & {
+export const FormattedDisplayName: React_2.FC<DisplayNamesOptions & {
     value: string | number | object;
 }>;
 
 // @public (undocumented)
-export const FormattedList: React.FC<IntlListFormatOptions & {
-    value: React.ReactNode[];
+export const FormattedList: React_2.FC<IntlListFormatOptions & {
+    value: React_2.ReactNode[];
 }>;
 
 // Warning: (ae-forgotten-export) The symbol "PrimitiveType" needs to be exported by the entry point index.d.ts
@@ -83,7 +86,7 @@ export const FormattedList: React.FC<IntlListFormatOptions & {
 // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export class FormattedMessage<T = React.ReactNode, V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>> extends React.Component<Props_3<V>> {
+export class FormattedMessage<V extends Record<string, any> = Record<string, PrimitiveType | React_2.ReactElement | FormatXMLElementFn<React_2.ReactNode, React_2.ReactNode>>> extends React_2.Component<Props_3<V>> {
     // (undocumented)
     static defaultProps: {
         values: {};
@@ -97,32 +100,32 @@ export class FormattedMessage<T = React.ReactNode, V extends Record<string, any>
 }
 
 // @public (undocumented)
-export const FormattedNumber: React.FC<UnifiedNumberFormatOptions & CustomFormatConfig & {
+export const FormattedNumber: React_2.FC<UnifiedNumberFormatOptions & CustomFormatConfig & {
     value: number;
 }>;
 
 // Warning: (ae-forgotten-export) The symbol "Formatter" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export const FormattedNumberParts: React.FC<Formatter['formatNumber'] & {
+export const FormattedNumberParts: React_2.FC<Formatter['formatNumber'] & {
     value: Parameters<IntlShape['formatNumber']>[0];
-    children(val: Intl.NumberFormatPart[]): React.ReactElement | null;
+    children(val: Intl.NumberFormatPart[]): React_2.ReactElement | null;
 }>;
 
 // 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" | "localeMatcher" | "format" | "type" | "value"> & {
-    forwardedRef?: ((instance: any) => void) | React.RefObject<any> | null | undefined;
-} & React.RefAttributes<any>> & {
-    WrappedComponent: React.ComponentType<Props_2>;
+export const FormattedPlural: React_2.ForwardRefExoticComponent<Pick<Props_2, "children" | "other" | "zero" | "one" | "two" | "few" | "many" | "localeMatcher" | "format" | "type" | "value"> & {
+    forwardedRef?: ((instance: any) => void) | React_2.RefObject<any> | null | undefined;
+} & React_2.RefAttributes<any>> & {
+    WrappedComponent: React_2.ComponentType<Props_2>;
 };
 
 // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "State" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export class FormattedRelativeTime extends React.PureComponent<Props, State_2> {
+export class FormattedRelativeTime extends React_2.PureComponent<Props, State_2> {
     constructor(props: Props);
     // (undocumented)
     componentDidMount(): void;
@@ -147,14 +150,14 @@ export class FormattedRelativeTime extends React.PureComponent<Props, State_2> {
 }
 
 // @public (undocumented)
-export const FormattedTime: React.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
+export const FormattedTime: React_2.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
     value: string | number | Date | undefined;
 }>;
 
 // @public (undocumented)
-export const FormattedTimeParts: React.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
+export const FormattedTimeParts: React_2.FC<Intl.DateTimeFormatOptions & CustomFormatConfig & {
     value: string | number | Date | undefined;
-    children(val: Intl.DateTimeFormatPart[]): React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null;
+    children(val: Intl.DateTimeFormatPart[]): React_2.ReactElement<any, string | ((props: any) => React_2.ReactElement<any, string | any | (new (props: any) => React_2.Component<any, any, any>)> | null) | (new (props: any) => React_2.Component<any, any, any>)> | null;
 }>;
 
 // @public (undocumented)
@@ -186,13 +189,13 @@ export interface Formatters {
 // Warning: (ae-forgotten-export) The symbol "Opts" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export function injectIntl<IntlPropName extends string, P extends WrappedComponentProps<IntlPropName> = WrappedComponentProps<any>>(WrappedComponent: React.ComponentType<P>, options?: Opts<IntlPropName, false>): React.FC<WithIntlProps<P>> & {
-    WrappedComponent: React.ComponentType<P>;
+export function injectIntl<IntlPropName extends string, P extends WrappedComponentProps<IntlPropName> = WrappedComponentProps<any>>(WrappedComponent: React_2.ComponentType<P>, options?: Opts<IntlPropName, false>): React_2.FC<WithIntlProps<P>> & {
+    WrappedComponent: React_2.ComponentType<P>;
 };
 
 // @public (undocumented)
-export function injectIntl<IntlPropName extends string = 'intl', P extends WrappedComponentProps<IntlPropName> = WrappedComponentProps<any>, T extends React.ComponentType<P> = any>(WrappedComponent: React.ComponentType<P>, options?: Opts<IntlPropName, true>): React.ForwardRefExoticComponent<React.PropsWithoutRef<WithIntlProps<P>> & React.RefAttributes<T>> & {
-    WrappedComponent: React.ComponentType<P>;
+export function injectIntl<IntlPropName extends string = 'intl', P extends WrappedComponentProps<IntlPropName> = WrappedComponentProps<any>, T extends React_2.ComponentType<P> = any>(WrappedComponent: React_2.ComponentType<P>, options?: Opts<IntlPropName, true>): React_2.ForwardRefExoticComponent<React_2.PropsWithoutRef<WithIntlProps<P>> & React_2.RefAttributes<T>> & {
+    WrappedComponent: React_2.ComponentType<P>;
 };
 
 // @public (undocumented)
@@ -232,7 +235,7 @@ export interface IntlConfig {
     // (undocumented)
     onError(err: ReactIntlError | FormatError): void;
     // (undocumented)
-    textComponent?: React.ComponentType | keyof React.ReactHTML;
+    textComponent?: React_2.ComponentType | keyof React_2.ReactHTML;
     // (undocumented)
     timeZone?: string;
     // (undocumented)
@@ -240,10 +243,10 @@ export interface IntlConfig {
 }
 
 // @public (undocumented)
-export const IntlContext: React.Context<IntlShape>;
+export const IntlContext: React_2.Context<IntlShape>;
 
 // @public (undocumented)
-export interface IntlFormatters<T = React.ReactNode> {
+export interface IntlFormatters<T = React_2.ReactNode, R = T> {
     // (undocumented)
     formatDate(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     // (undocumented)
@@ -253,11 +256,11 @@ export interface IntlFormatters<T = React.ReactNode> {
     // (undocumented)
     formatList(values: Array<string>, opts?: FormatListOptions): string;
     // (undocumented)
-    formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
+    formatList(values: Array<string | React_2.ReactNode>, opts?: FormatListOptions): React_2.ReactNode;
     // (undocumented)
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): string;
     // (undocumented)
-    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>): string | React.ReactNodeArray;
+    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React_2.ReactElement | FormatXMLElementFn<T, R>>): string | React_2.ReactNodeArray;
     // (undocumented)
     formatNumber(value: Parameters<Intl.NumberFormat['format']>[0], opts?: FormatNumberOptions): string;
     // (undocumented)
@@ -275,7 +278,7 @@ export interface IntlFormatters<T = React.ReactNode> {
 // Warning: (ae-forgotten-export) The symbol "State" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export class IntlProvider extends React.PureComponent<OptionalIntlConfig, State> {
+export class IntlProvider extends React_2.PureComponent<OptionalIntlConfig, State> {
     // (undocumented)
     static defaultProps: Pick<IntlConfig, "formats" | "messages" | "timeZone" | "textComponent" | "defaultLocale" | "defaultFormats" | "onError">;
     // (undocumented)
@@ -305,16 +308,20 @@ export interface MessageDescriptor {
 }
 
 // @public (undocumented)
-export type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
+type Omit_2<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
+
+export { Omit_2 as Omit }
 
 // @public (undocumented)
-export const RawIntlProvider: React.Provider<IntlShape>;
+export const RawIntlProvider: React_2.Provider<IntlShape>;
 
 // @public (undocumented)
 export class ReactIntlError extends Error {
-    constructor(code: ReactIntlErrorCode, message: string, exception?: Error);
+    constructor(code: ReactIntlErrorCode, message: string, descriptor?: MessageDescriptor, exception?: Error);
+    // (undocumented)
+    readonly code: ReactIntlErrorCode;
     // (undocumented)
-    code: ReactIntlErrorCode;
+    readonly descriptor?: MessageDescriptor;
 }
 
 // @public (undocumented)
@@ -335,8 +342,8 @@ export const enum ReactIntlErrorCode {
 export function useIntl(): IntlShape;
 
 // @public (undocumented)
-export type WithIntlProps<P> = Omit<P, keyof WrappedComponentProps> & {
-    forwardedRef?: React.Ref<any>;
+export type WithIntlProps<P> = Omit_2<P, keyof WrappedComponentProps> & {
+    forwardedRef?: React_2.Ref<any>;
 };
 
 // @public (undocumented)