use-intl 0.0.0-canary-5bbd7ad56b530e283b07cff950de61d6af81f00c

package/dist/types/src/core/RelativeTimeFormatOptions.d.ts

@@ -0,0 +1,7 @@
+type RelativeTimeFormatOptions = {
+    now?: number | Date;
+    unit?: Intl.RelativeTimeFormatUnit;
+    numberingSystem?: string;
+    style?: Intl.RelativeTimeFormatStyle;
+};
+export default RelativeTimeFormatOptions;

package/dist/types/src/core/TimeZone.d.ts

@@ -0,0 +1,2 @@
+type TimeZone = 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Addis_Ababa' | 'Africa/Algiers' | 'Africa/Asmara' | 'Africa/Bamako' | 'Africa/Bangui' | 'Africa/Banjul' | 'Africa/Bissau' | 'Africa/Blantyre' | 'Africa/Brazzaville' | 'Africa/Bujumbura' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/Conakry' | 'Africa/Dakar' | 'Africa/Dar_es_Salaam' | 'Africa/Djibouti' | 'Africa/Douala' | 'Africa/El_Aaiun' | 'Africa/Freetown' | 'Africa/Gaborone' | 'Africa/Harare' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Kampala' | 'Africa/Khartoum' | 'Africa/Kigali' | 'Africa/Kinshasa' | 'Africa/Lagos' | 'Africa/Libreville' | 'Africa/Lome' | 'Africa/Luanda' | 'Africa/Lubumbashi' | 'Africa/Lusaka' | 'Africa/Malabo' | 'Africa/Maputo' | 'Africa/Maseru' | 'Africa/Mbabane' | 'Africa/Mogadishu' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Niamey' | 'Africa/Nouakchott' | 'Africa/Ouagadougou' | 'Africa/Porto-Novo' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Anguilla' | 'America/Antigua' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Aruba' | 'America/Asuncion' | 'America/Atikokan' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Blanc-Sablon' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Cayman' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Creston' | 'America/Cuiaba' | 'America/Curacao' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Dominica' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Godthab' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Grenada' | 'America/Guadeloupe' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/Kralendijk' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Lower_Princes' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Marigot' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/Montserrat' | 'America/Nassau' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Port_of_Spain' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Barthelemy' | 'America/St_Johns' | 'America/St_Kitts' | 'America/St_Lucia' | 'America/St_Thomas' | 'America/St_Vincent' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Tortola' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/DumontDUrville' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Syowa' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Arctic/Longyearbyen' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Phnom_Penh' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/St_Helena' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Currie' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Bratislava' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Busingen' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Guernsey' | 'Europe/Helsinki' | 'Europe/Isle_of_Man' | 'Europe/Istanbul' | 'Europe/Jersey' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/Ljubljana' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Mariehamn' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Podgorica' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/San_Marino' | 'Europe/Sarajevo' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Skopje' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vaduz' | 'Europe/Vatican' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zagreb' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'Indian/Antananarivo' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Comoro' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Mayotte' | 'Indian/Reunion' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'UTC' | 'W-SU' | 'WET' | 'Zulu' | (string & {});
+export default TimeZone;

package/dist/types/src/core/TranslationValues.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+export type TranslationValue = string | number | boolean | Date | null | undefined;
+type TranslationValues = Record<string, TranslationValue>;
+export type RichTranslationValues = Record<string, TranslationValue | ((chunks: ReactNode) => ReactNode)>;
+export type MarkupTranslationValues = Record<string, TranslationValue | ((chunks: string) => string)>;
+export default TranslationValues;

package/dist/types/src/core/convertFormatsToIntlMessageFormat.d.ts

@@ -0,0 +1,11 @@
+import { Formats as IntlFormats } from 'intl-messageformat';
+import Formats from './Formats';
+import TimeZone from './TimeZone';
+/**
+ * `intl-messageformat` uses separate keys for `date` and `time`, but there's
+ * only one native API: `Intl.DateTimeFormat`. Additionally you might want to
+ * include both a time and a date in a value, therefore the separation doesn't
+ * seem so useful. We offer a single `dateTime` namespace instead, but we have
+ * to convert the format before `intl-messageformat` can be used.
+ */
+export default function convertFormatsToIntlMessageFormat(formats: Formats, timeZone?: TimeZone): Partial<IntlFormats>;

package/dist/types/src/core/createBaseTranslator.d.ts

@@ -0,0 +1,24 @@
+import { ReactElement, ReactNodeArray } from 'react';
+import AbstractIntlMessages from './AbstractIntlMessages';
+import Formats from './Formats';
+import { InitializedIntlConfig } from './IntlConfig';
+import IntlError from './IntlError';
+import TranslationValues, { MarkupTranslationValues, RichTranslationValues } from './TranslationValues';
+import { Formatters, IntlCache } from './formatters';
+import MessageKeys from './utils/MessageKeys';
+import NestedKeyOf from './utils/NestedKeyOf';
+import NestedValueOf from './utils/NestedValueOf';
+export type CreateBaseTranslatorProps<Messages> = InitializedIntlConfig & {
+    cache: IntlCache;
+    formatters: Formatters;
+    defaultTranslationValues?: RichTranslationValues;
+    namespace?: string;
+    messagesOrError: Messages | IntlError;
+};
+export default function createBaseTranslator<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>(config: Omit<CreateBaseTranslatorProps<Messages>, 'messagesOrError'>): {
+    <TargetKey extends MessageKeys<NestedValueOf<Messages, NestedKey>, NestedKeyOf<NestedValueOf<Messages, NestedKey>>>>(key: TargetKey, values?: TranslationValues, formats?: Formats): string;
+    rich: (key: string, values?: RichTranslationValues, formats?: Formats) => string | ReactElement | ReactNodeArray;
+    markup(key: Parameters<(key: string, values?: RichTranslationValues, formats?: Formats) => string | ReactElement | ReactNodeArray>[0], values: MarkupTranslationValues, formats?: Parameters<(key: string, values?: RichTranslationValues, formats?: Formats) => string | ReactElement | ReactNodeArray>[2]): string;
+    raw(key: string): any;
+    has(key: Parameters<(key: string, values?: RichTranslationValues, formats?: Formats) => string | ReactElement | ReactNodeArray>[0]): boolean;
+};

package/dist/types/src/core/createFormatter.d.ts

@@ -0,0 +1,27 @@
+import { ReactElement } from 'react';
+import DateTimeFormatOptions from './DateTimeFormatOptions';
+import Formats from './Formats';
+import IntlError from './IntlError';
+import NumberFormatOptions from './NumberFormatOptions';
+import RelativeTimeFormatOptions from './RelativeTimeFormatOptions';
+import TimeZone from './TimeZone';
+import { Formatters, IntlCache } from './formatters';
+type Props = {
+    locale: string;
+    timeZone?: TimeZone;
+    onError?(error: IntlError): void;
+    formats?: Formats;
+    now?: Date;
+    /** @private */
+    _formatters?: Formatters;
+    /** @private */
+    _cache?: IntlCache;
+};
+export default function createFormatter({ _cache: cache, _formatters: formatters, formats, locale, now: globalNow, onError, timeZone: globalTimeZone }: Props): {
+    dateTime: (value: Date | number, formatOrOptions?: Extract<keyof IntlFormats["dateTime"], string> | DateTimeFormatOptions) => string;
+    number: (value: number | bigint, formatOrOptions?: Extract<keyof IntlFormats["number"], string> | NumberFormatOptions) => string;
+    relativeTime: (date: number | Date, nowOrOptions?: RelativeTimeFormatOptions["now"] | RelativeTimeFormatOptions) => string;
+    list: <Value extends string | ReactElement<any, string | import("react").JSXElementConstructor<any>>>(value: Iterable<Value>, formatOrOptions?: Extract<keyof IntlFormats["list"], string> | Intl.ListFormatOptions) => Value extends string ? string : Iterable<ReactElement>;
+    dateTimeRange: (start: Date | number, end: Date | number, formatOrOptions?: Extract<keyof IntlFormats["dateTime"], string> | DateTimeFormatOptions) => string;
+};
+export {};

package/dist/types/src/core/createFormatter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/core/createTranslator.d.ts

@@ -0,0 +1,71 @@
+import { ReactElement, ReactNodeArray } from 'react';
+import Formats from './Formats';
+import IntlConfig from './IntlConfig';
+import TranslationValues, { MarkupTranslationValues, RichTranslationValues } from './TranslationValues';
+import { Formatters, IntlCache } from './formatters';
+import MessageKeys from './utils/MessageKeys';
+import NamespaceKeys from './utils/NamespaceKeys';
+import NestedKeyOf from './utils/NestedKeyOf';
+import NestedValueOf from './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 createTranslator<NestedKey extends NamespaceKeys<IntlMessages, NestedKeyOf<IntlMessages>> = never>({ _cache, _formatters, getMessageFallback, messages, namespace, onError, ...rest }: Omit<IntlConfig<IntlMessages>, 'defaultTranslationValues' | 'messages'> & {
+    messages?: IntlConfig<IntlMessages>['messages'];
+    namespace?: NestedKey;
+    /** @private */
+    _formatters?: Formatters;
+    /** @private */
+    _cache?: IntlCache;
+}): {
+    <TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: TranslationValues, formats?: Formats): string;
+    rich<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Formats): string | ReactElement | ReactNodeArray;
+    markup<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: MarkupTranslationValues, formats?: Formats): string;
+    raw<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey): any;
+    has<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey): boolean;
+};

package/dist/types/src/core/createTranslator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/core/createTranslatorImpl.d.ts

@@ -0,0 +1,17 @@
+import AbstractIntlMessages from './AbstractIntlMessages';
+import { InitializedIntlConfig } from './IntlConfig';
+import { Formatters, IntlCache } from './formatters';
+import NestedKeyOf from './utils/NestedKeyOf';
+export type CreateTranslatorImplProps<Messages> = Omit<InitializedIntlConfig, 'messages'> & {
+    namespace: string;
+    messages: Messages;
+    formatters: Formatters;
+    cache: IntlCache;
+};
+export default function createTranslatorImpl<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>({ messages, namespace, ...rest }: CreateTranslatorImplProps<Messages>, namespacePrefix: string): {
+    <TargetKey extends import(".").MessageKeys<import(".").NestedValueOf<Messages, NestedKey>, NestedKeyOf<import(".").NestedValueOf<Messages, NestedKey>>>>(key: TargetKey, values?: import("./TranslationValues").default, formats?: import("./Formats").default): string;
+    rich: (key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: import("./Formats").default) => string | import("react").ReactElement | import("react").ReactNodeArray;
+    markup(key: Parameters<(key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: import("./Formats").default) => string | import("react").ReactElement | import("react").ReactNodeArray>[0], values: import("./TranslationValues").MarkupTranslationValues, formats?: Parameters<(key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: import("./Formats").default) => string | import("react").ReactElement | import("react").ReactNodeArray>[2]): string;
+    raw(key: string): any;
+    has(key: Parameters<(key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: import("./Formats").default) => string | import("react").ReactElement | import("react").ReactNodeArray>[0]): boolean;
+};

package/dist/types/src/core/defaults.d.ts

@@ -0,0 +1,11 @@
+import IntlError from './IntlError';
+/**
+ * Contains defaults that are used for all entry points into the core.
+ * See also `InitializedIntlConfiguration`.
+ */
+export declare function defaultGetMessageFallback(props: {
+    error: IntlError;
+    key: string;
+    namespace?: string;
+}): string;
+export declare function defaultOnError(error: IntlError): void;

package/dist/types/src/core/formatters.d.ts

@@ -0,0 +1,25 @@
+import type IntlMessageFormat from 'intl-messageformat';
+export type IntlCache = {
+    dateTime: Record<string, Intl.DateTimeFormat>;
+    number: Record<string, Intl.NumberFormat>;
+    message: Record<string, IntlMessageFormat>;
+    relativeTime: Record<string, Intl.RelativeTimeFormat>;
+    pluralRules: Record<string, Intl.PluralRules>;
+    list: Record<string, Intl.ListFormat>;
+    displayNames: Record<string, Intl.DisplayNames>;
+};
+export declare function createCache(): IntlCache;
+export declare function memoFn<Fn extends (...args: Array<any>) => any>(fn: Fn, cache: Record<string, ReturnType<Fn> | undefined>): Fn;
+export type IntlFormatters = {
+    getDateTimeFormat(...args: ConstructorParameters<typeof Intl.DateTimeFormat>): Intl.DateTimeFormat;
+    getNumberFormat(...args: ConstructorParameters<typeof Intl.NumberFormat>): Intl.NumberFormat;
+    getPluralRules(...args: ConstructorParameters<typeof Intl.PluralRules>): Intl.PluralRules;
+    getRelativeTimeFormat(...args: ConstructorParameters<typeof Intl.RelativeTimeFormat>): Intl.RelativeTimeFormat;
+    getListFormat(...args: ConstructorParameters<typeof Intl.ListFormat>): Intl.ListFormat;
+    getDisplayNames(...args: ConstructorParameters<typeof Intl.DisplayNames>): Intl.DisplayNames;
+};
+export declare function createIntlFormatters(cache: IntlCache): IntlFormatters;
+export type MessageFormatter = (...args: ConstructorParameters<typeof IntlMessageFormat>) => IntlMessageFormat;
+export type Formatters = IntlFormatters & {
+    getMessageFormat?: MessageFormatter;
+};

package/dist/types/src/core/index.d.ts

@@ -0,0 +1,16 @@
+export type { default as AbstractIntlMessages } from './AbstractIntlMessages';
+export type { default as TranslationValues, RichTranslationValues, MarkupTranslationValues } from './TranslationValues';
+export type { default as Formats } from './Formats';
+export type { default as IntlConfig } from './IntlConfig';
+export type { default as DateTimeFormatOptions } from './DateTimeFormatOptions';
+export type { default as NumberFormatOptions } from './NumberFormatOptions';
+export { default as IntlError, IntlErrorCode } from './IntlError';
+export { default as createTranslator } from './createTranslator';
+export { default as createFormatter } from './createFormatter';
+export { default as initializeConfig } from './initializeConfig';
+export type { default as MessageKeys } from './utils/MessageKeys';
+export type { default as NamespaceKeys } from './utils/NamespaceKeys';
+export type { default as NestedKeyOf } from './utils/NestedKeyOf';
+export type { default as NestedValueOf } from './utils/NestedValueOf';
+export { createIntlFormatters as _createIntlFormatters } from './formatters';
+export { createCache as _createCache } from './formatters';

package/dist/types/src/core/initializeConfig.d.ts

@@ -0,0 +1,13 @@
+import IntlConfig from './IntlConfig';
+/**
+ * Enhances the incoming props with defaults.
+ */
+export default function initializeConfig<Props extends IntlConfig>({ getMessageFallback, messages, onError, ...rest }: Props): Omit<Props, "onError" | "getMessageFallback" | "messages"> & {
+    messages: import("./AbstractIntlMessages").default | undefined;
+    onError: (error: import("./IntlError").default) => void;
+    getMessageFallback: (info: {
+        error: import("./IntlError").default;
+        key: string;
+        namespace?: string;
+    }) => string;
+};

package/dist/types/src/core/joinPath.d.ts

@@ -0,0 +1 @@
+export default function joinPath(...parts: Array<string | undefined>): string;

package/dist/types/src/core/resolveNamespace.d.ts

@@ -0,0 +1,5 @@
+/**
+ * For the strictly typed messages to work we have to wrap the namespace into
+ * a mandatory prefix. See https://stackoverflow.com/a/71529575/343045
+ */
+export default function resolveNamespace(namespace: string, namespacePrefix: string): string | undefined;

package/dist/types/src/core/utils/MessageKeys.d.ts

@@ -0,0 +1,5 @@
+import NestedValueOf from './NestedValueOf';
+type MessageKeys<ObjectType, Keys extends string> = {
+    [Property in Keys]: NestedValueOf<ObjectType, Property> extends string ? Property : never;
+}[Keys];
+export default MessageKeys;

package/dist/types/src/core/utils/NamespaceKeys.d.ts

@@ -0,0 +1,5 @@
+import NestedValueOf from './NestedValueOf';
+type NamespaceKeys<ObjectType, Keys extends string> = {
+    [Property in Keys]: NestedValueOf<ObjectType, Property> extends string ? never : Property;
+}[Keys];
+export default NamespaceKeys;

package/dist/types/src/core/utils/NestedKeyOf.d.ts

@@ -0,0 +1,4 @@
+type NestedKeyOf<ObjectType> = ObjectType extends object ? {
+    [Key in keyof ObjectType]: `${Key & string}` | `${Key & string}.${NestedKeyOf<ObjectType[Key]>}`;
+}[keyof ObjectType] : never;
+export default NestedKeyOf;

package/dist/types/src/core/utils/NestedValueOf.d.ts

@@ -0,0 +1,2 @@
+type NestedValueOf<ObjectType, Property extends string> = Property extends `${infer Key}.${infer Rest}` ? Key extends keyof ObjectType ? NestedValueOf<ObjectType[Key], Rest> : never : Property extends keyof ObjectType ? ObjectType[Property] : never;
+export default NestedValueOf;

package/dist/types/src/core/validateMessages.d.ts

@@ -0,0 +1,3 @@
+import AbstractIntlMessages from './AbstractIntlMessages';
+import IntlError from './IntlError';
+export default function validateMessages(messages: AbstractIntlMessages, onError: (error: IntlError) => void): void;

package/dist/types/src/core.d.ts

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

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

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

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

@@ -0,0 +1,8 @@
+import type { InitializedIntlConfig } from '../core/IntlConfig';
+import type { Formatters, IntlCache } from '../core/formatters';
+export type IntlContextValue = InitializedIntlConfig & {
+    formatters: Formatters;
+    cache: IntlCache;
+};
+declare const IntlContext: import("react").Context<IntlContextValue | undefined>;
+export default IntlContext;

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

@@ -0,0 +1,7 @@
+import React, { ReactNode } from 'react';
+import IntlConfig from '../core/IntlConfig';
+type Props = IntlConfig & {
+    children: ReactNode;
+};
+export default function IntlProvider({ children, defaultTranslationValues, formats, getMessageFallback, locale, messages, now, onError, timeZone }: Props): React.JSX.Element;
+export {};

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

@@ -0,0 +1 @@
+export {};

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

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

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

@@ -0,0 +1 @@
+export {};

package/dist/types/src/react/useFormatter.d.ts

@@ -0,0 +1,2 @@
+import createFormatter from '../core/createFormatter';
+export default function useFormatter(): ReturnType<typeof createFormatter>;

package/dist/types/src/react/useFormatter.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+import { IntlContextValue } from './IntlContext';
+export default function useIntlContext(): IntlContextValue;

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

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

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

@@ -0,0 +1 @@
+export {};

package/dist/types/src/react/useMessages.d.ts

@@ -0,0 +1,2 @@
+import { AbstractIntlMessages } from '../core';
+export default function useMessages(): AbstractIntlMessages;

package/dist/types/src/react/useMessages.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,23 @@
+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/types/src/react/useNow.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export default function useTimeZone(): import("../core/TimeZone").default | undefined;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,62 @@
+import { ReactElement, ReactNodeArray } from 'react';
+import Formats from '../core/Formats';
+import TranslationValues, { MarkupTranslationValues, 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?: Formats): string;
+    rich<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Formats): string | ReactElement | ReactNodeArray;
+    markup<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: MarkupTranslationValues, formats?: Formats): string;
+    raw<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey): any;
+    has<TargetKey extends MessageKeys<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>, NestedKeyOf<NestedValueOf<{
+        '!': IntlMessages;
+    }, [
+        NestedKey
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey): boolean;
+};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,9 @@
+import AbstractIntlMessages from '../core/AbstractIntlMessages';
+import NestedKeyOf from '../core/utils/NestedKeyOf';
+export default function useTranslationsImpl<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>(allMessagesPrefixed: Messages, namespacePrefixed: NestedKey, namespacePrefix: string): {
+    <TargetKey extends unknown>(key: TargetKey, values?: import("../core").TranslationValues, formats?: import("../core").Formats): string;
+    rich: (key: string, values?: import("../core").RichTranslationValues, formats?: import("../core").Formats) => string | import("react").ReactElement | import("react").ReactNodeArray;
+    markup(key: Parameters<(key: string, values?: import("../core").RichTranslationValues, formats?: import("../core").Formats) => string | import("react").ReactElement | import("react").ReactNodeArray>[0], values: import("../core").MarkupTranslationValues, formats?: Parameters<(key: string, values?: import("../core").RichTranslationValues, formats?: import("../core").Formats) => string | import("react").ReactElement | import("react").ReactNodeArray>[2]): string;
+    raw(key: string): any;
+    has(key: Parameters<(key: string, values?: import("../core").RichTranslationValues, formats?: import("../core").Formats) => string | import("react").ReactElement | import("react").ReactNodeArray>[0]): boolean;
+};

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

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

package/dist/types/test/setup.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "use-intl",
+  "version": "0.0.0-canary-5bbd7ad56b530e283b07cff950de61d6af81f00c",
+  "sideEffects": false,
+  "author": "Jan Amann <jan@amann.work>",
+  "description": "Internationalization (i18n) for React",
+  "license": "MIT",
+  "homepage": "https://next-intl-docs.vercel.app/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/amannn/next-intl/tree/main/packages/use-intl"
+  },
+  "scripts": {
+    "build": "rm -rf dist && rollup -c",
+    "test": "TZ=Europe/Berlin vitest",
+    "lint": "pnpm run lint:source && pnpm run lint:package",
+    "lint:source": "eslint src test && tsc --noEmit",
+    "lint:package": "publint && attw --pack",
+    "prepublishOnly": "turbo build",
+    "size": "size-limit"
+  },
+  "main": "./dist/index.js",
+  "module": "dist/esm/index.js",
+  "typings": "./dist/types/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./core": {
+      "types": "./core.d.ts",
+      "default": "./dist/core.js"
+    },
+    "./react": {
+      "types": "./react.d.ts",
+      "default": "./dist/react.js"
+    },
+    "./_useLocale": {
+      "types": "./_useLocale.d.ts",
+      "default": "./dist/_useLocale.js"
+    },
+    "./_IntlProvider": {
+      "types": "./_IntlProvider.d.ts",
+      "default": "./dist/_IntlProvider.js"
+    }
+  },
+  "files": [
+    "dist",
+    "core.d.ts",
+    "react.d.ts",
+    "_useLocale.d.ts",
+    "_IntlProvider.d.ts"
+  ],
+  "keywords": [
+    "react",
+    "intl",
+    "i18n",
+    "internationalization",
+    "localization",
+    "translate",
+    "translation",
+    "format",
+    "formatting"
+  ],
+  "dependencies": {
+    "@formatjs/fast-memoize": "^2.2.0",
+    "intl-messageformat": "^10.5.14"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
+  },
+  "gitHead": "dcb31a81d57ffc42072cf150c2d4b808a679a00c"
+}

package/react.d.ts

@@ -0,0 +1 @@
+export * from './dist/types/src/react';