@eventcatalog/core 5.0.0-beta.8 → 5.0.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 (467) hide show
  1. package/LICENSE +234 -134
  2. package/README.md +5 -5
  3. package/dist/analytics/analytics.cjs +18 -3
  4. package/dist/analytics/analytics.d.cts +1 -1
  5. package/dist/analytics/analytics.d.ts +1 -1
  6. package/dist/analytics/analytics.js +3 -2
  7. package/dist/analytics/log-build.cjs +157 -76
  8. package/dist/analytics/log-build.d.cts +2 -2
  9. package/dist/analytics/log-build.d.ts +2 -2
  10. package/dist/analytics/log-build.js +7 -5
  11. package/dist/analytics/studio-usage.cjs +90 -0
  12. package/dist/analytics/studio-usage.d.cts +5 -0
  13. package/dist/analytics/studio-usage.d.ts +5 -0
  14. package/dist/analytics/studio-usage.js +10 -0
  15. package/dist/analytics/telemetry.cjs +42 -0
  16. package/dist/analytics/telemetry.d.cts +20 -0
  17. package/dist/analytics/telemetry.d.ts +20 -0
  18. package/dist/analytics/telemetry.js +8 -0
  19. package/dist/catalog-runtime.cjs +1 -1
  20. package/dist/{chunk-RFIXKATC.js → chunk-4G7FSRPN.js} +35 -42
  21. package/dist/{chunk-AWOO63ME.js → chunk-AD7CL772.js} +11 -4
  22. package/dist/chunk-CA6WCQ2T.js +54 -0
  23. package/dist/chunk-CPW6G62V.js +17 -0
  24. package/dist/{chunk-PU25TOOJ.js → chunk-JZN4RSMF.js} +1 -1
  25. package/dist/{chunk-4W55ZOOS.js → chunk-NEAVAFSJ.js} +66 -35
  26. package/dist/{chunk-C6T2AAFR.js → chunk-NIVST4WY.js} +9 -3
  27. package/dist/{chunk-ENAG6UH7.js → chunk-NKNOXQ62.js} +1 -6
  28. package/dist/{chunk-AYNZXUB5.js → chunk-OX6TSVHY.js} +5 -5
  29. package/dist/{chunk-36RYTYT5.js → chunk-PD7KTSYN.js} +1 -1
  30. package/dist/{chunk-RDIZJ7UT.js → chunk-RE7UTPWH.js} +1 -1
  31. package/dist/chunk-S5GWAUG5.js +29 -0
  32. package/dist/{chunk-T4G3VVZ4.js → chunk-YQGRMDRB.js} +4 -2
  33. package/dist/constants.cjs +1 -1
  34. package/dist/constants.js +1 -1
  35. package/dist/docs/api/02-config.md +57 -7
  36. package/dist/docs/development/00-why-eventcatalog.md +11 -11
  37. package/dist/docs/development/01-fundamentals.md +20 -13
  38. package/dist/docs/development/01-getting-started/configuration-overview.md +2 -2
  39. package/dist/docs/development/01-getting-started/installation.md +9 -1
  40. package/dist/docs/development/_getting-started.mdx +1 -1
  41. package/dist/docs/development/ask-your-architecture/01-intro.md +5 -5
  42. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +0 -4
  43. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +15 -3
  44. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +0 -3
  45. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +1 -1
  46. package/dist/docs/development/ask-your-architecture/02-llms.txt.md +1 -1
  47. package/dist/docs/development/ask-your-architecture/{05-skills/01-introduction.md → 03-install-skills.md} +57 -7
  48. package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +1 -1
  49. package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +86 -33
  50. package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +14 -4
  51. package/dist/docs/development/ask-your-architecture/03-schemas.txt.md +1 -1
  52. package/dist/docs/development/ask-your-architecture/04-agents/_category_.json +1 -1
  53. package/dist/docs/development/authentication/01-introduction.md +2 -23
  54. package/dist/docs/development/authentication/02-enabling-authentication.md +0 -20
  55. package/dist/docs/development/authentication/07-rbac-middleware.md +0 -2
  56. package/dist/docs/development/authentication/providers/03-setting-up-github.md +0 -2
  57. package/dist/docs/development/authentication/providers/03a-setting-up-google.md +0 -2
  58. package/dist/docs/development/authentication/providers/04-setting-up-azure-ad.md +0 -2
  59. package/dist/docs/development/authentication/providers/05-setting-up-okta.md +0 -3
  60. package/dist/docs/development/authentication/providers/06-setting-up-auth0.md +0 -2
  61. package/dist/docs/development/bring-your-own-documentation/01-introduction.md +0 -4
  62. package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +0 -3
  63. package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +0 -17
  64. package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +0 -4
  65. package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +0 -2
  66. package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +1 -3
  67. package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +1 -4
  68. package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +0 -2
  69. package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +1 -3
  70. package/dist/docs/development/components/components/11-flow.md +17 -0
  71. package/dist/docs/development/components/components/15-nodegraph.md +43 -10
  72. package/dist/docs/development/components/components/18-remote-schema.md +1 -4
  73. package/dist/docs/development/components/custom-components/07-reference.md +14 -0
  74. package/dist/docs/development/customization/02-themes.md +0 -5
  75. package/dist/docs/development/customization/03-search.md +1 -1
  76. package/dist/docs/development/customization/05-custom-pages-and-api-routes/01-introduction.md +0 -2
  77. package/dist/docs/development/customization/05-custom-pages-and-api-routes/04-reference.md +7 -1
  78. package/dist/docs/development/customization/05-resource-sidebar.md +1 -1
  79. package/dist/docs/development/customization/09-embed-eventcatalog.md +20 -25
  80. package/dist/docs/development/deployment/hosting-options.md +7 -2
  81. package/dist/docs/development/developer-tools/eventcatalog-linter/how-to/05-fix-common-problems.md +16 -0
  82. package/dist/docs/development/developer-tools/eventcatalog-linter/reference/03-rules.md +31 -1
  83. package/dist/docs/development/developer-tools/eventcatalog-linter/reference/05-supported-resources.md +1 -1
  84. package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +0 -10
  85. package/dist/docs/development/governance/architecture-change-detection/06-pipeline-gates.md +0 -4
  86. package/dist/docs/development/guides/97-architecture-graph.md +1 -1
  87. package/dist/docs/development/guides/99-adding-analytics.md +0 -7
  88. package/dist/docs/development/guides/domains/03-model-subdomains.md +2 -2
  89. package/dist/docs/development/guides/domains/04-add-resources-to-domains/01-add-systems-to-domains.md +3 -1
  90. package/dist/docs/development/guides/domains/04-add-resources-to-domains/02-add-services-to-domains.md +5 -1
  91. package/dist/docs/development/guides/domains/04-add-resources-to-domains/03-add-messages-to-domains.md +2 -2
  92. package/dist/docs/development/guides/domains/04-add-resources-to-domains/05-add-entities-to-domains.md +1 -1
  93. package/dist/docs/development/guides/domains/04-add-resources-to-domains/06-domain-resources-page.md +40 -0
  94. package/dist/docs/development/guides/domains/06-visualize-domains/01-domain-diagram.md +89 -0
  95. package/dist/docs/development/guides/domains/06-visualize-domains/_category_.json +1 -2
  96. package/dist/docs/development/guides/domains/09-reference.md +4 -4
  97. package/dist/docs/development/guides/owners/automated-teams-and-users/create-your-own-connector.md +0 -2
  98. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-github.md +0 -3
  99. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-microsoft-entra.md +0 -2
  100. package/dist/docs/development/guides/resources/adrs/03-linking-resources.md +8 -0
  101. package/dist/docs/development/guides/resources/adrs/06-reference.md +4 -4
  102. package/dist/docs/development/guides/resources/agents/11-reference.md +1 -1
  103. package/dist/docs/development/guides/resources/data/04-reference.md +1 -1
  104. package/dist/docs/development/guides/resources/data-products/07-reference.md +1 -1
  105. package/dist/docs/development/guides/resources/entities/05-entity-maps.md +1 -1
  106. package/dist/docs/development/guides/resources/entities/06-reference.md +2 -2
  107. package/dist/docs/development/guides/resources/flows/01-introduction.md +11 -1
  108. package/dist/docs/development/guides/resources/flows/03-model-flow-steps.md +65 -6
  109. package/dist/docs/development/guides/resources/flows/05-explore-flows.md +112 -0
  110. package/dist/docs/development/guides/resources/flows/06-reference.md +25 -4
  111. package/dist/docs/development/guides/resources/messages/01-what-are-messages.md +19 -0
  112. package/dist/docs/development/guides/resources/messages/04-message-channels/01-introduction.md +16 -0
  113. package/dist/docs/development/guides/resources/messages/04-message-channels/05-reference.md +2 -1
  114. package/dist/docs/development/guides/resources/messages/10-reference.md +6 -3
  115. package/dist/docs/development/guides/resources/schemas/04-explore-schemas/01-schema-explorer.md +2 -2
  116. package/dist/docs/development/guides/resources/schemas/04-explore-schemas/02-fields-explorer.md +0 -9
  117. package/dist/docs/development/guides/resources/schemas/05-schema-api.md +0 -3
  118. package/dist/docs/development/guides/resources/schemas/06-schema-mcp.md +11 -3
  119. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/03-add-entities-to-services.md +1 -1
  120. package/dist/docs/development/guides/resources/services/05-resources-page.md +50 -0
  121. package/dist/docs/development/guides/resources/services/08-reference.md +2 -1
  122. package/dist/docs/development/guides/systems/01-introduction.md +1 -1
  123. package/dist/docs/development/guides/systems/02-create-system.md +2 -2
  124. package/dist/docs/development/guides/systems/03-add-resources-to-systems.md +35 -9
  125. package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md +5 -3
  126. package/dist/docs/development/guides/systems/05-system-context-maps.md +39 -22
  127. package/dist/docs/development/guides/systems/06-reference.md +4 -4
  128. package/dist/docs/development/license/01-license-file.md +151 -0
  129. package/dist/docs/development/license/_category_.json +12 -0
  130. package/dist/docs/development/license-keys/_category_.json +3 -3
  131. package/dist/docs/development/license-keys/integrations.md +7 -37
  132. package/dist/docs/development/license-keys/license-validation.md +4 -0
  133. package/dist/docs/development/license-keys/overview.md +5 -1
  134. package/dist/docs/development/license-keys/plans.md +4 -2
  135. package/dist/docs/development/studio/01-introduction.md +60 -0
  136. package/dist/docs/development/studio/02-create-a-canvas.md +103 -0
  137. package/dist/docs/development/studio/03-set-up-persistent-storage.md +59 -0
  138. package/dist/docs/development/studio/04-collaborate-on-a-canvas.md +78 -0
  139. package/dist/docs/development/studio/05-connect-your-agent.md +102 -0
  140. package/dist/docs/development/studio/06-run-studio-in-production.md +54 -0
  141. package/dist/docs/development/studio/07-reference.md +294 -0
  142. package/dist/docs/development/studio/_category_.json +12 -0
  143. package/dist/docs/development/upgrading/v5.md +345 -0
  144. package/dist/docs/federation/00-overview.md +2 -8
  145. package/dist/docs/federation/01-first-federation.md +6 -18
  146. package/dist/docs/federation/explanation/how-it-works.md +0 -4
  147. package/dist/docs/federation/explanation/lockfile-and-cache.md +0 -4
  148. package/dist/docs/federation/explanation/mvp-status-and-feedback.md +0 -4
  149. package/dist/docs/federation/explanation/ownership-and-references.md +0 -4
  150. package/dist/docs/federation/how-to/configure-github-sources.md +6 -5
  151. package/dist/docs/federation/how-to/configure-validation-rules.md +0 -4
  152. package/dist/docs/federation/how-to/run-in-ci.md +2 -9
  153. package/dist/docs/federation/how-to/share-assets-and-components.md +0 -4
  154. package/dist/docs/federation/how-to/use-local-sources.md +0 -4
  155. package/dist/docs/federation/legacy-federation/00-introduction.md +4 -22
  156. package/dist/docs/federation/legacy-federation/01-installation.md +7 -58
  157. package/dist/docs/federation/legacy-federation/02-plugin-configuration.md +3 -21
  158. package/dist/docs/federation/legacy-federation/03-examples.md +3 -5
  159. package/dist/docs/federation/legacy-federation/04-configuration.md +3 -8
  160. package/dist/docs/federation/legacy-federation/05-setup-team-catalog.md +3 -6
  161. package/dist/docs/federation/reference/cli.md +2 -8
  162. package/dist/docs/federation/reference/configuration.md +0 -4
  163. package/dist/docs/federation/reference/diagnostic-rules.md +0 -5
  164. package/dist/docs/federation/reference/generated-output.md +0 -4
  165. package/dist/docs/federation/reference/supported-content.md +0 -4
  166. package/dist/docs/federation/reference/troubleshooting.md +0 -14
  167. package/dist/docs/plugins/02-generators.md +1 -1
  168. package/dist/docs/plugins/amazon-apigateway/00-intro.md +3 -28
  169. package/dist/docs/plugins/amazon-apigateway/01-installation.md +4 -56
  170. package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +1 -6
  171. package/dist/docs/plugins/apicurio/00-intro.md +2 -31
  172. package/dist/docs/plugins/apicurio/01-installation.md +2 -26
  173. package/dist/docs/plugins/apicurio/02-plugin-configuration.md +5 -13
  174. package/dist/docs/plugins/apicurio/03-features.md +1 -3
  175. package/dist/docs/plugins/asyncapi/00-intro.md +2 -28
  176. package/dist/docs/plugins/asyncapi/01-installation.md +3 -54
  177. package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +2 -1
  178. package/dist/docs/plugins/aws-glue-registry/00-intro.md +4 -32
  179. package/dist/docs/plugins/aws-glue-registry/00a-installation.md +3 -53
  180. package/dist/docs/plugins/azure-schema-registry/00-intro.md +4 -32
  181. package/dist/docs/plugins/azure-schema-registry/01-installation.md +6 -33
  182. package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +1 -14
  183. package/dist/docs/plugins/azure-schema-registry/04-examples.md +0 -2
  184. package/dist/docs/plugins/backstage/00-overview.md +1 -7
  185. package/dist/docs/plugins/backstage/01-get-started.md +6 -15
  186. package/dist/docs/plugins/backstage/06-configuration.md +2 -8
  187. package/dist/docs/plugins/confluent-schema-registry/00-intro.md +2 -29
  188. package/dist/docs/plugins/confluent-schema-registry/01-installation.md +2 -26
  189. package/dist/docs/plugins/eventbridge/00-intro.md +0 -4
  190. package/dist/docs/plugins/eventbridge/00a-installation.md +1 -87
  191. package/dist/docs/plugins/eventbridge/03-api.md +2 -20
  192. package/dist/docs/plugins/github/00-intro.md +0 -31
  193. package/dist/docs/plugins/github/01-installation.md +2 -34
  194. package/dist/docs/plugins/graphql/00-intro.md +0 -30
  195. package/dist/docs/plugins/graphql/01-installation.md +1 -53
  196. package/dist/docs/plugins/graphql/02-plugin-configuration.md +0 -1
  197. package/dist/docs/plugins/hookdeck/01-intro.md +1 -1
  198. package/dist/docs/plugins/openapi/00-intro.md +0 -30
  199. package/dist/docs/plugins/openapi/01-installation.md +1 -57
  200. package/dist/docs/plugins/openapi/02-plugin-configuration.md +0 -5
  201. package/dist/docs/plugins/openapi/03-features.md +0 -4
  202. package/dist/eventcatalog-config-file-utils.cjs +34 -41
  203. package/dist/eventcatalog-config-file-utils.d.cts +56 -58
  204. package/dist/eventcatalog-config-file-utils.d.ts +56 -58
  205. package/dist/eventcatalog-config-file-utils.js +1 -1
  206. package/dist/eventcatalog.cjs +408 -281
  207. package/dist/eventcatalog.config.d.cts +26 -15
  208. package/dist/eventcatalog.config.d.ts +26 -15
  209. package/dist/eventcatalog.js +46 -27
  210. package/dist/features.cjs +36 -49
  211. package/dist/features.d.cts +1 -3
  212. package/dist/features.d.ts +1 -3
  213. package/dist/features.js +4 -6
  214. package/dist/federation/federate.cjs +37 -44
  215. package/dist/federation/federate.js +5 -5
  216. package/dist/federation/source-provider.js +2 -2
  217. package/dist/generate.cjs +37 -42
  218. package/dist/generate.js +4 -4
  219. package/dist/resolve-catalog-dependencies.cjs +34 -41
  220. package/dist/resolve-catalog-dependencies.js +2 -2
  221. package/dist/runtime-dependencies/@eventcatalog__visualiser__studio-fonts.css.mjs +3 -0
  222. package/dist/runtime-dependencies/@eventcatalog__visualiser__studio.css.mjs +3 -0
  223. package/dist/runtime-dependencies/@eventcatalog__visualiser__studio.mjs +3 -0
  224. package/dist/runtime-dependencies/htmlparser2.mjs +3 -0
  225. package/dist/runtime-dependencies/manifest.json +5 -1
  226. package/dist/runtime-dependencies/react-syntax-highlighter__dist__cjs__create-element.js.mjs +3 -0
  227. package/dist/utils/child-process-signals.cjs +53 -0
  228. package/dist/utils/child-process-signals.d.cts +19 -0
  229. package/dist/utils/child-process-signals.d.ts +19 -0
  230. package/dist/utils/child-process-signals.js +6 -0
  231. package/dist/utils/cli-logger.cjs +1 -1
  232. package/dist/utils/cli-logger.js +2 -2
  233. package/dist/utils/license-status.cjs +11 -4
  234. package/dist/utils/license-status.d.cts +3 -2
  235. package/dist/utils/license-status.d.ts +3 -2
  236. package/dist/utils/license-status.js +1 -1
  237. package/eventcatalog/astro.config.mjs +21 -1
  238. package/eventcatalog/integrations/config-loader.mjs +56 -58
  239. package/eventcatalog/integrations/skip-startup-reload.mjs +31 -0
  240. package/eventcatalog/integrations/stable-dependency-order.mjs +29 -0
  241. package/eventcatalog/integrations/storage.mjs +20 -0
  242. package/eventcatalog/integrations/studio-server.mjs +4 -1
  243. package/eventcatalog/src/components/CatalogGraph/CatalogForceGraph.tsx +39 -0
  244. package/eventcatalog/src/components/ChatPanel/ChatPanel.tsx +2 -0
  245. package/eventcatalog/src/components/Homepage/CatalogDashboard.astro +342 -0
  246. package/eventcatalog/src/components/MDX/NodeGraph/AstroNodeGraph.tsx +60 -4
  247. package/eventcatalog/src/components/MDX/NodeGraph/NodeGraph.astro +5 -1
  248. package/eventcatalog/src/components/NavigationProgress.astro +7 -0
  249. package/eventcatalog/src/components/SchemaExplorer/ApiContentViewer.tsx +2 -0
  250. package/eventcatalog/src/components/SchemaExplorer/ExamplesViewer.tsx +2 -0
  251. package/eventcatalog/src/components/SchemaExplorer/SchemaCodeModal.tsx +2 -0
  252. package/eventcatalog/src/components/SchemaExplorer/SchemaContentViewer.tsx +2 -0
  253. package/eventcatalog/src/components/Search/SearchDataLoader.astro +16 -28
  254. package/eventcatalog/src/components/Search/SearchModal.tsx +2 -10
  255. package/eventcatalog/src/components/Search/search-utils.ts +26 -0
  256. package/eventcatalog/src/components/Seo.astro +5 -1
  257. package/eventcatalog/src/components/Settings/AssistantSettingsForm.tsx +53 -48
  258. package/eventcatalog/src/components/Settings/GeneralSettingsForm.tsx +183 -178
  259. package/eventcatalog/src/components/Settings/LicenseSettings.tsx +140 -31
  260. package/eventcatalog/src/components/Settings/LlmAccessSettingsForm.tsx +40 -35
  261. package/eventcatalog/src/components/Settings/LogoUpload.tsx +1 -1
  262. package/eventcatalog/src/components/Settings/McpSettingsForm.tsx +9 -8
  263. package/eventcatalog/src/components/Settings/Row.tsx +7 -4
  264. package/eventcatalog/src/components/Settings/SettingsShared.tsx +3 -3
  265. package/eventcatalog/src/components/SideNav/NestedSideBar/index.tsx +37 -76
  266. package/eventcatalog/src/components/SideNav/NestedSideBar/storage.ts +2 -0
  267. package/eventcatalog/src/components/SideNav/NestedSideBar/utils.ts +122 -1
  268. package/eventcatalog/src/components/SideNav/SideNav.astro +9 -1
  269. package/eventcatalog/src/components/TrialBadge.astro +20 -9
  270. package/eventcatalog/src/content.config.ts +19 -2
  271. package/eventcatalog/src/features/auth/error.astro +4 -2
  272. package/eventcatalog/src/features/auth/login.astro +2 -1
  273. package/eventcatalog/src/features/auth/middleware/middleware-auth.ts +21 -1
  274. package/eventcatalog/src/features/auth/unauthorized.astro +1 -1
  275. package/eventcatalog/src/features/fields/pages/fields.astro +1 -1
  276. package/eventcatalog/src/features/integrations/eventcatalog-features.ts +13 -7
  277. package/eventcatalog/src/features/mcp/apps/architecture-diagram/node-chat.tsx +6 -45
  278. package/eventcatalog/src/features/mcp/apps/canvas/shared.ts +3 -3
  279. package/eventcatalog/src/features/mcp/apps/canvas/styles.css +3 -1
  280. package/eventcatalog/src/features/mcp/apps/canvas/view.tsx +7 -5
  281. package/eventcatalog/src/features/mcp/apps/generated/canvas.html +123 -98
  282. package/eventcatalog/src/features/mcp/apps/generated/viewer.html +118 -101
  283. package/eventcatalog/src/features/mcp/mcp-server.ts +20 -4
  284. package/eventcatalog/src/features/server/start.ts +25 -0
  285. package/eventcatalog/src/features/storage/database.ts +88 -0
  286. package/eventcatalog/src/features/storage/migrations.ts +85 -0
  287. package/eventcatalog/src/features/storage/sql/database.sql +5 -0
  288. package/eventcatalog/src/features/storage/sql/migrations/0001-studio-canvases.sql +12 -0
  289. package/eventcatalog/src/features/storage/sql/migrations.sql +15 -0
  290. package/eventcatalog/src/features/storage/sql.ts +28 -0
  291. package/eventcatalog/src/features/studio/agent-choreography.ts +13 -10
  292. package/eventcatalog/src/features/studio/agents.ts +28 -0
  293. package/eventcatalog/src/features/studio/api/canvases-api.ts +219 -0
  294. package/eventcatalog/src/features/studio/api/canvases.ts +25 -0
  295. package/eventcatalog/src/features/studio/api/client.ts +40 -0
  296. package/eventcatalog/src/features/studio/canvas-actions.ts +160 -34
  297. package/eventcatalog/src/features/studio/canvas-preview.ts +1 -2
  298. package/eventcatalog/src/features/studio/catalog.ts +16 -14
  299. package/eventcatalog/src/features/studio/components/CanvasHeader.tsx +274 -105
  300. package/eventcatalog/src/features/studio/components/CanvasStatusMenu.tsx +15 -14
  301. package/eventcatalog/src/features/studio/components/ConnectAgentDialog.tsx +272 -119
  302. package/eventcatalog/src/features/studio/components/ConnectionsChooser.tsx +1 -2
  303. package/eventcatalog/src/features/studio/components/DeleteCanvasDialog.tsx +65 -0
  304. package/eventcatalog/src/features/studio/components/Dialog.tsx +60 -0
  305. package/eventcatalog/src/features/studio/components/JoinForm.tsx +101 -26
  306. package/eventcatalog/src/features/studio/components/LeftPanel.tsx +122 -230
  307. package/eventcatalog/src/features/studio/components/NodeDetails.tsx +183 -0
  308. package/eventcatalog/src/features/studio/components/OpenInStudioDialog.tsx +79 -0
  309. package/eventcatalog/src/features/studio/components/Presence.tsx +52 -45
  310. package/eventcatalog/src/features/studio/components/ShareDialog.tsx +277 -141
  311. package/eventcatalog/src/features/studio/components/ShortcutsDialog.tsx +41 -0
  312. package/eventcatalog/src/features/studio/components/StudioDesigner.tsx +1314 -385
  313. package/eventcatalog/src/features/studio/components/StudioNotice.astro +24 -0
  314. package/eventcatalog/src/features/studio/document-name.ts +7 -0
  315. package/eventcatalog/src/features/studio/from-visualiser.ts +138 -0
  316. package/eventcatalog/src/features/studio/hooks/presence-sender.ts +19 -2
  317. package/eventcatalog/src/features/studio/hooks/use-canvas-webmcp.ts +9 -3
  318. package/eventcatalog/src/features/studio/hooks/use-comments.ts +2 -2
  319. package/eventcatalog/src/features/studio/hooks/use-follow-camera.ts +8 -3
  320. package/eventcatalog/src/features/studio/hooks/use-studio-flow.ts +244 -32
  321. package/eventcatalog/src/features/studio/identity.ts +25 -1
  322. package/eventcatalog/src/features/studio/limits.ts +2 -0
  323. package/eventcatalog/src/features/studio/pages/[id].astro +42 -16
  324. package/eventcatalog/src/features/studio/pages/index.astro +596 -373
  325. package/eventcatalog/src/features/studio/pages/webmcp-relay.ts +12 -15
  326. package/eventcatalog/src/features/studio/server/canvas-mcp.ts +8 -23
  327. package/eventcatalog/src/features/studio/server/runtime.ts +150 -46
  328. package/eventcatalog/src/features/studio/server/sql/storage.sql +18 -0
  329. package/eventcatalog/src/features/studio/server/storage.ts +53 -73
  330. package/eventcatalog/src/features/studio/webmcp-relay/LICENSE +21 -0
  331. package/eventcatalog/src/features/studio/webmcp-relay/README.md +5 -0
  332. package/eventcatalog/src/features/studio/webmcp-relay/embed.js +2 -0
  333. package/eventcatalog/src/features/studio/webmcp-relay/widget.html +10 -0
  334. package/eventcatalog/src/features/studio/webmcp-relay/widget.js +1 -0
  335. package/eventcatalog/src/features/tools/catalog-tools.ts +3 -1
  336. package/eventcatalog/src/layouts/BaseLayout.astro +4 -4
  337. package/eventcatalog/src/layouts/SettingsLayout.astro +2 -2
  338. package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +3 -2
  339. package/eventcatalog/src/pages/_index.astro +5 -342
  340. package/eventcatalog/src/pages/architecture/[type]/[id]/[version]/_index.data.spec.ts +2 -3
  341. package/eventcatalog/src/pages/architecture/[type]/[id]/[version]/_index.data.ts +0 -7
  342. package/eventcatalog/src/pages/architecture/[type]/[id]/[version]/index.astro +3 -1
  343. package/eventcatalog/src/pages/diagrams/[id]/[version]/_index.data.ts +0 -7
  344. package/eventcatalog/src/pages/diagrams/[id]/[version]/embed.astro +1 -0
  345. package/eventcatalog/src/pages/diagrams/[id]/[version]/index.astro +1 -0
  346. package/eventcatalog/src/pages/directory/[type]/_index.data.ts +5 -7
  347. package/eventcatalog/src/pages/directory/[type]/index.astro +3 -1
  348. package/eventcatalog/src/pages/discover/[type]/_index.data.ts +5 -7
  349. package/eventcatalog/src/pages/discover/[type]/index.astro +3 -1
  350. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/_index.data.ts +0 -7
  351. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/index.astro +1 -0
  352. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/_index.data.ts +0 -7
  353. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/index.astro +1 -0
  354. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/_index.data.ts +0 -7
  355. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/asyncapi/[filename].astro +3 -1
  356. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/asyncapi/_[filename].data.ts +0 -7
  357. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/changelog/_index.data.ts +0 -7
  358. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/changelog/index.astro +1 -0
  359. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/examples/[...filename].astro +1 -0
  360. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/examples/_[...filename].data.ts +0 -4
  361. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/field-lineage/_index.data.ts +0 -7
  362. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/field-lineage/index.astro +1 -0
  363. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/graphql/[filename].astro +3 -1
  364. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/graphql/_[filename].data.ts +0 -7
  365. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/index.astro +1 -0
  366. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/resources/_index.data.spec.ts +2 -3
  367. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/resources/_index.data.ts +0 -7
  368. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/resources/index.astro +1 -0
  369. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/spec/[filename].astro +1 -0
  370. package/eventcatalog/src/pages/docs/[type]/[id]/[version]/spec/_[filename].data.ts +0 -7
  371. package/eventcatalog/src/pages/docs/[type]/[id]/_index.data.ts +0 -7
  372. package/eventcatalog/src/pages/docs/[type]/[id]/index.astro +2 -1
  373. package/eventcatalog/src/pages/docs/[type]/[id]/language/[dictionaryId]/_index.data.ts +0 -7
  374. package/eventcatalog/src/pages/docs/[type]/[id]/language/[dictionaryId]/index.astro +1 -0
  375. package/eventcatalog/src/pages/docs/[type]/[id]/language/_index.data.ts +0 -7
  376. package/eventcatalog/src/pages/docs/[type]/[id]/language/index.astro +1 -0
  377. package/eventcatalog/src/pages/docs/custom/[...path]/_index.data.ts +0 -7
  378. package/eventcatalog/src/pages/docs/custom/[...path]/index.astro +1 -0
  379. package/eventcatalog/src/pages/docs/services/[id]/[docType]/[docId]/index.astro +1 -1
  380. package/eventcatalog/src/pages/docs/services/[id]/[version]/resources/index.astro +1 -0
  381. package/eventcatalog/src/pages/docs/services/[id]/asyncapi/[filename].astro +1 -1
  382. package/eventcatalog/src/pages/docs/services/[id]/changelog/index.astro +1 -1
  383. package/eventcatalog/src/pages/docs/services/[id]/graphql/[filename].astro +1 -1
  384. package/eventcatalog/src/pages/docs/services/[id]/spec/[filename].astro +1 -1
  385. package/eventcatalog/src/pages/docs/teams/[id]/_index.data.ts +0 -7
  386. package/eventcatalog/src/pages/docs/teams/[id]/index.astro +1 -0
  387. package/eventcatalog/src/pages/docs/users/[id]/_index.data.ts +0 -7
  388. package/eventcatalog/src/pages/docs/users/[id]/index.astro +1 -0
  389. package/eventcatalog/src/pages/index.astro +4 -2
  390. package/eventcatalog/src/pages/schemas/[type]/[id]/[version]/_index.data.ts +0 -7
  391. package/eventcatalog/src/pages/schemas/[type]/[id]/[version]/index.astro +9 -1
  392. package/eventcatalog/src/pages/schemas/explorer/_index.data.ts +0 -7
  393. package/eventcatalog/src/pages/schemas/explorer/index.astro +4 -2
  394. package/eventcatalog/src/pages/settings/license.astro +9 -1
  395. package/eventcatalog/src/pages/triggers/[type]/[id]/[version]/_index.data.ts +0 -7
  396. package/eventcatalog/src/pages/triggers/[type]/[id]/[version]/index.astro +1 -0
  397. package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/_index.data.ts +0 -7
  398. package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/data/_index.data.ts +0 -7
  399. package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/data/index.astro +1 -0
  400. package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/entity-map/_index.data.ts +0 -7
  401. package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/entity-map/index.astro +1 -0
  402. package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/index.astro +1 -0
  403. package/eventcatalog/src/pages/visualiser/[type]/[id]/_index.data.ts +38 -0
  404. package/eventcatalog/src/pages/visualiser/[type]/[id]/index.astro +18 -41
  405. package/eventcatalog/src/pages/visualiser/designs/[id]/_index.data.ts +0 -7
  406. package/eventcatalog/src/pages/visualiser/designs/[id]/index.astro +2 -1
  407. package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/_index.data.ts +0 -7
  408. package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/index.astro +1 -0
  409. package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/index.astro +1 -0
  410. package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/systems-context/_index.data.ts +0 -7
  411. package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/systems-context/index.astro +1 -0
  412. package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/context/_index.data.ts +0 -7
  413. package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/context/index.astro +1 -0
  414. package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/index.astro +1 -0
  415. package/eventcatalog/src/types/react-syntax-highlighter.d.ts +10 -0
  416. package/eventcatalog/src/utils/collections/flows.ts +20 -7
  417. package/eventcatalog/src/utils/collections/resource-owners.ts +8 -2
  418. package/eventcatalog/src/utils/collections/resources.ts +2 -0
  419. package/eventcatalog/src/utils/collections/util.ts +8 -4
  420. package/eventcatalog/src/utils/git.ts +11 -0
  421. package/eventcatalog/src/utils/homepage-dashboard.ts +143 -0
  422. package/eventcatalog/src/utils/license.ts +1 -1
  423. package/eventcatalog/src/utils/link-validation.ts +25 -19
  424. package/eventcatalog/src/utils/node-graphs/domain-entity-map.ts +3 -1
  425. package/eventcatalog/src/utils/node-graphs/domain-levels-node-graph.ts +3 -3
  426. package/eventcatalog/src/utils/node-graphs/field-node-graph.ts +4 -2
  427. package/eventcatalog/src/utils/node-graphs/layout-node-graph.ts +20 -1
  428. package/eventcatalog/src/utils/node-graphs/node-resource.ts +67 -0
  429. package/eventcatalog/src/utils/node-graphs/systems-node-graph.ts +1 -1
  430. package/eventcatalog/src/utils/page-loaders/hybrid-page.ts +4 -15
  431. package/eventcatalog/src/utils/page-title.ts +15 -0
  432. package/eventcatalog/src/utils/syntax-highlighter-renderer.ts +64 -0
  433. package/eventcatalog/src/utils/trial.ts +13 -0
  434. package/package.json +11 -11
  435. package/dist/docs/development/ask-your-architecture/05-skills/02-installation.md +0 -60
  436. package/dist/docs/development/ask-your-architecture/05-skills/_category_.json +0 -11
  437. package/dist/docs/development/ask-your-architecture/06-slack-integration/01-introduction.md +0 -63
  438. package/dist/docs/development/ask-your-architecture/06-slack-integration/02-slack-app-setup.md +0 -154
  439. package/dist/docs/development/ask-your-architecture/06-slack-integration/03-installation.md +0 -169
  440. package/dist/docs/development/ask-your-architecture/06-slack-integration/04-deployment.md +0 -236
  441. package/dist/docs/development/ask-your-architecture/06-slack-integration/05-usage.md +0 -140
  442. package/dist/docs/development/ask-your-architecture/06-slack-integration/06-troubleshooting.md +0 -268
  443. package/dist/docs/development/ask-your-architecture/06-slack-integration/_category_.json +0 -13
  444. package/dist/docs/development/guides/domains/06-visualize-domains/01-domain-integration-map.md +0 -40
  445. package/dist/runtime-dependencies/@mcp-b__webmcp-local-relay.mjs +0 -3
  446. package/eventcatalog/src/features/studio/canvas-doc.ts +0 -409
  447. package/eventcatalog/src/features/studio/clipboard.ts +0 -97
  448. package/eventcatalog/src/features/studio/components/CanvasControls.tsx +0 -154
  449. package/eventcatalog/src/features/studio/components/Comments.tsx +0 -770
  450. package/eventcatalog/src/features/studio/components/ContainerChooser.tsx +0 -145
  451. package/eventcatalog/src/features/studio/components/DragGhost.tsx +0 -115
  452. package/eventcatalog/src/features/studio/components/Picture.tsx +0 -21
  453. package/eventcatalog/src/features/studio/components/PropertiesPanel.tsx +0 -212
  454. package/eventcatalog/src/features/studio/components/canvas-nodes.tsx +0 -255
  455. package/eventcatalog/src/features/studio/components/icons.ts +0 -53
  456. package/eventcatalog/src/features/studio/components/status.ts +0 -51
  457. package/eventcatalog/src/features/studio/edges.ts +0 -56
  458. package/eventcatalog/src/features/studio/flow-state.ts +0 -92
  459. package/eventcatalog/src/features/studio/grouping.ts +0 -226
  460. package/eventcatalog/src/features/studio/layout.ts +0 -42
  461. package/eventcatalog/src/features/studio/levels.ts +0 -282
  462. package/eventcatalog/src/features/studio/node-types.ts +0 -205
  463. package/eventcatalog/src/features/studio/pages/new.astro +0 -24
  464. package/eventcatalog/src/features/studio/pages/wake.ts +0 -15
  465. package/eventcatalog/src/features/studio/placement.ts +0 -197
  466. package/eventcatalog/src/features/studio/studio.css +0 -273
  467. package/dist/{chunk-A2RZR3U4.js → chunk-6K7XZAYI.js} +3 -3
@@ -8,13 +8,10 @@ description: Installation of the EventCatalog Azure Schema Registry plugin
8
8
  ---
9
9
 
10
10
  import AddedIn from '@site/src/components/MDX/AddedIn';
11
- import PluginLicense from '@site/src/components/MDX/PluginLicense';
12
11
  import Beta from '@site/src/components/MDX/Beta';
13
12
  import Tabs from '@theme/Tabs';
14
13
  import TabItem from '@theme/TabItem';
15
14
 
16
- <PluginLicense url="#commercial-use" />
17
-
18
15
  Run the command below to install the EventCatalog Azure Schema Registry plugin.
19
16
 
20
17
  :::tip "Don't have an EventCatalog project yet?"
@@ -25,12 +22,6 @@ If you don't have an EventCatalog project yet, you can follow the instructions i
25
22
  npm i @eventcatalog/generator-azure-schema-registry
26
23
  ```
27
24
 
28
- :::info License Key
29
- The EventCatalog Azure Schema Registry plugin requires an EventCatalog Scale license key to work with EventCatalog.
30
-
31
- You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
32
- :::
33
-
34
25
  ## Configuration
35
26
 
36
27
  To use the plugin you need to configure it in your `eventcatalog.config.js` file.
@@ -199,12 +190,11 @@ generators: [
199
190
 
200
191
  The EventCatalog Azure Schema Registry plugin uses Azure's REST API with Bearer token authentication. You need to set the `AZURE_SCHEMA_REGISTRY_TOKEN` environment variable with your Azure access token.
201
192
 
202
- ### Configure Azure Schema Registry License Key
193
+ ### Licensing
203
194
 
204
- The EventCatalog Azure Schema Registry plugin requires an EventCatalog Scale license key to work with EventCatalog.
205
-
206
- You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
195
+ The EventCatalog Azure Schema Registry plugin is open source under the MIT License and doesn't need a license key.
207
196
 
197
+ If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
208
198
 
209
199
  ---
210
200
 
@@ -285,23 +275,10 @@ az account get-access-token --resource https://eventhubs.azure.net --query acces
285
275
  Create or update your `.env` file in your EventCatalog project root:
286
276
 
287
277
  ```bash title=".env"
288
- # EventCatalog license key
289
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
290
-
291
278
  # Azure Schema Registry access token (paste the token from step 1)
292
279
  AZURE_SCHEMA_REGISTRY_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGciOi...
293
280
  ```
294
281
 
295
- :::tip Using an Older API Key?
296
-
297
- If you already have an older Azure Schema Registry plugin key, you can still use it with the plugin-specific environment variable.
298
-
299
- ```bash title=".env"
300
- EVENTCATALOG_LICENSE_KEY_AZURE_SCHEMA_REGISTRY=your-license-key
301
- ```
302
-
303
- :::
304
-
305
282
  **Step 3: Run the Generator**
306
283
 
307
284
  ```bash
@@ -384,11 +361,7 @@ az role assignment create \
384
361
  --scope /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace-name}
385
362
  ```
386
363
 
387
- ## White listing EventCatalog Domains
388
-
389
- If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
390
-
391
- ### Run the plugin
364
+ ## Run the plugin
392
365
 
393
366
  Run the plugin to import your schemas into EventCatalog.
394
367
 
@@ -398,7 +371,7 @@ _This command will run the generators in your eventcatalog.config.js file._
398
371
  npm run generate
399
372
  ```
400
373
 
401
- ### View your catalog
374
+ ## View your catalog
402
375
 
403
376
  Run your catalog locally to see the changes
404
377
 
@@ -406,7 +379,7 @@ Run your catalog locally to see the changes
406
379
  npm run dev
407
380
  ```
408
381
 
409
- ### Build your catalog for production
382
+ ## Build your catalog for production
410
383
 
411
384
  ```bash
412
385
  npm run build
@@ -20,9 +20,6 @@ The plugin uses Azure's REST API with Bearer token authentication. You must set
20
20
  <summary>Example .env file</summary>
21
21
 
22
22
  ```bash
23
- # EventCatalog license key
24
- export EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
25
-
26
23
  # Azure Schema Registry access token
27
24
  export AZURE_SCHEMA_REGISTRY_TOKEN=your-azure-access-token
28
25
  ```
@@ -85,9 +82,7 @@ You can define and assign domains to organize your services.
85
82
 
86
83
  ### License
87
84
 
88
- | Option | Type | Default | Description |
89
- |--------|------|---------|-------------|
90
- | `licenseKey` | `string` | From env var | EventCatalog Scale license key. Can also be set via the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable. |
85
+ This plugin is open source under the MIT License and doesn't need a license key. If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
91
86
 
92
87
  ## Example Configurations
93
88
 
@@ -360,14 +355,6 @@ If the plugin can't find a schema:
360
355
  2. Check that your authenticated user/identity has read permissions on the schema registry
361
356
  3. Ensure the schema exists in the specified schema group
362
357
 
363
- ### License Key Issues
364
-
365
- If you have problems with your license key:
366
-
367
- 1. Ensure `https://api.eventcatalog.cloud` is not blocked by your firewall
368
- 2. Verify your license key is correctly set in the `.env` file or passed via configuration
369
- 3. Check your license hasn't expired at [EventCatalog Cloud](https://eventcatalog.cloud)
370
-
371
358
  ## Need Help?
372
359
 
373
360
  - [GitHub Issues](https://github.com/event-catalog/eventcatalog/issues)
@@ -106,7 +106,6 @@ Each example includes:
106
106
  - Azure CLI installed ([Install guide](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli))
107
107
  - Azure account with Event Hubs namespace
108
108
  - Azure Schema Registry with sample schemas
109
- - EventCatalog license key ([30-day trial available](https://eventcatalog.cloud))
110
109
  - Appropriate Azure permissions (`Azure Event Hubs Data Receiver` role)
111
110
 
112
111
  ### Quick Start
@@ -123,7 +122,6 @@ npm install
123
122
 
124
123
  # Copy and configure environment variables
125
124
  cp .env.example .env
126
- # Edit .env with your EventCatalog license key
127
125
 
128
126
  # Authenticate with Azure
129
127
  az login
@@ -9,10 +9,6 @@ keywords:
9
9
  - integration
10
10
  ---
11
11
 
12
- import PluginLicense from '@site/src/components/MDX/PluginLicense';
13
-
14
- <PluginLicense url="#licensing" />
15
-
16
12
  The EventCatalog Backstage plugin embeds EventCatalog views in Backstage entity pages. Developers can explore architecture documentation without leaving the software catalog they use for ownership, APIs, dependencies, and operations.
17
13
 
18
14
  ![EventCatalog embedded in a Backstage entity page](/img/integrations/backstage/backstage-eventcatalog.png)
@@ -48,6 +44,4 @@ Read [How EventCatalog embeds work](/docs/plugins/backstage/how-embeds-work) for
48
44
 
49
45
  ## Licensing
50
46
 
51
- The plugin requires an EventCatalog Scale license for commercial use. You can start a 30-day trial in [EventCatalog Cloud](https://eventcatalog.cloud) and follow [Getting a license key for integrations](/docs/development/license-keys/integrations).
52
-
53
- For license terms, see the [plugin repository](https://github.com/event-catalog/backstage-plugin-eventcatalog).
47
+ The Backstage plugin is open source under the MIT License and doesn't need a license key. If you previously set a license key for the plugin, you can remove it because it's ignored.
@@ -15,19 +15,10 @@ You will need:
15
15
 
16
16
  - a Backstage app with a software catalog entity page
17
17
  - an EventCatalog instance that the user's browser can reach
18
- - an EventCatalog Scale license for commercial use
19
18
 
20
- ## 1. Enable the integration in EventCatalog
19
+ The plugin is open source under the MIT License and doesn't need a license key.
21
20
 
22
- Add your Scale license key to the `.env` file in the EventCatalog project:
23
-
24
- ```bash title=".env"
25
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
26
- ```
27
-
28
- Build and deploy EventCatalog with this environment variable. For license setup and legacy keys, see [Getting a license key for integrations](/docs/development/license-keys/integrations).
29
-
30
- ## 2. Install the Backstage plugin
21
+ ## 1. Install the Backstage plugin
31
22
 
32
23
  From the root of your Backstage app, install the frontend plugin:
33
24
 
@@ -35,7 +26,7 @@ From the root of your Backstage app, install the frontend plugin:
35
26
  yarn add @eventcatalog/backstage-plugin-eventcatalog
36
27
  ```
37
28
 
38
- ## 3. Configure the EventCatalog URL
29
+ ## 2. Configure the EventCatalog URL
39
30
 
40
31
  Add the public base URL of your EventCatalog instance to `app-config.yaml`:
41
32
 
@@ -46,7 +37,7 @@ eventcatalog:
46
37
 
47
38
  Do not add a trailing view path such as `/docs` or `/visualiser`. The plugin builds each embed URL from this base URL.
48
39
 
49
- ## 4. Map a Backstage entity
40
+ ## 3. Map a Backstage entity
50
41
 
51
42
  Add EventCatalog annotations to a Backstage catalog entity. This example maps a Backstage component to version `1.0.0` of the `order-service` service in EventCatalog:
52
43
 
@@ -68,7 +59,7 @@ spec:
68
59
 
69
60
  The annotation values must match the resource ID, version, and collection in EventCatalog.
70
61
 
71
- ## 5. Add an EventCatalog tab
62
+ ## 4. Add an EventCatalog tab
72
63
 
73
64
  Open the file that defines your catalog entity page, commonly `packages/app/src/components/catalog/EntityPage.tsx`.
74
65
 
@@ -86,7 +77,7 @@ Add a route inside the `EntityLayout` used for your service entities:
86
77
  </EntityLayout.Route>
87
78
  ```
88
79
 
89
- ## 6. Check the result
80
+ ## 5. Check the result
90
81
 
91
82
  Start Backstage and open the mapped service. Select **EventCatalog: Docs**.
92
83
 
@@ -74,12 +74,6 @@ Component props override annotations. For example, this always displays the `ord
74
74
 
75
75
  `type` is an alias for `collection` and accepts singular or plural values. Known singular resource types are converted to their plural collection, so `type="service"` resolves to `services`.
76
76
 
77
- ## EventCatalog license configuration
77
+ ## License
78
78
 
79
- For commercial use, set the Scale license key in the EventCatalog deployment rather than the Backstage app:
80
-
81
- ```bash title=".env"
82
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
83
- ```
84
-
85
- Existing Backstage-specific keys can continue to use `EVENTCATALOG_LICENSE_KEY_BACKSTAGE`, but new deployments should use `EVENTCATALOG_SCALE_LICENSE_KEY`. See [Getting a license key for integrations](/docs/development/license-keys/integrations).
79
+ The Backstage plugin is open source under the MIT License and doesn't need a license key. Any license key setting you used for the plugin before, such as `EVENTCATALOG_LICENSE_KEY_BACKSTAGE`, is ignored and can be removed.
@@ -7,11 +7,6 @@ title: Introduction
7
7
  description: Getting started with AsyncAPI plugin
8
8
  ---
9
9
 
10
-
11
- <!-- import PluginLicense from '@site/src/components/MDX/PluginLicense'; -->
12
-
13
- <!-- <PluginLicense url="#commercial-use" /> -->
14
-
15
10
  <iframe width="100%" height="515" src="https://www.youtube.com/embed/NMZKnPKx-L0?si=og1Nvnr3FfPfAqn4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
16
11
 
17
12
  ---
@@ -59,32 +54,10 @@ EventCatalog supports [generators](/docs/plugins/generators). These are scripts
59
54
 
60
55
  The EventCatalog Confluent Schema Registry plugin is a generator. It will import your schemas from your Confluent Schema Registry into EventCatalog.
61
56
 
62
- ## Commercial and License
63
-
64
- This plugin requires an EventCatalog Scale license key to be used.
65
-
66
- You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
67
-
68
- After the trial, you can continue using this plugin with EventCatalog Scale.
57
+ ### License
69
58
 
70
- See [pricing](/pricing) for more information.
71
-
72
- _Have any questions? You can email us at `hello@eventcatalog.dev`._
59
+ This plugin is open source under the MIT License and doesn't need a license key.
73
60
 
74
61
  ## Need a demo?
75
62
 
76
63
  If you would like a demo of the plugin, please feel free to reach out to us and book a time to chat at hello@eventcatalog.dev.
77
-
78
- ## License FAQ
79
-
80
- ### What is the license key for?
81
- The EventCatalog Scale license key is required to use the Confluent Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
82
-
83
- ### How do I get an EventCatalog Scale license key?
84
- You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
85
-
86
- ### Terms
87
- - **Trial Period**: 30-day free trial no credit card required
88
- - **Support**: Discord community support (extra for priority support)
89
-
90
- After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
@@ -8,13 +8,10 @@ description: Installation of the EventCatalog Confluent Schema Registry plugin
8
8
  ---
9
9
 
10
10
  import AddedIn from '@site/src/components/MDX/AddedIn';
11
- import PluginLicense from '@site/src/components/MDX/PluginLicense';
12
11
  import Beta from '@site/src/components/MDX/Beta';
13
12
  import Tabs from '@theme/Tabs';
14
13
  import TabItem from '@theme/TabItem';
15
14
 
16
- <PluginLicense url="#commercial-use" />
17
-
18
15
  The Confluent Schema Registry plugin is used to generate a catalog from a Confluent Schema Registry and import your schemas into EventCatalog.
19
16
 
20
17
  You can map your schemas from your Confluent Schema Registry to commands, events in your catalog, and assign these to services and domains.
@@ -53,7 +50,6 @@ Add the plugin to the `generators` array.
53
50
 
54
51
  You can also create topics, and assign schemas to producers/consumers and domains. [(see examples)](/docs/plugins/confluent-schema-registry/plugin-configuration#example-configurations).
55
52
 
56
-
57
53
 
58
54
  ```js title="eventcatalog.config.js"
59
55
  // ...
@@ -167,36 +163,18 @@ In this example we configure the plugin twice, the first time we import and crea
167
163
 
168
164
  ### Configure API keys
169
165
 
170
- The EventCatalog Confluent Schema Registry plugin requires API keys in your environment variables.
166
+ The EventCatalog Confluent Schema Registry plugin is open source under the MIT License and doesn't need a license key. If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
171
167
 
172
- 1. An EventCatalog Scale license key for the Confluent Schema Registry plugin (30-day trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
173
- 2. Confluent Schema Registry API keys (found in the [Confluent Cloud](https://confluent.cloud) console)
168
+ The plugin needs your Confluent Schema Registry API keys (found in the [Confluent Cloud](https://confluent.cloud) console) in your environment variables.
174
169
 
175
170
  Create a `.env` file in the root, and add your keys to the project.
176
171
 
177
172
  ```bash title=".env"
178
- # EventCatalog license key
179
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
180
-
181
173
  # Confluent Schema Registry API Keys
182
174
  CONFLUENT_SCHEMA_REGISTRY_KEY=your-confluent-schema-registry-key
183
175
  CONFLUENT_SCHEMA_REGISTRY_SECRET=your-confluent-schema-registry-key-secret
184
176
  ```
185
177
 
186
- :::tip Using an Older API Key?
187
-
188
- If you already have an older Confluent Schema Registry plugin key, you can still use it with the plugin-specific environment variable.
189
-
190
- ```bash title=".env"
191
- EVENTCATALOG_LICENSE_KEY_CONFLUENT_SCHEMA_REGISTRY=your-license-key
192
- ```
193
-
194
- :::
195
-
196
- #### White listing EventCatalog domains
197
-
198
- If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
199
-
200
178
  #### Run the plugin
201
179
 
202
180
  Run the plugin to import your schemas into EventCatalog.
@@ -221,8 +199,6 @@ npm run dev
221
199
  npm run build
222
200
  ```
223
201
 
224
-
225
-
226
202
  ## Any questions or need help?
227
203
 
228
204
  If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).
@@ -8,10 +8,8 @@ description: Getting started with Amazon EventBridge plugin
8
8
  ---
9
9
 
10
10
  import AddedIn from '@site/src/components/MDX/AddedIn';
11
- import PluginLicense from '@site/src/components/MDX/PluginLicense';
12
11
 
13
12
  <AddedIn version="2.6.0"/>
14
- <PluginLicense url="#commercial-use" />
15
13
 
16
14
  <iframe width="100%" height="415" src="https://www.youtube.com/embed/MeBuwAflwM4?si=rhio4gjfDPau4eqB" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
17
15
 
@@ -29,7 +27,6 @@ Although EventBridge offers managed schema solutions, [there is a still an issue
29
27
 
30
28
  Using the EventCatalog EventBridge generator you can automate and generate your EventCatalog. Enable your teams to quickly find events from EventBridge, what services they belong too and how to start consuming them.
31
29
 
32
-
33
30
  ### Core Features
34
31
 
35
32
  The EventCatalog Amazon EventBridge plugin can provide you with many features:
@@ -52,4 +49,3 @@ EventCatalog supports [generators](/docs/plugins/generators). These are scripts
52
49
  The EventCatalog EventBridge plugin let's you map your events into domains and services. You can use [custom filters (prefix, suffix, detailType and source)](/docs/plugins/eventbridge/features#using-filters-to-map-events-to-your-services) to map which events you want your service to produce and consume.
53
50
 
54
51
  You can also use the EventCatalog plugin to map ALL events from your registry into your system and not map them into services if you wish to have a direct import.
55
-
@@ -9,7 +9,6 @@ id: installation
9
9
  ---
10
10
 
11
11
  import AddedIn from '@site/src/components/MDX/AddedIn';
12
- import PluginLicense from '@site/src/components/MDX/PluginLicense';
13
12
  import Tabs from '@theme/Tabs';
14
13
  import TabItem from '@theme/TabItem';
15
14
 
@@ -40,7 +39,6 @@ npx @eventcatalog/create-eventcatalog@latest my-catalog --template eventbridge
40
39
  </TabItem>
41
40
  </Tabs>
42
41
 
43
-
44
42
  #### Configuration
45
43
 
46
44
  Configure the plugin in your `eventcatalog.config.js` file.
@@ -109,7 +107,6 @@ generators: [
109
107
  // "myapp.orders" will be assigned to the inventory service. The inventory service will publish these events.
110
108
  { id: 'Inventory Service', version: '1.0.0', sends: [{ source: "myapp.orders", eventBusName: 'orders'}], receives:[{ detailType: "UserCheckedOut", eventBusName: 'inventory'}] },
111
109
 
112
-
113
110
  // This service sends events that match the SchemaName prefixing myapp, and will receive events that end with Payment
114
111
  // this also does not map any event buses to your events
115
112
  { id: 'Payment Service', version: '1.0.0', sends: [{ prefix: "myapp"}], receives:[{ suffix: "Payment" }] }
@@ -182,63 +179,7 @@ generators: [
182
179
  </TabItem>
183
180
  </Tabs>
184
181
 
185
-
186
-
187
- ### Configure license key
188
-
189
- The EventBridge plugin requires an EventCatalog Scale license key to work with EventCatalog.
190
-
191
- You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
192
-
193
- You have a few options for setting the license key:
194
-
195
- 1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
196
- 2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
197
-
198
- #### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
199
-
200
- <AddedIn version="2.35.4" />
201
-
202
- Create a `.env` file in the root of your project and add the following:
203
-
204
- ```bash title=".env"
205
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
206
- ```
207
-
208
- :::tip Using an Older API Key?
209
-
210
- If you already have an older EventBridge plugin key, you can still use it with the EventBridge-specific environment variable.
211
-
212
- ```bash title=".env"
213
- EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE=your-license-key
214
- ```
215
-
216
- :::
217
-
218
-
219
- #### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
220
-
221
- If you prefer, you can set the license key in the `eventcatalog.config.js` file
222
- using the `licenseKey` property in the EventCatalog EventBridge plugin.
223
-
224
- ```js title="eventcatalog.config.js"
225
- export default {
226
- generators: [
227
- [
228
- '@eventcatalog/generator-eventbridge',
229
- {
230
- licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
231
- region: 'us-east-1',
232
- registryName: 'discovered-schemas'
233
- },
234
- ],
235
- ],
236
- };
237
- ```
238
-
239
- #### White listing EventCatalog domains
240
-
241
- If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
182
+ This plugin is open source under the MIT License and doesn't need a license key. If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
242
183
 
243
184
  #### Run the plugin
244
185
 
@@ -285,33 +226,6 @@ It's recommended you create a new IAM user with the following policy.
285
226
  }
286
227
  ```
287
228
 
288
-
289
- ## Commercial and License
290
-
291
- This plugin requires an EventCatalog Scale license key to be used.
292
-
293
- You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
294
-
295
- After the trial, you can continue using this plugin with EventCatalog Scale.
296
-
297
- See [pricing](/pricing) for more information.
298
-
299
- _Have any questions? You can email us at `hello@eventcatalog.dev`._
300
-
301
- ## License FAQ
302
-
303
- ### What is the license key for?
304
- The EventCatalog Scale license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
305
-
306
- ### How do I get an EventCatalog Scale license key?
307
- You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
308
-
309
- ### Terms
310
- - **Trial Period**: 30-day free trial no credit card required
311
- - **Support**: Discord community support (extra for priority support)
312
-
313
- After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
314
-
315
229
  ## Issues
316
230
 
317
231
  If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators
@@ -138,28 +138,10 @@ The EventBridge registry name for your schemas.
138
138
  ],
139
139
  ```
140
140
 
141
- ### `licenseKey` {#licenseKey}
141
+ :::info No license key needed
142
142
 
143
- - Type: `String`
144
-
145
- The license key for the EventBridge generator. You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
143
+ The generator is open source under the MIT License and doesn't need a license key. If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
146
144
 
147
- ```js title="eventcatalog.config.js"
148
- [
149
- '@eventcatalog/generator-eventbridge',
150
- {
151
- licenseKey: 'YOUR_LICENSE_KEY'
152
- },
153
- ],
154
- ```
155
-
156
- :::info Using environment variables
157
-
158
- You can also set the license key as an environment variable. If this is set on the machine the `licenseKey` is not required in the generator configuration.
159
-
160
- ```bash
161
- EVENTCATALOG_SCALE_LICENSE_KEY=YOUR_SCALE_LICENSE_KEY
162
- ```
163
145
  :::
164
146
 
165
147
  ## Optional fields {#optional-fields}
@@ -7,11 +7,6 @@ title: Introduction
7
7
  description: Getting started with GitHub plugin
8
8
  ---
9
9
 
10
-
11
- <!-- import PluginLicense from '@site/src/components/MDX/PluginLicense'; -->
12
-
13
- <!-- <PluginLicense url="#commercial-use" /> -->
14
-
15
10
  <!-- <iframe width="100%" height="515" src="https://www.youtube.com/embed/NMZKnPKx-L0?si=og1Nvnr3FfPfAqn4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> -->
16
11
 
17
12
  <iframe width="100%" height="515" src="https://www.youtube.com/embed/o2ryPdBa-68?si=2d1cynW_wgzNhbaV" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
@@ -62,32 +57,6 @@ Any documentation you add to your schemas in EventCatalog will persist between b
62
57
 
63
58
  :::
64
59
 
65
- ## Commercial and License
66
-
67
- This plugin requires an EventCatalog Scale license key to be used.
68
-
69
- You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
70
-
71
- After the trial, you can continue using this plugin with EventCatalog Scale.
72
-
73
- See [pricing](/pricing) for more information.
74
-
75
- _Have any questions? You can email us at `hello@eventcatalog.dev`._
76
-
77
60
  ## Need a demo?
78
61
 
79
62
  If you would like a demo of the plugin, please feel free to reach out to us and book a time to chat at hello@eventcatalog.dev.
80
-
81
- ## License FAQ
82
-
83
- ### What is the license key for?
84
- The EventCatalog Scale license key is required to use the GitHub plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
85
-
86
- ### How do I get an EventCatalog Scale license key?
87
- You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
88
-
89
- ### Terms
90
- - **Trial Period**: 30-day free trial no credit card required
91
- - **Support**: Discord community support (extra for priority support)
92
-
93
- After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
@@ -8,13 +8,10 @@ description: Installation of the EventCatalog GitHub plugin
8
8
  ---
9
9
 
10
10
  import AddedIn from '@site/src/components/MDX/AddedIn';
11
- import PluginLicense from '@site/src/components/MDX/PluginLicense';
12
11
  import Beta from '@site/src/components/MDX/Beta';
13
12
  import Tabs from '@theme/Tabs';
14
13
  import TabItem from '@theme/TabItem';
15
14
 
16
- <PluginLicense url="#commercial-use" />
17
-
18
15
  The GitHub plugin is used to pull and sync your schemas from your GitHub repository to EventCatalog, these can be public or private repositories.
19
16
 
20
17
  You can map your schemas from your GitHub repository to commands, events and queries in your catalog, and assign these to services (producers and consumers) and domains.
@@ -122,7 +119,6 @@ In this example we:
122
119
  - Create a domain `Retail Domain`
123
120
  - Assign the services to the domain
124
121
 
125
-
126
122
  ```js title="eventcatalog.config.js"
127
123
  // ...
128
124
  [
@@ -194,32 +190,9 @@ In this example we:
194
190
  </TabItem>
195
191
  </Tabs>
196
192
 
197
- ### Configure API keys
198
-
199
- The EventCatalog GitHub plugin requires API keys in your environment variables.
200
-
201
- 1. An EventCatalog Scale license key for the GitHub plugin (30-day trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
202
-
203
- Create a `.env` file in the root, and add your keys to the project.
193
+ ### License
204
194
 
205
- ```bash title=".env"
206
- # EventCatalog license key
207
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
208
- ```
209
-
210
- :::tip Using an Older API Key?
211
-
212
- If you already have an older GitHub plugin key, you can still use it with the plugin-specific environment variable.
213
-
214
- ```bash title=".env"
215
- EVENTCATALOG_LICENSE_KEY_GITHUB=your-license-key
216
- ```
217
-
218
- :::
219
-
220
- #### White listing EventCatalog domains
221
-
222
- If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
195
+ This plugin is open source under the MIT License and doesn't need a license key. If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
223
196
 
224
197
  ### Private repository authentication
225
198
 
@@ -234,9 +207,6 @@ You can authenticate in two ways:
234
207
  Set the `EVENTCATALOG_GITHUB_TOKEN` environment variable in your `.env` file.
235
208
 
236
209
  ```bash title=".env"
237
- # EventCatalog license key
238
- EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
239
-
240
210
  # GitHub token for private repository access
241
211
  EVENTCATALOG_GITHUB_TOKEN=ghp_your_token_here
242
212
  ```
@@ -291,8 +261,6 @@ npm run dev
291
261
  npm run build
292
262
  ```
293
263
 
294
-
295
-
296
264
  ## Any questions or need help?
297
265
 
298
266
  If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).