@eventcatalog/core 1.2.7 → 2.0.0

package/lib/__tests__/services.spec.ts

@@ -1,268 +0,0 @@
-import path from 'path';
-import { getAllServices, getAllServicesByOwnerId, getServiceByName } from '../services';
-
-let PROJECT_DIR: any;
-
-describe('services', () => {
-  beforeAll(() => {
-    PROJECT_DIR = process.env.PROJECT_DIR;
-    process.env.PROJECT_DIR = path.join(__dirname, 'assets');
-  });
-
-  afterAll(() => {
-    process.env.PROJECT_DIR = PROJECT_DIR;
-  });
-
-  describe('getAllServices', () => {
-    it('gets all the services (in the PROJECT_DIR services dir)', async () => {
-      const services = await getAllServices();
-
-      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',
-            },
-          ],
-          publishes: [],
-          subscribes: [],
-          badges: [
-            {
-              content: 'Extra!',
-              backgroundColor: 'green',
-              textColor: 'green',
-            },
-            {
-              content: 'Long form',
-              backgroundColor: 'yellow',
-              textColor: 'red',
-            },
-          ],
-        },
-        {
-          name: 'Email Platform',
-          summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
-          domain: null,
-          owners: ['dboyne'],
-          repository: {
-            url: 'https://github.com/boyney123/EmailPlatform',
-            language: 'JavaScript',
-          },
-          tags: [
-            {
-              label: 'defaultContentType:application/json',
-            },
-            {
-              label: 'Apache 2.0',
-              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: [],
-              tags: [],
-              historicVersions: [],
-              badges: [],
-            },
-          ],
-          subscribes: [],
-          badges: [],
-        },
-        {
-          name: 'Payment Service',
-          summary: 'Event based application that integrates with Stripe.\n',
-          domain: null,
-          owners: [],
-          repository: {},
-          tags: [],
-          externalLinks: [],
-          publishes: [],
-          subscribes: [],
-          badges: [],
-        },
-        {
-          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: [],
-          badges: [
-            {
-              content: 'New!',
-              backgroundColor: 'blue',
-              textColor: 'blue',
-            },
-          ],
-        },
-      ]);
-    });
-  });
-
-  describe('getAllServicesByOwnerId', () => {
-    it('returns empty array when no owner is found', async () => {
-      const services = await getAllServicesByOwnerId('made-up-user');
-      expect(services).toEqual([]);
-    });
-
-    it('returns all the services for a given owner id', async () => {
-      const services = await getAllServicesByOwnerId('dboyne');
-
-      expect(services).toEqual([
-        {
-          name: 'Email Platform',
-          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',
-            language: 'JavaScript',
-          },
-          domain: null,
-          tags: [
-            {
-              label: 'defaultContentType:application/json',
-            },
-            {
-              label: 'Apache 2.0',
-              url: 'https://www.apache.org/licenses/LICENSE-2.0',
-            },
-          ],
-          publishes: [
-            {
-              name: 'EmailSent',
-              version: '0.0.1',
-              summary: 'Tells us when an email has been sent\n',
-              producerNames: ['Email Platform'],
-              consumerNames: [],
-              historicVersions: [],
-              badges: [],
-              domain: null,
-              externalLinks: [],
-              tags: [],
-              owners: ['dboyne', 'mSmith'],
-            },
-          ],
-          subscribes: [],
-          externalLinks: [],
-          badges: [],
-        },
-      ]);
-    });
-  });
-
-  describe('getServiceByName', () => {
-    it('returns an event and markdown by the given event name', async () => {
-      const { service, markdown } = await getServiceByName({ serviceName: 'Email Platform' });
-
-      expect(service).toEqual({
-        name: 'Email Platform',
-        summary: 'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
-        owners: ['dboyne'],
-        domain: null,
-        openAPISpec: null,
-        asyncAPISpec: null,
-        repository: {
-          url: 'https://github.com/boyney123/EmailPlatform',
-          language: 'JavaScript',
-        },
-        tags: [
-          {
-            label: 'defaultContentType:application/json',
-          },
-          {
-            label: 'Apache 2.0',
-            url: 'https://www.apache.org/licenses/LICENSE-2.0',
-          },
-        ],
-        publishes: [
-          {
-            name: 'EmailSent',
-            version: '0.0.1',
-            summary: 'Tells us when an email has been sent\n',
-            producerNames: ['Email Platform'],
-            consumerNames: [],
-            historicVersions: [],
-            badges: [],
-            domain: null,
-            externalLinks: [],
-            owners: ['dboyne', 'mSmith'],
-            tags: [],
-          },
-        ],
-        subscribes: [],
-        externalLinks: [],
-        badges: [],
-      });
-
-      // @ts-ignore
-      expect(markdown.content).toMatchMarkdown('# Testing');
-    });
-
-    describe('services within domains', () => {
-      it('returns an event and markdown by the given event name', async () => {
-        const { service, markdown } = await getServiceByName({ serviceName: 'User Service', domain: 'User' });
-
-        expect(service).toEqual({
-          name: 'User Service',
-          summary: 'CRUD based API to handle User information\n',
-          domain: 'User',
-          owners: ['mSmith'],
-          openAPISpec: null,
-          asyncAPISpec: null,
-          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: [],
-          badges: [
-            {
-              content: 'New!',
-              backgroundColor: 'blue',
-              textColor: 'blue',
-            },
-          ],
-        });
-
-        // @ts-ignore
-        expect(markdown.content).toMatchMarkdown('# Testing');
-      });
-    });
-  });
-});

package/lib/analytics.ts

@@ -1,30 +0,0 @@
-import { AnalyticsConfig } from '@eventcatalog/types';
-
-// eslint-disable-next-line import/no-unresolved
-import config from 'eventcatalog.config';
-
-const { analytics } = config;
-const { googleAnalyticsTrackingId } = analytics || ({} as AnalyticsConfig);
-
-declare const window: any;
-
-/**
- * Register page view event
- * @param url
- */
-export const pageview = (url) => {
-  if (window?.gtag && googleAnalyticsTrackingId) {
-    window.gtag('config', googleAnalyticsTrackingId, {
-      page_path: url,
-    });
-  }
-};
-
-/**
- * Register event
- * @param action
- * @param category
- */
-export const event = ({ action, params }) => {
-  window.gtag('event', action, params);
-};

package/lib/domains.ts

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