Feature Request: Surface the underlying object

[joshribakoff-sm]

export function UpdateUserRequestSchema(): z.ZodSchema<UpdateUserRequest> {
  return z.object({
    email: z.string().nullish(),
    enabled: z.boolean().nullish(),
    first_name: z.string().nullish(),
    last_name: z.string().nullish(),
    role: RoleSchema.nullish(),
    team_id: z.number().nullish(),
  });
}

This cannot be extended, instead my idea is to have an option so it outputs this:

const updateUserRequestFields = {
    email: z.string().nullish(),
    enabled: z.boolean().nullish(),
    first_name: z.string().nullish(),
    last_name: z.string().nullish(),
    role: RoleSchema.nullish(),
    team_id: z.number().nullish(),
 }

export function UpdateUserRequestSchema(): z.ZodSchema<UpdateUserRequest> {
  return z.object(updateUserRequestFields);
}

I could then import updateUserRequestFields and extend it prior to passing it to z.object() in the consuming code

export function MyCustomSchema(): z.ZodSchema<UpdateUserRequest> {
  const fields = updateUserRequestFields
  fields.email.min(1) // extending the validations :)
  return z.object(fields);
}

It could also optionally append:

export function UpdateUserRequestSchema(): z.ZodSchema<UpdateUserRequest> {
  return z.object(updateUserRequestFields);
}

[Code-Hex]

@joshribakoff-sm Thanks. I think you can do by extend method like UpdateUserRequestSchema().extend({ email: z.string().nullish().email() }) .

see: https://github.com/Code-Hex/graphql-codegen-typescript-validation-schema/tree/main/example/zod

[joshribakoff-sm]

Interesting, thanks for the heads up! Why not surface this on your main readme? There is no way I would have found this on my own 😆

[Code-Hex]

@joshribakoff-sm I have written like

You can check example directory if you want to see more complex config example or how is generated some files.

...And I wrote some tips in there.

[joshribakoff-sm]

Bottom line is that it wasn't clear (to me). I would suggest to reword it better (such as grammar), and inline the example into the main readme.

Something like:

you may want to extend or modify the generated schemas. There are two options to do this. Client side with .extend(), and server side with directives.

Below this, there could be two headings labelled "extending schema server side with directives", "extending schema client side with .extend().

It also doesn't work. See the resulting type error I get when following the example:

Looks like the underlying z.ZodObject is what has extend method, but the generated code annotates the return type to ZodSchema which has no extend method.

[Code-Hex]

@joshribakoff-sm thanks for reporting.
I fixed returned type to z.ZodObject at v0.4.0

About documentation, welcome PR.