@burtson-labs/bandit-types

TypeScript type definitions for the Bandit gateway contract and stored configuration interfaces. Install this package when you need to build against the Bandit API contract — implementing a custom gateway, writing server-side integrations, or typing responses — without pulling in the full React engine.

Install

npm install --save-dev @burtson-labs/bandit-types
# or for runtime use
npm install @burtson-labs/bandit-types

Gateway contract types

Use these when implementing a custom gateway that the engine will call:

import type {
  GatewayChatRequest,
  GatewayChatResponse,
  GatewayGenerateRequest,
  GatewayGenerateResponse,
  GatewayHealthResponse,
  GatewayMessage,
  GatewayTool,
  GatewayToolCall,
  GatewayModel,
  GatewayModelsResponse,
  GatewayMemoryRecord,
  GatewayMemoryResponse,
} from '@burtson-labs/bandit-types';

Configuration types

Use these when reading or writing Bandit stored configuration records:

import type {
  StoredBrandingConfig,
  StoredModelConfig,
  StoredBanditConfigRecord,
} from '@burtson-labs/bandit-types';

No runtime dependencies

This package is type-only. It has zero runtime dependencies and zero peer dependencies. It compiles to empty JS with full .d.ts output.

Part of the Bandit ecosystem

• @burtson-labs/bandit-engine — React chat components and AI provider SDK
• @burtson-labs/bandit-cli — Quickstart scaffolding CLI
• @burtson-labs/bandit-themes — MUI theme pack

Full docs: banditailabs.com/npm-package