use-intl 2.9.1 → 2.10.0-alpha.3

package/dist/src/core/validateMessages.js

@@ -0,0 +1,22 @@
+import IntlError, { IntlErrorCode } from './IntlError';
+function validateMessagesSegment(messages, invalidKeyLabels, parentPath) {
+    Object.entries(messages).forEach(([key, messageOrMessages]) => {
+        if (key.includes('.')) {
+            let keyLabel = key;
+            if (parentPath)
+                keyLabel += ` (at ${parentPath})`;
+            invalidKeyLabels.push(keyLabel);
+        }
+        if (messageOrMessages != null && typeof messageOrMessages === 'object') {
+            validateMessagesSegment(messageOrMessages, invalidKeyLabels, [parentPath, key].filter((part) => part != null).join('.'));
+        }
+    });
+}
+export default function validateMessages(messages, onError) {
+    const invalidKeyLabels = [];
+    validateMessagesSegment(messages, invalidKeyLabels);
+    if (invalidKeyLabels.length > 0) {
+        onError(new IntlError(IntlErrorCode.INVALID_KEY, `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 ${invalidKeyLabels.length === 1 ? 'key' : 'keys'}: ${invalidKeyLabels.join(', ')}`));
+    }
+}
+//# sourceMappingURL=validateMessages.js.map

package/dist/src/core/validateMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateMessages.js","sourceRoot":"","sources":["../../../src/core/validateMessages.tsx"],"names":[],"mappings":"AACA,OAAO,SAAS,EAAE,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAErD,SAAS,uBAAuB,CAC9B,QAA8B,EAC9B,gBAA+B,EAC/B,UAAmB;IAEnB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE;QAC5D,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACrB,IAAI,QAAQ,GAAG,GAAG,CAAC;YACnB,IAAI,UAAU;gBAAE,QAAQ,IAAI,QAAQ,UAAU,GAAG,CAAC;YAClD,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACjC;QAED,IAAI,iBAAiB,IAAI,IAAI,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;YACtE,uBAAuB,CACrB,iBAAiB,EACjB,gBAAgB,EAChB,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,CAAC;SACH;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,QAA8B,EAC9B,OAAmC;IAEnC,MAAM,gBAAgB,GAAkB,EAAE,CAAC;IAC3C,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IAEpD,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/B,OAAO,CACL,IAAI,SAAS,CACX,aAAa,CAAC,WAAW,EACzB,0JACE,gBAAgB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAC1C,KAAK,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACnC,CACF,CAAC;KACH;AACH,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './core';
+export * from './react';

package/dist/src/index.js

@@ -0,0 +1,3 @@
+export * from './core';
+export * from './react';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/dist/src/react/IntlContext.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import IntlContextValue from './IntlContextValue';
+declare const IntlContext: import("react").Context<IntlContextValue | undefined>;
+export default IntlContext;

package/dist/src/react/IntlContext.js

@@ -0,0 +1,4 @@
+import { createContext } from 'react';
+const IntlContext = createContext(undefined);
+export default IntlContext;
+//# sourceMappingURL=IntlContext.js.map

package/dist/src/react/IntlContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntlContext.js","sourceRoot":"","sources":["../../../src/react/IntlContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AAGpC,MAAM,WAAW,GAAG,aAAa,CAA+B,SAAS,CAAC,CAAC;AAE3E,eAAe,WAAW,CAAC"}

package/dist/src/react/IntlContextValue.d.ts

@@ -0,0 +1,19 @@
+import AbstractIntlMessages from '../core/AbstractIntlMessages';
+import Formats from '../core/Formats';
+import IntlError from '../core/IntlError';
+import { RichTranslationValues } from '../core/TranslationValues';
+declare 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/dist/src/react/IntlContextValue.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IntlContextValue.js.map

package/dist/src/react/IntlContextValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntlContextValue.js","sourceRoot":"","sources":["../../../src/react/IntlContextValue.tsx"],"names":[],"mappings":""}

package/dist/src/react/IntlProvider.d.ts

@@ -0,0 +1,2 @@
+import IntlProviderProps from './IntlProviderProps';
+export default function IntlProvider({ children, ...props }: IntlProviderProps): JSX.Element;

package/dist/src/react/IntlProvider.js

@@ -0,0 +1,7 @@
+import React from 'react';
+import IntlContext from './IntlContext';
+import getIntlContextValue from './getIntlContextValue';
+export default function IntlProvider({ children, ...props }) {
+    return (React.createElement(IntlContext.Provider, { value: getIntlContextValue(props) }, children));
+}
+//# sourceMappingURL=IntlProvider.js.map

package/dist/src/react/IntlProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntlProvider.js","sourceRoot":"","sources":["../../../src/react/IntlProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,EAAC,QAAQ,EAAE,GAAG,KAAK,EAAoB;IAC1E,OAAO,CACL,oBAAC,WAAW,CAAC,QAAQ,IAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,IACpD,QAAQ,CACY,CACxB,CAAC;AACJ,CAAC"}

package/dist/src/react/IntlProviderProps.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+import { AbstractIntlMessages } from '../core';
+import IntlConfiguration from '../core/IntlConfiguration';
+import { RichTranslationValues } from '../core/TranslationValues';
+declare 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/dist/src/react/IntlProviderProps.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IntlProviderProps.js.map

package/dist/src/react/IntlProviderProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntlProviderProps.js","sourceRoot":"","sources":["../../../src/react/IntlProviderProps.tsx"],"names":[],"mappings":""}

package/dist/src/react/getIntlContextValue.d.ts

@@ -0,0 +1,18 @@
+import IntlProviderProps from './IntlProviderProps';
+/**
+ * Enhances the incoming props with defaults.
+ */
+export default function getIntlContextValue({ getMessageFallback, messages, onError, ...rest }: Omit<IntlProviderProps, 'children'>): {
+    messages: import("../core/AbstractIntlMessages").default | undefined;
+    onError: (error: import("..").IntlError) => void;
+    getMessageFallback: (info: {
+        error: import("..").IntlError;
+        key: string;
+        namespace?: string | undefined;
+    }) => string;
+    defaultTranslationValues?: import("..").RichTranslationValues | undefined;
+    formats?: Partial<import("../core/Formats").default> | undefined;
+    locale: string;
+    timeZone?: string | undefined;
+    now?: Date | undefined;
+};

package/dist/src/react/getIntlContextValue.js

@@ -0,0 +1,21 @@
+import { defaultGetMessageFallback, defaultOnError } from '../core/defaults';
+import validateMessages from '../core/validateMessages';
+/**
+ * Enhances the incoming props with defaults.
+ */
+export default function getIntlContextValue({ getMessageFallback, messages, onError, ...rest }) {
+    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
+    };
+}
+//# sourceMappingURL=getIntlContextValue.js.map

package/dist/src/react/getIntlContextValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getIntlContextValue.js","sourceRoot":"","sources":["../../../src/react/getIntlContextValue.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,yBAAyB,EAAE,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3E,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AAGxD;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,EAC1C,kBAAkB,EAClB,QAAQ,EACR,OAAO,EACP,GAAG,IAAI,EAC6B;IACpC,MAAM,YAAY,GAAG,OAAO,IAAI,cAAc,CAAC;IAC/C,MAAM,uBAAuB,GAC3B,kBAAkB,IAAI,yBAAyB,CAAC;IAElD,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;QACzC,IAAI,QAAQ,EAAE;YACZ,gBAAgB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;SAC1C;KACF;IAED,OAAO;QACL,GAAG,IAAI;QACP,QAAQ;QACR,OAAO,EAAE,YAAY;QACrB,kBAAkB,EAAE,uBAAuB;KAC5C,CAAC;AACJ,CAAC"}

package/dist/src/react/index.d.ts

@@ -0,0 +1,6 @@
+export { default as IntlProvider } from './IntlProvider';
+export { default as useTranslations } from './useTranslations';
+export { default as useIntl } from './useIntl';
+export { default as useLocale } from './useLocale';
+export { default as useNow } from './useNow';
+export { default as useTimeZone } from './useTimeZone';

package/dist/src/react/index.js

@@ -0,0 +1,7 @@
+export { default as IntlProvider } from './IntlProvider';
+export { default as useTranslations } from './useTranslations';
+export { default as useIntl } from './useIntl';
+export { default as useLocale } from './useLocale';
+export { default as useNow } from './useNow';
+export { default as useTimeZone } from './useTimeZone';
+//# sourceMappingURL=index.js.map

package/dist/src/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/react/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,aAAa,CAAC;AACjD,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,eAAe,CAAC"}

package/dist/src/react/useIntl.d.ts

@@ -0,0 +1,5 @@
+export default function useIntl(): {
+    formatDateTime: (value: number | Date, formatOrOptions?: string | import("../core/DateTimeFormatOptions").default | undefined) => string;
+    formatNumber: (value: number, formatOrOptions?: string | import("@formatjs/ecma402-abstract").NumberFormatOptions | undefined) => string;
+    formatRelativeTime: (date: number | Date, now?: number | Date | undefined) => string;
+};

package/dist/src/react/useIntl.js

@@ -0,0 +1,14 @@
+import { useMemo } from 'react';
+import createIntl from '../core/createIntl';
+import useIntlContext from './useIntlContext';
+export default function useIntl() {
+    const { formats, locale, now: globalNow, onError, timeZone } = useIntlContext();
+    return useMemo(() => createIntl({
+        formats,
+        locale,
+        now: globalNow,
+        onError,
+        timeZone
+    }), [formats, globalNow, locale, onError, timeZone]);
+}
+//# sourceMappingURL=useIntl.js.map

package/dist/src/react/useIntl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIntl.js","sourceRoot":"","sources":["../../../src/react/useIntl.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,OAAO;IAC7B,MAAM,EAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAC,GAAG,cAAc,EAAE,CAAC;IAE9E,OAAO,OAAO,CACZ,GAAG,EAAE,CACH,UAAU,CAAC;QACT,OAAO;QACP,MAAM;QACN,GAAG,EAAE,SAAS;QACd,OAAO;QACP,QAAQ;KACT,CAAC,EACJ,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAChD,CAAC;AACJ,CAAC"}

package/dist/src/react/useIntlContext.d.ts

@@ -0,0 +1 @@
+export default function useIntlContext(): import("./IntlContextValue").default;

package/dist/src/react/useIntlContext.js

@@ -0,0 +1,12 @@
+import { useContext } from 'react';
+import IntlContext from './IntlContext';
+export default function useIntlContext() {
+    const context = useContext(IntlContext);
+    if (!context) {
+        throw new Error(process.env.NODE_ENV !== 'production'
+            ? 'No intl context found. Have you configured the provider?'
+            : undefined);
+    }
+    return context;
+}
+//# sourceMappingURL=useIntlContext.js.map

package/dist/src/react/useIntlContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIntlContext.js","sourceRoot":"","sources":["../../../src/react/useIntlContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,OAAO,CAAC;AACjC,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,MAAM,CAAC,OAAO,UAAU,cAAc;IACpC,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IAExC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CACb,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;YACnC,CAAC,CAAC,0DAA0D;YAC5D,CAAC,CAAC,SAAS,CACd,CAAC;KACH;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/src/react/useLocale.d.ts

@@ -0,0 +1 @@
+export default function useLocale(): string;

package/dist/src/react/useLocale.js

@@ -0,0 +1,5 @@
+import useIntlContext from './useIntlContext';
+export default function useLocale() {
+    return useIntlContext().locale;
+}
+//# sourceMappingURL=useLocale.js.map

package/dist/src/react/useLocale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocale.js","sourceRoot":"","sources":["../../../src/react/useLocale.tsx"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,SAAS;IAC/B,OAAO,cAAc,EAAE,CAAC,MAAM,CAAC;AACjC,CAAC"}

package/dist/src/react/useNow.d.ts

@@ -0,0 +1,23 @@
+declare type Options = {
+    updateInterval?: number;
+};
+/**
+ * Reading the current date via `new Date()` in components should be avoided, as
+ * it causes components to be impure and can lead to flaky tests. Instead, this
+ * hook can be used.
+ *
+ * By default, it returns the time when the component mounts. If `updateInterval`
+ * is specified, the value will be updated based on the interval.
+ *
+ * You can however also return a static value from this hook, if you
+ * configure the `now` parameter on the context provider. Note however,
+ * that if `updateInterval` is configured in this case, the component
+ * will initialize with the global value, but will afterwards update
+ * continuously based on the interval.
+ *
+ * For unit tests, this can be mocked to a constant value. For end-to-end
+ * testing, an environment parameter can be passed to the `now` parameter
+ * of the provider to mock this to a static value.
+ */
+export default function useNow(options?: Options): Date;
+export {};

package/dist/src/react/useNow.js

@@ -0,0 +1,40 @@
+import { useState, useEffect } from 'react';
+import useIntlContext from './useIntlContext';
+function getNow() {
+    return new Date();
+}
+/**
+ * Reading the current date via `new Date()` in components should be avoided, as
+ * it causes components to be impure and can lead to flaky tests. Instead, this
+ * hook can be used.
+ *
+ * By default, it returns the time when the component mounts. If `updateInterval`
+ * is specified, the value will be updated based on the interval.
+ *
+ * You can however also return a static value from this hook, if you
+ * configure the `now` parameter on the context provider. Note however,
+ * that if `updateInterval` is configured in this case, the component
+ * will initialize with the global value, but will afterwards update
+ * continuously based on the interval.
+ *
+ * For unit tests, this can be mocked to a constant value. For end-to-end
+ * testing, an environment parameter can be passed to the `now` parameter
+ * of the provider to mock this to a static value.
+ */
+export default function useNow(options) {
+    const updateInterval = options?.updateInterval;
+    const { now: globalNow } = useIntlContext();
+    const [now, setNow] = useState(globalNow || getNow());
+    useEffect(() => {
+        if (!updateInterval)
+            return;
+        const intervalId = setInterval(() => {
+            setNow(getNow());
+        }, updateInterval);
+        return () => {
+            clearInterval(intervalId);
+        };
+    }, [globalNow, updateInterval]);
+    return now;
+}
+//# sourceMappingURL=useNow.js.map

package/dist/src/react/useNow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useNow.js","sourceRoot":"","sources":["../../../src/react/useNow.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,SAAS,EAAC,MAAM,OAAO,CAAC;AAC1C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAM9C,SAAS,MAAM;IACb,OAAO,IAAI,IAAI,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,OAAiB;IAC9C,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,CAAC;IAE/C,MAAM,EAAC,GAAG,EAAE,SAAS,EAAC,GAAG,cAAc,EAAE,CAAC;IAC1C,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,SAAS,IAAI,MAAM,EAAE,CAAC,CAAC;IAEtD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,cAAc;YAAE,OAAO;QAE5B,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE;YAClC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QACnB,CAAC,EAAE,cAAc,CAAC,CAAC;QAEnB,OAAO,GAAG,EAAE;YACV,aAAa,CAAC,UAAU,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAEhC,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/src/react/useTimeZone.d.ts

@@ -0,0 +1 @@
+export default function useTimeZone(): string | undefined;

package/dist/src/react/useTimeZone.js

@@ -0,0 +1,5 @@
+import useIntlContext from './useIntlContext';
+export default function useTimeZone() {
+    return useIntlContext().timeZone;
+}
+//# sourceMappingURL=useTimeZone.js.map

package/dist/src/react/useTimeZone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTimeZone.js","sourceRoot":"","sources":["../../../src/react/useTimeZone.tsx"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,WAAW;IACjC,OAAO,cAAc,EAAE,CAAC,QAAQ,CAAC;AACnC,CAAC"}

package/dist/src/react/useTranslations.d.ts

@@ -0,0 +1,44 @@
+import { ReactElement, ReactNodeArray } from 'react';
+import Formats from '../core/Formats';
+import TranslationValues, { RichTranslationValues } from '../core/TranslationValues';
+import MessageKeys from '../core/utils/MessageKeys';
+import NamespaceKeys from '../core/utils/NamespaceKeys';
+import NestedKeyOf from '../core/utils/NestedKeyOf';
+import NestedValueOf from '../core/utils/NestedValueOf';
+/**
+ * Translates messages from the given namespace by using the ICU syntax.
+ * See https://formatjs.io/docs/core-concepts/icu-syntax.
+ *
+ * If no namespace is provided, all available messages are returned.
+ * The namespace can also indicate nesting by using a dot
+ * (e.g. `namespace.Component`).
+ */
+export default function useTranslations<NestedKey extends NamespaceKeys<IntlMessages, NestedKeyOf<IntlMessages>> = never>(namespace?: NestedKey): {
+    <TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: TranslationValues, formats?: Partial<Formats>): string;
+    rich<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Partial<Formats>): string | ReactElement | ReactNodeArray;
+    raw<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey): any;
+};

package/dist/src/react/useTranslations.js

@@ -0,0 +1,21 @@
+import useIntlContext from './useIntlContext';
+import useTranslationsImpl from './useTranslationsImpl';
+/**
+ * Translates messages from the given namespace by using the ICU syntax.
+ * See https://formatjs.io/docs/core-concepts/icu-syntax.
+ *
+ * If no namespace is provided, all available messages are returned.
+ * The namespace can also indicate nesting by using a dot
+ * (e.g. `namespace.Component`).
+ */
+export default function useTranslations(namespace) {
+    const context = useIntlContext();
+    const messages = context.messages;
+    // We have to wrap the actual hook so the type inference for the optional
+    // namespace works correctly. See https://stackoverflow.com/a/71529575/343045
+    // The prefix ("!") is arbitrary.
+    return useTranslationsImpl({ '!': messages }, 
+    // @ts-ignore
+    namespace ? `!.${namespace}` : '!', '!');
+}
+//# sourceMappingURL=useTranslations.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTranslations.js","sourceRoot":"","sources":["../../../src/react/useTranslations.tsx"],"names":[],"mappings":"AASA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAMrC,SAAqB;IA6DrB,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAwB,CAAC;IAElD,yEAAyE;IACzE,6EAA6E;IAC7E,iCAAiC;IACjC,OAAO,mBAAmB,CAIxB,EAAC,GAAG,EAAE,QAAQ,EAAC;IACf,aAAa;IACb,SAAS,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,EAClC,GAAG,CACJ,CAAC;AACJ,CAAC"}

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

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

package/dist/src/react/useTranslationsImpl.js

@@ -0,0 +1,35 @@
+import { useMemo, useRef } from 'react';
+import createBaseTranslator, { getMessagesOrError } from '../core/createBaseTranslator';
+import resolveNamespace from '../core/resolveNamespace';
+import useIntlContext from './useIntlContext';
+export default function useTranslationsImpl(allMessages, namespace, namespacePrefix) {
+    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];
+    namespace = resolveNamespace(namespace, namespacePrefix);
+    const cachedFormatsByLocaleRef = useRef({});
+    const messagesOrError = useMemo(() => getMessagesOrError({ messages: allMessages, namespace, onError }), [allMessages, namespace, onError]);
+    const translate = useMemo(() => createBaseTranslator({
+        cachedFormatsByLocale: cachedFormatsByLocaleRef.current,
+        getMessageFallback,
+        messagesOrError,
+        defaultTranslationValues,
+        namespace,
+        onError,
+        formats: globalFormats,
+        locale,
+        timeZone
+    }), [
+        getMessageFallback,
+        messagesOrError,
+        defaultTranslationValues,
+        namespace,
+        onError,
+        globalFormats,
+        locale,
+        timeZone
+    ]);
+    return translate;
+}
+//# sourceMappingURL=useTranslationsImpl.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTranslationsImpl.js","sourceRoot":"","sources":["../../../src/react/useTranslationsImpl.tsx"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAEtC,OAAO,oBAAoB,EAAE,EAC3B,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AAExD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAGzC,WAAqB,EAAE,SAAoB,EAAE,eAAuB;IACpE,MAAM,EACJ,wBAAwB,EACxB,OAAO,EAAE,aAAa,EACtB,kBAAkB,EAClB,MAAM,EACN,OAAO,EACP,QAAQ,EACT,GAAG,cAAc,EAAE,CAAC;IAErB,oDAAoD;IACpD,0CAA0C;IAC1C,WAAW,GAAG,WAAW,CAAC,eAAe,CAAa,CAAC;IACvD,SAAS,GAAG,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAc,CAAC;IAEtE,MAAM,wBAAwB,GAAG,MAAM,CAErC,EAAE,CAAC,CAAC;IAEN,MAAM,eAAe,GAAG,OAAO,CAC7B,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAC,CAAC,EACrE,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAClC,CAAC;IAEF,MAAM,SAAS,GAAG,OAAO,CACvB,GAAG,EAAE,CACH,oBAAoB,CAAC;QACnB,qBAAqB,EAAE,wBAAwB,CAAC,OAAO;QACvD,kBAAkB;QAClB,eAAe;QACf,wBAAwB;QACxB,SAAS;QACT,OAAO;QACP,OAAO,EAAE,aAAa;QACtB,MAAM;QACN,QAAQ;KACT,CAAC,EACJ;QACE,kBAAkB;QAClB,eAAe;QACf,wBAAwB;QACxB,SAAS;QACT,OAAO;QACP,aAAa;QACb,MAAM;QACN,QAAQ;KACT,CACF,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/use-intl.cjs.development.js

@@ -266,13 +266,13 @@ function getMessagesOrError(_ref) {
 
   try {
     if (!messages) {
-      throw new Error("development" !== "production" ? "No messages were configured on the provider." : undefined);
+      throw new Error("development" !== 'production' ? "No messages were configured on the provider." : undefined);
     }
 
     var retrievedMessages = namespace ? resolvePath(messages, namespace) : messages;
 
     if (!retrievedMessages) {
-      throw new Error("development" !== "production" ? "No messages for namespace `" + namespace + "` found." : undefined);
+      throw new Error("development" !== 'production' ? "No messages for namespace `" + namespace + "` found." : undefined);
     }
 
     return retrievedMessages;
@@ -366,7 +366,7 @@ function createBaseTranslator(_ref2) {
       prepareTranslationValues(_extends({}, defaultTranslationValues, values)));
 
       if (formattedMessage == null) {
-        throw new Error("development" !== "production" ? "Unable to format `" + key + "` in " + (namespace ? "namespace `" + namespace + "`" : 'messages') : undefined);
+        throw new Error("development" !== 'production' ? "Unable to format `" + key + "` in " + (namespace ? "namespace `" + namespace + "`" : 'messages') : undefined);
       } // Limit the function signature to return strings or React elements
 
 
@@ -427,13 +427,13 @@ function resolveNamespace(namespace, namespacePrefix) {
   return namespace === namespacePrefix ? undefined : namespace.slice((namespacePrefix + '.').length);
 }
 
-var _excluded$2 = ["getMessageFallback", "messages", "namespace", "onError"];
+var _excluded$3 = ["getMessageFallback", "messages", "namespace", "onError"];
 function createTranslatorImpl(_ref, namespacePrefix) {
   var getMessageFallback = _ref.getMessageFallback,
       messages = _ref.messages,
       namespace = _ref.namespace,
       onError = _ref.onError,
-      rest = _objectWithoutPropertiesLoose(_ref, _excluded$2);
+      rest = _objectWithoutPropertiesLoose(_ref, _excluded$3);
 
   // The `namespacePrefix` is part of the type system.
   // See the comment in the function invocation.
@@ -479,7 +479,7 @@ function createTranslatorImpl(_ref, namespacePrefix) {
   return base;
 }
 
-var _excluded$1 = ["onError", "getMessageFallback", "messages", "namespace"];
+var _excluded$2 = ["onError", "getMessageFallback", "messages", "namespace"];
 /**
  * Translates messages from the given namespace by using the ICU syntax.
  * See https://formatjs.io/docs/core-concepts/icu-syntax.
@@ -496,7 +496,7 @@ function createTranslator(_ref) {
       getMessageFallback = _ref$getMessageFallba === void 0 ? defaultGetMessageFallback : _ref$getMessageFallba,
       messages = _ref.messages,
       namespace = _ref.namespace,
-      rest = _objectWithoutPropertiesLoose(_ref, _excluded$1);
+      rest = _objectWithoutPropertiesLoose(_ref, _excluded$2);
 
   // We have to wrap the actual function so the type inference for the optional
   // namespace works correctly. See https://stackoverflow.com/a/71529575/343045
@@ -633,7 +633,7 @@ function createIntl(_ref) {
         if (globalNow) {
           now = globalNow;
         } else {
-          throw new Error("development" !== "production" ? "The `now` parameter wasn't provided to `formatRelativeTime` and there was no global fallback configured on the provider." : undefined);
+          throw new Error("development" !== 'production' ? "The `now` parameter wasn't provided to `formatRelativeTime` and there was no global fallback configured on the provider." : undefined);
         }
       }
 
@@ -661,6 +661,8 @@ function createIntl(_ref) {
   };
 }
 
+var IntlContext = /*#__PURE__*/React.createContext(undefined);
+
 function validateMessagesSegment(messages, invalidKeyLabels, parentPath) {
   Object.entries(messages).forEach(function (_ref) {
     var key = _ref[0],
@@ -689,33 +691,40 @@ function validateMessages(messages, onError) {
   }
 }
 
-var IntlContext = /*#__PURE__*/React.createContext(undefined);
+var _excluded$1 = ["getMessageFallback", "messages", "onError"];
+/**
+ * Enhances the incoming props with defaults.
+ */
 
-var _excluded = ["children", "onError", "getMessageFallback", "messages"];
-function IntlProvider(_ref) {
-  var children = _ref.children,
-      _ref$onError = _ref.onError,
-      onError = _ref$onError === void 0 ? defaultOnError : _ref$onError,
-      _ref$getMessageFallba = _ref.getMessageFallback,
-      getMessageFallback = _ref$getMessageFallba === void 0 ? defaultGetMessageFallback : _ref$getMessageFallba,
+function getIntlContextValue(_ref) {
+  var getMessageFallback = _ref.getMessageFallback,
       messages = _ref.messages,
-      contextValues = _objectWithoutPropertiesLoose(_ref, _excluded);
+      onError = _ref.onError,
+      rest = _objectWithoutPropertiesLoose(_ref, _excluded$1);
+
+  var finalOnError = onError || defaultOnError;
+  var finalGetMessageFallback = getMessageFallback || defaultGetMessageFallback;
 
   {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    React.useEffect(function () {
-      if (messages) {
-        validateMessages(messages, onError);
-      }
-    }, [messages, onError]);
+    if (messages) {
+      validateMessages(messages, finalOnError);
+    }
   }
 
+  return _extends({}, rest, {
+    messages: messages,
+    onError: finalOnError,
+    getMessageFallback: finalGetMessageFallback
+  });
+}
+
+var _excluded = ["children"];
+function IntlProvider(_ref) {
+  var children = _ref.children,
+      props = _objectWithoutPropertiesLoose(_ref, _excluded);
+
   return React__default["default"].createElement(IntlContext.Provider, {
-    value: _extends({}, contextValues, {
-      messages: messages,
-      onError: onError,
-      getMessageFallback: getMessageFallback
-    })
+    value: getIntlContextValue(props)
   }, children);
 }