@eventcatalog/create-eventcatalog 4.1.1 → 4.1.3

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.3",
   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.3",
   "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/events/InventoryAdjusted/versioned/0.0.1/index.mdx

@@ -2,6 +2,7 @@
 id: InventoryAdjusted
 name: Inventory adjusted
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Indicates a change in inventory level
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of the inventory adjustment"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the adjusted product"
+    },
+    "adjusted_quantity": {
+      "type": "integer",
+      "description": "The quantity adjusted (positive or negative)"
+    },
+    "new_quantity": {
+      "type": "integer",
+      "description": "The new total inventory quantity"
+    },
+    "adjustment_reason": {
+      "type": "string",
+      "description": "Reason for the adjustment"
+    },
+    "adjusted_by": {
+      "type": "string",
+      "description": "Identifier of the user who made the adjustment"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id", "adjusted_quantity", "new_quantity"]
+}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/index.mdx

@@ -2,6 +2,7 @@
 id: InventoryAdjusted
 name: Inventory adjusted
 version: 1.0.0
+schemaPath: schema.json
 summary: |
   Indicates a change in inventory level
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of the inventory adjustment"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the adjusted product"
+    },
+    "adjusted_quantity": {
+      "type": "integer",
+      "description": "The quantity adjusted (positive or negative)"
+    },
+    "new_quantity": {
+      "type": "integer",
+      "description": "The new total inventory quantity"
+    },
+    "adjustment_reason": {
+      "type": "string",
+      "description": "Reason for the adjustment"
+    },
+    "adjusted_by": {
+      "type": "string",
+      "description": "Identifier of the user who made the adjustment"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id", "adjusted_quantity", "new_quantity"]
+}

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

@@ -2,6 +2,7 @@
 id: OutOfStock
 name: Inventory out of stock
 version: 0.0.4
+schemaPath: schema.json
 summary: |
   Indicates inventory is out of stock
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp when the out-of-stock condition was detected"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the out-of-stock product"
+    },
+    "last_available_quantity": {
+      "type": "integer",
+      "description": "The last known available quantity before stock ran out"
+    },
+    "warehouse_id": {
+      "type": "string",
+      "description": "Identifier of the warehouse reporting the stock-out"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id"]
+}

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

@@ -2,6 +2,7 @@
 id: OutOfStock
 name: Inventory out of stock
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Indicates inventory is out of stock
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp when the out-of-stock condition was detected"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the out-of-stock product"
+    },
+    "last_available_quantity": {
+      "type": "integer",
+      "description": "The last known available quantity before stock ran out"
+    },
+    "warehouse_id": {
+      "type": "string",
+      "description": "Identifier of the warehouse reporting the stock-out"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id"]
+}

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/Payment/services/PaymentService/events/PaymentInitiated/index.mdx

@@ -2,6 +2,7 @@
 id: PaymentInitiated
 name: Payment Initiated
 version: 0.0.1
+schemaPath: schema.json
 summary: Event is triggered when a user initiates a payment through the Payment Service
 owners:
   - dboyne

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user initiating the payment"
+    },
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the associated order"
+    },
+    "amount": {
+      "type": "number",
+      "description": "Payment amount"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method used"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the payment was initiated"
+    }
+  },
+  "required": ["userId", "orderId", "amount", "paymentMethod", "timestamp"]
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/index.mdx

@@ -2,6 +2,7 @@
 id: PaymentProcessed
 name: Payment Processed
 version: 1.0.0
+schemaPath: schema.json
 summary: Event is triggered after the payment has been successfully processed
 owners:
   - dboyne