@blaxel/core 0.2.96-preview.204 → 0.2.96-preview.205

package/dist/esm-browser/common/pagination.js

@@ -0,0 +1,88 @@
+export function unwrapListData(response) {
+    if (!response) {
+        return [];
+    }
+    if (Array.isArray(response)) {
+        return response;
+    }
+    return response.data ?? [];
+}
+function unwrapListMeta(response) {
+    if (!response || Array.isArray(response)) {
+        return { hasMore: false };
+    }
+    return response.meta ?? { hasMore: false };
+}
+export async function createPaginatedList({ response, fetchPage, mapItem, query, seenCursors, }) {
+    const meta = unwrapListMeta(response);
+    const data = await Promise.all(unwrapListData(response).map(mapItem));
+    const cursors = new Set(seenCursors);
+    if (query?.cursor) {
+        cursors.add(query.cursor);
+    }
+    const list = {
+        data,
+        meta,
+        // Derive `hasMore` from cursor presence, not `meta.hasMore`: `nextPage()`
+        // can only advance when there is a `nextCursor`, so a consumer doing
+        // `if (page.hasMore) await page.nextPage()` must never see `hasMore: true`
+        // while `nextPage()` returns null. Keeping the two in sync prevents silent
+        // truncation if the API ever sends `hasMore: true` without a cursor.
+        get hasMore() {
+            return Boolean(list.nextCursor);
+        },
+        get nextCursor() {
+            return meta.nextCursor || undefined;
+        },
+        async nextPage() {
+            const cursor = list.nextCursor;
+            if (!cursor) {
+                return null;
+            }
+            if (cursors.has(cursor)) {
+                throw new Error("Pagination returned a repeated cursor");
+            }
+            const nextQuery = { ...(query ?? {}), cursor };
+            const nextSeenCursors = new Set(cursors);
+            nextSeenCursors.add(cursor);
+            return createPaginatedList({
+                response: await fetchPage(nextQuery),
+                fetchPage,
+                mapItem,
+                query: nextQuery,
+                seenCursors: nextSeenCursors,
+            });
+        },
+        async autoPagingEach(onItem) {
+            for await (const item of list) {
+                const shouldContinue = await onItem(item);
+                if (shouldContinue === false) {
+                    return;
+                }
+            }
+        },
+        async autoPagingToArray(options) {
+            if (!options || !Number.isFinite(options.limit) || options.limit <= 0) {
+                throw new Error("autoPagingToArray requires a positive limit");
+            }
+            const items = [];
+            for await (const item of list) {
+                items.push(item);
+                if (items.length >= options.limit) {
+                    return items;
+                }
+            }
+            return items;
+        },
+        async *[Symbol.asyncIterator]() {
+            let page = list;
+            while (page) {
+                for (const item of page.data) {
+                    yield item;
+                }
+                page = await page.nextPage();
+            }
+        },
+    };
+    return list;
+}

package/dist/esm-browser/common/pagination.test.js

@@ -0,0 +1,79 @@
+import { describe, expect, it } from "vitest";
+import { createPaginatedList, unwrapListData } from "./pagination.js";
+describe("pagination helpers", () => {
+    it("unwraps legacy array and paginated list responses", () => {
+        expect(unwrapListData([{ name: "legacy" }])).toEqual([{ name: "legacy" }]);
+        expect(unwrapListData({
+            data: [{ name: "paginated" }],
+            meta: { hasMore: false },
+        })).toEqual([{ name: "paginated" }]);
+    });
+    it("returns page data and lets callers request the next page", async () => {
+        const cursors = [];
+        const fetchPage = async (query) => {
+            await Promise.resolve();
+            cursors.push(query?.cursor);
+            if (!query?.cursor) {
+                return {
+                    data: ["first"],
+                    meta: { hasMore: true, nextCursor: "next-page" },
+                };
+            }
+            return {
+                data: ["second"],
+                meta: { hasMore: false },
+            };
+        };
+        const page = await createPaginatedList({
+            response: await fetchPage(),
+            fetchPage,
+            mapItem: (item) => item.toUpperCase(),
+        });
+        expect(page.data).toEqual(["FIRST"]);
+        expect(page.hasMore).toBe(true);
+        expect(page.nextCursor).toBe("next-page");
+        const nextPage = await page.nextPage();
+        expect(nextPage?.data).toEqual(["SECOND"]);
+        expect(cursors).toEqual([undefined, "next-page"]);
+    });
+    it("keeps hasMore consistent with nextPage when the API omits a cursor", async () => {
+        const fetchPage = async () => {
+            await Promise.resolve();
+            // API reports more data but gives no cursor to fetch it.
+            return {
+                data: ["only"],
+                meta: { hasMore: true },
+            };
+        };
+        const page = await createPaginatedList({
+            response: await fetchPage(),
+            fetchPage,
+            mapItem: (item) => item,
+        });
+        // hasMore must reflect what nextPage() can actually deliver.
+        expect(page.hasMore).toBe(false);
+        await expect(page.nextPage()).resolves.toBeNull();
+        await expect(page.autoPagingToArray({ limit: 10 })).resolves.toEqual(["only"]);
+    });
+    it("supports auto paging with an explicit limit", async () => {
+        const fetchPage = async (query) => {
+            await Promise.resolve();
+            if (!query?.cursor) {
+                return {
+                    data: ["first"],
+                    meta: { hasMore: true, nextCursor: "next-page" },
+                };
+            }
+            return {
+                data: ["second"],
+                meta: { hasMore: false },
+            };
+        };
+        const page = await createPaginatedList({
+            response: await fetchPage(),
+            fetchPage,
+            mapItem: (item) => item,
+        });
+        await expect(page.autoPagingToArray({ limit: 2 })).resolves.toEqual(["first", "second"]);
+    });
+});

package/dist/esm-browser/common/settings.js

@@ -22,10 +22,10 @@ function missingCredentialsMessage() {
     return "No Blaxel credentials found. Set the BL_API_KEY and BL_WORKSPACE environment variables, or run `bl login`.";
 }
 // Build info - these placeholders are replaced at build time by build:replace-imports
-const BUILD_VERSION = "0.2.96-preview.204";
-const BUILD_COMMIT = "05c335edad327feae5ecd407b96b385a7662a701";
+const BUILD_VERSION = "0.2.96-preview.205";
+const BUILD_COMMIT = "b2439e6cde8dee15ff0ff166366670a4f48d8ade";
 const BUILD_SENTRY_DSN = "https://fd5e60e1c9820e1eef5ccebb84a07127@o4508714045276160.ingest.us.sentry.io/4510465864564736";
-const BLAXEL_API_VERSION = "2026-04-16";
+const BLAXEL_API_VERSION = "2026-04-28";
 // Cache for config.yaml tracking value
 let configTrackingValue = null;
 let configTrackingLoaded = false;

package/dist/esm-browser/common/settings.test.js

@@ -8,10 +8,10 @@ describe('Settings.apiVersion', () => {
     afterEach(() => {
         delete env.BL_API_VERSION;
     });
-    it('defaults to 2026-04-16 when BL_API_VERSION is not set', async () => {
+    it('defaults to 2026-04-28 when BL_API_VERSION is not set', async () => {
         delete env.BL_API_VERSION;
         const { settings } = await import('./settings.js');
-        expect(settings.apiVersion).toBe('2026-04-16');
+        expect(settings.apiVersion).toBe('2026-04-28');
     });
     it('headers include Blaxel-Version set to the default', async () => {
         delete env.BL_API_VERSION;
@@ -20,7 +20,7 @@ describe('Settings.apiVersion', () => {
         const previous = settings.credentials;
         settings.credentials = new ApiKey({ apiKey: 'test-key', workspace: 'test-ws' });
         try {
-            expect(settings.headers['Blaxel-Version']).toBe('2026-04-16');
+            expect(settings.headers['Blaxel-Version']).toBe('2026-04-28');
         }
         finally {
             settings.credentials = previous;

package/dist/esm-browser/drive/index.js

@@ -1,5 +1,6 @@
 import { v4 as uuidv4 } from "uuid";
 import { createDrive, deleteDrive, getDrive, listDrives, updateDrive } from "../client/index.js";
+import { createPaginatedList } from "../common/pagination.js";
 import { settings } from "../common/settings.js";
 export class DriveInstance {
     drive;
@@ -87,10 +88,44 @@ export class DriveInstance {
         });
         return new DriveInstance(data);
     }
-    static async list() {
-        const { data } = await listDrives({ throwOnError: true });
-        const items = Array.isArray(data) ? data : (data?.data ?? []);
-        return items.map((drive) => new DriveInstance(drive));
+    /**
+     * List one page of drives.
+     *
+     * The returned page exposes `data` for the current page, `meta` for cursor
+     * metadata, and helpers to fetch more pages only when you need them.
+     *
+     * @example
+     * ```ts
+     * const page = await DriveInstance.list({ limit: 50 });
+     *
+     * for (const drive of page.data) {
+     *   console.log(drive.name);
+     * }
+     *
+     * const nextPage = await page.nextPage();
+     * ```
+     *
+     * @example
+     * ```ts
+     * const allDrives = await (await DriveInstance.list()).autoPagingToArray({
+     *   limit: 1000,
+     * });
+     * ```
+     */
+    static async list(query) {
+        const fetchPage = async (pageQuery) => {
+            const { data } = await listDrives({
+                query: pageQuery,
+                throwOnError: true,
+            });
+            return data;
+        };
+        return createPaginatedList({
+            response: await fetchPage(query),
+            fetchPage,
+            mapItem: (drive) => new DriveInstance(drive),
+            query,
+        });
     }
     static async delete(driveName) {
         const { data } = await deleteDrive({

package/dist/esm-browser/index.js

@@ -7,6 +7,7 @@ export * from "./common/node.js";
 export * from "./common/errors.js";
 export * from "./common/internal.js";
 export * from "./common/logger.js";
+export * from "./common/pagination.js";
 export * from "./common/settings.js";
 export * from "./common/webhook.js";
 export * from "./drive/index.js";

package/dist/esm-browser/jobs/jobs.js

@@ -1,5 +1,6 @@
 import { createJobExecution, deleteJobExecution, getJobExecution, listJobExecutions, } from "../client/index.js";
 import { logger } from "../common/logger.js";
+import { createPaginatedList } from "../common/pagination.js";
 import { settings } from "../common/settings.js";
 import { startSpan } from "../telemetry/telemetry.js";
 class BlJob {
@@ -75,19 +76,50 @@ class BlJob {
         return data;
     }
     /**
-     * List all executions for this job
+     * List one page of executions for this job.
+     *
+     * The returned page exposes `data` for the current page, `meta` for cursor
+     * metadata, and helpers to fetch more pages only when you need them.
+     *
+     * @example
+     * ```ts
+     * const job = blJob("daily-import");
+     * const page = await job.listExecutions({ limit: 50 });
+     *
+     * for (const execution of page.data) {
+     *   console.log(execution.status);
+     * }
+     *
+     * const nextPage = await page.nextPage();
+     * ```
+     *
+     * @example
+     * ```ts
+     * const job = blJob("daily-import");
+     * const executions = await (await job.listExecutions()).autoPagingToArray({
+     *   limit: 1000,
+     * });
+     * ```
      */
-    async listExecutions() {
+    async listExecutions(query) {
         logger.debug(`Listing executions for job: ${this.jobName}`);
-        const { data } = await listJobExecutions({
-            path: {
-                jobId: this.jobName,
-            },
-            headers: settings.headers,
-            throwOnError: true,
+        const fetchPage = async (pageQuery) => {
+            const { data } = await listJobExecutions({
+                path: {
+                    jobId: this.jobName,
+                },
+                query: pageQuery,
+                headers: settings.headers,
+                throwOnError: true,
+            });
+            return data;
+        };
+        return createPaginatedList({
+            response: await fetchPage(query),
+            fetchPage,
+            mapItem: (execution) => execution,
+            query,
         });
-        const items = Array.isArray(data) ? data : (data?.data ?? []);
-        return items;
     }
     /**
      * Get the status of a specific execution

package/dist/esm-browser/sandbox/client/sdk.gen.js

@@ -86,7 +86,7 @@ export const getDrivesMount = (options) => {
 };
 /**
  * Attach a drive to a local path
- * Mounts an agent drive using the blfs binary to a local path, optionally mounting a subpath within the drive
+ * Mounts an agent drive using the blfs binary to a local path, optionally mounting a subpath within the drive. Supports optional UID/GID mapping to remap file ownership between the local sandbox and the filer (always mapped to filer UID/GID 0). Mapping values can be set per-request via uidMap/gidMap fields, or globally via BLFS_UID_MAP/BLFS_GID_MAP environment variables (request values take precedence).
  */
 export const postDrivesMount = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -607,7 +607,7 @@ export const getProcessByIdentifierLogsStream = (options) => {
  * Triggers an upgrade of the sandbox-api process. Returns 200 immediately before upgrading.
  * The upgrade will: download the specified binary from GitHub releases, validate it, and restart.
  * All running processes will be preserved across the upgrade.
- * Available versions: "develop" (default), "main", "latest", or specific tag like "v1.0.0"
+ * Available versions: "latest" (default, most recent release), "develop", "main", or specific tag like "v1.0.0"
  * You can also specify a custom baseUrl for forks (defaults to https://github.com/blaxel-ai/sandbox/releases)
  */
 export const postUpgrade = (options) => {

package/dist/esm-browser/sandbox/preview.js

@@ -99,24 +99,29 @@ export class SandboxPreviews {
         });
         return data.map((preview) => new SandboxPreview(preview));
     }
-    async create(preview) {
+    async create(preview, force) {
+        const query = {};
+        if (force) {
+            query['force'] = 'true';
+        }
         const { data } = await createSandboxPreview({
             path: {
                 sandboxName: this.sandboxName,
             },
+            query,
             body: preview,
             throwOnError: true,
         });
         return new SandboxPreview(data);
     }
-    async createIfNotExists(preview) {
+    async createIfNotExists(preview, force) {
         try {
             const previewInstance = await this.get(preview.metadata.name);
             return previewInstance;
         }
         catch (e) {
             if (typeof e === "object" && e !== null && "code" in e && e.code === 404) {
-                return this.create(preview);
+                return this.create(preview, force);
             }
             throw e;
         }

package/dist/esm-browser/sandbox/sandbox.js

@@ -1,6 +1,7 @@
 import { v4 as uuidv4 } from "uuid";
 import { createSandbox, deleteSandbox, getSandbox, getSandboxByExternalId, listSandboxes, updateSandbox } from "../client/index.js";
 import { logger } from "../common/logger.js";
+import { createPaginatedList } from "../common/pagination.js";
 import { settings } from "../common/settings.js";
 import { SandboxCodegen } from "./codegen/index.js";
 import { SandboxDrive } from "./drive/index.js";
@@ -247,40 +248,46 @@ export class SandboxInstance {
         const instance = new SandboxInstance(data);
         return SandboxInstance.attachH2Session(instance);
     }
-    static async list({ externalId } = {}) {
-        const { data: raw } = await listSandboxes({
-            query: externalId ? { externalId } : undefined,
-            throwOnError: true,
+    /**
+     * List one page of sandboxes.
+     *
+     * The returned page exposes `data` for the current page, `meta` for cursor
+     * metadata, and helpers to fetch more pages only when you need them.
+     *
+     * @example
+     * ```ts
+     * const page = await SandboxInstance.list({ limit: 50 });
+     *
+     * for (const sandbox of page.data) {
+     *   console.log(sandbox.metadata.name);
+     * }
+     *
+     * const nextPage = await page.nextPage();
+     * ```
+     *
+     * @example
+     * ```ts
+     * const page = await SandboxInstance.list({ limit: 100 });
+     *
+     * for await (const sandbox of page) {
+     *   console.log(sandbox.metadata.name);
+     * }
+     * ```
+     */
+    static async list(query) {
+        const fetchPage = async (pageQuery) => {
+            const { data } = await listSandboxes({
+                query: pageQuery,
+                throwOnError: true,
+            });
+            return data;
+        };
+        return createPaginatedList({
+            response: await fetchPage(query),
+            fetchPage,
+            mapItem: (sandbox) => SandboxInstance.attachH2Session(new SandboxInstance(sandbox)),
+            query,
         });
-        const items = (Array.isArray(raw) ? raw : (raw?.data ?? []));
-        const instances = items.map((sb) => new SandboxInstance(sb));
-        if (!settings.disableH2) {
-            const { h2Pool } = await import("../common/h2pool.js");
-            const uniqueDomains = [
-                ...new Set(instances
-                    .map((i) => SandboxInstance.edgeDomainForRegion(i.spec?.region))
-                    .filter((d) => d !== null)),
-            ];
-            const sessionByDomain = new Map();
-            await Promise.all(uniqueDomains.map(async (domain) => {
-                try {
-                    sessionByDomain.set(domain, await h2Pool.get(domain));
-                }
-                catch {
-                    sessionByDomain.set(domain, null);
-                }
-            }));
-            for (const instance of instances) {
-                const domain = SandboxInstance.edgeDomainForRegion(instance.spec?.region);
-                if (domain) {
-                    const session = sessionByDomain.get(domain) ?? null;
-                    instance.h2Session = session;
-                    instance.sandbox.h2Session = session;
-                    instance.sandbox.h2Domain = domain;
-                }
-            }
-        }
-        return instances;
     }
     static async delete(sandboxName) {
         const { data } = await deleteSandbox({

package/dist/esm-browser/volume/index.js

@@ -1,5 +1,6 @@
 import { v4 as uuidv4 } from "uuid";
 import { createVolume, deleteVolume, getVolume, listVolumes, updateVolume } from "../client/index.js";
+import { createPaginatedList } from "../common/pagination.js";
 import { settings } from "../common/settings.js";
 export class VolumeInstance {
     volume;
@@ -85,10 +86,46 @@ export class VolumeInstance {
         });
         return new VolumeInstance(data);
     }
-    static async list() {
-        const { data } = await listVolumes({ throwOnError: true });
-        const items = Array.isArray(data) ? data : (data?.data ?? []);
-        return items.map((volume) => new VolumeInstance(volume));
+    /**
+     * List one page of volumes.
+     *
+     * The returned page exposes `data` for the current page, `meta` for cursor
+     * metadata, and helpers to fetch more pages only when you need them.
+     *
+     * @example
+     * ```ts
+     * const page = await VolumeInstance.list({ limit: 50 });
+     *
+     * for (const volume of page.data) {
+     *   console.log(volume.name);
+     * }
+     *
+     * const nextPage = await page.nextPage();
+     * ```
+     *
+     * @example
+     * ```ts
+     * const page = await VolumeInstance.list({ limit: 100 });
+     *
+     * for await (const volume of page) {
+     *   console.log(volume.name);
+     * }
+     * ```
+     */
+    static async list(query) {
+        const fetchPage = async (pageQuery) => {
+            const { data } = await listVolumes({
+                query: pageQuery,
+                throwOnError: true,
+            });
+            return data;
+        };
+        return createPaginatedList({
+            response: await fetchPage(query),
+            fetchPage,
+            mapItem: (volume) => new VolumeInstance(volume),
+            query,
+        });
     }
     static async delete(volumeName) {
         const { data } = await deleteVolume({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@blaxel/core",
-	"version": "0.2.96-preview.204",
+	"version": "0.2.96-preview.205",
 	"description": "Blaxel Core SDK for TypeScript",
 	"license": "MIT",
 	"author": "Blaxel, INC (https://blaxel.ai)",