@eventcatalog/core 5.0.0 → 5.0.2

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/index.astro

@@ -2,7 +2,7 @@
 import { render } from 'astro:content';
 
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
-import Admonition from '@components/MDX/Admonition';
+import NewVersionBanner from '@components/NewVersionBanner.astro';
 import components from '@components/MDX/components';
 import CopyAsMarkdown from '@components/CopyAsMarkdown';
 import Badge from '@components/Badge.astro';
@@ -11,7 +11,7 @@ import { AlignLeftIcon, HistoryIcon } from 'lucide-react';
 import { isEventCatalogChatVisible, isMarkdownDownloadEnabled } from '@utils/feature';
 import { getResourceDocTypeLabel } from '@utils/collections/resource-docs';
 import { getIcon } from '@utils/badges';
-import { collectionToResourceMap } from '@utils/collections/util';
+import { getResourceNoun } from '@utils/collections/util';
 
 import { Page } from './_index.data';
 
@@ -31,9 +31,7 @@ const badges = (props.data.badges || []).map((badge: any) => ({
 }));
 
 const docsBasePath = `/docs/${props.data.resourceCollection}/${props.data.resourceId}/${props.data.resourceVersion}/${encodeURIComponent(props.data.type)}/${encodeURIComponent(props.data.id)}`;
-const singularResourceName =
-  collectionToResourceMap[props.data.resourceCollection as keyof typeof collectionToResourceMap] ??
-  props.data.resourceCollection.slice(0, props.data.resourceCollection.length - 1);
+const singularResourceName = getResourceNoun(props.data.resourceCollection);
 const chatEnabled = isEventCatalogChatVisible();
 const chatQuery = `Tell me about the ${props.data.type} doc "${title}" for ${props.data.resourceId} (version ${props.data.version})`;
 
@@ -89,14 +87,13 @@ const pagefindAttributes =
         <div data-pagefind-ignore>
           {
             props.data.version !== props.data.latestVersion && (
-              <Admonition type="warning" title="New version found">
-                <p>
-                  You are looking at a previous version of the {singularResourceName} doc <strong>{title}</strong>.{' '}
-                  <a class="underline block pt-2" href={buildUrl(`${docsBasePath}/${props.data.latestVersion}`)}>
-                    The latest version of this doc is <span>v{props.data.latestVersion}</span> &rarr;
-                  </a>
-                </p>
-              </Admonition>
+              <NewVersionBanner
+                subject={`${singularResourceName} doc`}
+                name={title}
+                latestOf="doc"
+                latestVersion={props.data.latestVersion}
+                href={buildUrl(`${docsBasePath}/${props.data.latestVersion}`)}
+              />
             )
           }
         </div>

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/index.astro

@@ -2,7 +2,7 @@
 import { render } from 'astro:content';
 
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
-import Admonition from '@components/MDX/Admonition';
+import NewVersionBanner from '@components/NewVersionBanner.astro';
 import components from '@components/MDX/components';
 import CopyAsMarkdown from '@components/CopyAsMarkdown';
 import Badge from '@components/Badge.astro';
@@ -10,7 +10,7 @@ import { buildUrl } from '@utils/url-builder';
 import { AlignLeftIcon, HistoryIcon } from 'lucide-react';
 import { isEventCatalogChatVisible, isMarkdownDownloadEnabled } from '@utils/feature';
 import { getIcon } from '@utils/badges';
-import { collectionToResourceMap } from '@utils/collections/util';
+import { getResourceNoun } from '@utils/collections/util';
 import { getResourceDocTypeLabel } from '@utils/collections/resource-docs';
 
 import { Page } from './_index.data';
@@ -31,9 +31,7 @@ const badges = (props.data.badges || []).map((badge: any) => ({
 }));
 
 const docsBasePath = `/docs/${props.data.resourceCollection}/${props.data.resourceId}/${props.data.resourceVersion}/${encodeURIComponent(props.data.type)}/${encodeURIComponent(props.data.id)}`;
-const singularResourceName =
-  collectionToResourceMap[props.data.resourceCollection as keyof typeof collectionToResourceMap] ??
-  props.data.resourceCollection.slice(0, props.data.resourceCollection.length - 1);
+const singularResourceName = getResourceNoun(props.data.resourceCollection);
 const typeLabel = getResourceDocTypeLabel(props.data.type);
 const chatEnabled = isEventCatalogChatVisible();
 const chatQuery = `Tell me about the ${props.data.type} doc "${title}" for ${props.data.resourceId} (version ${props.data.version})`;
@@ -88,14 +86,13 @@ const pagefindAttributes =
         <div data-pagefind-ignore>
           {
             props.data.version !== props.data.latestVersion && (
-              <Admonition type="warning" title="New version found">
-                <p>
-                  You are looking at a previous version of the {singularResourceName} doc <strong>{title}</strong>.{' '}
-                  <a class="underline block pt-2" href={buildUrl(`${docsBasePath}/${props.data.latestVersion}`)}>
-                    The latest version of this doc is <span>v{props.data.latestVersion}</span> &rarr;
-                  </a>
-                </p>
-              </Admonition>
+              <NewVersionBanner
+                subject={`${singularResourceName} doc`}
+                name={title}
+                latestOf="doc"
+                latestVersion={props.data.latestVersion}
+                href={buildUrl(`${docsBasePath}/${props.data.latestVersion}`)}
+              />
             )
           }
         </div>

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/graphql/[filename].astro

@@ -8,9 +8,10 @@ import { Page } from './_[filename].data';
 import { getAbsoluteFilePathForAstroFile } from '@utils/files';
 import { buildUrl, buildEditUrlForResource } from '@utils/url-builder';
 import Admonition from '@components/MDX/Admonition';
+import NewVersionBanner from '@components/NewVersionBanner.astro';
 import Badge from '@components/Badge.astro';
-
-import { ServerIcon } from '@heroicons/react/24/outline';
+import { getResourceTypeBadge } from '@utils/collections/resource-type-badge';
+import { getResourceNoun } from '@utils/collections/util';
 
 export const prerender = Page.prerender;
 export const getStaticPaths = Page.getStaticPaths;
@@ -38,9 +39,8 @@ if (isRemote) {
 // Create comprehensive page title
 const pageTitle = `${collection} | ${data.name} | GraphQL Schema`.replace(/^\w/, (c) => c.toUpperCase());
 
-const getServiceBadge = () => {
-  return [{ textColor: 'gray', content: 'Service', icon: ServerIcon }];
-};
+// The schema belongs to a service, event, command, query or domain
+const getResourceBadge = () => [getResourceTypeBadge(collection)];
 
 const getGraphQLBadge = () => {
   return [
@@ -53,7 +53,7 @@ const getGraphQLBadge = () => {
   ];
 };
 
-const badges = [...getServiceBadge(), ...getGraphQLBadge()];
+const badges = [...getResourceBadge(), ...getGraphQLBadge()];
 
 // Index only the latest version
 const pagefindAttributes =
@@ -96,18 +96,13 @@ const pagefindAttributes =
         <div data-pagefind-ignore>
           {
             data.version !== data.latestVersion && (
-              <Admonition type="warning" title="New version found">
-                <p>
-                  You are looking at a previous version of the service <strong>{data.name}</strong>.{' '}
-                  <a
-                    class="underline block pt-2"
-                    href={buildUrl(`/docs/${collection}/${data.id}/${data.latestVersion}/graphql/${filename}`)}
-                  >
-                    The latest version of this GraphQL schema is
-                    <span>v{data.latestVersion}</span> &rarr;
-                  </a>
-                </p>
-              </Admonition>
+              <NewVersionBanner
+                subject={getResourceNoun(collection)}
+                name={data.name}
+                latestOf="GraphQL schema"
+                latestVersion={data.latestVersion}
+                href={buildUrl(`/docs/${collection}/${data.id}/${data.latestVersion}/graphql/${filename}`)}
+              />
             )
           }
         </div>

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/index.astro

@@ -13,6 +13,7 @@ import NodeGraph from '@components/MDX/NodeGraph/NodeGraph.astro';
 import ArchitectureGraph from '@components/MDX/ArchitectureGraph/ArchitectureGraph.astro';
 import SchemaViewer from '@components/MDX/SchemaViewer/SchemaViewerRoot.astro';
 import Admonition from '@components/MDX/Admonition';
+import NewVersionBanner from '@components/NewVersionBanner.astro';
 import VersionList from '@components/Lists/VersionList.astro';
 import CopyAsMarkdown from '@components/CopyAsMarkdown';
 import FavoriteButton from '@components/FavoriteButton';
@@ -46,7 +47,12 @@ import {
 } from 'lucide-react';
 
 import { getSpecificationsForService } from '@utils/collections/services';
-import { resourceToCollectionMap, collectionToResourceMap, getDeprecatedDetails } from '@utils/collections/util';
+import {
+  resourceToCollectionMap,
+  collectionToResourceMap,
+  getDeprecatedDetails,
+  getResourceNoun,
+} from '@utils/collections/util';
 import {
   createAdrStatusBadge,
   formatAdrDate,
@@ -305,16 +311,13 @@ const {
   deprecatedDate: formattedDate,
 } = getDeprecatedDetails(props as unknown as CollectionEntry<CollectionTypes>);
 
-let friendlyCollectionName = props.collection.slice(0, props.collection.length - 1);
-friendlyCollectionName = friendlyCollectionName === 'querie' ? 'query' : friendlyCollectionName;
-friendlyCollectionName = friendlyCollectionName === 'entitie' ? 'entity' : friendlyCollectionName;
-friendlyCollectionName = friendlyCollectionName === 'adr' ? 'architecture decision' : friendlyCollectionName;
+const friendlyCollectionName = getResourceNoun(props.collection);
 
 const schemasForResource = getSchemasFromResource(props);
 
 const generatePromptForResource = (props: any) => {
   return `
-    Please tell me more about the ${props.collection.slice(0, props.collection.length - 1)} -  ${props.data.name} v${props.data.version} in this catalog.
+    Please tell me more about the ${friendlyCollectionName} -  ${props.data.name} v${props.data.version} in this catalog.
   `;
 };
 
@@ -596,19 +599,13 @@ if (!isAdrPage && !hasCurrentFlowEmbed && !hasCurrentPageNodeGraph) {
         <div data-pagefind-ignore>
           {
             props.data.version !== props.data.latestVersion && (
-              <Admonition type="warning" title="New version found">
-                <p>
-                  You are looking at a previous version of the {props.collection.slice(0, props.collection.length - 1)}{' '}
-                  <strong>{props.data.name}</strong>.{' '}
-                  <a
-                    class="underline block pt-2"
-                    href={buildUrl(`/docs/${props.collection}/${props.data.id}/${props.data.latestVersion}`)}
-                  >
-                    The latest version of this {props.collection.slice(0, props.collection.length - 1)} is
-                    <span>v{props.data.latestVersion}</span> &rarr;
-                  </a>
-                </p>
-              </Admonition>
+              <NewVersionBanner
+                subject={friendlyCollectionName}
+                name={props.data.name}
+                latestOf={friendlyCollectionName}
+                latestVersion={props.data.latestVersion}
+                href={buildUrl(`/docs/${props.collection}/${props.data.id}/${props.data.latestVersion}`)}
+              />
             )
           }
         </div>

package/eventcatalog/src/utils/collections/resource-type-badge.ts

@@ -0,0 +1,9 @@
+import { getIconForCollection } from '@utils/collections/icons';
+import { getResourceTypeLabel } from '@utils/collections/util';
+
+/** A badge naming a resource's type, with its icon (e.g. on a GraphQL schema page, the resource it belongs to) */
+export const getResourceTypeBadge = (collection: string) => ({
+  textColor: 'gray',
+  content: getResourceTypeLabel(collection),
+  icon: getIconForCollection(collection),
+});

package/eventcatalog/src/utils/collections/util.ts

@@ -227,6 +227,16 @@ export const getResourceTypeLabel = (collection: string): string => {
     .join(' ');
 };
 
+/**
+ * What a resource in a collection is called in a sentence, e.g. "a previous version of the query".
+ * e.g. 'queries' → 'query', 'data-products' → 'data product', 'adrs' → 'architecture decision'
+ */
+export const getResourceNoun = (collection: string): string => {
+  if (collection === 'adrs') return 'architecture decision';
+  const raw = (collectionToResourceMap as Record<string, string>)[collection] || collection;
+  return raw.replace(/-/g, ' ');
+};
+
 /**
  * Returns the correct pointer field name for a collection and direction.
  * Data-products use 'outputs'/'inputs' instead of 'sends'/'receives'.

package/eventcatalog/src/utils/version-banner.ts

@@ -0,0 +1,10 @@
+/**
+ * The sentences on the "New version found" banner (components/NewVersionBanner.astro), shown on a previous version of a
+ * page. Each ends with the space before what follows it (the name, then the version), so the markup can't lose it.
+ */
+export const getVersionBannerText = ({ subject, latestOf }: { subject: string; latestOf: string }) => ({
+  /** Followed by the name of what this page is a version of, e.g. "...of the query " Get Orders */
+  previous: `You are looking at a previous version of the ${subject} `,
+  /** Followed by the latest version, e.g. "...of this query is " v2.0.0 */
+  latest: `The latest version of this ${latestOf} is `,
+});

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "BUSL-1.1",
   "type": "module",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "publishConfig": {
     "access": "public"
   },
@@ -66,7 +66,7 @@
     "@mcp-b/webmcp-polyfill": "5.1.0",
     "@mermaid-js/layout-elk": "^0.2.0",
     "@modelcontextprotocol/ext-apps": "^1.7.5",
-    "@modelcontextprotocol/sdk": "^1.30.0",
+    "@modelcontextprotocol/sdk": "^1.32.0",
     "@nanostores/react": "^1.0.0",
     "@parcel/watcher": "^2.4.1",
     "@radix-ui/react-context-menu": "^2.2.6",
@@ -140,9 +140,9 @@
     "y-protocols": "^1.0.7",
     "yjs": "^13.6.33",
     "zod": "^4.6.6",
-    "@eventcatalog/linter": "1.2.0",
-    "@eventcatalog/sdk": "2.30.0",
-    "@eventcatalog/visualiser": "^5.0.0"
+    "@eventcatalog/linter": "1.2.1",
+    "@eventcatalog/visualiser": "^5.0.0",
+    "@eventcatalog/sdk": "2.30.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.10",