@eventcatalog/generator-asyncapi 6.4.4 → 7.0.1

package/dist/index.mjs

@@ -1528,7 +1528,7 @@ var require_dist2 = __commonJS({
 // src/index.ts
 import { Parser, fromFile, fromURL } from "@asyncapi/parser";
 import utils from "@eventcatalog/sdk";
-import { readFile } from "fs/promises";
+import { cp, mkdir, readFile, rm } from "fs/promises";
 import argv from "minimist";
 import yaml from "js-yaml";
 import { z } from "zod";
@@ -1538,7 +1538,7 @@ import path3 from "path";
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-asyncapi",
-  version: "6.4.4",
+  version: "7.0.1",
   description: "AsyncAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -4156,6 +4156,7 @@ var cliArgs = argv(process.argv.slice(2));
 var optionsSchema = z.object({
   licenseKey: z.string().optional(),
   writeFilesToRoot: z.boolean().optional(),
+  preserveExistingMessages: z.boolean().optional(),
   services: z.array(
     z.object({
       id: z.string({ required_error: "The service id is required. please provide the service id" }),
@@ -4290,6 +4291,9 @@ var index_default = async (config, options) => {
     versionCommand,
     versionEvent,
     versionQuery,
+    rmCommandById,
+    rmEventById,
+    rmQueryById,
     addSchemaToCommand,
     addSchemaToEvent,
     addSchemaToQuery,
@@ -4309,6 +4313,7 @@ var index_default = async (config, options) => {
       write: writeEvent,
       version: versionEvent,
       get: getEvent,
+      remove: rmEventById,
       addSchema: addSchemaToEvent,
       addExample: addExampleToEvent,
       collection: "events"
@@ -4317,6 +4322,7 @@ var index_default = async (config, options) => {
       write: writeCommand,
       version: versionCommand,
       get: getCommand,
+      remove: rmCommandById,
       addSchema: addSchemaToCommand,
       addExample: addExampleToCommand,
       collection: "commands"
@@ -4325,6 +4331,7 @@ var index_default = async (config, options) => {
       write: writeQuery,
       version: versionQuery,
       get: getQuery,
+      remove: rmQueryById,
       addSchema: addSchemaToQuery,
       addExample: addExampleToQuery,
       collection: "queries"
@@ -4337,7 +4344,8 @@ var index_default = async (config, options) => {
     parseSchemas = true,
     parseChannels = false,
     parseExamples = true,
-    attachHeadersToSchema = false
+    attachHeadersToSchema = false,
+    preserveExistingMessages = true
   } = options;
   console.log(chalk4.green(`Processing ${services.length} AsyncAPI files...`));
   for (const service of services) {
@@ -4496,7 +4504,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
         const deprecatedDate = message2.extensions().get("x-eventcatalog-deprecated-date")?.value() || null;
         const deprecatedMessage = message2.extensions().get("x-eventcatalog-deprecated-message")?.value() || null;
         const isMessageMarkedAsDraft = isDomainMarkedAsDraft || isServiceMarkedAsDraft || message2.extensions().get("x-eventcatalog-draft")?.value() || null;
-        const serviceOwnsMessageContract = isServiceMessageOwner(message2, operation);
+        const messageOwnership = getMessageOwnership(message2, operation);
+        const serviceOwnsMessageContract = messageOwnership === "owner";
         const isReceived = operation.action() === "receive" || operation.action() === "subscribe";
         const isSent = operation.action() === "send" || operation.action() === "publish";
         let messageId = options.messages?.id?.lowerCase ? message2.id().toLowerCase() : message2.id();
@@ -4514,6 +4523,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
           write: writeMessage,
           version: versionMessage,
           get: getMessage,
+          remove: removeMessage,
           addSchema: addSchemaToMessage,
           addExample: addExampleToMessage,
           collection: folder
@@ -4528,15 +4538,26 @@ Processing domain: ${domainName} (v${domainVersion})`));
         if (options.writeFilesToRoot) {
           messagePath = messageId;
         }
-        if (serviceOwnsMessageContract) {
+        if (messageOwnership === "external") {
+          console.log(chalk4.yellow(` - Skipping external message: ${getMessageName(message2)}(v${messageVersion})`));
+        } else {
           const catalogedMessage = await getMessage(messageId, "latest");
           let shouldWriteMessage = true;
-          if (catalogedMessage) {
-            messageMarkdown = catalogedMessage.markdown;
+          let existingMessageDirectoryToRelocate = null;
+          if (serviceOwnsMessageContract && catalogedMessage) {
             messageBadges = catalogedMessage.badges || null;
             messageAttachments = catalogedMessage.attachments || null;
+            if (preserveExistingMessages) {
+              messageMarkdown = catalogedMessage.markdown;
+            }
             const catalogedVersion = catalogedMessage.version ?? "";
             if (isSameVersion(catalogedVersion, messageVersion)) {
+              const catalogedMessagePath = await getResourcePath(process.env.PROJECT_DIR, messageId, catalogedVersion);
+              const targetMessageDirectory = path3.resolve(process.env.PROJECT_DIR, folder, messagePath);
+              const catalogedMessageDirectory = catalogedMessagePath ? path3.dirname(catalogedMessagePath.fullPath) : null;
+              if (catalogedMessageDirectory && path3.normalize(catalogedMessageDirectory) !== path3.normalize(targetMessageDirectory)) {
+                existingMessageDirectoryToRelocate = catalogedMessageDirectory;
+              }
             } else if (isNewerVersion(messageVersion, catalogedVersion)) {
               await versionMessage(messageId);
               console.log(chalk4.cyan(` - Versioned previous message: (v${catalogedMessage.version})`));
@@ -4549,8 +4570,24 @@ Processing domain: ${domainName} (v${domainVersion})`));
               messageVersion = catalogedVersion;
               shouldWriteMessage = false;
             }
+          } else if (!serviceOwnsMessageContract && catalogedMessage) {
+            console.log(
+              chalk4.yellow(` - Referencing existing message ${messageId} (v${catalogedMessage.version}) without overwriting`)
+            );
+            messageVersion = catalogedMessage.version ?? messageVersion;
+            shouldWriteMessage = false;
           }
           if (shouldWriteMessage) {
+            if (existingMessageDirectoryToRelocate) {
+              const targetMessageDirectory = path3.resolve(process.env.PROJECT_DIR, folder, messagePath);
+              await removeMessage(messageId, messageVersion, true);
+              await mkdir(path3.dirname(targetMessageDirectory), { recursive: true });
+              await cp(existingMessageDirectoryToRelocate, targetMessageDirectory, {
+                recursive: true,
+                force: true
+              });
+              await rm(existingMessageDirectoryToRelocate, { recursive: true, force: true });
+            }
             await writeMessage(
               {
                 id: messageId,
@@ -4568,7 +4605,9 @@ Processing domain: ${domainName} (v${domainVersion})`));
                 ...isMessageMarkedAsDraft && { draft: true }
               },
               {
-                override: true,
+                // References only reach this branch when the message is missing. They may
+                // create a fallback, but only owners may replace an existing contract.
+                override: serviceOwnsMessageContract,
                 path: messagePath
               }
             );
@@ -4602,8 +4641,6 @@ Processing domain: ${domainName} (v${domainVersion})`));
               }
             }
           }
-        } else {
-          console.log(chalk4.yellow(` - Skipping external message: ${getMessageName(message2)}(v${messageVersion})`));
         }
         const group = options.groupMessagesBy === "x-extension" ? message2.extensions().get("x-eventcatalog-group")?.value() || void 0 : void 0;
         if (parseChannels) {
@@ -4769,11 +4806,18 @@ var getSchemaFromMessagePart = (schema) => {
 var isJSONSchemaMessage = (message2) => {
   return getSchemaFileName(message2).endsWith(".json");
 };
-var isServiceMessageOwner = (message2, operation) => {
+var getMessageOwnership = (message2, operation) => {
   const operationRole = operation?.extensions?.().get?.("x-eventcatalog-role")?.value?.();
   const messageRole = message2.extensions().get("x-eventcatalog-role")?.value();
-  const value = operationRole || messageRole || "provider";
-  return value === "provider";
+  const explicitRole = operationRole || messageRole;
+  if (explicitRole) {
+    return explicitRole === "provider" ? "owner" : "external";
+  }
+  const action = operation?.action?.();
+  if (action === "receive" || action === "subscribe") {
+    return "reference";
+  }
+  return "owner";
 };
 export {
   index_default as default