react-intl 3.12.0 → 4.1.1

package/dist/react-intl.d.ts

@@ -5,11 +5,6 @@ import * as React from 'react';
 
 declare type ArgumentElement = BaseElement<TYPE.argument>;
 
-declare interface ArgumentPart {
-    type: PART_TYPE.argument;
-    value: any;
-}
-
 declare interface BaseElement<T extends TYPE> {
     type: T;
     value: string;
@@ -50,6 +45,12 @@ declare interface ElementPart {
     value: string;
 }
 
+declare const enum ErrorCode {
+    MISSING_VALUE = 0,
+    INVALID_VALUE = 1,
+    MISSING_INTL_API = 2
+}
+
 declare interface FieldData {
     '0'?: string;
     '1'?: string;
@@ -66,6 +67,12 @@ export declare type FormatDateOptions = Exclude<Intl.DateTimeFormatOptions, 'loc
 
 export declare type FormatDisplayNameOptions = Exclude<DisplayNamesOptions, 'localeMatcher'>;
 
+declare class FormatError extends Error {
+    readonly code: ErrorCode;
+    constructor(msg: string, code: ErrorCode);
+    toString(): string;
+}
+
 export declare type FormatListOptions = Exclude<IntlListFormatOptions, 'localeMatcher'>;
 
 export declare type FormatNumberOptions = Exclude<UnifiedNumberFormatOptions, 'localeMatcher'> & CustomFormatConfig;
@@ -95,20 +102,11 @@ export declare const FormattedDisplayName: React.FC<DisplayNamesOptions_2 & {
     value: string | number | object;
 }>;
 
-export declare class FormattedHTMLMessage extends FormattedMessage<Record<string, PrimitiveType>> {
-    static displayName: string;
-    static defaultProps: {
-        tagName: "span";
-        values: {};
-    };
-    render(): JSX.Element;
-}
-
 export declare const FormattedList: React.FC<IntlListFormatOptions & {
     value: React.ReactNode[];
 }>;
 
-export declare class FormattedMessage<V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn>> extends React.Component<Props_3<V>> {
+export declare class FormattedMessage<T = React.ReactNode, V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>> extends React.Component<Props_3<V>> {
     static displayName: string;
     static defaultProps: {
         values: {};
@@ -126,7 +124,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" | "format" | "localeMatcher" | "type" | "value"> & {
+export declare 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>;
@@ -179,7 +177,7 @@ declare interface Formatters_2 {
     getPluralRules(...args: ConstructorParameters<typeof Intl.PluralRules>): Intl.PluralRules;
 }
 
-declare type FormatXMLElementFn = (...args: any[]) => string | object;
+declare type FormatXMLElementFn<T> = (...args: Array<string | T>) => string | Array<string | T>;
 
 export declare 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>;
@@ -207,12 +205,12 @@ export declare interface IntlConfig {
     messages: Record<string, string> | Record<string, MessageFormatElement[]>;
     defaultLocale: string;
     defaultFormats: CustomFormats;
-    onError(err: string): void;
+    onError(err: ReactIntlError | FormatError): void;
 }
 
 export declare const IntlContext: React.Context<IntlShape>;
 
-export declare interface IntlFormatters {
+export declare interface IntlFormatters<T = React.ReactNode> {
     formatDate(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatTime(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatDateToParts(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): Intl.DateTimeFormatPart[];
@@ -222,8 +220,7 @@ export declare interface IntlFormatters {
     formatNumberToParts(value: Parameters<Intl.NumberFormat['format']>[0], opts?: FormatNumberOptions): Intl.NumberFormatPart[];
     formatPlural(value: Parameters<Intl.PluralRules['select']>[0], opts?: FormatPluralOptions): ReturnType<Intl.PluralRules['select']>;
     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;
+    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>): string | React.ReactNodeArray;
     formatList(values: Array<string>, opts?: FormatListOptions): string;
     formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
     formatDisplayName(value: Parameters<DisplayNames['of']>[0], opts?: FormatDisplayNameOptions): string | undefined;
@@ -263,9 +260,8 @@ declare class IntlMessageFormat {
     private readonly message;
     private readonly formatterCache;
     constructor(message: string | MessageFormatElement[], locales?: string | string[], overrideFormats?: Partial<Formats>, opts?: Options);
-    format: (values?: Record<string, PrimitiveType> | undefined) => string;
-    formatToParts: (values?: Record<string, any> | undefined) => MessageFormatPart[];
-    formatHTMLMessage: (values?: Record<string, string | number | boolean | object | Date | FormatXMLElementFn | null | undefined> | undefined) => (string | object)[];
+    format: <T = void>(values?: Record<string, string | number | boolean | Date | T | FormatXMLElementFn<T> | null | undefined> | undefined) => string | T | (string | T)[];
+    formatToParts: <T>(values?: Record<string, string | number | boolean | Date | T | FormatXMLElementFn<T> | null | undefined> | undefined) => MessageFormatPart<T>[];
     resolvedOptions: () => {
         locale: string;
     };
@@ -459,9 +455,9 @@ export declare interface MessageDescriptor {
     defaultMessage?: string;
 }
 
-declare type MessageFormatElement = LiteralElement | ArgumentElement | NumberElement | DateElement | TimeElement | SelectElement | PluralElement | PoundElement;
+declare type MessageFormatElement = LiteralElement | ArgumentElement | NumberElement | DateElement | TimeElement | SelectElement | PluralElement | TagElement | PoundElement;
 
-declare type MessageFormatPart = LiteralPart_2 | ArgumentPart;
+declare type MessageFormatPart<T> = LiteralPart_2 | ObjectPart<T>;
 
 declare type NumberElement = SimpleFormatElement<TYPE.number, NumberSkeleton>;
 
@@ -484,6 +480,11 @@ declare interface NumberSkeletonToken {
     options: string[];
 }
 
+declare interface ObjectPart<T = any> {
+    type: PART_TYPE.object;
+    value: T;
+}
+
 export declare type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
 
 declare type OptionalIntlConfig = Omit<IntlConfig, keyof typeof DEFAULT_INTL_CONFIG> & Partial<typeof DEFAULT_INTL_CONFIG>;
@@ -522,7 +523,7 @@ declare type Part_2 = LiteralPart | ElementPart;
 
 declare const enum PART_TYPE {
     literal = 0,
-    argument = 1
+    object = 1
 }
 
 declare interface PluralElement extends BaseElement<TYPE.plural> {
@@ -570,6 +571,19 @@ declare interface Props_3<V extends Record<string, any> = Record<string, React.R
 
 export declare const RawIntlProvider: React.Provider<IntlShape>;
 
+export declare class ReactIntlError extends Error {
+    code: ReactIntlErrorCode;
+    constructor(code: ReactIntlErrorCode, message: string, exception?: Error);
+}
+
+export declare const enum ReactIntlErrorCode {
+    FORMAT_ERROR = "FORMAT_ERROR",
+    UNSUPPORTED_FORMATTER = "UNSUPPORTED_FORMATTER",
+    INVALID_CONFIG = "INVALID_CONFIG",
+    MISSING_DATA = "MISSING_DATA",
+    MISSING_TRANSLATION = "MISSING_TRANSLATION"
+}
+
 declare type RelativeTimeData = {
     [u in LDMLPluralRule]?: string;
 };
@@ -679,6 +693,13 @@ declare interface State_2 {
     currentValueInSeconds: number;
 }
 
+declare interface TagElement {
+    type: TYPE.tag;
+    value: string;
+    children: MessageFormatElement[];
+    location?: Location;
+}
+
 declare type TimeElement = SimpleFormatElement<TYPE.time, DateTimeSkeleton>;
 
 declare enum TYPE {
@@ -714,21 +735,41 @@ declare enum TYPE {
      * Only possible within plural argument.
      * This is the `#` symbol that will be substituted with the count.
      */
-    pound = 7
+    pound = 7,
+    /**
+     * XML-like tag
+     */
+    tag = 8
 }
 
 declare type UnifiedNumberFormatOptions = Intl.NumberFormatOptions & NumberFormatDigitOptions & {
-    localeMatcher?: 'lookup' | 'best fit';
-    style?: 'decimal' | 'percent' | 'currency' | 'unit';
-    compactDisplay?: 'short' | 'long';
-    currencyDisplay?: 'symbol' | 'code' | 'name' | 'narrowSymbol';
-    currencySign?: 'standard' | 'accounting';
-    notation?: 'standard' | 'scientific' | 'engineering' | 'compact';
-    signDisplay?: 'auto' | 'always' | 'never' | 'exceptZero';
+    localeMatcher?: UnifiedNumberFormatOptionsLocaleMatcher;
+    style?: UnifiedNumberFormatOptionsStyle;
+    compactDisplay?: UnifiedNumberFormatOptionsCompactDisplay;
+    currencyDisplay?: UnifiedNumberFormatOptionsCurrencyDisplay;
+    currencySign?: UnifiedNumberFormatOptionsCurrencySign;
+    notation?: UnifiedNumberFormatOptionsNotation;
+    signDisplay?: UnifiedNumberFormatOptionsSignDisplay;
     unit?: Unit_2;
-    unitDisplay?: 'long' | 'short' | 'narrow';
+    unitDisplay?: UnifiedNumberFormatOptionsUnitDisplay;
 };
 
+declare type UnifiedNumberFormatOptionsCompactDisplay = 'short' | 'long';
+
+declare type UnifiedNumberFormatOptionsCurrencyDisplay = 'symbol' | 'code' | 'name' | 'narrowSymbol';
+
+declare type UnifiedNumberFormatOptionsCurrencySign = 'standard' | 'accounting';
+
+declare type UnifiedNumberFormatOptionsLocaleMatcher = 'lookup' | 'best fit';
+
+declare type UnifiedNumberFormatOptionsNotation = 'standard' | 'scientific' | 'engineering' | 'compact';
+
+declare type UnifiedNumberFormatOptionsSignDisplay = 'auto' | 'always' | 'never' | 'exceptZero';
+
+declare type UnifiedNumberFormatOptionsStyle = 'decimal' | 'percent' | 'currency' | 'unit';
+
+declare type UnifiedNumberFormatOptionsUnitDisplay = 'long' | 'short' | 'narrow';
+
 declare type Unit = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
 
 declare type Unit_2 = 'degree' | 'acre' | 'hectare' | 'percent' | 'bit' | 'byte' | 'gigabit' | 'gigabyte' | 'kilobit' | 'kilobyte' | 'megabit' | 'megabyte' | 'petabyte' | 'terabit' | 'terabyte' | 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'second' | 'week' | 'year' | 'centimeter' | 'foot' | 'inch' | 'kilometer' | 'meter' | 'mile-scandinavian' | 'mile' | 'millimeter' | 'yard' | 'gram' | 'kilogram' | 'ounce' | 'pound' | 'stone' | 'celsius' | 'fahrenheit' | 'fluid-ounce' | 'gallon' | 'liter' | 'milliliter';