@eventcatalog/create-eventcatalog 4.3.2 → 4.3.4-beta.0

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

@@ -1,43 +0,0 @@
----
-id: PaymentProcessed
-name: Payment Processed
-version: 1.0.0
-schemaPath: schema.json
-summary: Event is triggered after the payment has been successfully processed
-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.
-
-<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.5,
-  "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/domains/Payment/services/PaymentService/events/PaymentProcessed/schema.json

@@ -1,54 +0,0 @@
-{
-  "$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

@@ -1,43 +0,0 @@
----
-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
----
-
-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.5,
-  "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/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/schema.json

@@ -1,54 +0,0 @@
-{
-  "$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/index.mdx

@@ -1,41 +0,0 @@
----
-id: PaymentService
-name: Payment Service
-version: 0.0.1
-summary: |
-  Service that handles payments
-owners:
-  - dboyne
-receives:
-  - id: PaymentInitiated
-    version: 0.0.1
-    from:
-      - id: 'payments.{env}.events'
-        parameters:
-          env: staging
-  - id: GetPaymentStatus
-sends:
-  - id: PaymentProcessed
-    version: 0.0.1
-    to:
-      - id: 'payments.{env}.events'
-        parameters:
-          env: staging
-repository:
-  language: JavaScript
-  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.
-
-<NodeGraph />
-
-### Key Components
-
-- Payment API: Exposes endpoints for initiating payments and querying payment status.
-- Payment Processor: Handles the core payment processing logic.
-- Event Bus: Manages the communication between services using events.
-- Payment Gateway: Interfaces with external payment providers.
-- Transaction Service: Manages transaction records and states.
-- Notification Service: Sends notifications related to payment status changes.
-- Database: Stores transaction data and payment status.

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

@@ -1,26 +0,0 @@
----
-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

@@ -1,39 +0,0 @@
-{
-  "$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.mdx

@@ -1,96 +0,0 @@
----
-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/ProductCatalog/entities/Category/index.mdx

@@ -1,127 +0,0 @@
----
-id: Category
-name: Category
-version: 1.0.0
-identifier: categoryId
-aggregateRoot: true
-summary: Represents a product category with hierarchical structure support.
-owners:
-  - dboyne
-properties:
-  - name: categoryId
-    type: UUID
-    required: true
-    description: Unique identifier for the category
-  - name: name
-    type: string
-    required: true
-    description: Name of the category
-  - name: description
-    type: string
-    required: false
-    description: Description of the category
-  - name: slug
-    type: string
-    required: true
-    description: URL-friendly identifier for the category
-  - name: parentCategoryId
-    type: UUID
-    required: false
-    description: Parent category for hierarchical structure
-    references: Category
-    referencesIdentifier: categoryId
-    relationType: hasOne
-  - name: childCategories
-    type: array
-    items:
-      type: Category
-    required: false
-    description: Subcategories under this category
-    references: Category
-    referencesIdentifier: parentCategoryId
-    relationType: hasMany
-  - name: level
-    type: integer
-    required: true
-    description: Depth level in the category hierarchy (0 = root)
-  - name: isActive
-    type: boolean
-    required: true
-    description: Whether the category is currently active
-  - name: sortOrder
-    type: integer
-    required: false
-    description: Display order within the same level
-  - name: icon
-    type: string
-    required: false
-    description: Icon URL or identifier for the category
-  - name: imageUrl
-    type: string
-    required: false
-    description: Category banner or thumbnail image
-  - name: seoTitle
-    type: string
-    required: false
-    description: SEO-optimized title for the category page
-  - name: seoDescription
-    type: string
-    required: false
-    description: SEO meta description for the category page
-  - name: products
-    type: array
-    items:
-      type: Product
-    required: false
-    description: Products belonging to this category
-    references: Product
-    referencesIdentifier: categoryId
-    relationType: hasMany
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Date and time when the category was created
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the category was last updated
----
-
-## Overview
-
-The Category entity organizes products into a hierarchical structure, supporting multi-level categorization. It enables efficient product discovery and navigation through the e-commerce catalog.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Parent Category:** Each category can have one parent `Category` (identified by `parentCategoryId`).
-- **Child Categories:** A category can have multiple child `Category` entities creating a hierarchy.
-- **Products:** A category contains multiple `Product` entities (identified by `categoryId`).
-
-## Hierarchy Examples
-
-```
-Electronics (Level 0)
-├── Computers (Level 1)
-│   ├── Laptops (Level 2)
-│   ├── Desktops (Level 2)
-│   └── Tablets (Level 2)
-├── Mobile Phones (Level 1)
-│   ├── Smartphones (Level 2)
-│   └── Feature Phones (Level 2)
-└── Audio (Level 1)
-    ├── Headphones (Level 2)
-    └── Speakers (Level 2)
-```
-
-## Business Rules
-
-- Root categories have `parentCategoryId` as null and `level` as 0
-- Child categories must have a valid `parentCategoryId`
-- Category slugs must be unique across the entire catalog
-- Categories cannot be deleted if they contain products or subcategories
-- Inactive categories should hide all associated products from public view
-- Maximum hierarchy depth should be limited (e.g., 5 levels)

package/templates/default/domains/ProductCatalog/entities/Inventory/index.mdx

@@ -1,119 +0,0 @@
----
-id: Inventory
-name: Inventory
-version: 1.0.0
-identifier: inventoryId
-summary: Tracks stock levels and availability for products.
-owners:
-  - dboyne
-properties:
-  - name: inventoryId
-    type: UUID
-    required: true
-    description: Unique identifier for the inventory record
-  - name: productId
-    type: UUID
-    required: true
-    description: Product this inventory record tracks
-    references: Product
-    referencesIdentifier: productId
-    relationType: hasOne
-  - name: sku
-    type: string
-    required: true
-    description: Stock Keeping Unit matching the product SKU
-  - name: quantityOnHand
-    type: integer
-    required: true
-    description: Current available stock quantity
-  - name: quantityReserved
-    type: integer
-    required: true
-    description: Quantity reserved for pending orders
-  - name: quantityAvailable
-    type: integer
-    required: true
-    description: Calculated available quantity (onHand - reserved)
-  - name: minimumStockLevel
-    type: integer
-    required: true
-    description: Minimum stock level before reorder alert
-  - name: maximumStockLevel
-    type: integer
-    required: false
-    description: Maximum stock level for inventory management
-  - name: reorderPoint
-    type: integer
-    required: true
-    description: Stock level that triggers reorder process
-  - name: reorderQuantity
-    type: integer
-    required: true
-    description: Quantity to order when restocking
-  - name: unitCost
-    type: decimal
-    required: false
-    description: Cost per unit for inventory valuation
-  - name: warehouseLocation
-    type: string
-    required: false
-    description: Physical location or bin where item is stored
-  - name: lastRestockedAt
-    type: DateTime
-    required: false
-    description: Date and time of last restock
-  - name: lastSoldAt
-    type: DateTime
-    required: false
-    description: Date and time of last sale
-  - name: isTrackingEnabled
-    type: boolean
-    required: true
-    description: Whether inventory tracking is enabled for this product
-  - name: backorderAllowed
-    type: boolean
-    required: true
-    description: Whether backorders are allowed when out of stock
-  - name: createdAt
-    type: DateTime
-    required: true
-    description: Date and time when the inventory record was created
-  - name: updatedAt
-    type: DateTime
-    required: false
-    description: Date and time when the inventory record was last updated
----
-
-## Overview
-
-The Inventory entity manages stock levels and availability for products in the e-commerce system. It tracks current quantities, reserved stock, and provides reorder management capabilities.
-
-### Entity Properties
-
-<EntityPropertiesTable />
-
-## Relationships
-
-- **Product:** Each inventory record belongs to one `Product` (identified by `productId`).
-- **OrderItem:** Inventory quantities are affected by `OrderItem` entities when orders are placed.
-
-## Stock Calculations
-
-- **Available Quantity** = Quantity On Hand - Quantity Reserved
-- **Reorder Needed** = Quantity Available &lt;= Reorder Point
-- **Stock Value** = Quantity On Hand × Unit Cost
-
-## Examples
-
-- **Inventory #1:** iPhone 15 Pro - 25 on hand, 5 reserved, 20 available, reorder at 10 units.
-- **Inventory #2:** Running Shoes Size 9 - 0 on hand, 2 reserved, backorder allowed.
-
-## Business Rules
-
-- Quantity on hand cannot be negative
-- Quantity reserved cannot exceed quantity on hand
-- Available quantity is automatically calculated
-- Reorder alerts are triggered when available = reorder point
-- Stock reservations are created when orders are placed
-- Stock is decremented when orders are shipped
-- Inventory adjustments must be logged for audit trail