@eventcatalog/generator-openapi 7.8.0 → 7.9.0

package/dist/index.d.mts

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -1632,6 +1632,53 @@ async function getSchemasByOperationId(filePath, operationId, parsedDocument) {
     return;
   }
 }
+async function getExamplesByOperationId(filePath, operationId, parsedDocument) {
+  const api = parsedDocument || await import_swagger_parser.default.dereference(filePath);
+  const examples = [];
+  for (const [, pathItem] of Object.entries(api.paths)) {
+    for (const [, operation] of Object.entries(pathItem)) {
+      const typedOperation = operation;
+      if (typedOperation.operationId !== operationId) continue;
+      if (typedOperation.requestBody?.content) {
+        const contentType = Object.keys(typedOperation.requestBody.content)[0];
+        const mediaType = typedOperation.requestBody.content[contentType];
+        if (mediaType.example) {
+          examples.push({ fileName: "example.json", content: JSON.stringify(mediaType.example, null, 2) });
+        }
+        if (mediaType.examples) {
+          for (const [name, exampleObj] of Object.entries(mediaType.examples)) {
+            if (exampleObj.value) {
+              examples.push({ fileName: `${name}.json`, content: JSON.stringify(exampleObj.value, null, 2) });
+            }
+          }
+        }
+      }
+      if (typedOperation.responses) {
+        for (const [statusCode, response] of Object.entries(typedOperation.responses)) {
+          if (response.content) {
+            const contentType = Object.keys(response.content)[0];
+            const mediaType = response.content[contentType];
+            if (mediaType.example) {
+              examples.push({ fileName: `response-${statusCode}.json`, content: JSON.stringify(mediaType.example, null, 2) });
+            }
+            if (mediaType.examples) {
+              for (const [name, exampleObj] of Object.entries(mediaType.examples)) {
+                if (exampleObj.value) {
+                  examples.push({
+                    fileName: `response-${statusCode}-${name}.json`,
+                    content: JSON.stringify(exampleObj.value, null, 2)
+                  });
+                }
+              }
+            }
+          }
+        }
+      }
+      return examples;
+    }
+  }
+  return examples;
+}
 function getDeprecatedValues(openAPIOperation) {
   const deprecatedDate = openAPIOperation["x-eventcatalog-deprecated-date"] || null;
   const deprecatedMessage = openAPIOperation["x-eventcatalog-deprecated-message"] || null;
@@ -1889,7 +1936,10 @@ var getMessageTypeUtils = (projectDirectory, messageType) => {
     getQuery,
     rmQueryById,
     writeQuery,
-    addFileToQuery
+    addFileToQuery,
+    addExampleToEvent,
+    addExampleToCommand,
+    addExampleToQuery
   } = (0, import_sdk.default)(projectDirectory);
   const messageTypeMap = {
     event: {
@@ -1898,6 +1948,7 @@ var getMessageTypeUtils = (projectDirectory, messageType) => {
       rmMessageById: rmEventById,
       writeMessage: writeEvent,
       addFileToMessage: addFileToEvent,
+      addExampleToMessage: addExampleToEvent,
       collection: "events"
     },
     command: {
@@ -1906,6 +1957,7 @@ var getMessageTypeUtils = (projectDirectory, messageType) => {
       rmMessageById: rmCommandById,
       writeMessage: writeCommand,
       addFileToMessage: addFileToCommand,
+      addExampleToMessage: addExampleToCommand,
       collection: "commands"
     },
     query: {
@@ -1914,6 +1966,7 @@ var getMessageTypeUtils = (projectDirectory, messageType) => {
       rmMessageById: rmQueryById,
       writeMessage: writeQuery,
       addFileToMessage: addFileToQuery,
+      addExampleToMessage: addExampleToQuery,
       collection: "queries"
     }
   };
@@ -4152,7 +4205,7 @@ var import_node_path = require("path");
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "7.8.0",
+  version: "7.9.0",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -4189,7 +4242,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "2.12.1",
+    "@eventcatalog/sdk": "2.17.4",
     chalk: "4.1.2",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -4586,6 +4639,7 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
   const sidebarBadgeType = options.sidebarBadgeType || "HTTP_METHOD";
   const version = options.serviceVersion || document2.info.version;
   const preserveExistingMessages = options.preserveExistingMessages ?? true;
+  const parseExamples = options.parseExamples ?? true;
   const isDraft = options.isDraft ?? null;
   let receives = [], sends = [];
   for (const operation of operations) {
@@ -4606,6 +4660,7 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
     console.log(import_chalk4.default.blue(`Processing message: ${message2.name} (v${message2.version})`));
     const {
       addFileToMessage,
+      addExampleToMessage,
       writeMessage,
       getMessage,
       versionMessage,
@@ -4692,6 +4747,15 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
         );
       }
     }
+    if (parseExamples && operation.operationId) {
+      const operationExamples = await getExamplesByOperationId(pathToSpec, operation.operationId, document2);
+      for (const example of operationExamples) {
+        await addExampleToMessage(message2.id, { content: example.content, fileName: example.fileName }, message2.version);
+      }
+      if (operationExamples.length > 0) {
+        console.log(import_chalk4.default.cyan(` - ${operationExamples.length} example(s) added to message (v${message2.version})`));
+      }
+    }
     console.log(import_chalk4.default.cyan(` - Message (v${message2.version}) created`));
     if (!operation.operationId) {
       console.log(import_chalk4.default.yellow(`  - OperationId not found for ${operation.method} ${operation.path}, creating one...`));