@eventcatalog/create-eventcatalog 4.1.1 → 4.1.3

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

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "transactionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the transaction"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user"
+    },
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the associated order"
+    },
+    "amount": {
+      "type": "number",
+      "description": "Payment amount processed"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method used"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["confirmed", "pending", "failed"],
+      "description": "Status of the payment"
+    },
+    "confirmationDetails": {
+      "type": "object",
+      "properties": {
+        "gatewayResponse": {
+          "type": "string",
+          "description": "Response from the payment gateway"
+        },
+        "transactionId": {
+          "type": "string",
+          "description": "Gateway transaction identifier"
+        }
+      }
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the payment was processed"
+    }
+  },
+  "required": ["transactionId", "userId", "orderId", "amount", "status", "timestamp"]
+}

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

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

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "transactionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the transaction"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user"
+    },
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the associated order"
+    },
+    "amount": {
+      "type": "number",
+      "description": "Payment amount processed"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method used"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["confirmed", "pending", "failed"],
+      "description": "Status of the payment"
+    },
+    "confirmationDetails": {
+      "type": "object",
+      "properties": {
+        "gatewayResponse": {
+          "type": "string",
+          "description": "Response from the payment gateway"
+        },
+        "transactionId": {
+          "type": "string",
+          "description": "Gateway transaction identifier"
+        }
+      }
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the payment was processed"
+    }
+  },
+  "required": ["transactionId", "userId", "orderId", "amount", "status", "timestamp"]
+}

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/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/index.mdx

@@ -2,6 +2,7 @@
 id: CancelSubscription
 name: Cancel subscription
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Command that will try and cancel a users subscription
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/schema.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the subscription to cancel"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user requesting cancellation"
+    },
+    "reason": {
+      "type": "string",
+      "description": "Reason for cancellation"
+    },
+    "cancelImmediately": {
+      "type": "boolean",
+      "description": "Whether to cancel immediately or at end of billing period"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the cancellation was requested"
+    }
+  },
+  "required": ["subscriptionId", "userId", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/index.mdx

@@ -2,6 +2,7 @@
 id: SubscribeUser
 name: Subscribe user
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Command that will try and subscribe a given user
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/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 to subscribe"
+    },
+    "planId": {
+      "type": "string",
+      "description": "Identifier of the subscription plan"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method for the subscription"
+    },
+    "startDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the subscription should start"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the command was issued"
+    }
+  },
+  "required": ["userId", "planId", "paymentMethod", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/index.mdx

@@ -2,6 +2,7 @@
 id: UserSubscriptionCancelled
 name: User subscription cancelled
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   An event that is triggered when a users subscription has been cancelled
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the cancelled subscription"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user"
+    },
+    "planId": {
+      "type": "string",
+      "description": "Identifier of the subscription plan"
+    },
+    "cancellationReason": {
+      "type": "string",
+      "description": "Reason for the cancellation"
+    },
+    "effectiveDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the cancellation takes effect"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the cancellation event occurred"
+    }
+  },
+  "required": ["subscriptionId", "userId", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/index.mdx

@@ -2,6 +2,7 @@
 id: UserSubscriptionStarted
 name: User subscription started
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   An event that is triggered when a new user subscription has started
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the new subscription"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the subscribed user"
+    },
+    "planId": {
+      "type": "string",
+      "description": "Identifier of the subscription plan"
+    },
+    "startDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the subscription started"
+    },
+    "billingCycle": {
+      "type": "string",
+      "enum": ["monthly", "quarterly", "yearly"],
+      "description": "The billing cycle for the subscription"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the subscription started event occurred"
+    }
+  },
+  "required": ["subscriptionId", "userId", "planId", "startDate", "timestamp"]
+}

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