@eventcatalog/core 2.65.0 → 3.0.0-beta.0

package/eventcatalog/src/pages/architecture/architecture.astro

@@ -1,101 +0,0 @@
----
-import { getDomains, getMessagesForDomain } from '@utils/collections/domains';
-import { getServices } from '@utils/collections/services';
-import { getContainers } from '@utils/collections/containers';
-import { getMessages } from '@utils/messages';
-import type { ExtendedDomain } from '@components/Grids/DomainGrid';
-import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
-import DomainGrid from '@components/Grids/DomainGrid';
-import ServiceGrid from '@components/Grids/ServiceGrid';
-import MessageGrid from '@components/Grids/MessageGrid';
-import { removeContentFromCollection } from '@utils/collections/util';
-
-import type { CollectionEntry } from 'astro:content';
-import type { CollectionMessageTypes } from '@types';
-
-import { ClientRouter, fade } from 'astro:transitions';
-// Define valid types and their corresponding data fetchers
-const VALID_TYPES = ['domains', 'services', 'messages'] as const;
-type ValidType = (typeof VALID_TYPES)[number];
-
-interface Service extends CollectionEntry<'services'> {
-  sends: CollectionEntry<'events' | 'commands' | 'queries'>[];
-  receives: CollectionEntry<'events' | 'commands' | 'queries'>[];
-}
-
-const { type, embeded = false } = Astro.props as { type: ValidType; embeded: boolean };
-
-// Get data based on type
-let items: Service[] | CollectionEntry<'commands'>[] | CollectionEntry<CollectionMessageTypes>[] = [];
-let domains: ExtendedDomain[] = [];
-let containers: CollectionEntry<'containers'>[] = [];
-
-const getDomainsForArchitecturePages = async () => {
-  const domains = await getDomains({ getAllVersions: false });
-
-  // Get messages for each domain
-  return Promise.all(
-    domains.map(async (domain) => {
-      const messages = await getMessagesForDomain(domain);
-      // @ts-ignore we have to remove markdown information, as it's all send to the astro components. This reduced the page size.
-      return {
-        ...domain,
-        sends: messages.sends.map((s) => ({ ...s, body: undefined, catalog: undefined })),
-        receives: messages.receives.map((r) => ({ ...r, body: undefined, catalog: undefined })),
-        catalog: undefined,
-        body: undefined,
-      } as ExtendedDomain;
-    })
-  );
-};
-
-if (type === 'domains' || type === 'services') {
-  domains = await getDomainsForArchitecturePages();
-}
-
-if (type === 'services') {
-  const services = await getServices({ getAllVersions: false });
-  let filteredServices = services.map((s) => {
-    // @ts-ignore we have to remove markdown information, as it's all send to the astro components. This reduced the page size.
-    return {
-      ...s,
-      sends: (s.data.sends || []).map((s) => ({ ...s, body: undefined, catalog: undefined })),
-      receives: (s.data.receives || []).map((r) => ({ ...r, body: undefined, catalog: undefined })),
-      catalog: undefined,
-      body: undefined,
-    } as Service;
-  }) as unknown as Service[];
-  items = filteredServices;
-} else if (type === 'messages') {
-  const { events, commands, queries } = await getMessages({ getAllVersions: false, hydrateServices: false });
-  const messages = [...events, ...commands, ...queries];
-  items = removeContentFromCollection(messages) as unknown as CollectionEntry<CollectionMessageTypes>[];
-  containers = await getContainers({ getAllVersions: false });
-}
----
-
-<VerticalSideBarLayout title={'EventCatalog'}>
-  <div class="bg-white min-h-screen">
-    <div class="max-w-[90em] mx-auto">
-      <div class="px-6 py-6" transition:animate={fade({ duration: '0.4s' })}>
-        {type === 'domains' && <DomainGrid domains={domains} embeded={embeded} client:load />}
-        {
-          type === 'services' && (
-            <ServiceGrid domains={domains} services={items as unknown as Service[]} embeded={embeded} client:load />
-          )
-        }
-        {
-          type === 'messages' && (
-            <MessageGrid
-              messages={items as CollectionEntry<CollectionMessageTypes>[]}
-              embeded={embeded}
-              containers={containers}
-              client:load
-            />
-          )
-        }
-      </div>
-    </div>
-    <ClientRouter />
-  </div>
-</VerticalSideBarLayout>

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

@@ -1,14 +0,0 @@
----
-import Architecture from '../../architecture.astro';
-
-export async function getStaticPaths() {
-  const VALID_TYPES = ['domains', 'services', 'messages'] as const;
-  return VALID_TYPES.map((type) => ({
-    params: { type },
-  }));
-}
-
-const { type } = Astro.params;
----
-
-<Architecture type={type} embeded={true} />

package/eventcatalog/src/utils/commands.ts

@@ -1,112 +0,0 @@
-import { getCollection } from 'astro:content';
-import type { CollectionEntry } from 'astro:content';
-import path from 'path';
-import { getVersionForCollectionItem, satisfies } from './collections/util';
-import utils from '@eventcatalog/sdk';
-
-const PROJECT_DIR = process.env.PROJECT_DIR || process.cwd();
-
-type Command = CollectionEntry<'commands'> & {
-  catalog: {
-    path: string;
-    filePath: string;
-    type: string;
-  };
-};
-
-interface Props {
-  getAllVersions?: boolean;
-  hydrateServices?: boolean;
-}
-
-// cache for build time
-let cachedCommands: Record<string, Command[]> = {
-  allVersions: [],
-  currentVersions: [],
-};
-
-export const getCommands = async ({ getAllVersions = true, hydrateServices = true }: Props = {}): Promise<Command[]> => {
-  const cacheKey = getAllVersions ? 'allVersions' : 'currentVersions';
-
-  if (cachedCommands[cacheKey].length > 0 && hydrateServices) {
-    return cachedCommands[cacheKey];
-  }
-
-  const commands = await getCollection('commands', (command) => {
-    return (getAllVersions || !command.filePath?.includes('versioned')) && command.data.hidden !== true;
-  });
-
-  const services = await getCollection('services');
-  const allChannels = await getCollection('channels');
-
-  // @ts-ignore
-  cachedCommands[cacheKey] = await Promise.all(
-    commands.map(async (command) => {
-      const { latestVersion, versions } = getVersionForCollectionItem(command, commands);
-
-      const producers = services
-        .filter((service) => {
-          return service.data.sends?.some((item) => {
-            if (item.id != command.data.id) return false;
-            if (item.version == 'latest' || item.version == undefined) return command.data.version == latestVersion;
-            return satisfies(command.data.version, item.version);
-          });
-        })
-        .map((service) => {
-          if (!hydrateServices) return { id: service.data.id, version: service.data.version };
-          return service;
-        });
-
-      const consumers = services
-        .filter((service) => {
-          return service.data.receives?.some((item) => {
-            if (item.id != command.data.id) return false;
-            if (item.version == 'latest' || item.version == undefined) return command.data.version == latestVersion;
-            return satisfies(command.data.version, item.version);
-          });
-        })
-        .map((service) => {
-          if (!hydrateServices) return { id: service.data.id, version: service.data.version };
-          return service;
-        });
-
-      const messageChannels = command.data.channels || [];
-      const channelsForCommand = allChannels.filter((c) => messageChannels.some((channel) => c.data.id === channel.id));
-
-      const { getResourceFolderName } = utils(process.env.PROJECT_DIR ?? '');
-      const folderName = await getResourceFolderName(
-        process.env.PROJECT_DIR ?? '',
-        command.data.id,
-        command.data.version.toString()
-      );
-      const commandFolderName = folderName ?? command.id.replace(`-${command.data.version}`, '');
-
-      return {
-        ...command,
-        data: {
-          ...command.data,
-          messageChannels: channelsForCommand,
-          producers,
-          consumers,
-          versions,
-          latestVersion,
-        },
-        catalog: {
-          path: path.join(command.collection, command.id.replace('/index.mdx', '')),
-          absoluteFilePath: path.join(PROJECT_DIR, command.collection, command.id.replace('/index.mdx', '/index.md')),
-          astroContentFilePath: path.join(process.cwd(), 'src', 'content', command.collection, command.id),
-          filePath: path.join(process.cwd(), 'src', 'catalog-files', command.collection, command.id.replace('/index.mdx', '')),
-          publicPath: path.join('/generated', command.collection, commandFolderName),
-          type: 'command',
-        },
-      };
-    })
-  );
-
-  // order them by the name of the command
-  cachedCommands[cacheKey].sort((a, b) => {
-    return (a.data.name || a.data.id).localeCompare(b.data.name || b.data.id);
-  });
-
-  return cachedCommands[cacheKey];
-};

package/eventcatalog/src/utils/events.ts

@@ -1,108 +0,0 @@
-import { getCollection } from 'astro:content';
-import type { CollectionEntry } from 'astro:content';
-import path from 'path';
-import { getVersionForCollectionItem, satisfies } from './collections/util';
-import utils from '@eventcatalog/sdk';
-
-const PROJECT_DIR = process.env.PROJECT_DIR || process.cwd();
-
-type Event = CollectionEntry<'events'> & {
-  catalog: {
-    path: string;
-    filePath: string;
-    type: string;
-  };
-};
-
-interface Props {
-  getAllVersions?: boolean;
-  hydrateServices?: boolean;
-}
-
-// cache for build time
-let cachedEvents: Record<string, Event[]> = {
-  allVersions: [],
-  currentVersions: [],
-};
-
-export const getEvents = async ({ getAllVersions = true, hydrateServices = true }: Props = {}): Promise<Event[]> => {
-  const cacheKey = getAllVersions ? 'allVersions' : 'currentVersions';
-
-  if (cachedEvents[cacheKey].length > 0 && hydrateServices) {
-    return cachedEvents[cacheKey];
-  }
-
-  const events = await getCollection('events', (event) => {
-    return (getAllVersions || !event.filePath?.includes('versioned')) && event.data.hidden !== true;
-  });
-
-  const services = await getCollection('services');
-  const allChannels = await getCollection('channels');
-
-  // @ts-ignore
-  cachedEvents[cacheKey] = await Promise.all(
-    events.map(async (event) => {
-      const { latestVersion, versions } = getVersionForCollectionItem(event, events);
-
-      const producers = services
-        .filter((service) =>
-          service.data.sends?.some((item) => {
-            if (item.id != event.data.id) return false;
-            if (item.version == 'latest' || item.version == undefined) return event.data.version == latestVersion;
-            return satisfies(event.data.version, item.version);
-          })
-        )
-        .map((service) => {
-          if (!hydrateServices) return { id: service.data.id, version: service.data.version };
-          return service;
-        });
-
-      const consumers = services
-        .filter((service) =>
-          service.data.receives?.some((item) => {
-            if (item.id != event.data.id) return false;
-            if (item.version == 'latest' || item.version == undefined) return event.data.version == latestVersion;
-            return satisfies(event.data.version, item.version);
-          })
-        )
-        .map((service) => {
-          if (!hydrateServices) return { id: service.data.id, version: service.data.version };
-          return service;
-        });
-
-      const messageChannels = event.data.channels || [];
-      const channelsForEvent = allChannels.filter((c) => messageChannels.some((channel) => c.data.id === channel.id));
-
-      const { getResourceFolderName } = utils(process.env.PROJECT_DIR ?? '');
-      const folderName = await getResourceFolderName(process.env.PROJECT_DIR ?? '', event.data.id, event.data.version.toString());
-      const eventFolderName = folderName ?? event.id.replace(`-${event.data.version}`, '');
-
-      return {
-        ...event,
-        data: {
-          ...event.data,
-          messageChannels: channelsForEvent,
-          producers,
-          consumers,
-          versions,
-          latestVersion,
-        },
-        catalog: {
-          path: path.join(event.collection, event.id.replace('/index.mdx', '')),
-          absoluteFilePath: path.join(PROJECT_DIR, event.collection, event.id.replace('/index.mdx', '/index.md')),
-          astroContentFilePath: path.join(process.cwd(), 'src', 'content', event.collection, event.id),
-          filePath: path.join(process.cwd(), 'src', 'catalog-files', event.collection, event.id.replace('/index.mdx', '')),
-          publicPath: path.join('/generated', event.collection, eventFolderName),
-          type: 'event',
-        },
-      };
-    })
-  );
-
-  // order them by the name of the event
-  cachedEvents[cacheKey].sort((a, b) => {
-    return (a.data.name || a.data.id).localeCompare(b.data.name || b.data.id);
-  });
-
-  return cachedEvents[cacheKey];
-};

package/eventcatalog/src/utils/generators/index.ts

@@ -1,10 +0,0 @@
-// Should really only be used on the server side
-// If users are using path or fs in the eventcatalog.config.js file, it will break the build (for now)
-
-import config from '@config';
-
-export const getConfigurationForGivenGenerator = (generator: string) => {
-  const generators = config.generators ?? [];
-  const generatorConfig = generators.find((g: any) => g[0] === generator);
-  return generatorConfig?.[1];
-};

package/eventcatalog/src/utils/teams.ts

@@ -1,72 +0,0 @@
-import { getCollection } from 'astro:content';
-import type { CollectionEntry } from 'astro:content';
-import path from 'path';
-
-export type Team = CollectionEntry<'teams'>;
-
-// Cache for build time
-let cachedTeams: Team[] = [];
-
-export const getTeams = async (): Promise<Team[]> => {
-  if (cachedTeams.length > 0) {
-    return cachedTeams;
-  }
-
-  // Get services that are not versioned
-  const teams = await getCollection('teams', (team) => {
-    return team.data.hidden !== true;
-  });
-  // What do they own?
-  const domains = await getCollection('domains');
-  // What do they own?
-  const services = await getCollection('services');
-  // What do they own?
-  const events = await getCollection('events');
-  const commands = await getCollection('commands');
-  const queries = await getCollection('queries');
-  cachedTeams = teams.map((team) => {
-    const ownedDomains = domains.filter((domain) => {
-      return domain.data.owners?.find((owner) => owner.id === team.data.id);
-    });
-
-    const ownedServices = services.filter((service) => {
-      return service.data.owners?.find((owner) => owner.id === team.data.id);
-    });
-
-    const ownedEvents = events.filter((event) => {
-      return event.data.owners?.find((owner) => owner.id === team.data.id);
-    });
-
-    const ownedCommands = commands.filter((command) => {
-      return command.data.owners?.find((owner) => owner.id === team.data.id);
-    });
-
-    const ownedQueries = queries.filter((query) => {
-      return query.data.owners?.find((owner) => owner.id === team.data.id);
-    });
-
-    return {
-      ...team,
-      data: {
-        ...team.data,
-        ownedDomains,
-        ownedServices,
-        ownedCommands,
-        ownedQueries,
-        ownedEvents,
-      },
-      catalog: {
-        path: path.join(team.collection, team.id.replace('/index.mdx', '')),
-        filePath: path.join(process.cwd(), 'src', 'catalog-files', team.collection, team.id.replace('/index.mdx', '')),
-        type: 'team',
-      },
-    };
-  });
-
-  // order them by the name of the team
-  cachedTeams.sort((a, b) => {
-    return (a.data.name || a.data.id).localeCompare(b.data.name || b.data.id);
-  });
-
-  return cachedTeams;
-};

package/eventcatalog/src/utils/users.ts

@@ -1,72 +0,0 @@
-import type { CollectionTypes } from '@types';
-import { getCollection } from 'astro:content';
-import type { CollectionEntry } from 'astro:content';
-import path from 'path';
-
-export type User = CollectionEntry<'users'>;
-
-export const getUsers = async (): Promise<User[]> => {
-  // Get services that are not versioned
-  const users = await getCollection('users', (user) => {
-    return user.data.hidden !== true;
-  });
-
-  // What do they own?
-  const domains = await getCollection('domains');
-  const services = await getCollection('services');
-  const events = await getCollection('events');
-  const commands = await getCollection('commands');
-  const queries = await getCollection('queries');
-
-  const teams = await getCollection('teams', (team) => {
-    return team.data.hidden !== true;
-  });
-
-  const mappedUsers = users.map((user) => {
-    const associatedTeams = teams.filter((team) => {
-      return team.data.members?.some((member) => member.id === user.data.id);
-    });
-
-    const ownedDomains = domains.filter((domain) => {
-      return domain.data.owners?.find((owner) => owner.id === user.data.id);
-    });
-
-    const isOwnedByUserOrAssociatedTeam = (item: CollectionEntry<CollectionTypes>) => {
-      const associatedTeamsId: string[] = associatedTeams.map((team) => team.data.id);
-      return item.data.owners?.some((owner) => owner.id === user.data.id || associatedTeamsId.includes(owner.id));
-    };
-
-    const ownedServices = services.filter(isOwnedByUserOrAssociatedTeam);
-
-    const ownedEvents = events.filter(isOwnedByUserOrAssociatedTeam);
-
-    const ownedCommands = commands.filter(isOwnedByUserOrAssociatedTeam);
-
-    const ownedQueries = queries.filter(isOwnedByUserOrAssociatedTeam);
-
-    return {
-      ...user,
-      data: {
-        ...user.data,
-        ownedDomains,
-        ownedServices,
-        ownedEvents,
-        ownedCommands,
-        ownedQueries,
-        associatedTeams,
-      },
-      catalog: {
-        path: path.join(user.collection, user.id.replace('/index.mdx', '')),
-        filePath: path.join(process.cwd(), 'src', 'catalog-files', user.collection, user.id.replace('/index.mdx', '')),
-        type: 'user',
-      },
-    };
-  });
-
-  // order them by the name of the user
-  mappedUsers.sort((a, b) => {
-    return (a.data.name || a.data.id).localeCompare(b.data.name || b.data.id);
-  });
-
-  return mappedUsers;
-};