@lizard-build/sdk 0.1.67 → 0.1.69

package/dist/index.d.mts

@@ -1401,6 +1401,7 @@ interface MetricPoint {
 }
 interface ServiceMetrics {
     cpu: MetricPoint[];
+    /** Working set: what the service holds, without the file cache the kernel frees on demand. */
     memory: MetricPoint[];
     networkRx: MetricPoint[];
     networkTx: MetricPoint[];
@@ -1493,12 +1494,16 @@ interface WorkspaceLimits {
     maxCpuVcpus: number | null;
     /** Memory (MB) its apps and databases may be using right now (measured). */
     maxMemoryMb: number | null;
+    /** SSD (GB) its databases and volumes may hold (measured: data written, not sizes asked for). */
+    maxDiskGb: number | null;
 }
 interface WorkspaceUsage {
     runningSandboxes: number;
     /** Measured, all regions, its apps and databases. */
     cpuVcpus: number;
     memoryMb: number;
+    /** SSD (GB) its databases and volumes hold, last measurement of each. */
+    diskGb: number;
     /** Unix ms of the oldest reading in the sum; null when nothing was measured. */
     measuredAt: number | null;
 }
@@ -1586,9 +1591,12 @@ declare class WorkspacesAPI {
      *   not their configured limits). While at or over a cap, deploys, redeploys, restarts,
      *   scale-ups, new databases and resumes there fail with HTTP 429 `WORKSPACE_USAGE_LIMIT`;
      *   services already running keep running.
+     * - `maxDiskGb`: the SSD its databases and volumes hold (measured, not their sizes). While at
+     *   or over it, new volumes, volume growth, new databases and template deploys fail with
+     *   HTTP 429 `WORKSPACE_USAGE_LIMIT`; data already written stays.
      *
      * ```ts
-     * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+     * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096, maxDiskGb: 20 })
      * ```
      */
     setLimits(id: string, limits: Partial<WorkspaceLimits>): Promise<WorkspaceLimitsInfo>;
@@ -2251,6 +2259,40 @@ declare class PaymentRequiredError extends LizardError {
     /** The one page to open next for this {@link paymentStatus}. */
     get url(): string | undefined;
 }
+/**
+ * A limit was reached (HTTP 429). {@link LizardError.code} says which:
+ * - `SANDBOX_LIMIT_REACHED` / `SANDBOX_RATE_LIMITED`: the account's sandbox limits (running at
+ *   once, starts per minute/hour/day); {@link retryAfterS} says when to try again.
+ * - `WORKSPACE_SANDBOX_LIMIT`: the workspace's own cap on running sandboxes
+ *   (`workspaces.setLimits`).
+ * - `WORKSPACE_USAGE_LIMIT`: the workspace's apps and databases use as much CPU or memory as its
+ *   cap; {@link usage} and {@link limits} carry both.
+ * Still a {@link LizardError}, so existing `catch` blocks keep working.
+ */
+declare class LimitExceededError extends LizardError {
+    /** The limit that was reached (sandbox counts). */
+    limit?: number;
+    /** How many were running when it was refused. */
+    running?: number;
+    /** Seconds until a rate limit lets the next start through. */
+    retryAfterS?: number;
+    /** `WORKSPACE_USAGE_LIMIT`: the workspace's current use. */
+    usage?: {
+        runningSandboxes: number;
+        cpuVcpus: number;
+        memoryMb: number;
+        diskGb?: number;
+        measuredAt: number | null;
+    };
+    /** `WORKSPACE_USAGE_LIMIT`: the workspace's limits. */
+    limits?: {
+        maxRunningSandboxes: number | null;
+        maxCpuVcpus: number | null;
+        maxMemoryMb: number | null;
+        maxDiskGb?: number | null;
+    };
+    constructor(message?: string);
+}
 
 /** A single output item produced during code execution. */
 type OutputItem = {
@@ -2426,4 +2468,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 ResaleMultipliers, type ResalePricing, 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, type WorkspaceLimits, type WorkspaceLimitsInfo, type WorkspaceUsage, 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, LimitExceededError, 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 ResaleMultipliers, type ResalePricing, 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, type WorkspaceLimits, type WorkspaceLimitsInfo, type WorkspaceUsage, WorkspacesAPI, resolveProjectId };

package/dist/index.d.ts

@@ -1401,6 +1401,7 @@ interface MetricPoint {
 }
 interface ServiceMetrics {
     cpu: MetricPoint[];
+    /** Working set: what the service holds, without the file cache the kernel frees on demand. */
     memory: MetricPoint[];
     networkRx: MetricPoint[];
     networkTx: MetricPoint[];
@@ -1493,12 +1494,16 @@ interface WorkspaceLimits {
     maxCpuVcpus: number | null;
     /** Memory (MB) its apps and databases may be using right now (measured). */
     maxMemoryMb: number | null;
+    /** SSD (GB) its databases and volumes may hold (measured: data written, not sizes asked for). */
+    maxDiskGb: number | null;
 }
 interface WorkspaceUsage {
     runningSandboxes: number;
     /** Measured, all regions, its apps and databases. */
     cpuVcpus: number;
     memoryMb: number;
+    /** SSD (GB) its databases and volumes hold, last measurement of each. */
+    diskGb: number;
     /** Unix ms of the oldest reading in the sum; null when nothing was measured. */
     measuredAt: number | null;
 }
@@ -1586,9 +1591,12 @@ declare class WorkspacesAPI {
      *   not their configured limits). While at or over a cap, deploys, redeploys, restarts,
      *   scale-ups, new databases and resumes there fail with HTTP 429 `WORKSPACE_USAGE_LIMIT`;
      *   services already running keep running.
+     * - `maxDiskGb`: the SSD its databases and volumes hold (measured, not their sizes). While at
+     *   or over it, new volumes, volume growth, new databases and template deploys fail with
+     *   HTTP 429 `WORKSPACE_USAGE_LIMIT`; data already written stays.
      *
      * ```ts
-     * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+     * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096, maxDiskGb: 20 })
      * ```
      */
     setLimits(id: string, limits: Partial<WorkspaceLimits>): Promise<WorkspaceLimitsInfo>;
@@ -2251,6 +2259,40 @@ declare class PaymentRequiredError extends LizardError {
     /** The one page to open next for this {@link paymentStatus}. */
     get url(): string | undefined;
 }
+/**
+ * A limit was reached (HTTP 429). {@link LizardError.code} says which:
+ * - `SANDBOX_LIMIT_REACHED` / `SANDBOX_RATE_LIMITED`: the account's sandbox limits (running at
+ *   once, starts per minute/hour/day); {@link retryAfterS} says when to try again.
+ * - `WORKSPACE_SANDBOX_LIMIT`: the workspace's own cap on running sandboxes
+ *   (`workspaces.setLimits`).
+ * - `WORKSPACE_USAGE_LIMIT`: the workspace's apps and databases use as much CPU or memory as its
+ *   cap; {@link usage} and {@link limits} carry both.
+ * Still a {@link LizardError}, so existing `catch` blocks keep working.
+ */
+declare class LimitExceededError extends LizardError {
+    /** The limit that was reached (sandbox counts). */
+    limit?: number;
+    /** How many were running when it was refused. */
+    running?: number;
+    /** Seconds until a rate limit lets the next start through. */
+    retryAfterS?: number;
+    /** `WORKSPACE_USAGE_LIMIT`: the workspace's current use. */
+    usage?: {
+        runningSandboxes: number;
+        cpuVcpus: number;
+        memoryMb: number;
+        diskGb?: number;
+        measuredAt: number | null;
+    };
+    /** `WORKSPACE_USAGE_LIMIT`: the workspace's limits. */
+    limits?: {
+        maxRunningSandboxes: number | null;
+        maxCpuVcpus: number | null;
+        maxMemoryMb: number | null;
+        maxDiskGb?: number | null;
+    };
+    constructor(message?: string);
+}
 
 /** A single output item produced during code execution. */
 type OutputItem = {
@@ -2426,4 +2468,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 ResaleMultipliers, type ResalePricing, 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, type WorkspaceLimits, type WorkspaceLimitsInfo, type WorkspaceUsage, 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, LimitExceededError, 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 ResaleMultipliers, type ResalePricing, 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, type WorkspaceLimits, type WorkspaceLimitsInfo, type WorkspaceUsage, WorkspacesAPI, resolveProjectId };

package/dist/index.js

@@ -31,6 +31,7 @@ __export(index_exports, {
   Desktop: () => Desktop,
   DomainsAPI: () => DomainsAPI,
   GitHubAPI: () => GitHubAPI,
+  LimitExceededError: () => LimitExceededError,
   Lizard: () => Lizard,
   LizardCLI: () => LizardCLI,
   LizardError: () => LizardError,
@@ -126,6 +127,12 @@ var PaymentRequiredError = class extends LizardError {
     return this.billingUrl ?? this.subscribeUrl ?? this.topupUrl;
   }
 };
+var LimitExceededError = class extends LizardError {
+  constructor(message = "Limit reached") {
+    super(message);
+    this.name = "LimitExceededError";
+  }
+};
 var PREPAID_STATUSES = /* @__PURE__ */ new Set(["grace", "frozen", "card_required", "credits_required"]);
 var ERROR_CODE = /^[A-Z][A-Z0-9_]*$/;
 async function handleApiError(res) {
@@ -153,7 +160,17 @@ async function handleApiError(res) {
   else if (res.status === 404) err = new NotFoundError(message);
   else if (res.status === 409) err = new ConflictError(message);
   else if (res.status === 408 || res.status === 504) err = new TimeoutError(message);
-  else err = new LizardError(`API error ${res.status}: ${message}`);
+  else if (res.status === 429) {
+    const limited = new LimitExceededError(message);
+    const n = (key) => typeof body[key] === "number" ? body[key] : void 0;
+    limited.limit = n("limit");
+    limited.running = n("running");
+    const retry = n("retryAfterS") ?? (Number(res.headers?.get?.("retry-after")) || void 0);
+    limited.retryAfterS = retry;
+    if (body.usage && typeof body.usage === "object") limited.usage = body.usage;
+    if (body.limits && typeof body.limits === "object") limited.limits = body.limits;
+    err = limited;
+  } else err = new LizardError(`API error ${res.status}: ${message}`);
   err.status = res.status;
   err.code = code;
   throw err;
@@ -1769,9 +1786,12 @@ var WorkspacesAPI = class {
    *   not their configured limits). While at or over a cap, deploys, redeploys, restarts,
    *   scale-ups, new databases and resumes there fail with HTTP 429 `WORKSPACE_USAGE_LIMIT`;
    *   services already running keep running.
+   * - `maxDiskGb`: the SSD its databases and volumes hold (measured, not their sizes). While at
+   *   or over it, new volumes, volume growth, new databases and template deploys fail with
+   *   HTTP 429 `WORKSPACE_USAGE_LIMIT`; data already written stays.
    *
    * ```ts
-   * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+   * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096, maxDiskGb: 20 })
    * ```
    */
   setLimits(id, limits) {
@@ -2689,6 +2709,7 @@ var LizardCLI = class {
   Desktop,
   DomainsAPI,
   GitHubAPI,
+  LimitExceededError,
   Lizard,
   LizardCLI,
   LizardError,

package/dist/index.mjs

@@ -73,6 +73,12 @@ var PaymentRequiredError = class extends LizardError {
     return this.billingUrl ?? this.subscribeUrl ?? this.topupUrl;
   }
 };
+var LimitExceededError = class extends LizardError {
+  constructor(message = "Limit reached") {
+    super(message);
+    this.name = "LimitExceededError";
+  }
+};
 var PREPAID_STATUSES = /* @__PURE__ */ new Set(["grace", "frozen", "card_required", "credits_required"]);
 var ERROR_CODE = /^[A-Z][A-Z0-9_]*$/;
 async function handleApiError(res) {
@@ -100,7 +106,17 @@ async function handleApiError(res) {
   else if (res.status === 404) err = new NotFoundError(message);
   else if (res.status === 409) err = new ConflictError(message);
   else if (res.status === 408 || res.status === 504) err = new TimeoutError(message);
-  else err = new LizardError(`API error ${res.status}: ${message}`);
+  else if (res.status === 429) {
+    const limited = new LimitExceededError(message);
+    const n = (key) => typeof body[key] === "number" ? body[key] : void 0;
+    limited.limit = n("limit");
+    limited.running = n("running");
+    const retry = n("retryAfterS") ?? (Number(res.headers?.get?.("retry-after")) || void 0);
+    limited.retryAfterS = retry;
+    if (body.usage && typeof body.usage === "object") limited.usage = body.usage;
+    if (body.limits && typeof body.limits === "object") limited.limits = body.limits;
+    err = limited;
+  } else err = new LizardError(`API error ${res.status}: ${message}`);
   err.status = res.status;
   err.code = code;
   throw err;
@@ -1716,9 +1732,12 @@ var WorkspacesAPI = class {
    *   not their configured limits). While at or over a cap, deploys, redeploys, restarts,
    *   scale-ups, new databases and resumes there fail with HTTP 429 `WORKSPACE_USAGE_LIMIT`;
    *   services already running keep running.
+   * - `maxDiskGb`: the SSD its databases and volumes hold (measured, not their sizes). While at
+   *   or over it, new volumes, volume growth, new databases and template deploys fail with
+   *   HTTP 429 `WORKSPACE_USAGE_LIMIT`; data already written stays.
    *
    * ```ts
-   * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+   * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096, maxDiskGb: 20 })
    * ```
    */
   setLimits(id, limits) {
@@ -2635,6 +2654,7 @@ export {
   Desktop,
   DomainsAPI,
   GitHubAPI,
+  LimitExceededError,
   Lizard,
   LizardCLI,
   LizardError,

package/package.json

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