react-intl 4.2.2 → 4.5.0

package/src/index.ts

@@ -3,56 +3,69 @@
  * Copyrights licensed under the New BSD License.
  * See the accompanying LICENSE file for terms.
  */
-import * as React from 'react';
-export * from './types';
+import * as React from 'react'
+export * from './types'
 export function defineMessages<T, U extends Record<string, T>>(msgs: U): U {
-  return msgs;
+  return msgs
+}
+export function defineMessage<T>(msg: T): T {
+  return msg
 }
 import {
   createFormattedComponent,
   createFormattedDateTimePartsComponent,
-} from './components/createFormattedComponent';
-import {CustomFormatConfig} from './types';
-import {UnifiedNumberFormatOptions} from '@formatjs/intl-unified-numberformat';
-import {IntlListFormatOptions} from '@formatjs/intl-listformat';
-import {DisplayNamesOptions} from '@formatjs/intl-displaynames/lib';
+} from './components/createFormattedComponent'
+import {CustomFormatConfig} from './types'
+import {UnifiedNumberFormatOptions} from '@formatjs/intl-unified-numberformat'
+import {IntlListFormatOptions} from '@formatjs/intl-listformat'
+import {DisplayNamesOptions} from '@formatjs/intl-displaynames/lib'
 export {
   default as injectIntl,
   Provider as RawIntlProvider,
   Context as IntlContext,
   WithIntlProps,
   WrappedComponentProps,
-} from './components/injectIntl';
-export {default as useIntl} from './components/useIntl';
-export {default as IntlProvider, createIntl} from './components/provider';
+} from './components/injectIntl'
+export {default as useIntl} from './components/useIntl'
+export {default as IntlProvider, createIntl} from './components/provider'
 // IMPORTANT: Explicit here to prevent api-extractor from outputing `import('./types').CustomFormatConfig`
-export const FormattedDate: React.FC<Intl.DateTimeFormatOptions &
-  CustomFormatConfig & {
-    value: string | number | Date | undefined;
-  }> = createFormattedComponent('formatDate');
-export const FormattedTime: React.FC<Intl.DateTimeFormatOptions &
-  CustomFormatConfig & {
-    value: string | number | Date | undefined;
-  }> = createFormattedComponent('formatTime');
-export const FormattedNumber: React.FC<UnifiedNumberFormatOptions &
-  CustomFormatConfig & {
-    value: number;
-  }> = createFormattedComponent('formatNumber');
-export const FormattedList: React.FC<IntlListFormatOptions & {
-  value: React.ReactNode[];
-}> = createFormattedComponent('formatList');
-export const FormattedDisplayName: React.FC<DisplayNamesOptions & {
-  value: string | number | object;
-}> = createFormattedComponent('formatDisplayName');
+export const FormattedDate: React.FC<
+  Intl.DateTimeFormatOptions &
+    CustomFormatConfig & {
+      value: string | number | Date | undefined
+    }
+> = createFormattedComponent('formatDate')
+export const FormattedTime: React.FC<
+  Intl.DateTimeFormatOptions &
+    CustomFormatConfig & {
+      value: string | number | Date | undefined
+    }
+> = createFormattedComponent('formatTime')
+export const FormattedNumber: React.FC<
+  UnifiedNumberFormatOptions &
+    CustomFormatConfig & {
+      value: number
+    }
+> = createFormattedComponent('formatNumber')
+export const FormattedList: React.FC<
+  IntlListFormatOptions & {
+    value: React.ReactNode[]
+  }
+> = createFormattedComponent('formatList')
+export const FormattedDisplayName: React.FC<
+  DisplayNamesOptions & {
+    value: string | number | object
+  }
+> = createFormattedComponent('formatDisplayName')
 export const FormattedDateParts = createFormattedDateTimePartsComponent(
   'formatDate'
-);
+)
 export const FormattedTimeParts = createFormattedDateTimePartsComponent(
   'formatTime'
-);
-export {FormattedNumberParts} from './components/createFormattedComponent';
-export {default as FormattedRelativeTime} from './components/relative';
-export {default as FormattedPlural} from './components/plural';
-export {default as FormattedMessage} from './components/message';
-export {createIntlCache} from './utils';
+)
+export {FormattedNumberParts} from './components/createFormattedComponent'
+export {default as FormattedRelativeTime} from './components/relative'
+export {default as FormattedPlural} from './components/plural'
+export {default as FormattedMessage} from './components/message'
+export {createIntlCache} from './utils'
 export {ReactIntlError, ReactIntlErrorCode} from './error'

package/src/tsconfig.cjs.json

@@ -1,8 +1,8 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "../dist",
-        "module": "commonjs",
-        "target": "es5",
-    }
-}
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist",
+    "module": "commonjs",
+    "target": "es5"
+  }
+}

package/src/tsconfig.json

@@ -1,8 +1,8 @@
 {
-    "extends": "../tsconfig.json",
-    "compilerOptions": {
-        "outDir": "../lib",
-        "baseUrl": ".",
-        "lib": ["dom", "es2015", "esnext.intl", "es2018.intl", "es2017.intl"]
-    }
-}
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../lib",
+    "baseUrl": ".",
+    "lib": ["dom", "es2015", "esnext.intl", "es2018.intl", "es2017.intl"]
+  }
+}

package/src/types.ts

@@ -3,168 +3,168 @@
  * Copyrights licensed under the New BSD License.
  * See the accompanying LICENSE file for terms.
  */
-import * as React from 'react';
+import * as React from 'react'
 import IntlMessageFormat, {
   Formats,
   PrimitiveType,
   FormatXMLElementFn,
   FormatError,
-} from 'intl-messageformat';
+} from 'intl-messageformat'
 import IntlRelativeTimeFormat, {
   IntlRelativeTimeFormatOptions,
-} from '@formatjs/intl-relativetimeformat';
-import {MessageFormatElement} from 'intl-messageformat-parser';
-import {UnifiedNumberFormatOptions} from '@formatjs/intl-unified-numberformat';
-import IntlListFormat, {IntlListFormatOptions} from '@formatjs/intl-listformat';
-import {DisplayNames, DisplayNamesOptions} from '@formatjs/intl-displaynames';
-import { ReactIntlError } from './error';
+} from '@formatjs/intl-relativetimeformat'
+import {MessageFormatElement} from 'intl-messageformat-parser'
+import {UnifiedNumberFormatOptions} from '@formatjs/intl-unified-numberformat'
+import IntlListFormat, {IntlListFormatOptions} from '@formatjs/intl-listformat'
+import {DisplayNames, DisplayNamesOptions} from '@formatjs/intl-displaynames'
+import {ReactIntlError} from './error'
 
 export interface IntlConfig {
-  locale: string;
-  timeZone?: string;
-  formats: CustomFormats;
-  textComponent?: React.ComponentType | keyof React.ReactHTML;
-  messages: Record<string, string> | Record<string, MessageFormatElement[]>;
-  defaultLocale: string;
-  defaultFormats: CustomFormats;
-  wrapRichTextChunksInFragment?: boolean;
-  onError(err: ReactIntlError | FormatError): void;
+  locale: string
+  timeZone?: string
+  formats: CustomFormats
+  textComponent?: React.ComponentType | keyof React.ReactHTML
+  messages: Record<string, string> | Record<string, MessageFormatElement[]>
+  defaultLocale: string
+  defaultFormats: CustomFormats
+  wrapRichTextChunksInFragment?: boolean
+  onError(err: ReactIntlError | FormatError): void
 }
 
 export interface CustomFormats extends Partial<Formats> {
-  relative?: Record<string, IntlRelativeTimeFormatOptions>;
+  relative?: Record<string, IntlRelativeTimeFormatOptions>
 }
 
 export interface CustomFormatConfig {
-  format?: string;
+  format?: string
 }
 
 export type FormatDateOptions = Exclude<
   Intl.DateTimeFormatOptions,
   'localeMatcher'
 > &
-  CustomFormatConfig;
+  CustomFormatConfig
 export type FormatNumberOptions = Exclude<
   UnifiedNumberFormatOptions,
   'localeMatcher'
 > &
-  CustomFormatConfig;
+  CustomFormatConfig
 export type FormatRelativeTimeOptions = Exclude<
   IntlRelativeTimeFormatOptions,
   'localeMatcher'
 > &
-  CustomFormatConfig;
+  CustomFormatConfig
 export type FormatPluralOptions = Exclude<
   Intl.PluralRulesOptions,
   'localeMatcher'
 > &
-  CustomFormatConfig;
+  CustomFormatConfig
 
-export type FormatListOptions = Exclude<IntlListFormatOptions, 'localeMatcher'>;
+export type FormatListOptions = Exclude<IntlListFormatOptions, 'localeMatcher'>
 
 export type FormatDisplayNameOptions = Exclude<
   DisplayNamesOptions,
   'localeMatcher'
->;
+>
 
-export interface IntlFormatters<T = React.ReactNode> {
+export interface IntlFormatters<T = React.ReactNode, R = T> {
   formatDate(
     value: Parameters<Intl.DateTimeFormat['format']>[0] | string,
     opts?: FormatDateOptions
-  ): string;
+  ): string
   formatTime(
     value: Parameters<Intl.DateTimeFormat['format']>[0] | string,
     opts?: FormatDateOptions
-  ): string;
+  ): string
   formatDateToParts(
     value: Parameters<Intl.DateTimeFormat['format']>[0] | string,
     opts?: FormatDateOptions
-  ): Intl.DateTimeFormatPart[];
+  ): Intl.DateTimeFormatPart[]
   formatTimeToParts(
     value: Parameters<Intl.DateTimeFormat['format']>[0] | string,
     opts?: FormatDateOptions
-  ): Intl.DateTimeFormatPart[];
+  ): Intl.DateTimeFormatPart[]
   formatRelativeTime(
     value: Parameters<IntlRelativeTimeFormat['format']>[0],
     unit?: Parameters<IntlRelativeTimeFormat['format']>[1],
     opts?: FormatRelativeTimeOptions
-  ): string;
+  ): string
   formatNumber(
     value: Parameters<Intl.NumberFormat['format']>[0],
     opts?: FormatNumberOptions
-  ): string;
+  ): string
   formatNumberToParts(
     value: Parameters<Intl.NumberFormat['format']>[0],
     opts?: FormatNumberOptions
-  ): Intl.NumberFormatPart[];
+  ): Intl.NumberFormatPart[]
   formatPlural(
     value: Parameters<Intl.PluralRules['select']>[0],
     opts?: FormatPluralOptions
-  ): ReturnType<Intl.PluralRules['select']>;
+  ): ReturnType<Intl.PluralRules['select']>
   formatMessage(
     descriptor: MessageDescriptor,
     values?: Record<string, PrimitiveType>
-  ): string;
+  ): string
   formatMessage(
     descriptor: MessageDescriptor,
     values?: Record<
       string,
-      PrimitiveType | React.ReactElement | FormatXMLElementFn<T>
+      PrimitiveType | React.ReactElement | FormatXMLElementFn<T, R>
     >
-  ): string | React.ReactNodeArray;
-  formatList(values: Array<string>, opts?: FormatListOptions): string;
+  ): string | React.ReactNodeArray
+  formatList(values: Array<string>, opts?: FormatListOptions): string
   formatList(
     values: Array<string | React.ReactNode>,
     opts?: FormatListOptions
-  ): React.ReactNode;
+  ): React.ReactNode
   formatDisplayName(
     value: Parameters<DisplayNames['of']>[0],
     opts?: FormatDisplayNameOptions
-  ): string | undefined;
+  ): string | undefined
 }
 
 export interface Formatters {
   getDateTimeFormat(
     ...args: ConstructorParameters<typeof Intl.DateTimeFormat>
-  ): Intl.DateTimeFormat;
+  ): Intl.DateTimeFormat
   getNumberFormat(
     ...args: ConstructorParameters<typeof Intl.NumberFormat>
-  ): Intl.NumberFormat;
+  ): Intl.NumberFormat
   getMessageFormat(
     ...args: ConstructorParameters<typeof IntlMessageFormat>
-  ): IntlMessageFormat;
+  ): IntlMessageFormat
   getRelativeTimeFormat(
     ...args: ConstructorParameters<typeof IntlRelativeTimeFormat>
-  ): IntlRelativeTimeFormat;
+  ): IntlRelativeTimeFormat
   getPluralRules(
     ...args: ConstructorParameters<typeof Intl.PluralRules>
-  ): Intl.PluralRules;
+  ): Intl.PluralRules
   getListFormat(
     ...args: ConstructorParameters<typeof IntlListFormat>
-  ): IntlListFormat;
+  ): IntlListFormat
   getDisplayNames(
     ...args: ConstructorParameters<typeof DisplayNames>
-  ): DisplayNames;
+  ): DisplayNames
 }
 
 export interface IntlShape extends IntlConfig, IntlFormatters {
-  formatters: Formatters;
+  formatters: Formatters
 }
 
 export interface IntlCache {
-  dateTime: Record<string, Intl.DateTimeFormat>;
-  number: Record<string, Intl.NumberFormat>;
-  message: Record<string, IntlMessageFormat>;
-  relativeTime: Record<string, IntlRelativeTimeFormat>;
-  pluralRules: Record<string, Intl.PluralRules>;
-  list: Record<string, IntlListFormat>;
-  displayNames: Record<string, DisplayNames>;
+  dateTime: Record<string, Intl.DateTimeFormat>
+  number: Record<string, Intl.NumberFormat>
+  message: Record<string, IntlMessageFormat>
+  relativeTime: Record<string, IntlRelativeTimeFormat>
+  pluralRules: Record<string, Intl.PluralRules>
+  list: Record<string, IntlListFormat>
+  displayNames: Record<string, DisplayNames>
 }
 
 export interface MessageDescriptor {
-  id?: string | number;
-  description?: string | object;
-  defaultMessage?: string;
+  id?: string | number
+  description?: string | object
+  defaultMessage?: string
 }
 
-export type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
+export type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>

package/src/utils.ts

@@ -9,13 +9,13 @@ This source code is licensed under the BSD-style license found in the LICENSE
 file in the root directory of React's source tree.
 */
 
-import {IntlConfig, IntlCache, CustomFormats, Formatters} from './types';
-import * as React from 'react';
-import IntlMessageFormat from 'intl-messageformat';
-import memoizeIntlConstructor from 'intl-format-cache';
-import {invariant} from '@formatjs/intl-utils';
-import {IntlRelativeTimeFormatOptions} from '@formatjs/intl-relativetimeformat';
-import { ReactIntlError, ReactIntlErrorCode } from './error';
+import {IntlConfig, IntlCache, CustomFormats, Formatters} from './types'
+import * as React from 'react'
+import IntlMessageFormat from 'intl-messageformat'
+import memoizeIntlConstructor from 'intl-format-cache'
+import {invariant} from '@formatjs/intl-utils'
+import {IntlRelativeTimeFormatOptions} from '@formatjs/intl-relativetimeformat'
+import {ReactIntlError, ReactIntlErrorCode} from './error'
 
 export function filterProps<T extends Record<string, any>, K extends string>(
   props: T,
@@ -24,13 +24,13 @@ export function filterProps<T extends Record<string, any>, K extends string>(
 ): Pick<T, K> {
   return whitelist.reduce((filtered, name) => {
     if (name in props) {
-      filtered[name] = props[name];
+      filtered[name] = props[name]
     } else if (name in defaults) {
-      filtered[name] = defaults[name]!;
+      filtered[name] = defaults[name]!
     }
 
-    return filtered;
-  }, {} as Pick<T, K>);
+    return filtered
+  }, {} as Pick<T, K>)
 }
 
 export function invariantIntlContext(intl?: any): asserts intl {
@@ -38,12 +38,12 @@ export function invariantIntlContext(intl?: any): asserts intl {
     intl,
     '[React Intl] Could not find required `intl` object. ' +
       '<IntlProvider> needs to exist in the component ancestry.'
-  );
+  )
 }
 
 export function defaultErrorHandler(error: ReactIntlError): void {
   if (process.env.NODE_ENV !== 'production') {
-    console.error(error);
+    console.error(error)
   }
 }
 
@@ -66,7 +66,7 @@ export const DEFAULT_INTL_CONFIG: Pick<
   defaultFormats: {},
 
   onError: defaultErrorHandler,
-};
+}
 
 export function createIntlCache(): IntlCache {
   return {
@@ -77,7 +77,7 @@ export function createIntlCache(): IntlCache {
     pluralRules: {},
     list: {},
     displayNames: {},
-  };
+  }
 }
 
 /**
@@ -87,9 +87,9 @@ export function createIntlCache(): IntlCache {
 export function createFormatters(
   cache: IntlCache = createIntlCache()
 ): Formatters {
-  const RelativeTimeFormat = (Intl as any).RelativeTimeFormat;
-  const ListFormat = (Intl as any).ListFormat;
-  const DisplayNames = (Intl as any).DisplayNames;
+  const RelativeTimeFormat = (Intl as any).RelativeTimeFormat
+  const ListFormat = (Intl as any).ListFormat
+  const DisplayNames = (Intl as any).DisplayNames
   return {
     getDateTimeFormat: memoizeIntlConstructor(
       Intl.DateTimeFormat,
@@ -104,7 +104,7 @@ export function createFormatters(
     getPluralRules: memoizeIntlConstructor(Intl.PluralRules, cache.pluralRules),
     getListFormat: memoizeIntlConstructor(ListFormat, cache.list),
     getDisplayNames: memoizeIntlConstructor(DisplayNames, cache.displayNames),
-  };
+  }
 }
 
 export function getNamedFormat<T extends keyof CustomFormats>(
@@ -117,14 +117,19 @@ export function getNamedFormat<T extends keyof CustomFormats>(
   | Intl.DateTimeFormatOptions
   | IntlRelativeTimeFormatOptions
   | undefined {
-  const formatType = formats && formats[type];
-  let format;
+  const formatType = formats && formats[type]
+  let format
   if (formatType) {
-    format = formatType[name];
+    format = formatType[name]
   }
   if (format) {
-    return format;
+    return format
   }
 
-  onError(new ReactIntlError(ReactIntlErrorCode.UNSUPPORTED_FORMATTER, `No ${type} format named: ${name}`));
+  onError(
+    new ReactIntlError(
+      ReactIntlErrorCode.UNSUPPORTED_FORMATTER,
+      `No ${type} format named: ${name}`
+    )
+  )
 }

package/src/vendor.d.ts

@@ -1 +1 @@
-declare module 'shallow-equal/objects';
+declare module 'shallow-equal/objects'