Migrate zod and associated dependencies to v4

Author: devksingh4

package.json

@@ -48,7 +48,7 @@
     "@typescript-eslint/eslint-plugin": "^8.0.1",
     "@typescript-eslint/parser": "^8.0.1",
     "@vitejs/plugin-react": "^4.3.1",
-    "@vitest/coverage-istanbul": "3.1.2",
+    "@vitest/coverage-istanbul": "^3.1.2",
     "@vitest/ui": "^3.1.2",
     "aws-sdk-client-mock": "^4.1.0",
     "concurrently": "^9.1.2",
@@ -86,10 +86,10 @@
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.31.0",
     "vite-tsconfig-paths": "^5.0.1",
-    "vitest": "^3.1.2",
+    "vitest": "^3.2.4",
     "yarn-upgrade-all": "^0.7.5"
   },
   "resolutions": {
     "pdfjs-dist": "^4.8.69"
   }
-}
+}

src/api/build.js

@@ -41,7 +41,6 @@ const commonParams = {
       const require = topLevelCreateRequire(import.meta.url);
       const __filename = fileURLToPath(import.meta.url);
       const __dirname = path.dirname(__filename);
-      import "zod-openapi/extend";
     `.trim(),
   }, // Banner for compatibility with CommonJS
   plugins: [
@@ -60,7 +59,6 @@ const commonParams = {
       },
     }),
   ],
-  inject: [resolve(process.cwd(), "./zod-openapi-patch.js")],
 };
 esbuild
   .build({

src/api/components/index.ts

@@ -1,13 +1,13 @@
 import { AppRoles } from "common/roles.js";
 import { FastifyZodOpenApiSchema } from "fastify-zod-openapi";
-import { z } from "zod";
+import * as z from "zod/v4";
 
 export const ts = z.coerce
   .number()
   .min(0)
   .optional()
-  .openapi({ description: "Staleness bound", example: 0 });
-export const groupId = z.string().min(1).openapi({
+  .meta({ description: "Staleness bound", example: 0 });
+export const groupId = z.string().min(1).meta({
   description: "Entra ID Group ID",
   example: "d8cbb7c9-2f6d-4b7e-8ba6-b54f8892003b",
 });

src/api/esbuild.config.js

@@ -35,7 +35,6 @@ const buildOptions = {
       const require = topLevelCreateRequire(import.meta.url);
       const __filename = fileURLToPath(import.meta.url);
       const __dirname = path.dirname(__filename);
-      import "zod-openapi/extend";
     `.trim(),
   }, // Banner for compatibility with CommonJS
   plugins: [

src/api/functions/auditLog.ts

@@ -20,11 +20,14 @@ function buildMarshalledAuditLogItem(entry: AuditLogEntry) {
   const expireAt =
     timestamp + Math.floor((RETENTION_DAYS * 24 * 60 * 60 * 1000) / 1000);
 
-  return marshall({
-    ...entry,
-    createdAt: timestamp,
-    expireAt,
-  });
+  return marshall(
+    {
+      ...entry,
+      createdAt: timestamp,
+      expireAt,
+    },
+    { removeUndefinedValues: true },
+  );
 }
 
 export async function createAuditLogEntry({

src/api/functions/validation.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import * as z from "zod/v4";
 
 export function validateEmail(email: string): boolean {
   const emailSchema = z.string().email();

src/api/index.ts

@@ -1,5 +1,5 @@
 /* eslint import/no-nodejs-modules: ["error", {"allow": ["crypto"]}] */
-import "zod-openapi/extend";
+
 import { randomUUID } from "crypto";
 import fastify, { FastifyInstance } from "fastify";
 import FastifyAuthProvider from "@fastify/auth";
@@ -126,6 +126,7 @@ async function init(prettyPrint: boolean = false) {
           description: "QA API server",
         },
       ],
+
       tags: [
         {
           name: "Events",
@@ -177,6 +178,7 @@ async function init(prettyPrint: boolean = false) {
           description: "Manage the lifecycle of API keys.",
         },
       ],
+
       openapi: "3.1.0" satisfies ZodOpenApiVersion, // If this is not specified, it will default to 3.1.0
       components: {
         securitySchemes: {

src/api/lambda.ts

@@ -1,4 +1,3 @@
-import "zod-openapi/extend";
 import awsLambdaFastify, { LambdaResponse } from "@fastify/aws-lambda";
 import init from "./index.js";
 import warmer from "lambda-warmer";

src/api/package.json

@@ -44,7 +44,7 @@
     "fastify": "^5.3.2",
     "fastify-plugin": "^5.0.1",
     "fastify-raw-body": "^5.0.0",
-    "fastify-zod-openapi": "^4.1.1",
+    "fastify-zod-openapi": "^5.0.1",
     "handlebars": "^4.7.8",
     "ical-generator": "^8.1.1",
     "ioredis": "^5.6.1",
@@ -60,8 +60,7 @@
     "qrcode": "^1.5.4",
     "stripe": "^18.0.0",
     "uuid": "^11.1.0",
-    "zod": "^3.24.3",
-    "zod-openapi": "^4.2.4",
+    "zod": "^3.25.73",
     "zod-validation-error": "^3.3.1"
   },
   "devDependencies": {

src/api/routes/apiKey.ts

@@ -21,7 +21,7 @@ import {
   DatabaseInsertError,
   ValidationError,
 } from "common/errors/index.js";
-import { z } from "zod";
+import * as z from "zod/v4";
 import { AvailableSQSFunctions, SQSPayload } from "common/types/sqsMessage.js";
 import { SendMessageCommand, SQSClient } from "@aws-sdk/client-sqs";
 
@@ -71,7 +71,7 @@ const apiKeyRoute: FastifyPluginAsync = async (fastify, _options) => {
           {
             Put: {
               TableName: genericConfig.ApiKeyTable,
-              Item: marshall(apiKeyPayload),
+              Item: marshall(apiKeyPayload, { removeUndefinedValues: true }),
               ConditionExpression: "attribute_not_exists(keyId)",
             },
           },
@@ -145,7 +145,7 @@ If you did not create this API key, please secure your account and notify the AC
         withTags(["API Keys"], {
           summary: "Delete an organization API key.",
           params: z.object({
-            keyId: z.string().min(1).openapi({
+            keyId: z.string().min(1).meta({
               description:
                 "Key ID to delete. The key ID is the second segment of the API key.",
             }),