@eventcatalog/core 0.1.17 → 0.2.0

package/lib/__tests__/graphs.spec.ts

@@ -48,8 +48,8 @@ click My_Service href "/docs/services/My Service" "Go to My Service" _self`);
       const event = {
         name: 'My Event',
         version: '0.0.1',
-        producers: ['Service 1'],
-        consumers: ['Service 2'],
+        producerNames: ['Service 1'],
+        consumerNames: ['Service 2'],
       };
 
       const result = buildMermaidFlowChartForEvent(event);
@@ -77,8 +77,8 @@ click My_Event href "/docs/events/My Event" "Go to My Event" _self`);
       const event = {
         name: 'My Event',
         version: '0.0.1',
-        producers: ['Service 1 With Spaces'],
-        consumers: [],
+        producerNames: ['Service 1 With Spaces'],
+        consumerNames: [],
       };
       const result = buildMermaidFlowChartForEvent(event);
       expect(result).toContain(`Service_1_With_Spaces[Service 1 With Spaces]:::producer-->My_Event[My Event]:::event`);

package/lib/__tests__/services.spec.ts

@@ -33,6 +33,7 @@ describe('services', () => {
             url: 'https://github.com/boyney123/pretend-basket-service',
           },
           subscribes: [],
+          domain: null,
           summary: 'CRUD based API to handle Basket interactions for users of the shopping website.\n',
           tags: [],
         },
@@ -40,6 +41,7 @@ describe('services', () => {
           name: 'Email Platform',
           summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
           owners: ['dboyne'],
+          domain: null,
           repository: {
             url: 'https://github.com/boyney123/EmailPlatform',
             language: 'JavaScript',
@@ -58,16 +60,36 @@ describe('services', () => {
               name: 'EmailSent',
               version: '0.0.1',
               summary: 'Tells us when an email has been sent\n',
-              producers: ['Email Platform'],
-              consumers: [],
+              producerNames: ['Email Platform'],
+              consumerNames: [],
               externalLinks: [],
               historicVersions: [],
+              domain: null,
               owners: ['dboyne', 'mSmith'],
             },
           ],
           subscribes: [],
           externalLinks: [],
         },
+        {
+          name: 'User Service',
+          summary: 'CRUD based API to handle User information\n',
+          domain: 'User',
+          owners: ['mSmith'],
+          repository: {
+            language: 'JavaScript',
+            url: 'https://github.com/boyney123/pretend-basket-service',
+          },
+          tags: [],
+          externalLinks: [
+            {
+              label: 'AsyncAPI Specification',
+              url: 'https://studio.asyncapi.com/#schema-lightMeasuredPayload',
+            },
+          ],
+          publishes: [],
+          subscribes: [],
+        },
       ]);
     });
   });
@@ -90,6 +112,7 @@ describe('services', () => {
             url: 'https://github.com/boyney123/EmailPlatform',
             language: 'JavaScript',
           },
+          domain: null,
           tags: [
             {
               label: 'defaultContentType:application/json',
@@ -104,9 +127,10 @@ describe('services', () => {
               name: 'EmailSent',
               version: '0.0.1',
               summary: 'Tells us when an email has been sent\n',
-              producers: ['Email Platform'],
-              consumers: [],
+              producerNames: ['Email Platform'],
+              consumerNames: [],
               historicVersions: [],
+              domain: null,
               externalLinks: [],
               owners: ['dboyne', 'mSmith'],
             },
@@ -120,12 +144,13 @@ describe('services', () => {
 
   describe('getServiceByName', () => {
     it('returns an event and markdown by the given event name', async () => {
-      const { service, markdown } = await getServiceByName('Email Platform');
+      const { service, markdown } = await getServiceByName({ serviceName: 'Email Platform' });
 
       expect(service).toEqual({
         name: 'Email Platform',
         summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
         owners: ['dboyne'],
+        domain: null,
         repository: {
           url: 'https://github.com/boyney123/EmailPlatform',
           language: 'JavaScript',
@@ -144,9 +169,10 @@ describe('services', () => {
             name: 'EmailSent',
             version: '0.0.1',
             summary: 'Tells us when an email has been sent\n',
-            producers: ['Email Platform'],
-            consumers: [],
+            producerNames: ['Email Platform'],
+            consumerNames: [],
             historicVersions: [],
+            domain: null,
             externalLinks: [],
             owners: ['dboyne', 'mSmith'],
           },
@@ -158,5 +184,34 @@ describe('services', () => {
       // @ts-ignore
       expect(markdown.content).toMatchMarkdown('# Testing');
     });
+
+    describe('services within domains', () => {
+      it('returns an event and markdown by the given event name', async () => {
+        const { service, markdown } = await getServiceByName({ serviceName: 'User Service', domain: 'User' });
+
+        expect(service).toEqual({
+          name: 'User Service',
+          summary: 'CRUD based API to handle User information\n',
+          domain: 'User',
+          owners: ['mSmith'],
+          repository: {
+            language: 'JavaScript',
+            url: 'https://github.com/boyney123/pretend-basket-service',
+          },
+          tags: [],
+          externalLinks: [
+            {
+              label: 'AsyncAPI Specification',
+              url: 'https://studio.asyncapi.com/#schema-lightMeasuredPayload',
+            },
+          ],
+          publishes: [],
+          subscribes: [],
+        });
+
+        // @ts-ignore
+        expect(markdown.content).toMatchMarkdown('# Testing');
+      });
+    });
   });
 });

package/lib/domains.ts

@@ -0,0 +1,148 @@
+import path from 'path';
+import fs from 'fs';
+import type { Event } from '@eventcatalog/types';
+import { Domain } from '@eventcatalog/types';
+import { serialize } from 'next-mdx-remote/serialize';
+import { getAllEventsFromPath } from './events';
+import { getAllServicesFromPath } from './services';
+import { readMarkdownFile, getLastModifiedDateOfFile } from '@/lib/file-reader';
+
+import { MarkdownFile } from '../types/index';
+
+const buildDomain = (domainFrontMatter: any): Domain => {
+  const { name, summary, owners = [], tags = [], externalLinks = [] } = domainFrontMatter;
+  return { name, summary, owners, tags, externalLinks };
+};
+
+export const getUniqueDomainNamesFromEvents = (events: Event[]) => {
+  const allDomains = events.filter((event) => !!event.domain).map((event) => event.domain);
+  // @ts-ignore
+  return [...new Set(allDomains)];
+};
+
+export const getAllDomainsByOwnerId = async (ownerId): Promise<Domain[]> => {
+  const domainsWithMarkdown = await getAllDomains();
+
+  const domains = domainsWithMarkdown.map((item) => item.domain);
+  const domainsOwnedByUser = domains.filter((domain) => domain.owners.some((id) => id === ownerId));
+  return domainsOwnedByUser.map((domain) => ({
+    ...domain,
+  }));
+};
+
+export const getAllEventsFromDomains = () => {
+  const domainsDir = path.join(process.env.PROJECT_DIR, 'domains');
+
+  if (!fs.existsSync(domainsDir)) return [];
+
+  const domains = fs.readdirSync(domainsDir);
+
+  return domains.reduce((allEventsFromDomains, domainFolder) => {
+    const domainDir = path.join(domainsDir, domainFolder);
+    const eventsForDomainDir = path.join(domainDir, 'events');
+    const domainHasEvents = fs.existsSync(eventsForDomainDir);
+
+    if (domainHasEvents) {
+      const domainEvents = getAllEventsFromPath(eventsForDomainDir);
+
+      // Add domains onto events
+      const eventsWithDomain = domainEvents.map((event) => ({ ...event, domain: domainFolder }));
+
+      return [...allEventsFromDomains, ...eventsWithDomain];
+    }
+
+    return allEventsFromDomains;
+  }, []);
+};
+
+export const getAllServicesFromDomains = () => {
+  const domainsDir = path.join(process.env.PROJECT_DIR, 'domains');
+  if (!fs.existsSync(domainsDir)) return [];
+  const domains = fs.readdirSync(domainsDir);
+
+  return domains.reduce((allServicesFromDomains, domainFolder) => {
+    const domainDir = path.join(domainsDir, domainFolder);
+    const servicesForDomainDir = path.join(domainDir, 'services');
+    const domainHasServices = fs.existsSync(servicesForDomainDir);
+
+    if (domainHasServices) {
+      const domainServices = getAllServicesFromPath(servicesForDomainDir);
+
+      // Add domains onto events
+      const eventsWithDomain = domainServices.map((event) => ({ ...event, domain: domainFolder }));
+
+      return [...allServicesFromDomains, ...eventsWithDomain];
+    }
+
+    return allServicesFromDomains;
+  }, []);
+};
+
+export const getDomainByName = async ({
+  domainName,
+}: {
+  domainName: string;
+}): Promise<{ domain: Domain; markdown: MarkdownFile }> => {
+  try {
+    const domainsDir = path.join(process.env.PROJECT_DIR, 'domains');
+    const domainDirectory = path.join(domainsDir, domainName);
+
+    const { data, content } = readMarkdownFile(path.join(domainDirectory, `index.md`));
+    const domain = buildDomain(data);
+
+    const mdxSource = await serialize(content);
+
+    const eventsForDomain = getAllEventsFromPath(path.join(domainDirectory, 'events'));
+    const servicesForDomain = getAllServicesFromPath(path.join(domainDirectory, 'services'));
+
+    return {
+      // @ts-ignore
+      domain: {
+        ...domain,
+        events: eventsForDomain,
+        services: servicesForDomain,
+      },
+      markdown: {
+        content,
+        lastModifiedDate: getLastModifiedDateOfFile(path.join(domainDirectory, `index.md`)),
+        source: mdxSource,
+      },
+    };
+  } catch (error) {
+    console.log('Failed to get domain by name', domainName);
+    return Promise.reject();
+  }
+};
+
+export const getDomainByPath = async (domainDirectory: string): Promise<{ domain: Domain; markdown: MarkdownFile }> => {
+  const { data, content } = readMarkdownFile(path.join(domainDirectory, `index.md`));
+  const domain = buildDomain(data);
+
+  const mdxSource = await serialize(content);
+
+  const eventsForDomain = getAllEventsFromPath(path.join(domainDirectory, 'events'));
+  const servicesForDomain = getAllServicesFromPath(path.join(domainDirectory, 'services'));
+
+  return {
+    // @ts-ignore
+    domain: {
+      ...domain,
+      events: eventsForDomain,
+      services: servicesForDomain,
+    },
+    markdown: {
+      content,
+      lastModifiedDate: getLastModifiedDateOfFile(path.join(domainDirectory, `index.md`)),
+      source: mdxSource,
+    },
+  };
+};
+
+export const getAllDomainsFromPath = async (domainsDir: string) => {
+  if (!fs.existsSync(domainsDir)) return [];
+  const folders = fs.readdirSync(domainsDir);
+  const allDomains = folders.map((folder) => getDomainByPath(path.join(domainsDir, folder)));
+  return Promise.all(allDomains);
+};
+
+export const getAllDomains = () => getAllDomainsFromPath(path.join(process.env.PROJECT_DIR, 'domains'));

package/lib/events.ts

@@ -9,11 +9,22 @@ import { MarkdownFile } from '@/types/index';
 import { extentionToLanguageMap } from './file-reader';
 
 import { getLastModifiedDateOfFile, getSchemaFromDir, readMarkdownFile } from '@/lib/file-reader';
-import { getAllServices } from './services';
+
+import { getAllServices, hydrateEventProducersAndConsumers } from './services';
+import { getAllEventsFromDomains } from './domains';
 
 const parseEventFrontMatterIntoEvent = (eventFrontMatter: any): Event => {
-  const { name, version, summary, producers = [], consumers = [], owners = [], externalLinks = [] } = eventFrontMatter;
-  return { name, version, summary, producers, consumers, owners, externalLinks };
+  const {
+    name,
+    version,
+    summary,
+    domain = null,
+    producers = [],
+    consumers = [],
+    owners = [],
+    externalLinks = [],
+  } = eventFrontMatter;
+  return { name, version, summary, domain, producerNames: producers, consumerNames: consumers, owners, externalLinks };
 };
 
 const versionsForEvents = (pathToEvent) => {
@@ -27,8 +38,13 @@ const versionsForEvents = (pathToEvent) => {
   return [];
 };
 
-export const getLogsForEvent = (eventName) => {
-  const eventsDir = path.join(process.env.PROJECT_DIR, 'events');
+export const getLogsForEvent = ({ eventName, domain }: { eventName: string; domain?: string }) => {
+  let eventsDir = path.join(process.env.PROJECT_DIR, 'events');
+
+  if (domain) {
+    eventsDir = path.join(process.env.PROJECT_DIR, 'domains', domain, 'events');
+  }
+
   const historicVersions = versionsForEvents(path.join(eventsDir, eventName));
 
   const allVersions = historicVersions.map((version) => ({
@@ -129,17 +145,28 @@ const getEventExamplesFromDir = (pathToExamples) => {
   return examples;
 };
 
-export const getAllEvents = (): Event[] => {
-  const eventsDir = path.join(process.env.PROJECT_DIR, 'events');
+export const getEventByPath = (eventDir: string): Event => {
+  const { data } = readMarkdownFile(path.join(eventDir, 'index.md'));
+  const historicVersions = versionsForEvents(path.join(eventDir));
+  return {
+    ...parseEventFrontMatterIntoEvent(data),
+    historicVersions,
+  };
+};
+
+export const getAllEventsFromPath = (eventsDir: string): Event[] => {
   const folders = fs.readdirSync(eventsDir);
-  return folders.map((folder) => {
-    const { data } = readMarkdownFile(path.join(eventsDir, folder, 'index.md'));
-    const historicVersions = versionsForEvents(path.join(eventsDir, folder));
-    return {
-      ...parseEventFrontMatterIntoEvent(data),
-      historicVersions,
-    };
-  });
+  return folders.map((folder) => getEventByPath(path.join(eventsDir, folder)));
+};
+
+export const getAllEvents = (): Event[] => {
+  const allEventsFromDomainFolders = getAllEventsFromDomains();
+  const eventsWithoutDomains = getAllEventsFromPath(path.join(process.env.PROJECT_DIR, 'events'));
+
+  const events = [...eventsWithoutDomains, ...allEventsFromDomainFolders];
+  const sortedEvents = events.sort((a, b) => a.name.localeCompare(b.name));
+
+  return sortedEvents;
 };
 
 export const getAllOwners = (): string[] => {
@@ -158,15 +185,30 @@ export const getAllEventsAndVersionsFlattened = () => {
     // eventsWithVersionsFlattened.push({ eventName: event.name, version: event.version })
 
     if (event.historicVersions) {
-      event.historicVersions.forEach((version) => eventsWithVersionsFlattened.push({ eventName: event.name, version }));
+      event.historicVersions.forEach((version) =>
+        eventsWithVersionsFlattened.push({ eventName: event.name, version, domain: event.domain })
+      );
     }
 
     return eventsWithVersionsFlattened;
   }, []);
 };
 
-export const getEventByName = async (eventName: string, version?: string): Promise<{ event: Event; markdown: MarkdownFile }> => {
-  const eventsDir = path.join(process.env.PROJECT_DIR, 'events');
+export const getEventByName = async ({
+  eventName,
+  version,
+  domain,
+}: {
+  eventName: string;
+  version?: string;
+  domain?: string;
+}): Promise<{ event: Event; markdown: MarkdownFile }> => {
+  let eventsDir = path.join(process.env.PROJECT_DIR, 'events');
+
+  if (domain) {
+    eventsDir = path.join(process.env.PROJECT_DIR, 'domains', domain, 'events');
+  }
+
   const eventDirectory = path.join(eventsDir, eventName);
   let versionDirectory = null;
 
@@ -179,12 +221,16 @@ export const getEventByName = async (eventName: string, version?: string): Promi
   try {
     const { data, content } = readMarkdownFile(path.join(directoryToLoadForEvent, `index.md`));
     const event = parseEventFrontMatterIntoEvent(data);
+    const services = getAllServices();
+    const consumersAndProducersAsServices = hydrateEventProducersAndConsumers(event, services);
 
     const mdxSource = await serialize(content);
 
     return {
       event: {
         ...event,
+        ...consumersAndProducersAsServices,
+        domain: domain || null,
         historicVersions: versionsForEvents(eventDirectory),
         schema: getSchemaFromDir(directoryToLoadForEvent),
         examples: getEventExamplesFromDir(path.join(directoryToLoadForEvent, `examples`)),
@@ -204,8 +250,8 @@ export const getEventByName = async (eventName: string, version?: string): Promi
 
 export const getUniqueServicesNamesFromEvents = (events: Event[]) => {
   const allConsumersAndProducers = events.reduce((domains, event) => {
-    const { consumers = [], producers = [] } = event;
-    return domains.concat(consumers).concat(producers);
+    const { consumerNames = [], producerNames = [] } = event;
+    return domains.concat(consumerNames).concat(producerNames);
   }, []);
 
   const data = allConsumersAndProducers.map((service) => service);
@@ -225,8 +271,8 @@ export const getAllEventsThatHaveRelationshipWithService = (
 ): { publishes: Event[]; subscribes: Event[] } => {
   const relationshipsBetweenEvents = events.reduce(
     (data, event) => {
-      const serviceSubscribesToEvent = event.consumers.some((id) => id === service.name);
-      const servicePublishesEvent = event.producers.some((id) => id === service.name);
+      const serviceSubscribesToEvent = event.consumerNames.some((id) => id === service.name);
+      const servicePublishesEvent = event.producerNames.some((id) => id === service.name);
 
       return {
         publishes: servicePublishesEvent ? data.publishes.concat(event) : data.publishes,

package/lib/graphs.ts

@@ -31,14 +31,17 @@ click ${centerNode.id} href "${centerNode.link}" "Go to ${centerNode.name}" _sel
  * @param {string} rootNodeColor of the root node
  * @returns {string} Mermaid Graph
  */
-export const buildMermaidFlowChartForEvent = ({ name: eventName, producers, consumers }: Event, rootNodeColor = '#2563eb') => {
+export const buildMermaidFlowChartForEvent = (
+  { name: eventName, producerNames, consumerNames }: Event,
+  rootNodeColor = '#2563eb'
+) => {
   // Transforms services & event into a graph model
-  const leftNodes = producers.map(truncateNode).map((node) => ({
+  const leftNodes = producerNames.map(truncateNode).map((node) => ({
     id: node.replace(/ /g, '_'),
     name: node,
     link: generateLink(node, 'services'),
   }));
-  const rightNodes = consumers.map(truncateNode).map((node) => ({
+  const rightNodes = consumerNames.map(truncateNode).map((node) => ({
     id: node.replace(/ /g, '_'),
     name: node,
     link: generateLink(node, 'services'),

package/lib/services.ts

@@ -1,33 +1,44 @@
 import fs from 'fs';
 import path from 'path';
 import { serialize } from 'next-mdx-remote/serialize';
-import { Service } from '@eventcatalog/types';
+import { Service, Event } from '@eventcatalog/types';
 import { readMarkdownFile, getLastModifiedDateOfFile } from '@/lib/file-reader';
 import { MarkdownFile } from '../types/index';
 
 import { getAllEvents, getAllEventsThatHaveRelationshipWithService } from '@/lib/events';
+import { getAllServicesFromDomains } from '@/lib/domains';
 
 const buildService = (eventFrontMatter: any): Service => {
-  const { name, summary, owners = [], repository = {}, tags = [], externalLinks = [] } = eventFrontMatter;
-  return { name, summary, owners, repository, tags, externalLinks };
+  const { name, summary, domain = null, owners = [], repository = {}, tags = [], externalLinks = [] } = eventFrontMatter;
+  return { name, summary, domain, owners, repository, tags, externalLinks };
 };
 
-export const getAllServices = (): Service[] => {
-  const servicesDir = path.join(process.env.PROJECT_DIR, 'services');
+export const getServiceByPath = (serviceDirPath: string): Service => {
+  const { data } = readMarkdownFile(path.join(serviceDirPath, 'index.md'));
+  return buildService(data);
+};
 
-  const folders = fs.readdirSync(servicesDir);
-  const services = folders.map((folder) => readMarkdownFile(path.join(servicesDir, folder, 'index.md')));
+export const getAllServicesFromPath = (serviceDir: string): Service[] => {
+  const folders = fs.readdirSync(serviceDir);
   const events = getAllEvents();
+  const services = folders.map((folder) => getServiceByPath(path.join(serviceDir, folder)));
 
-  const parsedServices = services.map((frontMatter) => buildService(frontMatter.data));
-
-  // @ts-ignore
-  return parsedServices.map((service) => ({
+  // // @ts-ignore
+  return services.map((service) => ({
     ...service,
     ...getAllEventsThatHaveRelationshipWithService(service, events),
   }));
 };
 
+export const getAllServices = (): Service[] => {
+  const allServicesFromDomainFolders = getAllServicesFromDomains();
+  const servicesWithoutDomains = getAllServicesFromPath(path.join(process.env.PROJECT_DIR, 'services'));
+
+  const services = [...allServicesFromDomainFolders, ...servicesWithoutDomains];
+  const sortedServices = services.sort((a, b) => a.name.localeCompare(b.name));
+  return sortedServices;
+};
+
 export const getAllServicesByOwnerId = async (ownerId): Promise<Service[]> => {
   const services = await getAllServices();
   const servicesOwnedByUser = services.filter((service) => service.owners.some((id) => id === ownerId));
@@ -36,9 +47,20 @@ export const getAllServicesByOwnerId = async (ownerId): Promise<Service[]> => {
   }));
 };
 
-export const getServiceByName = async (serviceName): Promise<{ service: Service; markdown: MarkdownFile }> => {
+export const getServiceByName = async ({
+  serviceName,
+  domain = null,
+}: {
+  serviceName: string;
+  domain?: string;
+}): Promise<{ service: Service; markdown: MarkdownFile }> => {
   try {
-    const servicesDir = path.join(process.env.PROJECT_DIR, 'services');
+    let servicesDir = path.join(process.env.PROJECT_DIR, 'services');
+
+    if (domain) {
+      servicesDir = path.join(process.env.PROJECT_DIR, 'domains', domain, 'services');
+    }
+
     const serviceDirectory = path.join(servicesDir, serviceName);
     const { data, content } = readMarkdownFile(path.join(serviceDirectory, `index.md`));
     const service = buildService(data);
@@ -51,6 +73,7 @@ export const getServiceByName = async (serviceName): Promise<{ service: Service;
       // @ts-ignore
       service: {
         ...service,
+        domain,
         ...getAllEventsThatHaveRelationshipWithService(service, events),
       },
       markdown: {
@@ -64,3 +87,18 @@ export const getServiceByName = async (serviceName): Promise<{ service: Service;
     return Promise.reject();
   }
 };
+
+export const hydrateEventProducersAndConsumers = (
+  event: Event,
+  services: Service[]
+): { producers: Service[]; consumers: Service[] } => {
+  const findServiceByName = (name) => services.find((service) => service.name === name);
+
+  const producers = event.producerNames.map((name) => findServiceByName(name)).filter((service) => !!service);
+  const consumers = event.consumerNames.map((name) => findServiceByName(name)).filter((service) => !!service);
+
+  return {
+    producers: producers.length > 0 ? producers : [],
+    consumers: consumers.length > 0 ? consumers : [],
+  };
+};

package/out/404/index.html

@@ -1 +1 @@
-<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><script src="//unpkg.com/three"></script><script src="//unpkg.com/three/examples/js/renderers/CSS2DRenderer.js"></script><link rel="stylesheet" href="https://cdn.bootcss.com/font-awesome/4.7.0/css/font-awesome.css"/><meta name="description" content="An open source project to Discover, Explore and Document your Event Driven Architectures."/><meta property="og:url" content="https://eventcatalog.dev/"/><meta property="og:type" content="website"/><meta property="og:title" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."/><meta property="og:description" content="An open source tool powered by markdown to document your Event Driven Architecture."/><meta property="og:image" content="https://eventcatalog.dev/img/opengraph.png"/><meta property="og:image:alt" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="600"/><meta property="og:locale" content="en-GB"/><meta name="author" content="David Boyne"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-light.min.css"/><title>404: This page could not be found</title><meta name="next-head-count" content="18"/><link rel="preload" href="/_next/static/css/6774df2af1f71309.css" as="style"/><link rel="stylesheet" href="/_next/static/css/6774df2af1f71309.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-49abfa9a972ed5a3.js" defer=""></script><script src="/_next/static/chunks/framework-576ec6a1c1386453.js" defer=""></script><script src="/_next/static/chunks/main-0015f560a7edeb35.js" defer=""></script><script src="/_next/static/chunks/pages/_app-6eba1099469a6889.js" defer=""></script><script src="/_next/static/chunks/pages/_error-5a714c45c50a8db4.js" defer=""></script><script src="/_next/static/R1JBWbiD3Q61grTfkBBSU/_buildManifest.js" defer=""></script><script src="/_next/static/R1JBWbiD3Q61grTfkBBSU/_ssgManifest.js" defer=""></script><script src="/_next/static/R1JBWbiD3Q61grTfkBBSU/_middlewareManifest.js" defer=""></script></head><body><div id="__next" data-reactroot=""><div class="bg-gray-800"><div class="max-w-7xl mx-auto "><div class="relative flex items-center justify-between h-16"><div class="flex-1 flex items-center justify-center sm:items-stretch sm:justify-start"><div class="flex-shrink-0 flex items-center text-white font-bold"><a class="flex items-center" href="/"><img alt="logo" class="text-white w-8 inline-block mr-3" src="/logo.svg"/><span class="text-xl">EventCatalog</span></a></div></div><div class="hidden sm:block sm:ml-6"><div class="flex space-x-4"><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/events/">Events</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/services/">Services</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/visualiser/">Visualiser</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/overview/">3D Node Graph</a></div></div></div></div></div><div style="color:#000;background:#fff;font-family:-apple-system, BlinkMacSystemFont, Roboto, &quot;Segoe UI&quot;, &quot;Fira Sans&quot;, Avenir, &quot;Helvetica Neue&quot;, &quot;Lucida Grande&quot;, sans-serif;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body { margin: 0 }</style><h1 style="display:inline-block;border-right:1px solid rgba(0, 0, 0,.3);margin:0;margin-right:20px;padding:10px 23px 10px 0;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block;text-align:left;line-height:49px;height:49px;vertical-align:middle"><h2 style="font-size:14px;font-weight:normal;line-height:inherit;margin:0;padding:0">This page could not be found<!-- -->.</h2></div></div></div><footer class="bg-gray-800"><div class="max-w-7xl mx-auto py-12 px-4 overflow-hidden sm:px-6 lg:px-8"><nav class="-mx-5 -my-2 flex flex-wrap justify-center" aria-label="Footer"><div class="px-5 py-2"><a href="/events" class="text-base text-gray-500 hover:text-gray-900">Events</a></div><div class="px-5 py-2"><a href="/services" class="text-base text-gray-500 hover:text-gray-900">Services</a></div><div class="px-5 py-2"><a href="/overview" class="text-base text-gray-500 hover:text-gray-900">3D Node Graph</a></div><div class="px-5 py-2"><a href="https://github.com/boyney123/eventcatalog-demo/edit/master" class="text-base text-gray-500 hover:text-gray-900">GitHub</a></div></nav><p class="mt-8 text-center text-base text-gray-400">Copyright © <!-- -->2022<!-- --> <!-- -->Your Company<!-- -->. Built with<!-- --> <a class="underline" href="https://eventcatalog.dev" target="_blank" rel="noreferrer">EventCatalog.</a></p></div></footer></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"R1JBWbiD3Q61grTfkBBSU","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
+<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><script src="//unpkg.com/three"></script><script src="//unpkg.com/three/examples/js/renderers/CSS2DRenderer.js"></script><link rel="stylesheet" href="https://cdn.bootcss.com/font-awesome/4.7.0/css/font-awesome.css"/><meta name="description" content="Discover, Explore and Document your Event Driven Architectures"/><link rel="icon" href="/favicon.ico"/><meta property="og:url" content="https://eventcatalog.dev/"/><meta property="og:type" content="website"/><meta property="og:title" content="EventCatalog"/><meta property="og:description" content="Discover, Explore and Document your Event Driven Architectures"/><meta property="og:image" content="https://eventcatalog.dev/img/opengraph.png"/><meta property="og:image:alt" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures"/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="600"/><meta property="og:locale" content="en-GB"/><meta name="author" content="David Boyne"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-light.min.css"/><title>404: This page could not be found</title><meta name="next-head-count" content="19"/><link rel="preload" href="/_next/static/css/70ede87da43120f8.css" as="style"/><link rel="stylesheet" href="/_next/static/css/70ede87da43120f8.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-b17b8ef11b94ba66.js" defer=""></script><script src="/_next/static/chunks/framework-576ec6a1c1386453.js" defer=""></script><script src="/_next/static/chunks/main-0015f560a7edeb35.js" defer=""></script><script src="/_next/static/chunks/pages/_app-d88c877888678e85.js" defer=""></script><script src="/_next/static/chunks/pages/_error-5a714c45c50a8db4.js" defer=""></script><script src="/_next/static/sTHntsHUajnk_njFTxiB5/_buildManifest.js" defer=""></script><script src="/_next/static/sTHntsHUajnk_njFTxiB5/_ssgManifest.js" defer=""></script><script src="/_next/static/sTHntsHUajnk_njFTxiB5/_middlewareManifest.js" defer=""></script></head><body><div id="__next" data-reactroot=""><div class="bg-gray-800"><div class="max-w-7xl mx-auto "><div class="relative flex items-center justify-between h-16"><div class="flex-1 flex items-center justify-center sm:items-stretch sm:justify-start"><div class="flex-shrink-0 flex items-center text-white font-bold"><a class="flex items-center" href="/"><img alt="logo" class="text-white w-8 inline-block mr-3" src="/logo.svg"/><span class="text-xl">EventCatalog</span></a></div></div><div class="hidden sm:block sm:ml-6"><div class="flex space-x-4"><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/events/">Events</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/services/">Services</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/domains/">Domains</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/visualiser/">Visualiser</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/overview/">3D Node Graph</a></div></div></div></div></div><div style="color:#000;background:#fff;font-family:-apple-system, BlinkMacSystemFont, Roboto, &quot;Segoe UI&quot;, &quot;Fira Sans&quot;, Avenir, &quot;Helvetica Neue&quot;, &quot;Lucida Grande&quot;, sans-serif;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body { margin: 0 }</style><h1 style="display:inline-block;border-right:1px solid rgba(0, 0, 0,.3);margin:0;margin-right:20px;padding:10px 23px 10px 0;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block;text-align:left;line-height:49px;height:49px;vertical-align:middle"><h2 style="font-size:14px;font-weight:normal;line-height:inherit;margin:0;padding:0">This page could not be found<!-- -->.</h2></div></div></div><footer class="bg-gray-800"><div class="max-w-7xl mx-auto py-12 px-4 overflow-hidden sm:px-6 lg:px-8"><nav class="-mx-5 -my-2 flex flex-wrap justify-center" aria-label="Footer"><div class="px-5 py-2"><a href="/events" class="text-base text-gray-500 hover:text-gray-400">Events</a></div><div class="px-5 py-2"><a href="/services" class="text-base text-gray-500 hover:text-gray-400">Services</a></div><div class="px-5 py-2"><a href="/visualiser" class="text-base text-gray-500 hover:text-gray-400">Visualiser</a></div><div class="px-5 py-2"><a href="/overview" class="text-base text-gray-500 hover:text-gray-400">3D Node Graph</a></div><div class="px-5 py-2"><a href="https://github.com/boyney123/eventcatalog-demo/edit/master" class="text-base text-gray-500 hover:text-gray-400">GitHub</a></div></nav><p class="mt-8 text-center text-base text-gray-400">Copyright © <!-- -->2022<!-- --> <!-- -->Your Company<!-- -->. Built with<!-- --> <a class="underline" href="https://eventcatalog.dev" target="_blank" rel="noreferrer">EventCatalog.</a></p></div></footer></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"sTHntsHUajnk_njFTxiB5","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>

package/out/_next/data/sTHntsHUajnk_njFTxiB5/domains/Shopping/events/AddedItemToCart/v/0.0.1.json

@@ -0,0 +1 @@
+{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.1","summary":"Holds information about what the user added to their shopping cart.\n","domain":"Shopping","producerNames":["Basket Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"producers":[{"name":"Basket Service","summary":"CRUD based API to handle Basket interactions for users of the shopping website.\n","domain":"Shopping","owners":["dboyne"],"repository":{"language":"JavaScript","url":"https://github.com/boyney123/pretend-basket-service"},"tags":[],"externalLinks":[{"label":"AsyncAPI Specification","url":"https://studio.asyncapi.com/#schema-lightMeasuredPayload"}],"publishes":[{"name":"AddedItemToCart","version":"0.0.3","summary":"Holds information about what the user added to their shopping cart.\n","domain":"Shopping","producerNames":["Basket Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[{"label":"AsyncAPI Specification","url":"https://studio.asyncapi.com/#schema-lightMeasuredPayload"}],"historicVersions":["0.0.2","0.0.1"]},{"name":"OrderRequested","version":"0.0.1","summary":"Holds information about the customers order.\n","domain":null,"producerNames":["Basket Service"],"consumerNames":["Payment Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"RemovedItemFromCart","version":"0.0.1","summary":"Holds information about what the user removed from their cart.\n","domain":null,"producerNames":["Basket Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[]}],"consumers":[{"name":"Data Lake","summary":"Our internal datalake used by the data team and business analytics.\n","domain":"Shopping","owners":["dboyne"],"repository":{},"tags":[],"externalLinks":[],"publishes":[],"subscribes":[{"name":"AddedItemToCart","version":"0.0.3","summary":"Holds information about what the user added to their shopping cart.\n","domain":"Shopping","producerNames":["Basket Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[{"label":"AsyncAPI Specification","url":"https://studio.asyncapi.com/#schema-lightMeasuredPayload"}],"historicVersions":["0.0.2","0.0.1"]},{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":null,"producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"RemovedItemFromCart","version":"0.0.1","summary":"Holds information about what the user removed from their cart.\n","domain":null,"producerNames":["Basket Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentDelivered","version":"0.0.1","summary":"Event represents when a shipment has been delivered and received.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Order Service","Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n  \"$id\": \"https://example.com/AddedItemToCart.json\",\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"AddedItemToCart\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"metadata\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"correlationId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the user\"\n        },\n        \"domain\": {\n          \"type\": \"string\",\n          \"description\": \"The domain of the event\"\n        },\n        \"service\": {\n          \"type\": \"string\",\n          \"description\": \"The name of the service that triggered the event\"\n        }\n      },\n      \"required\": [\"correlationId\", \"domain\"]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"userId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the user\"\n        },\n        \"itemId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the shopping item\"\n        }\n      }\n    }\n  }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/2/28"},"eventPath":"/domains/Shopping/events/AddedItemToCart","breadCrumbs":[{"name":"Domain","href":"/events","current":false},{"name":"Shopping","href":"/domains/Shopping","current":false},{"name":"Events","href":"/events?domain=Shopping","current":false},{"name":"AddedItemToCart","href":"/domains/Shopping/events/AddedItemToCart","current":false},{"name":"v0.0.1","href":"/domains/Shopping/events/AddedItemToCart/v/0.0.1","current":true}],"loadedVersion":"0.0.1"},"__N_SSG":true}