@amqp-contract/worker-nestjs 0.3.0 → 0.3.2

package/dist/index.d.cts

@@ -2,7 +2,7 @@ import * as _nestjs_common0 from "@nestjs/common";
 import { OnModuleDestroy, OnModuleInit } from "@nestjs/common";
 import { ContractDefinition } from "@amqp-contract/contract";
 import { AmqpConnectionManagerOptions, ConnectionUrl } from "amqp-connection-manager";
-import { WorkerInferConsumerHandlers } from "@amqp-contract/worker";
+import { WorkerInferConsumerHandler, WorkerInferConsumerHandlers, WorkerInferConsumerHandlers as WorkerInferConsumerHandlers$1, WorkerInferConsumerInput, defineHandler, defineHandlers } from "@amqp-contract/worker";
 
 //#region src/worker.service.d.ts
 
@@ -31,7 +31,7 @@ interface AmqpWorkerModuleOptions<TContract extends ContractDefinition> {
   /** The AMQP contract definition specifying consumers and their message schemas */
   contract: TContract;
   /** Message handlers for each consumer defined in the contract */
-  handlers: WorkerInferConsumerHandlers<TContract>;
+  handlers: WorkerInferConsumerHandlers$1<TContract>;
   /** AMQP broker URL(s). Multiple URLs provide failover support */
   urls: ConnectionUrl[];
   /** Optional connection configuration (heartbeat, reconnect settings, etc.) */
@@ -111,5 +111,5 @@ declare const ConfigurableModuleClass: _nestjs_common0.ConfigurableModuleCls<Amq
  */
 declare class AmqpWorkerModule extends ConfigurableModuleClass {}
 //#endregion
-export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN };
+export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput, type defineHandler, type defineHandlers };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/worker.service.ts","../src/worker.module-definition.ts","../src/worker.module.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AA2BA;;;;;;;;AA6CA;;;;;;;;;;UA7CiB,0CAA0C;;ECnB5C,QAAA,EDqBH,SCrBG;EAAuB;EAAA,QAAA,EDuB1B,2BCvB0B,CDuBE,SCvBF,CAAA;EAAA;EAAA,IAAA,EDyB9B,aCzB8B,EAAA;EAAE;sBD2BlB;;;AE1BtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cFgEa,oCAAoC,+BACpC,cAAc;;;uBAMG,wBAAwB;;;;;;;;;;;kBAa9B;;;;;;;;qBAWG;;;;;;;;cChGZ,yBAAuB,eAAA,CAAA,sBAAA,wBAAA;;;;;;;;cCKzB,gBAAA,SAAyB,uBAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/worker.service.ts","../src/worker.module-definition.ts","../src/worker.module.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AA2BA;;;;;;;;AA6CA;;;;;;;;;;UA7CiB,0CAA0C;;ECnB5C,QAAA,EDqBH,SCrBG;EAAuB;EAAA,QAAA,EDuB1B,6BCvB0B,CDuBE,SCvBF,CAAA;EAAA;EAAA,IAAA,EDyB9B,aCzB8B,EAAA;EAAE;sBD2BlB;;;AE1BtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cFgEa,oCAAoC,+BACpC,cAAc;;;uBAMG,wBAAwB;;;;;;;;;;;kBAa9B;;;;;;;;qBAWG;;;;;;;;cChGZ,yBAAuB,eAAA,CAAA,sBAAA,wBAAA;;;;;;;;cCKzB,gBAAA,SAAyB,uBAAA"}

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as _nestjs_common0 from "@nestjs/common";
 import { OnModuleDestroy, OnModuleInit } from "@nestjs/common";
-import { WorkerInferConsumerHandlers } from "@amqp-contract/worker";
+import { WorkerInferConsumerHandler, WorkerInferConsumerHandlers, WorkerInferConsumerHandlers as WorkerInferConsumerHandlers$1, WorkerInferConsumerInput, defineHandler, defineHandlers } from "@amqp-contract/worker";
 import { ContractDefinition } from "@amqp-contract/contract";
 import { AmqpConnectionManagerOptions, ConnectionUrl } from "amqp-connection-manager";
 
@@ -31,7 +31,7 @@ interface AmqpWorkerModuleOptions<TContract extends ContractDefinition> {
   /** The AMQP contract definition specifying consumers and their message schemas */
   contract: TContract;
   /** Message handlers for each consumer defined in the contract */
-  handlers: WorkerInferConsumerHandlers<TContract>;
+  handlers: WorkerInferConsumerHandlers$1<TContract>;
   /** AMQP broker URL(s). Multiple URLs provide failover support */
   urls: ConnectionUrl[];
   /** Optional connection configuration (heartbeat, reconnect settings, etc.) */
@@ -111,5 +111,5 @@ declare const ConfigurableModuleClass: _nestjs_common0.ConfigurableModuleCls<Amq
  */
 declare class AmqpWorkerModule extends ConfigurableModuleClass {}
 //#endregion
-export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN };
+export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput, type defineHandler, type defineHandlers };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/worker.service.ts","../src/worker.module-definition.ts","../src/worker.module.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AA2BA;;;;;;;;AA6CA;;;;;;;;;;UA7CiB,0CAA0C;;ECnB5C,QAAA,EDqBH,SCrBG;EAAuB;EAAA,QAAA,EDuB1B,2BCvB0B,CDuBE,SCvBF,CAAA;EAAA;EAAA,IAAA,EDyB9B,aCzB8B,EAAA;EAAE;sBD2BlB;;;AE1BtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cFgEa,oCAAoC,+BACpC,cAAc;;;uBAMG,wBAAwB;;;;;;;;;;;kBAa9B;;;;;;;;qBAWG;;;;;;;;cChGZ,yBAAuB,eAAA,CAAA,sBAAA,wBAAA;;;;;;;;cCKzB,gBAAA,SAAyB,uBAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/worker.service.ts","../src/worker.module-definition.ts","../src/worker.module.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AA2BA;;;;;;;;AA6CA;;;;;;;;;;UA7CiB,0CAA0C;;ECnB5C,QAAA,EDqBH,SCrBG;EAAuB;EAAA,QAAA,EDuB1B,6BCvB0B,CDuBE,SCvBF,CAAA;EAAA;EAAA,IAAA,EDyB9B,aCzB8B,EAAA;EAAE;sBD2BlB;;;AE1BtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cFgEa,oCAAoC,+BACpC,cAAc;;;uBAMG,wBAAwB;;;;;;;;;;;kBAa9B;;;;;;;;qBAWG;;;;;;;;cChGZ,yBAAuB,eAAA,CAAA,sBAAA,wBAAA;;;;;;;;cCKzB,gBAAA,SAAyB,uBAAA"}

package/docs/index.md

@@ -8,7 +8,7 @@
 
 ### AmqpWorkerModule
 
-Defined in: [packages/worker-nestjs/src/worker.module.ts:14](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.module.ts#L14)
+Defined in: [packages/worker-nestjs/src/worker.module.ts:14](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.module.ts#L14)
 
 NestJS module for AMQP worker integration
 This module provides type-safe AMQP worker functionality using @amqp-contract/worker
@@ -55,7 +55,7 @@ ConfigurableModuleClass.constructor
 
 ### AmqpWorkerService
 
-Defined in: [packages/worker-nestjs/src/worker.service.ts:74](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L74)
+Defined in: [packages/worker-nestjs/src/worker.service.ts:74](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L74)
 
 Type-safe AMQP worker service for NestJS applications.
 
@@ -108,7 +108,7 @@ export class AppModule {}
 new AmqpWorkerService<TContract>(options): AmqpWorkerService<TContract>;
 ```
 
-Defined in: [packages/worker-nestjs/src/worker.service.ts:79](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L79)
+Defined in: [packages/worker-nestjs/src/worker.service.ts:79](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L79)
 
 ###### Parameters
 
@@ -128,7 +128,7 @@ Defined in: [packages/worker-nestjs/src/worker.service.ts:79](https://github.com
 onModuleDestroy(): Promise<void>;
 ```
 
-Defined in: [packages/worker-nestjs/src/worker.service.ts:105](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L105)
+Defined in: [packages/worker-nestjs/src/worker.service.ts:105](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L105)
 
 Close the AMQP worker when the NestJS module is destroyed.
 
@@ -152,7 +152,7 @@ OnModuleDestroy.onModuleDestroy
 onModuleInit(): Promise<void>;
 ```
 
-Defined in: [packages/worker-nestjs/src/worker.service.ts:94](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L94)
+Defined in: [packages/worker-nestjs/src/worker.service.ts:94](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L94)
 
 Initialize the AMQP worker when the NestJS module starts.
 
@@ -179,7 +179,7 @@ OnModuleInit.onModuleInit
 
 ### AmqpWorkerModuleOptions
 
-Defined in: [packages/worker-nestjs/src/worker.service.ts:28](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L28)
+Defined in: [packages/worker-nestjs/src/worker.service.ts:28](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L28)
 
 Configuration options for the AMQP worker NestJS module.
 
@@ -210,10 +210,247 @@ const options: AmqpWorkerModuleOptions<typeof contract> = {
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/worker-nestjs/src/worker.service.ts:36](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L36) |
-| <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying consumers and their message schemas | [packages/worker-nestjs/src/worker.service.ts:30](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L30) |
-| <a id="handlers"></a> `handlers` | `WorkerInferConsumerHandlers`\<`TContract`\> | Message handlers for each consumer defined in the contract | [packages/worker-nestjs/src/worker.service.ts:32](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L32) |
-| <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/worker-nestjs/src/worker.service.ts:34](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.service.ts#L34) |
+| <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/worker-nestjs/src/worker.service.ts:36](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L36) |
+| <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying consumers and their message schemas | [packages/worker-nestjs/src/worker.service.ts:30](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L30) |
+| <a id="handlers"></a> `handlers` | [`WorkerInferConsumerHandlers`](#workerinferconsumerhandlers)\<`TContract`\> | Message handlers for each consumer defined in the contract | [packages/worker-nestjs/src/worker.service.ts:32](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L32) |
+| <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/worker-nestjs/src/worker.service.ts:34](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.service.ts#L34) |
+
+## Type Aliases
+
+### defineHandler()
+
+```ts
+type defineHandler = <TContract, TName>(contract, consumerName, handler) => WorkerInferConsumerHandler<TContract, TName>;
+```
+
+Defined in: packages/worker/dist/index.d.mts:273
+
+Define a type-safe handler for a specific consumer in a contract.
+
+This utility allows you to define handlers outside of the worker creation,
+providing better code organization and reusability.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `TContract` *extends* `ContractDefinition` | The contract definition type |
+| `TName` *extends* `string` \| `number` \| `symbol` | The consumer name from the contract |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `contract` | `TContract` | The contract definition containing the consumer |
+| `consumerName` | `TName` | The name of the consumer from the contract |
+| `handler` | [`WorkerInferConsumerHandler`](#workerinferconsumerhandler)\<`TContract`, `TName`\> | The async handler function that processes messages |
+
+#### Returns
+
+[`WorkerInferConsumerHandler`](#workerinferconsumerhandler)\<`TContract`, `TName`\>
+
+A type-safe handler that can be used with TypedAmqpWorker
+
+#### Examples
+
+```typescript
+import { defineHandler } from '@amqp-contract/worker';
+import { orderContract } from './contract';
+
+// Define handler outside of worker creation
+const processOrderHandler = defineHandler(
+  orderContract,
+  'processOrder',
+  async (message) => {
+    // message is fully typed based on the contract
+    console.log('Processing order:', message.orderId);
+    await processPayment(message);
+  }
+);
+
+// Use the handler in worker
+const worker = await TypedAmqpWorker.create({
+  contract: orderContract,
+  handlers: {
+    processOrder: processOrderHandler,
+  },
+  connection: 'amqp://localhost',
+});
+```
+
+```typescript
+// Define multiple handlers
+const processOrderHandler = defineHandler(
+  orderContract,
+  'processOrder',
+  async (message) => {
+    await processOrder(message);
+  }
+);
+
+const notifyOrderHandler = defineHandler(
+  orderContract,
+  'notifyOrder',
+  async (message) => {
+    await sendNotification(message);
+  }
+);
+
+// Compose handlers
+const worker = await TypedAmqpWorker.create({
+  contract: orderContract,
+  handlers: {
+    processOrder: processOrderHandler,
+    notifyOrder: notifyOrderHandler,
+  },
+  connection: 'amqp://localhost',
+});
+```
+
+***
+
+### defineHandlers()
+
+```ts
+type defineHandlers = <TContract>(contract, handlers) => WorkerInferConsumerHandlers<TContract>;
+```
+
+Defined in: packages/worker/dist/index.d.mts:330
+
+Define multiple type-safe handlers for consumers in a contract.
+
+This utility allows you to define all handlers at once outside of the worker creation,
+ensuring type safety and providing better code organization.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `TContract` *extends* `ContractDefinition` | The contract definition type |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `contract` | `TContract` | The contract definition containing the consumers |
+| `handlers` | [`WorkerInferConsumerHandlers`](#workerinferconsumerhandlers)\<`TContract`\> | An object with async handler functions for each consumer |
+
+#### Returns
+
+[`WorkerInferConsumerHandlers`](#workerinferconsumerhandlers)\<`TContract`\>
+
+A type-safe handlers object that can be used with TypedAmqpWorker
+
+#### Examples
+
+```typescript
+import { defineHandlers } from '@amqp-contract/worker';
+import { orderContract } from './contract';
+
+// Define all handlers at once
+const handlers = defineHandlers(orderContract, {
+  processOrder: async (message) => {
+    // message is fully typed based on the contract
+    console.log('Processing order:', message.orderId);
+    await processPayment(message);
+  },
+  notifyOrder: async (message) => {
+    await sendNotification(message);
+  },
+  shipOrder: async (message) => {
+    await prepareShipment(message);
+  },
+});
+
+// Use the handlers in worker
+const worker = await TypedAmqpWorker.create({
+  contract: orderContract,
+  handlers,
+  connection: 'amqp://localhost',
+});
+```
+
+```typescript
+// Separate handler definitions for better organization
+async function handleProcessOrder(message: WorkerInferConsumerInput<typeof orderContract, 'processOrder'>) {
+  await processOrder(message);
+}
+
+async function handleNotifyOrder(message: WorkerInferConsumerInput<typeof orderContract, 'notifyOrder'>) {
+  await sendNotification(message);
+}
+
+const handlers = defineHandlers(orderContract, {
+  processOrder: handleProcessOrder,
+  notifyOrder: handleNotifyOrder,
+});
+```
+
+***
+
+### WorkerInferConsumerHandler()
+
+```ts
+type WorkerInferConsumerHandler<TContract, TName> = (message) => Promise<void>;
+```
+
+Defined in: packages/worker/dist/index.d.mts:55
+
+Infer consumer handler type for a specific consumer
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TContract` *extends* `ContractDefinition` |
+| `TName` *extends* `InferConsumerNames`\<`TContract`\> |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | [`WorkerInferConsumerInput`](#workerinferconsumerinput)\<`TContract`, `TName`\> |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### WorkerInferConsumerHandlers
+
+```ts
+type WorkerInferConsumerHandlers<TContract> = { [K in InferConsumerNames<TContract>]: WorkerInferConsumerHandler<TContract, K> };
+```
+
+Defined in: packages/worker/dist/index.d.mts:59
+
+Infer all consumer handlers for a contract
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TContract` *extends* `ContractDefinition` |
+
+***
+
+### WorkerInferConsumerInput
+
+```ts
+type WorkerInferConsumerInput<TContract, TName> = ConsumerInferInput<InferConsumer<TContract, TName>>;
+```
+
+Defined in: packages/worker/dist/index.d.mts:51
+
+Worker perspective types - for consuming messages
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TContract` *extends* `ContractDefinition` |
+| `TName` *extends* `InferConsumerNames`\<`TContract`\> |
 
 ## Variables
 
@@ -223,4 +460,4 @@ const options: AmqpWorkerModuleOptions<typeof contract> = {
 MODULE_OPTIONS_TOKEN: string | symbol;
 ```
 
-Defined in: [packages/worker-nestjs/src/worker.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/worker-nestjs/src/worker.module-definition.ts#L9)
+Defined in: [packages/worker-nestjs/src/worker.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/worker-nestjs/src/worker.module-definition.ts#L9)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amqp-contract/worker-nestjs",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "NestJS integration for @amqp-contract/worker",
   "keywords": [
     "amqp",
@@ -43,8 +43,8 @@
     "docs"
   ],
   "dependencies": {
-    "@amqp-contract/contract": "0.3.0",
-    "@amqp-contract/worker": "0.3.0"
+    "@amqp-contract/contract": "0.3.2",
+    "@amqp-contract/worker": "0.3.2"
   },
   "devDependencies": {
     "@nestjs/common": "11.1.10",
@@ -56,7 +56,7 @@
     "reflect-metadata": "0.2.2",
     "rxjs": "7.8.2",
     "tsdown": "0.18.2",
-    "typedoc": "0.28.3",
+    "typedoc": "0.28.15",
     "typedoc-plugin-markdown": "4.9.0",
     "typescript": "5.9.3",
     "vitest": "4.0.16",