Commit 849401f

committed

fix customCtx args type

1 parent 79501fe commit 849401fCopy full SHA for 849401f

File tree

2 files changed

+42

-10

lines changed

packages/convex-helpers/server
- customFunctions.ts
- zod.test.ts

2 files changed

+42

-10

lines changed

`‎packages/convex-helpers/server/customFunctions.ts‎`

Lines changed: 14 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -76,10 +76,15 @@ import { omit, pick } from "../index.js";`
`76`	`76`	`* has access to resources created during input processing via closure.`
`77`	`77`	`*/`
`78`	`78`	`export type Customization<`
	`79`	`+ // The ctx object from the original function.`
`79`	`80`	`Ctx extends Record<string, any>,`
	`81`	`+ // The validators for the args the customization function consumes.`
`80`	`82`	`CustomArgsValidator extends PropertyValidators,`
	`83`	`+ // The ctx object produced: a patch applied to the original ctx.`
`81`	`84`	`CustomCtx extends Record<string, any>,`
	`85`	`+ // The args produced by the customization function.`
`82`	`86`	`CustomMadeArgs extends Record<string, any>,`
	`87`	`+ // Extra args that are passed to the input function.`
`83`	`88`	`ExtraArgs extends Record<string, any> = Record<string, any>,`
`84`	`89`	`> = {`
`85`	`90`	`args: CustomArgsValidator;`
`@@ -155,31 +160,30 @@ export function customCtxAndArgs<`
`155`	`160`	`CustomMadeArgs,`
`156`	`161`	`ExtraArgs`
`157`	`162`	`> {`
	`163`	`+ // This is already the right type. This function just helps you define it.`
`158`	`164`	`return objectWithArgsAndInput;`
`159`	`165`	`}`
`160`	`166`
`161`	`167`	`/**`
`162`	`168`	`* A helper for defining a Customization when your mod doesn't need to add or remove`
`163`	`169`	`* anything from args.`
`164`		`- * @param mod A function that defines how to modify the ctx.`
	`170`	`+ * @param modifyCtx A function that defines how to modify the ctx.`
`165`	`171`	`* @returns A ctx delta to be applied to the original ctx.`
`166`	`172`	`*/`
`167`	`173`	`export function customCtx<`
`168`	`174`	`InCtx extends Record<string, any>,`
`169`	`175`	`OutCtx extends Record<string, any>,`
`170`	`176`	`ExtraArgs extends Record<string, any> = Record<string, any>,`
`171`	`177`	`>(`
`172`		`- mod: (original: InCtx, extra: ExtraArgs) => Promise<OutCtx> \| OutCtx,`
`173`		`-): Customization<`
`174`		`- InCtx,`
`175`		`- Record<string, never>,`
`176`		`- OutCtx,`
`177`		`- Record<string, never>,`
`178`		`- ExtraArgs`
`179`		`-> {`
	`178`	`+ modifyCtx: (original: InCtx, extra: ExtraArgs) => Promise<OutCtx> \| OutCtx,`
	`179`	`+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type`
	`180`	`+): Customization<InCtx, {}, OutCtx, object, ExtraArgs> {`
`180`	`181`	`return {`
`181`	`182`	`args: {},`
`182`		`- input: async (ctx, _, extra) => ({ ctx: await mod(ctx, extra), args: {} }),`
	`183`	`+ input: async (ctx, _, extra) => ({`
	`184`	`+ ctx: await modifyCtx(ctx, extra),`
	`185`	`+ args: {},`
	`186`	`+ }),`
`183`	`187`	`};`
`184`	`188`	`}`
`185`	`189`

`‎packages/convex-helpers/server/zod.test.ts‎`

Lines changed: 28 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import type {`
`4`	`4`	`ApiFromModules,`
`5`	`5`	`RegisteredQuery,`
`6`	`6`	`DefaultFunctionArgs,`
	`7`	`+ FunctionReference,`
`7`	`8`	`} from "convex/server";`
`8`	`9`	`import { defineTable, defineSchema, queryGeneric, anyApi } from "convex/server";`
`9`	`10`	`import type { Equals } from "../index.js";`
`@@ -361,6 +362,7 @@ const testApi: ApiFromModules<{`
`361`	`362`	`addC: typeof addC;`
`362`	`363`	`addCU: typeof addCU;`
`363`	`364`	`addCU2: typeof addCU2;`
	`365`	`+ addCtxWithExistingArg: typeof addCtxWithExistingArg;`
`364`	`366`	`add: typeof add;`
`365`	`367`	`addUnverified: typeof addUnverified;`
`366`	`368`	`addUnverified2: typeof addUnverified2;`
`@@ -644,6 +646,32 @@ describe("zod functions", () => {`
`644`	`646`	`});`
`645`	`647`	`});`
`646`	`648`
	`649`	`+ test("add ctx with existing arg", async () => {`
	`650`	`+ const t = convexTest(schema, modules);`
	`651`	`+ expect(`
	`652`	`+ await t.query(testApi.addCtxWithExistingArg, { b: "foo" }),`
	`653`	`+ ).toMatchObject({`
	`654`	`+ ctxA: "hi",`
	`655`	`+ argB: "foo",`
	`656`	`+ });`
	`657`	`+ expectTypeOf(testApi.addCtxWithExistingArg).toExtend<`
	`658`	`+ FunctionReference<`
	`659`	`+ "query",`
	`660`	`+ "public",`
	`661`	`+ { b: string },`
	`662`	`+ { ctxA: string; argB: string }`
	`663`	`+ >`
	`664`	`+ >();`
	`665`	`+ expectTypeOf<`
	`666`	`+ FunctionReference<`
	`667`	`+ "query",`
	`668`	`+ "public",`
	`669`	`+ { b: string },`
	`670`	`+ { ctxA: string; argB: string }`
	`671`	`+ >`
	`672`	`+ >().toExtend<typeof testApi.addCtxWithExistingArg>();`
	`673`	`+ });`
	`674`	`+`
`647`	`675`	`test("add args", async () => {`
`648`	`676`	`const t = convexTest(schema, modules);`
`649`	`677`	`expect(await t.query(testApi.add, {})).toMatchObject({`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 849401f

File tree

2 files changed

2 files changed

`‎packages/convex-helpers/server/customFunctions.ts‎`

`‎packages/convex-helpers/server/zod.test.ts‎`

0 commit comments