@discord/intl 0.10.0-rc.4 → 0.10.2

package/dist/format.js

@@ -35,7 +35,7 @@ class FormatBuilder {
 }
 exports.FormatBuilder = FormatBuilder;
 function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, formatConfig, values = {}, currentPluralValue, originalMessage) {
-    var _a, _b;
+    var _a;
     // Hot path for static messages that are just parsed as a single string element.
     if (nodes.length === 1 && typeof nodes[0] === 'string') {
         builder.pushLiteralText(nodes[0]);
@@ -146,17 +146,16 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
                 break;
             }
             case intl_ast_1.FormatJsNodeType.Select: {
-                const value = node[1 /* AstNodeIndices.Value */];
+                const requestedOption = value;
                 const options = node[2 /* AstNodeIndices.Options */];
-                const option = value in options ? options[value] : options.other;
+                const option = requestedOption in options ? options[requestedOption] : options.other;
                 if (option == null) {
-                    throw `${value} is not a known option for select value ${variableName}. Valid options are ${Object.keys(options).join(', ')}`;
+                    throw `${requestedOption} is not a known option for select value ${variableName}. Valid options are ${Object.keys(options).join(', ')}`;
                 }
                 bindFormatValuesWithBuilder(builder, option, locales, formatters, formatConfig, values);
                 break;
             }
             case intl_ast_1.FormatJsNodeType.Plural: {
-                const value = node[1 /* AstNodeIndices.Value */];
                 const options = node[2 /* AstNodeIndices.Options */];
                 const offset = node[3 /* AstNodeIndices.Offset */];
                 const pluralType = node[4 /* AstNodeIndices.PluralType */];
@@ -175,8 +174,8 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
                     throw `${value} is not a known option for plural value ${variableName}. Valid options are ${Object.keys(options).join(', ')}`;
                 }
                 bindFormatValuesWithBuilder(builder, option, locales, formatters, formatConfig, values, 
-                // @ts-expect-error assert this `as number` properly.
-                value - ((_b = node.offset) !== null && _b !== void 0 ? _b : 0));
+                // @ts-expect-error assert this `as number` properly
+                value - (offset !== null && offset !== void 0 ? offset : 0));
                 break;
             }
         }

package/dist/message-loader.d.ts

@@ -2,17 +2,12 @@ import { AstNode, FullFormatJsNode } from '@discord/intl-ast';
 import { InternalIntlMessage } from './message';
 /**
  * Type representing the serialized content of a translations file, which is a record of hashed
- * message keys to their AST structure. This type represents both compressed, keyless AstNodes as
- * well as fully-typed, object FullFormatJsNodes as the message content, since either can be given
- * depending on the configuration of the bundler/compiler.
+ * message keys to their AST structure. This type represents both compressed, keyless AstNodes and
+ * fully-typed, object FullFormatJsNodes as the message content, since either can be given depending
+ * on the configuration of the bundler/compiler.
  */
 type MessagesData = Record<string, AstNode[] | FullFormatJsNode[]>;
-export interface IntlMessageGetterAdditions {
-    onChange(callback: () => void): () => void;
-}
-export interface IntlMessageGetter extends IntlMessageGetterAdditions {
-    (locale: LocaleId): InternalIntlMessage;
-}
+export type IntlMessageGetter = (this: MessageLoader, locale: LocaleId) => InternalIntlMessage;
 export type LocaleId = string;
 export type LocaleImportMap = Record<LocaleId, () => Promise<{
     default: MessagesData;
@@ -103,6 +98,13 @@ export declare class MessageLoader {
      * for `get` with the that key as the first argument, allowing consumers to
      * just call the function with a locale to retrieve the translated message
      * for that key.
+     *
+     * This method is provided as a way to generate binds _at runtime_, but for
+     * very-large messages files (e.g., thousands of messages), this can be a
+     * non-negligible cost. Where feasible, consider generating these binds
+     * at build/bundle time, especially in cases where they can be substantially
+     * minified (i.e., Hermes bytecode). This is provided automatically as an
+     * option when using one of `@discord/intl`'s transformers.
      */
     getBinds(): Record<string, IntlMessageGetter>;
     _loadLocale(locale: LocaleId): Promise<void>;

package/dist/message-loader.js

@@ -105,14 +105,18 @@ class MessageLoader {
      * for `get` with the that key as the first argument, allowing consumers to
      * just call the function with a locale to retrieve the translated message
      * for that key.
+     *
+     * This method is provided as a way to generate binds _at runtime_, but for
+     * very-large messages files (e.g., thousands of messages), this can be a
+     * non-negligible cost. Where feasible, consider generating these binds
+     * at build/bundle time, especially in cases where they can be substantially
+     * minified (i.e., Hermes bytecode). This is provided automatically as an
+     * option when using one of `@discord/intl`'s transformers.
      */
     getBinds() {
-        const onChange = this.onChange.bind(this);
         const result = {};
         for (const key of this.messageKeys) {
-            const bound = (locale) => this.get(key, locale);
-            bound.onChange = onChange;
-            result[key] = bound;
+            result[key] = this.get.bind(this, key);
         }
         return result;
     }

package/dist/types.d.ts

@@ -1,5 +1,4 @@
 import type { InternalIntlMessage } from './message';
-import type { IntlMessageGetterAdditions } from './message-loader';
 import { FormatBuilderConstructor } from './format';
 
 /**
@@ -42,7 +41,7 @@ export type IntlTime = string | number | Date | null | undefined;
 export type PlainIntlMessage = string;
 export type AnyIntlMessage = PlainIntlMessage | InternalIntlMessage;
 
-export interface IntlMessageGetter extends IntlMessageGetterAdditions {
+export interface IntlMessageGetter {
   (locale: string): InternalIntlMessage | PlainIntlMessage;
 }
 
@@ -52,8 +51,7 @@ export interface IntlMessageGetter extends IntlMessageGetterAdditions {
  * value types that are required to format the message, or `{}` to represent
  * that there are no values required and the message is a plain string.
  */
-export interface TypedIntlMessageGetter<FormatValues extends object>
-  extends IntlMessageGetterAdditions {
+export interface TypedIntlMessageGetter<FormatValues extends object> {
   // TODO: This is lossy and unfortunate that typing can't be propagated
   // to the returned message type, but doing so causes problems with
   // contravariance of the type. When returning a message getter from a

package/package.json

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

package/src/format.ts

@@ -192,18 +192,17 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
       }
 
       case FormatJsNodeType.Select: {
-        const value = node[AstNodeIndices.Value];
+        const requestedOption = value as string;
         const options = node[AstNodeIndices.Options];
-        const option = value in options ? options[value] : options.other;
+        const option = requestedOption in options ? options[requestedOption] : options.other;
         if (option == null) {
-          throw `${value} is not a known option for select value ${variableName}. Valid options are ${Object.keys(options).join(', ')}`;
+          throw `${requestedOption} is not a known option for select value ${variableName}. Valid options are ${Object.keys(options).join(', ')}`;
         }
         bindFormatValuesWithBuilder(builder, option, locales, formatters, formatConfig, values);
         break;
       }
 
       case FormatJsNodeType.Plural: {
-        const value = node[AstNodeIndices.Value];
         const options = node[AstNodeIndices.Options];
         const offset = node[AstNodeIndices.Offset];
         const pluralType = node[AstNodeIndices.PluralType];
@@ -227,8 +226,8 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
           formatters,
           formatConfig,
           values,
-          // @ts-expect-error assert this `as number` properly.
-          (value as number) - (node.offset ?? 0),
+          // @ts-expect-error assert this `as number` properly
+          (value as number) - (offset ?? 0),
         );
         break;
       }

package/src/message-loader.ts

@@ -3,18 +3,13 @@ import { InternalIntlMessage } from './message';
 
 /**
  * Type representing the serialized content of a translations file, which is a record of hashed
- * message keys to their AST structure. This type represents both compressed, keyless AstNodes as
- * well as fully-typed, object FullFormatJsNodes as the message content, since either can be given
- * depending on the configuration of the bundler/compiler.
+ * message keys to their AST structure. This type represents both compressed, keyless AstNodes and
+ * fully-typed, object FullFormatJsNodes as the message content, since either can be given depending
+ * on the configuration of the bundler/compiler.
  */
 type MessagesData = Record<string, AstNode[] | FullFormatJsNode[]>;
-export interface IntlMessageGetterAdditions {
-  onChange(callback: () => void): () => void;
-}
 
-export interface IntlMessageGetter extends IntlMessageGetterAdditions {
-  (locale: LocaleId): InternalIntlMessage;
-}
+export type IntlMessageGetter = (this: MessageLoader, locale: LocaleId) => InternalIntlMessage;
 
 export type LocaleId = string;
 
@@ -191,14 +186,18 @@ export class MessageLoader {
    * for `get` with the that key as the first argument, allowing consumers to
    * just call the function with a locale to retrieve the translated message
    * for that key.
+   *
+   * This method is provided as a way to generate binds _at runtime_, but for
+   * very-large messages files (e.g., thousands of messages), this can be a
+   * non-negligible cost. Where feasible, consider generating these binds
+   * at build/bundle time, especially in cases where they can be substantially
+   * minified (i.e., Hermes bytecode). This is provided automatically as an
+   * option when using one of `@discord/intl`'s transformers.
    */
   getBinds(): Record<string, IntlMessageGetter> {
-    const onChange = this.onChange.bind(this);
     const result: Record<string, IntlMessageGetter> = {};
     for (const key of this.messageKeys) {
-      const bound = (locale: LocaleId) => this.get(key, locale);
-      bound.onChange = onChange;
-      result[key] = bound;
+      result[key] = this.get.bind(this, key);
     }
 
     return result;

package/src/types.d.ts

@@ -1,5 +1,4 @@
 import type { InternalIntlMessage } from './message';
-import type { IntlMessageGetterAdditions } from './message-loader';
 import { FormatBuilderConstructor } from './format';
 
 /**
@@ -42,7 +41,7 @@ export type IntlTime = string | number | Date | null | undefined;
 export type PlainIntlMessage = string;
 export type AnyIntlMessage = PlainIntlMessage | InternalIntlMessage;
 
-export interface IntlMessageGetter extends IntlMessageGetterAdditions {
+export interface IntlMessageGetter {
   (locale: string): InternalIntlMessage | PlainIntlMessage;
 }
 
@@ -52,8 +51,7 @@ export interface IntlMessageGetter extends IntlMessageGetterAdditions {
  * value types that are required to format the message, or `{}` to represent
  * that there are no values required and the message is a plain string.
  */
-export interface TypedIntlMessageGetter<FormatValues extends object>
-  extends IntlMessageGetterAdditions {
+export interface TypedIntlMessageGetter<FormatValues extends object> {
   // TODO: This is lossy and unfortunate that typing can't be propagated
   // to the returned message type, but doing so causes problems with
   // contravariance of the type. When returning a message getter from a