@eventcatalog/create-eventcatalog 4.3.2 → 4.3.4-beta.0

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

@@ -1,61 +0,0 @@
----
-id: ShippingService
-version: 0.0.1
-name: Shipping Service
-summary: |
-  Service that handles shipping
-owners:
-  - dboyne
-receives:
-  - id: PaymentProcessed
-    from:
-      - id: 'payments.{env}.events'
-        parameters:
-          env: staging
-  - id: CancelShipment
-  - id: CreateShipment
-  - id: UpdateShipmentStatus
-sends:
-  - id: ShipmentCreated
-  - id: ReturnInitiated
-  - id: ShipmentDispatched
-  - id: ShipmentInTransit
-  - id: ShipmentDelivered
-  - id: DeliveryFailed
-repository:
-  language: JavaScript
-  url: 'https://github.com/event-catalog/pretend-shipping-service'
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-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>
-
-### 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
-
-<NodeGraph />
-
-<MessageTable format="all" limit={4} />
-
-<Footer />

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

@@ -1,127 +0,0 @@
----
-dictionary:
-  - id: Payment
-    name: Payment
-    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.'
-    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:
-
-      - Unique PO number for tracking
-      - Detailed item specifications and quantities
-      - Agreed prices and payment terms
-      - Delivery requirements and timelines
-      - Terms and conditions of the purchase
-
-      POs are essential for budget control, audit trails, and inventory management. They help prevent unauthorized purchases and provide a clear record for accounting and reconciliation purposes.
-    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.'
-    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:
-
-      - Product identifier (SKU or part number)
-      - Quantity ordered
-      - Unit price and total line value
-      - Special handling instructions
-      - Required delivery date
-
-      Order lines drive warehouse picking operations, shipping processes, and financial calculations. They are essential for tracking partial shipments and managing order modifications.
-    icon: ListOrdered
-  - id: SKU
-    name: SKU
-    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:
-
-      - Product variations (size, color, style)
-      - Storage location identifiers
-      - Supplier information
-      - Reorder points and quantities
-
-      SKUs enable precise inventory tracking, automated reordering, and detailed sales analytics. They are crucial for maintaining optimal stock levels and preventing stockouts or overstock situations.
-    icon: Tag
-  - id: Consignment
-    name: Consignment
-    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:
-
-      - Packaging and labeling requirements
-      - Transportation method and routing
-      - Customs documentation for international shipments
-      - Tracking and proof of delivery
-
-      Consignments may combine multiple orders for efficient shipping and can be tracked as a single unit throughout the delivery process. They are crucial for managing logistics costs and ensuring timely delivery to customers.
-    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.'
-    description: |
-      Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
-
-      - Invoice number for tracking
-      - List of products or services provided
-      - Total amount due and payment terms
-      - Seller and buyer contact information
-      - Due date for payment
-
-      Invoices are essential for accounting, tax purposes, and maintaining cash flow.
-    icon: Receipt
-  - id: Supplier
-    name: Supplier
-    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:
-
-      - Supplier identification and contact details
-      - Product or service offerings
-      - Pricing and payment terms
-      - Delivery schedules and reliability
-
-      Effective supplier management ensures quality, cost-effectiveness, and timely delivery.
-    icon: Truck
-  - id: Inventory
-    name: Inventory
-    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:
-
-      - Tracking stock levels and locations
-      - Managing reorder points and quantities
-      - Conducting regular stock audits
-      - Analyzing inventory turnover rates
-
-      Proper inventory management minimizes costs and maximizes service levels.
-    icon: Warehouse
-  - id: Fulfillment
-    name: Fulfillment
-    summary: 'The process of completing an order and delivering it to the customer.'
-    description: |
-      Fulfillment encompasses all steps from order receipt to delivery, including:
-
-      - Order processing and picking
-      - Packaging and shipping
-      - Delivery tracking and confirmation
-      - Handling returns and exchanges
-
-      Efficient fulfillment is key to customer satisfaction and operational efficiency.
-    icon: PackageCheck
-  - id: Return
-    name: Return
-    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:
-
-      - Processing return requests and authorizations
-      - Inspecting returned items for quality
-      - Restocking or disposing of returned goods
-      - Issuing refunds or exchanges
-
-      A streamlined returns process enhances customer loyalty and operational efficiency.
-    icon: PackageX
----

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

@@ -1,21 +0,0 @@
----
-id: Orders
-name: Orders
-version: 0.0.1
-summary: |
-  Domain for everything shopping
-owners:
-  - dboyne
-  - full-stack
-services:
-  - id: InventoryService
-    version: 0.0.2
-badges:
-  - content: New domain
-    backgroundColor: blue
-    textColor: blue
----
-
-## Overview
-
-<NodeGraph />

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

@@ -1,50 +0,0 @@
----
-id: Orders
-name: Orders
-summary: Handles all operations related to customer orders, from creation to fulfillment
-version: 0.0.2
-owners:
-  - dboyne
-services:
-  - id: InventoryService
-    version: 0.0.2
-  - id: NotificationService
-    version: 0.0.2
-  - id: OrdersService
-    version: 0.0.2
-badges:
-  - content: New domain
-    backgroundColor: blue
-    textColor: blue
----
-
-## Overview
-
-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>
-
-## Bounded context
-
-<NodeGraph />
-
-### 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
-```

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

@@ -1,165 +0,0 @@
----
-id: Address
-name: Address
-version: 1.0.0
-identifier: addressId
-summary: Represents shipping and billing addresses for customers and orders.
-owners:
-  - dboyne
-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

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

@@ -1,92 +0,0 @@
----
-id: Invoice
-name: Invoice
-version: 1.0.0
-identifier: invoiceId
-summary: Represents a bill issued to a customer, detailing charges for products or services.
-owners:
-  - dboyne
-
-properties:
-  - name: invoiceId
-    type: UUID
-    required: true
-    description: Unique identifier for the invoice.
-  - name: customerId
-    type: UUID
-    required: true
-    description: Identifier of the customer being invoiced
-    references: Customer
-    relationType: hasOne
-  - name: orderId # Optional, if invoice is directly tied to a single order
-    type: UUID
-    required: false
-    description: Identifier of the associated order, if applicable.
-  - name: subscriptionId # Optional, if invoice is for a subscription period
-    type: UUID
-    required: false
-    description: Identifier of the associated subscription, if applicable.
-  - name: invoiceNumber
-    type: string
-    required: true
-    description: Human-readable, sequential identifier for the invoice (may have specific format).
-  - name: issueDate
-    type: Date
-    required: true
-    description: Date the invoice was generated and issued.
-  - name: dueDate
-    type: Date
-    required: true
-    description: Date by which the payment for the invoice is due.
-  - name: totalAmount
-    type: decimal
-    required: true
-    description: The total amount due on the invoice.
-  - name: currency
-    type: string # ISO 4217 code
-    required: true
-    description: Currency of the invoice amount.
-  - name: status
-    type: string # (e.g., Draft, Sent, Paid, Overdue, Void)
-    required: true
-    description: Current status of the invoice.
-  - name: billingAddressId # Address used for this specific invoice
-    type: UUID
-    required: true
-    description: Identifier for the billing address used on this invoice.
-  - name: lineItems
-    type: array
-    items:
-      type: InvoiceLineItem # Assuming a value object or separate entity for line items
-    required: true
-    description: List of individual items or services being charged on the invoice.
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Timestamp when the invoice record was created.
-  - name: paidAt # Timestamp when payment was confirmed
-    type: DateTime
-    required: false
-    description: Timestamp when the invoice was marked as paid.
----
-
-## Overview
-
-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`.
-
-## 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.

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

@@ -1,140 +0,0 @@
----
-id: Payment
-name: Payment
-version: 1.0.0
-identifier: paymentId
-aggregateRoot: true
-summary: Represents payment transactions for orders in the e-commerce system.
-owners:
-  - dboyne
-properties:
-  - name: paymentId
-    type: UUID
-    required: true
-    description: Unique identifier for the payment
-  - name: orderId
-    type: UUID
-    required: true
-    description: Order this payment is associated with
-    references: Order
-    referencesIdentifier: orderId
-    relationType: hasOne
-  - name: customerId
-    type: UUID
-    required: true
-    description: Customer who made the payment
-    references: Customer
-    referencesIdentifier: customerId
-    relationType: hasOne
-  - name: amount
-    type: decimal
-    required: true
-    description: Payment amount
-  - name: currency
-    type: string
-    required: true
-    description: Currency code (e.g., USD, EUR, GBP)
-  - name: paymentMethod
-    type: string
-    required: true
-    description: Payment method used
-    enum: ['credit_card', 'debit_card', 'paypal', 'stripe', 'bank_transfer', 'apple_pay', 'google_pay']
-  - name: paymentMethodDetails
-    type: object
-    required: false
-    description: Additional payment method specific details
-    properties:
-      - name: cardLast4
-        type: string
-        description: Last 4 digits of card number
-      - name: cardType
-        type: string
-        description: Card type (Visa, MasterCard, etc.)
-      - name: expiryMonth
-        type: integer
-        description: Card expiry month
-      - name: expiryYear
-        type: integer
-        description: Card expiry year
-  - name: status
-    type: string
-    required: true
-    description: Current payment status
-    enum: ['pending', 'processing', 'completed', 'failed', 'cancelled', 'refunded', 'partially_refunded']
-  - name: transactionId
-    type: string
-    required: false
-    description: External payment processor transaction ID
-  - name: gatewayResponse
-    type: object
-    required: false
-    description: Raw response from payment gateway
-  - name: billingAddress
-    type: Address
-    required: true
-    description: Billing address for the payment
-    references: Address
-    referencesIdentifier: addressId
-    relationType: hasOne
-  - name: processedAt
-    type: DateTime
-    required: false
-    description: Date and time when payment was processed
-  - name: failureReason
-    type: string
-    required: false
-    description: Reason for payment failure if applicable
-  - name: refunds
-    type: array
-    items:
-      type: PaymentRefund
-    required: false
-    description: Refunds associated with this payment
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Date and time when the payment record was created
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the payment record was last updated
----
-
-## Overview
-
-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.
-
-## Payment States
-
-```
-pending → processing → completed
-    ↓         ↓           ↓
-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.
-
-## 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