@eventcatalog/generator-openapi 7.11.1 → 7.12.0

package/dist/index.d.mts

@@ -16,6 +16,13 @@ type Props = {
     httpMethodsToMessages?: HTTP_METHOD_TO_MESSAGE_TYPE;
     preserveExistingMessages?: boolean;
     parseExamples?: boolean;
+    /**
+     * Group messages in the visualiser by a derived value.
+     * - `'x-extension'`: Use the `x-eventcatalog-group` extension on each operation.
+     * - `'path-prefix'`: Derive the group from the first meaningful URL path segment
+     *    (skips common prefixes like `api`, `v1`, `v2`).
+     */
+    groupMessagesBy?: 'x-extension' | 'path-prefix';
 };
 declare const _default: (_: any, options: Props) => Promise<void>;
 

package/dist/index.d.ts

@@ -16,6 +16,13 @@ type Props = {
     httpMethodsToMessages?: HTTP_METHOD_TO_MESSAGE_TYPE;
     preserveExistingMessages?: boolean;
     parseExamples?: boolean;
+    /**
+     * Group messages in the visualiser by a derived value.
+     * - `'x-extension'`: Use the `x-eventcatalog-group` extension on each operation.
+     * - `'path-prefix'`: Derive the group from the first meaningful URL path segment
+     *    (skips common prefixes like `api`, `v1`, `v2`).
+     */
+    groupMessagesBy?: 'x-extension' | 'path-prefix';
 };
 declare const _default: (_: any, options: Props) => Promise<void>;
 

package/dist/index.js

@@ -4213,7 +4213,7 @@ var import_node_path = require("path");
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-openapi",
-  version: "7.11.1",
+  version: "7.12.0",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -4250,7 +4250,7 @@ var package_default = {
   dependencies: {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@changesets/cli": "^2.27.7",
-    "@eventcatalog/sdk": "^2.18.2",
+    "@eventcatalog/sdk": "^2.18.4",
     chalk: "4.1.2",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -4453,6 +4453,22 @@ var mergeSends = (existing, incoming) => {
 var toUniqueArray = (array) => {
   return array.filter((item, index, self) => index === self.findIndex((t) => t.id === item.id && t.version === item.version));
 };
+var SKIP_PATH_SEGMENTS = /* @__PURE__ */ new Set(["api", "v1", "v2", "v3", "v4", "v5"]);
+var getMessageGroup = (operation, groupMessagesBy) => {
+  if (!groupMessagesBy) return void 0;
+  if (groupMessagesBy === "x-extension") {
+    return operation.extensions?.["x-eventcatalog-group"] || void 0;
+  }
+  if (groupMessagesBy === "path-prefix") {
+    const allSegments = operation.path.split("/").filter(Boolean);
+    const meaningfulSegments = allSegments.filter((s) => !SKIP_PATH_SEGMENTS.has(s.toLowerCase()));
+    if (meaningfulSegments.length < 2) return void 0;
+    const prefix = meaningfulSegments.find((s) => !s.startsWith("{"));
+    if (!prefix) return void 0;
+    return prefix.charAt(0).toUpperCase() + prefix.slice(1).toLowerCase();
+  }
+  return void 0;
+};
 var fetchAuthenticatedSpec = async (specUrl, headers) => {
   const response = await fetch(specUrl, { method: "GET", headers });
   if (!response.ok) {
@@ -4613,6 +4629,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
       let repository = null;
       let styles2 = null;
       let serviceDiagrams = null;
+      let serviceFlows = null;
+      let serviceEntities = null;
       let serviceWritesTo = configuredWritesTo;
       let serviceReadsFrom = configuredReadsFrom;
       const persistPreviousSpecificationFiles = Array.isArray(serviceSpec.path) === false;
@@ -4626,6 +4644,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
         serviceBadges = latestServiceInCatalog.badges || null;
         serviceAttachments = latestServiceInCatalog.attachments || null;
         serviceDiagrams = latestServiceInCatalog.diagrams || null;
+        serviceFlows = latestServiceInCatalog.flows || null;
+        serviceEntities = latestServiceInCatalog.entities || null;
         serviceWritesTo = latestServiceInCatalog.writesTo || [];
         serviceReadsFrom = latestServiceInCatalog.readsFrom || [];
         if (persistPreviousSpecificationFiles) {
@@ -4656,6 +4676,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
           ...repository ? { repository } : {},
           ...styles2 ? { styles: styles2 } : {},
           ...serviceDiagrams ? { diagrams: serviceDiagrams } : {},
+          ...serviceFlows ? { flows: serviceFlows } : {},
+          ...serviceEntities ? { entities: serviceEntities } : {},
           ...isServiceMarkedAsDraft ? { draft: true } : {},
           ...serviceAttachments ? { attachments: serviceAttachments } : {},
           ...serviceWritesTo.length > 0 ? { writesTo: serviceWritesTo } : {},
@@ -4684,9 +4706,9 @@ Processing domain: ${domainName} (v${domainVersion})`));
       console.log(import_chalk4.default.cyan(` - Service (v${version}) created`));
       const consumers = serviceSpec.consumers || [];
       for (const consumer of consumers) {
-        const consumerVersion = consumer.version || "1.0.0";
         const filteredSends = filterMessagesByRoutes(allGeneratedMessages, consumer.routes);
-        const existingConsumer = await getService(consumer.id, consumerVersion);
+        const existingConsumer = await getService(consumer.id, consumer.version || "latest");
+        const consumerVersion = consumer.version || existingConsumer?.version || "1.0.0";
         if (existingConsumer) {
           const mergedSends = mergeSends(existingConsumer.sends || [], filteredSends);
           const consumerResource = await getResourcePath(process.env.PROJECT_DIR, consumer.id, consumerVersion);
@@ -4823,16 +4845,16 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
       },
       { path: options.pathForMessages || messagePath, override: true }
     );
+    const group = getMessageGroup(operation, options.groupMessagesBy);
+    const pointer = {
+      id: message2.id,
+      version: message2.version,
+      ...group ? { group } : {}
+    };
     if (messageAction === "sends") {
-      sends.push({
-        id: message2.id,
-        version: message2.version
-      });
+      sends.push(pointer);
     } else {
-      receives.push({
-        id: message2.id,
-        version: message2.version
-      });
+      receives.push(pointer);
     }
     allGeneratedMessages.push({
       id: message2.id,