use-intl 2.7.7-alpha.0 → 2.8.0

package/dist/use-intl.esm.js

@@ -1,10 +1,10 @@
-export { default as IntlError, IntlErrorCode } from './core/use-intl.esm2.js';
-export { default as createTranslator } from './core/use-intl.esm.js';
+export { default as IntlError, IntlErrorCode } from './core/use-intl.esm.js';
+export { default as createTranslator } from './core/use-intl.esm2.js';
 export { default as createIntl } from './core/use-intl.esm3.js';
-export { default as IntlProvider } from './react/use-intl.esm5.js';
+export { default as IntlProvider } from './react/use-intl.esm.js';
 export { default as useTranslations } from './react/use-intl.esm2.js';
-export { default as useIntl } from './react/use-intl.esm.js';
-export { default as useLocale } from './react/use-intl.esm6.js';
-export { default as useNow } from './react/use-intl.esm4.js';
-export { default as useTimeZone } from './react/use-intl.esm3.js';
+export { default as useIntl } from './react/use-intl.esm3.js';
+export { default as useLocale } from './react/use-intl.esm4.js';
+export { default as useNow } from './react/use-intl.esm6.js';
+export { default as useTimeZone } from './react/use-intl.esm5.js';
 //# sourceMappingURL=use-intl.esm.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-intl",
-  "version": "2.7.7-alpha.0",
+  "version": "2.8.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.me>",
   "description": "Minimal, but complete solution for managing internationalization in React apps.",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=10"
   },
-  "gitHead": "23c828fea41004a6c756e878e5722f5edd82f82e"
+  "gitHead": "a924207b28e11578f7a16f90c3f2ee3dae995d82"
 }

package/src/core/IntlConfiguration.tsx

@@ -0,0 +1,50 @@
+import Formats from './Formats';
+import IntlError from './IntlError';
+
+/**
+ * Should be used for entry points that configure the library.
+ */
+
+type IntlConfiguration = {
+  /** A valid Unicode locale tag (e.g. "en" or "en-GB"). */
+  locale: string;
+  /** Global formats can be provided to achieve consistent
+   * formatting across components. */
+  formats?: Partial<Formats>;
+  /** A time zone as defined in [the tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) which will be applied when formatting dates and times. If this is absent, the user time zone will be used. You can override this by supplying an explicit time zone to `formatDateTime`. */
+  timeZone?: string;
+  /** This callback will be invoked when an error is encountered during
+   * resolving a message or formatting it. This defaults to `console.error` to
+   * keep your app running. You can customize the handling by taking
+   * `error.code` into account. */
+  onError?(error: IntlError): void;
+  /** Will be called when a message couldn't be resolved or formatting it led to
+   * an error. This defaults to `${namespace}.${key}` You can use this to
+   * customize what will be rendered in this case. */
+  getMessageFallback?(info: {
+    error: IntlError;
+    key: string;
+    namespace?: string;
+  }): string;
+  /**
+   * Providing this value will have two effects:
+   * 1. It will be used as the default for the `now` argument of
+   *    `useIntl().formatRelativeTime` if no explicit value is provided.
+   * 2. It will be returned as a static value from the `useNow` hook. Note
+   *    however that when `updateInterval` is configured on the `useNow` hook,
+   *    the global `now` value will only be used for the initial render, but
+   *    afterwards the current date will be returned continuously.
+   */
+  now?: Date;
+};
+
+/**
+ * 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 default IntlConfiguration;

package/src/core/TranslationValues.tsx

@@ -11,6 +11,9 @@ export type TranslationValue =
 
 type TranslationValues = Record<string, TranslationValue>;
 
+// We could consider renaming this to `ReactRichTranslationValues` and defining
+// it in the `react` namespace if the core becomes useful to other frameworks.
+// It would be a breaking change though, so let's wait for now.
 export type RichTranslationValues = Record<
   string,
   TranslationValue | ((chunks: ReactNode) => ReactNode)

package/src/core/createBaseTranslator.tsx

@@ -8,10 +8,11 @@ import {
 } from 'react';
 import AbstractIntlMessages from './AbstractIntlMessages';
 import Formats from './Formats';
+import {InitializedIntlConfiguration} from './IntlConfiguration';
 import IntlError, {IntlErrorCode} from './IntlError';
 import TranslationValues, {RichTranslationValues} from './TranslationValues';
-import {defaultGetMessageFallback, defaultOnError} from './config';
 import convertFormatsToIntlMessageFormat from './convertFormatsToIntlMessageFormat';
+import {defaultGetMessageFallback, defaultOnError} from './defaults';
 import MessageKeys from './utils/MessageKeys';
 import NestedKeyOf from './utils/NestedKeyOf';
 import NestedValueOf from './utils/NestedValueOf';
@@ -115,21 +116,13 @@ export function getMessagesOrError<Messages extends AbstractIntlMessages>({
   }
 }
 
-export type CreateBaseTranslatorProps<Messages> = {
-  cachedFormatsByLocale?: Record<string, Record<string, IntlMessageFormat>>;
-  defaultTranslationValues?: RichTranslationValues;
-  formats?: Partial<Formats>;
-  getMessageFallback?(info: {
-    error: IntlError;
-    key: string;
+export type CreateBaseTranslatorProps<Messages> =
+  InitializedIntlConfiguration & {
+    cachedFormatsByLocale?: Record<string, Record<string, IntlMessageFormat>>;
+    defaultTranslationValues?: RichTranslationValues;
     namespace?: string;
-  }): string;
-  locale: string;
-  messagesOrError: Messages | IntlError;
-  namespace?: string;
-  onError(error: IntlError): void;
-  timeZone?: string;
-};
+    messagesOrError: Messages | IntlError;
+  };
 
 export default function createBaseTranslator<
   Messages extends AbstractIntlMessages,

package/src/core/createIntl.tsx

@@ -2,7 +2,7 @@ import DateTimeFormatOptions from './DateTimeFormatOptions';
 import Formats from './Formats';
 import IntlError, {IntlErrorCode} from './IntlError';
 import NumberFormatOptions from './NumberFormatOptions';
-import {defaultOnError} from './config';
+import {defaultOnError} from './defaults';
 
 const MINUTE = 60;
 const HOUR = MINUTE * 60;

package/src/core/createTranslator.tsx

@@ -1,9 +1,10 @@
 import Formats from './Formats';
+import IntlConfiguration from './IntlConfiguration';
 import TranslationValues from './TranslationValues';
 import createTranslatorImpl, {
-  CreateTranslatorImplProps,
   CoreRichTranslationValues
 } from './createTranslatorImpl';
+import {defaultGetMessageFallback, defaultOnError} from './defaults';
 import MessageKeys from './utils/MessageKeys';
 import NamespaceKeys from './utils/NamespaceKeys';
 import NestedKeyOf from './utils/NestedKeyOf';
@@ -23,13 +24,12 @@ export default function createTranslator<
     NestedKeyOf<IntlMessages>
   > = never
 >({
+  onError = defaultOnError,
+  getMessageFallback = defaultGetMessageFallback,
   messages,
   namespace,
   ...rest
-}: Omit<
-  CreateTranslatorImplProps<IntlMessages>,
-  'messagesOrError' | 'namespace' | 'namespacePrefix'
-> & {
+}: IntlConfiguration & {
   messages: IntlMessages;
   namespace?: NestedKey;
 }): // Explicitly defining the return type is necessary as TypeScript would get it wrong
@@ -101,6 +101,8 @@ export default function createTranslator<
   >(
     {
       ...rest,
+      onError,
+      getMessageFallback,
       messages: {'!': messages},
       // @ts-ignore
       namespace: namespace ? `!.${namespace}` : '!'

package/src/core/createTranslatorImpl.tsx

@@ -1,11 +1,8 @@
 import AbstractIntlMessages from './AbstractIntlMessages';
+import {InitializedIntlConfiguration} from './IntlConfiguration';
 import IntlError, {IntlErrorCode} from './IntlError';
 import {RichTranslationValues, TranslationValue} from './TranslationValues';
-import {defaultGetMessageFallback, defaultOnError} from './config';
-import createBaseTranslator, {
-  CreateBaseTranslatorProps,
-  getMessagesOrError
-} from './createBaseTranslator';
+import createBaseTranslator, {getMessagesOrError} from './createBaseTranslator';
 import resolveNamespace from './resolveNamespace';
 import NestedKeyOf from './utils/NestedKeyOf';
 
@@ -14,29 +11,21 @@ export type CoreRichTranslationValues = Record<
   TranslationValue | ((chunks: string) => string)
 >;
 
-export type CreateTranslatorImplProps<Messages> = Omit<
-  CreateBaseTranslatorProps<Messages>,
-  'messagesOrError' | 'onError' | 'getMessageFallback' | 'namespace'
-> & {
-  messages: Messages;
-  onError?(error: IntlError): void;
-  getMessageFallback?(info: {
-    error: IntlError;
-    key: string;
-    namespace?: string;
-  }): string;
-  namespace: string;
-};
+export type CreateTranslatorImplProps<Messages> =
+  InitializedIntlConfiguration & {
+    namespace: string;
+    messages: Messages;
+  };
 
 export default function createTranslatorImpl<
   Messages extends AbstractIntlMessages,
   NestedKey extends NestedKeyOf<Messages>
 >(
   {
+    getMessageFallback,
     messages,
     namespace,
-    onError = defaultOnError,
-    getMessageFallback = defaultGetMessageFallback,
+    onError,
     ...rest
   }: CreateTranslatorImplProps<Messages>,
   namespacePrefix: string
@@ -49,6 +38,7 @@ export default function createTranslatorImpl<
   const translator = createBaseTranslator<Messages, NestedKey>({
     ...rest,
     onError,
+    getMessageFallback,
     messagesOrError: getMessagesOrError({
       messages,
       namespace,

package/src/core/defaults.tsx

@@ -0,0 +1,18 @@
+import IntlError from './IntlError';
+
+/**
+ * Contains defaults that are used for all entry points into the core.
+ * See also `InitializedIntlConfiguration`.
+ */
+
+export function defaultGetMessageFallback(props: {
+  error: IntlError;
+  key: string;
+  namespace?: string;
+}) {
+  return [props.namespace, props.key].filter((part) => part != null).join('.');
+}
+
+export function defaultOnError(error: IntlError) {
+  console.error(error);
+}

package/src/react/IntlProvider.tsx

@@ -1,51 +1,20 @@
 import React, {ReactNode, useEffect} from 'react';
-import AbstractIntlMessages from '../core/AbstractIntlMessages';
-import Formats from '../core/Formats';
-import IntlError from '../core/IntlError';
+import {AbstractIntlMessages} from '../core';
+import IntlConfiguration from '../core/IntlConfiguration';
 import {RichTranslationValues} from '../core/TranslationValues';
-import {defaultGetMessageFallback, defaultOnError} from '../core/config';
+import {defaultGetMessageFallback, defaultOnError} from '../core/defaults';
 import validateMessages from '../core/validateMessages';
 import IntlContext from './IntlContext';
 
-type Props = {
-  /** All messages that will be available in your components. */
-  messages?: AbstractIntlMessages;
-  /** A valid Unicode locale tag (e.g. "en" or "en-GB"). */
-  locale: string;
-  /** Global formats can be provided to achieve consistent
-   * formatting across components. */
-  formats?: Partial<Formats>;
-  /** A time zone as defined in [the tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) which will be applied when formatting dates and times. If this is absent, the user time zone will be used. You can override this by supplying an explicit time zone to `formatDateTime`. */
-  timeZone?: string;
-  /** This callback will be invoked when an error is encountered during
-   * resolving a message or formatting it. This defaults to `console.error` to
-   * keep your app running. You can customize the handling by taking
-   * `error.code` into account. */
-  onError?(error: IntlError): void;
-  /** Will be called when a message couldn't be resolved or formatting it led to
-   * an error. This defaults to `${namespace}.${key}` You can use this to
-   * customize what will be rendered in this case. */
-  getMessageFallback?(info: {
-    namespace?: string;
-    key: string;
-    error: IntlError;
-  }): string;
+type Props = IntlConfiguration & {
   /** All components that use the provided hooks should be within this tree. */
   children: ReactNode;
-  /**
-   * Providing this value will have two effects:
-   * 1. It will be used as the default for the `now` argument of
-   *    `useIntl().formatRelativeTime` if no explicit value is provided.
-   * 2. It will be returned as a static value from the `useNow` hook. Note
-   *    however that when `updateInterval` is configured on the `useNow` hook,
-   *    the global `now` value will only be used for the initial render, but
-   *    afterwards the current date will be returned continuously.
-   */
-  now?: Date;
   /** 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;
+  /** All messages that will be available in your components. */
+  messages?: AbstractIntlMessages;
 };
 
 export default function IntlProvider({

package/dist/core/config.d.ts

@@ -1,6 +0,0 @@
-import IntlError from './IntlError';
-export declare function defaultGetMessageFallback({ key, namespace }: {
-    key: string;
-    namespace?: string;
-}): string;
-export declare function defaultOnError(error: IntlError): void;

package/src/core/config.tsx

@@ -1,15 +0,0 @@
-import IntlError from './IntlError';
-
-export function defaultGetMessageFallback({
-  key,
-  namespace
-}: {
-  key: string;
-  namespace?: string;
-}) {
-  return [namespace, key].filter((part) => part != null).join('.');
-}
-
-export function defaultOnError(error: IntlError) {
-  console.error(error);
-}