@struktoai/mirage-core/dist/runtime/config.d.ts

A Unified Virtual Filesystem For AI Agents

/**
 * A runtime's `maxMemory` in bytes, null for no cap.
 *
 * Spelled as sandlock spells its own (`10M`, `512M`, `1G`), or a count of
 * bytes. Mirrors the Python `memory_limit`.
 *
 * Args:
 *   value: the setting as configured.
 *
 * Throws:
 *   Error: the setting is not a size.
 */
export declare function memoryLimit(value: string | number | null | undefined): number | null;
/** Constructor options every runtime accepts (a yaml entry's keys). */
export interface RuntimeOptions<C extends RuntimeConfig = Record<string, unknown>> {
    /**
     * Commands this runtime claims; EXTERNAL_COMMANDS (`@external`)
     * captures unresolved program names. WHOLE_LINE (`@line`) claims every
     * line for a line-executing runtime.
     */
    captures?: readonly string[];
    /**
     * The runtime's implementation knobs (a yaml entry's `config`
     * block), coerced against the runtime's own key list so a field the
     * runtime does not have fails loud.
     */
    config?: C;
}
/**
 * How a runtime's engine is set up: its implementation knobs.
 *
 * Every runtime is constructed the same way (captures, config); what
 * differs between runtimes lives here. In yaml this is
 * the runtime entry's `config` block, mirroring a mount's.
 *
 * The base names no field, because no knob is shared by every tier.
 * Python gets its fail-loud check from the dataclass (a field the
 * runtime does not have is a TypeError); TypeScript has no runtime
 * view of an interface, so each runtime hands the base its own key
 * list and coerceRuntimeConfig enforces it.
 */
export type RuntimeConfig = object;
/**
 * Config for runtimes whose engine lives in a directory or binary.
 *
 * Args:
 *   home: where the engine is (a wasm build dir, an interpreter
 *     path). Absent falls back to the runtime's own environment
 *     variable, then its built-in default.
 */
export interface HomeConfig extends RuntimeConfig {
    home?: string;
}
export declare const HOME_CONFIG_KEYS: readonly string[];
/**
 * Where a runtime's engine is: the config's `home`, else `envVar`'s value,
 * else undefined for the runtime's built-in default. Mirrors Python's
 * `resolve_home`.
 */
export declare function resolveHome(config: HomeConfig, envVar: string): string | undefined;
/**
 * A constructor's config option as the runtime's own config, mirroring
 * Python's RuntimeConfig.coerce: keys outside the runtime's list fail
 * loud (Python gets this from the dataclass raising TypeError; a TS
 * object spread would silently swallow a typo key without it).
 *
 * Args:
 *   value: the caller's config block, or undefined for the defaults.
 *   keys: the field names this runtime accepts.
 *   label: what to call the config in the failure message.
 */
export declare function coerceRuntimeConfig<C extends RuntimeConfig>(value: C | undefined, keys: readonly string[], label?: string): C;
//# sourceMappingURL=config.d.ts.map