Support zod@4 (#153)

Author: Bram-dc

.github/dependabot.yml

@@ -12,6 +12,4 @@ updates:
       interval: 'weekly'
     open-pull-requests-limit: 10
     ignore:
-      - dependency-name: '@typescript-eslint/eslint-plugin'
-      - dependency-name: '@typescript-eslint/parser'
       - dependency-name: '@types/node'

README.md

@@ -48,7 +48,7 @@ type ZodSerializerCompilerOptions = {
 ```js
 import Fastify from 'fastify';
 import { createSerializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
-import z from 'zod';
+import { z } from 'zod/v4';
 
 const app = Fastify();
 
@@ -77,7 +77,7 @@ app.listen({ port: 4949 });
 import fastify from 'fastify';
 import fastifySwagger from '@fastify/swagger';
 import fastifySwaggerUI from '@fastify/swagger-ui';
-import { z } from 'zod';
+import { z } from 'zod/v4';
 
 import {
   jsonSchemaTransform,
@@ -182,16 +182,16 @@ fastifyApp.setErrorHandler((err, req, reply) => {
 
 ## How to create refs to the schemas?
 
-It is possible to create refs to the schemas by using the `createJsonSchemaTransformObject` function. You provide the schemas as an object and fastifySwagger will create a OpenAPI document in which the schemas are referenced. The following example creates a ref to the `User` schema and will include the `User` schema in the OpenAPI document.
+When provided, this package will automatically create refs using the `jsonSchemaTransformObject` function. You register the schemas to the global zod registry and give it an `id` and fastifySwagger will create a OpenAPI document in which the schemas are referenced. The following example creates a ref to the `User` schema and will include the `User` schema in the OpenAPI document.
 
 ```ts
 import fastifySwagger from '@fastify/swagger';
 import fastifySwaggerUI from '@fastify/swagger-ui';
 import fastify from 'fastify';
-import { z } from 'zod';
+import { z } from 'zod/v4';
 import type { ZodTypeProvider } from 'fastify-type-provider-zod';
 import {
-  createJsonSchemaTransformObject,
+  jsonSchemaTransformObject,
   jsonSchemaTransform,
   serializerCompiler,
   validatorCompiler,
@@ -202,6 +202,8 @@ const USER_SCHEMA = z.object({
   name: z.string().describe('The name of the user'),
 });
 
+z.globalRegistry.add(USER_SCHEMA, { id: 'User' })
+
 const app = fastify();
 app.setValidatorCompiler(validatorCompiler);
 app.setSerializerCompiler(serializerCompiler);
@@ -216,11 +218,7 @@ app.register(fastifySwagger, {
     servers: [],
   },
   transform: jsonSchemaTransform,
-  transformObject: createJsonSchemaTransformObject({
-    schemas: {
-      User: USER_SCHEMA,
-    },
-  }),
+  transformObject: jsonSchemaTransformObject,
 });
 
 app.register(fastifySwaggerUI, {
@@ -258,7 +256,7 @@ run();
 ## How to create a plugin?
 
 ```ts
-import { z } from 'zod';
+import { z } from 'zod/v4';
 import { FastifyPluginAsyncZod } from 'fastify-type-provider-zod';
 
 const plugin: FastifyPluginAsyncZod = async function (fastify, _opts) {

package.json

@@ -2,21 +2,28 @@
   "name": "fastify-type-provider-zod",
   "version": "4.0.2",
   "description": "Zod Type Provider for Fastify@5",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    "require": "./dist/cjs/index.js",
+    "import": "./dist/esm/index.js"
+  },
+  "types": "./dist/cjs/index.d.ts",
   "files": ["README.md", "LICENSE", "dist"],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json",
     "test": "npm run build && npm run typescript && vitest",
     "test:coverage": "vitest --coverage",
-    "lint": "biome check . && tsc --project tsconfig.lint.json --noEmit",
+    "lint": "biome check .",
     "lint:fix": "biome check --write .",
     "typescript": "tsd",
+    "prepare": "npm run build",
     "prepublishOnly": "npm run build"
   },
   "peerDependencies": {
     "fastify": "^5.0.0",
-    "zod": "^3.14.2"
+    "zod": "^3.25.7"
   },
   "repository": {
     "url": "https://github.com/turkerdev/fastify-type-provider-zod"
@@ -29,24 +36,22 @@
   },
   "homepage": "https://github.com/turkerdev/fastify-type-provider-zod",
   "dependencies": {
-    "@fastify/error": "^4.0.0",
-    "zod-to-json-schema": "^3.23.3"
+    "@fastify/error": "^4.1.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "^1.9.3",
-    "@fastify/swagger": "^9.1.0",
-    "@fastify/swagger-ui": "^5.0.1",
+    "@biomejs/biome": "^1.9.4",
+    "@fastify/swagger": "^9.5.1",
+    "@fastify/swagger-ui": "^5.2.2",
     "@kibertoad/biome-config": "^1.2.1",
     "@types/node": "^20.16.10",
-    "@vitest/coverage-v8": "^2.1.2",
+    "@vitest/coverage-v8": "^3.1.4",
     "fastify": "^5.0.0",
     "fastify-plugin": "^5.0.1",
     "oas-validator": "^5.0.8",
-    "openapi-types": "^12.1.3",
-    "tsd": "^0.31.2",
-    "typescript": "^5.6.2",
-    "vitest": "^2.1.2",
-    "zod": "^3.23.8"
+    "tsd": "^0.32.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.4",
+    "zod": "^3.25.36"
   },
   "tsd": {
     "directory": "types"

src/core.ts

@@ -1,3 +1,4 @@
+import type { SwaggerTransform, SwaggerTransformObject } from '@fastify/swagger'
 import type {
   FastifyPluginAsync,
   FastifyPluginCallback,
@@ -9,14 +10,11 @@ import type {
   RawServerDefault,
 } from 'fastify'
 import type { FastifySerializerCompiler } from 'fastify/types/schema'
-import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
-import type { z } from 'zod'
+import { z } from 'zod/v4'
 
 import { InvalidSchemaError, ResponseSerializationError, createValidationError } from './errors'
-import { resolveRefs } from './ref'
-import { convertZodToJsonSchema } from './zod-to-json'
+import { zodRegistryToJson, zodSchemaToJson } from './zod-to-json'
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type FreeformRecord = Record<string, any>
 
 const defaultSkipList = [
@@ -38,8 +36,16 @@ interface Schema extends FastifySchema {
   hide?: boolean
 }
 
-export const createJsonSchemaTransform = ({ skipList }: { skipList: readonly string[] }) => {
-  return ({ schema, url }: { schema: Schema; url: string }) => {
+type CreateJsonSchemaTransformOptions = {
+  skipList?: readonly string[]
+  schemaRegistry?: z.core.$ZodRegistry<{ id?: string | undefined }>
+}
+
+export const createJsonSchemaTransform = ({
+  skipList = defaultSkipList,
+  schemaRegistry = z.globalRegistry,
+}: CreateJsonSchemaTransformOptions): SwaggerTransform<Schema> => {
+  return ({ schema, url }) => {
     if (!schema) {
       return {
         schema,
@@ -61,20 +67,17 @@ export const createJsonSchemaTransform = ({ skipList }: { skipList: readonly str
     for (const prop in zodSchemas) {
       const zodSchema = zodSchemas[prop]
       if (zodSchema) {
-        transformed[prop] = convertZodToJsonSchema(zodSchema)
+        transformed[prop] = zodSchemaToJson(zodSchema, schemaRegistry, 'input')
       }
     }
 
     if (response) {
       transformed.response = {}
 
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       for (const prop in response as any) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const schema = resolveSchema((response as any)[prop])
+        const zodSchema = resolveSchema((response as any)[prop])
 
-        const transformedResponse = convertZodToJsonSchema(schema)
-        transformed.response[prop] = transformedResponse
+        transformed.response[prop] = zodSchemaToJson(zodSchema, schemaRegistry, 'output')
       }
     }
 
@@ -89,25 +92,48 @@ export const createJsonSchemaTransform = ({ skipList }: { skipList: readonly str
   }
 }
 
-export const jsonSchemaTransform = createJsonSchemaTransform({
-  skipList: defaultSkipList,
-})
+export const jsonSchemaTransform = createJsonSchemaTransform({})
+
+type CreateJsonSchemaTransformObjectOptions = {
+  schemaRegistry?: z.core.$ZodRegistry<{ id?: string | undefined }>
+}
 
 export const createJsonSchemaTransformObject =
-  ({ schemas }: { schemas: Record<string, z.ZodTypeAny> }) =>
-  (
-    input:
-      | { swaggerObject: Partial<OpenAPIV2.Document> }
-      | { openapiObject: Partial<OpenAPIV3.Document | OpenAPIV3_1.Document> },
-  ) => {
+  ({
+    schemaRegistry = z.globalRegistry,
+  }: CreateJsonSchemaTransformObjectOptions): SwaggerTransformObject =>
+  (input) => {
     if ('swaggerObject' in input) {
       console.warn('This package currently does not support component references for Swagger 2.0')
       return input.swaggerObject
     }
 
-    return resolveRefs(input.openapiObject, schemas)
+    const inputSchemas = zodRegistryToJson(schemaRegistry, 'input')
+    const outputSchemas = zodRegistryToJson(schemaRegistry, 'output')
+
+    for (const key in outputSchemas) {
+      if (inputSchemas[key]) {
+        throw new Error(
+          `Collision detected for schema "${key}". The is already an input schema with the same name.`,
+        )
+      }
+    }
+
+    return {
+      ...input.openapiObject,
+      components: {
+        ...input.openapiObject.components,
+        schemas: {
+          ...input.openapiObject.components?.schemas,
+          ...inputSchemas,
+          ...outputSchemas,
+        },
+      },
+    } as ReturnType<SwaggerTransformObject>
   }
 
+export const jsonSchemaTransformObject = createJsonSchemaTransformObject({})
+
 export const validatorCompiler: FastifySchemaCompiler<z.ZodTypeAny> =
   ({ schema }) =>
   (data) => {
@@ -129,7 +155,6 @@ function resolveSchema(maybeSchema: z.ZodTypeAny | { properties: z.ZodTypeAny })
   throw new InvalidSchemaError(JSON.stringify(maybeSchema))
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type ReplacerFunction = (this: any, key: string, value: any) => any
 
 export type ZodSerializerCompilerOptions = {

src/errors.ts

@@ -1,20 +1,22 @@
 import createError from '@fastify/error'
 import type { FastifyError } from 'fastify'
-import type { ZodError, ZodIssue, ZodIssueCode } from 'zod'
+import type { z } from 'zod/v4'
 
-export class ResponseSerializationError extends createError<[{ cause: ZodError }]>(
+export class ResponseSerializationError extends createError<[{ cause: z.ZodError }]>(
   'FST_ERR_RESPONSE_SERIALIZATION',
   "Response doesn't match the schema",
   500,
 ) {
-  cause!: ZodError
+  cause!: z.ZodError
 
   constructor(
     public method: string,
     public url: string,
-    options: { cause: ZodError },
+    options: { cause: z.ZodError },
   ) {
     super({ cause: options.cause })
+
+    this.cause = options.cause
   }
 }
 
@@ -32,11 +34,11 @@ const ZodFastifySchemaValidationErrorSymbol = Symbol.for('ZodFastifySchemaValida
 
 export type ZodFastifySchemaValidationError = {
   [ZodFastifySchemaValidationErrorSymbol]: true
-  keyword: ZodIssueCode
+  keyword: string
   instancePath: string
   schemaPath: string
   params: {
-    issue: ZodIssue
+    issue: z.ZodIssue
   }
   message: string
 }
@@ -59,10 +61,10 @@ export const hasZodFastifySchemaValidationErrors = (
   error.validation.length > 0 &&
   isZodFastifySchemaValidationError(error.validation[0])
 
-export const createValidationError = (error: ZodError): ZodFastifySchemaValidationError[] =>
-  error.errors.map((issue) => ({
+export const createValidationError = (error: z.ZodError): ZodFastifySchemaValidationError[] =>
+  error.issues.map((issue) => ({
     [ZodFastifySchemaValidationErrorSymbol]: true,
-    keyword: issue.code,
+    keyword: issue.code ?? 'custom',
     instancePath: `/${issue.path.join('/')}`,
     schemaPath: `#/${issue.path.join('/')}/${issue.code}`,
     params: {

index.ts src/index.tsindex.ts renamed to src/index.ts

@@ -5,16 +5,17 @@ export {
   type ZodSerializerCompilerOptions,
   jsonSchemaTransform,
   createJsonSchemaTransform,
+  jsonSchemaTransformObject,
   createJsonSchemaTransformObject,
   serializerCompiler,
   validatorCompiler,
   createSerializerCompiler,
-} from './src/core'
+} from './core'
 
 export {
   type ZodFastifySchemaValidationError,
   ResponseSerializationError,
   InvalidSchemaError,
   hasZodFastifySchemaValidationErrors,
   isResponseSerializationError,
-} from './src/errors'
+} from './errors'