@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

package/templates/default/domains/Subscriptions/flows/CancelSubscription/SubscriptionRenewed/index.mdx

@@ -1,300 +0,0 @@
----
-id: 'SubscriptionRenewed'
-name: 'Subscription Renewal Flow'
-version: '1.0.0'
-summary: 'Business flow for automatic subscription renewals and related processes'
-steps:
-  - id: 'renewal_timer_triggered'
-    title: 'Renewal Period Reached'
-    custom:
-      title: 'Renewal Timer'
-      color: 'orange'
-      icon: 'ClockIcon'
-      type: 'Scheduler'
-      summary: 'Automated timer triggers the subscription renewal process'
-      height: 8
-      properties:
-        subscription_id: 'sub_12345678'
-        renewal_type: 'Automatic'
-        billing_cycle: 'Monthly'
-        next_billing_date: '2024-08-01'
-      menu:
-        - label: 'View scheduler configuration'
-          url: 'https://docs.example.com/scheduler'
-        - label: 'Subscription timing documentation'
-          url: 'https://docs.example.com/subscription-timing'
-    next_step:
-      id: 'check_subscription_status'
-      label: 'Verify subscription status'
-
-  - id: 'check_subscription_status'
-    title: 'Check Subscription Status'
-    service:
-      id: 'SubscriptionService'
-      version: '0.0.1'
-    next_steps:
-      - id: 'payment_approval_check'
-        label: 'Subscription active, proceed to payment'
-      - id: 'subscription_expired'
-        label: 'Subscription has expired'
-      - id: 'subscription_canceled'
-        label: 'Subscription was canceled'
-
-  - id: 'subscription_expired'
-    title: 'Subscription Expired'
-    type: 'node'
-    next_step:
-      id: 'send_renewal_notification'
-      label: 'Notify customer to renew'
-
-  - id: 'subscription_canceled'
-    title: 'Subscription Canceled'
-    type: 'node'
-    next_step:
-      id: 'send_reactivation_offer'
-      label: 'Send special reactivation offer'
-
-  - id: 'send_renewal_notification'
-    title: 'Send Renewal Notification'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
-    next_step:
-      id: 'await_customer_action'
-      label: 'Wait for customer response'
-
-  - id: 'send_reactivation_offer'
-    title: 'Send Reactivation Offer'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
-    next_step:
-      id: 'await_customer_action'
-      label: 'Wait for customer response'
-
-  - id: 'await_customer_action'
-    title: 'Await Customer Action'
-    custom:
-      title: 'Customer Decision Point'
-      color: 'purple'
-      icon: 'UserIcon'
-      type: 'Decision'
-      height: 8
-      summary: 'Waiting period for customer to take action on notification'
-      properties:
-        timeout_period: '7 days'
-        options: 'Renew, Upgrade, Cancel, Ignore'
-    next_steps:
-      - id: 'manual_renewal_flow'
-        label: 'Customer manually renews'
-      - id: 'flow_ends'
-        label: 'No action taken'
-
-  - id: 'manual_renewal_flow'
-    title: 'Manual Renewal Flow'
-    type: 'node'
-    next_step:
-      id: 'payment_initiated'
-      label: 'Process payment'
-
-  - id: 'payment_approval_check'
-    title: 'Check Payment Approval'
-    message:
-      id: 'GetPaymentStatus'
-      version: '0.0.1'
-    next_steps:
-      - id: 'payment_initiated'
-        label: 'Payment approved, proceed with billing'
-      - id: 'payment_method_invalid'
-        label: 'Invalid payment method'
-
-  - id: 'payment_method_invalid'
-    title: 'Invalid Payment Method'
-    type: 'node'
-    next_step:
-      id: 'request_payment_update'
-      label: 'Request updated payment method'
-
-  - id: 'request_payment_update'
-    title: 'Request Payment Update'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
-    next_step:
-      id: 'await_updated_payment'
-      label: 'Wait for payment update'
-
-  - id: 'await_updated_payment'
-    title: 'Await Updated Payment Method'
-    actor:
-      name: 'Customer'
-    next_steps:
-      - id: 'payment_initiated'
-        label: 'Payment method updated'
-      - id: 'subscription_grace_period'
-        label: 'No update received'
-
-  - id: 'subscription_grace_period'
-    title: 'Grace Period'
-    custom:
-      title: 'Subscription Grace Period'
-      color: 'yellow'
-      icon: 'ShieldExclamationIcon'
-      type: 'Timer'
-      summary: 'Limited period where subscription remains active despite payment failure'
-      properties:
-        duration: '7 days'
-        status: 'At risk'
-    next_steps:
-      - id: 'payment_initiated'
-        label: 'Payment updated during grace period'
-      - id: 'subscription_suspended'
-        label: 'Grace period expired'
-
-  - id: 'subscription_suspended'
-    title: 'Subscription Suspended'
-    message:
-      id: 'UserSubscriptionCancelled'
-      version: '0.0.1'
-    next_step:
-      id: 'send_suspension_notification'
-      label: 'Notify customer of suspension'
-
-  - id: 'send_suspension_notification'
-    title: 'Send Suspension Notification'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
-    next_step:
-      id: 'flow_ends'
-      label: 'Flow ends'
-
-  - id: 'payment_initiated'
-    title: 'Process Payment'
-    message:
-      id: 'PaymentInitiated'
-      version: '0.0.1'
-    next_step:
-      id: 'payment_gateway'
-      label: 'Send to payment gateway'
-
-  - id: 'payment_gateway'
-    title: 'Payment Gateway'
-    externalSystem:
-      name: 'Stripe'
-      summary: '3rd party payment processor'
-      url: 'https://stripe.com/'
-    next_steps:
-      - id: 'payment_processed'
-        label: 'Payment successful'
-      - id: 'payment_failed'
-        label: 'Payment failed'
-
-  - id: 'payment_failed'
-    title: 'Payment Failed'
-    type: 'node'
-    next_step:
-      id: 'retry_payment'
-      label: 'Retry payment'
-
-  - id: 'retry_payment'
-    title: 'Retry Payment'
-    custom:
-      title: 'Payment Retry Logic'
-      color: 'red'
-      icon: 'ArrowPathIcon'
-      type: 'Processor'
-      summary: 'Automated retry logic for failed payments'
-      properties:
-        max_attempts: 3
-        backoff_interval: '24 hours'
-        current_attempt: 1
-    next_steps:
-      - id: 'payment_initiated'
-        label: 'Retry payment'
-      - id: 'subscription_grace_period'
-        label: 'Max retries exceeded'
-
-  - id: 'payment_processed'
-    title: 'Payment Processed'
-    message:
-      id: 'PaymentProcessed'
-      version: '1.0.0'
-    next_step:
-      id: 'update_subscription_status'
-      label: 'Update subscription'
-
-  - id: 'update_subscription_status'
-    title: 'Update Subscription'
-    service:
-      id: 'SubscriptionService'
-      version: '0.0.1'
-    next_step:
-      id: 'send_renewal_confirmation'
-      label: 'Confirm renewal to customer'
-
-  - id: 'send_renewal_confirmation'
-    title: 'Send Renewal Confirmation'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
-    next_step:
-      id: 'analyze_customer_usage'
-      label: 'Analyze customer usage patterns'
-
-  - id: 'analyze_customer_usage'
-    title: 'Analyze Usage Patterns'
-    custom:
-      title: 'Usage Analytics'
-      color: 'blue'
-      icon: 'ChartBarIcon'
-      type: 'Analytics'
-      summary: 'Analyze customer usage patterns to identify upsell opportunities'
-      properties:
-        metrics_analyzed: 'Feature usage, Resource consumption, Access patterns'
-        lookback_period: '90 days'
-      menu:
-        - label: 'View analytics dashboard'
-          url: 'https://analytics.example.com/subscriptions'
-        - label: 'Documentation'
-          url: 'https://docs.example.com/analytics'
-    next_steps:
-      - id: 'send_upgrade_recommendation'
-        label: 'Usage suggests upgrade opportunity'
-      - id: 'flow_ends'
-        label: 'No upgrade opportunity identified'
-
-  - id: 'send_upgrade_recommendation'
-    title: 'Send Upgrade Recommendation'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
-    next_step:
-      id: 'flow_ends'
-      label: 'Flow completed'
-
-  - id: 'flow_ends'
-    title: 'Flow Completed'
-    type: 'node'
----
-
-## Subscription Renewal Flow
-
-This flow documents the process of automatic subscription renewals, including handling various edge cases such as payment failures, expired subscriptions, and customer interactions.
-
-<NodeGraph />
-
-### Key Components
-
-- **Automatic Renewal Process**: Triggered by a scheduled timer when the subscription renewal period is reached
-- **Payment Processing**: Integration with payment gateway and handling of payment failures
-- **Customer Notifications**: Various notifications sent throughout the process
-- **Grace Period Handling**: Special handling when payments fail with a grace period before subscription suspension
-- **Usage Analytics**: Analysis of customer usage patterns to identify upgrade opportunities
-
-### Business Rules
-
-1. Subscriptions are renewed automatically unless explicitly canceled
-2. Failed payments trigger a retry process (up to 3 attempts)
-3. Customers receive a 7-day grace period before subscription suspension
-4. Usage patterns are analyzed to provide personalized upgrade recommendations

package/templates/default/domains/Subscriptions/flows/CancelSubscription/index.mdx

@@ -1,69 +0,0 @@
----
-id: 'CancelSubscription'
-name: 'User Cancels Subscription'
-version: '1.0.0'
-summary: 'Flow for when a user has cancelled a subscription'
-owners:
-  - dboyne
-steps:
-  - id: 'cancel_subscription_initiated'
-    title: 'Cancels Subscription'
-    summary: 'User cancels their subscription'
-    actor:
-      name: 'User'
-    next_step:
-      id: 'cancel_subscription_request'
-      label: 'Initiate subscription cancellation'
-
-  - id: 'cancel_subscription_request'
-    title: 'Cancel Subscription'
-    message:
-      id: 'CancelSubscription'
-      version: '0.0.1'
-    next_step:
-      id: 'subscription_service'
-      label: 'Proceed to subscription service'
-
-  - id: 'stripe_integration'
-    title: 'Stripe'
-    externalSystem:
-      name: 'Stripe'
-      summary: '3rd party payment system'
-      url: 'https://stripe.com/'
-    next_step:
-      id: 'subscription_service'
-      label: 'Return to subscription service'
-
-  - id: 'subscription_service'
-    title: 'Subscription Service'
-    service:
-      id: 'SubscriptionService'
-      version: '0.0.1'
-    next_steps:
-      - id: 'stripe_integration'
-        label: 'Cancel subscription via Stripe'
-      - id: 'subscription_cancelled'
-        label: 'Successful cancellation'
-      - id: 'subscription_rejected'
-        label: 'Failed cancellation'
-
-  - id: 'subscription_cancelled'
-    title: 'Subscription has been Cancelled'
-    message:
-      id: 'UserSubscriptionCancelled'
-      version: '0.0.1'
-    next_step:
-      id: 'notification_service'
-      label: 'Email customer'
-
-  - id: 'subscription_rejected'
-    title: 'Subscription cancellation has been rejected'
-
-  - id: 'notification_service'
-    title: 'Notifications Service'
-    service:
-      id: 'NotificationService'
-      version: '0.0.2'
----
-
-<NodeGraph />

package/templates/default/domains/Subscriptions/flows/CancelSubscription/versioned/0.0.1/index.mdx

@@ -1,51 +0,0 @@
----
-id: 'CancelSubscription'
-name: 'User Cancels Subscription'
-version: '0.0.1'
-summary: 'Flow for when a user has cancelled a subscription'
-owners:
-  - dboyne
-steps:
-  - id: 'cancel_subscription_initiated'
-    title: 'Cancels Subscription'
-    summary: 'User cancels their subscription'
-    actor:
-      name: 'User'
-    next_step:
-      id: 'cancel_subscription_request'
-      label: 'Initiate subscription cancellation'
-
-  - id: 'cancel_subscription_request'
-    title: 'Cancel Subscription'
-    message:
-      id: 'CancelSubscription'
-      version: '0.0.1'
-    next_step:
-      id: 'subscription_service'
-      label: 'Proceed to subscription service'
-
-  - id: 'stripe_integration'
-    title: 'Stripe'
-    externalSystem:
-      name: 'Stripe'
-      summary: '3rd party payment system'
-      url: 'https://stripe.com/'
-    next_step:
-      id: 'subscription_service'
-      label: 'Return to subscription service'
-
-  - id: 'subscription_service'
-    title: 'Subscription Service'
-    service:
-      id: 'SubscriptionService'
-      version: '0.0.1'
-    next_steps:
-      - id: 'stripe_integration'
-        label: 'Cancel subscription via Stripe'
-      - id: 'subscription_cancelled'
-        label: 'Successful cancellation'
-      - id: 'subscription_rejected'
-        label: 'Failed cancellation'
----
-
-<NodeGraph />

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

@@ -1,35 +0,0 @@
----
-id: Subscription
-name: Subscription
-version: 0.0.1
-summary: |
-  Domain that contains subscription related services and messages.
-owners:
-  - dboyne
-services:
-  - id: BillingService
-    version: 0.0.1
-  - id: PlanManagementService
-    version: 0.0.1
-entities:
-  - id: BillingProfile
-  - id: SubscriptionPeriod
-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
-
-### Architecture for the Subscription domain
-
-<NodeGraph />
-
-### Entity Map
-
-A visualization of the entities in the Subscription domain. Here you can see the relationships between the entities and how they are used in the domain.
-
-<EntityMap id="Subscription" />

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/examples/examples.config.yaml

@@ -1,7 +0,0 @@
-upcoming-renewal.json:
-  name: Upcoming Renewal Payment
-  summary: A payment reminder generated 3 days before a Pro Monthly subscription renewal is due.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @upcoming-renewal.json

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/examples/upcoming-renewal.json

@@ -1,28 +0,0 @@
-{
-  "eventId": "evt_pay_due_5a72bf",
-  "eventType": "SubscriptionPaymentDue",
-  "timestamp": "2024-04-12T06:00:00Z",
-  "data": {
-    "subscriptionId": "sub_9f84kd02",
-    "userId": "usr_28471",
-    "plan": {
-      "planId": "plan_monthly_pro",
-      "name": "Pro Monthly"
-    },
-    "amount": 32.39,
-    "currency": "USD",
-    "dueDate": "2024-04-15",
-    "billingPeriod": {
-      "start": "2024-04-15",
-      "end": "2024-05-15"
-    },
-    "paymentMethodId": "pm_card_4242",
-    "paymentMethodLast4": "4242",
-    "remindersSent": 1,
-    "daysUntilDue": 3
-  },
-  "metadata": {
-    "correlationId": "corr_due_001",
-    "version": "1.0.0"
-  }
-}

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/index.mdx

@@ -1,63 +0,0 @@
----
-id: SubscriptionPaymentDue
-version: 0.0.1
-name: Subscription Payment Due
-summary: Emitted when a subscription payment is due for collection
-owners:
-  - dboyne
-tags:
-  - billing
-  - payment
-  - cross-domain
-badges:
-  - content: Cross-Domain
-    backgroundColor: purple
-    textColor: white
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `SubscriptionPaymentDue` event is emitted by the Billing Service when a subscription's billing cycle is due for payment. This event triggers the payment collection process in the Payment domain.
-
-## Cross-Domain Communication
-
-This event facilitates communication between:
-
-- **Source**: Subscriptions Domain (BillingService)
-- **Target**: Payment Domain (PaymentService, FraudDetectionService)
-
-## Schema
-
-<SchemaViewer title="SubscriptionPaymentDue Schema" schemaPath={frontmatter.schemaPath} />
-
-## Event Flow
-
-1. BillingService calculates when payment is due
-2. Emits `SubscriptionPaymentDue` event
-3. PaymentService receives and initiates payment
-4. FraudDetectionService performs risk assessment
-5. Payment is processed through PaymentGatewayService
-
-## Example Payload
-
-```json
-{
-  "subscriptionId": "sub_ABC123",
-  "customerId": "cust_XYZ789",
-  "invoiceId": "inv_123456",
-  "amount": 49.99,
-  "currency": "USD",
-  "dueDate": "2024-02-01T00:00:00Z",
-  "billingPeriod": {
-    "start": "2024-02-01",
-    "end": "2024-02-29"
-  },
-  "planId": "pro-monthly",
-  "retryAttempt": 0
-}
-```
-
-<Footer />

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/schema.json

@@ -1,54 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "subscriptionId": {
-      "type": "string",
-      "description": "Unique identifier for the subscription"
-    },
-    "customerId": {
-      "type": "string",
-      "description": "Unique identifier for the customer"
-    },
-    "invoiceId": {
-      "type": "string",
-      "description": "Unique identifier for the invoice"
-    },
-    "amount": {
-      "type": "number",
-      "description": "Amount due for payment"
-    },
-    "currency": {
-      "type": "string",
-      "description": "Currency code (ISO 4217)"
-    },
-    "dueDate": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the payment is due"
-    },
-    "billingPeriod": {
-      "type": "object",
-      "properties": {
-        "start": {
-          "type": "string",
-          "format": "date"
-        },
-        "end": {
-          "type": "string",
-          "format": "date"
-        }
-      },
-      "required": ["start", "end"]
-    },
-    "planId": {
-      "type": "string",
-      "description": "Subscription plan identifier"
-    },
-    "retryAttempt": {
-      "type": "integer",
-      "description": "Number of retry attempts for failed payments"
-    }
-  },
-  "required": ["subscriptionId", "customerId", "invoiceId", "amount", "currency", "dueDate"]
-}

package/templates/default/domains/Subscriptions/services/BillingService/index.mdx

@@ -1,83 +0,0 @@
----
-id: BillingService
-version: 0.0.1
-name: Billing Service
-summary: >-
-  Manages billing cycles, invoice generation, and payment scheduling for
-  subscriptions
-tags:
-  - billing
-  - subscriptions
-  - invoicing
-repository:
-  url: 'https://github.com/eventcatalog/billing-service'
-receives:
-  - id: PaymentProcessed
-    version: 0.0.1
-    from:
-      - id: 'payments.{env}.events'
-        parameters:
-          env: staging
-sends:
-  - id: SubscriptionPaymentDue
-    version: 0.0.1
-  - id: ProcessPayment
-    version: 0.0.1
-owners:
-  - dboyne
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The Billing Service is responsible for managing all billing-related operations for subscriptions. It calculates billing cycles, generates invoices, and coordinates with payment services to ensure timely payment collection.
-
-## Key Features
-
-- **Billing Cycle Management**: Handles daily, weekly, monthly, quarterly, and annual billing cycles
-- **Invoice Generation**: Creates detailed invoices with line items and tax calculations
-- **Payment Scheduling**: Schedules recurring payments based on billing cycles
-- **Proration**: Calculates prorated charges for mid-cycle changes
-- **Dunning Management**: Handles failed payment retry logic
-
-## API Endpoints
-
-### REST API
-
-- `GET /api/billing/invoice/{subscriptionId}` - Get current invoice
-- `GET /api/billing/history/{subscriptionId}` - Get billing history
-- `POST /api/billing/preview` - Preview upcoming charges
-- `PUT /api/billing/retry/{invoiceId}` - Retry failed payment
-
-## Billing Cycle States
-
-```mermaid
-stateDiagram-v2
-    [*] --> Scheduled
-    Scheduled --> Processing
-    Processing --> Paid
-    Processing --> Failed
-    Failed --> Retrying
-    Retrying --> Paid
-    Retrying --> Suspended
-    Paid --> [*]
-    Suspended --> [*]
-```
-
-## Configuration
-
-```yaml
-billing_service:
-  cycles:
-    - daily
-    - weekly
-    - monthly
-    - quarterly
-    - annual
-  retry_attempts: 3
-  retry_interval_days: [1, 3, 7]
-  invoice_generation_lead_days: 7
-```
-
-<Footer />