Migrate to zod v4 (#398)

fruneen · jskiller1404 · web-flow · commit 79f27b207be3 · 2025-11-20T14:45:33.000+03:00
* feat: migrate from zod v3 to zod v4

* fix: fix depricated zod features

* fix: fix comments

---------

Co-authored-by: stasik1404 &lt;skonashuk04@gmail.com&gt;
diff --git a/docs/api-reference/middlewares.mdx b/docs/api-reference/middlewares.mdx
@@ -86,7 +86,7 @@ import { validateMiddleware } from 'middlewares';
 
 // Define your schema
 const schema = z.object({
-  email: z.string().email('Email format is incorrect'),
+  email: z.email('Email format is incorrect'),
   firstName: z.string().min(1, 'First name is required').max(100),
   lastName: z.string().min(1, 'Last name is required').max(100),
   age: z.number().int().positive().optional(),
diff --git a/docs/examples/api-public-docs/usage.mdx b/docs/examples/api-public-docs/usage.mdx
@@ -43,7 +43,7 @@ export const EmptySchema = docsService.registerSchema('EmptyObject', z.object({}
 export const schema = z.object({
   firstName: z.string().min(1, 'Please enter First name').max(100),
   lastName: z.string().min(1, 'Please enter Last name').max(100),
-  email: z.string().min(1, 'Please enter email').email('Email format is incorrect.'),
+  email: z.email('Email format is incorrect.').min(1, 'Please enter email'),
   password: z.string().regex(
     PASSWORD_REGEXP,
     'The password must contain 6 or more characters with at least one letter (a-z) and one number (0-9).',
diff --git a/template/.cursor/rules/shared-packages.mdc b/template/.cursor/rules/shared-packages.mdc
@@ -67,7 +67,7 @@ import { dbSchema } from './db.schema';
 
 export const userSchema = dbSchema.extends({
   name: z.string().min(1),
-  email: z.string().email(),
+  email: z.email(),
 });
 ```
 
diff --git a/template/.cursor/rules/validation-schemas.mdc b/template/.cursor/rules/validation-schemas.mdc
@@ -34,7 +34,7 @@ The middleware validates:
 - `ctx.request.body` - Request body
 - `ctx.request.files` - Uploaded formidable files
 - `ctx.query` - Query parameters
-- `ctx.params` - URL parameters  
+- `ctx.params` - URL parameters
 
 ## Web/Frontend Validation
 
@@ -81,7 +81,7 @@ import { dbSchema } from './db.schema';
 export const userSchema = dbSchema.extend({
   firstName: z.string(),
   lastName: z.string(),
-  email: z.string().email(),
+  email: z.email(),
   passwordHash: z.string().optional(),
 });
 
@@ -102,13 +102,13 @@ export const updateUserSchema = userSchema
 
 ## Enums in Schemas
 
-Enums are centralized in [packages/enums/src/](mdc:packages/enums/src/). Use `z.nativeEnum()` for validation:
+Enums are centralized in [packages/enums/src/](mdc:packages/enums/src/). Use `z.enum()` for validation:
 
 ```typescript
 import { TokenType } from 'enums';
 
 export const tokenSchema = dbSchema.extend({
-  type: z.nativeEnum(TokenType),
+  type: z.enum(TokenType),
 });
 ```
 
diff --git a/template/apps/api/src/middlewares/validate.middleware.ts b/template/apps/api/src/middlewares/validate.middleware.ts
@@ -1,11 +1,11 @@
-import { ZodError, ZodIssue, ZodSchema } from 'zod';
+import { ZodError, ZodType } from 'zod';
 
 import { AppKoaContext, Next, ValidationErrors } from 'types';
 
 const formatError = (zodError: ZodError): ValidationErrors => {
   const errors: ValidationErrors = {};
 
-  zodError.issues.forEach((error: ZodIssue) => {
+  zodError.issues.forEach((error) => {
     const key = error.path.join('.');
 
     if (!errors[key]) {
@@ -18,7 +18,7 @@ const formatError = (zodError: ZodError): ValidationErrors => {
   return errors;
 };
 
-const validate = (schema: ZodSchema) => async (ctx: AppKoaContext, next: Next) => {
+const validate = (schema: ZodType) => async (ctx: AppKoaContext, next: Next) => {
   const result = await schema.safeParseAsync({
     ...ctx.request.body,
     ...ctx.request.files,
@@ -28,7 +28,7 @@ const validate = (schema: ZodSchema) => async (ctx: AppKoaContext, next: Next) =
 
   if (!result.success) ctx.throw(400, { clientErrors: formatError(result.error) });
 
-  ctx.validatedData = result.data;
+  ctx.validatedData = result.data as object;
 
   await next();
 };
diff --git a/template/apps/api/src/migrator/migration-log/migration-log.schema.ts b/template/apps/api/src/migrator/migration-log/migration-log.schema.ts
@@ -9,7 +9,7 @@ const schema = z.object({
   error: z.string().optional(),
   errorStack: z.string().optional(),
   duration: z.string().optional(),
-  migrationVersion: z.number(),
+  migrationVersion: z.int(),
 
   createdOn: z.date().optional(),
   updatedOn: z.date().optional(),
diff --git a/template/apps/api/src/migrator/migration-version/migration-version.schema.ts b/template/apps/api/src/migrator/migration-version/migration-version.schema.ts
@@ -3,7 +3,7 @@ import { z } from 'zod';
 const schema = z.object({
   _id: z.string(),
 
-  version: z.number(),
+  version: z.int(),
 
   createdOn: z.date().optional(),
   updatedOn: z.date().optional(),
diff --git a/template/apps/api/src/resources/user/actions/list.ts b/template/apps/api/src/resources/user/actions/list.ts
@@ -24,7 +24,7 @@ const schema = paginationSchema.extend({
       lastName: z.enum(['asc', 'desc']).optional(),
       createdOn: z.enum(['asc', 'desc']).default('asc'),
     })
-    .default({}),
+    .default({ createdOn: 'asc' }),
 });
 
 type ValidatedData = z.infer<typeof schema>;
diff --git a/template/apps/api/src/services/google/google.service.ts b/template/apps/api/src/services/google/google.service.ts
@@ -19,10 +19,10 @@ import { User } from 'types';
 
 const googleUserInfoSchema = z.object({
   sub: z.string().describe('Unique Google user ID'),
-  email: z.string().email().describe('User email'),
+  email: z.email().describe('User email'),
   email_verified: z.boolean().describe('Email verification status'),
   name: z.string().describe('User full name'),
-  picture: z.string().url().describe('Profile picture URL').optional(),
+  picture: z.url().describe('Profile picture URL').optional(),
   given_name: z.string().describe('First name'),
   family_name: z.string().describe('Last name'),
 });
@@ -34,7 +34,7 @@ const googleCallbackParamsSchema = z
     storedState: z.string(),
     codeVerifier: z.string(),
   })
-  .refine((data) => data.state === data.storedState, { message: 'OAuth state mismatch' });
+  .refine((data) => data.state === data.storedState, { error: 'OAuth state mismatch' });
 
 export const googleClient = new Google(
   config.GOOGLE_CLIENT_ID!,
@@ -132,7 +132,7 @@ export const validateCallback = async (params: {
     const errorMessage = 'Failed to validate Google authentication data.';
 
     logger.error(`[Google OAuth] ${errorMessage}`);
-    logger.error(parsedParams.error.flatten().fieldErrors);
+    logger.error(z.treeifyError(parsedParams.error).errors);
 
     throw new Error(errorMessage);
   }
@@ -165,7 +165,7 @@ export const validateCallback = async (params: {
     const errorMessage = 'Failed to validate Google user info';
 
     logger.error(`[Google OAuth] ${errorMessage}`);
-    logger.error(parsedUserInfo.error.flatten().fieldErrors);
+    logger.error(z.treeifyError(parsedUserInfo.error).errors);
 
     throw new Error(errorMessage);
   }
diff --git a/template/apps/api/src/utils/config.util.ts b/template/apps/api/src/utils/config.util.ts
@@ -1,12 +1,12 @@
 import process from 'node:process';
-import { ZodSchema } from 'zod';
+import { z, ZodType } from 'zod';
 
-const validateConfig = <T>(schema: ZodSchema): T => {
+const validateConfig = <T>(schema: ZodType<T>): T => {
   const parsed = schema.safeParse(process.env);
 
   if (!parsed.success) {
-    // Allow the use of a console instance for logging before launching the application.
-    console.error('❌ Invalid environment variables:', parsed.error.flatten().fieldErrors);
+    console.error('❌ Invalid environment variables ❌');
+    console.error(z.prettifyError(parsed.error));
 
     throw new Error('Invalid environment variables');
   }
diff --git a/template/apps/web/package.json b/template/apps/web/package.json
@@ -15,7 +15,7 @@
     "precommit": "lint-staged"
   },
   "dependencies": {
-    "@hookform/resolvers": "5.1.1",
+    "@hookform/resolvers": "5.2.2",
     "@mantine/core": "8.3.6",
     "@mantine/dates": "8.3.6",
     "@mantine/dropzone": "8.3.6",
@@ -35,7 +35,7 @@
     "dotenv-flow": "4.1.0",
     "lodash": "4.17.21",
     "mixpanel-browser": "2.53.0",
-    "next": "15.5.3",
+    "next": "15.5.6",
     "object-to-formdata": "4.5.1",
     "react": "catalog:",
     "react-dom": "catalog:",
diff --git a/template/apps/web/src/utils/config.util.ts b/template/apps/web/src/utils/config.util.ts
@@ -1,12 +1,13 @@
-import { ZodSchema } from 'zod';
+import { z, ZodType } from 'zod';
 
-export const validateConfig = <T>(schema: ZodSchema, processEnv: Record<keyof T, string | undefined>): T => {
+export const validateConfig = <T>(schema: ZodType<T>, processEnv: Record<keyof T, string | undefined>): T => {
   const parsed = schema.safeParse(processEnv);
 
   if (!parsed.success) {
-    console.error('❌ Invalid environment variables:', parsed.error.flatten().fieldErrors);
+    console.error('❌ Invalid environment variables ❌');
+    console.error(z.prettifyError(parsed.error));
 
-    throw new Error(`Invalid environment variables ${JSON.stringify(parsed.error.flatten().fieldErrors)}`);
+    throw new Error('Invalid environment variables');
   }
 
   return parsed.data;
diff --git a/template/packages/schemas/src/account.schema.ts b/template/packages/schemas/src/account.schema.ts
@@ -5,7 +5,7 @@ import { userSchema } from './user.schema';
 
 export const signInSchema = z.object({
   email: emailSchema,
-  password: z.string({ required_error: 'Password is required' }).max(128, 'Password must be less than 128 characters.'),
+  password: z.string().min(1, 'Password is required').max(128, 'Password must be less than 128 characters.'),
 });
 
 export const signUpSchema = userSchema.pick({ firstName: true, lastName: true }).extend({
@@ -22,6 +22,6 @@ export const forgotPasswordSchema = z.object({
 });
 
 export const resetPasswordSchema = z.object({
-  token: z.string({ required_error: 'Token is required' }),
+  token: z.string().min(1, 'Token is required'),
   password: passwordSchema,
 });
diff --git a/template/packages/schemas/src/common.schema.ts b/template/packages/schemas/src/common.schema.ts
@@ -13,20 +13,19 @@ export const paginationSchema = z.object({
     .object({
       createdOn: z.enum(['asc', 'desc']).default('asc'),
     })
-    .default({}),
+    .default({ createdOn: 'asc' }),
 });
 
 export const emailSchema = z
-  .string()
-  .nonempty('Email is required')
+  .email()
+  .min(1, 'Email is required')
   .toLowerCase()
   .trim()
-  .email()
   .max(255, 'Email must be less than 255 characters.');
 
 export const passwordSchema = z
   .string()
-  .nonempty('Password is required')
+  .min(1, 'Password is required')
   .min(PASSWORD_RULES.MIN_LENGTH, `Password must be at least ${PASSWORD_RULES.MIN_LENGTH} characters.`)
   .max(PASSWORD_RULES.MAX_LENGTH, `Password must be less than ${PASSWORD_RULES.MAX_LENGTH} characters.`)
   .regex(
diff --git a/template/packages/schemas/src/db.schema.ts b/template/packages/schemas/src/db.schema.ts
@@ -1,11 +1,9 @@
 import { z } from 'zod';
 
-export default z
-  .object({
-    _id: z.string(),
+export default z.object({
+  _id: z.string(),
 
-    createdOn: z.date().optional(),
-    updatedOn: z.date().optional(),
-    deletedOn: z.date().optional().nullable(),
-  })
-  .strict();
+  createdOn: z.date().optional(),
+  updatedOn: z.date().optional(),
+  deletedOn: z.date().optional().nullable(),
+});
diff --git a/template/packages/schemas/src/token.schema.ts b/template/packages/schemas/src/token.schema.ts
@@ -6,6 +6,6 @@ import dbSchema from './db.schema';
 export const tokenSchema = dbSchema.extend({
   value: z.string(),
   userId: z.string(),
-  type: z.nativeEnum(TokenType),
+  type: z.enum(TokenType),
   expiresOn: z.date(),
 });
diff --git a/template/packages/schemas/src/user.schema.ts b/template/packages/schemas/src/user.schema.ts
@@ -8,29 +8,27 @@ import dbSchema from './db.schema';
 const oauthSchema = z.object({
   google: z
     .object({
-      userId: z.string().nonempty('Google user ID is required'),
+      userId: z.string().min(1, 'Google user ID is required'),
       connectedOn: z.date(),
     })
     .optional(),
 });
 
-export const userSchema = dbSchema
-  .extend({
-    firstName: z.string().nonempty('First name is required').max(128, 'First name must be less than 128 characters.'),
-    lastName: z.string().nonempty('Last name is required').max(128, 'Last name must be less than 128 characters.'),
+export const userSchema = dbSchema.extend({
+  firstName: z.string().min(1, 'First name is required').max(128, 'First name must be less than 128 characters.'),
+  lastName: z.string().min(1, 'Last name is required').max(128, 'Last name must be less than 128 characters.'),
 
-    email: emailSchema,
-    passwordHash: z.string().optional(),
+  email: emailSchema,
+  passwordHash: z.string().optional(),
 
-    isEmailVerified: z.boolean().default(false),
+  isEmailVerified: z.boolean().default(false),
 
-    avatarUrl: z.string().nullable().optional(),
+  avatarUrl: z.string().nullable().optional(),
 
-    oauth: oauthSchema.optional(),
+  oauth: oauthSchema.optional(),
 
-    lastRequest: z.date().optional(),
-  })
-  .strip();
+  lastRequest: z.date().optional(),
+});
 
 export const updateUserSchema = userSchema
   .pick({ firstName: true, lastName: true })
diff --git a/template/pnpm-lock.yaml b/template/pnpm-lock.yaml
diff --git a/template/pnpm-workspace.yaml b/template/pnpm-workspace.yaml
