tensorlake 0.5.9 → 0.5.10

package/dist/{sandbox-image-BMDaNpZ2.d.cts → sandbox-image-CUEKMhZ1.d.cts}

@@ -8,6 +8,7 @@ declare enum SandboxStatus {
 }
 declare enum SnapshotStatus {
     IN_PROGRESS = "in_progress",
+    LOCAL_READY = "local_ready",
     COMPLETED = "completed",
     FAILED = "failed"
 }
@@ -31,6 +32,7 @@ type SnapshotType = "memory" | "filesystem";
  *   this checkpoint cold-boot from the snapshot tarball.
  */
 type CheckpointType = "memory" | "filesystem";
+type SnapshotWaitCondition = "local_ready" | "completed";
 declare enum ProcessStatus {
     RUNNING = "running",
     EXITED = "exited",
@@ -132,6 +134,7 @@ interface SnapshotInfo {
     snapshotType?: SnapshotType;
     error?: string;
     snapshotUri?: string;
+    snapshotFormatVersion?: string;
     sizeBytes?: number;
     rootfsDiskBytes?: number;
     createdAt?: Date;
@@ -147,6 +150,8 @@ interface SnapshotOptions {
 interface SnapshotAndWaitOptions extends SnapshotOptions {
     timeout?: number;
     pollInterval?: number;
+    /** Defaults to `"local_ready"`, which is enough to resume from a snapshot. */
+    waitUntil?: SnapshotWaitCondition;
 }
 interface CreatePoolOptions {
     /** Sandbox image name, such as `tensorlake/ubuntu-minimal` or a registered Sandbox Image. */
@@ -303,6 +308,8 @@ interface SuspendResumeOptions {
 }
 interface CheckpointOptions extends SuspendResumeOptions {
     checkpointType?: CheckpointType;
+    /** Defaults to `"local_ready"`, which is enough to resume from a checkpoint. */
+    waitUntil?: SnapshotWaitCondition;
 }
 interface ConnectOptions {
     sandboxId: string;
@@ -424,13 +431,14 @@ interface BuildClient {
         timeout?: number;
         pollInterval?: number;
         snapshotType?: SnapshotType;
+        waitUntil?: SnapshotWaitCondition;
     }): Promise<SnapshotInfo>;
     close(): void;
 }
 interface CreateSandboxImageDeps {
     emit?: (event: Record<string, unknown>) => void;
     createClient?: (context: BuildContext) => BuildClient;
-    registerImage?: (context: BuildContext, name: string, dockerfile: string, snapshotId: string, snapshotSandboxId: string, snapshotUri: string, snapshotSizeBytes: number, rootfsDiskBytes: number, isPublic: boolean) => Promise<Record<string, unknown>>;
+    registerImage?: (context: BuildContext, name: string, dockerfile: string, snapshotId: string, snapshotSandboxId: string, snapshotUri: string, snapshotSizeBytes: number, rootfsDiskBytes: number, isPublic: boolean, snapshotFormatVersion?: string) => Promise<Record<string, unknown>>;
     sleep?: (ms: number) => Promise<void>;
 }
 declare function defaultRegisteredName(dockerfilePath: string): string;
@@ -440,7 +448,8 @@ declare function logicalDockerfileLines(dockerfileText: string): Array<{
 }>;
 declare function loadDockerfilePlan(dockerfilePath: string, registeredName?: string): Promise<DockerfileBuildPlan>;
 declare function loadImagePlan(image: Image, options?: Pick<CreateSandboxImageOptions, "registeredName" | "contextDir">): DockerfileBuildPlan;
+declare function registerImage(context: BuildContext, name: string, dockerfile: string, snapshotId: string, snapshotSandboxId: string, snapshotUri: string, snapshotSizeBytes: number, rootfsDiskBytes: number, isPublic: boolean, snapshotFormatVersion?: string): Promise<Record<string, unknown>>;
 declare function createSandboxImage(source: SandboxImageSource, options?: CreateSandboxImageOptions, deps?: CreateSandboxImageDeps): Promise<Record<string, unknown>>;
 declare function runCreateSandboxImageCli(argv?: string[]): Promise<void>;
 
-export { defaultRegisteredName as $, type CreateSandboxImageOptions as A, type DirectoryEntry as B, type CreatePtySessionOptions as C, type DaemonInfo as D, type DockerfileBuildPlan as E, type DockerfileInstruction as F, type ImageBuildOperation as G, type HealthResponse as H, Image as I, ImageBuildOperationType as J, type ImageOptions as K, type ListDirectoryResponse as L, OutputMode as M, type NetworkConfig as N, type OutputResponse as O, type ProcessInfo as P, type PoolContainerInfo as Q, type RunOptions as R, type SandboxOptions as S, ProcessStatus as T, type UpdateSandboxOptions as U, type SandboxImageSource as V, SnapshotStatus as W, type SnapshotType as X, StdinMode as Y, createSandboxImage as Z, dockerfileContent as _, type CreateAndConnectOptions as a, loadDockerfilePlan as a0, loadImagePlan as a1, logicalDockerfileLines as a2, runCreateSandboxImageCli as a3, type SandboxClientOptions as b, type ConnectOptions as c, type SnapshotInfo as d, type SandboxInfo as e, SandboxStatus as f, type SuspendResumeOptions as g, type CheckpointOptions as h, type CommandResult as i, type StartProcessOptions as j, type SendSignalResponse as k, type OutputEvent as l, type PtySessionInfo as m, type CreateSandboxOptions as n, type CreateSandboxResponse as o, type SandboxPortAccess as p, type SnapshotOptions as q, type CreateSnapshotResponse as r, type SnapshotAndWaitOptions as s, type CreatePoolOptions as t, type CreateSandboxPoolResponse as u, type SandboxPoolInfo as v, type UpdatePoolOptions as w, type CheckpointType as x, type ContainerResourcesInfo as y, ContainerState as z };
+export { dockerfileContent as $, type CreateSandboxImageOptions as A, type DirectoryEntry as B, type CreatePtySessionOptions as C, type DaemonInfo as D, type DockerfileBuildPlan as E, type DockerfileInstruction as F, type ImageBuildOperation as G, type HealthResponse as H, Image as I, ImageBuildOperationType as J, type ImageOptions as K, type ListDirectoryResponse as L, OutputMode as M, type NetworkConfig as N, type OutputResponse as O, type ProcessInfo as P, type PoolContainerInfo as Q, type RunOptions as R, type SandboxOptions as S, ProcessStatus as T, type UpdateSandboxOptions as U, type SandboxImageSource as V, SnapshotStatus as W, type SnapshotType as X, type SnapshotWaitCondition as Y, StdinMode as Z, createSandboxImage as _, type CreateAndConnectOptions as a, type BuildContext as a0, defaultRegisteredName as a1, loadDockerfilePlan as a2, loadImagePlan as a3, logicalDockerfileLines as a4, registerImage as a5, runCreateSandboxImageCli as a6, type SandboxClientOptions as b, type ConnectOptions as c, type SnapshotInfo as d, type SandboxInfo as e, SandboxStatus as f, type SuspendResumeOptions as g, type CheckpointOptions as h, type CommandResult as i, type StartProcessOptions as j, type SendSignalResponse as k, type OutputEvent as l, type PtySessionInfo as m, type CreateSandboxOptions as n, type CreateSandboxResponse as o, type SandboxPortAccess as p, type SnapshotOptions as q, type CreateSnapshotResponse as r, type SnapshotAndWaitOptions as s, type CreatePoolOptions as t, type CreateSandboxPoolResponse as u, type SandboxPoolInfo as v, type UpdatePoolOptions as w, type CheckpointType as x, type ContainerResourcesInfo as y, ContainerState as z };

package/dist/{sandbox-image-BMDaNpZ2.d.ts → sandbox-image-CUEKMhZ1.d.ts}

@@ -8,6 +8,7 @@ declare enum SandboxStatus {
 }
 declare enum SnapshotStatus {
     IN_PROGRESS = "in_progress",
+    LOCAL_READY = "local_ready",
     COMPLETED = "completed",
     FAILED = "failed"
 }
@@ -31,6 +32,7 @@ type SnapshotType = "memory" | "filesystem";
  *   this checkpoint cold-boot from the snapshot tarball.
  */
 type CheckpointType = "memory" | "filesystem";
+type SnapshotWaitCondition = "local_ready" | "completed";
 declare enum ProcessStatus {
     RUNNING = "running",
     EXITED = "exited",
@@ -132,6 +134,7 @@ interface SnapshotInfo {
     snapshotType?: SnapshotType;
     error?: string;
     snapshotUri?: string;
+    snapshotFormatVersion?: string;
     sizeBytes?: number;
     rootfsDiskBytes?: number;
     createdAt?: Date;
@@ -147,6 +150,8 @@ interface SnapshotOptions {
 interface SnapshotAndWaitOptions extends SnapshotOptions {
     timeout?: number;
     pollInterval?: number;
+    /** Defaults to `"local_ready"`, which is enough to resume from a snapshot. */
+    waitUntil?: SnapshotWaitCondition;
 }
 interface CreatePoolOptions {
     /** Sandbox image name, such as `tensorlake/ubuntu-minimal` or a registered Sandbox Image. */
@@ -303,6 +308,8 @@ interface SuspendResumeOptions {
 }
 interface CheckpointOptions extends SuspendResumeOptions {
     checkpointType?: CheckpointType;
+    /** Defaults to `"local_ready"`, which is enough to resume from a checkpoint. */
+    waitUntil?: SnapshotWaitCondition;
 }
 interface ConnectOptions {
     sandboxId: string;
@@ -424,13 +431,14 @@ interface BuildClient {
         timeout?: number;
         pollInterval?: number;
         snapshotType?: SnapshotType;
+        waitUntil?: SnapshotWaitCondition;
     }): Promise<SnapshotInfo>;
     close(): void;
 }
 interface CreateSandboxImageDeps {
     emit?: (event: Record<string, unknown>) => void;
     createClient?: (context: BuildContext) => BuildClient;
-    registerImage?: (context: BuildContext, name: string, dockerfile: string, snapshotId: string, snapshotSandboxId: string, snapshotUri: string, snapshotSizeBytes: number, rootfsDiskBytes: number, isPublic: boolean) => Promise<Record<string, unknown>>;
+    registerImage?: (context: BuildContext, name: string, dockerfile: string, snapshotId: string, snapshotSandboxId: string, snapshotUri: string, snapshotSizeBytes: number, rootfsDiskBytes: number, isPublic: boolean, snapshotFormatVersion?: string) => Promise<Record<string, unknown>>;
     sleep?: (ms: number) => Promise<void>;
 }
 declare function defaultRegisteredName(dockerfilePath: string): string;
@@ -440,7 +448,8 @@ declare function logicalDockerfileLines(dockerfileText: string): Array<{
 }>;
 declare function loadDockerfilePlan(dockerfilePath: string, registeredName?: string): Promise<DockerfileBuildPlan>;
 declare function loadImagePlan(image: Image, options?: Pick<CreateSandboxImageOptions, "registeredName" | "contextDir">): DockerfileBuildPlan;
+declare function registerImage(context: BuildContext, name: string, dockerfile: string, snapshotId: string, snapshotSandboxId: string, snapshotUri: string, snapshotSizeBytes: number, rootfsDiskBytes: number, isPublic: boolean, snapshotFormatVersion?: string): Promise<Record<string, unknown>>;
 declare function createSandboxImage(source: SandboxImageSource, options?: CreateSandboxImageOptions, deps?: CreateSandboxImageDeps): Promise<Record<string, unknown>>;
 declare function runCreateSandboxImageCli(argv?: string[]): Promise<void>;
 
-export { defaultRegisteredName as $, type CreateSandboxImageOptions as A, type DirectoryEntry as B, type CreatePtySessionOptions as C, type DaemonInfo as D, type DockerfileBuildPlan as E, type DockerfileInstruction as F, type ImageBuildOperation as G, type HealthResponse as H, Image as I, ImageBuildOperationType as J, type ImageOptions as K, type ListDirectoryResponse as L, OutputMode as M, type NetworkConfig as N, type OutputResponse as O, type ProcessInfo as P, type PoolContainerInfo as Q, type RunOptions as R, type SandboxOptions as S, ProcessStatus as T, type UpdateSandboxOptions as U, type SandboxImageSource as V, SnapshotStatus as W, type SnapshotType as X, StdinMode as Y, createSandboxImage as Z, dockerfileContent as _, type CreateAndConnectOptions as a, loadDockerfilePlan as a0, loadImagePlan as a1, logicalDockerfileLines as a2, runCreateSandboxImageCli as a3, type SandboxClientOptions as b, type ConnectOptions as c, type SnapshotInfo as d, type SandboxInfo as e, SandboxStatus as f, type SuspendResumeOptions as g, type CheckpointOptions as h, type CommandResult as i, type StartProcessOptions as j, type SendSignalResponse as k, type OutputEvent as l, type PtySessionInfo as m, type CreateSandboxOptions as n, type CreateSandboxResponse as o, type SandboxPortAccess as p, type SnapshotOptions as q, type CreateSnapshotResponse as r, type SnapshotAndWaitOptions as s, type CreatePoolOptions as t, type CreateSandboxPoolResponse as u, type SandboxPoolInfo as v, type UpdatePoolOptions as w, type CheckpointType as x, type ContainerResourcesInfo as y, ContainerState as z };
+export { dockerfileContent as $, type CreateSandboxImageOptions as A, type DirectoryEntry as B, type CreatePtySessionOptions as C, type DaemonInfo as D, type DockerfileBuildPlan as E, type DockerfileInstruction as F, type ImageBuildOperation as G, type HealthResponse as H, Image as I, ImageBuildOperationType as J, type ImageOptions as K, type ListDirectoryResponse as L, OutputMode as M, type NetworkConfig as N, type OutputResponse as O, type ProcessInfo as P, type PoolContainerInfo as Q, type RunOptions as R, type SandboxOptions as S, ProcessStatus as T, type UpdateSandboxOptions as U, type SandboxImageSource as V, SnapshotStatus as W, type SnapshotType as X, type SnapshotWaitCondition as Y, StdinMode as Z, createSandboxImage as _, type CreateAndConnectOptions as a, type BuildContext as a0, defaultRegisteredName as a1, loadDockerfilePlan as a2, loadImagePlan as a3, logicalDockerfileLines as a4, registerImage as a5, runCreateSandboxImageCli as a6, type SandboxClientOptions as b, type ConnectOptions as c, type SnapshotInfo as d, type SandboxInfo as e, SandboxStatus as f, type SuspendResumeOptions as g, type CheckpointOptions as h, type CommandResult as i, type StartProcessOptions as j, type SendSignalResponse as k, type OutputEvent as l, type PtySessionInfo as m, type CreateSandboxOptions as n, type CreateSandboxResponse as o, type SandboxPortAccess as p, type SnapshotOptions as q, type CreateSnapshotResponse as r, type SnapshotAndWaitOptions as s, type CreatePoolOptions as t, type CreateSandboxPoolResponse as u, type SandboxPoolInfo as v, type UpdatePoolOptions as w, type CheckpointType as x, type ContainerResourcesInfo as y, ContainerState as z };

package/dist/sandbox-image.cjs

@@ -83,7 +83,7 @@ var SDK_VERSION, API_URL, API_KEY, NAMESPACE, SANDBOX_PROXY_URL, DEFAULT_HTTP_TI
 var init_defaults = __esm({
   "src/defaults.ts"() {
     "use strict";
-    SDK_VERSION = "0.5.9";
+    SDK_VERSION = "0.5.10";
     API_URL = process.env.TENSORLAKE_API_URL ?? "https://api.tensorlake.ai";
     API_KEY = process.env.TENSORLAKE_API_KEY ?? void 0;
     NAMESPACE = process.env.INDEXIFY_NAMESPACE ?? "default";
@@ -3334,11 +3334,10 @@ var init_sandbox = __esm({
         await client.resume(this.lifecycleIdentifier, options);
       }
       /**
-       * Create a snapshot of this sandbox's filesystem and wait for it to
-       * be committed.
+       * Create a checkpoint of this sandbox and wait for it to be locally ready.
        *
-       * By default blocks until the snapshot artifact is ready and returns
-       * the completed `SnapshotInfo`. Pass `{ wait: false }` to fire-and-return
+       * By default blocks until the checkpoint is resumable and returns
+       * `SnapshotInfo`. Pass `{ wait: false }` to fire-and-return
        * (returns `undefined`).
        */
       async checkpoint(options) {
@@ -3350,7 +3349,8 @@ var init_sandbox = __esm({
         return client.snapshotAndWait(this.lifecycleIdentifier, {
           timeout: options?.timeout,
           pollInterval: options?.pollInterval,
-          snapshotType: options?.checkpointType
+          snapshotType: options?.checkpointType,
+          waitUntil: options?.waitUntil
         });
       }
       /**
@@ -3745,6 +3745,12 @@ __export(client_exports, {
 function sleep2(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
+function snapshotStatusSatisfiesWaitCondition(status, waitUntil) {
+  if (waitUntil === "local_ready") {
+    return status === "local_ready" /* LOCAL_READY */ || status === "completed" /* COMPLETED */;
+  }
+  return status === "completed" /* COMPLETED */;
+}
 function formatStartupFailureMessage(sandboxId, status, options) {
   const prefix = status === "terminated" /* TERMINATED */ ? `Sandbox ${sandboxId} terminated during startup` : `Sandbox ${sandboxId} became ${status} during startup`;
   const detail = formatErrorDetails(options.errorDetails);
@@ -4045,7 +4051,8 @@ var init_client = __esm({
        *
        * This call **returns immediately** with a `snapshotId` and `in_progress`
        * status — the snapshot is created asynchronously. Poll `getSnapshot()` until
-       * `completed` or `failed`, or use `snapshotAndWait()` to block automatically.
+       * `local_ready`, `completed`, or `failed`, or use `snapshotAndWait()` to
+       * block automatically.
        *
        * @param options.snapshotType - `"filesystem"` for cold-boot snapshots (e.g. image builds).
        *   Omit to use the server default (`filesystem`).
@@ -4086,9 +4093,11 @@ var init_client = __esm({
         );
       }
       /**
-       * Create a snapshot and block until it is committed.
+       * Create a snapshot and block until it is locally ready.
        *
-       * Combines `snapshot()` with polling `getSnapshot()` until `completed`.
+       * Combines `snapshot()` with polling `getSnapshot()` until `local_ready`
+       * or `completed`. Pass `{ waitUntil: "completed" }` when durable
+       * `snapshotUri` metadata is required.
        * Prefer `sandbox.checkpoint()` on a `Sandbox` handle for the same behavior
        * without managing the client separately.
        *
@@ -4101,13 +4110,14 @@ var init_client = __esm({
       async snapshotAndWait(sandboxId, options) {
         const timeout = options?.timeout ?? 300;
         const pollInterval = options?.pollInterval ?? 1;
+        const waitUntil = options?.waitUntil ?? "local_ready";
         const result = await this.snapshot(sandboxId, {
           snapshotType: options?.snapshotType
         });
         const deadline = Date.now() + timeout * 1e3;
         while (Date.now() < deadline) {
           const info = await this.getSnapshot(result.snapshotId);
-          if (info.status === "completed" /* COMPLETED */) return info;
+          if (snapshotStatusSatisfiesWaitCondition(info.status, waitUntil)) return info;
           if (info.status === "failed" /* FAILED */) {
             throw new SandboxError(
               `Snapshot ${result.snapshotId} failed: ${info.error}`
@@ -4116,7 +4126,7 @@ var init_client = __esm({
           await sleep2(pollInterval * 1e3);
         }
         throw new SandboxError(
-          `Snapshot ${result.snapshotId} did not complete within ${timeout}s`
+          `Snapshot ${result.snapshotId} did not reach ${waitUntil} within ${timeout}s`
         );
       }
       // --- Pools ---
@@ -4307,6 +4317,7 @@ __export(sandbox_image_exports, {
   loadDockerfilePlan: () => loadDockerfilePlan,
   loadImagePlan: () => loadImagePlan,
   logicalDockerfileLines: () => logicalDockerfileLines,
+  registerImage: () => registerImage,
   runCreateSandboxImageCli: () => runCreateSandboxImageCli
 });
 module.exports = __toCommonJS(sandbox_image_exports);
@@ -4930,23 +4941,26 @@ async function executeDockerfilePlan(sandbox, plan, emit, sleep3) {
     );
   }
 }
-async function registerImage(context, name, dockerfile, snapshotId, snapshotSandboxId, snapshotUri, snapshotSizeBytes, rootfsDiskBytes, isPublic) {
-  if (!context.organizationId || !context.projectId) {
-    throw new Error(
-      "Organization ID and Project ID are required. Run 'tl login' and 'tl init'."
-    );
-  }
+async function registerImage(context, name, dockerfile, snapshotId, snapshotSandboxId, snapshotUri, snapshotSizeBytes, rootfsDiskBytes, isPublic, snapshotFormatVersion) {
   const bearerToken = context.apiKey ?? context.personalAccessToken;
   if (!bearerToken) {
     throw new Error("Missing TENSORLAKE_API_KEY or TENSORLAKE_PAT.");
   }
   const baseUrl = context.apiUrl.replace(/\/+$/, "");
-  const url = `${baseUrl}/platform/v1/organizations/${encodeURIComponent(context.organizationId)}/projects/${encodeURIComponent(context.projectId)}/sandbox-templates`;
   const headers = {
     Authorization: `Bearer ${bearerToken}`,
     "Content-Type": "application/json"
   };
-  if (context.personalAccessToken && !context.apiKey) {
+  let url;
+  if (context.apiKey) {
+    url = `${baseUrl}/platform/v1/sandbox-templates`;
+  } else {
+    if (!context.organizationId || !context.projectId) {
+      throw new Error(
+        "Personal Access Token authentication requires TENSORLAKE_ORGANIZATION_ID and TENSORLAKE_PROJECT_ID to be set (e.g. via 'tl login && tl init'). To skip this requirement, authenticate with TENSORLAKE_API_KEY instead \u2014 API keys are bound to a single project at creation."
+      );
+    }
+    url = `${baseUrl}/platform/v1/organizations/${encodeURIComponent(context.organizationId)}/projects/${encodeURIComponent(context.projectId)}/sandbox-templates`;
     headers["X-Forwarded-Organization-Id"] = context.organizationId;
     headers["X-Forwarded-Project-Id"] = context.projectId;
   }
@@ -4959,6 +4973,7 @@ async function registerImage(context, name, dockerfile, snapshotId, snapshotSand
       snapshotId,
       snapshotSandboxId,
       snapshotUri,
+      ...snapshotFormatVersion ? { snapshotFormatVersion } : {},
       snapshotSizeBytes,
       rootfsDiskBytes,
       public: isPublic
@@ -5001,7 +5016,8 @@ async function createSandboxImage(source, options = {}, deps = {}) {
     await executeDockerfilePlan(sandbox, plan, emit, sleep3);
     emit({ type: "status", message: "Creating snapshot..." });
     const snapshot = await client.snapshotAndWait(sandbox.sandboxId, {
-      snapshotType: "filesystem"
+      snapshotType: "filesystem",
+      waitUntil: "completed"
     });
     emit({
       type: "snapshot_created",
@@ -5035,7 +5051,8 @@ async function createSandboxImage(source, options = {}, deps = {}) {
       snapshot.snapshotUri,
       snapshot.sizeBytes,
       snapshot.rootfsDiskBytes,
-      options.isPublic ?? false
+      options.isPublic ?? false,
+      snapshot.snapshotFormatVersion
     );
     emit({
       type: "image_registered",
@@ -5129,6 +5146,7 @@ init_sandbox_image();
   loadDockerfilePlan,
   loadImagePlan,
   logicalDockerfileLines,
+  registerImage,
   runCreateSandboxImageCli
 });
 //# sourceMappingURL=sandbox-image.cjs.map