@eventcatalog/generator-openapi 7.2.0 → 7.3.0

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

@@ -6644,6 +6644,7 @@ 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, generateMarkdown) => {
     specifications: {
       openapiPath: schemaPath
     },
-    markdown: generateMarkdown ? generateMarkdown(document2, schemaPath) : 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,18 +6884,20 @@ 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,
     sidebar: {
       badge: httpVerb
     },
+    ...extensions["x-eventcatalog-draft"] ? { draft: true } : {},
     ...operation.deprecated ? { deprecated: operation.deprecated } : {}
   };
 };
@@ -8293,7 +8296,7 @@ var import_node_path2 = require("path");
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "7.2.0",
+  version: "7.3.0",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -8330,7 +8333,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "^2.3.7",
+    "@eventcatalog/sdk": "^2.6.9",
     chalk: "^4",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -9260,6 +9263,11 @@ var index_default = async (_, options) => {
       let serviceMarkdown = service.markdown;
       let serviceSpecificationsFiles = [];
       let serviceSpecifications = service.specifications;
+      const isDomainMarkedAsDraft = options.domain?.draft || null;
+      const isServiceMarkedAsDraft = (
+        // @ts-ignore
+        isDomainMarkedAsDraft || document2.info?.["x-eventcatalog-draft"] || serviceSpec.draft || null
+      );
       let servicePath = options.domain ? (0, import_node_path2.join)("../", "domains", options.domain.id, "services", service.id) : (0, import_node_path2.join)("../", "services", service.id);
       if (options.writeFilesToRoot) {
         servicePath = service.id;
@@ -9275,12 +9283,14 @@ 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(),
-            ...options.domain?.owners ? { owners: options.domain.owners } : {}
+            markdown: options.domain?.generateMarkdown ? options.domain.generateMarkdown({ domain: options.domain, markdown: generatedMarkdownForDomain }) : generatedMarkdownForDomain,
+            ...options.domain?.owners ? { owners: options.domain.owners } : {},
+            ...isDomainMarkedAsDraft && { draft: true }
           });
           console.log(import_chalk3.default.cyan(` - Domain (v${domainVersion}) created`));
         }
@@ -9302,7 +9312,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
       let { sends, receives } = await processMessagesForOpenAPISpec(specPath, document2, servicePath, {
         ...options,
         owners: service.setMessageOwnersToServiceOwners ? service.owners : [],
-        serviceHasMultipleSpecFiles: Array.isArray(serviceSpec.path)
+        serviceHasMultipleSpecFiles: Array.isArray(serviceSpec.path),
+        isDraft: isServiceMarkedAsDraft
       });
       let owners = service.owners || [];
       let repository = null;
@@ -9323,6 +9334,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
           receives = latestServiceInCatalog.receives ? [...latestServiceInCatalog.receives, ...receives] : receives;
         }
       }
+      console.log("isServiceMarkedAsDraft", service);
       await writeService(
         {
           ...service,
@@ -9332,7 +9344,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
           receives,
           ...owners ? { owners } : {},
           ...repository ? { repository } : {},
-          ...styles2 ? { styles: styles2 } : {}
+          ...styles2 ? { styles: styles2 } : {},
+          ...isServiceMarkedAsDraft ? { draft: true } : {}
         },
         { path: (0, import_node_path2.join)(servicePath), override: true }
       );
@@ -9363,9 +9376,15 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
   const sidebarBadgeType = options.sidebarBadgeType || "HTTP_METHOD";
   const version = document2.info.version;
   const preserveExistingMessages = options.preserveExistingMessages ?? true;
+  const isDraft = options.isDraft ?? null;
   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;
@@ -9397,7 +9416,8 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
         markdown: messageMarkdown,
         ...options.owners ? { owners: options.owners } : {},
         // only if its defined add it to the sidebar
-        ...sidebarBadgeType === "HTTP_METHOD" ? { sidebar } : {}
+        ...sidebarBadgeType === "HTTP_METHOD" ? { sidebar } : {},
+        ...isDraft ? { draft: true } : {}
       },
       { path: options.pathForMessages || messagePath, override: true }
     );