@amqp-contract/worker-nestjs 0.3.2 → 0.3.3
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.cjs +13 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +2 -2
- package/docs/index.md +91 -88
- package/package.json +3 -3
package/dist/index.cjs
CHANGED
|
@@ -92,4 +92,16 @@ Object.defineProperty(exports, 'AmqpWorkerService', {
|
|
|
92
92
|
return AmqpWorkerService;
|
|
93
93
|
}
|
|
94
94
|
});
|
|
95
|
-
exports.MODULE_OPTIONS_TOKEN = MODULE_OPTIONS_TOKEN;
|
|
95
|
+
exports.MODULE_OPTIONS_TOKEN = MODULE_OPTIONS_TOKEN;
|
|
96
|
+
Object.defineProperty(exports, 'defineHandler', {
|
|
97
|
+
enumerable: true,
|
|
98
|
+
get: function () {
|
|
99
|
+
return _amqp_contract_worker.defineHandler;
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
Object.defineProperty(exports, 'defineHandlers', {
|
|
103
|
+
enumerable: true,
|
|
104
|
+
get: function () {
|
|
105
|
+
return _amqp_contract_worker.defineHandlers;
|
|
106
|
+
}
|
|
107
|
+
});
|
package/dist/index.d.cts
CHANGED
|
@@ -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, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput,
|
|
114
|
+
export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput, defineHandler, defineHandlers };
|
|
115
115
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.mts
CHANGED
|
@@ -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, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput,
|
|
114
|
+
export { AmqpWorkerModule, type AmqpWorkerModuleOptions, AmqpWorkerService, MODULE_OPTIONS_TOKEN, type WorkerInferConsumerHandler, type WorkerInferConsumerHandlers, type WorkerInferConsumerInput, defineHandler, defineHandlers };
|
|
115
115
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ConfigurableModuleBuilder, Inject, Injectable, Module } from "@nestjs/common";
|
|
2
|
-
import { TypedAmqpWorker } from "@amqp-contract/worker";
|
|
2
|
+
import { TypedAmqpWorker, defineHandler, defineHandlers } from "@amqp-contract/worker";
|
|
3
3
|
|
|
4
4
|
//#region src/worker.module-definition.ts
|
|
5
5
|
/**
|
|
@@ -80,5 +80,5 @@ AmqpWorkerModule = __decorate([Module({
|
|
|
80
80
|
})], AmqpWorkerModule);
|
|
81
81
|
|
|
82
82
|
//#endregion
|
|
83
|
-
export { AmqpWorkerModule, AmqpWorkerService, MODULE_OPTIONS_TOKEN };
|
|
83
|
+
export { AmqpWorkerModule, AmqpWorkerService, MODULE_OPTIONS_TOKEN, defineHandler, defineHandlers };
|
|
84
84
|
//# sourceMappingURL=index.mjs.map
|
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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/packages/worker-nestjs/src/worker.service.ts#L28)
|
|
183
183
|
|
|
184
184
|
Configuration options for the AMQP worker NestJS module.
|
|
185
185
|
|
|
@@ -210,17 +210,96 @@ 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`](#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/
|
|
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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/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/fb7fe976925e332da34b847357ebcbeefd37355d/packages/worker-nestjs/src/worker.service.ts#L34) |
|
|
217
217
|
|
|
218
218
|
## Type Aliases
|
|
219
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:55
|
|
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:59
|
|
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:51
|
|
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`\> |
|
|
283
|
+
|
|
284
|
+
## Variables
|
|
285
|
+
|
|
286
|
+
### MODULE\_OPTIONS\_TOKEN
|
|
287
|
+
|
|
288
|
+
```ts
|
|
289
|
+
MODULE_OPTIONS_TOKEN: string | symbol;
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
Defined in: [packages/worker-nestjs/src/worker.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/fb7fe976925e332da34b847357ebcbeefd37355d/packages/worker-nestjs/src/worker.module-definition.ts#L9)
|
|
293
|
+
|
|
294
|
+
## Functions
|
|
295
|
+
|
|
220
296
|
### defineHandler()
|
|
221
297
|
|
|
222
298
|
```ts
|
|
223
|
-
|
|
299
|
+
function defineHandler<TContract, TName>(
|
|
300
|
+
contract,
|
|
301
|
+
consumerName,
|
|
302
|
+
handler): WorkerInferConsumerHandler<TContract, TName>;
|
|
224
303
|
```
|
|
225
304
|
|
|
226
305
|
Defined in: packages/worker/dist/index.d.mts:273
|
|
@@ -312,7 +391,7 @@ const worker = await TypedAmqpWorker.create({
|
|
|
312
391
|
### defineHandlers()
|
|
313
392
|
|
|
314
393
|
```ts
|
|
315
|
-
|
|
394
|
+
function defineHandlers<TContract>(contract, handlers): WorkerInferConsumerHandlers<TContract>;
|
|
316
395
|
```
|
|
317
396
|
|
|
318
397
|
Defined in: packages/worker/dist/index.d.mts:330
|
|
@@ -385,79 +464,3 @@ const handlers = defineHandlers(orderContract, {
|
|
|
385
464
|
notifyOrder: handleNotifyOrder,
|
|
386
465
|
});
|
|
387
466
|
```
|
|
388
|
-
|
|
389
|
-
***
|
|
390
|
-
|
|
391
|
-
### WorkerInferConsumerHandler()
|
|
392
|
-
|
|
393
|
-
```ts
|
|
394
|
-
type WorkerInferConsumerHandler<TContract, TName> = (message) => Promise<void>;
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
Defined in: packages/worker/dist/index.d.mts:55
|
|
398
|
-
|
|
399
|
-
Infer consumer handler type for a specific consumer
|
|
400
|
-
|
|
401
|
-
#### Type Parameters
|
|
402
|
-
|
|
403
|
-
| Type Parameter |
|
|
404
|
-
| ------ |
|
|
405
|
-
| `TContract` *extends* `ContractDefinition` |
|
|
406
|
-
| `TName` *extends* `InferConsumerNames`\<`TContract`\> |
|
|
407
|
-
|
|
408
|
-
#### Parameters
|
|
409
|
-
|
|
410
|
-
| Parameter | Type |
|
|
411
|
-
| ------ | ------ |
|
|
412
|
-
| `message` | [`WorkerInferConsumerInput`](#workerinferconsumerinput)\<`TContract`, `TName`\> |
|
|
413
|
-
|
|
414
|
-
#### Returns
|
|
415
|
-
|
|
416
|
-
`Promise`\<`void`\>
|
|
417
|
-
|
|
418
|
-
***
|
|
419
|
-
|
|
420
|
-
### WorkerInferConsumerHandlers
|
|
421
|
-
|
|
422
|
-
```ts
|
|
423
|
-
type WorkerInferConsumerHandlers<TContract> = { [K in InferConsumerNames<TContract>]: WorkerInferConsumerHandler<TContract, K> };
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
Defined in: packages/worker/dist/index.d.mts:59
|
|
427
|
-
|
|
428
|
-
Infer all consumer handlers for a contract
|
|
429
|
-
|
|
430
|
-
#### Type Parameters
|
|
431
|
-
|
|
432
|
-
| Type Parameter |
|
|
433
|
-
| ------ |
|
|
434
|
-
| `TContract` *extends* `ContractDefinition` |
|
|
435
|
-
|
|
436
|
-
***
|
|
437
|
-
|
|
438
|
-
### WorkerInferConsumerInput
|
|
439
|
-
|
|
440
|
-
```ts
|
|
441
|
-
type WorkerInferConsumerInput<TContract, TName> = ConsumerInferInput<InferConsumer<TContract, TName>>;
|
|
442
|
-
```
|
|
443
|
-
|
|
444
|
-
Defined in: packages/worker/dist/index.d.mts:51
|
|
445
|
-
|
|
446
|
-
Worker perspective types - for consuming messages
|
|
447
|
-
|
|
448
|
-
#### Type Parameters
|
|
449
|
-
|
|
450
|
-
| Type Parameter |
|
|
451
|
-
| ------ |
|
|
452
|
-
| `TContract` *extends* `ContractDefinition` |
|
|
453
|
-
| `TName` *extends* `InferConsumerNames`\<`TContract`\> |
|
|
454
|
-
|
|
455
|
-
## Variables
|
|
456
|
-
|
|
457
|
-
### MODULE\_OPTIONS\_TOKEN
|
|
458
|
-
|
|
459
|
-
```ts
|
|
460
|
-
MODULE_OPTIONS_TOKEN: string | symbol;
|
|
461
|
-
```
|
|
462
|
-
|
|
463
|
-
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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/worker-nestjs",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.3",
|
|
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.3.
|
|
47
|
-
"@amqp-contract/worker": "0.3.
|
|
46
|
+
"@amqp-contract/contract": "0.3.3",
|
|
47
|
+
"@amqp-contract/worker": "0.3.3"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@nestjs/common": "11.1.10",
|