@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/index.mdx

@@ -1,75 +0,0 @@
----
-id: ProcessPayment
-version: 0.0.1
-name: Process Payment
-summary: Command to process a payment through the payment gateway
-owners:
-  - dboyne
-tags:
-  - payment
-  - command
-  - cross-domain
-badges:
-  - content: Command
-    backgroundColor: blue
-    textColor: white
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `ProcessPayment` command is used to initiate payment processing through the payment gateway. This command can be triggered by various sources including the Billing Service for subscription payments.
-
-## Command Sources
-
-This command can be triggered by:
-
-- **BillingService** (Subscriptions Domain) - For recurring subscription payments
-- **OrdersService** (Orders Domain) - For one-time order payments
-- **PaymentService** (Payment Domain) - For payment retries
-
-## Command Flow
-
-```mermaid
-sequenceDiagram
-    participant BS as BillingService
-    participant PGS as PaymentGatewayService
-    participant FDS as FraudDetectionService
-    participant EXT as External Gateway
-
-    BS->>PGS: ProcessPayment
-    PGS->>FDS: Check Fraud
-    FDS-->>PGS: Risk Assessment
-    PGS->>EXT: Process Payment
-    EXT-->>PGS: Payment Result
-    PGS-->>BS: PaymentProcessed/Failed
-```
-
-## Schema
-
-<SchemaViewer title="ProcessPayment Schema" schemaPath={frontmatter.schemaPath} />
-
-## Example Request
-
-```json
-{
-  "paymentId": "pay_123456",
-  "amount": 49.99,
-  "currency": "USD",
-  "paymentMethod": {
-    "type": "card",
-    "token": "tok_visa_4242"
-  },
-  "metadata": {
-    "subscriptionId": "sub_ABC123",
-    "invoiceId": "inv_123456",
-    "customerId": "cust_XYZ789"
-  },
-  "idempotencyKey": "sub_ABC123_2024_02",
-  "captureImmediately": true
-}
-```
-
-<Footer />

package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/schema.json

@@ -1,58 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "paymentId": {
-      "type": "string",
-      "description": "Unique identifier for this payment"
-    },
-    "amount": {
-      "type": "number",
-      "description": "Payment amount"
-    },
-    "currency": {
-      "type": "string",
-      "description": "Currency code (ISO 4217)"
-    },
-    "paymentMethod": {
-      "type": "object",
-      "properties": {
-        "type": {
-          "type": "string",
-          "enum": ["card", "bank_transfer", "paypal", "digital_wallet"]
-        },
-        "token": {
-          "type": "string",
-          "description": "Payment method token"
-        }
-      },
-      "required": ["type", "token"]
-    },
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "subscriptionId": {
-          "type": "string"
-        },
-        "invoiceId": {
-          "type": "string"
-        },
-        "customerId": {
-          "type": "string"
-        },
-        "orderId": {
-          "type": "string"
-        }
-      }
-    },
-    "idempotencyKey": {
-      "type": "string",
-      "description": "Key to prevent duplicate payments"
-    },
-    "captureImmediately": {
-      "type": "boolean",
-      "description": "Whether to capture payment immediately or just authorize"
-    }
-  },
-  "required": ["paymentId", "amount", "currency", "paymentMethod", "idempotencyKey"]
-}

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/card-declined.json

@@ -1,38 +0,0 @@
-{
-  "eventId": "evt_pf_8a3b1c9d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
-  "timestamp": "2024-03-15T14:23:47.892Z",
-  "type": "PaymentFailed",
-  "source": "payment-gateway-service",
-  "data": {
-    "paymentId": "pay_7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f",
-    "orderId": "ord_92847561",
-    "customerId": "cust_10482",
-    "amount": 249.99,
-    "currency": "USD",
-    "paymentMethod": {
-      "type": "credit_card",
-      "brand": "visa",
-      "last4": "4242",
-      "expiryMonth": 11,
-      "expiryYear": 2026
-    },
-    "failureReason": "card_declined",
-    "failureCode": "DECLINED_GENERIC",
-    "failureMessage": "The card was declined. Please contact your card issuer for more information.",
-    "gatewayResponse": {
-      "gatewayId": "gw_stripe",
-      "transactionId": "txn_3PqR5sT7uV9wX1y",
-      "responseCode": "05",
-      "avsCheck": "pass",
-      "cvvCheck": "pass"
-    },
-    "retryable": true,
-    "attemptNumber": 1,
-    "maxAttempts": 3
-  },
-  "metadata": {
-    "correlationId": "corr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
-    "ipAddress": "192.168.1.42",
-    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
-  }
-}

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/examples.config.yaml

@@ -1,23 +0,0 @@
-card-declined.json:
-  name: Card Declined
-  summary: Payment failed because the card was declined by the issuing bank with a generic decline code.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @card-declined.json
-
-insufficient-funds.json:
-  name: Insufficient Funds
-  summary: Payment failed due to insufficient funds on a Mastercard for a high-value order.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @insufficient-funds.json
-
-expired-card.json:
-  name: Expired Card
-  summary: Payment failed because the customer attempted to use an expired Amex card. This failure is non-retryable.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @expired-card.json

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/expired-card.json

@@ -1,38 +0,0 @@
-{
-  "eventId": "evt_pf_5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
-  "timestamp": "2024-03-16T09:12:05.671Z",
-  "type": "PaymentFailed",
-  "source": "payment-gateway-service",
-  "data": {
-    "paymentId": "pay_9e8d7c6b-5a4f-3e2d-1c0b-9a8f7e6d5c4b",
-    "orderId": "ord_92853298",
-    "customerId": "cust_30692",
-    "amount": 54.5,
-    "currency": "EUR",
-    "paymentMethod": {
-      "type": "credit_card",
-      "brand": "amex",
-      "last4": "1003",
-      "expiryMonth": 1,
-      "expiryYear": 2024
-    },
-    "failureReason": "expired_card",
-    "failureCode": "CARD_EXPIRED",
-    "failureMessage": "The card has expired. Please use a different payment method.",
-    "gatewayResponse": {
-      "gatewayId": "gw_stripe",
-      "transactionId": "txn_OpQrStUvWxYz123",
-      "responseCode": "54",
-      "avsCheck": "unavailable",
-      "cvvCheck": "fail"
-    },
-    "retryable": false,
-    "attemptNumber": 1,
-    "maxAttempts": 3
-  },
-  "metadata": {
-    "correlationId": "corr_11223344-5566-7788-99aa-bbccddeeff00",
-    "ipAddress": "172.16.0.55",
-    "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_3 like Mac OS X)"
-  }
-}

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/insufficient-funds.json

@@ -1,38 +0,0 @@
-{
-  "eventId": "evt_pf_2d3e4f5a-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
-  "timestamp": "2024-03-15T16:45:12.334Z",
-  "type": "PaymentFailed",
-  "source": "payment-gateway-service",
-  "data": {
-    "paymentId": "pay_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
-    "orderId": "ord_92851034",
-    "customerId": "cust_20571",
-    "amount": 1299.0,
-    "currency": "USD",
-    "paymentMethod": {
-      "type": "credit_card",
-      "brand": "mastercard",
-      "last4": "8910",
-      "expiryMonth": 3,
-      "expiryYear": 2027
-    },
-    "failureReason": "insufficient_funds",
-    "failureCode": "INSUFFICIENT_FUNDS",
-    "failureMessage": "The card has insufficient funds to complete this transaction.",
-    "gatewayResponse": {
-      "gatewayId": "gw_stripe",
-      "transactionId": "txn_9AbCdEfGhIjKlMn",
-      "responseCode": "51",
-      "avsCheck": "pass",
-      "cvvCheck": "pass"
-    },
-    "retryable": true,
-    "attemptNumber": 1,
-    "maxAttempts": 3
-  },
-  "metadata": {
-    "correlationId": "corr_f7e6d5c4-b3a2-1098-7654-321fedcba098",
-    "ipAddress": "10.0.0.88",
-    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
-  }
-}

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/index.mdx

@@ -1,64 +0,0 @@
----
-id: PaymentFailed
-version: 0.0.1
-name: Payment Failed
-summary: Emitted when a payment attempt fails
-owners:
-  - dboyne
-badges:
-  - content: Error Event
-    backgroundColor: red
-    textColor: white
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `PaymentFailed` event is emitted when a payment attempt fails for any reason. This event is consumed by various services to handle payment failures appropriately.
-
-## Consumers
-
-This event is consumed by:
-
-- **BillingService** (Subscriptions Domain) - To handle subscription payment failures
-- **OrdersService** (Orders Domain) - To handle order payment failures
-- **NotificationService** (Orders Domain) - To notify customers of payment failures
-
-## Failure Reasons
-
-Common failure reasons include:
-
-- **insufficient_funds** - Card has insufficient funds
-- **card_declined** - Card was declined by issuer
-- **expired_card** - Card has expired
-- **fraud_suspected** - Payment flagged as potentially fraudulent
-- **network_error** - Payment gateway network error
-- **invalid_payment_method** - Payment method is invalid
-
-## Schema
-
-<SchemaViewer title="PaymentFailed Schema" schemaPath={frontmatter.schemaPath} />
-
-## Example Payload
-
-```json
-{
-  "paymentId": "pay_123456",
-  "amount": 49.99,
-  "currency": "USD",
-  "failureReason": "insufficient_funds",
-  "failureMessage": "Your card has insufficient funds",
-  "metadata": {
-    "subscriptionId": "sub_ABC123",
-    "invoiceId": "inv_123456",
-    "customerId": "cust_XYZ789"
-  },
-  "canRetry": true,
-  "nextRetryAt": "2024-02-02T00:00:00Z",
-  "timestamp": "2024-02-01T10:30:00Z"
-}
-```
-
-<Footer />

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/schema.json

@@ -1,68 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "paymentId": {
-      "type": "string",
-      "description": "Unique identifier for the failed payment"
-    },
-    "amount": {
-      "type": "number",
-      "description": "Payment amount that failed"
-    },
-    "currency": {
-      "type": "string",
-      "description": "Currency code (ISO 4217)"
-    },
-    "failureReason": {
-      "type": "string",
-      "enum": [
-        "insufficient_funds",
-        "card_declined",
-        "expired_card",
-        "fraud_suspected",
-        "network_error",
-        "invalid_payment_method",
-        "authentication_required",
-        "other"
-      ],
-      "description": "Reason for payment failure"
-    },
-    "failureMessage": {
-      "type": "string",
-      "description": "Human-readable failure message"
-    },
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "subscriptionId": {
-          "type": "string"
-        },
-        "invoiceId": {
-          "type": "string"
-        },
-        "customerId": {
-          "type": "string"
-        },
-        "orderId": {
-          "type": "string"
-        }
-      }
-    },
-    "canRetry": {
-      "type": "boolean",
-      "description": "Whether this payment can be retried"
-    },
-    "nextRetryAt": {
-      "type": "string",
-      "format": "date-time",
-      "description": "Suggested time for next retry attempt"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the failure occurred"
-    }
-  },
-  "required": ["paymentId", "amount", "currency", "failureReason", "timestamp"]
-}

package/templates/default/domains/Payment/services/PaymentGatewayService/index.mdx

@@ -1,71 +0,0 @@
----
-id: PaymentGatewayService
-version: 0.0.1
-name: Payment Gateway Service
-summary: Manages integration with external payment processors (Stripe, PayPal, etc.)
-tags:
-  - payment
-  - gateway
-  - integration
-repository:
-  url: https://github.com/eventcatalog/payment-gateway-service
-receives:
-  - id: ProcessPayment
-    version: 0.0.1
-  - id: FraudCheckCompleted
-    version: 0.0.1
-sends:
-  - id: PaymentFailed
-    version: 0.0.1
-owners:
-  - dboyne
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The Payment Gateway Service acts as an abstraction layer between our payment system and external payment processors. It handles the complexity of integrating with multiple payment providers and provides a unified interface for payment operations.
-
-## Supported Payment Providers
-
-- **Stripe**: Credit/debit cards, digital wallets
-- **PayPal**: PayPal accounts, PayPal Credit
-- **Square**: In-person and online payments
-- **Adyen**: Global payment processing
-- **Braintree**: Multiple payment methods
-
-## Key Features
-
-- **Multi-provider Support**: Switch between providers seamlessly
-- **Retry Logic**: Automatic retry for failed transactions
-- **Tokenization**: Secure card data handling
-- **Webhook Management**: Handles provider webhooks
-- **Currency Conversion**: Support for 150+ currencies
-
-## API Endpoints
-
-### REST API
-
-- `POST /api/gateway/authorize` - Authorize a payment
-- `POST /api/gateway/capture` - Capture an authorized payment
-- `POST /api/gateway/refund` - Process a refund
-- `GET /api/gateway/status/{transactionId}` - Get transaction status
-
-## Configuration
-
-```yaml
-payment_gateway:
-  providers:
-    stripe:
-      api_key: ${STRIPE_API_KEY}
-      webhook_secret: ${STRIPE_WEBHOOK_SECRET}
-    paypal:
-      client_id: ${PAYPAL_CLIENT_ID}
-      client_secret: ${PAYPAL_CLIENT_SECRET}
-  retry:
-    max_attempts: 3
-    backoff_ms: 1000
-```
-
-<Footer />

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-standard-checkout.json:
-  name: Standard Checkout
-  summary: Payment initiated through the standard web checkout flow with a Visa credit card and multiple items.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @standard-checkout.json
-
-express-checkout.json:
-  name: Express Checkout
-  summary: Payment initiated via Apple Pay express checkout on mobile for a single item with a discount code applied.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @express-checkout.json

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/express-checkout.json

@@ -1,45 +0,0 @@
-{
-  "eventId": "evt_pi_9f8e7d6c-5b4a-3f2e-1d0c-9b8a7f6e5d4c",
-  "timestamp": "2024-03-16T07:33:41.890Z",
-  "type": "PaymentInitiated",
-  "source": "payment-service",
-  "data": {
-    "paymentId": "pay_3e2d1c0b-9a8f-7e6d-5c4b-3a2f1e0d9c8b",
-    "orderId": "ord_92855010",
-    "customerId": "cust_55832",
-    "amount": 29.99,
-    "currency": "USD",
-    "paymentMethod": {
-      "type": "apple_pay",
-      "brand": "mastercard",
-      "last4": "7654",
-      "walletType": "apple_pay"
-    },
-    "checkoutType": "express",
-    "shippingAddress": {
-      "line1": "890 Broadway",
-      "city": "New York",
-      "state": "NY",
-      "postalCode": "10003",
-      "country": "US"
-    },
-    "items": [
-      {
-        "productId": "prod_8210",
-        "name": "Phone Case - Clear",
-        "quantity": 1,
-        "unitPrice": 29.99
-      }
-    ],
-    "discountCode": "SAVE10",
-    "taxAmount": 2.66,
-    "shippingCost": 0.0,
-    "initiatedAt": "2024-03-16T07:33:41.890Z"
-  },
-  "metadata": {
-    "correlationId": "corr_c3d4e5f6-a7b8-9012-cdef-345678901234",
-    "channel": "mobile_app",
-    "ipAddress": "10.0.0.201",
-    "sessionId": "sess_2r3s4t5u6v7w8x9y"
-  }
-}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/standard-checkout.json

@@ -1,52 +0,0 @@
-{
-  "eventId": "evt_pi_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
-  "timestamp": "2024-03-15T10:58:22.104Z",
-  "type": "PaymentInitiated",
-  "source": "payment-service",
-  "data": {
-    "paymentId": "pay_4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
-    "orderId": "ord_92840123",
-    "customerId": "cust_10482",
-    "amount": 189.97,
-    "currency": "USD",
-    "paymentMethod": {
-      "type": "credit_card",
-      "brand": "visa",
-      "last4": "4242",
-      "expiryMonth": 11,
-      "expiryYear": 2026
-    },
-    "checkoutType": "standard",
-    "shippingAddress": {
-      "line1": "123 Main Street",
-      "city": "San Francisco",
-      "state": "CA",
-      "postalCode": "94102",
-      "country": "US"
-    },
-    "items": [
-      {
-        "productId": "prod_5001",
-        "name": "Wireless Headphones",
-        "quantity": 1,
-        "unitPrice": 149.99
-      },
-      {
-        "productId": "prod_5032",
-        "name": "USB-C Cable",
-        "quantity": 2,
-        "unitPrice": 19.99
-      }
-    ],
-    "discountCode": null,
-    "taxAmount": 15.58,
-    "shippingCost": 0.0,
-    "initiatedAt": "2024-03-15T10:58:22.104Z"
-  },
-  "metadata": {
-    "correlationId": "corr_b2c3d4e5-f6a7-8901-bcde-f23456789012",
-    "channel": "web",
-    "ipAddress": "192.168.1.42",
-    "sessionId": "sess_7k8l9m0n1o2p3q4r"
-  }
-}

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

@@ -1,37 +0,0 @@
----
-id: PaymentInitiated
-name: Payment Initiated
-version: 0.0.1
-schemaPath: schema.json
-summary: Event is triggered when a user initiates a payment through the Payment Service
-owners:
-  - dboyne
----
-
-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.
-
-<NodeGraph />
-
-### Payload Example
-
-```json title="Payload example"
-{
-  "userId": "123e4567-e89b-12d3-a456-426614174000",
-  "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
-  "amount": 100.5,
-  "paymentMethod": "CreditCard",
-  "timestamp": "2024-07-04T14:48:00Z"
-}
-```
-
-### Security Considerations
-
-- **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.
-
-<Footer />

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/schema.json

@@ -1,31 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "userId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the user initiating the payment"
-    },
-    "orderId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the associated order"
-    },
-    "amount": {
-      "type": "number",
-      "description": "Payment amount"
-    },
-    "paymentMethod": {
-      "type": "string",
-      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
-      "description": "The payment method used"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the payment was initiated"
-    }
-  },
-  "required": ["userId", "orderId", "amount", "paymentMethod", "timestamp"]
-}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-successful-payment.json:
-  name: Successful Payment
-  summary: A standard credit card payment completed successfully for a domestic order with multiple items.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @successful-payment.json
-
-international-payment.json:
-  name: International Payment
-  summary: Payment processed for an international order in GBP with currency conversion details included.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @international-payment.json