@eventcatalog/generator-openapi 5.0.0 → 5.0.2

package/dist/index.d.mts

@@ -1,6 +1,9 @@
 import { Service, Domain } from './types.mjs';
 import 'openapi-types';
 
+type MESSAGE_TYPE = 'command' | 'query' | 'event';
+type HTTP_METHOD = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+type HTTP_METHOD_TO_MESSAGE_TYPE = Partial<Record<HTTP_METHOD, MESSAGE_TYPE>>;
 type Props = {
     services: Service[];
     domain?: Domain;
@@ -8,7 +11,9 @@ type Props = {
     saveParsedSpecFile?: boolean;
     licenseKey?: string;
     writeFilesToRoot?: boolean;
+    sidebarBadgeType?: 'HTTP_METHOD' | 'MESSAGE_TYPE';
+    httpMethodsToMessages?: HTTP_METHOD_TO_MESSAGE_TYPE;
 };
 declare const _default: (_: any, options: Props) => Promise<void>;
 
-export { _default as default };
+export { type HTTP_METHOD, type HTTP_METHOD_TO_MESSAGE_TYPE, _default as default };

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import { Service, Domain } from './types.js';
 import 'openapi-types';
 
+type MESSAGE_TYPE = 'command' | 'query' | 'event';
+type HTTP_METHOD = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+type HTTP_METHOD_TO_MESSAGE_TYPE = Partial<Record<HTTP_METHOD, MESSAGE_TYPE>>;
 type Props = {
     services: Service[];
     domain?: Domain;
@@ -8,7 +11,9 @@ type Props = {
     saveParsedSpecFile?: boolean;
     licenseKey?: string;
     writeFilesToRoot?: boolean;
+    sidebarBadgeType?: 'HTTP_METHOD' | 'MESSAGE_TYPE';
+    httpMethodsToMessages?: HTTP_METHOD_TO_MESSAGE_TYPE;
 };
 declare const _default: (_: any, options: Props) => Promise<void>;
 
-export { _default as default };
+export { type HTTP_METHOD, type HTTP_METHOD_TO_MESSAGE_TYPE, _default as default };

package/dist/index.js

@@ -387,7 +387,7 @@ async function getSchemasByOperationId(filePath, operationId) {
     return;
   }
 }
-async function getOperationsByType(openApiPath) {
+async function getOperationsByType(openApiPath, httpMethodsToMessages) {
   try {
     const api = await import_swagger_parser.default.validate(openApiPath);
     const operations = [];
@@ -395,7 +395,8 @@ async function getOperationsByType(openApiPath) {
       const pathItem = api.paths[path3];
       for (const method in pathItem) {
         const openAPIOperation = pathItem[method];
-        const messageType = openAPIOperation["x-eventcatalog-message-type"] || DEFAULT_MESSAGE_TYPE;
+        const defaultMessageType = httpMethodsToMessages?.[method.toUpperCase()] || DEFAULT_MESSAGE_TYPE;
+        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) => {
           if (key.startsWith("x-eventcatalog-")) {
@@ -552,6 +553,7 @@ var buildMessage = async (pathToFile, document, operation) => {
   if (!operation.operationId && path3) {
     uniqueIdentifier = uniqueIdentifier.concat(`_${path3}`);
   }
+  const httpVerb = operation.method.toUpperCase() || "";
   return {
     id: extensions["x-eventcatalog-message-id"] || uniqueIdentifier,
     version: extensions["x-eventcatalog-message-version"] || document.info.version,
@@ -560,7 +562,10 @@ var buildMessage = async (pathToFile, document, operation) => {
     markdown: defaultMarkdown3(operation, requestBodiesAndResponses),
     schemaPath: requestBodiesAndResponses?.requestBody ? "request-body.json" : "",
     badges,
-    requestBodiesAndResponses
+    requestBodiesAndResponses,
+    sidebar: {
+      badge: httpVerb
+    }
   };
 };
 
@@ -619,7 +624,7 @@ var import_chalk = __toESM(require("chalk"));
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "5.0.0",
+  version: "5.0.2",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -655,7 +660,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "^2.0.0",
+    "@eventcatalog/sdk": "^2.0.1",
     chalk: "^4",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -1690,11 +1695,12 @@ Processing domain: ${domainName} (v${domainVersion})`));
   }
 };
 var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, options) => {
-  const operations = await getOperationsByType(pathToSpec);
+  const operations = await getOperationsByType(pathToSpec, options.httpMethodsToMessages);
+  const sidebarBadgeType = options.sidebarBadgeType || "HTTP_METHOD";
   const version = document.info.version;
   let receives = [], sends = [];
   for (const operation of operations) {
-    const { requestBodiesAndResponses, ...message } = await buildMessage(pathToSpec, document, operation);
+    const { requestBodiesAndResponses, sidebar, ...message } = await buildMessage(pathToSpec, document, operation);
     let messageMarkdown = message.markdown;
     const messageType = operation.type;
     const messageAction = operation.action;
@@ -1719,7 +1725,13 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
       messagePath = message.id;
     }
     await writeMessage(
-      { ...message, markdown: messageMarkdown, ...options.owners ? { owners: options.owners } : {} },
+      {
+        ...message,
+        markdown: messageMarkdown,
+        ...options.owners ? { owners: options.owners } : {},
+        // only if its defined add it to the sidebar
+        ...sidebarBadgeType === "HTTP_METHOD" ? { sidebar } : {}
+      },
       { path: messagePath, override: true }
     );
     if (messageAction === "sends") {