@eventcatalog/create-eventcatalog 3.0.1 → 3.0.3

package/dist/index.js

@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "3.0.1",
+  version: "3.0.3",
   bin: {
     "create-catalog": "./dist/index.js"
   },

package/package.json

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

package/templates/asyncapi/gitignore

@@ -21,4 +21,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-.eventcatalog-core
+.eventcatalog-core
+
+.env
+.env-*

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

@@ -0,0 +1,152 @@
+---
+id: E-Commerce
+name: E-Commerce
+version: 1.0.0
+owners:
+  - dboyne
+  - full-stack
+domains:
+  - id: Orders
+  - id: Payment
+  - id: Subscription
+badges:
+  - content: Core domain
+    backgroundColor: blue
+    textColor: blue
+    icon: RectangleGroupIcon
+  - content: Business Critical
+    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';
+
+The E-Commerce domain is the core business domain of FlowMart, our modern digital marketplace. This domain orchestrates all critical business operations from product discovery to order fulfillment, handling millions of transactions monthly across our global customer base.
+
+<Tiles>
+    <Tile 
+        icon="UserGroupIcon" 
+        href="/docs/teams/full-stack" 
+        title="Engineering Support" 
+        description="Questions? Contact our full-stack team for technical support" 
+    />
+    <Tile 
+        icon="RectangleGroupIcon" 
+        href={`/visualiser/domains/${frontmatter.id}/${frontmatter.version}`} 
+        title="Domain Architecture" 
+        description="Explore our domain structure and service interactions" 
+    />
+</Tiles>
+
+## Domain Overview
+
+FlowMart's E-Commerce domain is built on event-driven microservices architecture, enabling:
+- Real-time inventory management across multiple warehouses
+- Seamless payment processing with multiple providers
+- Smart order routing and fulfillment
+- Personalized customer notifications
+- Subscription-based shopping experiences
+- Advanced fraud detection and prevention
+
+## Sub domains
+
+The E-Commerce domain is built on the following sub domains:
+
+- <ResourceLink id="Orders" type="domain">Orders</ResourceLink> - Core domain for order management
+- <ResourceLink id="Payment" type="domain">Payment</ResourceLink> - A generic domain for payment processing using Stripe as a payment provider
+- <ResourceLink id="Subscription" type="domain">Subscription</ResourceLink> - Generic subscription domain handling users subscriptions
+
+## Target Architecture (Event Storming Results)
+
+Our target architecture was defined through collaborative event storming sessions with product, engineering, and business stakeholders. This represents our vision for FlowMart's commerce capabilities.
+
+<Miro boardId="uXjVIHCImos=/" moveToWidget="3074457347671667709" edit={false} />
+
+## Current Production Architecture
+
+Our current event-driven architecture powering FlowMart's shopping experience:
+
+<NodeGraph />
+
+### Order Processing Flow
+
+```mermaid
+sequenceDiagram
+    participant Customer
+    participant OrdersService
+    participant InventoryService
+    participant PaymentService
+    participant NotificationService
+    participant ShippingService
+
+    Customer->>OrdersService: Place Order
+    OrdersService->>InventoryService: Check Stock Availability
+    InventoryService-->>OrdersService: Stock Confirmed
+    OrdersService->>PaymentService: Process Payment
+    PaymentService-->>OrdersService: Payment Successful
+    OrdersService->>InventoryService: Reserve Inventory
+    OrdersService->>ShippingService: Create Shipping Label
+    ShippingService-->>OrdersService: Shipping Label Generated
+    OrdersService->>NotificationService: Send Order Confirmation
+    NotificationService-->>Customer: Order & Tracking Details
+```
+
+## Key Business Flows
+
+### Subscription Management
+Our subscription service powers FlowMart's popular "Subscribe & Save" feature:
+
+<Flow id="CancelSubscription" version="latest" includeKey={false} />
+
+### Payment Processing
+Secure, multi-provider payment processing with fraud detection:
+
+<Flow id="PaymentFlow" version="latest" includeKey={false} />
+
+## Core Services
+
+These services form the backbone of FlowMart's e-commerce operations:
+
+<ResourceGroupTable 
+    id="related-resources" 
+    limit={7} 
+    showOwners={true} 
+    description="Essential services powering our e-commerce platform" 
+/>
+
+## Performance SLAs
+
+- Order Processing: < 2 seconds
+- Payment Processing: < 3 seconds
+- Inventory Updates: Real-time
+- Notification Delivery: < 30 seconds
+
+## Monitoring & Alerts
+
+- Real-time order volume monitoring
+- Payment gateway health checks
+- Inventory level alerts
+- Customer experience metrics
+- System performance dashboards
+
+<Footer />

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

@@ -7,35 +7,51 @@ owners:
   - full-stack
 services:
   - id: InventoryService
-  - id: NotificationService
   - id: OrdersService
-  - id: PaymentService
+  - id: NotificationService
+  - id: ShippingService
 badges:
-  - content: New domain
+  - content: Subdomain
     backgroundColor: blue
     textColor: blue
+    icon: RectangleGroupIcon
+
+resourceGroups:
+  - id: related-resources
+    title: Core resources
+    items:
+      - id: InventoryService
+        type: service
+      - id: OrdersService
+        type: service
+      - id: NotificationService
+        type: service
+      - id: ShippingService
+        type: service
 ---
 
 import Footer from '@catalog/components/footer.astro';
 
-## Overview
 
-<Admonition type="warning">Please ensure all services are updated to the latest version for compatibility and performance improvements.</Admonition>
 
-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.
+:::warning
 
+Please ensure all services are **updated** to the latest version for compatibility and performance improvements.
+:::
+
+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
 
 <Tiles >
     <Tile icon="UserGroupIcon" href="/docs/teams/full-stack" title="Contact the team" description="Any questions? Feel free to contact the owners" />
-    <Tile icon="RectangleGroupIcon" href={`/visualiser/domains/${frontmatter.id}/${frontmatter.version}`} title={`${frontmatter.services.length} services are in this domain`} description="This service sends messages to downstream consumers" />
+    <Tile icon="RectangleGroupIcon" href={`/visualiser/domains/${frontmatter.id}/${frontmatter.version}`} title={`${frontmatter.services.length} services`} description="This domain contains the following services." />
 </Tiles>
 
-
-
-## Bounded context
+### Architecture for the Orders domain
 
 <NodeGraph />
 
+<MessageTable format="all" limit={4} showChannels={true} title="Messages in/out of the domain" />
+
 ### Order example (sequence diagram)
 
 ```mermaid
@@ -67,4 +83,6 @@ Documented flow when a user makes a payment within the order domain
 
 <Flow id="PaymentFlow" version="latest" includeKey={false} />
 
+<ResourceGroupTable id="related-resources" limit={4} showOwners={true} title="Core resources for the Orders domain" description="Resources that are related to the Orders domain, you may find them useful" />
+
 <Footer />

package/templates/default/gitignore

@@ -21,4 +21,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-.eventcatalog-core
+.eventcatalog-core
+
+.env
+.env-*

package/templates/empty/gitignore

@@ -21,4 +21,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-.eventcatalog-core
+.eventcatalog-core
+
+.env
+.env-*

package/templates/openapi/gitignore

@@ -21,4 +21,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-.eventcatalog-core
+.eventcatalog-core
+
+.env
+.env-*