@eventcatalog/core 2.8.3 → 2.8.5

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @eventcatalog/core
 
+## 2.8.5
+
+### Patch Changes
+
+- db41392: fix(core): flows now work with latest semver for services
+- 8376da8: chore(core): fixed url builder for server/client components
+
+## 2.8.4
+
+### Patch Changes
+
+- 95ca9aa: chore(core): removed type checks for consuming catalogs
+
 ## 2.8.3
 
 ### Patch Changes

package/astro.config.mjs

@@ -48,6 +48,15 @@ export default defineConfig({
     pagefind(),
   ],
   vite: {
+    define: {
+      /**
+       * Trailing slash is exposed as global variable here principally for `@utils/url-builder`.
+       * The utility is used by client components and because of that it can't direct import 
+       * the eventcatalog.config, as the config use packages that only run in node environments,
+       * such as `node:path`.
+       */
+      '__EC_TRAILING_SLASH__': config.trailingSlash || false,
+    },
     build: {
       commonjsOptions: {
         transformMixedEsModules: true,

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.8.3",
+  "version": "2.8.5",
   "publishConfig": {
     "access": "public"
   },
@@ -21,7 +21,7 @@
     "test": "vitest --config vitest.config.ts",
     "test:ci": "node scripts/ci/test.js",
     "start": "astro dev",
-    "build": "npm run scripts:hydrate-content && node scripts/analytics/log-build.js && astro check --minimumSeverity error && astro build",
+    "build": "npm run scripts:hydrate-content && node scripts/analytics/log-build.js && astro build",
     "build:cd": "node scripts/build-ci.js",
     "preview": "astro preview",
     "astro": "astro",
@@ -41,7 +41,6 @@
     "@astrojs/react": "^3.6.2",
     "@astrojs/tailwind": "^5.1.2",
     "@asyncapi/react-component": "^2.2.2",
-    "@changesets/cli": "^2.27.5",
     "@headlessui/react": "^2.0.3",
     "@heroicons/react": "^2.1.3",
     "@parcel/watcher": "^2.4.1",
@@ -82,6 +81,7 @@
     "@types/semver": "^7.5.8"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.27.5",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "prettier": "^3.3.3",

package/scripts/build-ci.js

@@ -16,7 +16,10 @@ fs.copyFileSync(join(projectDIR, 'eventcatalog.config.js'), join(catalogDir, 'ev
 
 fs.copyFileSync(join(projectDIR, 'eventcatalog.styles.css'), join(catalogDir, 'eventcatalog.styles.css'));
 
-execSync(`cross-env NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run build`, {
-  cwd: catalogDir,
-  stdio: 'inherit',
-});
+execSync(
+  `cross-env NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run build && astro check --minimumSeverity error`,
+  {
+    cwd: catalogDir,
+    stdio: 'inherit',
+  }
+);

package/src/components/MDX/NodeGraph/NodeGraph.astro

@@ -5,8 +5,6 @@ import { getNodesAndEdges as getNodesAndEdgesForEvent } from '@utils/events/node
 import { getNodesAndEdges as getNodesAndEdgesForCommand } from '@utils/commands/node-graph';
 import { getNodesAndEdges as getNodesAndEdgesForDomain } from '@utils/domains/node-graph';
 import { getNodesAndEdges as getNodesAndEdgesForFlows } from '@utils/flows/node-graph';
-import { buildUrl } from '@utils/url-builder';
-import config from '@eventcatalog';
 
 interface Props {
   id: string;
@@ -80,13 +78,6 @@ if (collection === 'flows') {
   nodes = eventNodes;
   edges = eventEdges;
 }
-
-const getDocUrlForCollection = () => {
-  return buildUrl(`/docs/${collection}/${id}/${version}`);
-};
-const getVisualiserUrlForCollection = () => {
-  return buildUrl(`/visualiser/${collection}/${id}/${version}`);
-};
 ---
 
 <div>
@@ -99,7 +90,6 @@ const getVisualiserUrlForCollection = () => {
     href={href.url}
     linkTo={linkTo}
     client:only="react"
-    urlHasTrailingSlash={config.trailingSlash}
     linksToVisualiser={linksToVisualiser}
   />
 </div>

package/src/components/MDX/NodeGraph/NodeGraph.tsx

@@ -23,7 +23,7 @@ import type { CollectionEntry } from 'astro:content';
 import { navigate } from 'astro:transitions/client';
 import type { CollectionTypes } from '@types';
 import DownloadButton from './DownloadButton';
-import { buildUrl } from '@utils/url-builder-client';
+import { buildUrl } from '@utils/url-builder';
 
 interface Props {
   nodes: any;
@@ -34,18 +34,14 @@ interface Props {
   includeControls?: boolean;
   linkTo: 'docs' | 'visualiser';
   includeKey?: boolean;
-  urlHasTrailingSlash?: boolean;
   linksToVisualiser?: boolean;
 }
 
-const getDocUrlForCollection = (collectionItem: CollectionEntry<CollectionTypes>, trailingSlash?: boolean) => {
-  return buildUrl(`/docs/${collectionItem.collection}/${collectionItem.data.id}/${collectionItem.data.version}`, trailingSlash);
+const getDocUrlForCollection = (collectionItem: CollectionEntry<CollectionTypes>) => {
+  return buildUrl(`/docs/${collectionItem.collection}/${collectionItem.data.id}/${collectionItem.data.version}`);
 };
-const getVisualiserUrlForCollection = (collectionItem: CollectionEntry<CollectionTypes>, trailingSlash?: boolean) => {
-  return buildUrl(
-    `/visualiser/${collectionItem.collection}/${collectionItem.data.id}/${collectionItem.data.version}`,
-    trailingSlash
-  );
+const getVisualiserUrlForCollection = (collectionItem: CollectionEntry<CollectionTypes>) => {
+  return buildUrl(`/visualiser/${collectionItem.collection}/${collectionItem.data.id}/${collectionItem.data.version}`);
 };
 
 const NodeGraphBuilder = ({
@@ -55,7 +51,6 @@ const NodeGraphBuilder = ({
   includeBackground = true,
   linkTo = 'docs',
   includeKey = true,
-  urlHasTrailingSlash,
   linksToVisualiser = false,
 }: Props) => {
   const nodeTypes = useMemo(
@@ -93,10 +88,10 @@ const NodeGraphBuilder = ({
     (_: any, node: Node) => {
       if (linksToVisualiser) {
         if (node.type === 'events' || node.type === 'commands') {
-          navigate(getVisualiserUrlForCollection(node.data.message, urlHasTrailingSlash));
+          navigate(getVisualiserUrlForCollection(node.data.message));
         }
         if (node.type === 'services') {
-          navigate(getVisualiserUrlForCollection(node.data.service, urlHasTrailingSlash));
+          navigate(getVisualiserUrlForCollection(node.data.service));
         }
         return;
       }
@@ -198,7 +193,6 @@ interface NodeGraphProps {
   linkTo: 'docs' | 'visualiser';
   includeKey?: boolean;
   footerLabel?: string;
-  urlHasTrailingSlash?: boolean;
   linksToVisualiser?: boolean;
 }
 
@@ -212,7 +206,6 @@ const NodeGraph = ({
   hrefLabel = 'Open in visualizer',
   includeKey = true,
   footerLabel,
-  urlHasTrailingSlash,
   linksToVisualiser = false,
 }: NodeGraphProps) => {
   const [elem, setElem] = useState(null);
@@ -234,7 +227,6 @@ const NodeGraph = ({
             title={title}
             linkTo={linkTo}
             includeKey={includeKey}
-            urlHasTrailingSlash={urlHasTrailingSlash}
             linksToVisualiser={linksToVisualiser}
           />
 

package/src/components/MDX/Tiles/Tile.astro

@@ -1,7 +1,7 @@
 ---
 import type { ComponentType } from 'react';
 import * as Icons from '@heroicons/react/24/solid';
-import { buildUrl } from '@utils/url-builder-client';
+import { buildUrl } from '@utils/url-builder';
 
 interface Props {
   href: string;

package/src/env.d.ts

@@ -1,2 +1,4 @@
 /// <reference path="../.astro/types.d.ts" />
 /// <reference types="astro/client" />
+
+declare const __EC_TRAILING_SLASH__: boolean;

package/src/utils/flows/node-graph.ts

@@ -16,9 +16,8 @@ interface Props {
 }
 
 const getServiceNode = (step: any, services: CollectionEntry<'services'>[]) => {
-  const service = services.find(
-    (service) => service.data.id === step.service.id && service.data.version === step.service.version
-  );
+  const servicesForVersion = getItemsFromCollectionByIdAndSemverOrLatest(services, step.service.id, step.service.version);
+  const service = servicesForVersion?.[0];
   return {
     ...step,
     type: service ? service.collection : 'step',

package/src/utils/url-builder.ts

@@ -1,5 +1,3 @@
-import config from '@eventcatalog';
-
 const cleanUrl = (url: string) => {
   return url.replace(/\/+/g, '/');
 };
@@ -7,7 +5,7 @@ const cleanUrl = (url: string) => {
 // Custom URL builder as Astro does not support this stuff out the box
 export const buildUrl = (url: string, ignoreTrailingSlash = false) => {
   // Should a trailingSlash be added to urls?
-  const trailingSlash = config.trailingSlash || false;
+  const trailingSlash = __EC_TRAILING_SLASH__;
 
   let newUrl = url;
 

package/src/utils/url-builder-client.ts

@@ -1,22 +0,0 @@
-const cleanUrl = (url: string) => {
-  return url.replace(/\/+/g, '/');
-};
-
-// Custom URL builder as Astro does not support this stuff out the box.
-// Used on client components to build URLs
-export const buildUrl = (url: string, trailingSlash = false, ignoreTrailingSlash = false) => {
-  let newUrl = url;
-
-  // If the base URL is not the root, we need to append it
-  if (import.meta.env.BASE_URL !== '/') {
-    newUrl = `${import.meta.env.BASE_URL}${url}`;
-  }
-
-  // Should we add a trailing slash to the url?
-  if (trailingSlash && !ignoreTrailingSlash) {
-    if (url.endsWith('/')) return newUrl;
-    return cleanUrl(`${newUrl}/`);
-  }
-
-  return cleanUrl(newUrl);
-};