@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

package/templates/default/domains/ProductCatalog/entities/Inventory/index.mdx

@@ -1,119 +0,0 @@
----
-id: Inventory
-name: Inventory
-version: 1.0.0
-identifier: inventoryId
-summary: Tracks stock levels and availability for products.
-owners:
-  - dboyne
-properties:
-  - name: inventoryId
-    type: UUID
-    required: true
-    description: Unique identifier for the inventory record
-  - name: productId
-    type: UUID
-    required: true
-    description: Product this inventory record tracks
-    references: Product
-    referencesIdentifier: productId
-    relationType: hasOne
-  - name: sku
-    type: string
-    required: true
-    description: Stock Keeping Unit matching the product SKU
-  - name: quantityOnHand
-    type: integer
-    required: true
-    description: Current available stock quantity
-  - name: quantityReserved
-    type: integer
-    required: true
-    description: Quantity reserved for pending orders
-  - name: quantityAvailable
-    type: integer
-    required: true
-    description: Calculated available quantity (onHand - reserved)
-  - name: minimumStockLevel
-    type: integer
-    required: true
-    description: Minimum stock level before reorder alert
-  - name: maximumStockLevel
-    type: integer
-    required: false
-    description: Maximum stock level for inventory management
-  - name: reorderPoint
-    type: integer
-    required: true
-    description: Stock level that triggers reorder process
-  - name: reorderQuantity
-    type: integer
-    required: true
-    description: Quantity to order when restocking
-  - name: unitCost
-    type: decimal
-    required: false
-    description: Cost per unit for inventory valuation
-  - name: warehouseLocation
-    type: string
-    required: false
-    description: Physical location or bin where item is stored
-  - name: lastRestockedAt
-    type: DateTime
-    required: false
-    description: Date and time of last restock
-  - name: lastSoldAt
-    type: DateTime
-    required: false
-    description: Date and time of last sale
-  - name: isTrackingEnabled
-    type: boolean
-    required: true
-    description: Whether inventory tracking is enabled for this product
-  - name: backorderAllowed
-    type: boolean
-    required: true
-    description: Whether backorders are allowed when out of stock
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Date and time when the inventory record was created
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the inventory record was last updated
----
-
-## Overview
-
-The Inventory entity manages stock levels and availability for products in the e-commerce system. It tracks current quantities, reserved stock, and provides reorder management capabilities.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Product:** Each inventory record belongs to one `Product` (identified by `productId`).
-- **OrderItem:** Inventory quantities are affected by `OrderItem` entities when orders are placed.
-
-## Stock Calculations
-
-- **Available Quantity** = Quantity On Hand - Quantity Reserved
-- **Reorder Needed** = Quantity Available &lt;= Reorder Point
-- **Stock Value** = Quantity On Hand × Unit Cost
-
-## Examples
-
-- **Inventory #1:** iPhone 15 Pro - 25 on hand, 5 reserved, 20 available, reorder at 10 units.
-- **Inventory #2:** Running Shoes Size 9 - 0 on hand, 2 reserved, backorder allowed.
-
-## Business Rules
-
-- Quantity on hand cannot be negative
-- Quantity reserved cannot exceed quantity on hand
-- Available quantity is automatically calculated
-- Reorder alerts are triggered when available = reorder point
-- Stock reservations are created when orders are placed
-- Stock is decremented when orders are shipped
-- Inventory adjustments must be logged for audit trail

package/templates/default/domains/ProductCatalog/entities/Product/index.mdx

@@ -1,118 +0,0 @@
----
-id: Product
-name: Product
-version: 1.0.0
-identifier: productId
-aggregateRoot: true
-summary: Represents a product or service available for purchase in the e-commerce system.
-owners:
-  - dboyne
-properties:
-  - name: productId
-    type: UUID
-    required: true
-    description: Unique identifier for the product
-  - name: name
-    type: string
-    required: true
-    description: Name of the product
-  - name: description
-    type: string
-    required: false
-    description: Detailed description of the product
-  - name: sku
-    type: string
-    required: true
-    description: Stock Keeping Unit - unique product identifier
-  - name: price
-    type: decimal
-    required: true
-    description: Current selling price of the product
-  - name: categoryId
-    type: UUID
-    required: true
-    description: Category this product belongs to
-    references: Category
-    referencesIdentifier: categoryId
-    relationType: hasOne
-  - name: brand
-    type: string
-    required: false
-    description: Brand name of the product
-  - name: weight
-    type: decimal
-    required: false
-    description: Weight of the product in kilograms
-  - name: dimensions
-    type: object
-    required: false
-    description: Product dimensions (length, width, height)
-    properties:
-      - name: length
-        type: decimal
-      - name: width
-        type: decimal
-      - name: height
-        type: decimal
-  - name: isActive
-    type: boolean
-    required: true
-    description: Whether the product is currently available for sale
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Date and time when the product was created
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the product was last updated
-  - name: images
-    type: array
-    items:
-      type: string
-    required: false
-    description: URLs of product images
-  - name: inventory
-    type: Inventory
-    required: false
-    description: Inventory information for this product
-    references: Inventory
-    referencesIdentifier: productId
-    relationType: hasOne
-  - name: reviews
-    type: array
-    items:
-      type: Review
-    required: false
-    description: Customer reviews for this product
-    references: Review
-    referencesIdentifier: productId
-    relationType: hasMany
----
-
-## Overview
-
-The Product entity represents items or services available for purchase in the e-commerce system. It serves as an aggregate root containing all product-related information including pricing, categorization, inventory details, and customer reviews.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Category:** Each product belongs to one `Category` (identified by `categoryId`).
-- **Inventory:** Each product has one `Inventory` record tracking stock levels.
-- **Review:** A product can have multiple `Review` entities from customers.
-- **OrderItem:** Products are referenced in `OrderItem` entities when included in orders.
-
-## Examples
-
-- **Product #1:** "iPhone 15 Pro" - Electronics category, $999.99, with 50 units in stock and 4.5-star reviews.
-- **Product #2:** "Running Shoes" - Sports category, $129.99, various sizes available, with detailed size chart.
-
-## Business Rules
-
-- Products must have a unique SKU across the entire catalog
-- Products cannot be deleted if they have associated order items
-- Price changes should be tracked for audit purposes
-- Products must belong to an active category to be purchasable

package/templates/default/domains/ProductCatalog/entities/Review/index.mdx

@@ -1,157 +0,0 @@
----
-id: Review
-name: Review
-version: 1.0.0
-identifier: reviewId
-summary: Represents customer reviews and ratings for products.
-owners:
-  - dboyne
-properties:
-  - name: reviewId
-    type: UUID
-    required: true
-    description: Unique identifier for the review
-  - name: productId
-    type: UUID
-    required: true
-    description: Product being reviewed
-    references: Product
-    referencesIdentifier: productId
-    relationType: hasOne
-  - name: customerId
-    type: UUID
-    required: true
-    description: Customer who wrote the review
-    references: Customer
-    referencesIdentifier: customerId
-    relationType: hasOne
-  - name: orderId
-    type: UUID
-    required: false
-    description: Order associated with this review (for verified purchases)
-    references: Order
-    referencesIdentifier: orderId
-    relationType: hasOne
-  - name: rating
-    type: integer
-    required: true
-    description: Rating given by customer (1-5 stars)
-    minimum: 1
-    maximum: 5
-  - name: title
-    type: string
-    required: false
-    description: Review title or headline
-  - name: content
-    type: string
-    required: true
-    description: Review content and comments
-  - name: isVerifiedPurchase
-    type: boolean
-    required: true
-    description: Whether this review is from a verified purchase
-  - name: isRecommended
-    type: boolean
-    required: false
-    description: Whether customer recommends this product
-  - name: helpfulVotes
-    type: integer
-    required: true
-    description: Number of helpful votes received
-  - name: totalVotes
-    type: integer
-    required: true
-    description: Total number of votes received
-  - name: status
-    type: string
-    required: true
-    description: Current review status
-    enum: ['pending', 'approved', 'rejected', 'flagged']
-  - name: moderationNotes
-    type: string
-    required: false
-    description: Internal moderation notes
-  - name: images
-    type: array
-    items:
-      type: string
-    required: false
-    description: URLs of images uploaded with the review
-  - name: pros
-    type: array
-    items:
-      type: string
-    required: false
-    description: List of positive aspects mentioned
-  - name: cons
-    type: array
-    items:
-      type: string
-    required: false
-    description: List of negative aspects mentioned
-  - name: merchantResponse
-    type: object
-    required: false
-    description: Response from merchant to this review
-    properties:
-      - name: content
-        type: string
-        description: Merchant response content
-      - name: respondedAt
-        type: DateTime
-        description: When merchant responded
-      - name: respondedBy
-        type: string
-        description: Who responded for the merchant
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Date and time when the review was created
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the review was last updated
-  - name: moderatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the review was moderated
----
-
-## Overview
-
-The Review entity captures customer feedback and ratings for products. It supports verified purchase validation, content moderation, community voting, and merchant responses to build trust and provide valuable product insights.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Product:** Each review belongs to one `Product` (identified by `productId`).
-- **Customer:** Each review is written by one `Customer` (identified by `customerId`).
-- **Order:** Each review can be linked to one `Order` for purchase verification (identified by `orderId`).
-
-## Review Lifecycle
-
-```
-submitted → pending → approved → published
-              ↓         ↓
-           rejected   flagged
-```
-
-## Examples
-
-- **Review #1:** 5-star review for iPhone 15 Pro, verified purchase, "Excellent camera quality!"
-- **Review #2:** 3-star review for Running Shoes, helpful votes: 15/20, includes photos
-- **Review #3:** 1-star review flagged for inappropriate content, pending moderation
-
-## Business Rules
-
-- Reviews can only be submitted by customers who purchased the product
-- Rating must be between 1-5 stars
-- Verified purchase reviews are given higher weight in calculations
-- Inappropriate content is flagged and requires moderation
-- Customers can only review the same product once per purchase
-- Helpful votes help surface most valuable reviews
-- Merchant responses are limited to one per review
-- Reviews older than 2 years may have reduced weight in calculations

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

@@ -1,73 +0,0 @@
----
-id: ProductCatalog
-name: Product Catalog
-version: 0.0.1
-summary: Manages product information, categories, inventory, and customer reviews in the e-commerce system.
-owners:
-  - dboyne
-entities:
-  - id: Product
-  - id: Category
-  - id: Inventory
-  - id: Review
-services:
-  - id: InventoryService
----
-
-## Overview
-
-The Product Catalog subdomain is responsible for managing all product-related information in the e-commerce system. This includes product details, hierarchical categorization, inventory tracking, and customer reviews.
-
-### Architecture for the Product Catalog domain
-
-<NodeGraph />
-
-### Entity Map
-
-A visualization of the entities in the Product Catalog domain. Here you can see the relationships between the entities and how they are used in the domain.
-
-<EntityMap id="ProductCatalog" />
-
-## Core Responsibilities
-
-### Product Management
-
-- Maintain product information including pricing, descriptions, and specifications
-- Support product variants (size, color, style)
-- Handle product lifecycle (active, discontinued, draft)
-- Manage product relationships and cross-selling
-
-### Category Management
-
-- Organize products into hierarchical categories
-- Support multi-level category structures
-- Maintain category metadata and SEO information
-- Handle category navigation and filtering
-
-### Inventory Management
-
-- Track stock levels and availability
-- Manage reorder points and stock alerts
-- Handle inventory reservations and allocations
-- Support warehouse and location management
-
-### Review Management
-
-- Collect and manage customer product reviews
-- Calculate review metrics and ratings
-- Moderate review content
-- Support review helpfulness and responses
-
-## Key Entities
-
-- **Product**: Central aggregate containing all product information
-- **Category**: Hierarchical product categorization system
-- **Inventory**: Stock tracking and availability management
-- **Review**: Customer feedback and rating system
-
-## Business Rules
-
-- Products must belong to an active category
-- Inventory levels affect product availability
-- Reviews require verified purchases
-- Category hierarchies have maximum depth limits

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

@@ -1,88 +0,0 @@
----
-dictionary:
-  - id: Product
-    name: Product
-    summary: 'A distinct item available for sale, defined by its attributes, pricing, and descriptions.'
-    description: |
-      A product is the central aggregate in the Product Catalog domain. It contains all information needed to present and sell an item:
-
-      - Title, description, and images
-      - Pricing and currency information
-      - Attributes and specifications
-      - Availability status and lifecycle state (draft, active, discontinued)
-
-      Products may have multiple variants and belong to one or more categories.
-    icon: Package
-  - id: Category
-    name: Category
-    summary: 'A hierarchical grouping used to organize products for browsing and discovery.'
-    description: |
-      Categories form a tree structure that helps customers navigate the catalog. Key aspects include:
-
-      - Parent-child relationships for multi-level hierarchies
-      - Category metadata and SEO attributes
-      - Display ordering and featured status
-      - Maximum depth limits enforced by business rules
-
-      Products must belong to at least one active category.
-    icon: FolderTree
-  - id: Inventory
-    name: Inventory
-    summary: 'The tracked quantity of a product available for sale across warehouses and locations.'
-    description: |
-      Inventory represents the stock levels for each product or variant. It involves:
-
-      - Current stock quantities per location
-      - Reorder points and safety stock thresholds
-      - Reserved and allocated quantities
-      - Stock movement history and audit trails
-
-      Inventory levels directly affect product availability on the storefront.
-    icon: Warehouse
-  - id: Review
-    name: Review
-    summary: 'Customer feedback on a product, including a rating and optional written commentary.'
-    description: |
-      Reviews provide social proof and help customers make purchase decisions. Review management includes:
-
-      - Star ratings and written feedback
-      - Verified purchase validation
-      - Content moderation and approval workflows
-      - Helpfulness voting and seller responses
-
-      Reviews require a verified purchase before submission.
-    icon: Star
-  - id: SKU
-    name: SKU
-    summary: 'Stock Keeping Unit — a unique identifier assigned to each distinct product variant for inventory tracking.'
-    icon: Tag
-  - id: Variant
-    name: Variant
-    summary: 'A specific version of a product differentiated by attributes such as size, color, or material.'
-    description: |
-      Variants allow a single product to be offered in multiple configurations. Each variant has:
-
-      - Its own SKU and inventory levels
-      - Specific attribute values (e.g., size: Large, color: Blue)
-      - Optional price overrides
-      - Independent availability status
-
-      Variants share the parent product's core information but differ in selectable attributes.
-    icon: Layers
-  - id: Pricing
-    name: Pricing
-    summary: 'The monetary value assigned to a product or variant, including base price, sale price, and currency.'
-    icon: DollarSign
-  - id: Product Lifecycle
-    name: Product Lifecycle
-    summary: 'The stages a product moves through from creation to retirement: draft, active, and discontinued.'
-    icon: RefreshCw
-  - id: Attribute
-    name: Attribute
-    summary: 'A descriptive property of a product such as weight, dimensions, material, or brand.'
-    icon: ListChecks
-  - id: Cross-Sell
-    name: Cross-Sell
-    summary: 'A recommendation of related or complementary products to encourage additional purchases.'
-    icon: ArrowRightLeft
----

package/templates/default/domains/Subscriptions/entities/BillingProfile/index.mdx

@@ -1,71 +0,0 @@
----
-id: BillingProfile
-name: BillingProfile
-version: 1.0.0
-identifier: billingProfileId
-summary: Stores billing-related contact information and preferences for a customer, often used for invoices and communication.
-owners:
-  - dboyne
-
-properties:
-  - name: billingProfileId
-    type: UUID
-    required: true
-    description: Unique identifier for the billing profile.
-  - name: customerId
-    type: UUID
-    required: true
-    description: Identifier of the customer this billing profile belongs to.
-    references: Customer
-    referencesIdentifier: customerId
-    relationType: hasOne
-  - name: billingEmail
-    type: string
-    required: false # May default to customer's primary email
-    description: Specific email address for sending invoices and billing notifications
-  - name: companyName # Optional, for B2B
-    type: string
-    required: false
-    description: Company name for billing purposes.
-  - name: taxId # Optional, for B2B or specific regions
-    type: string
-    required: false
-    description: Tax identification number (e.g., VAT ID, EIN).
-  - name: billingAddressId
-    type: UUID
-    required: true
-    description: Identifier for the primary billing address associated with this profile.
-  - name: preferredPaymentMethodId # Optional default for invoices/subscriptions
-    type: UUID
-    required: false
-    description: Customer's preferred payment method for charges related to this profile.
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Timestamp when the billing profile was created.
-  - name: updatedAt
-    type: DateTime
-    required: true
-    description: Timestamp when the billing profile was last updated.
----
-
-## Overview
-
-The BillingProfile entity consolidates billing-specific details for a customer, such as the billing address, contact email for invoices, tax information, and potentially preferred payment methods. This might be distinct from the customer's general contact information or shipping addresses.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Customer:** A billing profile belongs to one `Customer`. A customer might potentially have multiple profiles in complex scenarios, but often just one.
-- **Address:** Linked to a primary billing `Address`.
-- **PaymentMethod:** May specify a preferred `PaymentMethod`.
-- **Invoice:** Invoices are typically generated using information from the BillingProfile.
-- **Subscription:** Subscriptions may use the associated customer's BillingProfile for charging.
-
-## Examples
-
-- Jane Doe's personal billing profile with her home address and primary email.
-- Acme Corp's billing profile with their HQ address, VAT ID, and accounts payable email address.

package/templates/default/domains/Subscriptions/entities/SubscriptionPeriod/index.mdx

@@ -1,76 +0,0 @@
----
-id: SubscriptionPeriod
-name: SubscriptionPeriod
-version: 1.0.0
-identifier: subscriptionPeriodId
-summary: Represents a single billing cycle or interval within a subscription's lifetime.
-owners:
-  - dboyne
-
-properties:
-  - name: subscriptionPeriodId
-    type: UUID
-    required: true
-    description: Unique identifier for this specific subscription period.
-  - name: subscriptionId
-    type: UUID
-    required: true
-    description: Identifier of the parent Subscription this period belongs to.
-  - name: planId # Denormalized for easier lookup?
-    type: UUID
-    required: true
-    description: Identifier of the Plan active during this period
-  - name: startDate
-    type: Date
-    required: true
-    description: The start date of this billing period.
-  - name: endDate
-    type: Date
-    required: true
-    description: The end date of this billing period.
-  - name: invoiceId # Optional, links to the invoice generated for this period
-    type: UUID
-    required: false
-    description: Identifier of the invoice created for this period's charge.
-  - name: paymentId # Optional, links to the payment made for this period's invoice
-    type: UUID
-    required: false
-    description: Identifier of the payment that settled the invoice for this period.
-  - name: status
-    type: string # (e.g., Active, Billed, Paid, Unpaid, PastDue)
-    required: true
-    description: Status specific to this period (reflects invoicing/payment state).
-  - name: amountBilled
-    type: decimal
-    required: false # May only be set once invoiced
-    description: The actual amount billed for this period (could differ from plan due to promotions, usage, etc.).
-  - name: currency
-    type: string # ISO 4217 code
-    required: false
-    description: Currency of the billed amount.
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Timestamp when this period record was created (often at the start of the period).
----
-
-## Overview
-
-The SubscriptionPeriod entity tracks the state and details of a specific billing cycle within a `Subscription`. It links the subscription to the relevant invoice and payment for that interval and records the exact dates and amount billed.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Subscription:** A subscription period belongs to one `Subscription`.
-- **Plan:** Reflects the `Plan` active during this period.
-- **Invoice:** May be associated with one `Invoice` generated for this period.
-- **Payment:** May be associated with one `Payment` that settled the period's invoice.
-
-## Examples
-
-- Period for Jane Doe's 'Pro Plan' from 2024-05-01 to 2024-05-31, invoiced via #INV-00123, status Paid.
-- Period for Acme Corp's 'Enterprise Plan' from 2024-04-15 to 2024-05-14, status Billed, awaiting payment.
-- The first period (trial) for a new subscription from 2024-05-20 to 2024-06-19, status Active, amountBilled $0.00.