@eventcatalog/core 2.65.0 → 3.0.0-beta.0

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

@@ -1,91 +0,0 @@
-export interface MessageItem {
-  href: string;
-  label: string;
-  service: string;
-  id: string;
-  direction: 'sends' | 'receives';
-  type: 'command' | 'query' | 'event';
-  collection: string;
-  data: {
-    name: string;
-  };
-}
-
-export interface EntityItem {
-  href: string;
-  label: string;
-  id: string;
-  name: string;
-}
-
-export interface ServiceItem {
-  href: string;
-  label: string;
-  name: string;
-  id: string;
-  version: string;
-  sidebar?: {
-    badge?: string;
-    color?: string;
-    backgroundColor?: string;
-  };
-  draft: boolean | { title?: string; message: string };
-  sends: MessageItem[];
-  receives: MessageItem[];
-  entities: EntityItem[];
-  writesTo: MessageItem[];
-  readsFrom: MessageItem[];
-  specifications?: {
-    type: string;
-    path: string;
-    name?: string;
-    filename?: string;
-    filenameWithoutExtension?: string;
-  }[];
-}
-
-export interface DomainItem {
-  href: string;
-  label: string;
-  id: string;
-  name: string;
-  services: any[];
-  domains: any[];
-  entities: EntityItem[];
-}
-
-export interface FlowItem {
-  href: string;
-  label: string;
-}
-
-export interface DesignItem {
-  href: string;
-  label: string;
-  id: string;
-  name: string;
-}
-
-export interface Resources {
-  'context-map'?: Array<{
-    href: string;
-    label: string;
-    id: string;
-    name: string;
-  }>;
-  domains?: DomainItem[];
-  services?: ServiceItem[];
-  flows?: FlowItem[];
-  designs?: DesignItem[];
-  messagesNotInService?: MessageItem[];
-  commands?: MessageItem[];
-  queries?: MessageItem[];
-  events?: MessageItem[];
-  containers?: MessageItem[];
-}
-
-export interface ListViewSideBarProps {
-  resources: Resources;
-  currentPath: string;
-  showOrphanedMessages: boolean;
-}

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

@@ -1,201 +0,0 @@
-import { isCollectionVisibleInCatalog } from '@eventcatalog';
-import { buildUrl } from '@utils/url-builder';
-import { getChannels } from '@utils/channels';
-import { getDomains } from '@utils/collections/domains';
-import { getFlows } from '@utils/collections/flows';
-import { getServices, getSpecificationsForService } from '@utils/collections/services';
-import { getCommands } from '@utils/commands';
-import { getEvents } from '@utils/events';
-import { getQueries } from '@utils/queries';
-import { getDesigns } from '@utils/collections/designs';
-import { getContainers } from '@utils/collections/containers';
-
-const stripCollection = (collection: any) => {
-  return collection.map((item: any) => ({
-    data: {
-      id: item.data.id,
-      version: item.data.version,
-    },
-  }));
-};
-
-export async function getResourcesForNavigation({ currentPath }: { currentPath: string }) {
-  const events = await getEvents({ getAllVersions: false });
-  const commands = await getCommands({ getAllVersions: false });
-  const queries = await getQueries({ getAllVersions: false });
-  const services = await getServices({ getAllVersions: false });
-  const domains = await getDomains({ getAllVersions: false });
-  const channels = await getChannels({ getAllVersions: false });
-  const flows = await getFlows({ getAllVersions: false });
-  const containers = await getContainers({ getAllVersions: false });
-  const designs = await getDesigns({ getAllVersions: false });
-
-  const messages = [...events, ...commands, ...queries];
-
-  // messages that are not in a service (sends or receives)
-  const messagesNotInService = messages.filter(
-    (message) =>
-      !services.some(
-        (service) =>
-          service.data?.sends?.some((send: any) => send.data.id === message.data.id) ||
-          service.data?.receives?.some((receive: any) => receive.data.id === message.data.id)
-      )
-  );
-
-  const route = currentPath.includes('visualiser') ? 'visualiser' : 'docs';
-
-  // Just the domains for now.
-  const allDataAsSideNav = [...domains, ...services, ...flows, ...channels, ...containers].reduce((acc, item) => {
-    const title = item.collection;
-    const group = acc[title] || [];
-
-    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;
-
-    const writesTo = isCollectionService ? item.data.writesTo || null : null;
-    const readsFrom = isCollectionService ? item.data.readsFrom || null : null;
-
-    // Add href to the sends and receives
-    const sendsWithHref = sends?.map((send: any) => ({
-      id: send.data.id,
-      data: {
-        name: send.data.name,
-        sidebar: send.data.sidebar,
-        aggregateRoot: send?.data?.aggregateRoot,
-        draft: send.data.draft,
-      },
-      collection: send.collection,
-      href: buildUrl(`/${route}/${send.collection}/${send.data.id}/${send.data.version}`),
-    }));
-    const receivesWithHref = receives?.map((receive: any) => ({
-      id: receive.data.id,
-      data: {
-        name: receive.data.name,
-        sidebar: receive.data.sidebar,
-        aggregateRoot: receive?.data?.aggregateRoot,
-        draft: receive.data.draft,
-      },
-      collection: receive.collection,
-      href: buildUrl(`/${route}/${receive.collection}/${receive.data.id}/${receive.data.version}`),
-    }));
-    const entitiesWithHref = entities?.map((entity: any) => ({
-      id: entity.data.id,
-      data: {
-        name: entity.data.name,
-        sidebar: entity.data.sidebar,
-        aggregateRoot: entity?.data?.aggregateRoot,
-        draft: entity.data.draft,
-      },
-      collection: entity.collection,
-      href: buildUrl(`/${route}/${entity.collection}/${entity.data.id}/${entity.data.version}`),
-    }));
-
-    const writesToWithHref = writesTo?.map((writeTo: any) => ({
-      id: writeTo.data.id,
-      data: {
-        name: writeTo.data.name,
-        sidebar: {
-          badge: writeTo.data.container_type || writeTo.collection,
-          backgroundColor: 'bg-blue-100 text-blue-600',
-        },
-      },
-      collection: writeTo.collection,
-      href: buildUrl(`/${route}/${writeTo.collection}/${writeTo.data.id}/${writeTo.data.version}`),
-    }));
-
-    const readsFromWithHref = readsFrom?.map((readFrom: any) => ({
-      id: readFrom.data.id,
-      data: {
-        name: readFrom.data.name,
-        sidebar: {
-          badge: readFrom.data.container_type || readFrom.collection,
-          backgroundColor: 'bg-blue-100 text-indigo-600',
-        },
-      },
-      collection: readFrom.collection,
-      href: buildUrl(`/${route}/${readFrom.collection}/${readFrom.data.id}/${readFrom.data.version}`),
-    }));
-
-    // don't render items if we are in the visualiser and the item has visualiser set to false
-    if (currentPath.includes('visualiser') && item.data.visualiser === false) {
-      return acc;
-    }
-
-    const navigationItem = {
-      label: item.data.name,
-      version: item.data.version,
-      // items: item.collection === 'users' ? [] : item.headings,
-      visible: isCollectionVisibleInCatalog(item.collection),
-      // @ts-ignore
-      href: item.data.version
-        ? // @ts-ignore
-          buildUrl(`/${route}/${item.collection}/${item.data.id}/${item.data.version}`)
-        : buildUrl(`/${route}/${item.collection}/${item.data.id}`),
-      collection: item.collection,
-      servicesCount,
-      id: item.data.id,
-      name: item.data.name,
-      draft: item.data.draft,
-      services: isCollectionDomain ? stripCollection(item.data.services) : null,
-      domains: isCollectionDomain ? stripCollection(item.data.domains) : null,
-      sends: sendsWithHref,
-      receives: receivesWithHref,
-      entities: entitiesWithHref,
-      specifications: isCollectionService ? getSpecificationsForService(item) : null,
-      writesTo: writesToWithHref,
-      readsFrom: readsFromWithHref,
-      sidebar: item.data?.sidebar,
-      renderInVisualiser: item.data?.visualiser ?? true,
-    };
-
-    group.push(navigationItem);
-
-    return {
-      ...acc,
-      [title]: group,
-    };
-  }, {} as any);
-
-  // Add messagesNotInService
-  const messagesNotInServiceAsSideNav = messagesNotInService.map((item) => ({
-    label: item.data.name,
-    version: item.data.version,
-    id: item.data.id,
-    name: item.data.name,
-    draft: item.data.draft,
-    href: buildUrl(`/${route}/${item.collection}/${item.data.id}/${item.data.version}`),
-    collection: item.collection,
-  }));
-
-  const sideNav = {
-    ...(currentPath.includes('visualiser')
-      ? {
-          'context-map': [
-            {
-              label: 'Domain Integration Map',
-              href: buildUrl('/visualiser/domain-integrations'),
-              collection: 'domain-integrations',
-            },
-          ],
-        }
-      : {}),
-    ...allDataAsSideNav,
-    messagesNotInService: messagesNotInServiceAsSideNav,
-  };
-
-  // Add designs?
-  if (designs.length > 0) {
-    sideNav['designs'] = designs.map((design) => ({
-      label: design.data.name,
-      href: buildUrl(`/visualiser/designs/${design.data.id}`),
-      collection: 'designs',
-    }));
-  }
-
-  return sideNav;
-}

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

@@ -1,190 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import os from 'node:os';
-import gm from 'gray-matter';
-import { globSync } from 'glob';
-import type { CollectionKey } from 'astro:content';
-import { buildUrl } from '@utils/url-builder';
-
-export type TreeNode = {
-  id: string;
-  name: string;
-  version: string;
-  href?: string;
-  type: CollectionKey | null;
-  children: TreeNode[];
-};
-
-/**
- * Resource types that should be in the sidenav
- */
-const RESOURCE_TYPES = ['domains', 'entities', 'services', 'events', 'commands', 'queries', 'flows', 'channels', 'containers'];
-// const RESOURCE_TYPES = ['domains', 'services', 'events', 'commands', 'queries', 'flows', 'channels'];
-
-/**
- * Check if the path has a RESOURCE_TYPE on path
- */
-function canBeResource(dirPath: string) {
-  const parts = dirPath.split(path.sep);
-  for (let i = parts.length - 1; i >= 0; i--) {
-    if (RESOURCE_TYPES.includes(parts[i])) return true;
-  }
-  return false;
-}
-
-function isNotVersioned(dirPath: string) {
-  const parts = dirPath.split(path.sep);
-  return parts.every((p) => p !== 'versioned');
-}
-
-function getResourceType(filePath: string): CollectionKey | null {
-  const parts = filePath.split(path.sep);
-  for (let i = parts.length - 1; i >= 0; i--) {
-    if (RESOURCE_TYPES.includes(parts[i])) return parts[i] as CollectionKey;
-  }
-  return null;
-}
-
-function buildTreeOfDir(directory: string, parentNode: TreeNode, options: { ignore?: CollectionKey[] }) {
-  let node: TreeNode | null = null;
-
-  const resourceType = getResourceType(directory);
-
-  const markdownFiles = globSync(path.join(directory, '/*.mdx'), { windowsPathsNoEscape: os.platform() === 'win32' });
-  const isResourceIgnored = options?.ignore && resourceType && options.ignore.includes(resourceType);
-
-  if (markdownFiles.length > 0 && !isResourceIgnored) {
-    const resourceFilePath = markdownFiles.find((md) => md.endsWith('index.mdx'));
-    if (resourceFilePath) {
-      const resourceDef = gm.read(resourceFilePath);
-      node = {
-        id: resourceDef.data.id,
-        name: resourceDef.data.name,
-        type: resourceType,
-        version: resourceDef.data.version,
-        children: [],
-      };
-      parentNode.children.push(node);
-    }
-  }
-
-  const directories = fs.readdirSync(directory).filter((name) => {
-    const dirPath = path.join(directory, name);
-    return fs.statSync(dirPath).isDirectory() && isNotVersioned(dirPath) && canBeResource(dirPath);
-  });
-  for (const dir of directories) {
-    buildTreeOfDir(path.join(directory, dir), node || parentNode, options);
-  }
-}
-
-function forEachTreeNodeOf(node: TreeNode, ...callbacks: Array<(node: TreeNode) => void>) {
-  const next = node.children;
-
-  callbacks.forEach((cb) => cb(node));
-
-  // Go to next level
-  next.forEach((n) => {
-    forEachTreeNodeOf(n, ...callbacks);
-  });
-}
-
-function addHrefToNode(basePathname: 'docs' | 'visualiser') {
-  return (node: TreeNode) => {
-    node.href = encodeURI(
-      buildUrl(
-        `/${basePathname}/${node.type}/${node.id}${node.type === 'teams' || node.type === 'users' ? '' : `/${node.version}`}`
-      )
-    );
-  };
-}
-
-function orderChildrenByName(parentNode: TreeNode) {
-  parentNode.children.sort((a, b) => a.name.localeCompare(b.name));
-}
-
-function groupChildrenByType(parentNode: TreeNode) {
-  if (parentNode.children.length === 0) return; // Only group if there are children
-
-  const acc: Record<string, TreeNode[]> = {};
-
-  // Flows and messages are collapsed by default
-
-  parentNode.children.forEach((n) => {
-    if (n.type === null) return; // TODO: Just ignore or remove the type null???
-    if (!(n.type in acc)) acc[n.type] = [];
-    acc[n.type].push(n);
-  });
-
-  // Collapse everything except domains
-  const AUTO_EXPANDED_TYPES = ['domains'];
-
-  parentNode.children = Object.entries(acc)
-    // Order label nodes by RESOURCE_TYPES
-    .sort(([aType], [bType]) => RESOURCE_TYPES.indexOf(aType) - RESOURCE_TYPES.indexOf(bType))
-    // Construct the label nodes
-    .map(([type, nodes]) => {
-      return {
-        id: `${parentNode.id}/${type}`,
-        name: type === 'containers' ? 'Data' : type,
-        type: type as CollectionKey,
-        version: '0',
-        children: nodes,
-        isExpanded: AUTO_EXPANDED_TYPES.includes(type),
-        isLabel: true,
-      };
-    });
-}
-
-const treeViewCache = new Map<string, TreeNode>();
-
-export function getTreeView({ projectDir, currentPath }: { projectDir: string; currentPath: string }): TreeNode {
-  const basePathname = currentPath.split('/').find((p) => p === 'docs' || p === 'visualiser') || 'docs';
-
-  const cacheKey = `${projectDir}:${basePathname}`;
-  if (treeViewCache.has(cacheKey)) return treeViewCache.get(cacheKey)!;
-
-  const rootNode: TreeNode = {
-    id: '/',
-    name: 'root',
-    type: null,
-    version: '0',
-    children: [],
-  };
-
-  buildTreeOfDir(projectDir, rootNode, {
-    ignore: basePathname === 'visualiser' ? ['teams', 'users', 'channels'] : undefined,
-  });
-
-  // prettier-ignore
-  forEachTreeNodeOf(
-    rootNode,
-    addHrefToNode(basePathname),
-    orderChildrenByName,
-    groupChildrenByType,
-  );
-
-  if (basePathname === 'visualiser') {
-    rootNode.children.unshift({
-      id: '/bounded-context-map',
-      name: 'bounded context map',
-      type: 'bounded-context-map' as any,
-      version: '0',
-      isLabel: true,
-      children: [
-        {
-          id: '/domain-map',
-          name: 'Domain map',
-          href: buildUrl('/visualiser/context-map'),
-          type: 'bounded-context-map' as any,
-          version: '',
-          children: [],
-        },
-      ],
-    } as TreeNode);
-  }
-
-  // Store in cache before returning
-  treeViewCache.set(cacheKey, rootNode);
-
-  return rootNode;
-}

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

@@ -1,94 +0,0 @@
-import { gray } from 'tailwindcss/colors';
-import { TreeView } from '@components/TreeView';
-import { navigate } from 'astro:transitions/client';
-import type { TreeNode as RawTreeNode } from './getTreeView';
-import { getIconForCollection } from '@utils/collections/icons';
-import { useEffect, useState } from 'react';
-
-type TreeNode = RawTreeNode & { isLabel?: true; isDefaultExpanded?: boolean; isExpanded?: boolean };
-
-function isCurrentNode(node: TreeNode, currentPathname: string) {
-  return currentPathname === node.href;
-}
-
-function TreeNode({ node }: { node: TreeNode }) {
-  const Icon = getIconForCollection(node.type ?? '');
-  const [isCurrent, setIsCurrent] = useState(document.location.pathname === node.href);
-
-  useEffect(() => {
-    const abortCtrl = new AbortController();
-    // prettier-ignore
-    document.addEventListener(
-      'astro:page-load', 
-      () => setIsCurrent(document.location.pathname === node.href), 
-      { signal: abortCtrl.signal },
-    );
-    return () => abortCtrl.abort();
-  }, [document, node]);
-
-  return (
-    <TreeView.Item
-      key={node.id}
-      id={node.id}
-      current={isCurrent}
-      defaultExpanded={node?.isExpanded || node?.isDefaultExpanded}
-      onSelect={node?.isLabel || !node?.href ? undefined : () => navigate(node.href!)}
-    >
-      {!node?.isLabel && (
-        <TreeView.LeadingVisual>
-          <Icon className="w-3 -ml-1" />
-        </TreeView.LeadingVisual>
-      )}
-      <span
-        className={node?.isLabel ? ' capitalize  text-[13px]  text-purple-900 font-extrabold' : 'font-light text-[14px] -ml-0.5'}
-      >
-        {node.name} {node.isLabel ? `(${node.children.length})` : ''}
-      </span>
-      {(node.children || []).length > 0 && (
-        <TreeView.SubTree>
-          {node.children!.map((childNode) => (
-            <TreeNode key={childNode.id} node={childNode} />
-          ))}
-        </TreeView.SubTree>
-      )}
-    </TreeView.Item>
-  );
-}
-
-export function SideNavTreeView({ tree }: { tree: TreeNode }) {
-  function bubbleUpExpanded(parentNode: TreeNode) {
-    if (isCurrentNode(parentNode, document.location.pathname)) return true;
-    return (parentNode.isDefaultExpanded = parentNode.children.some(bubbleUpExpanded));
-  }
-  bubbleUpExpanded(tree);
-
-  return (
-    <nav id="resources-tree" className="px-2 py-2">
-      <TreeView
-        truncate={false}
-        style={{
-          // @ts-expect-error inline css var
-          '--base-size-8': '0.5rem',
-          '--base-size-12': '0.75rem',
-          '--borderColor-muted': '#fff',
-          '--borderRadius-medium': '0.375rem',
-          '--borderWidth-thick': '0.125rem',
-          '--borderWidth-thin': '0.0625rem',
-          '--boxShadow-thick': 'inset 0 0 0 var(--borderWidth-thick)',
-          '--control-transparent-bgColor-hover': '#656c7626',
-          '--control-transparent-bgColor-selected': '#656c761a',
-          // '--fgColor-accent': purple[700],
-          '--fgColor-default': gray[600],
-          '--fgColor-muted': gray[600],
-          '--text-body-size-medium': '0.875rem',
-          '--stack-gap-condensed': '0.5rem',
-          '--treeViewItem-leadingVisual-iconColor-rest': 'var(--fgColor-muted)',
-        }}
-      >
-        {tree.children.map((n) => (
-          <TreeNode key={n.id} node={n} />
-        ))}
-      </TreeView>
-    </nav>
-  );
-}