@eventcatalog/core 1.2.6 → 2.0.0

package/eventcatalog.config.js

@@ -1,58 +0,0 @@
-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',
-  trailingSlash: true,
-  logo: {
-    alt: 'EventCatalog Logo',
-    src: 'logo.svg'
-  },
-  primaryCTA: {
-    label: 'Explore Events',
-    href: '/events'
-  },
-  secondaryCTA: {
-    label: 'Getting Started',
-    href:"https://www.eventcatalog.dev/"
-  },
-  headerLinks: [
-    { label: 'Events', href: '/events'},
-    { label: 'Services', href: '/services' },
-    { label: 'Domains', href: '/domains'},
-    { label: 'Users', href: '/users'},
-    { label: 'Visualiser', href: '/visualiser' },
-    { label: '3D Node Graph', href: '/overview' },
-  ],
-  footerLinks: [
-    { label: 'Events', href: '/events' },
-    { label: 'Services', href: '/services' },
-    { label: 'Visualiser', href: '/visualiser' },
-    { 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/eventcatalog.styles.css

@@ -1,15 +0,0 @@
-
-/**
-
-Stylesheet overrides for EventCatalog. 
-There is currently a limit on what can be changed. 
-
-If you want to override some styles of particular elements, raise an issue for discussion. (https://github.com/boyney123/eventcatalog)
-
-Note: Override based on custom selectors / hacks at your own risk. EventCatalog selectors will change over time, which may break your styles.
-      use the styles marked with `ec-` for non breaking styling changes.
-
-*/
-.ec-homepage{
-    background:black;
-}

package/hooks/EventCatalog.tsx

@@ -1,54 +0,0 @@
-import React, { useContext, ReactNode } from 'react';
-import type { EventCatalogConfig, User } from '@eventcatalog/types';
-import path from 'path';
-import defaultConfig from '../eventcatalog.config';
-
-export const Context = React.createContext<EventCatalogConfig | null>(defaultConfig);
-
-export function EventCatalogContextProvider({ children }: { children: ReactNode }): JSX.Element {
-  return <Context.Provider value={defaultConfig}>{children}</Context.Provider>;
-}
-
-export const useConfig = () => useContext<EventCatalogConfig>(Context);
-
-export const useUser = () => {
-  const config = useConfig();
-
-  const getUserById = (id): User => {
-    const users = config.users || [];
-    return users.find((user) => user.id === id);
-  };
-
-  return {
-    getUserById,
-  };
-};
-
-export const useUrl = () => {
-  const config = useConfig();
-  const getEditUrl = (url: string) => {
-    const editBaseUrl = new URL(config.editUrl);
-
-    editBaseUrl.pathname = path.join(editBaseUrl.pathname, url);
-
-    return editBaseUrl.toString();
-  };
-
-  return {
-    getEditUrl,
-    hasEditUrl: !!config.editUrl,
-  };
-};
-
-export const useUsers = () => {
-  const config = useConfig();
-
-  const getUsersArray = (): User[] => {
-    const users = config.users || [];
-    return users;
-  };
-
-  return {
-    getUsersArray,
-  };
-};

package/lib/__tests__/assets/domains/User/events/UserCreated/index.md

@@ -1,20 +0,0 @@
----
-name: UserCreated
-version: 0.0.1
-summary: |
-  Holds information about when the user has been created.
-producers:
-    - Application API
-consumers:
-    - Customer Portal
-owners:
-    - dboyne
-    - mSmith
-draft: true
-badges:
-    - content: New!
-      backgroundColor: blue
-      textColor: blue    
----
-
-# Testing

package/lib/__tests__/assets/domains/User/events/UserRemoved/examples/Basic.cs

@@ -1,31 +0,0 @@
-public static async Task ConnectAsync()
-{
-  string clientId = Guid.NewGuid().ToString();
-  string mqttURI = {REPLACE THIS WITH YOUR MQTT SERVER URI HERE}
-  string mqttUser = { REPLACE THIS WITH YOUR MQTT USER HERE }
-  string mqttPassword = { REPLACE THIS WITH YOUR MQTT PASSWORD HERE }
-  int mqttPort = { REPLACE THIS WITH YOUR MQTT PORT HERE }
-  bool mqttSecure = {IF YOU ARE USING SSL Port THEN SET true OTHERWISE SET false}
-
-  var messageBuilder = new MqttClientOptionsBuilder()
-    .WithClientId(clientId)
-    .WithCredentials(mqttUser, mqttPassword)
-    .WithTcpServer(mqttURI, mqttPort)
-    .WithCleanSession();
-
-  var options = mqttSecure
-    ? messageBuilder
-      .WithTls()
-      .Build()
-    : messageBuilder
-      .Build();
-
-  var managedOptions = new ManagedMqttClientOptionsBuilder()
-    .WithAutoReconnectDelay(TimeSpan.FromSeconds(5))
-    .WithClientOptions(options)
-    .Build();
-
-  client = new MqttFactory().CreateManagedMqttClient();
-
-  await client.StartAsync(managedOptions);
-}

package/lib/__tests__/assets/domains/User/events/UserRemoved/examples/Basic.js

@@ -1 +0,0 @@
-export default true;

package/lib/__tests__/assets/domains/User/events/UserRemoved/index.md

@@ -1,16 +0,0 @@
----
-name: UserRemoved
-version: 0.0.1
-summary: |
-  Holds information about when the user has been removed.
-producers:
-    - Application API
-consumers:
-    - Customer Portal
-owners:
-    - dboyne
-    - mSmith
-draft: true    
----
-
-# Testing

package/lib/__tests__/assets/domains/User/events/UserRemoved/schema.json

@@ -1,4 +0,0 @@
-{
-  "some-schema": true,
-  "does-not-really-matter-what-content-is-in-this-file": true
-}

package/lib/__tests__/assets/domains/User/index.md

@@ -1,16 +0,0 @@
----
-name: User
-version: 0.0.1
-summary: |
-  User Domain
-owners:
-    - dboyne
-    - mSmith
-draft: true    
-badges:
-    - content: New!
-      backgroundColor: blue
-      textColor: blue
----
-
-# Testing

package/lib/__tests__/assets/domains/User/services/User Service/index.md

@@ -1,19 +0,0 @@
----
-name: User Service
-summary: |
-  CRUD based API to handle User information
-owners:
-  - mSmith
-repository:
-  language: JavaScript
-  url: https://github.com/boyney123/pretend-basket-service
-externalLinks:
-    - label: AsyncAPI Specification
-      url: https://studio.asyncapi.com/#schema-lightMeasuredPayload
-badges:
-  - content: New!
-    backgroundColor: blue
-    textColor: blue
----
-
-# Testing

package/lib/__tests__/assets/events/AddedItemToCart/index.md

@@ -1,25 +0,0 @@
----
-name: AddedItemToCart
-version: 0.0.1
-summary: |
-  Holds information about the cusomer and product when they add an item to the cart.
-producers:
-    - Shopping API
-    - Application API
-consumers:
-    - Customer Portal
-owners:
-    - dboyne
-    - mSmith
-draft: true
-badges:
-    - content: Deprecated
-      backgroundColor: red
-      textColor: red
-tags:
-  - label: 'Topic: add-item-to-cart'
-  - label: 'Broker: kafka'
-    url: https://kafka.apache.org
----
-
-# Testing

package/lib/__tests__/assets/events/EmailSent/index.md

@@ -1,15 +0,0 @@
----
-name: EmailSent
-version: 0.0.1
-summary: |
-  Tells us when an email has been sent
-producers:
-    - Email Platform
-owners:
-    - dboyne
-    - mSmith
----
-
-Duis mollis quam enim, feugiat porta mi porta non. In lacus nulla, gravida nec sagittis vel, sagittis id tellus. Vestibulum maximus velit eget massa pulvinar ornare. In vel libero nulla. Aliquam a leo risus. Donec bibendum velit non nulla sollicitudin lacinia. Vestibulum imperdiet nunc eget neque sagittis, eget volutpat purus ornare. Mauris malesuada finibus pretium. Vestibulum suscipit tortor sit amet dolor tempor cursus. Nunc ac felis accumsan.
-
-<Mermaid />

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/examples/Basic.cs

@@ -1,31 +0,0 @@
-public static async Task ConnectAsync()
-{
-  string clientId = Guid.NewGuid().ToString();
-  string mqttURI = {REPLACE THIS WITH YOUR MQTT SERVER URI HERE}
-  string mqttUser = { REPLACE THIS WITH YOUR MQTT USER HERE }
-  string mqttPassword = { REPLACE THIS WITH YOUR MQTT PASSWORD HERE }
-  int mqttPort = { REPLACE THIS WITH YOUR MQTT PORT HERE }
-  bool mqttSecure = {IF YOU ARE USING SSL Port THEN SET true OTHERWISE SET false}
-
-  var messageBuilder = new MqttClientOptionsBuilder()
-    .WithClientId(clientId)
-    .WithCredentials(mqttUser, mqttPassword)
-    .WithTcpServer(mqttURI, mqttPort)
-    .WithCleanSession();
-
-  var options = mqttSecure
-    ? messageBuilder
-      .WithTls()
-      .Build()
-    : messageBuilder
-      .Build();
-
-  var managedOptions = new ManagedMqttClientOptionsBuilder()
-    .WithAutoReconnectDelay(TimeSpan.FromSeconds(5))
-    .WithClientOptions(options)
-    .Build();
-
-  client = new MqttFactory().CreateManagedMqttClient();
-
-  await client.StartAsync(managedOptions);
-}

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/examples/Basic.js

@@ -1 +0,0 @@
-export default true;

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/index.md

@@ -1,8 +0,0 @@
----
-name: EventWithSchemaAndExamples
-version: 0.0.1
-summary: |
-  Example event with schema and examples
----
-
-# Testing

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/schema.json

@@ -1,4 +0,0 @@
-{
-  "some-schema": true,
-  "does-not-really-matter-what-content-is-in-this-file": true
-}

package/lib/__tests__/assets/events/EventWithVersions/index.md

@@ -1,10 +0,0 @@
----
-name: EventWithVersions
-version: 0.0.5
-summary: |
-  Tells us when an email has been sent
----
-
-Duis mollis quam enim, feugiat porta mi porta non. In lacus nulla, gravida nec sagittis vel, sagittis id tellus. Vestibulum maximus velit eget massa pulvinar ornare. In vel libero nulla. Aliquam a leo risus. Donec bibendum velit non nulla sollicitudin lacinia. Vestibulum imperdiet nunc eget neque sagittis, eget volutpat purus ornare. Mauris malesuada finibus pretium. Vestibulum suscipit tortor sit amet dolor tempor cursus. Nunc ac felis accumsan.
-
-<Mermaid />

package/lib/__tests__/assets/events/EventWithVersions/versioned/0.0.1/index.md

@@ -1,10 +0,0 @@
----
-name: EventWithVersions
-version: 0.0.1
-summary: |
-  Tells us when an email has been sent
-producers:
-    - Email Platform
----
-
-# Old Version

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

@@ -1,26 +0,0 @@
----
-name: Basket Service
-summary: |
-  CRUD based API to handle Basket interactions for users of the shopping website.
-owners:
-  - mSmith
-repository:
-  language: JavaScript
-  url: https://github.com/boyney123/pretend-basket-service
-externalLinks:
-    - label: AsyncAPI Specification
-      url: https://studio.asyncapi.com/#schema-lightMeasuredPayload
-badges:
-  - content: Extra!
-    backgroundColor: green
-    textColor: green
-  - content: Long form
-    backgroundColor: yellow
-    textColor: red
----
-
-Simple API that handles interactions between users and their baskets. Use this service to add, remove and query the status of a users basket.
-
-This service will also generate Async events for downstream services.
-
-<Mermaid />

package/lib/__tests__/assets/services/Email Platform/index.md

@@ -1,17 +0,0 @@
----
-id: Email Platform
-name: Email Platform
-summary: |
-  Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS
-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  
----
-
-# Testing

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

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