# AIAssistant Widget

_Generated on 2026-05-14._

## Purpose

`AIAssistant` is an Octopus detached widget package. It can run standalone
during development and can also be loaded dynamically by
`ska-octopus-frontend` at runtime.

## Bigger Picture (Octopus Suite)

The `ska-octopus-suite` combines backend, frontend, deployment charts, and
helper tooling. In that architecture:

- `ska-octopus-backend` exposes GraphQL over HTTP/WebSocket and handles
  runtime widget delivery metadata.
- `ska-octopus-frontend` loads widget bundles from the backend catalog and
  each bundle self-registers via `Octopus.registerWidget(...)`.
- Widgets stay decoupled from frontend releases, so teams can ship widget
  updates without rebuilding the host app.

Reference:
https://developer.skao.int/projects/ska-octopus-suite/en/latest/overview.html

## Widget Metadata

- Repository folder: `rasor-ai-assistant-widget`
- Package name: `@atlar-widgets/rasor-ai-assistant-widget`
- GraphQL modes scaffolded: subscriptions (WebSocket)

## Runtime Configuration

The widget configuration schema is defined in `src/index.ts`.
Variables detected during scaffolding:

| Name | Default | GraphQL type |

|------|---------|--------------| | title | "" | SDK custom type |

## Local Development (Standalone)

```bash
git clone <repo-url> rasor-ai-assistant-widget
cd rasor-ai-assistant-widget
npm install
npm run dev
```

Default dev endpoints are configured in `dev/main.tsx`:

- GraphQL HTTP: `http://localhost:8000/graphql`
- GraphQL WS: `ws://localhost:8000/graphql`

Build and test:

```bash
npm run build
npm run test
```

## Integrate with Local `ska-octopus-frontend`

1. Add a Vite alias to your local widget source:
   `@atlar-widgets/rasor-ai-assistant-widget` -> `<path-to>/rasor-ai-assistant-widget/src`
2. Import the module in `src/dashboard.ts`:
   `import '@atlar-widgets/rasor-ai-assistant-widget';`
3. Start frontend dev server and add the widget from the picker.

## Integrate with Deployed Octopus

1. Publish `@atlar-widgets/rasor-ai-assistant-widget` to your npm registry.
2. Add/update it in Octopus Config UI -> Widgets Store.
3. The backend serves widget bundle metadata; frontend fetches and executes
   the bundle at runtime.

Note: deployments can restrict allowed widget registries/scopes (for
example through `WIDGET_ALLOWED_NPM_SCOPES`).