@discord/intl 0.5.0 → 0.5.2

package/dist/format-config.d.ts

@@ -0,0 +1,17 @@
+export interface FormatConfig {
+    number: {
+        [name: string]: Intl.NumberFormatOptions;
+    };
+    time: {
+        [name: string]: Intl.DateTimeFormatOptions;
+    };
+    date: {
+        [name: string]: Intl.DateTimeFormatOptions;
+    };
+}
+/**
+ * Default formatting configuration options for common date, time, and number formats. This is
+ * taken almost directly from FormatJS's defaults here, for the sake of compatibility.
+ * https://github.com/formatjs/formatjs/blob/c30975bfbe2db7eb62f4dbe6c8ad6ca5e786dcb3/packages/intl-messageformat/src/core.ts#L229-L296
+ */
+export declare const DEFAULT_FORMAT_CONFIG: FormatConfig;

package/dist/format-config.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_FORMAT_CONFIG = void 0;
+/**
+ * Default formatting configuration options for common date, time, and number formats. This is
+ * taken almost directly from FormatJS's defaults here, for the sake of compatibility.
+ * https://github.com/formatjs/formatjs/blob/c30975bfbe2db7eb62f4dbe6c8ad6ca5e786dcb3/packages/intl-messageformat/src/core.ts#L229-L296
+ */
+exports.DEFAULT_FORMAT_CONFIG = {
+    number: {
+        integer: { maximumFractionDigits: 0 },
+        currency: { style: 'currency' },
+        percent: { style: 'percent' },
+    },
+    date: {
+        short: {
+            month: 'numeric',
+            day: 'numeric',
+            year: '2-digit',
+        },
+        medium: {
+            month: 'short',
+            day: 'numeric',
+            year: 'numeric',
+        },
+        long: {
+            month: 'long',
+            day: 'numeric',
+            year: 'numeric',
+        },
+        full: {
+            weekday: 'long',
+            month: 'long',
+            day: 'numeric',
+            year: 'numeric',
+        },
+    },
+    time: {
+        short: {
+            hour: 'numeric',
+            minute: 'numeric',
+        },
+        medium: {
+            hour: 'numeric',
+            minute: 'numeric',
+            second: 'numeric',
+        },
+        long: {
+            hour: 'numeric',
+            minute: 'numeric',
+            second: 'numeric',
+            timeZoneName: 'short',
+        },
+        full: {
+            hour: 'numeric',
+            minute: 'numeric',
+            second: 'numeric',
+            timeZoneName: 'short',
+        },
+    },
+};

package/dist/format.d.ts

@@ -17,8 +17,9 @@
  *   parameter, important to have React treat the resulting elements nicely.
  */
 import { FormatJsNode } from './keyless-json';
-import { Formats, Formatters } from 'intl-messageformat';
-import { RichTextTagNames } from './types';
+import { Formatters } from 'intl-messageformat';
+import type { FormatConfig } from './format-config';
+import type { RichTextTagNames } from './types';
 export declare abstract class FormatBuilder<Result> {
     abstract pushRichTextTag(tag: RichTextTagNames, children: Result[]): void;
     abstract pushLiteralText(text: string): void;
@@ -26,5 +27,5 @@ export declare abstract class FormatBuilder<Result> {
     abstract finish(): Result[];
 }
 export type FormatBuilderConstructor<Result> = new () => FormatBuilder<Result>;
-export declare function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>(builder: Builder, nodes: FormatJsNode[], locales: string | string[], formatters: Formatters, formats: Formats, values?: Record<string, string | object>, currentPluralValue?: number, originalMessage?: string): void;
-export declare function bindFormatValues<Result>(Builder: FormatBuilderConstructor<Result>, nodes: FormatJsNode[], locales: string | string[], formatters: Formatters, formats: Formats, values?: Record<string, string | object>, currentPluralValue?: number): Result[];
+export declare function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>(builder: Builder, nodes: FormatJsNode[], locales: string | string[], formatters: Formatters, formatConfig: FormatConfig, values?: Record<string, string | object>, currentPluralValue?: number, originalMessage?: string): void;
+export declare function bindFormatValues<Result>(Builder: FormatBuilderConstructor<Result>, nodes: FormatJsNode[], locales: string | string[], formatters: Formatters, formatConfig: FormatConfig, values?: Record<string, string | object>, currentPluralValue?: number): Result[];

package/dist/format.js

@@ -32,9 +32,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormatBuilder = void 0;
 exports.bindFormatValuesWithBuilder = bindFormatValuesWithBuilder;
 exports.bindFormatValues = bindFormatValues;
+var icu_skeleton_parser_1 = require("@formatjs/icu-skeleton-parser");
 var keyless_json_1 = require("./keyless-json");
 var intl_messageformat_1 = require("intl-messageformat");
-var icu_skeleton_parser_1 = require("@formatjs/icu-skeleton-parser");
 /**
  * Returns true if the tag name should be considered a rich text tag that
  * applies formatting to a message, rather than being a user-supplied value.
@@ -48,7 +48,7 @@ var FormatBuilder = /** @class */ (function () {
     return FormatBuilder;
 }());
 exports.FormatBuilder = FormatBuilder;
-function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, formats, values, currentPluralValue, originalMessage) {
+function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, formatConfig, values, currentPluralValue, originalMessage) {
     var e_1, _a;
     var _b, _c;
     if (values === void 0) { values = {}; }
@@ -97,11 +97,11 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
             case keyless_json_1.FormatJsNodeType.Date: {
                 // Distinct from FormatJS: We don't currently parse the skeleton ahead of time in the AST,
                 // so this manages parsing the skeleton as well before passing it onto the date formatter.
-                var style = node.style in formats.date
-                    ? formats.date[node.style]
+                var style = node.style in formatConfig.date
+                    ? formatConfig.date[node.style]
                     : node.style != null
                         ? (0, icu_skeleton_parser_1.parseDateTimeSkeleton)(node.style)
-                        : undefined;
+                        : formatConfig.time.medium;
                 // @ts-expect-error Cast string values to dates properly.
                 builder.pushLiteralText(formatters.getDateTimeFormat(locales, style).format(value));
                 break;
@@ -109,8 +109,8 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
             case keyless_json_1.FormatJsNodeType.Time: {
                 // Distinct from FormatJS: We don't currently parse the skeleton ahead of time in the AST,
                 // so this manages parsing the skeleton as well before passing it onto the date formatter.
-                var style = node.style in formats.time
-                    ? formats.time[node.style]
+                var style = node.style in formatConfig.time
+                    ? formatConfig.time[node.style]
                     : node.style != null
                         ? (0, icu_skeleton_parser_1.parseDateTimeSkeleton)(node.style)
                         : undefined; // TODO: parseSkeleton();
@@ -122,8 +122,8 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
             case keyless_json_1.FormatJsNodeType.Number: {
                 // Distinct from FormatJS: We don't currently parse the skeleton ahead of time in the AST,
                 // so this manages parsing the skeleton as well before passing it onto the date formatter.
-                var style = node.style in formats.number
-                    ? formats.number[node.style]
+                var style = node.style in formatConfig.number
+                    ? formatConfig.number[node.style]
                     : node.style != null
                         ? (0, icu_skeleton_parser_1.parseNumberSkeleton)((0, icu_skeleton_parser_1.parseNumberSkeletonFromString)(node.style))
                         : undefined;
@@ -135,7 +135,7 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
             }
             case keyless_json_1.FormatJsNodeType.Tag: {
                 var children = node.children;
-                var appliedChildren = bindFormatValues(builder.constructor, children, locales, formatters, formats, values, currentPluralValue);
+                var appliedChildren = bindFormatValues(builder.constructor, children, locales, formatters, formatConfig, values, currentPluralValue);
                 if (isRichTextTag(variableName)) {
                     builder.pushRichTextTag(variableName, appliedChildren);
                 }
@@ -171,7 +171,7 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
                 if (option == null) {
                     throw "".concat(node.value, " is not a known option for select value ").concat(variableName, ". Valid options are ").concat(Object.keys(node.options).join(', '));
                 }
-                bindFormatValuesWithBuilder(builder, option.value, locales, formatters, formats, values);
+                bindFormatValuesWithBuilder(builder, option.value, locales, formatters, formatConfig, values);
                 break;
             }
             case keyless_json_1.FormatJsNodeType.Plural: {
@@ -189,7 +189,7 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
                 if (option == null) {
                     throw "".concat(node.value, " is not a known option for plural value ").concat(variableName, ". Valid options are ").concat(Object.keys(node.options).join(', '));
                 }
-                bindFormatValuesWithBuilder(builder, option.value, locales, formatters, formats, values, 
+                bindFormatValuesWithBuilder(builder, option.value, locales, formatters, formatConfig, values, 
                 // @ts-expect-error assert this `as number` properly.
                 value - ((_c = node.offset) !== null && _c !== void 0 ? _c : 0));
                 break;
@@ -210,9 +210,9 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
         finally { if (e_1) throw e_1.error; }
     }
 }
-function bindFormatValues(Builder, nodes, locales, formatters, formats, values, currentPluralValue) {
+function bindFormatValues(Builder, nodes, locales, formatters, formatConfig, values, currentPluralValue) {
     if (values === void 0) { values = {}; }
     var builder = new Builder();
-    bindFormatValuesWithBuilder(builder, nodes, locales, formatters, formats, values, currentPluralValue);
+    bindFormatValuesWithBuilder(builder, nodes, locales, formatters, formatConfig, values, currentPluralValue);
     return builder.finish();
 }

package/dist/intl-manager.d.ts

@@ -2,6 +2,7 @@ import { IntlShape } from '@formatjs/intl';
 import type { FormatterImplementation, IntlMessageGetter, RequiredFormatValues, TypedIntlMessageGetter } from './types';
 import { InternalIntlMessage } from './message';
 import { FormatBuilderConstructor } from './format';
+import { FormatConfig } from './format-config';
 /**
  * Fallback locale used for all internationalization when an operation in the
  * requested locale is not possible.
@@ -17,6 +18,7 @@ export declare class IntlManager {
     defaultLocale: string;
     currentLocale: string;
     intl: IntlShape;
+    formatConfig: FormatConfig;
     _localeSubscriptions: Set<(locale: string) => void>;
     constructor(defaultLocale?: string);
     /**

package/dist/intl-manager.js

@@ -29,8 +29,8 @@ var __read = (this && this.__read) || function (o, n) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntlManager = exports.DEFAULT_LOCALE = void 0;
 var intl_1 = require("@formatjs/intl");
-var intl_messageformat_1 = require("intl-messageformat");
 var format_1 = require("./format");
+var format_config_1 = require("./format-config");
 /**
  * Fallback locale used for all internationalization when an operation in the
  * requested locale is not possible.
@@ -49,8 +49,9 @@ var IntlManager = /** @class */ (function () {
         };
         this.defaultLocale = defaultLocale;
         this.currentLocale = defaultLocale;
+        this.formatConfig = format_config_1.DEFAULT_FORMAT_CONFIG;
         this.intl = (0, intl_1.createIntl)({
-            formats: intl_messageformat_1.IntlMessageFormat.formats,
+            formats: format_config_1.DEFAULT_FORMAT_CONFIG,
             defaultLocale: defaultLocale,
             locale: defaultLocale,
         });
@@ -144,7 +145,7 @@ var IntlManager = /** @class */ (function () {
         return resolved.reserialize();
     };
     IntlManager.prototype.bindFormatValues = function (Builder, message, values) {
-        return (0, format_1.bindFormatValues)(Builder, message.ast, [this.currentLocale, this.defaultLocale], this.intl.formatters, this.intl.formats, values);
+        return (0, format_1.bindFormatValues)(Builder, message.ast, [this.currentLocale, this.defaultLocale], this.intl.formatters, this.formatConfig, values);
     };
     return IntlManager;
 }());

package/dist/message-loader.js

@@ -206,7 +206,14 @@ var MessageLoader = /** @class */ (function () {
                         // requested locale. Shouldn't happen, but throwing here is much more
                         // contextual than whatever error would result otherwise.
                         if (this.localeImportMap[locale] == null) {
-                            throw new Error("Requested to load locale ".concat(locale, ", which should be supported, but no source for translation data was provided."));
+                            if (this.supportedLocales.includes(locale)) {
+                                // `supportedLocales` is determined by the `localeImportMap`, so if it's present but
+                                // nullish, it's almost definitely a configuration error and deserves to be reported loudly.
+                                throw new Error("Requested to load locale ".concat(locale, ", which should be supported, but no source for translation data was provided."));
+                            }
+                            else {
+                                return [2 /*return*/];
+                            }
                         }
                         // If the locale is already set in `messages`, then it doesn't need to be loaded again.
                         if (this.messages[locale] != null)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "license": "MIT",
   "description": "Client runtime for managing messages and translations in a React project.",
   "main": "./dist/index.js",

package/src/format-config.ts

@@ -0,0 +1,72 @@
+export interface FormatConfig {
+  number: { [name: string]: Intl.NumberFormatOptions };
+  time: { [name: string]: Intl.DateTimeFormatOptions };
+  date: { [name: string]: Intl.DateTimeFormatOptions };
+}
+
+/**
+ * Default formatting configuration options for common date, time, and number formats. This is
+ * taken almost directly from FormatJS's defaults here, for the sake of compatibility.
+ * https://github.com/formatjs/formatjs/blob/c30975bfbe2db7eb62f4dbe6c8ad6ca5e786dcb3/packages/intl-messageformat/src/core.ts#L229-L296
+ */
+export const DEFAULT_FORMAT_CONFIG: FormatConfig = {
+  number: {
+    integer: { maximumFractionDigits: 0 },
+    currency: { style: 'currency' },
+    percent: { style: 'percent' },
+  },
+
+  date: {
+    short: {
+      month: 'numeric',
+      day: 'numeric',
+      year: '2-digit',
+    },
+
+    medium: {
+      month: 'short',
+      day: 'numeric',
+      year: 'numeric',
+    },
+
+    long: {
+      month: 'long',
+      day: 'numeric',
+      year: 'numeric',
+    },
+
+    full: {
+      weekday: 'long',
+      month: 'long',
+      day: 'numeric',
+      year: 'numeric',
+    },
+  },
+
+  time: {
+    short: {
+      hour: 'numeric',
+      minute: 'numeric',
+    },
+
+    medium: {
+      hour: 'numeric',
+      minute: 'numeric',
+      second: 'numeric',
+    },
+
+    long: {
+      hour: 'numeric',
+      minute: 'numeric',
+      second: 'numeric',
+      timeZoneName: 'short',
+    },
+
+    full: {
+      hour: 'numeric',
+      minute: 'numeric',
+      second: 'numeric',
+      timeZoneName: 'short',
+    },
+  },
+};

package/src/format.ts

@@ -17,15 +17,17 @@
  *   parameter, important to have React treat the resulting elements nicely.
  */
 
-import { FormatJsNode, FormatJsNodeType } from './keyless-json';
-import { Formats, Formatters, MissingValueError } from 'intl-messageformat';
-import { RichTextTagNames } from './types';
 import {
   parseDateTimeSkeleton,
   parseNumberSkeleton,
   parseNumberSkeletonFromString,
 } from '@formatjs/icu-skeleton-parser';
 
+import { FormatJsNode, FormatJsNodeType } from './keyless-json';
+import { Formatters, MissingValueError } from 'intl-messageformat';
+import type { FormatConfig } from './format-config';
+import type { RichTextTagNames } from './types';
+
 /**
  * Returns true if the tag name should be considered a rich text tag that
  * applies formatting to a message, rather than being a user-supplied value.
@@ -48,7 +50,7 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
   nodes: FormatJsNode[],
   locales: string | string[],
   formatters: Formatters,
-  formats: Formats,
+  formatConfig: FormatConfig,
   values: Record<string, string | object> = {},
   currentPluralValue?: number,
   originalMessage?: string,
@@ -102,11 +104,11 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
         // Distinct from FormatJS: We don't currently parse the skeleton ahead of time in the AST,
         // so this manages parsing the skeleton as well before passing it onto the date formatter.
         const style =
-          node.style in formats.date
-            ? formats.date[node.style]
+          node.style in formatConfig.date
+            ? formatConfig.date[node.style]
             : node.style != null
               ? parseDateTimeSkeleton(node.style)
-              : undefined;
+              : formatConfig.time.medium;
         // @ts-expect-error Cast string values to dates properly.
         builder.pushLiteralText(formatters.getDateTimeFormat(locales, style).format(value));
         break;
@@ -115,8 +117,8 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
         // Distinct from FormatJS: We don't currently parse the skeleton ahead of time in the AST,
         // so this manages parsing the skeleton as well before passing it onto the date formatter.
         const style =
-          node.style in formats.time
-            ? formats.time[node.style]
+          node.style in formatConfig.time
+            ? formatConfig.time[node.style]
             : node.style != null
               ? parseDateTimeSkeleton(node.style)
               : undefined; // TODO: parseSkeleton();
@@ -130,8 +132,8 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
         // Distinct from FormatJS: We don't currently parse the skeleton ahead of time in the AST,
         // so this manages parsing the skeleton as well before passing it onto the date formatter.
         const style =
-          node.style in formats.number
-            ? formats.number[node.style]
+          node.style in formatConfig.number
+            ? formatConfig.number[node.style]
             : node.style != null
               ? parseNumberSkeleton(parseNumberSkeletonFromString(node.style))
               : undefined;
@@ -149,7 +151,7 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
           children,
           locales,
           formatters,
-          formats,
+          formatConfig,
           values,
           currentPluralValue,
         );
@@ -177,7 +179,14 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
         if (option == null) {
           throw `${node.value} is not a known option for select value ${variableName}. Valid options are ${Object.keys(node.options).join(', ')}`;
         }
-        bindFormatValuesWithBuilder(builder, option.value, locales, formatters, formats, values);
+        bindFormatValuesWithBuilder(
+          builder,
+          option.value,
+          locales,
+          formatters,
+          formatConfig,
+          values,
+        );
         break;
       }
 
@@ -200,7 +209,7 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
           option.value,
           locales,
           formatters,
-          formats,
+          formatConfig,
           values,
           // @ts-expect-error assert this `as number` properly.
           (value as number) - (node.offset ?? 0),
@@ -216,7 +225,7 @@ export function bindFormatValues<Result>(
   nodes: FormatJsNode[],
   locales: string | string[],
   formatters: Formatters,
-  formats: Formats,
+  formatConfig: FormatConfig,
   values: Record<string, string | object> = {},
   currentPluralValue?: number,
 ): Result[] {
@@ -226,7 +235,7 @@ export function bindFormatValues<Result>(
     nodes,
     locales,
     formatters,
-    formats,
+    formatConfig,
     values,
     currentPluralValue,
   );

package/src/intl-manager.ts

@@ -1,5 +1,5 @@
 import { createIntl, IntlShape } from '@formatjs/intl';
-import { Formats, Formatters, IntlMessageFormat } from 'intl-messageformat';
+import { Formatters } from 'intl-messageformat';
 
 import type {
   FormatterImplementation,
@@ -10,6 +10,7 @@ import type {
 import { InternalIntlMessage } from './message';
 import { bindFormatValues, FormatBuilderConstructor } from './format';
 import { FormatJsLiteral } from './keyless-json';
+import { DEFAULT_FORMAT_CONFIG, FormatConfig } from './format-config';
 
 /**
  * Fallback locale used for all internationalization when an operation in the
@@ -41,14 +42,16 @@ export class IntlManager {
   defaultLocale: string;
   currentLocale: string;
   intl: IntlShape;
+  formatConfig: FormatConfig;
 
   _localeSubscriptions: Set<(locale: string) => void>;
 
   constructor(defaultLocale: string = DEFAULT_LOCALE) {
     this.defaultLocale = defaultLocale;
     this.currentLocale = defaultLocale;
+    this.formatConfig = DEFAULT_FORMAT_CONFIG;
     this.intl = createIntl({
-      formats: IntlMessageFormat.formats,
+      formats: DEFAULT_FORMAT_CONFIG,
       defaultLocale,
       locale: defaultLocale,
     });
@@ -148,7 +151,7 @@ export class IntlManager {
       message.ast,
       [this.currentLocale, this.defaultLocale],
       this.intl.formatters as Formatters,
-      this.intl.formats as Formats,
+      this.formatConfig,
       values,
     );
   }

package/src/message-loader.ts

@@ -210,9 +210,15 @@ export class MessageLoader {
     // requested locale. Shouldn't happen, but throwing here is much more
     // contextual than whatever error would result otherwise.
     if (this.localeImportMap[locale] == null) {
-      throw new Error(
-        `Requested to load locale ${locale}, which should be supported, but no source for translation data was provided.`,
-      );
+      if (this.supportedLocales.includes(locale)) {
+        // `supportedLocales` is determined by the `localeImportMap`, so if it's present but
+        // nullish, it's almost definitely a configuration error and deserves to be reported loudly.
+        throw new Error(
+          `Requested to load locale ${locale}, which should be supported, but no source for translation data was provided.`,
+        );
+      } else {
+        return;
+      }
     }
 
     // If the locale is already set in `messages`, then it doesn't need to be loaded again.