@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

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

@@ -3,23 +3,24 @@ id: payments.{env}.events
 name: Payment Events Channel
 version: 1.0.0
 summary: |
- All events contain payment ID for traceability and ordered processing.
+  All events contain payment ID for traceability and ordered processing.
 owners:
- - dboyne
+  - dboyne
 address: payments.{env}.events
-protocols: 
- - kafka
+protocols:
+  - kafka
 
 parameters:
- env:
-   enum:
-     - dev
-     - sit
-     - prod
-   description: 'Environment to use for payment events'
+  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 />
@@ -49,7 +50,7 @@ payment_event = {
    "timestamp": datetime.utcnow().isoformat(),
    "version": "1.0",
    "payload": {
-       "paymentId": "PAY-123-456", 
+       "paymentId": "PAY-123-456",
        "orderId": "ORD-789",
        "amount": {
            "value": 99.99,
@@ -71,7 +72,7 @@ payment_event = {
    },
    "metadata": {
        "correlationId": "corr-123-abc",
-       "merchantId": "MERCH-456", 
+       "merchantId": "MERCH-456",
        "source": "payment_service",
        "environment": "prod",
        "idempotencyKey": "PAY-123-456-2024-11-11-99.99"
@@ -85,4 +86,4 @@ producer.send(
    value=payment_event
 )
 producer.flush()
-```
+```

package/templates/default/domains/E-Commerce/index.mdx

@@ -26,23 +26,24 @@ 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" 
-    />
+  <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
@@ -54,9 +55,18 @@ FlowMart's E-Commerce domain is built on event-driven microservices architecture
 
 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
+- <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
 
 ## Target Architecture (Event Storming Results)
 
@@ -96,11 +106,13 @@ sequenceDiagram
 ## 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} />
@@ -109,11 +121,11 @@ Secure, multi-provider payment processing with fraud detection:
 
 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" 
+<ResourceGroupTable
+  id="related-resources"
+  limit={7}
+  showOwners={true}
+  description="Essential services powering our e-commerce platform"
 />
 
 ## Performance SLAs

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

@@ -2,7 +2,7 @@
 dictionary:
   - id: Marketplace
     name: Marketplace
-    summary: "The digital platform where buyers and sellers interact to browse, purchase, and sell goods."
+    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:
 
@@ -13,7 +13,7 @@ dictionary:
     icon: Store
   - id: Checkout
     name: Checkout
-    summary: "The process by which a customer finalizes a purchase, providing payment and shipping details."
+    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:
 
@@ -26,7 +26,7 @@ dictionary:
     icon: ShoppingCart
   - id: Cart
     name: Cart
-    summary: "A temporary collection of items a customer intends to purchase."
+    summary: 'A temporary collection of items a customer intends to purchase.'
     description: |
       The shopping cart holds selected products before checkout. Key behaviors include:
 
@@ -39,11 +39,11 @@ dictionary:
     icon: ShoppingBag
   - id: Catalog
     name: Catalog
-    summary: "The complete collection of products available for sale on the marketplace."
+    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."
+    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:
 
@@ -56,11 +56,11 @@ dictionary:
     icon: User
   - id: Storefront
     name: Storefront
-    summary: "The customer-facing presentation layer of the marketplace, including product pages, navigation, and branding."
+    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."
+    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:
 
@@ -74,7 +74,7 @@ dictionary:
     icon: Percent
   - id: Conversion
     name: Conversion
-    summary: "The completion of a desired customer action, most commonly a purchase."
+    summary: 'The completion of a desired customer action, most commonly a purchase.'
     icon: TrendingUp
   - id: Fulfillment
     name: Fulfillment
@@ -82,6 +82,6 @@ dictionary:
     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."
+    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

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

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

@@ -94,30 +94,31 @@ properties:
 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`).
+- **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)
+- **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.
+- **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
+- 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

@@ -45,15 +45,15 @@ properties:
 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.
+- **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.
-
+- **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

@@ -80,19 +80,19 @@ properties:
 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).
+- **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.
-
+- **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

@@ -24,7 +24,7 @@ properties:
     description: Identifier for the product being ordered
     references: Product
     referencesIdentifier: productId
-    relationType: hasOne 
+    relationType: hasOne
   - name: productName
     type: string
     required: false # Often denormalized for performance/display
@@ -48,14 +48,15 @@ properties:
 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`).
+- **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
+- **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

@@ -115,14 +115,15 @@ properties:
 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`).
+- **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
 
@@ -134,17 +135,17 @@ 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.
+- **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
+- 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

@@ -39,8 +39,6 @@ resourceGroups:
 
 import Footer from '@catalog/components/footer.astro';
 
-
-
 :::warning
 
 Please ensure all services are **updated** to the latest version for compatibility and performance improvements.
@@ -48,9 +46,19 @@ Please ensure all services are **updated** to the latest version for compatibili
 
 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>
+  <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
@@ -63,7 +71,6 @@ A visualization of the entities in the Orders domain. Here you can see the relat
 
 <EntityMap id="Orders" />
 
-
 <MessageTable format="all" limit={4} showChannels={true} title="Messages in/out of the domain" />
 
 ### Order example (sequence diagram)
@@ -88,15 +95,23 @@ sequenceDiagram
 ## 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" />
+<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

@@ -4,4 +4,4 @@ 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.
+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/commands/AddInventory/index.mdx

@@ -25,7 +25,7 @@ The AddInventory command is issued to add new stock to the inventory. This comma
 
 ## Architecture diagram
 
-<NodeGraph/>
+<NodeGraph />
 
 ## Payload example
 
@@ -36,13 +36,10 @@ The AddInventory command is issued to add new stock to the inventory. This comma
   "warehouseId": "456e7891-c23d-45f6-b78a-123456789abc",
   "timestamp": "2024-07-04T14:48:00Z"
 }
-
 ```
 
 ## Schema
 
-<Schema file="schema.json"/>
+<Schema file="schema.json" />
 
 <Footer />
-
-

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

@@ -1,29 +1,28 @@
 {
-    "$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."
-      }
+  "$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."
     },
-    "required": ["productId", "quantity", "warehouseId", "timestamp"],
-    "additionalProperties": false
-  }
-  
+    "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

@@ -5,15 +5,15 @@ version: 0.0.1
 summary: |
   Command that will place an order
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
+  - dboyne
+  - msmith
+  - asmith
+  - full-stack
+  - mobile-devs
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: 'schema.json'
 ---
 
@@ -25,12 +25,10 @@ The Order Placement Command is a versatile and robust system designed to streaml
 
 ## Architecture diagram
 
-<NodeGraph/>
+<NodeGraph />
 
 ## Schema
 
-<SchemaViewer file="schema.json"/>
+<SchemaViewer file="schema.json" />
 
 <Footer />
-
-

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

@@ -42,6 +42,6 @@ The UpdateInventory command is issued to update the existing stock levels of a p
 
 ## Schema (JSON schema)
 
-<Schema file="schema.json"/>
+<Schema file="schema.json" />
 
 <Footer />