@eventcatalog/create-eventcatalog 0.0.0

package/README.md

@@ -0,0 +1,3 @@
+# create-eventcatalog
+
+NPM package that is used to allow users to quickly create EventCatalogs.

package/dist/default/Dockerfile

@@ -0,0 +1,36 @@
+
+   
+# Install dependencies only when needed
+FROM node:16-alpine AS deps
+# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
+RUN apk add --no-cache libc6-compat
+WORKDIR /app
+COPY package.json yarn.lock ./
+RUN yarn install --frozen-lockfile
+
+# Rebuild the source code only when needed
+FROM node:16-alpine AS builder
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+RUN yarn build
+
+# Production image, copy all the files and run next
+FROM node:16-alpine AS runner
+WORKDIR /app
+
+ENV NODE_ENV production
+
+RUN addgroup -g 1001 -S nodejs
+RUN adduser -S nextjs -u 1001
+RUN /bin/sh -c "apk add --no-cache bash"
+
+COPY --from=builder --chown=nextjs:nodejs /app ./
+
+USER nextjs
+
+EXPOSE 3000
+
+ENV PORT 3000
+
+CMD ["npm", "start"]

package/dist/default/README-template.md

@@ -0,0 +1 @@
+# My Event Catalog

package/dist/default/dockerignore

@@ -0,0 +1,7 @@
+Dockerfile
+.dockerignore
+node_modules
+npm-debug.log
+README.md
+.next
+.eventcatalog-core

package/dist/default/eventcatalog.config.js

@@ -0,0 +1,26 @@
+module.exports = {
+  title: 'EventCatalog',
+  tagline: 'Discover, Explore and Document your Event Driven Architectures',
+  organizationName: 'Your Company',
+  projectName: 'Event Catalog',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
+  logo: {
+    alt: 'EventCatalog Logo',
+    // found in the public dir
+    src: 'logo.svg',
+  },
+  users: [
+    {
+      id: 'dboyne',
+      name: 'David Boyne',
+      avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+      role: 'Developer',
+    },
+    {
+      id: 'mSmith',
+      name: 'Matthew Smith',
+      avatarUrl: 'https://randomuser.me/api/portraits/lego/3.jpg',
+      role: 'Developer',
+    },
+  ],
+}

package/dist/default/events/AddedItemToCart/index.md

@@ -0,0 +1,30 @@
+---
+name: AddedItemToCart
+version: 0.0.2
+summary: |
+  Holds information about what the user added to their shopping cart.
+producers:
+    - Basket Service
+consumers:
+    - Data Lake
+domains:
+    - Shop
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.
+
+We have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.
+
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/AddedItemToCart/schema.json

@@ -0,0 +1,46 @@
+{
+  "$id": "https://example.com/AddedItemToCart.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "AddedItemToCart",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "itemId": {
+          "type": "string",
+          "description": "The ID of the shopping item"
+        },
+        "quantity": {
+          "type": "number",
+          "description": "How many items the user wants to add to their shopping cart",
+          "minimum": 1,
+          "maximum": 100,
+          "default": 1
+        }
+      }
+    }
+  }
+}

package/dist/default/events/AddedItemToCart/versioned/0.0.1/index.md

@@ -0,0 +1,30 @@
+---
+name: AddedItemToCart
+version: 0.0.1
+summary: |
+  Holds information about what the user added to their shopping cart.
+producers:
+    - Basket Service
+consumers:
+    - Data Lake
+domains:
+    - Shop
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.
+
+We have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.
+
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/AddedItemToCart/versioned/0.0.1/schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "https://example.com/AddedItemToCart.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "AddedItemToCart",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "itemId": {
+          "type": "string",
+          "description": "The ID of the shopping item"
+        }
+      }
+    }
+  }
+}

package/dist/default/events/OrderComplete/index.md

@@ -0,0 +1,25 @@
+---
+name: OrderComplete
+version: 0.0.1
+summary: |
+  Event represents when an order has been complete. (Delivered and finished)
+producers:
+    - Orders Service
+consumers:
+    - Data Lake
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event is the final event of the ordering process. It gets raised when the shipment has been delivered.
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/OrderComplete/schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "https://example.com/OrderRequested.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "OrderRequested",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain", "service"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "orderId": {
+          "type": "string",
+          "description": "The ID the users order"
+        }
+      }
+    }
+  }
+}

package/dist/default/events/OrderConfirmed/index.md

@@ -0,0 +1,25 @@
+---
+name: OrderConfirmed
+version: 0.0.1
+summary: |
+  Event represents when an order has been confirmed and ready to be processed (shipped for example)
+producers:
+    - Orders Service
+consumers:
+    - Shipping Service
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+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.
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/OrderConfirmed/schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "https://example.com/OrderRequested.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "OrderRequested",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain", "service"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "orderId": {
+          "type": "string",
+          "description": "The ID the users order"
+        }
+      }
+    }
+  }
+}

package/dist/default/events/OrderRequested/index.md

@@ -0,0 +1,27 @@
+---
+name: OrderRequested
+version: 0.0.1
+summary: |
+  Holds information about the customers order.
+producers:
+    - Basket Service
+consumers:
+    - Payment Service
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event is triggered when the user confirms their order and wants to process their payment.
+
+We have a frontend application that allows users to buy things from our store. The frontend application interacts with the Backet Service to trigger the `OrderRequested` event.
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/OrderRequested/schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "https://example.com/OrderRequested.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "OrderRequested",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain", "service"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "orderId": {
+          "type": "string",
+          "description": "The ID the users order"
+        }
+      }
+    }
+  }
+}

package/dist/default/events/PaymentProcessed/index.md

@@ -0,0 +1,27 @@
+---
+name: PaymentProcessed
+version: 0.0.1
+summary: |
+  Holds information about the payment that has been processed.
+producers:
+    - Payment Service
+consumers:
+    - Orders Service
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event is triggered when the payment has succesfully been processed for a customers orders.
+
+We use Stripe to handle customer payments. The Payment Service listens for Stripe webhooks and raises the PaymentProcessed event.
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/PaymentProcessed/schema.json

@@ -0,0 +1,43 @@
+{
+  "$id": "https://example.com/PaymentProcessed.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "PaymentProcessed",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain", "service"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "orderId": {
+          "type": "string",
+          "description": "The ID the users order"
+        },
+        "stripeId": {
+          "type": "string",
+          "description": "The ID the payment handled in stripe"
+        }
+      }
+    }
+  }
+}

package/dist/default/events/RemovedItemFromCart/index.md

@@ -0,0 +1,30 @@
+---
+name: RemovedItemFromCart
+version: 0.0.1
+summary: |
+  Holds information about what the user removed from their cart.
+producers:
+    - Basket Service
+consumers:
+    - Data Lake
+domains:
+    - Shop
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.
+
+We have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.
+
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/RemovedItemFromCart/schema.json

@@ -0,0 +1,46 @@
+{
+  "$id": "https://example.com/RemovedItemFromCart.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RemovedItemFromCart",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "itemId": {
+          "type": "string",
+          "description": "The ID of the shopping item"
+        },
+        "quantity": {
+          "type": "number",
+          "description": "How many items the user wants to remove to their shopping cart",
+          "minimum": 1,
+          "maximum": 100,
+          "default": 1
+        }
+      }
+    }
+  }
+}

package/dist/default/events/ShipmentDelivered/index.md

@@ -0,0 +1,26 @@
+---
+name: ShipmentDelivered
+version: 0.0.1
+summary: |
+  Event represents when a shipment has been delievered and received.
+producers:
+    - Shipping Service
+consumers:
+    - Order Service
+    - Data Lake
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event is triggered when a shipment has been delievered to it's destination.
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />

package/dist/default/events/ShipmentDelivered/schema.json

@@ -0,0 +1,43 @@
+{
+  "$id": "https://example.com/ShipmentDispatched.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "ShipmentDispatched",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "correlationId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the event"
+        },
+        "service": {
+          "type": "string",
+          "description": "The name of the service that triggered the event"
+        }
+      },
+      "required": ["correlationId", "domain", "service"]
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user"
+        },
+        "shipmentId": {
+          "type": "string",
+          "description": "The ID of the shipment"
+        },
+        "orderId": {
+          "type": "string",
+          "description": "The order assigned to the shipment"
+        }
+      }
+    }
+  }
+}

package/dist/default/events/ShipmentDispatched/index.md

@@ -0,0 +1,25 @@
+---
+name: ShipmentDispatched
+version: 0.0.1
+summary: |
+  Event represents when a shipment has been dispatched.
+producers:
+    - Shipping Service
+consumers:
+    - Shipping Service
+owners:
+    - dboyne
+    - mSmith
+---
+
+<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>
+
+### Details
+
+This event is triggered when a shipment has been dispatched from the warehouse.
+
+### Consumer / Producer Diagram
+
+<Mermaid />
+
+<Schema />