@eventcatalog/core 0.2.9 → 0.2.12

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @eventcatalog/core
 
+## 0.2.12
+
+### Patch Changes
+
+- [`4269b19`](https://github.com/boyney123/eventcatalog/commit/4269b199809807bd08968ce4f9c6e025c5d14794) [#241](https://github.com/boyney123/eventcatalog/pull/241) Thanks [@donaldpipowitch](https://github.com/donaldpipowitch)! - chore: improve typings
+
+## 0.2.11
+
+### Patch Changes
+
+- [`8c3c719`](https://github.com/boyney123/eventcatalog/commit/8c3c719b94e005921f6caec16106466da3f86992) [#244](https://github.com/boyney123/eventcatalog/pull/244) Thanks [@otbe](https://github.com/otbe)! - Fix broken links for services that have no domain on events detail page
+
+## 0.2.10
+
+### Patch Changes
+
+- [`41f6b5a`](https://github.com/boyney123/eventcatalog/commit/41f6b5a03645bfac2006f80c013ed7315cbe3add) [#229](https://github.com/boyney123/eventcatalog/pull/229) Thanks [@rtoro](https://github.com/rtoro)! - feat(core): allow the use of swagger ui in service pages
+
 ## 0.2.9
 
 ### Patch Changes

package/components/Mdx/NodeGraph/GraphLayout.ts

@@ -1,5 +1,6 @@
 import { isNode, Elements, Position } from 'react-flow-renderer';
 import dagre from 'dagre';
+import { DataSource } from './NodeGraph';
 
 const nodeDefaultWidth = 150;
 const nodeDefaultHeight = 36;
@@ -92,16 +93,16 @@ export default function createGraphLayout(elements: Elements, isHorizontal: bool
 }
 
 // Helper - ReactFlow canvas height calculator
-export const calcCanvasHeight = (data, type): number => {
+export const calcCanvasHeight = ({ source, data }: DataSource): number => {
   const minHeight = 300;
   const nodeSpacing = nodeDefaultHeight + verticalOffset;
   let nodesHeight = 0;
 
-  if (type === 'event') {
+  if (source === 'event') {
     nodesHeight = Math.max(data.producerNames.length, data.consumerNames.length) * nodeSpacing;
   }
 
-  if (type === 'service') {
+  if (source === 'service') {
     nodesHeight = Math.max(data.publishes.length, data.subscribes.length) * nodeSpacing;
   }
 

package/components/Mdx/NodeGraph/NodeGraph.tsx

@@ -11,9 +11,29 @@ interface CombinedEventsAndServices {
   name?: string;
 }
 
-interface NodeGraphBuilderProps {
-  data: Event | Service | Domain | CombinedEventsAndServices;
-  source: 'event' | 'service' | 'domain' | 'all';
+interface CombinedEventsAndServicesSource {
+  data: CombinedEventsAndServices;
+  source: 'all';
+}
+
+interface DomainSource {
+  data: Domain;
+  source: 'domain';
+}
+
+interface ServiceSource {
+  data: Service;
+  source: 'service';
+}
+
+interface EventSource {
+  data: Event;
+  source: 'event';
+}
+
+export type DataSource = CombinedEventsAndServicesSource | DomainSource | ServiceSource | EventSource;
+
+interface NodeGraphBuilderSharedProps {
   title?: string;
   subtitle?: string;
   rootNodeColor?: string;
@@ -28,10 +48,12 @@ interface NodeGraphBuilderProps {
   includeNodeIcons?: boolean;
 }
 
-interface NodeGraphProps extends NodeGraphBuilderProps {
+type NodeGraphBuilderProps = NodeGraphBuilderSharedProps & DataSource;
+
+type NodeGraphProps = NodeGraphBuilderProps & {
   maxHeight?: number | string;
   renderWithBorder?: boolean;
-}
+};
 
 // NodeGraphBuilder component wrapping ReactFlow
 function NodeGraphBuilder({
@@ -52,9 +74,8 @@ function NodeGraphBuilder({
 }: NodeGraphBuilderProps) {
   const getElements = useCallback(() => {
     if (source === 'domain' || source === 'all') {
-      const graphData = source === 'domain' ? (data as Domain) : (data as CombinedEventsAndServices);
-      const totalEventElements = graphData.events.map((event) => getEventElements(event, rootNodeColor, isAnimated, true, true));
-      const totalServiceElements = graphData.services.map((service) =>
+      const totalEventElements = data.events.map((event) => getEventElements(event, rootNodeColor, isAnimated, true, true));
+      const totalServiceElements = data.services.map((service) =>
         getServiceElements(service, rootNodeColor, isAnimated, true, true)
       );
       const eventsWithServices = totalEventElements.flat().concat(totalServiceElements.flat());
@@ -120,50 +141,18 @@ function NodeGraphBuilder({
 }
 
 // NodeGraph wrapping NodeGraphBuilder Component
-function NodeGraph({
-  data,
-  source,
-  rootNodeColor,
-  maxHeight,
-  maxZoom,
-  fitView,
-  zoomOnScroll,
-  isAnimated,
-  isDraggable,
-  isHorizontal,
-  includeBackground,
-  renderWithBorder = true,
-  title,
-  subtitle,
-  includeEdgeLabels,
-  includeNodeIcons,
-}: NodeGraphProps) {
+function NodeGraph({ maxHeight, renderWithBorder = true, ...builderProps }: NodeGraphProps) {
   // Set dynamic height of node graph
-  const dynamicHeight = maxHeight || calcCanvasHeight(data, source);
+  const dynamicHeight = maxHeight || calcCanvasHeight(builderProps);
 
   const borderClasses = `border-dashed border-2 border-slate-300`;
 
   return (
     <div className={`node-graph w-full h-screen ${renderWithBorder ? borderClasses : ''}`} style={{ height: dynamicHeight }}>
       <ReactFlowProvider>
-        <NodeGraphBuilder
-          source={source}
-          data={data}
-          rootNodeColor={rootNodeColor}
-          maxZoom={maxZoom}
-          fitView={fitView}
-          includeBackground={includeBackground}
-          zoomOnScroll={zoomOnScroll}
-          isAnimated={isAnimated}
-          isDraggable={isDraggable}
-          isHorizontal={isHorizontal}
-          includeEdgeLabels={includeEdgeLabels}
-          includeNodeIcons={includeNodeIcons}
-          title={title}
-          subtitle={subtitle}
-        />
+        <NodeGraphBuilder {...builderProps} />
       </ReactFlowProvider>
-      <Link href={`/visualiser?type=${source}&name=${data.name}`}>
+      <Link href={`/visualiser?type=${builderProps.source}&name=${builderProps.data.name}`}>
         <a className="block text-right  underline text-xs mt-4">Open in Visualiser &rarr;</a>
       </Link>
     </div>

package/components/Mdx/NodeGraph/__tests__/GraphLayout.spec.ts

@@ -1,3 +1,4 @@
+import { Event, Service } from '@eventcatalog/types';
 import { Elements } from 'react-flow-renderer';
 import createGraphLayout, { calcCanvasHeight } from '../GraphLayout';
 
@@ -84,20 +85,30 @@ describe('GraphLayout', () => {
 
   describe('calcCanvasHeight', () => {
     it('takes all events and calculate the canvas height', () => {
-      const data = {
-        producerNames: [1, 2, 3, 4, 5, 6, 7, 8],
-        consumerNames: [1, 2, 3, 4, 5],
+      const data: Event = {
+        producerNames: ['1', '2', '3', '4', '5', '6', '7', '8'],
+        consumerNames: ['1', '2', '3', '4', '5'],
+        name: 'mock',
+        version: '1.0.0',
       };
-      const result = calcCanvasHeight(data, 'event');
+      const result = calcCanvasHeight({ data, source: 'event' });
       expect(result).toEqual(544);
     });
 
     it('takes all services and calculate the canvas height', () => {
-      const data = {
-        publishes: [1, 2, 3, 4, 5, 6, 7, 8, 9],
-        subscribes: [1, 2, 3, 4, 5],
+      const event: Event = {
+        producerNames: [],
+        consumerNames: [],
+        name: 'mock',
+        version: '1.0.0',
       };
-      const result = calcCanvasHeight(data, 'service');
+      const data: Service = {
+        publishes: [event, event, event, event, event, event, event, event, event],
+        subscribes: [event, event, event, event, event],
+        name: 'mock',
+        summary: 'mock',
+      };
+      const result = calcCanvasHeight({ data, source: 'service' });
       expect(result).toEqual(612);
     });
   });

package/components/Mdx/OpenApiSpec.tsx

@@ -0,0 +1,18 @@
+import SwaggerUI from 'swagger-ui-react';
+import 'swagger-ui-react/swagger-ui.css';
+
+interface OpenApiSpecProps {
+  spec: string;
+  showTitle?: boolean;
+}
+
+export default function OpenApiSpec({ spec, showTitle = true }: OpenApiSpecProps) {
+  const className = !showTitle ? 'swagger-hide-title' : '';
+
+  return (
+    <div className={`my-4 border border-gray-300 border-dashed px-5 eventcatalog-swagger ${className}`}>
+      {!showTitle && <span className="text-2xl block mt-10 font-bold -mb-8">OpenAPI Specification</span>}
+      <SwaggerUI spec={spec} tryItOutEnabled={false} />
+    </div>
+  );
+}

package/components/Sidebars/EventSidebar.tsx

@@ -18,7 +18,7 @@ interface EventSideBarProps {
 const getServiceLink = (serviceName: string, event: Event) => {
   const allEventServices = [...event.consumers, ...event.producers];
   const matchedService = allEventServices.find((service) => service.name === serviceName);
-  if (matchedService) return `/domains/${matchedService.domain}/services/${serviceName}`;
+  if (matchedService && matchedService.domain) return `/domains/${matchedService.domain}/services/${serviceName}`;
   return `/services/${serviceName}`;
 };
 

package/lib/__tests__/assets/services/Payment Service/index.md

@@ -0,0 +1,7 @@
+---
+name: Payment Service
+summary: |
+  Event based application that integrates with Stripe.
+---
+
+# Testing

package/lib/__tests__/assets/services/Payment Service/openapi.yaml

@@ -0,0 +1,94 @@
+openapi: 3.0.0
+info:
+  description: A Payment Service API
+  version: 0.0.1
+  title: Payment service API
+servers:
+  - url: http://payment.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://payment.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+paths:
+  /getSinglePaymentURL:
+    get:
+      tags:
+        - PaymentServices
+      summary: Generate a Payment endpoint URL
+      operationId: singlepaymenturlUsingGET
+      consumes:
+        - application/json
+      produces:
+        - application/xml
+      parameters:
+        - name: transType
+          in: query
+          description: transType
+          required: true
+          type: string
+        - name: invoiceNumber
+          in: query
+          description: invoiceNumber
+          required: true
+          type: string
+        - name: approvedPage
+          in: query
+          description: approvedPage
+          required: true
+          type: string
+        - name: declinedPage
+          in: query
+          description: declinedPage
+          required: true
+          type: string
+        - in: query
+          name: errorPage
+          description: errorPage
+          required: true
+          type: string
+        - in: query
+          name: totalItemsAmount
+          description: totalItemsAmount
+          required: true
+          type: string
+        - name: ref1
+          in: query
+          description: ref1
+          required: false
+          type: string
+        - name: ref2
+          in: query
+          description: ref2
+          required: false
+          type: string
+        - name: ref3
+          in: query
+          description: ref3
+          required: false
+          type: string
+        - name: minutesToExpire
+          in: query
+          description: minutesToExpire
+          required: true
+          type: string
+      responses:
+        '200':
+          description: Successful operation
+          schema:
+            $ref: '#/definitions/SinglePaymentResponse'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+definitions:
+  SinglePaymentResponse:
+    type: object
+    properties:
+      respCode:
+        type: integer
+        format: int32
+      respMsg:
+        type: string
+      respValue:
+        type: string

package/lib/__tests__/file-reader.spec.ts

@@ -1,6 +1,6 @@
 import path from 'path';
 import fs from 'fs';
-import { getSchemaFromDir, getLastModifiedDateOfFile } from '../file-reader';
+import { getSchemaFromDir, getLastModifiedDateOfFile, getOpenAPISpecFromDir } from '../file-reader';
 
 let PROJECT_DIR: any;
 
@@ -34,6 +34,24 @@ describe('file-reader lib', () => {
     });
   });
 
+  describe('getOpenAPISpecFromDir', () => {
+    it('returns the OPEN API file found in the given directory path', () => {
+      const rawFile = fs.readFileSync(path.join(process.env.PROJECT_DIR, 'services', 'Payment Service', 'openapi.yaml'), {
+        encoding: 'utf-8',
+      });
+
+      const result = getOpenAPISpecFromDir(path.join(process.env.PROJECT_DIR, 'services', 'Payment Service'));
+
+      expect(result).toEqual(rawFile);
+    });
+
+    it('returns null when no schema file can be found in the given directory path', () => {
+      const result = getSchemaFromDir(path.join(process.env.PROJECT_DIR, 'services', 'Email Service'));
+
+      expect(result).toEqual(null);
+    });
+  });
+
   describe('getLastModifiedDateOfFile', () => {
     it('returns the date the given file was last modified', () => {
       const result = getLastModifiedDateOfFile(

package/lib/__tests__/services.spec.ts

@@ -19,29 +19,29 @@ describe('services', () => {
 
       expect(services).toEqual([
         {
+          name: 'Basket Service',
+          summary: 'CRUD based API to handle Basket interactions for users of the shopping website.\n',
+          domain: null,
+          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',
             },
           ],
-          name: 'Basket Service',
-          owners: ['mSmith'],
           publishes: [],
-          repository: {
-            language: 'JavaScript',
-            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: [],
         },
         {
           name: 'Email Platform',
           summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
-          owners: ['dboyne'],
           domain: null,
+          owners: ['dboyne'],
           repository: {
             url: 'https://github.com/boyney123/EmailPlatform',
             language: 'JavaScript',
@@ -55,21 +55,32 @@ describe('services', () => {
               url: 'https://www.apache.org/licenses/LICENSE-2.0',
             },
           ],
+          externalLinks: [],
           publishes: [
             {
               name: 'EmailSent',
               version: '0.0.1',
               summary: 'Tells us when an email has been sent\n',
+              domain: null,
               producerNames: ['Email Platform'],
               consumerNames: [],
+              owners: ['dboyne', 'mSmith'],
               externalLinks: [],
               historicVersions: [],
-              domain: null,
-              owners: ['dboyne', 'mSmith'],
             },
           ],
           subscribes: [],
+        },
+        {
+          name: 'Payment Service',
+          summary: 'Event based application that integrates with Stripe.\n',
+          domain: null,
+          owners: [],
+          repository: {},
+          tags: [],
           externalLinks: [],
+          publishes: [],
+          subscribes: [],
         },
         {
           name: 'User Service',
@@ -151,6 +162,7 @@ describe('services', () => {
         summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
         owners: ['dboyne'],
         domain: null,
+        openAPISpec: null,
         repository: {
           url: 'https://github.com/boyney123/EmailPlatform',
           language: 'JavaScript',
@@ -194,6 +206,7 @@ describe('services', () => {
           summary: 'CRUD based API to handle User information\n',
           domain: 'User',
           owners: ['mSmith'],
+          openAPISpec: null,
           repository: {
             language: 'JavaScript',
             url: 'https://github.com/boyney123/pretend-basket-service',

package/lib/file-reader.ts

@@ -43,6 +43,19 @@ export const getSchemaFromDir = (pathToSchemaDir: string): Schema => {
   }
 };
 
+export const getOpenAPISpecFromDir = (pathToOpenAPISpecDir: string): string => {
+  try {
+    const files = fs.readdirSync(pathToOpenAPISpecDir);
+
+    // See if any oas are in there, ignoring extension
+    const openAPIFileName = files.find((fileName) => fileName.includes('openapi'));
+    if (!openAPIFileName) throw new Error('No schema found');
+    return fs.readFileSync(path.join(pathToOpenAPISpecDir, openAPIFileName), 'utf-8');
+  } catch (error) {
+    return null;
+  }
+};
+
 export const getLastModifiedDateOfFile = (filePath) => {
   const stats = fs.statSync(filePath);
   const lastModifiedDate = new Date(stats.mtime);

package/lib/services.ts

@@ -2,7 +2,7 @@ import fs from 'fs';
 import path from 'path';
 import { serialize } from 'next-mdx-remote/serialize';
 import { Service, Event } from '@eventcatalog/types';
-import { readMarkdownFile, getLastModifiedDateOfFile } from '@/lib/file-reader';
+import { readMarkdownFile, getLastModifiedDateOfFile, getOpenAPISpecFromDir } from '@/lib/file-reader';
 import { MarkdownFile } from '../types/index';
 
 import { getAllEvents, getAllEventsThatHaveRelationshipWithService } from '@/lib/events';
@@ -75,6 +75,7 @@ export const getServiceByName = async ({
       service: {
         ...service,
         domain,
+        openAPISpec: getOpenAPISpecFromDir(serviceDirectory),
         ...getAllEventsThatHaveRelationshipWithService(service, events),
       },
       markdown: {

package/out/404/index.html

@@ -1 +1 @@
-<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><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"/><title>404: This page could not be found</title><meta name="next-head-count" content="15"/><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"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-light.min.css"/><link rel="preload" href="/_next/static/css/0a26a4437a9215b6.css" as="style"/><link rel="stylesheet" href="/_next/static/css/0a26a4437a9215b6.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-e5e3b0fb197a3a00.js" defer=""></script><script src="/_next/static/chunks/framework-d23f68ad701fe0b2.js" defer=""></script><script src="/_next/static/chunks/main-b9941e28536fdc23.js" defer=""></script><script src="/_next/static/chunks/pages/_app-2e37f6bdeff8f48f.js" defer=""></script><script src="/_next/static/chunks/pages/_error-5a714c45c50a8db4.js" defer=""></script><script src="/_next/static/053__bBTIZvPKam2MmLPC/_buildManifest.js" defer=""></script><script src="/_next/static/053__bBTIZvPKam2MmLPC/_ssgManifest.js" defer=""></script><script src="/_next/static/053__bBTIZvPKam2MmLPC/_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":"053__bBTIZvPKam2MmLPC","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"/><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"/><title>404: This page could not be found</title><meta name="next-head-count" content="15"/><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"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-light.min.css"/><link rel="preload" href="/_next/static/css/996136b57250cdf7.css" as="style"/><link rel="stylesheet" href="/_next/static/css/996136b57250cdf7.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-5243ea3e842fcabb.js" defer=""></script><script src="/_next/static/chunks/framework-d23f68ad701fe0b2.js" defer=""></script><script src="/_next/static/chunks/main-b9941e28536fdc23.js" defer=""></script><script src="/_next/static/chunks/pages/_app-2e37f6bdeff8f48f.js" defer=""></script><script src="/_next/static/chunks/pages/_error-5a714c45c50a8db4.js" defer=""></script><script src="/_next/static/P5kR3NJnMI8_LCcCh0vDK/_buildManifest.js" defer=""></script><script src="/_next/static/P5kR3NJnMI8_LCcCh0vDK/_ssgManifest.js" defer=""></script><script src="/_next/static/P5kR3NJnMI8_LCcCh0vDK/_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":"P5kR3NJnMI8_LCcCh0vDK","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>

package/out/_next/data/{053__bBTIZvPKam2MmLPC → P5kR3NJnMI8_LCcCh0vDK}/domains/Orders/events/OrderComplete.json

@@ -1 +1 @@
-{"pageProps":{"event":{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"producers":[{"name":"Orders Service","summary":"Service that handles customer orders\n","domain":"Orders","owners":["dboyne"],"repository":{},"tags":[],"externalLinks":[],"publishes":[{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[{"name":"PaymentProcessed","version":"0.0.1","summary":"Holds information about the payment that has been processed.\n","domain":null,"producerNames":["Payment Service"],"consumerNames":["Orders Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"consumers":[],"historicVersions":[],"schema":{"snippet":"{\n  \"$id\": \"https://example.com/OrderRequested.json\",\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"OrderRequested\",\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\", \"service\"]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"userId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the user\"\n        },\n        \"orderId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID the users order\"\n        }\n      }\n    }\n  }\n}","language":"json","extension":"json"},"examples":[]},"eventPath":"/domains/Orders/events/OrderComplete","breadCrumbs":[{"name":"Domain","href":"/domains","current":false},{"name":"Orders","href":"/domains/Orders","current":false},{"name":"Events","href":"/events?domain=Orders","current":false},{"name":"OrderComplete","href":"/domains/Orders/events/OrderComplete","current":true}],"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 is the final event of the ordering process. It gets raised when the shipment has been delivered.\n\n<NodeGraph title=\"Consumer/Producer Diagram\" />\n\n<Schema />","source":{"compiledSource":"var p=Object.defineProperty,c=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?p(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(r)for(var t of r(o))d.call(o,t)&&s(e,t,o[t]);return e},h=(e,o)=>c(e,u(o));var m=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),NodeGraph=makeShortcode(\"NodeGraph\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=m(n,[\"components\"]);return mdx(MDXLayout,h(a(a({},layoutProps),o),{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 is the final event of the ordering process. It gets raised when the shipment has been delivered.\"),mdx(NodeGraph,{title:\"Consumer/Producer Diagram\",mdxType:\"NodeGraph\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/3/7"},"loadedVersion":"latest"},"__N_SSG":true}
+{"pageProps":{"event":{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"producers":[{"name":"Orders Service","summary":"Service that handles customer orders\n","domain":"Orders","owners":["dboyne"],"repository":{},"tags":[],"externalLinks":[],"publishes":[{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[{"name":"PaymentProcessed","version":"0.0.1","summary":"Holds information about the payment that has been processed.\n","domain":null,"producerNames":["Payment Service"],"consumerNames":["Orders Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"consumers":[],"historicVersions":[],"schema":{"snippet":"{\n  \"$id\": \"https://example.com/OrderRequested.json\",\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"OrderRequested\",\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\", \"service\"]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"userId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the user\"\n        },\n        \"orderId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID the users order\"\n        }\n      }\n    }\n  }\n}","language":"json","extension":"json"},"examples":[]},"eventPath":"/domains/Orders/events/OrderComplete","breadCrumbs":[{"name":"Domain","href":"/domains","current":false},{"name":"Orders","href":"/domains/Orders","current":false},{"name":"Events","href":"/events?domain=Orders","current":false},{"name":"OrderComplete","href":"/domains/Orders/events/OrderComplete","current":true}],"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 is the final event of the ordering process. It gets raised when the shipment has been delivered.\n\n<NodeGraph title=\"Consumer/Producer Diagram\" />\n\n<Schema />","source":{"compiledSource":"var p=Object.defineProperty,c=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?p(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(r)for(var t of r(o))d.call(o,t)&&s(e,t,o[t]);return e},h=(e,o)=>c(e,u(o));var m=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),NodeGraph=makeShortcode(\"NodeGraph\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=m(n,[\"components\"]);return mdx(MDXLayout,h(a(a({},layoutProps),o),{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 is the final event of the ordering process. It gets raised when the shipment has been delivered.\"),mdx(NodeGraph,{title:\"Consumer/Producer Diagram\",mdxType:\"NodeGraph\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/3/18"},"loadedVersion":"latest"},"__N_SSG":true}

package/out/_next/data/{053__bBTIZvPKam2MmLPC → P5kR3NJnMI8_LCcCh0vDK}/domains/Orders/events/OrderConfirmed.json

@@ -1 +1 @@
-{"pageProps":{"event":{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"producers":[{"name":"Orders Service","summary":"Service that handles customer orders\n","domain":"Orders","owners":["dboyne"],"repository":{},"tags":[],"externalLinks":[],"publishes":[{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[{"name":"PaymentProcessed","version":"0.0.1","summary":"Holds information about the payment that has been processed.\n","domain":null,"producerNames":["Payment Service"],"consumerNames":["Orders Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"consumers":[{"name":"Shipping Service","summary":"Event based application that handles processing of shipments, preparing them and dispatching them.\n","domain":null,"owners":["dboyne"],"repository":{"language":"JavaScript","url":"https://github.com/boyney123/pretend-shipping-service"},"tags":[],"externalLinks":[],"publishes":[{"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":[]},{"name":"ShipmentDispatched","version":"0.0.1","summary":"Event represents when a shipment has been dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentPrepared","version":"0.0.1","summary":"Event represents when a shipment has finished being prepared and is ready to be dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentDispatched","version":"0.0.1","summary":"Event represents when a shipment has been dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentPrepared","version":"0.0.1","summary":"Event represents when a shipment has finished being prepared and is ready to be dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"historicVersions":[],"schema":{"snippet":"{\n  \"$id\": \"https://example.com/OrderRequested.json\",\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"OrderRequested\",\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\", \"service\"]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"userId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the user\"\n        },\n        \"orderId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID the users order\"\n        }\n      }\n    }\n  }\n}","language":"json","extension":"json"},"examples":[]},"eventPath":"/domains/Orders/events/OrderConfirmed","breadCrumbs":[{"name":"Domain","href":"/domains","current":false},{"name":"Orders","href":"/domains/Orders","current":false},{"name":"Events","href":"/events?domain=Orders","current":false},{"name":"OrderConfirmed","href":"/domains/Orders/events/OrderConfirmed","current":true}],"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 is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\n\n<NodeGraph title=\"Consumer/Producer Diagram\" />\n\n<Schema />","source":{"compiledSource":"var m=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,o,t)=>o in e?m(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&d(e,t,o[t]);if(r)for(var t of r(o))s.call(o,t)&&d(e,t,o[t]);return e},h=(e,o)=>p(e,u(o));var c=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&s.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),NodeGraph=makeShortcode(\"NodeGraph\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=c(n,[\"components\"]);return mdx(MDXLayout,h(a(a({},layoutProps),o),{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 is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\"),mdx(NodeGraph,{title:\"Consumer/Producer Diagram\",mdxType:\"NodeGraph\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/3/7"},"loadedVersion":"latest"},"__N_SSG":true}
+{"pageProps":{"event":{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"producers":[{"name":"Orders Service","summary":"Service that handles customer orders\n","domain":"Orders","owners":["dboyne"],"repository":{},"tags":[],"externalLinks":[],"publishes":[{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[{"name":"PaymentProcessed","version":"0.0.1","summary":"Holds information about the payment that has been processed.\n","domain":null,"producerNames":["Payment Service"],"consumerNames":["Orders Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"consumers":[{"name":"Shipping Service","summary":"Event based application that handles processing of shipments, preparing them and dispatching them.\n","domain":null,"owners":["dboyne"],"repository":{"language":"JavaScript","url":"https://github.com/boyney123/pretend-shipping-service"},"tags":[],"externalLinks":[],"publishes":[{"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":[]},{"name":"ShipmentDispatched","version":"0.0.1","summary":"Event represents when a shipment has been dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentPrepared","version":"0.0.1","summary":"Event represents when a shipment has finished being prepared and is ready to be dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}],"subscribes":[{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","domain":"Orders","producerNames":["Orders Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentDispatched","version":"0.0.1","summary":"Event represents when a shipment has been dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]},{"name":"ShipmentPrepared","version":"0.0.1","summary":"Event represents when a shipment has finished being prepared and is ready to be dispatched.\n","domain":null,"producerNames":["Shipping Service"],"consumerNames":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[]}]}],"historicVersions":[],"schema":{"snippet":"{\n  \"$id\": \"https://example.com/OrderRequested.json\",\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"OrderRequested\",\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\", \"service\"]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"userId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the user\"\n        },\n        \"orderId\": {\n          \"type\": \"string\",\n          \"description\": \"The ID the users order\"\n        }\n      }\n    }\n  }\n}","language":"json","extension":"json"},"examples":[]},"eventPath":"/domains/Orders/events/OrderConfirmed","breadCrumbs":[{"name":"Domain","href":"/domains","current":false},{"name":"Orders","href":"/domains/Orders","current":false},{"name":"Events","href":"/events?domain=Orders","current":false},{"name":"OrderConfirmed","href":"/domains/Orders/events/OrderConfirmed","current":true}],"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 is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\n\n<NodeGraph title=\"Consumer/Producer Diagram\" />\n\n<Schema />","source":{"compiledSource":"var m=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,o,t)=>o in e?m(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&d(e,t,o[t]);if(r)for(var t of r(o))s.call(o,t)&&d(e,t,o[t]);return e},h=(e,o)=>p(e,u(o));var c=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&s.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),NodeGraph=makeShortcode(\"NodeGraph\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=c(n,[\"components\"]);return mdx(MDXLayout,h(a(a({},layoutProps),o),{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 is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\"),mdx(NodeGraph,{title:\"Consumer/Producer Diagram\",mdxType:\"NodeGraph\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/3/18"},"loadedVersion":"latest"},"__N_SSG":true}