@eventcatalog/generator-asyncapi 4.2.1 → 4.4.0

package/dist/index.mjs

@@ -1051,9 +1051,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"(exports) {
+  "../../node_modules/.pnpm/agent-base@7.1.4/node_modules/agent-base/dist/helpers.js"(exports) {
     "use strict";
     var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
       if (k2 === void 0) k2 = k;
@@ -1121,9 +1121,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"(exports) {
+  "../../node_modules/.pnpm/agent-base@7.1.4/node_modules/agent-base/dist/index.js"(exports) {
     "use strict";
     var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
       if (k2 === void 0) k2 = k;
@@ -1219,7 +1219,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);
         }
@@ -1536,7 +1536,7 @@ import path2 from "path";
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-asyncapi",
-  version: "4.2.1",
+  version: "4.4.0",
   description: "AsyncAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -1574,7 +1574,7 @@ var package_default = {
   dependencies: {
     "@asyncapi/avro-schema-parser": "^3.0.24",
     "@asyncapi/parser": "^3.3.0",
-    "@eventcatalog/sdk": "^2.5.5",
+    "@eventcatalog/sdk": "^2.6.9",
     chalk: "^4",
     "fs-extra": "^11.2.0",
     glob: "^11.0.0",
@@ -2656,16 +2656,50 @@ var optionsSchema = z.object({
     z.object({
       id: z.string({ required_error: "The service id is required. please provide the service id" }),
       path: z.string({ required_error: "The service path is required. please provide the path to specification file" }),
+      draft: z.boolean().optional(),
       name: z.string().optional(),
-      owners: z.array(z.string()).optional()
+      owners: z.array(z.string()).optional(),
+      generateMarkdown: z.function().args(
+        z.object({
+          service: z.object({
+            id: z.string(),
+            name: z.string(),
+            version: z.string()
+          }),
+          // AsyncAPI Interface
+          document: z.any(),
+          markdown: z.string().optional()
+        })
+      ).returns(z.string()).optional()
     }),
     { message: "Please provide correct services configuration" }
   ),
+  messages: z.object({
+    generateMarkdown: z.function().args(
+      z.object({
+        message: z.any(),
+        document: z.any(),
+        markdown: z.string().optional()
+      })
+    ).returns(z.string()).optional()
+  }).optional(),
   domain: z.object({
     id: z.string({ required_error: "The domain id is required. please provide a domain id" }),
     name: z.string({ required_error: "The domain name is required. please provide a domain name" }),
     owners: z.array(z.string()).optional(),
-    version: z.string({ required_error: "The domain version is required. please provide a domain version" })
+    version: z.string({ required_error: "The domain version is required. please provide a domain version" }),
+    draft: z.boolean().optional(),
+    // function that takes options (including domain) and returns a string
+    generateMarkdown: z.function().args(
+      z.object({
+        domain: z.object({
+          id: z.string(),
+          name: z.string(),
+          version: z.string()
+        }),
+        markdown: z.string().optional()
+      })
+    ).returns(z.string()).optional()
   }).optional(),
   debug: z.boolean().optional(),
   parseSchemas: z.boolean().optional(),
@@ -2760,6 +2794,8 @@ var index_default = async (config, options) => {
     const operations = document2.allOperations();
     const channels = document2.allChannels();
     const documentTags = document2.info().tags().all() || [];
+    const isDomainMarkedAsDraft = options.domain?.draft || false;
+    const isServiceMarkedAsDraft = isDomainMarkedAsDraft || document2.info().extensions().get("x-eventcatalog-draft")?.value() || service.draft || false;
     const serviceId = service.id;
     const serviceName = service.name || document2.info().title();
     const version = document2.info().version();
@@ -2769,7 +2805,12 @@ var index_default = async (config, options) => {
     let repository = null;
     let serviceSpecifications = {};
     let serviceSpecificationsFiles = [];
-    let serviceMarkdown = defaultMarkdown2(document2);
+    const generatedMarkdownForService = defaultMarkdown2(document2);
+    let serviceMarkdown = service.generateMarkdown ? service.generateMarkdown({
+      service: { id: service.id, name: serviceName, version },
+      document: document2,
+      markdown: generatedMarkdownForService
+    }) : generatedMarkdownForService;
     let styles2 = null;
     let servicePath = options.domain ? path2.join("../", "domains", options.domain.id, "services", service.id) : path2.join("../", "services", service.id);
     if (options.writeFilesToRoot) {
@@ -2779,6 +2820,7 @@ var index_default = async (config, options) => {
       const { id: domainId, name: domainName, version: domainVersion, owners: domainOwners } = options.domain;
       const domain = await getDomain(options.domain.id, domainVersion || "latest");
       const currentDomain = await getDomain(options.domain.id, "latest");
+      const domainIsDraft = isDomainMarkedAsDraft || currentDomain?.draft || false;
       console.log(chalk3.blue(`
 Processing domain: ${domainName} (v${domainVersion})`));
       if (currentDomain && currentDomain.version !== domainVersion) {
@@ -2786,12 +2828,14 @@ Processing domain: ${domainName} (v${domainVersion})`));
         console.log(chalk3.cyan(` - Versioned previous domain (v${currentDomain.version})`));
       }
       if (!domain || domain && domain.version !== domainVersion) {
+        const generatedMarkdownForDomain = defaultMarkdown3(document2);
         await writeDomain({
           id: domainId,
           name: domainName,
           version: domainVersion,
-          markdown: defaultMarkdown3(document2),
-          ...domainOwners && { owners: domainOwners }
+          markdown: options.domain?.generateMarkdown ? options.domain.generateMarkdown({ domain: options.domain, markdown: generatedMarkdownForDomain }) : generatedMarkdownForDomain,
+          ...domainOwners && { owners: domainOwners },
+          ...domainIsDraft && { draft: true }
           // services: [{ id: serviceId, version: version }],
         });
         console.log(chalk3.cyan(` - Domain (v${domainVersion}) created`));
@@ -2839,7 +2883,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
             ...Object.keys(paramsForCatalog).length > 0 && { parameters: paramsForCatalog },
             ...channel.address() && { address: channel.address() },
             ...channelAsJSON?.summary && { summary: channelAsJSON.summary },
-            ...protocols.length > 0 && { protocols }
+            ...protocols.length > 0 && { protocols },
+            ...(isDomainMarkedAsDraft || isServiceMarkedAsDraft) && { draft: true }
           },
           { override: true }
         );
@@ -2852,6 +2897,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
         const messageVersion = message.extensions().get("x-eventcatalog-message-version")?.value() || version;
         const deprecatedDate = message.extensions().get("x-eventcatalog-deprecated-date")?.value() || null;
         const deprecatedMessage = message.extensions().get("x-eventcatalog-deprecated-message")?.value() || null;
+        const isMessageMarkedAsDraft = isDomainMarkedAsDraft || isServiceMarkedAsDraft || message.extensions().get("x-eventcatalog-draft")?.value() || null;
         const serviceOwnsMessageContract = isServiceMessageOwner(message);
         const isReceived = operation.action() === "receive" || operation.action() === "subscribe";
         const isSent = operation.action() === "send" || operation.action() === "publish";
@@ -2866,7 +2912,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
           addSchema: addSchemaToMessage,
           collection: folder
         } = MESSAGE_OPERATIONS[eventType];
-        let messageMarkdown = defaultMarkdown(document2, message);
+        const generatedMarkdownForMessage = defaultMarkdown(document2, message);
+        let messageMarkdown = options.messages?.generateMarkdown ? options.messages.generateMarkdown({ message, document: document2, markdown: generatedMarkdownForMessage }) : generatedMarkdownForMessage;
         const badges = message.tags().all() || [];
         console.log(chalk3.blue(`Processing message: ${getMessageName(message)} (v${messageVersion})`));
         let messagePath = join(servicePath, folder, message.id());
@@ -2896,7 +2943,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
               ...channelsForMessage.length > 0 && { channels: channelsForMessage },
               ...deprecatedDate && {
                 deprecated: { date: deprecatedDate, ...deprecatedMessage && { message: deprecatedMessage } }
-              }
+              },
+              ...isMessageMarkedAsDraft && { draft: true }
             },
             {
               override: true,
@@ -2963,7 +3011,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
         },
         ...owners && { owners },
         ...repository && { repository },
-        ...styles2 && { styles: styles2 }
+        ...styles2 && { styles: styles2 },
+        ...isServiceMarkedAsDraft && { draft: true }
       },
       {
         path: servicePath,