@amqp-contract/client 0.19.0 → 0.20.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 +16 -16
  2. package/package.json +6 -6
package/docs/index.md CHANGED
@@ -64,7 +64,7 @@ Error.constructor
64
64
  | <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 |
65
65
  | <a id="source"></a> `source` | `readonly` | `string` | - | - | packages/core/dist/index.d.mts:84 |
66
66
  | <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 |
67
- | <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 |
67
+ | <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.3.0/node\_modules/@types/node/globals.d.ts:67 |
68
68
 
69
69
  #### Methods
70
70
 
@@ -74,7 +74,7 @@ Error.constructor
74
74
  static captureStackTrace(targetObject, constructorOpt?): void;
75
75
  ```
76
76
 
77
- Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:51
77
+ Defined in: node\_modules/.pnpm/@types+node@25.3.0/node\_modules/@types/node/globals.d.ts:51
78
78
 
79
79
  Creates a `.stack` property on `targetObject`, which when accessed returns
80
80
  a string representing the location in the code at which
@@ -143,7 +143,7 @@ Error.captureStackTrace
143
143
  static prepareStackTrace(err, stackTraces): any;
144
144
  ```
145
145
 
146
- Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:55
146
+ Defined in: node\_modules/.pnpm/@types+node@25.3.0/node\_modules/@types/node/globals.d.ts:55
147
147
 
148
148
  ###### Parameters
149
149
 
@@ -170,7 +170,7 @@ Error.prepareStackTrace
170
170
 
171
171
  ### TypedAmqpClient
172
172
 
173
- Defined in: [packages/client/src/client.ts:56](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L56)
173
+ Defined in: [packages/client/src/client.ts:56](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L56)
174
174
 
175
175
  Type-safe AMQP client for publishing messages
176
176
 
@@ -188,7 +188,7 @@ Type-safe AMQP client for publishing messages
188
188
  close(): Future<Result<void, TechnicalError>>;
189
189
  ```
190
190
 
191
- Defined in: [packages/client/src/client.ts:203](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L203)
191
+ Defined in: [packages/client/src/client.ts:203](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L203)
192
192
 
193
193
  Close the channel and connection
194
194
 
@@ -205,7 +205,7 @@ publish<TName>(
205
205
  options?): Future<Result<void, TechnicalError | MessageValidationError>>;
206
206
  ```
207
207
 
208
- Defined in: [packages/client/src/client.ts:109](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L109)
208
+ Defined in: [packages/client/src/client.ts:109](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L109)
209
209
 
210
210
  Publish a message using a defined publisher.
211
211
  TypeScript guarantees publisher exists for valid publisher names.
@@ -234,7 +234,7 @@ TypeScript guarantees publisher exists for valid publisher names.
234
234
  static create<TContract>(__namedParameters): Future<Result<TypedAmqpClient<TContract>, TechnicalError>>;
235
235
  ```
236
236
 
237
- Defined in: [packages/client/src/client.ts:74](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L74)
237
+ Defined in: [packages/client/src/client.ts:74](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L74)
238
238
 
239
239
  Create a type-safe AMQP client from a contract.
240
240
 
@@ -269,7 +269,7 @@ connection options, following RabbitMQ best practices.
269
269
  type ClientInferPublisherInput<TContract, TName> = PublisherInferInput<InferPublisher<TContract, TName>>;
270
270
  ```
271
271
 
272
- Defined in: [packages/client/src/types.ts:41](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/types.ts#L41)
272
+ Defined in: [packages/client/src/types.ts:41](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/types.ts#L41)
273
273
 
274
274
  Infer publisher input type (message payload) for a specific publisher in a contract
275
275
 
@@ -288,7 +288,7 @@ Infer publisher input type (message payload) for a specific publisher in a contr
288
288
  type CreateClientOptions<TContract> = object;
289
289
  ```
290
290
 
291
- Defined in: [packages/client/src/client.ts:40](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L40)
291
+ Defined in: [packages/client/src/client.ts:40](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L40)
292
292
 
293
293
  Options for creating a client
294
294
 
@@ -302,11 +302,11 @@ Options for creating a client
302
302
 
303
303
  | Property | Type | Description | Defined in |
304
304
  | ------ | ------ | ------ | ------ |
305
- | <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | - | [packages/client/src/client.ts:43](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L43) |
306
- | <a id="contract"></a> `contract` | `TContract` | - | [packages/client/src/client.ts:41](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L41) |
307
- | <a id="logger"></a> `logger?` | `Logger` | - | [packages/client/src/client.ts:44](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L44) |
308
- | <a id="telemetry"></a> `telemetry?` | `TelemetryProvider` | Optional telemetry provider for tracing and metrics. If not provided, uses the default provider which attempts to load OpenTelemetry. OpenTelemetry instrumentation is automatically enabled if @opentelemetry/api is installed. | [packages/client/src/client.ts:50](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L50) |
309
- | <a id="urls"></a> `urls` | `ConnectionUrl`[] | - | [packages/client/src/client.ts:42](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L42) |
305
+ | <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | - | [packages/client/src/client.ts:43](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L43) |
306
+ | <a id="contract"></a> `contract` | `TContract` | - | [packages/client/src/client.ts:41](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L41) |
307
+ | <a id="logger"></a> `logger?` | `Logger` | - | [packages/client/src/client.ts:44](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L44) |
308
+ | <a id="telemetry"></a> `telemetry?` | `TelemetryProvider` | Optional telemetry provider for tracing and metrics. If not provided, uses the default provider which attempts to load OpenTelemetry. OpenTelemetry instrumentation is automatically enabled if @opentelemetry/api is installed. | [packages/client/src/client.ts:50](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L50) |
309
+ | <a id="urls"></a> `urls` | `ConnectionUrl`[] | - | [packages/client/src/client.ts:42](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L42) |
310
310
 
311
311
  ***
312
312
 
@@ -316,7 +316,7 @@ Options for creating a client
316
316
  type PublishOptions = Options.Publish & object;
317
317
  ```
318
318
 
319
- Defined in: [packages/client/src/client.ts:28](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L28)
319
+ Defined in: [packages/client/src/client.ts:28](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L28)
320
320
 
321
321
  Publish options that extend amqplib's Options.Publish with optional compression support.
322
322
 
@@ -324,4 +324,4 @@ Publish options that extend amqplib's Options.Publish with optional compression
324
324
 
325
325
  | Name | Type | Description | Defined in |
326
326
  | ------ | ------ | ------ | ------ |
327
- | `compression?` | `CompressionAlgorithm` | Optional compression algorithm to use for the message payload. When specified, the message will be compressed using the chosen algorithm and the contentEncoding header will be set automatically. | [packages/client/src/client.ts:34](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/client/src/client.ts#L34) |
327
+ | `compression?` | `CompressionAlgorithm` | Optional compression algorithm to use for the message payload. When specified, the message will be compressed using the chosen algorithm and the contentEncoding header will be set automatically. | [packages/client/src/client.ts:34](https://github.com/btravers/amqp-contract/blob/04791f62e768b84b07aa5288adb8ab72296d6663/packages/client/src/client.ts#L34) |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amqp-contract/client",
3
- "version": "0.19.0",
3
+ "version": "0.20.0",
4
4
  "description": "Client utilities for publishing messages using amqp-contract",
5
5
  "keywords": [
6
6
  "amqp",
@@ -53,22 +53,22 @@
53
53
  "@standard-schema/spec": "1.1.0",
54
54
  "@swan-io/boxed": "3.2.1",
55
55
  "ts-pattern": "5.9.0",
56
- "@amqp-contract/contract": "0.19.0",
57
- "@amqp-contract/core": "0.19.0"
56
+ "@amqp-contract/contract": "0.20.0",
57
+ "@amqp-contract/core": "0.20.0"
58
58
  },
59
59
  "devDependencies": {
60
60
  "@types/amqplib": "0.10.8",
61
- "@types/node": "25.2.3",
61
+ "@types/node": "25.3.0",
62
62
  "@vitest/coverage-v8": "4.0.18",
63
63
  "amqp-connection-manager": "5.0.0",
64
64
  "amqplib": "0.10.9",
65
65
  "tsdown": "0.20.3",
66
- "typedoc": "0.28.16",
66
+ "typedoc": "0.28.17",
67
67
  "typedoc-plugin-markdown": "4.10.0",
68
68
  "typescript": "5.9.3",
69
69
  "vitest": "4.0.18",
70
70
  "zod": "4.3.6",
71
- "@amqp-contract/testing": "0.19.0",
71
+ "@amqp-contract/testing": "0.20.0",
72
72
  "@amqp-contract/tsconfig": "0.1.0",
73
73
  "@amqp-contract/typedoc": "0.1.0"
74
74
  },