@claxedo/sandbox-manager 0.9.0 → 0.10.0

package/dist/drivers/boat.d.ts

@@ -0,0 +1,64 @@
+import { type SandboxDriver, type SandboxDriverEnsureInput } from "../contract";
+import { type WorkspaceRuntimeControlEnv } from "../runtime-env";
+import { type BoatFetch } from "./boat-client";
+export type { BoatFetch };
+/**
+ * A named snapshot of a machine that already holds `image`'s trees, stub and
+ * env, and Boat's record of the files the runtime opens first; another Boat
+ * account creates a sandbox from it with the share code.
+ */
+export type BoatRuntimeTemplate = {
+    image: string;
+    shareCode: string;
+};
+export declare function formatBoatRuntimeTemplate(template: BoatRuntimeTemplate): string;
+export declare function parseBoatRuntimeTemplate(setting: string): BoatRuntimeTemplate;
+export type BoatSandboxDriverOptions = {
+    apiKey: string;
+    baseUrl?: string;
+    image: string;
+    runtimePort?: number;
+    runtimeCommand?: string;
+    workspaceDir?: string;
+    nativeHarness?: string;
+    controlEnv?: WorkspaceRuntimeControlEnv;
+    /** Container name used for the runtime container inside the sandbox. */
+    containerName?: string;
+    /**
+     * Optional `docker login` before the pull, for a private runtime registry.
+     * Omit for public images.
+     */
+    registryAuth?: {
+        server: string;
+        username: string;
+        password: string;
+    };
+    /** Creates a sandbox that boots the template's image from the template instead of pulling and seeding the image. */
+    runtimeTemplate?: BoatRuntimeTemplate;
+    env?: (input: SandboxDriverEnsureInput, host: {
+        id: string;
+    }) => Record<string, string> | Promise<Record<string, string>>;
+    provisionTimeoutMs?: number;
+    /** The first and the longest wait between two reads of a sandbox's state, where Boat offers no wait. */
+    statePollMs?: {
+        firstMs: number;
+        maxMs: number;
+    };
+    healthTimeoutMs?: number;
+    healthIntervalMs?: number;
+    operationTimeoutMs?: number;
+    fetchImpl?: BoatFetch;
+};
+/**
+ * Turns a booted machine into one any workspace can start from: it keeps what
+ * every machine of the image shares (the image's trees, stub archive and env,
+ * and Boat's ~/.ascii/playbook.json) and removes what this machine's boot made
+ * (the runtime container and Boat's record and image archive of it, the
+ * workspace, the runtime's state, the boot's env). Nothing the runtime wrote
+ * into the image's trees was found there (Boat, 2026-10-16: the trees held only
+ * the image's own entries after two boots); what else differs on the machine
+ * is Boat's own, and a machine created from the template gets its own
+ * machine-id, SSH host keys, hostname and no hosted port.
+ */
+export declare function boatTemplateResetCommand(): string;
+export declare function createBoatSandboxDriver(options: BoatSandboxDriverOptions): SandboxDriver;