Actions and queries accept both styles for args and returns (#27726)

Allow both styles of validator syntax (`v.whatever()` and `{ a: v.whatever() }`) in queries and actions, as well as mutations where both styles already worked for both `args` and `returns`.

GitOrigin-RevId: 37677c68709d1223bea1867e78a9c40c645b1f46

Author: thomasballinger

npm-packages/convex/src/server/registration.test.ts

@@ -2,9 +2,13 @@ import { test, describe, expect } from "vitest";
 import { assert, Equals } from "../test/type_testing.js";
 import { v } from "../values/validator.js";
 import {
+  ActionBuilder,
   ApiFromModules,
   DefaultFunctionArgs,
+  QueryBuilder,
+  actionGeneric,
   mutationGeneric,
+  queryGeneric,
 } from "./index.js";
 import { EmptyObject, MutationBuilder } from "./registration.js";
 
@@ -276,8 +280,10 @@ describe("argument inference", () => {
 });
 
 describe("argument and return value validators can be objects or validators", () => {
-  // Test with mutation, but all the wrappers work the same way.
+  // Test with mutation, we aim for all the wrappers work the same way.
   const mutation: MutationBuilder<any, "public"> = mutationGeneric;
+  const query: QueryBuilder<any, "public"> = queryGeneric;
+  const action: ActionBuilder<any, "public"> = actionGeneric;
 
   const module = {
     configArgsObject: mutation({
@@ -314,6 +320,27 @@ describe("argument and return value validators can be objects or validators", ()
         return { arg: "result" };
       },
     }),
+
+    // test queries and actions just a bit too
+    q1: query({
+      args: v.object({
+        arg: v.string(),
+      }),
+      returns: { arg: v.string() },
+      handler: (_, { arg }) => {
+        return { arg: arg };
+      },
+    }),
+
+    a1: action({
+      args: v.object({
+        arg: v.string(),
+      }),
+      returns: { arg: v.string() },
+      handler: (_, { arg }) => {
+        return { arg: arg };
+      },
+    }),
   };
   type API = ApiFromModules<{ module: typeof module }>;
 
@@ -372,4 +399,20 @@ describe("argument and return value validators can be objects or validators", ()
     const returnString = module.configOutputValidator.exportReturns();
     expect(JSON.parse(returnString)).toEqual(expectedReturnsExport);
   });
+
+  test("queries", () => {
+    type ReturnType = API["module"]["q1"]["_returnType"];
+    type Expected = { arg: string };
+    assert<Equals<ReturnType, Expected>>;
+    const returnString = module.configOutputValidator.exportReturns();
+    expect(JSON.parse(returnString)).toEqual(expectedReturnsExport);
+  });
+
+  test("actions", () => {
+    type ReturnType = API["module"]["configOutputValidator"]["_returnType"];
+    type Expected = { arg: string };
+    assert<Equals<ReturnType, Expected>>;
+    const returnString = module.configOutputValidator.exportReturns();
+    expect(JSON.parse(returnString)).toEqual(expectedReturnsExport);
+  });
 });

npm-packages/convex/src/server/registration.ts

@@ -643,8 +643,11 @@ export type QueryBuilder<
   Visibility extends FunctionVisibility,
 > = {
   <
-    ArgsValidator extends PropertyValidators | void,
-    ReturnsValidator extends Validator<any, any, any> | void,
+    ArgsValidator extends PropertyValidators | Validator<any, any, any> | void,
+    ReturnsValidator extends
+      | PropertyValidators
+      | Validator<any, any, any>
+      | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
     OneOrZeroArgs extends
       ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,
@@ -726,8 +729,11 @@ export type ActionBuilder<
   Visibility extends FunctionVisibility,
 > = {
   <
-    ArgsValidator extends PropertyValidators | void,
-    ReturnsValidator extends Validator<any, any, any> | void,
+    ArgsValidator extends PropertyValidators | Validator<any, any, any> | void,
+    ReturnsValidator extends
+      | PropertyValidators
+      | Validator<any, any, any>
+      | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
     OneOrZeroArgs extends
       ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,