use-intl 2.17.2-alpha.1 → 2.17.2-alpha.2

package/dist/src/react/useTranslations.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/react/useTranslations.tsx"],"sourcesContent":["import {ReactElement, ReactNodeArray} from 'react';\nimport Formats from '../core/Formats';\nimport TranslationValues, {\n  RichTranslationValues\n} from '../core/TranslationValues';\nimport MessageKeys from '../core/utils/MessageKeys';\nimport NamespaceKeys from '../core/utils/NamespaceKeys';\nimport NestedKeyOf from '../core/utils/NestedKeyOf';\nimport NestedValueOf from '../core/utils/NestedValueOf';\nimport useIntlContext from './useIntlContext';\nimport useTranslationsImpl from './useTranslationsImpl';\n\n/**\n * Translates messages from the given namespace by using the ICU syntax.\n * See https://formatjs.io/docs/core-concepts/icu-syntax.\n *\n * If no namespace is provided, all available messages are returned.\n * The namespace can also indicate nesting by using a dot\n * (e.g. `namespace.Component`).\n */\nexport default function useTranslations<\n  NestedKey extends NamespaceKeys<\n    IntlMessages,\n    NestedKeyOf<IntlMessages>\n  > = never\n>(\n  namespace?: NestedKey\n): // Explicitly defining the return type is necessary as TypeScript would get it wrong\n{\n  // Default invocation\n  <\n    TargetKey extends MessageKeys<\n      NestedValueOf<\n        {'!': IntlMessages},\n        [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n      >,\n      NestedKeyOf<\n        NestedValueOf<\n          {'!': IntlMessages},\n          [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n        >\n      >\n    >\n  >(\n    key: TargetKey,\n    values?: TranslationValues,\n    formats?: Partial<Formats>\n  ): string;\n\n  // `rich`\n  rich<\n    TargetKey extends MessageKeys<\n      NestedValueOf<\n        {'!': IntlMessages},\n        [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n      >,\n      NestedKeyOf<\n        NestedValueOf<\n          {'!': IntlMessages},\n          [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n        >\n      >\n    >\n  >(\n    key: TargetKey,\n    values?: RichTranslationValues,\n    formats?: Partial<Formats>\n  ): string | ReactElement | ReactNodeArray;\n\n  // `raw`\n  raw<\n    TargetKey extends MessageKeys<\n      NestedValueOf<\n        {'!': IntlMessages},\n        [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n      >,\n      NestedKeyOf<\n        NestedValueOf<\n          {'!': IntlMessages},\n          [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n        >\n      >\n    >\n  >(\n    key: TargetKey\n  ): any;\n} {\n  const context = useIntlContext();\n  const messages = context.messages as IntlMessages;\n\n  // We have to wrap the actual hook so the type inference for the optional\n  // namespace works correctly. See https://stackoverflow.com/a/71529575/343045\n  // The prefix (\"!\") is arbitrary.\n  return useTranslationsImpl<\n    {'!': IntlMessages},\n    [NestedKey] extends [never] ? '!' : `!.${NestedKey}`\n  >(\n    {'!': messages},\n    // @ts-ignore\n    namespace ? `!.${namespace}` : '!',\n    '!'\n  );\n}\n"],"mappings":"AASA,OAAOA,MAAoB,mBAC3B,OAAOC,MAAyB,wBAUjB,SAARC,EAMLC,EA4DA,CAEA,MAAMC,EADUJ,EAAe,EACN,SAKzB,OAAOC,EAIL,CAAC,IAAKG,CAAQ,EAEdD,EAAY,KAAKA,CAAS,GAAK,IAC/B,GACF,CACF","names":["useIntlContext","useTranslationsImpl","useTranslations","namespace","messages"]}

package/dist/src/react/useTranslationsImpl.d.mts

@@ -1,16 +0,0 @@
-import * as react from 'react';
-import AbstractIntlMessages from '../core/AbstractIntlMessages.mjs';
-import TranslationValues, { RichTranslationValues } from '../core/TranslationValues.mjs';
-import Formats from '../core/Formats.mjs';
-import NestedKeyOf from '../core/utils/NestedKeyOf.mjs';
-import '../core/DateTimeFormatOptions.mjs';
-import '../core/TimeZone.mjs';
-import '@formatjs/ecma402-abstract/types/number';
-
-declare function useTranslationsImpl<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>(allMessages: Messages, namespace: NestedKey, namespacePrefix: string): {
-    <TargetKey extends unknown>(key: TargetKey, values?: TranslationValues | undefined, formats?: Partial<Formats> | undefined): string;
-    rich: (key: string, values?: RichTranslationValues | undefined, formats?: Partial<Formats> | undefined) => string | react.ReactElement<any, string | react.JSXElementConstructor<any>> | react.ReactNodeArray;
-    raw(key: string): any;
-};
-
-export { useTranslationsImpl as default };

package/dist/src/react/useTranslationsImpl.mjs

@@ -1,2 +0,0 @@
-import{useMemo as g,useRef as d}from"react";import i,{getMessagesOrError as u}from"../core/createBaseTranslator.mjs";import M from"../core/resolveNamespace.mjs";import y from"./useIntlContext.mjs";function F(t,e,r){const{defaultTranslationValues:o,formats:a,getMessageFallback:n,locale:m,onError:s,timeZone:l}=y();t=t[r],e=M(e,r);const c=d({}),f=g(()=>u({messages:t,namespace:e,onError:s}),[t,e,s]);return g(()=>i({cachedFormatsByLocale:c.current,getMessageFallback:n,messagesOrError:f,defaultTranslationValues:o,namespace:e,onError:s,formats:a,locale:m,timeZone:l}),[n,f,o,e,s,a,m,l])}export{F as default};
-//# sourceMappingURL=useTranslationsImpl.mjs.map

package/dist/src/react/useTranslationsImpl.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/react/useTranslationsImpl.tsx"],"sourcesContent":["// eslint-disable-next-line import/no-named-as-default -- False positive\nimport IntlMessageFormat from 'intl-messageformat';\nimport {useMemo, useRef} from 'react';\nimport AbstractIntlMessages from '../core/AbstractIntlMessages';\nimport createBaseTranslator, {\n  getMessagesOrError\n} from '../core/createBaseTranslator';\nimport resolveNamespace from '../core/resolveNamespace';\nimport NestedKeyOf from '../core/utils/NestedKeyOf';\nimport useIntlContext from './useIntlContext';\n\nexport default function useTranslationsImpl<\n  Messages extends AbstractIntlMessages,\n  NestedKey extends NestedKeyOf<Messages>\n>(allMessages: Messages, namespace: NestedKey, namespacePrefix: string) {\n  const {\n    defaultTranslationValues,\n    formats: globalFormats,\n    getMessageFallback,\n    locale,\n    onError,\n    timeZone\n  } = useIntlContext();\n\n  // The `namespacePrefix` is part of the type system.\n  // See the comment in the hook invocation.\n  allMessages = allMessages[namespacePrefix] as Messages;\n  namespace = resolveNamespace(namespace, namespacePrefix) as NestedKey;\n\n  const cachedFormatsByLocaleRef = useRef<\n    Record<string, Record<string, IntlMessageFormat>>\n  >({});\n\n  const messagesOrError = useMemo(\n    () => getMessagesOrError({messages: allMessages, namespace, onError}),\n    [allMessages, namespace, onError]\n  );\n\n  const translate = useMemo(\n    () =>\n      createBaseTranslator({\n        cachedFormatsByLocale: cachedFormatsByLocaleRef.current,\n        getMessageFallback,\n        messagesOrError,\n        defaultTranslationValues,\n        namespace,\n        onError,\n        formats: globalFormats,\n        locale,\n        timeZone\n      }),\n    [\n      getMessageFallback,\n      messagesOrError,\n      defaultTranslationValues,\n      namespace,\n      onError,\n      globalFormats,\n      locale,\n      timeZone\n    ]\n  );\n\n  return translate;\n}\n"],"mappings":"AAEA,OAAQ,WAAAA,EAAS,UAAAC,MAAa,QAE9B,OAAOC,GACL,sBAAAC,MACK,+BACP,OAAOC,MAAsB,2BAE7B,OAAOC,MAAoB,mBAEZ,SAARC,EAGLC,EAAuBC,EAAsBC,EAAyB,CACtE,KAAM,CACJ,yBAAAC,EACA,QAASC,EACT,mBAAAC,EACA,OAAAC,EACA,QAAAC,EACA,SAAAC,CACF,EAAIV,EAAe,EAInBE,EAAcA,EAAYE,CAAe,EACzCD,EAAYJ,EAAiBI,EAAWC,CAAe,EAEvD,MAAMO,EAA2Bf,EAE/B,CAAC,CAAC,EAEEgB,EAAkBjB,EACtB,IAAMG,EAAmB,CAAC,SAAUI,EAAa,UAAAC,EAAW,QAAAM,CAAO,CAAC,EACpE,CAACP,EAAaC,EAAWM,CAAO,CAClC,EA2BA,OAzBkBd,EAChB,IACEE,EAAqB,CACnB,sBAAuBc,EAAyB,QAChD,mBAAAJ,EACA,gBAAAK,EACA,yBAAAP,EACA,UAAAF,EACA,QAAAM,EACA,QAASH,EACT,OAAAE,EACA,SAAAE,CACF,CAAC,EACH,CACEH,EACAK,EACAP,EACAF,EACAM,EACAH,EACAE,EACAE,CACF,CACF,CAGF","names":["useMemo","useRef","createBaseTranslator","getMessagesOrError","resolveNamespace","useIntlContext","useTranslationsImpl","allMessages","namespace","namespacePrefix","defaultTranslationValues","globalFormats","getMessageFallback","locale","onError","timeZone","cachedFormatsByLocaleRef","messagesOrError"]}