@eventcatalog/core 3.41.4 → 3.43.0

package/dist/analytics/analytics.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(analytics_exports);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-VQLDZRHC.js";
-import "../chunk-OH2U6UEJ.js";
+} from "../chunk-2EI3M7OO.js";
+import "../chunk-KY74BE42.js";
 export {
   raiseEvent
 };

package/dist/analytics/count-resources.cjs

@@ -26,6 +26,7 @@ __export(count_resources_exports, {
 module.exports = __toCommonJS(count_resources_exports);
 var import_glob = require("glob");
 var RESOURCE_PATTERNS = {
+  adrs: ["**/adrs/*/index.@(md|mdx)"],
   agents: ["**/agents/*/index.@(md|mdx)"],
   events: ["**/events/*/index.@(md|mdx)"],
   commands: ["**/commands/*/index.@(md|mdx)"],

package/dist/analytics/count-resources.js

@@ -1,7 +1,7 @@
 import {
   countResources,
   serializeCounts
-} from "../chunk-3DVHEVHQ.js";
+} from "../chunk-DAOXTQVS.js";
 export {
   countResources,
   serializeCounts

package/dist/analytics/log-build.cjs

@@ -110,7 +110,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;
@@ -149,6 +149,7 @@ async function raiseEvent(eventData) {
 // src/analytics/count-resources.js
 var import_glob = require("glob");
 var RESOURCE_PATTERNS = {
+  adrs: ["**/adrs/*/index.@(md|mdx)"],
   agents: ["**/agents/*/index.@(md|mdx)"],
   events: ["**/events/*/index.@(md|mdx)"],
   commands: ["**/commands/*/index.@(md|mdx)"],
@@ -196,6 +197,7 @@ var getFeatures = async (configFile) => {
 };
 var CLOUD_ANALYTICS_ENDPOINT = "https://api.ecingest.dev/v1/analytics/ingest";
 var toCloudResourceCounts = (counts) => ({
+  adrs: counts.adrs || 0,
   agents: counts.agents || 0,
   domains: counts.domains || 0,
   services: counts.services || 0,

package/dist/analytics/log-build.js

@@ -1,9 +1,9 @@
 import {
   log_build_default
-} from "../chunk-LYRAK5LI.js";
-import "../chunk-VQLDZRHC.js";
-import "../chunk-3DVHEVHQ.js";
-import "../chunk-OH2U6UEJ.js";
+} from "../chunk-QV2PKXZM.js";
+import "../chunk-2EI3M7OO.js";
+import "../chunk-DAOXTQVS.js";
+import "../chunk-KY74BE42.js";
 import "../chunk-5T63CXKU.js";
 export {
   log_build_default as default

package/dist/{chunk-VQLDZRHC.js → chunk-2EI3M7OO.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-OH2U6UEJ.js";
+} from "./chunk-KY74BE42.js";
 
 // src/analytics/analytics.js
 import os from "os";

package/dist/{chunk-COPXPOV2.js → chunk-7M5IQL3J.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-OH2U6UEJ.js";
+} from "./chunk-KY74BE42.js";
 
 // src/utils/cli-logger.ts
 import pc from "picocolors";

package/dist/{chunk-3DVHEVHQ.js → chunk-DAOXTQVS.js}

@@ -1,6 +1,7 @@
 // src/analytics/count-resources.js
 import { glob } from "glob";
 var RESOURCE_PATTERNS = {
+  adrs: ["**/adrs/*/index.@(md|mdx)"],
   agents: ["**/agents/*/index.@(md|mdx)"],
   events: ["**/events/*/index.@(md|mdx)"],
   commands: ["**/commands/*/index.@(md|mdx)"],

package/dist/{chunk-OH2U6UEJ.js → chunk-KY74BE42.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/{chunk-LYRAK5LI.js → chunk-QV2PKXZM.js}

@@ -1,10 +1,10 @@
 import {
   raiseEvent
-} from "./chunk-VQLDZRHC.js";
+} from "./chunk-2EI3M7OO.js";
 import {
   countResources,
   serializeCounts
-} from "./chunk-3DVHEVHQ.js";
+} from "./chunk-DAOXTQVS.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile
@@ -21,6 +21,7 @@ var getFeatures = async (configFile) => {
 };
 var CLOUD_ANALYTICS_ENDPOINT = "https://api.ecingest.dev/v1/analytics/ingest";
 var toCloudResourceCounts = (counts) => ({
+  adrs: counts.adrs || 0,
   agents: counts.agents || 0,
   domains: counts.domains || 0,
   services: counts.services || 0,

package/dist/{chunk-QMORF42U.js → chunk-ZONBICNH.js}

@@ -4,6 +4,7 @@ import path from "path";
 import { glob } from "glob";
 import matter from "gray-matter";
 var RESOURCE_COLLECTIONS = {
+  adrs: { docsPath: "adrs", type: "Architecture Decision" },
   agents: { docsPath: "agents", type: "Agent" },
   channels: { docsPath: "channels", type: "Channel" },
   commands: { docsPath: "commands", type: "Command" },
@@ -68,6 +69,9 @@ var findResourceSegment = (segments) => {
   let match = null;
   for (let index = 0; index < segments.length - 1; index++) {
     const segment = segments[index];
+    if (segments[index - 1] === "docs") {
+      continue;
+    }
     if (RESOURCE_COLLECTIONS[segment] && segments[index + 1]) {
       match = { index, segment };
     }
@@ -234,6 +238,10 @@ var collectSearchRecords = async ({
         summary: baseRecord.summary,
         version: baseRecord.version,
         owners: parsed.data.owners,
+        status: parsed.data.status,
+        date: parsed.data.date,
+        decisionMakers: parsed.data.decisionMakers,
+        appliesTo: parsed.data.appliesTo,
         badges: parsed.data.badges
       });
       const content = [frontmatterText, markdownToSearchText(parsed.content)].filter(Boolean).join("\n\n");

package/dist/{chunk-YWG7CCN7.js → chunk-ZQHBDPIY.js}

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-COPXPOV2.js";
+} from "./chunk-7M5IQL3J.js";
 import {
   cleanup,
   getEventCatalogConfigFile

package/dist/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-OH2U6UEJ.js";
+} from "./chunk-KY74BE42.js";
 export {
   VERSION
 };

package/dist/docs/development/developer-tools/api-catalog.md

@@ -0,0 +1,114 @@
+---
+sidebar_position: 5
+keywords:
+- api-catalog
+- RFC 9727
+- well-known
+- API discovery
+- OpenAPI
+- AsyncAPI
+- GraphQL
+sidebar_label: api-catalog (RFC 9727)
+title: api-catalog
+description: Machine-readable catalog discovery endpoint for tools and agents
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+
+<AddedIn version="3.42.0" />
+
+Let API tools, agents, and crawlers discover every service and domain specification in your catalog from a single endpoint, without parsing HTML.
+
+### What is RFC 9727?
+
+[RFC 9727](https://datatracker.ietf.org/doc/rfc9727/) defines the `/.well-known/api-catalog` well-known URI. It returns a [Linkset](https://www.rfc-editor.org/rfc/rfc9264) document that lists every API an organization publishes along with links to their specifications and documentation.
+
+Tools that understand RFC 9727 can point at your catalog URL and immediately enumerate all services and domains, their OpenAPI, AsyncAPI, and GraphQL specs, and their documentation pages. No scraping required.
+
+### How it works
+
+EventCatalog automatically publishes a Linkset at `/.well-known/api-catalog`. Every service and domain that has `specifications` defined in its frontmatter appears as an entry.
+
+Each entry contains:
+
+- **`anchor`** - the canonical URL of the service. EventCatalog reads the `servers[].url` field from OpenAPI or AsyncAPI specs and uses that. When no server URL is found it falls back to the EventCatalog documentation page.
+- **`service-desc`** - one link per specification file, pointing at `/api-catalog/specifications/{collection}/{id}/{version}/{specification}` with the correct media type (`application/yaml`, `application/json`, or `application/graphql`).
+- **`service-doc`** - two links per resource: the markdown source and the rendered HTML page.
+
+Resources marked `hidden: true` are excluded from the linkset.
+
+### Access the endpoint
+
+```
+GET  /.well-known/api-catalog
+HEAD /.well-known/api-catalog
+```
+
+The `GET` response body is `application/linkset+json` profiled against RFC 9727:
+
+```json
+{
+  "linkset": [
+    {
+      "anchor": "https://api.example.com/orders",
+      "service-desc": [
+        {
+          "href": "https://catalog.example.com/api-catalog/specifications/services/OrderService/1.0.0/openapi-b3BlbmFwaS55bWw",
+          "type": "application/yaml",
+          "title": "Order Service OpenAPI"
+        }
+      ],
+      "service-doc": [
+        {
+          "href": "https://catalog.example.com/docs/services/OrderService/1.0.0.md",
+          "type": "text/markdown",
+          "title": "Order Service documentation"
+        },
+        {
+          "href": "https://catalog.example.com/docs/services/OrderService/1.0.0",
+          "type": "text/html",
+          "title": "Order Service documentation"
+        }
+      ]
+    }
+  ]
+}
+```
+
+The `HEAD` response includes a `Link` header so clients can confirm the endpoint exists before fetching the full body:
+
+```
+Link: <https://catalog.example.com/.well-known/api-catalog>; rel="api-catalog"
+```
+
+### Fetch a specification file
+
+The raw specification files referenced in `service-desc` are served from:
+
+```
+GET /api-catalog/specifications/{collection}/{id}/{version}/{specification}
+```
+
+| Segment | Values |
+|---------|--------|
+| `collection` | `services`, `domains` |
+| `id` | The resource `id` field |
+| `version` | The resource `version` field |
+| `specification` | Stable specification identifier, formatted as `{type}-{base64url(path)}` |
+
+Example:
+
+```
+GET /api-catalog/specifications/services/OrderService/1.0.0/openapi-b3BlbmFwaS55bWw
+Content-Type: application/yaml
+```
+
+### MCP server entry
+
+When the EventCatalog MCP server is enabled, an additional entry pointing at `/docs/mcp` is appended to the linkset. This lets MCP-aware agents discover the catalog's machine interface alongside its API specifications.
+
+### What is included
+
+Only services and domains are included in v1 of this endpoint. Events, commands, queries, data products, schemas, diagrams, teams, and users are out of scope for this release.
+
+For a broader machine-readable index of your catalog content, see [llms.txt](/docs/development/developer-tools/llms.txt) and [schemas.txt](/docs/development/developer-tools/schemas.txt).

package/dist/eventcatalog.cjs

@@ -114,7 +114,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;
@@ -244,6 +244,7 @@ async function raiseEvent(eventData) {
 // src/analytics/count-resources.js
 var import_glob = require("glob");
 var RESOURCE_PATTERNS = {
+  adrs: ["**/adrs/*/index.@(md|mdx)"],
   agents: ["**/agents/*/index.@(md|mdx)"],
   events: ["**/events/*/index.@(md|mdx)"],
   commands: ["**/commands/*/index.@(md|mdx)"],
@@ -291,6 +292,7 @@ var getFeatures = async (configFile) => {
 };
 var CLOUD_ANALYTICS_ENDPOINT = "https://api.ecingest.dev/v1/analytics/ingest";
 var toCloudResourceCounts = (counts) => ({
+  adrs: counts.adrs || 0,
   agents: counts.agents || 0,
   domains: counts.domains || 0,
   services: counts.services || 0,
@@ -1332,6 +1334,7 @@ var import_node_path8 = __toESM(require("path"), 1);
 var import_glob4 = require("glob");
 var import_gray_matter4 = __toESM(require("gray-matter"), 1);
 var RESOURCE_COLLECTIONS = {
+  adrs: { docsPath: "adrs", type: "Architecture Decision" },
   agents: { docsPath: "agents", type: "Agent" },
   channels: { docsPath: "channels", type: "Channel" },
   commands: { docsPath: "commands", type: "Command" },
@@ -1396,6 +1399,9 @@ var findResourceSegment = (segments) => {
   let match = null;
   for (let index = 0; index < segments.length - 1; index++) {
     const segment = segments[index];
+    if (segments[index - 1] === "docs") {
+      continue;
+    }
     if (RESOURCE_COLLECTIONS[segment] && segments[index + 1]) {
       match = { index, segment };
     }
@@ -1562,6 +1568,10 @@ var collectSearchRecords = async ({
         summary: baseRecord.summary,
         version: baseRecord.version,
         owners: parsed.data.owners,
+        status: parsed.data.status,
+        date: parsed.data.date,
+        decisionMakers: parsed.data.decisionMakers,
+        appliesTo: parsed.data.appliesTo,
         badges: parsed.data.badges
       });
       const content = [frontmatterText, markdownToSearchText(parsed.content)].filter(Boolean).join("\n\n");

package/dist/eventcatalog.js

@@ -7,15 +7,15 @@ import {
 } from "./chunk-WAJIJEI3.js";
 import {
   buildSearchIndex
-} from "./chunk-QMORF42U.js";
+} from "./chunk-ZONBICNH.js";
 import {
   watch
 } from "./chunk-3H2RT3CM.js";
 import {
   log_build_default
-} from "./chunk-LYRAK5LI.js";
-import "./chunk-VQLDZRHC.js";
-import "./chunk-3DVHEVHQ.js";
+} from "./chunk-QV2PKXZM.js";
+import "./chunk-2EI3M7OO.js";
+import "./chunk-DAOXTQVS.js";
 import {
   catalogToAstro
 } from "./chunk-O6KT4DPL.js";
@@ -28,13 +28,13 @@ import {
 } from "./chunk-ULZYHF3V.js";
 import {
   generate
-} from "./chunk-YWG7CCN7.js";
+} from "./chunk-ZQHBDPIY.js";
 import {
   logger
-} from "./chunk-COPXPOV2.js";
+} from "./chunk-7M5IQL3J.js";
 import {
   VERSION
-} from "./chunk-OH2U6UEJ.js";
+} from "./chunk-KY74BE42.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/generate.cjs

@@ -78,7 +78,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-YWG7CCN7.js";
-import "./chunk-COPXPOV2.js";
-import "./chunk-OH2U6UEJ.js";
+} from "./chunk-ZQHBDPIY.js";
+import "./chunk-7M5IQL3J.js";
+import "./chunk-KY74BE42.js";
 import "./chunk-5T63CXKU.js";
 export {
   generate

package/dist/search-indexer.cjs

@@ -40,6 +40,7 @@ var import_node_path = __toESM(require("path"), 1);
 var import_glob = require("glob");
 var import_gray_matter = __toESM(require("gray-matter"), 1);
 var RESOURCE_COLLECTIONS = {
+  adrs: { docsPath: "adrs", type: "Architecture Decision" },
   agents: { docsPath: "agents", type: "Agent" },
   channels: { docsPath: "channels", type: "Channel" },
   commands: { docsPath: "commands", type: "Command" },
@@ -104,6 +105,9 @@ var findResourceSegment = (segments) => {
   let match = null;
   for (let index = 0; index < segments.length - 1; index++) {
     const segment = segments[index];
+    if (segments[index - 1] === "docs") {
+      continue;
+    }
     if (RESOURCE_COLLECTIONS[segment] && segments[index + 1]) {
       match = { index, segment };
     }
@@ -270,6 +274,10 @@ var collectSearchRecords = async ({
         summary: baseRecord.summary,
         version: baseRecord.version,
         owners: parsed.data.owners,
+        status: parsed.data.status,
+        date: parsed.data.date,
+        decisionMakers: parsed.data.decisionMakers,
+        appliesTo: parsed.data.appliesTo,
         badges: parsed.data.badges
       });
       const content = [frontmatterText, markdownToSearchText(parsed.content)].filter(Boolean).join("\n\n");

package/dist/search-indexer.js

@@ -2,7 +2,7 @@ import {
   buildSearchIndex,
   collectSearchRecords,
   markdownToSearchText
-} from "./chunk-QMORF42U.js";
+} from "./chunk-ZONBICNH.js";
 export {
   buildSearchIndex,
   collectSearchRecords,

package/dist/utils/cli-logger.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(cli_logger_exports);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "3.41.4";
+var version = "3.43.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

@@ -1,7 +1,7 @@
 import {
   logger
-} from "../chunk-COPXPOV2.js";
-import "../chunk-OH2U6UEJ.js";
+} from "../chunk-7M5IQL3J.js";
+import "../chunk-KY74BE42.js";
 export {
   logger
 };

package/eventcatalog/src/components/MDX/Attachments.astro

@@ -19,13 +19,13 @@ interface Props {
   title?: string;
   description?: string;
   columns?: number;
-  data: {
-    attachments: Attachment[];
+  data?: {
+    attachments?: Attachment[];
   };
 }
 
 const { title = 'Attachments', description, columns = 2, ...props } = Astro.props;
-const { attachments } = props.data;
+const attachments = props.data?.attachments ?? [];
 
 function getIconForAttachment(attachment: AttachmentObject): ComponentType<{ className?: string }> | null {
   // If custom icon is provided, try to find it

package/eventcatalog/src/components/SideNav/NestedSideBar/index.tsx

@@ -221,6 +221,8 @@ export default function NestedSideBar() {
         // Agents
         { pattern: /^\/docs\/agents\/([^/]+)\/([^/]+)/, type: 'agent' },
         { pattern: /^\/visualiser\/agents\/([^/]+)\/([^/]+)/, type: 'agent' },
+        // Decision Records
+        { pattern: /^\/docs\/adrs\/([^/]+)\/([^/]+)/, type: 'adr' },
         // Services
         { pattern: /^\/docs\/services\/([^/]+)\/([^/]+)/, type: 'service' },
         { pattern: /^\/architecture\/services\/([^/]+)\/([^/]+)/, type: 'service' },
@@ -503,6 +505,13 @@ export default function NestedSideBar() {
     [favorites]
   );
 
+  const urlsMatch = useCallback((left: string | undefined, right: string | undefined) => {
+    if (!left || !right) return false;
+    return stripBasePath(left).replace(/\/$/, '') === stripBasePath(right).replace(/\/$/, '');
+  }, []);
+
+  const activeNodeKey = useMemo(() => findNodeKeyByUrl(currentPath), [currentPath, findNodeKeyByUrl]);
+
   // Show loading state if no data yet
   if (!data || roots.length === 0) {
     return (
@@ -838,7 +847,7 @@ export default function NestedSideBar() {
    */
   const renderItem = (item: NavNode, itemKey: string | null, index: number) => {
     const itemHasChildren = hasChildren(item);
-    const isActive = item.href && currentPath === item.href;
+    const isActive = urlsMatch(item.href, currentPath) || (itemKey !== null && itemKey === activeNodeKey);
     const isFav = isFavorited(itemKey);
     const canFavorite = itemKey !== null; // Only items with keys can be favorited
 
@@ -925,7 +934,7 @@ export default function NestedSideBar() {
         key={`item-${itemKey || index}`}
         title={item.title}
         onClick={() => handleDrillDown(item, itemKey)}
-        className={cn(baseClasses, parentClasses)}
+        className={cn(baseClasses, parentClasses, activeClasses)}
       >
         {content}
       </button>