@eventcatalog/core 0.0.0-202201214199 → 0.0.0-2022018141010

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # @eventcatalog/core
 
-## 0.0.0-202201214199
+## 0.0.0-2022018141010
+
+### Patch Changes
+
+- [`9eb7463`](https://github.com/boyney123/eventcatalog/commit/9eb7463b32baa09a6dd693e7f0eede63e33cd39c) [#71](https://github.com/boyney123/eventcatalog/pull/71) Thanks [@thim81](https://github.com/thim81)! - feat: link to external event documentation added
+
+## 0.0.7
 
 ### Patch Changes
 

package/bin/eventcatalog.js

@@ -22,16 +22,11 @@ const copyCoreApplicationCodeIntoUsersProjectDir = () => {
   // remove any files we don't care about
   exclusions.map((path) => {
     try {
-      fs.lstatSync(path).isDirectory()
-        ? fs.rmSync(path, { recursive: true, force: true })
-        : fs.unlinkSync(path);
+      fs.lstatSync(path).isDirectory() ? fs.rmSync(path, { recursive: true, force: true }) : fs.unlinkSync(path);
     } catch (error) {}
   });
 
-  fs.copyFileSync(
-    path.join(projectDIR, 'eventcatalog.config.js'),
-    path.join(eventCatalogLibDir, 'eventcatalog.config.js')
-  );
+  fs.copyFileSync(path.join(projectDIR, 'eventcatalog.config.js'), path.join(eventCatalogLibDir, 'eventcatalog.config.js'));
 };
 
 cli
@@ -77,10 +72,7 @@ cli
     // copy any public assets over (from users to the lib itself)
     fs.copySync(path.join(projectDIR, 'public'), path.join(eventCatalogLibDir, 'public'));
 
-    fs.copyFileSync(
-      path.join(projectDIR, 'eventcatalog.config.js'),
-      path.join(eventCatalogLibDir, 'eventcatalog.config.js')
-    );
+    fs.copyFileSync(path.join(projectDIR, 'eventcatalog.config.js'), path.join(eventCatalogLibDir, 'eventcatalog.config.js'));
 
     execSync(`cross-env PROJECT_DIR=${projectDIR} npm run dev`, {
       cwd: eventCatalogLibDir,
@@ -98,10 +90,7 @@ cli
       copyCoreApplicationCodeIntoUsersProjectDir();
     }
 
-    fs.copyFileSync(
-      path.join(projectDIR, 'eventcatalog.config.js'),
-      path.join(eventCatalogLibDir, 'eventcatalog.config.js')
-    );
+    fs.copyFileSync(path.join(projectDIR, 'eventcatalog.config.js'), path.join(eventCatalogLibDir, 'eventcatalog.config.js'));
 
     execSync(`cross-env PROJECT_DIR=${projectDIR} npm run generate`, {
       cwd: eventCatalogLibDir,

package/components/ContentView.tsx

@@ -39,9 +39,7 @@ export default function ContentView({
             <div className="max-w-5xl mx-auto px-4 sm:px-6 lg:px-8 xl:max-w-7xl xl:grid xl:grid-cols-4">
               <div className="xl:col-span-3 xl:pr-8 xl:border-r xl:border-gray-200 flex-col justify-between flex">
                 <div>
-                  {BreadCrumbs && (
-                    <div className="mb-5 border-b border-gray-100 pb-4">{BreadCrumbs}</div>
-                  )}
+                  {BreadCrumbs && <div className="mb-5 border-b border-gray-100 pb-4">{BreadCrumbs}</div>}
                   <div>
                     <div>
                       <div className="xl:border-b pb-4 flex justify-between ">
@@ -70,9 +68,7 @@ export default function ContentView({
                               <>
                                 You are currently viewing an old version of this event ({version}).
                                 <Link href={latestVersionUrl}>
-                                  <a className="block text-sm pl-7 mt-2 text-blue-500 underline">
-                                    Read latest version &rarr;
-                                  </a>
+                                  <a className="block text-sm pl-7 mt-2 text-blue-500 underline">Read latest version &rarr;</a>
                                 </Link>
                               </>
                             </Admonition>
@@ -86,10 +82,7 @@ export default function ContentView({
                             className="hidden md:inline-flex h-10 justify-center px-4 py-2 border border-gray-300 shadow-sm text-sm font-medium rounded-md text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-900"
                             rel="noreferrer"
                           >
-                            <PencilIcon
-                              className="-ml-1 mr-2 h-5 w-5 text-gray-400"
-                              aria-hidden="true"
-                            />
+                            <PencilIcon className="-ml-1 mr-2 h-5 w-5 text-gray-400" aria-hidden="true" />
                             <span>Edit</span>
                           </a>
                         </div>
@@ -98,8 +91,7 @@ export default function ContentView({
                         {isDraft && (
                           <Admonition className="mt-0 pt-0" type="warning">
                             <>
-                              This event is currently in <span className="underline">draft</span>{' '}
-                              mode.
+                              This event is currently in <span className="underline">draft</span> mode.
                             </>
                           </Admonition>
                         )}
@@ -111,10 +103,7 @@ export default function ContentView({
                 </div>
                 <div className="flex justify-between mt-10">
                   <a href={editUrl} target="_blank" className="flex text-gray-400" rel="noreferrer">
-                    <PencilIcon
-                      className="top-1 mr-2 relative h-4 w-4 text-gray-400"
-                      aria-hidden="true"
-                    />
+                    <PencilIcon className="top-1 mr-2 relative h-4 w-4 text-gray-400" aria-hidden="true" />
                     <span>Edit this page</span>
                   </a>
                   <span className="italic text-xs mt-2">Last updated on {lastModifiedDate}</span>

package/components/Grids/EventGrid.tsx

@@ -52,26 +52,16 @@ function EventGrid({ events = [], showMermaidDiagrams = false }: EventGridProps)
                     </div>
                     {showMermaidDiagrams && (
                       <div className="h-full items-center flex">
-                        <Mermaid
-                          source="event"
-                          data={event}
-                          rootNodeColor={getBackgroundColor(event.name)}
-                        />
+                        <Mermaid source="event" data={event} rootNodeColor={getBackgroundColor(event.name)} />
                       </div>
                     )}
                     <div className="flex space-x-4 text-xs pt-2 relative bottom-0 left-0">
                       <div className=" font-medium text-gray-500">
-                        <CubeIcon
-                          className="h-4 w-4 text-green-400 inline-block mr-2"
-                          aria-hidden="true"
-                        />
+                        <CubeIcon className="h-4 w-4 text-green-400 inline-block mr-2" aria-hidden="true" />
                         Producers ({event.producers.length})
                       </div>
                       <div className=" font-medium text-gray-500">
-                        <CubeIcon
-                          className="h-4 w-4 text-indigo-400 inline-block mr-2"
-                          aria-hidden="true"
-                        />
+                        <CubeIcon className="h-4 w-4 text-indigo-400 inline-block mr-2" aria-hidden="true" />
                         Subscribers ({event.consumers.length})
                       </div>
                     </div>

package/components/Grids/ServiceGrid.tsx

@@ -36,23 +36,15 @@ function ServiceGrid({ services = [] }: ServiceGridProps) {
                           Draft
                         </span>
                       )}
-                      <div className="text-gray-500 text-xs font-normal mt-2 line-clamp-3">
-                        {service.summary}
-                      </div>
+                      <div className="text-gray-500 text-xs font-normal mt-2 line-clamp-3">{service.summary}</div>
                     </div>
                     <div className="flex space-x-4 text-xs pt-2 relative bottom-0 left-0">
                       <div className=" font-medium text-gray-500">
-                        <CubeIcon
-                          className="h-4 w-4 text-green-400 inline-block mr-2"
-                          aria-hidden="true"
-                        />
+                        <CubeIcon className="h-4 w-4 text-green-400 inline-block mr-2" aria-hidden="true" />
                         Subscribe Events ({service.subscribes.length})
                       </div>
                       <div className=" font-medium text-gray-500">
-                        <CubeIcon
-                          className="h-4 w-4 text-indigo-400 inline-block mr-2"
-                          aria-hidden="true"
-                        />
+                        <CubeIcon className="h-4 w-4 text-indigo-400 inline-block mr-2" aria-hidden="true" />
                         Publish Events ({service.publishes.length})
                       </div>
                     </div>

package/components/Header.tsx

@@ -38,9 +38,7 @@ export default function Example() {
                   <Link key={item.name} href={item.href}>
                     <a
                       className={classNames(
-                        current
-                          ? 'bg-gray-900 text-white'
-                          : 'text-gray-300 hover:bg-gray-700 hover:text-white',
+                        current ? 'bg-gray-900 text-white' : 'text-gray-300 hover:bg-gray-700 hover:text-white',
                         'px-3 py-2 rounded-md text-sm font-medium'
                       )}
                       aria-current={current ? 'page' : undefined}

package/components/Mdx/Examples.tsx

@@ -12,12 +12,7 @@ interface ExampleProps {
   showLineNumbers?: boolean;
 }
 
-function Examples({
-  title = 'Examples',
-  description,
-  examples = [],
-  showLineNumbers,
-}: ExampleProps) {
+function Examples({ title = 'Examples', description, examples = [], showLineNumbers }: ExampleProps) {
   const tabs = examples.map((example, index) => ({
     name: example.name || `Example ${index + 1}`,
     content: example.snippet,
@@ -64,9 +59,7 @@ function Examples({
             <SyntaxHighlighter language={selectedTab.langugage} showLineNumbers={showLineNumbers}>
               {selectedTab.content}
             </SyntaxHighlighter>
-            {selectedTab.langugage && (
-              <span className="-mb-2 block text-xs text-right font-bold">{selectedTab.name}</span>
-            )}
+            {selectedTab.langugage && <span className="-mb-2 block text-xs text-right font-bold">{selectedTab.name}</span>}
           </div>
         </div>
       </div>

package/components/NotFound/index.tsx

@@ -18,15 +18,11 @@ export default function Example(props: NotFoundProps) {
         <p className="text-sm font-semibold text-gray-700 text-opacity-50 uppercase tracking-wide blur-xl">
           Failed to find {type}
         </p>
-        <h1 className="mt-2 text-4xl font-extrabold text-gray-900 tracking-tight sm:text-5xl">
-          Missing Documentation
-        </h1>
+        <h1 className="mt-2 text-4xl font-extrabold text-gray-900 tracking-tight sm:text-5xl">Missing Documentation</h1>
         <p className="mt-2 text-lg font-medium text-gray-700 text-opacity-50">
           Documentation for {type} <span className="underline">{name}</span> is missing!
         </p>
-        <p className="mt-4 text-xs text-gray-400">
-          Help the eco-system and add the documentation for others ❤️{' '}
-        </p>
+        <p className="mt-4 text-xs text-gray-400">Help the eco-system and add the documentation for others ❤️ </p>
         <div className="mt-12">
           <a
             href={urlToAddPage}

package/components/Sidebars/EventSidebar.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import Link from 'next/link';
-import { CubeIcon, DownloadIcon } from '@heroicons/react/outline';
+import { CubeIcon, DownloadIcon, ExternalLinkIcon } from '@heroicons/react/outline';
 import type { Event } from '@eventcatalog/types';
 import fileDownload from 'js-file-download';
 import { useUser } from '@/hooks/EventCatalog';
@@ -13,7 +13,7 @@ interface EventSideBarProps {
 function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
   const { getUserById } = useUser();
 
-  const { name: eventName, owners, producers, consumers, historicVersions } = event;
+  const { name: eventName, owners, producers, consumers, historicVersions, externalLinks } = event;
 
   const handleDownload = async () => {
     try {
@@ -43,10 +43,7 @@ function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
                 <Link href={`/services/${producer}`}>
                   <a className="relative inline-flex items-center rounded-full border border-gray-300 px-3 py-0.5">
                     <div className="absolute flex-shrink-0 flex items-center justify-center">
-                      <span
-                        className="h-1.5 w-1.5 rounded-full bg-green-500 animate animate-pulse"
-                        aria-hidden="true"
-                      />
+                      <span className="h-1.5 w-1.5 rounded-full bg-green-500 animate animate-pulse" aria-hidden="true" />
                     </div>
                     <div className="ml-3.5 text-sm font-medium text-gray-900">{producer}</div>
                   </a>
@@ -66,15 +63,9 @@ function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
             {consumers.map((consumer) => (
               <li className="inline" key={consumer}>
                 <Link href={`/services/${consumer}`}>
-                  <a
-                    href="#"
-                    className="relative inline-flex items-center rounded-full border border-gray-300 px-3 py-0.5"
-                  >
+                  <a href="#" className="relative inline-flex items-center rounded-full border border-gray-300 px-3 py-0.5">
                     <div className="absolute flex-shrink-0 flex items-center justify-center">
-                      <span
-                        className="h-1.5 w-1.5 rounded-full bg-indigo-500 animate animate-pulse"
-                        aria-hidden="true"
-                      />
+                      <span className="h-1.5 w-1.5 rounded-full bg-indigo-500 animate animate-pulse" aria-hidden="true" />
                     </div>
                     <div className="ml-3.5 text-sm font-medium text-gray-900">{consumer}</div>
                   </a>
@@ -194,6 +185,19 @@ function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
             </a>
           </Link>
         )}
+        {externalLinks.length > 0 &&
+          externalLinks.map((tag) => (
+            <a
+              href={tag.url}
+              target="_blank"
+              type="button"
+              className="hidden w-full md:inline-flex h-10 justify-center px-4 py-2 border border-teal-300 shadow-sm text-sm font-medium rounded-md text-teal-800 hover:bg-teal-100 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-teal-200"
+              rel="noreferrer"
+            >
+              <ExternalLinkIcon className="-ml-1 mr-2 h-5 w-5 text-teal-200" aria-hidden="true" />
+              <span>{`${tag.label}`}</span>
+            </a>
+          ))}
       </div>
     </aside>
   );

package/components/Sidebars/ServiceSidebar.tsx

@@ -44,15 +44,9 @@ function ServiceSidebar({ service }: ServiceSideBarProps) {
             {publishes.map((event) => (
               <li className="inline" key={event.name}>
                 <Link href={`/events/${event.name}`}>
-                  <a
-                    href="#"
-                    className="relative inline-flex items-center rounded-full border border-gray-300 px-3 py-0.5"
-                  >
+                  <a href="#" className="relative inline-flex items-center rounded-full border border-gray-300 px-3 py-0.5">
                     <div className="absolute flex-shrink-0 flex items-center justify-center">
-                      <span
-                        className="h-1.5 w-1.5 rounded-full bg-indigo-500 animate animate-pulse"
-                        aria-hidden="true"
-                      />
+                      <span className="h-1.5 w-1.5 rounded-full bg-indigo-500 animate animate-pulse" aria-hidden="true" />
                     </div>
                     <div className="ml-3.5 text-sm font-medium text-gray-900">{event.name}</div>
                   </a>
@@ -74,10 +68,7 @@ function ServiceSidebar({ service }: ServiceSideBarProps) {
                 <Link href={`/events/${event.name}`}>
                   <a className="relative inline-flex items-center rounded-full border border-gray-300 px-3 py-0.5">
                     <div className="absolute flex-shrink-0 flex items-center justify-center">
-                      <span
-                        className="h-1.5 w-1.5 rounded-full bg-green-500  animate animate-pulse"
-                        aria-hidden="true"
-                      />
+                      <span className="h-1.5 w-1.5 rounded-full bg-green-500  animate animate-pulse" aria-hidden="true" />
                     </div>
                     <div className="ml-3.5 text-sm font-medium text-gray-900">{event.name}</div>
                   </a>
@@ -139,11 +130,7 @@ function ServiceSidebar({ service }: ServiceSideBarProps) {
             {languages.map((value) => (
               <div className="relative flex items-center mt-2" key={value}>
                 <div className="absolute flex-shrink-0 flex items-center justify-center">
-                  <span
-                    className="h-2 w-2 rounded-full"
-                    aria-hidden="true"
-                    style={{ background: getBackgroundColor(value) }}
-                  />
+                  <span className="h-2 w-2 rounded-full" aria-hidden="true" style={{ background: getBackgroundColor(value) }} />
                 </div>
                 <div className="ml-3.5 text-sm font-medium text-gray-900">{value}</div>
               </div>
@@ -164,12 +151,7 @@ function ServiceSidebar({ service }: ServiceSideBarProps) {
 
                 if (url) {
                   return (
-                    <a
-                      href={url}
-                      className="inline-block underline"
-                      target="_blank"
-                      rel="noreferrer"
-                    >
+                    <a href={url} className="inline-block underline" target="_blank" rel="noreferrer">
                       <span
                         className={`underline inline-block mr-2 items-center px-2.5 py-0.5 rounded-full text-xs font-medium -top-0.5 relative bg-${color}-100 text-${color}-800`}
                       >

package/eventcatalog.config.js

@@ -0,0 +1,40 @@
+module.exports = {
+  title: 'EventCatalog',
+  tagline: 'Discover, Explore and Document your Event Driven Architectures',
+  organizationName: 'Your Company',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
+  logo: {
+    alt: 'EventCatalog Logo',
+    src: 'logo.svg',
+  },
+  footerLinks: [
+    { label: 'Events', href: '/events' },
+    { label: 'Services', href: '/services' },
+    { label: '3D Node Graph', href: '/overview' },
+    { label: 'GitHub', href: 'https://github.com/boyney123/eventcatalog-demo/edit/master' }
+  ],
+  generators: [
+    [
+      '@eventcatalog/plugin-doc-generator-asyncapi',
+      {
+        file: './asyncapi.yml',
+      },
+    ]
+  ],
+  users: [
+    {
+      id: 'dboyne',
+      name: 'David Boyne',
+      avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+      role: 'Developer',
+      summary: 'Currently building tools for Event Architectures.'
+    },
+    {
+      id: 'mSmith',
+      name: 'Matthew Smith',
+      avatarUrl: 'https://randomuser.me/api/portraits/lego/3.jpg',
+      role: 'Developer',
+      summary: 'About Fugiat ipsum ipsum deserunt culpa aute sint do nostrud anim incididunt cillum culpa consequat.'
+    },
+  ],
+}

package/lib/__tests__/events.spec.ts

@@ -27,12 +27,12 @@ describe('events lib', () => {
       expect(event).toEqual({
         name: 'AddedItemToCart',
         version: '0.0.1',
-        summary:
-          'Holds information about the cusomer and product when they add an item to the cart.\n',
+        summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
         producers: ['Shopping API', 'Application API'],
         consumers: ['Customer Portal'],
         owners: ['dboyne', 'mSmith'],
         historicVersions: [],
+        externalLinks: [],
         schema: null,
         examples: [],
       });
@@ -68,23 +68,11 @@ describe('events lib', () => {
       const example2 = event.examples[1];
 
       const example1File = fs.readFileSync(
-        path.join(
-          process.env.PROJECT_DIR,
-          'events',
-          'EventWithSchemaAndExamples',
-          'examples',
-          'Basic.cs'
-        ),
+        path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'examples', 'Basic.cs'),
         { encoding: 'utf-8' }
       );
       const example2File = fs.readFileSync(
-        path.join(
-          process.env.PROJECT_DIR,
-          'events',
-          'EventWithSchemaAndExamples',
-          'examples',
-          'Basic.js'
-        ),
+        path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'examples', 'Basic.js'),
         { encoding: 'utf-8' }
       );
 
@@ -118,11 +106,11 @@ describe('events lib', () => {
         {
           name: 'AddedItemToCart',
           version: '0.0.1',
-          summary:
-            'Holds information about the cusomer and product when they add an item to the cart.\n',
+          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
           producers: ['Shopping API', 'Application API'],
           consumers: ['Customer Portal'],
           historicVersions: [],
+          externalLinks: [],
           owners: ['dboyne', 'mSmith'],
         },
         {
@@ -131,6 +119,7 @@ describe('events lib', () => {
           summary: 'Tells us when an email has been sent\n',
           producers: ['Email Platform'],
           historicVersions: [],
+          externalLinks: [],
           consumers: [],
           owners: ['dboyne', 'mSmith'],
         },
@@ -139,6 +128,7 @@ describe('events lib', () => {
           version: '0.0.1',
           summary: 'Example event with schema and examples\n',
           historicVersions: [],
+          externalLinks: [],
           producers: [],
           consumers: [],
           owners: [],
@@ -149,6 +139,7 @@ describe('events lib', () => {
           summary: 'Tells us when an email has been sent\n',
           historicVersions: ['0.0.1'],
           producers: [],
+          externalLinks: [],
           consumers: [],
           owners: [],
         },
@@ -206,12 +197,12 @@ describe('events lib', () => {
         {
           name: 'AddedItemToCart',
           version: '0.0.1',
-          summary:
-            'Holds information about the cusomer and product when they add an item to the cart.\n',
+          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
           producers: ['Shopping API', 'Application API'],
           consumers: ['Customer Portal'],
-          historicVersions: [],
           owners: ['dboyne', 'mSmith'],
+          historicVersions: [],
+          externalLinks: [],
         },
         {
           name: 'EmailSent',
@@ -220,6 +211,7 @@ describe('events lib', () => {
           producers: ['Email Platform'],
           consumers: [],
           historicVersions: [],
+          externalLinks: [],
           owners: ['dboyne', 'mSmith'],
         },
       ]);
@@ -232,8 +224,7 @@ describe('events lib', () => {
         {
           name: 'AddedItemToCart',
           version: '0.0.1',
-          summary:
-            'Holds information about the cusomer and product when they add an item to the cart.\n',
+          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
           producers: ['Shopping API', 'My Service'],
           consumers: ['Customer Portal'],
           historicVersions: [],
@@ -254,8 +245,7 @@ describe('events lib', () => {
           {
             name: 'AddedItemToCart',
             version: '0.0.1',
-            summary:
-              'Holds information about the cusomer and product when they add an item to the cart.\n',
+            summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
             producers: ['Shopping API', 'My Service'],
             consumers: ['Customer Portal'],
             historicVersions: [],
@@ -271,8 +261,7 @@ describe('events lib', () => {
         {
           name: 'AddedItemToCart',
           version: '0.0.1',
-          summary:
-            'Holds information about the cusomer and product when they add an item to the cart.\n',
+          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
           producers: ['Shopping API', 'Service'],
           consumers: ['Customer Portal'],
           historicVersions: [],

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

@@ -21,9 +21,7 @@ describe('file-reader lib', () => {
         { encoding: 'utf-8' }
       );
 
-      const result = getSchemaFromDir(
-        path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples')
-      );
+      const result = getSchemaFromDir(path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples'));
 
       expect(result.snippet).toEqual(rawSchemaFile);
       expect(result.language).toEqual('json');
@@ -42,14 +40,10 @@ describe('file-reader lib', () => {
         path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'schema.json')
       );
 
-      const stats = fs.statSync(
-        path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'schema.json')
-      );
+      const stats = fs.statSync(path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'schema.json'));
 
       const fileData = new Date(stats.mtime);
-      const expectedResult = `${fileData.getFullYear()}/${
-        fileData.getMonth() + 1
-      }/${fileData.getDate()}`;
+      const expectedResult = `${fileData.getFullYear()}/${fileData.getMonth() + 1}/${fileData.getDate()}`;
 
       expect(result).toEqual(expectedResult);
     });

package/lib/__tests__/services.spec.ts

@@ -20,8 +20,7 @@ describe('services', () => {
       expect(services).toEqual([
         {
           name: 'Email Platform',
-          summary:
-            'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
+          summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
           owners: ['dboyne'],
           repository: {
             url: 'https://github.com/boyney123/EmailPlatform',
@@ -43,6 +42,7 @@ describe('services', () => {
               summary: 'Tells us when an email has been sent\n',
               producers: ['Email Platform'],
               consumers: [],
+              externalLinks: [],
               historicVersions: [],
               owners: ['dboyne', 'mSmith'],
             },
@@ -65,8 +65,7 @@ describe('services', () => {
       expect(services).toEqual([
         {
           name: 'Email Platform',
-          summary:
-            'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
+          summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
           owners: ['dboyne'],
           repository: {
             url: 'https://github.com/boyney123/EmailPlatform',
@@ -89,6 +88,7 @@ describe('services', () => {
               producers: ['Email Platform'],
               consumers: [],
               historicVersions: [],
+              externalLinks: [],
               owners: ['dboyne', 'mSmith'],
             },
           ],
@@ -104,8 +104,7 @@ describe('services', () => {
 
       expect(service).toEqual({
         name: 'Email Platform',
-        summary:
-          'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
+        summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
         owners: ['dboyne'],
         repository: {
           url: 'https://github.com/boyney123/EmailPlatform',
@@ -128,6 +127,7 @@ describe('services', () => {
             producers: ['Email Platform'],
             consumers: [],
             historicVersions: [],
+            externalLinks: [],
             owners: ['dboyne', 'mSmith'],
           },
         ],

package/lib/events.ts

@@ -11,8 +11,8 @@ import { extentionToLanguageMap } from './file-reader';
 import { getLastModifiedDateOfFile, getSchemaFromDir, readMarkdownFile } from '@/lib/file-reader';
 
 const parseEventFrontMatterIntoEvent = (eventFrontMatter: any): Event => {
-  const { name, version, summary, producers = [], consumers = [], owners = [] } = eventFrontMatter;
-  return { name, version, summary, producers, consumers, owners };
+  const { name, version, summary, producers = [], consumers = [], owners = [], externalLinks = [] } = eventFrontMatter;
+  return { name, version, summary, producers, consumers, owners, externalLinks };
 };
 
 const versionsForEvents = (pathToEvent) => {
@@ -36,9 +36,7 @@ export const getLogsForEvent = (eventName) => {
   }));
 
   // Get the latest version
-  const { data: { version: latestVersion } = {} } = readMarkdownFile(
-    path.join(eventsDir, eventName, 'index.md')
-  );
+  const { data: { version: latestVersion } = {} } = readMarkdownFile(path.join(eventsDir, eventName, 'index.md'));
 
   // Add the current version to the list
   allVersions.unshift({ version: latestVersion, pathToDir: path.join(eventsDir, eventName) });
@@ -143,10 +141,7 @@ export const getAllEvents = (): Event[] => {
   });
 };
 
-export const getEventByName = async (
-  eventName: string,
-  version?: string
-): Promise<{ event: Event; markdown: MarkdownFile }> => {
+export const getEventByName = async (eventName: string, version?: string): Promise<{ event: Event; markdown: MarkdownFile }> => {
   const eventsDir = path.join(process.env.PROJECT_DIR, 'events');
   const eventDirectory = path.join(eventsDir, eventName);
   let versionDirectory = null;

package/lib/file-reader.ts

@@ -46,7 +46,5 @@ export const getSchemaFromDir = (pathToSchemaDir: string): Schema => {
 export const getLastModifiedDateOfFile = (filePath) => {
   const stats = fs.statSync(filePath);
   const lastModifiedDate = new Date(stats.mtime);
-  return `${lastModifiedDate.getFullYear()}/${
-    lastModifiedDate.getMonth() + 1
-  }/${lastModifiedDate.getDate()}`;
+  return `${lastModifiedDate.getFullYear()}/${lastModifiedDate.getMonth() + 1}/${lastModifiedDate.getDate()}`;
 };