@eventcatalog/generator-openapi 5.0.3 → 5.0.5

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

@@ -387,6 +387,19 @@ async function getSchemasByOperationId(filePath, operationId) {
     return;
   }
 }
+function getDeprecatedValues(openAPIOperation) {
+  const deprecatedDate = openAPIOperation["x-eventcatalog-deprecated-date"] || null;
+  const deprecatedMessage = openAPIOperation["x-eventcatalog-deprecated-message"] || null;
+  const isNativeDeprecated = openAPIOperation.deprecated;
+  let deprecated = isNativeDeprecated;
+  if (deprecatedDate) {
+    deprecated = {
+      date: deprecatedDate,
+      message: deprecatedMessage
+    };
+  }
+  return deprecated;
+}
 async function getOperationsByType(openApiPath, httpMethodsToMessages) {
   try {
     const api = await import_swagger_parser.default.validate(openApiPath);
@@ -396,6 +409,7 @@ async function getOperationsByType(openApiPath, httpMethodsToMessages) {
       for (const method in pathItem) {
         const openAPIOperation = pathItem[method];
         const defaultMessageType = httpMethodsToMessages?.[method.toUpperCase()] || DEFAULT_MESSAGE_TYPE;
+        const deprecated = getDeprecatedValues(openAPIOperation);
         const messageType = openAPIOperation["x-eventcatalog-message-type"] || defaultMessageType;
         const messageAction = openAPIOperation["x-eventcatalog-message-action"] === "sends" ? "sends" : "receives";
         const extensions = Object.keys(openAPIOperation).reduce((acc, key) => {
@@ -414,7 +428,8 @@ async function getOperationsByType(openApiPath, httpMethodsToMessages) {
           description: openAPIOperation.description,
           summary: openAPIOperation.summary,
           tags: openAPIOperation.tags || [],
-          extensions
+          extensions,
+          ...deprecated ? { deprecated } : {}
         };
         operations.push(operation);
       }
@@ -565,7 +580,8 @@ var buildMessage = async (pathToFile, document, operation) => {
     requestBodiesAndResponses,
     sidebar: {
       badge: httpVerb
-    }
+    },
+    ...operation.deprecated ? { deprecated: operation.deprecated } : {}
   };
 };
 
@@ -624,7 +640,7 @@ var import_chalk = __toESM(require("chalk"));
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "5.0.3",
+  version: "5.0.5",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -660,7 +676,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "^2.2.4",
+    "@eventcatalog/sdk": "^2.2.6",
     chalk: "^4",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -1701,6 +1717,7 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
   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);
@@ -1717,7 +1734,9 @@ 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 (preserveExistingMessages) {
+        messageMarkdown = catalogedMessage.markdown;
+      }
       if (catalogedMessage.version !== version) {
         await versionMessage(message.id);
         console.log(import_chalk3.default.cyan(` - Versioned previous message: (v${catalogedMessage.version})`));