Generate a Mounts type in component codegen (#29609)

Generate a Mounts type in component codegen

GitOrigin-RevId: 1009bd46515be96a8dfedc09e02c49c779923e3f

Author: thomasballinger

npm-packages/component-tests/component/_generated/api.d.ts

@@ -28,7 +28,7 @@ import type {
 declare const fullApi: ApiFromModules<{
   messages: typeof messages;
 }>;
-declare const fullApiWithMounts: typeof fullApi & {
+export type Mounts = {
   messages: {
     dateNow: FunctionReference<"query", "public", {}, any>;
     hello: FunctionReference<"action", "public", {}, any>;
@@ -43,6 +43,10 @@ declare const fullApiWithMounts: typeof fullApi & {
     tryToPaginate: FunctionReference<"query", "public", {}, any>;
   };
 };
+// For now fullApiWithMounts is only fullApi which provides
+// jump-to-definition in component client code.
+// Use Mounts for the same type without the inference.
+declare const fullApiWithMounts: typeof fullApi;
 
 export declare const api: FilterApi<
   typeof fullApiWithMounts,

npm-packages/component-tests/envVars/_generated/api.d.ts

@@ -28,7 +28,7 @@ import type {
 declare const fullApi: ApiFromModules<{
   messages: typeof messages;
 }>;
-declare const fullApiWithMounts: typeof fullApi & {
+export type Mounts = {
   messages: {
     envVarAction: FunctionReference<"action", "public", any, any>;
     envVarQuery: FunctionReference<"query", "public", any, any>;
@@ -37,6 +37,10 @@ declare const fullApiWithMounts: typeof fullApi & {
     systemEnvVarQuery: FunctionReference<"query", "public", any, any>;
   };
 };
+// For now fullApiWithMounts is only fullApi which provides
+// jump-to-definition in component client code.
+// Use Mounts for the same type without the inference.
+declare const fullApiWithMounts: typeof fullApi;
 
 export declare const api: FilterApi<
   typeof fullApiWithMounts,

npm-packages/component-tests/errors/_generated/api.d.ts

@@ -28,12 +28,16 @@ import type {
 declare const fullApi: ApiFromModules<{
   throwSystemError: typeof throwSystemError;
 }>;
-declare const fullApiWithMounts: typeof fullApi & {
+export type Mounts = {
   throwSystemError: {
     fromAction: FunctionReference<"action", "public", any, any>;
     fromQuery: FunctionReference<"query", "public", any, any>;
   };
 };
+// For now fullApiWithMounts is only fullApi which provides
+// jump-to-definition in component client code.
+// Use Mounts for the same type without the inference.
+declare const fullApiWithMounts: typeof fullApi;
 
 export declare const api: FilterApi<
   typeof fullApiWithMounts,

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

@@ -123,13 +123,17 @@ async function* codegenApiWithMounts(
   definitionPath: ComponentDefinitionPath,
 ): AsyncGenerator<string> {
   const mountTree = await buildMountTree(ctx, startPush, definitionPath, []);
-  if (!mountTree) {
+  if (mountTree) {
+    yield "export type Mounts = ";
+    yield* codegenMountTree(mountTree);
+    yield `;`;
+    yield `// For now fullApiWithMounts is only fullApi which provides`;
+    yield `// jump-to-definition in component client code.`;
+    yield `// Use Mounts for the same type without the inference.`;
+    yield "declare const fullApiWithMounts: typeof fullApi;";
+  } else {
     yield "declare const fullApiWithMounts: typeof fullApi;";
-    return;
   }
-  yield "declare const fullApiWithMounts: typeof fullApi &";
-  yield* codegenMountTree(mountTree);
-  yield `;`;
 }
 
 function* codegenMountTree(tree: MountTree): Generator<string> {