@lizard-build/sdk 0.1.56 → 0.1.58

package/dist/index.d.mts

@@ -918,10 +918,24 @@ interface SandboxSnapshot {
     memoryMb: number;
     /** Unix milliseconds. */
     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;
 }
+/**
+ * Where a snapshot may be restored, always in its own region: `'user'` (the default) into any
+ * project you can use, in any of your workspaces; `'workspace'` only its own workspace;
+ * `'project'` only its own project.
+ */
+type SnapshotScope = 'user' | 'workspace' | 'project';
 interface SnapshotOpts {
     /** Warm copies to keep ready (container sandboxes only; ignored for Firecracker, whose snapshots restore from disk). */
     poolSize?: number;
+    /** Where it may be restored. Default `'user'`: any of your projects and workspaces. */
+    scope?: SnapshotScope;
 }
 /**
  * One entry of {@link Sandbox.fork}'s result: the new sandbox, or why that copy
@@ -1173,11 +1187,22 @@ declare class Sandbox extends SandboxClient {
         signal?: AbortSignal;
     }): AsyncGenerator<StreamEvent, any, any>;
     static snapshots(projectId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot[]>;
+    /** Every snapshot you took, across all your workspaces and projects. */
+    static mySnapshots(opts?: ConnectionOpts): Promise<SandboxSnapshot[]>;
     static getSnapshot(snapshotId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
-    /** Start a new sandbox from a snapshot, in the snapshot's project and region. */
+    /**
+     * 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 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>;
     static setSnapshotWarmPool(snapshotId: string, poolSize: number, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
     /** Release idle warm copies (container snapshots); retain saved state and existing claimed sandboxes. */
     static pauseSnapshot(snapshotId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
@@ -2218,4 +2243,4 @@ declare class LizardCLI {
     }): Promise<CLIResult>;
 }
 
-export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };
+export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotScope, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };

package/dist/index.d.ts

@@ -918,10 +918,24 @@ interface SandboxSnapshot {
     memoryMb: number;
     /** Unix milliseconds. */
     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;
 }
+/**
+ * Where a snapshot may be restored, always in its own region: `'user'` (the default) into any
+ * project you can use, in any of your workspaces; `'workspace'` only its own workspace;
+ * `'project'` only its own project.
+ */
+type SnapshotScope = 'user' | 'workspace' | 'project';
 interface SnapshotOpts {
     /** Warm copies to keep ready (container sandboxes only; ignored for Firecracker, whose snapshots restore from disk). */
     poolSize?: number;
+    /** Where it may be restored. Default `'user'`: any of your projects and workspaces. */
+    scope?: SnapshotScope;
 }
 /**
  * One entry of {@link Sandbox.fork}'s result: the new sandbox, or why that copy
@@ -1173,11 +1187,22 @@ declare class Sandbox extends SandboxClient {
         signal?: AbortSignal;
     }): AsyncGenerator<StreamEvent, any, any>;
     static snapshots(projectId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot[]>;
+    /** Every snapshot you took, across all your workspaces and projects. */
+    static mySnapshots(opts?: ConnectionOpts): Promise<SandboxSnapshot[]>;
     static getSnapshot(snapshotId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
-    /** Start a new sandbox from a snapshot, in the snapshot's project and region. */
+    /**
+     * 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 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>;
     static setSnapshotWarmPool(snapshotId: string, poolSize: number, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
     /** Release idle warm copies (container snapshots); retain saved state and existing claimed sandboxes. */
     static pauseSnapshot(snapshotId: string, opts?: ConnectionOpts): Promise<SandboxSnapshot>;
@@ -2218,4 +2243,4 @@ declare class LizardCLI {
     }): Promise<CLIResult>;
 }
 
-export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };
+export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotScope, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };

package/dist/index.js

@@ -1291,7 +1291,7 @@ var Sandbox = class extends SandboxClient {
    * keeps running. `poolSize` applies to container sandboxes only.
    */
   snapshot(name = `Snapshot ${this.sandboxId}`, opts = {}) {
-    return new PlatformClient(this.resolveOpts()).post(`/api/sandboxes/${this.sandboxId}/snapshot`, { name, poolSize: opts.poolSize ?? 5 });
+    return new PlatformClient(this.resolveOpts()).post(`/api/sandboxes/${this.sandboxId}/snapshot`, { name, poolSize: opts.poolSize ?? 5, scope: opts.scope });
   }
   unexpose(port) {
     return new PlatformClient(this.resolveOpts()).delete(`/api/sandboxes/${this.sandboxId}/expose/${port}`);
@@ -1303,21 +1303,35 @@ var Sandbox = class extends SandboxClient {
   static snapshots(projectId, opts) {
     return new PlatformClient(opts ?? {}).get(`/api/projects/${encodeURIComponent(projectId)}/snapshots`);
   }
+  /** Every snapshot you took, across all your workspaces and projects. */
+  static mySnapshots(opts) {
+    return new PlatformClient(opts ?? {}).get("/api/sandbox-snapshots");
+  }
   static getSnapshot(snapshotId, opts) {
     return new PlatformClient(opts ?? {}).get(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}`);
   }
-  /** Start a new sandbox from a snapshot, in the snapshot's project and region. */
+  /**
+   * 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 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: 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 });
   }
+  /** Change where a snapshot you took may be restored. */
+  static setSnapshotScope(snapshotId, scope, opts) {
+    return new PlatformClient(opts ?? {}).patch(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}`, { scope });
+  }
   static setSnapshotWarmPool(snapshotId, poolSize, opts) {
     return new PlatformClient(opts ?? {}).patch(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}`, { poolSize });
   }

package/dist/index.mjs

@@ -1238,7 +1238,7 @@ var Sandbox = class extends SandboxClient {
    * keeps running. `poolSize` applies to container sandboxes only.
    */
   snapshot(name = `Snapshot ${this.sandboxId}`, opts = {}) {
-    return new PlatformClient(this.resolveOpts()).post(`/api/sandboxes/${this.sandboxId}/snapshot`, { name, poolSize: opts.poolSize ?? 5 });
+    return new PlatformClient(this.resolveOpts()).post(`/api/sandboxes/${this.sandboxId}/snapshot`, { name, poolSize: opts.poolSize ?? 5, scope: opts.scope });
   }
   unexpose(port) {
     return new PlatformClient(this.resolveOpts()).delete(`/api/sandboxes/${this.sandboxId}/expose/${port}`);
@@ -1250,21 +1250,35 @@ var Sandbox = class extends SandboxClient {
   static snapshots(projectId, opts) {
     return new PlatformClient(opts ?? {}).get(`/api/projects/${encodeURIComponent(projectId)}/snapshots`);
   }
+  /** Every snapshot you took, across all your workspaces and projects. */
+  static mySnapshots(opts) {
+    return new PlatformClient(opts ?? {}).get("/api/sandbox-snapshots");
+  }
   static getSnapshot(snapshotId, opts) {
     return new PlatformClient(opts ?? {}).get(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}`);
   }
-  /** Start a new sandbox from a snapshot, in the snapshot's project and region. */
+  /**
+   * 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 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: 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 });
   }
+  /** Change where a snapshot you took may be restored. */
+  static setSnapshotScope(snapshotId, scope, opts) {
+    return new PlatformClient(opts ?? {}).patch(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}`, { scope });
+  }
   static setSnapshotWarmPool(snapshotId, poolSize, opts) {
     return new PlatformClient(opts ?? {}).patch(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}`, { poolSize });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.56",
+  "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",