@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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

@@ -1,62 +0,0 @@
----
-id: OrderItem
-name: OrderItem
-version: 1.0.0
-identifier: orderItemId
-summary: Represents a single item within a customer's order.
-owners:
-  - dboyne
-
-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

@@ -1,151 +0,0 @@
----
-id: ShoppingCart
-name: ShoppingCart
-version: 1.0.0
-identifier: cartId
-aggregateRoot: true
-summary: Represents a customer's shopping cart containing products before checkout.
-owners:
-  - dboyne
-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

@@ -1,117 +0,0 @@
----
-id: Orders
-name: Orders
-summary: Handles all operations related to customer orders, from creation to fulfillment
-version: 0.0.3
-owners:
-  - dboyne
-  - full-stack
-services:
-  - id: InventoryService
-  - id: OrdersService
-  - id: NotificationService
-  - id: ShippingService
-entities:
-  - id: Order
-  - id: OrderItem
-  - id: Customer
-  - id: ShoppingCart
-  - id: CartItem
-badges:
-  - content: Subdomain
-    backgroundColor: blue
-    textColor: blue
-    icon: RectangleGroupIcon
-
-resourceGroups:
-  - id: related-resources
-    title: Core resources
-    items:
-      - id: InventoryService
-        type: service
-      - id: OrdersService
-        type: service
-      - id: NotificationService
-        type: service
-      - id: ShippingService
-        type: service
----
-
-import Footer from '@catalog/components/footer.astro';
-
-:::warning
-
-Please ensure all services are **updated** to the latest version for compatibility and performance improvements.
-:::
-
-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
-
-<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`}
-    description="This domain contains the following services."
-  />
-</Tiles>
-
-### Architecture for the Orders domain
-
-<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)
-
-```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
-```
-
-## Flows
-
-### Cancel Subscription flow
-
-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} />
-
-<ResourceGroupTable
-  id="related-resources"
-  limit={4}
-  showOwners={true}
-  title="Core resources for the Orders domain"
-  description="Resources that are related to the Orders domain, you may find them useful"
-/>
-
-<Footer />

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

@@ -1,7 +0,0 @@
----
-createdAt: 2024-08-01
----
-
-### Service receives additional events
-
-Service now receives [OrderAmended](/docs/events/OrderAmended/0.0.1) and [UpdateInventory](/docs/commands/UpdateInventory/0.0.3) events.

package/templates/default/domains/Orders/services/InventoryService/channels/inventory-dlq/index.mdx

@@ -1,13 +0,0 @@
----
-id: inventory-dlq
-name: Inventory DLQ
-version: 0.0.1
-summary: |
-  Dead Letter Queue for inventory events
-owners:
-  - dboyne
----
-
-## Overview
-
-The Inventory DLQ is a dead letter queue for inventory events. It is used to store inventory events that are not yet processed.

package/templates/default/domains/Orders/services/InventoryService/channels/inventory-queue/index.mdx

@@ -1,13 +0,0 @@
----
-id: inventory-queue
-name: Inventory Queue
-version: 0.0.1
-summary: |
-  Queue for inventory events
-owners:
-  - dboyne
----
-
-## Overview
-
-The Inventory Queue is a queue for inventory events. It is used to store inventory events that are not yet processed.

package/templates/default/domains/Orders/services/InventoryService/commands/AddInventory/index.mdx

@@ -1,45 +0,0 @@
----
-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
----
-
-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.
-
-## 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" />
-
-<Footer />

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

@@ -1,28 +0,0 @@
-{
-  "$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/domains/Orders/services/InventoryService/commands/PlaceOrder/index.mdx

@@ -1,34 +0,0 @@
----
-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

@@ -1,124 +0,0 @@
-{
-  "$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/domains/Orders/services/InventoryService/commands/UpdateInventory/index.mdx

@@ -1,47 +0,0 @@
----
-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
----
-
-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.
-
-## Architecture diagram
-
-<NodeGraph />
-
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
-
-## 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" />
-
-<Footer />

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

@@ -1,28 +0,0 @@
-{
-  "$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
-}