Change legacyJavaScriptFileType: true to fileType: "js/dts" in convex.json (#42889)

GitOrigin-RevId: 53c5e48d40b881c42afebcfd9eb2a188be40956e

Author: thomasballinger

npm-packages/convex/schemas/convex.schema.json

@@ -54,10 +54,11 @@
       "type": "object",
       "description": "Configuration for Convex code generation.",
       "properties": {
-        "legacyJavaScriptFileType": {
-          "type": "boolean",
-          "description": "When true (or omitted, default is true), generates separate .js and .d.ts files for the Convex API. When false generates combined .ts files instead. The .ts format is more modern and recommended for TypeScript projects.\n\nNote: This option must be true when using generateCommonJSApi.",
-          "default": true
+        "fileType": {
+          "type": "string",
+          "enum": ["ts", "js/dts"],
+          "description": "The file format of generated code. \"ts\" generates combined .ts files (recommended for TypeScript projects), \"js/dts\" generates separate .js and .d.ts files.\n\nNote: \"js/dts\" must be used when using generateCommonJSApi.",
+          "default": "js/dts"
         },
         "legacyComponentApi": {
           "type": "boolean",

npm-packages/convex/src/cli/lib/config.ts

@@ -77,7 +77,7 @@ export interface ProjectConfig {
     staticApi: boolean;
     staticDataModel: boolean;
     legacyComponentApi?: boolean;
-    legacyJavaScriptFileType?: boolean;
+    fileType?: "ts" | "js/dts";
   };
 }
 
@@ -102,7 +102,7 @@ const DEFAULT_FUNCTIONS_PATH = "convex/";
 
 /** Whether .ts file extensions should be used for generated code (default is false). */
 export function usesTypeScriptCodegen(projectConfig: ProjectConfig): boolean {
-  return projectConfig.codegen.legacyJavaScriptFileType === false;
+  return projectConfig.codegen.fileType === "ts";
 }
 
 /** Whether the new component API import style should be used (default is false) */
@@ -215,29 +215,27 @@ export async function parseProjectConfig(
   }
 
   if (
-    typeof obj.codegen.legacyJavaScriptFileType !== "undefined" &&
-    typeof obj.codegen.legacyJavaScriptFileType !== "boolean"
+    typeof obj.codegen.fileType !== "undefined" &&
+    obj.codegen.fileType !== "ts" &&
+    obj.codegen.fileType !== "js/dts"
   ) {
     return await ctx.crash({
       exitCode: 1,
       errorType: "invalid filesystem data",
       printedMessage:
-        "Expected `codegen.legacyJavaScriptFileType` in `convex.json` to be true or false",
+        'Expected `codegen.fileType` in `convex.json` to be "ts" or "js/dts"',
     });
   }
 
-  // Validate that generateCommonJSApi is not true when legacyJavaScriptFileType is false
-  if (
-    obj.generateCommonJSApi &&
-    obj.codegen.legacyJavaScriptFileType === false
-  ) {
+  // Validate that generateCommonJSApi is not true when using TypeScript codegen
+  if (obj.generateCommonJSApi && obj.codegen.fileType === "ts") {
     return await ctx.crash({
       exitCode: 1,
       errorType: "invalid filesystem data",
       printedMessage:
-        "Cannot use `generateCommonJSApi: true` with `codegen.legacyJavaScriptFileType: false`. " +
+        'Cannot use `generateCommonJSApi: true` with `codegen.fileType: "ts"`. ' +
         "CommonJS modules require JavaScript generation. " +
-        "Either set `codegen.legacyJavaScriptFileType: true` or remove `generateCommonJSApi`.",
+        'Either set `codegen.fileType: "js/dts"` or remove `generateCommonJSApi`.',
     });
   }
 
@@ -676,8 +674,11 @@ function stripDefaults(projectConfig: ProjectConfig): any {
   if (stripped.codegen.staticDataModel === false) {
     delete stripped.codegen.staticDataModel;
   }
-  // legacyJavaScriptFileType and legacyComponentApi are optional and undefined by default,
-  // so they'll only be present if explicitly set - we don't need to strip them
+
+  // `"fileType"` and `"legacyComponentApi"` are optional and undefined by
+  // default, and the behavior of undefined may change in the future for these
+  // so we don't want to strip them.
+
   if (Object.keys(stripped.codegen).length === 0) {
     delete stripped.codegen;
   }

npm-packages/private-demos/actions/convex.json

@@ -4,6 +4,6 @@
     "externalPackages": ["*"]
   },
   "codegen": {
-    "legacyJavaScriptFileType": false
+    "fileType": "ts"
   }
 }

npm-packages/private-demos/components-api-import-ts/convex.json

@@ -2,6 +2,6 @@
   "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "legacyComponentApi": false,
-    "legacyJavaScriptFileType": false
+    "fileType": "ts"
   }
 }

npm-packages/private-demos/components-api-import/convex.json

@@ -2,6 +2,6 @@
   "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "legacyComponentApi": false,
-    "legacyJavaScriptFileType": true
+    "fileType": "js/dts"
   }
 }

npm-packages/private-demos/components-legacy-ts/convex.json

@@ -2,6 +2,6 @@
   "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "legacyComponentApi": true,
-    "legacyJavaScriptFileType": false
+    "fileType": "ts"
   }
 }

npm-packages/private-demos/components-legacy/convex.json

@@ -1,7 +1,7 @@
 {
   "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
-    "legacyJavaScriptFileType": true,
+    "fileType": "js/dts",
     "legacyComponentApi": true
   }
 }

npm-packages/private-demos/components-ts-alias/convex.json

@@ -2,6 +2,6 @@
   "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "legacyComponentApi": false,
-    "legacyJavaScriptFileType": false
+    "fileType": "ts"
   }
 }

npm-packages/private-demos/static-codegen-ts/convex.json

@@ -3,6 +3,6 @@
   "codegen": {
     "staticApi": true,
     "staticDataModel": true,
-    "legacyJavaScriptFileType": false
+    "fileType": "ts"
   }
 }