@vercel/sandbox 1.9.3 → 1.10.1

package/dist/snapshot.d.ts

@@ -3,8 +3,12 @@ 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 {
   /**
@@ -23,7 +27,14 @@ interface GetSnapshotParams {
  * @hideconstructor
  */
 declare class Snapshot {
-  private readonly client;
+  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.
    */
@@ -53,16 +64,27 @@ declare class Snapshot {
    */
   private snapshot;
   /**
-   * Create a new Snapshot instance.
+   * 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 client - API client used to communicate with the backend
-   * @param snapshot - Snapshot metadata
+   * @param data - The serialized snapshot data
+   * @returns The reconstructed Snapshot instance
    */
+  static [WORKFLOW_DESERIALIZE](data: SerializedSnapshot): Snapshot;
   constructor({
     client,
     snapshot
   }: {
-    client: APIClient;
+    client?: APIClient;
     snapshot: SnapshotMetadata;
   });
   /**
@@ -106,5 +128,5 @@ declare class Snapshot {
   }): Promise<void>;
 }
 //#endregion
-export { Snapshot };
+export { SerializedSnapshot, Snapshot };
 //# sourceMappingURL=snapshot.d.ts.map

package/dist/snapshot.js

@@ -1,6 +1,7 @@
 import { APIClient } from "./api-client/api-client.js";
 import "./api-client/index.js";
 import { getCredentials } from "./utils/get-credentials.js";
+import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from "@workflow/serde";
 
 //#region src/snapshot.ts
 /**
@@ -10,6 +11,22 @@ import { getCredentials } from "./utils/get-credentials.js";
 * @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.
 	*/
@@ -48,13 +65,29 @@ var Snapshot = class Snapshot {
 		return new Date(this.snapshot.expiresAt);
 	}
 	/**
-	* Create a new Snapshot instance.
+	* Serialize a Snapshot instance to plain data for @workflow/serde.
 	*
-	* @param client - API client used to communicate with the backend
-	* @param snapshot - Snapshot metadata
+	* @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 = client;
+		this._client = null;
+		this._client = client ?? null;
 		this.snapshot = snapshot;
 	}
 	/**
@@ -104,7 +137,7 @@ var Snapshot = class Snapshot {
 	*/
 	async delete(opts) {
 		"use step";
-		this.snapshot = (await this.client.deleteSnapshot({
+		this.snapshot = (await (await this.ensureClient()).deleteSnapshot({
 			snapshotId: this.snapshot.id,
 			signal: opts?.signal
 		})).json.snapshot;

package/dist/snapshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.js","names":[],"sources":["../src/snapshot.ts"],"sourcesContent":["import 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\";\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 readonly client: APIClient;\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 the sandbox from which this snapshot was created.\n   */\n  public get sourceSandboxId(): string {\n    return this.snapshot.sourceSandboxId;\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   * Create a new Snapshot instance.\n   *\n   * @param client - API client used to communicate with the backend\n   * @param snapshot - Snapshot metadata\n   */\n  constructor({\n    client,\n    snapshot,\n  }: {\n    client: APIClient;\n    snapshot: SnapshotMetadata;\n  }) {\n    this.client = client;\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  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    return client.listSnapshots({\n      ...credentials,\n      ...params,\n    });\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 response = await this.client!.deleteSnapshot({\n      snapshotId: this.snapshot.id,\n      signal: opts?.signal,\n    });\n\n    this.snapshot = response.json.snapshot;\n  }\n}\n"],"mappings":";;;;;;;;;;;AAuBA,IAAa,WAAb,MAAa,SAAS;;;;CAMpB,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,YAAY,EACV,QACA,YAIC;AACD,OAAK,SAAS;AACd,OAAK,WAAW;;;;;;;CAQlB,aAAa,KACX,QAGA;AACA;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;AAMhD,SALe,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC,CACY,cAAc;GAC1B,GAAG;GACH,GAAG;GACJ,CAAC;;;;;;;;CASJ,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;AAMA,OAAK,YALY,MAAM,KAAK,OAAQ,eAAe;GACjD,YAAY,KAAK,SAAS;GAC1B,QAAQ,MAAM;GACf,CAAC,EAEuB,KAAK"}
+{"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\";\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 the sandbox from which this snapshot was created.\n   */\n  public get sourceSandboxId(): string {\n    return this.snapshot.sourceSandboxId;\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  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    return client.listSnapshots({\n      ...credentials,\n      ...params,\n    });\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":";;;;;;;;;;;;AA4BA,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;;;;;;;CAQlB,aAAa,KACX,QAGA;AACA;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;AAMhD,SALe,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC,CACY,cAAc;GAC1B,GAAG;GACH,GAAG;GACJ,CAAC;;;;;;;;CASJ,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/version.cjs

@@ -1,6 +1,6 @@
 
 //#region src/version.ts
-const VERSION = "1.9.3";
+const VERSION = "1.10.1";
 
 //#endregion
 exports.VERSION = VERSION;

package/dist/version.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.cjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"1.9.3\";\n"],"mappings":";;AACA,MAAa,UAAU"}
+{"version":3,"file":"version.cjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"1.10.1\";\n"],"mappings":";;AACA,MAAa,UAAU"}

package/dist/version.js

@@ -1,5 +1,5 @@
 //#region src/version.ts
-const VERSION = "1.9.3";
+const VERSION = "1.10.1";
 
 //#endregion
 export { VERSION };

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"1.9.3\";\n"],"mappings":";AACA,MAAa,UAAU"}
+{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"1.10.1\";\n"],"mappings":";AACA,MAAa,UAAU"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "1.9.3",
+  "version": "1.10.1",
   "description": "Software Development Kit for Vercel Sandbox",
   "type": "module",
   "main": "dist/index.cjs",