@automatons/typescript-zod

What is @automatons/typescript-zod

This is a generator that emits zod schemas from an OpenAPI document's component schemas. Only use openapi-automatons.

This package is ESM-only and requires Node.js >= 22.

For every model it emits a XxxSchema zod schema plus a type Xxx = z.infer<typeof XxxSchema>, so the inferred static type and the runtime validator never drift apart.

zod is a peer dependency — install it alongside the generated output (zod@^3 || ^4).

Generated schemas

Each model becomes a XxxSchema plus an inferred type Xxx. The most natural place to use them is the boundary where untrusted data enters your app — i.e. the request body you are about to send (form input), validated at mutation time:

import { NewPetSchema, type NewPet } from "./models";

// validate user/form input before sending it
const body: NewPet = NewPetSchema.parse(formValues); // or .safeParse for non-throwing
await api.createPet(body);

It drops straight into react-hook-form…

const form = useForm<NewPet>({ resolver: zodResolver(NewPetSchema) });

…and pairs with the generated mutation from @automatons/typescript-client-react-query:

const { mutate } = useCreatePet();
const onSubmit = (values: unknown) => mutate([NewPetSchema.parse(values)]);

The same schemas can also be used defensively on responses to catch backend / contract drift (optional — the generated client already types responses from the spec):

const pet = PetSchema.parse(await response.json());

How can I use @automatons/typescript-zod?

This library is designed to be used by openapi-automatons. Please read the readme of openapi-automatons for how to use it.