@eventcatalog/core 0.1.19 → 0.2.0

package/lib/__tests__/domains.spec.ts

@@ -0,0 +1,267 @@
+import path from 'path';
+import {
+  getAllDomains,
+  getAllDomainsByOwnerId,
+  getAllEventsFromDomains,
+  getAllServicesFromDomains,
+  getDomainByName,
+} from '../domains';
+
+let PROJECT_DIR: any;
+
+describe('domains lib', () => {
+  beforeAll(() => {
+    PROJECT_DIR = process.env.PROJECT_DIR;
+    process.env.PROJECT_DIR = path.join(__dirname, 'assets');
+  });
+
+  afterAll(() => {
+    process.env.PROJECT_DIR = PROJECT_DIR;
+  });
+
+  describe('getAllEventsFromDomains', () => {
+    it('returns all the events within every domain folder in the catalog', async () => {
+      const events = await getAllEventsFromDomains();
+      expect(events).toEqual([
+        {
+          name: 'UserCreated',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been created.\n',
+          domain: 'User',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
+          historicVersions: [],
+        },
+        {
+          name: 'UserRemoved',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been removed.\n',
+          domain: 'User',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
+          historicVersions: [],
+        },
+      ]);
+    });
+  });
+  describe('getAllServicesFromDomains', () => {
+    it('returns all the services within every domain folder in the catalog', async () => {
+      const services = await getAllServicesFromDomains();
+
+      expect(services).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: [],
+        },
+      ]);
+    });
+  });
+
+  describe('getDomainByName', () => {
+    it('returns domain information for a given domain name', async () => {
+      const { domain, markdown } = await getDomainByName({ domainName: 'User' });
+
+      expect(domain).toEqual({
+        name: 'User',
+        summary: 'User Domain\n',
+        owners: ['dboyne', 'mSmith'],
+        tags: [],
+        externalLinks: [],
+        events: [
+          {
+            name: 'UserCreated',
+            version: '0.0.1',
+            summary: 'Holds information about when the user has been created.\n',
+            domain: null,
+            producerNames: ['Application API'],
+            consumerNames: ['Customer Portal'],
+            owners: ['dboyne', 'mSmith'],
+            externalLinks: [],
+            historicVersions: [],
+          },
+          {
+            name: 'UserRemoved',
+            version: '0.0.1',
+            summary: 'Holds information about when the user has been removed.\n',
+            domain: null,
+            producerNames: ['Application API'],
+            consumerNames: ['Customer Portal'],
+            owners: ['dboyne', 'mSmith'],
+            externalLinks: [],
+            historicVersions: [],
+          },
+        ],
+        services: [
+          {
+            name: 'User Service',
+            summary: 'CRUD based API to handle User information\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',
+              },
+            ],
+            publishes: [],
+            subscribes: [],
+          },
+        ],
+      });
+      // @ts-ignore
+      expect(markdown.content).toMatchMarkdown('# Testing');
+    });
+  });
+
+  describe('getAllDomains', () => {
+    it('returns all domains within the catalog', async () => {
+      const domains = await getAllDomains();
+      const data = domains.map((item) => item.domain);
+
+      expect(data).toEqual([
+        {
+          name: 'User',
+          summary: 'User Domain\n',
+          owners: ['dboyne', 'mSmith'],
+          tags: [],
+          externalLinks: [],
+          events: [
+            {
+              name: 'UserCreated',
+              version: '0.0.1',
+              summary: 'Holds information about when the user has been created.\n',
+              domain: null,
+              producerNames: ['Application API'],
+              consumerNames: ['Customer Portal'],
+              owners: ['dboyne', 'mSmith'],
+              externalLinks: [],
+              historicVersions: [],
+            },
+            {
+              name: 'UserRemoved',
+              version: '0.0.1',
+              summary: 'Holds information about when the user has been removed.\n',
+              domain: null,
+              producerNames: ['Application API'],
+              consumerNames: ['Customer Portal'],
+              owners: ['dboyne', 'mSmith'],
+              externalLinks: [],
+              historicVersions: [],
+            },
+          ],
+          services: [
+            {
+              name: 'User Service',
+              summary: 'CRUD based API to handle User information\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',
+                },
+              ],
+              publishes: [],
+              subscribes: [],
+            },
+          ],
+        },
+      ]);
+    });
+  });
+
+  describe('getAllDomainsByOwnerId', () => {
+    it('returns empty array when no owner is found', async () => {
+      const domains = await getAllDomainsByOwnerId('made-up-user');
+      expect(domains).toEqual([]);
+    });
+
+    it('returns all the domains for a given owner id', async () => {
+      const domains = await getAllDomainsByOwnerId('dboyne');
+
+      expect(domains).toEqual([
+        {
+          name: 'User',
+          summary: 'User Domain\n',
+          owners: ['dboyne', 'mSmith'],
+          tags: [],
+          externalLinks: [],
+          events: [
+            {
+              name: 'UserCreated',
+              version: '0.0.1',
+              summary: 'Holds information about when the user has been created.\n',
+              domain: null,
+              producerNames: ['Application API'],
+              consumerNames: ['Customer Portal'],
+              owners: ['dboyne', 'mSmith'],
+              externalLinks: [],
+              historicVersions: [],
+            },
+            {
+              name: 'UserRemoved',
+              version: '0.0.1',
+              summary: 'Holds information about when the user has been removed.\n',
+              domain: null,
+              producerNames: ['Application API'],
+              consumerNames: ['Customer Portal'],
+              owners: ['dboyne', 'mSmith'],
+              externalLinks: [],
+              historicVersions: [],
+            },
+          ],
+          services: [
+            {
+              name: 'User Service',
+              summary: 'CRUD based API to handle User information\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',
+                },
+              ],
+              publishes: [],
+              subscribes: [],
+            },
+          ],
+        },
+      ]);
+    });
+  });
+});

package/lib/__tests__/events.spec.ts

@@ -21,85 +21,161 @@ describe('events lib', () => {
   });
 
   describe('getEventByName', () => {
-    it('returns an event and markdown by the given event name', async () => {
-      const { event, markdown } = await getEventByName('AddedItemToCart');
-
-      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',
-        producers: ['Shopping API', 'Application API'],
-        consumers: ['Customer Portal'],
-        owners: ['dboyne', 'mSmith'],
-        historicVersions: [],
-        externalLinks: [],
-        schema: null,
-        examples: [],
+    describe('events without domains', () => {
+      it('returns an event and markdown by the given event name', async () => {
+        const { event, markdown } = await getEventByName({ eventName: 'AddedItemToCart' });
+
+        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',
+          producerNames: ['Shopping API', 'Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
+          domain: null,
+          historicVersions: [],
+          consumers: [],
+          producers: [],
+          externalLinks: [],
+          schema: null,
+          examples: [],
+        });
+
+        // @ts-ignore
+        expect(markdown.content).toMatchMarkdown('# Testing');
       });
 
-      // @ts-ignore
-      expect(markdown.content).toMatchMarkdown('# Testing');
-    });
+      it('returns the schema and examples of the event as empty if no schema or examples are found', async () => {
+        const { event } = await getEventByName({ eventName: 'AddedItemToCart' });
 
-    it('returns the schema and examples of the event as empty if no schema or examples are found', async () => {
-      const { event } = await getEventByName('AddedItemToCart');
+        expect(event.schema).toEqual(null);
+        expect(event.examples).toEqual([]);
+      });
 
-      expect(event.schema).toEqual(null);
-      expect(event.examples).toEqual([]);
-    });
+      it('returns the schema if there is a `schema` file is found in directory of the event', async () => {
+        const { event } = await getEventByName({ eventName: 'EventWithSchemaAndExamples' });
 
-    it('returns the schema if there is a `schema` file is found in directory of the event', async () => {
-      const { event } = await getEventByName('EventWithSchemaAndExamples');
+        const schema = `{
+              "some-schema": true,
+              "does-not-really-matter-what-content-is-in-this-file": true
+          }`;
 
-      const schema = `{
-            "some-schema": true,
-            "does-not-really-matter-what-content-is-in-this-file": true
-        }`;
+        // @ts-ignore
+        expect(event.schema.snippet).toMatchMarkdown(schema);
+        expect(event.schema.language).toEqual('json');
+      });
 
-      // @ts-ignore
-      expect(event.schema.snippet).toMatchMarkdown(schema);
-      expect(event.schema.language).toEqual('json');
-    });
+      it('returns all event examples (files) when examples directory is found within the event folder', async () => {
+        const { event } = await getEventByName({ eventName: 'EventWithSchemaAndExamples' });
 
-    it('returns all event examples (files) when examples directory is found within the event folder', async () => {
-      const { event } = await getEventByName('EventWithSchemaAndExamples');
+        const example1 = event.examples[0];
+        const example2 = event.examples[1];
 
-      const example1 = event.examples[0];
-      const example2 = event.examples[1];
+        const example1File = fs.readFileSync(
+          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'),
+          { encoding: 'utf-8' }
+        );
 
-      const example1File = fs.readFileSync(
-        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'),
-        { encoding: 'utf-8' }
-      );
+        expect(event.examples).toHaveLength(2);
 
-      expect(event.examples).toHaveLength(2);
+        expect(example1.name).toEqual('Basic.cs');
+        expect(example1.langugage).toEqual('csharp');
+        expect(example1.snippet).toEqual(example1File);
 
-      expect(example1.name).toEqual('Basic.cs');
-      expect(example1.langugage).toEqual('csharp');
-      expect(example1.snippet).toEqual(example1File);
+        expect(example2.name).toEqual('Basic.js');
+        expect(example2.langugage).toEqual('javascript');
+        expect(example2.snippet).toEqual(example2File);
+      });
 
-      expect(example2.name).toEqual('Basic.js');
-      expect(example2.langugage).toEqual('javascript');
-      expect(example2.snippet).toEqual(example2File);
-    });
+      it('returns previous versions of events when the event has previous versions in the folder directory', async () => {
+        const { event } = await getEventByName({ eventName: 'EventWithVersions' });
+        expect(event.historicVersions).toEqual(['0.0.1']);
+      });
 
-    it('returns previous versions of events when the event has previous versions in the folder directory', async () => {
-      const { event } = await getEventByName('EventWithVersions');
-      expect(event.historicVersions).toEqual(['0.0.1']);
+      it('returns empty array of event historic events when the event does not have previous versions in the folder directory', async () => {
+        const { event } = await getEventByName({ eventName: 'EventWithSchemaAndExamples' });
+        expect(event.historicVersions).toEqual([]);
+      });
     });
 
-    it('returns empty array of event historic events when the event does not have previous versions in the folder directory', async () => {
-      const { event } = await getEventByName('EventWithSchemaAndExamples');
-      expect(event.historicVersions).toEqual([]);
+    describe('events within domains', () => {
+      it('returns an event and markdown by the given event name', async () => {
+        const { event, markdown } = await getEventByName({ eventName: 'UserCreated', domain: 'User' });
+
+        expect(event).toEqual({
+          name: 'UserCreated',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been created.\n',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
+          domain: 'User',
+          historicVersions: [],
+          externalLinks: [],
+          consumers: [],
+          producers: [],
+          schema: null,
+          examples: [],
+        });
+
+        // @ts-ignore
+        expect(markdown.content).toMatchMarkdown('# Testing');
+      });
+
+      it('returns the schema and examples of the event as empty if no schema or examples are found', async () => {
+        const { event } = await getEventByName({ eventName: 'UserCreated', domain: 'User' });
+
+        expect(event.schema).toEqual(null);
+        expect(event.examples).toEqual([]);
+      });
+
+      it('returns the schema if there is a `schema` file is found in directory of the event', async () => {
+        const { event } = await getEventByName({ eventName: 'UserRemoved', domain: 'User' });
+
+        const schema = `{
+              "some-schema": true,
+              "does-not-really-matter-what-content-is-in-this-file": true
+          }`;
+
+        // @ts-ignore
+        expect(event.schema.snippet).toMatchMarkdown(schema);
+        expect(event.schema.language).toEqual('json');
+      });
+
+      it('returns all event examples (files) when examples directory is found within the event folder', async () => {
+        const { event } = await getEventByName({ eventName: 'UserRemoved', domain: 'User' });
+
+        const example1 = event.examples[0];
+        const example2 = event.examples[1];
+
+        const example1File = fs.readFileSync(
+          path.join(process.env.PROJECT_DIR, 'domains', 'User', 'events', 'UserRemoved', 'examples', 'Basic.cs'),
+          { encoding: 'utf-8' }
+        );
+        const example2File = fs.readFileSync(
+          path.join(process.env.PROJECT_DIR, 'domains', 'User', 'events', 'UserRemoved', 'examples', 'Basic.js'),
+          { encoding: 'utf-8' }
+        );
+
+        expect(event.examples).toHaveLength(2);
+
+        expect(example1.name).toEqual('Basic.cs');
+        expect(example1.langugage).toEqual('csharp');
+        expect(example1.snippet).toEqual(example1File);
+
+        expect(example2.name).toEqual('Basic.js');
+        expect(example2.langugage).toEqual('javascript');
+        expect(example2.snippet).toEqual(example2File);
+      });
     });
   });
 
   describe('getAllEvents', () => {
-    it('gets all the events (in the PROJECT_DIR events dir)', async () => {
+    it('gets all the events in the /events directory and also all events within domain directorys', async () => {
       const events = await getAllEvents();
 
       expect(events).toEqual([
@@ -107,41 +183,67 @@ 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',
-          producers: ['Shopping API', 'Application API'],
-          consumers: ['Customer Portal'],
-          historicVersions: [],
-          externalLinks: [],
+          domain: null,
+          producerNames: ['Shopping API', 'Application API'],
+          consumerNames: ['Customer Portal'],
           owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
+          historicVersions: [],
         },
         {
           name: 'EmailSent',
           version: '0.0.1',
           summary: 'Tells us when an email has been sent\n',
-          producers: ['Email Platform'],
-          historicVersions: [],
-          externalLinks: [],
-          consumers: [],
+          domain: null,
+          producerNames: ['Email Platform'],
+          consumerNames: [],
           owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
+          historicVersions: [],
         },
         {
           name: 'EventWithSchemaAndExamples',
           version: '0.0.1',
           summary: 'Example event with schema and examples\n',
-          historicVersions: [],
-          externalLinks: [],
-          producers: [],
-          consumers: [],
+          domain: null,
+          producerNames: [],
+          consumerNames: [],
           owners: [],
+          externalLinks: [],
+          historicVersions: [],
         },
         {
           name: 'EventWithVersions',
           version: '0.0.5',
           summary: 'Tells us when an email has been sent\n',
+          domain: null,
+          producerNames: [],
+          consumerNames: [],
+          owners: [],
+          externalLinks: [],
           historicVersions: ['0.0.1'],
-          producers: [],
+        },
+        {
+          name: 'UserCreated',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been created.\n',
+          domain: 'User',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
           externalLinks: [],
-          consumers: [],
-          owners: [],
+          historicVersions: [],
+        },
+        {
+          name: 'UserRemoved',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been removed.\n',
+          domain: 'User',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
+          historicVersions: [],
         },
       ]);
     });
@@ -164,18 +266,18 @@ describe('events lib', () => {
         {
           name: 'Testing',
           version: '1.0.0',
-          consumers: ['Service 1', 'Service 2'],
+          consumerNames: ['Service 1', 'Service 2'],
           historicVersions: [],
-          producers: ['Service 3'],
+          producerNames: ['Service 3'],
         },
         {
           name: 'Testing',
           version: '2.0.0',
-          consumers: ['Service 2', 'Service 3'],
+          consumerNames: ['Service 2', 'Service 3'],
           historicVersions: [],
-          producers: ['Service 4'],
+          producerNames: ['Service 4'],
         },
-        { name: 'Testing', version: '3.0.0', consumers: ['Service 3', 'Service 4'] },
+        { name: 'Testing', version: '3.0.0', consumerNames: ['Service 3', 'Service 4'] },
       ];
 
       const result = getUniqueServicesNamesFromEvents(events);
@@ -198,21 +300,45 @@ 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',
-          producers: ['Shopping API', 'Application API'],
-          consumers: ['Customer Portal'],
+          domain: null,
+          producerNames: ['Shopping API', 'Application API'],
+          consumerNames: ['Customer Portal'],
           owners: ['dboyne', 'mSmith'],
-          historicVersions: [],
           externalLinks: [],
+          historicVersions: [],
         },
         {
           name: 'EmailSent',
           version: '0.0.1',
           summary: 'Tells us when an email has been sent\n',
-          producers: ['Email Platform'],
-          consumers: [],
+          domain: null,
+          producerNames: ['Email Platform'],
+          consumerNames: [],
+          owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
           historicVersions: [],
+        },
+        {
+          name: 'UserCreated',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been created.\n',
+          domain: 'User',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
+          owners: ['dboyne', 'mSmith'],
           externalLinks: [],
+          historicVersions: [],
+        },
+        {
+          name: 'UserRemoved',
+          version: '0.0.1',
+          summary: 'Holds information about when the user has been removed.\n',
+          domain: 'User',
+          producerNames: ['Application API'],
+          consumerNames: ['Customer Portal'],
           owners: ['dboyne', 'mSmith'],
+          externalLinks: [],
+          historicVersions: [],
         },
       ]);
     });
@@ -225,8 +351,8 @@ 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',
-          producers: ['Shopping API', 'My Service'],
-          consumers: ['Customer Portal'],
+          producerNames: ['Shopping API', 'My Service'],
+          consumerNames: ['Customer Portal'],
           historicVersions: [],
           owners: ['dboyne', 'mSmith'],
         },
@@ -246,8 +372,8 @@ 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',
-            producers: ['Shopping API', 'My Service'],
-            consumers: ['Customer Portal'],
+            producerNames: ['Shopping API', 'My Service'],
+            consumerNames: ['Customer Portal'],
             historicVersions: [],
             owners: ['dboyne', 'mSmith'],
           },
@@ -262,8 +388,8 @@ 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',
-          producers: ['Shopping API', 'Service'],
-          consumers: ['Customer Portal'],
+          producerNames: ['Shopping API', 'Service'],
+          consumerNames: ['Customer Portal'],
           historicVersions: [],
           owners: ['dboyne', 'mSmith'],
         },