add Id to the generated api.d.ts file when doing static type generation (#42050)

We don't currently define the `Id` type that we reference when doing static api.d.ts generation - leading to any ID in those types being treated as `any` (not validated on arguments or useful in return values).

GitOrigin-RevId: f5e18f583d3328e2e14229ae71c25b6561705a0d

Author: ianmacartney

npm-packages/common/config/rush/pnpm-lock.yaml

@@ -135,6 +135,7 @@ async function* codegenStaticApiObjects(
   analysis: EvaluatedComponentDefinition,
 ) {
   yield `import type { FunctionReference } from "convex/server";`;
+  yield `import type { GenericId as Id } from "convex/values";`;
 
   const apiTree = await buildApiTree(ctx, analysis.functions, {
     kind: "public",

npm-packages/convex/src/cli/codegen_templates/component_api.ts

@@ -261,7 +261,7 @@ async function* codegenTable(ctx: Context, table: TableDefinition) {
   for (const index of table.vectorIndexes ?? []) {
     yield `    "${index.indexDescriptor}": {`;
     yield `      vectorField: "${index.vectorField}",`;
-    yield `      dimensions: ${index.dimensions},`;
+    yield `      dimensions: number,`;
     yield `      filterFields: ${stringLiteralUnionType(index.filterFields)},`;
     yield `    },`;
   }
@@ -340,14 +340,19 @@ async function addSystemFieldsToObject(
 function* extractFieldPaths(validator: ConvexValidator): Generator<string[]> {
   if (validator.type === "object") {
     for (const [fieldName, fieldValidator] of Object.entries(validator.value)) {
+      yield [fieldName];
       for (const subFieldPath of extractFieldPaths(fieldValidator.fieldType)) {
-        yield [fieldName, ...subFieldPath];
+        if (subFieldPath.length > 0) {
+          yield [fieldName, ...subFieldPath];
+        }
       }
     }
   } else if (validator.type === "union") {
     for (const subValidator of validator.value) {
       yield* extractFieldPaths(subValidator);
     }
+  } else if (validator.type === "record") {
+    yield ["${string}"];
   } else {
     yield [];
   }
@@ -356,9 +361,9 @@ function* extractFieldPaths(validator: ConvexValidator): Generator<string[]> {
 function stringLiteralUnionType(fields: string[]) {
   if (fields.length === 0) {
     return "never";
-  } else if (fields.length === 1) {
-    return `"${fields[0]}"`;
   } else {
-    return fields.map((field) => `"${field}"`).join(" | ");
+    return fields
+      .map((field) => (field.includes("${") ? `\`${field}\`` : `"${field}"`))
+      .join(" | ");
   }
 }

npm-packages/convex/src/cli/codegen_templates/dataModel.ts

@@ -0,0 +1,6 @@
+{
+  "codegen": {
+    "staticApi": true,
+    "staticDataModel": true
+  }
+}

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

@@ -0,0 +1,82 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type { FunctionReference } from "convex/server";
+import type { GenericId as Id } from "convex/values";
+
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export declare const api: {
+  staticFunctions: {
+    q: FunctionReference<
+      "query",
+      "public",
+      { branded: string; id: Id<"empty"> },
+      { _creationTime: number; _id: Id<"empty"> } | string
+    >;
+    m: FunctionReference<
+      "mutation",
+      "public",
+      { branded: string; id: Id<"empty"> },
+      string
+    >;
+    a: FunctionReference<
+      "action",
+      "public",
+      { branded: string; id: Id<"empty"> },
+      string
+    >;
+  };
+};
+
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export declare const internal: {
+  staticFunctions: {
+    iq: FunctionReference<
+      "query",
+      "internal",
+      {
+        arr: Array<number>;
+        bool: boolean;
+        data: ArrayBuffer;
+        id: Id<"empty">;
+        literal: "literal";
+        null: null;
+        num: number;
+        str: string;
+      },
+      | string
+      | "literal"
+      | number
+      | boolean
+      | ArrayBuffer
+      | Array<number>
+      | null
+      | Id<"empty">
+    >;
+    im: FunctionReference<"mutation", "internal", { branded: string }, null>;
+    ia: FunctionReference<"action", "internal", {}, any>;
+  };
+};
+
+export declare const components: {};

npm-packages/private-demos/static-codegen/convex/_generated/api.d.ts

@@ -0,0 +1,23 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import { anyApi, componentsGeneric } from "convex/server";
+
+/**
+ * A utility for referencing Convex functions in your app's API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api = anyApi;
+export const internal = anyApi;
+export const components = componentsGeneric();