Ian/use convex json schema (#42792)

ianmacartney · Convex, Inc. · commit eb9d2267bff0 · 2025-11-06T19:57:05.000Z
- reference the schema format so it's harder to make mistakes in the future
- update codegen to exercise the ComponentApi path

GitOrigin-RevId: 77e9c931326751d4498174b03bf0939b160c0f14
diff --git a/npm-packages/private-demos/actions/convex.json b/npm-packages/private-demos/actions/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "node": {
     "externalPackages": ["*"]
   },
diff --git a/npm-packages/private-demos/cjs-typescript/convex.json b/npm-packages/private-demos/cjs-typescript/convex.json
@@ -1,3 +1,4 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "generateCommonJSApi": true
 }
diff --git a/npm-packages/private-demos/components-api-import-ts/convex.json b/npm-packages/private-demos/components-api-import-ts/convex.json
@@ -1,6 +1,7 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
-    "useComponentApiImports": true,
+    "legacyComponentApi": false,
     "legacyJavaScriptFileType": false
   }
 }
diff --git a/npm-packages/private-demos/components-api-import-ts/convex/_generated/api.ts b/npm-packages/private-demos/components-api-import-ts/convex/_generated/api.ts
@@ -48,118 +48,6 @@ export const internal: FilterApi<
 > = anyApi as any;
 
 export const components = componentsGeneric() as unknown as {
-  waitlist: {
-    actionDemo: {
-      demo: FunctionReference<"action", "internal", any, any>;
-    };
-    index: {
-      fileDownloadUrl: FunctionReference<
-        "query",
-        "internal",
-        { id: string },
-        string
-      >;
-      fileUploadUrl: FunctionReference<"mutation", "internal", {}, string>;
-      getMessageCount: FunctionReference<"query", "internal", {}, number>;
-      latestWrite: FunctionReference<"query", "internal", {}, string>;
-      listFiles: FunctionReference<"query", "internal", any, any>;
-      readFromFile: FunctionReference<
-        "action",
-        "internal",
-        { id: string },
-        string
-      >;
-      repeatMessage: FunctionReference<
-        "action",
-        "internal",
-        { message: string; n: number },
-        string
-      >;
-      sayGoodbyeFromQuery: FunctionReference<"query", "internal", {}, string>;
-      sayHelloFromMutation: FunctionReference<
-        "mutation",
-        "internal",
-        {},
-        string
-      >;
-      scheduleMessage: FunctionReference<"mutation", "internal", {}, any>;
-      scheduleSend: FunctionReference<"mutation", "internal", {}, any>;
-      sendMessage: FunctionReference<"mutation", "internal", {}, any>;
-      storeInFile: FunctionReference<
-        "action",
-        "internal",
-        { message: string },
-        string
-      >;
-      writeSuccessfully: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-      writeThenFail: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-    };
-  };
-  waitlist2: {
-    actionDemo: {
-      demo: FunctionReference<"action", "internal", any, any>;
-    };
-    index: {
-      fileDownloadUrl: FunctionReference<
-        "query",
-        "internal",
-        { id: string },
-        string
-      >;
-      fileUploadUrl: FunctionReference<"mutation", "internal", {}, string>;
-      getMessageCount: FunctionReference<"query", "internal", {}, number>;
-      latestWrite: FunctionReference<"query", "internal", {}, string>;
-      listFiles: FunctionReference<"query", "internal", any, any>;
-      readFromFile: FunctionReference<
-        "action",
-        "internal",
-        { id: string },
-        string
-      >;
-      repeatMessage: FunctionReference<
-        "action",
-        "internal",
-        { message: string; n: number },
-        string
-      >;
-      sayGoodbyeFromQuery: FunctionReference<"query", "internal", {}, string>;
-      sayHelloFromMutation: FunctionReference<
-        "mutation",
-        "internal",
-        {},
-        string
-      >;
-      scheduleMessage: FunctionReference<"mutation", "internal", {}, any>;
-      scheduleSend: FunctionReference<"mutation", "internal", {}, any>;
-      sendMessage: FunctionReference<"mutation", "internal", {}, any>;
-      storeInFile: FunctionReference<
-        "action",
-        "internal",
-        { message: string },
-        string
-      >;
-      writeSuccessfully: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-      writeThenFail: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-    };
-  };
+  waitlist: import("../../examples/waitlist@name-with-dashes/_generated/component.js").ComponentApi<"waitlist">;
+  waitlist2: import("../../examples/waitlist@name-with-dashes/_generated/component.js").ComponentApi<"waitlist2">;
 };
diff --git a/npm-packages/private-demos/components-api-import-ts/examples/waitlist@name-with-dashes/_generated/api.ts b/npm-packages/private-demos/components-api-import-ts/examples/waitlist@name-with-dashes/_generated/api.ts
@@ -50,38 +50,5 @@ export const internal: FilterApi<
 > = anyApi as any;
 
 export const components = componentsGeneric() as unknown as {
-  ratelimiter: {
-    index: {
-      checkRateLimit: FunctionReference<
-        "query",
-        "internal",
-        {
-          count?: number;
-          key?: string;
-          name: string;
-          reserve?: boolean;
-          throws?: boolean;
-        },
-        { ok: boolean; retryAt?: number; ts?: number; value?: number }
-      >;
-      rateLimit: FunctionReference<
-        "mutation",
-        "internal",
-        {
-          count?: number;
-          key?: string;
-          name: string;
-          reserve?: boolean;
-          throws?: boolean;
-        },
-        { ok: boolean; retryAt?: number }
-      >;
-      resetRateLimit: FunctionReference<
-        "mutation",
-        "internal",
-        { key?: string; name: string },
-        any
-      >;
-    };
-  };
+  ratelimiter: import("@convex-dev/ratelimiter/_generated/component.js").ComponentApi<"ratelimiter">;
 };
diff --git a/npm-packages/private-demos/components-api-import/convex.json b/npm-packages/private-demos/components-api-import/convex.json
@@ -1,6 +1,7 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
-    "legacyJavaScriptFileType": true,
-    "useComponentApiImports": true
+    "legacyComponentApi": false,
+    "legacyJavaScriptFileType": true
   }
 }
diff --git a/npm-packages/private-demos/components-api-import/convex/_generated/api.d.ts b/npm-packages/private-demos/components-api-import/convex/_generated/api.d.ts
@@ -47,118 +47,6 @@ export declare const internal: FilterApi<
 >;
 
 export declare const components: {
-  waitlist: {
-    actionDemo: {
-      demo: FunctionReference<"action", "internal", any, any>;
-    };
-    index: {
-      fileDownloadUrl: FunctionReference<
-        "query",
-        "internal",
-        { id: string },
-        string
-      >;
-      fileUploadUrl: FunctionReference<"mutation", "internal", {}, string>;
-      getMessageCount: FunctionReference<"query", "internal", {}, number>;
-      latestWrite: FunctionReference<"query", "internal", {}, string>;
-      listFiles: FunctionReference<"query", "internal", any, any>;
-      readFromFile: FunctionReference<
-        "action",
-        "internal",
-        { id: string },
-        string
-      >;
-      repeatMessage: FunctionReference<
-        "action",
-        "internal",
-        { message: string; n: number },
-        string
-      >;
-      sayGoodbyeFromQuery: FunctionReference<"query", "internal", {}, string>;
-      sayHelloFromMutation: FunctionReference<
-        "mutation",
-        "internal",
-        {},
-        string
-      >;
-      scheduleMessage: FunctionReference<"mutation", "internal", {}, any>;
-      scheduleSend: FunctionReference<"mutation", "internal", {}, any>;
-      sendMessage: FunctionReference<"mutation", "internal", {}, any>;
-      storeInFile: FunctionReference<
-        "action",
-        "internal",
-        { message: string },
-        string
-      >;
-      writeSuccessfully: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-      writeThenFail: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-    };
-  };
-  waitlist2: {
-    actionDemo: {
-      demo: FunctionReference<"action", "internal", any, any>;
-    };
-    index: {
-      fileDownloadUrl: FunctionReference<
-        "query",
-        "internal",
-        { id: string },
-        string
-      >;
-      fileUploadUrl: FunctionReference<"mutation", "internal", {}, string>;
-      getMessageCount: FunctionReference<"query", "internal", {}, number>;
-      latestWrite: FunctionReference<"query", "internal", {}, string>;
-      listFiles: FunctionReference<"query", "internal", any, any>;
-      readFromFile: FunctionReference<
-        "action",
-        "internal",
-        { id: string },
-        string
-      >;
-      repeatMessage: FunctionReference<
-        "action",
-        "internal",
-        { message: string; n: number },
-        string
-      >;
-      sayGoodbyeFromQuery: FunctionReference<"query", "internal", {}, string>;
-      sayHelloFromMutation: FunctionReference<
-        "mutation",
-        "internal",
-        {},
-        string
-      >;
-      scheduleMessage: FunctionReference<"mutation", "internal", {}, any>;
-      scheduleSend: FunctionReference<"mutation", "internal", {}, any>;
-      sendMessage: FunctionReference<"mutation", "internal", {}, any>;
-      storeInFile: FunctionReference<
-        "action",
-        "internal",
-        { message: string },
-        string
-      >;
-      writeSuccessfully: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-      writeThenFail: FunctionReference<
-        "mutation",
-        "internal",
-        { text: string },
-        any
-      >;
-    };
-  };
+  waitlist: import("../../examples/waitlist@name-with-dashes/_generated/component.js").ComponentApi<"waitlist">;
+  waitlist2: import("../../examples/waitlist@name-with-dashes/_generated/component.js").ComponentApi<"waitlist2">;
 };
diff --git a/npm-packages/private-demos/components-api-import/examples/waitlist@name-with-dashes/_generated/api.ts b/npm-packages/private-demos/components-api-import/examples/waitlist@name-with-dashes/_generated/api.ts
@@ -50,38 +50,5 @@ export const internal: FilterApi<
 > = anyApi as any;
 
 export const components = componentsGeneric() as unknown as {
-  ratelimiter: {
-    index: {
-      checkRateLimit: FunctionReference<
-        "query",
-        "internal",
-        {
-          count?: number;
-          key?: string;
-          name: string;
-          reserve?: boolean;
-          throws?: boolean;
-        },
-        { ok: boolean; retryAt?: number; ts?: number; value?: number }
-      >;
-      rateLimit: FunctionReference<
-        "mutation",
-        "internal",
-        {
-          count?: number;
-          key?: string;
-          name: string;
-          reserve?: boolean;
-          throws?: boolean;
-        },
-        { ok: boolean; retryAt?: number }
-      >;
-      resetRateLimit: FunctionReference<
-        "mutation",
-        "internal",
-        { key?: string; name: string },
-        any
-      >;
-    };
-  };
+  ratelimiter: import("@convex-dev/ratelimiter/_generated/component.js").ComponentApi<"ratelimiter">;
 };
diff --git a/npm-packages/private-demos/components-legacy-ts/convex.json b/npm-packages/private-demos/components-legacy-ts/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "legacyComponentApi": true,
     "legacyJavaScriptFileType": false
diff --git a/npm-packages/private-demos/components-legacy/convex.json b/npm-packages/private-demos/components-legacy/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "legacyJavaScriptFileType": true,
     "legacyComponentApi": true
diff --git a/npm-packages/private-demos/npm-showcase/convex.json b/npm-packages/private-demos/npm-showcase/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "node": {
     "externalPackages": ["*"]
   }
diff --git a/npm-packages/private-demos/quickstarts/nodejs/convex.json b/npm-packages/private-demos/quickstarts/nodejs/convex.json
@@ -1,3 +1,4 @@
 {
+  "$schema": "../../../convex/schemas/convex.schema.json",
   "generateCommonJSApi": true
 }
diff --git a/npm-packages/private-demos/quickstarts/sveltekit/convex.json b/npm-packages/private-demos/quickstarts/sveltekit/convex.json
@@ -1,3 +1,4 @@
 {
+	"$schema": "../../../convex/schemas/convex.schema.json",
 	"functions": "src/convex/"
 }
diff --git a/npm-packages/private-demos/snippets/convex.json b/npm-packages/private-demos/snippets/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "node": {
     "externalPackages": ["*"]
   }
diff --git a/npm-packages/private-demos/static-codegen-ts/convex.json b/npm-packages/private-demos/static-codegen-ts/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "staticApi": true,
     "staticDataModel": true,
diff --git a/npm-packages/private-demos/static-codegen/convex.json b/npm-packages/private-demos/static-codegen/convex.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../../convex/schemas/convex.schema.json",
   "codegen": {
     "staticApi": true,
     "staticDataModel": true

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "$schema": "../../convex/schemas/convex.schema.json",`
`2`	`3`	`"node": {`
`3`	`4`	`"externalPackages": ["*"]`
`4`	`5`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`{`
	`2`	`+ "$schema": "../../convex/schemas/convex.schema.json",`
`2`	`3`	`"generateCommonJSApi": true`
`3`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
	`2`	`+ "$schema": "../../convex/schemas/convex.schema.json",`
`2`	`3`	`"codegen": {`
`3`		`- "useComponentApiImports": true,`
	`4`	`+ "legacyComponentApi": false,`
`4`	`5`	`"legacyJavaScriptFileType": false`
`5`	`6`	`}`
`6`	`7`	`}`