@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "4.1.3",
+  "version": "4.2.0",
   "bin": {
     "create-catalog": "./dist/index.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/event-catalog/create-eventcatalog.git"
+    "url": "https://github.com/event-catalog/eventcatalog"
   },
   "files": [
     "dist",
@@ -20,7 +20,7 @@
     "@types/async-retry": "1.4.2",
     "@types/ci-info": "2.0.0",
     "@types/cross-spawn": "6.0.0",
-    "@types/node": "^12.6.8",
+    "@types/node": "^20.14.10",
     "@types/prompts": "2.0.1",
     "@types/rimraf": "3.0.0",
     "@types/tar": "4.0.3",
@@ -35,6 +35,7 @@
     "fast-glob": "^3.3.2",
     "got": "^14.0.0",
     "ora": "^5.4.1",
+    "prettier": "^3.3.3",
     "prompts": "2.1.0",
     "rimraf": "^5.0.7",
     "tar": "^4.4.19",
@@ -49,9 +50,11 @@
   },
   "scripts": {
     "build": "tsup index.ts --format cjs --dts",
+    "build:bin": "tsup index.ts --format cjs --dts",
+    "test:ci": "echo 'No tests for create-eventcatalog yet'",
     "run": "node dist/index.js",
-    "dev": "npm run build --watch",
-    "changeset": "changeset",
-    "release": "changeset publish"
+    "dev": "pnpm run build --watch",
+    "format": "prettier --write .",
+    "format:diff": "prettier --list-different ."
   }
 }

package/templates/amazon-api-gateway/README-template.md

@@ -5,10 +5,10 @@ Welcome to your new Amazon API Gateway EventCatalog!
 Getting started:
 
 1. Edit the `.env` file to configure your environment variables.
-1. Configure the apis in the `eventcatalog.config.js` file 
-2. Run `npm run generate` to import your OpenAPI specs from apigateway and document them.
-3. Run `npm run dev` to start the development server.
-4. Go to localhost:3000 to view your catalog.
+1. Configure the apis in the `eventcatalog.config.js` file
+1. Run `npm run generate` to import your OpenAPI specs from apigateway and document them.
+1. Run `npm run dev` to start the development server.
+1. Go to localhost:3000 to view your catalog.
 
 ### What else can you do?
 
@@ -22,10 +22,6 @@ With the ApiGateway integration you can :
 
 The easiest way to get started and dive deeper is to read the [EventCatalog documentation](https://www.eventcatalog.dev/docs/plugins/amazon-apigateway/intro).
 
-
 ### Found a problem?
 
 If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
-
-
-

package/templates/amazon-api-gateway/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/amazon-api-gateway/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 EventBridge schemas, services and domains, 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 EventBridge schemas, services and domains, and understand the message contracts that connect our infrastructure',
   organizationName: '<organizationName>',
   homepageLink: 'https://eventcatalog.dev/',
   editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
@@ -17,19 +18,19 @@ export default {
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
-    text: 'EventCatalog'
+    text: 'EventCatalog',
   },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,
     // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
+    limit: 20,
   },
   docs: {
     sidebar: {
       // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
       // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
+      type: 'LIST_VIEW',
     },
   },
   // This lets you copy markdown contents from EventCatalog to your clipboard
@@ -41,7 +42,7 @@ export default {
   cId: '<cId>',
   generators: [
     [
-      "@eventcatalog/generator-amazon-apigateway",
+      '@eventcatalog/generator-amazon-apigateway',
       {
         output: 'amazon-api-gateway-output',
         apis: [
@@ -53,20 +54,24 @@ export default {
             // The API stage name
             stageName: 'prod',
             version: '2',
-          }
-        ]
+          },
+        ],
       },
     ],
     // This will process the output of the amazon api gateway generator
     // it will process the OpenAPI file and map it into a service and domain
     // All routes are mapped to messages.
     [
-      "@eventcatalog/generator-openapi",
+      '@eventcatalog/generator-openapi',
       {
         services: [
-          { path: path.join(__dirname, "amazon-api-gateway-output", "EcommerceApi.json"), id: 'ecommerce-api', owners: ['full-stack'] },
-        ]
+          {
+            path: path.join(__dirname, 'amazon-api-gateway-output', 'EcommerceApi.json'),
+            id: 'ecommerce-api',
+            owners: ['full-stack'],
+          },
+        ],
       },
     ],
   ],
-}
+};

package/templates/amazon-api-gateway/eventcatalog.styles.css

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

package/templates/analytics.ts

@@ -8,25 +8,25 @@ interface EventMetadata {
 }
 
 async function raiseEvent(eventData: EventMetadata): Promise<void> {
-  const url = "https://queue.simpleanalyticscdn.com/events";
+  const url = 'https://queue.simpleanalyticscdn.com/events';
   const userAgent = `@eventcatalog/create-eventcatalog/${pkg.version} (${os.platform()}; ${os.arch()}; Node/${process.version})`;
 
   const payload = {
-    type: "event",
-    hostname: "eventcatalog.dev",
-    event: "@eventcatalog/create-eventcatalog",
+    type: 'event',
+    hostname: 'eventcatalog.dev',
+    event: '@eventcatalog/create-eventcatalog',
     metadata: {
       ...eventData,
       t: `t;${new Date().toISOString()}`,
-      ua: userAgent
+      ua: userAgent,
     },
-    ua: userAgent
+    ua: userAgent,
   };
 
   try {
     await fetch(url, {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify(payload),
     });
   } catch (error) {

package/templates/asyncapi/asyncapi-files/messages/user-signed-up.yml

@@ -41,4 +41,4 @@ UserSignedUp:
       - email
       - password
       - termsAccepted
-    additionalProperties: false
+    additionalProperties: false

package/templates/asyncapi/asyncapi-files/user-service.yml

@@ -20,4 +20,4 @@ components:
     UserSignedUp:
       schemaFormat: 'application/schema+json;version=draft-07'
       schema:
-        '$ref': './messages/user-signed-up.yml#/UserSignedUp'
+        '$ref': './messages/user-signed-up.yml#/UserSignedUp'

package/templates/asyncapi/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/asyncapi/eventcatalog.config.js

@@ -6,7 +6,8 @@ const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 /** @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',
@@ -21,9 +22,7 @@ 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:all',
-    ]
+    pages: ['list:all'],
   },
   logo: {
     alt: 'EventCatalog Logo',
@@ -40,7 +39,11 @@ export default {
       '@eventcatalog/generator-asyncapi',
       {
         services: [
-          { path: path.join(__dirname, 'asyncapi-files', 'orders-service.yml'), owners: ['order-management'], id: 'Orders Service' },
+          {
+            path: path.join(__dirname, 'asyncapi-files', 'orders-service.yml'),
+            owners: ['order-management'],
+            id: 'Orders Service',
+          },
         ],
         domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
       },
@@ -49,7 +52,11 @@ export default {
       '@eventcatalog/generator-asyncapi',
       {
         services: [
-          { path: path.join(__dirname, 'asyncapi-files', 'payment-service.yml'), owners: ['order-management'], id: 'Payment Service' },
+          {
+            path: path.join(__dirname, 'asyncapi-files', 'payment-service.yml'),
+            owners: ['order-management'],
+            id: 'Payment Service',
+          },
         ],
         domain: { id: 'payment', name: 'Payment', version: '0.0.1' },
       },
@@ -61,7 +68,7 @@ export default {
           { path: path.join(__dirname, 'asyncapi-files', 'user-service.yml'), owners: ['user-management'], id: 'User Service' },
         ],
         domain: { id: 'user-domain', name: 'User Domain', version: '0.0.1' },
-        debug: true
+        debug: true,
       },
     ],
   ],
@@ -69,8 +76,8 @@ export default {
   rss: {
     enabled: true,
     // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
+    limit: 20,
   },
   // required random generated id used by eventcatalog
-  cId: '<cId>'
+  cId: '<cId>',
 };

package/templates/asyncapi/eventcatalog.styles.css

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

package/templates/asyncapi/teams/order-management.mdx

@@ -3,11 +3,11 @@ id: order-management
 name: Order Management
 summmary: Order Management team based in London, UK
 members:
-    - dboyne
-    - asmith
-    - msmith
-    - alee
-    - azhang
+  - dboyne
+  - asmith
+  - msmith
+  - alee
+  - azhang
 email: test@test.com
 slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
 ---
@@ -28,4 +28,4 @@ The Order Management team is responsible for managing orders, inventory, shipmen
 
 - David Boyne
 - Alice Smith
-- Mike Smith
+- Mike Smith

package/templates/asyncapi/teams/user-management.mdx

@@ -2,9 +2,9 @@
 id: user-management
 name: User Management
 members:
-    - dboyne
-    - jbrown
-    - dkim
+  - dboyne
+  - jbrown
+  - dkim
 ---
 
 The user management team is responsible for managing users and user accounts.
@@ -15,4 +15,4 @@ The user management team is responsible for managing users and user accounts.
 - Manage user and user account provisioning
 - Manage user and user account deprovisioning
 - Manage user and user account password management
-- Manage user and user account role management
+- Manage user and user account role management

package/templates/asyncapi/users/aSmith.mdx

@@ -24,4 +24,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!
-

package/templates/asyncapi/users/alee.mdx

@@ -5,4 +5,4 @@ avatarUrl: https://randomuser.me/api/portraits/women/91.jpg
 role: Technical Writer
 ---
 
-As a Technical Writer on the Documentation team, I create clear, comprehensive documentation for our products and APIs. My focus is on making complex technical concepts accessible to developers and end-users alike. I collaborate with engineering teams to ensure our documentation stays current and accurate. 
+As a Technical Writer on the Documentation team, I create clear, comprehensive documentation for our products and APIs. My focus is on making complex technical concepts accessible to developers and end-users alike. I collaborate with engineering teams to ensure our documentation stays current and accurate.

package/templates/asyncapi/users/azhang.mdx

@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/azhang
 msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=azhang@company.com
 ---
 
-Building and maintaining data pipelines and infrastructure... 
+Building and maintaining data pipelines and infrastructure...

package/templates/asyncapi/users/dboyne.mdx

@@ -1,7 +1,7 @@
 ---
 id: dboyne
 name: David Boyne
-avatarUrl: "https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png"
+avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png'
 role: Lead developer
 email: test@test.com
 slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
@@ -28,5 +28,6 @@ I am passionate about leveraging the power of events to build systems that are n
 Feel free to connect with me to discuss all things tech, event-driven architectures, or to exchange ideas on building better software systems!
 
 ---
-*David Boyne*
-*Tech Lead, Full Stackers*
+
+_David Boyne_
+_Tech Lead, Full Stackers_

package/templates/asyncapi/users/dkim.mdx

@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/dkim
 msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=dkim@company.com
 ---
 
-Optimizing application performance and user experience... 
+Optimizing application performance and user experience...

package/templates/asyncapi/users/jbrown.mdx

@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/jbrown
 msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=jbrown@company.com
 ---
 
-Creating intuitive and engaging user interfaces... 
+Creating intuitive and engaging user interfaces...

package/templates/asyncapi/users/mSmith.mdx

@@ -1,8 +1,8 @@
 ---
 id: msmith
 name: Martin Smith
-avatarUrl: "https://randomuser.me/api/portraits/men/51.jpg"
+avatarUrl: 'https://randomuser.me/api/portraits/men/51.jpg'
 role: Senior software engineer
 ---
 
-As a Senior Mobile Developer on The Mobile Devs team, I play a key role in designing, developing, and maintaining our company’s mobile applications. My focus is on creating a seamless and intuitive user experience for our customers on both iOS and Android platforms. I work closely with cross-functional teams, including backend developers, UX/UI designers, and product managers, to deliver high-quality mobile solutions that meet business objectives and exceed user expectations.
+As a Senior Mobile Developer on The Mobile Devs team, I play a key role in designing, developing, and maintaining our company’s mobile applications. My focus is on creating a seamless and intuitive user experience for our customers on both iOS and Android platforms. I work closely with cross-functional teams, including backend developers, UX/UI designers, and product managers, to deliver high-quality mobile solutions that meet business objectives and exceed user expectations.

package/templates/confluent/README-template.md

@@ -5,10 +5,10 @@ Welcome to your new Confluent Event Catalog!
 Getting started:
 
 1. Edit the `.env` file to configure your environment variables.
-1. Run Confluent Cloud locally, or configure your `schemaRegistryUrl` in the `eventcatalog.config.js` file 
-2. Run `npm run generate` to import your schemas from confluent schema registry.
-3. Run `npm run dev` to start the development server.
-4. Go to localhost:3000 to view your catalog.
+1. Run Confluent Cloud locally, or configure your `schemaRegistryUrl` in the `eventcatalog.config.js` file
+1. Run `npm run generate` to import your schemas from confluent schema registry.
+1. Run `npm run dev` to start the development server.
+1. Go to localhost:3000 to view your catalog.
 
 ### What else can you do?
 
@@ -23,10 +23,6 @@ With the Confluent Schema Registry integration you can :
 
 The easiest way to get started and dive deeper is to read the [Event Catalog documentation](https://eventcatalog.dev/docs/plugins/confluent-schema-registry/intro).
 
-
 ### Found a problem?
 
 If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
-
-
-

package/templates/confluent/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/confluent/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 kafka schemas, topics, services and domains, 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 kafka schemas, topics, services and domains, 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,21 +17,19 @@ 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:all',
-    ]
+    pages: ['list:all'],
   },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
-    text: 'EventCatalog'
+    text: 'EventCatalog',
   },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,
     // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
+    limit: 20,
   },
   // required random generated id used by eventcatalog
   cId: '<cId>',
@@ -46,8 +45,8 @@ export default {
         // The URL for your schema registry
         schemaRegistryUrl: 'http://localhost:8081',
         // This will document all the schemas in the registry, not just the latest version (default is false)
-        includeAllVersions: true
+        includeAllVersions: true,
       },
     ],
   ],
-}
+};

package/templates/confluent/eventcatalog.styles.css

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

package/templates/default/channels/inventory.{env}.events/index.mdx

@@ -7,7 +7,7 @@ summary: |
 owners:
   - dboyne
 address: inventory.{env}.events
-protocols: 
+protocols:
   - kafka
 
 parameters:
@@ -20,6 +20,7 @@ parameters:
 ---
 
 ### Overview
+
 The Inventory Events channel is the central stream for all inventory-related events across the system. This includes stock level changes, inventory allocations, adjustments, and stocktake events. Events for a specific SKU are guaranteed to be processed in sequence when using productId as the partition key.
 
 <ChannelInformation />
@@ -27,6 +28,7 @@ The Inventory Events channel is the central stream for all inventory-related eve
 ### Publishing and Subscribing to Events
 
 #### Publishing Example
+
 ```python
 from kafka import KafkaProducer
 import json
@@ -68,7 +70,7 @@ inventory_event = {
 
 # Send the message - using productId as key for partitioning
 producer.send(
-    topic, 
+    topic,
     key=inventory_event['payload']['productId'].encode('utf-8'),
     value=inventory_event
 )
@@ -102,7 +104,7 @@ class InventoryEventConsumer:
     def process_event(self, event):
         """Process individual inventory events based on type"""
         event_type = event.get('eventType')
-        
+
         if event_type == 'STOCK_LEVEL_CHANGED':
             self.handle_stock_level_change(event)
         elif event_type == 'LOW_STOCK_ALERT':
@@ -132,18 +134,18 @@ class InventoryEventConsumer:
                     # Process the message
                     event = message.value
                     print(f"Received event: {event['eventType']} for product: {event['payload']['productId']}")
-                    
+
                     # Process the event
                     self.process_event(event)
-                    
+
                     # Commit the offset after successful processing
                     self.consumer.commit()
-                    
+
                 except Exception as e:
                     print(f"Error processing message: {str(e)}")
                     # Implement your error handling logic here
                     # You might want to send to a DLQ (Dead Letter Queue)
-        
+
         except Exception as e:
             print(f"Consumer error: {str(e)}")
         finally:
@@ -154,4 +156,4 @@ if __name__ == "__main__":
     # Create and start the consumer
     consumer = InventoryEventConsumer()
     consumer.start_consuming()
-  ```
+```

package/templates/default/channels/orders.{env}.events/index.mdx

@@ -7,7 +7,7 @@ summary: |
 owners:
   - dboyne
 address: orders.{env}.events
-protocols: 
+protocols:
   - kafka
 routes:
   - id: inventory-queue
@@ -21,6 +21,7 @@ parameters:
 ---
 
 ### Overview
+
 The Orders Events channel is the central stream for all order-related events across the order processing lifecycle. This includes order creation, updates, payment status, fulfillment status, and customer communications. All events related to a specific order are guaranteed to be processed in sequence when using orderId as the partition key.
 
 <ChannelInformation />
@@ -74,10 +75,11 @@ order_event = {
 
 # Send the message - using orderId as key for partitioning
 producer.send(
-    topic, 
+    topic,
     key=order_event['payload']['orderId'].encode('utf-8'),
     value=order_event
 )
 producer.flush()
 
-print(f"Order event sent to topic {topic}")
+print(f"Order event sent to topic {topic}")
+```