refactor: add base global errors for zod

Author: chertik77

app/app.ts

@@ -2,13 +2,16 @@ import express from 'express'
 import cors from 'cors'
 import helmet from 'helmet'
 import logger from 'morgan'
+import * as z from 'zod'
 
-import { env } from './config'
+import { env, zodConfig } from './config'
 import { globalErrorHandler, notFoundHandler } from './middlewares'
 import { apiRouter } from './routes'
 
 export const app = express()
 
+z.config(zodConfig)
+
 app.use(helmet())
 app.use(cors({ origin: env.ALLOWED_ORIGINS }))
 app.use(logger(app.get('env') === 'development' ? 'dev' : 'combined'))

app/config/index.ts

@@ -2,4 +2,5 @@ export { transport } from './mailer.config'
 export { default } from './cloudinary.config'
 export { env } from './env.config'
 export { redisClient } from './redis.config'
+export { zodConfig } from './zod.config'
 export { defaultUserAvatars } from './default-user-avatars.config'

app/config/zod.config.ts

@@ -0,0 +1,35 @@
+import type { core } from 'zod'
+
+export const zodConfig: core.$ZodConfig = {
+  customError: ({
+    input,
+    code,
+    minimum,
+    maximum,
+    expected,
+    format,
+    values
+  }) => {
+    if (!input) return 'The field is required'
+
+    if (code === 'too_small') {
+      return `The field must be at least ${minimum} characters`
+    }
+
+    if (code === 'too_big') {
+      return `The field must be at most ${maximum} characters`
+    }
+
+    if (code === 'invalid_value') {
+      return `The field must be one of the following values: ${values.join(', ')}`
+    }
+
+    if (code === 'invalid_format') {
+      return `The field must have a valid ${format} format`
+    }
+
+    if (code === 'invalid_type') return `The field must be of type ${expected}`
+
+    return undefined
+  }
+}

app/schemas/auth.schema.ts

@@ -1,23 +1,20 @@
 import * as z from 'zod'
 
 export const SigninSchema = z.object({
-  email: z.email('Email is required'),
-  password: z
-    .string()
-    .min(8, 'Password must be at least 8 characters')
-    .max(64, 'Password must be at most 64 characters')
+  email: z.email(),
+  password: z.string().min(8).max(64)
 })
 
 export const SignupSchema = z.object({
   ...SigninSchema.shape,
-  name: z.string().min(2, 'Name must be at least 2 characters')
+  name: z.string().min(2)
 })
 
 export const RefreshTokenSchema = z.object({
-  refreshToken: z.string().min(1, 'Refresh token is required')
+  refreshToken: z.string().min(1)
 })
 
 export const GoogleCodeSchema = z.object({
-  code: z.string().min(1, 'Code is required'),
+  code: z.string().min(1),
   state: z.optional(z.string())
 })

app/schemas/board.schema.ts

@@ -14,7 +14,7 @@ const zObjectKeys = <T extends Record<string, unknown>>(obj: T) => {
 }
 
 export const AddBoardSchema = z.object({
-  title: z.string().min(3, 'Title must be at least 3 characters'),
+  title: z.string().min(3),
   icon: z.enum(Icon),
   background: zObjectKeys(boardImages)
 })

app/schemas/card.schema.ts

@@ -4,13 +4,10 @@ import * as z from 'zod'
 import { objectIdSchema } from './object-id.schema'
 
 export const AddCardSchema = z.object({
-  title: z.string().min(3, 'Title must be at least 3 characters'),
-  description: z.string().min(3, 'Description must be at least 3 characters'),
-  priority: z.enum(
-    Priority,
-    `Priority must be one of the following: ${Object.values(Priority).join(',')}`
-  ),
-  deadline: z.iso.datetime('Deadline must be a valid datetime')
+  title: z.string().min(3),
+  description: z.string().min(3),
+  priority: z.enum(Priority),
+  deadline: z.iso.datetime()
 })
 
 export const EditCardSchema = z

app/schemas/column.schema.ts

@@ -3,7 +3,7 @@ import * as z from 'zod'
 import { objectIdSchema } from './object-id.schema'
 
 export const AddColumnSchema = z.object({
-  title: z.string().min(3, 'Title must be at least 3 characters')
+  title: z.string().min(3)
 })
 
 export const EditColumnSchema = AddColumnSchema.partial()

app/schemas/object-id.schema.ts

@@ -1,4 +1,6 @@
 import * as z from 'zod'
 
 export const objectIdSchema = () =>
-  z.string().regex(/^[0-9a-f]{24}$/, 'Id must be a valid ObjectId')
+  z
+    .string()
+    .regex(/^[0-9a-f]{24}$/, 'The field must have a valid ObjectId format')

app/schemas/user.schema.ts

@@ -2,20 +2,15 @@ import { Theme } from '@prisma/client'
 import * as z from 'zod'
 
 export const NeedHelpSchema = z.object({
-  email: z.email('Email is invalid'),
-  comment: z.string().min(5, 'Comment must be at least 5 characters')
+  email: z.email(),
+  comment: z.string().min(5)
 })
 
 export const EditUserSchema = z
   .object({
-    name: z.string().min(2, 'Name must be at least 2 characters'),
-    email: z.email('Email is invalid'),
-    password: z
-      .string()
-      .min(8, 'Password must be at least 8 characters')
-      .max(64, 'Password must be at most 64 characters'),
-    theme: z.enum(Theme, {
-      message: `Theme must be one of the following: ${Object.values(Theme).join(',')}`
-    })
+    name: z.string().min(2),
+    email: z.email(),
+    password: z.string().min(8).max(64),
+    theme: z.enum(Theme)
   })
   .partial()

swagger.json

@@ -924,9 +924,7 @@
         "type": "object",
         "properties": {
           "statusCode": { "type": "integer", "example": 400 },
-          "message": {
-            "oneOf": [{ "type": "string" }, { "type": "object" }]
-          }
+          "message": { "type": "object" }
         }
       }
     },
@@ -982,9 +980,9 @@
               "example": {
                 "statusCode": 400,
                 "message": {
-                  "email": "Email is invalid",
-                  "password": "Password must be at least 8 characters",
-                  "name": "Name must be at least 2 characters"
+                  "email": "The field must have a valid email format",
+                  "password": "The field must be at least 8 characters",
+                  "name": "The field must be at least 2 characters"
                 }
               }
             }
@@ -1091,7 +1089,7 @@
               "example": {
                 "statusCode": 400,
                 "message": {
-                  "ids": "Ids must be an array of valid ObjectIds"
+                  "ids": "The field must be of type array"
                 }
               }
             }
@@ -1123,8 +1121,8 @@
               "example": {
                 "statusCode": 400,
                 "message": {
-                  "title": "Title must be at least 3 characters",
-                  "icon": "Invalid enum value. Expected 'project' | 'star' | 'loading' | 'puzzle' | 'container' | 'lightning' | 'colors' | 'hexagon', received 'random-icon'"
+                  "title": "The field must be at least 3 characters",
+                  "icon": "The field must be one of the following values: project, star, loading, puzzle, container, lightning, colors, hexagon"
                 }
               }
             }
@@ -1179,8 +1177,8 @@
               "example": {
                 "statusCode": 400,
                 "message": {
-                  "title": "Title must be at least 3 characters",
-                  "boardId": "Id must be a valid ObjectId"
+                  "title": "The field must be at least 3 characters",
+                  "boardId": "The field must have a valid ObjectId format"
                 }
               }
             }
@@ -1212,9 +1210,9 @@
               "example": {
                 "statusCode": 400,
                 "message": {
-                  "description": "Title must be a string",
-                  "priority": "Priority must be one of the following: Without, Low, Medium, High",
-                  "columnId": "Id must be a valid ObjectId"
+                  "description": "The field must be of type string",
+                  "priority": "The field must be one of the following values: Without, Low, Medium, High",
+                  "columnId": "The field must have a valid ObjectId format"
                 }
               }
             }