@discord/intl 0.10.3-canary.b2d8368 → 0.10.4

package/dist/intl-manager.d.ts

@@ -14,13 +14,30 @@ export type FormatFunction<F extends FormatterImplementation<any, any>> = <T ext
 type ThisWithFormatters<This, T extends Record<string, FormatterImplementation<any, any>>> = This & {
     [K in keyof T]: FormatFunction<T[K]>;
 };
+export interface IntlManagerOptions {
+    /**
+     * The locale to initially have this manager use. Useful to set when information about the user's
+     * likely locale is available sooner than when that information is definitely known (at which
+     * point `setLocale` should be called instead).
+     *
+     * @default DEFAULT_LOCALE
+     */
+    initialLocale?: string;
+    /**
+     * The locale in which most messages are _defined_, used as an indication of where fallbacks
+     * should be loaded from when they can't be found in the requested `currentLocale`.
+     *
+     * @default DEFAULT_LOCALE
+     */
+    defaultLocale?: string;
+}
 export declare class IntlManager {
     defaultLocale: string;
     currentLocale: string;
     intl: IntlShape;
     formatConfig: FormatConfig;
     _localeSubscriptions: Set<(locale: string) => void>;
-    constructor(initialLocale?: string, defaultLocale?: string);
+    constructor({ initialLocale, defaultLocale, }: IntlManagerOptions);
     /**
      * Add a set of formatter implementations to this manager, making each available as a direct
      * property

package/dist/intl-manager.js

@@ -10,7 +10,7 @@ const format_config_1 = require("./format-config");
  */
 exports.DEFAULT_LOCALE = 'en-US';
 class IntlManager {
-    constructor(initialLocale = exports.DEFAULT_LOCALE, defaultLocale = exports.DEFAULT_LOCALE) {
+    constructor({ initialLocale = exports.DEFAULT_LOCALE, defaultLocale = exports.DEFAULT_LOCALE, }) {
         /**
          * Subscribe to changes in the current locale for this manager.
          */

package/dist/message-loader.d.ts

@@ -117,6 +117,7 @@ export declare class MessageLoader {
      * Subscribe to events about when a locale has loaded.
      */
     onChange(callback: () => void): () => void;
+    isLocaleLoading(locale: LocaleId): boolean;
     isLocaleLoaded(locale: LocaleId, requireCurrent?: boolean): boolean;
     waitForLocaleLoaded(locale: LocaleId, requireCurrent?: boolean): Promise<void>;
     /**

package/dist/message-loader.js

@@ -52,10 +52,18 @@ class MessageLoader {
         this._localeFileMap = localeFileMap;
     }
     get(key, locale) {
-        var _a;
-        const value = (_a = this.getMessageValue(key, locale)) !== null && _a !== void 0 ? _a : this.getMessageValue(key, this.defaultLocale);
-        if (value != null)
-            return value;
+        const expectedValue = this.getMessageValue(key, locale);
+        if (expectedValue != null)
+            return expectedValue;
+        // If the expected locale is still in progress with loading and the default locale _has not_
+        // started loading already, then return the fallback message instead of starting a load of the
+        // default locale when it may not be necessary.
+        if (this.isLocaleLoading(locale) && !this.isLocaleLoaded(this.defaultLocale)) {
+            return this.fallbackMessage;
+        }
+        const fallbackValue = this.getMessageValue(key, this.defaultLocale);
+        if (fallbackValue != null)
+            return fallbackValue;
         // If the message couldn't be found in either the requested nor the default locale, then
         // nothing can be done.
         const errorKey = this._debugKeyMap != null ? `"${this._debugKeyMap[key]}" (${key})` : undefined;
@@ -123,7 +131,7 @@ class MessageLoader {
     }
     _loadLocale(locale) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
+            var _a, _b, _c, _d;
             // If the locale is already set in `messages`, then it doesn't need to be loaded again.
             if (this.messages[locale] != null)
                 return;
@@ -146,7 +154,8 @@ class MessageLoader {
                 }
             }
             const current = this.localeImportMap[locale]();
-            this._localeLoadingPromises[locale] = { initialized: false, current };
+            const isAlreadyInitialized = (_d = (_c = this._localeLoadingPromises[locale]) === null || _c === void 0 ? void 0 : _c.initialized) !== null && _d !== void 0 ? _d : false;
+            this._localeLoadingPromises[locale] = { initialized: isAlreadyInitialized, current };
             this.messages[locale] = (yield current).default;
             this._localeLoadingPromises[locale] = { initialized: true, current: undefined };
             this.emitChange();
@@ -168,6 +177,10 @@ class MessageLoader {
         this._subscribers.add(callback);
         return () => this._subscribers.delete(callback);
     }
+    isLocaleLoading(locale) {
+        var _a;
+        return ((_a = this._localeLoadingPromises[locale]) === null || _a === void 0 ? void 0 : _a.current) != null;
+    }
     isLocaleLoaded(locale, requireCurrent = false) {
         const ref = this._localeLoadingPromises[locale];
         // Ensure the locale at least exists and is initialized.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl",
-  "version": "0.10.3-canary.b2d8368",
+  "version": "0.10.4",
   "license": "MIT",
   "description": "Client runtime for managing messages and translations in a React project.",
   "main": "./dist/index.js",
@@ -23,7 +23,7 @@
     "@formatjs/intl": "^2.10.1",
     "@intrnl/xxhash64": "^0.1.2",
     "intl-messageformat": "^10.5.11",
-    "@discord/intl-ast": "0.10.3"
+    "@discord/intl-ast": "0.10.4"
   },
   "devDependencies": {
     "@swc/cli": "^0.3.12",

package/src/intl-manager.ts

@@ -37,6 +37,24 @@ type ThisWithFormatters<
   [K in keyof T]: FormatFunction<T[K]>;
 };
 
+export interface IntlManagerOptions {
+  /**
+   * The locale to initially have this manager use. Useful to set when information about the user's
+   * likely locale is available sooner than when that information is definitely known (at which
+   * point `setLocale` should be called instead).
+   *
+   * @default DEFAULT_LOCALE
+   */
+  initialLocale?: string;
+  /**
+   * The locale in which most messages are _defined_, used as an indication of where fallbacks
+   * should be loaded from when they can't be found in the requested `currentLocale`.
+   *
+   * @default DEFAULT_LOCALE
+   */
+  defaultLocale?: string;
+}
+
 export class IntlManager {
   defaultLocale: string;
   currentLocale: string;
@@ -45,7 +63,10 @@ export class IntlManager {
 
   _localeSubscriptions: Set<(locale: string) => void>;
 
-  constructor(initialLocale: string = DEFAULT_LOCALE, defaultLocale: string = DEFAULT_LOCALE) {
+  constructor({
+    initialLocale = DEFAULT_LOCALE,
+    defaultLocale = DEFAULT_LOCALE,
+  }: IntlManagerOptions) {
     this.currentLocale = initialLocale;
     this.defaultLocale = defaultLocale;
     this.formatConfig = DEFAULT_FORMAT_CONFIG;

package/src/message-loader.ts

@@ -127,9 +127,17 @@ export class MessageLoader {
   }
 
   get(key: string, locale: LocaleId): InternalIntlMessage {
-    const value =
-      this.getMessageValue(key, locale) ?? this.getMessageValue(key, this.defaultLocale);
-    if (value != null) return value;
+    const expectedValue = this.getMessageValue(key, locale);
+    if (expectedValue != null) return expectedValue;
+    // If the expected locale is still in progress with loading and the default locale _has not_
+    // started loading already, then return the fallback message instead of starting a load of the
+    // default locale when it may not be necessary.
+    if (this.isLocaleLoading(locale) && !this.isLocaleLoaded(this.defaultLocale)) {
+      return this.fallbackMessage;
+    }
+
+    const fallbackValue = this.getMessageValue(key, this.defaultLocale);
+    if (fallbackValue != null) return fallbackValue;
 
     // If the message couldn't be found in either the requested nor the default locale, then
     // nothing can be done.
@@ -230,7 +238,8 @@ export class MessageLoader {
     }
 
     const current = this.localeImportMap[locale]();
-    this._localeLoadingPromises[locale] = { initialized: false, current };
+    const isAlreadyInitialized = this._localeLoadingPromises[locale]?.initialized ?? false;
+    this._localeLoadingPromises[locale] = { initialized: isAlreadyInitialized, current };
     this.messages[locale] = (await current).default;
     this._localeLoadingPromises[locale] = { initialized: true, current: undefined };
     this.emitChange();
@@ -255,6 +264,10 @@ export class MessageLoader {
     return () => this._subscribers.delete(callback);
   }
 
+  isLocaleLoading(locale: LocaleId): boolean {
+    return this._localeLoadingPromises[locale]?.current != null;
+  }
+
   isLocaleLoaded(locale: LocaleId, requireCurrent: boolean = false): boolean {
     const ref = this._localeLoadingPromises[locale];
     // Ensure the locale at least exists and is initialized.