@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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

@@ -1,85 +0,0 @@
----
-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
-routes:
-  - id: inventory-queue
-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.mdx

@@ -1,89 +0,0 @@
----
-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/domains/E-Commerce/index.mdx

@@ -1,140 +0,0 @@
----
-id: E-Commerce
-name: E-Commerce
-summary: Core business domain orchestrating FlowMart's digital marketplace operations
-version: 1.0.0
-owners:
-  - dboyne
-  - full-stack
-domains:
-  - id: Orders
-  - id: Payment
-  - id: Subscription
-badges:
-  - content: Core domain
-    backgroundColor: blue
-    textColor: blue
-    icon: RectangleGroupIcon
-  - content: Business Critical
-    backgroundColor: yellow
-    textColor: yellow
-    icon: ShieldCheckIcon
----
-
-import Footer from '@catalog/components/footer.astro';
-
-The E-Commerce domain is the core business domain of FlowMart, our modern digital marketplace. This domain orchestrates all critical business operations from product discovery to order fulfillment, handling millions of transactions monthly across our global customer base.
-
-<Tiles>
-  <Tile
-    icon="UserGroupIcon"
-    href="/docs/teams/full-stack"
-    title="Engineering Support"
-    description="Questions? Contact our full-stack team for technical support"
-  />
-  <Tile
-    icon="RectangleGroupIcon"
-    href={`/visualiser/domains/${frontmatter.id}/${frontmatter.version}`}
-    title="Domain Architecture"
-    description="Explore our domain structure and service interactions"
-  />
-</Tiles>
-
-## Domain Overview
-
-FlowMart's E-Commerce domain is built on event-driven microservices architecture, enabling:
-
-- Real-time inventory management across multiple warehouses
-- Seamless payment processing with multiple providers
-- Smart order routing and fulfillment
-- Personalized customer notifications
-- Subscription-based shopping experiences
-- Advanced fraud detection and prevention
-
-## Sub domains
-
-The E-Commerce domain is built on the following sub domains:
-
-- <ResourceLink id="Orders" type="domain">
-    Orders
-  </ResourceLink>
-  - Core domain for order management
-- <ResourceLink id="Payment" type="domain">
-    Payment
-  </ResourceLink>
-  - A generic domain for payment processing using Stripe as a payment provider
-- <ResourceLink id="Subscription" type="domain">
-    Subscription
-  </ResourceLink>
-  - Generic subscription domain handling users subscriptions
-
-## Architecture
-
-Our current event-driven architecture powering FlowMart's shopping experience:
-
-<NodeGraph />
-
-### Order Processing Flow
-
-```mermaid
-sequenceDiagram
-    participant Customer
-    participant OrdersService
-    participant InventoryService
-    participant PaymentService
-    participant NotificationService
-    participant ShippingService
-
-    Customer->>OrdersService: Place Order
-    OrdersService->>InventoryService: Check Stock Availability
-    InventoryService-->>OrdersService: Stock Confirmed
-    OrdersService->>PaymentService: Process Payment
-    PaymentService-->>OrdersService: Payment Successful
-    OrdersService->>InventoryService: Reserve Inventory
-    OrdersService->>ShippingService: Create Shipping Label
-    ShippingService-->>OrdersService: Shipping Label Generated
-    OrdersService->>NotificationService: Send Order Confirmation
-    NotificationService-->>Customer: Order & Tracking Details
-```
-
-## Key Business Flows
-
-### Subscription Management
-
-Our subscription service powers FlowMart's popular "Subscribe & Save" feature:
-
-<Flow id="CancelSubscription" version="latest" includeKey={false} />
-
-### Payment Processing
-
-Secure, multi-provider payment processing with fraud detection:
-
-<Flow id="PaymentFlow" version="latest" includeKey={false} />
-
-## Core Services
-
-These services form the backbone of FlowMart's e-commerce operations:
-
-<ResourceGroupTable
-  id="related-resources"
-  limit={7}
-  showOwners={true}
-  description="Essential services powering our e-commerce platform"
-/>
-
-## Performance SLAs
-
-- Order Processing: < 2 seconds
-- Payment Processing: < 3 seconds
-- Inventory Updates: Real-time
-- Notification Delivery: < 30 seconds
-
-## Monitoring & Alerts
-
-- Real-time order volume monitoring
-- Payment gateway health checks
-- Inventory level alerts
-- Customer experience metrics
-- System performance dashboards
-
-<Footer />

package/templates/default/domains/E-Commerce/ubiquitous-language.mdx

@@ -1,87 +0,0 @@
----
-dictionary:
-  - id: Marketplace
-    name: Marketplace
-    summary: 'The digital platform where buyers and sellers interact to browse, purchase, and sell goods.'
-    description: |
-      The marketplace is FlowMart's core digital storefront, providing the infrastructure for all commerce activity. It encompasses:
-
-      - Product discovery and search capabilities
-      - Seller listings and buyer interactions
-      - Transaction facilitation and trust mechanisms
-      - Platform-wide policies and governance
-    icon: Store
-  - id: Checkout
-    name: Checkout
-    summary: 'The process by which a customer finalizes a purchase, providing payment and shipping details.'
-    description: |
-      Checkout is the critical conversion step where a browsing customer becomes a paying customer. The checkout flow includes:
-
-      - Cart review and item confirmation
-      - Shipping address and method selection
-      - Payment method selection and authorization
-      - Order confirmation and receipt generation
-
-      Optimizing the checkout experience is essential for reducing cart abandonment and increasing conversion rates.
-    icon: ShoppingCart
-  - id: Cart
-    name: Cart
-    summary: 'A temporary collection of items a customer intends to purchase.'
-    description: |
-      The shopping cart holds selected products before checkout. Key behaviors include:
-
-      - Adding and removing items
-      - Updating item quantities
-      - Applying discount codes and promotions
-      - Calculating subtotals, taxes, and shipping estimates
-
-      Carts may persist across sessions for authenticated customers and have configurable expiration policies.
-    icon: ShoppingBag
-  - id: Catalog
-    name: Catalog
-    summary: 'The complete collection of products available for sale on the marketplace.'
-    icon: BookOpen
-  - id: Customer
-    name: Customer
-    summary: 'An individual or organization that purchases goods or services from the marketplace.'
-    description: |
-      Customers are the primary consumers in the e-commerce domain. A customer profile includes:
-
-      - Account and identity information
-      - Order history and preferences
-      - Saved addresses and payment methods
-      - Loyalty status and rewards balance
-
-      Customers may be guests (unauthenticated) or registered account holders.
-    icon: User
-  - id: Storefront
-    name: Storefront
-    summary: 'The customer-facing presentation layer of the marketplace, including product pages, navigation, and branding.'
-    icon: Layout
-  - id: Promotion
-    name: Promotion
-    summary: 'A marketing incentive such as a discount, coupon, or special offer applied to products or orders.'
-    description: |
-      Promotions drive customer engagement and sales. Common promotion types include:
-
-      - Percentage or fixed-amount discounts
-      - Buy-one-get-one (BOGO) offers
-      - Free shipping thresholds
-      - Time-limited flash sales
-      - Loyalty reward redemptions
-
-      Promotions have eligibility rules, usage limits, and validity periods.
-    icon: Percent
-  - id: Conversion
-    name: Conversion
-    summary: 'The completion of a desired customer action, most commonly a purchase.'
-    icon: TrendingUp
-  - id: Fulfillment
-    name: Fulfillment
-    summary: "The end-to-end process of receiving, processing, and delivering a customer's order."
-    icon: PackageCheck
-  - id: Cart Abandonment
-    name: Cart Abandonment
-    summary: 'When a customer adds items to their cart but leaves the site without completing the purchase.'
-    icon: ShoppingCart
----

package/templates/default/domains/Orders/changelog.mdx

@@ -1,7 +0,0 @@
----
-createdAt: 2024-08-01
----
-
-### Service added to domain
-
-Added the InventoryService to the domain.

package/templates/default/domains/Orders/entities/CartItem/index.mdx

@@ -1,124 +0,0 @@
----
-id: CartItem
-name: CartItem
-version: 1.0.0
-identifier: cartItemId
-summary: Represents an individual item within a shopping cart.
-owners:
-  - dboyne
-properties:
-  - name: cartItemId
-    type: UUID
-    required: true
-    description: Unique identifier for the cart item
-  - name: cartId
-    type: UUID
-    required: true
-    description: Shopping cart this item belongs to
-    references: ShoppingCart
-    referencesIdentifier: cartId
-    relationType: hasOne
-  - name: productId
-    type: UUID
-    required: true
-    description: Product being added to cart
-    references: Product
-    referencesIdentifier: productId
-    relationType: hasOne
-  - name: sku
-    type: string
-    required: true
-    description: Product SKU at time of adding to cart
-  - name: productName
-    type: string
-    required: true
-    description: Product name snapshot at time of adding to cart
-  - name: productImage
-    type: string
-    required: false
-    description: Product image URL snapshot
-  - name: quantity
-    type: integer
-    required: true
-    description: Quantity of this product in the cart
-  - name: unitPrice
-    type: decimal
-    required: true
-    description: Unit price at time of adding to cart
-  - name: totalPrice
-    type: decimal
-    required: true
-    description: Total price for this line item (quantity × unit price)
-  - name: originalPrice
-    type: decimal
-    required: false
-    description: Original product price before any discounts
-  - name: discountAmount
-    type: decimal
-    required: false
-    description: Discount applied to this line item
-  - name: productVariant
-    type: object
-    required: false
-    description: Product variant details (size, color, etc.)
-    properties:
-      - name: size
-        type: string
-        description: Product size if applicable
-      - name: color
-        type: string
-        description: Product color if applicable
-      - name: style
-        type: string
-        description: Product style if applicable
-  - name: isAvailable
-    type: boolean
-    required: true
-    description: Whether the product is still available
-  - name: notes
-    type: string
-    required: false
-    description: Customer notes for this item
-  - name: addedAt
-    type: DateTime
-    required: true
-    description: Date and time when item was added to cart
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when item was last updated
----
-
-## Overview
-
-The CartItem entity represents individual products within a customer's shopping cart. It maintains snapshots of product information and pricing to ensure consistency during the shopping session.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **ShoppingCart:** Each cart item belongs to one `ShoppingCart` (identified by `cartId`).
-- **Product:** Each cart item references one `Product` (identified by `productId`).
-
-## Price Calculations
-
-- **Total Price** = Quantity × Unit Price - Discount Amount
-- **Savings** = Original Price - Unit Price (if applicable)
-
-## Examples
-
-- **CartItem #1:** iPhone 15 Pro, quantity 1, $999.99 unit price, no discount.
-- **CartItem #2:** Running Shoes Size 9, quantity 2, $64.99 unit price (was $129.99).
-- **CartItem #3:** T-Shirt Large/Blue, quantity 3, $19.99 unit price.
-
-## Business Rules
-
-- Quantity must be greater than zero
-- Unit price is captured at time of adding to maintain consistency
-- Product availability is checked when cart is accessed
-- Unavailable items are marked but not automatically removed
-- Total price is recalculated when quantity changes
-- Product snapshots prevent price changes from affecting active carts
-- Maximum quantity limits may apply per product type

package/templates/default/domains/Orders/entities/Customer/index.mdx

@@ -1,59 +0,0 @@
----
-id: Customer
-name: Customer
-version: 1.0.0
-identifier: customerId
-summary: Represents an individual or organization that places orders.
-owners:
-  - dboyne
-
-properties:
-  - name: customerId
-    type: UUID
-    required: true
-    description: Unique identifier for the customer
-  - name: firstName
-    type: string
-    required: true
-    description: Customer's first name
-  - name: lastName
-    type: string
-    required: true
-    description: Customer's last name
-  - name: email
-    type: string
-    required: true
-    description: Customer's primary email address (unique)
-  - name: phone
-    type: string
-    required: false
-    description: Customer's phone number
-  - name: addresses
-    type: array
-    items:
-      type: Address # Assuming an Address value object or entity exists
-    required: false
-    description: List of addresses associated with the customer (e.g., shipping, billing)
-  - name: dateRegistered
-    type: DateTime
-    required: true
-    description: Date and time when the customer registered
----
-
-## Overview
-
-The Customer entity holds information about the individuals or organizations who interact with the system, primarily by placing orders. It stores contact details, addresses, and other relevant personal or business information.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Order:** A customer can have multiple `Order` entities. The `Order` entity holds a reference (`customerId`) back to the `Customer`.
-- **Address:** A customer can have multiple associated `Address` value objects or entities.
-
-## Examples
-
-- **Customer A:** Jane Doe, registered on 2023-01-15, with a primary shipping address and a billing address.
-- **Customer B:** John Smith, a long-time customer with multiple past orders.

package/templates/default/domains/Orders/entities/Order/index.mdx

@@ -1,98 +0,0 @@
----
-id: Order
-name: Order
-version: 1.0.0
-identifier: orderId
-aggregateRoot: true
-summary: Represents a customer's request to purchase products or services.
-owners:
-  - dboyne
-properties:
-  - name: orderId
-    type: UUID
-    required: true
-    description: Unique identifier for the order
-  - name: orderNumber
-    type: string
-    required: true
-    description: Unique identifier for the order
-  - name: customerId
-    type: UUID
-    required: false
-    description: Identifier for the customer placing the order test
-    references: Customer
-    referencesIdentifier: customerId
-    relationType: hasOne
-  - name: orderDate
-    type: DateTime
-    required: true
-    description: Date and time when the order was placed
-  - name: status
-    type: string
-    required: true
-    description: Current status of the order (e.g., Pending, Processing, Shipped, Delivered, Cancelled)
-    enum: ['Pending', 'Processing', 'Shipped', 'Delivered', 'Cancelled']
-  - name: orderItems
-    type: array
-    items:
-      type: OrderItem # Assuming an OrderItem entity exists
-    required: true
-    references: OrderItem
-    referencesIdentifier: orderItemId
-    relationType: hasMany
-    description: List of items included in the order
-  - name: totalAmount
-    type: decimal
-    required: true
-    description: Total monetary value of the order
-  - name: shippingAddress
-    type: Address
-    required: true
-    description: Address where the order should be shipped
-    references: Address
-    referencesIdentifier: addressId
-    relationType: hasOne
-  - name: billingAddress
-    type: Address
-    required: true
-    description: Address for billing purposes
-    references: Address
-    referencesIdentifier: addressId
-    relationType: hasOne
-  - name: payment
-    type: Payment
-    required: false
-    description: Payment associated with this order
-    references: Payment
-    referencesIdentifier: orderId
-    relationType: hasOne
-  - name: convertedFromCartId
-    type: UUID
-    required: false
-    description: Shopping cart that was converted to this order
-    references: ShoppingCart
-    referencesIdentifier: cartId
-    relationType: hasOne
----
-
-## Overview
-
-The Order entity captures all details related to a customer's purchase request. It serves as the central aggregate root within the Orders domain, coordinating information about the customer, products ordered, payment, and shipping.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Customer:** Each order belongs to one `Customer` (identified by `customerId`).
-- **OrderItem:** An order contains one or more `OrderItem` entities detailing the specific products and quantities.
-- **Address:** Each order has shipping and billing `Address` entities (identified by `shippingAddress` and `billingAddress`).
-- **Payment:** An order is associated with one `Payment` entity for transaction processing.
-- **ShoppingCart:** An order can be converted from a `ShoppingCart` (identified by `convertedFromCartId`).
-- **Shipment:** An order may lead to one or more `Shipment` entities (not detailed here).
-
-## Examples
-
-- **Order #12345:** A customer orders 2 units of Product A and 1 unit of Product B, to be shipped to their home address. Status is 'Processing'.
-- **Order #67890:** A customer places a large order for multiple items, requiring special shipping arrangements. Status is 'Pending' until payment confirmation.