@eventcatalog/create-eventcatalog 2.0.21 → 2.1.0

package/README.md

@@ -1,3 +1,35 @@
 # @eventcatalog/create-catalog
 
 CLI utility to create new Eventcatalog. Full documentation at https://eventcatalog.dev.
+
+# Sponsors
+
+Thank you to our project  sponsors.
+
+## Gold sponsors
+
+<div align="center">
+  <img alt="hookdeck" src="./images/sponsors/hookdeck.svg" />
+  <p style="margin: 0; padding: 0;">Serverless infrastructure for event-driven architecture. </p>
+  <a href="https://hookdeck.com/?ref=eventcatalog-sponsor" target="_blank" >Learn more</a>
+</div>
+
+<hr />
+
+<div align="center">
+  <img alt="gravitee" src="./images/sponsors/gravitee-logo-black.svg" width="50%" />
+  <p style="margin: 0; padding: 0;">Manage, secure, and govern every API in your organization</p>
+  <a href="https://gravitee.io?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship" target="_blank" >Learn more</a>
+</div>
+
+<hr />
+
+<div align="center">
+  <img alt="oso" src="./images/sponsors/oso-logo-green.png" width="40%" />
+  <p style="margin: 0; padding: 0;">Delivering Apache Kafka professional services to your business</p>
+  <a href="https://oso.sh/?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship" target="_blank" >Learn more</a>
+</div>
+
+<hr />
+
+_Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or [visit our sponsor page](https://www.eventcatalog.dev/support)._

package/dist/index.js

@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "2.0.21",
+  version: "2.1.0",
   bin: {
     "create-catalog": "./dist/index.js"
   },
@@ -22746,8 +22746,9 @@ function validateNpmName(name) {
 // index.ts
 var projectPath = "";
 var organizationName = "";
-var program = new import_commander.default.Command(package_default.name).version(package_default.version).arguments("<project-directory>").usage(`${import_chalk5.default.green("<project-directory>")} [options]`).action((name) => {
+var program = new import_commander.default.Command(package_default.name).version(package_default.version).arguments("<project-directory>").usage(`${import_chalk5.default.green("<project-directory>")} [options]`).action((name, options) => {
   projectPath = name;
+  organizationName = options.organizationName || "";
 }).option(
   "--ts, --typescript",
   `
@@ -22801,6 +22802,12 @@ var program = new import_commander.default.Command(package_default.name).version
   In this case, you must specify the path to the example separately:
   --example-path foo/bar
 `
+).option(
+  "--organization-name [name]",
+  `
+
+  The organization name.
+`
 ).allowUnknownOption().parse(process.argv);
 var packageManager = !!program.useNpm ? "npm" : !!program.usePnpm ? "pnpm" : getPkgManager();
 async function run() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "2.0.21",
+  "version": "2.1.0",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

package/templates/default/channels/inventory.{env}.events/index.md

@@ -0,0 +1,157 @@
+---
+id: inventory.{env}.events
+name: Inventory Events Channel
+version: 1.0.0
+summary: |
+  Central event stream for all inventory-related events including stock updates, allocations, and adjustments
+owners:
+  - dboyne
+address: inventory.{env}.events
+protocols: 
+  - kafka
+
+parameters:
+  env:
+    enum:
+      - dev
+      - sit
+      - prod
+    description: 'Environment to use'
+---
+
+### Overview
+The Inventory Events channel is the central stream for all inventory-related events across the system. This includes stock level changes, inventory allocations, adjustments, and stocktake events. Events for a specific SKU are guaranteed to be processed in sequence when using productId as the partition key.
+
+<ChannelInformation />
+
+### Publishing and Subscribing to Events
+
+#### Publishing Example
+```python
+from kafka import KafkaProducer
+import json
+from datetime import datetime
+
+# Kafka configuration
+bootstrap_servers = ['localhost:9092']
+topic = f'inventory.{env}.events'
+
+# Create a Kafka producer
+producer = KafkaProducer(
+    bootstrap_servers=bootstrap_servers,
+    value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Example inventory update event
+inventory_event = {
+    "eventType": "STOCK_LEVEL_CHANGED",
+    "timestamp": datetime.utcnow().isoformat(),
+    "version": "1.0",
+    "payload": {
+        "productId": "PROD-456",
+        "locationId": "WH-123",
+        "previousQuantity": 100,
+        "newQuantity": 95,
+        "changeReason": "ORDER_FULFILLED",
+        "unitOfMeasure": "EACH",
+        "batchInfo": {
+            "batchId": "BATCH-789",
+            "expiryDate": "2025-12-31"
+        }
+    },
+    "metadata": {
+        "source": "warehouse_system",
+        "correlationId": "inv-xyz-123",
+        "userId": "john.doe"
+    }
+}
+
+# Send the message - using productId as key for partitioning
+producer.send(
+    topic, 
+    key=inventory_event['payload']['productId'].encode('utf-8'),
+    value=inventory_event
+)
+producer.flush()
+
+print(f"Inventory event sent to topic {topic}")
+
+```
+
+### Subscription example
+
+```python
+from kafka import KafkaConsumer
+import json
+from datetime import datetime
+
+class InventoryEventConsumer:
+    def __init__(self):
+        # Kafka configuration
+        self.topic = f'inventory.{env}.events'
+        self.consumer = KafkaConsumer(
+            self.topic,
+            bootstrap_servers=['localhost:9092'],
+            group_id='inventory-processor-group',
+            auto_offset_reset='earliest',
+            enable_auto_commit=False,
+            value_deserializer=lambda x: json.loads(x.decode('utf-8')),
+            key_deserializer=lambda x: x.decode('utf-8') if x else None
+        )
+
+    def process_event(self, event):
+        """Process individual inventory events based on type"""
+        event_type = event.get('eventType')
+        
+        if event_type == 'STOCK_LEVEL_CHANGED':
+            self.handle_stock_level_change(event)
+        elif event_type == 'LOW_STOCK_ALERT':
+            self.handle_low_stock_alert(event)
+        # Add more event type handlers as needed
+
+    def handle_stock_level_change(self, event):
+        """Handle stock level change events"""
+        payload = event['payload']
+        print(f"Stock level change detected for product {payload['productId']}")
+        print(f"New quantity: {payload['newQuantity']}")
+        # Add your business logic here
+
+    def handle_low_stock_alert(self, event):
+        """Handle low stock alert events"""
+        payload = event['payload']
+        print(f"Low stock alert for product {payload['productId']}")
+        print(f"Current quantity: {payload['currentQuantity']}")
+        # Add your business logic here
+
+    def start_consuming(self):
+        """Start consuming messages from the topic"""
+        try:
+            print(f"Starting consumption from topic: {self.topic}")
+            for message in self.consumer:
+                try:
+                    # Process the message
+                    event = message.value
+                    print(f"Received event: {event['eventType']} for product: {event['payload']['productId']}")
+                    
+                    # Process the event
+                    self.process_event(event)
+                    
+                    # Commit the offset after successful processing
+                    self.consumer.commit()
+                    
+                except Exception as e:
+                    print(f"Error processing message: {str(e)}")
+                    # Implement your error handling logic here
+                    # You might want to send to a DLQ (Dead Letter Queue)
+        
+        except Exception as e:
+            print(f"Consumer error: {str(e)}")
+        finally:
+            # Clean up
+            self.consumer.close()
+
+if __name__ == "__main__":
+    # Create and start the consumer
+    consumer = InventoryEventConsumer()
+    consumer.start_consuming()
+  ```

package/templates/default/channels/orders.{env}.events/index.md

@@ -0,0 +1,82 @@
+---
+id: orders.{env}.events
+name: Order Events Channel
+version: 1.0.1
+summary: |
+  Central event stream for all order-related events in the order processing lifecycle
+owners:
+  - dboyne
+address: orders.{env}.events
+protocols: 
+  - kafka
+
+parameters:
+  env:
+    enum:
+      - dev
+      - sit
+      - prod
+    description: 'Environment to use'
+---
+
+### Overview
+The Orders Events channel is the central stream for all order-related events across the order processing lifecycle. This includes order creation, updates, payment status, fulfillment status, and customer communications. All events related to a specific order are guaranteed to be processed in sequence when using orderId as the partition key.
+
+<ChannelInformation />
+
+### Publishing a message using Kafka
+
+Here is an example of how to publish an order event using Kafka:
+
+```python
+from kafka import KafkaProducer
+import json
+from datetime import datetime
+
+# Kafka configuration
+bootstrap_servers = ['localhost:9092']
+topic = f'orders.{env}.events'
+
+# Create a Kafka producer
+producer = KafkaProducer(
+    bootstrap_servers=bootstrap_servers,
+    value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Example order created event
+order_event = {
+    "eventType": "ORDER_CREATED",
+    "timestamp": datetime.utcnow().isoformat(),
+    "version": "1.0",
+    "payload": {
+        "orderId": "12345",
+        "customerId": "CUST-789",
+        "items": [
+            {
+                "productId": "PROD-456",
+                "quantity": 2,
+                "price": 29.99
+            }
+        ],
+        "totalAmount": 59.98,
+        "shippingAddress": {
+            "street": "123 Main St",
+            "city": "Springfield",
+            "country": "US"
+        }
+    },
+    "metadata": {
+        "source": "web_checkout",
+        "correlationId": "abc-xyz-123"
+    }
+}
+
+# Send the message - using orderId as key for partitioning
+producer.send(
+    topic, 
+    key=order_event['payload']['orderId'].encode('utf-8'),
+    value=order_event
+)
+producer.flush()
+
+print(f"Order event sent to topic {topic}")

package/templates/default/channels/payment.{env}.events/index.md

@@ -0,0 +1,88 @@
+---
+id: payments.{env}.events
+name: Payment Events Channel
+version: 1.0.0
+summary: |
+ All events contain payment ID for traceability and ordered processing.
+owners:
+ - dboyne
+address: payments.{env}.events
+protocols: 
+ - kafka
+
+parameters:
+ env:
+   enum:
+     - dev
+     - sit
+     - prod
+   description: 'Environment to use for payment events'
+---
+
+### Overview
+The Payments Events channel is the central stream for all payment lifecycle events. This includes payment initiation, authorization, capture, completion and failure scenarios. Events for a specific payment are guaranteed to be processed in sequence when using paymentId as the partition key.
+
+<ChannelInformation />
+
+### Publishing Events Using Kafka
+
+Here's an example of publishing a payment event:
+
+```python
+from kafka import KafkaProducer
+import json
+from datetime import datetime
+
+# Kafka configuration
+bootstrap_servers = ['localhost:9092']
+topic = f'payments.{env}.events'
+
+# Create Kafka producer
+producer = KafkaProducer(
+   bootstrap_servers=bootstrap_servers,
+   value_serializer=lambda v: json.dumps(v).encode('utf-8')
+)
+
+# Example payment processed event
+payment_event = {
+   "eventType": "PAYMENT_PROCESSED",
+   "timestamp": datetime.utcnow().isoformat(),
+   "version": "1.0",
+   "payload": {
+       "paymentId": "PAY-123-456", 
+       "orderId": "ORD-789",
+       "amount": {
+           "value": 99.99,
+           "currency": "USD"
+       },
+       "status": "SUCCESS",
+       "paymentMethod": {
+           "type": "CREDIT_CARD",
+           "last4": "4242",
+           "expiryMonth": "12",
+           "expiryYear": "2025",
+           "network": "VISA"
+       },
+       "transactionDetails": {
+           "processorId": "stripe_123xyz",
+           "authorizationCode": "AUTH123",
+           "captureId": "CAP456"
+       }
+   },
+   "metadata": {
+       "correlationId": "corr-123-abc",
+       "merchantId": "MERCH-456", 
+       "source": "payment_service",
+       "environment": "prod",
+       "idempotencyKey": "PAY-123-456-2024-11-11-99.99"
+   }
+}
+
+# Send message - using paymentId as key for partitioning
+producer.send(
+   topic,
+   key=payment_event['payload']['paymentId'].encode('utf-8'),
+   value=payment_event
+)
+producer.flush()
+```

package/templates/default/components/footer.astro

@@ -0,0 +1,8 @@
+---
+import config from '@config';
+---
+
+<div class="w-full text-right">
+  <span class="italic text-gray-800">Event-driven architecture documentation: {config.organizationName}</span>
+</div>
+

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

@@ -1,9 +1,10 @@
 ---
 id: Orders
 name: Orders
-version: 0.0.2
+version: 0.0.3
 owners:
   - dboyne
+  - full-stack
 services:
   - id: InventoryService
     version: 0.0.2
@@ -17,11 +18,21 @@ badges:
     textColor: blue
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
+<Admonition type="warning">Please ensure all services are updated to the latest version for compatibility and performance improvements.</Admonition>
+
 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>
+
+<Tiles >
+    <Tile icon="UserGroupIcon" href="/docs/teams/full-stack" title="Contact the team" description="Any questions? Feel free to contact the owners" />
+    <Tile icon="RectangleGroupIcon" href={`/visualiser/domains/${frontmatter.id}/${frontmatter.version}`} title={`${frontmatter.services.length} services are in this domain`} description="This service sends messages to downstream consumers" />
+</Tiles>
+
+
 
 ## Bounded context
 
@@ -53,4 +64,9 @@ Documented flow when a user cancels their subscription.
 
 <Flow id="CancelSubscription" version="latest" includeKey={false} />
 
- 
+### Payment processing flow
+Documented flow when a user makes a payment within the order domain
+
+<Flow id="PaymentFlow" version="latest" includeKey={false} />
+
+<Footer />

package/templates/default/{commands → domains/Orders/services/InventoryService/commands}/AddInventory/index.md

@@ -14,9 +14,15 @@ badges:
     - content: Recently updated!
       backgroundColor: green
       textColor: green
+channels:
+  - id: inventory.{env}.events
+    parameters:
+      env: staging
 schemaPath: 'schema.json'
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## 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.
@@ -40,3 +46,7 @@ The AddInventory command is issued to add new stock to the inventory. This comma
 ## Schema
 
 <Schema file="schema.json"/>
+
+<Footer />
+
+

package/templates/default/domains/Orders/services/InventoryService/commands/PlaceOrder/index.md

@@ -0,0 +1,36 @@
+---
+id: PlaceOrder
+name: Place Order
+version: 0.0.1
+summary: |
+  Command that will place an order
+owners:
+    - dboyne
+    - msmith
+    - asmith
+    - full-stack
+    - mobile-devs
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: 'schema.json'
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The Order Placement Command is a versatile and robust system designed to streamline the process of placing an order. This command takes care of all the essential details needed to complete a purchase, ensuring a smooth and efficient transaction from start to finish.
+
+## Architecture diagram
+
+<NodeGraph/>
+
+## Schema
+
+<SchemaViewer file="schema.json"/>
+
+<Footer />
+
+

package/templates/default/domains/Orders/services/InventoryService/commands/PlaceOrder/schema.json

@@ -0,0 +1,124 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Order",
+  "description": "A schema representing an order placed by a customer",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "description": "Unique identifier for the order",
+      "type": "string"
+    },
+    "customer": {
+      "description": "Information about the customer placing the order",
+      "type": "object",
+      "properties": {
+        "customerId": {
+          "description": "Unique identifier for the customer",
+          "type": "string"
+        },
+        "name": {
+          "description": "Name of the customer",
+          "type": "string"
+        },
+        "email": {
+          "description": "Email address of the customer",
+          "type": "string",
+          "format": "email"
+        },
+        "phone": {
+          "description": "Phone number of the customer",
+          "type": "string",
+          "pattern": "^[+]?[0-9]{10,15}$"
+        }
+      },
+      "required": ["customerId", "name", "email"]
+    },
+    "items": {
+      "description": "List of items in the order",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "itemId": {
+            "description": "Unique identifier for the item",
+            "type": "string"
+          },
+          "name": {
+            "description": "Name of the item",
+            "type": "string"
+          },
+          "quantity": {
+            "description": "Quantity of the item ordered",
+            "type": "integer",
+            "minimum": 1
+          },
+          "price": {
+            "description": "Price per unit of the item",
+            "type": "number",
+            "minimum": 0
+          }
+        },
+        "required": ["itemId", "name", "quantity", "price"]
+      }
+    },
+    "shippingAddress": {
+      "description": "Address where the order will be shipped",
+      "type": "object",
+      "properties": {
+        "street": {
+          "description": "Street address",
+          "type": "string"
+        },
+        "city": {
+          "description": "City",
+          "type": "string"
+        },
+        "state": {
+          "description": "State or province",
+          "type": "string"
+        },
+        "zip": {
+          "description": "ZIP or postal code",
+          "type": "string"
+        },
+        "country": {
+          "description": "Country",
+          "type": "string"
+        }
+      },
+      "required": ["street", "city", "state", "zip", "country"]
+    },
+    "payment": {
+      "description": "Payment information for the order",
+      "type": "object",
+      "properties": {
+        "paymentMethod": {
+          "description": "Payment method used",
+          "type": "string",
+          "enum": ["Credit Card", "PayPal", "Bank Transfer"]
+        },
+        "transactionId": {
+          "description": "Transaction ID for the payment",
+          "type": "string"
+        },
+        "amount": {
+          "description": "Total amount paid",
+          "type": "number",
+          "minimum": 0
+        }
+      },
+      "required": ["paymentMethod", "transactionId", "amount"]
+    },
+    "orderDate": {
+      "description": "Date when the order was placed",
+      "type": "string",
+      "format": "date-time"
+    },
+    "status": {
+      "description": "Current status of the order",
+      "type": "string",
+      "enum": ["Pending", "Processing", "Shipped", "Delivered", "Cancelled"]
+    }
+  },
+  "required": ["orderId", "customer", "items", "shippingAddress", "payment", "orderDate", "status"]
+}

package/templates/default/{commands → domains/Orders/services/InventoryService/commands}/UpdateInventory/index.md

@@ -14,9 +14,15 @@ badges:
     - content: Recently updated!
       backgroundColor: green
       textColor: green
+channels:
+  - id: inventory.{env}.events
+    parameters:
+      env: staging
 schemaPath: "schema.json"
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## 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.
@@ -25,6 +31,8 @@ The UpdateInventory command is issued to update the existing stock levels of a p
 
 <NodeGraph />
 
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+
 ## Payload example
 
 ```json title="Payload example"
@@ -40,3 +48,4 @@ The UpdateInventory command is issued to update the existing stock levels of a p
 
 <Schema file="schema.json"/>
 
+<Footer />