@vercel/sandbox 2.0.0-beta.2 → 2.0.0-beta.20

package/dist/snapshot.d.ts

@@ -1,17 +1,24 @@
-import type { SnapshotMetadata } from "./api-client";
-import { APIClient } from "./api-client";
-import { WithFetchOptions } from "./api-client/api-client";
-import { Credentials } from "./utils/get-credentials";
+import { Paginator } from "./utils/paginator.js";
+import { SnapshotMetadata } from "./api-client/validators.js";
+import { APIClient, WithFetchOptions } from "./api-client/api-client.js";
+import "./api-client/index.js";
+import { Credentials } from "./utils/get-credentials.js";
+import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from "@workflow/serde";
+
+//#region src/snapshot.d.ts
+interface SerializedSnapshot {
+  snapshot: SnapshotMetadata;
+}
 /** @inline */
 interface GetSnapshotParams {
-    /**
-     * Unique identifier of the snapshot.
-     */
-    snapshotId: string;
-    /**
-     * An AbortSignal to cancel the operation.
-     */
-    signal?: AbortSignal;
+  /**
+   * Unique identifier of the snapshot.
+   */
+  snapshotId: string;
+  /**
+   * An AbortSignal to cancel the operation.
+   */
+  signal?: AbortSignal;
 }
 /**
  * A Snapshot is a saved state of a Sandbox that can be used to create new Sandboxes
@@ -19,84 +26,137 @@ interface GetSnapshotParams {
  * Use {@link Sandbox.snapshot} or {@link Snapshot.get} to construct.
  * @hideconstructor
  */
-export declare class Snapshot {
-    private readonly client;
-    /**
-     * Unique ID of this snapshot.
-     */
-    get snapshotId(): string;
-    /**
-     * The ID the sandbox from which this snapshot was created.
-     */
-    get sourceSandboxId(): string;
-    /**
-     * The status of the snapshot.
-     */
-    get status(): SnapshotMetadata["status"];
-    /**
-     * The size of the snapshot in bytes, or null if not available.
-     */
-    get sizeBytes(): number;
-    /**
-     * The creation date of this snapshot.
-     */
-    get createdAt(): Date;
-    /**
-     * The expiration date of this snapshot, or undefined if it does not expire.
-     */
-    get expiresAt(): Date | undefined;
-    /**
-     * Internal metadata about this snapshot.
-     */
-    private snapshot;
-    /**
-     * Create a new Snapshot instance.
-     *
-     * @param client - API client used to communicate with the backend
-     * @param snapshot - Snapshot metadata
-     */
-    constructor({ client, snapshot, }: {
-        client: APIClient;
-        snapshot: SnapshotMetadata;
-    });
-    /**
-     * Allow to get a list of snapshots for a team narrowed to the given params.
-     * It returns both the snapshots and the pagination metadata to allow getting
-     * the next page of results.
-     */
-    static list(params?: Partial<Parameters<APIClient["listSnapshots"]>[0]> & Partial<Credentials> & WithFetchOptions): Promise<import("./api-client/base-client").Parsed<{
-        pagination: {
-            count: number;
-            next: number | null;
-            prev: number | null;
-        };
-        snapshots: {
-            id: string;
-            region: string;
-            status: "failed" | "created" | "deleted";
-            createdAt: number;
-            updatedAt: number;
-            sourceSandboxId: string;
-            sizeBytes: number;
-            expiresAt?: number | undefined;
-        }[];
-    }>>;
-    /**
-     * Retrieve an existing snapshot.
-     *
-     * @param params - Get parameters and optional credentials.
-     * @returns A promise resolving to the {@link Sandbox}.
-     */
-    static get(params: GetSnapshotParams | (GetSnapshotParams & Credentials)): Promise<Snapshot>;
-    /**
-     * Delete this snapshot.
-     *
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves once the snapshot has been deleted.
-     */
-    delete(opts?: {
-        signal?: AbortSignal;
-    }): Promise<void>;
+declare class Snapshot {
+  private _client;
+  /**
+   * Lazily resolve credentials and construct an API client.
+   * This is used in step contexts where the Snapshot was deserialized
+   * without a client (e.g. when crossing workflow/step boundaries).
+   * @internal
+   */
+  private ensureClient;
+  /**
+   * Unique ID of this snapshot.
+   */
+  get snapshotId(): string;
+  /**
+   * The ID of the session from which this snapshot was created.
+   */
+  get sourceSessionId(): string;
+  /**
+   * The status of the snapshot.
+   */
+  get status(): SnapshotMetadata["status"];
+  /**
+   * The size of the snapshot in bytes, or null if not available.
+   */
+  get sizeBytes(): number;
+  /**
+   * The creation date of this snapshot.
+   */
+  get createdAt(): Date;
+  /**
+   * The expiration date of this snapshot, or undefined if it does not expire.
+   */
+  get expiresAt(): Date | undefined;
+  /**
+   * Internal metadata about this snapshot.
+   */
+  private snapshot;
+  /**
+   * Serialize a Snapshot instance to plain data for @workflow/serde.
+   *
+   * @param instance - The Snapshot instance to serialize
+   * @returns A plain object containing snapshot metadata
+   */
+  static [WORKFLOW_SERIALIZE](instance: Snapshot): SerializedSnapshot;
+  /**
+   * Deserialize a Snapshot from serialized data.
+   *
+   * The deserialized instance uses the serialized metadata synchronously and
+   * lazily creates an API client only when methods perform API requests.
+   *
+   * @param data - The serialized snapshot data
+   * @returns The reconstructed Snapshot instance
+   */
+  static [WORKFLOW_DESERIALIZE](data: SerializedSnapshot): Snapshot;
+  constructor({
+    client,
+    snapshot
+  }: {
+    client?: APIClient;
+    snapshot: SnapshotMetadata;
+  });
+  /**
+   * Allow to get a list of snapshots for a team narrowed to the given params.
+   * It returns both the snapshots and the pagination metadata to allow getting
+   * the next page of results.
+   *
+   * The returned object is async-iterable to auto-paginate through all pages:
+   *
+   * ```ts
+   * const result = await Snapshot.list({ name: "my-sandbox" });
+   * for await (const snapshot of result) { ... }
+   * // or: await result.toArray();
+   * // or: for await (const page of result.pages()) { ... }
+   * ```
+   */
+  static list(params?: Partial<Parameters<APIClient["listSnapshots"]>[0]> & Partial<Credentials> & WithFetchOptions): Promise<Paginator<{
+    pagination: {
+      count: number;
+      next: string | null;
+    };
+    snapshots: {
+      status: "failed" | "created" | "deleted";
+      region: string;
+      createdAt: number;
+      updatedAt: number;
+      id: string;
+      sourceSessionId: string;
+      sizeBytes: number;
+      expiresAt?: number | undefined;
+    }[];
+  }, "snapshots">>;
+  /**
+   * Resolve the current snapshot ID of an existing sandbox by name.
+   *
+   * Useful to feed into {@link Sandbox.create} as `source.snapshotId` without
+   * having to first look up the sandbox yourself.
+   *
+   * @param name - The name of the source sandbox.
+   * @param opts - Optional credentials, fetch override, and abort signal.
+   * @returns The current snapshot ID of the named sandbox.
+   * @throws If the sandbox has no current snapshot.
+   *
+   * @example
+   * const sandbox = await Sandbox.create({
+   *   source: {
+   *     type: "snapshot",
+   *     snapshotId: await Snapshot.fromSandbox("my-sandbox"),
+   *   },
+   * });
+   */
+  static fromSandbox(name: string, opts?: Partial<Credentials> & WithFetchOptions & {
+    signal?: AbortSignal;
+  }): Promise<string>;
+  /**
+   * Retrieve an existing snapshot.
+   *
+   * @param params - Get parameters and optional credentials.
+   * @returns A promise resolving to the {@link Sandbox}.
+   */
+  static get(params: GetSnapshotParams | (GetSnapshotParams & Credentials)): Promise<Snapshot>;
+  /**
+   * Delete this snapshot.
+   *
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves once the snapshot has been deleted.
+   */
+  delete(opts?: {
+    signal?: AbortSignal;
+  }): Promise<void>;
 }
-export {};
+//#endregion
+export { SerializedSnapshot, Snapshot };
+//# sourceMappingURL=snapshot.d.ts.map

package/dist/snapshot.js

@@ -1,116 +1,203 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Snapshot = void 0;
-const api_client_1 = require("./api-client");
-const get_credentials_1 = require("./utils/get-credentials");
+import { APIClient } from "./api-client/api-client.js";
+import "./api-client/index.js";
+import { getCredentials } from "./utils/get-credentials.js";
+import { attachPaginator } from "./utils/paginator.js";
+import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from "@workflow/serde";
+
+//#region src/snapshot.ts
 /**
- * A Snapshot is a saved state of a Sandbox that can be used to create new Sandboxes
- *
- * Use {@link Sandbox.snapshot} or {@link Snapshot.get} to construct.
- * @hideconstructor
- */
-class Snapshot {
-    /**
-     * Unique ID of this snapshot.
-     */
-    get snapshotId() {
-        return this.snapshot.id;
-    }
-    /**
-     * The ID the sandbox from which this snapshot was created.
-     */
-    get sourceSandboxId() {
-        return this.snapshot.sourceSandboxId;
-    }
-    /**
-     * The status of the snapshot.
-     */
-    get status() {
-        return this.snapshot.status;
-    }
-    /**
-     * The size of the snapshot in bytes, or null if not available.
-     */
-    get sizeBytes() {
-        return this.snapshot.sizeBytes;
-    }
-    /**
-     * The creation date of this snapshot.
-     */
-    get createdAt() {
-        return new Date(this.snapshot.createdAt);
-    }
-    /**
-     * The expiration date of this snapshot, or undefined if it does not expire.
-     */
-    get expiresAt() {
-        if (this.snapshot.expiresAt === undefined) {
-            return undefined;
-        }
-        return new Date(this.snapshot.expiresAt);
-    }
-    /**
-     * Create a new Snapshot instance.
-     *
-     * @param client - API client used to communicate with the backend
-     * @param snapshot - Snapshot metadata
-     */
-    constructor({ client, snapshot, }) {
-        this.client = client;
-        this.snapshot = snapshot;
-    }
-    /**
-     * Allow to get a list of snapshots for a team narrowed to the given params.
-     * It returns both the snapshots and the pagination metadata to allow getting
-     * the next page of results.
-     */
-    static async list(params) {
-        const credentials = await (0, get_credentials_1.getCredentials)(params);
-        const client = new api_client_1.APIClient({
-            teamId: credentials.teamId,
-            token: credentials.token,
-            fetch: params?.fetch,
-        });
-        return client.listSnapshots({
-            ...credentials,
-            ...params,
-        });
-    }
-    /**
-     * Retrieve an existing snapshot.
-     *
-     * @param params - Get parameters and optional credentials.
-     * @returns A promise resolving to the {@link Sandbox}.
-     */
-    static async get(params) {
-        const credentials = await (0, get_credentials_1.getCredentials)(params);
-        const client = new api_client_1.APIClient({
-            teamId: credentials.teamId,
-            token: credentials.token,
-        });
-        const sandbox = await client.getSnapshot({
-            snapshotId: params.snapshotId,
-            signal: params.signal,
-        });
-        return new Snapshot({
-            client,
-            snapshot: sandbox.json.snapshot,
-        });
-    }
-    /**
-     * Delete this snapshot.
-     *
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves once the snapshot has been deleted.
-     */
-    async delete(opts) {
-        const response = await this.client.deleteSnapshot({
-            snapshotId: this.snapshot.id,
-            signal: opts?.signal,
-        });
-        this.snapshot = response.json.snapshot;
-    }
-}
-exports.Snapshot = Snapshot;
+* A Snapshot is a saved state of a Sandbox that can be used to create new Sandboxes
+*
+* Use {@link Sandbox.snapshot} or {@link Snapshot.get} to construct.
+* @hideconstructor
+*/
+var Snapshot = class Snapshot {
+	/**
+	* Lazily resolve credentials and construct an API client.
+	* This is used in step contexts where the Snapshot was deserialized
+	* without a client (e.g. when crossing workflow/step boundaries).
+	* @internal
+	*/
+	async ensureClient() {
+		"use step";
+		if (this._client) return this._client;
+		const credentials = await getCredentials();
+		this._client = new APIClient({
+			teamId: credentials.teamId,
+			token: credentials.token
+		});
+		return this._client;
+	}
+	/**
+	* Unique ID of this snapshot.
+	*/
+	get snapshotId() {
+		return this.snapshot.id;
+	}
+	/**
+	* The ID of the session from which this snapshot was created.
+	*/
+	get sourceSessionId() {
+		return this.snapshot.sourceSessionId;
+	}
+	/**
+	* The status of the snapshot.
+	*/
+	get status() {
+		return this.snapshot.status;
+	}
+	/**
+	* The size of the snapshot in bytes, or null if not available.
+	*/
+	get sizeBytes() {
+		return this.snapshot.sizeBytes;
+	}
+	/**
+	* The creation date of this snapshot.
+	*/
+	get createdAt() {
+		return new Date(this.snapshot.createdAt);
+	}
+	/**
+	* The expiration date of this snapshot, or undefined if it does not expire.
+	*/
+	get expiresAt() {
+		if (this.snapshot.expiresAt === void 0) return;
+		return new Date(this.snapshot.expiresAt);
+	}
+	/**
+	* Serialize a Snapshot instance to plain data for @workflow/serde.
+	*
+	* @param instance - The Snapshot instance to serialize
+	* @returns A plain object containing snapshot metadata
+	*/
+	static [WORKFLOW_SERIALIZE](instance) {
+		return { snapshot: instance.snapshot };
+	}
+	/**
+	* Deserialize a Snapshot from serialized data.
+	*
+	* The deserialized instance uses the serialized metadata synchronously and
+	* lazily creates an API client only when methods perform API requests.
+	*
+	* @param data - The serialized snapshot data
+	* @returns The reconstructed Snapshot instance
+	*/
+	static [WORKFLOW_DESERIALIZE](data) {
+		return new Snapshot({ snapshot: data.snapshot });
+	}
+	constructor({ client, snapshot }) {
+		this._client = null;
+		this._client = client ?? null;
+		this.snapshot = snapshot;
+	}
+	/**
+	* Allow to get a list of snapshots for a team narrowed to the given params.
+	* It returns both the snapshots and the pagination metadata to allow getting
+	* the next page of results.
+	*
+	* The returned object is async-iterable to auto-paginate through all pages:
+	*
+	* ```ts
+	* const result = await Snapshot.list({ name: "my-sandbox" });
+	* for await (const snapshot of result) { ... }
+	* // or: await result.toArray();
+	* // or: for await (const page of result.pages()) { ... }
+	* ```
+	*/
+	static async list(params) {
+		"use step";
+		const credentials = await getCredentials(params);
+		const client = new APIClient({
+			teamId: credentials.teamId,
+			token: credentials.token,
+			fetch: params?.fetch
+		});
+		const fetchPage = async (cursor) => {
+			return (await client.listSnapshots({
+				...credentials,
+				...params,
+				...cursor !== void 0 && { cursor }
+			})).json;
+		};
+		return attachPaginator(await fetchPage(params?.cursor), {
+			itemsKey: "snapshots",
+			fetchNext: fetchPage,
+			signal: params?.signal
+		});
+	}
+	/**
+	* Resolve the current snapshot ID of an existing sandbox by name.
+	*
+	* Useful to feed into {@link Sandbox.create} as `source.snapshotId` without
+	* having to first look up the sandbox yourself.
+	*
+	* @param name - The name of the source sandbox.
+	* @param opts - Optional credentials, fetch override, and abort signal.
+	* @returns The current snapshot ID of the named sandbox.
+	* @throws If the sandbox has no current snapshot.
+	*
+	* @example
+	* const sandbox = await Sandbox.create({
+	*   source: {
+	*     type: "snapshot",
+	*     snapshotId: await Snapshot.fromSandbox("my-sandbox"),
+	*   },
+	* });
+	*/
+	static async fromSandbox(name, opts) {
+		"use step";
+		const credentials = await getCredentials(opts);
+		const snapshotId = (await new APIClient({
+			teamId: credentials.teamId,
+			token: credentials.token,
+			fetch: opts?.fetch
+		}).getSandbox({
+			name,
+			projectId: credentials.projectId,
+			resume: false,
+			signal: opts?.signal
+		})).json.sandbox.currentSnapshotId;
+		if (!snapshotId) throw new Error(`Sandbox "${name}" has no current snapshot.`);
+		return snapshotId;
+	}
+	/**
+	* Retrieve an existing snapshot.
+	*
+	* @param params - Get parameters and optional credentials.
+	* @returns A promise resolving to the {@link Sandbox}.
+	*/
+	static async get(params) {
+		"use step";
+		const credentials = await getCredentials(params);
+		const client = new APIClient({
+			teamId: credentials.teamId,
+			token: credentials.token
+		});
+		return new Snapshot({
+			client,
+			snapshot: (await client.getSnapshot({
+				snapshotId: params.snapshotId,
+				signal: params.signal
+			})).json.snapshot
+		});
+	}
+	/**
+	* Delete this snapshot.
+	*
+	* @param opts - Optional parameters.
+	* @param opts.signal - An AbortSignal to cancel the operation.
+	* @returns A promise that resolves once the snapshot has been deleted.
+	*/
+	async delete(opts) {
+		"use step";
+		this.snapshot = (await (await this.ensureClient()).deleteSnapshot({
+			snapshotId: this.snapshot.id,
+			signal: opts?.signal
+		})).json.snapshot;
+	}
+};
+
+//#endregion
+export { Snapshot };
 //# sourceMappingURL=snapshot.js.map

package/dist/snapshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.js","sourceRoot":"","sources":["../src/snapshot.ts"],"names":[],"mappings":";;;AACA,6CAAyC;AAEzC,6DAAsE;AActE;;;;;GAKG;AACH,MAAa,QAAQ;IAGnB;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAOD;;;;;OAKG;IACH,YAAY,EACV,MAAM,EACN,QAAQ,GAIT;QACC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,MAEkB;QAElB,MAAM,WAAW,GAAG,MAAM,IAAA,gCAAc,EAAC,MAAM,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC;YAC3B,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,KAAK,EAAE,MAAM,EAAE,KAAK;SACrB,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,aAAa,CAAC;YAC1B,GAAG,WAAW;YACd,GAAG,MAAM;SACV,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,CACd,MAA6D;QAE7D,MAAM,WAAW,GAAG,MAAM,IAAA,gCAAc,EAAC,MAAM,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC;YAC3B,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,KAAK,EAAE,WAAW,CAAC,KAAK;SACzB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC;YACvC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC,CAAC;QAEH,OAAO,IAAI,QAAQ,CAAC;YAClB,MAAM;YACN,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,IAA+B;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;YAChD,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC5B,MAAM,EAAE,IAAI,EAAE,MAAM;SACrB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;IACzC,CAAC;CACF;AAtID,4BAsIC"}
+{"version":3,"file":"snapshot.js","names":[],"sources":["../src/snapshot.ts"],"sourcesContent":["import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from \"@workflow/serde\";\nimport type { WithFetchOptions } from \"./api-client/api-client.js\";\nimport type { SnapshotMetadata } from \"./api-client/index.js\";\nimport { APIClient } from \"./api-client/index.js\";\nimport { type Credentials, getCredentials } from \"./utils/get-credentials.js\";\nimport { attachPaginator } from \"./utils/paginator.js\";\n\nexport interface SerializedSnapshot {\n  snapshot: SnapshotMetadata;\n}\n\n/** @inline */\ninterface GetSnapshotParams {\n  /**\n   * Unique identifier of the snapshot.\n   */\n  snapshotId: string;\n  /**\n   * An AbortSignal to cancel the operation.\n   */\n  signal?: AbortSignal;\n}\n\n/**\n * A Snapshot is a saved state of a Sandbox that can be used to create new Sandboxes\n *\n * Use {@link Sandbox.snapshot} or {@link Snapshot.get} to construct.\n * @hideconstructor\n */\nexport class Snapshot {\n  private _client: APIClient | null = null;\n\n  /**\n   * Lazily resolve credentials and construct an API client.\n   * This is used in step contexts where the Snapshot was deserialized\n   * without a client (e.g. when crossing workflow/step boundaries).\n   * @internal\n   */\n  private async ensureClient(): Promise<APIClient> {\n    \"use step\";\n    if (this._client) return this._client;\n    const credentials = await getCredentials();\n    this._client = new APIClient({\n      teamId: credentials.teamId,\n      token: credentials.token,\n    });\n    return this._client;\n  }\n\n  /**\n   * Unique ID of this snapshot.\n   */\n  public get snapshotId(): string {\n    return this.snapshot.id;\n  }\n\n  /**\n   * The ID of the session from which this snapshot was created.\n   */\n  public get sourceSessionId(): string {\n    return this.snapshot.sourceSessionId;\n  }\n\n  /**\n   * The status of the snapshot.\n   */\n  public get status(): SnapshotMetadata[\"status\"] {\n    return this.snapshot.status;\n  }\n\n  /**\n   * The size of the snapshot in bytes, or null if not available.\n   */\n  public get sizeBytes(): number {\n    return this.snapshot.sizeBytes;\n  }\n\n  /**\n   * The creation date of this snapshot.\n   */\n  public get createdAt(): Date {\n    return new Date(this.snapshot.createdAt);\n  }\n\n  /**\n   * The expiration date of this snapshot, or undefined if it does not expire.\n   */\n  public get expiresAt(): Date | undefined {\n    if (this.snapshot.expiresAt === undefined) {\n      return undefined;\n    }\n\n    return new Date(this.snapshot.expiresAt);\n  }\n\n  /**\n   * Internal metadata about this snapshot.\n   */\n  private snapshot: SnapshotMetadata;\n\n  /**\n   * Serialize a Snapshot instance to plain data for @workflow/serde.\n   *\n   * @param instance - The Snapshot instance to serialize\n   * @returns A plain object containing snapshot metadata\n   */\n  static [WORKFLOW_SERIALIZE](instance: Snapshot): SerializedSnapshot {\n    return {\n      snapshot: instance.snapshot,\n    };\n  }\n\n  /**\n   * Deserialize a Snapshot from serialized data.\n   *\n   * The deserialized instance uses the serialized metadata synchronously and\n   * lazily creates an API client only when methods perform API requests.\n   *\n   * @param data - The serialized snapshot data\n   * @returns The reconstructed Snapshot instance\n   */\n  static [WORKFLOW_DESERIALIZE](data: SerializedSnapshot): Snapshot {\n    return new Snapshot({\n      snapshot: data.snapshot,\n    });\n  }\n\n  constructor({\n    client,\n    snapshot,\n  }: {\n    client?: APIClient;\n    snapshot: SnapshotMetadata;\n  }) {\n    this._client = client ?? null;\n    this.snapshot = snapshot;\n  }\n\n  /**\n   * Allow to get a list of snapshots for a team narrowed to the given params.\n   * It returns both the snapshots and the pagination metadata to allow getting\n   * the next page of results.\n   *\n   * The returned object is async-iterable to auto-paginate through all pages:\n   *\n   * ```ts\n   * const result = await Snapshot.list({ name: \"my-sandbox\" });\n   * for await (const snapshot of result) { ... }\n   * // or: await result.toArray();\n   * // or: for await (const page of result.pages()) { ... }\n   * ```\n   */\n  static async list(\n    params?: Partial<Parameters<APIClient[\"listSnapshots\"]>[0]> &\n      Partial<Credentials> &\n      WithFetchOptions,\n  ) {\n    \"use step\";\n    const credentials = await getCredentials(params);\n    const client = new APIClient({\n      teamId: credentials.teamId,\n      token: credentials.token,\n      fetch: params?.fetch,\n    });\n    const fetchPage = async (cursor?: string) => {\n      const response = await client.listSnapshots({\n        ...credentials,\n        ...params,\n        ...(cursor !== undefined && { cursor }),\n      });\n      return response.json;\n    };\n    const firstPage = await fetchPage(params?.cursor);\n    return attachPaginator(firstPage, {\n      itemsKey: \"snapshots\",\n      fetchNext: fetchPage,\n      signal: params?.signal,\n    });\n  }\n\n  /**\n   * Resolve the current snapshot ID of an existing sandbox by name.\n   *\n   * Useful to feed into {@link Sandbox.create} as `source.snapshotId` without\n   * having to first look up the sandbox yourself.\n   *\n   * @param name - The name of the source sandbox.\n   * @param opts - Optional credentials, fetch override, and abort signal.\n   * @returns The current snapshot ID of the named sandbox.\n   * @throws If the sandbox has no current snapshot.\n   *\n   * @example\n   * const sandbox = await Sandbox.create({\n   *   source: {\n   *     type: \"snapshot\",\n   *     snapshotId: await Snapshot.fromSandbox(\"my-sandbox\"),\n   *   },\n   * });\n   */\n  static async fromSandbox(\n    name: string,\n    opts?: Partial<Credentials> & WithFetchOptions & { signal?: AbortSignal },\n  ): Promise<string> {\n    \"use step\";\n    const credentials = await getCredentials(opts);\n    const client = new APIClient({\n      teamId: credentials.teamId,\n      token: credentials.token,\n      fetch: opts?.fetch,\n    });\n\n    const response = await client.getSandbox({\n      name,\n      projectId: credentials.projectId,\n      resume: false,\n      signal: opts?.signal,\n    });\n\n    const snapshotId = response.json.sandbox.currentSnapshotId;\n    if (!snapshotId) {\n      throw new Error(`Sandbox \"${name}\" has no current snapshot.`);\n    }\n    return snapshotId;\n  }\n\n  /**\n   * Retrieve an existing snapshot.\n   *\n   * @param params - Get parameters and optional credentials.\n   * @returns A promise resolving to the {@link Sandbox}.\n   */\n  static async get(\n    params: GetSnapshotParams | (GetSnapshotParams & Credentials),\n  ): Promise<Snapshot> {\n    \"use step\";\n    const credentials = await getCredentials(params);\n    const client = new APIClient({\n      teamId: credentials.teamId,\n      token: credentials.token,\n    });\n\n    const sandbox = await client.getSnapshot({\n      snapshotId: params.snapshotId,\n      signal: params.signal,\n    });\n\n    return new Snapshot({\n      client,\n      snapshot: sandbox.json.snapshot,\n    });\n  }\n\n  /**\n   * Delete this snapshot.\n   *\n   * @param opts - Optional parameters.\n   * @param opts.signal - An AbortSignal to cancel the operation.\n   * @returns A promise that resolves once the snapshot has been deleted.\n   */\n  async delete(opts?: { signal?: AbortSignal }): Promise<void> {\n    \"use step\";\n    const client = await this.ensureClient();\n    const response = await client.deleteSnapshot({\n      snapshotId: this.snapshot.id,\n      signal: opts?.signal,\n    });\n\n    this.snapshot = response.json.snapshot;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AA6BA,IAAa,WAAb,MAAa,SAAS;;;;;;;CASpB,MAAc,eAAmC;AAC/C;AACA,MAAI,KAAK,QAAS,QAAO,KAAK;EAC9B,MAAM,cAAc,MAAM,gBAAgB;AAC1C,OAAK,UAAU,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACpB,CAAC;AACF,SAAO,KAAK;;;;;CAMd,IAAW,aAAqB;AAC9B,SAAO,KAAK,SAAS;;;;;CAMvB,IAAW,kBAA0B;AACnC,SAAO,KAAK,SAAS;;;;;CAMvB,IAAW,SAAqC;AAC9C,SAAO,KAAK,SAAS;;;;;CAMvB,IAAW,YAAoB;AAC7B,SAAO,KAAK,SAAS;;;;;CAMvB,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,SAAS,UAAU;;;;;CAM1C,IAAW,YAA8B;AACvC,MAAI,KAAK,SAAS,cAAc,OAC9B;AAGF,SAAO,IAAI,KAAK,KAAK,SAAS,UAAU;;;;;;;;CAc1C,QAAQ,oBAAoB,UAAwC;AAClE,SAAO,EACL,UAAU,SAAS,UACpB;;;;;;;;;;;CAYH,QAAQ,sBAAsB,MAAoC;AAChE,SAAO,IAAI,SAAS,EAClB,UAAU,KAAK,UAChB,CAAC;;CAGJ,YAAY,EACV,QACA,YAIC;OAvGK,UAA4B;AAwGlC,OAAK,UAAU,UAAU;AACzB,OAAK,WAAW;;;;;;;;;;;;;;;;CAiBlB,aAAa,KACX,QAGA;AACA;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC;EACF,MAAM,YAAY,OAAO,WAAoB;AAM3C,WALiB,MAAM,OAAO,cAAc;IAC1C,GAAG;IACH,GAAG;IACH,GAAI,WAAW,UAAa,EAAE,QAAQ;IACvC,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;;;;;;;;;;;;;;CAsBJ,aAAa,YACX,MACA,MACiB;AACjB;EACA,MAAM,cAAc,MAAM,eAAe,KAAK;EAc9C,MAAM,cAPW,MANF,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,MAAM;GACd,CAAC,CAE4B,WAAW;GACvC;GACA,WAAW,YAAY;GACvB,QAAQ;GACR,QAAQ,MAAM;GACf,CAAC,EAE0B,KAAK,QAAQ;AACzC,MAAI,CAAC,WACH,OAAM,IAAI,MAAM,YAAY,KAAK,4BAA4B;AAE/D,SAAO;;;;;;;;CAST,aAAa,IACX,QACmB;AACnB;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACpB,CAAC;AAOF,SAAO,IAAI,SAAS;GAClB;GACA,WAPc,MAAM,OAAO,YAAY;IACvC,YAAY,OAAO;IACnB,QAAQ,OAAO;IAChB,CAAC,EAIkB,KAAK;GACxB,CAAC;;;;;;;;;CAUJ,MAAM,OAAO,MAAgD;AAC3D;AAOA,OAAK,YALY,OADF,MAAM,KAAK,cAAc,EACV,eAAe;GAC3C,YAAY,KAAK,SAAS;GAC1B,QAAQ,MAAM;GACf,CAAC,EAEuB,KAAK"}

package/dist/utils/array.cjs

@@ -0,0 +1,17 @@
+
+//#region src/utils/array.ts
+/**
+* Returns an array from the given item. If the  item is an array it will be
+* returned as a it is, otherwise it will be returned as a single item array.
+* If the item is undefined or null an empty array will be returned.
+*
+* @param item The item to convert to an array.
+* @returns An array.
+*/
+function array(item) {
+	return item !== void 0 && item !== null ? Array.isArray(item) ? item : [item] : [];
+}
+
+//#endregion
+exports.array = array;
+//# sourceMappingURL=array.cjs.map

package/dist/utils/array.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.cjs","names":[],"sources":["../../src/utils/array.ts"],"sourcesContent":["/**\n * Returns an array from the given item. If the  item is an array it will be\n * returned as a it is, otherwise it will be returned as a single item array.\n * If the item is undefined or null an empty array will be returned.\n *\n * @param item The item to convert to an array.\n * @returns An array.\n */\nexport function array<T>(item?: null | T | T[]): T[] {\n  return item !== undefined && item !== null\n    ? Array.isArray(item)\n      ? item\n      : [item]\n    : [];\n}\n"],"mappings":";;;;;;;;;;AAQA,SAAgB,MAAS,MAA4B;AACnD,QAAO,SAAS,UAAa,SAAS,OAClC,MAAM,QAAQ,KAAK,GACjB,OACA,CAAC,KAAK,GACR,EAAE"}