@lizard-build/sdk 0.1.57 → 0.1.58

package/dist/index.d.mts

@@ -920,6 +920,8 @@ interface SandboxSnapshot {
     createdAt: number;
     /** Where it may be restored; see {@link SnapshotScope}. */
     scope: SnapshotScope;
+    /** Whether the source had a volume attached (a restore then cannot attach another); `null` for older snapshots, which cannot take one. */
+    sourceVolume: boolean | null;
     /** The user who took it; `null` for snapshots from before snapshots belonged to a user. */
     createdBy: string | null;
 }
@@ -1190,11 +1192,14 @@ declare class Sandbox extends SandboxClient {
     static getSnapshot(snapshotId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
     /**
      * Start a new sandbox from a snapshot, in its region. `projectId` puts it in another project,
-     * in any of your workspaces, as the snapshot's scope allows; default: the snapshot's own project.
+     * in any of your workspaces, as the snapshot's scope allows; default: the volume's project, else
+     * the snapshot's own. `volumeId` mounts that volume at `/workspace` (a Firecracker snapshot of a
+     * sandbox that had no volume attached; the volume must be in the snapshot's region).
      */
     static restore(snapshotId: string, opts?: ConnectionOpts & {
         timeoutMs?: number;
         projectId?: string;
+        volumeId?: string;
     }): Promise<Sandbox>;
     /** Change where a snapshot you took may be restored. */
     static setSnapshotScope(snapshotId: string, scope: SnapshotScope, opts?: ConnectionOpts): Promise<SandboxSnapshot>;

package/dist/index.d.ts

@@ -920,6 +920,8 @@ interface SandboxSnapshot {
     createdAt: number;
     /** Where it may be restored; see {@link SnapshotScope}. */
     scope: SnapshotScope;
+    /** Whether the source had a volume attached (a restore then cannot attach another); `null` for older snapshots, which cannot take one. */
+    sourceVolume: boolean | null;
     /** The user who took it; `null` for snapshots from before snapshots belonged to a user. */
     createdBy: string | null;
 }
@@ -1190,11 +1192,14 @@ declare class Sandbox extends SandboxClient {
     static getSnapshot(snapshotId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
     /**
      * Start a new sandbox from a snapshot, in its region. `projectId` puts it in another project,
-     * in any of your workspaces, as the snapshot's scope allows; default: the snapshot's own project.
+     * in any of your workspaces, as the snapshot's scope allows; default: the volume's project, else
+     * the snapshot's own. `volumeId` mounts that volume at `/workspace` (a Firecracker snapshot of a
+     * sandbox that had no volume attached; the volume must be in the snapshot's region).
      */
     static restore(snapshotId: string, opts?: ConnectionOpts & {
         timeoutMs?: number;
         projectId?: string;
+        volumeId?: string;
     }): Promise<Sandbox>;
     /** Change where a snapshot you took may be restored. */
     static setSnapshotScope(snapshotId: string, scope: SnapshotScope, opts?: ConnectionOpts): Promise<SandboxSnapshot>;

package/dist/index.js

@@ -1312,15 +1312,18 @@ var Sandbox = class extends SandboxClient {
   }
   /**
    * Start a new sandbox from a snapshot, in its region. `projectId` puts it in another project,
-   * in any of your workspaces, as the snapshot's scope allows; default: the snapshot's own project.
+   * in any of your workspaces, as the snapshot's scope allows; default: the volume's project, else
+   * the snapshot's own. `volumeId` mounts that volume at `/workspace` (a Firecracker snapshot of a
+   * sandbox that had no volume attached; the volume must be in the snapshot's region).
    */
   static async restore(snapshotId, opts) {
     const client = new PlatformClient(opts ?? {});
     const snapshot = await this.getSnapshot(snapshotId, opts);
     const result = await client.post("/api/sandboxes", {
       snapshotId,
-      projectId: opts?.projectId ?? snapshot.projectId,
+      projectId: opts?.projectId ?? (opts?.volumeId ? void 0 : snapshot.projectId),
       region: snapshot.region,
+      volumeId: opts?.volumeId,
       timeoutMs: opts?.timeoutMs ?? DEFAULT_SANDBOX_TIMEOUT_MS
     });
     return new this({ ...opts, sandboxId: result.sandboxId ?? result.id });

package/dist/index.mjs

@@ -1259,15 +1259,18 @@ var Sandbox = class extends SandboxClient {
   }
   /**
    * Start a new sandbox from a snapshot, in its region. `projectId` puts it in another project,
-   * in any of your workspaces, as the snapshot's scope allows; default: the snapshot's own project.
+   * in any of your workspaces, as the snapshot's scope allows; default: the volume's project, else
+   * the snapshot's own. `volumeId` mounts that volume at `/workspace` (a Firecracker snapshot of a
+   * sandbox that had no volume attached; the volume must be in the snapshot's region).
    */
   static async restore(snapshotId, opts) {
     const client = new PlatformClient(opts ?? {});
     const snapshot = await this.getSnapshot(snapshotId, opts);
     const result = await client.post("/api/sandboxes", {
       snapshotId,
-      projectId: opts?.projectId ?? snapshot.projectId,
+      projectId: opts?.projectId ?? (opts?.volumeId ? void 0 : snapshot.projectId),
       region: snapshot.region,
+      volumeId: opts?.volumeId,
       timeoutMs: opts?.timeoutMs ?? DEFAULT_SANDBOX_TIMEOUT_MS
     });
     return new this({ ...opts, sandboxId: result.sandboxId ?? result.id });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.57",
+  "version": "0.1.58",
   "description": "TypeScript SDK for Lizard: Firecracker microVM sandboxes, code execution and cloud apps.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",