refactor(utils): refactor all validator code

Author: mikemajesty

package-lock.json

@@ -58,6 +58,7 @@
     "convert-pino-request-to-curl": "^1.0.8",
     "handlebars": "^4.7.8",
     "helmet": "^8.0.0",
+    "i18next": "^24.2.2",
     "js-yaml": "^4.1.0",
     "jsonwebtoken": "^9.0.2",
     "luxon": "^3.5.0",
@@ -89,7 +90,8 @@
     "v8": "^0.1.0",
     "write-excel-file": "^2.3.1",
     "yaml": "^2.7.0",
-    "zod": "^3.24.2"
+    "zod": "^3.24.2",
+    "zod-i18n-map": "^2.27.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.7.1",

package.json

@@ -1,16 +1,15 @@
-import { z } from 'zod';
-
 import { BaseEntity } from '@/utils/entity';
+import { Infer, InputValidator } from '@/utils/validator';
 
-const ID = z.string().uuid();
-const Name = z.string().trim().min(1).max(200);
-const Breed = z.string().trim().min(1).max(200);
-const Age = z.number().min(0).max(30);
-const CreatedAt = z.date().nullish();
-const UpdatedAt = z.date().nullish();
-const DeletedAt = z.date().nullish();
+const ID = InputValidator.string().uuid();
+const Name = InputValidator.string().trim().min(1).max(200);
+const Breed = InputValidator.string().trim().min(1).max(200);
+const Age = InputValidator.number().min(0).max(30);
+const CreatedAt = InputValidator.date().nullish();
+const UpdatedAt = InputValidator.date().nullish();
+const DeletedAt = InputValidator.date().nullish();
 
-export const CatEntitySchema = z.object({
+export const CatEntitySchema = InputValidator.object({
   id: ID,
   name: Name,
   breed: Breed,
@@ -20,7 +19,7 @@ export const CatEntitySchema = z.object({
   deletedAt: DeletedAt
 });
 
-type Cat = z.infer<typeof CatEntitySchema>;
+type Cat = Infer<typeof CatEntitySchema>;
 
 export class CatEntity extends BaseEntity<CatEntity>() {
   name!: string;

src/core/cat/entity/cat.ts

@@ -1,10 +1,10 @@
 import { Test } from '@nestjs/testing';
 import { TestMock } from 'test/mock';
-import { ZodIssue } from 'zod';
 
 import { CreatedModel } from '@/infra/repository';
 import { ICatCreateAdapter } from '@/modules/cat/adapter';
 import { ApiInternalServerException } from '@/utils/exception';
+import { ZodExceptionIssue } from '@/utils/validator';
 
 import { CatEntity } from '../../entity/cat';
 import { ICatRepository } from '../../repository/cat';
@@ -39,7 +39,7 @@ describe(CatCreateUsecase.name, () => {
   test('when no input is specified, should expect an error', async () => {
     await TestMock.expectZodError(
       () => usecase.execute({} as CatCreateInput, TestMock.getMockTracing()),
-      (issues: ZodIssue[]) => {
+      (issues: ZodExceptionIssue[]) => {
         expect(issues).toEqual([
           { message: 'Required', path: TestMock.nameOf<CatCreateInput>('name') },
           { message: 'Required', path: TestMock.nameOf<CatCreateInput>('breed') },

src/core/cat/use-cases/__tests__/cat-create.spec.ts

@@ -1,12 +1,12 @@
 import { Test } from '@nestjs/testing';
 import { TestMock } from 'test/mock';
-import { ZodIssue } from 'zod';
 
 import { CatDeleteInput, CatDeleteUsecase } from '@/core/cat/use-cases/cat-delete';
 import { ILoggerAdapter, LoggerModule } from '@/infra/logger';
 import { UpdatedModel } from '@/infra/repository';
 import { ICatDeleteAdapter } from '@/modules/cat/adapter';
 import { ApiNotFoundException } from '@/utils/exception';
+import { ZodExceptionIssue } from '@/utils/validator';
 
 import { CatEntity } from '../../entity/cat';
 import { ICatRepository } from '../../repository/cat';
@@ -40,7 +40,7 @@ describe(CatDeleteUsecase.name, () => {
   test('when no input is specified, should expect an error', async () => {
     await TestMock.expectZodError(
       () => usecase.execute({} as CatDeleteInput, TestMock.getMockTracing()),
-      (issues: ZodIssue[]) => {
+      (issues: ZodExceptionIssue[]) => {
         expect(issues).toEqual([{ message: 'Required', path: TestMock.nameOf<CatDeleteInput>('id') }]);
       }
     );

src/core/cat/use-cases/__tests__/cat-delete.spec.ts

@@ -1,10 +1,10 @@
 import { Test } from '@nestjs/testing';
 import { TestMock } from 'test/mock';
-import { ZodIssue } from 'zod';
 
 import { ILoggerAdapter, LoggerModule } from '@/infra/logger';
 import { ICatGetByIdAdapter } from '@/modules/cat/adapter';
 import { ApiNotFoundException } from '@/utils/exception';
+import { ZodExceptionIssue } from '@/utils/validator';
 
 import { CatEntity } from '../../entity/cat';
 import { ICatRepository } from '../../repository/cat';
@@ -39,7 +39,7 @@ describe(CatGetByIdUsecase.name, () => {
   test('when no input is specified, should expect an error', async () => {
     await TestMock.expectZodError(
       () => usecase.execute({} as CatGetByIdInput),
-      (issues: ZodIssue[]) => {
+      (issues: ZodExceptionIssue[]) => {
         expect(issues).toEqual([{ message: 'Required', path: TestMock.nameOf<CatGetByIdInput>('id') }]);
       }
     );

src/core/cat/use-cases/__tests__/cat-get-by-id.spec.ts

@@ -1,10 +1,10 @@
 import { Test } from '@nestjs/testing';
 import { TestMock } from 'test/mock';
-import { ZodIssue } from 'zod';
 
 import { CatListInput, CatListOutput, CatListUsecase } from '@/core/cat/use-cases/cat-list';
 import { ILoggerAdapter, LoggerModule } from '@/infra/logger';
 import { ICatListAdapter } from '@/modules/cat/adapter';
+import { ZodExceptionIssue } from '@/utils/validator';
 
 import { CatEntity } from '../../entity/cat';
 import { ICatRepository } from '../../repository/cat';
@@ -38,7 +38,7 @@ describe(CatListUsecase.name, () => {
   test('when no input is specified, should expect an error', async () => {
     await TestMock.expectZodError(
       () => usecase.execute({} as CatListInput),
-      (issues: ZodIssue[]) => {
+      (issues: ZodExceptionIssue[]) => {
         expect(issues).toEqual([{ message: 'Required', path: TestMock.nameOf<CatListInput>('search') }]);
       }
     );

src/core/cat/use-cases/__tests__/cat-list.spec.ts

@@ -1,11 +1,11 @@
 import { Test } from '@nestjs/testing';
 import { TestMock } from 'test/mock';
-import { ZodIssue } from 'zod';
 
 import { ILoggerAdapter, LoggerModule } from '@/infra/logger';
 import { UpdatedModel } from '@/infra/repository';
 import { ICatUpdateAdapter } from '@/modules/cat/adapter';
 import { ApiNotFoundException } from '@/utils/exception';
+import { ZodExceptionIssue } from '@/utils/validator';
 
 import { CatEntity } from '../../entity/cat';
 import { ICatRepository } from '../../repository/cat';
@@ -40,7 +40,7 @@ describe(CatUpdateUsecase.name, () => {
   test('when no input is specified, should expect an error', async () => {
     await TestMock.expectZodError(
       () => usecase.execute({} as CatUpdateInput, TestMock.getMockTracing()),
-      (issues: ZodIssue[]) => {
+      (issues: ZodExceptionIssue[]) => {
         expect(issues).toEqual([{ message: 'Required', path: TestMock.nameOf<CatUpdateInput>('id') }]);
       }
     );

src/core/cat/use-cases/__tests__/cat-update.spec.ts

@@ -1,10 +1,9 @@
-import { z } from 'zod';
-
 import { CreatedModel } from '@/infra/repository';
 import { ValidateSchema } from '@/utils/decorators';
 import { ApiTrancingInput } from '@/utils/request';
 import { IUsecase } from '@/utils/usecase';
 import { UUIDUtils } from '@/utils/uuid';
+import { Infer } from '@/utils/validator';
 
 import { CatEntity, CatEntitySchema } from '../entity/cat';
 import { ICatRepository } from '../repository/cat';
@@ -30,5 +29,5 @@ export class CatCreateUsecase implements IUsecase {
   }
 }
 
-export type CatCreateInput = z.infer<typeof CatCreateSchema>;
+export type CatCreateInput = Infer<typeof CatCreateSchema>;
 export type CatCreateOutput = CreatedModel;

src/core/cat/use-cases/cat-create.ts

@@ -1,10 +1,9 @@
-import { z } from 'zod';
-
 import { ICatRepository } from '@/core/cat/repository/cat';
 import { ValidateSchema } from '@/utils/decorators';
 import { ApiNotFoundException } from '@/utils/exception';
 import { ApiTrancingInput } from '@/utils/request';
 import { IUsecase } from '@/utils/usecase';
+import { Infer } from '@/utils/validator';
 
 import { CatEntity, CatEntitySchema } from '../entity/cat';
 
@@ -34,5 +33,5 @@ export class CatDeleteUsecase implements IUsecase {
   }
 }
 
-export type CatDeleteInput = z.infer<typeof CatDeleteSchema>;
+export type CatDeleteInput = Infer<typeof CatDeleteSchema>;
 export type CatDeleteOutput = CatEntity;