@eventcatalog/core 4.10.12 → 4.10.14

package/dist/docs/plugins/backstage/08-how-embeds-work.md

@@ -0,0 +1,52 @@
+---
+sidebar_position: 9
+sidebar_label: How embeds work
+title: How EventCatalog embeds work in Backstage
+description: Understand resource mapping, iframe rendering, embed mode, themes, and sizing.
+keywords:
+  - backstage
+  - iframe
+  - architecture
+---
+
+The Backstage plugin is a frontend integration. EventCatalog remains the source of the documentation and visualizations; the plugin selects a view and embeds it inside a Backstage entity page.
+
+## Resource mapping
+
+Backstage and EventCatalog use different resource models. The plugin connects them with three annotations:
+
+- `eventcatalog.dev/id` identifies the EventCatalog resource.
+- `eventcatalog.dev/version` selects its version.
+- `eventcatalog.dev/collection` identifies the resource collection, such as `services`, `domains`, or `events`.
+
+Keeping this mapping on the Backstage entity makes the relationship portable with the entity definition. Props can override the annotations when a tab or card deliberately shows a different resource.
+
+## URL construction and embed mode
+
+The plugin combines the configured `eventcatalog.URL`, the selected component, and the resolved resource mapping. It adds `embed=true` to the EventCatalog URL.
+
+Embed mode removes EventCatalog navigation that would duplicate or cover Backstage navigation. Interactive content such as graph controls, filters, schema tabs, and flow exploration remains available inside the iframe.
+
+Specialized views use their native EventCatalog routes:
+
+- Architecture Graph: `/visualiser/graph`, with `focus` and `depth` query parameters
+- System Context Map overview: `/visualiser/system-context-map`
+- one system's context: `/visualiser/systems/{id}/{version}/context`
+- flow: `/visualiser/flows/{id}/{version}`
+- schema explorer: `/schemas/explorer`
+
+## Theme selection
+
+Passing `theme="light"` or `theme="dark"` adds a theme request to the embed URL. EventCatalog applies it before the embedded page paints, avoiding a flash of the wrong theme. The override is local to the embed and does not replace the visitor's saved EventCatalog preference.
+
+Without an explicit prop, the embedded page follows that saved preference. The Backstage theme is not automatically mirrored because the two applications have separate theme state.
+
+## Height and layout
+
+The plugin's wrapper and iframe both use the full width and height available from their parent. This makes the same component suitable for a full route or a grid card, but the parent still determines how much space exists.
+
+`height: 100%` only resolves when the ancestor layout has a defined height. Entity tabs typically provide that layout. Overview grid items should set an explicit height so graphs, tables, and schema panels can use the complete card area.
+
+## Browser access
+
+The iframe loads EventCatalog directly in the user's browser. The configured EventCatalog URL must therefore be reachable by users of Backstage and permit embedding in your deployment environment. Backstage does not copy EventCatalog content into its own backend.

package/dist/docs/plugins/backstage/_category_.json

@@ -1,11 +1,12 @@
 {
   "label": "Backstage Plugin",
+  "position": 8,
   "collapsible": true,
   "collapsed": true,
   "link": {
     "type": "generated-index",
     "slug": "backstage",
-    "title": "Backstage",
-    "description": "Backstage integration with EventCatalog"
+    "title": "EventCatalog for Backstage",
+    "description": "Embed EventCatalog documentation, diagrams, schemas, and flows in Backstage."
   }
-}
+}

package/dist/docs/plugins/eventbridge/00-intro.md

@@ -35,10 +35,10 @@ Using the EventCatalog EventBridge generator you can automate and generate your
 The EventCatalog Amazon EventBridge plugin can provide you with many features:
 
 - ⭐️ Generate domains, services, channels and messages into your catalog
-- ⭐️ [Automatically version your changes in EventCatalog in sync with your registry versions](#automatic-versioning)
-- ⭐️ [Allow you to write and persist custom markdown between changes](#persist-markdown)
-- ⭐️ [Display your JSONDraft and OpenAPI schemas for each event in EventCatalog](#downloading-schemas)
-- ⭐️ [Filter events to match to your services](#using-filters-to-map-events-to-your-services)
+- ⭐️ [Automatically version your changes in EventCatalog in sync with your registry versions](/docs/plugins/eventbridge/features#automatic-versioning)
+- ⭐️ [Allow you to write and persist custom markdown between changes](/docs/plugins/eventbridge/features#persist-markdown)
+- ⭐️ [Display your JSONDraft and OpenAPI schemas for each event in EventCatalog](/docs/plugins/eventbridge/features#downloading-schemas)
+- ⭐️ [Filter events to match to your services](/docs/plugins/eventbridge/features#using-filters-to-map-events-to-your-services)
 - ⭐️ Visualize your architecture
 - ⭐️ Download schemas and code bindings
 - ⭐️ and more....
@@ -49,7 +49,7 @@ The EventCatalog Amazon EventBridge plugin can provide you with many features:
 
 EventCatalog supports [generators](/docs/plugins/generators). These are scripts or plugins that can be run to integrate with any external API, system or specification files. EventCatalog also provides an [SDK](/docs/sdk) to give developers easier access to their catalogs through custom scripts or generators.
 
-The EventCatalog EventBridge plugin let's you map your events into domains and services. You can use [custom filters (prefix, suffix, detailType and source)](#using-filters-to-map-events-to-your-services) to map which events you want your service to produce and consume.
+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.
 
 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.
 

package/dist/docs/plugins/eventbridge/03-api.md

@@ -198,9 +198,9 @@ List of services to add and what events they publish (sends) and consume (receiv
 | ------------- | -------- | ----------------------------------------------------------------------------- |
 | id            | required | Id of the service, this will also be used as the folder name of your service. |
 | version            | required | The version of the service |
-| sends            | optional | The events the service sends (publishes). You can use [EventCatalog filters](/docs/plugins/eventbridge/intro#using-filters-to-map-events-to-your-services) to match your events. |
+| sends            | optional | The events the service sends (publishes). You can use [EventCatalog filters](/docs/plugins/eventbridge/features#using-filters-to-map-events-to-your-services) to match your events. |
 | sends.eventBusName            | optional | The name of the EventBus for the matched events. This will be displayed as an EventCatalog Channel. |
-| receives            | optional | The events the service receives (consumes). You can use [EventCatalog filters](/docs/plugins/eventbridge/intro#using-filters-to-map-events-to-your-services) to match your events. |
+| receives            | optional | The events the service receives (consumes). You can use [EventCatalog filters](/docs/plugins/eventbridge/features#using-filters-to-map-events-to-your-services) to match your events. |
 | receives.eventBusName            | optional | The name of the EventBus for the matched events. This will be displayed as an EventCatalog Channel. |
 | writesTo            | optional | Array of [data stores](/docs/development/guides/resources/data/introduction) ids that the service writes to. (Added in v3.2.2) |
 | readsFrom            | optional | Array of [data stores](/docs/development/guides/resources/data/introduction) ids that the service reads from. (Added in v3.2.2) |
@@ -333,7 +333,7 @@ AWS credentials to use for your plugin.
 ];
 ```
 
-If you are using credentials you will want to create a user with limited permissions. [See the documentation to get started](/docs/plugins/eventbridge/intro#aws-configuration).
+If you are using credentials you will want to create a user with limited permissions. [See the documentation to get started](/docs/plugins/eventbridge/api#credentials).
 
 ### `domain` {#domain}
 

package/dist/docs/plugins/graphql/00-intro.md

@@ -29,8 +29,8 @@ The EventCatalog GraphQL plugin can provide you with many features:
 - ⭐️ [Map queries, mutations and subscriptions from your GraphQL schema](/docs/plugins/graphql/features#mapping-operations-as-queries-mutations-or-subscriptions)
 - ⭐️ [Assign owners (your teams) to your services and messages all generated by your GraphQL schemas](/docs/plugins/graphql/features#assign-owners-to-your-domains-services-and-messages)
 - ⭐️ [Add semantic meaning to your GraphQL schemas, persist this meaning between versions](/docs/plugins/graphql/features#persist-markdown)
-- ⭐️ [Automatically version your changes in EventCatalog in sync with your GraphQL schema versions](#automatic-versioning)
-- ⭐️ [Display your GraphQL schemas and operations in the catalog](#displaying-schemas)
+- ⭐️ [Automatically version your changes in EventCatalog in sync with your GraphQL schema versions](/docs/plugins/graphql/features#automatic-versioning)
+- ⭐️ [Display your GraphQL schemas and operations in the catalog](/docs/plugins/graphql/features#displaying-schemas)
 - ⭐️ Ability to download your schemas and GraphQL files (also versioned)
 - ⭐️ Ability to draft services and operations in EventCatalog from your GraphQL schemas
 - ⭐️ and more....

package/dist/docs/plugins/graphql/02-plugin-configuration.md

@@ -35,7 +35,7 @@ Each service in the `services` array requires the following properties:
 | `owners` | string[] | No | Owners of the service. You can assign EventCatalog users or teams to services. Setting owners on the service will also set the owners of the messages in the GraphQL schema. If owners are already set on any resource, those owners are persisted. |
 | `name` | string | No | Display name for the service. If not provided, the `id` will be used. |
 | `summary` | string | No | Short summary of the service. |
-| `generateMarkdown` | function | - | Function to override the default markdown generation for the service. See [Markdown templates](#markdown-templates) for more information. |
+| `generateMarkdown` | function | - | Function to override the default markdown generation for the service. |
 | `writesTo` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service writes to. (Added in v0.4.4) |
 | `readsFrom` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service reads from. (Added in v0.4.0) |
 
@@ -49,7 +49,7 @@ Each service in the `services` array requires the following properties:
 | `domain.version` | string | - | Domain version |
 | `domain.owners` | string[] | - | Owners of the domain. If owners are already set on the domain, those owners are persisted. |
 | `domain.markdown` | string | - | Custom markdown content for the domain. |
-| `messages.generateMarkdown` | function | - | Function to override the default markdown generation for the message. See [Markdown templates](#markdown-templates) for more information. |
+| `messages.generateMarkdown` | function | - | Function to override the default markdown generation for the message. |
 | `writeFilesToRoot` | boolean | `false` | Write GraphQL messages to root instead of service folder. By default all domains, services and messages will be grouped in the folder directory structure. |
 
 ## Example Configuration

package/dist/docs/plugins/hookdeck/01-intro.md

@@ -18,7 +18,7 @@ Using the EventCatalog Hookdeck plugin you can extract information from Hookdeck
 The Hookdeck plugin can provide you with the following features:
 
 - ⭐️ [Generate EventCatalog Services](#generate-services) from Hookdeck Sources and Destinations
-- ⭐️ [Auto-generate EventCatalog Messages](#generate-messages) from Hookdeck Requests and Events
+- ⭐️ [Auto-generate EventCatalog Messages](#generate-message) from Hookdeck Requests and Events
 - ⭐️ [Auto-generate EventCatalog Message Schemas](#generate-schemas) from Hookdeck Requests and Events
 - ⭐️ [Provide insight into Hookdeck Filters](#filtered-messages) by indicating Requests that are received by an EventCatalog Service but are not connected to destination Service.
 

package/dist/docs/plugins/openapi/00-intro.md

@@ -34,7 +34,7 @@ The EventCatalog OpenAPI plugin can provide you with many features:
 - ⭐️ [Automate your EventCatalog and fetch OpenAPI files by URL](/docs/plugins/openapi/features#fetch-openapi-files-by-url)
 - ⭐️ [Map commands, queries and events from your OpenAPI file using custom extensions](/docs/plugins/openapi/features#mapping-messages-as-commands-queries-or-events)
 - ⭐️ [Add semantic meaning to your OpenAPI files, persist this meaning between versions](/docs/plugins/openapi/features#persist-markdown)
-- ⭐️ [Automatically version your changes in EventCatalog in sync with your OpenAPI versions](#automatic-versioning)
+- ⭐️ [Automatically version your changes in EventCatalog in sync with your OpenAPI versions](/docs/plugins/openapi/features#automatic-versioning)
 - ⭐️ [Render and display your OpenAPI specification in EventCatalog](/docs/plugins/openapi/intro)
 - ⭐️ Display your endpoints and parameters in the catalog
 - ⭐️ Ability to download your schemas and OpenAPI files (also versioned)

package/dist/eventcatalog.cjs

@@ -144,7 +144,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "4.10.12";
+var version = "4.10.14";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -4,8 +4,8 @@ import {
 import "./chunk-CA4U2JP7.js";
 import {
   log_build_default
-} from "./chunk-S4LLGOO4.js";
-import "./chunk-Y5XU3YLT.js";
+} from "./chunk-LUW6RDA7.js";
+import "./chunk-LITOQH56.js";
 import "./chunk-ZAZHAVKB.js";
 import {
   FederationConflictError,
@@ -31,10 +31,10 @@ import {
 } from "./chunk-B7HCX5HM.js";
 import {
   generate
-} from "./chunk-7URQ754Q.js";
+} from "./chunk-HERAHLM2.js";
 import {
   logger
-} from "./chunk-VFSEVDCQ.js";
+} from "./chunk-ONDFEA5R.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-LHR4G2UO.js";
@@ -54,7 +54,7 @@ import {
 import "./chunk-W5JQON7Z.js";
 import {
   VERSION
-} from "./chunk-A53VCEEA.js";
+} from "./chunk-V2SKOQYF.js";
 import {
   linkCoreNodeModules,
   resolveInstalledCoreNodeModules

package/dist/generate.cjs

@@ -108,7 +108,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "4.10.12";
+var version = "4.10.14";
 
 // src/constants.ts
 var VERSION = version;

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-7URQ754Q.js";
-import "./chunk-VFSEVDCQ.js";
-import "./chunk-A53VCEEA.js";
+} from "./chunk-HERAHLM2.js";
+import "./chunk-ONDFEA5R.js";
+import "./chunk-V2SKOQYF.js";
 import "./chunk-6QENHZZP.js";
 export {
   generate

package/dist/utils/cli-logger.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(cli_logger_exports);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "4.10.12";
+var version = "4.10.14";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

@@ -1,7 +1,7 @@
 import {
   logger
-} from "../chunk-VFSEVDCQ.js";
-import "../chunk-A53VCEEA.js";
+} from "../chunk-ONDFEA5R.js";
+import "../chunk-V2SKOQYF.js";
 export {
   logger
 };