@fugood/buttress-server 2.25.0-beta.9 → 2.25.0

package/lib/index.d.mts

@@ -1,370 +0,0 @@
-
-import { AnyElysia, Elysia } from "elysia";
-import { ReadableStream } from "node:stream/web";
-import { EventEmitter } from "node:events";
-
-//#region ../buttress-backend-core/lib/types/caps.d.ts
-declare function getCapabilities(type: any, currentClientCapabilities?: any, options?: {}): Promise<any>;
-//#endregion
-//#region ../buttress-backend-core/lib/types/status.d.ts
-/**
- * StatusTracker - Manages history with fixed limit using circular buffer pattern
- */
-declare class StatusTracker {
-  constructor(maxEntries?: number);
-  maxEntries: number;
-  modelLoads: any[];
-  completions: any[];
-  transcriptions: any[];
-  addModelLoad(entry: any): void;
-  addCompletion(entry: any): void;
-  addTranscription(entry: any): void;
-  getModelLoadHistory(): any[];
-  getCompletionHistory(): any[];
-  getTranscriptionHistory(): any[];
-  clear(): void;
-}
-declare const llmStatusTracker: StatusTracker;
-declare const sttStatusTracker: StatusTracker;
-declare const statusEmitter: EventEmitter<[never]>;
-/**
- * Subscribe to all status changes
- * @param {Function} callback - Called with { type, entry } on each change
- * @returns {Function} Unsubscribe function
- */
-declare function subscribeToStatus(callback: Function): Function;
-/**
- * Subscribe with ID for management
- * @param {Function} callback
- * @returns {{ subscriberId: number, unsubscribe: Function }}
- */
-declare function subscribeToStatusWithId(callback: Function): {
-  subscriberId: number;
-  unsubscribe: Function;
-};
-//#endregion
-//#region ../buttress-backend-core/lib/types/test-caps.d.ts
-/**
- * Display model capabilities in a Markdown table format
- * @param {Object} options - Display options
- * @param {Array<string>} options.modelIds - Array of model repository IDs
- * @param {Object|null} options.defaultConfig - Default configuration from TOML
- * @returns {Promise<void>}
- */
-declare function showModelsTable({
-  modelIds,
-  defaultConfig
-}?: {
-  modelIds: Array<string>;
-  defaultConfig: any | null;
-}): Promise<void>;
-/**
- * Test ggml-llm capabilities for a backend type with optional model configuration
- * @param {Object} options - Test options
- * @param {string|null} options.modelId - Model repository ID
- * @param {Object|null} options.defaultConfig - Default configuration from TOML
- * @returns {Promise<void>}
- */
-declare function testGgmlLlmCapabilities({
-  modelId,
-  defaultConfig
-}?: {
-  modelId: string | null;
-  defaultConfig: any | null;
-}): Promise<void>;
-/**
- * Display STT model capabilities in a Markdown table format
- * @param {Object} options - Display options
- * @param {Array<string>} options.modelIds - Array of model IDs (format: repo_id:filename)
- * @param {Object|null} options.defaultConfig - Default configuration from TOML
- * @returns {Promise<void>}
- */
-declare function showSttModelsTable({
-  modelIds,
-  defaultConfig
-}?: {
-  modelIds: Array<string>;
-  defaultConfig: any | null;
-}): Promise<void>;
-/**
- * Test ggml-stt capabilities for a backend type with optional model configuration
- * @param {Object} options - Test options
- * @param {string|null} options.modelId - Model ID (format: repo_id:filename)
- * @param {Object|null} options.defaultConfig - Default configuration from TOML
- * @returns {Promise<void>}
- */
-declare function testGgmlSttCapabilities({
-  modelId,
-  defaultConfig
-}?: {
-  modelId: string | null;
-  defaultConfig: any | null;
-}): Promise<void>;
-declare namespace index_d_exports {
-  export { finalizeGenerator, generatorRegistry, getCapabilities, getModelIdentifier, ggmlLlm, ggmlStt, globalDownloadManager, mlxLlm, showModelsTable, showSttModelsTable, startGenerator, startModelDownload, status, testGgmlLlmCapabilities, testGgmlSttCapabilities };
-}
-declare function startGenerator(type: any, config: any): Promise<{
-  id: any;
-  info: any;
-}>;
-declare function finalizeGenerator(id: any): Promise<boolean>;
-declare function getModelIdentifier(type: any, config: any): any;
-declare namespace ggmlLlm {
-  function initContext(id: any, property: any): Promise<any>;
-  function completion(id: any, property: any): Promise<any>;
-  function tokenize(id: any, property: any): Promise<any>;
-  function detokenize(id: any, property: any): Promise<any>;
-  function applyChatTemplate(id: any, property: any): Promise<any>;
-  function releaseContext(id: any, property: any): Promise<any>;
-}
-declare namespace ggmlStt {
-  function initContext(id: any, property: any): Promise<any>;
-  function transcribe(id: any, property: any): Promise<any>;
-  function transcribeData(id: any, property: any): Promise<any>;
-  function releaseContext(id: any, property: any): Promise<any>;
-}
-declare namespace mlxLlm {
-  function initContext(id: any, property: any): Promise<any>;
-  function completion(id: any, property: any): Promise<any>;
-  function tokenize(id: any, property: any): Promise<any>;
-  function detokenize(id: any, property: any): Promise<any>;
-  function applyChatTemplate(id: any, property: any): Promise<any>;
-  function releaseContext(id: any, property: any): Promise<any>;
-}
-declare namespace status {
-  export function getFullStatus(): any;
-  export function getGgmlLlmStatus(): any;
-  export function getGgmlSttStatus(): any;
-  export function getMlxLlmStatus(): any;
-  export { subscribeToStatus };
-  export { subscribeToStatusWithId };
-  export { llmStatusTracker };
-  export { sttStatusTracker };
-  export { statusEmitter };
-}
-declare const generatorRegistry: Map<any, any>;
-declare namespace globalDownloadManager {
-  let downloads: Map<any, any>;
-  /**
-   * Get an existing download promise for a model path
-   * @param {string} localPath - The local path for the model
-   * @returns {Promise<void>|null} - The download promise or null if not downloading
-   */
-  function getDownload(localPath: string): Promise<void> | null;
-  /**
-   * Register a download promise for a model path
-   * @param {string} localPath - The local path for the model
-   * @param {Promise<void>} downloadPromise - The download promise
-   */
-  function setDownload(localPath: string, downloadPromise: Promise<void>): void;
-  /**
-   * Remove a download from tracking
-   * @param {string} localPath - The local path for the model
-   */
-  function deleteDownload(localPath: string): void;
-  /**
-   * Check if a model is currently being downloaded
-   * @param {string} localPath - The local path for the model
-   * @returns {boolean}
-   */
-  function isDownloading(localPath: string): boolean;
-  /**
-   * Get all active downloads
-   * @returns {Array<{localPath: string, promise: Promise<void>}>}
-   */
-  function getActiveDownloads(): Array<{
-    localPath: string;
-    promise: Promise<void>;
-  }>;
-}
-/**
- * Start downloading a model if download=true in config.
- * This function starts the download in the background and returns immediately.
- * The download will be tracked by the global download manager so that
- * initContext can wait for it if needed.
- *
- * @param {string} type - The generator type ('ggml-llm' or 'ggml-stt')
- * @param {Object} config - The generator configuration
- * @param {Object} options - Options for the download
- * @param {function} options.onProgress - Progress callback (0-1)
- * @param {function} options.onComplete - Called when download completes
- * @param {function} options.onError - Called on error
- * @returns {Promise<{started: boolean, localPath: string|null, repoId: string|null}>}
- */
-declare function startModelDownload(type: string, config: any, options?: {
-  onProgress: Function;
-  onComplete: Function;
-  onError: Function;
-}): Promise<{
-  started: boolean;
-  localPath: string | null;
-  repoId: string | null;
-}>;
-//#endregion
-//#region src/types.d.ts
-type HumanReadableUnit = number | string;
-type HumanReadableServerConfig = {
-  id?: string;
-  name?: string;
-  port?: number;
-  log_level?: 'debug' | 'info' | 'warn' | 'error';
-  max_body_size?: HumanReadableUnit;
-  session_timeout?: HumanReadableUnit;
-  temp_file_dir?: string;
-};
-type SessionCacheConfig = {
-  enabled?: boolean;
-  max_size_bytes?: HumanReadableUnit;
-  max_entries?: number;
-};
-type RuntimeConfig = {
-  cache_dir?: string;
-  huggingface_token?: string;
-  session_cache?: SessionCacheConfig;
-} & Record<string, any>;
-type GeneratorType = 'ggml-llm' | 'ggml-stt' | 'mlx-llm';
-type GeneratorConfig = {
-  type: GeneratorType;
-} & Record<string, any>;
-type GlobalConfig = {
-  runtime?: RuntimeConfig;
-  openai_compat?: {
-    enabled?: boolean;
-    cors_allowed_origins?: string | string[];
-  };
-  anthropic_messages?: {
-    enabled?: boolean;
-    cors_allowed_origins?: string | string[];
-  };
-} & Record<string, any>;
-type AutodiscoverConfig = {
-  udp: {
-    port?: number;
-    announcements: {
-      enabled: boolean;
-      interval?: number;
-    };
-    requests: {
-      enabled: boolean;
-      responseDelay?: number;
-    };
-  };
-  http: {
-    enabled: boolean;
-    path?: string;
-    cors?: boolean;
-  };
-  mdns?: {
-    enabled: boolean;
-  };
-};
-type HumanReadableConfig = {
-  autodiscover?: AutodiscoverConfig | boolean;
-  server?: HumanReadableServerConfig;
-  generators?: GeneratorConfig[];
-} & GlobalConfig;
-type ServerConfig = {
-  id: string;
-  name: string;
-  port: number;
-  log_level?: 'debug' | 'info' | 'warn' | 'error';
-  max_body_size: number;
-  session_timeout: number;
-  temp_file_dir: string;
-};
-type Config = {
-  autodiscover: AutodiscoverConfig | null;
-  server: ServerConfig;
-  global: GlobalConfig;
-  generators: GeneratorConfig[];
-};
-type GeneratorInfo = {
-  type: GeneratorType; /** Performance score 0–100 from buttress-hardware-guardrails. */
-  score?: number; /** Whether the host has an accelerator (GPU/Metal/etc) for this backend. */
-  hasGpu?: boolean; /** Usable memory in bytes for this backend (GPU when present, else CPU). */
-  usableBytes?: number;
-} & Record<string, any>;
-type ServerInfo = {
-  id: string;
-  name: string;
-  version: string;
-  address: string;
-  port: number;
-  url: string;
-  generators: GeneratorInfo[];
-  authentication: {
-    required: boolean;
-    type: string; /** Issuer key id (when type === 'workspace-jwt'). */
-    kid?: string; /** True when buttress is paired with a workspace. */
-    bound?: boolean;
-  }; /** Workspace identity (only present when paired). */
-  workspace?: {
-    id: string;
-    name?: string;
-  };
-};
-//#endregion
-//#region src/autodiscover/types.d.ts
-type GetServerInfoFn = () => ServerInfo;
-//#endregion
-//#region src/autodiscover/index.d.ts
-/**
- * Autodiscover service that manages discovery transports.
- * Currently supports UDP announcements/responses.
- * HTTP discovery is handled by the info route.
- */
-declare class AutodiscoverService {
-  private config;
-  private getServerInfo;
-  private transports;
-  private started;
-  constructor(config: AutodiscoverConfig, getServerInfo: GetServerInfoFn);
-  start(): Promise<void>;
-  stop(): Promise<void>;
-}
-//#endregion
-//#region src/utils/config.d.ts
-/**
- * Process raw user config (HumanReadableConfig) into Config.
- * Handles: device defaults, value normalization (bytes/ms), structure splitting.
- */
-declare const processConfig: (input: HumanReadableConfig | null) => Config;
-//#endregion
-//#region src/index.d.ts
-declare const checkForUpdates: () => Promise<string | null>;
-declare const compareVersions: (current: string, latest: string) => boolean;
-declare const logUpdateMessage: (latestVersion: string) => void;
-declare const checkAndNotifyUpdates: () => Promise<void>;
-type Backend = typeof index_d_exports;
-interface StartServerOptions {
-  backend?: Backend;
-  router?: AnyElysia;
-  config: Config;
-  enableOpenAICompat?: boolean;
-  enableAnthropicMessages?: boolean;
-}
-declare const createServer: ({
-  backend,
-  router,
-  config,
-  enableOpenAICompat,
-  enableAnthropicMessages
-}: StartServerOptions) => Promise<{
-  app: AnyElysia;
-  config: Config;
-}>;
-declare const startServer: ({
-  backend,
-  router,
-  config,
-  enableOpenAICompat,
-  enableAnthropicMessages
-}: StartServerOptions) => Promise<{
-  app: AnyElysia;
-  port: number;
-  openaiEnabled: boolean;
-  anthropicMessagesEnabled: boolean;
-  autoDiscover: AutodiscoverService | null;
-}>;
-//#endregion
-export { Backend, StartServerOptions, checkAndNotifyUpdates, checkForUpdates, compareVersions, createServer, logUpdateMessage, processConfig, startModelDownload, startServer };