@wisemen/nestjs-async-api 0.0.0

package/.eslintcache

@@ -0,0 +1 @@
+[{"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/eslint.config.js":"1","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-column.ts":"2","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-command.builder.ts":"3","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-command.ts":"4","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-response.ts":"5","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address.builder.ts":"6","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address.ts":"7","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/index.ts":"8","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/is-address.validator.ts":"9","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/address-column.integration.test.ts":"10","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/is-address.validator.unit.test.ts":"11","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/sql/address-test.entity.ts":"12","/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/sql/datasource.ts":"13","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/eslint.config.js":"14","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/async-api-definition.types.ts":"15","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/async-api.types.ts":"16","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/create-channel.ts":"17","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/generate-async-api-html.ts":"18","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/generate-async-api-yaml.ts":"19","/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/index.ts":"20"},{"size":357,"mtime":1768820135069,"results":"21","hashOfConfig":"22"},{"size":887,"mtime":1768819954982,"results":"23","hashOfConfig":"24"},{"size":1035,"mtime":1768819954982,"results":"25","hashOfConfig":"24"},{"size":2013,"mtime":1768819804323,"results":"26","hashOfConfig":"24"},{"size":1420,"mtime":1768819804324,"results":"27","hashOfConfig":"24"},{"size":1352,"mtime":1768819954982,"results":"28","hashOfConfig":"24"},{"size":327,"mtime":1768819804324,"results":"29","hashOfConfig":"24"},{"size":411,"mtime":1768819804324,"results":"30","hashOfConfig":"24"},{"size":2949,"mtime":1768819954982,"results":"31","hashOfConfig":"24"},{"size":5341,"mtime":1768820137303,"results":"32","hashOfConfig":"33"},{"size":4618,"mtime":1768820202242,"results":"34","hashOfConfig":"33"},{"size":283,"mtime":1768820158704,"results":"35","hashOfConfig":"24"},{"size":370,"mtime":1768819804327,"results":"36","hashOfConfig":"24"},{"size":357,"mtime":1770738733468,"results":"37","hashOfConfig":"38"},{"size":955,"mtime":1770739412145,"results":"39","hashOfConfig":"40"},{"size":4322,"mtime":1770739141464,"results":"41","hashOfConfig":"40"},{"size":656,"mtime":1770739431600,"results":"42","hashOfConfig":"40"},{"size":611,"mtime":1770739438631,"results":"43","hashOfConfig":"40"},{"size":3558,"mtime":1770739532981,"results":"44","hashOfConfig":"40"},{"size":211,"mtime":1770739592457,"results":"45","hashOfConfig":"40"},{"filePath":"46","messages":"47","suppressedMessages":"48","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"lwlkib",{"filePath":"49","messages":"50","suppressedMessages":"51","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1o8juwo",{"filePath":"52","messages":"53","suppressedMessages":"54","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"55","messages":"56","suppressedMessages":"57","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"58","messages":"59","suppressedMessages":"60","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"61","messages":"62","suppressedMessages":"63","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"64","messages":"65","suppressedMessages":"66","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"67","messages":"68","suppressedMessages":"69","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"70","messages":"71","suppressedMessages":"72","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"73","messages":"74","suppressedMessages":"75","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"x22v1o",{"filePath":"76","messages":"77","suppressedMessages":"78","errorCount":2,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"79","messages":"80","suppressedMessages":"81","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"82","messages":"83","suppressedMessages":"84","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"85","messages":"86","suppressedMessages":"87","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"5esopc",{"filePath":"88","messages":"89","suppressedMessages":"90","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"yhymis",{"filePath":"91","messages":"92","suppressedMessages":"93","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"94","messages":"95","suppressedMessages":"96","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"97","messages":"98","suppressedMessages":"99","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"100","messages":"101","suppressedMessages":"102","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"103","messages":"104","suppressedMessages":"105","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/eslint.config.js",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-column.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-command.builder.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-command.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address-response.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address.builder.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/address.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/index.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/is-address.validator.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/address-column.integration.test.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/is-address.validator.unit.test.ts",["106","107"],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/sql/address-test.entity.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/address/lib/tests/sql/datasource.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/eslint.config.js",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/async-api-definition.types.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/async-api.types.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/create-channel.ts",[],[],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/generate-async-api-html.ts",[],["108","109","110","111"],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/generate-async-api-yaml.ts",[],["112"],"/Users/kobe/Documents/Projects/project-template/node-core/packages/async-api/lib/index.ts",[],[],{"ruleId":"113","severity":2,"message":"114","line":137,"column":5,"nodeType":"115","messageId":"116","endLine":137,"endColumn":57},{"ruleId":"117","severity":2,"message":"118","line":137,"column":54,"nodeType":"119","messageId":"120","endLine":137,"endColumn":57,"suggestions":"121"},{"ruleId":"113","severity":2,"message":"122","line":12,"column":9,"nodeType":"123","messageId":"116","endLine":22,"endColumn":4,"suppressions":"124"},{"ruleId":"125","severity":2,"message":"126","line":12,"column":21,"nodeType":"127","messageId":"128","endLine":22,"endColumn":4,"suppressions":"129"},{"ruleId":"125","severity":2,"message":"130","line":24,"column":9,"nodeType":"131","messageId":"132","endLine":24,"endColumn":37,"suppressions":"133"},{"ruleId":"134","severity":2,"message":"135","line":24,"column":19,"nodeType":"136","messageId":"137","endLine":24,"endColumn":37,"suppressions":"138"},{"ruleId":"139","severity":2,"message":"140","line":63,"column":33,"nodeType":"136","messageId":"141","endLine":63,"endColumn":41,"suppressions":"142"},"@typescript-eslint/no-unsafe-assignment","Unsafe assignment of an `any` value.","AssignmentExpression","anyAssignment","@typescript-eslint/no-explicit-any","Unexpected any. Specify a different type.","TSAnyKeyword","unexpectedAny",["143","144"],"Unsafe assignment of an error typed value.","VariableDeclarator",["145"],"@typescript-eslint/no-unsafe-call","Unsafe construction of a type that could not be resolved.","NewExpression","errorNew",["146"],"Unsafe call of a type that could not be resolved.","MemberExpression","errorCall",["147"],"@typescript-eslint/no-unsafe-member-access","Unsafe member access .generateFromString on a type that cannot be resolved.","Identifier","errorMemberExpression",["148"],"@typescript-eslint/no-unsafe-function-type","The `Function` type accepts any function-like value.\nPrefer explicitly defining any function parameters and return type.","bannedFunctionType",["149"],{"messageId":"150","fix":"151","desc":"152"},{"messageId":"153","fix":"154","desc":"155"},{"kind":"156","justification":"157"},{"kind":"156","justification":"157"},{"kind":"156","justification":"157"},{"kind":"156","justification":"157"},{"kind":"156","justification":"157"},"suggestUnknown",{"range":"158","text":"159"},"Use `unknown` instead, this will force you to explicitly, and safely assert the type is correct.","suggestNever",{"range":"160","text":"161"},"Use `never` instead, this is useful when instantiating generic type parameters that you don't need to know the type of.","directive","",[4392,4395],"unknown",[4392,4395],"never"]

package/README.md

@@ -0,0 +1,121 @@
+# @wisemen/nestjs-async-api
+
+A TypeScript package for generating AsyncAPI v3.0.0 documentation for NestJS applications. Automatically generate YAML specifications and HTML documentation for your asynchronous APIs (WebSockets, message queues, event-driven architectures).
+
+## Features
+
+- **AsyncAPI v3.0.0 Types**: Complete TypeScript type definitions for AsyncAPI specification
+- **Channel Definitions**: Type-safe channel definitions with parameter extraction
+- **YAML Generation**: Automatically generate AsyncAPI YAML specifications from your code
+- **HTML Documentation**: Generate beautiful HTML documentation using AsyncAPI templates
+- **NestJS Integration**: Seamlessly integrates with NestJS decorators and DTOs
+- **Schema Generation**: Automatic schema generation from TypeScript classes using NestJS Swagger decorators
+
+## Installation
+
+```bash
+npm install @wisemen/nestjs-async-api
+```
+
+## Usage
+
+### Define a Channel
+
+Create channels using the `createChannel` function with type-safe address parameters:
+
+```typescript
+import { createChannel } from '@wisemen/nestjs-async-api'
+
+export const userNotificationsChannel = createChannel(
+  'users.{userId}.notifications',
+  {
+    parameters: {
+      userId: {
+        description: 'The ID of the user receiving notifications'
+      }
+    },
+    operations: {
+      subscribe: {
+        action: 'receive',
+        summary: 'Subscribe to user notifications',
+        description: 'Receive real-time notifications for a specific user',
+        messages: [
+            UserNotificationEvent // a DTO decorated with @nestjs/swagger properties
+        ]
+      }
+    }
+  }
+)
+```
+
+### Define Your AsyncAPI Specification
+
+Create an AsyncAPI definition that points to your channel files:
+
+```typescript
+import { AsyncAPIDefinition } from '@wisemen/nestjs-async-api'
+
+export const asyncApiDefinition: AsyncAPIDefinition = {
+  asyncapi: '3.0.0',
+  defaultContentType: 'application/json',
+  info: {
+    title: 'My Application API',
+    version: '1.0.0',
+    description: 'Real-time event API for My Application',
+    contact: {
+      name: 'API Support',
+      email: 'support@example.com'
+    }
+  },
+  channels: 'src/**/*.channel.ts'  // Glob pattern to find channel files
+}
+```
+
+### Generate YAML Documentation
+
+Generate AsyncAPI YAML specification from your definitions:
+
+```typescript
+import { generateAsyncApiYaml } from '@wisemen/nestjs-async-api'
+import { asyncApiDefinition } from './async-api.definition'
+
+const yaml = await generateAsyncApiYaml(asyncApiDefinition)
+console.log(yaml)
+```
+
+### Generate HTML Documentation
+
+Generate beautiful HTML documentation from your YAML specification:
+
+```typescript
+import { generateAsyncAPIHTML } from '@wisemen/nestjs-async-api'
+
+await generateAsyncAPIHTML(
+  yaml,                    // AsyncAPI YAML string
+  './docs',                // Output directory
+  'async-api.html'         // Output filename
+)
+```
+
+## Integration with NestJS
+
+This package works seamlessly with NestJS decorators from `@nestjs/swagger`. Use `@ApiProperty()` decorators on your DTOs, and they will be automatically converted to AsyncAPI schemas:
+
+```typescript
+import { ApiProperty } from '@nestjs/swagger'
+
+export class UserNotificationEvent {
+  @ApiProperty({ description: 'Notification ID' })
+  id: string
+
+  @ApiProperty({ description: 'Notification message' })
+  message: string
+
+  @ApiProperty({ description: 'Timestamp', type: Date })
+  timestamp: Date
+}
+```
+
+## License
+
+GPL

package/dist/lib/async-api-definition.types.d.ts

@@ -0,0 +1,27 @@
+import { AsyncAPIInfo, AsyncAPIOperation, AsyncAPIParameter } from './async-api.types.js';
+type ExtractParams<T> = T extends `{${infer Param}}.${infer Rest}` ? {
+    [K in Param]: string;
+} & ExtractParams<Rest> : T extends `${infer _Start}.{${infer Param}}${infer Rest}` ? {
+    [K in Param]: string;
+} & ExtractParams<Rest> : object;
+export type AsyncAPIChannelParameters<Address> = {
+    [Param in keyof ExtractParams<Address>]: AsyncAPIParameter;
+};
+export type AsyncAPIOperationDefinition = Omit<AsyncAPIOperation, 'messages' | 'channel' | 'reply'> & {
+    messages?: {
+        name: string;
+        constructor: () => unknown;
+    }[];
+};
+export type AsyncAPIChannelDefinition<Address extends string> = {
+    address: Address;
+    parameters: AsyncAPIChannelParameters<Address>;
+    operations?: Record<string, AsyncAPIOperationDefinition>;
+};
+export type AsyncAPIDefinition = {
+    asyncapi: string;
+    defaultContentType: string;
+    info: AsyncAPIInfo;
+    channels: string;
+};
+export {};

package/dist/lib/async-api-definition.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=async-api-definition.types.js.map

package/dist/lib/async-api-definition.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-api-definition.types.js","sourceRoot":"","sources":["../../lib/async-api-definition.types.ts"],"names":[],"mappings":""}

package/dist/lib/async-api.types.d.ts

@@ -0,0 +1,148 @@
+export type AsyncApiRef = {
+    $ref: string;
+};
+export type AsyncAPIDocument = {
+    asyncapi: string;
+    id?: string;
+    info: AsyncAPIInfo;
+    servers?: Record<string, AsyncAPIServer>;
+    defaultContentType?: string;
+    channels: Record<string, AsyncAPIChannel>;
+    operations?: Record<string, AsyncAPIOperation>;
+    components?: AsyncAPIComponents;
+    tags?: AsyncAPITag[];
+    externalDocs?: AsyncAPIExternalDocs;
+};
+export type AsyncAPIInfo = {
+    title: string;
+    version: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: AsyncAPIContact;
+    license?: AsyncAPILicense;
+};
+export type AsyncAPIContact = {
+    name?: string;
+    url?: string;
+    email?: string;
+};
+export type AsyncAPILicense = {
+    name: string;
+    url?: string;
+};
+export type AsyncAPIServer = {
+    host: string;
+    protocol: string;
+    protocolVersion?: string;
+    description?: string;
+    tags?: AsyncAPITag[];
+    security?: AsyncAPISecurityRequirement[];
+    variables?: Record<string, AsyncAPIServerVariable>;
+    bindings?: AsyncAPIServerBindings;
+};
+export type AsyncAPIServerVariable = {
+    description?: string;
+    default: string;
+    examples?: string[];
+    enum?: string[];
+};
+export type AsyncAPISecurityRequirement = Record<string, string[]>;
+export type AsyncAPIServerBindings = Record<string, unknown>;
+export type AsyncAPIChannel = {
+    address: string;
+    description?: string;
+    parameters?: Record<string, AsyncAPIParameter>;
+    messages?: Record<string, AsyncApiRef>;
+    subscribe?: string;
+    publish?: string;
+    bindings?: AsyncAPIChannelBindings;
+};
+export type AsyncAPIChannelBindings = Record<string, unknown>;
+export type AsyncAPIParameter = {
+    enum?: string[];
+    default?: string;
+    description?: string;
+    examples?: string[];
+    location?: string;
+};
+export type AsyncAPIOperation = {
+    action: 'send' | 'receive';
+    channel: AsyncApiRef;
+    title?: string;
+    summary?: string;
+    description?: string;
+    tags?: AsyncAPITag[];
+    externalDocs?: AsyncAPIExternalDocs;
+    bindings?: AsyncAPIOperationBindings;
+    traits?: (string | AsyncAPIOperationTrait)[];
+    messages?: AsyncApiRef[];
+    security?: AsyncAPISecurityRequirement[];
+    deprecated?: boolean;
+    reply?: AsyncAPIOperationReply;
+};
+export type AsyncAPIOperationReply = {
+    address?: AsyncAPIOperationReplyAddress;
+    channel?: AsyncApiRef;
+    messages?: AsyncApiRef;
+};
+export type AsyncAPIOperationReplyAddress = {
+    location: string;
+    description?: string;
+};
+export type AsyncAPIOperationTrait = Record<string, unknown>;
+export type AsyncAPIOperationBindings = Record<string, unknown>;
+export type AsyncAPIMessage = {
+    name?: string;
+    title?: string;
+    summary?: string;
+    description?: string;
+    headers?: AsyncAPISchema;
+    payload?: AsyncApiRef;
+    correlationId?: AsyncAPICorrelationId;
+    schemaFormat?: string;
+    contentType?: string;
+    tags?: AsyncAPITag[];
+    externalDocs?: AsyncAPIExternalDocs;
+    bindings?: AsyncAPIMessageBindings;
+    examples?: unknown[];
+    traits?: (string | AsyncAPIMessageTrait)[];
+};
+export type AsyncAPIMessageTrait = Record<string, unknown>;
+export type AsyncAPIMessageBindings = Record<string, unknown>;
+export type AsyncAPICorrelationId = {
+    description?: string;
+    location: string;
+};
+export type AsyncAPISchema = Record<string, unknown>;
+export type AsyncAPIComponents = {
+    schemas?: Record<string, AsyncAPISchema>;
+    messages?: Record<string, AsyncAPIMessage>;
+    securitySchemes?: Record<string, AsyncAPISecurityScheme>;
+    parameters?: Record<string, AsyncAPIParameter>;
+    correlationIds?: Record<string, AsyncAPICorrelationId>;
+    operationTraits?: Record<string, AsyncAPIOperationTrait>;
+    messageTraits?: Record<string, AsyncAPIMessageTrait>;
+    serverBindings?: Record<string, AsyncAPIServerBindings>;
+    channelBindings?: Record<string, AsyncAPIChannelBindings>;
+    operationBindings?: Record<string, AsyncAPIOperationBindings>;
+    messageBindings?: Record<string, AsyncAPIMessageBindings>;
+};
+export type AsyncAPISecurityScheme = {
+    type: string;
+    description?: string;
+    name?: string;
+    in?: string;
+    scheme?: string;
+    bearerFormat?: string;
+    flows?: unknown;
+    openIdConnectUrl?: string;
+};
+export type AsyncAPITag = {
+    name: string;
+    description?: string;
+    externalDocs?: AsyncAPIExternalDocs;
+};
+export type AsyncAPIExternalDocs = {
+    description?: string;
+    url: string;
+};

package/dist/lib/async-api.types.js

@@ -0,0 +1,4 @@
+// AsyncAPI v3.0.0 Document Format as TypeScript Types
+// Reference: https://www.asyncapi.com/docs/reference/specification/v3.0.0
+export {};
+//# sourceMappingURL=async-api.types.js.map

package/dist/lib/async-api.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-api.types.js","sourceRoot":"","sources":["../../lib/async-api.types.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,0EAA0E"}

package/dist/lib/create-channel.d.ts

@@ -0,0 +1,4 @@
+import { AsyncAPIChannelDefinition } from './async-api-definition.types.js';
+export type ChannelConfig<Address extends string> = Omit<AsyncAPIChannelDefinition<Address>, 'address'>;
+export declare function isChannel(value: object): value is AsyncAPIChannelDefinition<string>;
+export declare function createChannel<Address extends string>(address: Address, config: ChannelConfig<Address>): AsyncAPIChannelDefinition<Address>;

package/dist/lib/create-channel.js

@@ -0,0 +1,10 @@
+const CHANNEL_METADATA_KEY = 'async-api:channel';
+export function isChannel(value) {
+    return Reflect.hasMetadata(CHANNEL_METADATA_KEY, value);
+}
+export function createChannel(address, config) {
+    const channel = { address, ...config };
+    Reflect.defineMetadata(CHANNEL_METADATA_KEY, true, channel);
+    return channel;
+}
+//# sourceMappingURL=create-channel.js.map

package/dist/lib/create-channel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-channel.js","sourceRoot":"","sources":["../../lib/create-channel.ts"],"names":[],"mappings":"AAEA,MAAM,oBAAoB,GAAG,mBAAmB,CAAA;AAKhD,MAAM,UAAU,SAAS,CAAE,KAAa;IACtC,OAAO,OAAO,CAAC,WAAW,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAA;AACzD,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,OAAgB,EAChB,MAA8B;IAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,CAAA;IAEtC,OAAO,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAE3D,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/lib/generate-async-api-html.d.ts

@@ -0,0 +1 @@
+export declare function generateAsyncAPIHTML(yaml: string, outputPath: string, fileName: string): Promise<void>;

package/dist/lib/generate-async-api-html.js

@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+import Generator from '@asyncapi/generator';
+export async function generateAsyncAPIHTML(yaml, outputPath, fileName) {
+    const generator = new Generator('@asyncapi/html-template', outputPath, {
+        forceWrite: true,
+        templateParams: {
+            singleFile: true,
+            outFilename: fileName
+        }
+    });
+    await generator.generateFromString(yaml, 'yaml');
+}
+//# sourceMappingURL=generate-async-api-html.js.map

package/dist/lib/generate-async-api-html.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-async-api-html.js","sourceRoot":"","sources":["../../lib/generate-async-api-html.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,sDAAsD;AACtD,4DAA4D;AAE5D,OAAO,SAAS,MAAM,qBAAqB,CAAA;AAE3C,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAY,EACZ,UAAkB,EAClB,QAAgB;IAEhB,MAAM,SAAS,GAAG,IAAI,SAAS,CAC7B,yBAAyB,EACzB,UAAU,EACV;QACE,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE;YACd,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,QAAQ;SACtB;KACF,CACF,CAAA;IAED,MAAM,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AAClD,CAAC"}

package/dist/lib/generate-async-api-yaml.d.ts

@@ -0,0 +1,2 @@
+import { AsyncAPIDefinition } from './async-api-definition.types.js';
+export declare function generateAsyncApiYaml(api: AsyncAPIDefinition): Promise<string>;

package/dist/lib/generate-async-api-yaml.js

@@ -0,0 +1,81 @@
+import { globSync } from 'fs';
+import assert from 'assert';
+import YAML from 'yaml';
+import { SchemaObjectFactory } from '@nestjs/swagger/dist/services/schema-object-factory.js';
+import { ModelPropertiesAccessor } from '@nestjs/swagger/dist/services/model-properties-accessor.js';
+import { SwaggerTypesMapper } from '@nestjs/swagger/dist/services/swagger-types-mapper.js';
+import { pascalCase } from 'change-case';
+import { isChannel } from './create-channel.js';
+export async function generateAsyncApiYaml(api) {
+    const apiDocs = {
+        asyncapi: api.asyncapi,
+        info: api.info,
+        defaultContentType: api.defaultContentType,
+        channels: {},
+        operations: {},
+        components: { messages: {}, schemas: {} }
+    };
+    const channelFiles = globSync(api.channels);
+    const channels = {};
+    for (const channelFile of channelFiles) {
+        const moduleExports = await import('../../../../' + channelFile);
+        for (const exportedKey in moduleExports) {
+            const exported = moduleExports[exportedKey];
+            if (typeof exported !== 'object') {
+                continue;
+            }
+            if (isChannel(exported)) {
+                const channelName = pascalCase(exportedKey.substring(0, exportedKey.indexOf('Channel')));
+                assert(channels[channelName] === undefined, `duplicate channel name ${channelName}`);
+                channels[channelName] = exported;
+            }
+        }
+    }
+    const accessor = new ModelPropertiesAccessor();
+    const typeMapper = new SwaggerTypesMapper();
+    for (const channelName in channels) {
+        const channel = channels[channelName];
+        const channelRef = { $ref: '#/channels/' + channelName };
+        const channelMessages = {};
+        for (const operationName in channel.operations) {
+            const operation = channel.operations[operationName];
+            const operationMessages = [];
+            for (const message of operation.messages) {
+                const name = message.name;
+                const factory = new SchemaObjectFactory(accessor, typeMapper);
+                factory.exploreModelSchema(
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+                message, apiDocs.components.schemas);
+                // Add the message itself
+                apiDocs.components.messages[name] = {
+                    name: name,
+                    contentType: 'application/json',
+                    payload: { $ref: `#/components/schemas/${name}` }
+                };
+                operationMessages.push({ $ref: `#/channels/${channelName}/messages/${name}` });
+                channelMessages[name] = { $ref: '#/components/messages/' + name };
+            }
+            apiDocs.operations[operationName] = {
+                channel: channelRef,
+                action: operation.action,
+                bindings: operation.bindings,
+                deprecated: operation.deprecated,
+                description: operation.description,
+                externalDocs: operation.externalDocs,
+                security: operation.security,
+                summary: operation.summary,
+                title: operation.title,
+                tags: operation.tags,
+                traits: operation.traits,
+                messages: operationMessages
+            };
+        }
+        apiDocs.channels[channelName] = {
+            address: channel.address,
+            parameters: channel.parameters,
+            messages: channelMessages
+        };
+    }
+    return YAML.stringify(apiDocs);
+}
+//# sourceMappingURL=generate-async-api-yaml.js.map

package/dist/lib/generate-async-api-yaml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-async-api-yaml.js","sourceRoot":"","sources":["../../lib/generate-async-api-yaml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAA;AAC7B,OAAO,MAAM,MAAM,QAAQ,CAAA;AAC3B,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,wDAAwD,CAAA;AAC5F,OAAO,EAAE,uBAAuB,EAAE,MAAM,4DAA4D,CAAA;AACpG,OAAO,EAAE,kBAAkB,EAAE,MAAM,uDAAuD,CAAA;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGxC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAE,GAAuB;IACjE,MAAM,OAAO,GAAqB;QAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,kBAAkB,EAAE,GAAG,CAAC,kBAAkB;QAC1C,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;KAC1C,CAAA;IAED,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC3C,MAAM,QAAQ,GAAsD,EAAE,CAAA;IAEtE,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,cAAc,GAAG,WAAW,CAA2B,CAAA;QAE1F,KAAK,MAAM,WAAW,IAAI,aAAa,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,CAAA;YAE3C,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,SAAQ;YACV,CAAC;YAED,IAAI,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACxB,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;gBAExF,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,0BAA0B,WAAW,EAAE,CAAC,CAAA;gBACpF,QAAQ,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAA;YAClC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,uBAAuB,EAAE,CAAA;IAC9C,MAAM,UAAU,GAAG,IAAI,kBAAkB,EAAE,CAAA;IAE3C,KAAK,MAAM,WAAW,IAAI,QAAQ,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;QACrC,MAAM,UAAU,GAAgB,EAAE,IAAI,EAAE,aAAa,GAAG,WAAW,EAAE,CAAA;QACrE,MAAM,eAAe,GAAgC,EAAE,CAAA;QAEvD,KAAK,MAAM,aAAa,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;YACnD,MAAM,iBAAiB,GAAkB,EAAE,CAAA;YAE3C,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,QAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;gBAEzB,MAAM,OAAO,GAAG,IAAI,mBAAmB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;gBAE7D,OAAO,CAAC,kBAAkB;gBACxB,sEAAsE;gBACtE,OAA8B,EAC9B,OAAO,CAAC,UAAW,CAAC,OAAQ,CAC7B,CAAA;gBAED,yBAAyB;gBACzB,OAAO,CAAC,UAAW,CAAC,QAAS,CAAC,IAAI,CAAC,GAAG;oBACpC,IAAI,EAAE,IAAI;oBACV,WAAW,EAAE,kBAAkB;oBAC/B,OAAO,EAAE,EAAE,IAAI,EAAE,wBAAwB,IAAI,EAAE,EAAE;iBAClD,CAAA;gBAED,iBAAiB,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,WAAW,aAAa,IAAI,EAAE,EAAE,CAAC,CAAA;gBAC9E,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,wBAAwB,GAAG,IAAI,EAAE,CAAA;YACnE,CAAC;YAED,OAAO,CAAC,UAAW,CAAC,aAAa,CAAC,GAAG;gBACnC,OAAO,EAAE,UAAU;gBACnB,MAAM,EAAE,SAAS,CAAC,MAAM;gBACxB,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,UAAU,EAAE,SAAS,CAAC,UAAU;gBAChC,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,YAAY,EAAE,SAAS,CAAC,YAAY;gBACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,MAAM,EAAE,SAAS,CAAC,MAAM;gBACxB,QAAQ,EAAE,iBAAiB;aAC5B,CAAA;QACH,CAAC;QAED,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG;YAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,eAAe;SAC1B,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC"}

package/dist/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './async-api-definition.types.js';
+export * from './async-api.types.js';
+export * from './create-channel.js';
+export * from './generate-async-api-html.js';
+export * from './generate-async-api-yaml.js';

package/dist/lib/index.js

@@ -0,0 +1,6 @@
+export * from './async-api-definition.types.js';
+export * from './async-api.types.js';
+export * from './create-channel.js';
+export * from './generate-async-api-html.js';
+export * from './generate-async-api-yaml.js';
+//# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAA;AAC/C,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,8BAA8B,CAAA"}

package/eslint.config.js

@@ -0,0 +1,17 @@
+import eslintNestJSConfig from '@wisemen/eslint-config-nestjs'
+
+export default [
+  ...eslintNestJSConfig,
+  {
+    rules: {
+      'import-typescript/no-relative-parent-imports': 'off'
+    }
+  },
+  {
+    files: ['**/*.test.ts'],
+    rules: {
+      '@typescript-eslint/unbound-method': 'off',
+      '@typescript-eslint/no-floating-promises': 'off'
+    }
+  }
+]

package/lib/async-api-definition.types.ts

@@ -0,0 +1,29 @@
+import { AsyncAPIInfo, AsyncAPIOperation, AsyncAPIParameter } from './async-api.types.js'
+
+type ExtractParams<T>
+  = T extends `{${infer Param}}.${infer Rest}`
+    ? { [K in Param]: string } & ExtractParams<Rest>
+    : T extends `${infer _Start}.{${infer Param}}${infer Rest}`
+      ? { [K in Param]: string } & ExtractParams<Rest>
+      : object
+
+export type AsyncAPIChannelParameters<Address> = {
+  [Param in keyof ExtractParams<Address>]: AsyncAPIParameter
+}
+
+export type AsyncAPIOperationDefinition
+  = Omit<AsyncAPIOperation, 'messages' | 'channel' | 'reply'>
+    & { messages?: { name: string, constructor: () => unknown }[] }
+
+export type AsyncAPIChannelDefinition<Address extends string> = {
+  address: Address
+  parameters: AsyncAPIChannelParameters<Address>
+  operations?: Record<string, AsyncAPIOperationDefinition>
+}
+
+export type AsyncAPIDefinition = {
+  asyncapi: string
+  defaultContentType: string
+  info: AsyncAPIInfo
+  channels: string
+}

package/lib/async-api.types.ts

@@ -0,0 +1,174 @@
+// AsyncAPI v3.0.0 Document Format as TypeScript Types
+// Reference: https://www.asyncapi.com/docs/reference/specification/v3.0.0
+
+export type AsyncApiRef = {
+  $ref: string
+}
+
+export type AsyncAPIDocument = {
+  asyncapi: string
+  id?: string
+  info: AsyncAPIInfo
+  servers?: Record<string, AsyncAPIServer>
+  defaultContentType?: string
+  channels: Record<string, AsyncAPIChannel>
+  operations?: Record<string, AsyncAPIOperation>
+  components?: AsyncAPIComponents
+  tags?: AsyncAPITag[]
+  externalDocs?: AsyncAPIExternalDocs
+}
+
+export type AsyncAPIInfo = {
+  title: string
+  version: string
+  description?: string
+  termsOfService?: string
+  contact?: AsyncAPIContact
+  license?: AsyncAPILicense
+}
+
+export type AsyncAPIContact = {
+  name?: string
+  url?: string
+  email?: string
+}
+
+export type AsyncAPILicense = {
+  name: string
+  url?: string
+}
+
+export type AsyncAPIServer = {
+  host: string
+  protocol: string
+  protocolVersion?: string
+  description?: string
+  tags?: AsyncAPITag[]
+  security?: AsyncAPISecurityRequirement[]
+  variables?: Record<string, AsyncAPIServerVariable>
+  bindings?: AsyncAPIServerBindings
+}
+
+export type AsyncAPIServerVariable = {
+  description?: string
+  default: string
+  examples?: string[]
+  enum?: string[]
+}
+
+export type AsyncAPISecurityRequirement = Record<string, string[]>
+
+export type AsyncAPIServerBindings = Record<string, unknown>
+
+export type AsyncAPIChannel = {
+  address: string
+  description?: string
+  parameters?: Record<string, AsyncAPIParameter>
+  messages?: Record<string, AsyncApiRef>
+  subscribe?: string // Operation ID
+  publish?: string // Operation ID
+  bindings?: AsyncAPIChannelBindings
+}
+
+export type AsyncAPIChannelBindings = Record<string, unknown>
+
+export type AsyncAPIParameter = {
+  enum?: string[]
+  default?: string
+  description?: string
+  examples?: string[]
+  location?: string
+}
+
+export type AsyncAPIOperation = {
+  action: 'send' | 'receive'
+  channel: AsyncApiRef
+  title?: string
+  summary?: string
+  description?: string
+  tags?: AsyncAPITag[]
+  externalDocs?: AsyncAPIExternalDocs
+  bindings?: AsyncAPIOperationBindings
+  traits?: (string | AsyncAPIOperationTrait)[]
+  messages?: AsyncApiRef[]
+  security?: AsyncAPISecurityRequirement[]
+  deprecated?: boolean
+  reply?: AsyncAPIOperationReply
+}
+
+export type AsyncAPIOperationReply = {
+  address?: AsyncAPIOperationReplyAddress
+  channel?: AsyncApiRef
+  messages?: AsyncApiRef
+}
+
+export type AsyncAPIOperationReplyAddress = {
+  location: string
+  description?: string
+}
+
+export type AsyncAPIOperationTrait = Record<string, unknown>
+export type AsyncAPIOperationBindings = Record<string, unknown>
+
+export type AsyncAPIMessage = {
+  name?: string
+  title?: string
+  summary?: string
+  description?: string
+  headers?: AsyncAPISchema
+  payload?: AsyncApiRef
+  correlationId?: AsyncAPICorrelationId
+  schemaFormat?: string
+  contentType?: string
+  tags?: AsyncAPITag[]
+  externalDocs?: AsyncAPIExternalDocs
+  bindings?: AsyncAPIMessageBindings
+  examples?: unknown[]
+  traits?: (string | AsyncAPIMessageTrait)[]
+}
+
+export type AsyncAPIMessageTrait = Record<string, unknown>
+export type AsyncAPIMessageBindings = Record<string, unknown>
+
+export type AsyncAPICorrelationId = {
+  description?: string
+  location: string
+}
+
+export type AsyncAPISchema = Record<string, unknown>
+
+export type AsyncAPIComponents = {
+  schemas?: Record<string, AsyncAPISchema>
+  messages?: Record<string, AsyncAPIMessage>
+  securitySchemes?: Record<string, AsyncAPISecurityScheme>
+  parameters?: Record<string, AsyncAPIParameter>
+  correlationIds?: Record<string, AsyncAPICorrelationId>
+  operationTraits?: Record<string, AsyncAPIOperationTrait>
+  messageTraits?: Record<string, AsyncAPIMessageTrait>
+  serverBindings?: Record<string, AsyncAPIServerBindings>
+  channelBindings?: Record<string, AsyncAPIChannelBindings>
+  operationBindings?: Record<string, AsyncAPIOperationBindings>
+  messageBindings?: Record<string, AsyncAPIMessageBindings>
+}
+
+export type AsyncAPISecurityScheme = {
+  type: string
+  description?: string
+  name?: string
+  in?: string
+  scheme?: string
+  bearerFormat?: string
+  flows?: unknown
+  openIdConnectUrl?: string
+}
+
+export type AsyncAPITag = {
+  name: string
+  description?: string
+  externalDocs?: AsyncAPIExternalDocs
+}
+
+export type AsyncAPIExternalDocs = {
+  description?: string
+  url: string
+}

package/lib/create-channel.ts

@@ -0,0 +1,21 @@
+import { AsyncAPIChannelDefinition } from './async-api-definition.types.js'
+
+const CHANNEL_METADATA_KEY = 'async-api:channel'
+
+export type ChannelConfig<Address extends string>
+  = Omit<AsyncAPIChannelDefinition<Address>, 'address'>
+
+export function isChannel (value: object): value is AsyncAPIChannelDefinition<string> {
+  return Reflect.hasMetadata(CHANNEL_METADATA_KEY, value)
+}
+
+export function createChannel<Address extends string> (
+  address: Address,
+  config: ChannelConfig<Address>
+): AsyncAPIChannelDefinition<Address> {
+  const channel = { address, ...config }
+
+  Reflect.defineMetadata(CHANNEL_METADATA_KEY, true, channel)
+
+  return channel
+}

package/lib/generate-async-api-html.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+import Generator from '@asyncapi/generator'
+
+export async function generateAsyncAPIHTML (
+  yaml: string,
+  outputPath: string,
+  fileName: string
+): Promise<void> {
+  const generator = new Generator(
+    '@asyncapi/html-template',
+    outputPath,
+    {
+      forceWrite: true,
+      templateParams: {
+        singleFile: true,
+        outFilename: fileName
+      }
+    }
+  )
+
+  await generator.generateFromString(yaml, 'yaml')
+}

package/lib/generate-async-api-yaml.ts

@@ -0,0 +1,102 @@
+import { globSync } from 'fs'
+import assert from 'assert'
+import YAML from 'yaml'
+import { SchemaObjectFactory } from '@nestjs/swagger/dist/services/schema-object-factory.js'
+import { ModelPropertiesAccessor } from '@nestjs/swagger/dist/services/model-properties-accessor.js'
+import { SwaggerTypesMapper } from '@nestjs/swagger/dist/services/swagger-types-mapper.js'
+import { pascalCase } from 'change-case'
+import { AsyncAPIDocument, AsyncApiRef } from './async-api.types.js'
+import { AsyncAPIChannelDefinition, AsyncAPIDefinition } from './async-api-definition.types.js'
+import { isChannel } from './create-channel.js'
+
+export async function generateAsyncApiYaml (api: AsyncAPIDefinition): Promise<string> {
+  const apiDocs: AsyncAPIDocument = {
+    asyncapi: api.asyncapi,
+    info: api.info,
+    defaultContentType: api.defaultContentType,
+    channels: {},
+    operations: {},
+    components: { messages: {}, schemas: {} }
+  }
+
+  const channelFiles = globSync(api.channels)
+  const channels: Record<string, AsyncAPIChannelDefinition<string>> = {}
+
+  for (const channelFile of channelFiles) {
+    const moduleExports = await import('../../../../' + channelFile) as Record<string, object>
+
+    for (const exportedKey in moduleExports) {
+      const exported = moduleExports[exportedKey]
+
+      if (typeof exported !== 'object') {
+        continue
+      }
+
+      if (isChannel(exported)) {
+        const channelName = pascalCase(exportedKey.substring(0, exportedKey.indexOf('Channel')))
+
+        assert(channels[channelName] === undefined, `duplicate channel name ${channelName}`)
+        channels[channelName] = exported
+      }
+    }
+  }
+
+  const accessor = new ModelPropertiesAccessor()
+  const typeMapper = new SwaggerTypesMapper()
+
+  for (const channelName in channels) {
+    const channel = channels[channelName]
+    const channelRef: AsyncApiRef = { $ref: '#/channels/' + channelName }
+    const channelMessages: Record<string, AsyncApiRef> = {}
+
+    for (const operationName in channel.operations) {
+      const operation = channel.operations[operationName]
+      const operationMessages: AsyncApiRef[] = []
+
+      for (const message of operation.messages!) {
+        const name = message.name
+
+        const factory = new SchemaObjectFactory(accessor, typeMapper)
+
+        factory.exploreModelSchema(
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+          message as unknown as Function,
+          apiDocs.components!.schemas!
+        )
+
+        // Add the message itself
+        apiDocs.components!.messages![name] = {
+          name: name,
+          contentType: 'application/json',
+          payload: { $ref: `#/components/schemas/${name}` }
+        }
+
+        operationMessages.push({ $ref: `#/channels/${channelName}/messages/${name}` })
+        channelMessages[name] = { $ref: '#/components/messages/' + name }
+      }
+
+      apiDocs.operations![operationName] = {
+        channel: channelRef,
+        action: operation.action,
+        bindings: operation.bindings,
+        deprecated: operation.deprecated,
+        description: operation.description,
+        externalDocs: operation.externalDocs,
+        security: operation.security,
+        summary: operation.summary,
+        title: operation.title,
+        tags: operation.tags,
+        traits: operation.traits,
+        messages: operationMessages
+      }
+    }
+
+    apiDocs.channels[channelName] = {
+      address: channel.address,
+      parameters: channel.parameters,
+      messages: channelMessages
+    }
+  }
+
+  return YAML.stringify(apiDocs)
+}

package/lib/index.ts

@@ -0,0 +1,5 @@
+export * from './async-api-definition.types.js'
+export * from './async-api.types.js'
+export * from './create-channel.js'
+export * from './generate-async-api-html.js'
+export * from './generate-async-api-yaml.js'

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@wisemen/nestjs-async-api",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "imports": {
+    "#*": "./lib/*"
+  },
+  "scripts": {
+    "prebuild": "rm -rf ./dist",
+    "clean": "rm -rf ./dist",
+    "build": "tsc",
+    "pretest": "npm run clean && npm run build",
+    "test": "node --env-file=.env.test --test ./**/*.test.js",
+    "lint": "eslint --cache",
+    "prerelease": "npm run build",
+    "release": "pnpx release-it"
+  },
+  "dependencies": {
+    "change-case": "^5.4.4",
+    "@asyncapi/generator": "3.1.2",
+    "yaml": "2.8.2",
+    "@nestjs/swagger": "11.2.6"
+  },
+  "devDependencies": {
+    "@wisemen/eslint-config-nestjs": "^0.2.8",
+    "eslint": "9.39.2",
+    "typescript": "^5.9.3"
+  },
+  "author": "Kobe Kwanten",
+  "license": "GPL",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:wisemen-digital/node-core.git"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "declaration": true,
+    "target": "esnext",
+    "module": "NodeNext",
+    "types": [
+      "node",
+    ],
+    "rootDir": "./",
+    "moduleResolution": "nodenext",
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "resolveJsonModule": true,
+    "strictNullChecks": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "./index.ts",
+    "./lib/**/*.ts"
+  ],
+  "exclude": [
+    "./lib/test-utils.ts",
+    "./lib/**/*.spec.ts"
+  ],
+  "ts-node": {
+    "transpileOnly": true
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "./index.ts",
+      "./lib"
+    ],
+    "entryPointStrategy": "expand",
+    "out": "../../documentation/client"
+  }
+}
+