@lizard-build/sdk 0.1.46 → 0.1.47

package/README.md

@@ -38,6 +38,14 @@ try {
 
 The package includes TypeScript declarations and ESM and CommonJS builds. For CommonJS, use `const { Lizard } = require('@lizard-build/sdk')` inside a program with an async entry point.
 
+## Machine size
+
+Sandboxes come in three sizes: `small` (2 vCPU / 4 GB, $0.009/h), `medium` (4 vCPU / 8 GB, $0.018/h, the default) and `large` (8 vCPU / 16 GB, $0.036/h). Billing is flat by size, per second while the sandbox runs; measured CPU/RAM are not charged, egress is free, and volumes bill separately.
+
+```ts
+const sandbox = await lizard.create('base', { size: 'large' })
+```
+
 ## Stream command output
 
 Inside the `try` block above:

package/dist/index.d.mts

@@ -651,7 +651,9 @@ interface SandboxInfo {
     region?: string;
     status?: string;
     pauseError?: string | null;
+    /** Machine size (`'small' | 'medium' | 'large'`); may be `null` for a sandbox created from a private snapshot. */
     size?: 'small' | 'medium' | 'large' | null;
+    /** Flat hourly price in USD for `size`, billed per second while running; may be `null` when billed by measured usage (private snapshot). */
     pricePerHour?: number | null;
     cpus?: number;
     memoryMb?: number;
@@ -660,15 +662,28 @@ interface SandboxInfo {
 interface SandboxOpts extends ConnectionOpts {
     /**
      * The project this sandbox belongs to — its ID, slug, or name. Required:
-     * a sandbox must be attributed to a project so its CPU, RAM, egress, and
-     * storage are billed. Prefer the {@link Lizard} client, which pins a project
+     * a sandbox must be attributed to a project so its usage is billed there —
+     * a flat hourly price per {@link SandboxOpts.size}, charged per second while
+     * it runs (attached volumes bill separately). Prefer the {@link Lizard} client, which pins a project
      * for you. Ignored when {@link SandboxOpts.projectId} is set.
      */
     project?: string;
     /** Exact project ID — skips resolving {@link SandboxOpts.project}. */
     projectId?: string;
     template?: string;
+    /**
+     * Create from a private saved snapshot. The sandbox runs on the machine the
+     * snapshot was captured on and is billed by measured usage; `size` is ignored.
+     */
     snapshotId?: string;
+    /**
+     * Machine size, billed flat per hour (per second of running time):
+     * - `'small'`  — 2 vCPU / 4 GB, $0.009/h
+     * - `'medium'` — 4 vCPU / 8 GB, $0.018/h (default)
+     * - `'large'`  — 8 vCPU / 16 GB, $0.036/h
+     *
+     * Measured CPU/RAM are not charged and egress is free. Ignored with {@link SandboxOpts.snapshotId}.
+     */
     size?: 'small' | 'medium' | 'large';
     metadata?: Record<string, string>;
     envs?: Record<string, string>;

package/dist/index.d.ts

@@ -651,7 +651,9 @@ interface SandboxInfo {
     region?: string;
     status?: string;
     pauseError?: string | null;
+    /** Machine size (`'small' | 'medium' | 'large'`); may be `null` for a sandbox created from a private snapshot. */
     size?: 'small' | 'medium' | 'large' | null;
+    /** Flat hourly price in USD for `size`, billed per second while running; may be `null` when billed by measured usage (private snapshot). */
     pricePerHour?: number | null;
     cpus?: number;
     memoryMb?: number;
@@ -660,15 +662,28 @@ interface SandboxInfo {
 interface SandboxOpts extends ConnectionOpts {
     /**
      * The project this sandbox belongs to — its ID, slug, or name. Required:
-     * a sandbox must be attributed to a project so its CPU, RAM, egress, and
-     * storage are billed. Prefer the {@link Lizard} client, which pins a project
+     * a sandbox must be attributed to a project so its usage is billed there —
+     * a flat hourly price per {@link SandboxOpts.size}, charged per second while
+     * it runs (attached volumes bill separately). Prefer the {@link Lizard} client, which pins a project
      * for you. Ignored when {@link SandboxOpts.projectId} is set.
      */
     project?: string;
     /** Exact project ID — skips resolving {@link SandboxOpts.project}. */
     projectId?: string;
     template?: string;
+    /**
+     * Create from a private saved snapshot. The sandbox runs on the machine the
+     * snapshot was captured on and is billed by measured usage; `size` is ignored.
+     */
     snapshotId?: string;
+    /**
+     * Machine size, billed flat per hour (per second of running time):
+     * - `'small'`  — 2 vCPU / 4 GB, $0.009/h
+     * - `'medium'` — 4 vCPU / 8 GB, $0.018/h (default)
+     * - `'large'`  — 8 vCPU / 16 GB, $0.036/h
+     *
+     * Measured CPU/RAM are not charged and egress is free. Ignored with {@link SandboxOpts.snapshotId}.
+     */
     size?: 'small' | 'medium' | 'large';
     metadata?: Record<string, string>;
     envs?: Record<string, string>;

package/package.json

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