Docs on integrating with other OSS

It would be nice to have docs on how to integrate zod with other OSS. This would help people:

• identify whether zod will work well with their tech stack
• figure out how to use zod with their tech stack
• help zod validate its feature set. If the docs are hard to write, zod is probably missing something.

GraphQL

It seems like zod could be well suited for GraphQL validations. It would be handy to have a reference for the parallels of GraphQL types and their corresponding zod types, as well as any other suggestions for integrating zod into the GraphQL environment.

As a single small example:

union Fish = Salmon | Tuna | Trout
type Catch {
  fish: Fish!
}

const FishEnum = z.union([z.literal('Salmon'), z.literal('Tuna'), z.literal('Trout')]);
const Catch = z.object({
  fish: FishEnum,
});

Of course it’s a bit less obvious when it comes to nullable types because GraphQL is nullable by default, and zod is required by default.

React PropTypes

Seems like an integration that would make sense for libraries. Similar docs like those for GraphQL could make sense.

formik

Formik has native support for Yup schemas. Docs on integrating zod with formik would be nice!

[ivosabev]

Formik integration would be nice, especially with Formik V3 coming soon.

[ryardley]

So far this works for me getting Zod to work with Formik (only semi-tested).

import * as z from 'zod'

class ValidationError extends Error {
  public name = 'ValidationError'
  inner: { path: string; message: string }[]
}

function createValidationError(e: z.ZodError) {
  const error = new ValidationError(e.message)
  error.inner = Object.keys(e.errors).map((k) => ({
    message: e.errors[k].message,
    path: e.errors[k].path.join('.'),
  }))
  return error
}


// Wrap your zod schema before passing it to Formik's `validationSchema` prop
export function toFormikYupSchema(schema: z.ZodSchema<any>) {
  return {
    async validate(obj: any) {
      try {
        await Promise.resolve(schema.parse(obj))
      } catch (err) {
        throw createValidationError(err)
      }
    },
  }
}