@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. package/dist/index.js +510 -539
  2. package/package.json +9 -6
  3. package/templates/amazon-api-gateway/README-template.md +4 -8
  4. package/templates/amazon-api-gateway/eventcatalog.auth.js +4 -5
  5. package/templates/amazon-api-gateway/eventcatalog.config.js +16 -11
  6. package/templates/amazon-api-gateway/eventcatalog.styles.css +1 -1
  7. package/templates/analytics.ts +8 -8
  8. package/templates/asyncapi/asyncapi-files/messages/user-signed-up.yml +1 -1
  9. package/templates/asyncapi/asyncapi-files/user-service.yml +1 -1
  10. package/templates/asyncapi/eventcatalog.auth.js +4 -5
  11. package/templates/asyncapi/eventcatalog.config.js +16 -9
  12. package/templates/asyncapi/eventcatalog.styles.css +1 -1
  13. package/templates/asyncapi/teams/order-management.mdx +6 -6
  14. package/templates/asyncapi/teams/user-management.mdx +4 -4
  15. package/templates/asyncapi/users/aSmith.mdx +0 -1
  16. package/templates/asyncapi/users/alee.mdx +1 -1
  17. package/templates/asyncapi/users/azhang.mdx +1 -1
  18. package/templates/asyncapi/users/dboyne.mdx +4 -3
  19. package/templates/asyncapi/users/dkim.mdx +1 -1
  20. package/templates/asyncapi/users/jbrown.mdx +1 -1
  21. package/templates/asyncapi/users/mSmith.mdx +2 -2
  22. package/templates/confluent/README-template.md +4 -8
  23. package/templates/confluent/eventcatalog.auth.js +4 -5
  24. package/templates/confluent/eventcatalog.config.js +7 -8
  25. package/templates/confluent/eventcatalog.styles.css +1 -1
  26. package/templates/default/channels/inventory.{env}.events/index.mdx +10 -8
  27. package/templates/default/channels/orders.{env}.events/index.mdx +5 -3
  28. package/templates/default/channels/payment.{env}.events/index.mdx +14 -13
  29. package/templates/default/domains/E-Commerce/index.mdx +32 -20
  30. package/templates/default/domains/E-Commerce/ubiquitous-language.mdx +9 -9
  31. package/templates/default/domains/Orders/changelog.mdx +1 -1
  32. package/templates/default/domains/Orders/entities/CartItem/index.mdx +15 -14
  33. package/templates/default/domains/Orders/entities/Customer/index.mdx +5 -5
  34. package/templates/default/domains/Orders/entities/Order/index.mdx +9 -9
  35. package/templates/default/domains/Orders/entities/OrderItem/index.mdx +6 -5
  36. package/templates/default/domains/Orders/entities/ShoppingCart/index.mdx +16 -15
  37. package/templates/default/domains/Orders/index.mdx +22 -7
  38. package/templates/default/domains/Orders/services/InventoryService/changelog.mdx +1 -1
  39. package/templates/default/domains/Orders/services/InventoryService/commands/AddInventory/index.mdx +2 -5
  40. package/templates/default/domains/Orders/services/InventoryService/commands/AddInventory/schema.json +26 -27
  41. package/templates/default/domains/Orders/services/InventoryService/commands/PlaceOrder/index.mdx +10 -12
  42. package/templates/default/domains/Orders/services/InventoryService/commands/UpdateInventory/index.mdx +1 -1
  43. package/templates/default/domains/Orders/services/InventoryService/commands/UpdateInventory/schema.json +26 -27
  44. package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/changelog.mdx +3 -4
  45. package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/index.mdx +14 -4
  46. package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/changelog.mdx +3 -7
  47. package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/index.mdx +8 -5
  48. package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/changelog.mdx +11 -11
  49. package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/index.mdx +15 -12
  50. package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/index.mdx +1 -0
  51. package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/index.mdx +13 -12
  52. package/templates/default/domains/Orders/services/InventoryService/index.mdx +40 -21
  53. package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryList/index.mdx +5 -5
  54. package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryList/schema.json +48 -49
  55. package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryStatus/index.mdx +6 -7
  56. package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryStatus/schema.json +25 -26
  57. package/templates/default/domains/Orders/services/NotificationService/index.mdx +29 -10
  58. package/templates/default/domains/Orders/services/NotificationService/queries/GetNotificationDetails/index.mdx +4 -4
  59. package/templates/default/domains/Orders/services/NotificationService/queries/GetNotificationDetails/schema.json +0 -1
  60. package/templates/default/domains/Orders/services/NotificationService/queries/GetUserNotifications/index.mdx +4 -5
  61. package/templates/default/domains/Orders/services/NotificationService/queries/GetUserNotifications/schema.json +43 -44
  62. package/templates/default/domains/Orders/services/OrdersService/changelog.mdx +1 -1
  63. package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/schema.json +66 -67
  64. package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/index.mdx +1 -2
  65. package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/schema.json +67 -68
  66. package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/index.mdx +1 -1
  67. package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/schema.json +62 -63
  68. package/templates/default/domains/Orders/services/OrdersService/index.mdx +26 -6
  69. package/templates/default/domains/Orders/services/OrdersService/openapi.yml +3 -3
  70. package/templates/default/domains/Orders/services/OrdersService/order-service-asyncapi.yaml +11 -11
  71. package/templates/default/domains/Orders/services/OrdersService/queries/GetOrder/index.mdx +5 -5
  72. package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/changelog.mdx +1 -1
  73. package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/index.mdx +1 -1
  74. package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/openapi.yml +1 -1
  75. package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/order-service-asyncapi.yaml +11 -11
  76. package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/index.mdx +1 -2
  77. package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/schema.json +12 -12
  78. package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/index.mdx +2 -2
  79. package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/schema.json +17 -17
  80. package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/index.mdx +2 -2
  81. package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/index.mdx +2 -2
  82. package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/schema.json +26 -26
  83. package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/index.mdx +2 -2
  84. package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/schema.json +15 -15
  85. package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/index.mdx +2 -2
  86. package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/schema.json +15 -15
  87. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/index.mdx +2 -2
  88. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/schema.json +0 -1
  89. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/index.mdx +2 -2
  90. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/schema.json +15 -15
  91. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/index.mdx +2 -2
  92. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/schema.json +15 -15
  93. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/index.mdx +2 -2
  94. package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/schema.json +15 -15
  95. package/templates/default/domains/Orders/services/ShippingService/index.mdx +14 -5
  96. package/templates/default/domains/Orders/ubiquitous-language.mdx +10 -10
  97. package/templates/default/domains/Orders/versioned/0.0.1/index.mdx +7 -7
  98. package/templates/default/domains/Orders/versioned/0.0.2/index.mdx +3 -3
  99. package/templates/default/domains/Payment/entities/Address/index.mdx +17 -16
  100. package/templates/default/domains/Payment/entities/Invoice/index.mdx +8 -7
  101. package/templates/default/domains/Payment/entities/Payment/index.mdx +15 -14
  102. package/templates/default/domains/Payment/entities/PaymentMethod/index.mdx +8 -7
  103. package/templates/default/domains/Payment/entities/Transaction/index.mdx +6 -5
  104. package/templates/default/domains/Payment/flows/PaymentProcessed/index.mdx +71 -70
  105. package/templates/default/domains/Payment/index.mdx +10 -10
  106. package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/index.mdx +2 -2
  107. package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/schema.json +1 -1
  108. package/templates/default/domains/Payment/services/FraudDetectionService/index.mdx +3 -2
  109. package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/index.mdx +4 -3
  110. package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/schema.json +1 -1
  111. package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/index.mdx +4 -2
  112. package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/schema.json +1 -1
  113. package/templates/default/domains/Payment/services/PaymentGatewayService/index.mdx +3 -2
  114. package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/index.mdx +1 -1
  115. package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/index.mdx +1 -1
  116. package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/index.mdx +3 -3
  117. package/templates/default/domains/Payment/services/PaymentService/index.mdx +1 -0
  118. package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/index.mdx +5 -5
  119. package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/schema.json +0 -1
  120. package/templates/default/domains/Payment/ubiquitous-language.mdx +8 -8
  121. package/templates/default/domains/ProductCatalog/entities/Category/index.mdx +10 -9
  122. package/templates/default/domains/ProductCatalog/entities/Inventory/index.mdx +15 -14
  123. package/templates/default/domains/ProductCatalog/entities/Product/index.mdx +11 -10
  124. package/templates/default/domains/ProductCatalog/entities/Review/index.mdx +15 -14
  125. package/templates/default/domains/ProductCatalog/index.mdx +8 -6
  126. package/templates/default/domains/ProductCatalog/ubiquitous-language.mdx +10 -10
  127. package/templates/default/domains/Subscriptions/entities/BillingProfile/index.mdx +8 -7
  128. package/templates/default/domains/Subscriptions/entities/SubscriptionPeriod/index.mdx +8 -7
  129. package/templates/default/domains/Subscriptions/flows/CancelSubscription/SubscriptionRenewed/index.mdx +207 -208
  130. package/templates/default/domains/Subscriptions/flows/CancelSubscription/index.mdx +48 -49
  131. package/templates/default/domains/Subscriptions/flows/CancelSubscription/versioned/0.0.1/index.mdx +36 -36
  132. package/templates/default/domains/Subscriptions/index.mdx +10 -10
  133. package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/index.mdx +3 -2
  134. package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/schema.json +1 -1
  135. package/templates/default/domains/Subscriptions/services/BillingService/index.mdx +2 -1
  136. package/templates/default/domains/Subscriptions/services/PlanManagementService/index.mdx +6 -2
  137. package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/index.mdx +5 -5
  138. package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/index.mdx +5 -5
  139. package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/index.mdx +5 -5
  140. package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/index.mdx +5 -5
  141. package/templates/default/domains/Subscriptions/services/SubscriptionService/index.mdx +30 -10
  142. package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/index.mdx +5 -5
  143. package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/schema.json +10 -2
  144. package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/versioned/0.0.1/index.mdx +5 -5
  145. package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/versioned/0.0.1/schema.json +10 -2
  146. package/templates/default/domains/Subscriptions/ubiquitous-language.mdx +9 -9
  147. package/templates/default/eventcatalog.auth.js +4 -5
  148. package/templates/default/eventcatalog.config.js +6 -8
  149. package/templates/default/eventcatalog.styles.css +1 -1
  150. package/templates/default/teams/full-stack.mdx +4 -4
  151. package/templates/default/teams/mobile-devs.mdx +4 -2
  152. package/templates/default/users/aSmith.mdx +0 -1
  153. package/templates/default/users/dboyne.mdx +4 -3
  154. package/templates/default/users/mSmith.mdx +2 -2
  155. package/templates/empty/eventcatalog.auth.js +4 -5
  156. package/templates/empty/eventcatalog.config.js +6 -7
  157. package/templates/empty/eventcatalog.styles.css +1 -1
  158. package/templates/eventbridge/README-template.md +4 -8
  159. package/templates/eventbridge/eventcatalog.auth.js +4 -5
  160. package/templates/eventbridge/eventcatalog.config.js +7 -8
  161. package/templates/eventbridge/eventcatalog.styles.css +1 -1
  162. package/templates/graphql/eventcatalog.auth.js +4 -5
  163. package/templates/graphql/eventcatalog.config.js +29 -20
  164. package/templates/graphql/eventcatalog.styles.css +1 -1
  165. package/templates/graphql/teams/order-management.mdx +6 -6
  166. package/templates/graphql/teams/payment-management.mdx +4 -4
  167. package/templates/graphql/teams/product-management.mdx +4 -4
  168. package/templates/graphql/users/aSmith.mdx +0 -1
  169. package/templates/graphql/users/alee.mdx +1 -1
  170. package/templates/graphql/users/azhang.mdx +1 -1
  171. package/templates/graphql/users/dboyne.mdx +4 -3
  172. package/templates/graphql/users/dkim.mdx +1 -1
  173. package/templates/graphql/users/jbrown.mdx +1 -1
  174. package/templates/graphql/users/mSmith.mdx +2 -2
  175. package/templates/index.ts +49 -59
  176. package/templates/openapi/eventcatalog.auth.js +4 -5
  177. package/templates/openapi/eventcatalog.config.js +33 -26
  178. package/templates/openapi/eventcatalog.styles.css +1 -1
  179. package/templates/openapi/teams/order-management.mdx +6 -6
  180. package/templates/openapi/teams/payment-management.mdx +4 -4
  181. package/templates/openapi/teams/product-management.mdx +4 -4
  182. package/templates/openapi/users/aSmith.mdx +0 -1
  183. package/templates/openapi/users/alee.mdx +1 -1
  184. package/templates/openapi/users/azhang.mdx +1 -1
  185. package/templates/openapi/users/dboyne.mdx +4 -3
  186. package/templates/openapi/users/dkim.mdx +1 -1
  187. package/templates/openapi/users/jbrown.mdx +1 -1
  188. package/templates/openapi/users/mSmith.mdx +2 -2
  189. package/templates/types.ts +12 -3
@@ -2,7 +2,7 @@
2
2
  id: dboyne
3
3
  name: David Boyne
4
4
  summary: Tech Lead of the Full Stackers team
5
- avatarUrl: "https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png"
5
+ avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png'
6
6
  role: Lead developer
7
7
  email: test@test.com
8
8
  slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
@@ -29,5 +29,6 @@ I am passionate about leveraging the power of events to build systems that are n
29
29
  Feel free to connect with me to discuss all things tech, event-driven architectures, or to exchange ideas on building better software systems!
30
30
 
31
31
  ---
32
- *David Boyne*
33
- *Tech Lead, Full Stackers*
32
+
33
+ _David Boyne_
34
+ _Tech Lead, Full Stackers_
@@ -2,8 +2,8 @@
2
2
  id: msmith
3
3
  name: Martin Smith
4
4
  summary: Senior Mobile Developer on The Mobile Devs team
5
- avatarUrl: "https://randomuser.me/api/portraits/men/51.jpg"
5
+ avatarUrl: 'https://randomuser.me/api/portraits/men/51.jpg'
6
6
  role: Senior software engineer
7
7
  ---
8
8
 
9
- 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.
9
+ 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.
@@ -1,13 +1,12 @@
1
-
2
1
  /**
3
2
  * This is an optional file that can add authentication to your EventCatalog.
4
- *
3
+ *
5
4
  * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
5
  * And then pick which provider you want to use.
7
- *
6
+ *
8
7
  * You can read more in the documentation:
9
8
  * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
- *
9
+ *
11
10
  */
12
11
 
13
12
  // export default {
@@ -42,4 +41,4 @@
42
41
  // issuer: process.env.AUTH_OKTA_ISSUER,
43
42
  // },
44
43
  // },
45
- // }
44
+ // }
@@ -1,7 +1,8 @@
1
1
  /** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
2
2
  export default {
3
3
  title: 'EventCatalog',
4
- 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',
4
+ tagline:
5
+ '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',
5
6
  organizationName: '<organizationName>',
6
7
  homepageLink: 'https://eventcatalog.dev/',
7
8
  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
@@ -16,15 +17,13 @@ export default {
16
17
  // Customize the navigation for your docs sidebar.
17
18
  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
18
19
  navigation: {
19
- pages: [
20
- 'list:all',
21
- ]
20
+ pages: ['list:all'],
22
21
  },
23
22
  // Customize the logo, add your logo to public/ folder
24
23
  logo: {
25
24
  alt: 'EventCatalog Logo',
26
25
  src: '/logo.png',
27
- text: 'EventCatalog'
26
+ text: 'EventCatalog',
28
27
  },
29
28
  // This lets you copy markdown contents from EventCatalog to your clipboard
30
29
  // Including schemas for your events and services
@@ -32,5 +31,5 @@ export default {
32
31
  enabled: true,
33
32
  },
34
33
  // required random generated id used by eventcatalog
35
- cId: '<cId>'
36
- }
34
+ cId: '<cId>',
35
+ };
@@ -1 +1 @@
1
- /* Custom styling support coming soon. */
1
+ /* Custom styling support coming soon. */
@@ -5,10 +5,10 @@ Welcome to your new EventBridge EventCatalog!
5
5
  Getting started:
6
6
 
7
7
  1. Edit the `.env` file to configure your environment variables.
8
- 1. Configure the region and schema registry name in the `eventcatalog.config.js` file
9
- 2. Run `npm run generate` to import your schemas from confluent schema registry.
10
- 3. Run `npm run dev` to start the development server.
11
- 4. Go to localhost:3000 to view your catalog.
8
+ 1. Configure the region and schema registry name in the `eventcatalog.config.js` file
9
+ 1. Run `npm run generate` to import your schemas from confluent schema registry.
10
+ 1. Run `npm run dev` to start the development server.
11
+ 1. Go to localhost:3000 to view your catalog.
12
12
 
13
13
  ### What else can you do?
14
14
 
@@ -22,10 +22,6 @@ With the EventBridge integration you can :
22
22
 
23
23
  The easiest way to get started and dive deeper is to read the [EventCatalog documentation](https://www.eventcatalog.dev/docs/plugins/eventbridge/intro).
24
24
 
25
-
26
25
  ### Found a problem?
27
26
 
28
27
  If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
29
-
30
-
31
-
@@ -1,13 +1,12 @@
1
-
2
1
  /**
3
2
  * This is an optional file that can add authentication to your EventCatalog.
4
- *
3
+ *
5
4
  * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
5
  * And then pick which provider you want to use.
7
- *
6
+ *
8
7
  * You can read more in the documentation:
9
8
  * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
- *
9
+ *
11
10
  */
12
11
 
13
12
  // export default {
@@ -42,4 +41,4 @@
42
41
  // issuer: process.env.AUTH_OKTA_ISSUER,
43
42
  // },
44
43
  // },
45
- // }
44
+ // }
@@ -1,7 +1,8 @@
1
1
  /** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
2
2
  export default {
3
3
  title: 'EventCatalog',
4
- 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',
4
+ tagline:
5
+ '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',
5
6
  organizationName: '<organizationName>',
6
7
  homepageLink: 'https://eventcatalog.dev/',
7
8
  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
@@ -16,21 +17,19 @@ export default {
16
17
  // Customize the navigation for your docs sidebar.
17
18
  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
18
19
  navigation: {
19
- pages: [
20
- 'list:all',
21
- ]
20
+ pages: ['list:all'],
22
21
  },
23
22
  // Customize the logo, add your logo to public/ folder
24
23
  logo: {
25
24
  alt: 'EventCatalog Logo',
26
25
  src: '/logo.png',
27
- text: 'EventCatalog'
26
+ text: 'EventCatalog',
28
27
  },
29
28
  // Enable RSS feed for your eventcatalog
30
29
  rss: {
31
30
  enabled: true,
32
31
  // number of items to include in the feed per resource (event, service, etc)
33
- limit: 20
32
+ limit: 20,
34
33
  },
35
34
  // This lets you copy markdown contents from EventCatalog to your clipboard
36
35
  // Including schemas for your events and services
@@ -46,7 +45,7 @@ export default {
46
45
  // The region of your EventBridge registry
47
46
  region: 'us-east-1',
48
47
  // The name of your EventBridge registry
49
- registryName: 'discovered-schemas'
48
+ registryName: 'discovered-schemas',
50
49
  },
51
50
  ],
52
- }
51
+ };
@@ -1 +1 @@
1
- /* Custom styling support coming soon. */
1
+ /* Custom styling support coming soon. */
@@ -1,13 +1,12 @@
1
-
2
1
  /**
3
2
  * This is an optional file that can add authentication to your EventCatalog.
4
- *
3
+ *
5
4
  * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
5
  * And then pick which provider you want to use.
7
- *
6
+ *
8
7
  * You can read more in the documentation:
9
8
  * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
- *
9
+ *
11
10
  */
12
11
 
13
12
  // export default {
@@ -42,4 +41,4 @@
42
41
  // issuer: process.env.AUTH_OKTA_ISSUER,
43
42
  // },
44
43
  // },
45
- // }
44
+ // }
@@ -1,15 +1,16 @@
1
- import path from "path";
2
- import url from "url";
1
+ import path from 'path';
2
+ import url from 'url';
3
3
 
4
4
  const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
5
5
 
6
6
  /** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
7
7
  export default {
8
- title: "EventCatalog",
9
- 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',
8
+ title: 'EventCatalog',
9
+ tagline:
10
+ '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',
10
11
  organizationName: '<organizationName>',
11
- homepageLink: "https://eventcatalog.dev/",
12
- editUrl: "https://github.com/boyney123/eventcatalog-demo/edit/master",
12
+ homepageLink: 'https://eventcatalog.dev/',
13
+ editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
13
14
  // Supports static or server. Static renders a static site, server renders a server side rendered site
14
15
  // large catalogs may benefit from server side rendering
15
16
  output: 'static',
@@ -17,19 +18,17 @@ export default {
17
18
  trailingSlash: false,
18
19
  // Change to make the base url of the site different, by default https://{website}.com/docs,
19
20
  // changing to /company would be https://{website}.com/company/docs,
20
- base: "/",
21
+ base: '/',
21
22
  // Customize the navigation for your docs sidebar.
22
23
  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
23
24
  navigation: {
24
- pages: [
25
- 'list:all',
26
- ]
25
+ pages: ['list:all'],
27
26
  },
28
27
  // Customize the logo, add your logo to public/ folder
29
28
  logo: {
30
- alt: "EventCatalog Logo",
31
- src: "/logo.png",
32
- text: "EventCatalog",
29
+ alt: 'EventCatalog Logo',
30
+ src: '/logo.png',
31
+ text: 'EventCatalog',
33
32
  },
34
33
  // This lets you copy markdown contents from EventCatalog to your clipboard
35
34
  // Including schemas for your events and services
@@ -38,24 +37,34 @@ export default {
38
37
  },
39
38
  generators: [
40
39
  [
41
- "@eventcatalog/generator-graphql",
40
+ '@eventcatalog/generator-graphql',
42
41
  {
43
42
  services: [
44
- { path: path.join(__dirname, "graphql-files", "orders-service.graphql"), id: 'orders-service', version: '0.0.1', owners: ['order-management'] },
43
+ {
44
+ path: path.join(__dirname, 'graphql-files', 'orders-service.graphql'),
45
+ id: 'orders-service',
46
+ version: '0.0.1',
47
+ owners: ['order-management'],
48
+ },
45
49
  ],
46
- domain: { id: "orders", name: "Orders", version: "0.0.1" },
50
+ domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
47
51
  },
48
52
  ],
49
53
  [
50
- "@eventcatalog/generator-graphql",
54
+ '@eventcatalog/generator-graphql',
51
55
  {
52
56
  services: [
53
- { path: path.join(__dirname, "graphql-files", "payment-service.graphql"), id: 'payment-service', version: '0.0.1', owners: ['payment-management'] },
57
+ {
58
+ path: path.join(__dirname, 'graphql-files', 'payment-service.graphql'),
59
+ id: 'payment-service',
60
+ version: '0.0.1',
61
+ owners: ['payment-management'],
62
+ },
54
63
  ],
55
- domain: { id: "payment", name: "Payment", version: "0.0.1" },
64
+ domain: { id: 'payment', name: 'Payment', version: '0.0.1' },
56
65
  },
57
66
  ],
58
67
  ],
59
68
  // required random generated id used by eventcatalog
60
- cId: '<cId>'
69
+ cId: '<cId>',
61
70
  };
@@ -1 +1 @@
1
- /* Custom styling support coming soon. */
1
+ /* Custom styling support coming soon. */
@@ -3,11 +3,11 @@ id: order-management
3
3
  name: Order Management
4
4
  summmary: Order Management team based in London, UK
5
5
  members:
6
- - dboyne
7
- - asmith
8
- - msmith
9
- - alee
10
- - azhang
6
+ - dboyne
7
+ - asmith
8
+ - msmith
9
+ - alee
10
+ - azhang
11
11
  email: test@test.com
12
12
  slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
13
13
  ---
@@ -28,4 +28,4 @@ The Order Management team is responsible for managing orders, inventory, shipmen
28
28
 
29
29
  - David Boyne
30
30
  - Alice Smith
31
- - Mike Smith
31
+ - Mike Smith
@@ -2,9 +2,9 @@
2
2
  id: payment-management
3
3
  name: Payment Management
4
4
  members:
5
- - dboyne
6
- - jbrown
7
- - dkim
5
+ - dboyne
6
+ - jbrown
7
+ - dkim
8
8
  ---
9
9
 
10
10
  The payment management team is responsible for managing payments and payment accounts.
@@ -15,4 +15,4 @@ The payment management team is responsible for managing payments and payment acc
15
15
  - Manage payment and payment account provisioning
16
16
  - Manage payment and payment account deprovisioning
17
17
  - Manage user and user account password management
18
- - Manage user and user account role management
18
+ - Manage user and user account role management
@@ -2,9 +2,9 @@
2
2
  id: product-management
3
3
  name: Product Management
4
4
  members:
5
- - dboyne
6
- - jbrown
7
- - dkim
5
+ - dboyne
6
+ - jbrown
7
+ - dkim
8
8
  ---
9
9
 
10
10
  The product management team is responsible for managing products and product accounts.
@@ -15,4 +15,4 @@ The product management team is responsible for managing products and product acc
15
15
  - Manage product and product account provisioning
16
16
  - Manage product and product account deprovisioning
17
17
  - Manage product and product account password management
18
- - Manage product and product account role management
18
+ - Manage product and product account role management
@@ -24,4 +24,3 @@ As the Product Owner for Full Stackers, my role involves a wide range of respons
24
24
  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.
25
25
 
26
26
  If you’re interested in product management, user experience, or discussing the latest trends in technology, feel free to reach out!
27
-
@@ -5,4 +5,4 @@ avatarUrl: https://randomuser.me/api/portraits/women/91.jpg
5
5
  role: Technical Writer
6
6
  ---
7
7
 
8
- 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.
8
+ 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.
@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/azhang
8
8
  msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=azhang@company.com
9
9
  ---
10
10
 
11
- Building and maintaining data pipelines and infrastructure...
11
+ Building and maintaining data pipelines and infrastructure...
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  id: dboyne
3
3
  name: David Boyne
4
- avatarUrl: "https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png"
4
+ avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png'
5
5
  role: Lead developer
6
6
  email: test@test.com
7
7
  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
28
28
  Feel free to connect with me to discuss all things tech, event-driven architectures, or to exchange ideas on building better software systems!
29
29
 
30
30
  ---
31
- *David Boyne*
32
- *Tech Lead, Full Stackers*
31
+
32
+ _David Boyne_
33
+ _Tech Lead, Full Stackers_
@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/dkim
8
8
  msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=dkim@company.com
9
9
  ---
10
10
 
11
- Optimizing application performance and user experience...
11
+ Optimizing application performance and user experience...
@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/jbrown
8
8
  msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=jbrown@company.com
9
9
  ---
10
10
 
11
- Creating intuitive and engaging user interfaces...
11
+ Creating intuitive and engaging user interfaces...
@@ -1,8 +1,8 @@
1
1
  ---
2
2
  id: msmith
3
3
  name: Martin Smith
4
- avatarUrl: "https://randomuser.me/api/portraits/men/51.jpg"
4
+ avatarUrl: 'https://randomuser.me/api/portraits/men/51.jpg'
5
5
  role: Senior software engineer
6
6
  ---
7
7
 
8
- 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.
8
+ 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.
@@ -1,22 +1,18 @@
1
- import { copy } from "../helpers/copy";
2
- import { install } from "../helpers/install";
1
+ import { copy } from '../helpers/copy';
2
+ import { install } from '../helpers/install';
3
3
 
4
- import os from "os";
5
- import fs from "fs";
6
- import path from "path";
7
- import { v4 } from 'uuid'
4
+ import os from 'os';
5
+ import fs from 'fs';
6
+ import path from 'path';
7
+ import { v4 } from 'uuid';
8
8
 
9
- import { GetTemplateFileArgs, InstallTemplateArgs } from "./types";
10
- import { raiseEvent } from "./analytics";
9
+ import { GetTemplateFileArgs, InstallTemplateArgs } from './types';
10
+ import { raiseEvent } from './analytics';
11
11
 
12
12
  /**
13
13
  * Get the file path for a given file in a template, e.g. "next.config.js".
14
14
  */
15
- export const getTemplateFile = ({
16
- template,
17
- mode,
18
- file,
19
- }: GetTemplateFileArgs): string => {
15
+ export const getTemplateFile = ({ template, mode, file }: GetTemplateFileArgs): string => {
20
16
  return path.join(__dirname, template, mode, file);
21
17
  };
22
18
 
@@ -31,32 +27,29 @@ export const installTemplate = async ({
31
27
  template,
32
28
  mode,
33
29
  eslint,
34
- organizationName
30
+ organizationName,
35
31
  }: InstallTemplateArgs) => {
36
32
  /**
37
33
  * Create a package.json for the new project
38
34
  */
39
35
  const packageJson = {
40
36
  name: appName,
41
- version: "0.1.0",
37
+ version: '0.1.0',
42
38
  private: true,
43
39
  scripts: {
44
- dev: "eventcatalog dev",
45
- build: "eventcatalog build",
46
- start: "eventcatalog start",
47
- preview: "eventcatalog preview",
48
- generate: "eventcatalog generate",
49
- lint: "eventcatalog-linter",
40
+ dev: 'eventcatalog dev',
41
+ build: 'eventcatalog build',
42
+ start: 'eventcatalog start',
43
+ preview: 'eventcatalog preview',
44
+ generate: 'eventcatalog generate',
45
+ lint: 'eventcatalog-linter',
50
46
  test: 'echo "Error: no test specified" && exit 1',
51
- }
47
+ },
52
48
  };
53
49
  /**
54
50
  * Write it to disk.
55
51
  */
56
- fs.writeFileSync(
57
- path.join(root, "package.json"),
58
- JSON.stringify(packageJson, null, 2) + os.EOL,
59
- );
52
+ fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(packageJson, null, 2) + os.EOL);
60
53
  /**
61
54
  * These flags will be passed to `install()`, which calls the package manager
62
55
  * install process.
@@ -67,35 +60,32 @@ export const installTemplate = async ({
67
60
  * Default dependencies.
68
61
  */
69
62
  // const dependencies = ["@eventcatalog/eventcatalog-2"];
70
- const dependencies = [
71
- "@eventcatalog/core",
72
- "@eventcatalog/linter"
73
- ] as any;
63
+ const dependencies = ['@eventcatalog/core', '@eventcatalog/linter'] as any;
74
64
 
75
65
  // if asyncapi is selected, add the asyncapi dependencies
76
- if (template === "asyncapi") {
77
- dependencies.push("@eventcatalog/generator-asyncapi");
66
+ if (template === 'asyncapi') {
67
+ dependencies.push('@eventcatalog/generator-asyncapi');
78
68
  }
79
69
 
80
- if (template === "openapi") {
81
- dependencies.push("@eventcatalog/generator-openapi");
70
+ if (template === 'openapi') {
71
+ dependencies.push('@eventcatalog/generator-openapi');
82
72
  }
83
73
 
84
- if (template === "graphql") {
85
- dependencies.push("@eventcatalog/generator-graphql");
74
+ if (template === 'graphql') {
75
+ dependencies.push('@eventcatalog/generator-graphql');
86
76
  }
87
77
 
88
- if (template === "confluent") {
89
- dependencies.push("@eventcatalog/generator-confluent-schema-registry");
78
+ if (template === 'confluent') {
79
+ dependencies.push('@eventcatalog/generator-confluent-schema-registry');
90
80
  }
91
81
 
92
- if (template === "eventbridge") {
93
- dependencies.push("@eventcatalog/generator-eventbridge");
82
+ if (template === 'eventbridge') {
83
+ dependencies.push('@eventcatalog/generator-eventbridge');
94
84
  }
95
85
 
96
- if (template === "amazon-apigateway") {
97
- dependencies.push("@eventcatalog/generator-amazon-apigateway");
98
- dependencies.push("@eventcatalog/generator-openapi");
86
+ if (template === 'amazon-apigateway') {
87
+ dependencies.push('@eventcatalog/generator-amazon-apigateway');
88
+ dependencies.push('@eventcatalog/generator-openapi');
99
89
  }
100
90
 
101
91
  // "@myuser/my-package": "file:../lib"
@@ -115,24 +105,24 @@ export const installTemplate = async ({
115
105
  /**
116
106
  * Copy the template files to the target directory.
117
107
  */
118
- const templatePath = path.join(__dirname, "../templates", template);
108
+ const templatePath = path.join(__dirname, '../templates', template);
119
109
  // console.log("templatePath", templatePath, __dirname, template);
120
- await copy("**", root, {
110
+ await copy('**', root, {
121
111
  parents: true,
122
112
  cwd: templatePath,
123
113
  rename: (name) => {
124
114
  switch (name) {
125
- case "env":
126
- case "gitignore":
127
- case "npmrc":
128
- case "dockerignore":
129
- case "eslintrc.json": {
130
- return ".".concat(name);
115
+ case 'env':
116
+ case 'gitignore':
117
+ case 'npmrc':
118
+ case 'dockerignore':
119
+ case 'eslintrc.json': {
120
+ return '.'.concat(name);
131
121
  }
132
122
  // README.md is ignored by webpack-asset-relocator-loader used by ncc:
133
123
  // https://github.com/vercel/webpack-asset-relocator-loader/blob/e9308683d47ff507253e37c9bcbb99474603192b/src/asset-relocator.js#L227
134
- case "README-template.md": {
135
- return "README.md";
124
+ case 'README-template.md': {
125
+ return 'README.md';
136
126
  }
137
127
  default: {
138
128
  return name;
@@ -144,18 +134,18 @@ export const installTemplate = async ({
144
134
  const cId = v4();
145
135
 
146
136
  // update the properties in the eventcatalog.config.js
147
- const eventCatalogConfigPath = path.join(root, "eventcatalog.config.js");
148
- let eventCatalogConfig = fs.readFileSync(eventCatalogConfigPath, "utf8");
149
- eventCatalogConfig = eventCatalogConfig.replace( /<organizationName>/g, organizationName );
150
- eventCatalogConfig = eventCatalogConfig.replace( /<cId>/g, cId );
137
+ const eventCatalogConfigPath = path.join(root, 'eventcatalog.config.js');
138
+ let eventCatalogConfig = fs.readFileSync(eventCatalogConfigPath, 'utf8');
139
+ eventCatalogConfig = eventCatalogConfig.replace(/<organizationName>/g, organizationName);
140
+ eventCatalogConfig = eventCatalogConfig.replace(/<cId>/g, cId);
151
141
  fs.writeFileSync(eventCatalogConfigPath, eventCatalogConfig);
152
142
 
153
143
  await raiseEvent({ command: 'create', org: organizationName, cId });
154
144
 
155
145
  if (!eslint) {
156
146
  // remove un-necessary template file if eslint is not desired
157
- await fs.promises.unlink(path.join(root, ".eslintrc.json"));
147
+ await fs.promises.unlink(path.join(root, '.eslintrc.json'));
158
148
  }
159
149
  };
160
150
 
161
- export * from "./types";
151
+ export * from './types';