Oren•9mo ago

using zod schema for validation

import { z } from "zod";
import { NoOp } from "convex-helpers/server/customFunctions";
import { zCustomMutation } from "convex-helpers/server/zod";
import { mutation } from "./_generated/server";

const zMutation = zCustomMutation(mutation, NoOp);

export const emailFormSchema = z.object({
  email: z.string().email(),
});

export const add = zMutation({
  args: emailFormSchema,
  handler: async (ctx, args) => {
    await ctx.db.insert("emails", { email: args.email });
  },
});

import { z } from "zod";
import { NoOp } from "convex-helpers/server/customFunctions";
import { zCustomMutation } from "convex-helpers/server/zod";
import { mutation } from "./_generated/server";

const zMutation = zCustomMutation(mutation, NoOp);

export const emailFormSchema = z.object({
  email: z.string().email(),
});

export const add = zMutation({
  args: emailFormSchema,
  handler: async (ctx, args) => {
    await ctx.db.insert("emails", { email: args.email });
  },
});

I want to use the zod schema directly like above emailFormSchema but its giving me error;

Type 'ZodObject<{ email: ZodString; }, "strip", ZodTypeAny, { email: string; }, { email: string; }>' is not assignable to type 'void | ZodValidator | undefined'.

9 Replies

David Alonso•9mo ago

I wonder if args: { ...emailFormSchema.shape } works

ian•9mo ago

Yeah right now args doesn't accept a z.object, just {email: z.string().email() } directly. does .shape or emailFormSchema._def.shape maintain the types?

OrenOP•8mo ago

someone posted a workaround here https://discord.com/channels/1019350475847499849/1269743602397872229/1270532300303634514 would be nice to have it supported this causes duplication of the schemas 😦

Tiger 🐅•8mo ago

yeah would be nice to have it supported

ian•8mo ago

@Oren @Tiger 🐅 @David Alonso are you still seeing issues with args: myZodObject._def.shape() ? And @Tiger 🐅 you mentioned there's issues with Zod - is this what you're referring to, or others? I'd love to have known issues in the GitHub issues, since Discord is getting pretty busy nowadays and things will slip though

Tiger 🐅•8mo ago

honestly to be fully fair ive not given it a shot i was ok with simply duplicating v.union works out for discriminated unions so duplication was the fastest route for the mvp

OrenOP•8mo ago

@ian this works now 👍

const zMutation = zCustomMutation(mutation, NoOp);

export const emailFormSchema = z.object({
  email: z.string().email(),
});

export const add = zMutation({
  args: emailFormSchema._def.shape(),
  handler: async (ctx, args) => {
    await ctx.db.insert("emails", { email: args.email });
  },
});

const zMutation = zCustomMutation(mutation, NoOp);

export const emailFormSchema = z.object({
  email: z.string().email(),
});

export const add = zMutation({
  args: emailFormSchema._def.shape(),
  handler: async (ctx, args) => {
    await ctx.db.insert("emails", { email: args.email });
  },
});

Is it ok to create

convex/validations.ts

convex/validations.ts

file and share the declerations like

emailFormSchema

emailFormSchema

from there with my nextjs app/forms?

ian•8mo ago

sounds like a great idea

OrenOP•8mo ago

using zod schema for validation

Did you find this page helpful?