@eventcatalog/core 5.0.0-beta.8 → 5.0.0

package/dist/docs/development/ask-your-architecture/06-slack-integration/03-installation.md

@@ -1,169 +0,0 @@
----
-sidebar_position: 3
-keywords:
-- Slack Bot
-- Installation
-sidebar_label: Installation
-title: Installation
-description: Install and configure the bot
----
-
-import PlanBanner from '@site/src/components/MDX/PlanBanner';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<PlanBanner plan="Scale" />
-
-Install the EventCatalog Slack Bot locally or deploy it to your infrastructure. The bot runs as a long-lived process that maintains a connection to Slack.
-
-## Install locally
-
-### Clone repository
-
-```bash
-git clone https://github.com/event-catalog/eventcatalog-slack-bot.git
-cd eventcatalog-slack-bot
-```
-
-### Install dependencies
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-    ```bash
-    npm install
-    ```
-  </TabItem>
-  <TabItem value="pnpm" label="pnpm">
-    ```bash
-    pnpm install
-    ```
-  </TabItem>
-</Tabs>
-
-### Configure environment
-
-Create a `.env` file with your credentials:
-
-```bash
-# EventCatalog Scale License (Required)
-EVENTCATALOG_SCALE_LICENSE_KEY=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
-
-# Slack Credentials (Required)
-SLACK_BOT_TOKEN=xoxb-...
-SLACK_APP_TOKEN=xapp-...
-SLACK_SIGNING_SECRET=...
-
-# AI Provider (at least one required)
-ANTHROPIC_API_KEY=sk-ant-...
-# OPENAI_API_KEY=sk-...
-# GOOGLE_GENERATIVE_AI_API_KEY=...
-```
-
-### Create configuration
-
-Create `eventcatalog-bot.config.ts`:
-
-```typescript
-export default {
-  eventCatalog: {
-    url: 'http://localhost:3000',
-    // Optional: Add authentication headers
-    // headers: {
-    //   'Authorization': 'Bearer your-token',
-    // },
-  },
-  ai: {
-    provider: 'anthropic', // 'anthropic' | 'openai' | 'google'
-    // model: 'claude-sonnet-4-20250514', // Optional: override default model
-    maxSteps: 5,
-    temperature: 0.4,
-  },
-  slack: {
-    // Optional: Channel IDs for auto-reply (bot responds to all messages)
-    autoReplyChannels: [],
-    // Optional: Custom icon URL for bot messages
-    icon: 'https://www.eventcatalog.dev/img/logo.png',
-    // Optional: Custom username for bot messages
-    username: 'EventCatalog',
-  },
-};
-```
-
-### Start the bot
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-    ```bash
-    npm run dev
-    ```
-  </TabItem>
-  <TabItem value="pnpm" label="pnpm">
-    ```bash
-    pnpm dev
-    ```
-  </TabItem>
-</Tabs>
-
-Or with a custom config path:
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-    ```bash
-    npm run dev -- --config ./my-config.ts
-    ```
-  </TabItem>
-  <TabItem value="pnpm" label="pnpm">
-    ```bash
-    pnpm dev --config ./my-config.ts
-    ```
-  </TabItem>
-</Tabs>
-
-## Configuration reference
-
-### eventCatalog
-
-| Option | Type | Required | Description |
-|--------|------|----------|-------------|
-| `url` | string | Yes | URL of your EventCatalog instance |
-| `headers` | object | No | Authentication headers if needed |
-
-### ai
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `provider` | string | Required | AI provider: `anthropic`, `openai`, or `google` |
-| `model` | string | Provider default | Model to use (see [supported models](#supported-ai-providers)) |
-| `maxSteps` | number | 5 | Maximum tool-calling steps (1-20) |
-| `temperature` | number | 0.4 | AI temperature (0-2) |
-
-### slack
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `autoReplyChannels` | string[] | [] | Channel IDs where bot auto-replies to all messages |
-| `icon` | string | EventCatalog logo | Custom icon URL for bot messages |
-| `username` | string | 'EventCatalog' | Custom display name for bot messages |
-
-## Supported AI providers
-
-| Provider | Environment Variable | Default Model |
-|----------|---------------------|---------------|
-| Anthropic | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514` |
-| OpenAI | `OPENAI_API_KEY` | `gpt-4o` |
-| Google | `GOOGLE_GENERATIVE_AI_API_KEY` | `gemini-2.0-flash` |
-
-You can override the default model in your configuration. For a full list of available models, see the [Vercel AI SDK Providers documentation](https://ai-sdk.dev/providers/ai-sdk-providers).
-
-```typescript
-ai: {
-  provider: 'anthropic',
-  model: 'claude-opus-4-20250514', // Use a different model
-}
-```
-
-## License key
-
-Get your EventCatalog Scale license key from [eventcatalog.cloud](https://eventcatalog.cloud). A 30-day free trial is available.
-
-The license key must be set as the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable.

package/dist/docs/development/ask-your-architecture/06-slack-integration/04-deployment.md

@@ -1,236 +0,0 @@
----
-sidebar_position: 4
-keywords:
-- Slack Bot
-- Deployment
-- Docker
-sidebar_label: Deployment
-title: Deployment
-description: Deploy the bot to production
----
-
-import PlanBanner from '@site/src/components/MDX/PlanBanner';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<PlanBanner plan="Scale" />
-
-Deploy the EventCatalog Slack Bot to your infrastructure. The bot uses Socket Mode, so it maintains an outbound connection to Slack without requiring a public URL, load balancer, or SSL certificates.
-
-## Docker
-
-The simplest way to deploy is using Docker. The bot includes a Dockerfile and docker-compose configuration.
-
-### Build the image
-
-```bash
-docker build -t eventcatalog-slack-bot .
-```
-
-### Run with docker-compose
-
-```bash
-docker compose up -d
-```
-
-### View logs
-
-```bash
-docker compose logs -f
-```
-
-The `docker-compose.yml` file mounts your config and reads environment variables from `.env`:
-
-```yaml
-services:
-  eventcatalog-slack-bot:
-    build: .
-    container_name: eventcatalog-slack-bot
-    restart: unless-stopped
-    env_file:
-      - .env
-    volumes:
-      - ./eventcatalog-bot.config.ts:/app/eventcatalog-bot.config.ts:ro
-    environment:
-      - NODE_ENV=production
-```
-
-## Docker networking
-
-When running the bot in Docker, the container needs network access to your EventCatalog server. Configuration depends on where EventCatalog runs.
-
-### EventCatalog on localhost
-
-Docker containers cannot use `localhost` to reach the host machine. Use one of these approaches:
-
-**Option 1: Use host.docker.internal (recommended)**
-
-Update your config to use the special Docker hostname:
-
-```typescript
-eventCatalog: {
-  url: 'http://host.docker.internal:3000',
-}
-```
-
-:::info
-Your EventCatalog server must bind to all interfaces (`0.0.0.0`), not just `localhost`. Check your EventCatalog startup logs. If it shows `localhost:3000`, you may need to start it with a `--host 0.0.0.0` flag.
-:::
-
-**Option 2: Run the bot outside Docker**
-
-For local development, skip Docker and run the bot directly:
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-    ```bash
-    npm install
-    npm run dev
-    ```
-  </TabItem>
-  <TabItem value="pnpm" label="pnpm">
-    ```bash
-    pnpm install
-    pnpm dev
-    ```
-  </TabItem>
-</Tabs>
-
-This avoids networking complexity during development.
-
-### EventCatalog in Docker
-
-Put both containers on the same Docker network and use the container name as hostname:
-
-```yaml
-services:
-  eventcatalog:
-    # your EventCatalog config
-    networks:
-      - app-network
-
-  eventcatalog-slack-bot:
-    build: .
-    env_file:
-      - .env
-    volumes:
-      - ./eventcatalog-bot.config.ts:/app/eventcatalog-bot.config.ts:ro
-    networks:
-      - app-network
-
-networks:
-  app-network:
-```
-
-Configure the bot to use the container name:
-
-```typescript
-eventCatalog: {
-  url: 'http://eventcatalog:3000',
-}
-```
-
-### EventCatalog at public URL
-
-Use the public URL directly - no special configuration needed:
-
-```typescript
-eventCatalog: {
-  url: 'https://your-catalog.example.com',
-}
-```
-
-## Other deployment options
-
-<details>
-<summary>Railway</summary>
-
-Railway automatically detects the Dockerfile and deploys the bot.
-
-1. Create a new project and connect your repository
-2. Add environment variables in the Railway dashboard:
-   - `EVENTCATALOG_SCALE_LICENSE_KEY`
-   - `SLACK_BOT_TOKEN`
-   - `SLACK_APP_TOKEN`
-   - `SLACK_SIGNING_SECRET`
-   - `ANTHROPIC_API_KEY` (or your chosen provider)
-3. Add your `eventcatalog-bot.config.ts` to the repository
-4. Deploy - Railway detects the Dockerfile automatically
-
-</details>
-
-<details>
-<summary>Fly.io</summary>
-
-Deploy to Fly.io using their CLI.
-
-**Initialize:**
-
-```bash
-fly launch --no-deploy
-```
-
-**Set secrets:**
-
-```bash
-fly secrets set EVENTCATALOG_SCALE_LICENSE_KEY=your-key
-fly secrets set SLACK_BOT_TOKEN=xoxb-...
-fly secrets set SLACK_APP_TOKEN=xapp-...
-fly secrets set SLACK_SIGNING_SECRET=...
-fly secrets set ANTHROPIC_API_KEY=sk-ant-...
-```
-
-**Deploy:**
-
-```bash
-fly deploy
-```
-
-</details>
-
-<details>
-<summary>Render</summary>
-
-Deploy as a Background Worker on Render.
-
-1. Create a new **Background Worker** (not a Web Service)
-2. Connect your repository
-3. Set the build and start commands:
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-    - Build command: `npm install && npm run build`
-    - Start command: `npm start`
-  </TabItem>
-  <TabItem value="pnpm" label="pnpm">
-    - Build command: `pnpm install && pnpm build`
-    - Start command: `pnpm start`
-  </TabItem>
-</Tabs>
-
-4. Add environment variables in the Render dashboard
-5. Deploy
-
-</details>
-
-<details>
-<summary>AWS, GCP, or Azure</summary>
-
-Deploy as a container or long-running process. The bot requires:
-
-- Outbound HTTPS/WSS connections to Slack
-- No inbound connections (Socket Mode handles communication)
-- No load balancers or public endpoints needed
-
-Suitable services include:
-
-- **AWS:** ECS, EKS, EC2
-- **GCP:** Cloud Run (always running), GKE, Compute Engine
-- **Azure:** Container Instances, AKS, Virtual Machines
-
-Ensure the process stays running and can make outbound connections to:
-- `slack.com` (Socket Mode connection)
-- Your EventCatalog instance
-- Your AI provider API
-
-</details>

package/dist/docs/development/ask-your-architecture/06-slack-integration/05-usage.md

@@ -1,140 +0,0 @@
----
-sidebar_position: 5
-keywords:
-- Slack Bot
-- Usage
-sidebar_label: Using the bot
-title: Using the bot
-description: Query architecture documentation from Slack
----
-
-import PlanBanner from '@site/src/components/MDX/PlanBanner';
-
-<PlanBanner plan="Scale" />
-
-Interact with the EventCatalog Slack Bot to query your architecture documentation. The bot responds to @mentions and can auto-reply in dedicated channels.
-
-## @Mention in any channel
-
-Invite the bot to any channel and @mention it to ask questions. The bot replies in a thread to keep channels organized.
-
-### Example questions
-
-```
-@eventcatalog Tell me about the OrderCreated event
-```
-
-```
-@eventcatalog What services consume the InventoryUpdated event?
-```
-
-```
-@eventcatalog List all events in the Orders domain
-```
-
-```
-@eventcatalog Show me the schema for the PaymentProcessed event
-```
-
-The bot reads your EventCatalog documentation and provides detailed answers grounded in your architecture.
-
-## Dedicated auto-reply channels
-
-Create a channel where the bot automatically responds to every message - no @mention needed. This gives your team a dedicated space for architecture questions.
-
-### Setup
-
-1. Create a new channel (e.g., `#ask-eventcatalog` or `#ask-eda`)
-2. Invite the bot to the channel
-3. Get the channel ID:
-   - Right-click the channel name
-   - Click **View channel details**
-   - Scroll to the bottom to find the Channel ID
-4. Add the channel ID to your config:
-
-```typescript
-slack: {
-  autoReplyChannels: ['C0123456789'],
-}
-```
-
-5. Restart the bot
-
-Now anyone can post questions directly in the channel and receive instant answers.
-
-### Multiple channels
-
-Configure multiple auto-reply channels:
-
-```typescript
-slack: {
-  autoReplyChannels: ['C0123456789', 'C9876543210'],
-}
-```
-
-## Thread context
-
-The bot automatically reads conversation history in threads. This enables natural follow-up questions without repeating context.
-
-### Example conversation
-
-**User:** Tell me about the OrderCreated event
-
-**Bot:** The OrderCreated event is published when...
-
-**User:** What are its consumers?
-
-**Bot:** Based on our earlier discussion about OrderCreated, the consumers are...
-
-**User:** Show me the schema
-
-**Bot:** Here's the schema for OrderCreated...
-
-Thread context works automatically in public channels. For private channels and DMs, add optional scopes to your Slack app:
-
-- `groups:history` - Private channels
-- `im:history` - Direct messages
-- `mpim:history` - Group DMs
-
-After adding scopes, reinstall the app to your workspace.
-
-## Best practices
-
-### Ask specific questions
-
-The bot performs best with clear, specific questions:
-
-**Good:**
-- "What services consume the OrderCreated event?"
-- "Show me all events in the Payment domain"
-- "What's the schema format for UserRegistered?"
-
-**Less effective:**
-- "Tell me about everything"
-- "What does this system do?"
-
-### Use thread conversations
-
-Keep related questions in the same thread. The bot uses thread history to provide better context-aware answers.
-
-### Name resources clearly
-
-Mention specific event names, service names, or domain names to get precise answers:
-
-- "Tell me about the **OrderCreated** event"
-- "What events does the **PaymentService** produce?"
-- "List all events in the **Orders** domain"
-
-## Invite the bot to channels
-
-The bot can only see messages in channels where it's invited.
-
-### Invite the bot
-
-1. Navigate to the channel
-2. Click the channel name at the top
-3. Click the **Integrations** tab
-4. Click **Add an app**
-5. Search for your bot and add it
-
-Alternatively, type `/invite @eventcatalog` in the channel.