@eventcatalog/generator-asyncapi 0.0.2 → 0.0.3

package/README.md

@@ -4,7 +4,7 @@
 
 [![PRs Welcome][prs-badge]][prs]
 <img src="https://img.shields.io/github/actions/workflow/status/event-catalog/generator-asyncapi/verify-build.yml"/>
-[![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" height="20px" />](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub)
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" height="20px" />](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub) [![blog](https://img.shields.io/badge/license-Dual--License-brightgreen)](https://github.com/event-catalog/generator-asyncapi/blob/main/LICENSE.md)
 
 <img alt="header" src="./images/asyncapi.jpeg" />
 
@@ -129,4 +129,4 @@ You can find the [contributing guidelines here](https://eventcatalog.dev/docs/co
 
 # Commercial Use
 
-This project is governed by the [AGPL-3.0](/LICENSE.md) copyleft license. To ensure the sustainability of the project, you can freely make use of this software as long the outcome is distributed under the same license. Otherwise, you must obtain a [commercial license](./LICENSE-COMMERCIAL.md) that removes such restrictions.
+This project is governed by a [dual-license](./LICENSE.md). To ensure the sustainability of the project, you can freely make use of this software if your projects are Open Source. Otherwise for proprietary systems you must obtain a [commercial license](./LICENSE-COMMERCIAL.md).

package/dist/checkLicense.d.mts

@@ -0,0 +1,3 @@
+declare const _default: () => void;
+
+export { _default as default };

package/dist/checkLicense.d.ts

@@ -0,0 +1,3 @@
+declare const _default: () => void;
+
+export { _default as default };

package/dist/checkLicense.js

@@ -0,0 +1,47 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/checkLicense.ts
+var checkLicense_exports = {};
+__export(checkLicense_exports, {
+  default: () => checkLicense_default
+});
+module.exports = __toCommonJS(checkLicense_exports);
+var import_chalk = __toESM(require("chalk"));
+var checkLicense_default = () => {
+  console.log(import_chalk.default.bgBlue(`
+You are using the open source license for this plugin`));
+  console.log(
+    import_chalk.default.blueBright(
+      `This plugin is governed and published under a dual-license. 
+If using for internal, commercial or proprietary software, please contact hello@eventcatalog.dev for a license to support the project.`
+    )
+  );
+};
+//# sourceMappingURL=checkLicense.js.map

package/dist/checkLicense.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/checkLicense.ts"],"sourcesContent":["import chalk from 'chalk';\n\nexport default () => {\n  console.log(chalk.bgBlue(`\\nYou are using the open source license for this plugin`));\n  console.log(\n    chalk.blueBright(\n      `This plugin is governed and published under a dual-license. \\nIf using for internal, commercial or proprietary software, please contact hello@eventcatalog.dev for a license to support the project.`\n    )\n  );\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAElB,IAAO,uBAAQ,MAAM;AACnB,UAAQ,IAAI,aAAAA,QAAM,OAAO;AAAA,sDAAyD,CAAC;AACnF,UAAQ;AAAA,IACN,aAAAA,QAAM;AAAA,MACJ;AAAA;AAAA,IACF;AAAA,EACF;AACF;","names":["chalk"]}

package/dist/checkLicense.mjs

@@ -0,0 +1,16 @@
+// src/checkLicense.ts
+import chalk from "chalk";
+var checkLicense_default = () => {
+  console.log(chalk.bgBlue(`
+You are using the open source license for this plugin`));
+  console.log(
+    chalk.blueBright(
+      `This plugin is governed and published under a dual-license. 
+If using for internal, commercial or proprietary software, please contact hello@eventcatalog.dev for a license to support the project.`
+    )
+  );
+};
+export {
+  checkLicense_default as default
+};
+//# sourceMappingURL=checkLicense.mjs.map

package/dist/checkLicense.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/checkLicense.ts"],"sourcesContent":["import chalk from 'chalk';\n\nexport default () => {\n  console.log(chalk.bgBlue(`\\nYou are using the open source license for this plugin`));\n  console.log(\n    chalk.blueBright(\n      `This plugin is governed and published under a dual-license. \\nIf using for internal, commercial or proprietary software, please contact hello@eventcatalog.dev for a license to support the project.`\n    )\n  );\n};\n"],"mappings":";AAAA,OAAO,WAAW;AAElB,IAAO,uBAAQ,MAAM;AACnB,UAAQ,IAAI,MAAM,OAAO;AAAA,sDAAyD,CAAC;AACnF,UAAQ;AAAA,IACN,MAAM;AAAA,MACJ;AAAA;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/dist/index.d.mts

@@ -1,13 +1,25 @@
+import { OpenAPIV3_1 } from 'openapi-types';
+
+type Props = {
+    path: string | string[];
+    domain?: Domain;
+    debug?: boolean;
+};
 type Domain = {
     id: string;
     name: string;
     version: string;
 };
-type Props = {
-    path: string | string[];
-    domain?: Domain;
-    debug?: boolean;
+type Operation = {
+    path: string;
+    method: string;
+    operationId: string;
+    summary?: string;
+    description?: string;
+    type: string;
+    externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;
+    tags: string[];
 };
 declare const _default: (config: any, options: Props) => Promise<void>;
 
-export { _default as default };
+export { type Operation, _default as default };

package/dist/index.d.ts

@@ -1,13 +1,25 @@
+import { OpenAPIV3_1 } from 'openapi-types';
+
+type Props = {
+    path: string | string[];
+    domain?: Domain;
+    debug?: boolean;
+};
 type Domain = {
     id: string;
     name: string;
     version: string;
 };
-type Props = {
-    path: string | string[];
-    domain?: Domain;
-    debug?: boolean;
+type Operation = {
+    path: string;
+    method: string;
+    operationId: string;
+    summary?: string;
+    description?: string;
+    type: string;
+    externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;
+    tags: string[];
 };
 declare const _default: (config: any, options: Props) => Promise<void>;
 
-export { _default as default };
+export { type Operation, _default as default };

package/dist/index.js

@@ -33,260 +33,253 @@ __export(src_exports, {
   default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
-var import_parser = require("@asyncapi/parser");
-var import_promises = require("fs/promises");
 var import_sdk = __toESM(require("@eventcatalog/sdk"));
+var import_promises = require("fs/promises");
+var import_chalk2 = __toESM(require("chalk"));
+var import_swagger_parser = __toESM(require("@apidevtools/swagger-parser"));
 var import_slugify = __toESM(require("slugify"));
 
-// src/utils/schemas.ts
-var getFileExtentionFromSchemaFormat = (format = "") => {
-  if (format.includes("avro")) return "avsc";
-  if (format.includes("yml")) return "yml";
-  if (format.includes("json")) return "json";
-  if (format.includes("openapi")) return "openapi";
-  if (format.includes("protobuf")) return "protobuf";
-  if (format.includes("yaml")) return "yaml";
-  return "json";
-};
-
-// src/utils/messages.ts
-var defaultMarkdown = (document, message) => {
+// src/utils/domains.ts
+var defaultMarkdown = () => {
   return `
-## Architecture
-<NodeGraph />
-
-${messageHasSchema(message) ? `
-## Schema
-<SchemaViewer file="${getSchemaFileName(message)}" title="Message Schema" maxHeight="500" />
-` : ""}
 
-${message.externalDocs() ? `
-## External documentation
-- [${message.externalDocs()?.description()}](${message.externalDocs()?.url()})
-` : ""}
+## Architecture diagram
+<NodeGraph />
 
 `;
 };
-var getSummary = (message) => {
-  const messageSummary = message.hasSummary() ? message.summary() : "";
-  const messageDescription = message.hasDescription() ? message.description() : "";
-  let eventCatalogMessageSummary = messageSummary;
-  if (!eventCatalogMessageSummary) {
-    eventCatalogMessageSummary = messageDescription && messageDescription.length < 150 ? messageDescription : "";
-  }
-  return eventCatalogMessageSummary;
-};
-var messageHasSchema = (message) => {
-  return message.hasPayload() && message.schemaFormat();
-};
-var getSchemaFileName = (message) => {
-  const extension = getFileExtentionFromSchemaFormat(message.schemaFormat());
-  return `schema.${extension}`;
-};
-var getMessageName = (message) => {
-  return message.hasTitle() && message.title() ? message.title() : message.id();
-};
 
 // src/utils/services.ts
 var defaultMarkdown2 = (document) => {
   return `
 
-${document.info().hasDescription() ? `${document.info().description()}` : ""}  
+${document.info.description ? `${document.info.description}` : ""}  
 
 ## Architecture diagram
 <NodeGraph />
 
-${document.info().externalDocs() ? `
+${document.externalDocs ? `
 ## External documentation
-- [${document.info().externalDocs()?.description()}](${document.info().externalDocs()?.url()})
+- [${document.externalDocs.description}](${document.externalDocs.url})
 ` : ""}
 `;
 };
-var getSummary2 = (document) => {
-  const summary = document.info().hasDescription() ? document.info().description() : "";
+var getSummary = (document) => {
+  const summary = document.info.description ? document.info.description : "";
   return summary && summary.length < 150 ? summary : "";
 };
 
-// src/utils/domains.ts
-var defaultMarkdown3 = (document) => {
+// src/utils/messages.ts
+var defaultMarkdown3 = (message) => {
   return `
-
-## Architecture diagram
+## Architecture
 <NodeGraph />
 
+${message.externalDocs ? `
+## External documentation
+- [${message.externalDocs.description}](${message.externalDocs.url})
+` : ""}
+
 `;
 };
+var getSummary2 = (message) => {
+  const messageSummary = message.summary ? message.summary : "";
+  const messageDescription = message.description ? message.description : "";
+  let eventCatalogMessageSummary = messageSummary;
+  if (!eventCatalogMessageSummary) {
+    eventCatalogMessageSummary = messageDescription && messageDescription.length < 150 ? messageDescription : "";
+  }
+  return eventCatalogMessageSummary;
+};
+var getMessageName = (message) => {
+  return message.operationId;
+};
 
-// src/index.ts
+// src/checkLicense.ts
 var import_chalk = __toESM(require("chalk"));
-var parser = new import_parser.Parser();
+var checkLicense_default = () => {
+  console.log(import_chalk.default.bgBlue(`
+You are using the open source license for this plugin`));
+  console.log(
+    import_chalk.default.blueBright(
+      `This plugin is governed and published under a dual-license. 
+If using for internal, commercial or proprietary software, please contact hello@eventcatalog.dev for a license to support the project.`
+    )
+  );
+};
+
+// src/index.ts
+var DEFAULT_MESSAGE_TYPE = "query";
+async function getOperationsByType(openApiPath) {
+  try {
+    const api = await import_swagger_parser.default.validate(openApiPath);
+    const operations = [];
+    for (const path in api.paths) {
+      const pathItem = api.paths[path];
+      for (const method in pathItem) {
+        const openAPIOperation = pathItem[method];
+        const messageType = openAPIOperation["x-eventcatalog-message-type"] || DEFAULT_MESSAGE_TYPE;
+        const operation = {
+          path,
+          method: method.toUpperCase(),
+          operationId: openAPIOperation.operationId,
+          externalDocs: openAPIOperation.externalDocs,
+          type: messageType,
+          description: openAPIOperation.description,
+          summary: openAPIOperation.summary,
+          tags: openAPIOperation.tags || []
+        };
+        operations.push(operation);
+      }
+    }
+    return operations;
+  } catch (err) {
+    console.error("Error parsing OpenAPI document:", err);
+    return [];
+  }
+}
 var src_default = async (config, options) => {
   if (!process.env.PROJECT_DIR) {
     throw new Error("Please provide catalog url (env variable PROJECT_DIR)");
   }
   const {
-    writeService,
     writeEvent,
-    writeCommand,
-    getService,
-    versionService,
-    rmService,
     getDomain,
+    versionDomain,
     writeDomain,
     addServiceToDomain,
-    getCommand,
+    getService,
+    versionService,
+    rmService,
+    writeService,
+    addFileToService,
+    versionCommand,
     getEvent,
-    rmEventById,
+    getCommand,
     rmCommandById,
-    versionCommand,
-    versionEvent,
-    addSchemaToCommand,
-    addSchemaToEvent,
-    addFileToService,
-    versionDomain
+    rmEventById,
+    writeCommand
   } = (0, import_sdk.default)(process.env.PROJECT_DIR);
-  const asyncAPIFiles = Array.isArray(options.path) ? options.path : [options.path];
-  console.log(import_chalk.default.green(`Processing ${asyncAPIFiles.length} AsyncAPI files...`));
-  for (const path of asyncAPIFiles) {
-    console.log(import_chalk.default.gray(`Processing ${path}`));
-    const asyncAPIFile = await (0, import_promises.readFile)(path, "utf-8");
-    const { document } = await parser.parse(asyncAPIFile);
-    if (!document) {
-      console.log(import_chalk.default.red("Failed to parse AsyncAPI file"));
-      if (options.debug) {
-        const diagnostics = await parser.validate(asyncAPIFile);
-        console.log(diagnostics);
-      } else {
-        console.log(import_chalk.default.red("Run with debug option in the generator to see diagnostics"));
-      }
+  const openAPIFiles = Array.isArray(options.path) ? options.path : [options.path];
+  for (const path of openAPIFiles) {
+    console.log(import_chalk2.default.green(`Processing ${path}`));
+    try {
+      await import_swagger_parser.default.validate(path);
+    } catch (error) {
+      console.error(import_chalk2.default.red(`Failed to parse OpenAPI file: ${path}`));
+      console.error(import_chalk2.default.red(error));
       continue;
     }
-    const operations = document.allOperations();
-    const documentTags = document.info().tags().all() || [];
-    const serviceId = (0, import_slugify.default)(document.info().title(), { lower: true, strict: true });
-    const version = document.info().version();
-    const sends = [];
-    const receives = [];
+    const openAPIFile = await (0, import_promises.readFile)(path, "utf-8");
+    const document = await import_swagger_parser.default.parse(path);
+    const operations = await getOperationsByType(path);
+    const serviceId = (0, import_slugify.default)(document.info.title, { lower: true, strict: true });
+    const version = document.info.version;
     let serviceMarkdown = defaultMarkdown2(document);
     if (options.domain) {
       const { id: domainId, name: domainName, version: domainVersion } = options.domain;
       const domain = await getDomain(options.domain.id, domainVersion || "latest");
       const currentDomain = await getDomain(options.domain.id, "latest");
-      console.log(import_chalk.default.blue(`
+      console.log(import_chalk2.default.blue(`
 Processing domain: ${domainName} (v${domainVersion})`));
       if (currentDomain && currentDomain.version !== domainVersion) {
         await versionDomain(domainId);
-        console.log(import_chalk.default.cyan(` - Versioned previous domain (v${currentDomain.version})`));
+        console.log(import_chalk2.default.cyan(` - Versioned previous domain (v${currentDomain.version})`));
       }
       if (!domain || domain && domain.version !== domainVersion) {
         await writeDomain({
           id: domainId,
           name: domainName,
           version: domainVersion,
-          markdown: defaultMarkdown3(document)
-          // services: [{ id: serviceId, version: version }],
+          markdown: defaultMarkdown()
         });
-        console.log(import_chalk.default.cyan(` - Domain (v${domainVersion}) created`));
+        console.log(import_chalk2.default.cyan(` - Domain (v${domainVersion}) created`));
       }
       if (currentDomain && currentDomain.version === domainVersion) {
-        console.log(import_chalk.default.yellow(` - Domain (v${domainVersion}) already exists, skipped creation...`));
+        console.log(import_chalk2.default.yellow(` - Domain (v${domainVersion}) already exists, skipped creation...`));
       }
       await addServiceToDomain(domainId, { id: serviceId, version }, domainVersion);
     }
+    const documentTags = document.tags || [];
+    let sends = [];
+    const receives = [];
     for (const operation of operations) {
-      for (const message of operation.messages()) {
-        const eventType = message.extensions().get("x-eventcatalog-message-type")?.value() || "event";
-        const messageId = message.id().toLowerCase();
-        let messageMarkdown = defaultMarkdown(document, message);
-        const writeMessage = eventType === "event" ? writeEvent : writeCommand;
-        const versionMessage = eventType === "event" ? versionEvent : versionCommand;
-        const getMessage = eventType === "event" ? getEvent : getCommand;
-        const rmMessageById = eventType === "event" ? rmEventById : rmCommandById;
-        const addSchemaToMessage = eventType === "event" ? addSchemaToEvent : addSchemaToCommand;
-        const badges = message.tags().all() || [];
-        const catalogedMessage = await getMessage(message.id().toLowerCase(), "latest");
-        console.log(import_chalk.default.blue(`Processing message: ${getMessageName(message)} (v${version})`));
-        if (catalogedMessage) {
-          messageMarkdown = catalogedMessage.markdown;
-          if (catalogedMessage.version === version) {
-            await rmMessageById(messageId, version);
-          } else {
-            await versionMessage(messageId);
-            console.log(import_chalk.default.cyan(` - Versioned previous message: (v${catalogedMessage.version})`));
-          }
-        }
-        await writeMessage(
-          {
-            id: messageId,
-            version,
-            name: getMessageName(message),
-            summary: getSummary(message),
-            markdown: messageMarkdown,
-            badges: badges.map((badge) => ({ content: badge.name(), textColor: "blue", backgroundColor: "blue" })),
-            schemaPath: messageHasSchema(message) ? getSchemaFileName(message) : void 0
-          },
-          {
-            path: message.id()
-          }
-        );
-        console.log(import_chalk.default.cyan(` - Message (v${version}) created`));
-        if (messageHasSchema(message)) {
-          addSchemaToMessage(
-            messageId,
-            {
-              fileName: getSchemaFileName(message),
-              schema: JSON.stringify(message.payload()?.json(), null, 4)
-            },
-            version
-          );
-          console.log(import_chalk.default.cyan(` - Schema added to message (v${version})`));
-        }
-        if (operation.action() === "send" || operation.action() === "publish") {
-          sends.push({ id: messageId, version });
-        }
-        if (operation.action() === "receive" || operation.action() === "subscribe") {
-          receives.push({ id: messageId, version });
+      const messageType = operation.type;
+      const messageId = getMessageName(operation);
+      let messageMarkdown = defaultMarkdown3(operation);
+      const versionMessage = versionCommand;
+      const getMessage = messageType === "event" ? getEvent : getCommand;
+      const rmMessageById = messageType === "event" ? rmEventById : rmCommandById;
+      const writeMessage = messageType === "event" ? writeEvent : writeCommand;
+      const catalogedMessage = await getMessage(messageId, "latest");
+      console.log(import_chalk2.default.blue(`Processing message: ${getMessageName(operation)} (v${version})`));
+      if (catalogedMessage) {
+        messageMarkdown = catalogedMessage.markdown;
+        if (catalogedMessage.version === version) {
+          await rmMessageById(messageId, version);
+        } else {
+          await versionMessage(messageId);
+          console.log(import_chalk2.default.cyan(` - Versioned previous message: (v${catalogedMessage.version})`));
         }
       }
+      await writeMessage(
+        {
+          id: messageId,
+          version,
+          name: getMessageName(operation),
+          summary: getSummary2(operation),
+          markdown: messageMarkdown,
+          badges: operation.tags.map((badge) => ({ content: badge, textColor: "blue", backgroundColor: "blue" }))
+        },
+        {
+          path: messageId
+        }
+      );
+      receives.push({
+        id: operation.operationId,
+        version
+      });
+      console.log(import_chalk2.default.cyan(` - Message (v${version}) created`));
     }
     const latestServiceInCatalog = await getService(serviceId, "latest");
-    console.log(import_chalk.default.blue(`Processing service: ${document.info().title()} (v${version})`));
+    console.log(import_chalk2.default.blue(`Processing service: ${document.info.title} (v${version})`));
     if (latestServiceInCatalog) {
       serviceMarkdown = latestServiceInCatalog.markdown;
+      sends = latestServiceInCatalog.sends || [];
       if (latestServiceInCatalog.version !== version) {
         await versionService(serviceId);
-        console.log(import_chalk.default.cyan(` - Versioned previous service (v${latestServiceInCatalog.version})`));
+        console.log(import_chalk2.default.cyan(` - Versioned previous service (v${latestServiceInCatalog.version})`));
       }
       if (latestServiceInCatalog.version === version) {
-        serviceMarkdown = latestServiceInCatalog.markdown;
-        await rmService(document.info().title());
+        await rmService(document.info.title);
       }
     }
     await writeService(
       {
         id: serviceId,
-        name: document.info().title(),
+        name: document.info.title,
         version,
-        summary: getSummary2(document),
-        badges: documentTags.map((tag) => ({ content: tag.name(), textColor: "blue", backgroundColor: "blue" })),
+        summary: getSummary(document),
+        badges: documentTags.map((tag) => ({ content: tag.name, textColor: "blue", backgroundColor: "blue" })),
         markdown: serviceMarkdown,
         sends,
-        schemaPath: path.split("/").pop() || "asyncapi.yml",
+        schemaPath: path.split("/").pop() || "openapi.yml",
         receives
       },
-      { path: document.info().title() }
+      { path: document.info.title }
     );
     await addFileToService(
       serviceId,
       {
-        fileName: path.split("/").pop() || "asyncapi.yml",
-        content: asyncAPIFile
+        fileName: path.split("/").pop() || "openapi.yml",
+        content: openAPIFile
       },
       version
     );
-    console.log(import_chalk.default.cyan(` - Service (v${version}) created`));
-    console.log(import_chalk.default.green(`
-Finished generating event catalog for AsyncAPI ${document.info().title()} (v${version})`));
+    console.log(import_chalk2.default.cyan(` - Service (v${version}) created`));
+    console.log(import_chalk2.default.green(`
+Finished generating event catalog for AsyncAPI ${document.info.title} (v${version})`));
   }
+  await checkLicense_default();
 };
 //# sourceMappingURL=index.js.map