@wenathlan/saddle 2.0.151 → 2.0.153

package/dist/modalityregistry.d.ts

@@ -0,0 +1,109 @@
+/** The boot cost classes the ladder measures. */
+export type BootClass = "hot" | "warm" | "cold";
+/** The isolation families the modalities group under. */
+export type ModalityFamily = "virtual" | "runner" | "packages" | "container" | "microvm" | "browser" | "mobile" | "confidential" | "emulator" | "pod" | "local" | "screen" | "wasm" | "fs" | "ram" | "delivery" | "language" | "sandbox" | "storage" | "network" | "build" | "ci" | "gpu";
+/**
+ * The honest wiring state of one modality — the truth ladder every record
+ * declares and every report reads:
+ * - live — the platform lanes drive it today: the run lane executes
+ *   through it or the storage lane stores through it;
+ * - host — the lane probes the host runtime and reports availability, the
+ *   execution wiring is the next rung;
+ * - planned — the declared catalog promise, no lane wires it yet and the
+ *   record never pretends otherwise.
+ */
+export type ModalityState = "live" | "host" | "planned";
+/** One sandbox modality of the registry. */
+export interface ModalityRecord {
+    /** The stable id the api and the config rows reference. */
+    id: string;
+    /** The display label (short, lowercase). */
+    label: string;
+    /** The isolation family the modality belongs to. */
+    family: ModalityFamily;
+    /** The isolation depth the family reaches (the capability contract). */
+    isolation: "process" | "namespace" | "vm" | "hardware";
+    /** The honest wiring state of the modality (the report never lies). */
+    state: ModalityState;
+    /** The driver modules the modality mounts when it boots. */
+    drivers: readonly string[];
+    /** The hardening gates the modality enforces by default. */
+    hardening: readonly string[];
+    /** The boot cost class (the measured budget lives in the boot ladder). */
+    boot: BootClass;
+    /** The measured boot budget in milliseconds (the ladder answers). */
+    bootms: number;
+    /** Whether the modality presents a gpu through the virtual drivers. */
+    gpu: boolean;
+    /** Whether the modality opens a network path (the hardened default is off). */
+    network: boolean;
+    /** The mime type the modality's api surface answers. */
+    mime: string;
+}
+/** The boot budgets of the ladder, per class: the ceilings the records walk
+ * under (firecracker 125 ms and gvisor about 200 ms ride warm, the full
+ * machine images ride cold). */
+export declare const BOOTLADDER: Readonly<Record<BootClass, number>>;
+/** The ninety modality plan: the count the owner charged (the ninety
+ * modalities of saddle acting for the system) and the registry answers —
+ * the catalog walked from twenty through forty to the ninety law, and
+ * this constant is the line the plan pins. */
+export declare const MODALITYPLANCOUNT = 90;
+/** The modality records: the catalog the join resolver reads. */
+export declare const MODALITIES: readonly ModalityRecord[];
+/** The honest plan report: what the catalog holds against the ninety
+ * plan —
+ * the counts per state and whether the plan is answered. The report is the
+ * truth surface the lanes and the tests read; it never counts a record as
+ * more than its state declares. */
+export interface ModalityPlanReport {
+    /** The plan line the owner charged (the ninety modalities). */
+    plancount: number;
+    /** The records the catalog holds. */
+    catalogcount: number;
+    /** The records the platform lanes drive today. */
+    live: number;
+    /** The records whose host runtime the lane probes. */
+    host: number;
+    /** The declared promises no lane wires yet. */
+    planned: number;
+    /** Whether the catalog answers the plan count. */
+    plananswered: boolean;
+}
+/** planreport — the honest census of the registry against the ninety plan:
+ * the counts per state and the plan verdict, computed from the records
+ * (never hardcoded, so the report cannot drift from the catalog). */
+export declare function planreport(): ModalityPlanReport;
+/** The base profiles the owner names (the config wave makes them editable). */
+export type BaseProfile = "max" | "balanced" | "lite";
+/** The join request: what the workload asks, never a modality name. */
+export interface JoinRequest {
+    /** The base profile the sandbox boots under. */
+    base: BaseProfile;
+    /** Whether the workload needs a gpu path through the virtual drivers. */
+    gpu: boolean;
+    /** Whether the workload needs a network path. */
+    network: boolean;
+    /** The isolation depth the workload demands at minimum. */
+    isolation?: ModalityRecord["isolation"];
+    /** The boot budget the workload tolerates, in milliseconds. */
+    bootbudget?: number;
+    /** The family the workload prefers (the first filter when given). */
+    family?: ModalityFamily;
+}
+/**
+ * Resolves the modality join for a request: the records that satisfy every
+ * demand, ordered by boot cost then isolation depth — the platform answers
+ * the join, the person never names a modality (the nuclear law).
+ *
+ * @param request the workload demands.
+ * @returns the modality records that satisfy the join, best candidate first.
+ */
+export declare function resolvejoin(request: JoinRequest): readonly ModalityRecord[];
+/**
+ * Answers one modality by id (the config rows and the api carry ids).
+ *
+ * @param id the modality id.
+ * @returns the record, or undefined when the id is unknown.
+ */
+export declare function getmodality(id: string): ModalityRecord | undefined;