@formatjs/intl 4.1.18 → 4.1.20

package/index.d.ts

@@ -44,54 +44,54 @@ type NumberFormatOptions = Omit<Intl.NumberFormatOptions, "signDisplay" | "useGr
 };
 //#endregion
 //#region packages/intl/error.d.ts
-declare enum IntlErrorCode {
+export declare enum IntlErrorCode {
   FORMAT_ERROR = "FORMAT_ERROR",
   UNSUPPORTED_FORMATTER = "UNSUPPORTED_FORMATTER",
   INVALID_CONFIG = "INVALID_CONFIG",
   MISSING_DATA = "MISSING_DATA",
   MISSING_TRANSLATION = "MISSING_TRANSLATION"
 }
-declare class IntlError<T extends IntlErrorCode = IntlErrorCode.FORMAT_ERROR> extends Error {
+export declare class IntlError<T extends IntlErrorCode = IntlErrorCode.FORMAT_ERROR> extends Error {
   readonly code: T;
   constructor(code: T, message: string, exception?: Error | unknown);
 }
-declare class UnsupportedFormatterError extends IntlError<IntlErrorCode.UNSUPPORTED_FORMATTER> {
+export declare class UnsupportedFormatterError extends IntlError<IntlErrorCode.UNSUPPORTED_FORMATTER> {
   constructor(message: string, exception?: Error | unknown);
 }
-declare class InvalidConfigError extends IntlError<IntlErrorCode.INVALID_CONFIG> {
+export declare class InvalidConfigError extends IntlError<IntlErrorCode.INVALID_CONFIG> {
   constructor(message: string, exception?: Error | unknown);
 }
-declare class MissingDataError extends IntlError<IntlErrorCode.MISSING_DATA> {
+export declare class MissingDataError extends IntlError<IntlErrorCode.MISSING_DATA> {
   constructor(message: string, exception?: Error | unknown);
 }
-declare class IntlFormatError extends IntlError<IntlErrorCode.FORMAT_ERROR> {
+export declare class IntlFormatError extends IntlError<IntlErrorCode.FORMAT_ERROR> {
   readonly descriptor?: MessageDescriptor;
   readonly locale: string;
   constructor(message: string, locale: string, exception?: Error | unknown);
 }
-declare class MessageFormatError extends IntlFormatError {
+export declare class MessageFormatError extends IntlFormatError {
   readonly descriptor?: MessageDescriptor;
   readonly locale: string;
   constructor(message: string, locale: string, descriptor?: MessageDescriptor, exception?: Error | unknown);
 }
-declare class MissingTranslationError extends IntlError<IntlErrorCode.MISSING_TRANSLATION> {
+export declare class MissingTranslationError extends IntlError<IntlErrorCode.MISSING_TRANSLATION> {
   readonly descriptor?: MessageDescriptor;
   constructor(descriptor: MessageDescriptor, locale: string);
 }
 //#endregion
 //#region packages/intl/utils.d.ts
-declare function filterProps<T extends Record<string, any>, K extends string>(props: T, allowlist: Array<K>, defaults?: Partial<T>): Pick<T, K>;
-declare const DEFAULT_INTL_CONFIG: Pick<ResolvedIntlConfig<any>, "fallbackOnEmptyString" | "formats" | "messages" | "timeZone" | "defaultLocale" | "defaultFormats" | "onError" | "onWarn">;
-declare function createIntlCache(): IntlCache;
+export declare function filterProps<T extends Record<string, any>, K extends string>(props: T, allowlist: Array<K>, defaults?: Partial<T>): Pick<T, K>;
+export declare const DEFAULT_INTL_CONFIG: Pick<ResolvedIntlConfig<any>, "fallbackOnEmptyString" | "formats" | "messages" | "timeZone" | "defaultLocale" | "defaultFormats" | "onError" | "onWarn">;
+export declare function createIntlCache(): IntlCache;
 /**
  * Create intl formatters and populate cache
  * @param cache explicit cache to prevent leaking memory
  */
-declare function createFormatters(cache?: IntlCache): Formatters;
-declare function getNamedFormat<T extends keyof CustomFormats>(formats: CustomFormats, type: T, name: string, onError: OnErrorFn): NumberFormatOptions | Intl.DateTimeFormatOptions | Intl.RelativeTimeFormatOptions | undefined;
+export declare function createFormatters(cache?: IntlCache): Formatters;
+export declare function getNamedFormat<T extends keyof CustomFormats>(formats: CustomFormats, type: T, name: string, onError: OnErrorFn): NumberFormatOptions | Intl.DateTimeFormatOptions | Intl.RelativeTimeFormatOptions | undefined;
 //#endregion
 //#region packages/intl/types.d.ts
-interface Part<T = string> {
+export interface Part<T = string> {
   type: "element" | "literal";
   value: T;
 }
@@ -108,14 +108,14 @@ type MessageIds = FormatjsIntl.Message extends {
 type Locale = FormatjsIntl.IntlConfig extends {
   locale: infer T;
 } ? T extends string ? T : string : string;
-type OnErrorFn = (err: MissingTranslationError | MessageFormatError | MissingDataError | InvalidConfigError | UnsupportedFormatterError | FormatError) => void;
-type OnWarnFn = (warning: string) => void;
+export type OnErrorFn = (err: MissingTranslationError | MessageFormatError | MissingDataError | InvalidConfigError | UnsupportedFormatterError | FormatError) => void;
+export type OnWarnFn = (warning: string) => void;
 /**
  * Config for intl object.
  * Generic type T is the type of potential rich text element. For example:
  * With React, T would be React.ReactNode
  */
-interface ResolvedIntlConfig<T = string> {
+export interface ResolvedIntlConfig<T = string> {
   locale: Locale;
   timeZone?: string;
   fallbackOnEmptyString?: boolean;
@@ -127,26 +127,26 @@ interface ResolvedIntlConfig<T = string> {
   onError: OnErrorFn;
   onWarn?: OnWarnFn;
 }
-interface CustomFormats extends Partial<Formats> {
+export interface CustomFormats extends Partial<Formats> {
   relative?: Record<string, Intl.RelativeTimeFormatOptions>;
   dateTimeRange?: Record<string, Intl.DateTimeFormatOptions>;
 }
-interface CustomFormatConfig<Source = string> {
+export interface CustomFormatConfig<Source = string> {
   format?: Source extends keyof FormatjsIntl.Formats ? FormatjsIntl.Formats[Source] : string;
 }
-type FormatDateTimeRangeOptions = Omit<Intl.DateTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"dateTimeRange">;
-type FormatDateOptions = Omit<Intl.DateTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"date">;
-type FormatTimeOptions = Omit<Intl.DateTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"time">;
-type FormatNumberOptions = Omit<NumberFormatOptions, "localeMatcher"> & CustomFormatConfig<"number">;
-type FormatRelativeTimeOptions = Omit<Intl.RelativeTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"time">;
-type FormatPluralOptions = Omit<Intl.PluralRulesOptions, "localeMatcher"> & CustomFormatConfig;
-type FormatListOptions = Omit<Intl.ListFormatOptions, "localeMatcher">;
-type FormatDisplayNameOptions = Omit<Intl.DisplayNamesOptions, "localeMatcher">;
+export type FormatDateTimeRangeOptions = Omit<Intl.DateTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"dateTimeRange">;
+export type FormatDateOptions = Omit<Intl.DateTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"date">;
+export type FormatTimeOptions = Omit<Intl.DateTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"time">;
+export type FormatNumberOptions = Omit<NumberFormatOptions, "localeMatcher"> & CustomFormatConfig<"number">;
+export type FormatRelativeTimeOptions = Omit<Intl.RelativeTimeFormatOptions, "localeMatcher"> & CustomFormatConfig<"time">;
+export type FormatPluralOptions = Omit<Intl.PluralRulesOptions, "localeMatcher"> & CustomFormatConfig;
+export type FormatListOptions = Omit<Intl.ListFormatOptions, "localeMatcher">;
+export type FormatDisplayNameOptions = Omit<Intl.DisplayNamesOptions, "localeMatcher">;
 /**
  * `TBase` is the type constraints of the rich text element in the formatted output.
  * For example, with React, `TBase` should be `React.ReactNode`.
  */
-interface IntlFormatters<TBase = unknown> {
+export interface IntlFormatters<TBase = unknown> {
   formatDateTimeRange(this: void, from: Parameters<Intl.DateTimeFormat["formatRange"]>[0] | string, to: Parameters<Intl.DateTimeFormat["formatRange"]>[1] | string, opts?: FormatDateTimeRangeOptions): string;
   formatDate(this: void, value: Parameters<Intl.DateTimeFormat["format"]>[0] | string, opts?: FormatDateOptions): string;
   formatTime(this: void, value: Parameters<Intl.DateTimeFormat["format"]>[0] | string, opts?: FormatTimeOptions): string;
@@ -165,7 +165,7 @@ interface IntlFormatters<TBase = unknown> {
   formatListToParts<T extends TBase>(this: void, values: Iterable<string | T>, opts?: FormatListOptions): Part[];
   formatDisplayName(this: void, value: Parameters<Intl.DisplayNames["of"]>[0], opts: FormatDisplayNameOptions): string | undefined;
 }
-interface Formatters {
+export interface Formatters {
   getDateTimeFormat(this: void, ...args: ConstructorParameters<typeof Intl.DateTimeFormat>): Intl.DateTimeFormat;
   getNumberFormat(this: void, locales?: string | string[], opts?: NumberFormatOptions): Intl.NumberFormat;
   getMessageFormat(this: void, ...args: ConstructorParameters<typeof IntlMessageFormat>): IntlMessageFormat;
@@ -174,10 +174,10 @@ interface Formatters {
   getListFormat(this: void, ...args: ConstructorParameters<typeof Intl.ListFormat>): Intl.ListFormat;
   getDisplayNames(this: void, ...args: ConstructorParameters<typeof Intl.DisplayNames>): Intl.DisplayNames;
 }
-interface IntlShape<T = string> extends ResolvedIntlConfig<T>, IntlFormatters<T> {
+export interface IntlShape<T = string> extends ResolvedIntlConfig<T>, IntlFormatters<T> {
   formatters: Formatters;
 }
-interface IntlCache {
+export interface IntlCache {
   dateTime: Record<string, Intl.DateTimeFormat>;
   number: Record<string, Intl.NumberFormat>;
   message: Record<string, IntlMessageFormat>;
@@ -186,12 +186,12 @@ interface IntlCache {
   list: Record<string, Intl.ListFormat>;
   displayNames: Record<string, Intl.DisplayNames>;
 }
-interface MessageDescriptor {
+export interface MessageDescriptor {
   id?: MessageIds;
   description?: string | object;
   defaultMessage?: string | MessageFormatElement[];
 }
-type IntlConfig<T = string> = Omit<ResolvedIntlConfig<T>, keyof typeof DEFAULT_INTL_CONFIG> & Partial<typeof DEFAULT_INTL_CONFIG>;
+export type IntlConfig<T = string> = Omit<ResolvedIntlConfig<T>, keyof typeof DEFAULT_INTL_CONFIG> & Partial<typeof DEFAULT_INTL_CONFIG>;
 //#endregion
 //#region packages/intl/message.d.ts
 type FormatMessageFn<T> = ({ locale, formats, messages, defaultLocale, defaultFormats, fallbackOnEmptyString, onError, timeZone, defaultRichTextElements }: {
@@ -205,28 +205,28 @@ type FormatMessageFn<T> = ({ locale, formats, messages, defaultLocale, defaultFo
   fallbackOnEmptyString?: boolean;
   onError: OnErrorFn;
 }, state: Formatters$1 & Pick<Formatters, "getMessageFormat">, messageDescriptor: MessageDescriptor, values?: Record<string, PrimitiveType | T | FormatXMLElementFn<T>>, opts?: Options) => T extends string ? string : Array<T | string> | string | T;
-declare const formatMessage: FormatMessageFn<any>;
+export declare const formatMessage: FormatMessageFn<any>;
 //#endregion
 //#region packages/intl/dateTime.d.ts
-declare function formatDate(config: {
+export declare function formatDate(config: {
   locale: string;
   timeZone?: string;
   formats: CustomFormats;
   onError: OnErrorFn;
 }, getDateTimeFormat: Formatters["getDateTimeFormat"], value: Parameters<IntlFormatters["formatDate"]>[0], options?: Parameters<IntlFormatters["formatDate"]>[1]): string;
-declare function formatTime(config: {
+export declare function formatTime(config: {
   locale: string;
   timeZone?: string;
   formats: CustomFormats;
   onError: OnErrorFn;
 }, getDateTimeFormat: Formatters["getDateTimeFormat"], value: Parameters<IntlFormatters["formatTime"]>[0], options?: Parameters<IntlFormatters["formatTime"]>[1]): string;
-declare function formatDateToParts(config: {
+export declare function formatDateToParts(config: {
   locale: string;
   timeZone?: string;
   formats: CustomFormats;
   onError: OnErrorFn;
 }, getDateTimeFormat: Formatters["getDateTimeFormat"], value: Parameters<IntlFormatters["formatDate"]>[0], options?: Parameters<IntlFormatters["formatDate"]>[1]): Intl.DateTimeFormatPart[];
-declare function formatTimeToParts(config: {
+export declare function formatTimeToParts(config: {
   locale: string;
   timeZone?: string;
   formats: CustomFormats;
@@ -234,37 +234,37 @@ declare function formatTimeToParts(config: {
 }, getDateTimeFormat: Formatters["getDateTimeFormat"], value: Parameters<IntlFormatters["formatTimeToParts"]>[0], options?: Parameters<IntlFormatters["formatTimeToParts"]>[1]): Intl.DateTimeFormatPart[];
 //#endregion
 //#region packages/intl/displayName.d.ts
-declare function formatDisplayName({ locale, onError }: {
+export declare function formatDisplayName({ locale, onError }: {
   locale: string;
   onError: OnErrorFn;
 }, getDisplayNames: Formatters["getDisplayNames"], value: Parameters<IntlFormatters["formatDisplayName"]>[0], options: Parameters<IntlFormatters["formatDisplayName"]>[1]): string | undefined;
 //#endregion
 //#region packages/intl/list.d.ts
-declare function formatList(opts: {
+export declare function formatList(opts: {
   locale: string;
   onError: OnErrorFn;
 }, getListFormat: Formatters["getListFormat"], values: Iterable<string>, options: Parameters<IntlFormatters["formatList"]>[1]): string;
 //#endregion
 //#region packages/intl/plural.d.ts
-declare function formatPlural({ locale, onError }: {
+export declare function formatPlural({ locale, onError }: {
   locale: string;
   onError: OnErrorFn;
 }, getPluralRules: Formatters["getPluralRules"], value: Parameters<IntlFormatters["formatPlural"]>[0], options?: Parameters<IntlFormatters["formatPlural"]>[1]): Intl.LDMLPluralRule;
 //#endregion
 //#region packages/intl/relativeTime.d.ts
-declare function formatRelativeTime(config: {
+export declare function formatRelativeTime(config: {
   locale: string;
   formats: CustomFormats;
   onError: OnErrorFn;
 }, getRelativeTimeFormat: Formatters["getRelativeTimeFormat"], value: Parameters<IntlFormatters["formatRelativeTime"]>[0], unit?: Parameters<IntlFormatters["formatRelativeTime"]>[1], options?: Parameters<IntlFormatters["formatRelativeTime"]>[2]): string;
 //#endregion
 //#region packages/intl/number.d.ts
-declare function formatNumber(config: {
+export declare function formatNumber(config: {
   locale: string;
   formats: CustomFormats;
   onError: OnErrorFn;
 }, getNumberFormat: Formatters["getNumberFormat"], value: Parameters<IntlFormatters["formatNumber"]>[0], options?: Parameters<IntlFormatters["formatNumber"]>[1]): string;
-declare function formatNumberToParts(config: {
+export declare function formatNumberToParts(config: {
   locale: string;
   formats: CustomFormats;
   onError: OnErrorFn;
@@ -279,11 +279,11 @@ interface CreateIntlFn<T = string, C extends IntlConfig<T> = IntlConfig<T>, S ex
  * @param config intl config
  * @param cache cache for formatter instances to prevent memory leak
  */
-declare function createIntl<T = string>(config: IntlConfig<T>, cache?: IntlCache): IntlShape<T>;
+export declare function createIntl<T = string>(config: IntlConfig<T>, cache?: IntlCache): IntlShape<T>;
 //#endregion
 //#region packages/intl/index.d.ts
-declare function defineMessages<K extends keyof any, T = MessageDescriptor, U extends Record<K, T> = Record<K, T>>(msgs: U): U;
-declare function defineMessage<T>(msg: T): T;
+export declare function defineMessages<K extends keyof any, T = MessageDescriptor, U extends Record<K, T> = Record<K, T>>(msgs: U): U;
+export declare function defineMessage<T>(msg: T): T;
 //#endregion
-export { type CreateIntlFn, CustomFormatConfig, CustomFormats, DEFAULT_INTL_CONFIG, FormatDateOptions, FormatDateTimeRangeOptions, FormatDisplayNameOptions, FormatListOptions, type FormatMessageFn, FormatNumberOptions, FormatPluralOptions, FormatRelativeTimeOptions, FormatTimeOptions, Formatters, IntlCache, IntlConfig, IntlError, IntlErrorCode, IntlFormatError, IntlFormatters, IntlShape, InvalidConfigError, MessageDescriptor, MessageFormatError, MissingDataError, MissingTranslationError, OnErrorFn, OnWarnFn, Part, ResolvedIntlConfig, UnsupportedFormatterError, createFormatters, createIntl, createIntlCache, defineMessage, defineMessages, filterProps, formatDate, formatDateToParts, formatDisplayName, formatList, formatMessage, formatNumber, formatNumberToParts, formatPlural, formatRelativeTime, formatTime, formatTimeToParts, getNamedFormat };
+export type { CreateIntlFn, FormatMessageFn };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formatjs/intl",
-  "version": "4.1.18",
+  "version": "4.1.20",
   "description": "Internationalize JS apps. This library provides an API to format dates, numbers, and strings, including pluralization and handling translations.",
   "keywords": [
     "format",
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "@formatjs/fast-memoize": "3.1.7",
-    "@formatjs/icu-messageformat-parser": "3.5.16",
-    "intl-messageformat": "11.2.13"
+    "@formatjs/icu-messageformat-parser": "3.5.17",
+    "intl-messageformat": "11.2.14"
   }
 }