@amqp-contract/client-nestjs 0.9.0 → 0.10.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 +17 -17
  2. package/package.json +4 -4
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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/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/f058a24938d9644a82812e57d7995cb683cfd6b5/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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.service.ts#L146)
276
276
 
277
277
  Publish a message using a contract-defined publisher.
278
278
 
@@ -372,7 +372,7 @@ This includes validation failures and AMQP channel issues
372
372
  type AmqpClientModuleAsyncOptions<TContract> = object;
373
373
  ```
374
374
 
375
- Defined in: [packages/client-nestjs/src/client.module.ts:22](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.module.ts#L22)
375
+ Defined in: [packages/client-nestjs/src/client.module.ts:22](https://github.com/btravers/amqp-contract/blob/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.module.ts#L22)
376
376
 
377
377
  Options for async module configuration using factory pattern
378
378
 
@@ -386,9 +386,9 @@ Options for async module configuration using factory pattern
386
386
 
387
387
  | Property | Type | Description | Defined in |
388
388
  | ------ | ------ | ------ | ------ |
389
- | <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/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.module.ts#L37) |
390
- | <a id="inject"></a> `inject?` | (`string` \| `symbol` \| `Type`\<`unknown`\>)[] | 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/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.module.ts#L33) |
391
- | <a id="usefactory"></a> `useFactory` | (...`args`) => `AmqpClientModuleOptionsFactory`\<`TContract`\> | 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/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.module.ts#L28) |
389
+ | <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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.module.ts#L37) |
390
+ | <a id="inject"></a> `inject?` | (`string` \| `symbol` \| `Type`\<`unknown`\>)[] | 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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.module.ts#L33) |
391
+ | <a id="usefactory"></a> `useFactory` | (...`args`) => `AmqpClientModuleOptionsFactory`\<`TContract`\> | 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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.module.ts#L28) |
392
392
 
393
393
  ***
394
394
 
@@ -398,7 +398,7 @@ Options for async module configuration using factory pattern
398
398
  type AmqpClientModuleOptions<TContract> = object;
399
399
  ```
400
400
 
401
- Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.service.ts#L30)
401
+ Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.service.ts#L30)
402
402
 
403
403
  Configuration options for the AMQP client NestJS module.
404
404
 
@@ -424,9 +424,9 @@ const options: AmqpClientModuleOptions<typeof contract> = {
424
424
 
425
425
  | Property | Type | Description | Defined in |
426
426
  | ------ | ------ | ------ | ------ |
427
- | <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/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.service.ts#L36) |
428
- | <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/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.service.ts#L32) |
429
- | <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/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.service.ts#L34) |
427
+ | <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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.service.ts#L36) |
428
+ | <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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.service.ts#L32) |
429
+ | <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/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.service.ts#L34) |
430
430
 
431
431
  ***
432
432
 
@@ -455,7 +455,7 @@ Infer publisher input type (message payload) for a specific publisher in a contr
455
455
  const MODULE_OPTIONS_TOKEN: typeof MODULE_OPTIONS_TOKEN;
456
456
  ```
457
457
 
458
- Defined in: [packages/client-nestjs/src/client.module-definition.ts:5](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/client-nestjs/src/client.module-definition.ts#L5)
458
+ Defined in: [packages/client-nestjs/src/client.module-definition.ts:5](https://github.com/btravers/amqp-contract/blob/00468eb63a019d6161c43f07dab8b68232bbb383/packages/client-nestjs/src/client.module-definition.ts#L5)
459
459
 
460
460
  Injection token for AMQP client module options
461
461
  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.9.0",
3
+ "version": "0.10.0",
4
4
  "description": "NestJS integration for @amqp-contract/client",
5
5
  "keywords": [
6
6
  "amqp",
@@ -52,8 +52,8 @@
52
52
  "docs"
53
53
  ],
54
54
  "dependencies": {
55
- "@amqp-contract/client": "0.9.0",
56
- "@amqp-contract/contract": "0.9.0"
55
+ "@amqp-contract/client": "0.10.0",
56
+ "@amqp-contract/contract": "0.10.0"
57
57
  },
58
58
  "devDependencies": {
59
59
  "@nestjs/common": "11.1.11",
@@ -73,7 +73,7 @@
73
73
  "typescript": "5.9.3",
74
74
  "vitest": "4.0.16",
75
75
  "zod": "4.3.5",
76
- "@amqp-contract/testing": "0.9.0",
76
+ "@amqp-contract/testing": "0.10.0",
77
77
  "@amqp-contract/tsconfig": "0.1.0",
78
78
  "@amqp-contract/typedoc": "0.1.0"
79
79
  },