@eventcatalog/core 2.14.3 → 2.16.0

package/{src → eventcatalog/src}/utils/collections/domains.ts

@@ -6,7 +6,7 @@ import path from 'path';
 const PROJECT_DIR = process.env.PROJECT_DIR || process.cwd();
 
 export type Domain = CollectionEntry<'domains'>;
-
+export type UbiquitousLanguage = CollectionEntry<'ubiquitousLanguages'>;
 interface Props {
   getAllVersions?: boolean;
 }
@@ -28,7 +28,9 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
     const servicesInDomain = domain.data.services || [];
 
     const services = servicesInDomain
-      .map((_service) => getItemsFromCollectionByIdAndSemverOrLatest(servicesCollection, _service.id, _service.version))
+      .map((_service: { id: string; version: string | undefined }) =>
+        getItemsFromCollectionByIdAndSemverOrLatest(servicesCollection, _service.id, _service.version)
+      )
       .flat();
 
     return {
@@ -50,3 +52,16 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
     };
   });
 };
+
+export const getUbiquitousLanguage = async (domain: Domain): Promise<UbiquitousLanguage[]> => {
+  const { collection, data, slug } = domain;
+
+  const allUbiquitousLanguages = await getCollection('ubiquitousLanguages');
+  console.log('allUbiquitousLanguages', allUbiquitousLanguages, collection, slug, data.name);
+
+  const ubiquitousLanguages = await getCollection('ubiquitousLanguages', (ubiquitousLanguage) => {
+    return ubiquitousLanguage.id.includes(`${collection}/${data.name}`);
+  });
+
+  return ubiquitousLanguages;
+};

package/{src → eventcatalog/src}/utils/collections/icons.ts

@@ -10,6 +10,7 @@ import {
   ArrowsRightLeftIcon,
   VariableIcon,
 } from '@heroicons/react/24/outline';
+import { BookText } from 'lucide-react';
 
 export const getIconForCollection = (collection: string) => {
   switch (collection) {
@@ -33,6 +34,8 @@ export const getIconForCollection = (collection: string) => {
       return ArrowsRightLeftIcon;
     case 'channels-parameter':
       return VariableIcon;
+    case 'ubiquitousLanguages':
+      return BookText;
     default:
       return ServerIcon;
   }

package/{src → eventcatalog/src}/utils/node-graphs/message-node-graph.ts

@@ -9,6 +9,8 @@ import {
   generatedIdForEdge,
   generateIdForNode,
   getChannelNodesAndEdges,
+  getEdgeLabelForMessageAsSource,
+  getEdgeLabelForServiceAsTarget,
 } from './utils/utils';
 import { MarkerType } from 'reactflow';
 import { findMatchingNodes } from '@utils/collections/util';
@@ -26,33 +28,6 @@ interface Props {
   collection?: CollectionEntry<CollectionMessageTypes>[];
 }
 
-const getEdgeLabelForServiceAsTarget = (data: CollectionEntry<CollectionMessageTypes>) => {
-  const type = data.collection;
-  switch (type) {
-    case 'commands':
-      return 'invokes';
-    case 'events':
-      return 'publishes event';
-    case 'queries':
-      return 'requests';
-    default:
-      return 'sends to';
-  }
-};
-const getEdgeLabelForMessageAsSource = (data: CollectionEntry<CollectionMessageTypes>) => {
-  const type = data.collection;
-  switch (type) {
-    case 'commands':
-      return 'accepts';
-    case 'events':
-      return 'subscribed by';
-    case 'queries':
-      return 'accepts';
-    default:
-      return 'sends to';
-  }
-};
-
 const getNodesAndEdges = async ({ id, version, defaultFlow, mode = 'simple', collection = [] }: Props) => {
   const flow = defaultFlow || createDagreGraph({ ranksep: 300, nodesep: 50 });
   const nodes = [] as any,

package/{src → eventcatalog/src}/utils/node-graphs/utils/utils.ts

@@ -2,7 +2,7 @@ import { getCollection, type CollectionEntry } from 'astro:content';
 import { MarkerType, Position, type Edge, type Node } from 'reactflow';
 import dagre from 'dagre';
 import { getItemsFromCollectionByIdAndSemverOrLatest } from '@utils/collections/util';
-import type { CollectionTypes } from '@types';
+import type { CollectionMessageTypes, CollectionTypes } from '@types';
 
 export const generateIdForNode = (node: CollectionEntry<CollectionTypes>) => {
   return `${node.data.id}-${node.data.version}`;
@@ -14,6 +14,33 @@ export const generatedIdForEdge = (source: CollectionEntry<CollectionTypes>, tar
   return `${source.data.id}-${source.data.version}-${target.data.id}-${target.data.version}`;
 };
 
+export const getEdgeLabelForServiceAsTarget = (data: CollectionEntry<CollectionMessageTypes>) => {
+  const type = data.collection;
+  switch (type) {
+    case 'commands':
+      return 'invokes';
+    case 'events':
+      return 'publishes event';
+    case 'queries':
+      return 'requests';
+    default:
+      return 'sends to';
+  }
+};
+export const getEdgeLabelForMessageAsSource = (data: CollectionEntry<CollectionMessageTypes>) => {
+  const type = data.collection;
+  switch (type) {
+    case 'commands':
+      return 'accepts';
+    case 'events':
+      return 'subscribed by';
+    case 'queries':
+      return 'accepts';
+    default:
+      return 'sends to';
+  }
+};
+
 export const calculatedNodes = (flow: dagre.graphlib.Graph, nodes: Node[]) => {
   return nodes.map((node: any) => {
     const { x, y } = flow.node(node.id);
@@ -107,7 +134,7 @@ export const getChannelNodesAndEdges = ({
         target: channelId,
         label: '',
         // label: sourceToChannelLabel,
-        data: { message: edgeMessage },
+        data: { message: edgeMessage, source: edgeMessage, channel, target },
       })
     );
 
@@ -119,10 +146,40 @@ export const getChannelNodesAndEdges = ({
         source: channelId,
         target: generateIdForNode(target),
         label: channelToTargetLabel,
-        data: { message: edgeMessage },
+        data: { message: edgeMessage, source, channel, target },
       })
     );
   });
 
   return { nodes, edges };
 };
+
+type DagreGraph = any;
+
+export const getNodesAndEdgesFromDagre = ({
+  nodes,
+  edges,
+  defaultFlow,
+}: {
+  nodes: Node[];
+  edges: Edge[];
+  defaultFlow?: DagreGraph;
+}) => {
+  const flow = defaultFlow || createDagreGraph({ ranksep: 300, nodesep: 50 });
+
+  nodes.forEach((node: any) => {
+    flow.setNode(node.id, { width: 150, height: 100 });
+  });
+
+  edges.forEach((edge: any) => {
+    flow.setEdge(edge.source, edge.target);
+  });
+
+  // Render the diagram in memory getting hte X and Y
+  dagre.layout(flow);
+
+  return {
+    nodes: calculatedNodes(flow, nodes),
+    edges,
+  };
+};

package/package.json

@@ -6,18 +6,25 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.14.3",
+  "version": "2.16.0",
   "publishConfig": {
     "access": "public"
   },
   "bin": {
-    "eventcatalog": "bin/dist/eventcatalog.cjs"
+    "eventcatalog": "bin/eventcatalog.js"
   },
+  "files": [
+    "eventcatalog/",
+    "!eventcatalog/**/__tests__/",
+    "bin/",
+    "dist/",
+    "default-files-for-collections/"
+  ],
   "scripts": {
     "dev": "astro dev",
     "build:bin": "tsup",
     "prepublishOnly": "npm run build:bin",
-    "test": "vitest --config vitest.config.ts",
+    "test": "vitest",
     "test:ci": "node scripts/ci/test.js",
     "test:e2e": "playwright test",
     "start": "astro dev",
@@ -61,6 +68,7 @@
     "glob": "^10.4.1",
     "gray-matter": "^4.0.3",
     "html-to-image": "^1.11.11",
+    "js-yaml": "^4.1.0",
     "lodash.debounce": "^4.0.8",
     "lodash.merge": "4.6.2",
     "lucide-react": "^0.453.0",
@@ -84,6 +92,7 @@
     "@playwright/test": "^1.48.1",
     "@types/dagre": "^0.7.52",
     "@types/diff": "^5.2.2",
+    "@types/js-yaml": "^4.0.9",
     "@types/lodash.debounce": "^4.0.9",
     "@types/lodash.merge": "4.6.9",
     "@types/node": "^20.14.2",

package/.all-contributorsrc

@@ -1,436 +0,0 @@
-{
-  "projectName": "eventcatalog",
-  "projectOwner": "event-catalog",
-  "repoType": "github",
-  "repoHost": "https://github.com",
-  "files": [
-    "README.md"
-  ],
-  "imageSize": 100,
-  "commit": true,
-  "commitConvention": "none",
-  "contributors": [
-    {
-      "login": "boyney123",
-      "name": "David Boyne",
-      "avatar_url": "https://avatars.githubusercontent.com/u/3268013?v=4",
-      "profile": "https://boyney.io/",
-      "contributions": [
-        "code",
-        "content",
-        "design",
-        "example",
-        "ideas",
-        "doc"
-      ]
-    },
-    {
-      "login": "otbe",
-      "name": "Benjamin Otto",
-      "avatar_url": "https://avatars.githubusercontent.com/u/3391052?v=4",
-      "profile": "https://otbe.io",
-      "contributions": [
-        "code",
-        "ideas",
-        "doc",
-        "bug"
-      ]
-    },
-    {
-      "login": "pongz79",
-      "name": "Tiago Oliveira",
-      "avatar_url": "https://avatars.githubusercontent.com/u/250872?v=4",
-      "profile": "https://github.com/pongz79",
-      "contributions": [
-        "doc",
-        "bug"
-      ]
-    },
-    {
-      "login": "jaymcguinness",
-      "name": "Jay McGuinness",
-      "avatar_url": "https://avatars.githubusercontent.com/u/11387911?v=4",
-      "profile": "https://www.bigjump.com/",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "davidkpiano",
-      "name": "David Khourshid",
-      "avatar_url": "https://avatars.githubusercontent.com/u/1093738?v=4",
-      "profile": "https://github.com/davidkpiano",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "thim81",
-      "name": "thim81",
-      "avatar_url": "https://avatars.githubusercontent.com/u/952446?v=4",
-      "profile": "https://github.com/thim81",
-      "contributions": [
-        "ideas",
-        "bug",
-        "code"
-      ]
-    },
-    {
-      "login": "Muthuveerappanv",
-      "name": "Muthu",
-      "avatar_url": "https://avatars.githubusercontent.com/u/33663725?v=4",
-      "profile": "https://github.com/Muthuveerappanv",
-      "contributions": [
-        "bug"
-      ]
-    },
-    {
-      "login": "tavelli",
-      "name": "Dan Tavelli",
-      "avatar_url": "https://avatars.githubusercontent.com/u/484951?v=4",
-      "profile": "https://github.com/tavelli",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "steppi91",
-      "name": "steppi91",
-      "avatar_url": "https://avatars.githubusercontent.com/u/25939641?v=4",
-      "profile": "https://github.com/steppi91",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "donaldpipowitch",
-      "name": "Donald Pipowitch",
-      "avatar_url": "https://avatars.githubusercontent.com/u/1152805?v=4",
-      "profile": "https://twitter.com/PipoPeperoni",
-      "contributions": [
-        "bug",
-        "code"
-      ]
-    },
-    {
-      "login": "kzhen",
-      "name": "Ken",
-      "avatar_url": "https://avatars.githubusercontent.com/u/2233210?v=4",
-      "profile": "http://unravelled.dev",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "rtoro",
-      "name": "Rodolfo Toro",
-      "avatar_url": "https://avatars.githubusercontent.com/u/5186897?v=4",
-      "profile": "http://rtoro.cl",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "drub0y",
-      "name": "Drew Marsh",
-      "avatar_url": "https://avatars.githubusercontent.com/u/284152?v=4",
-      "profile": "http://blog.hackedbrain.com",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "dpwdec",
-      "name": "Dec Kolakowski",
-      "avatar_url": "https://avatars.githubusercontent.com/u/51292634?v=4",
-      "profile": "https://github.com/dpwdec",
-      "contributions": [
-        "code",
-        "doc"
-      ]
-    },
-    {
-      "login": "dytyniuk",
-      "name": "Yevhenii Dytyniuk",
-      "avatar_url": "https://avatars.githubusercontent.com/u/1890615?v=4",
-      "profile": "https://github.com/dytyniuk",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "lcsbltm",
-      "name": "lcsbltm",
-      "avatar_url": "https://avatars.githubusercontent.com/u/25868958?v=4",
-      "profile": "https://github.com/lcsbltm",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "martzcodes",
-      "name": "Matt Martz",
-      "avatar_url": "https://avatars.githubusercontent.com/u/978362?v=4",
-      "profile": "https://matt.martz.codes",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "michelgrootjans",
-      "name": "Michel Grootjans",
-      "avatar_url": "https://avatars.githubusercontent.com/u/345770?v=4",
-      "profile": "https://github.com/michelgrootjans",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "arturoabruzzini",
-      "name": "Arturo Abruzzini",
-      "avatar_url": "https://avatars.githubusercontent.com/u/17528406?v=4",
-      "profile": "https://github.com/arturoabruzzini",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "adlecluse",
-      "name": "Ad L'Ecluse",
-      "avatar_url": "https://avatars.githubusercontent.com/u/13390934?v=4",
-      "profile": "https://github.com/adlecluse",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "rafaelrenanpacheco",
-      "name": "Rafael Renan Pacheco",
-      "avatar_url": "https://avatars.githubusercontent.com/u/12160864?v=4",
-      "profile": "https://github.com/rafaelrenanpacheco",
-      "contributions": [
-        "code",
-        "doc"
-      ]
-    },
-    {
-      "login": "ldiego73",
-      "name": "Luis Diego",
-      "avatar_url": "https://avatars.githubusercontent.com/u/394222?v=4",
-      "profile": "https://ldiego73.github.io/",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "DanielRuf",
-      "name": "Daniel Ruf",
-      "avatar_url": "https://avatars.githubusercontent.com/u/827205?v=4",
-      "profile": "https://www.linkedin.com/in/danielruf/",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "frenkan",
-      "name": "Fredrik Johansson",
-      "avatar_url": "https://avatars.githubusercontent.com/u/859840?v=4",
-      "profile": "https://github.com/frenkan",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "name": "Naresh Kumar Reddy Gaddam",
-      "avatar_url": "https://avatars.githubusercontent.com/u/2576375?v=4",
-      "profile": "https://gaddam1987.github.io/",
-      "login": "gaddam1987",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "dremonkey",
-      "name": "Andre Deutmeyer",
-      "avatar_url": "https://avatars.githubusercontent.com/u/480159?v=4",
-      "profile": "https://github.com/dremonkey",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "pebbz",
-      "name": "Pebbz",
-      "avatar_url": "https://avatars.githubusercontent.com/u/1685464?v=4",
-      "profile": "https://github.com/pebbz",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "aholbreich",
-      "name": "Alexander Holbreich",
-      "avatar_url": "https://avatars.githubusercontent.com/u/16252784?v=4",
-      "profile": "https://alexander.holbreich.org/",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "jslim",
-      "name": "José Delgado",
-      "avatar_url": "https://avatars.githubusercontent.com/u/30370263?v=4",
-      "profile": "https://www.josedelgadoing.com/",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "jlee-spt",
-      "name": "jlee-spt",
-      "avatar_url": "https://avatars.githubusercontent.com/u/135801616?v=4",
-      "profile": "https://github.com/jlee-spt",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "kimrejstrom",
-      "name": "Kim Rejström",
-      "avatar_url": "https://avatars.githubusercontent.com/u/26428365?v=4",
-      "profile": "https://github.com/kimrejstrom",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "cgabard",
-      "name": "Christophe Gabard",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6103932?v=4",
-      "profile": "https://github.com/cgabard",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "WaYdotNET",
-      "name": "Carlo Bertini",
-      "avatar_url": "https://avatars.githubusercontent.com/u/197466?v=4",
-      "profile": "http://www.waydotnet.com",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "dreglad",
-      "name": "David Regla",
-      "avatar_url": "https://avatars.githubusercontent.com/u/50302?v=4",
-      "profile": "https://github.com/dreglad",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "marciovmartins",
-      "name": "Marcio Vinicius",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6377735?v=4",
-      "profile": "https://blogdomarcioweb.wordpress.com/",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "danielcastill0",
-      "name": "Daniel Andres Castillo Ardila",
-      "avatar_url": "https://avatars.githubusercontent.com/u/40574235?v=4",
-      "profile": "https://github.com/danielcastill0",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "debae",
-      "name": "Baerten Dennis",
-      "avatar_url": "https://avatars.githubusercontent.com/u/2007116?v=4",
-      "profile": "http://www.ennovative-solutions.be",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "ryancormack",
-      "name": "Ryan Cormack",
-      "avatar_url": "https://avatars.githubusercontent.com/u/1962883?v=4",
-      "profile": "https://github.com/ryancormack",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "nathanbirrell",
-      "name": "Nathan Birrell",
-      "avatar_url": "https://avatars.githubusercontent.com/u/4300215?v=4",
-      "profile": "https://natee.biz",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "jacktomlinson",
-      "name": "Jack Tomlinson",
-      "avatar_url": "https://avatars.githubusercontent.com/u/15871032?v=4",
-      "profile": "https://www.jacktomlinson.co.uk/",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "carlosallexandre",
-      "name": "Carlos Rodrigues",
-      "avatar_url": "https://avatars.githubusercontent.com/u/20143946?v=4",
-      "profile": "https://github.com/carlosallexandre",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "XaaXaaX",
-      "name": "omid eidivandi",
-      "avatar_url": "https://avatars.githubusercontent.com/u/13409925?v=4",
-      "profile": "https://github.com/XaaXaaX",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "hpatoio",
-      "name": "Simone Fumagalli",
-      "avatar_url": "https://avatars.githubusercontent.com/u/249948?v=4",
-      "profile": "https://github.com/hpatoio",
-      "contributions": [
-        "doc"
-      ]
-    },
-    {
-      "login": "d-o-h",
-      "name": "d-o-h",
-      "avatar_url": "https://avatars.githubusercontent.com/u/23699653?v=4",
-      "profile": "https://github.com/d-o-h",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "skyrpex",
-      "name": "Cristian Pallarés",
-      "avatar_url": "https://avatars.githubusercontent.com/u/1077520?v=4",
-      "profile": "https://pallares.io",
-      "contributions": [
-        "code"
-      ]
-    }
-  ],
-  "contributorsPerLine": 7,
-  "skipCi": true,
-  "commitType": "docs"
-}

package/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.1/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "restricted",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/.github/CODEOWNERS

@@ -1,3 +0,0 @@
-# https://help.github.com/articles/about-codeowners/
-
-* @boyney123