@eventcatalog/create-eventcatalog 2.0.22 → 2.1.1

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/ubiquitous-language.md

@@ -0,0 +1,127 @@
+---
+dictionary:
+  - id: Payment
+    name: Payment
+    summary: "The act of paying for magical goods or services."
+    icon: Wand2
+  - id: Purchase Order
+    name: Purchase Order
+    summary: "A mystical document issued by a buyer to a seller indicating the types, quantities, and agreed prices for enchanted products or services."
+    description: |
+      A purchase order (PO) is a magical document that initiates the buying process between mystical entities. It protects both buyer and seller by clearly documenting the transaction details. Key components include:
+
+      - Unique PO number for tracking
+      - Detailed item specifications and quantities
+      - Agreed prices and payment terms
+      - Delivery requirements and timelines
+      - Terms and conditions of the purchase
+
+      POs are essential for budget control, audit trails, and inventory management. They help prevent unauthorized purchases and provide a clear record for accounting and reconciliation purposes.
+    icon: FileText
+  - id: Order Line
+    name: Order Line
+    summary: "An individual enchanted item within a purchase order, representing a specific magical product or service being ordered."
+    description: |
+      Order lines are the fundamental building blocks of any purchase order. Each line represents a distinct item or service and contains critical information for order fulfillment:
+
+      - Product identifier (SKU or part number)
+      - Quantity ordered
+      - Unit price and total line value
+      - Special handling instructions
+      - Required delivery date
+
+      Order lines drive warehouse picking operations, shipping processes, and financial calculations. They are essential for tracking partial shipments and managing order modifications.
+    icon: ListOrdered
+  - id: SKU
+    name: SKU
+    summary: "Sorcery Keeping Unit - A unique identifier for distinct magical products and their variants in inventory."
+    description: |
+      SKUs are the cornerstone of effective inventory management systems. Each SKU represents a unique combination of product attributes:
+
+      - Product variations (size, color, style)
+      - Storage location identifiers
+      - Supplier information
+      - Reorder points and quantities
+
+      SKUs enable precise inventory tracking, automated reordering, and detailed sales analytics. They are crucial for maintaining optimal stock levels and preventing stockouts or overstock situations.
+    icon: Tag
+  - id: Consignment
+    name: Consignment
+    summary: "A batch of enchanted goods destined for or delivered to someone."
+    description: |
+      A consignment represents the physical movement of goods through the supply chain. It encompasses all aspects of the shipping process:
+
+      - Packaging and labeling requirements
+      - Transportation method and routing
+      - Customs documentation for international shipments
+      - Tracking and proof of delivery
+
+      Consignments may combine multiple orders for efficient shipping and can be tracked as a single unit throughout the delivery process. They are crucial for managing logistics costs and ensuring timely delivery to customers.
+    icon: Package
+  - id: Invoice
+    name: Invoice
+    summary: "A document issued by a seller to a buyer, listing enchanted goods or services provided and the amount due."
+    description: |
+      Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
+
+      - Invoice number for tracking
+      - List of products or services provided
+      - Total amount due and payment terms
+      - Seller and buyer contact information
+      - Due date for payment
+
+      Invoices are essential for accounting, tax purposes, and maintaining cash flow.
+    icon: Receipt
+  - id: Supplier
+    name: Supplier
+    summary: "An entity that provides enchanted goods or services to another organization."
+    description: |
+      Suppliers are key partners in the supply chain, responsible for delivering the necessary products or services. Key aspects include:
+
+      - Supplier identification and contact details
+      - Product or service offerings
+      - Pricing and payment terms
+      - Delivery schedules and reliability
+
+      Effective supplier management ensures quality, cost-effectiveness, and timely delivery.
+    icon: Truck
+  - id: Inventory
+    name: Inventory
+    summary: "The complete list of enchanted items held in stock by a business."
+    description: |
+      Inventory management is crucial for balancing supply and demand. It involves:
+
+      - Tracking stock levels and locations
+      - Managing reorder points and quantities
+      - Conducting regular stock audits
+      - Analyzing inventory turnover rates
+
+      Proper inventory management minimizes costs and maximizes service levels.
+    icon: Warehouse
+  - id: Fulfillment
+    name: Fulfillment
+    summary: "The process of completing an order and delivering it to the customer."
+    description: |
+      Fulfillment encompasses all steps from order receipt to delivery, including:
+
+      - Order processing and picking
+      - Packaging and shipping
+      - Delivery tracking and confirmation
+      - Handling returns and exchanges
+
+      Efficient fulfillment is key to customer satisfaction and operational efficiency.
+    icon: PackageCheck
+  - id: Return
+    name: Return
+    summary: "The process of sending back enchanted goods to the seller for a refund or exchange."
+    description: |
+      Returns management is an important aspect of customer service and inventory control. It involves:
+
+      - Processing return requests and authorizations
+      - Inspecting returned items for quality
+      - Restocking or disposing of returned goods
+      - Issuing refunds or exchanges
+
+      A streamlined returns process enhances customer loyalty and operational efficiency.
+    icon: PackageX
+---

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/Payment/ubiquitous-language.md

@@ -0,0 +1,96 @@
+---
+dictionary:
+  - id: Transaction
+    name: Transaction
+    summary: "The process of transferring funds from one party to another."
+    icon: CreditCard
+  - id: Invoice
+    name: Invoice
+    summary: "A document issued by a seller to a buyer, listing goods or services provided and the amount due."
+    description: |
+      Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
+
+      - Invoice number for tracking
+      - List of products or services provided
+      - Total amount due and payment terms
+      - Seller and buyer contact information
+      - Due date for payment
+
+      Invoices are essential for accounting, tax purposes, and maintaining cash flow.
+    icon: CreditCard
+  - id: Payment Method
+    name: Payment Method
+    summary: "The means by which a payment is made, such as credit card or bank transfer."
+    description: |
+      Payment methods are the various ways customers can pay for goods or services. Common methods include:
+
+      - Credit and debit cards
+      - Bank transfers
+      - Digital wallets
+      - Cash on delivery
+
+      Offering multiple payment methods can enhance customer satisfaction and increase sales.
+    icon: Wallet
+  - id: Receipt
+    name: Receipt
+    summary: "A document acknowledging that a payment has been made."
+    description: |
+      Receipts serve as proof of payment and are important for record-keeping. They typically include:
+
+      - Receipt number
+      - Date and time of payment
+      - Amount paid
+      - Payment method used
+      - Details of the transaction
+
+      Receipts are essential for both customers and businesses to track financial transactions.
+    icon: Receipt
+  - id: Refund
+    name: Refund
+    summary: "The process of returning funds to a customer for a returned product or service."
+    description: |
+      Refunds are issued when a customer returns a product or cancels a service. The process involves:
+
+      - Verifying the return or cancellation
+      - Processing the refund through the original payment method
+      - Updating financial records
+
+      Efficient refund processes can improve customer satisfaction and loyalty.
+    icon: RotateCcw
+  - id: Currency
+    name: Currency
+    summary: "The system of money in general use in a particular country."
+    description: |
+      Currency is the medium of exchange for goods and services. Key aspects include:
+
+      - Currency code (e.g., USD, EUR)
+      - Exchange rates
+      - Currency symbols
+
+      Understanding currency is crucial for international transactions and financial reporting.
+    icon: DollarSign
+  - id: Payment Gateway
+    name: Payment Gateway
+    summary: "A service that authorizes and processes payments for online and offline transactions."
+    description: |
+      Payment gateways facilitate the transfer of payment information between the customer and the merchant. They ensure secure and efficient transactions by:
+
+      - Encrypting sensitive data
+      - Authorizing payments
+      - Providing transaction reports
+
+      Choosing a reliable payment gateway is essential for business operations.
+    icon: Server
+  - id: Chargeback
+    name: Chargeback
+    summary: "A demand by a credit card provider for a retailer to make good the loss on a fraudulent or disputed transaction."
+    description: |
+      Chargebacks occur when a customer disputes a transaction, and the funds are returned to their account. The process involves:
+
+      - Investigating the dispute
+      - Providing evidence to the payment processor
+      - Resolving the issue with the customer
+
+      Managing chargebacks effectively can prevent financial losses and maintain customer trust.
+    icon: AlertCircle
+---

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 />