@eventcatalog/create-eventcatalog 3.0.10 → 3.0.11

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: "3.0.10",
+  version: "3.0.11",
   bin: {
     "create-catalog": "./dist/index.js"
   },

package/package.json

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

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

@@ -0,0 +1,121 @@
+---
+id: CartItem
+name: CartItem
+version: 1.0.0
+identifier: cartItemId
+summary: Represents an individual item within a shopping cart.
+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

@@ -0,0 +1,57 @@
+---
+id: Customer
+name: Customer
+version: 1.0.0
+identifier: customerId
+summary: Represents an individual or organization that places orders.
+
+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

@@ -0,0 +1,96 @@
+---
+id: Order
+name: Order
+version: 1.0.0
+identifier: orderId
+aggregateRoot: true
+summary: Represents a customer's request to purchase products or services.
+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.
+

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

@@ -0,0 +1,59 @@
+---
+id: OrderItem
+name: OrderItem
+version: 1.0.0
+identifier: orderItemId
+summary: Represents a single item within a customer's order.
+
+properties:
+  - name: orderItemId
+    type: UUID
+    required: true
+    description: Unique identifier for the order item
+  - name: orderId
+    type: UUID
+    required: true
+    description: Identifier for the parent Order
+    references: Order
+    relationType: hasOne
+  - name: productId
+    type: UUID
+    required: true
+    description: Identifier for the product being ordered
+    references: Product
+    referencesIdentifier: productId
+    relationType: hasOne 
+  - name: productName
+    type: string
+    required: false # Often denormalized for performance/display
+    description: Name of the product at the time of order
+  - name: quantity
+    type: integer
+    required: true
+    description: Number of units of the product ordered
+  - name: unitPrice
+    type: decimal
+    required: true
+    description: Price per unit of the product at the time of order
+  - name: totalPrice
+    type: decimal
+    required: true
+    description: Total price for this item line (quantity * unitPrice)
+---
+
+## Overview
+
+The OrderItem entity details a specific product and its quantity requested within an `Order`. It holds information about the product, the quantity ordered, and the price calculation for that line item. OrderItems are part of the `Order` aggregate.
+
+### Entity Properties
+<EntityPropertiesTable />
+
+## Relationships
+
+*   **Order:** Each `OrderItem` belongs to exactly one `Order` (identified by `orderId`). It is a constituent part of the Order aggregate.
+*   **Product:** Each `OrderItem` refers to one `Product` (identified by `productId`).
+
+## Examples
+
+*   **OrderItem A (for Order #12345):** Product ID: P001, Quantity: 2, Unit Price: $50.00, Total Price: $100.00
+*   **OrderItem B (for Order #12345):** Product ID: P002, Quantity: 1, Unit Price: $75.00, Total Price: $75.00

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

@@ -0,0 +1,148 @@
+---
+id: ShoppingCart
+name: ShoppingCart
+version: 1.0.0
+identifier: cartId
+aggregateRoot: true
+summary: Represents a customer's shopping cart containing products before checkout.
+properties:
+  - name: cartId
+    type: UUID
+    required: true
+    description: Unique identifier for the shopping cart
+  - name: customerId
+    type: UUID
+    required: false
+    description: Customer who owns this cart (null for guest carts)
+    references: Customer
+    referencesIdentifier: customerId
+    relationType: hasOne
+  - name: sessionId
+    type: string
+    required: false
+    description: Session identifier for guest carts
+  - name: status
+    type: string
+    required: true
+    description: Current status of the cart
+    enum: ['active', 'abandoned', 'converted', 'expired']
+  - name: cartItems
+    type: array
+    items:
+      type: CartItem
+    required: false
+    description: Items in the shopping cart
+    references: CartItem
+    referencesIdentifier: cartId
+    relationType: hasMany
+  - name: subtotal
+    type: decimal
+    required: true
+    description: Subtotal amount before taxes and shipping
+  - name: taxAmount
+    type: decimal
+    required: false
+    description: Calculated tax amount
+  - name: shippingAmount
+    type: decimal
+    required: false
+    description: Calculated shipping amount
+  - name: discountAmount
+    type: decimal
+    required: false
+    description: Total discount amount applied
+  - name: totalAmount
+    type: decimal
+    required: true
+    description: Final total amount including taxes and shipping
+  - name: currency
+    type: string
+    required: true
+    description: Currency code for all amounts
+  - name: appliedCoupons
+    type: array
+    items:
+      type: string
+    required: false
+    description: Coupon codes applied to this cart
+  - name: shippingAddress
+    type: Address
+    required: false
+    description: Selected shipping address
+    references: Address
+    referencesIdentifier: addressId
+    relationType: hasOne
+  - name: billingAddress
+    type: Address
+    required: false
+    description: Selected billing address
+    references: Address
+    referencesIdentifier: addressId
+    relationType: hasOne
+  - name: notes
+    type: string
+    required: false
+    description: Customer notes or special instructions
+  - name: abandonedAt
+    type: DateTime
+    required: false
+    description: Date and time when cart was abandoned
+  - name: convertedToOrderId
+    type: UUID
+    required: false
+    description: Order ID if cart was successfully converted
+    references: Order
+    referencesIdentifier: orderId
+    relationType: hasOne
+  - name: expiresAt
+    type: DateTime
+    required: false
+    description: Date and time when cart expires
+  - name: createdAt
+    type: DateTime
+    required: true
+    description: Date and time when the cart was created
+  - name: updatedAt
+    type: DateTime
+    required: false
+    description: Date and time when the cart was last updated
+---
+
+## Overview
+
+The ShoppingCart entity manages the customer's shopping experience before checkout. It tracks selected products, quantities, pricing, and supports both registered customer and guest shopping scenarios.
+
+### Entity Properties
+<EntityPropertiesTable />
+
+## Relationships
+
+* **Customer:** A cart can belong to one `Customer` (identified by `customerId`).
+* **CartItem:** A cart contains multiple `CartItem` entities with product details.
+* **Address:** A cart can reference shipping and billing `Address` entities.
+* **Order:** A cart can be converted to one `Order` (identified by `convertedToOrderId`).
+
+## Cart States
+
+```
+active → abandoned
+   ↓       ↓
+converted  expired
+```
+
+## Examples
+
+* **Cart #1:** Customer cart with 3 items, $299.99 total, active status.
+* **Cart #2:** Guest cart abandoned after 24 hours, contains 1 high-value item.
+* **Cart #3:** Converted cart that became Order #12345, marked as converted.
+
+## Business Rules
+
+* Guest carts are identified by session ID when customer ID is null
+* Cart totals are recalculated when items are added/removed
+* Abandoned carts trigger marketing automation after configured time
+* Expired carts are cleaned up after retention period
+* Cart conversion creates an order and marks cart as converted
+* Inventory is not reserved until checkout begins
+* Applied coupons are validated on each cart update
+* Cart items maintain snapshot of product prices at time of addition

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

@@ -10,6 +10,12 @@ services:
   - id: OrdersService
   - id: NotificationService
   - id: ShippingService
+entities:
+  - id: Order
+  - id: OrderItem
+  - id: Customer
+  - id: ShoppingCart
+  - id: CartItem
 badges:
   - content: Subdomain
     backgroundColor: blue
@@ -50,6 +56,13 @@ The Orders domain handles all operations related to customer orders, from creati
 
 <NodeGraph />
 
+### Entity Map
+
+A visualization of the entities in the Orders domain. Here you can see the relationships between the entities and how they are used in the domain.
+
+<EntityMap id="Orders" />
+
+
 <MessageTable format="all" limit={4} showChannels={true} title="Messages in/out of the domain" />
 
 ### Order example (sequence diagram)

package/templates/default/domains/Payment/entities/Address/index.mdx

@@ -0,0 +1,162 @@
+---
+id: Address
+name: Address
+version: 1.0.0
+identifier: addressId
+summary: Represents shipping and billing addresses for customers and orders.
+properties:
+  - name: addressId
+    type: UUID
+    required: true
+    description: Unique identifier for the address
+  - name: customerId
+    type: UUID
+    required: false
+    description: Customer this address belongs to
+    references: Customer
+    referencesIdentifier: customerId
+    relationType: hasOne
+  - name: type
+    type: string
+    required: true
+    description: Type of address
+    enum: ['billing', 'shipping', 'both']
+  - name: firstName
+    type: string
+    required: true
+    description: First name of the recipient
+  - name: lastName
+    type: string
+    required: true
+    description: Last name of the recipient
+  - name: company
+    type: string
+    required: false
+    description: Company name if applicable
+  - name: addressLine1
+    type: string
+    required: true
+    description: Primary address line (street address)
+  - name: addressLine2
+    type: string
+    required: false
+    description: Secondary address line (apartment, suite, etc.)
+  - name: city
+    type: string
+    required: true
+    description: City name
+  - name: state
+    type: string
+    required: true
+    description: State or province
+  - name: postalCode
+    type: string
+    required: true
+    description: Postal or ZIP code
+  - name: country
+    type: string
+    required: true
+    description: Country code (ISO 3166-1 alpha-2)
+  - name: phone
+    type: string
+    required: false
+    description: Phone number for delivery contact
+  - name: isDefault
+    type: boolean
+    required: true
+    description: Whether this is the default address for the customer
+  - name: isValidated
+    type: boolean
+    required: true
+    description: Whether the address has been validated
+  - name: validationDetails
+    type: object
+    required: false
+    description: Address validation details
+    properties:
+      - name: validatedAt
+        type: DateTime
+        description: When the address was validated
+      - name: validationService
+        type: string
+        description: Service used for validation
+      - name: confidence
+        type: decimal
+        description: Validation confidence score
+  - name: geocoordinates
+    type: object
+    required: false
+    description: Geographic coordinates for the address
+    properties:
+      - name: latitude
+        type: decimal
+        description: Latitude coordinate
+      - name: longitude
+        type: decimal
+        description: Longitude coordinate
+  - name: deliveryInstructions
+    type: string
+    required: false
+    description: Special delivery instructions
+  - name: orders
+    type: array
+    items:
+      type: Order
+    required: false
+    description: Orders using this address
+    references: Order
+    referencesIdentifier: shippingAddress
+    relationType: hasMany
+  - name: payments
+    type: array
+    items:
+      type: Payment
+    required: false
+    description: Payments using this as billing address
+    references: Payment
+    referencesIdentifier: billingAddress
+    relationType: hasMany
+  - name: createdAt
+    type: DateTime
+    required: true
+    description: Date and time when the address was created
+  - name: updatedAt
+    type: DateTime
+    required: false
+    description: Date and time when the address was last updated
+---
+
+## Overview
+
+The Address entity stores shipping and billing addresses for customers, orders, and payments. It supports address validation, geocoding, and delivery instructions to ensure accurate order fulfillment.
+
+### Entity Properties
+<EntityPropertiesTable />
+
+## Relationships
+
+* **Customer:** An address can belong to one `Customer` (identified by `customerId`).
+* **Order:** An address can be used by multiple `Order` entities for shipping.
+* **Payment:** An address can be used by multiple `Payment` entities for billing.
+
+## Address Types
+
+* **Billing:** Used for payment processing and invoicing
+* **Shipping:** Used for order delivery
+* **Both:** Can be used for both billing and shipping
+
+## Examples
+
+* **Address #1:** John Doe's home address - default shipping and billing address.
+* **Address #2:** Corporate office address - billing only, validated with high confidence.
+* **Address #3:** Gift recipient address - shipping only, with special delivery instructions.
+
+## Business Rules
+
+* Each customer can have only one default address per type
+* Addresses must be validated before being marked as default
+* International addresses require country-specific validation
+* Geocoordinates are automatically populated when available
+* Address changes should create new versions for audit trail
+* PO Box addresses may have shipping restrictions
+* Address validation improves delivery success rates