@eventcatalog/create-eventcatalog 2.0.22 → 2.1.1

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

@@ -0,0 +1,25 @@
+---
+id: SubscribeUser
+name: Subscribe user
+version: 0.0.1
+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/events/UserSubscriptionCancelled/index.md

@@ -0,0 +1,25 @@
+---
+id: UserSubscriptionCancelled
+name: User subscription cancelled
+version: 0.0.1
+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/UserSubscriptionStarted/index.md

@@ -0,0 +1,25 @@
+---
+id: UserSubscriptionStarted
+name: User subscription started
+version: 0.0.1
+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/index.md

@@ -0,0 +1,42 @@
+---
+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.md

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

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

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

package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/versioned/0.0.1/schema.json

@@ -0,0 +1,46 @@
+
+{
+  "$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/ubiquitous-language.md

@@ -0,0 +1,129 @@
+---
+dictionary:
+  - id: Subscription
+    name: Subscription
+    summary: "A recurring agreement where a customer pays for access to a product or service at regular intervals."
+    description: |
+      A subscription represents an ongoing relationship between customer and provider. Key aspects include:
+
+      - Subscription plan details
+      - Billing frequency
+      - Access rights and limitations
+      - Start and end dates
+      - Auto-renewal settings
+
+      Subscriptions provide predictable revenue for businesses and convenient access for customers.
+    icon: Repeat
+  - id: Billing Cycle
+    name: Billing Cycle
+    summary: "The recurring period for which a subscription is billed."
+    description: |
+      Billing cycles define when payments are collected and services are provided. They include:
+
+      - Cycle duration (monthly, annually, etc.)
+      - Billing date
+      - Payment due dates
+      - Pro-ration rules
+      - Grace periods
+
+      Clear billing cycles help manage customer expectations and cash flow.
+    icon: Calendar
+  - id: Plan
+    name: Plan
+    summary: "A specific subscription offering with defined features, pricing, and terms."
+    description: |
+      Subscription plans define the service levels available to customers. They specify:
+
+      - Feature sets and limitations
+      - Pricing structure
+      - Billing frequency options
+      - Usage allowances
+      - Additional benefits
+
+      Well-designed plans cater to different customer segments and needs.
+    icon: Layout
+  - id: Trial Period
+    name: Trial Period
+    summary: "A promotional period allowing customers to test a subscription service before committing."
+    description: |
+      Trial periods help customers evaluate the service risk-free. They include:
+
+      - Duration of trial
+      - Available features
+      - Conversion process
+      - Payment information requirements
+      - Trial end notifications
+
+      Effective trials can increase conversion rates to paid subscriptions.
+    icon: Clock
+  - id: Auto-Renewal
+    name: Auto-Renewal
+    summary: "Automatic continuation of a subscription at the end of each billing period."
+    description: |
+      Auto-renewal ensures service continuity for customers. The process includes:
+
+      - Renewal notifications
+      - Payment processing
+      - Service extension
+      - Failed payment handling
+      - Cancellation options
+
+      Auto-renewal reduces churn and maintains steady revenue streams.
+    icon: RefreshCw
+  - id: Upgrade
+    name: Upgrade
+    summary: "The process of moving to a higher-tier subscription plan."
+    description: |
+      Upgrades allow customers to access more features or capacity. This involves:
+
+      - Plan comparison
+      - Pro-rated billing adjustments
+      - Feature activation
+      - Data migration if needed
+      - Service level changes
+
+      Smooth upgrade processes encourage customer growth.
+    icon: ArrowUpCircle
+  - id: Downgrade
+    name: Downgrade
+    summary: "The process of moving to a lower-tier subscription plan."
+    description: |
+      Downgrades adjust service levels to match customer needs. This includes:
+
+      - Feature reduction
+      - Billing adjustments
+      - Data retention policies
+      - Service level changes
+      - Customer retention strategies
+
+      Flexible downgrade options can prevent complete cancellations.
+    icon: ArrowDownCircle
+  - id: Cancellation
+    name: Cancellation
+    summary: "The termination of a subscription service."
+    description: |
+      Cancellation processes handle the end of subscription relationships. They cover:
+
+      - Notice periods
+      - Final billing
+      - Data retention/export
+      - Service access termination
+      - Reactivation options
+
+      Clear cancellation policies protect both customer and provider interests.
+    icon: XCircle
+  - id: Usage Limit
+    name: Usage Limit
+    summary: "Restrictions on service usage within a subscription plan."
+    description: |
+      Usage limits define the boundaries of service consumption. They include:
+
+      - Quantitative restrictions
+      - Monitoring systems
+      - Overage handling
+      - Alert mechanisms
+      - Upgrade triggers
+
+      Well-defined limits help manage resources and encourage appropriate plan selection.
+    icon: Gauge
+---

package/templates/default/eventcatalog.config.js

@@ -16,12 +16,6 @@ export default {
     src: '/logo.png',
     text: 'EventCatalog'
   },
-  docs: {
-    sidebar: {
-      // Should the sub heading be rendered in the docs sidebar?
-      showPageHeadings: true
-    }
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 }

package/templates/default/events/Inventory/InventoryAdjusted/schema.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "Employee",
-  "properties": {
-    "Name": {
-      "type": "string"
-    },
-    "Age": {
-      "type": "integer"
-    },
-    "Town": {
-      "type": "string"
-    }
-  },
-  "required": ["Name", "Age", "Town"]
-}

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.3/schema.avro

@@ -1,14 +0,0 @@
-{
-  "type" : "record",
-  "namespace" : "Tutorialspoint",
-  "name" : "Employee",
-  "fields" : [
-     { "name" : "Name" , "type" : "string" },
-     { "name" : "Age" , "type" : "int" },
-     { "name" : "Age" , "type" : "int" },
-     { "name" : "Age" , "type" : "int" },
-     { "name" : "Age" , "type" : "int" },
-     { "name" : "Age" , "type" : "int" },
-     { "name" : "Age" , "type" : "int" }
-  ]
-}

package/templates/default/services/OrdersService/openapi.yml

@@ -1,170 +0,0 @@
-openapi: "3.0.0"
-info:
-  title: Simple API overview
-  version: 2.0.0
-paths:
-  /:
-    get:
-      operationId: listVersionsv2
-      summary: List API versions
-      responses:
-        '200':
-          description: |-
-            200 response
-          content:
-            application/json:
-              examples: 
-                foo:
-                  value:
-                    {
-                      "versions": [
-                        {
-                            "status": "CURRENT",
-                            "updated": "2011-01-21T11:33:21Z",
-                            "id": "v2.0",
-                            "links": [
-                                {
-                                    "href": "http://127.0.0.1:8774/v2/",
-                                    "rel": "self"
-                                }
-                            ]
-                        },
-                        {
-                            "status": "EXPERIMENTAL",
-                            "updated": "2013-07-23T11:33:21Z",
-                            "id": "v3.0",
-                            "links": [
-                                {
-                                    "href": "http://127.0.0.1:8774/v3/",
-                                    "rel": "self"
-                                }
-                            ]
-                        }
-                      ]
-                    }
-        '300':
-          description: |-
-            300 response
-          content:
-            application/json: 
-              examples: 
-                foo:
-                  value: |
-                   {
-                    "versions": [
-                          {
-                            "status": "CURRENT",
-                            "updated": "2011-01-21T11:33:21Z",
-                            "id": "v2.0",
-                            "links": [
-                                {
-                                    "href": "http://127.0.0.1:8774/v2/",
-                                    "rel": "self"
-                                }
-                            ]
-                        },
-                        {
-                            "status": "EXPERIMENTAL",
-                            "updated": "2013-07-23T11:33:21Z",
-                            "id": "v3.0",
-                            "links": [
-                                {
-                                    "href": "http://127.0.0.1:8774/v3/",
-                                    "rel": "self"
-                                }
-                            ]
-                        }
-                    ]
-                   }
-  /v2:
-    get:
-      operationId: getVersionDetailsv2
-      summary: Show API version details
-      responses:
-        '200':
-          description: |-
-            200 response
-          content:
-            application/json: 
-              examples:
-                foo:
-                  value:
-                    {
-                      "version": {
-                        "status": "CURRENT",
-                        "updated": "2011-01-21T11:33:21Z",
-                        "media-types": [
-                          {
-                              "base": "application/xml",
-                              "type": "application/vnd.openstack.compute+xml;version=2"
-                          },
-                          {
-                              "base": "application/json",
-                              "type": "application/vnd.openstack.compute+json;version=2"
-                          }
-                        ],
-                        "id": "v2.0",
-                        "links": [
-                          {
-                              "href": "http://127.0.0.1:8774/v2/",
-                              "rel": "self"
-                          },
-                          {
-                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
-                              "type": "application/pdf",
-                              "rel": "describedby"
-                          },
-                          {
-                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
-                              "type": "application/vnd.sun.wadl+xml",
-                              "rel": "describedby"
-                          },
-                          {
-                            "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
-                            "type": "application/vnd.sun.wadl+xml",
-                            "rel": "describedby"
-                          }
-                        ]
-                      }
-                    }
-        '203':
-          description: |-
-            203 response
-          content:
-            application/json: 
-              examples:
-                foo:
-                  value:
-                    {
-                      "version": {
-                        "status": "CURRENT",
-                        "updated": "2011-01-21T11:33:21Z",
-                        "media-types": [
-                          {
-                              "base": "application/xml",
-                              "type": "application/vnd.openstack.compute+xml;version=2"
-                          },
-                          {
-                              "base": "application/json",
-                              "type": "application/vnd.openstack.compute+json;version=2"
-                          }
-                        ],
-                        "id": "v2.0",
-                        "links": [
-                          {
-                              "href": "http://23.253.228.211:8774/v2/",
-                              "rel": "self"
-                          },
-                          {
-                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
-                              "type": "application/pdf",
-                              "rel": "describedby"
-                          },
-                          {
-                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
-                              "type": "application/vnd.sun.wadl+xml",
-                              "rel": "describedby"
-                          }
-                        ]
-                      }
-                    }