@amqp-contract/asyncapi 0.16.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.
- package/docs/index.md +7 -7
- package/package.json +8 -8
package/docs/index.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
### AsyncAPIGenerator
|
|
10
10
|
|
|
11
|
-
Defined in: [index.ts:96](https://github.com/btravers/amqp-contract/blob/
|
|
11
|
+
Defined in: [index.ts:96](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/asyncapi/src/index.ts#L96)
|
|
12
12
|
|
|
13
13
|
Generator for creating AsyncAPI 3.0 documentation from AMQP contracts.
|
|
14
14
|
|
|
@@ -63,10 +63,10 @@ const asyncapi = await generator.generate(contract, {
|
|
|
63
63
|
##### Constructor
|
|
64
64
|
|
|
65
65
|
```ts
|
|
66
|
-
new AsyncAPIGenerator(options): AsyncAPIGenerator;
|
|
66
|
+
new AsyncAPIGenerator(options?): AsyncAPIGenerator;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [index.ts:104](https://github.com/btravers/amqp-contract/blob/
|
|
69
|
+
Defined in: [index.ts:104](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/asyncapi/src/index.ts#L104)
|
|
70
70
|
|
|
71
71
|
Create a new AsyncAPI generator instance.
|
|
72
72
|
|
|
@@ -88,7 +88,7 @@ Create a new AsyncAPI generator instance.
|
|
|
88
88
|
generate(contract, options): Promise<AsyncAPIObject>;
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
Defined in: [index.ts:136](https://github.com/btravers/amqp-contract/blob/
|
|
91
|
+
Defined in: [index.ts:136](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/asyncapi/src/index.ts#L136)
|
|
92
92
|
|
|
93
93
|
Generate an AsyncAPI 3.0 document from a contract definition.
|
|
94
94
|
|
|
@@ -135,7 +135,7 @@ const asyncapi = await generator.generate(contract, {
|
|
|
135
135
|
type AsyncAPIGeneratorGenerateOptions = Pick<AsyncAPIObject, "info"> & Partial<Pick<AsyncAPIObject, "id" | "servers">>;
|
|
136
136
|
```
|
|
137
137
|
|
|
138
|
-
Defined in: [index.ts:45](https://github.com/btravers/amqp-contract/blob/
|
|
138
|
+
Defined in: [index.ts:45](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/asyncapi/src/index.ts#L45)
|
|
139
139
|
|
|
140
140
|
Options for generating an AsyncAPI document.
|
|
141
141
|
These correspond to the top-level AsyncAPI document fields.
|
|
@@ -148,7 +148,7 @@ These correspond to the top-level AsyncAPI document fields.
|
|
|
148
148
|
type AsyncAPIGeneratorOptions = object;
|
|
149
149
|
```
|
|
150
150
|
|
|
151
|
-
Defined in: [index.ts:33](https://github.com/btravers/amqp-contract/blob/
|
|
151
|
+
Defined in: [index.ts:33](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/asyncapi/src/index.ts#L33)
|
|
152
152
|
|
|
153
153
|
Options for configuring the AsyncAPI generator.
|
|
154
154
|
|
|
@@ -167,4 +167,4 @@ const generator = new AsyncAPIGenerator({
|
|
|
167
167
|
|
|
168
168
|
| Property | Type | Description | Defined in |
|
|
169
169
|
| ------ | ------ | ------ | ------ |
|
|
170
|
-
| <a id="schemaconverters"></a> `schemaConverters?` | `ConditionalSchemaConverter`[] | Schema converters for transforming validation schemas to JSON Schema. Supports Zod, Valibot, ArkType, and other Standard Schema v1 compatible libraries. | [index.ts:38](https://github.com/btravers/amqp-contract/blob/
|
|
170
|
+
| <a id="schemaconverters"></a> `schemaConverters?` | `ConditionalSchemaConverter`[] | Schema converters for transforming validation schemas to JSON Schema. Supports Zod, Valibot, ArkType, and other Standard Schema v1 compatible libraries. | [index.ts:38](https://github.com/btravers/amqp-contract/blob/fc480811955c7c63b50aea18b1676c065870bfae/packages/asyncapi/src/index.ts#L38) |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/asyncapi",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.18.0",
|
|
4
4
|
"description": "AsyncAPI specification generator for amqp-contract",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"amqp",
|
|
@@ -49,21 +49,21 @@
|
|
|
49
49
|
"docs"
|
|
50
50
|
],
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@orpc/openapi": "1.13.
|
|
52
|
+
"@orpc/openapi": "1.13.5",
|
|
53
53
|
"@standard-schema/spec": "1.1.0",
|
|
54
|
-
"@amqp-contract/contract": "0.
|
|
54
|
+
"@amqp-contract/contract": "0.18.0"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"@asyncapi/parser": "3.6.0",
|
|
58
|
-
"@orpc/arktype": "1.13.
|
|
59
|
-
"@orpc/valibot": "1.13.
|
|
60
|
-
"@orpc/zod": "1.13.
|
|
61
|
-
"@types/node": "25.2.
|
|
58
|
+
"@orpc/arktype": "1.13.5",
|
|
59
|
+
"@orpc/valibot": "1.13.5",
|
|
60
|
+
"@orpc/zod": "1.13.5",
|
|
61
|
+
"@types/node": "25.2.3",
|
|
62
62
|
"@vitest/coverage-v8": "4.0.18",
|
|
63
63
|
"arktype": "2.1.29",
|
|
64
64
|
"tsdown": "0.20.3",
|
|
65
65
|
"typedoc": "0.28.16",
|
|
66
|
-
"typedoc-plugin-markdown": "4.
|
|
66
|
+
"typedoc-plugin-markdown": "4.10.0",
|
|
67
67
|
"typescript": "5.9.3",
|
|
68
68
|
"valibot": "1.2.0",
|
|
69
69
|
"vitest": "4.0.18",
|