@ido_kawaz/amqp-client 7.2.0 → 7.3.1

package/README.md

@@ -43,20 +43,19 @@ const config: AmqpConfig = {
 };
 
 async function bootstrap() {
-	const consumer = new Consumer<OrderCreatedPayload>(
-		binding,
-		isOrderCreatedPayload,
-		async (payload) => {
+	const consumer = new Consumer<OrderCreatedPayload, typeof binding>('orders-created-consumer', binding);
+	consumer
+		.on('validateMessage', isOrderCreatedPayload)
+		.on('handleMessage', async (payload) => {
 			if (payload.total <= 0) {
-				throw new AmqpRetriableError(new Error('Amount not ready yet'), 5);
+				throw new AmqpRetriableError(payload, 'Amount not ready yet', undefined, 5);
 			}
 
 			console.log('received order:', payload.orderId);
-		}
-	);
+		});
 
 	const client = new AmqpClient(config, [consumer]);
-	await client.start();
+	await client.start('my-service');
 
 	client.publish('orders.exchange', 'orders.created', {
 		orderId: '123',
@@ -79,17 +78,19 @@ bootstrap().catch(console.error);
 
 `createAmqpConfig(): AmqpConfig`
 
-- Validates `AMQP_CONNECTION_STRING` from `process.env` using Joi
+- Validates `AMQP_CONNECTION_STRING` from `process.env` using Zod
 - Requires URI scheme `amqp` or `amqps`
-- Throws Joi validation error for invalid or missing env value
+- Throws Zod validation error for invalid or missing env value
 
 ## API
 
 ### `AmqpClient`
 
-- `new AmqpClient(config: AmqpConfig, consumers: Consumer[])`
-- `start(): Promise<void>`
+- `new AmqpClient(config: AmqpConfig, consumers?: Consumer[])`
+- `start(serviceName: string): Promise<void>`
 	- Connects to RabbitMQ and starts all consumer registrations.
+- `registerConsumers(consumers: Consumer[]): void`
+	- Adds consumers after construction.
 - `publish<T>(exchange: string, topic: string, message: T): void`
 	- Serializes payload to JSON and publishes it.
 	- Throws `AmqpUninitializedError` if `start()` has not been called.
@@ -99,11 +100,14 @@ bootstrap().catch(console.error);
 
 ### `Consumer`
 
-- `new Consumer<Payload>(binding, validatePayload, handlePayload)`
-	- Generic `Payload` type is required; binding type is inferred from the binding parameter.
-	- `binding: ConsumerBinding` contains `queue`, `exchange`, `topic`.
-	- `validatePayload(payload): payload is Payload` validates parsed JSON before handling.
-	- `handlePayload(payload)` runs only for valid payloads.
+- `new Consumer<Payload, Binding>(consumerName: string, binding: Binding)`
+	- Generic `Payload` type must be provided; `Binding` is inferred from the binding parameter.
+	- Wire handlers with `.on(event, handler)` (chainable):
+		- `validateMessage`: type guard `(payload: object) => payload is Payload`
+		- `handleMessage`: `(payload: Payload) => Promise<Output>`
+		- `handleSuccess`: `(payload: Payload, response: Output) => Promise<void>`
+		- `handleRetriableError`: `(error: AmqpRetriableError, payload: Payload) => Promise<void>`
+		- `handleFatalError`: `(error: AmqpFatalError, payload: any) => Promise<void>`
 	- `ack`s on success.
 	- `nack`s invalid payloads without requeue.
 	- `nack`s with requeue for `AmqpRetriableError` while `x-delivery-count < retryLimit`.
@@ -116,13 +120,14 @@ bootstrap().catch(console.error);
 
 ## Errors
 
-- `AmqpError`
+Exported error classes:
+
+- `AmqpError` (base)
 - `AmqpConnectionError`
-- `AmqpUninitializedError`
 - `AmqpPublisherError`
 - `AmqpConsumerError`
-- `AmqpRetriableError`
-- `AmqpFatalError`
+- `AmqpRetriableError` — has `retryLimit: number`; triggers requeue up to that limit
+- `AmqpFatalError` — triggers nack without requeue
 
 ## Development
 

package/dist/config.d.ts

@@ -1,5 +1,6 @@
 export interface AmqpConfig {
     amqpConnectionString: string;
+    amqpPrefetchCount?: number;
 }
 export declare const createAmqpConfig: () => AmqpConfig;
 //# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,UAAU;IACvB,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAOD,eAAO,MAAM,gBAAgB,QAAO,UAKnC,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,UAAU;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AASD,eAAO,MAAM,gBAAgB,QAAO,UAMnC,CAAA"}

package/dist/config.js

@@ -4,11 +4,13 @@ exports.createAmqpConfig = void 0;
 const zod_1 = require("zod");
 const amqpEnvSchema = zod_1.z.object({
     AMQP_CONNECTION_STRING: zod_1.z.url({ protocol: /^amqp(s)?$/ }),
+    AMQP_PREFETCH_COUNT: zod_1.z.coerce.number().optional(),
 });
 const createAmqpConfig = () => {
     const amqpEnv = amqpEnvSchema.parse(process.env);
     return {
-        amqpConnectionString: amqpEnv.AMQP_CONNECTION_STRING
+        amqpConnectionString: amqpEnv.AMQP_CONNECTION_STRING,
+        amqpPrefetchCount: amqpEnv.AMQP_PREFETCH_COUNT
     };
 };
 exports.createAmqpConfig = createAmqpConfig;

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAOxB,MAAM,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,sBAAsB,EAAE,OAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC5D,CAAC,CAAC;AAEI,MAAM,gBAAgB,GAAG,GAAe,EAAE;IAC7C,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,OAAO;QACH,oBAAoB,EAAE,OAAO,CAAC,sBAAsB;KACvD,CAAC;AACN,CAAC,CAAA;AALY,QAAA,gBAAgB,oBAK5B"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAQxB,MAAM,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,sBAAsB,EAAE,OAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzD,mBAAmB,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAEpD,CAAC,CAAC;AAEI,MAAM,gBAAgB,GAAG,GAAe,EAAE;IAC7C,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,OAAO;QACH,oBAAoB,EAAE,OAAO,CAAC,sBAAsB;QACpD,iBAAiB,EAAE,OAAO,CAAC,mBAAmB;KACjD,CAAC;AACN,CAAC,CAAA;AANY,QAAA,gBAAgB,oBAM5B"}

package/dist/consumer.d.ts

@@ -8,8 +8,8 @@ interface ConsumerBinding {
 interface ConsumerEvents<Payload extends object, Output = any> {
     validateMessage: (payload: object) => payload is Payload;
     handleMessage: (payload: Payload) => Promise<Output>;
-    handleRetriableError: (error: AmqpRetriableError<Payload>, payload: Payload) => Promise<void>;
-    handleFatalError: (error: AmqpFatalError, payload: any) => Promise<void>;
+    handleRetriableError: <T extends AmqpRetriableError<Payload>>(error: T, payload: Payload) => Promise<void>;
+    handleFatalError: <T extends AmqpFatalError>(error: T, payload: any) => Promise<void>;
     handleSuccess: (payload: Payload, response: Output) => Promise<void>;
 }
 export declare class Consumer<Payload extends object, Binding extends ConsumerBinding, Output = any> {

package/dist/consumer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consumer.d.ts","sourceRoot":"","sources":["../src/consumer.ts"],"names":[],"mappings":"AAAA,OAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGxC,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAyD,MAAM,UAAU,CAAC;AAErH,UAAU,eAAe;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,cAAc,CAAC,OAAO,SAAS,MAAM,EAAE,MAAM,GAAG,GAAG;IACzD,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,IAAI,OAAO,CAAC;IACzD,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,oBAAoB,EAAE,CAAC,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9F,gBAAgB,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAED,qBAAa,QAAQ,CAAC,OAAO,SAAS,MAAM,EAAE,OAAO,SAAS,eAAe,EAAE,MAAM,GAAG,GAAG;IAInF,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAJ5B,OAAO,CAAC,QAAQ,CAAgD;gBAG3C,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,OAAO;IAG/B,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjE,EAAE,CAAC,CAAC,SAAS,MAAM,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAKhH,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,aAAa;YAOP,aAAa;YAMb,oBAAoB;YAmBpB,gBAAgB;YAgBhB,WAAW;YAiBX,aAAa;IAgB3B,OAAO,CAAC,gBAAgB;YAYV,wBAAwB;YAMxB,WAAW;YAIX,cAAc;YAId,SAAS;CAG1B"}
+{"version":3,"file":"consumer.d.ts","sourceRoot":"","sources":["../src/consumer.ts"],"names":[],"mappings":"AAAA,OAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGxC,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAyD,MAAM,UAAU,CAAC;AAErH,UAAU,eAAe;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,cAAc,CAAC,OAAO,SAAS,MAAM,EAAE,MAAM,GAAG,GAAG;IACzD,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,IAAI,OAAO,CAAC;IACzD,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,oBAAoB,EAAE,CAAC,CAAC,SAAS,kBAAkB,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3G,gBAAgB,EAAE,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAED,qBAAa,QAAQ,CAAC,OAAO,SAAS,MAAM,EAAE,OAAO,SAAS,eAAe,EAAE,MAAM,GAAG,GAAG;IAInF,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAJ5B,OAAO,CAAC,QAAQ,CAAgD;gBAG3C,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,OAAO;IAG/B,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjE,EAAE,CAAC,CAAC,SAAS,MAAM,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAKhH,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,aAAa;YAOP,aAAa;YAMb,oBAAoB;YAmBpB,gBAAgB;YAgBhB,WAAW;YAiBX,aAAa;IAgB3B,OAAO,CAAC,gBAAgB;YAYV,wBAAwB;YAMxB,WAAW;YAIX,cAAc;YAId,SAAS;CAG1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ido_kawaz/amqp-client",
-  "version": "7.2.0",
+  "version": "7.3.1",
   "description": "AMQP client library for Kawaz Plus services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",