Migrate to zod v4 (#298)

Author: kibertoad

.github/workflows/ci.common.yml

@@ -39,3 +39,6 @@ jobs:
 
       - name: Docker stop
         run: npm run docker:stop:ci -- --filter=${{ inputs.package_name }}
+
+      - name: Run lint
+        run: npm run lint

.github/workflows/linting.yml

@@ -11,7 +11,7 @@ import type {
   SyncPublisher,
 } from '@message-queue-toolkit/core'
 import { objectToBuffer } from '@message-queue-toolkit/core'
-import type { ZodSchema } from 'zod/v3'
+import type { ZodSchema } from 'zod/v4'
 
 import type { AMQPDependencies } from './AbstractAmqpService.ts'
 import { AbstractAmqpService } from './AbstractAmqpService.ts'

packages/amqp/lib/AbstractAmqpPublisher.ts

@@ -38,7 +38,7 @@ export abstract class AbstractAmqpQueuePublisher<
 
     this.queueName = options.locatorConfig
       ? options.locatorConfig.queueName
-      : // biome-ignore lint/style/noNonNullAssertion: <explanation>
+      : // biome-ignore lint/style/noNonNullAssertion: this is expected
         options.creationConfig!.queueName
   }
 

packages/amqp/lib/AbstractAmqpQueuePublisher.ts

@@ -9,7 +9,7 @@ import type {
 } from '@message-queue-toolkit/core'
 import { AbstractPublisherManager } from '@message-queue-toolkit/core'
 import type { AmqpAwareEventDefinition } from '@message-queue-toolkit/schemas'
-import type z from 'zod/v3'
+import type z from 'zod/v4'
 
 import type { AMQPPublisherOptions, AbstractAmqpPublisher } from './AbstractAmqpPublisher.ts'
 import type {
@@ -63,27 +63,27 @@ export type AmqpPublisherManagerOptions<
   }
 }
 
-export type AmqpMessageSchemaType<T extends AmqpAwareEventDefinition> = z.infer<
+export type AmqpMessageSchemaType<T extends AmqpAwareEventDefinition> = z.input<
   T['publisherSchema']
 >
 
 export class AmqpQueuePublisherManager<
   T extends AbstractAmqpQueuePublisher<
-    z.infer<SupportedEventDefinitions[number]['publisherSchema']>
+    z.input<SupportedEventDefinitions[number]['publisherSchema']>
   >,
   SupportedEventDefinitions extends AmqpAwareEventDefinition[],
   MetadataType = PublisherMessageMetadataType,
 > extends AbstractPublisherManager<
   AmqpAwareEventDefinition,
   NonNullable<SupportedEventDefinitions[number]['queueName']>,
-  AbstractAmqpQueuePublisher<z.infer<SupportedEventDefinitions[number]['publisherSchema']>>,
+  AbstractAmqpQueuePublisher<z.input<SupportedEventDefinitions[number]['publisherSchema']>>,
   AMQPDependencies,
   AMQPQueueCreationConfig,
   AMQPQueueLocator,
   AmqpMessageSchemaType<AmqpAwareEventDefinition>,
   Omit<
     AMQPPublisherOptions<
-      z.infer<SupportedEventDefinitions[number]['publisherSchema']>,
+      z.input<SupportedEventDefinitions[number]['publisherSchema']>,
       AMQPQueueCreationConfig,
       AMQPQueueLocator
     >,
@@ -99,11 +99,11 @@ export class AmqpQueuePublisherManager<
       T,
       AmqpQueueMessageOptions,
       AMQPPublisherOptions<
-        z.infer<SupportedEventDefinitions[number]['publisherSchema']>,
+        z.input<SupportedEventDefinitions[number]['publisherSchema']>,
         AMQPQueueCreationConfig,
         AMQPQueueLocator
       >,
-      z.infer<SupportedEventDefinitions[number]['publisherSchema']>,
+      z.input<SupportedEventDefinitions[number]['publisherSchema']>,
       MetadataType
     >,
   ) {
@@ -152,7 +152,10 @@ export class AmqpQueuePublisherManager<
 
     const messageDefinition = this.resolveMessageDefinition(queue, message)
     const resolvedMessage = this.resolveMessage(messageDefinition, message, precedingEventMetadata)
-    publisher.publish(resolvedMessage, messageOptions)
+    publisher.publish(
+      resolvedMessage as MessagePublishType<SupportedEventDefinitions[number]>,
+      messageOptions,
+    )
     return resolvedMessage
   }
 

packages/amqp/lib/AmqpQueuePublisherManager.ts

@@ -1,10 +1,6 @@
-import { AbstractPublisherManager } from '@message-queue-toolkit/core'
-import type {
-  MessagePublishType,
-  MessageSchemaType,
-  PublisherMessageMetadataType,
-} from '@message-queue-toolkit/core'
-import type z from 'zod/v3'
+import { AbstractPublisherManager, type MessageSchemaType } from '@message-queue-toolkit/core'
+import type { MessagePublishType, PublisherMessageMetadataType } from '@message-queue-toolkit/core'
+import type z from 'zod/v4'
 
 import type { AMQPDependencies, AMQPTopicPublisherConfig } from './AbstractAmqpService.ts'
 import type {
@@ -22,20 +18,20 @@ import { CommonAmqpTopicPublisherFactory } from './CommonAmqpPublisherFactory.ts
 
 export class AmqpTopicPublisherManager<
   PublisherType extends AbstractAmqpTopicPublisher<
-    z.infer<SupportedEventDefinitions[number]['publisherSchema']>
+    z.input<SupportedEventDefinitions[number]['publisherSchema']>
   >,
   SupportedEventDefinitions extends AmqpAwareEventDefinition[],
   MetadataType = PublisherMessageMetadataType,
 > extends AbstractPublisherManager<
   AmqpAwareEventDefinition,
   NonNullable<SupportedEventDefinitions[number]['exchange']>,
-  AbstractAmqpTopicPublisher<z.infer<SupportedEventDefinitions[number]['publisherSchema']>>,
+  AbstractAmqpTopicPublisher<z.input<SupportedEventDefinitions[number]['publisherSchema']>>,
   AMQPDependencies,
   AMQPTopicPublisherConfig,
   AMQPTopicPublisherConfig,
   AmqpMessageSchemaType<AmqpAwareEventDefinition>,
   Omit<
-    AMQPTopicPublisherOptions<z.infer<SupportedEventDefinitions[number]['publisherSchema']>>,
+    AMQPTopicPublisherOptions<z.input<SupportedEventDefinitions[number]['publisherSchema']>>,
     'messageSchemas' | 'locatorConfig' | 'exchange'
   >,
   SupportedEventDefinitions,
@@ -47,8 +43,8 @@ export class AmqpTopicPublisherManager<
     options: AmqpPublisherManagerOptions<
       PublisherType,
       AmqpTopicMessageOptions,
-      AMQPTopicPublisherOptions<z.infer<SupportedEventDefinitions[number]['publisherSchema']>>,
-      z.infer<SupportedEventDefinitions[number]['publisherSchema']>,
+      AMQPTopicPublisherOptions<z.input<SupportedEventDefinitions[number]['publisherSchema']>>,
+      z.input<SupportedEventDefinitions[number]['publisherSchema']>,
       MetadataType,
       AMQPTopicPublisherConfig,
       AMQPTopicPublisherConfig
@@ -73,7 +69,7 @@ export class AmqpTopicPublisherManager<
     exchange: string,
   ): Partial<
     Omit<
-      AMQPTopicPublisherOptions<z.infer<SupportedEventDefinitions[number]['publisherSchema']>>,
+      AMQPTopicPublisherOptions<z.output<SupportedEventDefinitions[number]['publisherSchema']>>,
       'messageSchemas' | 'locatorConfig'
     >
   > {
@@ -112,7 +108,7 @@ export class AmqpTopicPublisherManager<
 
     const messageDefinition = this.resolveMessageDefinition(exchange, message)
     const resolvedMessage = this.resolveMessage(messageDefinition, message, precedingEventMetadata)
-    publisher.publish(resolvedMessage, {
+    publisher.publish(resolvedMessage as MessagePublishType<SupportedEventDefinitions[number]>, {
       routingKey: messageOptions?.routingKey ?? messageDefinition?.topic ?? '',
       publishOptions: messageOptions?.publishOptions,
     })

packages/amqp/lib/AmqpTopicPublisherManager.ts

@@ -6,7 +6,7 @@ import type {
 } from '@message-queue-toolkit/core'
 import { parseMessage } from '@message-queue-toolkit/core'
 import type { Message } from 'amqplib'
-import type { ZodType } from 'zod/v3'
+import type { ZodType } from 'zod/v4'
 
 import type { AmqpConsumerErrorResolver } from './errors/AmqpConsumerErrorResolver.ts'
 

packages/amqp/lib/amqpMessageDeserializer.ts

@@ -3,7 +3,7 @@ import { types } from 'node:util'
 import type { ErrorResolver } from '@lokalise/node-core'
 import { InternalError, isStandardizedError } from '@lokalise/node-core'
 import { MessageInvalidFormatError, MessageValidationError } from '@message-queue-toolkit/core'
-import { ZodError } from 'zod/v3'
+import { ZodError } from 'zod/v4'
 
 export class AmqpConsumerErrorResolver implements ErrorResolver {
   public processError(error: unknown): InternalError {

packages/amqp/lib/errors/AmqpConsumerErrorResolver.ts

@@ -29,15 +29,15 @@
     },
     "dependencies": {
         "@lokalise/node-core": "^14.0.1",
-        "zod": "^3.25.7"
+        "zod": "^3.25.67"
     },
     "peerDependencies": {
         "@message-queue-toolkit/core": ">=21.1.0",
         "@message-queue-toolkit/schemas": ">=6.0.0",
         "amqplib": "^0.10.8"
     },
     "devDependencies": {
-        "@biomejs/biome": "2.0.5",
+        "@biomejs/biome": "1.9.4",
         "@lokalise/biome-config": "^2.0.0",
         "@lokalise/tsconfig": "^1.3.0",
         "@message-queue-toolkit/core": "*",

packages/amqp/package.json

@@ -7,7 +7,7 @@ import type { Channel } from 'amqplib'
 import type { AwilixContainer } from 'awilix'
 import { asClass, asFunction } from 'awilix'
 import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest'
-import { ZodError } from 'zod/v3'
+import { ZodError } from 'zod/v4'
 
 import { FakeConsumerErrorResolver } from '../fakes/FakeConsumerErrorResolver.ts'
 import { FakeLogger } from '../fakes/FakeLogger.ts'
@@ -373,13 +373,12 @@ describe('AmqpPermissionConsumer', () => {
         `
         [ZodError: [
           {
-            "code": "invalid_type",
             "expected": "string",
-            "received": "number",
+            "code": "invalid_type",
             "path": [
               "id"
             ],
-            "message": "Expected string, received number"
+            "message": "Invalid input: expected string, received number"
           }
         ]]
       `,