@burtson-labs/bandit-types 1.0.1

package/README.md

@@ -0,0 +1,66 @@
+<a href="https://burtson.ai">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://cdn.burtson.ai/logos/burtson-labs-logo-alt.png" />
+    <source media="(prefers-color-scheme: light)" srcset="https://cdn.burtson.ai/logos/burtson-labs-logo.png" />
+    <img src="https://cdn.burtson.ai/logos/burtson-labs-logo.png" alt="Burtson Labs Logo" width="120" />
+  </picture>
+</a>
+
+# @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.
+
+[![License: BUSL-1.1](https://img.shields.io/badge/License-BUSL--1.1-red)](./LICENSE)
+
+## Install
+
+```bash
+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:
+
+```ts
+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:
+
+```ts
+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`](https://www.npmjs.com/package/@burtson-labs/bandit-engine) — React chat components and AI provider SDK
+- [`@burtson-labs/bandit-cli`](https://banditailabs.com/npm-package) — Quickstart scaffolding CLI
+- [`@burtson-labs/bandit-themes`](https://banditailabs.com/npm-package) — MUI theme pack
+
+Full docs: [banditailabs.com/npm-package](https://banditailabs.com/npm-package)

package/dist/index.d.mts

@@ -0,0 +1,173 @@
+interface GatewayMessageContent {
+    type: 'text' | 'image_url';
+    text?: string;
+    image_url?: {
+        url: string;
+        detail?: 'low' | 'high' | 'auto';
+    };
+}
+interface GatewayMessage {
+    role: 'system' | 'user' | 'assistant';
+    content: string | GatewayMessageContent[];
+    name?: string;
+    images?: string[];
+}
+interface GatewayTool {
+    type: 'function';
+    function: {
+        name: string;
+        description?: string;
+        parameters?: {
+            type: string;
+            properties?: Record<string, unknown>;
+            required?: string[];
+        };
+    };
+}
+interface GatewayChatRequest {
+    model: string;
+    messages: GatewayMessage[];
+    stream?: boolean;
+    temperature?: number;
+    max_tokens?: number;
+    top_p?: number;
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    provider?: 'openai' | 'azure-openai' | 'anthropic' | 'ollama' | 'xai' | 'bandit' | 'playground';
+    stop?: string | string[];
+    images?: string[];
+    tools?: GatewayTool[];
+}
+interface GatewayToolCall {
+    id?: string;
+    type?: 'function';
+    function: {
+        name: string;
+        arguments: string | Record<string, unknown>;
+    };
+}
+interface GatewayChatResponse {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: {
+        index: number;
+        delta?: {
+            role?: string;
+            content?: string;
+            tool_calls?: GatewayToolCall[];
+        };
+        message?: {
+            role: string;
+            content: string;
+            tool_calls?: GatewayToolCall[];
+        };
+        finish_reason?: string | null;
+    }[];
+    usage?: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+}
+interface GatewayGenerateRequest {
+    model: string;
+    prompt: string;
+    stream?: boolean;
+    temperature?: number;
+    max_tokens?: number;
+    provider?: 'openai' | 'azure-openai' | 'anthropic' | 'ollama' | 'xai' | 'bandit' | 'playground';
+    stop?: string | string[];
+}
+interface GatewayGenerateResponse {
+    model: string;
+    created_at: string;
+    response: string;
+    done: boolean;
+    context?: number[];
+    total_duration?: number;
+    load_duration?: number;
+    prompt_eval_count?: number;
+    prompt_eval_duration?: number;
+    eval_count?: number;
+    eval_duration?: number;
+}
+interface GatewayModel {
+    id: string;
+    name: string;
+    provider: string;
+    created: number;
+    modified_at: string;
+    size: number;
+    digest: string;
+    details?: {
+        format: string;
+        family: string;
+        families: string[];
+        parameter_size: string;
+        quantization_level: string;
+    };
+}
+interface GatewayModelsResponse {
+    models: GatewayModel[];
+}
+interface GatewayHealthResponse {
+    status: 'healthy' | 'unhealthy';
+    version: string;
+    providers: {
+        name: string;
+        status: 'available' | 'unavailable';
+        models_count: number;
+    }[];
+    uptime: number;
+}
+interface GatewayMemoryRecord {
+    id: string;
+    type: string;
+    content: string;
+    createdAt: string;
+    updatedAt: string;
+    metadata?: Record<string, unknown>;
+}
+interface GatewayMemoryResponse {
+    records: GatewayMemoryRecord[];
+    total: number;
+    nextCursor?: string | null;
+}
+interface GatewayContract {
+    chat(request: GatewayChatRequest): Promise<GatewayChatResponse>;
+    generate(request: GatewayGenerateRequest): Promise<GatewayGenerateResponse>;
+    health(): Promise<GatewayHealthResponse>;
+}
+
+interface StoredBrandingConfig {
+    brandingText?: string;
+    logoBase64?: string | null;
+    theme?: string;
+    hasTransparentLogo?: boolean;
+    userSaved?: boolean;
+    [key: string]: unknown;
+}
+interface StoredModelConfig {
+    name?: string;
+    tagline?: string;
+    systemPrompt?: string;
+    selectedModel?: string;
+    avatarBase64?: string | null;
+    [key: string]: unknown;
+}
+interface StoredBanditConfigRecord {
+    id: string;
+    branding?: StoredBrandingConfig;
+    model?: StoredModelConfig;
+    name?: string;
+    tagline?: string;
+    systemPrompt?: string;
+    selectedModel?: string;
+    avatarBase64?: string;
+    commands?: unknown;
+    [key: string]: unknown;
+}
+
+export type { GatewayChatRequest, GatewayChatResponse, GatewayContract, GatewayGenerateRequest, GatewayGenerateResponse, GatewayHealthResponse, GatewayMemoryRecord, GatewayMemoryResponse, GatewayMessage, GatewayMessageContent, GatewayModel, GatewayModelsResponse, GatewayTool, GatewayToolCall, StoredBanditConfigRecord, StoredBrandingConfig, StoredModelConfig };

package/dist/index.d.ts

@@ -0,0 +1,173 @@
+interface GatewayMessageContent {
+    type: 'text' | 'image_url';
+    text?: string;
+    image_url?: {
+        url: string;
+        detail?: 'low' | 'high' | 'auto';
+    };
+}
+interface GatewayMessage {
+    role: 'system' | 'user' | 'assistant';
+    content: string | GatewayMessageContent[];
+    name?: string;
+    images?: string[];
+}
+interface GatewayTool {
+    type: 'function';
+    function: {
+        name: string;
+        description?: string;
+        parameters?: {
+            type: string;
+            properties?: Record<string, unknown>;
+            required?: string[];
+        };
+    };
+}
+interface GatewayChatRequest {
+    model: string;
+    messages: GatewayMessage[];
+    stream?: boolean;
+    temperature?: number;
+    max_tokens?: number;
+    top_p?: number;
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    provider?: 'openai' | 'azure-openai' | 'anthropic' | 'ollama' | 'xai' | 'bandit' | 'playground';
+    stop?: string | string[];
+    images?: string[];
+    tools?: GatewayTool[];
+}
+interface GatewayToolCall {
+    id?: string;
+    type?: 'function';
+    function: {
+        name: string;
+        arguments: string | Record<string, unknown>;
+    };
+}
+interface GatewayChatResponse {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: {
+        index: number;
+        delta?: {
+            role?: string;
+            content?: string;
+            tool_calls?: GatewayToolCall[];
+        };
+        message?: {
+            role: string;
+            content: string;
+            tool_calls?: GatewayToolCall[];
+        };
+        finish_reason?: string | null;
+    }[];
+    usage?: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+}
+interface GatewayGenerateRequest {
+    model: string;
+    prompt: string;
+    stream?: boolean;
+    temperature?: number;
+    max_tokens?: number;
+    provider?: 'openai' | 'azure-openai' | 'anthropic' | 'ollama' | 'xai' | 'bandit' | 'playground';
+    stop?: string | string[];
+}
+interface GatewayGenerateResponse {
+    model: string;
+    created_at: string;
+    response: string;
+    done: boolean;
+    context?: number[];
+    total_duration?: number;
+    load_duration?: number;
+    prompt_eval_count?: number;
+    prompt_eval_duration?: number;
+    eval_count?: number;
+    eval_duration?: number;
+}
+interface GatewayModel {
+    id: string;
+    name: string;
+    provider: string;
+    created: number;
+    modified_at: string;
+    size: number;
+    digest: string;
+    details?: {
+        format: string;
+        family: string;
+        families: string[];
+        parameter_size: string;
+        quantization_level: string;
+    };
+}
+interface GatewayModelsResponse {
+    models: GatewayModel[];
+}
+interface GatewayHealthResponse {
+    status: 'healthy' | 'unhealthy';
+    version: string;
+    providers: {
+        name: string;
+        status: 'available' | 'unavailable';
+        models_count: number;
+    }[];
+    uptime: number;
+}
+interface GatewayMemoryRecord {
+    id: string;
+    type: string;
+    content: string;
+    createdAt: string;
+    updatedAt: string;
+    metadata?: Record<string, unknown>;
+}
+interface GatewayMemoryResponse {
+    records: GatewayMemoryRecord[];
+    total: number;
+    nextCursor?: string | null;
+}
+interface GatewayContract {
+    chat(request: GatewayChatRequest): Promise<GatewayChatResponse>;
+    generate(request: GatewayGenerateRequest): Promise<GatewayGenerateResponse>;
+    health(): Promise<GatewayHealthResponse>;
+}
+
+interface StoredBrandingConfig {
+    brandingText?: string;
+    logoBase64?: string | null;
+    theme?: string;
+    hasTransparentLogo?: boolean;
+    userSaved?: boolean;
+    [key: string]: unknown;
+}
+interface StoredModelConfig {
+    name?: string;
+    tagline?: string;
+    systemPrompt?: string;
+    selectedModel?: string;
+    avatarBase64?: string | null;
+    [key: string]: unknown;
+}
+interface StoredBanditConfigRecord {
+    id: string;
+    branding?: StoredBrandingConfig;
+    model?: StoredModelConfig;
+    name?: string;
+    tagline?: string;
+    systemPrompt?: string;
+    selectedModel?: string;
+    avatarBase64?: string;
+    commands?: unknown;
+    [key: string]: unknown;
+}
+
+export type { GatewayChatRequest, GatewayChatResponse, GatewayContract, GatewayGenerateRequest, GatewayGenerateResponse, GatewayHealthResponse, GatewayMemoryRecord, GatewayMemoryResponse, GatewayMessage, GatewayMessageContent, GatewayModel, GatewayModelsResponse, GatewayTool, GatewayToolCall, StoredBanditConfigRecord, StoredBrandingConfig, StoredModelConfig };

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@burtson-labs/bandit-types",
+  "version": "1.0.1",
+  "license": "BUSL-1.1",
+  "description": "Type definitions for Bandit gateway contracts and configuration — install without the full engine",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Burtson-Labs/bandit-engine.git"
+  },
+  "homepage": "https://banditailabs.com/npm-package",
+  "author": "Burtson Labs LLC <team@banditai.ai>",
+  "keywords": [
+    "bandit",
+    "types",
+    "typescript",
+    "gateway",
+    "ai"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "protect": "node scripts/add-license-headers.js",
+    "validate-protection": "node scripts/validate-protection.js"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "typescript": "5.5.4"
+  }
+}