@eventcatalog/create-eventcatalog 2.0.7 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/templates/default/domains/Orders/index.md +7 -0
- package/templates/default/domains/Payment/index.md +5 -0
- package/templates/default/flows/Payment/PaymentProcessed/index.md +81 -0
- package/templates/default/flows/Subscriptions/CancelSubscription/index.md +68 -0
- package/templates/default/flows/Subscriptions/CancelSubscription/versioned/0.0.1/index.md +49 -0
package/dist/index.js
CHANGED
|
@@ -22654,7 +22654,7 @@ function validateNpmName(name) {
|
|
|
22654
22654
|
var package_default = {
|
|
22655
22655
|
name: "@eventcatalog/create-eventcatalog",
|
|
22656
22656
|
description: "Create EventCatalog with one command",
|
|
22657
|
-
version: "2.0.
|
|
22657
|
+
version: "2.0.8",
|
|
22658
22658
|
bin: {
|
|
22659
22659
|
"create-catalog": "./dist/index.js"
|
|
22660
22660
|
},
|
package/package.json
CHANGED
|
@@ -46,4 +46,11 @@ sequenceDiagram
|
|
|
46
46
|
OrdersService->>InventoryService: Update Inventory
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
+
## Flows
|
|
50
|
+
|
|
51
|
+
### Cancel Subscription flow
|
|
52
|
+
Documented flow when a user cancels their subscription.
|
|
53
|
+
|
|
54
|
+
<Flow id="CancelSubscription" version="latest" includeKey={false} />
|
|
55
|
+
|
|
49
56
|
|
|
@@ -22,3 +22,8 @@ The Payment Domain encompasses all services and components related to handling f
|
|
|
22
22
|
## Bounded context
|
|
23
23
|
|
|
24
24
|
<NodeGraph />
|
|
25
|
+
|
|
26
|
+
### Payment processing flow
|
|
27
|
+
Documented flow when a user makes a payment within the order domain
|
|
28
|
+
|
|
29
|
+
<Flow id="PaymentFlow" version="latest" includeKey={false} />
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: PaymentFlow
|
|
3
|
+
name: Payment Flow for customers
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
summary: Business flow for processing payments in an e-commerce platform
|
|
6
|
+
steps:
|
|
7
|
+
- id: "customer_place_order"
|
|
8
|
+
title: Customer places order
|
|
9
|
+
next_step: "place_order_request"
|
|
10
|
+
- id: "place_order_request"
|
|
11
|
+
title: Place order
|
|
12
|
+
message:
|
|
13
|
+
id: PlaceOrder
|
|
14
|
+
version: 0.0.1
|
|
15
|
+
next_step:
|
|
16
|
+
id: "payment_initiated"
|
|
17
|
+
label: Initiate payment
|
|
18
|
+
- id: "payment_initiated"
|
|
19
|
+
title: Payment Initiated
|
|
20
|
+
message:
|
|
21
|
+
id: PaymentInitiated
|
|
22
|
+
version: 0.0.1
|
|
23
|
+
next_steps:
|
|
24
|
+
- "payment_processed"
|
|
25
|
+
- "payment_failed"
|
|
26
|
+
- id: "payment_processed"
|
|
27
|
+
title: Payment Processed
|
|
28
|
+
message:
|
|
29
|
+
id: PaymentProcessed
|
|
30
|
+
version: 0.0.1
|
|
31
|
+
next_steps:
|
|
32
|
+
- id: "adjust_inventory"
|
|
33
|
+
label: Adjust inventory
|
|
34
|
+
- id: "send_custom_notification"
|
|
35
|
+
label: Notify customer
|
|
36
|
+
- id: "payment_failed"
|
|
37
|
+
title: Payment Failed
|
|
38
|
+
type: node
|
|
39
|
+
next_steps:
|
|
40
|
+
- id: "failure_notification"
|
|
41
|
+
label: Notify customer of failure
|
|
42
|
+
- id: "retry_payment"
|
|
43
|
+
label: Retry payment
|
|
44
|
+
- id: "adjust_inventory"
|
|
45
|
+
title: Inventory Adjusted
|
|
46
|
+
message:
|
|
47
|
+
id: InventoryAdjusted
|
|
48
|
+
version: 1.0.1
|
|
49
|
+
next_step:
|
|
50
|
+
id: "payment_complete"
|
|
51
|
+
label: Complete order
|
|
52
|
+
- id: "send_custom_notification"
|
|
53
|
+
title: Customer Notified of Payment
|
|
54
|
+
type: node
|
|
55
|
+
next_step:
|
|
56
|
+
id: "payment_complete"
|
|
57
|
+
label: Complete order
|
|
58
|
+
- id: "failure_notification"
|
|
59
|
+
title: Customer Notified of Failure
|
|
60
|
+
type: node
|
|
61
|
+
- id: "retry_payment"
|
|
62
|
+
title: Retry Payment
|
|
63
|
+
type: node
|
|
64
|
+
next_step:
|
|
65
|
+
id: "payment_initiated"
|
|
66
|
+
label: Retry payment process
|
|
67
|
+
- id: "payment_complete"
|
|
68
|
+
title: Payment Complete
|
|
69
|
+
message:
|
|
70
|
+
id: PaymentComplete
|
|
71
|
+
version: 0.0.2
|
|
72
|
+
next_step:
|
|
73
|
+
id: "order-complete"
|
|
74
|
+
label: Order completed
|
|
75
|
+
- id: "order-complete"
|
|
76
|
+
title: Order Completed
|
|
77
|
+
type: node
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
### Flow of feature
|
|
81
|
+
<NodeGraph/>
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: "CancelSubscription"
|
|
3
|
+
name: "User Cancels Subscription"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
summary: "Flow for when a user has cancelled a subscription"
|
|
6
|
+
steps:
|
|
7
|
+
- id: "cancel_subscription_initiated"
|
|
8
|
+
title: "Cancels Subscription"
|
|
9
|
+
summary: "User cancels their subscription"
|
|
10
|
+
actor:
|
|
11
|
+
name: "User"
|
|
12
|
+
next_step:
|
|
13
|
+
id: "cancel_subscription_request"
|
|
14
|
+
label: "Initiate subscription cancellation"
|
|
15
|
+
|
|
16
|
+
- id: "cancel_subscription_request"
|
|
17
|
+
title: "Cancel Subscription"
|
|
18
|
+
message:
|
|
19
|
+
id: "CancelSubscription"
|
|
20
|
+
version: "0.0.1"
|
|
21
|
+
next_step:
|
|
22
|
+
id: "subscription_service"
|
|
23
|
+
label: "Proceed to subscription service"
|
|
24
|
+
|
|
25
|
+
- id: "stripe_integration"
|
|
26
|
+
title: "Stripe"
|
|
27
|
+
externalSystem:
|
|
28
|
+
name: "Stripe"
|
|
29
|
+
summary: "3rd party payment system"
|
|
30
|
+
url: "https://stripe.com/"
|
|
31
|
+
next_step:
|
|
32
|
+
id: "subscription_service"
|
|
33
|
+
label: "Return to subscription service"
|
|
34
|
+
|
|
35
|
+
- id: "subscription_service"
|
|
36
|
+
title: "Subscription Service"
|
|
37
|
+
service:
|
|
38
|
+
id: "SubscriptionService"
|
|
39
|
+
version: "0.0.1"
|
|
40
|
+
next_steps:
|
|
41
|
+
- id: "stripe_integration"
|
|
42
|
+
label: "Cancel subscription via Stripe"
|
|
43
|
+
- id: "subscription_cancelled"
|
|
44
|
+
label: "Successful cancellation"
|
|
45
|
+
- id: "subscription_rejected"
|
|
46
|
+
label: "Failed cancellation"
|
|
47
|
+
|
|
48
|
+
- id: "subscription_cancelled"
|
|
49
|
+
title: "Subscription has been Cancelled"
|
|
50
|
+
message:
|
|
51
|
+
id: "UserSubscriptionCancelled"
|
|
52
|
+
version: "0.0.1"
|
|
53
|
+
next_step:
|
|
54
|
+
id: "notification_service"
|
|
55
|
+
label: "Email customer"
|
|
56
|
+
|
|
57
|
+
- id: "subscription_rejected"
|
|
58
|
+
title: "Subscription cancellation has been rejected"
|
|
59
|
+
|
|
60
|
+
- id: "notification_service"
|
|
61
|
+
title: "Notifications Service"
|
|
62
|
+
service:
|
|
63
|
+
id: "NotificationService"
|
|
64
|
+
version: "0.0.2"
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
<NodeGraph />
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: "CancelSubscription"
|
|
3
|
+
name: "User Cancels Subscription"
|
|
4
|
+
version: "0.0.1"
|
|
5
|
+
summary: "Flow for when a user has cancelled a subscription"
|
|
6
|
+
steps:
|
|
7
|
+
- id: "cancel_subscription_initiated"
|
|
8
|
+
title: "Cancels Subscription"
|
|
9
|
+
summary: "User cancels their subscription"
|
|
10
|
+
actor:
|
|
11
|
+
name: "User"
|
|
12
|
+
next_step:
|
|
13
|
+
id: "cancel_subscription_request"
|
|
14
|
+
label: "Initiate subscription cancellation"
|
|
15
|
+
|
|
16
|
+
- id: "cancel_subscription_request"
|
|
17
|
+
title: "Cancel Subscription"
|
|
18
|
+
message:
|
|
19
|
+
id: "CancelSubscription"
|
|
20
|
+
version: "0.0.1"
|
|
21
|
+
next_step:
|
|
22
|
+
id: "subscription_service"
|
|
23
|
+
label: "Proceed to subscription service"
|
|
24
|
+
|
|
25
|
+
- id: "stripe_integration"
|
|
26
|
+
title: "Stripe"
|
|
27
|
+
externalSystem:
|
|
28
|
+
name: "Stripe"
|
|
29
|
+
summary: "3rd party payment system"
|
|
30
|
+
url: "https://stripe.com/"
|
|
31
|
+
next_step:
|
|
32
|
+
id: "subscription_service"
|
|
33
|
+
label: "Return to subscription service"
|
|
34
|
+
|
|
35
|
+
- id: "subscription_service"
|
|
36
|
+
title: "Subscription Service"
|
|
37
|
+
service:
|
|
38
|
+
id: "SubscriptionService"
|
|
39
|
+
version: "0.0.1"
|
|
40
|
+
next_steps:
|
|
41
|
+
- id: "stripe_integration"
|
|
42
|
+
label: "Cancel subscription via Stripe"
|
|
43
|
+
- id: "subscription_cancelled"
|
|
44
|
+
label: "Successful cancellation"
|
|
45
|
+
- id: "subscription_rejected"
|
|
46
|
+
label: "Failed cancellation"
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
<NodeGraph />
|