@eventcatalog/generator-openapi 5.0.4 → 6.0.0

package/dist/index.d.mts

@@ -13,6 +13,7 @@ type Props = {
     writeFilesToRoot?: boolean;
     sidebarBadgeType?: 'HTTP_METHOD' | 'MESSAGE_TYPE';
     httpMethodsToMessages?: HTTP_METHOD_TO_MESSAGE_TYPE;
+    preserveExistingMessages?: boolean;
 };
 declare const _default: (_: any, options: Props) => Promise<void>;
 

package/dist/index.d.ts

@@ -13,6 +13,7 @@ type Props = {
     writeFilesToRoot?: boolean;
     sidebarBadgeType?: 'HTTP_METHOD' | 'MESSAGE_TYPE';
     httpMethodsToMessages?: HTTP_METHOD_TO_MESSAGE_TYPE;
+    preserveExistingMessages?: boolean;
 };
 declare const _default: (_: any, options: Props) => Promise<void>;
 

package/dist/index.js

@@ -640,7 +640,7 @@ var import_chalk = __toESM(require("chalk"));
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "5.0.4",
+  version: "6.0.0",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -676,7 +676,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "^2.2.6",
+    "@eventcatalog/sdk": "^2.3.7",
     chalk: "^4",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -1608,115 +1608,136 @@ var index_default = async (_, options) => {
   } = (0, import_sdk2.default)(process.env.PROJECT_DIR);
   const { services = [], saveParsedSpecFile = false } = options;
   for (const serviceSpec of services) {
-    console.log(import_chalk3.default.green(`Processing ${serviceSpec.path}`));
-    try {
-      await import_swagger_parser2.default.validate(serviceSpec.path);
-    } catch (error) {
-      console.error(import_chalk3.default.red(`Failed to parse OpenAPI file: ${serviceSpec.path}`));
-      console.error(import_chalk3.default.red(error));
-      continue;
-    }
-    const document = await import_swagger_parser2.default.dereference(serviceSpec.path);
-    const version = document.info.version;
-    const service = buildService(serviceSpec, document);
-    let serviceMarkdown = service.markdown;
-    let serviceSpecificationsFiles = [];
-    let serviceSpecifications = service.specifications;
-    let servicePath = options.domain ? (0, import_node_path.join)("../", "domains", options.domain.id, "services", service.id) : (0, import_node_path.join)("../", "services", service.id);
-    if (options.writeFilesToRoot) {
-      servicePath = service.id;
-    }
-    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_chalk3.default.blue(`
-Processing domain: ${domainName} (v${domainVersion})`));
-      if (currentDomain && currentDomain.version !== domainVersion) {
-        await versionDomain(domainId);
-        console.log(import_chalk3.default.cyan(` - Versioned previous domain (v${currentDomain.version})`));
+    const specFiles = Array.isArray(serviceSpec.path) ? serviceSpec.path : [serviceSpec.path];
+    const specs = specFiles.map(async (specFile) => {
+      try {
+        await import_swagger_parser2.default.validate(specFile);
+        const document = await import_swagger_parser2.default.dereference(specFile);
+        return {
+          document,
+          path: specFile
+        };
+      } catch (error) {
+        console.error(import_chalk3.default.red(`Failed to parse OpenAPI file: ${serviceSpec.path}`));
+        console.error(import_chalk3.default.red(error));
+        return null;
       }
-      if (!domain || domain && domain.version !== domainVersion) {
-        await writeDomain({
-          id: domainId,
-          name: domainName,
-          version: domainVersion,
-          markdown: defaultMarkdown(),
-          ...options.domain?.owners ? { owners: options.domain.owners } : {}
-        });
-        console.log(import_chalk3.default.cyan(` - Domain (v${domainVersion}) created`));
+    });
+    const validSpecs = await Promise.all(specs);
+    const validSpecFiles = validSpecs.filter((v) => v !== null);
+    const orderedSpecs = validSpecFiles.sort((a, b) => {
+      const versionA = a?.document.info.version ?? "";
+      const versionB = b?.document.info.version ?? "";
+      return versionA.localeCompare(versionB);
+    });
+    for (const specification of orderedSpecs) {
+      const document = specification.document;
+      const version = document.info.version;
+      const specPath = specification.path;
+      const service = buildService({ ...serviceSpec, path: specPath }, document);
+      let serviceMarkdown = service.markdown;
+      let serviceSpecificationsFiles = [];
+      let serviceSpecifications = service.specifications;
+      let servicePath = options.domain ? (0, import_node_path.join)("../", "domains", options.domain.id, "services", service.id) : (0, import_node_path.join)("../", "services", service.id);
+      if (options.writeFilesToRoot) {
+        servicePath = service.id;
       }
-      if (currentDomain && currentDomain.version === domainVersion) {
-        console.log(import_chalk3.default.yellow(` - Domain (v${domainVersion}) already exists, skipped creation...`));
+      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_chalk3.default.blue(`
+Processing domain: ${domainName} (v${domainVersion})`));
+        if (currentDomain && currentDomain.version !== domainVersion) {
+          await versionDomain(domainId);
+          console.log(import_chalk3.default.cyan(` - Versioned previous domain (v${currentDomain.version})`));
+        }
+        if (!domain || domain && domain.version !== domainVersion) {
+          await writeDomain({
+            id: domainId,
+            name: domainName,
+            version: domainVersion,
+            markdown: defaultMarkdown(),
+            ...options.domain?.owners ? { owners: options.domain.owners } : {}
+          });
+          console.log(import_chalk3.default.cyan(` - Domain (v${domainVersion}) created`));
+        }
+        if (currentDomain && currentDomain.version === domainVersion) {
+          console.log(import_chalk3.default.yellow(` - Domain (v${domainVersion}) already exists, skipped creation...`));
+        }
+        await addServiceToDomain(domainId, { id: service.id, version: service.version }, domainVersion);
       }
-      await addServiceToDomain(domainId, { id: service.id, version: service.version }, domainVersion);
-    }
-    let { sends, receives } = await processMessagesForOpenAPISpec(serviceSpec.path, document, servicePath, {
-      ...options,
-      owners: service.setMessageOwnersToServiceOwners ? service.owners : []
-    });
-    let owners = service.owners || [];
-    let repository = null;
-    let styles2 = null;
-    const latestServiceInCatalog = await getService(service.id, "latest");
-    console.log(import_chalk3.default.blue(`Processing service: ${document.info.title} (v${version})`));
-    if (latestServiceInCatalog) {
-      serviceMarkdown = latestServiceInCatalog.markdown;
-      serviceSpecificationsFiles = await getSpecificationFilesForService(service.id, "latest");
-      sends = latestServiceInCatalog.sends || [];
-      owners = latestServiceInCatalog.owners || [];
-      repository = latestServiceInCatalog.repository || null;
-      styles2 = latestServiceInCatalog.styles || null;
-      serviceSpecifications = {
-        ...serviceSpecifications,
-        ...latestServiceInCatalog.specifications
-      };
-      if (latestServiceInCatalog.version !== version) {
+      const latestServiceInCatalog = await getService(service.id, "latest");
+      const versionTheService = latestServiceInCatalog && latestServiceInCatalog.version !== version;
+      console.log(import_chalk3.default.blue(`Processing service: ${document.info.title} (v${version})`));
+      if (versionTheService) {
         await versionService(service.id);
         console.log(import_chalk3.default.cyan(` - Versioned previous service (v${latestServiceInCatalog.version})`));
       }
-      if (latestServiceInCatalog.version === version) {
-        receives = latestServiceInCatalog.receives ? [...latestServiceInCatalog.receives, ...receives] : receives;
-      }
-    }
-    await writeService(
-      {
-        ...service,
-        markdown: serviceMarkdown,
-        specifications: serviceSpecifications,
-        sends,
-        receives,
-        ...owners ? { owners } : {},
-        ...repository ? { repository } : {},
-        ...styles2 ? { styles: styles2 } : {}
-      },
-      { path: (0, import_node_path.join)(servicePath), override: true }
-    );
-    const specFiles = [
-      // add any previous spec files to the list
-      ...serviceSpecificationsFiles,
-      {
-        content: saveParsedSpecFile ? getParsedSpecFile(serviceSpec, document) : await getRawSpecFile(serviceSpec),
-        fileName: service.schemaPath
+      let { sends, receives } = await processMessagesForOpenAPISpec(specPath, document, servicePath, {
+        ...options,
+        owners: service.setMessageOwnersToServiceOwners ? service.owners : [],
+        serviceHasMultipleSpecFiles: Array.isArray(serviceSpec.path)
+      });
+      let owners = service.owners || [];
+      let repository = null;
+      let styles2 = null;
+      const persistPreviousSpecificationFiles = Array.isArray(serviceSpec.path) === false;
+      if (latestServiceInCatalog) {
+        serviceMarkdown = latestServiceInCatalog.markdown;
+        serviceSpecificationsFiles = await getSpecificationFilesForService(service.id, "latest");
+        sends = latestServiceInCatalog.sends || [];
+        owners = latestServiceInCatalog.owners || [];
+        repository = latestServiceInCatalog.repository || null;
+        styles2 = latestServiceInCatalog.styles || null;
+        serviceSpecifications = {
+          ...serviceSpecifications,
+          ...persistPreviousSpecificationFiles ? latestServiceInCatalog.specifications : {}
+        };
+        if (latestServiceInCatalog.version === version) {
+          receives = latestServiceInCatalog.receives ? [...latestServiceInCatalog.receives, ...receives] : receives;
+        }
       }
-    ];
-    for (const specFile of specFiles) {
-      await addFileToService(
-        service.id,
+      await writeService(
         {
-          fileName: specFile.fileName,
-          content: specFile.content
+          ...service,
+          markdown: serviceMarkdown,
+          specifications: serviceSpecifications,
+          sends,
+          receives,
+          ...owners ? { owners } : {},
+          ...repository ? { repository } : {},
+          ...styles2 ? { styles: styles2 } : {}
         },
-        version
+        { path: (0, import_node_path.join)(servicePath), override: true }
       );
+      const specFiles2 = [
+        // add any previous spec files to the list
+        ...persistPreviousSpecificationFiles ? serviceSpecificationsFiles : [],
+        {
+          content: saveParsedSpecFile ? getParsedSpecFile({ ...serviceSpec, path: specPath }, document) : await getRawSpecFile({ ...serviceSpec, path: specPath }),
+          fileName: service.schemaPath
+        }
+      ];
+      for (const specFile of specFiles2) {
+        await addFileToService(
+          service.id,
+          {
+            fileName: specFile.fileName,
+            content: specFile.content
+          },
+          version
+        );
+      }
+      console.log(import_chalk3.default.cyan(` - Service (v${version}) created`));
     }
-    console.log(import_chalk3.default.cyan(` - Service (v${version}) created`));
   }
 };
 var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, options) => {
   const operations = await getOperationsByType(pathToSpec, options.httpMethodsToMessages);
   const sidebarBadgeType = options.sidebarBadgeType || "HTTP_METHOD";
   const version = document.info.version;
+  const preserveExistingMessages = options.preserveExistingMessages ?? true;
   let receives = [], sends = [];
   for (const operation of operations) {
     const { requestBodiesAndResponses, sidebar, ...message } = await buildMessage(pathToSpec, document, operation);
@@ -1733,10 +1754,12 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
     } = getMessageTypeUtils(process.env.PROJECT_DIR, messageType);
     const catalogedMessage = await getMessage(message.id, "latest");
     if (catalogedMessage) {
-      messageMarkdown = catalogedMessage.markdown;
-      if (catalogedMessage.version !== version) {
+      if (preserveExistingMessages) {
+        messageMarkdown = catalogedMessage.markdown;
+      }
+      if (catalogedMessage.version !== version && !options.serviceHasMultipleSpecFiles) {
         await versionMessage(message.id);
-        console.log(import_chalk3.default.cyan(` - Versioned previous message: (v${catalogedMessage.version})`));
+        console.log(import_chalk3.default.cyan(` - Versioned previous message: ${message.id} (v${catalogedMessage.version})`));
       }
     }
     let messagePath = (0, import_node_path.join)(servicePath, folder, message.id);
@@ -1751,7 +1774,7 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
         // only if its defined add it to the sidebar
         ...sidebarBadgeType === "HTTP_METHOD" ? { sidebar } : {}
       },
-      { path: messagePath, override: true }
+      { path: options.pathForMessages || messagePath, override: true }
     );
     if (messageAction === "sends") {
       sends.push({
@@ -1813,17 +1836,19 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
   return { receives, sends };
 };
 var getParsedSpecFile = (service, document) => {
-  const isSpecFileJSON = service.path.endsWith(".json");
+  const specPath = service.path;
+  const isSpecFileJSON = specPath.endsWith(".json");
   return isSpecFileJSON ? JSON.stringify(document, null, 2) : import_js_yaml.default.dump(document, { noRefs: true });
 };
 var getRawSpecFile = async (service) => {
-  if (service.path.startsWith("http")) {
-    const file = await fetch(service.path, { method: "GET" });
+  const specPath = service.path;
+  if (specPath.startsWith("http")) {
+    const file = await fetch(specPath, { method: "GET" });
     if (!file.ok) {
-      throw new Error(`Failed to fetch file: ${service.path}, status: ${file.status}`);
+      throw new Error(`Failed to fetch file: ${specPath}, status: ${file.status}`);
     }
     return await file.text();
   }
-  return await (0, import_promises.readFile)(service.path, "utf8");
+  return await (0, import_promises.readFile)(specPath, "utf8");
 };
 //# sourceMappingURL=index.js.map