use-intl 2.13.0-beta.2 → 2.13.0

package/src/core/{IntlConfiguration.tsx → IntlConfig.tsx}

@@ -1,11 +1,12 @@
 import Formats from './Formats';
 import IntlError from './IntlError';
+import {AbstractIntlMessages, RichTranslationValues} from '.';
 
 /**
  * Should be used for entry points that configure the library.
  */
 
-type IntlConfiguration = {
+type IntlConfig<Messages = AbstractIntlMessages> = {
   /** A valid Unicode locale tag (e.g. "en" or "en-GB"). */
   locale: string;
   /** Global formats can be provided to achieve consistent
@@ -36,15 +37,22 @@ type IntlConfiguration = {
    *    afterwards the current date will be returned continuously.
    */
   now?: Date;
+  /** All messages that will be available. */
+  messages?: Messages;
+  /** Global default values for translation values and rich text elements.
+   * Can be used for consistent usage or styling of rich text elements.
+   * Defaults will be overidden by locally provided values. */
+  defaultTranslationValues?: RichTranslationValues;
 };
 
 /**
  * A stricter set of the configuration that should be used internally
  * once defaults are assigned to `IntlConfiguration`.
  */
-export type InitializedIntlConfiguration = IntlConfiguration & {
-  onError: NonNullable<IntlConfiguration['onError']>;
-  getMessageFallback: NonNullable<IntlConfiguration['getMessageFallback']>;
-};
+export type InitializedIntlConfig<Messages = AbstractIntlMessages> =
+  IntlConfig<Messages> & {
+    onError: NonNullable<IntlConfig<Messages>['onError']>;
+    getMessageFallback: NonNullable<IntlConfig<Messages>['getMessageFallback']>;
+  };
 
-export default IntlConfiguration;
+export default IntlConfig;

package/src/core/createBaseTranslator.tsx

@@ -9,7 +9,7 @@ import {
 } from 'react';
 import AbstractIntlMessages from './AbstractIntlMessages';
 import Formats from './Formats';
-import {InitializedIntlConfiguration} from './IntlConfiguration';
+import {InitializedIntlConfig} from './IntlConfig';
 import IntlError, {IntlErrorCode} from './IntlError';
 import TranslationValues, {RichTranslationValues} from './TranslationValues';
 import convertFormatsToIntlMessageFormat from './convertFormatsToIntlMessageFormat';
@@ -121,13 +121,12 @@ export function getMessagesOrError<Messages extends AbstractIntlMessages>({
   }
 }
 
-export type CreateBaseTranslatorProps<Messages> =
-  InitializedIntlConfiguration & {
-    cachedFormatsByLocale?: Record<string, Record<string, IntlMessageFormat>>;
-    defaultTranslationValues?: RichTranslationValues;
-    namespace?: string;
-    messagesOrError: Messages | IntlError;
-  };
+export type CreateBaseTranslatorProps<Messages> = InitializedIntlConfig & {
+  cachedFormatsByLocale?: Record<string, Record<string, IntlMessageFormat>>;
+  defaultTranslationValues?: RichTranslationValues;
+  namespace?: string;
+  messagesOrError: Messages | IntlError;
+};
 
 export default function createBaseTranslator<
   Messages extends AbstractIntlMessages,

package/src/core/createTranslator.tsx

@@ -1,5 +1,5 @@
 import Formats from './Formats';
-import IntlConfiguration from './IntlConfiguration';
+import IntlConfig from './IntlConfig';
 import TranslationValues from './TranslationValues';
 import createTranslatorImpl, {
   CoreRichTranslationValues
@@ -29,8 +29,8 @@ export default function createTranslator<
   messages,
   namespace,
   ...rest
-}: IntlConfiguration & {
-  messages: IntlMessages;
+}: Omit<IntlConfig<IntlMessages>, 'defaultTranslationValues' | 'messages'> & {
+  messages: NonNullable<IntlConfig<IntlMessages>['messages']>;
   namespace?: NestedKey;
 }): // Explicitly defining the return type is necessary as TypeScript would get it wrong
 {

package/src/core/createTranslatorImpl.tsx

@@ -1,5 +1,5 @@
 import AbstractIntlMessages from './AbstractIntlMessages';
-import {InitializedIntlConfiguration} from './IntlConfiguration';
+import {InitializedIntlConfig} from './IntlConfig';
 import IntlError, {IntlErrorCode} from './IntlError';
 import {RichTranslationValues, TranslationValue} from './TranslationValues';
 import createBaseTranslator, {getMessagesOrError} from './createBaseTranslator';
@@ -11,11 +11,13 @@ export type CoreRichTranslationValues = Record<
   TranslationValue | ((chunks: string) => string)
 >;
 
-export type CreateTranslatorImplProps<Messages> =
-  InitializedIntlConfiguration & {
-    namespace: string;
-    messages: Messages;
-  };
+export type CreateTranslatorImplProps<Messages> = Omit<
+  InitializedIntlConfig,
+  'messages'
+> & {
+  namespace: string;
+  messages: Messages;
+};
 
 export default function createTranslatorImpl<
   Messages extends AbstractIntlMessages,

package/src/react/IntlContext.tsx

@@ -1,6 +1,6 @@
 import {createContext} from 'react';
-import IntlContextValue from './IntlContextValue';
+import {InitializedIntlConfig} from '../core/IntlConfig';
 
-const IntlContext = createContext<IntlContextValue | undefined>(undefined);
+const IntlContext = createContext<InitializedIntlConfig | undefined>(undefined);
 
 export default IntlContext;

package/src/react/IntlProvider.tsx

@@ -1,11 +1,15 @@
-import React from 'react';
+import React, {ReactNode} from 'react';
+import IntlConfig from '../core/IntlConfig';
 import IntlContext from './IntlContext';
-import IntlProviderProps from './IntlProviderProps';
-import getIntlContextValue from './getIntlContextValue';
+import getInitializedConfig from './getInitializedConfig';
 
-export default function IntlProvider({children, ...props}: IntlProviderProps) {
+type Props = IntlConfig & {
+  children: ReactNode;
+};
+
+export default function IntlProvider({children, ...props}: Props) {
   return (
-    <IntlContext.Provider value={getIntlContextValue(props)}>
+    <IntlContext.Provider value={getInitializedConfig(props)}>
       {children}
     </IntlContext.Provider>
   );

package/src/react/{getIntlContextValue.tsx → getInitializedConfig.tsx}

@@ -1,15 +1,20 @@
+import IntlConfig, {InitializedIntlConfig} from '../core/IntlConfig';
 import {defaultGetMessageFallback, defaultOnError} from '../core/defaults';
 import validateMessages from '../core/validateMessages';
-import IntlProviderProps from './IntlProviderProps';
 
 /**
  * Enhances the incoming props with defaults.
  */
-export default function getIntlContextValue<
+export default function getInitializedConfig<
   // This is a generic to allow for stricter typing. E.g.
   // the RSC integration always provides a `now` value.
-  Props extends Omit<IntlProviderProps, 'children'>
->({getMessageFallback, messages, onError, ...rest}: Props) {
+  Props extends Omit<IntlConfig, 'children'>
+>({
+  getMessageFallback,
+  messages,
+  onError,
+  ...rest
+}: Props): InitializedIntlConfig {
   const finalOnError = onError || defaultOnError;
   const finalGetMessageFallback =
     getMessageFallback || defaultGetMessageFallback;

package/src/react/useIntl.tsx

@@ -4,7 +4,7 @@ import useIntlContext from './useIntlContext';
 
 let hasWarned = false;
 
-/** @deprecated  Switch to `useFormatter` */
+/** @deprecated Switch to `useFormatter` instead. */
 export default function useIntl() {
   const {formats, locale, now: globalNow, onError, timeZone} = useIntlContext();