refactor(validation): replace ajv with zod (#73)

refactors all the remaining AJV schema validation

to review more easily, you can review 1 commit at a time. each commit
should be reviewable by itself

cc
https://linear.app/valora/issue/ACT-528/use-zod-instead-of-ajv-in-fiatconnect-api-starter-mock-provider

package.json

@@ -25,7 +25,6 @@
     "@typescript-eslint/eslint-plugin": "^5.40.1",
     "@valora/eslint-config-typescript": "^0.0.1",
     "@valora/prettier-config": "^0.0.1",
-    "ajv": "^8.11.0",
     "dotenv": "^16.0.3",
     "eslint": "^8.25.0",
     "eslint-plugin-import": "^2.26.0",

src/routes/accounts.ts

@@ -1,13 +1,16 @@
 import express from 'express'
 import { asyncRoute } from './async-route'
-import { validateSchema, validateZodSchema } from '../schema/'
+import { validateZodSchema } from '../schema/'
 import {
   DeleteFiatAccountRequestParams,
   NotImplementedError,
   PostFiatAccountRequestBody,
 } from '../types'
 import { siweAuthMiddleware } from '../middleware/authenticate'
-import { postFiatAccountRequestBodySchema } from '@fiatconnect/fiatconnect-types'
+import {
+  deleteFiatAccountRequestParamsSchema,
+  postFiatAccountRequestBodySchema,
+} from '@fiatconnect/fiatconnect-types'
 
 export function accountsRouter({
   clientAuthMiddleware,
@@ -33,9 +36,9 @@ export function accountsRouter({
     _res: express.Response,
     next: express.NextFunction,
   ) => {
-    req.params = validateSchema<DeleteFiatAccountRequestParams>(
+    req.params = validateZodSchema(
       req.params,
-      'DeleteFiatAccountRequestParamsSchema',
+      deleteFiatAccountRequestParamsSchema,
     )
     next()
   }

src/routes/auth.ts

@@ -1,13 +1,14 @@
 import express from 'express'
 import { ErrorTypes, SiweMessage } from 'siwe'
-import { validateSchema } from '../schema'
+import { validateZodSchema } from '../schema'
 import {
   AuthRequestBody,
   FiatConnectError,
   InvalidSiweParamsError,
   NotImplementedError,
 } from '../types'
 import { asyncRoute } from './async-route'
+import { authRequestBodySchema } from '@fiatconnect/fiatconnect-types'
 
 const MAX_EXPIRATION_TIME_MS = 4 * 60 * 60 * 1000 // 4 hours
 const VERSION = '1'
@@ -73,10 +74,7 @@ export function authRouter({ chainId }: { chainId: number }): express.Router {
     _res: express.Response,
     next: express.NextFunction,
   ) => {
-    req.body = validateSchema<AuthRequestBody>(
-      req.body,
-      'AuthRequestBodySchema',
-    )
+    req.body = validateZodSchema(req.body, authRequestBodySchema)
     next()
   }
 

src/routes/kyc.ts

@@ -1,13 +1,24 @@
 import express from 'express'
 import { asyncRoute } from './async-route'
-import { validateSchema } from '../schema/'
+import { validateZodSchema } from '../schema/'
 import {
   KycRequestParams,
   KycSchemas,
   NotImplementedError,
   SupportedKycSchemas,
 } from '../types'
 import { siweAuthMiddleware } from '../middleware/authenticate'
+import {
+  kycRequestParamsSchema,
+  KycSchema,
+  personalDataAndDocumentsKycSchema,
+} from '@fiatconnect/fiatconnect-types'
+import { AnyZodObject } from 'zod'
+
+const kycSchemaToZodSchema: { [kycSchema in KycSchema]: AnyZodObject } = {
+  // if a KYC schema is missing, that should be evident at compile-time, as long as fiatconnect-types is up to date
+  [KycSchema.PersonalDataAndDocuments]: personalDataAndDocumentsKycSchema,
+}
 
 export function kycRouter({
   clientAuthMiddleware,
@@ -24,10 +35,7 @@ export function kycRouter({
     _res: express.Response,
     next: express.NextFunction,
   ) => {
-    req.params = validateSchema<KycRequestParams>(
-      req.params,
-      'KycRequestParamsSchema',
-    )
+    req.params = validateZodSchema(req.params, kycRequestParamsSchema)
     next()
   }
 
@@ -44,10 +52,7 @@ export function kycRouter({
         _res: express.Response,
       ) => {
         // Delegate to type-specific handlers after validation provides type guards
-        validateSchema<KycSchemas[typeof req.params.kycSchema]>(
-          req.body,
-          `${req.params.kycSchema}KycSchema`,
-        )
+        validateZodSchema(req.body, kycSchemaToZodSchema[req.params.kycSchema])
 
         throw new NotImplementedError('POST /kyc/:kycSchema not implemented')
       },

src/routes/quote.ts

@@ -1,7 +1,8 @@
 import express from 'express'
 import { asyncRoute } from './async-route'
-import { validateSchema } from '../schema/'
+import { validateZodSchema } from '../schema/'
 import { QuoteRequestBody, NotImplementedError } from '../types'
+import { quoteRequestBodySchema } from '@fiatconnect/fiatconnect-types'
 
 export function quoteRouter({
   clientAuthMiddleware,
@@ -18,10 +19,7 @@ export function quoteRouter({
       _res: express.Response,
       next: express.NextFunction,
     ) => {
-      req.body = validateSchema<QuoteRequestBody>(
-        req.body,
-        'QuoteRequestBodySchema',
-      )
+      req.body = validateZodSchema(req.body, quoteRequestBodySchema)
       next()
     },
   )

src/routes/transfer.ts

@@ -1,12 +1,16 @@
 import express from 'express'
 import { asyncRoute } from './async-route'
-import { validateSchema } from '../schema/'
+import { validateZodSchema } from '../schema/'
 import {
   TransferRequestBody,
   TransferStatusRequestParams,
   NotImplementedError,
 } from '../types'
 import { siweAuthMiddleware } from '../middleware/authenticate'
+import {
+  transferRequestBodySchema,
+  transferStatusRequestParamsSchema,
+} from '@fiatconnect/fiatconnect-types'
 
 export function transferRouter({
   clientAuthMiddleware,
@@ -23,10 +27,7 @@ export function transferRouter({
     _res: express.Response,
     next: express.NextFunction,
   ) => {
-    req.body = validateSchema<TransferRequestBody>(
-      req.body,
-      'TransferRequestBodySchema',
-    )
+    req.body = validateZodSchema(req.body, transferRequestBodySchema)
     next()
   }
 
@@ -35,9 +36,9 @@ export function transferRouter({
     _res: express.Response,
     next: express.NextFunction,
   ) => {
-    req.params = validateSchema<TransferStatusRequestParams>(
+    req.params = validateZodSchema(
       req.params,
-      'TransferStatusRequestParamsSchema',
+      transferStatusRequestParamsSchema,
     )
     next()
   }

src/schema/index.ts

@@ -1,45 +1,8 @@
-import Ajv from 'ajv'
 import { ValidationError } from '../types'
 
-import { quoteRequestBodySchema } from './quote-request-body'
-import { kycRequestParamsSchema } from './kyc-request-params'
-import { personalDataAndDocumentsKycSchema } from './personal-data-and-documents-kyc'
-import { deleteFiatAccountRequestParamsSchema } from './delete-fiat-account-request-params'
-import { transferRequestBodySchema } from './transfer-request-body'
-import { transferStatusRequestParamsSchema } from './transfer-status-request-params'
-import { authRequestBodySchema } from './auth-request-body'
 import { z, ZodError } from 'zod'
 import { ZodType } from 'zod/lib/types'
 
-const ajv = new Ajv({
-  schemas: [
-    quoteRequestBodySchema,
-    kycRequestParamsSchema,
-    personalDataAndDocumentsKycSchema,
-    deleteFiatAccountRequestParamsSchema,
-    transferRequestBodySchema,
-    transferStatusRequestParamsSchema,
-    authRequestBodySchema,
-  ],
-})
-
-/**
- * Validate AJV schema
- *
- * @deprecated - prefer validateZodSchema (more re-usable with fiatconnect-types)
- *
- * @param data
- * @param schema
- */
-export function validateSchema<T>(data: any, schema: string): T {
-  if (ajv.validate(schema, data)) return data
-
-  throw new ValidationError(
-    `Error while validating schema: invalid ${schema}`,
-    ajv.errors,
-  )
-}
-
 /**
  * Validate zod schema
  *