@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

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

@@ -1,51 +1,51 @@
 ---
-id: "CancelSubscription"
-name: "User Cancels Subscription"
-version: "0.0.1"
-summary: "Flow for when a user has cancelled a subscription"
+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"
+  - 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"
+      name: 'User'
+    next_step:
+      id: 'cancel_subscription_request'
+      label: 'Initiate subscription cancellation'
 
-  - id: "cancel_subscription_request"
-    title: "Cancel Subscription"
+  - 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: 'CancelSubscription'
+      version: '0.0.1'
+    next_step:
+      id: 'subscription_service'
+      label: 'Proceed to subscription service'
 
-  - id: "stripe_integration"
-    title: "Stripe"
+  - 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"
+      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"
+  - id: 'subscription_service'
+    title: 'Subscription Service'
     service:
-      id: "SubscriptionService"
-      version: "0.0.1"
+      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: '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

@@ -5,19 +5,19 @@ version: 0.0.1
 summary: |
   Domain that contains subscription related services and messages.
 owners:
-    - dboyne
+  - dboyne
 services:
-    - id: BillingService
-      version: 0.0.1
-    - id: PlanManagementService
-      version: 0.0.1
+  - id: BillingService
+    version: 0.0.1
+  - id: PlanManagementService
+    version: 0.0.1
 entities:
-    - id: BillingProfile
-    - id: SubscriptionPeriod
+  - id: BillingProfile
+  - id: SubscriptionPeriod
 badges:
-    - content: Payment Domain
-      backgroundColor: blue
-      textColor: blue
+  - content: Payment Domain
+    backgroundColor: blue
+    textColor: blue
 ---
 
 ## Overview

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

@@ -16,7 +16,7 @@ badges:
 schemaPath: schema.json
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -25,6 +25,7 @@ The `SubscriptionPaymentDue` event is emitted by the Billing Service when a subs
 ## Cross-Domain Communication
 
 This event facilitates communication between:
+
 - **Source**: Subscriptions Domain (BillingService)
 - **Target**: Payment Domain (PaymentService, FraudDetectionService)
 
@@ -59,4 +60,4 @@ This event facilitates communication between:
 }
 ```
 
-<Footer />
+<Footer />

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

@@ -51,4 +51,4 @@
     }
   },
   "required": ["subscriptionId", "customerId", "invoiceId", "amount", "currency", "dueDate"]
-}
+}

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

@@ -27,7 +27,7 @@ owners:
   - dboyne
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -44,6 +44,7 @@ The Billing Service is responsible for managing all billing-related operations f
 ## 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

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

@@ -15,7 +15,7 @@ owners:
   - dboyne
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -32,17 +32,20 @@ The Plan Management Service handles the definition and management of subscriptio
 ## 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
@@ -52,6 +55,7 @@ The Plan Management Service handles the definition and management of subscriptio
 ## API Endpoints
 
 ### REST API
+
 - `GET /api/plans` - List all available plans
 - `GET /api/plans/{planId}` - Get plan details
 - `POST /api/plans` - Create new plan
@@ -76,4 +80,4 @@ The Plan Management Service handles the definition and management of subscriptio
 }
 ```
 
-<Footer />
+<Footer />

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

@@ -6,11 +6,11 @@ schemaPath: schema.json
 summary: |
   Command that will try and cancel a users subscription
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: New!
-      backgroundColor: green
-      textColor: green
+  - content: New!
+    backgroundColor: green
+    textColor: green
 ---
 
 import Footer from '@catalog/components/footer.astro';
@@ -23,4 +23,4 @@ The `CancelSubscription` command will try and cancel a subscription for the user
 
 <NodeGraph />
 
-<Footer />
+<Footer />

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

@@ -6,11 +6,11 @@ schemaPath: schema.json
 summary: |
   Command that will try and subscribe a given user
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: New!
-      backgroundColor: green
-      textColor: green
+  - content: New!
+    backgroundColor: green
+    textColor: green
 ---
 
 import Footer from '@catalog/components/footer.astro';
@@ -23,4 +23,4 @@ The `SubscribeUser` command represents when a new user wants to subscribe to our
 
 <NodeGraph />
 
-<Footer />
+<Footer />

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

@@ -6,11 +6,11 @@ schemaPath: schema.json
 summary: |
   An event that is triggered when a users subscription has been cancelled
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: New!
-      backgroundColor: green
-      textColor: green
+  - content: New!
+    backgroundColor: green
+    textColor: green
 ---
 
 import Footer from '@catalog/components/footer.astro';
@@ -23,4 +23,4 @@ The `UserSubscriptionCancelled` event is triggered when a users subscription has
 
 <NodeGraph />
 
-<Footer />
+<Footer />

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

@@ -6,11 +6,11 @@ schemaPath: schema.json
 summary: |
   An event that is triggered when a new user subscription has started
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: New!
-      backgroundColor: green
-      textColor: green
+  - content: New!
+    backgroundColor: green
+    textColor: green
 ---
 
 import Footer from '@catalog/components/footer.astro';
@@ -23,4 +23,4 @@ The `UserSubscriptionStarted` event is triggered when a user starts a new subscr
 
 <NodeGraph />
 
-<Footer />
+<Footer />

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

@@ -5,17 +5,17 @@ name: Subscription Service
 summary: |
   Service that handles subscriptions
 owners:
-    - dboyne
+  - dboyne
 receives:
   - id: SubscribeUser
     version: 0.0.1
   - id: CancelSubscription
     version: 0.0.1
-  - id: GetSubscriptionStatus  
+  - id: GetSubscriptionStatus
 sends:
   - id: UserSubscriptionStarted
     version: 0.0.1
-  - id: UserSubscriptionCancelled  
+  - id: UserSubscriptionCancelled
     version: 0.0.1
 repository:
   language: JavaScript
@@ -28,15 +28,35 @@ import Footer from '@catalog/components/footer.astro';
 
 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>
+  <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 
+## Architecture diagram
 
 <NodeGraph />
 
-<Footer />
+<Footer />

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

@@ -5,11 +5,11 @@ version: 0.0.2
 summary: |
   GET request that will return the current subscription status for a specific user, identified by their userId.
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -23,4 +23,4 @@ This query is particularly useful in managing subscriptions for SaaS products, m
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

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

@@ -1,4 +1,3 @@
-
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "GetSubscriptionStatusResponse",
@@ -41,6 +40,15 @@
       "description": "The date and time when the last payment was processed."
     }
   },
-  "required": ["userId", "subscriptionStatus", "subscriptionPlan", "nextBillingDate", "billingFrequency", "amount", "currency", "lastPaymentDate"],
+  "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

@@ -5,11 +5,11 @@ version: 0.0.1
 summary: |
   GET request that will return the current subscription status for a specific user, identified by their userId.
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -23,4 +23,4 @@ This query is particularly useful in managing subscriptions for SaaS products, m
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

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

@@ -1,4 +1,3 @@
-
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "GetSubscriptionStatusResponse",
@@ -41,6 +40,15 @@
       "description": "The date and time when the last payment was processed."
     }
   },
-  "required": ["userId", "subscriptionStatus", "subscriptionPlan", "nextBillingDate", "billingFrequency", "amount", "currency", "lastPaymentDate"],
+  "required": [
+    "userId",
+    "subscriptionStatus",
+    "subscriptionPlan",
+    "nextBillingDate",
+    "billingFrequency",
+    "amount",
+    "currency",
+    "lastPaymentDate"
+  ],
   "additionalProperties": false
 }

package/templates/default/domains/Subscriptions/ubiquitous-language.mdx

@@ -2,7 +2,7 @@
 dictionary:
   - id: Subscription
     name: Subscription
-    summary: "A recurring agreement where a customer pays for access to a product or service at regular intervals."
+    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:
 
@@ -16,7 +16,7 @@ dictionary:
     icon: Repeat
   - id: Billing Cycle
     name: Billing Cycle
-    summary: "The recurring period for which a subscription is billed."
+    summary: 'The recurring period for which a subscription is billed.'
     description: |
       Billing cycles define when payments are collected and services are provided. They include:
 
@@ -30,7 +30,7 @@ dictionary:
     icon: Calendar
   - id: Plan
     name: Plan
-    summary: "A specific subscription offering with defined features, pricing, and terms."
+    summary: 'A specific subscription offering with defined features, pricing, and terms.'
     description: |
       Subscription plans define the service levels available to customers. They specify:
 
@@ -44,7 +44,7 @@ dictionary:
     icon: Layout
   - id: Trial Period
     name: Trial Period
-    summary: "A promotional period allowing customers to test a subscription service before committing."
+    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:
 
@@ -58,7 +58,7 @@ dictionary:
     icon: Clock
   - id: Auto-Renewal
     name: Auto-Renewal
-    summary: "Automatic continuation of a subscription at the end of each billing period."
+    summary: 'Automatic continuation of a subscription at the end of each billing period.'
     description: |
       Auto-renewal ensures service continuity for customers. The process includes:
 
@@ -72,7 +72,7 @@ dictionary:
     icon: RefreshCw
   - id: Upgrade
     name: Upgrade
-    summary: "The process of moving to a higher-tier subscription plan."
+    summary: 'The process of moving to a higher-tier subscription plan.'
     description: |
       Upgrades allow customers to access more features or capacity. This involves:
 
@@ -86,7 +86,7 @@ dictionary:
     icon: ArrowUpCircle
   - id: Downgrade
     name: Downgrade
-    summary: "The process of moving to a lower-tier subscription plan."
+    summary: 'The process of moving to a lower-tier subscription plan.'
     description: |
       Downgrades adjust service levels to match customer needs. This includes:
 
@@ -100,7 +100,7 @@ dictionary:
     icon: ArrowDownCircle
   - id: Cancellation
     name: Cancellation
-    summary: "The termination of a subscription service."
+    summary: 'The termination of a subscription service.'
     description: |
       Cancellation processes handle the end of subscription relationships. They cover:
 
@@ -114,7 +114,7 @@ dictionary:
     icon: XCircle
   - id: Usage Limit
     name: Usage Limit
-    summary: "Restrictions on service usage within a subscription plan."
+    summary: 'Restrictions on service usage within a subscription plan.'
     description: |
       Usage limits define the boundaries of service consumption. They include:
 

package/templates/default/eventcatalog.auth.js

@@ -1,13 +1,12 @@
-
 /**
  * This is an optional file that can add authentication to your EventCatalog.
- * 
+ *
  * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
  * And then pick which provider you want to use.
- * 
+ *
  * You can read more in the documentation:
  * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
- * 
+ *
  */
 
 // export default {
@@ -42,4 +41,4 @@
 //       issuer: process.env.AUTH_OKTA_ISSUER,
 //     },
 //   },
-// }
+// }

package/templates/default/eventcatalog.config.js

@@ -1,7 +1,8 @@
 /** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
 export default {
   title: 'EventCatalog',
-  tagline: 'This internal platform provides a comprehensive view of our event-driven architecture across all systems. Use this portal to discover existing domains, explore services and their dependencies, and understand the message contracts that connect our infrastructure',
+  tagline:
+    'This internal platform provides a comprehensive view of our event-driven architecture across all systems. Use this portal to discover existing domains, explore services and their dependencies, and understand the message contracts that connect our infrastructure',
   organizationName: '<organizationName>',
   homepageLink: 'https://eventcatalog.dev/',
   editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
@@ -16,16 +17,13 @@ export default {
   // Customize the navigation for your docs sidebar.
   // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
   navigation: {
-    pages: [
-      'list:top-level-domains',
-      'list:all',
-    ]
+    pages: ['list:top-level-domains', 'list:all'],
   },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
-    text: 'EventCatalog'
+    text: 'EventCatalog',
   },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
@@ -33,5 +31,5 @@ export default {
     enabled: true,
   },
   // required random generated id used by eventcatalog
-  cId: '<cId>'
-}
+  cId: '<cId>',
+};

package/templates/default/eventcatalog.styles.css

@@ -1 +1 @@
-/* Custom styling support coming soon. */
+/* Custom styling support coming soon. */

package/templates/default/teams/full-stack.mdx

@@ -3,9 +3,9 @@ id: full-stack
 name: Full stackers
 summary: Full stack developers based in London, UK
 members:
-    - dboyne
-    - asmith
-    - msmith
+  - dboyne
+  - asmith
+  - msmith
 email: test@test.com
 slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
 ---
@@ -17,10 +17,10 @@ The Full Stack Team is responsible for developing and maintaining both the front
 ## Responsibilities
 
 ### Key Responsibilities
+
 - **Front-End Development**: Design and implement user interfaces using modern web technologies (e.g., HTML, CSS, JavaScript, React).
 - **Back-End Development**: Develop and maintain server-side logic, APIs, and database interactions (e.g., Node.js, Express, SQL/NoSQL databases).
 - **Integration**: Ensure seamless communication between the front-end and back-end components.
 - **Performance Optimization**: Optimize the performance and scalability of web applications.
 - **Testing and Debugging**: Write and maintain unit, integration, and end-to-end tests to ensure the quality and reliability of the applications.
 - **Deployment**: Manage the deployment of applications to production environments using CI/CD pipelines.
-

package/templates/default/teams/mobile-devs.mdx

@@ -3,7 +3,7 @@ id: mobile-devs
 name: The mobile devs
 summary: Mobile application development team for iOS and Android platforms
 members:
-    - dboyne
+  - dboyne
 ---
 
 The Mobile Devs team is responsible for the development and maintenance of the mobile applications for our company. This includes the iOS and Android apps that customers use to interact with our services, make purchases, and manage their accounts. The team ensures that the mobile apps are user-friendly, secure, and performant.
@@ -11,11 +11,13 @@ The Mobile Devs team is responsible for the development and maintenance of the m
 ## Responsibilities
 
 ### 1. Mobile Application Development
+
 - **Platform Support**: Developing and maintaining apps for iOS and Android platforms.
 - **Feature Implementation**: Implementing new features based on product requirements and user feedback.
 - **User Interface Design**: Ensuring a consistent and intuitive user interface across all mobile platforms.
 - **Performance Optimization**: Optimizing the performance of mobile apps to ensure fast and smooth user experiences.
 
 ### 2. Integration with Backend Services
+
 - **API Integration**: Integrating mobile apps with backend services using RESTful APIs and other communication protocols.
-- **Real-time Updates**: Implementing real-time data updates and synchronization with backend services.
+- **Real-time Updates**: Implementing real-time data updates and synchronization with backend services.

package/templates/default/users/aSmith.mdx

@@ -25,4 +25,3 @@ As the Product Owner for Full Stackers, my role involves a wide range of respons
 My mission is to deliver products that not only meet but exceed customer expectations. I thrive on the challenge of translating complex requirements into simple, intuitive solutions.
 
 If you’re interested in product management, user experience, or discussing the latest trends in technology, feel free to reach out!
-