@eventcatalog/create-eventcatalog 4.1.1 → 4.1.2

package/dist/index.js

@@ -29809,7 +29809,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "4.1.1",
+  version: "4.1.2",
   bin: {
     "create-catalog": "./dist/index.js"
   },
@@ -29912,6 +29912,7 @@ var installTemplate = async ({
       start: "eventcatalog start",
       preview: "eventcatalog preview",
       generate: "eventcatalog generate",
+      lint: "eventcatalog-linter",
       test: 'echo "Error: no test specified" && exit 1'
     }
   };
@@ -29921,7 +29922,8 @@ var installTemplate = async ({
   );
   const installFlags = { packageManager: packageManager2, isOnline };
   const dependencies = [
-    "@eventcatalog/core"
+    "@eventcatalog/core",
+    "@eventcatalog/linter"
   ];
   if (template === "asyncapi") {
     dependencies.push("@eventcatalog/generator-asyncapi");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "4.1.1",
+  "version": "4.1.2",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

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

@@ -1,6 +1,7 @@
 ---
 id: E-Commerce
 name: E-Commerce
+summary: Core business domain orchestrating FlowMart's digital marketplace operations
 version: 1.0.0
 owners:
   - dboyne
@@ -18,25 +19,6 @@ badges:
     backgroundColor: yellow
     textColor: yellow
     icon: ShieldCheckIcon
-
-resourceGroups:
-  - id: related-resources
-    title: Core FlowMart Services
-    items:
-      - id: InventoryService
-        type: service
-      - id: OrdersService
-        type: service
-      - id: NotificationService
-        type: service
-      - id: ShippingService
-        type: service
-      - id: CustomerService
-        type: service
-      - id: PaymentService
-        type: service
-      - id: AnalyticsService
-        type: service
 ---
 
 import Footer from '@catalog/components/footer.astro';

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

@@ -0,0 +1,87 @@
+---
+dictionary:
+  - id: Marketplace
+    name: Marketplace
+    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:
+
+      - Product discovery and search capabilities
+      - Seller listings and buyer interactions
+      - Transaction facilitation and trust mechanisms
+      - Platform-wide policies and governance
+    icon: Store
+  - id: Checkout
+    name: Checkout
+    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:
+
+      - Cart review and item confirmation
+      - Shipping address and method selection
+      - Payment method selection and authorization
+      - Order confirmation and receipt generation
+
+      Optimizing the checkout experience is essential for reducing cart abandonment and increasing conversion rates.
+    icon: ShoppingCart
+  - id: Cart
+    name: Cart
+    summary: "A temporary collection of items a customer intends to purchase."
+    description: |
+      The shopping cart holds selected products before checkout. Key behaviors include:
+
+      - Adding and removing items
+      - Updating item quantities
+      - Applying discount codes and promotions
+      - Calculating subtotals, taxes, and shipping estimates
+
+      Carts may persist across sessions for authenticated customers and have configurable expiration policies.
+    icon: ShoppingBag
+  - id: Catalog
+    name: Catalog
+    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."
+    description: |
+      Customers are the primary consumers in the e-commerce domain. A customer profile includes:
+
+      - Account and identity information
+      - Order history and preferences
+      - Saved addresses and payment methods
+      - Loyalty status and rewards balance
+
+      Customers may be guests (unauthenticated) or registered account holders.
+    icon: User
+  - id: Storefront
+    name: Storefront
+    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."
+    description: |
+      Promotions drive customer engagement and sales. Common promotion types include:
+
+      - Percentage or fixed-amount discounts
+      - Buy-one-get-one (BOGO) offers
+      - Free shipping thresholds
+      - Time-limited flash sales
+      - Loyalty reward redemptions
+
+      Promotions have eligibility rules, usage limits, and validity periods.
+    icon: Percent
+  - id: Conversion
+    name: Conversion
+    summary: "The completion of a desired customer action, most commonly a purchase."
+    icon: TrendingUp
+  - id: Fulfillment
+    name: Fulfillment
+    summary: "The end-to-end process of receiving, processing, and delivering a customer's order."
+    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."
+    icon: ShoppingCart
+---

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

@@ -4,6 +4,8 @@ name: CartItem
 version: 1.0.0
 identifier: cartItemId
 summary: Represents an individual item within a shopping cart.
+owners:
+  - dboyne
 properties:
   - name: cartItemId
     type: UUID

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

@@ -4,6 +4,8 @@ name: Customer
 version: 1.0.0
 identifier: customerId
 summary: Represents an individual or organization that places orders.
+owners:
+  - dboyne
 
 properties:
   - name: customerId

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

@@ -5,6 +5,8 @@ version: 1.0.0
 identifier: orderId
 aggregateRoot: true
 summary: Represents a customer's request to purchase products or services.
+owners:
+  - dboyne
 properties:
   - name: orderId
     type: UUID

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

@@ -4,6 +4,8 @@ name: OrderItem
 version: 1.0.0
 identifier: orderItemId
 summary: Represents a single item within a customer's order.
+owners:
+  - dboyne
 
 properties:
   - name: orderItemId

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

@@ -5,6 +5,8 @@ version: 1.0.0
 identifier: cartId
 aggregateRoot: true
 summary: Represents a customer's shopping cart containing products before checkout.
+owners:
+  - dboyne
 properties:
   - name: cartId
     type: UUID

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

@@ -1,6 +1,7 @@
 ---
 id: Orders
 name: Orders
+summary: Handles all operations related to customer orders, from creation to fulfillment
 version: 0.0.3
 owners:
   - dboyne

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

@@ -31,11 +31,11 @@ receives:
   - id: GetInventoryList
 sends:
   - id: InventoryAdjusted
-    version: 0.0.4
+    version: 1.0.1
     to:
       - id: 'inventory.{env}.events'
   - id: OutOfStock
-    version: 0.0.3
+    version: 0.0.4
     to:
       - id: 'inventory.{env}.events'
 repository:

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

@@ -31,11 +31,11 @@ receives:
           env: staging
 sends:
   - id: InventoryAdjusted
-    version: 0.0.4
+    version: 1.0.1
     to:
       - id: 'inventory.{env}.events'
   - id: OutOfStock
-    version: 0.0.3
+    version: 0.0.4
     to:
       - id: 'inventory.{env}.events'
 repository:

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

@@ -8,7 +8,7 @@ owners:
   - dboyne
 receives:
   - id: InventoryAdjusted
-    version: 0.0.3
+    version: 1.0.1
     from:
       - id: 'inventory.{env}.events'
   - id: CreateReturnLabel

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

@@ -8,7 +8,7 @@ owners:
   - dboyne
 receives:
   - id: InventoryAdjusted
-    version: 0.0.3
+    version: 1.0.1
     from:
       - id: 'inventory.{env}.events'
 sends:

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

@@ -1,6 +1,7 @@
 ---
 id: Orders
 name: Orders
+summary: Handles all operations related to customer orders, from creation to fulfillment
 version: 0.0.2
 owners:
   - dboyne

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

@@ -4,6 +4,8 @@ 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

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

@@ -4,6 +4,8 @@ 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

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

@@ -5,6 +5,8 @@ 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

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

@@ -4,6 +4,8 @@ name: PaymentMethod
 version: 1.0.0
 identifier: paymentMethodId
 summary: Represents a payment instrument a customer can use, like a credit card or bank account.
+owners:
+  - dboyne
 
 properties:
   - name: paymentMethodId

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

@@ -4,6 +4,8 @@ name: Transaction
 version: 1.0.0
 identifier: transactionId
 summary: Represents a low-level interaction with a payment gateway or processor (e.g., authorize, capture, refund, void).
+owners:
+  - dboyne
 
 properties:
   - name: transactionId

package/templates/default/domains/Payment/flows/PaymentProcessed/index.mdx

@@ -3,6 +3,8 @@ id: PaymentFlow
 name: Payment Flow for customers
 version: 1.0.0
 summary: Business flow for processing payments in an e-commerce platform
+owners:
+  - dboyne
 steps:
     - id: "customer_place_order"
       title: Customer places order
@@ -66,9 +68,7 @@ steps:
         label: Retry payment process
     - id: "payment_complete"
       title: Payment Complete
-      message:
-        id: PaymentComplete
-        version: 0.0.2
+      type: node
       next_step:
         id: "order-complete"
         label: Order completed

package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/index.mdx

@@ -3,6 +3,8 @@ id: FraudCheckCompleted
 version: 0.0.1
 name: Fraud Check Completed
 summary: Emitted when a fraud check has been completed for a transaction
+owners:
+  - dboyne
 tags:
   - payment
   - fraud

package/templates/default/domains/Payment/services/FraudDetectionService/index.mdx

@@ -21,12 +21,8 @@ receives:
 sends:
   - id: FraudCheckCompleted
     version: 0.0.1
-  - id: FraudDetected
-    version: 0.0.1
-  - id: RiskScoreCalculated
-    version: 0.0.1
 owners:
-  - riskTeam
+  - dboyne
 ---
 
 import Footer from '@catalog/components/footer.astro'

package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/index.mdx

@@ -3,6 +3,8 @@ id: ProcessPayment
 version: 0.0.1
 name: Process Payment
 summary: Command to process a payment through the payment gateway
+owners:
+  - dboyne
 tags:
   - payment
   - command

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/index.mdx

@@ -3,6 +3,8 @@ id: PaymentFailed
 version: 0.0.1
 name: Payment Failed
 summary: Emitted when a payment attempt fails
+owners:
+  - dboyne
 badges:
   - content: Error Event
     backgroundColor: red

package/templates/default/domains/Payment/services/PaymentGatewayService/index.mdx

@@ -12,21 +12,13 @@ repository:
 receives:
   - id: ProcessPayment
     version: 0.0.1
-  - id: RefundPayment
-    version: 0.0.1
   - id: FraudCheckCompleted
     version: 0.0.1
 sends:
-  - id: PaymentAuthorized
-    version: 0.0.1
-  - id: PaymentCaptured
-    version: 0.0.1
   - id: PaymentFailed
     version: 0.0.1
-  - id: RefundProcessed
-    version: 0.0.1
 owners:
-  - paymentsTeam
+  - dboyne
 ---
 
 import Footer from '@catalog/components/footer.astro'

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

@@ -5,6 +5,8 @@ version: 1.0.0
 identifier: categoryId
 aggregateRoot: true
 summary: Represents a product category with hierarchical structure support.
+owners:
+  - dboyne
 properties:
   - name: categoryId
     type: UUID

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

@@ -4,6 +4,8 @@ name: Inventory
 version: 1.0.0
 identifier: inventoryId
 summary: Tracks stock levels and availability for products.
+owners:
+  - dboyne
 properties:
   - name: inventoryId
     type: UUID

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

@@ -5,6 +5,8 @@ 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

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

@@ -4,6 +4,8 @@ name: Review
 version: 1.0.0
 identifier: reviewId
 summary: Represents customer reviews and ratings for products.
+owners:
+  - dboyne
 properties:
   - name: reviewId
     type: UUID

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

@@ -11,10 +11,7 @@ entities:
   - id: Inventory
   - id: Review
 services:
-  - id: ProductService
-  - id: CategoryService
   - id: InventoryService
-  - id: ReviewService
 ---
 
 ## Overview

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

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

@@ -4,6 +4,8 @@ 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

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

@@ -4,6 +4,8 @@ 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

package/templates/default/domains/Subscriptions/flows/CancelSubscription/index.mdx

@@ -3,6 +3,8 @@ id: "CancelSubscription"
 name: "User Cancels Subscription"
 version: "1.0.0"
 summary: "Flow for when a user has cancelled a subscription"
+owners:
+  - dboyne
 steps:
   - id: "cancel_subscription_initiated"
     title: "Cancels Subscription"

package/templates/default/domains/Subscriptions/flows/CancelSubscription/versioned/0.0.1/index.mdx

@@ -3,6 +3,8 @@ id: "CancelSubscription"
 name: "User Cancels Subscription"
 version: "0.0.1"
 summary: "Flow for when a user has cancelled a subscription"
+owners:
+  - dboyne
 steps:
   - id: "cancel_subscription_initiated"
     title: "Cancels Subscription"

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/index.mdx

@@ -3,6 +3,8 @@ id: SubscriptionPaymentDue
 version: 0.0.1
 name: Subscription Payment Due
 summary: Emitted when a subscription payment is due for collection
+owners:
+  - dboyne
 tags:
   - billing
   - payment

package/templates/default/domains/Subscriptions/services/BillingService/index.mdx

@@ -19,16 +19,12 @@ receives:
         parameters:
           env: staging
 sends:
-  - id: InvoiceGenerated
-    version: 0.0.1
   - id: SubscriptionPaymentDue
     version: 0.0.1
-  - id: BillingCycleCompleted
-    version: 0.0.1
   - id: ProcessPayment
     version: 0.0.1
 owners:
-  - billingTeam
+  - dboyne
 ---
 
 import Footer from '@catalog/components/footer.astro'

package/templates/default/domains/Subscriptions/services/PlanManagementService/index.mdx

@@ -9,24 +9,10 @@ tags:
   - subscriptions
 repository:
   url: https://github.com/eventcatalog/plan-management-service
-receives:
-  - id: CreatePlan
-    version: 0.0.1
-  - id: UpdatePlan
-    version: 0.0.1
-  - id: MigratePlan
-    version: 0.0.1
-sends:
-  - id: PlanCreated
-    version: 0.0.1
-  - id: PlanUpdated
-    version: 0.0.1
-  - id: PlanMigrationCompleted
-    version: 0.0.1
-  - id: FeatureAccessChanged
-    version: 0.0.1
+receives: []
+sends: []
 owners:
-  - productTeam
+  - dboyne
 ---
 
 import Footer from '@catalog/components/footer.astro'

package/templates/default/teams/full-stack.mdx

@@ -1,7 +1,7 @@
 ---
 id: full-stack
 name: Full stackers
-summmary: Full stack developers based in London, UK
+summary: Full stack developers based in London, UK
 members:
     - dboyne
     - asmith

package/templates/default/teams/mobile-devs.mdx

@@ -1,6 +1,7 @@
 ---
 id: mobile-devs
 name: The mobile devs
+summary: Mobile application development team for iOS and Android platforms
 members:
     - dboyne
 ---

package/templates/default/users/aSmith.mdx

@@ -1,6 +1,7 @@
 ---
 id: asmith
 name: Amy Smith
+summary: Product Owner of the Full Stackers team
 avatarUrl: https://randomuser.me/api/portraits/women/48.jpg
 role: Product owner
 ---

package/templates/default/users/dboyne.mdx

@@ -1,6 +1,7 @@
 ---
 id: dboyne
 name: David Boyne
+summary: Tech Lead of the Full Stackers team
 avatarUrl: "https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png"
 role: Lead developer
 email: test@test.com

package/templates/default/users/mSmith.mdx

@@ -1,6 +1,7 @@
 ---
 id: msmith
 name: Martin Smith
+summary: Senior Mobile Developer on The Mobile Devs team
 avatarUrl: "https://randomuser.me/api/portraits/men/51.jpg"
 role: Senior software engineer
 ---

package/templates/index.ts

@@ -46,6 +46,7 @@ export const installTemplate = async ({
       start: "eventcatalog start",
       preview: "eventcatalog preview",
       generate: "eventcatalog generate",
+      lint: "eventcatalog-linter",
       test: 'echo "Error: no test specified" && exit 1',
     }
   };
@@ -67,7 +68,8 @@ export const installTemplate = async ({
    */
   // const dependencies = ["@eventcatalog/eventcatalog-2"];
   const dependencies = [
-    "@eventcatalog/core"
+    "@eventcatalog/core",
+    "@eventcatalog/linter"
   ] as any;
 
   // if asyncapi is selected, add the asyncapi dependencies