@eventcatalog/generator-openapi 7.1.1 → 7.2.1

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Service, Domain } from './types.mjs';
+import { Service, Message, Domain } from './types.mjs';
 import 'openapi-types';
 
 type MESSAGE_TYPE = 'command' | 'query' | 'event';
@@ -6,6 +6,7 @@ type HTTP_METHOD = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIO
 type HTTP_METHOD_TO_MESSAGE_TYPE = Partial<Record<HTTP_METHOD, MESSAGE_TYPE>>;
 type Props = {
     services: Service[];
+    messages?: Message;
     domain?: Domain;
     debug?: boolean;
     saveParsedSpecFile?: boolean;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Service, Domain } from './types.js';
+import { Service, Message, Domain } from './types.js';
 import 'openapi-types';
 
 type MESSAGE_TYPE = 'command' | 'query' | 'event';
@@ -6,6 +6,7 @@ type HTTP_METHOD = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIO
 type HTTP_METHOD_TO_MESSAGE_TYPE = Partial<Record<HTTP_METHOD, MESSAGE_TYPE>>;
 type Props = {
     services: Service[];
+    messages?: Message;
     domain?: Domain;
     debug?: boolean;
     saveParsedSpecFile?: boolean;

package/dist/index.js

@@ -5872,9 +5872,9 @@ var require_src = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/agent-base@7.1.3/node_modules/agent-base/dist/helpers.js
+// ../../node_modules/.pnpm/agent-base@7.1.4/node_modules/agent-base/dist/helpers.js
 var require_helpers = __commonJS({
-  "../../node_modules/.pnpm/agent-base@7.1.3/node_modules/agent-base/dist/helpers.js"(exports2) {
+  "../../node_modules/.pnpm/agent-base@7.1.4/node_modules/agent-base/dist/helpers.js"(exports2) {
     "use strict";
     var __createBinding = exports2 && exports2.__createBinding || (Object.create ? function(o, m2, k, k2) {
       if (k2 === void 0) k2 = k;
@@ -5942,9 +5942,9 @@ var require_helpers = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/agent-base@7.1.3/node_modules/agent-base/dist/index.js
+// ../../node_modules/.pnpm/agent-base@7.1.4/node_modules/agent-base/dist/index.js
 var require_dist = __commonJS({
-  "../../node_modules/.pnpm/agent-base@7.1.3/node_modules/agent-base/dist/index.js"(exports2) {
+  "../../node_modules/.pnpm/agent-base@7.1.4/node_modules/agent-base/dist/index.js"(exports2) {
     "use strict";
     var __createBinding = exports2 && exports2.__createBinding || (Object.create ? function(o, m2, k, k2) {
       if (k2 === void 0) k2 = k;
@@ -6040,7 +6040,7 @@ var require_dist = __commonJS({
       // In order to properly update the socket pool, we need to call `getName()` on
       // the core `https.Agent` if it is a secureEndpoint.
       getName(options) {
-        const secureEndpoint = typeof options.secureEndpoint === "boolean" ? options.secureEndpoint : this.isSecureEndpoint(options);
+        const secureEndpoint = this.isSecureEndpoint(options);
         if (secureEndpoint) {
           return https_1.Agent.prototype.getName.call(this, options);
         }
@@ -6640,10 +6640,11 @@ var getSummary = (document2) => {
   const summary = document2.info.description ? document2.info.description : "";
   return summary && summary.length < 150 ? summary : "";
 };
-var buildService = (serviceOptions, document2) => {
+var buildService = (serviceOptions, document2, generateMarkdown) => {
   const schemaPath = import_path.default.basename(serviceOptions.path) || "openapi.yml";
   const documentTags = document2.tags || [];
   const serviceId = serviceOptions.id || (0, import_slugify.default)(document2.info.title, { lower: true, strict: true });
+  const generatedMarkdownForService = defaultMarkdown2(document2, schemaPath);
   return {
     id: serviceId,
     version: document2.info.version,
@@ -6653,7 +6654,7 @@ var buildService = (serviceOptions, document2) => {
     specifications: {
       openapiPath: schemaPath
     },
-    markdown: defaultMarkdown2(document2, schemaPath),
+    markdown: generateMarkdown ? generateMarkdown({ service: serviceOptions, document: document2, markdown: generatedMarkdownForService }) : generatedMarkdownForService,
     badges: documentTags.map((tag) => ({ content: tag.name, textColor: "blue", backgroundColor: "blue" })),
     owners: serviceOptions.owners || [],
     setMessageOwnersToServiceOwners: serviceOptions.setMessageOwnersToServiceOwners || true
@@ -6867,7 +6868,7 @@ var getSummary2 = (message) => {
   }
   return eventCatalogMessageSummary;
 };
-var buildMessage = async (pathToFile, document2, operation) => {
+var buildMessage = async (pathToFile, document2, operation, generateMarkdown) => {
   const requestBodiesAndResponses = await getSchemasByOperationId(pathToFile, operation.operationId);
   const extensions = operation.extensions || {};
   const operationTags = operation.tags.map((badge) => ({
@@ -6883,12 +6884,13 @@ var buildMessage = async (pathToFile, document2, operation) => {
     uniqueIdentifier = uniqueIdentifier.concat(`_${path3}`);
   }
   const httpVerb = operation.method.toUpperCase() || "";
+  const generatedMarkdownForMessage = defaultMarkdown3(operation, requestBodiesAndResponses);
   return {
     id: extensions["x-eventcatalog-message-id"] || uniqueIdentifier,
     version: extensions["x-eventcatalog-message-version"] || document2.info.version,
     name: extensions["x-eventcatalog-message-name"] || uniqueIdentifier,
     summary: getSummary2(operation),
-    markdown: defaultMarkdown3(operation, requestBodiesAndResponses),
+    markdown: generateMarkdown ? generateMarkdown({ operation, markdown: generatedMarkdownForMessage }) : generatedMarkdownForMessage,
     schemaPath: requestBodiesAndResponses?.requestBody ? "request-body.json" : "",
     badges,
     requestBodiesAndResponses,
@@ -8293,7 +8295,7 @@ var import_node_path2 = require("path");
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "7.1.1",
+  version: "7.2.1",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -9256,7 +9258,7 @@ var index_default = async (_, options) => {
       const document2 = specification.document;
       const version = document2.info.version;
       const specPath = specification.path;
-      const service = buildService({ ...serviceSpec, path: specPath }, document2);
+      const service = buildService({ ...serviceSpec, path: specPath }, document2, serviceSpec.generateMarkdown);
       let serviceMarkdown = service.markdown;
       let serviceSpecificationsFiles = [];
       let serviceSpecifications = service.specifications;
@@ -9275,11 +9277,12 @@ Processing domain: ${domainName} (v${domainVersion})`));
           console.log(import_chalk3.default.cyan(` - Versioned previous domain (v${currentDomain.version})`));
         }
         if (!domain || domain && domain.version !== domainVersion) {
+          const generatedMarkdownForDomain = defaultMarkdown();
           await writeDomain({
             id: domainId,
             name: domainName,
             version: domainVersion,
-            markdown: defaultMarkdown(),
+            markdown: options.domain?.generateMarkdown ? options.domain.generateMarkdown({ domain: options.domain, markdown: generatedMarkdownForDomain }) : generatedMarkdownForDomain,
             ...options.domain?.owners ? { owners: options.domain.owners } : {}
           });
           console.log(import_chalk3.default.cyan(` - Domain (v${domainVersion}) created`));
@@ -9365,7 +9368,12 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
   const preserveExistingMessages = options.preserveExistingMessages ?? true;
   let receives = [], sends = [];
   for (const operation of operations) {
-    const { requestBodiesAndResponses, sidebar, ...message } = await buildMessage(pathToSpec, document2, operation);
+    const { requestBodiesAndResponses, sidebar, ...message } = await buildMessage(
+      pathToSpec,
+      document2,
+      operation,
+      options.messages?.generateMarkdown
+    );
     let messageMarkdown = message.markdown;
     const messageType = operation.type;
     const messageAction = operation.action;