@konstantdotcloud/boombox 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,423 @@
+import { z } from 'zod';
+import { Hono } from 'hono';
+import prompts from 'prompts';
+import { spawn } from 'node:child_process';
+
+declare const BOOMBOX_VERSION: string;
+
+declare const KonstantSectionSchema: z.ZodObject<{
+    tenant_id: z.ZodString;
+    api_key: z.ZodString;
+    gateway_url: z.ZodString;
+    api_key_id: z.ZodOptional<z.ZodString>;
+    api_key_expires_at: z.ZodOptional<z.ZodString>;
+    user_id: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    tenant_id: string;
+    api_key: string;
+    gateway_url: string;
+    api_key_id?: string | undefined;
+    api_key_expires_at?: string | undefined;
+    user_id?: string | undefined;
+}, {
+    tenant_id: string;
+    api_key: string;
+    gateway_url: string;
+    api_key_id?: string | undefined;
+    api_key_expires_at?: string | undefined;
+    user_id?: string | undefined;
+}>;
+declare const BoomboxSectionSchema: z.ZodObject<{
+    http_port: z.ZodDefault<z.ZodNumber>;
+    mcp_enabled: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    http_port: number;
+    mcp_enabled: boolean;
+}, {
+    http_port?: number | undefined;
+    mcp_enabled?: boolean | undefined;
+}>;
+declare const BoomboxConfigSchema: z.ZodObject<{
+    konstant: z.ZodObject<{
+        tenant_id: z.ZodString;
+        api_key: z.ZodString;
+        gateway_url: z.ZodString;
+        api_key_id: z.ZodOptional<z.ZodString>;
+        api_key_expires_at: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        tenant_id: string;
+        api_key: string;
+        gateway_url: string;
+        api_key_id?: string | undefined;
+        api_key_expires_at?: string | undefined;
+        user_id?: string | undefined;
+    }, {
+        tenant_id: string;
+        api_key: string;
+        gateway_url: string;
+        api_key_id?: string | undefined;
+        api_key_expires_at?: string | undefined;
+        user_id?: string | undefined;
+    }>;
+    boombox: z.ZodDefault<z.ZodObject<{
+        http_port: z.ZodDefault<z.ZodNumber>;
+        mcp_enabled: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        http_port: number;
+        mcp_enabled: boolean;
+    }, {
+        http_port?: number | undefined;
+        mcp_enabled?: boolean | undefined;
+    }>>;
+    runtime: z.ZodDefault<z.ZodObject<{
+        default_kind: z.ZodDefault<z.ZodEnum<["cloud", "vm", "local"]>>;
+        /** Mode 2 target URL, usually returned by provision-vm (e.g. https://tenant.exe.xyz/v2). */
+        vm_url: z.ZodOptional<z.ZodString>;
+        tenant_vm_host: z.ZodOptional<z.ZodString>;
+        tenant_vm_token: z.ZodOptional<z.ZodString>;
+        local_sandbox: z.ZodDefault<z.ZodEnum<["just-bash", "docker"]>>;
+        docker_image: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        default_kind: "cloud" | "vm" | "local";
+        local_sandbox: "just-bash" | "docker";
+        vm_url?: string | undefined;
+        tenant_vm_host?: string | undefined;
+        tenant_vm_token?: string | undefined;
+        docker_image?: string | undefined;
+    }, {
+        default_kind?: "cloud" | "vm" | "local" | undefined;
+        vm_url?: string | undefined;
+        tenant_vm_host?: string | undefined;
+        tenant_vm_token?: string | undefined;
+        local_sandbox?: "just-bash" | "docker" | undefined;
+        docker_image?: string | undefined;
+    }>>;
+    admin: z.ZodDefault<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+}, "strip", z.ZodTypeAny, {
+    konstant: {
+        tenant_id: string;
+        api_key: string;
+        gateway_url: string;
+        api_key_id?: string | undefined;
+        api_key_expires_at?: string | undefined;
+        user_id?: string | undefined;
+    };
+    boombox: {
+        http_port: number;
+        mcp_enabled: boolean;
+    };
+    runtime: {
+        default_kind: "cloud" | "vm" | "local";
+        local_sandbox: "just-bash" | "docker";
+        vm_url?: string | undefined;
+        tenant_vm_host?: string | undefined;
+        tenant_vm_token?: string | undefined;
+        docker_image?: string | undefined;
+    };
+    admin: {};
+}, {
+    konstant: {
+        tenant_id: string;
+        api_key: string;
+        gateway_url: string;
+        api_key_id?: string | undefined;
+        api_key_expires_at?: string | undefined;
+        user_id?: string | undefined;
+    };
+    boombox?: {
+        http_port?: number | undefined;
+        mcp_enabled?: boolean | undefined;
+    } | undefined;
+    runtime?: {
+        default_kind?: "cloud" | "vm" | "local" | undefined;
+        vm_url?: string | undefined;
+        tenant_vm_host?: string | undefined;
+        tenant_vm_token?: string | undefined;
+        local_sandbox?: "just-bash" | "docker" | undefined;
+        docker_image?: string | undefined;
+    } | undefined;
+    admin?: {} | undefined;
+}>;
+type BoomboxConfig = z.infer<typeof BoomboxConfigSchema>;
+type KonstantSection = z.infer<typeof KonstantSectionSchema>;
+type BoomboxSection = z.infer<typeof BoomboxSectionSchema>;
+
+declare class ConfigNotFoundError extends Error {
+    readonly path: string;
+    constructor(path: string);
+}
+declare class ConfigInvalidError extends Error {
+    readonly path: string;
+    readonly issues: string;
+    constructor(path: string, issues: string);
+}
+interface LoadConfigOptions {
+    path?: string;
+}
+declare function loadConfig(options?: LoadConfigOptions): BoomboxConfig;
+declare function tryLoadConfig(options?: LoadConfigOptions): BoomboxConfig | null;
+
+interface SaveConfigOptions {
+    path?: string;
+}
+declare function saveConfig(config: BoomboxConfig, options?: SaveConfigOptions): string;
+declare function renderConfigToml(config: BoomboxConfig): string;
+
+declare function getConfigDir(): string;
+declare function getConfigPath(): string;
+
+interface HttpServerHandle {
+    port: number;
+    close: () => Promise<void>;
+    url: string;
+}
+interface StartHttpOptions {
+    config?: BoomboxConfig;
+    getConfig?: () => BoomboxConfig;
+    onRevoked?: () => Promise<BoomboxConfig | null>;
+    port?: number;
+    host?: string;
+    fetchImpl?: typeof fetch;
+    uiDistPath?: string;
+    log?: (msg: string) => void;
+}
+interface BuildHttpOptions {
+    config?: BoomboxConfig;
+    getConfig?: () => BoomboxConfig;
+    onRevoked?: () => Promise<BoomboxConfig | null>;
+    fetchImpl?: typeof fetch;
+    uiDistPath?: string;
+    log?: (msg: string) => void;
+}
+declare function buildHttpApp(options: BuildHttpOptions): Hono;
+declare function startHttp(options: StartHttpOptions): Promise<HttpServerHandle>;
+
+interface BuildProxyOptions {
+    getConfig: () => BoomboxConfig;
+    fetchImpl?: typeof fetch;
+    onRevoked?: () => Promise<BoomboxConfig | null>;
+    log?: (msg: string) => void;
+}
+declare function buildProxy(options: BuildProxyOptions): Hono;
+
+declare function startStdioMcp(config: BoomboxConfig): Promise<void>;
+
+interface ServeOptions {
+    config?: BoomboxConfig;
+    getConfig?: () => BoomboxConfig;
+    onRevoked?: () => Promise<BoomboxConfig | null>;
+    mcp: boolean;
+    http: boolean;
+    port?: number;
+    host?: string;
+    log?: (msg: string) => void;
+}
+interface ServeHandle {
+    http?: HttpServerHandle;
+    mcp?: Promise<void>;
+}
+declare function serve(options: ServeOptions): Promise<ServeHandle>;
+
+interface InitOptions {
+    configPath?: string;
+    prompter?: typeof prompts;
+    fetchImpl?: typeof fetch;
+    skipVerify?: boolean;
+    log?: (msg: string) => void;
+    tenantId?: string;
+    apiKey?: string;
+    tenantApiKey?: string;
+    gatewayUrl?: string;
+    vmUrl?: string;
+    portkeyVirtualKey?: string;
+    fromEnrollPath?: string;
+}
+interface InitResult {
+    configPath: string;
+    config: BoomboxConfig;
+    verified: boolean;
+    whoami?: unknown;
+}
+declare function runInit(options?: InitOptions): Promise<InitResult>;
+
+interface ServeCliOptions {
+    mcp?: boolean;
+    http?: boolean;
+    port?: number;
+    profile?: 'default' | 'advanced' | 'operator';
+    configPath?: string;
+    log?: (msg: string) => void;
+}
+declare function runServe(options?: ServeCliOptions): Promise<void>;
+
+interface DoctorOptions {
+    configPath?: string;
+    fetchImpl?: typeof fetch;
+    log?: (msg: string) => void;
+}
+interface DoctorReport {
+    ok: boolean;
+    checks: DoctorCheck[];
+}
+interface DoctorCheck {
+    name: string;
+    ok: boolean;
+    detail: string;
+}
+declare function runDoctor(options?: DoctorOptions): Promise<DoctorReport>;
+
+interface AdminCliOptions {
+    configPath?: string;
+    cloudUrl?: string;
+    fetchImpl?: typeof fetch;
+    openBrowser?: (url: string) => Promise<unknown>;
+    log?: (msg: string) => void;
+}
+declare function runAdmin(options?: AdminCliOptions): Promise<string>;
+
+interface LoginOptions {
+    configPath?: string;
+    tenantId?: string;
+    cloudUrl?: string;
+    prompter?: typeof prompts;
+    fetchImpl?: typeof fetch;
+    openBrowser?: (url: string) => Promise<void>;
+    sleep?: (ms: number) => Promise<void>;
+    timeoutMs?: number;
+    pollIntervalMs?: number;
+    log?: (msg: string) => void;
+    errLog?: (msg: string) => void;
+    sessionId?: string;
+    verifier?: string;
+}
+declare function runLogin(options?: LoginOptions): Promise<BoomboxConfig>;
+
+interface UpgradeOptions {
+    /** Only report whether a newer version is available; do not install. */
+    check?: boolean;
+    /** Reinstall the latest even if already current. */
+    force?: boolean;
+    log?: (msg: string) => void;
+    errLog?: (msg: string) => void;
+    /** Test seam: resolve the latest published version (null if the registry is unreachable). */
+    fetchLatestVersion?: () => Promise<string | null>;
+    /** Test seam: install the latest globally; resolves to the process exit code. */
+    installLatest?: () => Promise<number>;
+    /** Test seam: override the running version. */
+    currentVersion?: string;
+    /** Test seam: override npx detection. */
+    isNpx?: boolean;
+}
+declare function runUpgrade(options?: UpgradeOptions): Promise<number>;
+
+interface ReloadCliOptions {
+    pidfilePath?: string;
+    log?: (msg: string) => void;
+    signaller?: (pid: number, signal: NodeJS.Signals) => void;
+    isAlive?: (pid: number) => boolean;
+}
+interface ReloadResult {
+    ok: boolean;
+    pid: number | null;
+    reason?: string;
+}
+declare function runReload(options?: ReloadCliOptions): Promise<ReloadResult>;
+
+interface StopCliOptions {
+    pidfilePath?: string;
+    timeoutMs?: number;
+    log?: (msg: string) => void;
+    signaller?: (pid: number, signal: NodeJS.Signals | 0) => void;
+    sleep?: (ms: number) => Promise<void>;
+    isAlive?: (pid: number) => boolean;
+}
+interface StopResult {
+    ok: boolean;
+    pid: number | null;
+    reason?: string;
+    forced?: boolean;
+}
+declare function runStop(options?: StopCliOptions): Promise<StopResult>;
+
+interface RestartCliOptions extends StopCliOptions {
+    detach?: boolean;
+    serveArgs?: string[];
+    binPath?: string;
+    spawnImpl?: typeof spawn;
+}
+interface RestartResult {
+    stopped: boolean;
+    spawnedPid: number | null;
+    reason?: string;
+}
+declare function runRestart(options?: RestartCliOptions): Promise<RestartResult>;
+
+type ConfigChangeListener = (next: BoomboxConfig, prev: BoomboxConfig) => void;
+interface ConfigStoreOptions {
+    /** Optional override for the config path (defaults to getConfigPath()). */
+    path?: string;
+    /** Initial config. If omitted, the store loads from disk eagerly. */
+    initial?: BoomboxConfig;
+    /** Override the loader (used in tests). */
+    loader?: (opts: LoadConfigOptions) => BoomboxConfig;
+    /** Override the fs watcher (used in tests). */
+    watcher?: (path: string, onChange: () => void) => () => void;
+    /** Debounce window for fs change events. Default: 200ms. */
+    debounceMs?: number;
+    /** Per-event log sink. */
+    log?: (msg: string) => void;
+}
+/**
+ * In-memory holder for the boombox runtime config.
+ *
+ * Supports:
+ *  - Synchronous reads via {@link getCurrent}
+ *  - Explicit reloads via {@link reload} (concurrent calls dedupe)
+ *  - File-watch driven reloads via {@link watch} / {@link unwatch}
+ *  - Listener notification on every successful reload
+ */
+declare class ConfigStore {
+    private readonly path;
+    private readonly loader;
+    private readonly watcherFactory;
+    private readonly debounceMs;
+    private readonly log;
+    private current;
+    private listeners;
+    private pendingReload;
+    private stopWatcher;
+    private debounceTimer;
+    constructor(options?: ConfigStoreOptions);
+    /** Synchronous accessor for the latest config. */
+    getCurrent(): BoomboxConfig;
+    getPath(): string;
+    /**
+     * Re-read the config from disk and atomically replace {@link current}.
+     * Concurrent callers share a single in-flight load (dedupe).
+     * On parse/validation failure, the existing config is kept and the error is
+     * re-thrown to the caller; listeners are NOT notified.
+     */
+    reload(): Promise<BoomboxConfig>;
+    /**
+     * Begin watching the config file. fs change events are debounced and trigger
+     * {@link reload}. Calls beyond the first are no-ops until {@link unwatch}.
+     */
+    watch(): void;
+    unwatch(): void;
+    onChange(listener: ConfigChangeListener): () => void;
+}
+
+interface PidfileRecord {
+    pid: number;
+    port: number;
+    started_at: string;
+    config_path: string;
+}
+declare function getPidfilePath(): string;
+declare function writePidfile(record: PidfileRecord, path?: string): string;
+declare function readPidfile(path?: string): PidfileRecord | null;
+declare function clearPidfile(path?: string): void;
+declare function isProcessAlive(pid: number): boolean;
+
+export { BOOMBOX_VERSION, type BoomboxConfig, BoomboxConfigSchema, type BoomboxSection, BoomboxSectionSchema, ConfigInvalidError, ConfigNotFoundError, ConfigStore, type KonstantSection, KonstantSectionSchema, type PidfileRecord, buildHttpApp, buildProxy, clearPidfile, getConfigDir, getConfigPath, getPidfilePath, isProcessAlive, loadConfig, readPidfile, renderConfigToml, runAdmin, runDoctor, runInit, runLogin, runReload, runRestart, runServe, runStop, runUpgrade, saveConfig, serve, startHttp, startStdioMcp, tryLoadConfig, writePidfile };