use-intl 2.9.1 → 2.10.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-intl",
-  "version": "2.9.1",
+  "version": "2.10.0-alpha.3",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.me>",
   "description": "Minimal, but complete solution for managing internationalization in React apps.",
@@ -12,9 +12,11 @@
   },
   "scripts": {
     "start": "dts watch",
-    "build": "dts build",
+    "build": "yarn build:default && yarn build:rsc",
+    "build:default": "rm -rf dist && dts build",
+    "build:rsc": "tsc && rm -rf dist/test",
     "test": "TZ=Europe/Berlin dts test",
-    "lint": "eslint src test && tsc",
+    "lint": "eslint src test && tsc --noEmit",
     "prepublishOnly": "yarn test && yarn lint && yarn build"
   },
   "main": "dist/index.js",
@@ -59,6 +61,5 @@
   },
   "engines": {
     "node": ">=10"
-  },
-  "gitHead": "ef170366c1b0689d969b17e70f9e70a296e86254"
+  }
 }

package/src/core/createBaseTranslator.tsx

@@ -24,7 +24,9 @@ function resolvePath(
 ) {
   if (!messages) {
     throw new Error(
-      __DEV__ ? `No messages available at \`${namespace}\`.` : undefined
+      process.env.NODE_ENV !== 'production'
+        ? `No messages available at \`${namespace}\`.`
+        : undefined
     );
   }
 
@@ -35,7 +37,7 @@ function resolvePath(
 
     if (part == null || next == null) {
       throw new Error(
-        __DEV__
+        process.env.NODE_ENV !== 'production'
           ? `Could not resolve \`${key}\` in ${
               namespace ? `\`${namespace}\`` : 'messages'
             }.`
@@ -89,7 +91,9 @@ export function getMessagesOrError<Messages extends AbstractIntlMessages>({
   try {
     if (!messages) {
       throw new Error(
-        __DEV__ ? `No messages were configured on the provider.` : undefined
+        process.env.NODE_ENV !== 'production'
+          ? `No messages were configured on the provider.`
+          : undefined
       );
     }
 
@@ -99,7 +103,7 @@ export function getMessagesOrError<Messages extends AbstractIntlMessages>({
 
     if (!retrievedMessages) {
       throw new Error(
-        __DEV__
+        process.env.NODE_ENV !== 'production'
           ? `No messages for namespace \`${namespace}\` found.`
           : undefined
       );
@@ -187,7 +191,7 @@ export default function createBaseTranslator<
         return getFallbackFromErrorAndNotify(
           key,
           IntlErrorCode.INSUFFICIENT_PATH,
-          __DEV__
+          process.env.NODE_ENV !== 'production'
             ? `Insufficient path specified for \`${key}\` in \`${
                 namespace ? `\`${namespace}\`` : 'messages'
               }\`.`
@@ -231,7 +235,7 @@ export default function createBaseTranslator<
 
       if (formattedMessage == null) {
         throw new Error(
-          __DEV__
+          process.env.NODE_ENV !== 'production'
             ? `Unable to format \`${key}\` in ${
                 namespace ? `namespace \`${namespace}\`` : 'messages'
               }`
@@ -274,7 +278,7 @@ export default function createBaseTranslator<
       return getFallbackFromErrorAndNotify(
         key,
         IntlErrorCode.INVALID_MESSAGE,
-        __DEV__
+        process.env.NODE_ENV !== 'production'
           ? `The message \`${key}\` in ${
               namespace ? `namespace \`${namespace}\`` : 'messages'
             } didn't resolve to a string. If you want to format rich text, use \`t.rich\` instead.`

package/src/core/createIntl.tsx

@@ -71,7 +71,7 @@ export default function createIntl({
       if (!options) {
         const error = new IntlError(
           IntlErrorCode.MISSING_FORMAT,
-          __DEV__
+          process.env.NODE_ENV !== 'production'
             ? `Format \`${formatName}\` is not available. You can configure it on the provider or provide custom options.`
             : undefined
         );
@@ -153,7 +153,7 @@ export default function createIntl({
           now = globalNow;
         } else {
           throw new Error(
-            __DEV__
+            process.env.NODE_ENV !== 'production'
               ? `The \`now\` parameter wasn't provided to \`formatRelativeTime\` and there was no global fallback configured on the provider.`
               : undefined
           );

package/src/core/createTranslatorImpl.tsx

@@ -67,7 +67,7 @@ export default function createTranslatorImpl<
     if (typeof result !== 'string') {
       const error = new IntlError(
         IntlErrorCode.FORMATTING_ERROR,
-        __DEV__
+        process.env.NODE_ENV !== 'production'
           ? "`createTranslator` only accepts functions for rich text formatting that receive and return strings.\n\nE.g. t.rich('rich', {b: (chunks) => `<b>${chunks}</b>`})"
           : undefined
       );

package/src/react/IntlContext.tsx

@@ -1,24 +1,6 @@
 import {createContext} from 'react';
-import AbstractIntlMessages from '../core/AbstractIntlMessages';
-import Formats from '../core/Formats';
-import IntlError from '../core/IntlError';
-import {RichTranslationValues} from '../core/TranslationValues';
+import IntlContextValue from './IntlContextValue';
 
-export type IntlContextShape = {
-  messages?: AbstractIntlMessages;
-  locale: string;
-  formats?: Partial<Formats>;
-  timeZone?: string;
-  onError(error: IntlError): void;
-  getMessageFallback(info: {
-    error: IntlError;
-    key: string;
-    namespace?: string;
-  }): string;
-  now?: Date;
-  defaultTranslationValues?: RichTranslationValues;
-};
-
-const IntlContext = createContext<IntlContextShape | undefined>(undefined);
+const IntlContext = createContext<IntlContextValue | undefined>(undefined);
 
 export default IntlContext;

package/src/react/IntlContextValue.tsx

@@ -0,0 +1,21 @@
+import AbstractIntlMessages from '../core/AbstractIntlMessages';
+import Formats from '../core/Formats';
+import IntlError from '../core/IntlError';
+import {RichTranslationValues} from '../core/TranslationValues';
+
+type IntlContextValue = {
+  messages?: AbstractIntlMessages;
+  locale: string;
+  formats?: Partial<Formats>;
+  timeZone?: string;
+  onError(error: IntlError): void;
+  getMessageFallback(info: {
+    error: IntlError;
+    key: string;
+    namespace?: string;
+  }): string;
+  now?: Date;
+  defaultTranslationValues?: RichTranslationValues;
+};
+
+export default IntlContextValue;

package/src/react/IntlProvider.tsx

@@ -1,42 +1,11 @@
-import React, {ReactNode, useEffect} from 'react';
-import {AbstractIntlMessages} from '../core';
-import IntlConfiguration from '../core/IntlConfiguration';
-import {RichTranslationValues} from '../core/TranslationValues';
-import {defaultGetMessageFallback, defaultOnError} from '../core/defaults';
-import validateMessages from '../core/validateMessages';
+import React from 'react';
 import IntlContext from './IntlContext';
+import IntlProviderProps from './IntlProviderProps';
+import getIntlContextValue from './getIntlContextValue';
 
-type Props = IntlConfiguration & {
-  /** All components that use the provided hooks should be within this tree. */
-  children: ReactNode;
-  /** 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({
-  children,
-  onError = defaultOnError,
-  getMessageFallback = defaultGetMessageFallback,
-  messages,
-  ...contextValues
-}: Props) {
-  if (__DEV__) {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    useEffect(() => {
-      if (messages) {
-        validateMessages(messages, onError);
-      }
-    }, [messages, onError]);
-  }
-
+export default function IntlProvider({children, ...props}: IntlProviderProps) {
   return (
-    <IntlContext.Provider
-      value={{...contextValues, messages, onError, getMessageFallback}}
-    >
+    <IntlContext.Provider value={getIntlContextValue(props)}>
       {children}
     </IntlContext.Provider>
   );

package/src/react/IntlProviderProps.tsx

@@ -0,0 +1,17 @@
+import {ReactNode} from 'react';
+import {AbstractIntlMessages} from '../core';
+import IntlConfiguration from '../core/IntlConfiguration';
+import {RichTranslationValues} from '../core/TranslationValues';
+
+type IntlProviderProps = IntlConfiguration & {
+  /** All components that use the provided hooks should be within this tree. */
+  children: ReactNode;
+  /** 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 IntlProviderProps;

package/src/react/getIntlContextValue.tsx

@@ -0,0 +1,30 @@
+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({
+  getMessageFallback,
+  messages,
+  onError,
+  ...rest
+}: Omit<IntlProviderProps, 'children'>) {
+  const finalOnError = onError || defaultOnError;
+  const finalGetMessageFallback =
+    getMessageFallback || defaultGetMessageFallback;
+
+  if (process.env.NODE_ENV !== 'production') {
+    if (messages) {
+      validateMessages(messages, finalOnError);
+    }
+  }
+
+  return {
+    ...rest,
+    messages,
+    onError: finalOnError,
+    getMessageFallback: finalGetMessageFallback
+  };
+}

package/src/react/useIntlContext.tsx

@@ -6,7 +6,7 @@ export default function useIntlContext() {
 
   if (!context) {
     throw new Error(
-      __DEV__
+      process.env.NODE_ENV !== 'production'
         ? 'No intl context found. Have you configured the provider?'
         : undefined
     );

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Jan Amann
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.