@eventcatalog/generator-openapi 7.6.5 → 7.7.1

package/dist/index.mjs

@@ -1589,9 +1589,9 @@ var buildService = (serviceOptions, document2, generateMarkdown) => {
 // src/utils/openapi.ts
 import SwaggerParser from "@apidevtools/swagger-parser";
 var DEFAULT_MESSAGE_TYPE = "query";
-async function getSchemasByOperationId(filePath, operationId) {
+async function getSchemasByOperationId(filePath, operationId, parsedDocument) {
   try {
-    const api = await SwaggerParser.dereference(filePath);
+    const api = parsedDocument || await SwaggerParser.dereference(filePath);
     const schemas = {
       parameters: [],
       requestBody: null,
@@ -1612,7 +1612,8 @@ async function getSchemasByOperationId(filePath, operationId) {
             for (const [statusCode, response] of Object.entries(typedOperation.responses)) {
               if (response.content) {
                 const contentType = Object.keys(response.content)[0];
-                schemas.responses[statusCode] = response.content[contentType].schema || response.content[contentType];
+                const schemaOrContent = response.content[contentType].schema || response.content[contentType];
+                schemas.responses[statusCode] = { ...schemaOrContent };
                 schemas.responses[statusCode].isSchema = !!response.content[contentType].schema;
               }
             }
@@ -1640,9 +1641,9 @@ function getDeprecatedValues(openAPIOperation) {
   }
   return deprecated;
 }
-async function getOperationsByType(openApiPath, httpMethodsToMessages) {
+async function getOperationsByType(openApiPath, httpMethodsToMessages, parsedDocument) {
   try {
-    const api = await SwaggerParser.validate(openApiPath);
+    const api = parsedDocument || await SwaggerParser.validate(openApiPath);
     const operations = [];
     for (const path4 in api.paths) {
       const pathItem = api.paths[path4];
@@ -1810,7 +1811,7 @@ var getSummary2 = (message2) => {
   return escapeSpecialCharactersThatBreakMarkdown(eventCatalogMessageSummary);
 };
 var buildMessage = async (pathToFile, document2, operation, generateMarkdown, messageIdConfig, serviceId, serviceVersion) => {
-  const requestBodiesAndResponses = await getSchemasByOperationId(pathToFile, operation.operationId);
+  const requestBodiesAndResponses = await getSchemasByOperationId(pathToFile, operation.operationId, document2);
   const extensions = operation.extensions || {};
   const operationTags = operation.tags.map((badge) => ({
     content: `tag:${badge}`,
@@ -4067,7 +4068,7 @@ import { join } from "path";
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "7.6.5",
+  version: "7.7.1",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -4104,7 +4105,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "^2.9.6",
+    "@eventcatalog/sdk": "2.12.1",
     chalk: "4.1.2",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -4180,6 +4181,25 @@ var isVersionLessThan = (version, givenVersion) => {
 var toUniqueArray = (array) => {
   return array.filter((item, index, self) => index === self.findIndex((t) => t.id === item.id && t.version === item.version));
 };
+var fetchAuthenticatedSpec = async (specUrl, headers) => {
+  const response = await fetch(specUrl, { method: "GET", headers });
+  if (!response.ok) {
+    throw new Error(`Failed to fetch file: ${specUrl}, status: ${response.status}`);
+  }
+  const content = await response.text();
+  const contentType = response.headers.get("content-type") || "";
+  if (contentType.includes("json")) {
+    return JSON.parse(content);
+  }
+  if (contentType.includes("yaml")) {
+    return yaml.load(content);
+  }
+  try {
+    return JSON.parse(content);
+  } catch {
+    return yaml.load(content);
+  }
+};
 var mergeOpenApiIntoSpecifications = (existingSpecs, openapiFileName) => {
   if (Array.isArray(existingSpecs)) {
     return [...existingSpecs.filter((spec) => spec.type !== "openapi"), { type: "openapi", path: openapiFileName }];
@@ -4213,8 +4233,17 @@ var index_default = async (_, options) => {
     const specFiles = Array.isArray(serviceSpec.path) ? serviceSpec.path : [serviceSpec.path];
     const specs = specFiles.map(async (specFile) => {
       try {
-        await SwaggerParser2.validate(specFile);
-        const document2 = await SwaggerParser2.dereference(specFile);
+        const isUrl = specFile.startsWith("http");
+        const hasHeaders = serviceSpec.headers && Object.keys(serviceSpec.headers).length > 0;
+        let document2;
+        if (isUrl && hasHeaders) {
+          const parsedSpec = await fetchAuthenticatedSpec(specFile, serviceSpec.headers);
+          await SwaggerParser2.validate(parsedSpec);
+          document2 = await SwaggerParser2.dereference(parsedSpec);
+        } else {
+          await SwaggerParser2.validate(specFile);
+          document2 = await SwaggerParser2.dereference(specFile);
+        }
         return {
           document: document2,
           path: specFile,
@@ -4311,6 +4340,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
       let owners = service.owners || [];
       let repository = null;
       let styles2 = null;
+      let serviceDiagrams = null;
       let serviceWritesTo = configuredWritesTo;
       let serviceReadsFrom = configuredReadsFrom;
       const persistPreviousSpecificationFiles = Array.isArray(serviceSpec.path) === false;
@@ -4323,6 +4353,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
         styles2 = latestServiceInCatalog.styles || null;
         serviceBadges = latestServiceInCatalog.badges || null;
         serviceAttachments = latestServiceInCatalog.attachments || null;
+        serviceDiagrams = latestServiceInCatalog.diagrams || null;
         serviceWritesTo = latestServiceInCatalog.writesTo || [];
         serviceReadsFrom = latestServiceInCatalog.readsFrom || [];
         if (persistPreviousSpecificationFiles && latestServiceInCatalog.specifications) {
@@ -4333,7 +4364,6 @@ Processing domain: ${domainName} (v${domainVersion})`));
             // @ts-ignore
             toUniqueArray([...latestServiceInCatalog.receives, ...receives])
           ) : receives;
-          console.log("MEOW", "HELLO", latestServiceInCatalog.writesTo, serviceWritesTo);
           serviceWritesTo = latestServiceInCatalog.writesTo ? toUniqueArray([...latestServiceInCatalog.writesTo, ...configuredWritesTo]) : configuredWritesTo;
           serviceReadsFrom = latestServiceInCatalog.readsFrom ? toUniqueArray([...latestServiceInCatalog.readsFrom, ...configuredReadsFrom]) : configuredReadsFrom;
         }
@@ -4351,6 +4381,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
           ...owners ? { owners } : {},
           ...repository ? { repository } : {},
           ...styles2 ? { styles: styles2 } : {},
+          ...serviceDiagrams ? { diagrams: serviceDiagrams } : {},
           ...isServiceMarkedAsDraft ? { draft: true } : {},
           ...serviceAttachments ? { attachments: serviceAttachments } : {},
           ...serviceWritesTo.length > 0 ? { writesTo: serviceWritesTo } : {},
@@ -4381,7 +4412,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
   }
 };
 var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, options) => {
-  const operations = await getOperationsByType(pathToSpec, options.httpMethodsToMessages);
+  const operations = await getOperationsByType(pathToSpec, options.httpMethodsToMessages, document2);
   const sidebarBadgeType = options.sidebarBadgeType || "HTTP_METHOD";
   const version = options.serviceVersion || document2.info.version;
   const preserveExistingMessages = options.preserveExistingMessages ?? true;
@@ -4507,7 +4538,11 @@ var getParsedSpecFile = (service, document2) => {
 var getRawSpecFile = async (service) => {
   const specPath = service.path;
   if (specPath.startsWith("http")) {
-    const file = await fetch(specPath, { method: "GET" });
+    const fetchOptions = { method: "GET" };
+    if (service.headers && Object.keys(service.headers).length > 0) {
+      fetchOptions.headers = service.headers;
+    }
+    const file = await fetch(specPath, fetchOptions);
     if (!file.ok) {
       throw new Error(`Failed to fetch file: ${specPath}, status: ${file.status}`);
     }