@eventcatalog/create-eventcatalog 4.1.2 → 4.2.0-beta.0

package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   POST request that will update the status of a shipment, identified by its shipmentId.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This command can be applied in e-commerce systems, marketplaces, or any platform
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/schema.json

@@ -1,29 +1,29 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "UpdateShipmentStatus",
-    "description": "Schema for updating a shipment's status",
-    "properties": {
-        "UpdateShipmentStatus": {
-            "type": "object",
-            "properties": {
-                "shipmentId": {
-                    "type": "string",
-                    "description": "Unique identifier for the shipment"
-                },
-                "status": {
-                    "type": "string",
-                    "enum": ["pending", "shipped", "delivered", "returned"],
-                    "description": "Current status of the shipment"
-                },
-                "updatedAt": {
-                    "type": "string",
-                    "format": "date-time",
-                    "description": "Timestamp when the status was last updated"
-                }
-            },
-            "required": ["shipmentId", "status"]
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "UpdateShipmentStatus",
+  "description": "Schema for updating a shipment's status",
+  "properties": {
+    "UpdateShipmentStatus": {
+      "type": "object",
+      "properties": {
+        "shipmentId": {
+          "type": "string",
+          "description": "Unique identifier for the shipment"
+        },
+        "status": {
+          "type": "string",
+          "enum": ["pending", "shipped", "delivered", "returned"],
+          "description": "Current status of the shipment"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Timestamp when the status was last updated"
         }
-    },
-    "required": ["UpdateShipmentStatus"]
+      },
+      "required": ["shipmentId", "status"]
+    }
+  },
+  "required": ["UpdateShipmentStatus"]
 }

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   Event that is emitted when a shipment delivery fails.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This event can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/schema.json

@@ -1,17 +1,17 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "DeliveryFailed",
-    "description": "Schema for delivery failed event",
-    "properties": {
-        "shipmentId": {
-            "type": "string",
-            "description": "Unique identifier for the shipment"
-        },
-        "orderId": {
-            "type": "string",
-            "description": "Identifier for the associated order"
-        }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "DeliveryFailed",
+  "description": "Schema for delivery failed event",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
     },
-    "required": ["shipmentId", "orderId"]
-}
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    }
+  },
+  "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   Event that is emitted when a return is initiated.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This event can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/schema.json

@@ -1,17 +1,17 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "ReturnInitiated",
-    "description": "Schema for return initiated event",
-    "properties": {
-        "shipmentId": {
-            "type": "string",
-            "description": "Unique identifier for the shipment"
-        },
-        "orderId": {
-            "type": "string",
-            "description": "Identifier for the associated order"
-        }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "ReturnInitiated",
+  "description": "Schema for return initiated event",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
     },
-    "required": ["shipmentId", "orderId"]
-}
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    }
+  },
+  "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   Event that is emitted when a shipment is created.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This event can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/schema.json

@@ -62,4 +62,3 @@
   },
   "required": ["shipmentId", "orderId", "address", "items", "shippingMethod"]
 }
-

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   Event that is emitted when a shipment is delivered.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This event can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/schema.json

@@ -1,17 +1,17 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "ShipmentDelivered",
-    "description": "Schema for shipment delivered event",
-    "properties": {
-        "shipmentId": {
-            "type": "string",
-            "description": "Unique identifier for the shipment"
-        },
-        "orderId": {
-            "type": "string",
-            "description": "Identifier for the associated order"
-        }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "ShipmentDelivered",
+  "description": "Schema for shipment delivered event",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
     },
-    "required": ["shipmentId", "orderId"]
-}
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    }
+  },
+  "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   Event that is emitted when a shipment is dispatched.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This event can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/schema.json

@@ -1,17 +1,17 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "ShipmentDispatched",
-    "description": "Schema for shipment dispatched event",
-    "properties": {
-        "shipmentId": {
-            "type": "string",
-            "description": "Unique identifier for the shipment"
-        },
-        "orderId": {
-            "type": "string",
-            "description": "Identifier for the associated order"
-        }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "ShipmentDispatched",
+  "description": "Schema for shipment dispatched event",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
     },
-    "required": ["shipmentId", "orderId"]
-}
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    }
+  },
+  "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   Event that is emitted when a shipment is in transit.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This event can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/schema.json

@@ -1,17 +1,17 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "ShipmentInTransit",
-    "description": "Schema for shipment in transit event",
-    "properties": {
-        "shipmentId": {
-            "type": "string",
-            "description": "Unique identifier for the shipment"
-        },
-        "orderId": {
-            "type": "string",
-            "description": "Identifier for the associated order"
-        }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "ShipmentInTransit",
+  "description": "Schema for shipment in transit event",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
     },
-    "required": ["shipmentId", "orderId"]
-}
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    }
+  },
+  "required": ["shipmentId", "orderId"]
+}

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

@@ -33,17 +33,26 @@ import Footer from '@catalog/components/footer.astro';
 
 The Shipping Service is responsible for managing shipping within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
 
-<Tiles >
-    <Tile icon="BoltIcon" href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Sends ${frontmatter.sends.length} messages`} description="This service sends messages to downstream consumers" />
-    <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
+<Tiles>
+  <Tile
+    icon="BoltIcon"
+    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
+    title={`Sends ${frontmatter.sends.length} messages`}
+    description="This service sends messages to downstream consumers"
+  />
+  <Tile
+    icon="BoltIcon"
+    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
+    title={`Receives ${frontmatter.receives.length} messages`}
+    description="This service receives messages from other services"
+  />
 </Tiles>
 
 ### Core features
 
 The Shipping Service is responsible for managing shipping within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
 
-
-## Architecture diagram 
+## Architecture diagram
 
 <NodeGraph />
 

package/templates/default/domains/Orders/ubiquitous-language.mdx

@@ -2,11 +2,11 @@
 dictionary:
   - id: Payment
     name: Payment
-    summary: "The act of paying for magical goods or services."
+    summary: 'The act of paying for magical goods or services.'
     icon: Wand2
   - id: Purchase Order
     name: Purchase Order
-    summary: "A mystical document issued by a buyer to a seller indicating the types, quantities, and agreed prices for enchanted products or services."
+    summary: 'A mystical document issued by a buyer to a seller indicating the types, quantities, and agreed prices for enchanted products or services.'
     description: |
       A purchase order (PO) is a magical document that initiates the buying process between mystical entities. It protects both buyer and seller by clearly documenting the transaction details. Key components include:
 
@@ -20,7 +20,7 @@ dictionary:
     icon: FileText
   - id: Order Line
     name: Order Line
-    summary: "An individual enchanted item within a purchase order, representing a specific magical product or service being ordered."
+    summary: 'An individual enchanted item within a purchase order, representing a specific magical product or service being ordered.'
     description: |
       Order lines are the fundamental building blocks of any purchase order. Each line represents a distinct item or service and contains critical information for order fulfillment:
 
@@ -34,7 +34,7 @@ dictionary:
     icon: ListOrdered
   - id: SKU
     name: SKU
-    summary: "Sorcery Keeping Unit - A unique identifier for distinct magical products and their variants in inventory."
+    summary: 'Sorcery Keeping Unit - A unique identifier for distinct magical products and their variants in inventory.'
     description: |
       SKUs are the cornerstone of effective inventory management systems. Each SKU represents a unique combination of product attributes:
 
@@ -47,7 +47,7 @@ dictionary:
     icon: Tag
   - id: Consignment
     name: Consignment
-    summary: "A batch of enchanted goods destined for or delivered to someone."
+    summary: 'A batch of enchanted goods destined for or delivered to someone.'
     description: |
       A consignment represents the physical movement of goods through the supply chain. It encompasses all aspects of the shipping process:
 
@@ -60,7 +60,7 @@ dictionary:
     icon: Package
   - id: Invoice
     name: Invoice
-    summary: "A document issued by a seller to a buyer, listing enchanted goods or services provided and the amount due."
+    summary: 'A document issued by a seller to a buyer, listing enchanted goods or services provided and the amount due.'
     description: |
       Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
 
@@ -74,7 +74,7 @@ dictionary:
     icon: Receipt
   - id: Supplier
     name: Supplier
-    summary: "An entity that provides enchanted goods or services to another organization."
+    summary: 'An entity that provides enchanted goods or services to another organization.'
     description: |
       Suppliers are key partners in the supply chain, responsible for delivering the necessary products or services. Key aspects include:
 
@@ -87,7 +87,7 @@ dictionary:
     icon: Truck
   - id: Inventory
     name: Inventory
-    summary: "The complete list of enchanted items held in stock by a business."
+    summary: 'The complete list of enchanted items held in stock by a business.'
     description: |
       Inventory management is crucial for balancing supply and demand. It involves:
 
@@ -100,7 +100,7 @@ dictionary:
     icon: Warehouse
   - id: Fulfillment
     name: Fulfillment
-    summary: "The process of completing an order and delivering it to the customer."
+    summary: 'The process of completing an order and delivering it to the customer.'
     description: |
       Fulfillment encompasses all steps from order receipt to delivery, including:
 
@@ -113,7 +113,7 @@ dictionary:
     icon: PackageCheck
   - id: Return
     name: Return
-    summary: "The process of sending back enchanted goods to the seller for a refund or exchange."
+    summary: 'The process of sending back enchanted goods to the seller for a refund or exchange.'
     description: |
       Returns management is an important aspect of customer service and inventory control. It involves:
 

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

@@ -5,15 +5,15 @@ version: 0.0.1
 summary: |
   Domain for everything shopping
 owners:
-    - dboyne
-    - full-stack
+  - dboyne
+  - full-stack
 services:
-    - id: InventoryService
-      version: 0.0.2
+  - id: InventoryService
+    version: 0.0.2
 badges:
-    - content: New domain
-      backgroundColor: blue
-      textColor: blue
+  - content: New domain
+    backgroundColor: blue
+    textColor: blue
 ---
 
 ## Overview

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

@@ -22,7 +22,9 @@ badges:
 
 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>
+<Admonition type="warning">
+  Please ensure all services are updated to the latest version for compatibility and performance improvements.
+</Admonition>
 
 ## Bounded context
 
@@ -46,5 +48,3 @@ sequenceDiagram
     OrdersService->>Customer: Order Placed Successfully
     OrdersService->>InventoryService: Update Inventory
 ```
-
- 

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

@@ -133,32 +133,33 @@ properties:
 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.
+- **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
+- **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.
+- **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
+- 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

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

@@ -75,17 +75,18 @@ properties:
 The Invoice entity represents a formal request for payment issued by the business to a customer. It details the products, services, quantities, prices, taxes, and total amount due, along with payment terms.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-*   **Customer:** An invoice is issued to one `Customer`.
-*   **Order/Subscription:** An invoice may be related to one or more `Order`s or a specific `Subscription` period.
-*   **Payment:** An invoice is settled by one or more `Payment` transactions.
-*   **InvoiceLineItem:** An invoice contains multiple `InvoiceLineItem`s detailing the charges.
-*   **BillingProfile:** Invoice generation often uses details from the customer's `BillingProfile`.
+- **Customer:** An invoice is issued to one `Customer`.
+- **Order/Subscription:** An invoice may be related to one or more `Order`s or a specific `Subscription` period.
+- **Payment:** An invoice is settled by one or more `Payment` transactions.
+- **InvoiceLineItem:** An invoice contains multiple `InvoiceLineItem`s detailing the charges.
+- **BillingProfile:** Invoice generation often uses details from the customer's `BillingProfile`.
 
 ## Examples
 
-*   Invoice #INV-00123 issued to Jane Doe for her monthly subscription renewal, due in 15 days.
-*   Invoice #INV-00124 issued to Acme Corp for consulting services rendered in the previous month, status Paid. 
+- Invoice #INV-00123 issued to Jane Doe for her monthly subscription renewal, due in 15 days.
+- Invoice #INV-00124 issued to Acme Corp for consulting services rendered in the previous month, status Paid.

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

@@ -105,14 +105,15 @@ properties:
 The Payment entity manages all payment transactions in the e-commerce system. It tracks payment details, status, and relationships with orders and customers, supporting various payment methods and refund scenarios.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-* **Order:** Each payment belongs to one `Order` (identified by `orderId`).
-* **Customer:** Each payment is made by one `Customer` (identified by `customerId`).
-* **Address:** Each payment has a billing `Address` (identified by `billingAddress`).
-* **PaymentRefund:** A payment can have multiple `PaymentRefund` entities for partial or full refunds.
+- **Order:** Each payment belongs to one `Order` (identified by `orderId`).
+- **Customer:** Each payment is made by one `Customer` (identified by `customerId`).
+- **Address:** Each payment has a billing `Address` (identified by `billingAddress`).
+- **PaymentRefund:** A payment can have multiple `PaymentRefund` entities for partial or full refunds.
 
 ## Payment States
 
@@ -124,16 +125,16 @@ cancelled  failed    refunded/partially_refunded
 
 ## Examples
 
-* **Payment #1:** $299.99 credit card payment for Order #12345, completed successfully.
-* **Payment #2:** $150.00 PayPal payment for Order #67890, failed due to insufficient funds.
-* **Payment #3:** $500.00 bank transfer, completed with $50.00 partial refund.
+- **Payment #1:** $299.99 credit card payment for Order #12345, completed successfully.
+- **Payment #2:** $150.00 PayPal payment for Order #67890, failed due to insufficient funds.
+- **Payment #3:** $500.00 bank transfer, completed with $50.00 partial refund.
 
 ## Business Rules
 
-* Payment amount must match the order total
-* Payment status transitions must follow valid state machine
-* Failed payments should include failure reason
-* Completed payments cannot be cancelled
-* Refunds cannot exceed the original payment amount
-* Payment method details are encrypted and PCI compliant
-* Transaction IDs from payment gateways must be stored for reconciliation
+- Payment amount must match the order total
+- Payment status transitions must follow valid state machine
+- Failed payments should include failure reason
+- Completed payments cannot be cancelled
+- Refunds cannot exceed the original payment amount
+- Payment method details are encrypted and PCI compliant
+- Transaction IDs from payment gateways must be stored for reconciliation