@eventcatalog/create-eventcatalog 2.0.22 → 2.1.0

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/order-service-asyncapi.yaml

@@ -0,0 +1,148 @@
+asyncapi: 3.0.0
+
+info:
+  title: Order service
+  description: | 
+    This service is in charge of processing order events.
+  version: '1.0.0'
+
+servers: 
+  topic:
+    host: https://mytopic.com
+    description: Custom Topic.
+    protocol: HTTPS
+
+defaultContentType: application/json
+
+channels:
+  orderEventsChannel:
+    address: 'orders.{orderId}'
+    description: All Order related events are distributed and broadcasted for the interested consumers.
+    title: Order events channel
+    messages:
+      OrderConfirmed:
+        summary: Order confirmed event
+        $ref: '#/components/messages/OrderConfirmed'
+      OrderPlaced:
+        summary: Order placed event
+        $ref: '#/components/messages/OrderPlaced'
+
+operations: 
+  onOrderConfirmation:
+    summary: Action to confirm an order.
+    description: The product availability of an order will lead to the confirmation of the order.
+    title: Order Confirmed
+    channel:
+      $ref: '#/channels/orderEventsChannel'
+    action: send
+  onOrderPlacement:
+    summary: Action to place an order.
+    description: The reception and validation of an order will lead to the placement of the order.
+    title: Order Placed
+    channel:
+      $ref: '#/channels/orderEventsChannel'
+    action: send
+
+components:
+  messages:
+    OrderConfirmed:
+      payload:
+        $ref: '#/components/schemas/OrderConfirmed'
+
+    OrderPlaced:
+      payload:
+        $ref: '#/components/schemas/OrderPlaced'
+
+  schemas:
+    orderId:
+      description: The unique identifier of an order
+      type: string
+      pattern: ^([A-Za-z0-9_-]{21})$
+
+    userId:
+      description: The unique identifier of a user
+      type: string
+      pattern: ^([A-Za-z0-9_-]{21})$
+
+    productId:
+      description: The product unique identifier
+      type: string
+      pattern: ^([A-Za-z0-9_-]{21})$
+
+    Order:
+      required:
+        - orderId
+        - userId
+        - productId
+        - price
+        - quantity
+        - orderDate
+      type: object
+      description: order model
+      properties:
+        orderId:
+          "$ref": "#/components/schemas/orderId"
+        orderDate:
+          description: Date of order submition.
+          type: string
+          format: date-time
+        userId:
+          "$ref": "#/components/schemas/userId"
+        productId:
+          "$ref": "#/components/schemas/productId"
+        price:
+          type: number
+        quantity:
+          type: integer
+      title: Order
+
+    EventEnvelope:
+      type: object
+      allOf:
+      - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
+      properties:
+        id:
+          type: string
+          format: uuid
+        idempotencykey:
+          type: string
+          format: uuid
+        correlationid:
+          type: string
+          format: uuid
+        causationid:
+          type: string
+          format: uuid
+
+    EventType:
+      type: string
+      enum: 
+        - "order.placed" 
+        - "order.confirmed"
+
+    OrderConfirmed:
+      type: object
+      additionalProperties: false
+      allOf:
+        - $ref: '#/components/schemas/EventEnvelope'  
+      properties:
+        data:
+          $ref: '#/components/schemas/Order'
+        type:
+          $ref: '#/components/schemas/EventType'
+
+      required:
+        - data
+
+    OrderPlaced:
+      type: object
+      additionalProperties: false
+      allOf:
+        - $ref: '#/components/schemas/EventEnvelope'
+      properties:
+        data:
+          $ref: '#/components/schemas/Order'
+        type:
+          $ref: '#/components/schemas/EventType'
+      required:
+        - data

package/templates/default/domains/Orders/versioned/0.0.1/index.md

@@ -6,6 +6,7 @@ summary: |
   Domain for everything shopping
 owners:
     - dboyne
+    - full-stack
 services:
     - id: InventoryService
       version: 0.0.2

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

@@ -0,0 +1,49 @@
+---
+id: Orders
+name: Orders
+version: 0.0.2
+owners:
+  - dboyne
+services:
+  - id: InventoryService
+    version: 0.0.2
+  - id: NotificationService
+    version: 0.0.2
+  - id: OrdersService
+    version: 0.0.2
+badges:
+  - content: New domain
+    backgroundColor: blue
+    textColor: blue
+---
+
+## Overview
+
+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.
+
+<Admonition type="warning">Please ensure all services are updated to the latest version for compatibility and performance improvements.</Admonition>
+
+## Bounded context
+
+<NodeGraph />
+
+### Order example (sequence diagram)
+
+```mermaid
+sequenceDiagram
+    participant Customer
+    participant OrdersService
+    participant InventoryService
+    participant NotificationService
+
+    Customer->>OrdersService: Place Order
+    OrdersService->>InventoryService: Check Inventory
+    InventoryService-->>OrdersService: Inventory Available
+    OrdersService->>InventoryService: Reserve Inventory
+    OrdersService->>NotificationService: Send Order Confirmation
+    NotificationService-->>Customer: Order Confirmation
+    OrdersService->>Customer: Order Placed Successfully
+    OrdersService->>InventoryService: Update Inventory
+```
+
+ 

package/templates/default/domains/Payment/index.md

@@ -1,7 +1,7 @@
 ---
 id: Payment
 name: Payment
-version: 0.0.2
+version: 0.0.1
 summary: |
   Domain that contains payment related services and messages.
 owners:
@@ -22,8 +22,3 @@ The Payment Domain encompasses all services and components related to handling f
 ## Bounded context
 
 <NodeGraph />
-
-### Payment processing flow
-Documented flow when a user makes a payment within the order domain
-
-<Flow id="PaymentFlow" version="latest" includeKey={false} />

package/templates/default/{events/Payment → domains/Payment/services/PaymentService/events}/PaymentInitiated/index.md

@@ -5,8 +5,14 @@ version: 0.0.1
 summary: Event is triggered when a user initiates a payment through the Payment Service
 owners:
     - dboyne
+channels:
+  - id: payments.{env}.events
+    parameters:
+      env: staging
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 The Payment Initiated event is triggered when a user initiates a payment through the Payment Service. This event signifies the beginning of the payment process and contains all necessary information to process the payment.
@@ -29,4 +35,6 @@ The Payment Initiated event is triggered when a user initiates a payment through
 
 - **Authentication**: Ensure that only authenticated users can initiate a payment, and the userId in the payload matches the authenticated user.
 - **Data Validation**: Validate all input data to prevent injection attacks or other malicious input.
-- **Sensitive Data Handling**: Avoid including sensitive information (e.g., credit card numbers) in the event payload. Use secure channels and encryption for such data.
+- **Sensitive Data Handling**: Avoid including sensitive information (e.g., credit card numbers) in the event payload. Use secure channels and encryption for such data.
+
+<Footer />

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

@@ -0,0 +1,46 @@
+---
+id: PaymentProcessed
+name: Payment Processed
+version: 1.0.0
+summary: Event is triggered after the payment has been successfully processed
+owners:
+    - dboyne
+channels:
+  - id: payments.{env}.events
+    parameters:
+      env: staging
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The PaymentProcessed event is triggered after the payment has been successfully processed by the Payment Service. This event signifies that a payment has been confirmed, and it communicates the outcome to other services and components within the system.
+
+<NodeGraph />
+
+### Payload Example
+
+```json title="Payload example"
+{
+  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
+  "userId": "123e4567-e89b-12d3-a456-426614174000",
+  "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
+  "amount": 100.50,
+  "paymentMethod": "CreditCard",
+  "status": "confirmed",
+  "confirmationDetails": {
+    "gatewayResponse": "Approved",
+    "transactionId": "abc123"
+  },
+  "timestamp": "2024-07-04T14:48:00Z"
+}
+```
+
+### Security Considerations
+
+- **Data Validation**: Ensure that all data in the event payload is validated before publishing to prevent injection attacks or other malicious activities.
+- **Sensitive Data Handling**: Avoid including sensitive information (e.g., full credit card numbers) in the event payload. Use secure channels and encryption for such data.
+- **Authentication and Authorization**: Ensure that only authorized services can publish or consume PaymentProcessed events.
+
+<Footer />

package/templates/default/{events/Payment/PaymentProcessed → domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1}/index.md

@@ -7,6 +7,8 @@ owners:
     - dboyne
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 The PaymentProcessed event is triggered after the payment has been successfully processed by the Payment Service. This event signifies that a payment has been confirmed, and it communicates the outcome to other services and components within the system.
@@ -35,4 +37,6 @@ The PaymentProcessed event is triggered after the payment has been successfully
 
 - **Data Validation**: Ensure that all data in the event payload is validated before publishing to prevent injection attacks or other malicious activities.
 - **Sensitive Data Handling**: Avoid including sensitive information (e.g., full credit card numbers) in the event payload. Use secure channels and encryption for such data.
-- **Authentication and Authorization**: Ensure that only authorized services can publish or consume PaymentProcessed events.
+- **Authentication and Authorization**: Ensure that only authorized services can publish or consume PaymentProcessed events.
+
+<Footer />

package/templates/default/{services → domains/Payment/services}/PaymentService/index.md

@@ -9,23 +9,18 @@ owners:
 receives:
   - id: PaymentInitiated
     version: 0.0.1
+  - id: GetPaymentStatus
 sends:
   - id: PaymentProcessed
     version: 0.0.1
+  - id: GetOrder
 repository:
   language: JavaScript
-  url: https://github.com/boyney123/pretend-shipping-service
+  url: https://github.com/event-catalog/pretend-shipping-service
 ---
 
 The Payment Service is a crucial component of our system that handles all payment-related operations. It processes payments, manages transactions, and communicates with other services through events. Using an event-driven architecture, it ensures that all actions are asynchronous, decoupled, and scalable.
 
-<Tiles >
-    <Tile icon="DocumentIcon" href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}  title="View the changelog" description="Want to know the history of this service? View the change logs" />
-    <Tile icon="UserGroupIcon" href="/docs/users/dboyne" title="Contact the owner" description="Any questions? Feel free to contact the owners" />
-    <Tile icon="BoltIcon" href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Sends ${frontmatter.sends.length} messages`} description="This service sends messages to downstream consumers" />
-    <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
-</Tiles>
-
 <NodeGraph />
 
 ### Key Components

package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/index.md

@@ -0,0 +1,26 @@
+---
+id: GetPaymentStatus
+name: Get payment status
+version: 0.0.1
+summary: |
+  GET request that will return the payment status for a specific order, identified by its orderId.
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `GetPaymentStatus` message is a query used to retrieve the payment status for a specific order, identified by its `orderId`. This query returns the current status of the payment, such as whether it is pending, completed, failed, or refunded. It is used by systems that need to track the lifecycle of payments associated with orders, ensuring that the payment has been successfully processed or identifying if any issues occurred during the transaction.
+
+This query is useful in scenarios such as order management, refund processing, or payment auditing, ensuring that users or systems have real-time visibility into the payment status for a given order.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/schema.json

@@ -0,0 +1,40 @@
+
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "GetPaymentStatusResponse",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "type": "string",
+      "description": "The unique identifier for the order."
+    },
+    "paymentStatus": {
+      "type": "string",
+      "enum": ["pending", "completed", "failed", "refunded"],
+      "description": "The current payment status of the order."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The amount paid for the order."
+    },
+    "currency": {
+      "type": "string",
+      "description": "The currency in which the payment was made (e.g., USD, EUR)."
+    },
+    "paymentMethod": {
+      "type": "string",
+      "description": "The payment method used for the transaction (e.g., Credit Card, PayPal)."
+    },
+    "transactionId": {
+      "type": "string",
+      "description": "The unique identifier for the payment transaction."
+    },
+    "paymentDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the payment was processed."
+    }
+  },
+  "required": ["orderId", "paymentStatus", "amount", "currency", "paymentMethod", "transactionId", "paymentDate"],
+  "additionalProperties": false
+}

package/templates/default/domains/Subscriptions/index.md

@@ -0,0 +1,24 @@
+---
+id: Subscription
+name: Subscription
+version: 0.0.1
+summary: |
+  Domain that contains subscription related services and messages.
+owners:
+    - dboyne
+services:
+    - id: SubscriptionService
+      version: 0.0.1
+badges:
+    - content: Payment Domain
+      backgroundColor: blue
+      textColor: blue
+---
+
+## Overview
+
+The Payment Domain encompasses all services and components related to handling financial transactions within the system. It is responsible for managing payments, transactions, billing, and financial records. The domain ensures secure, reliable, and efficient processing of all payment-related activities
+
+## Bounded context
+
+<NodeGraph />

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/index.md

@@ -0,0 +1,25 @@
+---
+id: CancelSubscription
+name: Cancel subscription
+version: 0.0.1
+summary: |
+  Command that will try and cancel a users subscription
+owners:
+    - dboyne
+badges:
+    - content: New!
+      backgroundColor: green
+      textColor: green
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `CancelSubscription` command will try and cancel a subscription for the user.
+
+## Architecture diagram
+
+<NodeGraph />
+
+<Footer />

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

@@ -0,0 +1,25 @@
+---
+id: SubscribeUser
+name: Subscribe user
+version: 0.0.1
+summary: |
+  Command that will try and subscribe a given user
+owners:
+    - dboyne
+badges:
+    - content: New!
+      backgroundColor: green
+      textColor: green
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `SubscribeUser` command represents when a new user wants to subscribe to our service.
+
+## Architecture diagram
+
+<NodeGraph />
+
+<Footer />

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

@@ -0,0 +1,25 @@
+---
+id: UserSubscriptionCancelled
+name: User subscription cancelled
+version: 0.0.1
+summary: |
+  An event that is triggered when a users subscription has been cancelled
+owners:
+    - dboyne
+badges:
+    - content: New!
+      backgroundColor: green
+      textColor: green
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `UserSubscriptionCancelled` event is triggered when a users subscription has been cancelled.
+
+## Architecture diagram
+
+<NodeGraph />
+
+<Footer />

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

@@ -0,0 +1,25 @@
+---
+id: UserSubscriptionStarted
+name: User subscription started
+version: 0.0.1
+summary: |
+  An event that is triggered when a new user subscription has started
+owners:
+    - dboyne
+badges:
+    - content: New!
+      backgroundColor: green
+      textColor: green
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `UserSubscriptionStarted` event is triggered when a user starts a new subscription with our service.
+
+## Architecture diagram
+
+<NodeGraph />
+
+<Footer />

package/templates/default/domains/Subscriptions/services/SubscriptionService/index.md

@@ -0,0 +1,42 @@
+---
+id: SubscriptionService
+version: 0.0.1
+name: Subscription Service
+summary: |
+  Service that handles subscriptions
+owners:
+    - dboyne
+receives:
+  - id: SubscribeUser
+    version: 0.0.1
+  - id: CancelSubscription
+    version: 0.0.1
+  - id: GetSubscriptionStatus  
+sends:
+  - id: UserSubscriptionStarted
+    version: 0.0.1
+  - id: UserSubscriptionCancelled  
+    version: 0.0.1
+repository:
+  language: JavaScript
+  url: https://github.com/event-catalog/pretend-subscription-service
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The subscription Service is responsible for handling customer subscriptions in our system. It handles new subscriptions, cancelling subscriptions and updating them.
+
+<Tiles >
+    <Tile icon="DocumentIcon" href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}  title="View the changelog" description="Want to know the history of this service? View the change logs" />
+    <Tile icon="UserGroupIcon" href="/docs/teams/full-stack" title="Contact the team" description="Any questions? Feel free to contact the owners" />
+    <Tile icon="BoltIcon" href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Sends ${frontmatter.sends.length} messages`} description="This service sends messages to downstream consumers" />
+    <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
+</Tiles>
+
+## Architecture diagram 
+
+<NodeGraph />
+
+<Footer />

package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/index.md

@@ -0,0 +1,26 @@
+---
+id: GetSubscriptionStatus
+name: Get subscription status
+version: 0.0.2
+summary: |
+  GET request that will return the current subscription status for a specific user, identified by their userId.
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `GetSubscriptionStatus` message is a query used to retrieve the current subscription status for a specific user, identified by their `userId`. This query returns detailed information about the user's subscription, such as its current status (active, canceled, expired), the subscription tier or plan, and the next billing date. It is typically used by systems that manage user subscriptions, billing, and renewal processes to ensure that users are aware of their subscription details and any upcoming renewals.
+
+This query is particularly useful in managing subscriptions for SaaS products, media services, or any recurring payment-based services where users need to manage and view their subscription information.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/schema.json

@@ -0,0 +1,46 @@
+
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "GetSubscriptionStatusResponse",
+  "type": "object",
+  "properties": {
+    "userId": {
+      "type": "string",
+      "description": "The unique identifier for the user."
+    },
+    "subscriptionStatus": {
+      "type": "string",
+      "enum": ["active", "canceled", "expired", "pending"],
+      "description": "The current status of the user's subscription."
+    },
+    "subscriptionPlan": {
+      "type": "string",
+      "description": "The name or tier of the subscription plan."
+    },
+    "nextBillingDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time of the next billing or renewal."
+    },
+    "billingFrequency": {
+      "type": "string",
+      "enum": ["monthly", "yearly"],
+      "description": "The frequency of the billing cycle."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The amount to be billed for the subscription."
+    },
+    "currency": {
+      "type": "string",
+      "description": "The currency in which the subscription is billed (e.g., USD, EUR)."
+    },
+    "lastPaymentDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the last payment was processed."
+    }
+  },
+  "required": ["userId", "subscriptionStatus", "subscriptionPlan", "nextBillingDate", "billingFrequency", "amount", "currency", "lastPaymentDate"],
+  "additionalProperties": false
+}