@amqp-contract/asyncapi 0.2.1 → 0.3.0

package/README.md

@@ -19,11 +19,19 @@ pnpm add @amqp-contract/asyncapi
 ## Usage
 
 ```typescript
-import { generateAsyncAPI } from '@amqp-contract/asyncapi';
+import { AsyncAPIGenerator } from '@amqp-contract/asyncapi';
+import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4';
+import { writeFileSync } from 'fs';
+
 import { contract } from './contract';
 
+// Create generator with schema converters
+const generator = new AsyncAPIGenerator({
+  schemaConverters: [new ZodToJsonSchemaConverter()],
+});
+
 // Generate AsyncAPI specification
-const asyncAPISpec = generateAsyncAPI(contract, {
+const asyncAPISpec = await generator.generate(contract, {
   info: {
     title: 'My AMQP API',
     version: '1.0.0',
@@ -47,24 +55,27 @@ const asyncAPISpec = generateAsyncAPI(contract, {
 console.log(JSON.stringify(asyncAPISpec, null, 2));
 
 // Or write to file
-import { writeFileSync } from 'fs';
 writeFileSync('asyncapi.json', JSON.stringify(asyncAPISpec, null, 2));
 ```
 
 ## API
 
-### `generateAsyncAPI(contract, options)`
+### `AsyncAPIGenerator`
+
+Generator class for creating AsyncAPI 3.0.0 specifications from AMQP contracts.
 
-Generate an AsyncAPI 3.0.0 specification from an AMQP contract.
+**Constructor Parameters:**
 
-**Parameters:**
+- `options.schemaConverters`: Array of schema converters (e.g., `ZodToJsonSchemaConverter`)
 
-- `contract`: The AMQP contract definition
-- `options`: Configuration options
-  - `info`: API information (title, version, description, etc.)
-  - `servers`: Server configurations (optional)
+**Methods:**
 
-**Returns:** AsyncAPI 3.0.0 document
+- `generate(contract, options)`: Generate an AsyncAPI specification
+  - `contract`: The AMQP contract definition
+  - `options`: Configuration options
+    - `info`: API information (title, version, description, etc.)
+    - `servers`: Server configurations (optional)
+  - Returns: `Promise<AsyncAPIObject>` - AsyncAPI 3.0.0 document
 
 ## Features
 

package/docs/index.md

@@ -8,7 +8,7 @@
 
 ### AsyncAPIGenerator
 
-Defined in: [index.ts:92](https://github.com/btravers/amqp-contract/blob/f0945f098387fd3a6a40beac8cbe2ed7a4de210a/packages/asyncapi/src/index.ts#L92)
+Defined in: [index.ts:92](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/asyncapi/src/index.ts#L92)
 
 Generator for creating AsyncAPI 3.0 documentation from AMQP contracts.
 
@@ -65,7 +65,7 @@ const asyncapi = await generator.generate(contract, {
 new AsyncAPIGenerator(options): AsyncAPIGenerator;
 ```
 
-Defined in: [index.ts:100](https://github.com/btravers/amqp-contract/blob/f0945f098387fd3a6a40beac8cbe2ed7a4de210a/packages/asyncapi/src/index.ts#L100)
+Defined in: [index.ts:100](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/asyncapi/src/index.ts#L100)
 
 Create a new AsyncAPI generator instance.
 
@@ -87,7 +87,7 @@ Create a new AsyncAPI generator instance.
 generate(contract, options): Promise<AsyncAPIObject>;
 ```
 
-Defined in: [index.ts:132](https://github.com/btravers/amqp-contract/blob/f0945f098387fd3a6a40beac8cbe2ed7a4de210a/packages/asyncapi/src/index.ts#L132)
+Defined in: [index.ts:132](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/asyncapi/src/index.ts#L132)
 
 Generate an AsyncAPI 3.0 document from a contract definition.
 
@@ -130,7 +130,7 @@ const asyncapi = await generator.generate(contract, {
 
 ### AsyncAPIGeneratorOptions
 
-Defined in: [index.ts:31](https://github.com/btravers/amqp-contract/blob/f0945f098387fd3a6a40beac8cbe2ed7a4de210a/packages/asyncapi/src/index.ts#L31)
+Defined in: [index.ts:31](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/asyncapi/src/index.ts#L31)
 
 Options for configuring the AsyncAPI generator.
 
@@ -149,7 +149,7 @@ const generator = new AsyncAPIGenerator({
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <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:36](https://github.com/btravers/amqp-contract/blob/f0945f098387fd3a6a40beac8cbe2ed7a4de210a/packages/asyncapi/src/index.ts#L36) |
+| <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:36](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/asyncapi/src/index.ts#L36) |
 
 ## Type Aliases
 
@@ -159,7 +159,7 @@ const generator = new AsyncAPIGenerator({
 type AsyncAPIGeneratorGenerateOptions = Pick<AsyncAPIObject, "id" | "info" | "servers">;
 ```
 
-Defined in: [index.ts:43](https://github.com/btravers/amqp-contract/blob/f0945f098387fd3a6a40beac8cbe2ed7a4de210a/packages/asyncapi/src/index.ts#L43)
+Defined in: [index.ts:43](https://github.com/btravers/amqp-contract/blob/63bb54252f8a9109544152686427ef223964c15c/packages/asyncapi/src/index.ts#L43)
 
 Options for generating an AsyncAPI document.
 These correspond to the top-level AsyncAPI document fields.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amqp-contract/asyncapi",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "AsyncAPI specification generator for amqp-contract",
   "keywords": [
     "amqp",
@@ -44,7 +44,7 @@
   "dependencies": {
     "@orpc/openapi": "1.13.0",
     "@standard-schema/spec": "1.1.0",
-    "@amqp-contract/contract": "0.2.1"
+    "@amqp-contract/contract": "0.3.0"
   },
   "devDependencies": {
     "@asyncapi/parser": "3.4.0",