@formatjs/ts-transformer 4.0.6 → 4.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formatjs/ts-transformer",
   "description": "TS Compiler transformer for formatjs",
-  "version": "4.0.6",
+  "version": "4.1.0",
   "license": "MIT",
   "author": "Long Ho <holevietlong@gmail.com>",
   "type": "module",
@@ -12,7 +12,7 @@
     "json-stable-stringify": "^1.3.0",
     "tslib": "^2.8.0",
     "typescript": "^5.6.0",
-    "@formatjs/icu-messageformat-parser": "3.1.1"
+    "@formatjs/icu-messageformat-parser": "3.2.1"
   },
   "devDependencies": {
     "ts-jest": "^29"

package/src/transform.d.ts

@@ -71,6 +71,10 @@ export interface Opts {
      * Whether to preserve whitespace and newlines.
      */
     preserveWhitespace?: boolean;
+    /**
+     * Whether to hoist selectors & flatten sentences
+     */
+    flatten?: boolean;
 }
 export declare function transformWithTs(ts: TypeScript, opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
 export declare function transform(opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;

package/src/transform.js

@@ -1,4 +1,6 @@
 import { parse } from '@formatjs/icu-messageformat-parser';
+import { hoistSelectors } from '@formatjs/icu-messageformat-parser/manipulator.js';
+import { printAST } from '@formatjs/icu-messageformat-parser/printer.js';
 import * as stringifyNs from 'json-stable-stringify';
 import * as typescript from 'typescript';
 import { debug } from './console_utils.js';
@@ -117,7 +119,7 @@ function evaluateStringConcat(ts, node) {
     }
     return ['', false];
 }
-function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocation, preserveWhitespace }, sf) {
+function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocation, preserveWhitespace, flatten }, sf) {
     let properties = undefined;
     if (ts.isObjectLiteralExpression(node)) {
         properties = node.properties;
@@ -164,7 +166,15 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
                 }
             }
             // {id: dedent`id`}
+            // GH #5069: Only check for substitutions on message-related props
             else if (ts.isTaggedTemplateExpression(initializer)) {
+                const isMessageProp = name.text === 'id' ||
+                    name.text === 'defaultMessage' ||
+                    name.text === 'description';
+                if (!isMessageProp) {
+                    // Skip non-message props (like tagName, values, etc.)
+                    return;
+                }
                 const { template } = initializer;
                 if (!ts.isNoSubstitutionTemplateLiteral(template)) {
                     throw new Error('Tagged template expression must be no substitution');
@@ -217,7 +227,15 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
                     }
                 }
                 // <FormattedMessage foo={dedent`dedent Hello World!`} />
+                // GH #5069: Only check for substitutions on message-related props
                 else if (ts.isTaggedTemplateExpression(initializer.expression)) {
+                    const isMessageProp = name.text === 'id' ||
+                        name.text === 'defaultMessage' ||
+                        name.text === 'description';
+                    if (!isMessageProp) {
+                        // Skip non-message props (like tagName, values, etc.)
+                        return;
+                    }
                     const { expression: { template }, } = initializer;
                     if (!ts.isNoSubstitutionTemplateLiteral(template)) {
                         throw new Error('Tagged template expression must be no substitution');
@@ -251,6 +269,16 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
                                 break;
                         }
                     }
+                    else if (MESSAGE_DESC_KEYS.includes(name.text) &&
+                        name.text !== 'description') {
+                        // Non-static expression for defaultMessage or id
+                        throw new Error(`[FormatJS] \`${name.text}\` must be a string literal or statically evaluable expression to be extracted.`);
+                    }
+                }
+                // Non-static JSX expression for defaultMessage or id
+                else if (MESSAGE_DESC_KEYS.includes(name.text) &&
+                    name.text !== 'description') {
+                    throw new Error(`[FormatJS] \`${name.text}\` must be a string literal to be extracted.`);
                 }
             }
             // {defaultMessage: 'asd' + bar'}
@@ -269,12 +297,22 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
                             break;
                     }
                 }
+                else if (MESSAGE_DESC_KEYS.includes(name.text) &&
+                    name.text !== 'description') {
+                    // Non-static expression for defaultMessage or id
+                    throw new Error(`[FormatJS] \`${name.text}\` must be a string literal or statically evaluable expression to be extracted.`);
+                }
             }
             // description: {custom: 1}
             else if (ts.isObjectLiteralExpression(initializer) &&
                 name.text === 'description') {
                 msg.description = objectLiteralExpressionToObj(ts, initializer);
             }
+            // Non-static value for defaultMessage or id
+            else if (MESSAGE_DESC_KEYS.includes(name.text) &&
+                name.text !== 'description') {
+                throw new Error(`[FormatJS] \`${name.text}\` must be a string literal to be extracted.`);
+            }
         }
     });
     // We extracted nothing
@@ -284,6 +322,17 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
     if (msg.defaultMessage && !preserveWhitespace) {
         msg.defaultMessage = msg.defaultMessage.trim().replace(/\s+/gm, ' ');
     }
+    // GH #3537: Apply flatten transformation before calling overrideIdFn
+    // so that the ID generation sees the same message format as the final output
+    if (flatten && msg.defaultMessage) {
+        try {
+            msg.defaultMessage = printAST(hoistSelectors(parse(msg.defaultMessage)));
+        }
+        catch (e) {
+            // If flatten fails, continue with original message
+            // The error will be caught again during validation
+        }
+    }
     if (msg.defaultMessage && overrideIdFn) {
         switch (typeof overrideIdFn) {
             case 'string':
@@ -328,6 +377,15 @@ function isMemberMethodFormatMessageCall(ts, node, additionalFunctionNames) {
     if (ts.isPropertyAccessExpression(method)) {
         return fnNames.has(method.name.text);
     }
+    // GH #4471: Handle foo.formatMessage<T>?.() - when both generics and optional chaining are used
+    // TypeScript represents this as ExpressionWithTypeArguments containing a PropertyAccessExpression
+    if (ts.isExpressionWithTypeArguments &&
+        ts.isExpressionWithTypeArguments(method)) {
+        const expr = method.expression;
+        if (ts.isPropertyAccessExpression(expr)) {
+            return fnNames.has(expr.name.text);
+        }
+    }
     // Handle formatMessage()
     return ts.isIdentifier(method) && fnNames.has(method.text);
 }