@amqp-contract/client-nestjs 0.17.0 → 0.18.0

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.
Files changed (2) hide show
  1. package/docs/index.md +20 -20
  2. package/package.json +7 -7
package/docs/index.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  ### AmqpClientModule
10
10
 
11
- Defined in: [packages/client-nestjs/src/client.module.ts:93](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L93)
11
+ Defined in: [packages/client-nestjs/src/client.module.ts:93](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L93)
12
12
 
13
13
  NestJS module for AMQP client integration
14
14
  This module provides type-safe AMQP client functionality using @amqp-contract/client
@@ -84,7 +84,7 @@ new AmqpClientModule(): AmqpClientModule;
84
84
  static forRoot<TContract>(options): DynamicModule;
85
85
  ```
86
86
 
87
- Defined in: [packages/client-nestjs/src/client.module.ts:100](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L100)
87
+ Defined in: [packages/client-nestjs/src/client.module.ts:100](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L100)
88
88
 
89
89
  Register the AMQP client module with synchronous configuration
90
90
 
@@ -112,7 +112,7 @@ A dynamic module for NestJS
112
112
  static forRootAsync<TContract>(options): DynamicModule;
113
113
  ```
114
114
 
115
- Defined in: [packages/client-nestjs/src/client.module.ts:122](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L122)
115
+ Defined in: [packages/client-nestjs/src/client.module.ts:122](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L122)
116
116
 
117
117
  Register the AMQP client module with asynchronous configuration
118
118
 
@@ -138,7 +138,7 @@ A dynamic module for NestJS
138
138
 
139
139
  ### AmqpClientService
140
140
 
141
- Defined in: [packages/client-nestjs/src/client.service.ts:82](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L82)
141
+ Defined in: [packages/client-nestjs/src/client.service.ts:82](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L82)
142
142
 
143
143
  Type-safe AMQP client service for NestJS applications.
144
144
 
@@ -199,7 +199,7 @@ export class OrderService {
199
199
  new AmqpClientService<TContract>(options): AmqpClientService<TContract>;
200
200
  ```
201
201
 
202
- Defined in: [packages/client-nestjs/src/client.service.ts:87](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L87)
202
+ Defined in: [packages/client-nestjs/src/client.service.ts:87](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L87)
203
203
 
204
204
  ###### Parameters
205
205
 
@@ -219,7 +219,7 @@ Defined in: [packages/client-nestjs/src/client.service.ts:87](https://github.com
219
219
  onModuleDestroy(): Promise<void>;
220
220
  ```
221
221
 
222
- Defined in: [packages/client-nestjs/src/client.service.ts:110](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L110)
222
+ Defined in: [packages/client-nestjs/src/client.service.ts:110](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L110)
223
223
 
224
224
  Close the AMQP client when the NestJS module is destroyed.
225
225
 
@@ -243,7 +243,7 @@ OnModuleDestroy.onModuleDestroy
243
243
  onModuleInit(): Promise<void>;
244
244
  ```
245
245
 
246
- Defined in: [packages/client-nestjs/src/client.service.ts:99](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L99)
246
+ Defined in: [packages/client-nestjs/src/client.service.ts:99](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L99)
247
247
 
248
248
  Initialize the AMQP client when the NestJS module starts.
249
249
 
@@ -272,7 +272,7 @@ publish<TName>(
272
272
  | MessageValidationError>>;
273
273
  ```
274
274
 
275
- Defined in: [packages/client-nestjs/src/client.service.ts:146](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L146)
275
+ Defined in: [packages/client-nestjs/src/client.service.ts:146](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L146)
276
276
 
277
277
  Publish a message using a contract-defined publisher.
278
278
 
@@ -369,7 +369,7 @@ Error.constructor
369
369
  | <a id="message"></a> `message` | `public` | `string` | - | - | `Error.message` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
370
370
  | <a id="name"></a> `name` | `public` | `string` | - | - | `Error.name` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
371
371
  | <a id="stack"></a> `stack?` | `public` | `string` | - | - | `Error.stack` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
372
- | <a id="stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | - | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@25.2.1/node\_modules/@types/node/globals.d.ts:67 |
372
+ | <a id="stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | - | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:67 |
373
373
 
374
374
  #### Methods
375
375
 
@@ -379,7 +379,7 @@ Error.constructor
379
379
  static captureStackTrace(targetObject, constructorOpt?): void;
380
380
  ```
381
381
 
382
- Defined in: node\_modules/.pnpm/@types+node@25.2.1/node\_modules/@types/node/globals.d.ts:51
382
+ Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:51
383
383
 
384
384
  Creates a `.stack` property on `targetObject`, which when accessed returns
385
385
  a string representing the location in the code at which
@@ -448,7 +448,7 @@ Error.captureStackTrace
448
448
  static prepareStackTrace(err, stackTraces): any;
449
449
  ```
450
450
 
451
- Defined in: node\_modules/.pnpm/@types+node@25.2.1/node\_modules/@types/node/globals.d.ts:55
451
+ Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:55
452
452
 
453
453
  ###### Parameters
454
454
 
@@ -502,7 +502,7 @@ Error thrown when message validation fails
502
502
  type AmqpClientModuleAsyncOptions<TContract> = object;
503
503
  ```
504
504
 
505
- Defined in: [packages/client-nestjs/src/client.module.ts:22](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L22)
505
+ Defined in: [packages/client-nestjs/src/client.module.ts:22](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L22)
506
506
 
507
507
  Options for async module configuration using factory pattern
508
508
 
@@ -516,9 +516,9 @@ Options for async module configuration using factory pattern
516
516
 
517
517
  | Property | Type | Description | Defined in |
518
518
  | ------ | ------ | ------ | ------ |
519
- | <a id="imports"></a> `imports?` | `ModuleMetadata`\[`"imports"`\] | Optional list of imported modules that export providers needed by the factory | [packages/client-nestjs/src/client.module.ts:37](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L37) |
520
- | <a id="inject"></a> `inject?` | (`string` \| `symbol` \| `Type`&lt;`unknown`&gt;)[] | Optional dependencies to inject into the factory function. Can be a token (string/symbol) or a class reference to a provider. | [packages/client-nestjs/src/client.module.ts:33](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L33) |
521
- | <a id="usefactory"></a> `useFactory` | (...`args`) => `AmqpClientModuleOptionsFactory`&lt;`TContract`&gt; | Factory function that returns the module options. Can use injected dependencies to create configuration. | [packages/client-nestjs/src/client.module.ts:28](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module.ts#L28) |
519
+ | <a id="imports"></a> `imports?` | `ModuleMetadata`\[`"imports"`\] | Optional list of imported modules that export providers needed by the factory | [packages/client-nestjs/src/client.module.ts:37](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L37) |
520
+ | <a id="inject"></a> `inject?` | (`string` \| `symbol` \| `Type`&lt;`unknown`&gt;)[] | Optional dependencies to inject into the factory function. Can be a token (string/symbol) or a class reference to a provider. | [packages/client-nestjs/src/client.module.ts:33](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L33) |
521
+ | <a id="usefactory"></a> `useFactory` | (...`args`) => `AmqpClientModuleOptionsFactory`&lt;`TContract`&gt; | Factory function that returns the module options. Can use injected dependencies to create configuration. | [packages/client-nestjs/src/client.module.ts:28](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module.ts#L28) |
522
522
 
523
523
  ***
524
524
 
@@ -528,7 +528,7 @@ Options for async module configuration using factory pattern
528
528
  type AmqpClientModuleOptions<TContract> = object;
529
529
  ```
530
530
 
531
- Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L30)
531
+ Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L30)
532
532
 
533
533
  Configuration options for the AMQP client NestJS module.
534
534
 
@@ -554,9 +554,9 @@ const options: AmqpClientModuleOptions<typeof contract> = {
554
554
 
555
555
  | Property | Type | Description | Defined in |
556
556
  | ------ | ------ | ------ | ------ |
557
- | <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/client-nestjs/src/client.service.ts:36](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L36) |
558
- | <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying publishers and their message schemas | [packages/client-nestjs/src/client.service.ts:32](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L32) |
559
- | <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/client-nestjs/src/client.service.ts:34](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.service.ts#L34) |
557
+ | <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/client-nestjs/src/client.service.ts:36](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L36) |
558
+ | <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying publishers and their message schemas | [packages/client-nestjs/src/client.service.ts:32](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L32) |
559
+ | <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/client-nestjs/src/client.service.ts:34](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.service.ts#L34) |
560
560
 
561
561
  ***
562
562
 
@@ -585,7 +585,7 @@ Infer publisher input type (message payload) for a specific publisher in a contr
585
585
  const MODULE_OPTIONS_TOKEN: typeof MODULE_OPTIONS_TOKEN;
586
586
  ```
587
587
 
588
- Defined in: [packages/client-nestjs/src/client.module-definition.ts:5](https://github.com/btravers/amqp-contract/blob/5f68ac0e7a01403c51ddebd327d65b70384c2e2f/packages/client-nestjs/src/client.module-definition.ts#L5)
588
+ Defined in: [packages/client-nestjs/src/client.module-definition.ts:5](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/client-nestjs/src/client.module-definition.ts#L5)
589
589
 
590
590
  Injection token for AMQP client module options
591
591
  Used by NestJS DI system to inject configuration into AmqpClientService
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amqp-contract/client-nestjs",
3
- "version": "0.17.0",
3
+ "version": "0.18.0",
4
4
  "description": "NestJS integration for @amqp-contract/client",
5
5
  "keywords": [
6
6
  "amqp",
@@ -52,9 +52,9 @@
52
52
  "docs"
53
53
  ],
54
54
  "dependencies": {
55
- "@amqp-contract/client": "0.17.0",
56
- "@amqp-contract/contract": "0.17.0",
57
- "@amqp-contract/core": "0.17.0"
55
+ "@amqp-contract/client": "0.18.0",
56
+ "@amqp-contract/contract": "0.18.0",
57
+ "@amqp-contract/core": "0.18.0"
58
58
  },
59
59
  "devDependencies": {
60
60
  "@nestjs/common": "11.1.13",
@@ -62,7 +62,7 @@
62
62
  "@nestjs/testing": "11.1.13",
63
63
  "@swan-io/boxed": "3.2.1",
64
64
  "@types/amqplib": "0.10.8",
65
- "@types/node": "25.2.1",
65
+ "@types/node": "25.2.3",
66
66
  "@vitest/coverage-v8": "4.0.18",
67
67
  "amqp-connection-manager": "5.0.0",
68
68
  "amqplib": "0.10.9",
@@ -70,11 +70,11 @@
70
70
  "rxjs": "7.8.2",
71
71
  "tsdown": "0.20.3",
72
72
  "typedoc": "0.28.16",
73
- "typedoc-plugin-markdown": "4.9.0",
73
+ "typedoc-plugin-markdown": "4.10.0",
74
74
  "typescript": "5.9.3",
75
75
  "vitest": "4.0.18",
76
76
  "zod": "4.3.6",
77
- "@amqp-contract/testing": "0.17.0",
77
+ "@amqp-contract/testing": "0.18.0",
78
78
  "@amqp-contract/tsconfig": "0.1.0",
79
79
  "@amqp-contract/typedoc": "0.1.0"
80
80
  },