rightsize 0.2.0 → 0.4.0

package/dist/backend-msb/snapshot-import.js

@@ -0,0 +1,48 @@
+import * as path from "node:path";
+/**
+ * True if `stderr` (an `msb snapshot import` non-zero exit) names msb's own
+ * "this digest is already imported" signal, as opposed to some other import
+ * failure. Observed verbatim against the real msb 0.6.6 binary:
+ *
+ * ```
+ * error: snapshot already exists: <path>
+ * ```
+ *
+ * For a content-addressed archive this IS success — the artifact is already
+ * present under that digest either way — so `importCheckpoint` treats it as
+ * one rather than surfacing it. Deliberately a substring match on the stable
+ * prefix, the same reasoning `isSnapshotNotFoundError` applies to its own
+ * wording: the trailing path varies per host and msb has no structured/typed
+ * error for this.
+ */
+export function isSnapshotAlreadyExistsError(stderr) {
+    return stderr.includes("snapshot already exists");
+}
+/**
+ * Extracts the digest-dir basename from one `msb snapshot import`
+ * invocation's output. Verified against the real msb 0.6.6 binary: on both a
+ * success (the printed stdout line) and an already-exists failure (the
+ * `error: snapshot already exists: <path>` stderr line), the relevant line
+ * ENDS with the artifact path under `~/.microsandbox/snapshots/`, whose
+ * basename is the digest-derived directory name (e.g.
+ * `sha256-b9c0448ee9d54e33`) — never the original archive's own recorded
+ * ref. Callers pass whichever stream actually carries the signal (stdout on
+ * success, stderr on an already-exists failure). `undefined` means the
+ * output carried no recognizable trailing path — a shape this backend
+ * doesn't understand, which the caller turns into its own actionable error
+ * rather than guessing.
+ */
+export function parseImportedDigestDirName(output) {
+    const lines = output
+        .split("\n")
+        .map((line) => line.trim())
+        .filter((line) => line.length > 0);
+    const lastLine = lines.at(-1);
+    if (lastLine === undefined) {
+        return undefined;
+    }
+    const match = /(\S+)\s*$/.exec(lastLine);
+    const artifactPath = match?.[1];
+    return artifactPath === undefined ? undefined : path.basename(artifactPath);
+}
+//# sourceMappingURL=snapshot-import.js.map

package/dist/backend-msb/snapshot-import.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-import.js","sourceRoot":"","sources":["../../src/backend-msb/snapshot-import.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAAc;IACzD,OAAO,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAc;IACvD,MAAM,KAAK,GAAG,MAAM;SACjB,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAChC,OAAO,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AAC9E,CAAC"}

package/dist/backend-msb/snapshot-list.d.ts

@@ -0,0 +1,43 @@
+/**
+ * One `msb snapshot list --format json` entry, the fields
+ * `importCheckpoint`'s presence check actually reads. The current msb
+ * release's shape carries more fields than this (created/size/...); only
+ * `digest`, `name`, and `artifact_path` (snake_case on the wire) matter
+ * here, so everything else is ignored rather than modeled. `digest` itself
+ * is never returned as an effective ref (see `confirmDigestDirNamePresent`)
+ * — it is read only to skip a malformed/empty entry.
+ */
+export interface SnapshotListEntry {
+    readonly digest: string | undefined;
+    readonly name: string | undefined;
+    readonly artifactPath: string | undefined;
+}
+/**
+ * Parses `msb snapshot list --format json`'s array-of-objects output.
+ * Malformed/non-array JSON resolves to an empty list rather than throwing —
+ * the caller (`importCheckpoint`) already turns "digest not found" into its
+ * own actionable `BackendError`, so a parse failure here degrading to "found
+ * nothing" produces the same class of error rather than a confusing crash
+ * one level removed from the actual msb output.
+ */
+export declare function parseSnapshotList(json: string): SnapshotListEntry[];
+/**
+ * Confirms an imported snapshot's digest-dir basename (e.g.
+ * `sha256-b9c0448ee9d54e33`, parsed from `msb snapshot import`'s own
+ * output — see `snapshot-import.ts`) actually appears in `msb snapshot
+ * list`: an entry whose `name` equals `digestDirName` outright, or whose
+ * `artifact_path`'s basename does (`msb snapshot list` was verified to
+ * report both shapes depending on how the snapshot was created).
+ *
+ * Returns `digestDirName` itself once confirmed present — NOT the entry's
+ * `digest` field. Live-verified against msb 0.6.6: the full
+ * `sha256:<64hex>` digest does not resolve as a snapshot ref at all (`msb
+ * snapshot inspect sha256:<full>` fails "snapshot not found" — msb treats
+ * it as a literal path). Only the digest-dir name resolves for
+ * `inspect`/`rm`/`run --snapshot`, so it — not the `digest` field — is the
+ * effective ref `importCheckpoint` must hand back. `undefined` means no
+ * entry matched — the caller throws rather than returning an unconfirmed
+ * ref.
+ */
+export declare function confirmDigestDirNamePresent(entries: readonly SnapshotListEntry[], digestDirName: string): string | undefined;
+//# sourceMappingURL=snapshot-list.d.ts.map

package/dist/backend-msb/snapshot-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-list.d.ts","sourceRoot":"","sources":["../../src/backend-msb/snapshot-list.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAkBnE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,SAAS,iBAAiB,EAAE,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAO5H"}

package/dist/backend-msb/snapshot-list.js

@@ -0,0 +1,53 @@
+import * as path from "node:path";
+/**
+ * Parses `msb snapshot list --format json`'s array-of-objects output.
+ * Malformed/non-array JSON resolves to an empty list rather than throwing —
+ * the caller (`importCheckpoint`) already turns "digest not found" into its
+ * own actionable `BackendError`, so a parse failure here degrading to "found
+ * nothing" produces the same class of error rather than a confusing crash
+ * one level removed from the actual msb output.
+ */
+export function parseSnapshotList(json) {
+    let parsed;
+    try {
+        parsed = JSON.parse(json);
+    }
+    catch {
+        return [];
+    }
+    if (!Array.isArray(parsed)) {
+        return [];
+    }
+    return parsed.map((raw) => {
+        const rec = (typeof raw === "object" && raw !== null ? raw : {});
+        return {
+            digest: typeof rec["digest"] === "string" ? rec["digest"] : undefined,
+            name: typeof rec["name"] === "string" ? rec["name"] : undefined,
+            artifactPath: typeof rec["artifact_path"] === "string" ? rec["artifact_path"] : undefined,
+        };
+    });
+}
+/**
+ * Confirms an imported snapshot's digest-dir basename (e.g.
+ * `sha256-b9c0448ee9d54e33`, parsed from `msb snapshot import`'s own
+ * output — see `snapshot-import.ts`) actually appears in `msb snapshot
+ * list`: an entry whose `name` equals `digestDirName` outright, or whose
+ * `artifact_path`'s basename does (`msb snapshot list` was verified to
+ * report both shapes depending on how the snapshot was created).
+ *
+ * Returns `digestDirName` itself once confirmed present — NOT the entry's
+ * `digest` field. Live-verified against msb 0.6.6: the full
+ * `sha256:<64hex>` digest does not resolve as a snapshot ref at all (`msb
+ * snapshot inspect sha256:<full>` fails "snapshot not found" — msb treats
+ * it as a literal path). Only the digest-dir name resolves for
+ * `inspect`/`rm`/`run --snapshot`, so it — not the `digest` field — is the
+ * effective ref `importCheckpoint` must hand back. `undefined` means no
+ * entry matched — the caller throws rather than returning an unconfirmed
+ * ref.
+ */
+export function confirmDigestDirNamePresent(entries, digestDirName) {
+    const present = entries.some((entry) => entry.digest !== undefined &&
+        (entry.name === digestDirName || (entry.artifactPath !== undefined && path.basename(entry.artifactPath) === digestDirName)));
+    return present ? digestDirName : undefined;
+}
+//# sourceMappingURL=snapshot-list.js.map

package/dist/backend-msb/snapshot-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-list.js","sourceRoot":"","sources":["../../src/backend-msb/snapshot-list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAiBlC;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAqB,EAAE;QAC3C,MAAM,GAAG,GAAG,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAA4B,CAAC;QAC5F,OAAO;YACL,MAAM,EAAE,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;YACrE,IAAI,EAAE,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAC/D,YAAY,EAAE,OAAO,GAAG,CAAC,eAAe,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS;SAC1F,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,2BAA2B,CAAC,OAAqC,EAAE,aAAqB;IACtG,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAC1B,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,MAAM,KAAK,SAAS;QAC1B,CAAC,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,aAAa,CAAC,CAAC,CAC9H,CAAC;IACF,OAAO,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7C,CAAC"}

package/dist/backend-msb/snapshot-not-found.d.ts

@@ -0,0 +1,25 @@
+/**
+ * True if `output` (an `msb snapshot inspect <ref>` non-zero exit's stderr)
+ * names msb's own "this snapshot does not exist" signal, as opposed to some
+ * other probe failure. Observed verbatim against the real msb 0.6.6 binary:
+ *
+ * ```
+ * error: snapshot not found: <path>
+ * ```
+ *
+ * Only this exact framing may resolve `hasCheckpoint` to `false` — every
+ * other non-zero exit (a corrupted state db, a permission error, a
+ * malformed argument, an msb crash) must propagate as a thrown error
+ * instead. `Checkpoints.find` reacts to a `false` probe by best-effort
+ * deleting the registry entry as stale, so collapsing an unrelated,
+ * possibly transient msb failure into `false` here would silently evict a
+ * perfectly valid named checkpoint from the registry — exactly the
+ * "best-effort false on probe errors" the SPI's own contract forbids.
+ *
+ * Deliberately a substring match on the stable prefix rather than the full
+ * sentence — the trailing path varies per host, and msb has no structured/
+ * typed error for this, the same reasoning `isImageCacheCorruption` and
+ * `isMsbStateDbError` apply to their own wordings.
+ */
+export declare function isSnapshotNotFoundError(output: string): boolean;
+//# sourceMappingURL=snapshot-not-found.d.ts.map

package/dist/backend-msb/snapshot-not-found.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-not-found.d.ts","sourceRoot":"","sources":["../../src/backend-msb/snapshot-not-found.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE/D"}

package/dist/backend-msb/snapshot-not-found.js

@@ -0,0 +1,27 @@
+/**
+ * True if `output` (an `msb snapshot inspect <ref>` non-zero exit's stderr)
+ * names msb's own "this snapshot does not exist" signal, as opposed to some
+ * other probe failure. Observed verbatim against the real msb 0.6.6 binary:
+ *
+ * ```
+ * error: snapshot not found: <path>
+ * ```
+ *
+ * Only this exact framing may resolve `hasCheckpoint` to `false` — every
+ * other non-zero exit (a corrupted state db, a permission error, a
+ * malformed argument, an msb crash) must propagate as a thrown error
+ * instead. `Checkpoints.find` reacts to a `false` probe by best-effort
+ * deleting the registry entry as stale, so collapsing an unrelated,
+ * possibly transient msb failure into `false` here would silently evict a
+ * perfectly valid named checkpoint from the registry — exactly the
+ * "best-effort false on probe errors" the SPI's own contract forbids.
+ *
+ * Deliberately a substring match on the stable prefix rather than the full
+ * sentence — the trailing path varies per host, and msb has no structured/
+ * typed error for this, the same reasoning `isImageCacheCorruption` and
+ * `isMsbStateDbError` apply to their own wordings.
+ */
+export function isSnapshotNotFoundError(output) {
+    return output.includes("snapshot not found");
+}
+//# sourceMappingURL=snapshot-not-found.js.map

package/dist/backend-msb/snapshot-not-found.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-not-found.js","sourceRoot":"","sources":["../../src/backend-msb/snapshot-not-found.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAc;IACpD,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;AAC/C,CAAC"}

package/dist/core/backend.d.ts

@@ -64,10 +64,20 @@ export interface BackendCapabilities {
     readonly hardwareIsolated: boolean;
     /**
      * `true` when the backend can checkpoint/restore a sandbox's state
-     * (docker: commit-to-image; msb: no upstream microVM snapshot support
-     * yet). `GenericContainer.checkpoint()` demands `true`.
+     * (docker: commit-to-image; msb: disk snapshot via `msb snapshot`).
+     * `GenericContainer.checkpoint()` demands `true`.
      */
     readonly checkpoint: boolean;
+    /**
+     * `true` when a `checkpoint()` call on this backend restarts the
+     * sandbox's workload as a side effect of capturing state (msb: the
+     * stop/snapshot/reboot cycle boots a fresh microVM) — `false` when the
+     * sandbox is undisturbed (docker: commit-to-image never touches the
+     * running container). `GenericContainer.checkpoint()` re-runs the
+     * container's own wait strategy before returning exactly when this is
+     * `true`, so a caller never gets back a false-ready container.
+     */
+    readonly checkpointRestartsWorkload: boolean;
 }
 /**
  * The one interface every container backend implements. Host ports arrive
@@ -90,14 +100,70 @@ export interface SandboxBackend {
     /** Best-effort removal of the backend-native resource; callers swallow failures during teardown. */
     remove(handle: SandboxHandle): Promise<void>;
     /**
-     * Commits `handle`'s current filesystem to a new image tagged `imageRef` —
+     * Captures `handle`'s current state under `ref` —
      * `GenericContainer.checkpoint()`'s backend call, gated on
      * `capabilities.checkpoint` BEFORE this is ever reached, so an
      * unsupported backend never has to implement this for real (it may throw
-     * defensively). Docker: the engine's commit endpoint. Never called on a
-     * backend whose `capabilities.checkpoint` is `false`.
+     * defensively). Docker: commits the running container to image `ref`,
+     * undisturbed. Microsandbox: stop the sandbox, `msb snapshot create` a
+     * disk snapshot named `ref`, then start the sandbox back up — the
+     * workload restarts, which is why `capabilities.checkpointRestartsWorkload`
+     * exists. Never called on a backend whose `capabilities.checkpoint` is
+     * `false`.
+     */
+    createCheckpoint(handle: SandboxHandle, ref: string): Promise<void>;
+    /**
+     * Best-effort removal of a checkpoint identified by `ref` (docker: `rmi`;
+     * microsandbox: `msb snapshot rm`) — "not found" is success, the same
+     * contract as `removeByName`. SPI-only: there is no public
+     * `GenericContainer` method for this, only documented CLI one-liners for
+     * end users; it exists so tests can keep shared CI state clean.
+     */
+    removeCheckpoint(ref: string): Promise<void>;
+    /**
+     * Probes whether a checkpoint artifact identified by `ref` still exists —
+     * docker: image inspect; microsandbox: `msb snapshot inspect <ref>` exit
+     * code. `Checkpoints.find`'s only caller: it never probes an entry
+     * recorded under a DIFFERENT backend than the one this is called on, so in
+     * practice this is only ever invoked on a backend whose
+     * `capabilities.checkpoint` is `true`. A backend that never supports
+     * checkpoints at all may implement this by throwing
+     * `UnsupportedByBackendError`, the same defensive-throw convention
+     * `createCheckpoint` documents for that case. A probe FAILURE (the
+     * underlying call itself errors) must propagate — only a confirmed
+     * "does not exist" may resolve `false`; best-effort `false` on an error is
+     * not allowed.
      */
-    commitToImage(handle: SandboxHandle, imageRef: string): Promise<void>;
+    hasCheckpoint(ref: string): Promise<boolean>;
+    /**
+     * Writes this checkpoint's backend payload to `destFile` — the artifact
+     * step of `Checkpoints.exportTo`, byte-for-byte what the backend's own CLI
+     * produces (docker: `docker save -o <destFile> <ref>`; microsandbox:
+     * `msb snapshot export <ref> <destFile>`, never `--with-image` — see the
+     * checkpoints guide for why). Only ever called once the generic layer has
+     * already confirmed `ref` belongs to the ACTIVE backend and probed it
+     * exists via `hasCheckpoint`; a failure surfaces the underlying tool's
+     * stderr in a `BackendError`, the same convention `copyToContainer` uses.
+     */
+    exportCheckpoint(ref: string, destFile: string): Promise<void>;
+    /**
+     * Materializes an exported archive's backend payload from `srcFile` and
+     * returns the EFFECTIVE ref to use from here on — not necessarily `ref`
+     * itself. docker preserves the original tag on `docker load`, so its
+     * effective ref IS `ref`; microsandbox's `snapshot import` writes under a
+     * digest-derived DIRECTORY NAME (e.g. `sha256-b9c0448ee9d54e33`) it never
+     * lets the caller choose, so its effective ref is that directory name,
+     * confirmed present via `snapshot list --format json` — never the full
+     * `sha256:<64hex>` digest, which does not resolve as a snapshot ref at
+     * all. An already-exists failure for a content-addressed archive is
+     * treated as success. `ref` is the archive's own recorded ref (from
+     * `checkpoint.json`), passed through for backends (docker) that have no
+     * new ref to derive. Only ever called once the generic layer has already
+     * validated the archive's `checkpoint.json` (version, name, backend)
+     * against the active backend; any failure other than "already imported"
+     * surfaces the underlying tool's stderr in a `BackendError`.
+     */
+    importCheckpoint(srcFile: string, ref: string): Promise<string>;
     /**
      * Best-effort stop+remove of a sandbox identified by NAME rather than a
      * `SandboxHandle` — the reaping ledger only ever stores names (it must be
@@ -137,6 +203,20 @@ export interface SandboxBackend {
     removeNetwork(networkId: string): Promise<void>;
     /** Default no-op: docker relies on native networks. Only an emulating backend overrides it. */
     installNetworkLinks(handle: SandboxHandle, links: ReadonlyArray<NetworkLink>): Promise<void>;
+    /**
+     * Copies a host file or directory into the guest at `containerPath` — the
+     * TRANSFER step only. `GenericContainer.copyFileToContainer()` owns the
+     * running-check, the absolute-path check, and the `mkdir -p` pre-step (via
+     * `exec`) before this is ever called; this method does only the copy
+     * itself. `cp -r`-style destination naming: copying a directory to an
+     * absent destination path produces that path as a copy of the source's
+     * CONTENTS, not the source nested one level down — both backends' own
+     * copy tools already behave this way. A failure must carry the
+     * underlying tool's stderr in a `BackendError`, never a silent success.
+     */
+    copyToContainer(handle: SandboxHandle, hostPath: string, containerPath: string): Promise<void>;
+    /** The reverse direction of `copyToContainer` — see its own doc for the shared contract (transfer only, `cp -r`-style naming, stderr on failure). */
+    copyFromContainer(handle: SandboxHandle, containerPath: string, hostPath: string): Promise<void>;
     /** Best-effort teardown of backend-owned resources (sockets, child processes). */
     close(): Promise<void>;
     /**

package/dist/core/backend.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../../src/core/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;CAC9B;AAED,2FAA2F;AAC3F,MAAM,WAAW,YAAY;IAC3B,+HAA+H;IAC/H,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACrC,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,kJAAkJ;IAClJ,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0HAA0H;IAC1H,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACzC,wFAAwF;IACxF,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,8GAA8G;IAC9G,MAAM,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACpD,iKAAiK;IACjK,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,kEAAkE;IAClE,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,oGAAoG;IACpG,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;;;;;;OAOG;IACH,aAAa,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C;;;;;;;;;OASG;IACH,WAAW,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IACrE,gGAAgG;IAChG,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChD,iFAAiF;IACjF,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7E,0EAA0E;IAC1E,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC3F,yDAAyD;IACzD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,mEAAmE;IACnE,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,+FAA+F;IAC/F,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7F,kFAAkF;IAClF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,2FAA2F;IAC3F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2HAA2H;IAC3H,WAAW,IAAI,OAAO,CAAC;IACvB,8GAA8G;IAC9G,iBAAiB,IAAI,MAAM,CAAC;IAC5B,8EAA8E;IAC9E,MAAM,IAAI,cAAc,CAAC;CAC1B"}
+{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../../src/core/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;CAC9B;AAED,2FAA2F;AAC3F,MAAM,WAAW,YAAY;IAC3B,+HAA+H;IAC/H,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACrC,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,kJAAkJ;IAClJ,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B;;;;;;;;OAQG;IACH,QAAQ,CAAC,0BAA0B,EAAE,OAAO,CAAC;CAC9C;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0HAA0H;IAC1H,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACzC,wFAAwF;IACxF,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,8GAA8G;IAC9G,MAAM,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACpD,iKAAiK;IACjK,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,kEAAkE;IAClE,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,oGAAoG;IACpG,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE;;;;;;OAMG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C;;;;;;;;;OASG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAChE;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C;;;;;;;;;OASG;IACH,WAAW,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IACrE,gGAAgG;IAChG,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChD,iFAAiF;IACjF,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7E,0EAA0E;IAC1E,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC3F,yDAAyD;IACzD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,mEAAmE;IACnE,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,+FAA+F;IAC/F,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7F;;;;;;;;;;OAUG;IACH,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/F,qJAAqJ;IACrJ,iBAAiB,CAAC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjG,kFAAkF;IAClF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,2FAA2F;IAC3F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2HAA2H;IAC3H,WAAW,IAAI,OAAO,CAAC;IACvB,8GAA8G;IAC9G,iBAAiB,IAAI,MAAM,CAAC;IAC5B,8EAA8E;IAC9E,MAAM,IAAI,cAAc,CAAC;CAC1B"}

package/dist/core/checkpoint/api.d.ts

@@ -0,0 +1,129 @@
+import type { Checkpoint } from "../model.js";
+/**
+ * Rediscovers a named checkpoint written by an earlier `checkpoint(name)`
+ * call — in this process or an entirely different one, since the registry
+ * lives on disk under the shared rightsize cache directory. No entry for
+ * `name` resolves to `undefined`. A corrupt entry is treated the same as
+ * absent, with a best-effort delete of the bad file.
+ *
+ * When the entry's own recorded backend matches the CURRENTLY active
+ * backend, the underlying artifact is probed via the backend's
+ * `hasCheckpoint` SPI before this resolves — an artifact that's gone (removed
+ * by hand, or by something outside this library) makes the entry stale: it's
+ * best-effort deleted and this resolves to `undefined`, the same as if it
+ * had never existed. A probe FAILURE (the backend call itself throws) is
+ * never swallowed into a `false` — only a confirmed "does not exist"
+ * resolves that way, so a probe failure propagates out of this call.
+ *
+ * When the entry's recorded backend DIFFERS from the active one, this
+ * returns the entry unprobed — an msb ref means nothing to a docker probe
+ * and vice versa. `GenericContainer.fromCheckpoint(cp).start()`'s own
+ * `CheckpointBackendMismatchError` gate stays the sole authority for that
+ * mismatch; this function must not force-resolve a backend the host may not
+ * even have.
+ *
+ * `name` is validated against `CHECKPOINT_NAME_PATTERN` before anything else
+ * — including before the registry file is even looked up — so a `name`
+ * carrying `../` segments can never reach path construction; an invalid name
+ * throws `InvalidCheckpointNameError` and touches no file.
+ */
+export declare function find(name: string): Promise<Checkpoint | undefined>;
+/**
+ * Every named checkpoint currently in the registry — registry contents
+ * only, never probed against a backend (unlike `find`), so a stale entry
+ * whose artifact is gone still appears here until something calls `find` or
+ * `remove` on it. A corrupt entry is silently skipped, never removed (only
+ * `find`/`remove` clean those up, since `list` never resolves a single name
+ * the caller could target for a retry).
+ */
+export declare function list(): Promise<Checkpoint[]>;
+/**
+ * Deletes a named checkpoint: best-effort removal of the backend artifact
+ * (only when the entry's recorded backend matches the currently active
+ * one — this call never touches a backend that isn't active) plus the
+ * registry file, regardless of order of failure in either. Idempotent and
+ * always best-effort: "not found" anywhere (no registry entry at all) is
+ * success, reported as `false`; an existing entry — valid or corrupt —
+ * reports `true` once its registry file is gone.
+ *
+ * When the entry's recorded backend DIFFERS from the currently active one,
+ * only the registry record is deleted — the underlying artifact (the docker
+ * image, or the microsandbox snapshot) is left on disk PERMANENTLY, since
+ * this call never touches a backend that isn't active. Nothing in this
+ * library reclaims it automatically — and once the record is gone, a later
+ * `remove(name)` finds nothing to act on. Remove a checkpoint under its
+ * creating backend in the first place, or clean the leftover artifact
+ * directly with that backend's own CLI one-liner (see the
+ * [checkpoints guide](/guide/checkpoints#cleanup-checkpoints-are-not-auto-reaped)).
+ *
+ * `name` is validated against `CHECKPOINT_NAME_PATTERN` before anything else
+ * — including before the registry file is even looked up — so a `name`
+ * carrying `../` segments can never reach path construction; an invalid name
+ * throws `InvalidCheckpointNameError` and touches no file.
+ */
+export declare function remove(name: string): Promise<boolean>;
+/**
+ * Bundles `cp` into a self-describing archive at `destPath`: `checkpoint.json`
+ * (the pinned metadata — format version, this checkpoint's name if it was
+ * ever registered under one, ref, backend, creation time, and spec) plus an
+ * `artifact` member holding the backend's own payload, byte-for-byte what
+ * `SandboxBackend.exportCheckpoint` produces. See the
+ * [checkpoints guide](/guide/checkpoints#moving-checkpoints-between-machines)
+ * for the full CI-cache pattern this exists for.
+ *
+ * Requires the ACTIVE backend to equal `cp.backend` — the same
+ * `CheckpointBackendMismatchError` `fromCheckpoint(cp).start()` throws —
+ * before any backend or filesystem work. Then probes the artifact still
+ * exists via `hasCheckpoint`: exporting a stale checkpoint throws
+ * `CheckpointArtifactMissingError` rather than producing a broken archive.
+ * Only once both checks pass does this stage the export in a fresh unique
+ * temp directory (removed in a `finally` regardless of outcome) and tar it
+ * into `destPath` (parent directories created; a pre-existing file there is
+ * overwritten). Works on an ephemeral (unnamed) checkpoint too — the
+ * resulting archive just carries `name: null`.
+ */
+export declare function exportTo(cp: Checkpoint, destPath: string): Promise<void>;
+/**
+ * The inverse of `exportTo`: extracts `srcPath`, validates its
+ * `checkpoint.json` (format version, `name` against
+ * `CHECKPOINT_NAME_PATTERN` when non-null, backend against the ACTIVE
+ * backend — a `MalformedCheckpointArchiveError` or `CheckpointBackendMismatchError`
+ * either way, before any backend call or registry write), then hands the
+ * extracted `artifact` to `SandboxBackend.importCheckpoint`, which
+ * materializes it and returns the EFFECTIVE ref (docker: the same `ref` the
+ * archive recorded; microsandbox: the digest `snapshot import` actually
+ * assigned it — never necessarily the archive's own `ref`).
+ *
+ * A NAMED archive (`name` non-null) gets replace semantics matching
+ * `checkpoint(name)`: if a registry entry already exists for that name under
+ * a DIFFERENT ref and its recorded backend matches the active one, its old
+ * artifact is best-effort removed first (never a foreign-backend
+ * `removeCheckpoint` call — the same gate `remove()` applies); the registry
+ * entry is then written (or overwritten) with the effective ref. A NAMELESS
+ * archive writes no registry entry at all — the returned `Checkpoint` is
+ * purely ephemeral, the same as an unnamed `checkpoint()` call's result.
+ * Either way, the returned `Checkpoint` restores via the existing
+ * `fromCheckpoint()` path with zero changes — refs are opaque throughout
+ * this library.
+ */
+export declare function importFrom(srcPath: string): Promise<Checkpoint>;
+/**
+ * The library's entry point for rediscovering NAMED checkpoints across
+ * processes — see the [checkpoints guide](/guide/checkpoints#reusing-checkpoints-across-runs)
+ * for the `find(...) ?? seed()` first-run/later-run pattern this exists to
+ * support. Unnamed `checkpoint()` calls never appear here; only a
+ * `checkpoint(name)` call writes a registry entry these functions can find.
+ */
+export declare const Checkpoints: {
+    /** Rediscovers a named checkpoint — see `find` above. */
+    find: typeof find;
+    /** Every named checkpoint currently in the registry — see `list` above. */
+    list: typeof list;
+    /** Deletes a named checkpoint — see `remove` above. */
+    remove: typeof remove;
+    /** Bundles a checkpoint into a portable archive — see `exportTo` above. */
+    exportTo: typeof exportTo;
+    /** Materializes a portable archive on this machine — see `importFrom` above. */
+    importFrom: typeof importFrom;
+};
+//# sourceMappingURL=api.d.ts.map

package/dist/core/checkpoint/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/core/checkpoint/api.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAoB9C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAwBxE;AAED;;;;;;;GAOG;AACH,wBAAsB,IAAI,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAWlD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAmB3D;AAqBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,QAAQ,CAAC,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAsB9E;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAqCrE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;IACtB,yDAAyD;;IAEzD,2EAA2E;;IAE3E,uDAAuD;;IAEvD,2EAA2E;;IAE3E,gFAAgF;;CAEjF,CAAC"}