@eventcatalog/core 2.35.9 → 2.36.0

package/dist/analytics/analytics.cjs

@@ -37,7 +37,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.35.9";
+var version = "2.36.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-KEOGLT6Y.js";
-import "../chunk-RKOF335E.js";
+} from "../chunk-J5VDZAYA.js";
+import "../chunk-4UMY62TN.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -106,7 +106,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.35.9";
+var version = "2.36.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-K2XHQGHN.js";
-import "../chunk-KEOGLT6Y.js";
-import "../chunk-RKOF335E.js";
+} from "../chunk-56VOUKDM.js";
+import "../chunk-J5VDZAYA.js";
+import "../chunk-4UMY62TN.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-RKOF335E.js → chunk-4UMY62TN.js}

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

package/dist/{chunk-K2XHQGHN.js → chunk-56VOUKDM.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-KEOGLT6Y.js";
+} from "./chunk-J5VDZAYA.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/{chunk-KEOGLT6Y.js → chunk-J5VDZAYA.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-RKOF335E.js";
+} from "./chunk-4UMY62TN.js";
 
 // src/analytics/analytics.js
 import axios from "axios";

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-RKOF335E.js";
+} from "./chunk-4UMY62TN.js";
 export {
   VERSION
 };

package/dist/eventcatalog.cjs

@@ -157,7 +157,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.35.9";
+var version = "2.36.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -6,15 +6,15 @@ import {
 } from "./chunk-DCLTVJDP.js";
 import {
   log_build_default
-} from "./chunk-K2XHQGHN.js";
-import "./chunk-KEOGLT6Y.js";
+} from "./chunk-56VOUKDM.js";
+import "./chunk-J5VDZAYA.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
 } from "./chunk-SLEMYHTU.js";
 import {
   VERSION
-} from "./chunk-RKOF335E.js";
+} from "./chunk-4UMY62TN.js";
 import {
   isBackstagePluginEnabled,
   isEventCatalogScaleEnabled,

package/eventcatalog/src/components/Grids/DomainGrid.tsx

@@ -5,6 +5,7 @@ import type { CollectionEntry } from 'astro:content';
 import { type CollectionMessageTypes } from '@types';
 import { getCollectionStyles } from './utils';
 import { SearchBar } from './components';
+import { BoxIcon } from 'lucide-react';
 
 export interface ExtendedDomain extends CollectionEntry<'domains'> {
   sends: CollectionEntry<CollectionMessageTypes>[];
@@ -123,6 +124,14 @@ export default function DomainGrid({ domains, embeded }: DomainGridProps) {
                     </p>
                   </div>
                 </div>
+                {domain.data.entities && domain.data.entities.length > 0 && (
+                  <div className="flex items-center gap-2 bg-white rounded-lg px-3 py-2 border border-gray-200 ">
+                    <BoxIcon className="h-4 w-4 text-purple-500" />
+                    <div>
+                      <p className="text-sm font-medium text-gray-900">{domain.data.entities?.length} Entities</p>
+                    </div>
+                  </div>
+                )}
               </div>
 
               <div className="space-y-6">

package/eventcatalog/src/components/Grids/ServiceGrid.tsx

@@ -7,6 +7,7 @@ import type { CollectionMessageTypes } from '@types';
 import { getCollectionStyles } from './utils';
 import { SearchBar, TypeFilters, Pagination } from './components';
 import type { ExtendedDomain } from './DomainGrid';
+import { BoxIcon } from 'lucide-react';
 
 // Message component for reuse
 const Message = memo(({ message, collection }: { message: any; collection: string }) => {
@@ -157,6 +158,24 @@ const DomainSection = memo(
                 </div>
               </div>
 
+              {/* Entities */}
+              {subdomain.data.entities && subdomain.data.entities.length > 0 && (
+                <div className="grid grid-cols-1 sm:grid-cols-1 lg:grid-cols-1 xl:grid-cols-4 gap-6">
+                  {subdomain.data.entities.map((entity: any) => (
+                    <a
+                      key={entity.id}
+                      href={buildUrl(`/docs/entities/${entity.id}`)}
+                      className="bg-white border-2 border-dashed border-purple-400 rounded-lg p-4 space-y-4 hover:bg-purple-50 transition-colors duration-200"
+                    >
+                      <div className="flex items-center gap-2">
+                        <BoxIcon className="h-5 w-5 text-purple-500" />
+                        <h3 className="text-lg font-semibold text-gray-900">{entity.id} (Entity)</h3>
+                      </div>
+                    </a>
+                  ))}
+                </div>
+              )}
+
               <div className="grid grid-cols-1 sm:grid-cols-1 lg:grid-cols-1 xl:grid-cols-2 gap-6">
                 {subdomainServices.map((service) => (
                   <ServiceCard

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

@@ -0,0 +1,106 @@
+---
+import type { CollectionEntry } from 'astro:content';
+import Admonition from '../Admonition';
+
+// Define the shape for a single property used in this component
+type EntityProperty = {
+  name: string;
+  type: string;
+  required?: boolean;
+  description?: string;
+  enum?: string[];
+  items?: {
+    type: string;
+  };
+};
+
+// Expects a CollectionEntry for 'entities'.
+// The actual properties structure might differ slightly from the base type,
+// so we handle it below.
+export interface Props extends CollectionEntry<'entities'> {}
+
+const { data, collection } = Astro.props;
+// Cast the properties to our expected type for use in the template
+const properties = data?.properties as EntityProperty[] | undefined;
+const isComponentEnabled = collection === 'entities';
+---
+
+{
+  !isComponentEnabled && (
+    <Admonition type="warning">
+      <div>
+        <span class="font-bold">
+          {`<MessageTable/>`} component is not supported for resources of type {collection}.
+        </span>
+        <span class="block">This component is only supported for services and domains.</span>
+      </div>
+    </Admonition>
+  )
+}
+
+{
+  isComponentEnabled && properties && properties.length > 0 ? (
+    <div class="overflow-x-auto relative not-prose">
+      <table class="w-full text-sm text-left text-gray-500 border border-gray-200 rounded-lg shadow-sm">
+        <thead class="text-xs text-gray-700 uppercase bg-gray-50">
+          <tr>
+            <th scope="col" class="py-3 px-6">
+              Name
+            </th>
+            <th scope="col" class="py-3 px-6">
+              Type
+            </th>
+            <th scope="col" class="py-3 px-6">
+              Required
+            </th>
+            <th scope="col" class="py-3 px-6 min-w-[250px]">
+              Description
+            </th>
+          </tr>
+        </thead>
+        <tbody>
+          {properties.map((prop) => (
+            <tr class="bg-white border-b hover:bg-gray-50 align-top">
+              <td class="py-4 px-6 font-medium text-gray-900 whitespace-nowrap">
+                <code class="text-sm bg-gray-100 rounded px-1 py-0.5">{prop.name}</code>
+              </td>
+              <td class="py-4 px-6">
+                {prop.type === 'array' && prop.items ? (
+                  <span>
+                    array&lt;<code class="text-sm bg-gray-100 rounded px-1 py-0.5">{prop.items.type}</code>&gt;
+                  </span>
+                ) : (
+                  <code class="text-sm bg-gray-100 rounded px-1 py-0.5">{prop.type}</code>
+                )}
+                {prop.enum && (
+                  <div class="text-xs text-gray-500 mt-2">
+                    <span class="font-semibold block mb-1">Enum:</span>
+                    <ul class="list-disc list-inside ml-2 space-y-1">
+                      {prop.enum.map((enumValue: string) => (
+                        <li>
+                          <code class="text-xs bg-gray-100 rounded px-1 py-0.5">{enumValue}</code>
+                        </li>
+                      ))}
+                    </ul>
+                  </div>
+                )}
+              </td>
+              <td class="py-4 px-6">
+                {prop.required ? (
+                  <span class="bg-purple-100 text-purple-800 text-xs font-semibold mr-2 px-2.5 py-0.5 rounded">Required</span>
+                ) : (
+                  <span class="bg-gray-100 text-gray-800 text-xs font-semibold mr-2 px-2.5 py-0.5 rounded">Optional</span>
+                )}
+              </td>
+              <td class="py-4 px-6">{prop.description || <span class="text-gray-400 italic">No description provided.</span>}</td>
+            </tr>
+          ))}
+        </tbody>
+      </table>
+    </div>
+  ) : (
+    <Admonition type="note" title="No Properties Defined">
+      <p>There are no properties defined for this entity.</p>
+    </Admonition>
+  )
+}

package/eventcatalog/src/components/MDX/components.tsx

@@ -14,6 +14,7 @@ import AsyncAPI from '@components/MDX/AsyncAPI/AsyncAPI.astro';
 import ChannelInformation from '@components/MDX/ChannelInformation/ChannelInformation';
 import MessageTable from '@components/MDX/MessageTable/MessageTable.astro';
 import ResourceGroupTable from '@components/MDX/ResourceGroupTable/ResourceGroupTable.astro';
+import EntityPropertiesTable from '@components/MDX/EntityPropertiesTable/EntityPropertiesTable.astro';
 import Tabs from '@components/MDX/Tabs/Tabs.astro';
 import TabItem from '@components/MDX/Tabs/TabItem.astro';
 import ResourceLink from '@components/MDX/ResourceLink/ResourceLink.astro';
@@ -38,6 +39,7 @@ const components = (props: any) => {
     Flow,
     Link: (mdxProp: any) => jsx(Link, { ...props, ...mdxProp }),
     MessageTable: (mdxProp: any) => jsx(MessageTable, { ...props, ...mdxProp }),
+    EntityPropertiesTable: (mdxProp: any) => jsx(EntityPropertiesTable, { ...props, ...mdxProp }),
     NodeGraph: (mdxProp: any) => jsx(NodeGraphPortal, { ...props.data, ...mdxProp, props, mdxProp }),
     OpenAPI,
     ResourceGroupTable: (mdxProp: any) => jsx(ResourceGroupTable, { ...props, ...mdxProp }),

package/eventcatalog/src/components/SideBars/DomainSideBar.astro

@@ -21,6 +21,9 @@ const services = (domain.data.services as CollectionEntry<'services'>[]) || [];
 // @ts-ignore
 const subDomains = (domain.data.domains as CollectionEntry<'domains'>[]) || [];
 
+// @ts-ignore
+const entities = (domain.data.entities as CollectionEntry<'entities'>[]) || [];
+
 const ubiquitousLanguage = await getUbiquitousLanguage(domain);
 const hasUbiquitousLanguage = ubiquitousLanguage.length > 0;
 const ubiquitousLanguageDictionary = hasUbiquitousLanguage ? ubiquitousLanguage[0].data.dictionary : [];
@@ -86,6 +89,14 @@ const ubiquitousLanguageList = ubiquitousLanguageDictionary?.map((l) => ({
   href: buildUrl(`/docs/${domain.collection}/${domain.data.id}/language?id=${l.id}`),
 }));
 
+const entityList = entities.map((p) => ({
+  label: p.data.name,
+  badge: p.collection,
+  tag: `v${p.data.version}`,
+  collection: p.collection,
+  href: buildUrl(`/docs/${p.collection}/${p.data.id}/${p.data.version}`),
+}));
+
 const ownersList = filteredOwners.map((o) => ({
   label: o.data.name,
   type: o.collection,
@@ -160,6 +171,17 @@ const ownersList = filteredOwners.map((o) => ({
         />
       )
     }
+    {
+      entities.length > 0 && (
+        <PillListFlat
+          title={`Entities (${entities.length})`}
+          pills={entityList}
+          emptyMessage={`This domain does not contain any entities.`}
+          color="pink"
+          client:load
+        />
+      )
+    }
     {domain.data.versions && <VersionList versions={domain.data.versions} collectionItem={domain} />}
     {
       domain.data.repository && (

package/eventcatalog/src/components/SideBars/EntitySideBar.astro

@@ -0,0 +1,94 @@
+---
+import type { CollectionEntry } from 'astro:content';
+import PillListFlat from '@components/Lists/PillListFlat';
+import OwnersList from '@components/Lists/OwnersList';
+import VersionList from '@components/Lists/VersionList.astro';
+import { buildUrl } from '@utils/url-builder';
+import { ScrollText } from 'lucide-react';
+import { getOwner } from '@utils/collections/owners';
+
+interface Props {
+  entity: CollectionEntry<'entities'>;
+}
+
+const { entity } = Astro.props;
+
+const ownersRaw = entity.data?.owners || [];
+const owners = await Promise.all<ReturnType<typeof getOwner>>(ownersRaw.map(getOwner));
+const filteredOwners = owners.filter((o) => o !== undefined);
+
+// @ts-ignore
+const services = (entity.data.services as CollectionEntry<'services'>[]) || [];
+// @ts-ignore
+const domains = (entity.data.domains as CollectionEntry<'domains'>[]) || [];
+
+const ownersList = filteredOwners.map((o) => ({
+  label: o.data.name,
+  type: o.collection,
+  badge: o.collection === 'users' ? o.data.role : 'Team',
+  avatarUrl: o.collection === 'users' ? o.data.avatarUrl : '',
+  href: buildUrl(`/docs/${o.collection}/${o.data.id}`),
+}));
+
+const servicesList = services.map((p) => ({
+  label: p.data.name,
+  badge: p.collection,
+  color: 'pink',
+  collection: p.collection,
+  tag: `v${p.data.version}`,
+  href: buildUrl(`/docs/${p.collection}/${p.data.id}/${p.data.version}`),
+}));
+
+const domainsList = domains.map((p) => ({
+  label: p.data.name,
+  badge: p.collection,
+  color: 'blue',
+  collection: p.collection,
+  tag: `v${p.data.version}`,
+  href: buildUrl(`/docs/${p.collection}/${p.data.id}/${p.data.version}`),
+}));
+---
+
+<aside class="sticky top-28 left-0 space-y-8 h-full overflow-y-auto py-4">
+  <div class="">
+    {
+      (
+        <PillListFlat
+          title={`Domains (${domainsList.length})`}
+          pills={domainsList}
+          emptyMessage={`This entity is not used in any domains.`}
+          color="blue"
+          client:load
+        />
+      )
+    }
+    {
+      servicesList.length > 0 && (
+        <PillListFlat
+          title={`Services (${servicesList.length})`}
+          pills={servicesList}
+          emptyMessage={`This entity is not used in any services.`}
+          color="pink"
+          client:load
+        />
+      )
+    }
+    {entity.data.versions && <VersionList versions={entity.data.versions} collectionItem={entity} />}
+    <OwnersList
+      title={`Owners (${filteredOwners.length})`}
+      owners={ownersList}
+      emptyMessage={`This entity does not have any documented owners.`}
+      client:load
+    />
+
+    <div class="space-y-2">
+      <a
+        href={buildUrl(`/docs/${entity.collection}/${entity.data.id}/${entity.data.latestVersion}/changelog`)}
+        class="flex items-center space-x-2 justify-center text-center rounded-md w-full bg-white px-3.5 py-2.5 text-sm font-semibold text-gray-900 shadow-sm ring-1 ring-inset ring-gray-300 hover:bg-gray-100/60 hover:text-primary"
+      >
+        <ScrollText strokeWidth={2} size={16} />
+        <span class="block">Read changelog</span>
+      </a>
+    </div>
+  </div>
+</aside>

package/eventcatalog/src/components/SideBars/ServiceSideBar.astro

@@ -23,6 +23,9 @@ const sends = (service.data.sends as CollectionEntry<'events'>[]) || [];
 // @ts-ignore
 const receives = (service.data.receives as CollectionEntry<'events'>[]) || [];
 
+// @ts-ignore
+const entities = (service.data.entities as CollectionEntry<'entities'>[]) || [];
+
 const ownersRaw = service.data?.owners || [];
 const owners = await Promise.all<ReturnType<typeof getOwner>>(ownersRaw.map(getOwner));
 const filteredOwners = owners.filter((o) => o !== undefined);
@@ -69,6 +72,14 @@ const domainList = domainsServiceBelongsTo.map((d) => ({
   href: buildUrl(`/docs/${d.collection}/${d.data.id}/${d.data.version}`),
 }));
 
+const entityList = entities.map((p) => ({
+  label: p.data.name,
+  badge: p.collection,
+  tag: `v${p.data.version}`,
+  collection: p.collection,
+  href: buildUrl(`/docs/${p.collection}/${p.data.id}/${p.data.version}`),
+}));
+
 const isRSSEnabled = config.rss?.enabled;
 
 // @ts-ignore
@@ -113,6 +124,18 @@ const schemaURL = join(publicPath, schemaFilePath || '');
 
     {service.data.specifications && <SpecificationsList collectionItem={service} />}
 
+    {
+      entities.length > 0 && (
+        <PillListFlat
+          title={`Entities (${entities.length})`}
+          pills={entityList}
+          emptyMessage={`This service does not contain any entities.`}
+          color="pink"
+          client:load
+        />
+      )
+    }
+
     <OwnersList
       title={`Owners (${ownersList.length})`}
       owners={ownersList}

package/eventcatalog/src/components/SideNav/ListViewSideBar/components/MessageList.tsx

@@ -39,7 +39,7 @@ const MessageList: React.FC<MessageListProps> = ({ messages, decodedCurrentPath
           <span
             className={`ml-2 text-[10px]  flex items-center gap-1 font-medium px-2 uppercase py-0.5 rounded ${getMessageColorByLabelOrCollection(message.collection, message.data?.sidebar?.badge)}`}
           >
-            {message.data?.sidebar?.badge || getMessageCollectionName(message.collection)}
+            {message.data?.sidebar?.badge || getMessageCollectionName(message.collection, message)}
           </span>
         </a>
       </li>

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

@@ -11,13 +11,16 @@ export const getMessageColorByCollection = (collection: string) => {
   if (collection === 'commands') return 'bg-blue-50 text-blue-600';
   if (collection === 'queries') return 'bg-green-50 text-green-600';
   if (collection === 'events') return 'bg-orange-50 text-orange-600';
+  if (collection === 'entities') return 'bg-purple-50 text-purple-600';
   return 'text-gray-600';
 };
 
-export const getMessageCollectionName = (collection: string) => {
+export const getMessageCollectionName = (collection: string, item: any) => {
   if (collection === 'commands') return 'Command';
   if (collection === 'queries') return 'Query';
   if (collection === 'events') return 'Event';
+  if (collection === 'entities' && item.data.aggregateRoot) return 'Entity (Root)';
+  if (collection === 'entities') return 'Entity';
   return collection.slice(0, collection.length - 1).toUpperCase();
 };
 
@@ -41,11 +44,13 @@ const ServiceItem = React.memo(
     decodedCurrentPath,
     collapsedGroups,
     toggleGroupCollapse,
+    isVisualizer,
   }: {
     item: ServiceItem;
     decodedCurrentPath: string;
     collapsedGroups: { [key: string]: boolean };
     toggleGroupCollapse: (group: string) => void;
+    isVisualizer: boolean;
   }) => (
     <CollapsibleGroup
       isCollapsed={collapsedGroups[item.href]}
@@ -148,6 +153,25 @@ const ServiceItem = React.memo(
         >
           <MessageList messages={item.sends} decodedCurrentPath={decodedCurrentPath} />
         </CollapsibleGroup>
+        {!isVisualizer && item.entities.length > 0 && (
+          <CollapsibleGroup
+            isCollapsed={collapsedGroups[`${item.href}-entities`]}
+            onToggle={() => toggleGroupCollapse(`${item.href}-entities`)}
+            title={
+              <button
+                onClick={(e) => {
+                  e.stopPropagation();
+                  toggleGroupCollapse(`${item.href}-entities`);
+                }}
+                className="truncate underline ml-2 text-xs mb-1 py-1"
+              >
+                Entities ({item.entities.length})
+              </button>
+            }
+          >
+            <MessageList messages={item.entities} decodedCurrentPath={decodedCurrentPath} />
+          </CollapsibleGroup>
+        )}
       </div>
     </CollapsibleGroup>
   )
@@ -169,6 +193,7 @@ const ListViewSideBar: React.FC<ListViewSideBarProps> = ({ resources, currentPat
   });
 
   const decodedCurrentPath = window.location.pathname;
+  const isVisualizer = window.location.pathname.includes('/visualiser/');
 
   useEffect(() => {
     const timer = setTimeout(() => {
@@ -341,16 +366,37 @@ const ListViewSideBar: React.FC<ListViewSideBarProps> = ({ resources, currentPat
                           >
                             <span className="truncate">Architecture</span>
                           </a>
-                          <a
-                            href={buildUrl(`/docs/domains/${item.id}/language`)}
-                            className={`flex items-center px-2 py-1.5 text-xs text-gray-600 hover:bg-purple-100 rounded-md ${
-                              decodedCurrentPath.includes(`/docs/domains/${item.id}/language`)
-                                ? 'bg-purple-100 '
-                                : 'hover:bg-purple-100'
-                            }`}
-                          >
-                            <span className="truncate">Ubiquitous Language</span>
-                          </a>
+                          {!isVisualizer && (
+                            <a
+                              href={buildUrl(`/docs/domains/${item.id}/language`)}
+                              className={`flex items-center px-2 py-1.5 text-xs text-gray-600 hover:bg-purple-100 rounded-md ${
+                                decodedCurrentPath.includes(`/docs/domains/${item.id}/language`)
+                                  ? 'bg-purple-100 '
+                                  : 'hover:bg-purple-100'
+                              }`}
+                            >
+                              <span className="truncate">Ubiquitous Language</span>
+                            </a>
+                          )}
+                          {item.entities.length > 0 && !isVisualizer && (
+                            <CollapsibleGroup
+                              isCollapsed={collapsedGroups[`${item.href}-entities`]}
+                              onToggle={() => toggleGroupCollapse(`${item.href}-entities`)}
+                              title={
+                                <button
+                                  onClick={(e) => {
+                                    e.stopPropagation();
+                                    toggleGroupCollapse(`${item.href}-entities`);
+                                  }}
+                                  className="truncate underline ml-2 text-xs mb-1 py-1"
+                                >
+                                  Entities ({item.entities.length})
+                                </button>
+                              }
+                            >
+                              <MessageList messages={item.entities} decodedCurrentPath={decodedCurrentPath} />
+                            </CollapsibleGroup>
+                          )}
                         </div>
                       </div>
                     </li>
@@ -369,6 +415,7 @@ const ListViewSideBar: React.FC<ListViewSideBarProps> = ({ resources, currentPat
                       decodedCurrentPath={decodedCurrentPath}
                       collapsedGroups={collapsedGroups}
                       toggleGroupCollapse={toggleGroupCollapse}
+                      isVisualizer={isVisualizer}
                     />
                   ))}
                 </ul>
@@ -390,7 +437,7 @@ const ListViewSideBar: React.FC<ListViewSideBarProps> = ({ resources, currentPat
                         <span
                           className={`ml-2 text-[10px] font-medium px-2 uppercase py-0.5 rounded ${getMessageColorByCollection(item.collection)}`}
                         >
-                          {getMessageCollectionName(item.collection)}
+                          {getMessageCollectionName(item.collection, item)}
                         </span>
                       </a>
                     </li>

package/eventcatalog/src/components/SideNav/ListViewSideBar/types.ts

@@ -10,6 +10,13 @@ export interface MessageItem {
   };
 }
 
+export interface EntityItem {
+  href: string;
+  label: string;
+  id: string;
+  name: string;
+}
+
 export interface ServiceItem {
   href: string;
   label: string;
@@ -18,6 +25,7 @@ export interface ServiceItem {
   version: string;
   sends: MessageItem[];
   receives: MessageItem[];
+  entities: EntityItem[];
   specifications?: {
     asyncapiPath: string;
     openapiPath: string;

package/eventcatalog/src/components/SideNav/ListViewSideBar/utils.ts

@@ -36,10 +36,13 @@ export async function getResourcesForNavigation({ currentPath }: { currentPath:
     const title = item.collection;
     const group = acc[title] || [];
 
-    const servicesCount = item.collection === 'domains' ? item.data.services?.length || 0 : 0;
-    const sends = item.collection === 'services' ? item.data.sends || null : null;
-    const receives = item.collection === 'services' ? item.data.receives || null : null;
+    const isCollectionDomain = item.collection === 'domains';
+    const isCollectionService = item.collection === 'services';
 
+    const servicesCount = isCollectionDomain ? item.data.services?.length || 0 : 0;
+    const sends = isCollectionService ? item.data.sends || null : null;
+    const receives = isCollectionService ? item.data.receives || null : null;
+    const entities = isCollectionDomain || isCollectionService ? item.data.entities || null : null;
     // Add href to the sends and receives
     const sendsWithHref = sends?.map((send: any) => ({
       ...send,
@@ -49,6 +52,10 @@ export async function getResourcesForNavigation({ currentPath }: { currentPath:
       ...receive,
       href: buildUrl(`/${route}/${receive.collection}/${receive.data.id}/${receive.data.version}`),
     }));
+    const entitiesWithHref = entities?.map((entity: any) => ({
+      ...entity,
+      href: buildUrl(`/${route}/${entity.collection}/${entity.data.id}/${entity.data.version}`),
+    }));
 
     const navigationItem = {
       label: item.data.name,
@@ -64,11 +71,12 @@ export async function getResourcesForNavigation({ currentPath }: { currentPath:
       servicesCount,
       id: item.data.id,
       name: item.data.name,
-      services: item.collection === 'domains' ? item.data.services : null,
-      domains: item.collection === 'domains' ? item.data.domains : null,
+      services: isCollectionDomain ? item.data.services : null,
+      domains: isCollectionDomain ? item.data.domains : null,
       sends: sendsWithHref,
       receives: receivesWithHref,
-      specifications: item.collection === 'services' ? item.data.specifications : null,
+      entities: entitiesWithHref,
+      specifications: isCollectionService ? item.data.specifications : null,
       sidebar: item.data?.sidebar,
     };
 

package/eventcatalog/src/components/SideNav/TreeView/getTreeView.ts

@@ -18,7 +18,7 @@ export type TreeNode = {
 /**
  * Resource types that should be in the sidenav
  */
-const RESOURCE_TYPES = ['domains', 'services', 'events', 'commands', 'queries', 'flows', 'channels'];
+const RESOURCE_TYPES = ['domains', 'entities', 'services', 'events', 'commands', 'queries', 'flows', 'channels'];
 // const RESOURCE_TYPES = ['domains', 'services', 'events', 'commands', 'queries', 'flows', 'channels'];
 
 /**

package/eventcatalog/src/content.config.ts

@@ -295,6 +295,7 @@ const services = defineCollection({
     .object({
       sends: z.array(pointer).optional(),
       receives: z.array(pointer).optional(),
+      entities: z.array(pointer).optional(),
     })
     .merge(baseSchema),
 });
@@ -332,6 +333,7 @@ const domains = defineCollection({
     .object({
       services: z.array(pointer).optional(),
       domains: z.array(pointer).optional(),
+      entities: z.array(pointer).optional(),
     })
     .merge(baseSchema),
 });
@@ -387,6 +389,35 @@ const ubiquitousLanguages = defineCollection({
   }),
 });
 
+const entities = defineCollection({
+  loader: glob({
+    pattern: ['**/entities/*/index.(md|mdx)', '**/entities/*/versioned/*/index.(md|mdx)'],
+    base: projectDirBase,
+    generateId: ({ data, ...rest }) => {
+      return `${data.id}-${data.version}`;
+    },
+  }),
+  schema: z
+    .object({
+      aggregateRoot: z.boolean().optional(),
+      identifier: z.string().optional(),
+      properties: z
+        .array(
+          z.object({
+            name: z.string(),
+            type: z.string(),
+            required: z.boolean().optional(),
+            description: z.string().optional(),
+          })
+        )
+        .optional(),
+      services: z.array(reference('services')).optional(),
+      domains: z.array(reference('domains')).optional(),
+    })
+
+    .merge(baseSchema),
+});
+
 const users = defineCollection({
   loader: glob({ pattern: 'users/*.(md|mdx)', base: projectDirBase, generateId: ({ data }) => data.id as string }),
   schema: z.object({
@@ -438,7 +469,10 @@ export const collections = {
   flows,
   pages,
   changelogs,
+
+  // DDD Collections
   ubiquitousLanguages,
+  entities,
 
   // EventCatalog Pro Collections
   customPages,

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

@@ -14,7 +14,7 @@ import MessageSideBar from '@components/SideBars/MessageSideBar.astro';
 import DomainSideBar from '@components/SideBars/DomainSideBar.astro';
 import ChannelSideBar from '@components/SideBars/ChannelSideBar.astro';
 import FlowSideBar from '@components/SideBars/FlowSideBar.astro';
-
+import EntitySideBar from '@components/SideBars/EntitySideBar.astro';
 import {
   QueueListIcon,
   RectangleGroupIcon,
@@ -24,7 +24,7 @@ import {
   MagnifyingGlassIcon,
 } from '@heroicons/react/24/outline';
 import { ArrowsRightLeftIcon } from '@heroicons/react/20/solid';
-
+import { Box, Boxes } from 'lucide-react';
 import type { PageTypes } from '@types';
 import type { CollectionTypes } from '@types';
 
@@ -39,7 +39,7 @@ import { buildUrl } from '@utils/url-builder';
 import config from '@config';
 
 export async function getStaticPaths() {
-  const itemTypes: PageTypes[] = ['events', 'commands', 'queries', 'services', 'domains', 'flows', 'channels'];
+  const itemTypes: PageTypes[] = ['events', 'commands', 'queries', 'services', 'domains', 'flows', 'channels', 'entities'];
   const allItems = await Promise.all(itemTypes.map((type) => pageDataLoader[type]()));
 
   return allItems.flatMap((items, index) =>
@@ -74,36 +74,54 @@ const getContentBadges = () =>
 
 const getBadge = () => {
   if (props.collection === 'services') {
-    return { backgroundColor: 'pink', textColor: 'pink', content: 'Service', icon: ServerIcon, class: 'text-pink-400' };
+    return [{ backgroundColor: 'pink', textColor: 'pink', content: 'Service', icon: ServerIcon, class: 'text-pink-400' }];
   }
   if (props.collection === 'events') {
-    return { backgroundColor: 'orange', textColor: 'orange', content: 'Event', icon: BoltIcon, class: 'text-orange-400' };
+    return [{ backgroundColor: 'orange', textColor: 'orange', content: 'Event', icon: BoltIcon, class: 'text-orange-400' }];
   }
   if (props.collection === 'commands') {
-    return { backgroundColor: 'blue', textColor: 'blue', content: 'Command', icon: ChatBubbleLeftIcon, class: 'text-blue-400' };
+    return [{ backgroundColor: 'blue', textColor: 'blue', content: 'Command', icon: ChatBubbleLeftIcon, class: 'text-blue-400' }];
   }
   if (props.collection === 'queries') {
-    return { backgroundColor: 'green', textColor: 'green', content: 'Query', icon: MagnifyingGlassIcon, class: 'text-green-400' };
+    return [
+      { backgroundColor: 'green', textColor: 'green', content: 'Query', icon: MagnifyingGlassIcon, class: 'text-green-400' },
+    ];
   }
   if (props.collection === 'domains') {
-    return {
-      backgroundColor: 'yellow',
-      textColor: 'yellow',
-      content: 'Domain',
-      icon: RectangleGroupIcon,
-      class: 'text-yellow-400',
-    };
+    return [
+      {
+        backgroundColor: 'yellow',
+        textColor: 'yellow',
+        content: 'Domain',
+        icon: RectangleGroupIcon,
+        class: 'text-yellow-400',
+      },
+    ];
   }
 
   if (props.collection === 'flows') {
-    return { backgroundColor: 'teal', textColor: 'teal', content: 'Flow', icon: QueueListIcon, class: 'text-gray' };
+    return [{ backgroundColor: 'teal', textColor: 'teal', content: 'Flow', icon: QueueListIcon, class: 'text-gray' }];
   }
 
   if (props.collection === 'channels') {
-    return { backgroundColor: 'teal', textColor: 'teal', content: 'Channel', icon: ArrowsRightLeftIcon, class: 'text-gray' };
+    return [{ backgroundColor: 'teal', textColor: 'teal', content: 'Channel', icon: ArrowsRightLeftIcon, class: 'text-gray' }];
+  }
+
+  if (props.collection === 'entities') {
+    const entityBadges = [{ backgroundColor: 'purple', textColor: 'purple', content: 'Entity', icon: Box, class: 'text-gray' }];
+    if (props.data.aggregateRoot) {
+      entityBadges.push({
+        backgroundColor: 'purple',
+        textColor: 'purple',
+        content: '(Aggregate Root)',
+        icon: Boxes,
+        class: 'text-gray',
+      });
+    }
+    return entityBadges;
   }
 
-  return { backgroundColor: 'teal', textColor: 'teal', content: '', icon: QueueListIcon, class: 'text-gray' };
+  return [{ backgroundColor: 'teal', textColor: 'teal', content: '', icon: QueueListIcon, class: 'text-gray' }];
 };
 
 const getSpecificationBadges = () => {
@@ -138,7 +156,7 @@ const getSpecificationBadges = () => {
   return badges;
 };
 
-const badges = [getBadge(), ...getContentBadges(), ...getSpecificationBadges()];
+const badges = [...getBadge(), ...getContentBadges(), ...getSpecificationBadges()];
 
 // Index only the latest version
 const pagefindAttributes =
@@ -299,6 +317,7 @@ friendlyCollectionName = friendlyCollectionName === 'querie' ? 'query' : friendl
         {props?.collection === 'domains' && <DomainSideBar domain={props} />}
         {props?.collection === 'channels' && <ChannelSideBar channel={props} />}
         {props?.collection === 'flows' && <FlowSideBar flow={props} />}
+        {props?.collection === 'entities' && <EntitySideBar entity={props} />}
       </aside>
     </div>
     <ClientRouter />

package/eventcatalog/src/pages/docs/[type]/[id]/[version].md.ts

@@ -4,6 +4,7 @@
 
 import type { APIRoute } from 'astro';
 import { getCollection } from 'astro:content';
+import { getEntities } from '@utils/entities';
 import config from '@config';
 import fs from 'fs';
 
@@ -14,7 +15,7 @@ const services = await getCollection('services');
 const domains = await getCollection('domains');
 const flows = await getCollection('flows');
 const channels = await getCollection('channels');
-
+const entities = await getEntities();
 export async function getStaticPaths() {
   // Just return empty array if LLMs are not enabled
   if (!config.llmsTxt?.enabled) {
@@ -29,6 +30,7 @@ export async function getStaticPaths() {
     domains,
     flows,
     channels,
+    entities,
   };
   const paths = Object.keys(collections).map((type) => {
     return collections[type as keyof typeof collections].map((item: { data: { id: string; version: string } }) => ({

package/eventcatalog/src/pages/docs/[type]/[id]/[version].mdx.ts

@@ -14,6 +14,7 @@ const services = await getCollection('services');
 const domains = await getCollection('domains');
 const flows = await getCollection('flows');
 const channels = await getCollection('channels');
+const entities = await getCollection('entities');
 
 export async function getStaticPaths() {
   // Just return empty array if LLMs are not enabled
@@ -29,6 +30,7 @@ export async function getStaticPaths() {
     domains,
     flows,
     channels,
+    entities,
   };
   const paths = Object.keys(collections).map((type) => {
     return collections[type as keyof typeof collections].map((item: { data: { id: string; version: string } }) => ({

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

@@ -2,6 +2,7 @@
 import Seo from '@components/Seo.astro';
 import { buildUrl } from '@utils/url-builder';
 import { getEvents } from '@utils/events';
+import { getEntities } from '@utils/entities';
 import { getCommands } from '@utils/commands';
 import { getServices } from '@utils/collections/services';
 import { getDomains } from '@utils/collections/domains';
@@ -10,12 +11,13 @@ import type { CollectionTypes } from '@types';
 import { getChannels } from '@utils/channels';
 
 export async function getStaticPaths() {
-  const [events, commands, services, domains, channels] = await Promise.all([
+  const [events, commands, services, domains, channels, entities] = await Promise.all([
     getEvents(),
     getCommands(),
     getServices(),
     getDomains(),
     getChannels(),
+    getEntities(),
   ]);
 
   const buildPages = (collection: CollectionEntry<CollectionTypes>[]) => {
@@ -37,6 +39,7 @@ export async function getStaticPaths() {
     ...buildPages(services),
     ...buildPages(commands),
     ...buildPages(channels),
+    ...buildPages(entities),
   ];
 }
 

package/eventcatalog/src/types/index.ts

@@ -1,4 +1,4 @@
-export type CollectionTypes = 'commands' | 'events' | 'queries' | 'domains' | 'services' | 'flows' | 'channels';
+export type CollectionTypes = 'commands' | 'events' | 'queries' | 'domains' | 'services' | 'flows' | 'channels' | 'entities';
 export type CollectionMessageTypes = 'commands' | 'events' | 'queries';
 export type CollectionUserTypes = 'users';
-export type PageTypes = 'events' | 'commands' | 'queries' | 'services' | 'domains' | 'channels' | 'flows';
+export type PageTypes = 'events' | 'commands' | 'queries' | 'services' | 'domains' | 'channels' | 'flows' | 'entities';

package/eventcatalog/src/utils/badges.tsx

@@ -0,0 +1,22 @@
+import * as HeroIcons from '@heroicons/react/24/outline';
+import * as ProtocolIcons from '@icons/protocols';
+
+// const allIcons = [...HeroIcons, ...ProtocolIcons];
+
+const protocolIcons = Object.keys(ProtocolIcons).reduce(
+  (icons, key) => {
+    const iconKey = key as keyof typeof ProtocolIcons;
+    icons[key.toLowerCase()] = ProtocolIcons[iconKey];
+    return icons;
+  },
+  {} as { [key: string]: string }
+);
+
+const getIconForProtocol = (icon: keyof typeof protocolIcons) => {
+  const Icon = protocolIcons[icon];
+  return Icon ? (props: any) => <span {...props} dangerouslySetInnerHTML={{ __html: Icon }} /> : null;
+};
+
+export function getIcon(iconName: string) {
+  return getIconForProtocol(iconName as keyof typeof protocolIcons) || HeroIcons[iconName as keyof typeof HeroIcons] || null;
+}

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

@@ -34,6 +34,7 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
 
   // Get all the services that are not versioned
   const servicesCollection = await getCollection('services');
+  const entitiesCollection = await getCollection('entities');
 
   // @ts-ignore // TODO: Fix this type
   cachedDomains[cacheKey] = domains.map((domain) => {
@@ -42,7 +43,7 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
     // const receives = service.data.receives || [];
     const servicesInDomain = domain.data.services || [];
     const subDomainsInDomain = domain.data.domains || [];
-
+    const entitiesInDomain = domain.data.entities || [];
     const subDomains = subDomainsInDomain
       .map((_subDomain: { id: string; version: string | undefined }) =>
         getItemsFromCollectionByIdAndSemverOrLatest(domains, _subDomain.id, _subDomain.version)
@@ -60,12 +61,19 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
       )
       .flat();
 
+    const entities = [...entitiesInDomain]
+      .map((_entity: { id: string; version: string | undefined }) =>
+        getItemsFromCollectionByIdAndSemverOrLatest(entitiesCollection, _entity.id, _entity.version)
+      )
+      .flat();
+
     return {
       ...domain,
       data: {
         ...domain.data,
         services: services,
         domains: subDomains,
+        entities: entities,
         latestVersion,
         versions,
       },

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

@@ -11,7 +11,7 @@ import {
   VariableIcon,
   MapIcon,
 } from '@heroicons/react/24/outline';
-import { BookText } from 'lucide-react';
+import { BookText, Box } from 'lucide-react';
 
 export const getIconForCollection = (collection: string) => {
   switch (collection) {
@@ -39,6 +39,8 @@ export const getIconForCollection = (collection: string) => {
       return BookText;
     case 'bounded-context-map':
       return MapIcon;
+    case 'entities':
+      return Box;
     default:
       return ServerIcon;
   }
@@ -64,6 +66,8 @@ export const getColorAndIconForCollection = (collection: string) => {
       return { color: 'purple', Icon: icon };
     case 'ubiquitousLanguages':
       return { color: 'green', Icon: icon };
+    case 'entities':
+      return { color: 'purple', Icon: icon };
     case 'domains':
       return { color: 'yellow', Icon: icon };
     case 'services':

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

@@ -34,7 +34,7 @@ export const getServices = async ({ getAllVersions = true }: Props = {}): Promis
   const events = await getCollection('events');
   const commands = await getCollection('commands');
   const queries = await getCollection('queries');
-
+  const entities = await getCollection('entities');
   const allMessages = [...events, ...commands, ...queries];
 
   // @ts-ignore // TODO: Fix this type
@@ -43,6 +43,7 @@ export const getServices = async ({ getAllVersions = true }: Props = {}): Promis
 
     const sendsMessages = service.data.sends || [];
     const receivesMessages = service.data.receives || [];
+    const serviceEntities = service.data.entities || [];
 
     const sends = sendsMessages
       .map((message: any) => getItemsFromCollectionByIdAndSemverOrLatest(allMessages, message.id, message.version))
@@ -54,6 +55,11 @@ export const getServices = async ({ getAllVersions = true }: Props = {}): Promis
       .flat()
       .filter((e: any) => e !== undefined);
 
+    const mappedEntities = serviceEntities
+      .map((entity: any) => getItemsFromCollectionByIdAndSemverOrLatest(entities, entity.id, entity.version))
+      .flat()
+      .filter((e: any) => e !== undefined);
+
     return {
       ...service,
       data: {
@@ -62,6 +68,7 @@ export const getServices = async ({ getAllVersions = true }: Props = {}): Promis
         sends,
         versions,
         latestVersion,
+        entities: mappedEntities,
       },
       // TODO: verify if it could be deleted.
       nodes: {

package/eventcatalog/src/utils/entities.ts

@@ -0,0 +1,85 @@
+import { getCollection } from 'astro:content';
+import type { CollectionEntry } from 'astro:content';
+import path from 'path';
+import { getVersionForCollectionItem, satisfies } from './collections/util';
+
+const PROJECT_DIR = process.env.PROJECT_DIR || process.cwd();
+
+type Entity = CollectionEntry<'entities'> & {
+  catalog: {
+    path: string;
+    filePath: string;
+    type: string;
+  };
+};
+
+interface Props {
+  getAllVersions?: boolean;
+}
+
+// cache for build time
+let cachedEntities: Record<string, Entity[]> = {
+  allVersions: [],
+  currentVersions: [],
+};
+
+export const getEntities = async ({ getAllVersions = true }: Props = {}): Promise<Entity[]> => {
+  const cacheKey = getAllVersions ? 'allVersions' : 'currentVersions';
+
+  if (cachedEntities[cacheKey].length > 0) {
+    return cachedEntities[cacheKey];
+  }
+
+  const entities = await getCollection('entities', (entity) => {
+    return (getAllVersions || !entity.filePath?.includes('versioned')) && entity.data.hidden !== true;
+  });
+
+  const services = await getCollection('services');
+  const domains = await getCollection('domains');
+
+  cachedEntities[cacheKey] = entities.map((entity) => {
+    const { latestVersion, versions } = getVersionForCollectionItem(entity, entities);
+
+    const servicesThatReferenceEntity = services.filter((service) =>
+      service.data.entities?.some((item) => {
+        if (item.id != entity.data.id) return false;
+        if (item.version == 'latest' || item.version == undefined) return entity.data.version == latestVersion;
+        return satisfies(entity.data.version, item.version);
+      })
+    );
+
+    const domainsThatReferenceEntity = domains.filter((domain) =>
+      domain.data.entities?.some((item) => {
+        if (item.id != entity.data.id) return false;
+        if (item.version == 'latest' || item.version == undefined) return entity.data.version == latestVersion;
+        return satisfies(entity.data.version, item.version);
+      })
+    );
+
+    return {
+      ...entity,
+      data: {
+        ...entity.data,
+        versions,
+        latestVersion,
+        services: servicesThatReferenceEntity,
+        domains: domainsThatReferenceEntity,
+      },
+      catalog: {
+        path: path.join(entity.collection, entity.id.replace('/index.mdx', '')),
+        absoluteFilePath: path.join(PROJECT_DIR, entity.collection, entity.id.replace('/index.mdx', '/index.md')),
+        astroContentFilePath: path.join(process.cwd(), 'src', 'content', entity.collection, entity.id),
+        filePath: path.join(process.cwd(), 'src', 'catalog-files', entity.collection, entity.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', entity.collection, entity.id.replace(`-${entity.data.version}`, '')),
+        type: 'entity',
+      },
+    };
+  });
+
+  // order them by the name of the event
+  cachedEntities[cacheKey].sort((a, b) => {
+    return (a.data.name || a.data.id).localeCompare(b.data.name || b.data.id);
+  });
+
+  return cachedEntities[cacheKey];
+};

package/eventcatalog/src/utils/page-loaders/page-data-loader.ts

@@ -5,6 +5,7 @@ import { getCommands, getEvents } from '@utils/messages';
 import { getQueries } from '@utils/queries';
 import { getServices } from '@utils/collections/services';
 import { getFlows } from '@utils/collections/flows';
+import { getEntities } from '@utils/entities';
 import type { CollectionEntry } from 'astro:content';
 
 export const pageDataLoader: Record<PageTypes, () => Promise<CollectionEntry<CollectionTypes>[]>> = {
@@ -15,4 +16,5 @@ export const pageDataLoader: Record<PageTypes, () => Promise<CollectionEntry<Col
   domains: getDomains,
   channels: getChannels,
   flows: getFlows,
+  entities: getEntities,
 };

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.35.9",
+  "version": "2.36.0",
   "publishConfig": {
     "access": "public"
   },

package/eventcatalog/src/utils/badges.ts

@@ -1,5 +0,0 @@
-import * as HeroIcons from '@heroicons/react/24/outline';
-
-export function getIcon(iconName: string) {
-  return HeroIcons[iconName as keyof typeof HeroIcons] || null;
-}