use-intl 3.19.4 → 3.20.0

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

@@ -1,8 +1,8 @@
 import DateTimeFormatOptions from './DateTimeFormatOptions';
 import NumberFormatOptions from './NumberFormatOptions';
 type Formats = {
-    number: Record<string, NumberFormatOptions>;
-    dateTime: Record<string, DateTimeFormatOptions>;
-    list: Record<string, Intl.ListFormatOptions>;
+    number?: Record<string, NumberFormatOptions>;
+    dateTime?: Record<string, DateTimeFormatOptions>;
+    list?: Record<string, Intl.ListFormatOptions>;
 };
 export default Formats;

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

@@ -11,7 +11,7 @@ type IntlConfig<Messages = AbstractIntlMessages> = {
     locale: string;
     /** Global formats can be provided to achieve consistent
      * formatting across components. */
-    formats?: Partial<Formats>;
+    formats?: Formats;
     /** A time zone as defined in [the tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) which will be applied when formatting dates and times. If this is absent, the user time zone will be used. You can override this by supplying an explicit time zone to `formatDateTime`. */
     timeZone?: TimeZone;
     /** This callback will be invoked when an error is encountered during

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

@@ -8,4 +8,4 @@ import TimeZone from './TimeZone';
  * 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: Partial<Formats>, timeZone?: TimeZone): Partial<IntlFormats>;
+export default function convertFormatsToIntlMessageFormat(formats: Formats, timeZone?: TimeZone): Partial<IntlFormats>;

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

@@ -16,8 +16,8 @@ export type CreateBaseTranslatorProps<Messages> = InitializedIntlConfig & {
     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?: Partial<Formats>): string;
-    rich: (key: string, values?: RichTranslationValues, formats?: Partial<Formats>) => string | ReactElement | ReactNodeArray;
-    markup(key: Parameters<(key: string, values?: RichTranslationValues, formats?: Partial<Formats>) => string | ReactElement | ReactNodeArray>[0], values: MarkupTranslationValues, formats?: Parameters<(key: string, values?: RichTranslationValues, formats?: Partial<Formats>) => string | ReactElement | ReactNodeArray>[2]): string;
+    <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;
 };

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

@@ -10,7 +10,7 @@ type Props = {
     locale: string;
     timeZone?: TimeZone;
     onError?(error: IntlError): void;
-    formats?: Partial<Formats>;
+    formats?: Formats;
     now?: Date;
     /** @private */
     _formatters?: Formatters;
@@ -18,10 +18,10 @@ type Props = {
     _cache?: IntlCache;
 };
 export default function createFormatter({ _cache: cache, _formatters: formatters, formats, locale, now: globalNow, onError, timeZone: globalTimeZone }: Props): {
-    dateTime: (value: Date | number, formatOrOptions?: string | DateTimeFormatOptions) => string;
-    number: (value: number | bigint, formatOrOptions?: string | NumberFormatOptions) => string;
+    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?: string | Intl.ListFormatOptions) => Value extends string ? string : Iterable<ReactElement>;
-    dateTimeRange: (start: Date | number, end: Date | number, formatOrOptions?: string | DateTimeFormatOptions) => 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/createTranslator.d.ts

@@ -31,7 +31,7 @@ export default function createTranslator<NestedKey extends NamespaceKeys<IntlMes
         '!': IntlMessages;
     }, [
         NestedKey
-    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: TranslationValues, formats?: Partial<Formats>): string;
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: TranslationValues, formats?: Formats): string;
     rich<TargetKey extends MessageKeys<NestedValueOf<{
         '!': IntlMessages;
     }, [
@@ -40,7 +40,7 @@ export default function createTranslator<NestedKey extends NamespaceKeys<IntlMes
         '!': IntlMessages;
     }, [
         NestedKey
-    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Partial<Formats>): string | ReactElement | ReactNodeArray;
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Formats): string | ReactElement | ReactNodeArray;
     markup<TargetKey extends MessageKeys<NestedValueOf<{
         '!': IntlMessages;
     }, [
@@ -49,7 +49,7 @@ export default function createTranslator<NestedKey extends NamespaceKeys<IntlMes
         '!': IntlMessages;
     }, [
         NestedKey
-    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: MarkupTranslationValues, formats?: Partial<Formats>): string;
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: MarkupTranslationValues, formats?: Formats): string;
     raw<TargetKey extends MessageKeys<NestedValueOf<{
         '!': IntlMessages;
     }, [

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

@@ -9,8 +9,8 @@ export type CreateTranslatorImplProps<Messages> = Omit<InitializedIntlConfig, 'm
     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?: Partial<import("./Formats").default>): string;
-    rich: (key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: Partial<import("./Formats").default>) => string | import("react").ReactElement | import("react").ReactNodeArray;
-    markup(key: Parameters<(key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: Partial<import("./Formats").default>) => string | import("react").ReactElement | import("react").ReactNodeArray>[0], values: import("./TranslationValues").MarkupTranslationValues, formats?: Parameters<(key: string, values?: import("./TranslationValues").RichTranslationValues, formats?: Partial<import("./Formats").default>) => string | import("react").ReactElement | import("react").ReactNodeArray>[2]): 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;
 };

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

@@ -22,7 +22,7 @@ export default function useTranslations<NestedKey extends NamespaceKeys<IntlMess
         '!': IntlMessages;
     }, [
         NestedKey
-    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: TranslationValues, formats?: Partial<Formats>): string;
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: TranslationValues, formats?: Formats): string;
     rich<TargetKey extends MessageKeys<NestedValueOf<{
         '!': IntlMessages;
     }, [
@@ -31,7 +31,7 @@ export default function useTranslations<NestedKey extends NamespaceKeys<IntlMess
         '!': IntlMessages;
     }, [
         NestedKey
-    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Partial<Formats>): string | ReactElement | ReactNodeArray;
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: RichTranslationValues, formats?: Formats): string | ReactElement | ReactNodeArray;
     markup<TargetKey extends MessageKeys<NestedValueOf<{
         '!': IntlMessages;
     }, [
@@ -40,7 +40,7 @@ export default function useTranslations<NestedKey extends NamespaceKeys<IntlMess
         '!': IntlMessages;
     }, [
         NestedKey
-    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: MarkupTranslationValues, formats?: Partial<Formats>): string;
+    ] extends [never] ? '!' : `!.${NestedKey}`>>>>(key: TargetKey, values?: MarkupTranslationValues, formats?: Formats): string;
     raw<TargetKey extends MessageKeys<NestedValueOf<{
         '!': IntlMessages;
     }, [

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

@@ -1,8 +1,8 @@
 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?: Partial<import("../core").Formats>): string;
-    rich: (key: string, values?: import("../core").RichTranslationValues, formats?: Partial<import("../core").Formats>) => string | import("react").ReactElement | import("react").ReactNodeArray;
-    markup(key: Parameters<(key: string, values?: import("../core").RichTranslationValues, formats?: Partial<import("../core").Formats>) => string | import("react").ReactElement | import("react").ReactNodeArray>[0], values: import("../core").MarkupTranslationValues, formats?: Parameters<(key: string, values?: import("../core").RichTranslationValues, formats?: Partial<import("../core").Formats>) => string | import("react").ReactElement | import("react").ReactNodeArray>[2]): 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;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-intl",
-  "version": "3.19.4",
+  "version": "3.20.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "description": "Internationalization (i18n) for React",
@@ -69,5 +69,5 @@
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
-  "gitHead": "4c9c1307515618353a9669aafe25508306fe6fcd"
+  "gitHead": "5a50f56167b6a1200b2d14d6714a74641fb0c732"
 }