@discord/intl 0.10.2 → 0.10.3-canary.1346695

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(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(defaultLocale = exports.DEFAULT_LOCALE) {
+    constructor({ initialLocale = exports.DEFAULT_LOCALE, defaultLocale = exports.DEFAULT_LOCALE, }) {
         /**
          * Subscribe to changes in the current locale for this manager.
          */
@@ -18,8 +18,8 @@ class IntlManager {
             this._localeSubscriptions.add(callback);
             return () => this._localeSubscriptions.delete(callback);
         };
+        this.currentLocale = initialLocale;
         this.defaultLocale = defaultLocale;
-        this.currentLocale = defaultLocale;
         this.formatConfig = format_config_1.DEFAULT_FORMAT_CONFIG;
         this.intl = (0, intl_1.createIntl)({
             formats: format_config_1.DEFAULT_FORMAT_CONFIG,

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

@@ -24,7 +24,8 @@ class MessageLoader {
         this._localeLoadingPromises = {};
         this._parseCache = {};
         this._subscribers = new Set();
-        this._loadLocale(this.defaultLocale);
+        // TODO: Bring this back as an option to pre-load the locale.
+        // this._loadLocale(this.defaultLocale);
         this.fallbackMessage = new message_1.InternalIntlMessage([], this.defaultLocale);
         // In cases where hot module replacement is available, set up cache clearing whenever the
         // targets change so that values are always replaced.
@@ -51,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;
@@ -122,9 +131,13 @@ class MessageLoader {
     }
     _loadLocale(locale) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
+            var _a, _b;
+            // If the locale is already set in `messages`, then it doesn't need to be loaded again.
+            if (this.messages[locale] != null)
+                return;
             // Don't re-load a locale that's already in progress.
             if (((_a = this._localeLoadingPromises[locale]) === null || _a === void 0 ? void 0 : _a.current) != null) {
+                yield ((_b = this._localeLoadingPromises[locale]) === null || _b === void 0 ? void 0 : _b.current);
                 return;
             }
             // Safety check in case the locale map doesn't include a require for the
@@ -140,9 +153,6 @@ class MessageLoader {
                     return;
                 }
             }
-            // If the locale is already set in `messages`, then it doesn't need to be loaded again.
-            if (this.messages[locale] != null)
-                return;
             const current = this.localeImportMap[locale]();
             this._localeLoadingPromises[locale] = { initialized: false, current };
             this.messages[locale] = (yield current).default;
@@ -166,6 +176,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.2",
+  "version": "0.10.3-canary.1346695",
   "license": "MIT",
   "description": "Client runtime for managing messages and translations in a React project.",
   "main": "./dist/index.js",
@@ -14,12 +14,16 @@
     "dist",
     "src"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/discord/discord-intl"
+  },
   "dependencies": {
     "@formatjs/icu-skeleton-parser": "1.8.2",
     "@formatjs/intl": "^2.10.1",
     "@intrnl/xxhash64": "^0.1.2",
     "intl-messageformat": "^10.5.11",
-    "@discord/intl-ast": "0.10.2"
+    "@discord/intl-ast": "0.10.3"
   },
   "devDependencies": {
     "@swc/cli": "^0.3.12",
@@ -27,17 +31,7 @@
     "typescript": "*"
   },
   "peerDependencies": {
-    "@rspack/core": "0.x || 1.x",
-    "react": "> 16",
-    "webpack": "^5.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@rspack/core": {
-      "optional": true
-    },
-    "webpack": {
-      "optional": true
-    }
+    "react": "> 16"
   },
   "scripts": {
     "build": "tsc",

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,9 +63,12 @@ export class IntlManager {
 
   _localeSubscriptions: Set<(locale: string) => void>;
 
-  constructor(defaultLocale: string = DEFAULT_LOCALE) {
+  constructor({
+    initialLocale = DEFAULT_LOCALE,
+    defaultLocale = DEFAULT_LOCALE,
+  }: IntlManagerOptions) {
+    this.currentLocale = initialLocale;
     this.defaultLocale = defaultLocale;
-    this.currentLocale = defaultLocale;
     this.formatConfig = DEFAULT_FORMAT_CONFIG;
     this.intl = createIntl({
       formats: DEFAULT_FORMAT_CONFIG,

package/src/message-loader.ts

@@ -96,7 +96,8 @@ export class MessageLoader {
     this._parseCache = {};
     this._subscribers = new Set();
 
-    this._loadLocale(this.defaultLocale);
+    // TODO: Bring this back as an option to pre-load the locale.
+    // this._loadLocale(this.defaultLocale);
     this.fallbackMessage = new InternalIntlMessage([], this.defaultLocale);
 
     // In cases where hot module replacement is available, set up cache clearing whenever the
@@ -126,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.
@@ -204,8 +213,12 @@ export class MessageLoader {
   }
 
   async _loadLocale(locale: LocaleId) {
+    // If the locale is already set in `messages`, then it doesn't need to be loaded again.
+    if (this.messages[locale] != null) return;
+
     // Don't re-load a locale that's already in progress.
     if (this._localeLoadingPromises[locale]?.current != null) {
+      await this._localeLoadingPromises[locale]?.current;
       return;
     }
 
@@ -224,9 +237,6 @@ export class MessageLoader {
       }
     }
 
-    // If the locale is already set in `messages`, then it doesn't need to be loaded again.
-    if (this.messages[locale] != null) return;
-
     const current = this.localeImportMap[locale]();
     this._localeLoadingPromises[locale] = { initialized: false, current };
     this.messages[locale] = (await current).default;
@@ -253,6 +263,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.