Please extend zod generator with TS types from zod itself

[kopach]

What is the problem this feature would solve?

Types generated from OpenAPI schema by TypeScript generator are far less strict than one provided by ZOD.
Would be really great if we could use TS types provided by ZOD itself since we do use zod parsing anyway

External documents/projects?

docs reference below

https://zod.dev/?id=type-inference

You can extract the TypeScript type of any schema with z.infer<typeof mySchema>

const A = z.string();
type A = z.infer<typeof A>; // string

const u: A = 12; // TypeError
const u: A = "asdf"; // compiles

What is the feature you are proposing to solve the problem?

add option (enabled by default) to pluginZod which would add z.infer<typeof mySchema> to every zod schema generated by kubb (right in the same file as schema)

What alternatives have you considered?

As workaround I do add those types using hooks like so

  hooks: {
    done: [
      'replace-in-file --configFile=replace.config.cjs', // this should go as first hook otherwise won't work
      'prettier --loglevel silent generatedTypes/ --write', // we can apply code fomratting after
    ],
  },

and content of replace.config.cjs (this is config file for https://www.npmjs.com/package/replace-in-file)

module.exports = {
  files: 'generatedTypes/zod/*.ts',
  from: /(export const (\w+) .*)$/gm, // this will find every line starting with export
  to: '$1\nexport type $2=z.infer<typeof $2>', // this will add one more line after one with export wrapping everything after export with z.infer
};

It works quite well for me so far and I really don't see any downside of having this natively handled by kubb

[stijnvanhulle]

Hi, Do you have some examples of where TypeScript is less strict? We could adapt the TypeScript plugin to have the same strict types but being dependent on something like Zod is not great(not everybody wants to use Zod and I don't want to force people to use Zod for just types).

[csaba-veezla]

I feel, that the ts plugin should not change.
The zod plugin should be able to export types as well, by providing a type output path.
And plugins that have a dependency on the ts plugin, shouldn't or more like they should require zod(with ts path) or ts.

[Wykks]

Hello!

Very useful project, thanks a lot @stijnvanhulle!

I have the same concern about zod, it would be better to be able to export types with zod as well using zod.infer, this way we don't have the extras types when using zod

[stijnvanhulle]

So if I'm following, you guys want to export all types of the generated Zod schemas(based on z.infer)?

Something like this?

export const petSchema = z.object({ firstName: z.string() })
export type PetSchema = z.infer<typeof petSchema>