@eventcatalog/create-eventcatalog 1.2.1 → 2.0.0

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

@@ -0,0 +1,96 @@
+---
+id: OutOfStock
+name: Inventory out of stock
+version: 0.0.3
+summary: |
+  Indicates inventory is out of stock
+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 />
+
+### 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/Order/OrderAmended/index.md

@@ -0,0 +1,53 @@
+---
+id: OrderAmended
+name: Order amended
+version: 0.0.1
+summary: |
+  Indicates an order has been changed
+owners:
+    - dboyne
+    - msmith
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+    - content: Channel:Apache Kafka
+      backgroundColor: yellow
+      textColor: yellow
+schemaPath: schema.avro
+---
+
+## Overview
+
+The OrderAmended event is triggered whenever an existing order is modified. This event ensures that all relevant services are notified of changes to an order, such as updates to order items, quantities, shipping information, or status. The event allows the system to maintain consistency and ensure that all dependent services can react appropriately to the amendments.
+
+## Example payload
+
+```json title="Example Payload"
+{
+  "orderId": "123e4567-e89b-12d3-a456-426614174000",
+  "userId": "123e4567-e89b-12d3-a456-426614174000",
+  "amendedItems": [
+    {
+      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
+      "productName": "Example Product",
+      "oldQuantity": 2,
+      "newQuantity": 3,
+      "unitPrice": 29.99,
+      "totalPrice": 89.97
+    }
+  ],
+  "orderStatus": "confirmed",
+  "totalAmount": 150.75,
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+```
+
+## Schema (Avro)
+
+<Schema file="schema.avro" />
+
+## Schema (JSON)
+
+<Schema file="schema.json" />
+

package/templates/default/events/Order/OrderAmended/schema.avro

@@ -0,0 +1,75 @@
+{
+  "type": "record",
+  "name": "OrderAmendedEvent",
+  "namespace": "com.example.events",
+  "fields": [
+    {
+      "name": "orderId",
+      "type": "string",
+      "doc": "The unique identifier of the order that was amended."
+    },
+    {
+      "name": "userId",
+      "type": "string",
+      "doc": "The unique identifier of the user who placed the order."
+    },
+    {
+      "name": "amendedItems",
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "AmendedItem",
+          "fields": [
+            {
+              "name": "productId",
+              "type": "string",
+              "doc": "The unique identifier of the product."
+            },
+            {
+              "name": "productName",
+              "type": "string",
+              "doc": "The name of the product."
+            },
+            {
+              "name": "oldQuantity",
+              "type": "int",
+              "doc": "The original quantity of the product ordered."
+            },
+            {
+              "name": "newQuantity",
+              "type": "int",
+              "doc": "The new quantity of the product ordered."
+            },
+            {
+              "name": "unitPrice",
+              "type": "double",
+              "doc": "The price per unit of the product."
+            },
+            {
+              "name": "totalPrice",
+              "type": "double",
+              "doc": "The total price for this order item (newQuantity * unitPrice)."
+            }
+          ]
+        }
+      },
+      "doc": "A list of items that were amended in the order, each containing product details and updated quantities."
+    },
+    {
+      "name": "orderStatus",
+      "type": "string",
+      "doc": "The current status of the order after the amendment."
+    },
+    {
+      "name": "totalAmount",
+      "type": "double",
+      "doc": "The total amount of the order after the amendment."
+    },
+    {
+      "name": "timestamp",
+      "type": "string",
+      "doc": "The date and time when the order was amended, in ISO 8601 format."
+    }
+  ]
+}

package/templates/default/events/Order/OrderAmended/schema.json

@@ -0,0 +1,71 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderAmendedEvent",
+    "type": "object",
+    "properties": {
+      "orderId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the order that was amended."
+      },
+      "userId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the user who placed the order."
+      },
+      "amendedItems": {
+        "type": "array",
+        "description": "A list of items that were amended in the order, each containing product details and updated quantities.",
+        "items": {
+          "type": "object",
+          "properties": {
+            "productId": {
+              "type": "string",
+              "format": "uuid",
+              "description": "The unique identifier of the product."
+            },
+            "productName": {
+              "type": "string",
+              "description": "The name of the product."
+            },
+            "oldQuantity": {
+              "type": "integer",
+              "description": "The original quantity of the product ordered."
+            },
+            "newQuantity": {
+              "type": "integer",
+              "description": "The new quantity of the product ordered."
+            },
+            "unitPrice": {
+              "type": "number",
+              "format": "float",
+              "description": "The price per unit of the product."
+            },
+            "totalPrice": {
+              "type": "number",
+              "format": "float",
+              "description": "The total price for this order item (newQuantity * unitPrice)."
+            }
+          },
+          "required": ["productId", "productName", "oldQuantity", "newQuantity", "unitPrice", "totalPrice"]
+        }
+      },
+      "orderStatus": {
+        "type": "string",
+        "description": "The current status of the order after the amendment."
+      },
+      "totalAmount": {
+        "type": "number",
+        "format": "float",
+        "description": "The total amount of the order after the amendment."
+      },
+      "timestamp": {
+        "type": "string",
+        "format": "date-time",
+        "description": "The date and time when the order was amended, in ISO 8601 format."
+      }
+    },
+    "required": ["orderId", "userId", "amendedItems", "orderStatus", "totalAmount", "timestamp"],
+    "additionalProperties": false
+  }
+  

package/templates/default/events/Order/OrderCancelled/index.md

@@ -0,0 +1,51 @@
+---
+id: OrderCancelled
+name: Order cancelled
+version: 0.0.1
+summary: |
+  Indicates an order has been canceled
+owners:
+    - dboyne
+    - msmith
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+    - content: Channel:Apache Kafka
+      backgroundColor: yellow
+      textColor: yellow
+schemaPath: 'schema.json'
+---
+
+## Overview
+
+The OrderCancelled event is triggered whenever an existing order is cancelled. This event ensures that all relevant services are notified of the cancellation, allowing them to take appropriate actions such as updating inventory levels, refunding payments, and notifying the user. The event helps maintain consistency across the system by ensuring all dependent services are aware of the order cancellation.
+
+## Example payload
+
+```json title="Example payload"
+{
+  "orderId": "123e4567-e89b-12d3-a456-426614174000",
+  "userId": "123e4567-e89b-12d3-a456-426614174000",
+  "orderItems": [
+    {
+      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
+      "productName": "Example Product",
+      "quantity": 2,
+      "unitPrice": 29.99,
+      "totalPrice": 59.98
+    }
+  ],
+  "orderStatus": "cancelled",
+  "totalAmount": 59.98,
+  "cancellationReason": "Customer requested cancellation",
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+
+```
+
+## Schema
+
+JSON schema for the event.
+
+<Schema title="JSON Schema" file="schema.json"/>

package/templates/default/events/Order/OrderCancelled/schema.json

@@ -0,0 +1,72 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderCancelledEvent",
+    "type": "object",
+    "properties": {
+      "orderId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the order that was cancelled."
+      },
+      "userId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the user who placed the order."
+      },
+      "orderItems": {
+        "type": "array",
+        "description": "A list of items included in the cancelled order, each containing product details and quantities.",
+        "items": {
+          "type": "object",
+          "properties": {
+            "productId": {
+              "type": "string",
+              "format": "uuid",
+              "description": "The unique identifier of the product."
+            },
+            "productName": {
+              "type": "string",
+              "description": "The name of the product."
+            },
+            "quantity": {
+              "type": "integer",
+              "description": "The quantity of the product ordered."
+            },
+            "unitPrice": {
+              "type": "number",
+              "format": "float",
+              "description": "The price per unit of the product."
+            },
+            "totalPrice": {
+              "type": "number",
+              "format": "float",
+              "description": "The total price for this order item (quantity * unit price)."
+            }
+          },
+          "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
+        }
+      },
+      "orderStatus": {
+        "type": "string",
+        "description": "The current status of the order after cancellation.",
+        "enum": ["cancelled"]
+      },
+      "totalAmount": {
+        "type": "number",
+        "format": "float",
+        "description": "The total amount of the order that was cancelled."
+      },
+      "cancellationReason": {
+        "type": "string",
+        "description": "The reason for the order cancellation, if provided."
+      },
+      "timestamp": {
+        "type": "string",
+        "format": "date-time",
+        "description": "The date and time when the order was cancelled."
+      }
+    },
+    "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "timestamp"],
+    "additionalProperties": false
+  }
+  

package/templates/default/events/Order/OrderConfirmed/index.md

@@ -0,0 +1,51 @@
+---
+id: OrderConfirmed
+name: Order confirmed
+version: 0.0.1
+summary: |
+  Indicates an order has been confirmed
+owners:
+    - dboyne
+    - msmith
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+    - content: Channel:Apache Kafka
+      backgroundColor: yellow
+      textColor: yellow
+schemaPath: schema.json
+---
+
+## Overview
+
+The OrderConfirmed event is triggered when an order has been successfully confirmed. This event notifies relevant services that the order is ready for further processing, such as inventory adjustment, payment finalization, and preparation for shipping.
+
+## Architecture Diagram
+
+<NodeGraph />
+
+## Payload
+
+```json title="Example payload"
+{
+  "orderId": "123e4567-e89b-12d3-a456-426614174000",
+  "userId": "123e4567-e89b-12d3-a456-426614174000",
+  "orderItems": [
+    {
+      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
+      "productName": "Example Product",
+      "quantity": 2,
+      "unitPrice": 29.99,
+      "totalPrice": 59.98
+    }
+  ],
+  "orderStatus": "confirmed",
+  "totalAmount": 150.75,
+  "confirmationTimestamp": "2024-07-04T14:48:00Z"
+}
+```
+
+## Schema
+
+<Schema file="schema.json"/>

package/templates/default/events/Order/OrderConfirmed/schema.json

@@ -0,0 +1,67 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderConfirmedEvent",
+    "type": "object",
+    "properties": {
+      "orderId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the confirmed order."
+      },
+      "userId": {
+        "type": "string",
+        "format": "uuid",
+        "description": "The unique identifier of the user who placed the order."
+      },
+      "orderItems": {
+        "type": "array",
+        "description": "A list of items included in the confirmed order, each containing product details and quantities.",
+        "items": {
+          "type": "object",
+          "properties": {
+            "productId": {
+              "type": "string",
+              "format": "uuid",
+              "description": "The unique identifier of the product."
+            },
+            "productName": {
+              "type": "string",
+              "description": "The name of the product."
+            },
+            "quantity": {
+              "type": "integer",
+              "description": "The quantity of the product ordered."
+            },
+            "unitPrice": {
+              "type": "number",
+              "format": "float",
+              "description": "The price per unit of the product."
+            },
+            "totalPrice": {
+              "type": "number",
+              "format": "float",
+              "description": "The total price for this order item (quantity * unitPrice)."
+            }
+          },
+          "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
+        }
+      },
+      "orderStatus": {
+        "type": "string",
+        "description": "The current status of the order after confirmation."
+      },
+      "totalAmount": {
+        "type": "number",
+        "format": "float",
+        "description": "The total amount of the confirmed order."
+      },
+      "confirmationTimestamp": {
+        "type": "string",
+        "format": "date-time",
+        "description": "The date and time when the order was confirmed."
+      }
+    },
+    "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "confirmationTimestamp"],
+    "additionalProperties": false
+  }
+  

package/templates/default/events/Payment/PaymentInitiated/index.md

@@ -0,0 +1,32 @@
+---
+id: PaymentInitiated
+name: Payment Initiated
+version: 0.0.1
+summary: Event is triggered when a user initiates a payment through the Payment Service
+owners:
+    - dboyne
+---
+
+## Overview
+
+The Payment Initiated event is triggered when a user initiates a payment through the Payment Service. This event signifies the beginning of the payment process and contains all necessary information to process the payment.
+
+<NodeGraph />
+
+### Payload Example
+
+```json title="Payload example"
+{
+  "userId": "123e4567-e89b-12d3-a456-426614174000",
+  "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
+  "amount": 100.50,
+  "paymentMethod": "CreditCard",
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+```
+
+### Security Considerations
+
+- **Authentication**: Ensure that only authenticated users can initiate a payment, and the userId in the payload matches the authenticated user.
+- **Data Validation**: Validate all input data to prevent injection attacks or other malicious input.
+- **Sensitive Data Handling**: Avoid including sensitive information (e.g., credit card numbers) in the event payload. Use secure channels and encryption for such data.

package/templates/default/events/Payment/PaymentProcessed/index.md

@@ -0,0 +1,38 @@
+---
+id: PaymentProcessed
+name: Payment Processed
+version: 0.0.1
+summary: Event is triggered after the payment has been successfully processed
+owners:
+    - dboyne
+---
+
+## Overview
+
+The PaymentProcessed event is triggered after the payment has been successfully processed by the Payment Service. This event signifies that a payment has been confirmed, and it communicates the outcome to other services and components within the system.
+
+<NodeGraph />
+
+### Payload Example
+
+```json title="Payload example"
+{
+  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
+  "userId": "123e4567-e89b-12d3-a456-426614174000",
+  "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
+  "amount": 100.50,
+  "paymentMethod": "CreditCard",
+  "status": "confirmed",
+  "confirmationDetails": {
+    "gatewayResponse": "Approved",
+    "transactionId": "abc123"
+  },
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+```
+
+### Security Considerations
+
+- **Data Validation**: Ensure that all data in the event payload is validated before publishing to prevent injection attacks or other malicious activities.
+- **Sensitive Data Handling**: Avoid including sensitive information (e.g., full credit card numbers) in the event payload. Use secure channels and encryption for such data.
+- **Authentication and Authorization**: Ensure that only authorized services can publish or consume PaymentProcessed events.

package/{dist → templates}/default/gitignore

@@ -3,11 +3,11 @@
 
 # Production
 /build
-/public/schemas
 
 # Generated files
-.next
+.astro
 out
+dist
 
 
 # Misc

package/templates/default/services/InventoryService/index.md

@@ -0,0 +1,36 @@
+---
+id: InventoryService
+version: 0.0.2
+name: Inventory Service
+summary: |
+  Service that handles the inventory
+owners:
+    - dboyne
+    - full-stack
+    - mobile-devs
+receives:
+  - id: OrderConfirmed
+    version: 0.0.1
+  - id: OrderCancelled
+    version: 0.0.1
+  - id: OrderAmended
+    version: 0.0.1
+  - id: UpdateInventory
+    version: 0.0.3
+sends:
+  - id: InventoryAdjusted
+    version: 0.0.4
+  - id: OutOfStock
+    version: 0.0.3
+repository:
+  language: JavaScript
+  url: https://github.com/boyney123/pretend-shipping-service
+---
+
+## Overview
+
+The Inventory Service is a critical component of the system responsible for managing product stock levels, tracking inventory movements, and ensuring product availability. It interacts with other services to maintain accurate inventory records and supports operations such as order fulfillment, restocking, and inventory audits.
+
+## Architecture diagram
+
+<NodeGraph title="Hello world" />