@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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

@@ -1,83 +0,0 @@
----
-id: PlanManagementService
-version: 0.0.1
-name: Plan Management Service
-summary: Manages subscription plans, features, pricing tiers, and plan migrations
-tags:
-  - plans
-  - pricing
-  - subscriptions
-repository:
-  url: https://github.com/eventcatalog/plan-management-service
-receives: []
-sends: []
-owners:
-  - dboyne
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The Plan Management Service handles the definition and management of subscription plans, including pricing, features, and plan migrations. It serves as the source of truth for what features and limits apply to each subscription tier.
-
-## Key Features
-
-- **Plan Definition**: Create and manage subscription plans with different tiers
-- **Feature Flags**: Control feature access based on subscription plans
-- **Usage Limits**: Define and enforce usage limits per plan
-- **Plan Migration**: Handle upgrades and downgrades between plans
-- **Pricing Management**: Manage pricing, discounts, and promotional offers
-
-## Supported Plan Types
-
-### Basic Plan
-
-- Essential features
-- Limited usage quotas
-- Email support
-
-### Professional Plan
-
-- All Basic features
-- Higher usage quotas
-- Priority support
-- Advanced analytics
-
-### Enterprise Plan
-
-- All Professional features
-- Unlimited usage
-- Dedicated support
-- Custom integrations
-- SLA guarantees
-
-## API Endpoints
-
-### REST API
-
-- `GET /api/plans` - List all available plans
-- `GET /api/plans/{planId}` - Get plan details
-- `POST /api/plans` - Create new plan
-- `PUT /api/plans/{planId}` - Update plan
-- `POST /api/plans/migrate` - Migrate subscription to different plan
-
-## Plan Structure
-
-```json
-{
-  "id": "pro-monthly",
-  "name": "Professional Monthly",
-  "price": 49.99,
-  "currency": "USD",
-  "interval": "monthly",
-  "features": {
-    "api_calls": 10000,
-    "storage_gb": 100,
-    "team_members": 10,
-    "priority_support": true
-  }
-}
-```
-
-<Footer />

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

@@ -1,26 +0,0 @@
----
-id: CancelSubscription
-name: Cancel subscription
-version: 0.0.1
-schemaPath: schema.json
-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/CancelSubscription/schema.json

@@ -1,30 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "subscriptionId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the subscription to cancel"
-    },
-    "userId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the user requesting cancellation"
-    },
-    "reason": {
-      "type": "string",
-      "description": "Reason for cancellation"
-    },
-    "cancelImmediately": {
-      "type": "boolean",
-      "description": "Whether to cancel immediately or at end of billing period"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the cancellation was requested"
-    }
-  },
-  "required": ["subscriptionId", "userId", "timestamp"]
-}

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

@@ -1,26 +0,0 @@
----
-id: SubscribeUser
-name: Subscribe user
-version: 0.0.1
-schemaPath: schema.json
-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/commands/SubscribeUser/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 to subscribe"
-    },
-    "planId": {
-      "type": "string",
-      "description": "Identifier of the subscription plan"
-    },
-    "paymentMethod": {
-      "type": "string",
-      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
-      "description": "The payment method for the subscription"
-    },
-    "startDate": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the subscription should start"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the command was issued"
-    }
-  },
-  "required": ["userId", "planId", "paymentMethod", "timestamp"]
-}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-voluntary-cancellation.json:
-  name: Voluntary Cancellation
-  summary: A customer voluntarily cancels their Pro Monthly subscription, effective at the end of the current billing cycle.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @voluntary-cancellation.json
-
-payment-failure.json:
-  name: Payment Failure Cancellation
-  summary: System automatically cancels an Enterprise Annual subscription after 3 consecutive failed payment attempts.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @payment-failure.json

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/payment-failure.json

@@ -1,25 +0,0 @@
-{
-  "eventId": "evt_sub_cancel_b19c3f",
-  "eventType": "UserSubscriptionCancelled",
-  "timestamp": "2024-07-03T08:12:55Z",
-  "data": {
-    "subscriptionId": "sub_7j21np48",
-    "userId": "usr_41839",
-    "plan": {
-      "planId": "plan_annual_enterprise",
-      "name": "Enterprise Annual"
-    },
-    "cancellationReason": "payment_failure",
-    "cancellationNote": "Automatic cancellation after 3 failed payment attempts",
-    "cancelledBy": "system",
-    "effectiveDate": "2024-07-03",
-    "refundAmount": 0,
-    "failedPaymentAttempts": 3,
-    "lastPaymentAttempt": "2024-07-02T23:00:00Z",
-    "subscriptionDurationDays": 182
-  },
-  "metadata": {
-    "correlationId": "corr_aa11bb22",
-    "version": "1.0.0"
-  }
-}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/voluntary-cancellation.json

@@ -1,23 +0,0 @@
-{
-  "eventId": "evt_sub_cancel_4d82ea",
-  "eventType": "UserSubscriptionCancelled",
-  "timestamp": "2024-05-20T16:45:12Z",
-  "data": {
-    "subscriptionId": "sub_9f84kd02",
-    "userId": "usr_28471",
-    "plan": {
-      "planId": "plan_monthly_pro",
-      "name": "Pro Monthly"
-    },
-    "cancellationReason": "no_longer_needed",
-    "cancellationNote": "Switching to a competitor product",
-    "cancelledBy": "customer",
-    "effectiveDate": "2024-06-15",
-    "refundAmount": 0,
-    "subscriptionDurationDays": 67
-  },
-  "metadata": {
-    "correlationId": "corr_cd45ef67",
-    "version": "1.0.0"
-  }
-}

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

@@ -1,26 +0,0 @@
----
-id: UserSubscriptionCancelled
-name: User subscription cancelled
-version: 0.0.1
-schemaPath: schema.json
-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/UserSubscriptionCancelled/schema.json

@@ -1,35 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "subscriptionId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the cancelled subscription"
-    },
-    "userId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the user"
-    },
-    "planId": {
-      "type": "string",
-      "description": "Identifier of the subscription plan"
-    },
-    "cancellationReason": {
-      "type": "string",
-      "description": "Reason for the cancellation"
-    },
-    "effectiveDate": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the cancellation takes effect"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the cancellation event occurred"
-    }
-  },
-  "required": ["subscriptionId", "userId", "timestamp"]
-}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/annual-plan.json

@@ -1,26 +0,0 @@
-{
-  "eventId": "evt_sub_start_e91f2a",
-  "eventType": "UserSubscriptionStarted",
-  "timestamp": "2024-06-01T14:05:33Z",
-  "data": {
-    "subscriptionId": "sub_3k72mf91",
-    "userId": "usr_55102",
-    "plan": {
-      "planId": "plan_annual_enterprise",
-      "name": "Enterprise Annual",
-      "billingCycle": "annual",
-      "price": 499.0,
-      "currency": "USD"
-    },
-    "trialPeriodDays": 0,
-    "startDate": "2024-06-01",
-    "nextBillingDate": "2025-06-01",
-    "paymentMethodId": "pm_card_1881",
-    "source": "sales_team",
-    "discountCode": "ENTERPRISE20"
-  },
-  "metadata": {
-    "correlationId": "corr_ff93aa12",
-    "version": "1.0.0"
-  }
-}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-monthly-plan.json:
-  name: Monthly Plan Subscription
-  summary: A user subscribes to the Pro Monthly plan with a 14-day trial period via web checkout.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @monthly-plan.json
-
-annual-plan.json:
-  name: Annual Enterprise Plan
-  summary: A user subscribes to the Enterprise Annual plan through the sales team with a discount code applied.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @annual-plan.json

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/monthly-plan.json

@@ -1,25 +0,0 @@
-{
-  "eventId": "evt_sub_start_7a3b1c",
-  "eventType": "UserSubscriptionStarted",
-  "timestamp": "2024-03-15T09:22:41Z",
-  "data": {
-    "subscriptionId": "sub_9f84kd02",
-    "userId": "usr_28471",
-    "plan": {
-      "planId": "plan_monthly_pro",
-      "name": "Pro Monthly",
-      "billingCycle": "monthly",
-      "price": 29.99,
-      "currency": "USD"
-    },
-    "trialPeriodDays": 14,
-    "startDate": "2024-03-15",
-    "nextBillingDate": "2024-04-15",
-    "paymentMethodId": "pm_card_4242",
-    "source": "web_checkout"
-  },
-  "metadata": {
-    "correlationId": "corr_ab12cd34",
-    "version": "1.0.0"
-  }
-}

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

@@ -1,26 +0,0 @@
----
-id: UserSubscriptionStarted
-name: User subscription started
-version: 0.0.1
-schemaPath: schema.json
-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/events/UserSubscriptionStarted/schema.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "subscriptionId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the new subscription"
-    },
-    "userId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "Unique identifier of the subscribed user"
-    },
-    "planId": {
-      "type": "string",
-      "description": "Identifier of the subscription plan"
-    },
-    "startDate": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the subscription started"
-    },
-    "billingCycle": {
-      "type": "string",
-      "enum": ["monthly", "quarterly", "yearly"],
-      "description": "The billing cycle for the subscription"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "When the subscription started event occurred"
-    }
-  },
-  "required": ["subscriptionId", "userId", "planId", "startDate", "timestamp"]
-}

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

@@ -1,62 +0,0 @@
----
-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.mdx

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

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

package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/versioned/0.0.1/index.mdx

@@ -1,26 +0,0 @@
----
-id: GetSubscriptionStatus
-name: Get subscription status
-version: 0.0.1
-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" />