@lizard-build/sdk 0.1.65 → 0.1.67

package/dist/index.d.mts

@@ -149,7 +149,7 @@ interface CreateProjectOpts {
 }
 /** One app or managed database a project / workspace pause or resume acted on. */
 interface PausedService {
-    kind: 'app' | 'database';
+    kind: 'app' | 'database' | 'sandbox';
     id: string;
     name: string;
 }
@@ -1485,6 +1485,27 @@ interface ResalePricing {
     enabled: boolean;
     multipliers: ResaleMultipliers;
 }
+/** What a workspace may run at once (null: no limit). See {@link WorkspacesAPI.setLimits}. */
+interface WorkspaceLimits {
+    /** Sandboxes running (or resuming) at once; paused ones do not count. */
+    maxRunningSandboxes: number | null;
+    /** vCPU its apps and databases may be using right now (measured). */
+    maxCpuVcpus: number | null;
+    /** Memory (MB) its apps and databases may be using right now (measured). */
+    maxMemoryMb: number | null;
+}
+interface WorkspaceUsage {
+    runningSandboxes: number;
+    /** Measured, all regions, its apps and databases. */
+    cpuVcpus: number;
+    memoryMb: number;
+    /** Unix ms of the oldest reading in the sum; null when nothing was measured. */
+    measuredAt: number | null;
+}
+interface WorkspaceLimitsInfo {
+    limits: WorkspaceLimits;
+    usage: WorkspaceUsage;
+}
 interface CreateWorkspaceOpts {
     name: string;
 }
@@ -1550,6 +1571,27 @@ declare class WorkspacesAPI {
     setResalePricing(id: string, multipliers: Partial<ResaleMultipliers>): Promise<ResalePricing>;
     /** Turn resale prices off: scoped keys see Lizard's prices again (owner only). */
     clearResalePricing(id: string): Promise<ResalePricing>;
+    /**
+     * The workspace's limits and what it uses now. Anyone in the workspace may read them,
+     * including a key scoped to it (your customer sees how close they are).
+     */
+    getLimits(id: string): Promise<WorkspaceLimitsInfo>;
+    /**
+     * Limit what a workspace may run at once (owner only, key with no scopes). A field left out
+     * stays as it is; `null` removes that limit.
+     *
+     * - `maxRunningSandboxes`: a create, fork or resume past it fails with HTTP 429
+     *   `WORKSPACE_SANDBOX_LIMIT`.
+     * - `maxCpuVcpus` / `maxMemoryMb`: what its apps and databases USE (measured every ~10 s,
+     *   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.
+     *
+     * ```ts
+     * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+     * ```
+     */
+    setLimits(id: string, limits: Partial<WorkspaceLimits>): Promise<WorkspaceLimitsInfo>;
     /**
      * Delete a workspace.
      *
@@ -2384,4 +2426,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, 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 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

@@ -149,7 +149,7 @@ interface CreateProjectOpts {
 }
 /** One app or managed database a project / workspace pause or resume acted on. */
 interface PausedService {
-    kind: 'app' | 'database';
+    kind: 'app' | 'database' | 'sandbox';
     id: string;
     name: string;
 }
@@ -1485,6 +1485,27 @@ interface ResalePricing {
     enabled: boolean;
     multipliers: ResaleMultipliers;
 }
+/** What a workspace may run at once (null: no limit). See {@link WorkspacesAPI.setLimits}. */
+interface WorkspaceLimits {
+    /** Sandboxes running (or resuming) at once; paused ones do not count. */
+    maxRunningSandboxes: number | null;
+    /** vCPU its apps and databases may be using right now (measured). */
+    maxCpuVcpus: number | null;
+    /** Memory (MB) its apps and databases may be using right now (measured). */
+    maxMemoryMb: number | null;
+}
+interface WorkspaceUsage {
+    runningSandboxes: number;
+    /** Measured, all regions, its apps and databases. */
+    cpuVcpus: number;
+    memoryMb: number;
+    /** Unix ms of the oldest reading in the sum; null when nothing was measured. */
+    measuredAt: number | null;
+}
+interface WorkspaceLimitsInfo {
+    limits: WorkspaceLimits;
+    usage: WorkspaceUsage;
+}
 interface CreateWorkspaceOpts {
     name: string;
 }
@@ -1550,6 +1571,27 @@ declare class WorkspacesAPI {
     setResalePricing(id: string, multipliers: Partial<ResaleMultipliers>): Promise<ResalePricing>;
     /** Turn resale prices off: scoped keys see Lizard's prices again (owner only). */
     clearResalePricing(id: string): Promise<ResalePricing>;
+    /**
+     * The workspace's limits and what it uses now. Anyone in the workspace may read them,
+     * including a key scoped to it (your customer sees how close they are).
+     */
+    getLimits(id: string): Promise<WorkspaceLimitsInfo>;
+    /**
+     * Limit what a workspace may run at once (owner only, key with no scopes). A field left out
+     * stays as it is; `null` removes that limit.
+     *
+     * - `maxRunningSandboxes`: a create, fork or resume past it fails with HTTP 429
+     *   `WORKSPACE_SANDBOX_LIMIT`.
+     * - `maxCpuVcpus` / `maxMemoryMb`: what its apps and databases USE (measured every ~10 s,
+     *   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.
+     *
+     * ```ts
+     * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+     * ```
+     */
+    setLimits(id: string, limits: Partial<WorkspaceLimits>): Promise<WorkspaceLimitsInfo>;
     /**
      * Delete a workspace.
      *
@@ -2384,4 +2426,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, 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 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

@@ -1752,6 +1752,31 @@ var WorkspacesAPI = class {
   clearResalePricing(id) {
     return this.client.put(`/api/workspaces/${id}/resale-pricing`, {});
   }
+  /**
+   * The workspace's limits and what it uses now. Anyone in the workspace may read them,
+   * including a key scoped to it (your customer sees how close they are).
+   */
+  getLimits(id) {
+    return this.client.get(`/api/workspaces/${id}/limits`);
+  }
+  /**
+   * Limit what a workspace may run at once (owner only, key with no scopes). A field left out
+   * stays as it is; `null` removes that limit.
+   *
+   * - `maxRunningSandboxes`: a create, fork or resume past it fails with HTTP 429
+   *   `WORKSPACE_SANDBOX_LIMIT`.
+   * - `maxCpuVcpus` / `maxMemoryMb`: what its apps and databases USE (measured every ~10 s,
+   *   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.
+   *
+   * ```ts
+   * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+   * ```
+   */
+  setLimits(id, limits) {
+    return this.client.put(`/api/workspaces/${id}/limits`, limits);
+  }
   /**
    * Delete a workspace.
    *

package/dist/index.mjs

@@ -1699,6 +1699,31 @@ var WorkspacesAPI = class {
   clearResalePricing(id) {
     return this.client.put(`/api/workspaces/${id}/resale-pricing`, {});
   }
+  /**
+   * The workspace's limits and what it uses now. Anyone in the workspace may read them,
+   * including a key scoped to it (your customer sees how close they are).
+   */
+  getLimits(id) {
+    return this.client.get(`/api/workspaces/${id}/limits`);
+  }
+  /**
+   * Limit what a workspace may run at once (owner only, key with no scopes). A field left out
+   * stays as it is; `null` removes that limit.
+   *
+   * - `maxRunningSandboxes`: a create, fork or resume past it fails with HTTP 429
+   *   `WORKSPACE_SANDBOX_LIMIT`.
+   * - `maxCpuVcpus` / `maxMemoryMb`: what its apps and databases USE (measured every ~10 s,
+   *   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.
+   *
+   * ```ts
+   * await lizard.workspaces.setLimits(ws.id, { maxRunningSandboxes: 5, maxCpuVcpus: 2, maxMemoryMb: 4096 })
+   * ```
+   */
+  setLimits(id, limits) {
+    return this.client.put(`/api/workspaces/${id}/limits`, limits);
+  }
   /**
    * Delete a workspace.
    *

package/package.json

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