rightsize 0.2.0 → 0.4.0

package/dist/core/checkpoint/api.js

@@ -0,0 +1,261 @@
+import { cacheDir } from "../cache-dir.js";
+import { Backends } from "../backends.js";
+import { CheckpointArtifactMissingError, CheckpointBackendMismatchError } from "../errors.js";
+import { requireValidCheckpointName } from "./name.js";
+import { readCheckpointRegistry, removeCheckpointRegistryFile, writeCheckpointRegistryAtomic, listCheckpointNames, fromCheckpointRegistryEntry, toCheckpointRegistrySpec, } from "./registry.js";
+import { writeCheckpointArchive, readCheckpointArchive, CHECKPOINT_ARCHIVE_VERSION } from "./archive.js";
+/** Every field of a `Checkpoint` comes straight from the registry entry except `spec`, which is reconstructed via `fromCheckpointRegistryEntry` — see that function's own doc for what is and isn't meaningful in the result. */
+function toCheckpoint(entry) {
+    return { ref: entry.ref, backend: entry.backend, spec: fromCheckpointRegistryEntry(entry) };
+}
+/**
+ * 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 async function find(name) {
+    requireValidCheckpointName(name);
+    const dir = cacheDir();
+    const read = await readCheckpointRegistry(dir, name);
+    if (read.kind === "missing") {
+        return undefined;
+    }
+    if (read.kind === "corrupt") {
+        await removeCheckpointRegistryFile(dir, name);
+        return undefined;
+    }
+    const entry = read.entry;
+    const active = Backends.active();
+    if (entry.backend !== active.name) {
+        return toCheckpoint(entry);
+    }
+    const exists = await active.hasCheckpoint(entry.ref);
+    if (!exists) {
+        await removeCheckpointRegistryFile(dir, name);
+        return undefined;
+    }
+    return toCheckpoint(entry);
+}
+/**
+ * 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 async function list() {
+    const dir = cacheDir();
+    const names = await listCheckpointNames(dir);
+    const checkpoints = [];
+    for (const name of names) {
+        const read = await readCheckpointRegistry(dir, name);
+        if (read.kind === "found") {
+            checkpoints.push(toCheckpoint(read.entry));
+        }
+    }
+    return checkpoints;
+}
+/**
+ * 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 async function remove(name) {
+    requireValidCheckpointName(name);
+    const dir = cacheDir();
+    const read = await readCheckpointRegistry(dir, name);
+    if (read.kind === "missing") {
+        return false;
+    }
+    if (read.kind === "corrupt") {
+        await removeCheckpointRegistryFile(dir, name);
+        return true;
+    }
+    const entry = read.entry;
+    const active = Backends.active();
+    if (entry.backend === active.name) {
+        await active.removeCheckpoint(entry.ref).catch(() => { });
+    }
+    await removeCheckpointRegistryFile(dir, name);
+    return true;
+}
+/**
+ * Reverse lookup: the registry entry (if any) whose `ref`/`backend` match a
+ * `Checkpoint`'s own — `exportTo`'s only way to learn whether the checkpoint
+ * it's given was ever named, and under what name, since a `Checkpoint`
+ * object itself never carries one (see `toCheckpoint` above). Scans every
+ * registered name the same way `list()` does; a corrupt entry is silently
+ * skipped, matching `list()`'s own tolerance.
+ */
+async function findRegistryEntryByRef(dir, ref, backend) {
+    const names = await listCheckpointNames(dir);
+    for (const name of names) {
+        const read = await readCheckpointRegistry(dir, name);
+        if (read.kind === "found" && read.entry.ref === ref && read.entry.backend === backend) {
+            return read.entry;
+        }
+    }
+    return undefined;
+}
+/**
+ * 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 async function exportTo(cp, destPath) {
+    const active = Backends.active();
+    if (cp.backend !== active.name) {
+        throw new CheckpointBackendMismatchError(cp.backend, active.name);
+    }
+    const exists = await active.hasCheckpoint(cp.ref);
+    if (!exists) {
+        throw new CheckpointArtifactMissingError(cp.ref, cp.backend);
+    }
+    const dir = cacheDir();
+    const registryEntry = await findRegistryEntryByRef(dir, cp.ref, cp.backend);
+    const metadata = {
+        rightsizeArchive: CHECKPOINT_ARCHIVE_VERSION,
+        name: registryEntry?.name ?? null,
+        ref: cp.ref,
+        backend: cp.backend,
+        createdIso: registryEntry?.createdIso ?? new Date().toISOString(),
+        spec: toCheckpointRegistrySpec(cp.spec),
+    };
+    await writeCheckpointArchive(destPath, metadata, (artifactPath) => active.exportCheckpoint(cp.ref, artifactPath));
+}
+/**
+ * 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 async function importFrom(srcPath) {
+    const active = Backends.active();
+    return readCheckpointArchive(srcPath, async (metadata, artifactPath) => {
+        if (metadata.name !== null) {
+            requireValidCheckpointName(metadata.name);
+        }
+        if (metadata.backend !== active.name) {
+            throw new CheckpointBackendMismatchError(metadata.backend, active.name);
+        }
+        const effectiveRef = await active.importCheckpoint(artifactPath, metadata.ref);
+        const spec = fromCheckpointRegistryEntry({
+            name: metadata.name ?? "",
+            ref: effectiveRef,
+            backend: active.name,
+            createdIso: metadata.createdIso,
+            spec: metadata.spec,
+        });
+        if (metadata.name !== null) {
+            const dir = cacheDir();
+            const existing = await readCheckpointRegistry(dir, metadata.name);
+            if (existing.kind === "found" && existing.entry.ref !== effectiveRef && existing.entry.backend === active.name) {
+                await active.removeCheckpoint(existing.entry.ref).catch(() => { });
+            }
+            const entry = {
+                name: metadata.name,
+                ref: effectiveRef,
+                backend: active.name,
+                createdIso: metadata.createdIso,
+                spec: metadata.spec,
+            };
+            await writeCheckpointRegistryAtomic(dir, metadata.name, entry);
+        }
+        return { ref: effectiveRef, backend: active.name, spec };
+    });
+}
+/**
+ * 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 const Checkpoints = {
+    /** Rediscovers a named checkpoint — see `find` above. */
+    find,
+    /** Every named checkpoint currently in the registry — see `list` above. */
+    list,
+    /** Deletes a named checkpoint — see `remove` above. */
+    remove,
+    /** Bundles a checkpoint into a portable archive — see `exportTo` above. */
+    exportTo,
+    /** Materializes a portable archive on this machine — see `importFrom` above. */
+    importFrom,
+};
+//# sourceMappingURL=api.js.map

package/dist/core/checkpoint/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/core/checkpoint/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,8BAA8B,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,6BAA6B,EAC7B,mBAAmB,EACnB,2BAA2B,EAC3B,wBAAwB,GAEzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAGzG,iOAAiO;AACjO,SAAS,YAAY,CAAC,KAA8B;IAClD,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,2BAA2B,CAAC,KAAK,CAAC,EAAE,CAAC;AAC9F,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAY;IACrC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,QAAQ,EAAE,CAAC;IACvB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,4BAA4B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjC,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QAClC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,4BAA4B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI;IACxB,MAAM,GAAG,GAAG,QAAQ,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAY;IACvC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,QAAQ,EAAE,CAAC;IACvB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,4BAA4B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjC,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QAClC,MAAM,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,4BAA4B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,sBAAsB,CAAC,GAAW,EAAE,GAAW,EAAE,OAAe;IAC7E,MAAM,KAAK,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC7C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACtF,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,EAAc,EAAE,QAAgB;IAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,OAAO,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,IAAI,8BAA8B,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,8BAA8B,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,EAAE,CAAC;IACvB,MAAM,aAAa,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAA8B;QAC1C,gBAAgB,EAAE,0BAA0B;QAC5C,IAAI,EAAE,aAAa,EAAE,IAAI,IAAI,IAAI;QACjC,GAAG,EAAE,EAAE,CAAC,GAAG;QACX,OAAO,EAAE,EAAE,CAAC,OAAO;QACnB,UAAU,EAAE,aAAa,EAAE,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACjE,IAAI,EAAE,wBAAwB,CAAC,EAAE,CAAC,IAAI,CAAC;KACxC,CAAC;IAEF,MAAM,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;AACpH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAe;IAC9C,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjC,OAAO,qBAAqB,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE;QACrE,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC3B,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;YACrC,MAAM,IAAI,8BAA8B,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC/E,MAAM,IAAI,GAAG,2BAA2B,CAAC;YACvC,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,EAAE;YACzB,GAAG,EAAE,YAAY;YACjB,OAAO,EAAE,MAAM,CAAC,IAAI;YACpB,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,QAAQ,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClE,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,IAAI,QAAQ,CAAC,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC/G,MAAM,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACpE,CAAC;YACD,MAAM,KAAK,GAA4B;gBACrC,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,MAAM,CAAC,IAAI;gBACpB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB,CAAC;YACF,MAAM,6BAA6B,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,yDAAyD;IACzD,IAAI;IACJ,2EAA2E;IAC3E,IAAI;IACJ,uDAAuD;IACvD,MAAM;IACN,2EAA2E;IAC3E,QAAQ;IACR,gFAAgF;IAChF,UAAU;CACX,CAAC"}

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

@@ -0,0 +1,52 @@
+import type { CheckpointRegistrySpec } from "./registry.js";
+/** The one archive format version this library understands — pinned identically across every rightsize language implementation. */
+export declare const CHECKPOINT_ARCHIVE_VERSION = 1;
+/**
+ * `checkpoint.json`'s exact shape — pinned identically in every rightsize
+ * language implementation. `name` is `null` for an archive built from an
+ * unnamed (ephemeral) checkpoint; every other field mirrors
+ * `CheckpointRegistryEntry` plus the format version.
+ */
+export interface CheckpointArchiveMetadata {
+    readonly rightsizeArchive: 1;
+    readonly name: string | null;
+    readonly ref: string;
+    readonly backend: string;
+    readonly createdIso: string;
+    readonly spec: CheckpointRegistrySpec;
+}
+/**
+ * Parses and validates `text` (the extracted archive's `checkpoint.json`
+ * content) into a `CheckpointArchiveMetadata`. Every failure — invalid JSON,
+ * a `rightsizeArchive` value other than `CHECKPOINT_ARCHIVE_VERSION` (named
+ * in the thrown error, per the pinned format's own contract), a malformed
+ * `name`/`ref`/`backend`/`createdIso`/`spec` — throws
+ * `MalformedCheckpointArchiveError` naming `archivePath` (the ORIGINAL
+ * archive the caller passed to `importFrom`, not the temp-extracted json
+ * path, so the error is actionable). Never touches a backend or the
+ * registry — pure parsing.
+ */
+export declare function parseCheckpointArchiveMetadata(text: string, archivePath: string): CheckpointArchiveMetadata;
+/**
+ * Builds a checkpoint archive at `destPath`: stages `checkpoint.json` and an
+ * `artifact` file (written by `exportArtifact`, the backend's own
+ * `exportCheckpoint` call) in a fresh temp directory, then tars exactly
+ * those two members at the archive's root — never nested under the temp
+ * dir's own path. `destPath`'s parent directories are created first; a
+ * pre-existing file at `destPath` is overwritten (tar's own default
+ * behavior). The temp directory is removed in a `finally`, on success and on
+ * failure alike.
+ */
+export declare function writeCheckpointArchive(destPath: string, metadata: CheckpointArchiveMetadata, exportArtifact: (artifactPath: string) => Promise<void>): Promise<void>;
+/**
+ * Extracts `srcPath` into a fresh temp directory, parses and validates
+ * `checkpoint.json` (see `parseCheckpointArchiveMetadata`), confirms the
+ * `artifact` member is present, then hands both to `importArtifact` — the
+ * caller's own backend/registry validation and `importCheckpoint` call —
+ * before the temp directory is removed in a `finally`. `srcPath` not
+ * existing, or not being a valid tar, or missing its `checkpoint.json`
+ * member each throw `MalformedCheckpointArchiveError` naming `srcPath`
+ * itself, before any backend call.
+ */
+export declare function readCheckpointArchive<T>(srcPath: string, importArtifact: (metadata: CheckpointArchiveMetadata, artifactPath: string) => Promise<T>): Promise<T>;
+//# sourceMappingURL=archive.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"archive.d.ts","sourceRoot":"","sources":["../../../src/core/checkpoint/archive.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAG5D,mIAAmI;AACnI,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAU5C;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACvC;AAWD;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,yBAAyB,CAwC3G;AAED;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,yBAAyB,EACnC,cAAc,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GACtD,OAAO,CAAC,IAAI,CAAC,CAkBf;AAED;;;;;;;;;GASG;AACH,wBAAsB,qBAAqB,CAAC,CAAC,EAC3C,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,CAAC,QAAQ,EAAE,yBAAyB,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,GACxF,OAAO,CAAC,CAAC,CAAC,CAsCZ"}

package/dist/core/checkpoint/archive.js

@@ -0,0 +1,134 @@
+import * as fsp from "node:fs/promises";
+import * as os from "node:os";
+import * as path from "node:path";
+import { BackendError, MalformedCheckpointArchiveError } from "../errors.js";
+import { isCheckpointRegistrySpec } from "./registry.js";
+import { TarCli, runTar } from "./tar-cli.js";
+/** The one archive format version this library understands — pinned identically across every rightsize language implementation. */
+export const CHECKPOINT_ARCHIVE_VERSION = 1;
+/**
+ * An archive bundles a full backend artifact (a zstd-compressed msb snapshot
+ * or a saved docker image) — generous relative to a plain `msb copy`/`docker
+ * cp`, matching the backend's own export/import budget for the payload
+ * itself.
+ */
+const ARCHIVE_TAR_TIMEOUT_MS = 300_000;
+async function withTempDir(prefix, fn) {
+    const dir = await fsp.mkdtemp(path.join(os.tmpdir(), prefix));
+    try {
+        return await fn(dir);
+    }
+    finally {
+        await fsp.rm(dir, { recursive: true, force: true });
+    }
+}
+/**
+ * Parses and validates `text` (the extracted archive's `checkpoint.json`
+ * content) into a `CheckpointArchiveMetadata`. Every failure — invalid JSON,
+ * a `rightsizeArchive` value other than `CHECKPOINT_ARCHIVE_VERSION` (named
+ * in the thrown error, per the pinned format's own contract), a malformed
+ * `name`/`ref`/`backend`/`createdIso`/`spec` — throws
+ * `MalformedCheckpointArchiveError` naming `archivePath` (the ORIGINAL
+ * archive the caller passed to `importFrom`, not the temp-extracted json
+ * path, so the error is actionable). Never touches a backend or the
+ * registry — pure parsing.
+ */
+export function parseCheckpointArchiveMetadata(text, archivePath) {
+    let parsed;
+    try {
+        parsed = JSON.parse(text);
+    }
+    catch {
+        throw new MalformedCheckpointArchiveError(archivePath, "checkpoint.json is not valid JSON");
+    }
+    if (typeof parsed !== "object" || parsed === null) {
+        throw new MalformedCheckpointArchiveError(archivePath, "checkpoint.json is not a JSON object");
+    }
+    const rec = parsed;
+    if (rec["rightsizeArchive"] !== CHECKPOINT_ARCHIVE_VERSION) {
+        throw new MalformedCheckpointArchiveError(archivePath, `unsupported rightsizeArchive version ${JSON.stringify(rec["rightsizeArchive"])} (this library reads version ${CHECKPOINT_ARCHIVE_VERSION})`);
+    }
+    const name = rec["name"];
+    if (name !== null && typeof name !== "string") {
+        throw new MalformedCheckpointArchiveError(archivePath, "checkpoint.json's 'name' field must be a string or null");
+    }
+    if (typeof rec["ref"] !== "string" || typeof rec["backend"] !== "string" || typeof rec["createdIso"] !== "string") {
+        throw new MalformedCheckpointArchiveError(archivePath, "checkpoint.json is missing one of the required string fields 'ref', 'backend', 'createdIso'");
+    }
+    if (!isCheckpointRegistrySpec(rec["spec"])) {
+        throw new MalformedCheckpointArchiveError(archivePath, "checkpoint.json's 'spec' field is missing or malformed");
+    }
+    return {
+        rightsizeArchive: 1,
+        name,
+        ref: rec["ref"],
+        backend: rec["backend"],
+        createdIso: rec["createdIso"],
+        spec: rec["spec"],
+    };
+}
+/**
+ * Builds a checkpoint archive at `destPath`: stages `checkpoint.json` and an
+ * `artifact` file (written by `exportArtifact`, the backend's own
+ * `exportCheckpoint` call) in a fresh temp directory, then tars exactly
+ * those two members at the archive's root — never nested under the temp
+ * dir's own path. `destPath`'s parent directories are created first; a
+ * pre-existing file at `destPath` is overwritten (tar's own default
+ * behavior). The temp directory is removed in a `finally`, on success and on
+ * failure alike.
+ */
+export async function writeCheckpointArchive(destPath, metadata, exportArtifact) {
+    await fsp.mkdir(path.dirname(destPath), { recursive: true });
+    await withTempDir("rightsize-checkpoint-export-", async (workDir) => {
+        const artifactPath = path.join(workDir, "artifact");
+        await exportArtifact(artifactPath);
+        await fsp.writeFile(path.join(workDir, "checkpoint.json"), JSON.stringify(metadata));
+        const result = await runTar(TarCli.create(path.basename(destPath), workDir, ["checkpoint.json", "artifact"]), ARCHIVE_TAR_TIMEOUT_MS, path.dirname(destPath));
+        if (result.exitCode !== 0) {
+            throw new BackendError(`tar could not create checkpoint archive '${destPath}' (exit ${result.exitCode}): ${result.stderr.trim()}`);
+        }
+    });
+}
+/**
+ * Extracts `srcPath` into a fresh temp directory, parses and validates
+ * `checkpoint.json` (see `parseCheckpointArchiveMetadata`), confirms the
+ * `artifact` member is present, then hands both to `importArtifact` — the
+ * caller's own backend/registry validation and `importCheckpoint` call —
+ * before the temp directory is removed in a `finally`. `srcPath` not
+ * existing, or not being a valid tar, or missing its `checkpoint.json`
+ * member each throw `MalformedCheckpointArchiveError` naming `srcPath`
+ * itself, before any backend call.
+ */
+export async function readCheckpointArchive(srcPath, importArtifact) {
+    const exists = await fsp
+        .stat(srcPath)
+        .then((s) => s.isFile())
+        .catch(() => false);
+    if (!exists) {
+        throw new MalformedCheckpointArchiveError(srcPath, "the file does not exist");
+    }
+    return withTempDir("rightsize-checkpoint-import-", async (workDir) => {
+        const extracted = await runTar(TarCli.extract(path.basename(srcPath), workDir), ARCHIVE_TAR_TIMEOUT_MS, path.dirname(srcPath));
+        if (extracted.exitCode !== 0) {
+            throw new MalformedCheckpointArchiveError(srcPath, `not a valid tar archive: ${extracted.stderr.trim()}`);
+        }
+        let text;
+        try {
+            text = await fsp.readFile(path.join(workDir, "checkpoint.json"), "utf8");
+        }
+        catch {
+            throw new MalformedCheckpointArchiveError(srcPath, "missing checkpoint.json");
+        }
+        const metadata = parseCheckpointArchiveMetadata(text, srcPath);
+        const artifactPath = path.join(workDir, "artifact");
+        const hasArtifact = await fsp
+            .stat(artifactPath)
+            .then(() => true)
+            .catch(() => false);
+        if (!hasArtifact) {
+            throw new MalformedCheckpointArchiveError(srcPath, "missing artifact");
+        }
+        return importArtifact(metadata, artifactPath);
+    });
+}
+//# sourceMappingURL=archive.js.map

package/dist/core/checkpoint/archive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"archive.js","sourceRoot":"","sources":["../../../src/core/checkpoint/archive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAC;AACxC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,+BAA+B,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE9C,mIAAmI;AACnI,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAiBvC,KAAK,UAAU,WAAW,CAAI,MAAc,EAAE,EAA+B;IAC3E,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9D,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;YAAS,CAAC;QACT,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,8BAA8B,CAAC,IAAY,EAAE,WAAmB;IAC9E,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,+BAA+B,CAAC,WAAW,EAAE,mCAAmC,CAAC,CAAC;IAC9F,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,+BAA+B,CAAC,WAAW,EAAE,sCAAsC,CAAC,CAAC;IACjG,CAAC;IACD,MAAM,GAAG,GAAG,MAAiC,CAAC;IAE9C,IAAI,GAAG,CAAC,kBAAkB,CAAC,KAAK,0BAA0B,EAAE,CAAC;QAC3D,MAAM,IAAI,+BAA+B,CACvC,WAAW,EACX,wCAAwC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,gCAAgC,0BAA0B,GAAG,CAC7I,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9C,MAAM,IAAI,+BAA+B,CAAC,WAAW,EAAE,yDAAyD,CAAC,CAAC;IACpH,CAAC;IACD,IAAI,OAAO,GAAG,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QAClH,MAAM,IAAI,+BAA+B,CACvC,WAAW,EACX,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,+BAA+B,CAAC,WAAW,EAAE,wDAAwD,CAAC,CAAC;IACnH,CAAC;IAED,OAAO;QACL,gBAAgB,EAAE,CAAC;QACnB,IAAI;QACJ,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC;QACf,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC;QACvB,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC;QAC7B,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC;KAClB,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,QAAgB,EAChB,QAAmC,EACnC,cAAuD;IAEvD,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,MAAM,WAAW,CAAC,8BAA8B,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QAClE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACpD,MAAM,cAAc,CAAC,YAAY,CAAC,CAAC;QACnC,MAAM,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QAErF,MAAM,MAAM,GAAG,MAAM,MAAM,CACzB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC,EAChF,sBAAsB,EACtB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CACvB,CAAC;QACF,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CACpB,4CAA4C,QAAQ,WAAW,MAAM,CAAC,QAAQ,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAC3G,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAAe,EACf,cAAyF;IAEzF,MAAM,MAAM,GAAG,MAAM,GAAG;SACrB,IAAI,CAAC,OAAO,CAAC;SACb,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACvB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IACtB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,+BAA+B,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;IAChF,CAAC;IAED,OAAO,WAAW,CAAC,8BAA8B,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACnE,MAAM,SAAS,GAAG,MAAM,MAAM,CAC5B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAC/C,sBAAsB,EACtB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CACtB,CAAC;QACF,IAAI,SAAS,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,+BAA+B,CAAC,OAAO,EAAE,4BAA4B,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC5G,CAAC;QAED,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC;QAC3E,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,+BAA+B,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;QAChF,CAAC;QACD,MAAM,QAAQ,GAAG,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE/D,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,MAAM,GAAG;aAC1B,IAAI,CAAC,YAAY,CAAC;aAClB,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACtB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,+BAA+B,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QACzE,CAAC;QAED,OAAO,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,12 @@
+/**
+ * Pinned identically across every rightsize language implementation (see the
+ * named-checkpoints spec's own "Names and refs" section): lowercase letters,
+ * digits, and hyphens only, starting with a letter or digit, at most 41
+ * characters. This is also exactly the alphabet both backends' ref formats
+ * embed verbatim (`rz-ckpt-<name>`, `rightsize/checkpoint:<name>`), so a
+ * valid name is guaranteed to produce a valid ref on either backend.
+ */
+export declare const CHECKPOINT_NAME_PATTERN: RegExp;
+/** Fails fast — before any backend or filesystem call — on a `name` that doesn't match `CHECKPOINT_NAME_PATTERN`. */
+export declare function requireValidCheckpointName(name: string): void;
+//# sourceMappingURL=name.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"name.d.ts","sourceRoot":"","sources":["../../../src/core/checkpoint/name.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,QAA8B,CAAC;AAEnE,qHAAqH;AACrH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAI7D"}

package/dist/core/checkpoint/name.js

@@ -0,0 +1,17 @@
+import { InvalidCheckpointNameError } from "../errors.js";
+/**
+ * Pinned identically across every rightsize language implementation (see the
+ * named-checkpoints spec's own "Names and refs" section): lowercase letters,
+ * digits, and hyphens only, starting with a letter or digit, at most 41
+ * characters. This is also exactly the alphabet both backends' ref formats
+ * embed verbatim (`rz-ckpt-<name>`, `rightsize/checkpoint:<name>`), so a
+ * valid name is guaranteed to produce a valid ref on either backend.
+ */
+export const CHECKPOINT_NAME_PATTERN = /^[a-z0-9][a-z0-9-]{0,40}$/;
+/** Fails fast — before any backend or filesystem call — on a `name` that doesn't match `CHECKPOINT_NAME_PATTERN`. */
+export function requireValidCheckpointName(name) {
+    if (!CHECKPOINT_NAME_PATTERN.test(name)) {
+        throw new InvalidCheckpointNameError(name);
+    }
+}
+//# sourceMappingURL=name.js.map

package/dist/core/checkpoint/name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"name.js","sourceRoot":"","sources":["../../../src/core/checkpoint/name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,2BAA2B,CAAC;AAEnE,qHAAqH;AACrH,MAAM,UAAU,0BAA0B,CAAC,IAAY;IACrD,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,12 @@
+/**
+ * Mints the backend-specific checkpoint ref: `rz-ckpt-<suffix>` on
+ * microsandbox, `rightsize/checkpoint:<suffix>` elsewhere. `name` present
+ * (a NAMED checkpoint) makes the suffix — and therefore the whole ref —
+ * deterministic: re-checkpointing the same name reproduces the exact same
+ * ref, which is what makes the registry's replace semantics (remove the old
+ * artifact under this ref, then create the new one) correct. `name`
+ * `undefined` mints a fresh random 12-hex suffix instead, byte-for-byte the
+ * pre-named-checkpoints behavior.
+ */
+export declare function checkpointRef(backendName: string, name: string | undefined): string;
+//# sourceMappingURL=ref.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../../../src/core/checkpoint/ref.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAGnF"}

package/dist/core/checkpoint/ref.js

@@ -0,0 +1,16 @@
+import { randomBytes } from "node:crypto";
+/**
+ * Mints the backend-specific checkpoint ref: `rz-ckpt-<suffix>` on
+ * microsandbox, `rightsize/checkpoint:<suffix>` elsewhere. `name` present
+ * (a NAMED checkpoint) makes the suffix — and therefore the whole ref —
+ * deterministic: re-checkpointing the same name reproduces the exact same
+ * ref, which is what makes the registry's replace semantics (remove the old
+ * artifact under this ref, then create the new one) correct. `name`
+ * `undefined` mints a fresh random 12-hex suffix instead, byte-for-byte the
+ * pre-named-checkpoints behavior.
+ */
+export function checkpointRef(backendName, name) {
+    const suffix = name ?? randomBytes(6).toString("hex");
+    return backendName === "microsandbox" ? `rz-ckpt-${suffix}` : `rightsize/checkpoint:${suffix}`;
+}
+//# sourceMappingURL=ref.js.map

package/dist/core/checkpoint/ref.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ref.js","sourceRoot":"","sources":["../../../src/core/checkpoint/ref.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,WAAmB,EAAE,IAAwB;IACzE,MAAM,MAAM,GAAG,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,WAAW,KAAK,cAAc,CAAC,CAAC,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC,CAAC,wBAAwB,MAAM,EAAE,CAAC;AACjG,CAAC"}