@lizard-build/sdk 0.1.41 → 0.1.43

package/dist/index.d.mts

@@ -1352,9 +1352,15 @@ interface VolumeInfo {
     status: string;
     attachedTo?: string | null;
     createdAt: number;
+    /**
+     * Whether `sizeGb` is actually enforced as a hard limit on the volume's node.
+     * Returned by {@link Volume.resize}; `false` means the size was recorded but the
+     * node cannot enforce it, so writes past it are not refused.
+     */
+    sizeEnforced?: boolean;
 }
 interface CreateVolumeOpts extends ConnectionOpts {
-    /** Whole GB, default 5. New volumes allow 1–50 GB unless the server config sets another maximum. Existing volumes are never resized. */
+    /** Whole GB, default 5. New volumes allow 1–50 GB unless the server config sets another maximum. Creating never changes an existing volume's size; use `Volume.resize` for that. */
     sizeGb?: number;
     /**
      * Region to place the volume in, e.g. `'us-east-1'`. A volume is node-local, so
@@ -1399,8 +1405,8 @@ declare class Volume {
      * exist yet. This is the reason a volume's name is its key: an agent that wants
      * "the scratch disk for this task" no longer has to store an id between runs.
      *
-     * An existing volume is returned as-is — `sizeGb` applies only to a fresh create
-     * and never resizes one that is already there.
+     * An existing volume is returned as-is — `sizeGb` applies only to a fresh create,
+     * so an existing volume keeps its size. Call {@link Volume.resize} to change it.
      */
     static getOrCreate(projectId: string, name: string, opts?: CreateVolumeOpts): Promise<Volume>;
     /** Look a volume up by name or by id. */
@@ -1408,7 +1414,26 @@ declare class Volume {
     static list(projectId: string, opts?: ConnectionOpts): Promise<VolumeInfo[]>;
     /** Delete a volume by name or by id, without constructing one first. */
     static delete(projectId: string, nameOrId: string, opts?: ConnectionOpts): Promise<void>;
+    /**
+     * Resize a volume, by name or by id, to `sizeGb`.
+     *
+     * The change is in place and online: the size is a quota, so no data is copied,
+     * it completes in well under a second, and a sandbox that has the volume mounted
+     * keeps running and sees the new size immediately. Both growing and shrinking are
+     * allowed, but a shrink must leave at least 10% of the new size free — otherwise
+     * it throws `ConflictError` with `code: 'volume_too_full_to_shrink'`.
+     *
+     * Other failures carry a `code` too: `invalid_volume_size`, `volume_not_resizable`,
+     * `volume_resize_in_progress`, `volume_not_provisioned`,
+     * `volume_capacity_unavailable`, and `volume_resize_timeout` (a `TimeoutError`;
+     * the size is left unchanged).
+     *
+     * @returns The volume's updated info, including `sizeEnforced`.
+     */
+    static resize(projectId: string, nameOrId: string, sizeGb: number, opts?: ConnectionOpts): Promise<VolumeInfo>;
     getInfo(projectId: string): Promise<VolumeInfo>;
+    /** Resize this volume in place — see the static {@link Volume.resize}. */
+    resize(projectId: string, sizeGb: number): Promise<VolumeInfo>;
     delete(projectId: string): Promise<void>;
 }
 
@@ -1508,6 +1533,7 @@ declare class Lizard {
         getOrCreate: (name: string, opts?: CreateVolumeOpts) => Promise<Volume>;
         get: (nameOrId: string, opts?: ConnectionOpts) => Promise<Volume>;
         list: (opts?: ConnectionOpts) => Promise<VolumeInfo[]>;
+        resize: (nameOrId: string, sizeGb: number, opts?: ConnectionOpts) => Promise<VolumeInfo>;
         delete: (nameOrId: string, opts?: ConnectionOpts) => Promise<void>;
     };
     /**
@@ -1557,6 +1583,13 @@ interface Account {
 declare function resolveProjectId(ref: string, config: ConnectionConfig): Promise<string>;
 
 declare class LizardError extends Error {
+    /** HTTP status of the failed API call, when the error came from one. */
+    status?: number;
+    /**
+     * The server's machine-readable error code, when it sent one — e.g.
+     * `'volume_too_full_to_shrink'`. Branch on this rather than on `message`.
+     */
+    code?: string;
     constructor(message: string);
 }
 /** Config was saved, but one or more deploy/restart actions failed. Never retry blindly. */

package/dist/index.d.ts

@@ -1352,9 +1352,15 @@ interface VolumeInfo {
     status: string;
     attachedTo?: string | null;
     createdAt: number;
+    /**
+     * Whether `sizeGb` is actually enforced as a hard limit on the volume's node.
+     * Returned by {@link Volume.resize}; `false` means the size was recorded but the
+     * node cannot enforce it, so writes past it are not refused.
+     */
+    sizeEnforced?: boolean;
 }
 interface CreateVolumeOpts extends ConnectionOpts {
-    /** Whole GB, default 5. New volumes allow 1–50 GB unless the server config sets another maximum. Existing volumes are never resized. */
+    /** Whole GB, default 5. New volumes allow 1–50 GB unless the server config sets another maximum. Creating never changes an existing volume's size; use `Volume.resize` for that. */
     sizeGb?: number;
     /**
      * Region to place the volume in, e.g. `'us-east-1'`. A volume is node-local, so
@@ -1399,8 +1405,8 @@ declare class Volume {
      * exist yet. This is the reason a volume's name is its key: an agent that wants
      * "the scratch disk for this task" no longer has to store an id between runs.
      *
-     * An existing volume is returned as-is — `sizeGb` applies only to a fresh create
-     * and never resizes one that is already there.
+     * An existing volume is returned as-is — `sizeGb` applies only to a fresh create,
+     * so an existing volume keeps its size. Call {@link Volume.resize} to change it.
      */
     static getOrCreate(projectId: string, name: string, opts?: CreateVolumeOpts): Promise<Volume>;
     /** Look a volume up by name or by id. */
@@ -1408,7 +1414,26 @@ declare class Volume {
     static list(projectId: string, opts?: ConnectionOpts): Promise<VolumeInfo[]>;
     /** Delete a volume by name or by id, without constructing one first. */
     static delete(projectId: string, nameOrId: string, opts?: ConnectionOpts): Promise<void>;
+    /**
+     * Resize a volume, by name or by id, to `sizeGb`.
+     *
+     * The change is in place and online: the size is a quota, so no data is copied,
+     * it completes in well under a second, and a sandbox that has the volume mounted
+     * keeps running and sees the new size immediately. Both growing and shrinking are
+     * allowed, but a shrink must leave at least 10% of the new size free — otherwise
+     * it throws `ConflictError` with `code: 'volume_too_full_to_shrink'`.
+     *
+     * Other failures carry a `code` too: `invalid_volume_size`, `volume_not_resizable`,
+     * `volume_resize_in_progress`, `volume_not_provisioned`,
+     * `volume_capacity_unavailable`, and `volume_resize_timeout` (a `TimeoutError`;
+     * the size is left unchanged).
+     *
+     * @returns The volume's updated info, including `sizeEnforced`.
+     */
+    static resize(projectId: string, nameOrId: string, sizeGb: number, opts?: ConnectionOpts): Promise<VolumeInfo>;
     getInfo(projectId: string): Promise<VolumeInfo>;
+    /** Resize this volume in place — see the static {@link Volume.resize}. */
+    resize(projectId: string, sizeGb: number): Promise<VolumeInfo>;
     delete(projectId: string): Promise<void>;
 }
 
@@ -1508,6 +1533,7 @@ declare class Lizard {
         getOrCreate: (name: string, opts?: CreateVolumeOpts) => Promise<Volume>;
         get: (nameOrId: string, opts?: ConnectionOpts) => Promise<Volume>;
         list: (opts?: ConnectionOpts) => Promise<VolumeInfo[]>;
+        resize: (nameOrId: string, sizeGb: number, opts?: ConnectionOpts) => Promise<VolumeInfo>;
         delete: (nameOrId: string, opts?: ConnectionOpts) => Promise<void>;
     };
     /**
@@ -1557,6 +1583,13 @@ interface Account {
 declare function resolveProjectId(ref: string, config: ConnectionConfig): Promise<string>;
 
 declare class LizardError extends Error {
+    /** HTTP status of the failed API call, when the error came from one. */
+    status?: number;
+    /**
+     * The server's machine-readable error code, when it sent one — e.g.
+     * `'volume_too_full_to_shrink'`. Branch on this rather than on `message`.
+     */
+    code?: string;
     constructor(message: string);
 }
 /** Config was saved, but one or more deploy/restart actions failed. Never retry blindly. */

package/dist/index.js

@@ -112,17 +112,23 @@ var TimeoutError = class extends LizardError {
 };
 async function handleApiError(res) {
   let message;
+  let code;
   try {
     const body = await res.json();
     message = body.error ?? res.statusText;
+    if (typeof body.code === "string") code = body.code;
   } catch {
     message = res.statusText;
   }
-  if (res.status === 401 || res.status === 403) throw new AuthenticationError(message);
-  if (res.status === 404) throw new NotFoundError(message);
-  if (res.status === 409) throw new ConflictError(message);
-  if (res.status === 408 || res.status === 504) throw new TimeoutError(message);
-  throw new LizardError(`API error ${res.status}: ${message}`);
+  let err;
+  if (res.status === 401 || res.status === 403) err = new AuthenticationError(message);
+  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}`);
+  err.status = res.status;
+  err.code = code;
+  throw err;
 }
 
 // src/platform/client.ts
@@ -1565,8 +1571,8 @@ var Volume = class _Volume {
    * exist yet. This is the reason a volume's name is its key: an agent that wants
    * "the scratch disk for this task" no longer has to store an id between runs.
    *
-   * An existing volume is returned as-is — `sizeGb` applies only to a fresh create
-   * and never resizes one that is already there.
+   * An existing volume is returned as-is — `sizeGb` applies only to a fresh create,
+   * so an existing volume keeps its size. Call {@link Volume.resize} to change it.
    */
   static async getOrCreate(projectId, name, opts) {
     const config = new ConnectionConfig(opts);
@@ -1606,6 +1612,32 @@ var Volume = class _Volume {
     });
     if (!res.ok) await handleApiError(res);
   }
+  /**
+   * Resize a volume, by name or by id, to `sizeGb`.
+   *
+   * The change is in place and online: the size is a quota, so no data is copied,
+   * it completes in well under a second, and a sandbox that has the volume mounted
+   * keeps running and sees the new size immediately. Both growing and shrinking are
+   * allowed, but a shrink must leave at least 10% of the new size free — otherwise
+   * it throws `ConflictError` with `code: 'volume_too_full_to_shrink'`.
+   *
+   * Other failures carry a `code` too: `invalid_volume_size`, `volume_not_resizable`,
+   * `volume_resize_in_progress`, `volume_not_provisioned`,
+   * `volume_capacity_unavailable`, and `volume_resize_timeout` (a `TimeoutError`;
+   * the size is left unchanged).
+   *
+   * @returns The volume's updated info, including `sizeEnforced`.
+   */
+  static async resize(projectId, nameOrId, sizeGb, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes/${encodeURIComponent(nameOrId)}`, {
+      method: "PATCH",
+      headers: config.headers,
+      body: JSON.stringify({ sizeGb })
+    });
+    if (!res.ok) await handleApiError(res);
+    return res.json();
+  }
   async getInfo(projectId) {
     const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
       headers: this.config.headers
@@ -1613,6 +1645,13 @@ var Volume = class _Volume {
     if (!res.ok) await handleApiError(res);
     return res.json();
   }
+  /** Resize this volume in place — see the static {@link Volume.resize}. */
+  async resize(projectId, sizeGb) {
+    return _Volume.resize(projectId, this.volumeId, sizeGb, {
+      apiKey: this.config.apiKey,
+      apiUrl: this.config.apiUrl
+    });
+  }
   async delete(projectId) {
     const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
       method: "DELETE",
@@ -1646,6 +1685,7 @@ var Lizard = class {
       getOrCreate: async (name, opts) => Volume.getOrCreate(await this.projectId(), name, { ...await this.connectionOpts(), ...opts }),
       get: async (nameOrId, opts) => Volume.get(await this.projectId(), nameOrId, { ...await this.connectionOpts(), ...opts }),
       list: async (opts) => Volume.list(await this.projectId(), { ...await this.connectionOpts(), ...opts }),
+      resize: async (nameOrId, sizeGb, opts) => Volume.resize(await this.projectId(), nameOrId, sizeGb, { ...await this.connectionOpts(), ...opts }),
       delete: async (nameOrId, opts) => Volume.delete(await this.projectId(), nameOrId, { ...await this.connectionOpts(), ...opts })
     };
     this.config = new ConnectionConfig(opts);

package/dist/index.mjs

@@ -61,17 +61,23 @@ var TimeoutError = class extends LizardError {
 };
 async function handleApiError(res) {
   let message;
+  let code;
   try {
     const body = await res.json();
     message = body.error ?? res.statusText;
+    if (typeof body.code === "string") code = body.code;
   } catch {
     message = res.statusText;
   }
-  if (res.status === 401 || res.status === 403) throw new AuthenticationError(message);
-  if (res.status === 404) throw new NotFoundError(message);
-  if (res.status === 409) throw new ConflictError(message);
-  if (res.status === 408 || res.status === 504) throw new TimeoutError(message);
-  throw new LizardError(`API error ${res.status}: ${message}`);
+  let err;
+  if (res.status === 401 || res.status === 403) err = new AuthenticationError(message);
+  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}`);
+  err.status = res.status;
+  err.code = code;
+  throw err;
 }
 
 // src/platform/client.ts
@@ -1514,8 +1520,8 @@ var Volume = class _Volume {
    * exist yet. This is the reason a volume's name is its key: an agent that wants
    * "the scratch disk for this task" no longer has to store an id between runs.
    *
-   * An existing volume is returned as-is — `sizeGb` applies only to a fresh create
-   * and never resizes one that is already there.
+   * An existing volume is returned as-is — `sizeGb` applies only to a fresh create,
+   * so an existing volume keeps its size. Call {@link Volume.resize} to change it.
    */
   static async getOrCreate(projectId, name, opts) {
     const config = new ConnectionConfig(opts);
@@ -1555,6 +1561,32 @@ var Volume = class _Volume {
     });
     if (!res.ok) await handleApiError(res);
   }
+  /**
+   * Resize a volume, by name or by id, to `sizeGb`.
+   *
+   * The change is in place and online: the size is a quota, so no data is copied,
+   * it completes in well under a second, and a sandbox that has the volume mounted
+   * keeps running and sees the new size immediately. Both growing and shrinking are
+   * allowed, but a shrink must leave at least 10% of the new size free — otherwise
+   * it throws `ConflictError` with `code: 'volume_too_full_to_shrink'`.
+   *
+   * Other failures carry a `code` too: `invalid_volume_size`, `volume_not_resizable`,
+   * `volume_resize_in_progress`, `volume_not_provisioned`,
+   * `volume_capacity_unavailable`, and `volume_resize_timeout` (a `TimeoutError`;
+   * the size is left unchanged).
+   *
+   * @returns The volume's updated info, including `sizeEnforced`.
+   */
+  static async resize(projectId, nameOrId, sizeGb, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes/${encodeURIComponent(nameOrId)}`, {
+      method: "PATCH",
+      headers: config.headers,
+      body: JSON.stringify({ sizeGb })
+    });
+    if (!res.ok) await handleApiError(res);
+    return res.json();
+  }
   async getInfo(projectId) {
     const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
       headers: this.config.headers
@@ -1562,6 +1594,13 @@ var Volume = class _Volume {
     if (!res.ok) await handleApiError(res);
     return res.json();
   }
+  /** Resize this volume in place — see the static {@link Volume.resize}. */
+  async resize(projectId, sizeGb) {
+    return _Volume.resize(projectId, this.volumeId, sizeGb, {
+      apiKey: this.config.apiKey,
+      apiUrl: this.config.apiUrl
+    });
+  }
   async delete(projectId) {
     const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
       method: "DELETE",
@@ -1595,6 +1634,7 @@ var Lizard = class {
       getOrCreate: async (name, opts) => Volume.getOrCreate(await this.projectId(), name, { ...await this.connectionOpts(), ...opts }),
       get: async (nameOrId, opts) => Volume.get(await this.projectId(), nameOrId, { ...await this.connectionOpts(), ...opts }),
       list: async (opts) => Volume.list(await this.projectId(), { ...await this.connectionOpts(), ...opts }),
+      resize: async (nameOrId, sizeGb, opts) => Volume.resize(await this.projectId(), nameOrId, sizeGb, { ...await this.connectionOpts(), ...opts }),
       delete: async (nameOrId, opts) => Volume.delete(await this.projectId(), nameOrId, { ...await this.connectionOpts(), ...opts })
     };
     this.config = new ConnectionConfig(opts);

package/package.json

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