chore: upgrade to zod 4

.vscode/extensions.json

@@ -4,12 +4,9 @@
     "esbenp.prettier-vscode",
     "mikestead.dotenv",
     "prisma.prisma",
-    "vscode-icons-team.vscode-icons",
     "streetsidesoftware.code-spell-checker",
     "eamodio.gitlens",
     "ms-playwright.playwright",
-    "wayou.vscode-todo-highlight",
-    "orta.vscode-jest",
-    "firsttris.vscode-jest-runner"
+    "wayou.vscode-todo-highlight"
   ]
 }

apps/api/src/app/controllers/auth.controller.ts

@@ -71,7 +71,7 @@ export const routeDefinition = {
   getCsrfToken: {
     controllerFn: () => getCsrfToken,
     validators: {
-      query: z.record(z.any()),
+      query: z.record(z.string(), z.any()),
       hasSourceOrg: false,
     },
   },
@@ -86,29 +86,29 @@ export const routeDefinition = {
     validators: {
       params: z.object({ provider: OauthProviderTypeSchema }),
       query: z.object({ returnUrl: z.string().nullish(), isAccountLink: z.literal('true').nullish() }),
-      body: z.object({ csrfToken: z.string(), callbackUrl: z.string().url() }),
+      body: z.object({ csrfToken: z.string(), callbackUrl: z.url() }),
       hasSourceOrg: false,
     },
   },
   callback: {
     controllerFn: () => callback,
     validators: {
-      query: z.record(z.any()),
+      query: z.record(z.string(), z.any()),
       params: z.object({ provider: ProviderKeysSchema }),
       body: z.union([
         z.discriminatedUnion('action', [
           z.object({
             action: z.literal('login'),
             csrfToken: z.string(),
             captchaToken: z.string().nullish(),
-            email: z.string().email().min(5).max(255).toLowerCase(),
+            email: z.email().min(5).max(255).toLowerCase(),
             password: z.string().min(8).max(255),
           }),
           z.object({
             action: z.literal('register'),
             csrfToken: z.string(),
             captchaToken: z.string().nullish(),
-            email: z.string().email().min(5).max(255).toLowerCase(),
+            email: z.email().min(5).max(255).toLowerCase(),
             name: z.string().min(1).max(255).trim(),
             password: z.string().min(8).max(255),
           }),
@@ -162,7 +162,7 @@ export const routeDefinition = {
     controllerFn: () => validatePasswordReset,
     validators: {
       body: z.object({
-        email: z.string().email().toLowerCase(),
+        email: z.email().toLowerCase(),
         token: z.string(),
         password: z.string(),
         csrfToken: z.string(),

apps/api/src/app/controllers/data-sync.controller.ts

@@ -10,12 +10,11 @@ import { createRoute } from '../utils/route.utils';
 
 // FIXME: TEMPORARY UNTIL ALL CLIENTS HAVE BEEN BACKFILLED
 export const SyncRecordOperationSchemaFillHashedKey = z
-  .object({
+  .looseObject({
     key: z.string(),
     hashedKey: z.string().optional(),
-    data: z.record(z.unknown()),
+    data: z.record(z.string(), z.unknown()),
   })
-  .passthrough()
   .array()
   .transform((records) => {
     return SyncRecordOperationSchema.array()
@@ -61,7 +60,7 @@ export const routeDefinition = {
     controllerFn: () => push,
     validators: {
       query: z.object({
-        clientId: z.string().uuid(),
+        clientId: z.uuid(),
         updatedAt: z
           .string()
           .regex(REGEX.ISO_DATE)

apps/api/src/app/controllers/desktop-app.controller.ts

@@ -35,7 +35,7 @@ export const routeDefinition = {
     controllerFn: () => initSession,
     validators: {
       query: z.object({
-        deviceId: z.string().uuid(),
+        deviceId: z.uuid(),
       }),
       hasSourceOrg: false,
     },

apps/api/src/app/controllers/jetstream-organizations.controller.ts

@@ -25,7 +25,7 @@ export const routeDefinition = {
     controllerFn: () => updateOrganization,
     validators: {
       params: z.object({
-        id: z.string().uuid(),
+        id: z.uuid(),
       }),
       body: z.object({
         name: z.string(),
@@ -38,7 +38,7 @@ export const routeDefinition = {
     controllerFn: () => deleteOrganization,
     validators: {
       params: z.object({
-        id: z.string().uuid(),
+        id: z.uuid(),
       }),
       hasSourceOrg: false,
     },

apps/api/src/app/controllers/oauth.controller.ts

@@ -36,7 +36,7 @@ export const routeDefinition = {
   salesforceOauthCallback: {
     controllerFn: () => salesforceOauthCallback,
     validators: {
-      query: z.record(z.any()),
+      query: z.record(z.string(), z.any()),
       hasSourceOrg: false,
     },
   },

apps/api/src/app/controllers/orgs.controller.ts

@@ -46,7 +46,7 @@ export const routeDefinition = {
         uniqueId: z.string().min(1),
       }),
       body: z.object({
-        jetstreamOrganizationId: z.string().uuid().nullish(),
+        jetstreamOrganizationId: z.uuid().nullish(),
       }),
       hasSourceOrg: false,
     },

apps/api/src/app/controllers/web-extension.controller.ts

@@ -31,7 +31,7 @@ export const routeDefinition = {
     controllerFn: () => initSession,
     validators: {
       query: z.object({
-        deviceId: z.string().uuid(),
+        deviceId: z.uuid(),
       }),
       hasSourceOrg: false,
     },

apps/jetstream-desktop-client/src/app/components/profile/ProfileUserPassword.tsx

@@ -13,10 +13,11 @@ const FormSchema = z
   })
   .superRefine((data, ctx) => {
     if (data.password !== data.confirmPassword) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
+      ctx.issues.push({
+        code: 'custom',
         message: 'Passwords do not match',
         path: ['confirmPassword'],
+        input: '',
       });
     }
   });

apps/jetstream-desktop/src/config/environment.ts

@@ -59,11 +59,11 @@ const envSchema = z.object({
     .optional()
     .transform((value) => value ?? 'production'),
   CLIENT_URL: z.string(),
-  SERVER_URL: z.string().url(),
+  SERVER_URL: z.url(),
   // TODO: allow updating this in the app
   SFDC_API_VERSION: z.string().regex(/^[0-9]{2,4}\.[0-9]$/),
   DESKTOP_SFDC_CLIENT_ID: z.string().min(1),
-  DESKTOP_SFDC_CALLBACK_URL: z.string().url(),
+  DESKTOP_SFDC_CALLBACK_URL: z.url(),
 });
 
 const parseResults = envSchema.safeParse({
@@ -73,7 +73,7 @@ const parseResults = envSchema.safeParse({
 
 if (!parseResults.success) {
   console.error(`❌ ${chalk.red('Error parsing environment variables:')}
-${chalk.yellow(JSON.stringify(parseResults.error.flatten().fieldErrors, null, 2))}
+${chalk.yellow(JSON.stringify(z.treeifyError(parseResults.error), null, 2))}
 `);
   process.exit(1);
 }

apps/jetstream-desktop/src/controllers/jetstream-orgs.desktop.controller.ts

@@ -14,7 +14,7 @@ export const routeDefinition = {
     validators: {
       body: z.object({
         name: z.string(),
-        description: z.string().optional().nullable().default(null),
+        description: z.string().optional().nullable().prefault(null),
       }),
       hasSourceOrg: false,
     },
@@ -23,11 +23,11 @@ export const routeDefinition = {
     controllerFn: () => updateOrganization,
     validators: {
       params: z.object({
-        id: z.string().uuid(),
+        id: z.uuid(),
       }),
       body: z.object({
         name: z.string(),
-        description: z.string().optional().nullable().default(null),
+        description: z.string().optional().nullable().prefault(null),
       }),
       hasSourceOrg: false,
     },
@@ -36,7 +36,7 @@ export const routeDefinition = {
     controllerFn: () => deleteOrganization,
     validators: {
       params: z.object({
-        id: z.string().uuid(),
+        id: z.uuid(),
       }),
       hasSourceOrg: false,
     },

apps/jetstream-desktop/src/controllers/orgs.desktop.controller.ts

@@ -43,7 +43,7 @@ export const routeDefinition = {
         uniqueId: z.string().min(1),
       }),
       body: z.object({
-        jetstreamOrganizationId: z.string().uuid().nullish().default(null),
+        jetstreamOrganizationId: z.uuid().nullish().default(null),
       }),
       hasSourceOrg: false,
     },

apps/jetstream/src/app/components/profile/ProfileUserPassword.tsx

@@ -13,10 +13,11 @@ const FormSchema = z
   })
   .superRefine((data, ctx) => {
     if (data.password !== data.confirmPassword) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
+      ctx.issues.push({
+        code: 'custom',
         message: 'Passwords do not match',
         path: ['confirmPassword'],
+        input: '',
       });
     }
   });

apps/landing/components/auth/LoginOrSignUp.tsx

@@ -19,23 +19,24 @@ const LoginSchema = z.object({
   action: z.literal('login'),
   csrfToken: z.string(),
   captchaToken: z.string(),
-  email: z.string().email({ message: 'A valid email address is required' }).min(5).max(255).trim(),
+  email: z.email().min(5).max(255).trim(),
   password: PasswordSchema,
 });
 
 const RegisterSchema = LoginSchema.omit({ action: true }).extend({
   action: z.literal('register'),
-  name: z.string().min(1, { message: 'Name is required' }).max(255, { message: 'Name must be at most 255 characters' }),
+  name: z.string().min(1, { error: 'Name is required' }).max(255, { error: 'Name must be at most 255 characters' }),
   confirmPassword: PasswordSchema,
 });
 
 const FormSchema = z.discriminatedUnion('action', [LoginSchema, RegisterSchema]).superRefine((data, ctx) => {
   if (data.action === 'register') {
     if (data.password !== data.confirmPassword) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
+      ctx.issues.push({
+        code: 'custom',
         message: 'Passwords do not match',
         path: ['confirmPassword'],
+        input: '',
       });
     }
   }

apps/landing/components/auth/PasswordResetInit.tsx

@@ -14,7 +14,7 @@ import { Captcha } from './Captcha';
 const FormSchema = z.object({
   csrfToken: z.string(),
   captchaToken: z.string(),
-  email: z.string().email({ message: 'A valid email address is required' }).min(5).max(255).trim(),
+  email: z.email({ error: 'A valid email address is required' }).min(5).max(255).trim(),
 });
 
 type Form = z.infer<typeof FormSchema>;

apps/landing/components/auth/PasswordResetVerify.tsx

@@ -21,10 +21,11 @@ const FormSchema = z
   })
   .superRefine((data, ctx) => {
     if (data.password !== data.confirmPassword) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
+      ctx.issues.push({
+        code: 'custom',
         message: 'Passwords do not match',
         path: ['confirmPassword'],
+        input: '',
       });
     }
   });

apps/landing/utils/types.ts

@@ -4,9 +4,9 @@ import { z } from 'zod';
 
 export const PasswordSchema = z
   .string()
-  .min(1, { message: 'Password is required' })
-  .min(8, { message: 'Password must be at least 8 characters' })
-  .max(255, { message: 'Password must be at most 255 characters' });
+  .min(1, { error: 'Password is required' })
+  .min(8, { error: 'Password must be at least 8 characters' })
+  .max(255, { error: 'Password must be at most 255 characters' });
 
 export interface AnalyticSummaryItem {
   type: 'LOAD_SUMMARY' | 'QUERY_SUMMARY';

libs/api-config/src/lib/env-config.ts

@@ -95,7 +95,7 @@ const envSchema = z.object({
     })
     .nullish(),
   EXAMPLE_USER_PASSWORD: z.string().nullish(),
-  EXAMPLE_USER_FULL_PROFILE: z.record(z.any()).nullish(),
+  EXAMPLE_USER_FULL_PROFILE: z.record(z.string(), z.any()).nullish(),
   IS_LOCAL_DOCKER: booleanSchema,
   // SYSTEM
   NODE_ENV: z
@@ -134,7 +134,7 @@ const envSchema = z.object({
     .transform((val) => val || null),
   JETSTREAM_POSTGRES_DBURI: z.string(),
   JETSTREAM_SERVER_DOMAIN: z.string(),
-  JETSTREAM_SERVER_URL: z.string().url(),
+  JETSTREAM_SERVER_URL: z.url(),
   JETSTREAM_CLIENT_URL: z.string(),
   PRISMA_DEBUG: booleanSchema,
   COMETD_DEBUG: z.enum(['error', 'warn', 'info', 'debug']).optional(),
@@ -191,7 +191,7 @@ const envSchema = z.object({
   SFDC_API_VERSION: z.string().regex(/^[0-9]{2,4}\.[0-9]$/),
   SFDC_CONSUMER_SECRET: z.string().min(1),
   SFDC_CONSUMER_KEY: z.string().min(1),
-  SFDC_CALLBACK_URL: z.string().url(),
+  SFDC_CALLBACK_URL: z.url(),
   /**
    * Google OAuth2
    * Allows google drive configuration
@@ -239,7 +239,7 @@ const parseResults = envSchema.safeParse({
 
 if (!parseResults.success) {
   console.error(`❌ ${chalk.red('Error parsing environment variables:')}
-${chalk.yellow(JSON.stringify(parseResults.error.flatten().fieldErrors, null, 2))}
+${chalk.yellow(JSON.stringify(z.treeifyError(parseResults.error), null, 2))}
 `);
   process.exit(1);
 }

libs/api-types/src/lib/api-metadata.types.ts

@@ -30,6 +30,7 @@ export const DeployMetadataRequestSchema = z.object({
 export type DeployMetadataRequest = z.infer<typeof DeployMetadataRequestSchema>;
 
 export const RetrievePackageFromLisMetadataResultsRequestSchema = z.record(
+  z.string(),
   z
     .object({
       fullName: z.string(),
@@ -63,14 +64,15 @@ export type CheckRetrieveStatusAndRedeployRequest = z.infer<typeof CheckRetrieve
 
 export const GetPackageXmlSchema = z.object({
   metadata: z.record(
+    z.string(),
     z
       .object({
         fullName: z.string(),
         namespacePrefix: z.string().nullish(),
       })
       .array()
   ), // TODO: define metadata type
-  otherFields: z.record(z.string()).nullish(),
+  otherFields: z.record(z.string(), z.string()).nullish(),
 });
 export type GetPackageXml = z.infer<typeof GetPackageXmlSchema>;
 

libs/api-types/src/lib/api-misc.types.ts

@@ -5,7 +5,7 @@ export const SalesforceApiRequestSchema = z.object({
   method: z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
   isTooling: z.boolean().nullish(),
   body: z.any().nullish(),
-  headers: z.record(z.string()).nullish(),
+  headers: z.record(z.string(), z.string()).nullish(),
   options: z
     .object({
       responseType: z.enum(['json', 'text']).nullish().default('json'),

libs/api-types/src/lib/api-shared.types.ts

@@ -26,7 +26,7 @@ export const DeployOptionsSchema = z
       }
       return record;
     },
-    { message: 'RunSpecifiedTests requires specified tests to be provided' }
+    { error: 'RunSpecifiedTests requires specified tests to be provided' }
   )
   .transform((record) => {
     if (record.testLevel !== 'RunSpecifiedTests' && record.runTests) {