@amqp-contract/worker-nestjs 0.2.1 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +3 -3
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +3 -3
- package/dist/index.d.mts.map +1 -1
- package/docs/index.md +77 -11
- package/package.json +4 -4
package/dist/index.d.cts
CHANGED
|
@@ -2,7 +2,7 @@ import * as _nestjs_common0 from "@nestjs/common";
|
|
|
2
2
|
import { OnModuleDestroy, OnModuleInit } from "@nestjs/common";
|
|
3
3
|
import { ContractDefinition } from "@amqp-contract/contract";
|
|
4
4
|
import { AmqpConnectionManagerOptions, ConnectionUrl } from "amqp-connection-manager";
|
|
5
|
-
import { WorkerInferConsumerHandlers } from "@amqp-contract/worker";
|
|
5
|
+
import { WorkerInferConsumerHandler, WorkerInferConsumerHandlers, WorkerInferConsumerHandlers as WorkerInferConsumerHandlers$1, WorkerInferConsumerInput } from "@amqp-contract/worker";
|
|
6
6
|
|
|
7
7
|
//#region src/worker.service.d.ts
|
|
8
8
|
|
|
@@ -31,7 +31,7 @@ interface AmqpWorkerModuleOptions<TContract extends ContractDefinition> {
|
|
|
31
31
|
/** The AMQP contract definition specifying consumers and their message schemas */
|
|
32
32
|
contract: TContract;
|
|
33
33
|
/** Message handlers for each consumer defined in the contract */
|
|
34
|
-
handlers: WorkerInferConsumerHandlers<TContract>;
|
|
34
|
+
handlers: WorkerInferConsumerHandlers$1<TContract>;
|
|
35
35
|
/** AMQP broker URL(s). Multiple URLs provide failover support */
|
|
36
36
|
urls: ConnectionUrl[];
|
|
37
37
|
/** Optional connection configuration (heartbeat, reconnect settings, etc.) */
|
|
@@ -111,5 +111,5 @@ declare const ConfigurableModuleClass: _nestjs_common0.ConfigurableModuleCls<Amq
|
|
|
111
111
|
*/
|
|
112
112
|
declare class AmqpWorkerModule extends ConfigurableModuleClass {}
|
|
113
113
|
//#endregion
|
|
114
|
-
export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN };
|
|
114
|
+
export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput };
|
|
115
115
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +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,
|
|
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,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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as _nestjs_common0 from "@nestjs/common";
|
|
2
2
|
import { OnModuleDestroy, OnModuleInit } from "@nestjs/common";
|
|
3
|
-
import { WorkerInferConsumerHandlers } from "@amqp-contract/worker";
|
|
3
|
+
import { WorkerInferConsumerHandler, WorkerInferConsumerHandlers, WorkerInferConsumerHandlers as WorkerInferConsumerHandlers$1, WorkerInferConsumerInput } from "@amqp-contract/worker";
|
|
4
4
|
import { ContractDefinition } from "@amqp-contract/contract";
|
|
5
5
|
import { AmqpConnectionManagerOptions, ConnectionUrl } from "amqp-connection-manager";
|
|
6
6
|
|
|
@@ -31,7 +31,7 @@ interface AmqpWorkerModuleOptions<TContract extends ContractDefinition> {
|
|
|
31
31
|
/** The AMQP contract definition specifying consumers and their message schemas */
|
|
32
32
|
contract: TContract;
|
|
33
33
|
/** Message handlers for each consumer defined in the contract */
|
|
34
|
-
handlers: WorkerInferConsumerHandlers<TContract>;
|
|
34
|
+
handlers: WorkerInferConsumerHandlers$1<TContract>;
|
|
35
35
|
/** AMQP broker URL(s). Multiple URLs provide failover support */
|
|
36
36
|
urls: ConnectionUrl[];
|
|
37
37
|
/** Optional connection configuration (heartbeat, reconnect settings, etc.) */
|
|
@@ -111,5 +111,5 @@ declare const ConfigurableModuleClass: _nestjs_common0.ConfigurableModuleCls<Amq
|
|
|
111
111
|
*/
|
|
112
112
|
declare class AmqpWorkerModule extends ConfigurableModuleClass {}
|
|
113
113
|
//#endregion
|
|
114
|
-
export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN };
|
|
114
|
+
export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput };
|
|
115
115
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +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,
|
|
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,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
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
### AmqpWorkerModule
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/worker-nestjs/src/worker.module.ts:14](https://github.com/btravers/amqp-contract/blob/
|
|
11
|
+
Defined in: [packages/worker-nestjs/src/worker.module.ts:14](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.module.ts#L14)
|
|
12
12
|
|
|
13
13
|
NestJS module for AMQP worker integration
|
|
14
14
|
This module provides type-safe AMQP worker functionality using @amqp-contract/worker
|
|
@@ -55,7 +55,7 @@ ConfigurableModuleClass.constructor
|
|
|
55
55
|
|
|
56
56
|
### AmqpWorkerService
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/worker-nestjs/src/worker.service.ts:74](https://github.com/btravers/amqp-contract/blob/
|
|
58
|
+
Defined in: [packages/worker-nestjs/src/worker.service.ts:74](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L74)
|
|
59
59
|
|
|
60
60
|
Type-safe AMQP worker service for NestJS applications.
|
|
61
61
|
|
|
@@ -108,7 +108,7 @@ export class AppModule {}
|
|
|
108
108
|
new AmqpWorkerService<TContract>(options): AmqpWorkerService<TContract>;
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
Defined in: [packages/worker-nestjs/src/worker.service.ts:79](https://github.com/btravers/amqp-contract/blob/
|
|
111
|
+
Defined in: [packages/worker-nestjs/src/worker.service.ts:79](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L79)
|
|
112
112
|
|
|
113
113
|
###### Parameters
|
|
114
114
|
|
|
@@ -128,7 +128,7 @@ Defined in: [packages/worker-nestjs/src/worker.service.ts:79](https://github.com
|
|
|
128
128
|
onModuleDestroy(): Promise<void>;
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/worker-nestjs/src/worker.service.ts:105](https://github.com/btravers/amqp-contract/blob/
|
|
131
|
+
Defined in: [packages/worker-nestjs/src/worker.service.ts:105](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L105)
|
|
132
132
|
|
|
133
133
|
Close the AMQP worker when the NestJS module is destroyed.
|
|
134
134
|
|
|
@@ -152,7 +152,7 @@ OnModuleDestroy.onModuleDestroy
|
|
|
152
152
|
onModuleInit(): Promise<void>;
|
|
153
153
|
```
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/worker-nestjs/src/worker.service.ts:94](https://github.com/btravers/amqp-contract/blob/
|
|
155
|
+
Defined in: [packages/worker-nestjs/src/worker.service.ts:94](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L94)
|
|
156
156
|
|
|
157
157
|
Initialize the AMQP worker when the NestJS module starts.
|
|
158
158
|
|
|
@@ -179,7 +179,7 @@ OnModuleInit.onModuleInit
|
|
|
179
179
|
|
|
180
180
|
### AmqpWorkerModuleOptions
|
|
181
181
|
|
|
182
|
-
Defined in: [packages/worker-nestjs/src/worker.service.ts:28](https://github.com/btravers/amqp-contract/blob/
|
|
182
|
+
Defined in: [packages/worker-nestjs/src/worker.service.ts:28](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L28)
|
|
183
183
|
|
|
184
184
|
Configuration options for the AMQP worker NestJS module.
|
|
185
185
|
|
|
@@ -210,10 +210,76 @@ const options: AmqpWorkerModuleOptions<typeof contract> = {
|
|
|
210
210
|
|
|
211
211
|
| Property | Type | Description | Defined in |
|
|
212
212
|
| ------ | ------ | ------ | ------ |
|
|
213
|
-
| <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/
|
|
214
|
-
| <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/
|
|
215
|
-
| <a id="handlers"></a> `handlers` | `WorkerInferConsumerHandlers
|
|
216
|
-
| <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/
|
|
213
|
+
| <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/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L36) |
|
|
214
|
+
| <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/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L30) |
|
|
215
|
+
| <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/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L32) |
|
|
216
|
+
| <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/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.service.ts#L34) |
|
|
217
|
+
|
|
218
|
+
## Type Aliases
|
|
219
|
+
|
|
220
|
+
### WorkerInferConsumerHandler()
|
|
221
|
+
|
|
222
|
+
```ts
|
|
223
|
+
type WorkerInferConsumerHandler<TContract, TName> = (message) => Promise<void>;
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
Defined in: packages/worker/dist/index.d.mts:54
|
|
227
|
+
|
|
228
|
+
Infer consumer handler type for a specific consumer
|
|
229
|
+
|
|
230
|
+
#### Type Parameters
|
|
231
|
+
|
|
232
|
+
| Type Parameter |
|
|
233
|
+
| ------ |
|
|
234
|
+
| `TContract` *extends* `ContractDefinition` |
|
|
235
|
+
| `TName` *extends* `InferConsumerNames`\<`TContract`\> |
|
|
236
|
+
|
|
237
|
+
#### Parameters
|
|
238
|
+
|
|
239
|
+
| Parameter | Type |
|
|
240
|
+
| ------ | ------ |
|
|
241
|
+
| `message` | [`WorkerInferConsumerInput`](#workerinferconsumerinput)\<`TContract`, `TName`\> |
|
|
242
|
+
|
|
243
|
+
#### Returns
|
|
244
|
+
|
|
245
|
+
`Promise`\<`void`\>
|
|
246
|
+
|
|
247
|
+
***
|
|
248
|
+
|
|
249
|
+
### WorkerInferConsumerHandlers
|
|
250
|
+
|
|
251
|
+
```ts
|
|
252
|
+
type WorkerInferConsumerHandlers<TContract> = { [K in InferConsumerNames<TContract>]: WorkerInferConsumerHandler<TContract, K> };
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
Defined in: packages/worker/dist/index.d.mts:58
|
|
256
|
+
|
|
257
|
+
Infer all consumer handlers for a contract
|
|
258
|
+
|
|
259
|
+
#### Type Parameters
|
|
260
|
+
|
|
261
|
+
| Type Parameter |
|
|
262
|
+
| ------ |
|
|
263
|
+
| `TContract` *extends* `ContractDefinition` |
|
|
264
|
+
|
|
265
|
+
***
|
|
266
|
+
|
|
267
|
+
### WorkerInferConsumerInput
|
|
268
|
+
|
|
269
|
+
```ts
|
|
270
|
+
type WorkerInferConsumerInput<TContract, TName> = ConsumerInferInput<InferConsumer<TContract, TName>>;
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
Defined in: packages/worker/dist/index.d.mts:50
|
|
274
|
+
|
|
275
|
+
Worker perspective types - for consuming messages
|
|
276
|
+
|
|
277
|
+
#### Type Parameters
|
|
278
|
+
|
|
279
|
+
| Type Parameter |
|
|
280
|
+
| ------ |
|
|
281
|
+
| `TContract` *extends* `ContractDefinition` |
|
|
282
|
+
| `TName` *extends* `InferConsumerNames`\<`TContract`\> |
|
|
217
283
|
|
|
218
284
|
## Variables
|
|
219
285
|
|
|
@@ -223,4 +289,4 @@ const options: AmqpWorkerModuleOptions<typeof contract> = {
|
|
|
223
289
|
MODULE_OPTIONS_TOKEN: string | symbol;
|
|
224
290
|
```
|
|
225
291
|
|
|
226
|
-
Defined in: [packages/worker-nestjs/src/worker.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/
|
|
292
|
+
Defined in: [packages/worker-nestjs/src/worker.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker-nestjs/src/worker.module-definition.ts#L9)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/worker-nestjs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "NestJS integration for @amqp-contract/worker",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"amqp",
|
|
@@ -43,8 +43,8 @@
|
|
|
43
43
|
"docs"
|
|
44
44
|
],
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@amqp-contract/contract": "0.
|
|
47
|
-
"@amqp-contract/worker": "0.
|
|
46
|
+
"@amqp-contract/contract": "0.3.1",
|
|
47
|
+
"@amqp-contract/worker": "0.3.1"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@nestjs/common": "11.1.10",
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"reflect-metadata": "0.2.2",
|
|
57
57
|
"rxjs": "7.8.2",
|
|
58
58
|
"tsdown": "0.18.2",
|
|
59
|
-
"typedoc": "0.28.
|
|
59
|
+
"typedoc": "0.28.15",
|
|
60
60
|
"typedoc-plugin-markdown": "4.9.0",
|
|
61
61
|
"typescript": "5.9.3",
|
|
62
62
|
"vitest": "4.0.16",
|