@eventcatalog/create-eventcatalog 1.2.1 → 2.0.0

package/package.json

@@ -1,76 +1,52 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
-  "version": "1.2.1",
-  "keywords": [],
-  "description": "Create event catalogs apps with one command",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/boyney123/eventcatalog"
-  },
-  "author": "David Boyne",
-  "license": "MIT",
+  "description": "Create EventCatalog with one command",
+  "version": "2.0.0",
   "bin": {
-    "create-eventcatalog2": "./dist/index.js"
+    "create-catalog": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "dev": "ncc build ./index.ts -w -o dist/",
-    "test": "echo \"No test specified\"",
-    "lint": "eslint --max-warnings 13 --config .eslintrc .",
-    "prepare": "rimraf ./dist/ && ncc build ./index.ts -o ./dist/ --minify --no-cache --no-source-map-register",
-    "build": "npm run prepare",
-    "release": "semantic-release",
-    "get:version": "echo $npm_package_version",
-    "get:name": "echo $npm_package_name",
-    "generate:assets": "echo \"No assets to generate so far\"",
-    "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION"
+    "prepublishOnly": "npm run build",
+    "build": "tsup index.ts --format cjs --dts",
+    "run": "node dist/index.js",
+    "dev": "npm run build --watch",
+    "changeset": "changeset",
+    "release": "changeset publish"
   },
   "devDependencies": {
-    "@semantic-release/commit-analyzer": "^8.0.1",
-    "@semantic-release/github": "^7.0.4",
-    "@semantic-release/npm": "^7.0.6",
-    "@semantic-release/release-notes-generator": "^9.0.1",
-    "@types/async-retry": "1.3.0",
-    "@types/cross-spawn": "^6.0.2",
+    "@types/async-retry": "1.4.2",
+    "@types/ci-info": "2.0.0",
+    "@types/cross-spawn": "6.0.0",
     "@types/node": "^12.6.8",
     "@types/prompts": "2.0.1",
     "@types/rimraf": "3.0.0",
     "@types/tar": "4.0.3",
     "@types/validate-npm-package-name": "3.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
-    "@vercel/ncc": "0.25.1",
-    "all-contributors-cli": "^6.14.2",
+    "@vercel/ncc": "0.34.0",
     "async-retry": "1.3.1",
     "chalk": "2.4.2",
+    "ci-info": "watson/ci-info#f43f6a1cefff47fb361c88cf4b943fdbcaafe540",
     "commander": "2.20.0",
-    "conventional-changelog-conventionalcommits": "^4.4.0",
-    "cpy": "7.3.0",
+    "cpy": "^11.0.0",
     "cross-spawn": "6.0.5",
-    "eslint": "^8.46.0",
-    "eslint-plugin-github": "^4.1.3",
-    "eslint-plugin-security": "^1.4.0",
-    "eslint-plugin-sonarjs": "^0.5.0",
-    "got": "10.7.0",
-    "jest": "^29.6.2",
-    "jsdoc-to-markdown": "^5.0.0",
-    "markdown-toc": "^1.2.0",
+    "fast-glob": "^3.3.2",
+    "got": "^14.0.0",
     "prompts": "2.1.0",
-    "rimraf": "3.0.0",
-    "semantic-release": "^17.2.2",
-    "tar": "4.4.10",
-    "typescript": "5.1.6",
-    "unixify": "^1.0.0",
+    "rimraf": "^5.0.7",
+    "tar": "^4.4.19",
+    "tsup": "^8.1.0",
+    "typescript": "^5.4.5",
     "update-check": "1.5.4",
     "validate-npm-package-name": "3.0.0"
   },
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "gitHead": "5f82ce7f267e9b3ec771bbd3cc81359ed0a8fd18"
+  "dependencies": {
+    "@changesets/cli": "^2.27.6"
+  }
 }

package/templates/default/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:lts AS build
+WORKDIR /app
+COPY . .
+# Fix for astro in docker https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+RUN npm i
+RUN npm run build
+
+FROM httpd:2.4 AS runtime
+COPY --from=build /app/dist /usr/local/apache2/htdocs/
+EXPOSE 80

package/templates/default/README-template.md

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

package/templates/default/commands/AddInventory/index.md

@@ -0,0 +1,42 @@
+---
+id: AddInventory
+name: Add inventory
+version: 0.0.3
+summary: |
+  Command that will add item to a given inventory id
+owners:
+    - dboyne
+    - msmith
+    - asmith
+    - full-stack
+    - mobile-devs
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: 'schema.json'
+---
+
+## Overview
+
+The AddInventory command is issued to add new stock to the inventory. This command is used by the inventory management system to update the quantity of products available in the warehouse or store.
+
+## Architecture diagram
+
+<NodeGraph/>
+
+## Payload example
+
+```json title="Payload example"
+{
+  "productId": "789e1234-b56c-78d9-e012-3456789fghij",
+  "quantity": 50,
+  "warehouseId": "456e7891-c23d-45f6-b78a-123456789abc",
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+
+```
+
+## Schema
+
+<Schema file="schema.json"/>

package/templates/default/commands/AddInventory/schema.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "AddInventoryCommand",
+    "type": "object",
+    "properties": {
+      "productId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the product being added to the inventory."
+      },
+      "quantity": {
+        "type": "integer",
+        "description": "The quantity of the product being added to the inventory."
+      },
+      "warehouseId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the warehouse where the inventory is being added."
+      },
+      "timestamp": {
+        "type": "string",
+        "format": "date-time",
+        "description": "The date and time when the inventory was added."
+      }
+    },
+    "required": ["productId", "quantity", "warehouseId", "timestamp"],
+    "additionalProperties": false
+  }
+  

package/templates/default/commands/UpdateInventory/index.md

@@ -0,0 +1,42 @@
+---
+id: UpdateInventory
+name: Update inventory
+version: 0.0.3
+summary: |
+  Command that will update a given inventory item
+owners:
+    - dboyne
+    - msmith
+    - asmith
+    - full-stack
+    - mobile-devs
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: "schema.json"
+---
+
+## Overview
+
+The UpdateInventory command is issued to update the existing stock levels of a product in the inventory. This command is used by the inventory management system to adjust the quantity of products available in the warehouse or store, either by increasing or decreasing the current stock levels.
+
+## Architecture diagram
+
+<NodeGraph />
+
+## Payload example
+
+```json title="Payload example"
+{
+  "productId": "789e1234-b56c-78d9-e012-3456789fghij",
+  "quantityChange": -10,
+  "warehouseId": "456e7891-c23d-45f6-b78a-123456789abc",
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+```
+
+## Schema (JSON schema)
+
+<Schema file="schema.json"/>
+

package/templates/default/commands/UpdateInventory/schema.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "UpdateInventoryCommand",
+    "type": "object",
+    "properties": {
+      "productId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the product whose inventory is being updated."
+      },
+      "quantityChange": {
+        "type": "integer",
+        "description": "The change in quantity of the product in the inventory. Positive values indicate an increase, while negative values indicate a decrease."
+      },
+      "warehouseId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the warehouse where the inventory is being updated."
+      },
+      "timestamp": {
+        "type": "string",
+        "format": "date-time",
+        "description": "The date and time when the inventory update occurred."
+      }
+    },
+    "required": ["productId", "quantityChange", "warehouseId", "timestamp"],
+    "additionalProperties": false
+  }
+  

package/templates/default/domains/Orders/index.md

@@ -0,0 +1,49 @@
+---
+id: Orders
+name: Orders
+version: 0.0.2
+owners:
+  - dboyne
+services:
+  - id: InventoryService
+    version: 0.0.2
+  - id: NotificationService
+    version: 0.0.2
+  - id: OrdersService
+    version: 0.0.2
+badges:
+  - content: New domain
+    backgroundColor: blue
+    textColor: blue
+---
+
+## Overview
+
+The Orders domain handles all operations related to customer orders, from creation to fulfillment. This documentation provides an overview of the events and services involved in the Orders domain, helping developers and stakeholders understand the event-driven architecture.
+
+<Admonition type="warning">Please ensure all services are updated to the latest version for compatibility and performance improvements.</Admonition>
+
+## Bounded context
+
+<NodeGraph />
+
+### Order example (sequence diagram)
+
+```mermaid
+sequenceDiagram
+    participant Customer
+    participant OrdersService
+    participant InventoryService
+    participant NotificationService
+
+    Customer->>OrdersService: Place Order
+    OrdersService->>InventoryService: Check Inventory
+    InventoryService-->>OrdersService: Inventory Available
+    OrdersService->>InventoryService: Reserve Inventory
+    OrdersService->>NotificationService: Send Order Confirmation
+    NotificationService-->>Customer: Order Confirmation
+    OrdersService->>Customer: Order Placed Successfully
+    OrdersService->>InventoryService: Update Inventory
+```
+
+ 

package/templates/default/domains/Orders/versioned/0.0.1/index.md

@@ -0,0 +1,20 @@
+---
+id: Orders
+name: Orders
+version: 0.0.1
+summary: |
+  Domain for everything shopping
+owners:
+    - dboyne
+services:
+    - id: InventoryService
+      version: 0.0.2
+badges:
+    - content: New domain
+      backgroundColor: blue
+      textColor: blue
+---
+
+## Overview
+
+<NodeGraph />

package/templates/default/domains/Payment/index.md

@@ -0,0 +1,24 @@
+---
+id: Payment
+name: Payment
+version: 0.0.2
+summary: |
+  Domain that contains payment related services and messages.
+owners:
+    - dboyne
+services:
+    - id: PaymentService
+      version: 0.0.1
+badges:
+    - content: Payment Domain
+      backgroundColor: blue
+      textColor: blue
+---
+
+## Overview
+
+The Payment Domain encompasses all services and components related to handling financial transactions within the system. It is responsible for managing payments, transactions, billing, and financial records. The domain ensures secure, reliable, and efficient processing of all payment-related activities
+
+## Bounded context
+
+<NodeGraph />

package/templates/default/eventcatalog.config.js

@@ -0,0 +1,18 @@
+export default {
+  title: 'EventCatalog',
+  trailingSlash: false,
+  tagline: 'Discover, Explore and Document your Event Driven Architectures',
+  organizationName: 'Your Company',
+  homepageLink: 'https://eventcatalog.dev/',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
+  logo: {
+    alt: 'EventCatalog Logo',
+    src: 'logo.svg'
+  },
+  docs: {
+    sidebar: {
+      // Should the sub heading be rendered in the docs sidebar?
+      showPageHeadings: true
+    }
+  }
+}

package/templates/default/eventcatalog.styles.css

@@ -0,0 +1 @@
+/* Custom styling support coming soon */

package/templates/default/events/Inventory/InventoryAdjusted/index.md

@@ -0,0 +1,103 @@
+---
+id: InventoryAdjusted
+name: Inventory adjusted
+version: 0.0.4
+summary: |
+  Indicates a change in inventory level
+owners:
+    - dboyne
+    - msmith
+    - asmith
+    - full-stack
+    - mobile-devs
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+    - content: Channel:Apache Kafka
+      backgroundColor: yellow
+      textColor: yellow
+schemaPath: 'schema.avro'
+---
+
+## Overview
+
+The `Inventory Adjusted` event is triggered whenever there is a change in the inventory levels of a product. This could occur due to various reasons such as receiving new stock, sales, returns, or manual adjustments by the inventory management team. The event ensures that all parts of the system that rely on inventory data are kept up-to-date with the latest inventory levels.
+
+## Architecture diagram
+
+<NodeGraph />
+
+## Payload example
+
+Event example you my see being published.
+
+```json title="Payload example"
+{
+  "Name": "John Doe",
+  "Age": 30,
+  "Department": "Engineering",
+  "Position": "Software Engineer",
+  "Salary": 85000.50,
+  "JoinDate": "2024-01-15"
+}
+```
+
+## Schema (avro)
+
+<Schema file="schema.avro" title="Inventory Adjusted Schema (avro)" />
+
+## Producing the Event
+
+To produce an Inventory Adjusted event, use the following example Kafka producer configuration in Python:
+
+```python title="Produce event in Python" frame="terminal"
+from kafka import KafkaProducer
+import json
+from datetime import datetime
+
+# Kafka configuration
+producer = KafkaProducer(
+    bootstrap_servers=['localhost:9092'],
+    value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Event data
+event_data = {
+  "event_id": "abc123",
+  "timestamp": datetime.utcnow().isoformat() + 'Z',
+  "product_id": "prod987",
+  "adjusted_quantity": 10,
+  "new_quantity": 150,
+  "adjustment_reason": "restock",
+  "adjusted_by": "user123"
+}
+
+# Send event to Kafka topic
+producer.send('inventory.adjusted', event_data)
+producer.flush()
+```
+
+### Consuming the Event
+
+To consume an Inventory Adjusted event, use the following example Kafka consumer configuration in Python:
+
+```python title="Consuming the event with python" frame="terminal"
+from kafka import KafkaConsumer
+import json
+
+# Kafka configuration
+consumer = KafkaConsumer(
+    'inventory.adjusted',
+    bootstrap_servers=['localhost:9092'],
+    auto_offset_reset='earliest',
+    enable_auto_commit=True,
+    group_id='inventory_group',
+    value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Consume events
+for message in consumer:
+    event_data = json.loads(message.value)
+    print(f"Received Inventory Adjusted event: {event_data}")
+```

package/templates/default/events/Inventory/InventoryAdjusted/schema.avro

@@ -0,0 +1,13 @@
+{
+  "type" : "record",
+  "namespace" : "Tutorialspoint",
+  "name" : "Employee",
+  "fields" : [
+     { "name" : "Name", "type" : "string" },
+     { "name" : "Age", "type" : "int" },
+     { "name" : "Department", "type" : "string" },
+     { "name" : "Position", "type" : "string" },
+     { "name" : "Salary", "type" : "double" },
+     { "name" : "JoinDate", "type" : "string", "logicalType": "date" }
+  ]
+}

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.1/index.md

@@ -0,0 +1,19 @@
+---
+id: InventoryAdjusted
+name: Inventory adjusted
+version: 0.0.1
+summary: |
+  Indicates a change in inventory level
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+---
+
+<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
+
+<NodeGraph />

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.1/schema.avro

@@ -0,0 +1,9 @@
+{
+  "type" : "record",
+  "namespace" : "Tutorialspoint",
+  "name" : "Employee",
+  "fields" : [
+     { "name" : "Name" , "type" : "string" },
+     { "name" : "Age" , "type" : "int" }
+  ]
+}

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.3/index.md

@@ -0,0 +1,104 @@
+---
+id: InventoryAdjusted
+name: Inventory adjusted
+version: 0.0.3
+summary: |
+  Indicates a change in inventory level
+owners:
+    - dboyne
+    - msmith
+    - asmith
+    - full-stack
+    - mobile-devs
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+    - content: Channel:Apache Kafka
+      backgroundColor: yellow
+      textColor: yellow
+---
+
+## Overview
+
+The `Inventory Adjusted` event is triggered whenever there is a change in the inventory levels of a product. This could occur due to various reasons such as receiving new stock, sales, returns, or manual adjustments by the inventory management team. The event ensures that all parts of the system that rely on inventory data are kept up-to-date with the latest inventory levels.
+
+<NodeGraph />
+
+## Event Details
+
+### Event Name
+`inventory.adjusted`
+
+### Description
+This event indicates that the inventory count for one or more products has been adjusted. The event carries the updated inventory details including the product ID, the new quantity, and the reason for the adjustment.
+
+### Payload
+The payload of the `Inventory Adjusted` event includes the following fields:
+
+```json title="Example of payload" frame="terminal"
+{
+  "event_id": "string",
+  "timestamp": "ISO 8601 date-time",
+  "product_id": "string",
+  "adjusted_quantity": "integer",
+  "new_quantity": "integer",
+  "adjustment_reason": "string",
+  "adjusted_by": "string"
+}
+```
+
+### Producing the Event
+
+To produce an Inventory Adjusted event, use the following example Kafka producer configuration in Python:
+
+```python title="Produce event in Python" frame="terminal"
+from kafka import KafkaProducer
+import json
+from datetime import datetime
+
+# Kafka configuration
+producer = KafkaProducer(
+    bootstrap_servers=['localhost:9092'],
+    value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Event data
+event_data = {
+  "event_id": "abc123",
+  "timestamp": datetime.utcnow().isoformat() + 'Z',
+  "product_id": "prod987",
+  "adjusted_quantity": 10,
+  "new_quantity": 150,
+  "adjustment_reason": "restock",
+  "adjusted_by": "user123"
+}
+
+# Send event to Kafka topic
+producer.send('inventory.adjusted', event_data)
+producer.flush()
+```
+
+### Consuming the Event
+
+To consume an Inventory Adjusted event, use the following example Kafka consumer configuration in Python:
+
+```python title="Consuming the event with python" frame="terminal"
+from kafka import KafkaConsumer
+import json
+
+# Kafka configuration
+consumer = KafkaConsumer(
+    'inventory.adjusted',
+    bootstrap_servers=['localhost:9092'],
+    auto_offset_reset='earliest',
+    enable_auto_commit=True,
+    group_id='inventory_group',
+    value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Consume events
+for message in consumer:
+    event_data = json.loads(message.value)
+    print(f"Received Inventory Adjusted event: {event_data}")
+```

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.3/schema.avro

@@ -0,0 +1,14 @@
+{
+  "type" : "record",
+  "namespace" : "Tutorialspoint",
+  "name" : "Employee",
+  "fields" : [
+     { "name" : "Name" , "type" : "string" },
+     { "name" : "Age" , "type" : "int" },
+     { "name" : "Age" , "type" : "int" },
+     { "name" : "Age" , "type" : "int" },
+     { "name" : "Age" , "type" : "int" },
+     { "name" : "Age" , "type" : "int" },
+     { "name" : "Age" , "type" : "int" }
+  ]
+}