@discord/intl 0.13.0 → 0.13.1

package/dist/format.d.ts

@@ -20,12 +20,12 @@ import { AstNode } from '@discord/intl-ast';
 import { Formatters } from 'intl-messageformat';
 import type { FormatConfig } from './format-config';
 import type { RichTextTagNames } from './types';
-export declare abstract class FormatBuilder<Result> {
+export declare abstract class FormatBuilder<Result, ObjectType = Result extends object ? Result : never> {
     abstract pushRichTextTag(tag: RichTextTagNames, children: Result[], control: Result[]): void;
     abstract pushLiteralText(text: string): void;
-    abstract pushObject(value: object): void;
+    abstract pushObject(value: ObjectType): void;
     abstract finish(): Result[];
 }
 export type FormatBuilderConstructor<Result> = new () => FormatBuilder<Result>;
-export declare function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>(builder: Builder, nodes: AstNode[], locales: string | string[], formatters: Formatters, formatConfig: FormatConfig, values?: Record<string, string | object>, currentPluralValue?: number, originalMessage?: string): void;
+export declare function bindFormatValuesWithBuilder<T, ObjectType, Builder extends FormatBuilder<T, ObjectType>>(builder: Builder, nodes: AstNode[], 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: string | AstNode[], locales: string | string[], formatters: Formatters, formatConfig: FormatConfig, values?: Record<string, string | object>, currentPluralValue?: number): Result[];

package/dist/format.js

@@ -67,6 +67,13 @@ function bindFormatValuesWithBuilder(builder, nodes, locales, formatters, format
         const value = values[variableName];
         switch (nodeType) {
             case intl_ast_1.FormatJsNodeType.Argument:
+                // `function` here captures ReactNodes, which can be functions that
+                // return elements. Basically everything else fits in the `object`
+                // type, and the generic type requires that an explicit ObjectType
+                // be specified for cases where it's not. That means there's an
+                // escape hatch that _might_ break this, but it would have to be
+                // intentionally set by internal code to function that way, so we'll
+                // operate on a promise that it won't for now.
                 if (typeof value === 'object' || typeof value === 'function') {
                     builder.pushObject(value);
                 }

package/dist/formatters/ast.d.ts

@@ -12,17 +12,7 @@ export declare enum RichTextNodeType {
     Strikethrough = "s",
     Code = "inlineCode",
     Link = "link",
-    Paragraph = "paragraph",
-    /**
-     * A special extension for when the value of a placeholder is an object.
-     * Rather than casting to a string here, the object is preserved as-is for a
-     * future formatter to render as appropriate (i.e., using an object as a
-     * value when formatting to an AST should keep that object structure so that
-     * the final AST is accurate for what the user expects, but when rendering to
-     * a plain string, the final formatter can just cast that object to a string
-     * using its `toString` method or some other mechanism).
-     */
-    Object = "object"
+    Paragraph = "paragraph"
 }
 interface RichTextNodeBase<ContentType> {
     type: RichTextNodeType;
@@ -48,12 +38,9 @@ interface RichTextParagraphNode extends RichTextNodeBase<RichTextNode[]> {
 }
 interface RichTextLinkNode extends RichTextNodeBase<RichTextNode[]> {
     type: RichTextNodeType.Link;
-    target: string;
+    target: object;
 }
-interface RichTextObjectNode extends RichTextNodeBase<object> {
-    type: RichTextNodeType.Object;
-}
-export type RichTextNode = RichTextTextNode | RichTextStrongNode | RichTextEmphasisNode | RichTextStrikethroughNode | RichTextCodeNode | RichTextParagraphNode | RichTextLinkNode | RichTextObjectNode;
+export type RichTextNode = RichTextTextNode | RichTextStrongNode | RichTextEmphasisNode | RichTextStrikethroughNode | RichTextCodeNode | RichTextParagraphNode | RichTextLinkNode;
 /**
  * Format the given message in the current locale with the provided values.
  * The returned values is _always_ an Array of parts, even if the message is

package/dist/formatters/ast.js

@@ -15,16 +15,6 @@ var RichTextNodeType;
     RichTextNodeType["Code"] = "inlineCode";
     RichTextNodeType["Link"] = "link";
     RichTextNodeType["Paragraph"] = "paragraph";
-    /**
-     * A special extension for when the value of a placeholder is an object.
-     * Rather than casting to a string here, the object is preserved as-is for a
-     * future formatter to render as appropriate (i.e., using an object as a
-     * value when formatting to an AST should keep that object structure so that
-     * the final AST is accurate for what the user expects, but when rendering to
-     * a plain string, the final formatter can just cast that object to a string
-     * using its `toString` method or some other mechanism).
-     */
-    RichTextNodeType["Object"] = "object";
 })(RichTextNodeType || (exports.RichTextNodeType = RichTextNodeType = {}));
 const AST_RICH_TEXT_ELEMENTS = {
     $b: (content) => ({ type: RichTextNodeType.Strong, content }),
@@ -33,7 +23,7 @@ const AST_RICH_TEXT_ELEMENTS = {
     $code: (content) => ({ type: RichTextNodeType.Code, content }),
     $link: (content, _, [target]) => ({
         type: RichTextNodeType.Link,
-        target: target.content,
+        target,
         content,
     }),
     $p: (content) => ({ type: RichTextNodeType.Paragraph, content }),
@@ -65,7 +55,7 @@ class AstBuilder extends format_1.FormatBuilder {
         }
     }
     pushObject(value) {
-        this.result.push({ type: RichTextNodeType.Object, content: value });
+        this.result.push(value);
     }
     finish() {
         return this.result;

package/dist/formatters/react.js

@@ -41,8 +41,6 @@ function createReactBuilder(richTextElements) {
             }
         }
         pushObject(value) {
-            // @ts-expect-error this is technically invalid, but we'll just assume that if a format
-            // returns an object, it'll be acting as some form of ReactNode.
             this.result.push(value);
         }
         finish() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "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.13.0"
+    "@discord/intl-ast": "0.13.1"
   },
   "devDependencies": {
     "@swc/cli": "^0.3.12",

package/src/format.ts

@@ -36,16 +36,20 @@ function isRichTextTag(name: string) {
   return name[0] === '$';
 }
 
-export abstract class FormatBuilder<Result> {
+export abstract class FormatBuilder<Result, ObjectType = Result extends object ? Result : never> {
   abstract pushRichTextTag(tag: RichTextTagNames, children: Result[], control: Result[]): void;
   abstract pushLiteralText(text: string): void;
-  abstract pushObject(value: object): void;
+  abstract pushObject(value: ObjectType): void;
   abstract finish(): Result[];
 }
 
 export type FormatBuilderConstructor<Result> = new () => FormatBuilder<Result>;
 
-export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>(
+export function bindFormatValuesWithBuilder<
+  T,
+  ObjectType,
+  Builder extends FormatBuilder<T, ObjectType>,
+>(
   builder: Builder,
   nodes: AstNode[],
   locales: string | string[],
@@ -89,8 +93,15 @@ export function bindFormatValuesWithBuilder<T, Builder extends FormatBuilder<T>>
     const value = values[variableName];
     switch (nodeType) {
       case FormatJsNodeType.Argument:
+        // `function` here captures ReactNodes, which can be functions that
+        // return elements. Basically everything else fits in the `object`
+        // type, and the generic type requires that an explicit ObjectType
+        // be specified for cases where it's not. That means there's an
+        // escape hatch that _might_ break this, but it would have to be
+        // intentionally set by internal code to function that way, so we'll
+        // operate on a promise that it won't for now.
         if (typeof value === 'object' || typeof value === 'function') {
-          builder.pushObject(value);
+          builder.pushObject(value as ObjectType);
         } else {
           // Taken from FormatJS: non-objects (strings, numbers, and falsy
           // values) all get cast to strings immediately as literal nodes.

package/src/formatters/ast.ts

@@ -25,16 +25,6 @@ export enum RichTextNodeType {
   Code = 'inlineCode',
   Link = 'link',
   Paragraph = 'paragraph',
-  /**
-   * A special extension for when the value of a placeholder is an object.
-   * Rather than casting to a string here, the object is preserved as-is for a
-   * future formatter to render as appropriate (i.e., using an object as a
-   * value when formatting to an AST should keep that object structure so that
-   * the final AST is accurate for what the user expects, but when rendering to
-   * a plain string, the final formatter can just cast that object to a string
-   * using its `toString` method or some other mechanism).
-   */
-  Object = 'object',
 }
 
 interface RichTextNodeBase<ContentType> {
@@ -61,10 +51,7 @@ interface RichTextParagraphNode extends RichTextNodeBase<RichTextNode[]> {
 }
 interface RichTextLinkNode extends RichTextNodeBase<RichTextNode[]> {
   type: RichTextNodeType.Link;
-  target: string;
-}
-interface RichTextObjectNode extends RichTextNodeBase<object> {
-  type: RichTextNodeType.Object;
+  target: object;
 }
 
 export type RichTextNode =
@@ -74,8 +61,7 @@ export type RichTextNode =
   | RichTextStrikethroughNode
   | RichTextCodeNode
   | RichTextParagraphNode
-  | RichTextLinkNode
-  | RichTextObjectNode;
+  | RichTextLinkNode;
 
 const AST_RICH_TEXT_ELEMENTS: RichTextFormattingMap<AstFunctionTypes['hook']> = {
   $b: (content) => ({ type: RichTextNodeType.Strong, content }),
@@ -84,7 +70,7 @@ const AST_RICH_TEXT_ELEMENTS: RichTextFormattingMap<AstFunctionTypes['hook']> =
   $code: (content) => ({ type: RichTextNodeType.Code, content }),
   $link: (content, _, [target]) => ({
     type: RichTextNodeType.Link,
-    target: target.content as string,
+    target,
     content,
   }),
   $p: (content) => ({ type: RichTextNodeType.Paragraph, content }),
@@ -114,8 +100,8 @@ class AstBuilder extends FormatBuilder<RichTextNode> {
     }
   }
 
-  pushObject(value: object) {
-    this.result.push({ type: RichTextNodeType.Object, content: value });
+  pushObject(value: RichTextNode) {
+    this.result.push(value);
   }
 
   finish(): RichTextNode[] {

package/src/formatters/react.ts

@@ -66,9 +66,7 @@ function createReactBuilder(richTextElements: RichTextFormattingMap<ReactFunctio
       }
     }
 
-    pushObject(value: object) {
-      // @ts-expect-error this is technically invalid, but we'll just assume that if a format
-      // returns an object, it'll be acting as some form of ReactNode.
+    pushObject(value: React.ReactNode) {
       this.result.push(value);
     }