@blaxel/core 0.2.89-preview.179 → 0.2.90-dev.181

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/README.md +37 -2
  2. package/dist/cjs/.tsbuildinfo +1 -1
  3. package/dist/cjs/client/sdk.gen.js +63 -12
  4. package/dist/cjs/common/h2fetch.js +1 -1
  5. package/dist/cjs/common/pagination.js +87 -0
  6. package/dist/cjs/common/pagination.test.js +62 -0
  7. package/dist/cjs/common/settings.js +3 -3
  8. package/dist/cjs/common/settings.test.js +3 -3
  9. package/dist/cjs/drive/index.js +39 -3
  10. package/dist/cjs/index.js +1 -0
  11. package/dist/cjs/jobs/jobs.js +42 -9
  12. package/dist/cjs/sandbox/client/sdk.gen.js +1 -1
  13. package/dist/cjs/sandbox/preview.js +8 -3
  14. package/dist/cjs/sandbox/sandbox.js +41 -4
  15. package/dist/cjs/types/client/sdk.gen.d.ts +34 -19
  16. package/dist/cjs/types/client/types.gen.d.ts +704 -22
  17. package/dist/cjs/types/common/pagination.d.ts +35 -0
  18. package/dist/cjs/types/common/pagination.test.d.ts +1 -0
  19. package/dist/cjs/types/drive/index.d.ts +35 -4
  20. package/dist/cjs/types/index.d.ts +1 -0
  21. package/dist/cjs/types/jobs/jobs.d.ts +33 -3
  22. package/dist/cjs/types/sandbox/client/sdk.gen.d.ts +1 -1
  23. package/dist/cjs/types/sandbox/client/types.gen.d.ts +24 -0
  24. package/dist/cjs/types/sandbox/preview.d.ts +2 -2
  25. package/dist/cjs/types/sandbox/sandbox.d.ts +36 -2
  26. package/dist/cjs/types/volume/index.d.ts +37 -4
  27. package/dist/cjs/volume/index.js +41 -3
  28. package/dist/cjs-browser/.tsbuildinfo +1 -1
  29. package/dist/cjs-browser/client/sdk.gen.js +63 -12
  30. package/dist/cjs-browser/common/pagination.js +87 -0
  31. package/dist/cjs-browser/common/pagination.test.js +62 -0
  32. package/dist/cjs-browser/common/settings.js +3 -3
  33. package/dist/cjs-browser/common/settings.test.js +3 -3
  34. package/dist/cjs-browser/drive/index.js +39 -3
  35. package/dist/cjs-browser/index.js +1 -0
  36. package/dist/cjs-browser/jobs/jobs.js +42 -9
  37. package/dist/cjs-browser/sandbox/client/sdk.gen.js +1 -1
  38. package/dist/cjs-browser/sandbox/preview.js +8 -3
  39. package/dist/cjs-browser/sandbox/sandbox.js +41 -4
  40. package/dist/cjs-browser/types/client/sdk.gen.d.ts +34 -19
  41. package/dist/cjs-browser/types/client/types.gen.d.ts +704 -22
  42. package/dist/cjs-browser/types/common/pagination.d.ts +35 -0
  43. package/dist/cjs-browser/types/common/pagination.test.d.ts +1 -0
  44. package/dist/cjs-browser/types/drive/index.d.ts +35 -4
  45. package/dist/cjs-browser/types/index.d.ts +1 -0
  46. package/dist/cjs-browser/types/jobs/jobs.d.ts +33 -3
  47. package/dist/cjs-browser/types/sandbox/client/sdk.gen.d.ts +1 -1
  48. package/dist/cjs-browser/types/sandbox/client/types.gen.d.ts +24 -0
  49. package/dist/cjs-browser/types/sandbox/preview.d.ts +2 -2
  50. package/dist/cjs-browser/types/sandbox/sandbox.d.ts +36 -2
  51. package/dist/cjs-browser/types/volume/index.d.ts +37 -4
  52. package/dist/cjs-browser/volume/index.js +41 -3
  53. package/dist/esm/.tsbuildinfo +1 -1
  54. package/dist/esm/client/sdk.gen.js +57 -9
  55. package/dist/esm/common/h2fetch.js +1 -1
  56. package/dist/esm/common/pagination.js +83 -0
  57. package/dist/esm/common/pagination.test.js +60 -0
  58. package/dist/esm/common/settings.js +3 -3
  59. package/dist/esm/common/settings.test.js +3 -3
  60. package/dist/esm/drive/index.js +39 -3
  61. package/dist/esm/index.js +1 -0
  62. package/dist/esm/jobs/jobs.js +42 -9
  63. package/dist/esm/sandbox/client/sdk.gen.js +1 -1
  64. package/dist/esm/sandbox/preview.js +8 -3
  65. package/dist/esm/sandbox/sandbox.js +41 -4
  66. package/dist/esm/volume/index.js +41 -3
  67. package/dist/esm-browser/.tsbuildinfo +1 -1
  68. package/dist/esm-browser/client/sdk.gen.js +57 -9
  69. package/dist/esm-browser/common/pagination.js +83 -0
  70. package/dist/esm-browser/common/pagination.test.js +60 -0
  71. package/dist/esm-browser/common/settings.js +3 -3
  72. package/dist/esm-browser/common/settings.test.js +3 -3
  73. package/dist/esm-browser/drive/index.js +39 -3
  74. package/dist/esm-browser/index.js +1 -0
  75. package/dist/esm-browser/jobs/jobs.js +42 -9
  76. package/dist/esm-browser/sandbox/client/sdk.gen.js +1 -1
  77. package/dist/esm-browser/sandbox/preview.js +8 -3
  78. package/dist/esm-browser/sandbox/sandbox.js +41 -4
  79. package/dist/esm-browser/volume/index.js +41 -3
  80. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
  import { client as _heyApiClient } from "./client.gen.js";
3
3
  /**
4
4
  * List all agents
5
- * Returns all AI agents deployed in the workspace. Each agent includes its deployment status, runtime configuration, and global inference endpoint URL.
5
+ * Returns AI agents deployed in the workspace. Each agent includes its deployment status, runtime configuration, and global inference endpoint URL. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array with all agents.
6
6
  */
7
7
  export const listAgents = (options) => {
8
8
  return (options?.client ?? _heyApiClient).get({
@@ -221,7 +221,7 @@ export const verifyCustomDomain = (options) => {
221
221
  };
222
222
  /**
223
223
  * List drives
224
- * Returns all drives in the workspace. Drives provide persistent storage that can be attached to agents, functions, and sandboxes.
224
+ * Returns all drives in the workspace. Drives provide persistent storage that can be attached to agents, functions, and sandboxes. Starting with API version 2026-04-28, the response wraps items in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array with all drives.
225
225
  */
226
226
  export const listDrives = (options) => {
227
227
  return (options?.client ?? _heyApiClient).get({
@@ -348,6 +348,22 @@ export const listAllEgressGateways = (options) => {
348
348
  ...options
349
349
  });
350
350
  };
351
+ /**
352
+ * Egress gateway sandbox attachments
353
+ * Returns the inverse map (gateway → sandbox names) for the workspace. Used by the egress-IPs UI to render attachment counts without fetching the sandboxes listing full client-side.
354
+ */
355
+ export const getEgressGatewayUsage = (options) => {
356
+ return (options?.client ?? _heyApiClient).get({
357
+ security: [
358
+ {
359
+ scheme: 'bearer',
360
+ type: 'http'
361
+ }
362
+ ],
363
+ url: '/egressgateways/usage',
364
+ ...options
365
+ });
366
+ };
351
367
  /**
352
368
  * List all egress IPs across all VPCs and gateways in the workspace
353
369
  */
@@ -397,7 +413,7 @@ export const testFeatureFlag = (options) => {
397
413
  };
398
414
  /**
399
415
  * List all MCP servers
400
- * Returns all MCP server functions deployed in the workspace. Each function includes its deployment status, transport protocol (websocket or http-stream), and endpoint URL.
416
+ * Returns MCP server functions deployed in the workspace. Each function includes its deployment status, transport protocol (websocket or http-stream), and endpoint URL. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array with all functions.
401
417
  */
402
418
  export const listFunctions = (options) => {
403
419
  return (options?.client ?? _heyApiClient).get({
@@ -805,7 +821,7 @@ export const getIntegrationConnectionModel = (options) => {
805
821
  };
806
822
  /**
807
823
  * List batch jobs
808
- * Returns all batch job definitions in the workspace. Each job can be triggered to run multiple parallel tasks with configurable concurrency and retry settings.
824
+ * Returns batch job definitions in the workspace. Each job can be triggered to run multiple parallel tasks with configurable concurrency and retry settings. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array with all jobs.
809
825
  */
810
826
  export const listJobs = (options) => {
811
827
  return (options?.client ?? _heyApiClient).get({
@@ -893,7 +909,7 @@ export const updateJob = (options) => {
893
909
  };
894
910
  /**
895
911
  * List job executions
896
- * Returns paginated list of executions for a batch job, sorted by creation time. Each execution contains status, task counts, and timing information.
912
+ * Returns executions for a batch job. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep the legacy offset/limit contract and return a bare array.
897
913
  */
898
914
  export const listJobExecutions = (options) => {
899
915
  return (options.client ?? _heyApiClient).get({
@@ -959,6 +975,22 @@ export const getJobExecution = (options) => {
959
975
  ...options
960
976
  });
961
977
  };
978
+ /**
979
+ * List execution tasks
980
+ * Returns one cursor-paginated page of an execution's tasks. Tasks are derived from event history each request; only the in-memory slicing is paginated, the events scan still fetches the whole event log behind the scenes. Available starting with API version 2026-04-28.
981
+ */
982
+ export const listJobExecutionTasks = (options) => {
983
+ return (options.client ?? _heyApiClient).get({
984
+ security: [
985
+ {
986
+ scheme: 'bearer',
987
+ type: 'http'
988
+ }
989
+ ],
990
+ url: '/jobs/{jobId}/executions/{executionId}/tasks',
991
+ ...options
992
+ });
993
+ };
962
994
  /**
963
995
  * List job revisions
964
996
  * Returns revisions for a job by name.
@@ -1009,7 +1041,7 @@ export const listMcpHubDefinitions = (options) => {
1009
1041
  };
1010
1042
  /**
1011
1043
  * List model endpoints
1012
- * Returns all model gateway endpoints configured in the workspace. Each model represents a proxy to an external LLM provider (OpenAI, Anthropic, etc.) with unified access control.
1044
+ * Returns model gateway endpoints configured in the workspace. Each model represents a proxy to an external LLM provider (OpenAI, Anthropic, etc.) with unified access control. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array with all models.
1013
1045
  */
1014
1046
  export const listModels = (options) => {
1015
1047
  return (options?.client ?? _heyApiClient).get({
@@ -1161,7 +1193,7 @@ export const declineImageShare = (options) => {
1161
1193
  };
1162
1194
  /**
1163
1195
  * List governance policies
1164
- * Returns all governance policies in the workspace. Policies control deployment locations, hardware flavors, and token limits for agents, functions, and models.
1196
+ * Returns governance policies in the workspace. Policies control deployment locations, hardware flavors, and token limits for agents, functions, and models. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array with all policies.
1165
1197
  */
1166
1198
  export const listPolicies = (options) => {
1167
1199
  return (options?.client ?? _heyApiClient).get({
@@ -1247,6 +1279,22 @@ export const updatePolicy = (options) => {
1247
1279
  }
1248
1280
  });
1249
1281
  };
1282
+ /**
1283
+ * List resources using a policy
1284
+ * Returns the names of every resource (agent, function, model, sandbox, job) currently referencing the given policy. Replaces the client-side fan-out the policies UI used to do over the listings.
1285
+ */
1286
+ export const getPolicyUsages = (options) => {
1287
+ return (options.client ?? _heyApiClient).get({
1288
+ security: [
1289
+ {
1290
+ scheme: 'bearer',
1291
+ type: 'http'
1292
+ }
1293
+ ],
1294
+ url: '/policies/{policyName}/usages',
1295
+ ...options
1296
+ });
1297
+ };
1250
1298
  /**
1251
1299
  * List public ips
1252
1300
  * Returns a list of all public ips used in Blaxel..
@@ -1281,7 +1329,7 @@ export const listSandboxHubDefinitions = (options) => {
1281
1329
  };
1282
1330
  /**
1283
1331
  * List sandboxes
1284
- * Returns all sandboxes in the workspace. Each sandbox includes its configuration, status, and endpoint URL.
1332
+ * Returns sandboxes in the workspace. Each sandbox includes its configuration, status, and endpoint URL. Terminated sandboxes are hidden by default; pass `showTerminated=true` to include them. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array of all sandboxes.
1285
1333
  */
1286
1334
  export const listSandboxes = (options) => {
1287
1335
  return (options?.client ?? _heyApiClient).get({
@@ -1841,7 +1889,7 @@ export const deleteVolumeTemplateVersion = (options) => {
1841
1889
  };
1842
1890
  /**
1843
1891
  * List persistent volumes
1844
- * Returns all persistent storage volumes in the workspace. Volumes can be attached to sandboxes for durable file storage that persists across sessions and sandbox deletions.
1892
+ * Returns persistent storage volumes in the workspace. Volumes can be attached to sandboxes for durable file storage that persists across sessions and sandbox deletions. Starting with API version 2026-04-28 the response is wrapped in `{data, meta}` and supports cursor pagination via the `cursor` and `limit` query parameters; older versions keep returning a bare array of volumes.
1845
1893
  */
1846
1894
  export const listVolumes = (options) => {
1847
1895
  return (options?.client ?? _heyApiClient).get({
@@ -0,0 +1,83 @@
1
+ export function unwrapListData(response) {
2
+ if (!response) {
3
+ return [];
4
+ }
5
+ if (Array.isArray(response)) {
6
+ return response;
7
+ }
8
+ return response.data ?? [];
9
+ }
10
+ function unwrapListMeta(response) {
11
+ if (!response || Array.isArray(response)) {
12
+ return { hasMore: false };
13
+ }
14
+ return response.meta ?? { hasMore: false };
15
+ }
16
+ export async function createPaginatedList({ response, fetchPage, mapItem, query, seenCursors, }) {
17
+ const meta = unwrapListMeta(response);
18
+ const data = await Promise.all(unwrapListData(response).map(mapItem));
19
+ const cursors = new Set(seenCursors);
20
+ if (query?.cursor) {
21
+ cursors.add(query.cursor);
22
+ }
23
+ const list = {
24
+ data,
25
+ meta,
26
+ get hasMore() {
27
+ return Boolean(meta.hasMore);
28
+ },
29
+ get nextCursor() {
30
+ return meta.nextCursor || undefined;
31
+ },
32
+ async nextPage() {
33
+ const cursor = list.nextCursor;
34
+ if (!cursor) {
35
+ return null;
36
+ }
37
+ if (cursors.has(cursor)) {
38
+ throw new Error("Pagination returned a repeated cursor");
39
+ }
40
+ const nextQuery = { ...(query ?? {}), cursor };
41
+ const nextSeenCursors = new Set(cursors);
42
+ nextSeenCursors.add(cursor);
43
+ return createPaginatedList({
44
+ response: await fetchPage(nextQuery),
45
+ fetchPage,
46
+ mapItem,
47
+ query: nextQuery,
48
+ seenCursors: nextSeenCursors,
49
+ });
50
+ },
51
+ async autoPagingEach(onItem) {
52
+ for await (const item of list) {
53
+ const shouldContinue = await onItem(item);
54
+ if (shouldContinue === false) {
55
+ return;
56
+ }
57
+ }
58
+ },
59
+ async autoPagingToArray(options) {
60
+ if (!options || !Number.isFinite(options.limit) || options.limit <= 0) {
61
+ throw new Error("autoPagingToArray requires a positive limit");
62
+ }
63
+ const items = [];
64
+ for await (const item of list) {
65
+ items.push(item);
66
+ if (items.length >= options.limit) {
67
+ return items;
68
+ }
69
+ }
70
+ return items;
71
+ },
72
+ async *[Symbol.asyncIterator]() {
73
+ let page = list;
74
+ while (page) {
75
+ for (const item of page.data) {
76
+ yield item;
77
+ }
78
+ page = await page.nextPage();
79
+ }
80
+ },
81
+ };
82
+ return list;
83
+ }
@@ -0,0 +1,60 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { createPaginatedList, unwrapListData } from "./pagination.js";
3
+ describe("pagination helpers", () => {
4
+ it("unwraps legacy array and paginated list responses", () => {
5
+ expect(unwrapListData([{ name: "legacy" }])).toEqual([{ name: "legacy" }]);
6
+ expect(unwrapListData({
7
+ data: [{ name: "paginated" }],
8
+ meta: { hasMore: false },
9
+ })).toEqual([{ name: "paginated" }]);
10
+ });
11
+ it("returns page data and lets callers request the next page", async () => {
12
+ const cursors = [];
13
+ const fetchPage = async (query) => {
14
+ await Promise.resolve();
15
+ cursors.push(query?.cursor);
16
+ if (!query?.cursor) {
17
+ return {
18
+ data: ["first"],
19
+ meta: { hasMore: true, nextCursor: "next-page" },
20
+ };
21
+ }
22
+ return {
23
+ data: ["second"],
24
+ meta: { hasMore: false },
25
+ };
26
+ };
27
+ const page = await createPaginatedList({
28
+ response: await fetchPage(),
29
+ fetchPage,
30
+ mapItem: (item) => item.toUpperCase(),
31
+ });
32
+ expect(page.data).toEqual(["FIRST"]);
33
+ expect(page.hasMore).toBe(true);
34
+ expect(page.nextCursor).toBe("next-page");
35
+ const nextPage = await page.nextPage();
36
+ expect(nextPage?.data).toEqual(["SECOND"]);
37
+ expect(cursors).toEqual([undefined, "next-page"]);
38
+ });
39
+ it("supports auto paging with an explicit limit", async () => {
40
+ const fetchPage = async (query) => {
41
+ await Promise.resolve();
42
+ if (!query?.cursor) {
43
+ return {
44
+ data: ["first"],
45
+ meta: { hasMore: true, nextCursor: "next-page" },
46
+ };
47
+ }
48
+ return {
49
+ data: ["second"],
50
+ meta: { hasMore: false },
51
+ };
52
+ };
53
+ const page = await createPaginatedList({
54
+ response: await fetchPage(),
55
+ fetchPage,
56
+ mapItem: (item) => item,
57
+ });
58
+ await expect(page.autoPagingToArray({ limit: 2 })).resolves.toEqual(["first", "second"]);
59
+ });
60
+ });
@@ -22,10 +22,10 @@ function missingCredentialsMessage() {
22
22
  return "No Blaxel credentials found. Set the BL_API_KEY and BL_WORKSPACE environment variables, or run `bl login`.";
23
23
  }
24
24
  // Build info - these placeholders are replaced at build time by build:replace-imports
25
- const BUILD_VERSION = "0.2.89-preview.179";
26
- const BUILD_COMMIT = "c481e2f6670b3cef6832875dbc9f2bc6b0b198f4";
25
+ const BUILD_VERSION = "0.2.90-dev.181";
26
+ const BUILD_COMMIT = "588f48a812b2e4e0ff556b9008896ad944741f53";
27
27
  const BUILD_SENTRY_DSN = "https://fd5e60e1c9820e1eef5ccebb84a07127@o4508714045276160.ingest.us.sentry.io/4510465864564736";
28
- const BLAXEL_API_VERSION = "2026-04-16";
28
+ const BLAXEL_API_VERSION = "2026-04-28";
29
29
  // Cache for config.yaml tracking value
30
30
  let configTrackingValue = null;
31
31
  let configTrackingLoaded = false;
@@ -8,10 +8,10 @@ describe('Settings.apiVersion', () => {
8
8
  afterEach(() => {
9
9
  delete env.BL_API_VERSION;
10
10
  });
11
- it('defaults to 2026-04-16 when BL_API_VERSION is not set', async () => {
11
+ it('defaults to 2026-04-28 when BL_API_VERSION is not set', async () => {
12
12
  delete env.BL_API_VERSION;
13
13
  const { settings } = await import('./settings.js');
14
- expect(settings.apiVersion).toBe('2026-04-16');
14
+ expect(settings.apiVersion).toBe('2026-04-28');
15
15
  });
16
16
  it('headers include Blaxel-Version set to the default', async () => {
17
17
  delete env.BL_API_VERSION;
@@ -20,7 +20,7 @@ describe('Settings.apiVersion', () => {
20
20
  const previous = settings.credentials;
21
21
  settings.credentials = new ApiKey({ apiKey: 'test-key', workspace: 'test-ws' });
22
22
  try {
23
- expect(settings.headers['Blaxel-Version']).toBe('2026-04-16');
23
+ expect(settings.headers['Blaxel-Version']).toBe('2026-04-28');
24
24
  }
25
25
  finally {
26
26
  settings.credentials = previous;
@@ -1,5 +1,6 @@
1
1
  import { v4 as uuidv4 } from "uuid";
2
2
  import { createDrive, deleteDrive, getDrive, listDrives, updateDrive } from "../client/index.js";
3
+ import { createPaginatedList } from "../common/pagination.js";
3
4
  import { settings } from "../common/settings.js";
4
5
  export class DriveInstance {
5
6
  drive;
@@ -83,9 +84,44 @@ export class DriveInstance {
83
84
  });
84
85
  return new DriveInstance(data);
85
86
  }
86
- static async list() {
87
- const { data } = await listDrives({ throwOnError: true });
88
- return data.map((drive) => new DriveInstance(drive));
87
+ /**
88
+ * List one page of drives.
89
+ *
90
+ * The returned page exposes `data` for the current page, `meta` for cursor
91
+ * metadata, and helpers to fetch more pages only when you need them.
92
+ *
93
+ * @example
94
+ * ```ts
95
+ * const page = await DriveInstance.list({ limit: 50 });
96
+ *
97
+ * for (const drive of page.data) {
98
+ * console.log(drive.name);
99
+ * }
100
+ *
101
+ * const nextPage = await page.nextPage();
102
+ * ```
103
+ *
104
+ * @example
105
+ * ```ts
106
+ * const allDrives = await (await DriveInstance.list()).autoPagingToArray({
107
+ * limit: 1000,
108
+ * });
109
+ * ```
110
+ */
111
+ static async list(query) {
112
+ const fetchPage = async (pageQuery) => {
113
+ const { data } = await listDrives({
114
+ query: pageQuery,
115
+ throwOnError: true,
116
+ });
117
+ return data;
118
+ };
119
+ return createPaginatedList({
120
+ response: await fetchPage(query),
121
+ fetchPage,
122
+ mapItem: (drive) => new DriveInstance(drive),
123
+ query,
124
+ });
89
125
  }
90
126
  static async delete(driveName) {
91
127
  const { data } = await deleteDrive({
@@ -7,6 +7,7 @@ export * from "./common/node.js";
7
7
  export * from "./common/errors.js";
8
8
  export * from "./common/internal.js";
9
9
  export * from "./common/logger.js";
10
+ export * from "./common/pagination.js";
10
11
  export * from "./common/settings.js";
11
12
  export * from "./common/webhook.js";
12
13
  export * from "./drive/index.js";
@@ -1,5 +1,6 @@
1
1
  import { createJobExecution, deleteJobExecution, getJobExecution, listJobExecutions, } from "../client/index.js";
2
2
  import { logger } from "../common/logger.js";
3
+ import { createPaginatedList } from "../common/pagination.js";
3
4
  import { settings } from "../common/settings.js";
4
5
  import { startSpan } from "../telemetry/telemetry.js";
5
6
  class BlJob {
@@ -75,18 +76,50 @@ class BlJob {
75
76
  return data;
76
77
  }
77
78
  /**
78
- * List all executions for this job
79
+ * List one page of executions for this job.
80
+ *
81
+ * The returned page exposes `data` for the current page, `meta` for cursor
82
+ * metadata, and helpers to fetch more pages only when you need them.
83
+ *
84
+ * @example
85
+ * ```ts
86
+ * const job = blJob("daily-import");
87
+ * const page = await job.listExecutions({ limit: 50 });
88
+ *
89
+ * for (const execution of page.data) {
90
+ * console.log(execution.status);
91
+ * }
92
+ *
93
+ * const nextPage = await page.nextPage();
94
+ * ```
95
+ *
96
+ * @example
97
+ * ```ts
98
+ * const job = blJob("daily-import");
99
+ * const executions = await (await job.listExecutions()).autoPagingToArray({
100
+ * limit: 1000,
101
+ * });
102
+ * ```
79
103
  */
80
- async listExecutions() {
104
+ async listExecutions(query) {
81
105
  logger.debug(`Listing executions for job: ${this.jobName}`);
82
- const { data } = await listJobExecutions({
83
- path: {
84
- jobId: this.jobName,
85
- },
86
- headers: settings.headers,
87
- throwOnError: true,
106
+ const fetchPage = async (pageQuery) => {
107
+ const { data } = await listJobExecutions({
108
+ path: {
109
+ jobId: this.jobName,
110
+ },
111
+ query: pageQuery,
112
+ headers: settings.headers,
113
+ throwOnError: true,
114
+ });
115
+ return data;
116
+ };
117
+ return createPaginatedList({
118
+ response: await fetchPage(query),
119
+ fetchPage,
120
+ mapItem: (execution) => execution,
121
+ query,
88
122
  });
89
- return data ?? [];
90
123
  }
91
124
  /**
92
125
  * Get the status of a specific execution
@@ -86,7 +86,7 @@ export const getDrivesMount = (options) => {
86
86
  };
87
87
  /**
88
88
  * Attach a drive to a local path
89
- * Mounts an agent drive using the blfs binary to a local path, optionally mounting a subpath within the drive
89
+ * 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).
90
90
  */
91
91
  export const postDrivesMount = (options) => {
92
92
  return (options.client ?? _heyApiClient).post({
@@ -99,24 +99,29 @@ export class SandboxPreviews {
99
99
  });
100
100
  return data.map((preview) => new SandboxPreview(preview));
101
101
  }
102
- async create(preview) {
102
+ async create(preview, force) {
103
+ const query = {};
104
+ if (force) {
105
+ query['force'] = 'true';
106
+ }
103
107
  const { data } = await createSandboxPreview({
104
108
  path: {
105
109
  sandboxName: this.sandboxName,
106
110
  },
111
+ query,
107
112
  body: preview,
108
113
  throwOnError: true,
109
114
  });
110
115
  return new SandboxPreview(data);
111
116
  }
112
- async createIfNotExists(preview) {
117
+ async createIfNotExists(preview, force) {
113
118
  try {
114
119
  const previewInstance = await this.get(preview.metadata.name);
115
120
  return previewInstance;
116
121
  }
117
122
  catch (e) {
118
123
  if (typeof e === "object" && e !== null && "code" in e && e.code === 404) {
119
- return this.create(preview);
124
+ return this.create(preview, force);
120
125
  }
121
126
  throw e;
122
127
  }
@@ -1,6 +1,7 @@
1
1
  import { v4 as uuidv4 } from "uuid";
2
2
  import { createSandbox, deleteSandbox, getSandbox, listSandboxes, updateSandbox } from "../client/index.js";
3
3
  import { logger } from "../common/logger.js";
4
+ import { createPaginatedList } from "../common/pagination.js";
4
5
  import { settings } from "../common/settings.js";
5
6
  import { SandboxCodegen } from "./codegen/index.js";
6
7
  import { SandboxDrive } from "./drive/index.js";
@@ -236,10 +237,46 @@ export class SandboxInstance {
236
237
  const instance = new SandboxInstance(data);
237
238
  return SandboxInstance.attachH2Session(instance);
238
239
  }
239
- static async list() {
240
- const { data } = await listSandboxes({ throwOnError: true });
241
- const instances = data.map((sandbox) => new SandboxInstance(sandbox));
242
- return Promise.all(instances.map((instance) => SandboxInstance.attachH2Session(instance)));
240
+ /**
241
+ * List one page of sandboxes.
242
+ *
243
+ * The returned page exposes `data` for the current page, `meta` for cursor
244
+ * metadata, and helpers to fetch more pages only when you need them.
245
+ *
246
+ * @example
247
+ * ```ts
248
+ * const page = await SandboxInstance.list({ limit: 50 });
249
+ *
250
+ * for (const sandbox of page.data) {
251
+ * console.log(sandbox.metadata.name);
252
+ * }
253
+ *
254
+ * const nextPage = await page.nextPage();
255
+ * ```
256
+ *
257
+ * @example
258
+ * ```ts
259
+ * const page = await SandboxInstance.list({ limit: 100 });
260
+ *
261
+ * for await (const sandbox of page) {
262
+ * console.log(sandbox.metadata.name);
263
+ * }
264
+ * ```
265
+ */
266
+ static async list(query) {
267
+ const fetchPage = async (pageQuery) => {
268
+ const { data } = await listSandboxes({
269
+ query: pageQuery,
270
+ throwOnError: true,
271
+ });
272
+ return data;
273
+ };
274
+ return createPaginatedList({
275
+ response: await fetchPage(query),
276
+ fetchPage,
277
+ mapItem: (sandbox) => SandboxInstance.attachH2Session(new SandboxInstance(sandbox)),
278
+ query,
279
+ });
243
280
  }
244
281
  static async delete(sandboxName) {
245
282
  const { data } = await deleteSandbox({
@@ -1,5 +1,6 @@
1
1
  import { v4 as uuidv4 } from "uuid";
2
2
  import { createVolume, deleteVolume, getVolume, listVolumes, updateVolume } from "../client/index.js";
3
+ import { createPaginatedList } from "../common/pagination.js";
3
4
  import { settings } from "../common/settings.js";
4
5
  export class VolumeInstance {
5
6
  volume;
@@ -85,9 +86,46 @@ export class VolumeInstance {
85
86
  });
86
87
  return new VolumeInstance(data);
87
88
  }
88
- static async list() {
89
- const { data } = await listVolumes({ throwOnError: true });
90
- return data.map((volume) => new VolumeInstance(volume));
89
+ /**
90
+ * List one page of volumes.
91
+ *
92
+ * The returned page exposes `data` for the current page, `meta` for cursor
93
+ * metadata, and helpers to fetch more pages only when you need them.
94
+ *
95
+ * @example
96
+ * ```ts
97
+ * const page = await VolumeInstance.list({ limit: 50 });
98
+ *
99
+ * for (const volume of page.data) {
100
+ * console.log(volume.name);
101
+ * }
102
+ *
103
+ * const nextPage = await page.nextPage();
104
+ * ```
105
+ *
106
+ * @example
107
+ * ```ts
108
+ * const page = await VolumeInstance.list({ limit: 100 });
109
+ *
110
+ * for await (const volume of page) {
111
+ * console.log(volume.name);
112
+ * }
113
+ * ```
114
+ */
115
+ static async list(query) {
116
+ const fetchPage = async (pageQuery) => {
117
+ const { data } = await listVolumes({
118
+ query: pageQuery,
119
+ throwOnError: true,
120
+ });
121
+ return data;
122
+ };
123
+ return createPaginatedList({
124
+ response: await fetchPage(query),
125
+ fetchPage,
126
+ mapItem: (volume) => new VolumeInstance(volume),
127
+ query,
128
+ });
91
129
  }
92
130
  static async delete(volumeName) {
93
131
  const { data } = await deleteVolume({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blaxel/core",
3
- "version": "0.2.89-preview.179",
3
+ "version": "0.2.90-dev.181",
4
4
  "description": "Blaxel Core SDK for TypeScript",
5
5
  "license": "MIT",
6
6
  "author": "Blaxel, INC (https://blaxel.ai)",