react-intl 3.9.3 → 3.12.1

package/dist/react-intl.d.ts

@@ -1,3 +1,6 @@
+import { DisplayNames } from '@formatjs/intl-displaynames';
+import { DisplayNamesOptions } from '@formatjs/intl-displaynames';
+import { DisplayNamesOptions as DisplayNamesOptions_2 } from '@formatjs/intl-displaynames/lib';
 import * as React from 'react';
 
 declare type ArgumentElement = BaseElement<TYPE.argument>;
@@ -61,6 +64,8 @@ declare interface FieldData {
 
 export declare type FormatDateOptions = Exclude<Intl.DateTimeFormatOptions, 'localeMatcher'> & CustomFormatConfig;
 
+export declare type FormatDisplayNameOptions = Exclude<DisplayNamesOptions, 'localeMatcher'>;
+
 export declare type FormatListOptions = Exclude<IntlListFormatOptions, 'localeMatcher'>;
 
 export declare type FormatNumberOptions = Exclude<UnifiedNumberFormatOptions, 'localeMatcher'> & CustomFormatConfig;
@@ -81,11 +86,15 @@ export declare const FormattedDate: React.FC<Intl.DateTimeFormatOptions & Custom
     value: string | number | Date | undefined;
 }>;
 
-export declare const FormattedDateParts: React.FunctionComponent<Intl.DateTimeFormatOptions & CustomFormatConfig & {
+export declare const FormattedDateParts: React.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;
 }>;
 
+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: {
@@ -117,7 +126,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" | "localeMatcher" | "type" | "format" | "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>;
@@ -141,7 +150,7 @@ export declare const FormattedTime: React.FC<Intl.DateTimeFormatOptions & Custom
     value: string | number | Date | undefined;
 }>;
 
-export declare const FormattedTimeParts: React.FunctionComponent<Intl.DateTimeFormatOptions & CustomFormatConfig & {
+export declare const FormattedTimeParts: React.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;
 }>;
@@ -151,6 +160,7 @@ declare type Formatter = {
     formatTime: FormatDateOptions;
     formatNumber: FormatNumberOptions;
     formatList: FormatListOptions;
+    formatDisplayName: FormatDisplayNameOptions;
 };
 
 export declare interface Formatters {
@@ -160,6 +170,7 @@ export declare interface Formatters {
     getRelativeTimeFormat(...args: ConstructorParameters<typeof RelativeTimeFormat>): RelativeTimeFormat;
     getPluralRules(...args: ConstructorParameters<typeof Intl.PluralRules>): Intl.PluralRules;
     getListFormat(...args: ConstructorParameters<typeof ListFormat>): ListFormat;
+    getDisplayNames(...args: ConstructorParameters<typeof DisplayNames>): DisplayNames;
 }
 
 declare interface Formatters_2 {
@@ -185,6 +196,7 @@ export declare interface IntlCache {
     relativeTime: Record<string, RelativeTimeFormat>;
     pluralRules: Record<string, Intl.PluralRules>;
     list: Record<string, ListFormat>;
+    displayNames: Record<string, DisplayNames>;
 }
 
 export declare interface IntlConfig {
@@ -214,6 +226,7 @@ export declare interface IntlFormatters {
     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;
+    formatDisplayName(value: Parameters<DisplayNames['of']>[0], opts?: FormatDisplayNameOptions): string | undefined;
 }
 
 declare interface IntlListFormatOptions {
@@ -441,17 +454,25 @@ declare interface LocationDetails {
 }
 
 export declare interface MessageDescriptor {
-    id?: string;
+    id?: string | number;
     description?: string | object;
     defaultMessage?: string;
 }
 
-declare type MessageFormatElement = LiteralElement | ArgumentElement | NumberElement | DateElement | TimeElement | SelectElement | PluralElement;
+declare type MessageFormatElement = LiteralElement | ArgumentElement | NumberElement | DateElement | TimeElement | SelectElement | PluralElement | PoundElement;
 
 declare type MessageFormatPart = LiteralPart_2 | ArgumentPart;
 
 declare type NumberElement = SimpleFormatElement<TYPE.number, NumberSkeleton>;
 
+declare interface NumberFormatDigitOptions {
+    minimumIntegerDigits?: number;
+    minimumFractionDigits?: number;
+    maximumFractionDigits?: number;
+    minimumSignificantDigits?: number;
+    maximumSignificantDigits?: number;
+}
+
 declare interface NumberSkeleton {
     type: SKELETON_TYPE.number;
     tokens: NumberSkeletonToken[];
@@ -515,6 +536,11 @@ declare interface PluralOrSelectOption {
     location?: Location;
 }
 
+declare interface PoundElement {
+    type: TYPE.pound;
+    location?: Location;
+}
+
 declare type PrimitiveType = string | number | boolean | null | undefined | Date;
 
 declare interface Props extends FormatRelativeTimeOptions {
@@ -542,7 +568,7 @@ declare interface Props_3<V extends Record<string, any> = Record<string, React.R
     children?(...nodes: React.ReactNodeArray): React.ReactNode;
 }
 
-export declare const RawIntlProvider: React.ProviderExoticComponent<React.ProviderProps<IntlShape>>;
+export declare const RawIntlProvider: React.Provider<IntlShape>;
 
 declare type RelativeTimeData = {
     [u in LDMLPluralRule]?: string;
@@ -683,18 +709,41 @@ declare enum TYPE {
     /**
      * Variable w/ plural format
      */
-    plural = 6
+    plural = 6,
+    /**
+     * Only possible within plural argument.
+     * This is the `#` symbol that will be substituted with the count.
+     */
+    pound = 7
 }
 
-declare interface UnifiedNumberFormatOptions extends Intl.NumberFormatOptions {
-    compactDisplay?: 'short' | 'long';
-    currencyDisplay?: 'symbol' | 'code' | 'name' | 'narrowSymbol';
-    currencySign?: 'standard' | 'accounting';
-    notation?: 'standard' | 'scientific' | 'engineering' | 'compact';
-    signDisplay?: 'auto' | 'always' | 'never' | 'exceptZero';
+declare type UnifiedNumberFormatOptions = Intl.NumberFormatOptions & NumberFormatDigitOptions & {
+    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';