use-intl 2.7.6 → 2.8.0

package/dist/use-intl.esm9.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-intl.esm9.js","sources":["../src/validateMessages.tsx"],"sourcesContent":["import AbstractIntlMessages from './AbstractIntlMessages';\nimport IntlError, {IntlErrorCode} from './IntlError';\n\nfunction validateMessagesSegment(\n  messages: AbstractIntlMessages,\n  invalidKeyLabels: Array<string>,\n  parentPath?: string\n) {\n  Object.entries(messages).forEach(([key, messageOrMessages]) => {\n    if (key.includes('.')) {\n      let keyLabel = key;\n      if (parentPath) keyLabel += ` (at ${parentPath})`;\n      invalidKeyLabels.push(keyLabel);\n    }\n\n    if (messageOrMessages != null && typeof messageOrMessages === 'object') {\n      validateMessagesSegment(\n        messageOrMessages,\n        invalidKeyLabels,\n        [parentPath, key].filter((part) => part != null).join('.')\n      );\n    }\n  });\n}\n\nexport default function validateMessages(\n  messages: AbstractIntlMessages,\n  onError: (error: IntlError) => void\n) {\n  const invalidKeyLabels: Array<string> = [];\n  validateMessagesSegment(messages, invalidKeyLabels);\n\n  if (invalidKeyLabels.length > 0) {\n    onError(\n      new IntlError(\n        IntlErrorCode.INVALID_KEY,\n        `Namespace keys can not contain the character \".\" as this is used to express nesting. Please remove it or replace it with another character.\\n\\nInvalid ${\n          invalidKeyLabels.length === 1 ? 'key' : 'keys'\n        }: ${invalidKeyLabels.join(', ')}`\n      )\n    );\n  }\n}\n"],"names":["validateMessagesSegment","messages","invalidKeyLabels","parentPath","Object","entries","forEach","key","messageOrMessages","includes","keyLabel","push","filter","part","join","validateMessages","onError","length","IntlError","IntlErrorCode","INVALID_KEY"],"mappings":";;AAGA,SAASA,uBAAT,CACEC,QADF,EAEEC,gBAFF,EAGEC,UAHF,EAGqB;AAEnBC,EAAAA,MAAM,CAACC,OAAP,CAAeJ,QAAf,CAAyBK,CAAAA,OAAzB,CAAiC,UAA6B,IAAA,EAAA;AAAA,IAAA,IAA3BC,GAA2B,GAAA,IAAA,CAAA,CAAA,CAAA;AAAA,QAAtBC,iBAAsB,GAAA,IAAA,CAAA,CAAA,CAAA,CAAA;;AAC5D,IAAA,IAAID,GAAG,CAACE,QAAJ,CAAa,GAAb,CAAJ,EAAuB;AACrB,MAAIC,IAAAA,QAAQ,GAAGH,GAAf,CAAA;AACA,MAAA,IAAIJ,UAAJ,EAAgBO,QAAQ,IAAA,OAAA,GAAYP,UAAZ,GAAR,GAAA,CAAA;AAChBD,MAAAA,gBAAgB,CAACS,IAAjB,CAAsBD,QAAtB,CAAA,CAAA;AACD,KAAA;;AAED,IAAIF,IAAAA,iBAAiB,IAAI,IAArB,IAA6B,OAAOA,iBAAP,KAA6B,QAA9D,EAAwE;AACtER,MAAAA,uBAAuB,CACrBQ,iBADqB,EAErBN,gBAFqB,EAGrB,CAACC,UAAD,EAAaI,GAAb,CAAA,CAAkBK,MAAlB,CAAyB,UAACC,IAAD,EAAA;AAAA,QAAUA,OAAAA,IAAI,IAAI,IAAlB,CAAA;AAAA,OAAzB,CAAiDC,CAAAA,IAAjD,CAAsD,GAAtD,CAHqB,CAAvB,CAAA;AAKD,KAAA;AACF,GAdD,CAAA,CAAA;AAeD,CAAA;;AAEa,SAAUC,gBAAV,CACZd,QADY,EAEZe,OAFY,EAEuB;AAEnC,EAAMd,IAAAA,gBAAgB,GAAkB,EAAxC,CAAA;AACAF,EAAAA,uBAAuB,CAACC,QAAD,EAAWC,gBAAX,CAAvB,CAAA;;AAEA,EAAA,IAAIA,gBAAgB,CAACe,MAAjB,GAA0B,CAA9B,EAAiC;AAC/BD,IAAAA,OAAO,CACL,IAAIE,SAAJ,CACEC,aAAa,CAACC,WADhB,EAAA,2JAAA,IAGIlB,gBAAgB,CAACe,MAAjB,KAA4B,CAA5B,GAAgC,KAAhC,GAAwC,MAH5C,CAIOf,GAAAA,IAAAA,GAAAA,gBAAgB,CAACY,IAAjB,CAAsB,IAAtB,CAJP,CADK,CAAP,CAAA;AAQD,GAAA;AACF;;;;"}

package/dist/useTranslationsImpl.d.ts

@@ -1,12 +0,0 @@
-import { ReactElement, ReactNodeArray } from 'react';
-import AbstractIntlMessages from './AbstractIntlMessages';
-import Formats from './Formats';
-import TranslationValues, { RichTranslationValues } from './TranslationValues';
-import MessageKeys from './utils/MessageKeys';
-import NestedKeyOf from './utils/NestedKeyOf';
-import NestedValueOf from './utils/NestedValueOf';
-export default function useTranslationsImpl<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>(allMessages: Messages, namespace: NestedKey, namespacePrefix: string): {
-    <TargetKey extends MessageKeys<NestedValueOf<Messages, NestedKey>, NestedKeyOf<NestedValueOf<Messages, NestedKey>>>>(key: TargetKey, values?: TranslationValues | undefined, formats?: Partial<Formats> | undefined): string;
-    rich: (key: string, values?: RichTranslationValues | undefined, formats?: Partial<Formats> | undefined) => string | ReactElement | ReactNodeArray;
-    raw(key: string): any;
-};

package/src/TranslationValues.tsx

@@ -1,13 +0,0 @@
-import {ReactNode} from 'react';
-
-// From IntlMessageFormat#format
-type TranslationValue = string | number | boolean | Date | null | undefined;
-
-type TranslationValues = Record<string, TranslationValue>;
-
-export type RichTranslationValues = Record<
-  string,
-  TranslationValue | ((children: ReactNode) => ReactNode)
->;
-
-export default TranslationValues;

package/src/useTranslationsImpl.tsx

@@ -1,328 +0,0 @@
-import {IntlMessageFormat} from 'intl-messageformat';
-import {
-  cloneElement,
-  isValidElement,
-  ReactElement,
-  ReactNode,
-  ReactNodeArray,
-  useMemo,
-  useRef
-} from 'react';
-import AbstractIntlMessages from './AbstractIntlMessages';
-import Formats from './Formats';
-import IntlError, {IntlErrorCode} from './IntlError';
-import TranslationValues, {RichTranslationValues} from './TranslationValues';
-import convertFormatsToIntlMessageFormat from './convertFormatsToIntlMessageFormat';
-import useIntlContext from './useIntlContext';
-import MessageKeys from './utils/MessageKeys';
-import NestedKeyOf from './utils/NestedKeyOf';
-import NestedValueOf from './utils/NestedValueOf';
-
-function resolvePath(
-  messages: AbstractIntlMessages | undefined,
-  idPath: string,
-  namespace?: string
-) {
-  if (!messages) {
-    throw new Error(
-      __DEV__ ? `No messages available at \`${namespace}\`.` : undefined
-    );
-  }
-
-  let message = messages;
-
-  idPath.split('.').forEach((part) => {
-    const next = (message as any)[part];
-
-    if (part == null || next == null) {
-      throw new Error(
-        __DEV__
-          ? `Could not resolve \`${idPath}\` in ${
-              namespace ? `\`${namespace}\`` : 'messages'
-            }.`
-          : undefined
-      );
-    }
-
-    message = next;
-  });
-
-  return message;
-}
-
-function prepareTranslationValues(values: RichTranslationValues) {
-  if (Object.keys(values).length === 0) return undefined;
-
-  // Workaround for https://github.com/formatjs/formatjs/issues/1467
-  const transformedValues: RichTranslationValues = {};
-  Object.keys(values).forEach((key) => {
-    let index = 0;
-    const value = values[key];
-
-    let transformed;
-    if (typeof value === 'function') {
-      transformed = (children: ReactNode) => {
-        const result = value(children);
-
-        return isValidElement(result)
-          ? cloneElement(result, {key: key + index++})
-          : result;
-      };
-    } else {
-      transformed = value;
-    }
-
-    transformedValues[key] = transformed;
-  });
-
-  return transformedValues;
-}
-
-export default function useTranslationsImpl<
-  Messages extends AbstractIntlMessages,
-  NestedKey extends NestedKeyOf<Messages>
->(allMessages: Messages, namespace: NestedKey, namespacePrefix: string) {
-  const {
-    defaultTranslationValues,
-    formats: globalFormats,
-    getMessageFallback,
-    locale,
-    onError,
-    timeZone
-  } = useIntlContext();
-
-  // The `namespacePrefix` is part of the type system.
-  // See the comment in the hook invocation.
-  allMessages = allMessages[namespacePrefix] as Messages;
-  namespace = (
-    namespace === namespacePrefix
-      ? undefined
-      : namespace.slice((namespacePrefix + '.').length)
-  ) as NestedKey;
-
-  const cachedFormatsByLocaleRef = useRef<
-    Record<string, Record<string, IntlMessageFormat>>
-  >({});
-
-  const messagesOrError = useMemo(() => {
-    try {
-      if (!allMessages) {
-        throw new Error(
-          __DEV__ ? `No messages were configured on the provider.` : undefined
-        );
-      }
-
-      const retrievedMessages = namespace
-        ? resolvePath(allMessages, namespace)
-        : allMessages;
-
-      if (!retrievedMessages) {
-        throw new Error(
-          __DEV__
-            ? `No messages for namespace \`${namespace}\` found.`
-            : undefined
-        );
-      }
-
-      return retrievedMessages;
-    } catch (error) {
-      const intlError = new IntlError(
-        IntlErrorCode.MISSING_MESSAGE,
-        (error as Error).message
-      );
-      onError(intlError);
-      return intlError;
-    }
-  }, [allMessages, namespace, onError]);
-
-  const translate = useMemo(() => {
-    function getFallbackFromErrorAndNotify(
-      key: string,
-      code: IntlErrorCode,
-      message?: string
-    ) {
-      const error = new IntlError(code, message);
-      onError(error);
-      return getMessageFallback({error, key, namespace});
-    }
-
-    function translateBaseFn(
-      /** Use a dot to indicate a level of nesting (e.g. `namespace.nestedLabel`). */
-      key: string,
-      /** Key value pairs for values to interpolate into the message. */
-      values?: RichTranslationValues,
-      /** Provide custom formats for numbers, dates and times. */
-      formats?: Partial<Formats>
-    ): string | ReactElement | ReactNodeArray {
-      const cachedFormatsByLocale = cachedFormatsByLocaleRef.current;
-
-      if (messagesOrError instanceof IntlError) {
-        // We have already warned about this during render
-        return getMessageFallback({
-          error: messagesOrError,
-          key,
-          namespace
-        });
-      }
-      const messages = messagesOrError;
-
-      const cacheKey = [namespace, key]
-        .filter((part) => part != null)
-        .join('.');
-
-      let messageFormat;
-      if (cachedFormatsByLocale[locale]?.[cacheKey]) {
-        messageFormat = cachedFormatsByLocale[locale][cacheKey];
-      } else {
-        let message;
-        try {
-          message = resolvePath(messages, key, namespace);
-        } catch (error) {
-          return getFallbackFromErrorAndNotify(
-            key,
-            IntlErrorCode.MISSING_MESSAGE,
-            (error as Error).message
-          );
-        }
-
-        if (typeof message === 'object') {
-          return getFallbackFromErrorAndNotify(
-            key,
-            IntlErrorCode.INSUFFICIENT_PATH,
-            __DEV__
-              ? `Insufficient path specified for \`${key}\` in \`${
-                  namespace ? `\`${namespace}\`` : 'messages'
-                }\`.`
-              : undefined
-          );
-        }
-
-        try {
-          messageFormat = new IntlMessageFormat(
-            message,
-            locale,
-            convertFormatsToIntlMessageFormat(
-              {...globalFormats, ...formats},
-              timeZone
-            )
-          );
-        } catch (error) {
-          return getFallbackFromErrorAndNotify(
-            key,
-            IntlErrorCode.INVALID_MESSAGE,
-            (error as Error).message
-          );
-        }
-
-        if (!cachedFormatsByLocale[locale]) {
-          cachedFormatsByLocale[locale] = {};
-        }
-        cachedFormatsByLocale[locale][cacheKey] = messageFormat;
-      }
-
-      try {
-        const formattedMessage = messageFormat.format(
-          // @ts-ignore `intl-messageformat` expects a different format
-          // for rich text elements since a recent minor update. This
-          // needs to be evaluated in detail, possibly also in regards
-          // to be able to format to parts.
-          prepareTranslationValues({...defaultTranslationValues, ...values})
-        );
-
-        if (formattedMessage == null) {
-          throw new Error(
-            __DEV__
-              ? `Unable to format \`${key}\` in ${
-                  namespace ? `namespace \`${namespace}\`` : 'messages'
-                }`
-              : undefined
-          );
-        }
-
-        // Limit the function signature to return strings or React elements
-        return isValidElement(formattedMessage) ||
-          // Arrays of React elements
-          Array.isArray(formattedMessage) ||
-          typeof formattedMessage === 'string'
-          ? formattedMessage
-          : String(formattedMessage);
-      } catch (error) {
-        return getFallbackFromErrorAndNotify(
-          key,
-          IntlErrorCode.FORMATTING_ERROR,
-          (error as Error).message
-        );
-      }
-    }
-
-    function translateFn<
-      TargetKey extends MessageKeys<
-        NestedValueOf<Messages, NestedKey>,
-        NestedKeyOf<NestedValueOf<Messages, NestedKey>>
-      >
-    >(
-      /** Use a dot to indicate a level of nesting (e.g. `namespace.nestedLabel`). */
-      key: TargetKey,
-      /** Key value pairs for values to interpolate into the message. */
-      values?: TranslationValues,
-      /** Provide custom formats for numbers, dates and times. */
-      formats?: Partial<Formats>
-    ): string {
-      const message = translateBaseFn(key, values, formats);
-
-      if (typeof message !== 'string') {
-        return getFallbackFromErrorAndNotify(
-          key,
-          IntlErrorCode.INVALID_MESSAGE,
-          __DEV__
-            ? `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.`
-            : undefined
-        );
-      }
-
-      return message;
-    }
-
-    translateFn.rich = translateBaseFn;
-
-    translateFn.raw = (
-      /** Use a dot to indicate a level of nesting (e.g. `namespace.nestedLabel`). */
-      key: string
-    ): any => {
-      if (messagesOrError instanceof IntlError) {
-        // We have already warned about this during render
-        return getMessageFallback({
-          error: messagesOrError,
-          key,
-          namespace
-        });
-      }
-      const messages = messagesOrError;
-
-      try {
-        return resolvePath(messages, key, namespace);
-      } catch (error) {
-        return getFallbackFromErrorAndNotify(
-          key,
-          IntlErrorCode.MISSING_MESSAGE,
-          (error as Error).message
-        );
-      }
-    };
-
-    return translateFn;
-  }, [
-    onError,
-    getMessageFallback,
-    namespace,
-    messagesOrError,
-    locale,
-    globalFormats,
-    timeZone,
-    defaultTranslationValues
-  ]);
-
-  return translate;
-}