@eventcatalog/generator-openapi 7.11.2 → 7.12.1

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.2",
+  version: "7.12.1",
   description: "OpenAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -4453,6 +4453,39 @@ 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 isSkippableSegment = (segment) => /^(api|v\d+)$/i.test(segment);
+var getPathPrefix = (path4) => {
+  const segments = path4.split("/").filter(Boolean);
+  const meaningful = segments.filter((s) => !isSkippableSegment(s));
+  return meaningful.find((s) => !s.startsWith("{"));
+};
+var buildGroupablePrefixes = (operations) => {
+  const prefixToPaths = /* @__PURE__ */ new Map();
+  for (const op of operations) {
+    const prefix = getPathPrefix(op.path);
+    if (!prefix) continue;
+    if (!prefixToPaths.has(prefix)) prefixToPaths.set(prefix, /* @__PURE__ */ new Set());
+    prefixToPaths.get(prefix).add(op.path);
+  }
+  const groupable = /* @__PURE__ */ new Set();
+  for (const [prefix, paths] of prefixToPaths) {
+    if (paths.size >= 2) groupable.add(prefix);
+  }
+  return groupable;
+};
+var getMessageGroup = (operation, groupMessagesBy, groupablePrefixes) => {
+  if (!groupMessagesBy) return void 0;
+  if (groupMessagesBy === "x-extension") {
+    return operation.extensions?.["x-eventcatalog-group"] || void 0;
+  }
+  if (groupMessagesBy === "path-prefix") {
+    const prefix = getPathPrefix(operation.path);
+    if (!prefix) return void 0;
+    if (!groupablePrefixes?.has(prefix)) return void 0;
+    return `/${prefix}`;
+  }
+  return void 0;
+};
 var fetchAuthenticatedSpec = async (specUrl, headers) => {
   const response = await fetch(specUrl, { method: "GET", headers });
   if (!response.ok) {
@@ -4690,9 +4723,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);
@@ -4773,6 +4806,7 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
   const preserveExistingMessages = options.preserveExistingMessages ?? true;
   const parseExamples = options.parseExamples ?? true;
   const isDraft = options.isDraft ?? null;
+  const groupablePrefixes = options.groupMessagesBy === "path-prefix" ? buildGroupablePrefixes(operations) : void 0;
   let receives = [], sends = [];
   let allGeneratedMessages = [];
   for (const operation of operations) {
@@ -4829,16 +4863,16 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document2, servicePath, o
       },
       { path: options.pathForMessages || messagePath, override: true }
     );
+    const group = getMessageGroup(operation, options.groupMessagesBy, groupablePrefixes);
+    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,