@eventcatalog/core 3.34.0 → 3.35.1

package/dist/docs/miro/using-ai/01-overview.md

@@ -0,0 +1,105 @@
+---
+sidebar_position: 1
+sidebar_label: From Miro to EventCatalog
+title: "From Miro to EventCatalog with AI"
+description: Use AI to turn your Miro board designs into EventCatalog documentation automatically
+slug: /miro/using-ai
+---
+
+The real power of the Miro app is the round-trip: **import your architecture, design what comes next, then push it all back into EventCatalog**, with AI handling the documentation for you.
+
+### The value
+
+When you design on a Miro board, you're making architecture decisions: new services, new events, new connections. Normally, turning those decisions into documented, structured catalog entries is manual work. With [EventCatalog Skills](https://github.com/event-catalog/skills), an AI agent does it for you:
+
+- **Model with real artifacts.** Start from your actual architecture, not a blank canvas
+- **Draft the future.** Create new services, events, and connections on the board before they exist in code
+- **Pull it back automatically.** Export the board and let AI create the documentation, frontmatter, folder structure, and relationships in your catalog
+
+No copy-pasting. No manually creating files. The AI reads your Miro board export and generates properly structured EventCatalog documentation.
+
+### How it works
+
+```mermaid
+flowchart LR
+    A[Design in Miro] --> B[Export Board JSON]
+    B --> C[Feed to AI Agent]
+    C --> D[AI Creates Docs]
+    D --> E[Review & Commit]
+
+    style A fill:#FFD02F,color:#000,stroke:none
+    style B fill:#8B5CF6,color:#fff,stroke:none
+    style C fill:#7C3AED,color:#fff,stroke:none
+    style D fill:#9333EA,color:#fff,stroke:none
+    style E fill:#6B46C1,color:#fff,stroke:none
+```
+
+### Walkthrough
+
+#### 1. Design your architecture in Miro
+
+Import your existing catalog, then make changes. Add new services, draw new connections, rename resources, sketch out a future state. Everything you'd normally do in a design session with your team.
+
+#### 2. Export the board
+
+Click **Export to JSON** on the dashboard. This downloads a `miro-board-export.json` file containing everything on the board: resources, connections, positions, and labels.
+
+#### 3. Install EventCatalog Skills
+
+If you haven't already, add the skills to your project:
+
+```bash
+npx skills add event-catalog/skills
+```
+
+These skills teach your AI agent how to create and update EventCatalog documentation: proper frontmatter, folder structure, naming conventions, and resource relationships.
+
+#### 4. Feed the export to your AI agent
+
+Open your AI agent (e.g. Claude, Cursor, Windsurf) in your EventCatalog project and give it the export:
+
+```
+Here is the Miro board export from our architecture design session.
+
+Please update my EventCatalog to reflect the changes:
+- Add any new services, events, commands, or queries we created
+- Update connections between services and messages
+- Create documentation for all new resources
+
+<attach or paste miro-board-export.json>
+```
+
+The AI will:
+- Parse the board items (cards, sticky notes) and connectors
+- Identify new resources that need catalog entries
+- Map connections to EventCatalog relationships (sends, receives, writesTo, readsFrom)
+- Generate MDX files with correct frontmatter and folder structure
+- Cross-reference existing resources to avoid duplicates
+
+#### 5. Review and commit
+
+The AI creates files directly in your EventCatalog project. Review the changes, then commit:
+
+```bash
+git add .
+git commit -m "Update architecture from Miro design session"
+```
+
+Open a pull request if your team reviews architecture changes, just like code.
+
+### Example
+
+Say your team designs a new `NotificationService` on the Miro board that consumes an `OrderCompleted` event and sends an `EmailSent` event. After exporting and running through AI, you'd get:
+
+- `services/NotificationService/index.md` with frontmatter linking to the events it sends and receives
+- `events/EmailSent/index.md` with schema, summary, and producer information
+- Updated `events/OrderCompleted/index.md` with `NotificationService` added as a consumer
+
+All properly structured, all linked, all ready for your team to review.
+
+### Tips
+
+- **Be specific in your prompt.** Tell the AI what changed in this session so it knows what to focus on
+- **Attach the full export.** The AI needs the complete board state to understand connections
+- **Review before committing.** AI is great at structure and boilerplate, but you should verify the details match your team's decisions
+- **Use with pull requests.** Treat architecture documentation changes like code changes for team visibility

package/dist/docs/miro/using-ai/_category_.json

@@ -0,0 +1,11 @@
+{
+  "label": "Using AI",
+  "position": 4,
+  "collapsible": false,
+  "collapsed": false,
+  "link": {
+    "type": "generated-index",
+    "title": "Using AI with the Miro App",
+    "description": "Use AI to turn your Miro board designs into EventCatalog documentation"
+  }
+}

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

@@ -0,0 +1,49 @@
+---
+sidebar_position: 1
+keywords:
+- EventCatalog Contributing
+sidebar_label: Getting started with plugins
+title: Understanding EventCatalog Plugins
+description: Understand how to use EventCatalog plugins
+---
+
+EventCatalog is technology agnostic, which means we can integrate with any system in the world that exposes an API.
+
+This can be schema registries, brokers, cloud providers and more.
+
+EventCatalog intergrates with systems using [generators](/docs/plugins/generators).
+
+### What are generators?    
+
+Generators are scripts that are executed before your build time. They can be used to integrate with brokers, cloud providers and many more systems.
+
+EventCatalog will use generators to pull schemas from registries, or generate messages from your OpenAPI or AsyncAPI files and much more.
+
+You can create your own generators or use the [EventCatalog plugins](#official-eventcatalog-plugins) which are updated and maintained by the EventCatalog team.
+
+#### Official EventCatalog plugins
+
+These plugins are maintained by the EventCatalog team and are updated regularly, to get started click the link below to view the documentation for each plugin.
+
+- [AsyncAPI Plugin](/docs/plugins/asyncapi/intro) - Generate documentation from your AsyncAPI files
+- [OpenAPI Plugin](/docs/plugins/openapi/intro) - Generate documentation from your OpenAPI files
+- [GraphQL Plugin](/docs/plugins/graphql/intro) - Generate documentation from your GraphQL files
+- [Github Plugin](/docs/plugins/github/intro) - Sync your schemas from GitHub to EventCatalog
+- [Backstage Plugin](/docs/plugins/backstage/intro) - Use EventCatalog features within Backstage
+- [Amazon EventBridge](/docs/plugins/eventbridge/intro) - Sync Amazon EventBridge schemas to EventCatalog
+- [Amazon API Gateway](/docs/plugins/amazon-apigateway/intro) - Generate documentation from your Amazon API Gateway
+- [Confluent Schema Registry](/docs/plugins/confluent-schema-registry/intro) - Sync your schemas from Confluent Schema Registry to EventCatalog
+- [EventCatalog Federation](/docs/plugins/eventcatalog-federation/introduction) - Merge multiple EventCatalog instances into a single catalog.
+
+#### Community plugins
+
+- [Atlassian Compass](https://github.com/IsmaelMartinez/generator-atlassian-compass-event-catalog) - Integration with Atlassian Compass. 
+- [Hookdeck](/docs/plugins/hookdeck/intro) - Integration with Hookdeck.
+
+## Custom integrations
+
+EventCatalog can integrate with anything that has an API. 
+
+We offer support and services to build custom integrations for your EventCatalog.
+
+If you would like to explore custom integrations and have us build your integrate for you please contact us at `hello@eventcatalog.dev`.

package/dist/docs/plugins/02-generators.md

@@ -0,0 +1,76 @@
+---
+sidebar_position: 2
+keywords:
+  - Generators
+sidebar_label: Understanding generators
+title: Generators
+description: Understanding EventCatalog generators.
+---
+EventCatalog generators are custom scripts executed before the build process begins.
+
+During the catalog build, your configured generators run dynamically, providing the opportunity to utilize open-source generators and plugins or develop your own custom solutions.
+
+### Why use generators?
+
+Generators can be used to automate areas of your catalog. Examples of this include API requests to get schemas from a cloud provider, or integrating with brokers. A generator script can be anything you want.
+
+You can also use the [EventCatalog SDK](/docs/sdk) within your generators to interact with your catalog.
+
+### Getting Started
+
+When configuring a generator you need to define an entry point and it's custom configuration.
+
+In the example below we create a new plugin called `plugin.js` located in the root of the project.
+The object below is configuration the plugin will receive.
+
+```js title="eventcatalog.config.js"
+generators: [
+    [
+        // This generator called 'plugin.js' is located at in the root of your catalog
+      '<rootDir>/plugin.js',
+      // This is custom configuration your generator can use.
+      {
+        customValue: true,
+        hello: 'world'
+      },
+    ],
+    // more generators...
+  ],
+```
+
+```js title="/plugin.js"
+const utils = require('@eventcatalog/sdk');
+
+// Plugins require CJS files at the moment, this is being worked on...
+const { getEvent } = utils.default(__dirname);
+
+// The config value is your EventCatalog config
+// The options value is the configuration you pass to your plugin
+module.exports = async (config, options) => {
+
+    // access to your eventcatalog.config.js file
+    const { homepageLink } = config;
+
+    // Get values from your custom configuration
+    const { customValue, hello  } = options;
+
+    // Call the EventCatalog SDK
+    const event = await getEvent('InventoryAdjusted');
+}
+```
+
+### Running your generators
+
+To run your generators you need to call the command
+
+```sh
+npm run generate
+```
+
+Run generators in their debug mode.
+
+```sh
+npm run generate -- debug
+```
+
+EventCatalog will then run through your generators and call your scripts.

package/dist/docs/plugins/03-all-plugins.md

@@ -0,0 +1,26 @@
+---
+sidebar_position: 3
+keywords:
+- EventCatalog Contributing
+sidebar_label: All plugins
+title: All EventCatalog plugins
+description: All EventCatalog plugins
+---
+
+<!--  Table of plugins -->
+
+Automate and sync your data from a wide range of systems to EventCatalog.
+
+| Plugin | Description |
+|--------|-------------|
+| [AsyncAPI Plugin](/docs/plugins/asyncapi/intro) | Generate documentation from your AsyncAPI files |
+| [OpenAPI Plugin](/docs/plugins/openapi/intro) | Generate documentation from your OpenAPI files |
+| [GraphQL Plugin](/docs/plugins/graphql/intro) | Generate documentation from your GraphQL files |
+| [Apicurio Registry](/docs/plugins/apicurio/intro) | Import schemas and specifications from Apicurio Registry into EventCatalog |
+| [Azure Schema Registry](/docs/plugins/azure-schema-registry/intro) | Import schemas from Azure Schema Registry into EventCatalog |
+| [Github Plugin](/docs/plugins/github/intro) | Sync your schemas from GitHub to EventCatalog |
+| [Backstage Plugin](/docs/plugins/backstage/intro) | Use EventCatalog features within Backstage |
+| [Amazon EventBridge](/docs/plugins/eventbridge/intro) | Sync Amazon EventBridge schemas to EventCatalog |
+| [Amazon API Gateway](/docs/plugins/amazon-apigateway/intro) | Generate documentation from your Amazon API Gateway |
+| [Confluent Schema Registry](/docs/plugins/confluent-schema-registry/intro) | Sync your schemas from Confluent Schema Registry to EventCatalog |
+| [EventCatalog Federation](/docs/plugins/eventcatalog-federation/introduction) | Merge multiple EventCatalog instances into a single catalog. |

package/dist/docs/plugins/_category_.json

@@ -0,0 +1,12 @@
+{
+  "label": "Integrations",
+  "position": 4,
+  "collapsible": false,
+  "collapsed": false,
+  "link": {
+    "type": "generated-index",
+    "slug": "integrations",
+    "title": "Integrations",
+    "description": "Integrations with EventCatalog"
+  }
+}

package/dist/docs/plugins/amazon-apigateway/00-intro.md

@@ -0,0 +1,75 @@
+---
+sidebar_position: 1
+keywords:
+- components
+sidebar_label: Introduction
+title: Getting started
+description: Getting started with Amazon EventBridge plugin
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+import PluginLicense from '@site/src/components/MDX/PluginLicense';
+
+<PluginLicense url="#commercial-use" />
+
+<!-- <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> -->
+
+---
+
+[API Gateway](https://aws.amazon.com/api-gateway/) is an AWS service that allows you to create, publish, maintain, monitor, and secure APIs at any scale.
+
+### Why use EventCatalog with Amazon API Gateway?
+
+Using the EventCatalog Amazon API Gateway integration you can import your API Gateway specifications into EventCatalog. 
+
+This allows you to visualize your API's, their endpoints, and the messages they send and receive. You can map the endpoints to commands, events and queries in your catalog and assign these to services and domains and teams in your organization.
+
+EventCatalog will also allow you to download and view your OpenAPI specifications in the catalog directly, download schemas for each endpoint and see the requests/responses for each endpoint.
+
+### Core Features
+
+The EventCatalog Amazon API Gateway plugin can provide you with many features:
+
+- ⭐️ Generate domains, services, channels and messages into your catalog
+- ⭐️ Import and map your API Gateway specifications into EventCatalog
+- ⭐️ Map API Gateway routes to commands, events and queries in your catalog
+- ⭐️ Add semantic meaning to your API Gateway routes
+- ⭐️ and more....
+
+### How it works
+
+![Example](/img/integrations/amazon-apigateway/amazon-apigateway.png)
+
+This plugin will download OpenAPI specifications from your API Gateway and import them into EventCatalog. The API Gateway integration will add custom EventCatalog extensions onto your OpenAPI specification and then use the [OpenAPI plugin](/docs/plugins/openapi/intro) to import the specification into EventCatalog.
+
+This will map your routes into commands, events and queries in your catalog and assign these to services and domains and teams in your organization.
+
+## Commercial and License
+
+This plugin requires a license key to be used. 
+
+You can get a 14 day trial license key to try the plugin out by going to [EventCatalog Cloud](https://eventcatalog.cloud).
+
+After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization. 
+
+See [pricing](/pricing) for more information.
+
+_Have any questions? You can email us at `hello@eventcatalog.dev`._
+
+## License FAQ
+
+### What is the license key for?
+The license key is required to use the Amazon API Gateway plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
+
+### How do I get a license key?
+You can obtain a license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). Your organization can have a 14 day trial license key to try the plugin out.
+
+### Terms
+- **Trial Period**: 14 days free trial no credit card required
+- **Support**: Discord community support (extra for priority support)
+
+After your trial period ends, you can purchase a full license through [EventCatalog Cloud](https://eventcatalog.cloud) to continue using the plugin.
+
+## Issues
+
+If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators or join our [Discord community](https://eventcatalog.dev/discord) to chat with the team and other users.

package/dist/docs/plugins/amazon-apigateway/01-installation.md

@@ -0,0 +1,198 @@
+---
+sidebar_position: 1
+keywords:
+- components
+sidebar_label: Installation
+title: Installation
+description: Installation instructions for the Amazon API Gateway plugin
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+import PluginLicense from '@site/src/components/MDX/PluginLicense';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<PluginLicense url="#commercial-use" />
+
+This plugin requires the OpenAPI and Amazon API Gateway plugins to be installed.
+
+<!-- <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> -->
+
+---
+
+## Installation
+
+Run the command below to install the Amazon API Gateway generator.
+
+:::tip "Don't have an EventCatalog project yet?"
+If you don't have an EventCatalog project yet, you can follow the instructions in the [Getting Started](/docs/development/getting-started/installation) guide.
+:::
+
+<Tabs>
+  <TabItem value="apple" label="Install on existing catalog" default>
+    ```bash
+npm i @eventcatalog/generator-amazon-apigateway
+```
+  </TabItem>
+  <TabItem value="orange" label="Create new catalog with the Amazon API Gateway template">
+     ```bash
+npx @eventcatalog/create-eventcatalog@latest my-catalog --template amazon-apigateway
+```
+  </TabItem>
+</Tabs>
+
+## Configuration
+
+In your `eventcatalog.config.js` file, add the API Gateway generator and OpenAPI plugin to the `generators` array.
+
+```js title="eventcatalog.config.js"
+import path from "path";
+import url from "url";
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+/** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
+export default {
+  cId: "10b46030-5736-4600-8254-421c3ed56e47",
+  title: "EventCatalog",
+  tagline: "Discover, Explore and Document your Event Driven Architectures",
+  organizationName: "Your Company",
+  homepageLink: "https://eventcatalog.dev/",
+  editUrl: "https://github.com/boyney123/eventcatalog-demo/edit/master",
+  // By default set to false, add true to get urls ending in /
+  trailingSlash: false,
+  // Change to make the base url of the site different, by default https://{website}.com/docs,
+  // changing to /company would be https://{website}.com/company/docs,
+  base: "/",
+  // Customize the logo, add your logo to public/ folder
+  logo: {
+    alt: "EventCatalog Logo",
+    src: "/logo.png",
+    text: "EventCatalog",
+  },
+  docs: {
+    sidebar: {
+      // Should the sub heading be rendered in the docs sidebar?
+      showPageHeadings: true,
+    },
+  },
+  generators: [
+    [
+      "@eventcatalog/generator-amazon-apigateway",
+      {
+        output: 'amazon-api-gateway-output',
+        apis: [
+          {
+            // The name of the API we want to process
+            name: 'EcommerceApi',
+            // Assume it's deployed to us-east-1, change this if you deployed somewhere else
+            region: 'us-east-1',
+            // The API stage name
+            stageName: 'prod',
+            version: '2',
+            // Optional routes, we can map routes to message types
+            // give them descriptions and unique ids in eventcatalog
+            routes: {
+              'post /cart/checkout': {
+                type: 'command',
+                id: 'CheckoutCart',
+                description: 'Request to checkout the cart',
+              },
+              'post /cart/clear': {
+                type: 'command',
+                id: 'ClearCart',
+                description: 'Request to clear the cart',
+              },
+            }
+          }
+        ]
+      },
+    ],
+    // This will process the output of the amazon api gateway generator
+    // it will process the OpenAPI file and map it into a service and domain
+    // All routes are mapped to messages.
+    [
+      "@eventcatalog/generator-openapi",
+      {
+        services: [
+          { path: path.join(__dirname, "amazon-api-gateway-output", "EcommerceApi.json"), id: 'ecommerce-api', owners: ['full-stack'] },
+        ]
+      },
+    ],
+  ],
+};
+```
+
+### Configure license key
+
+The API Gateway and OpenAPI plugin both require a license key to work with EventCatalog.
+
+You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
+
+You have a few options for setting the license key:
+
+1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
+2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
+
+#### 1. Setting license key in `.env` file (recommended)
+
+<AddedIn version="2.35.4" />
+
+Create a `.env` file in the root of your project and add the following:
+
+```bash title=".env"
+EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=your-license-key
+EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
+```
+
+:::tip Using an older version of EventCatalog?
+
+If you are using an older version of EventCatalog that does not support the `.env` file, you can just export the license key as an environment variable.
+
+```bash title="Setting license key in environment variables"
+export EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=your-license-key
+export EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
+```
+
+:::
+
+#### 2. Setting license key in eventcatalog.config.js
+
+If you prefer, you can set the license key in the `eventcatalog.config.js` file
+using the `licenseKey` property in both the API Gateway and OpenAPI plugin.
+
+```js title="eventcatalog.config.js"
+export default {
+  generators: [
+    [
+      '@eventcatalog/generator-eventbridge',
+      {
+        licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY
+      },
+    ],
+  ],
+};
+```
+
+#### White listing EventCatalog domains
+
+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.
+
+## Run the generator
+
+Once you have configured the plugin and license key you can run the generator.
+
+```sh
+npm run generate
+```
+
+## View your catalog
+
+Run your catalog locally to see the changes.
+
+```sh
+npm run dev
+```
+
+
+