modal 0.10.2-dev.5 → 0.10.2-dev.6

package/README.md

@@ -50,6 +50,7 @@ We also provide a number of examples:
 - [Create a Sandbox using a private image from AWS ECR](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-private-image.ts)
 - [Run a Sidecar and snapshot its filesystem](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-sidecar.ts)
 - [Persist a workspace across Sidecars](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-sidecar-directory-snapshot.ts)
+- [Mount a Volume in a Sidecar](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-sidecar-volume.ts)
 - [Take a snapshot of the filesystem of a Sandbox](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-filesystem-snapshot.ts)
 - [Snapshot the filesystem of a Sandbox when it exits](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-exit-snapshot.ts)
 - [Snapshot a directory, and mount it in a running Sandbox](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-directory-snapshot.ts)

package/dist/index.cjs

@@ -70555,8 +70555,151 @@ var SandboxFilesystem = class {
 };
 
 // src/sandbox_sidecar.ts
-var import_nice_grpc10 = require("nice-grpc");
+var import_nice_grpc11 = require("nice-grpc");
 var import_uuid = require("uuid");
+
+// src/volume.ts
+var import_nice_grpc10 = require("nice-grpc");
+var VolumeService = class {
+  #client;
+  constructor(client) {
+    this.#client = client;
+  }
+  /**
+   * Reference a {@link Volume} by its name.
+   */
+  async fromName(name, params) {
+    try {
+      const resp = await this.#client.cpClient.volumeGetOrCreate({
+        deploymentName: name,
+        environmentName: this.#client.environmentName(params?.environment),
+        objectCreationType: params?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
+      });
+      this.#client.logger.debug(
+        "Retrieved Volume",
+        "volume_id",
+        resp.volumeId,
+        "volume_name",
+        name
+      );
+      return new Volume(resp.volumeId, name);
+    } catch (err) {
+      if (err instanceof import_nice_grpc10.ClientError && err.code === import_nice_grpc10.Status.NOT_FOUND)
+        throw new NotFoundError(err.details);
+      throw err;
+    }
+  }
+  /**
+   * Create a nameless, temporary {@link Volume}.
+   * It persists until closeEphemeral() is called, or the process exits.
+   */
+  async ephemeral(params = {}) {
+    const resp = await this.#client.cpClient.volumeGetOrCreate({
+      objectCreationType: 5 /* OBJECT_CREATION_TYPE_EPHEMERAL */,
+      environmentName: this.#client.environmentName(params.environment)
+    });
+    this.#client.logger.debug(
+      "Created ephemeral Volume",
+      "volume_id",
+      resp.volumeId
+    );
+    const ephemeralHbManager = new EphemeralHeartbeatManager(
+      () => this.#client.cpClient.volumeHeartbeat({ volumeId: resp.volumeId })
+    );
+    return new Volume(resp.volumeId, void 0, void 0, ephemeralHbManager);
+  }
+  /**
+   * Delete a named {@link Volume}.
+   *
+   * Warning: Deletion is irreversible and will affect any Apps currently using the Volume.
+   */
+  async delete(name, params) {
+    try {
+      const volume = await this.fromName(name, {
+        environment: params?.environment,
+        createIfMissing: false
+      });
+      await this.#client.cpClient.volumeDelete({
+        volumeId: volume.volumeId
+      });
+      this.#client.logger.debug(
+        "Deleted Volume",
+        "volume_name",
+        name,
+        "volume_id",
+        volume.volumeId
+      );
+    } catch (err) {
+      const isNotFound = err instanceof NotFoundError || err instanceof import_nice_grpc10.ClientError && err.code === import_nice_grpc10.Status.NOT_FOUND;
+      if (isNotFound && params?.allowMissing) {
+        return;
+      }
+      throw err;
+    }
+  }
+};
+var DEFAULT_MOUNT_OPTIONS = {
+  readOnly: false,
+  subPath: void 0
+};
+var Volume = class _Volume {
+  volumeId;
+  name;
+  /**
+   * @hidden
+   * @internal
+   */
+  _mountOptions = DEFAULT_MOUNT_OPTIONS;
+  #ephemeralHbManager;
+  /** @ignore */
+  constructor(volumeId, name, mountOptions, ephemeralHbManager) {
+    this.volumeId = volumeId;
+    this.name = name;
+    if (mountOptions) {
+      this._mountOptions = mountOptions;
+    }
+    this.#ephemeralHbManager = ephemeralHbManager;
+  }
+  /**
+   * Configure options used when mounting this Volume. Fields left undefined preserve their value
+   * from any previous withMountOptions call on the same Volume (stacking).
+   */
+  withMountOptions(params = {}) {
+    let subPath = this._mountOptions.subPath;
+    if (params.subPath !== void 0) {
+      subPath = params.subPath === "/" ? void 0 : params.subPath;
+    }
+    return new _Volume(
+      this.volumeId,
+      this.name,
+      {
+        readOnly: params.readOnly ?? this._mountOptions.readOnly,
+        subPath
+      },
+      this.#ephemeralHbManager
+    );
+  }
+  /** Delete the ephemeral Volume. Only usable with emphemeral Volumes. */
+  closeEphemeral() {
+    if (this.#ephemeralHbManager) {
+      this.#ephemeralHbManager.stop();
+    } else {
+      throw new InvalidError("Volume is not ephemeral.");
+    }
+  }
+};
+function volumeToMountProto(mountPath, volume) {
+  const opts = volume._mountOptions ?? DEFAULT_MOUNT_OPTIONS;
+  return {
+    volumeId: volume.volumeId,
+    mountPath,
+    allowBackgroundCommits: true,
+    readOnly: opts.readOnly,
+    subPath: opts.subPath
+  };
+}
+
+// src/sandbox_sidecar.ts
 var MAIN_CONTAINER_NAME = "main";
 var CONTAINER_WAIT_POLL_TIMEOUT_SECONDS = 10;
 var CONTROL_PLANE_SIDECAR_CREATE_ENV_VAR = "MODAL_USE_CONTROL_PLANE_SIDECAR_CREATE";
@@ -70573,6 +70716,29 @@ function validateSidecarName(name) {
     );
   }
 }
+function buildSidecarVolumeMounts(volumes) {
+  const mountPathsByVolumeId = /* @__PURE__ */ new Map();
+  const volumeMounts = [];
+  for (const [mountPath, volume] of Object.entries(volumes ?? {})) {
+    if (!volume) {
+      throw new InvalidError(
+        `Volume mounted at "${mountPath}" must not be null or undefined`
+      );
+    }
+    const mountPaths = mountPathsByVolumeId.get(volume.volumeId) ?? [];
+    mountPaths.push(mountPath);
+    mountPathsByVolumeId.set(volume.volumeId, mountPaths);
+    volumeMounts.push(volumeToMountProto(mountPath, volume));
+  }
+  for (const mountPaths of mountPathsByVolumeId.values()) {
+    if (mountPaths.length > 1) {
+      throw new InvalidError(
+        "The same Volume cannot be mounted at multiple paths in a sidecar: " + mountPaths.sort().join(", ")
+      );
+    }
+  }
+  return volumeMounts;
+}
 function sidecarContainerFromProto(access, info) {
   return new SidecarContainer(
     access,
@@ -70610,6 +70776,7 @@ var SidecarService = class {
     Object.assign(envDict, params?.env ?? {});
     await hydrateSecrets(this.#access.client, resolvableSecrets);
     const secretIds = collectSecretIds(resolvableSecrets);
+    const volumeMounts = buildSidecarVolumeMounts(params?.volumes);
     const ptyInfo = params?.pty ? defaultSandboxPTYInfo() : void 0;
     const networkAccess = buildOutboundNetworkAccess(
       false,
@@ -70629,6 +70796,7 @@ var SidecarService = class {
               entrypointArgs: command,
               workdir: params?.workdir ?? void 0,
               secretIds,
+              volumeMounts,
               networkAccess,
               ptyInfo
             }),
@@ -70646,17 +70814,18 @@ var SidecarService = class {
             env: envDict,
             workdir: params?.workdir ?? "",
             secretIds,
+            volumeMounts,
             networkAccess,
             ptyInfo
           })
         );
       }
     } catch (err) {
-      if (err instanceof import_nice_grpc10.ClientError) {
-        if (err.code === import_nice_grpc10.Status.ALREADY_EXISTS) {
+      if (err instanceof import_nice_grpc11.ClientError) {
+        if (err.code === import_nice_grpc11.Status.ALREADY_EXISTS) {
           throw new AlreadyExistsError(err.details || err.message);
         }
-        if (err.code === import_nice_grpc10.Status.INVALID_ARGUMENT) {
+        if (err.code === import_nice_grpc11.Status.INVALID_ARGUMENT) {
           throw new InvalidError(err.details || err.message);
         }
       }
@@ -70682,7 +70851,7 @@ var SidecarService = class {
         })
       );
     } catch (err) {
-      if (err instanceof import_nice_grpc10.ClientError && err.code === import_nice_grpc10.Status.NOT_FOUND) {
+      if (err instanceof import_nice_grpc11.ClientError && err.code === import_nice_grpc11.Status.NOT_FOUND) {
         throw new NotFoundError(`Sidecar container "${name}" not found`);
       }
       throw err;
@@ -71053,147 +71222,6 @@ var SandboxSnapshotService = class {
   }
 };
 
-// src/volume.ts
-var import_nice_grpc11 = require("nice-grpc");
-var VolumeService = class {
-  #client;
-  constructor(client) {
-    this.#client = client;
-  }
-  /**
-   * Reference a {@link Volume} by its name.
-   */
-  async fromName(name, params) {
-    try {
-      const resp = await this.#client.cpClient.volumeGetOrCreate({
-        deploymentName: name,
-        environmentName: this.#client.environmentName(params?.environment),
-        objectCreationType: params?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
-      });
-      this.#client.logger.debug(
-        "Retrieved Volume",
-        "volume_id",
-        resp.volumeId,
-        "volume_name",
-        name
-      );
-      return new Volume(resp.volumeId, name);
-    } catch (err) {
-      if (err instanceof import_nice_grpc11.ClientError && err.code === import_nice_grpc11.Status.NOT_FOUND)
-        throw new NotFoundError(err.details);
-      throw err;
-    }
-  }
-  /**
-   * Create a nameless, temporary {@link Volume}.
-   * It persists until closeEphemeral() is called, or the process exits.
-   */
-  async ephemeral(params = {}) {
-    const resp = await this.#client.cpClient.volumeGetOrCreate({
-      objectCreationType: 5 /* OBJECT_CREATION_TYPE_EPHEMERAL */,
-      environmentName: this.#client.environmentName(params.environment)
-    });
-    this.#client.logger.debug(
-      "Created ephemeral Volume",
-      "volume_id",
-      resp.volumeId
-    );
-    const ephemeralHbManager = new EphemeralHeartbeatManager(
-      () => this.#client.cpClient.volumeHeartbeat({ volumeId: resp.volumeId })
-    );
-    return new Volume(resp.volumeId, void 0, void 0, ephemeralHbManager);
-  }
-  /**
-   * Delete a named {@link Volume}.
-   *
-   * Warning: Deletion is irreversible and will affect any Apps currently using the Volume.
-   */
-  async delete(name, params) {
-    try {
-      const volume = await this.fromName(name, {
-        environment: params?.environment,
-        createIfMissing: false
-      });
-      await this.#client.cpClient.volumeDelete({
-        volumeId: volume.volumeId
-      });
-      this.#client.logger.debug(
-        "Deleted Volume",
-        "volume_name",
-        name,
-        "volume_id",
-        volume.volumeId
-      );
-    } catch (err) {
-      const isNotFound = err instanceof NotFoundError || err instanceof import_nice_grpc11.ClientError && err.code === import_nice_grpc11.Status.NOT_FOUND;
-      if (isNotFound && params?.allowMissing) {
-        return;
-      }
-      throw err;
-    }
-  }
-};
-var DEFAULT_MOUNT_OPTIONS = {
-  readOnly: false,
-  subPath: void 0
-};
-var Volume = class _Volume {
-  volumeId;
-  name;
-  /**
-   * @hidden
-   * @internal
-   */
-  _mountOptions = DEFAULT_MOUNT_OPTIONS;
-  #ephemeralHbManager;
-  /** @ignore */
-  constructor(volumeId, name, mountOptions, ephemeralHbManager) {
-    this.volumeId = volumeId;
-    this.name = name;
-    if (mountOptions) {
-      this._mountOptions = mountOptions;
-    }
-    this.#ephemeralHbManager = ephemeralHbManager;
-  }
-  /**
-   * Configure options used when mounting this Volume. Fields left undefined preserve their value
-   * from any previous withMountOptions call on the same Volume (stacking).
-   */
-  withMountOptions(params = {}) {
-    let subPath = this._mountOptions.subPath;
-    if (params.subPath !== void 0) {
-      subPath = params.subPath === "/" ? void 0 : params.subPath;
-    }
-    return new _Volume(
-      this.volumeId,
-      this.name,
-      {
-        readOnly: params.readOnly ?? this._mountOptions.readOnly,
-        subPath
-      },
-      this.#ephemeralHbManager
-    );
-  }
-  /** Delete the ephemeral Volume. Only usable with emphemeral Volumes. */
-  closeEphemeral() {
-    if (this.#ephemeralHbManager) {
-      this.#ephemeralHbManager.stop();
-    } else {
-      throw new InvalidError("Volume is not ephemeral.");
-    }
-  }
-};
-function volumeToMountProto(mountPath, volume) {
-  const opts = volume._mountOptions ?? DEFAULT_MOUNT_OPTIONS;
-  return {
-    volumeId: volume.volumeId,
-    mountPath,
-    allowBackgroundCommits: true,
-    readOnly: opts.readOnly,
-    subPath: opts.subPath
-  };
-}
-
 // src/sandbox.ts
 var SB_LOGS_INITIAL_DELAY_MS = 10;
 var SB_LOGS_DELAY_FACTOR = 2;
@@ -73372,7 +73400,7 @@ var AuthTokenManager = class {
 };
 
 // src/version.ts
-var SDK_VERSION = "0.10.2-dev.5";
+var SDK_VERSION = "0.10.2-dev.6";
 function getSDKVersion() {
   return SDK_VERSION;
 }

package/dist/index.d.cts

@@ -8893,6 +8893,8 @@ type SidecarCreateParams = {
     secrets?: Secret[];
     /** Working directory of the sidecar container. */
     workdir?: string;
+    /** Mount points for Modal {@link Volume}s. */
+    volumes?: Record<string, Volume>;
     /**
      * List of CIDRs the sidecar is allowed to access. Independent of the main
      * container; if not set, all CIDRs are allowed. An empty list blocks all

package/dist/index.d.ts

@@ -8893,6 +8893,8 @@ type SidecarCreateParams = {
     secrets?: Secret[];
     /** Working directory of the sidecar container. */
     workdir?: string;
+    /** Mount points for Modal {@link Volume}s. */
+    volumes?: Record<string, Volume>;
     /**
      * List of CIDRs the sidecar is allowed to access. Independent of the main
      * container; if not set, all CIDRs are allowed. An empty list blocks all

package/dist/index.js

@@ -70475,8 +70475,151 @@ var SandboxFilesystem = class {
 };
 
 // src/sandbox_sidecar.ts
-import { ClientError as ClientError9, Status as Status9 } from "nice-grpc";
+import { ClientError as ClientError10, Status as Status10 } from "nice-grpc";
 import { v4 as uuidv4 } from "uuid";
+
+// src/volume.ts
+import { ClientError as ClientError9, Status as Status9 } from "nice-grpc";
+var VolumeService = class {
+  #client;
+  constructor(client) {
+    this.#client = client;
+  }
+  /**
+   * Reference a {@link Volume} by its name.
+   */
+  async fromName(name, params) {
+    try {
+      const resp = await this.#client.cpClient.volumeGetOrCreate({
+        deploymentName: name,
+        environmentName: this.#client.environmentName(params?.environment),
+        objectCreationType: params?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
+      });
+      this.#client.logger.debug(
+        "Retrieved Volume",
+        "volume_id",
+        resp.volumeId,
+        "volume_name",
+        name
+      );
+      return new Volume(resp.volumeId, name);
+    } catch (err) {
+      if (err instanceof ClientError9 && err.code === Status9.NOT_FOUND)
+        throw new NotFoundError(err.details);
+      throw err;
+    }
+  }
+  /**
+   * Create a nameless, temporary {@link Volume}.
+   * It persists until closeEphemeral() is called, or the process exits.
+   */
+  async ephemeral(params = {}) {
+    const resp = await this.#client.cpClient.volumeGetOrCreate({
+      objectCreationType: 5 /* OBJECT_CREATION_TYPE_EPHEMERAL */,
+      environmentName: this.#client.environmentName(params.environment)
+    });
+    this.#client.logger.debug(
+      "Created ephemeral Volume",
+      "volume_id",
+      resp.volumeId
+    );
+    const ephemeralHbManager = new EphemeralHeartbeatManager(
+      () => this.#client.cpClient.volumeHeartbeat({ volumeId: resp.volumeId })
+    );
+    return new Volume(resp.volumeId, void 0, void 0, ephemeralHbManager);
+  }
+  /**
+   * Delete a named {@link Volume}.
+   *
+   * Warning: Deletion is irreversible and will affect any Apps currently using the Volume.
+   */
+  async delete(name, params) {
+    try {
+      const volume = await this.fromName(name, {
+        environment: params?.environment,
+        createIfMissing: false
+      });
+      await this.#client.cpClient.volumeDelete({
+        volumeId: volume.volumeId
+      });
+      this.#client.logger.debug(
+        "Deleted Volume",
+        "volume_name",
+        name,
+        "volume_id",
+        volume.volumeId
+      );
+    } catch (err) {
+      const isNotFound = err instanceof NotFoundError || err instanceof ClientError9 && err.code === Status9.NOT_FOUND;
+      if (isNotFound && params?.allowMissing) {
+        return;
+      }
+      throw err;
+    }
+  }
+};
+var DEFAULT_MOUNT_OPTIONS = {
+  readOnly: false,
+  subPath: void 0
+};
+var Volume = class _Volume {
+  volumeId;
+  name;
+  /**
+   * @hidden
+   * @internal
+   */
+  _mountOptions = DEFAULT_MOUNT_OPTIONS;
+  #ephemeralHbManager;
+  /** @ignore */
+  constructor(volumeId, name, mountOptions, ephemeralHbManager) {
+    this.volumeId = volumeId;
+    this.name = name;
+    if (mountOptions) {
+      this._mountOptions = mountOptions;
+    }
+    this.#ephemeralHbManager = ephemeralHbManager;
+  }
+  /**
+   * Configure options used when mounting this Volume. Fields left undefined preserve their value
+   * from any previous withMountOptions call on the same Volume (stacking).
+   */
+  withMountOptions(params = {}) {
+    let subPath = this._mountOptions.subPath;
+    if (params.subPath !== void 0) {
+      subPath = params.subPath === "/" ? void 0 : params.subPath;
+    }
+    return new _Volume(
+      this.volumeId,
+      this.name,
+      {
+        readOnly: params.readOnly ?? this._mountOptions.readOnly,
+        subPath
+      },
+      this.#ephemeralHbManager
+    );
+  }
+  /** Delete the ephemeral Volume. Only usable with emphemeral Volumes. */
+  closeEphemeral() {
+    if (this.#ephemeralHbManager) {
+      this.#ephemeralHbManager.stop();
+    } else {
+      throw new InvalidError("Volume is not ephemeral.");
+    }
+  }
+};
+function volumeToMountProto(mountPath, volume) {
+  const opts = volume._mountOptions ?? DEFAULT_MOUNT_OPTIONS;
+  return {
+    volumeId: volume.volumeId,
+    mountPath,
+    allowBackgroundCommits: true,
+    readOnly: opts.readOnly,
+    subPath: opts.subPath
+  };
+}
+
+// src/sandbox_sidecar.ts
 var MAIN_CONTAINER_NAME = "main";
 var CONTAINER_WAIT_POLL_TIMEOUT_SECONDS = 10;
 var CONTROL_PLANE_SIDECAR_CREATE_ENV_VAR = "MODAL_USE_CONTROL_PLANE_SIDECAR_CREATE";
@@ -70493,6 +70636,29 @@ function validateSidecarName(name) {
     );
   }
 }
+function buildSidecarVolumeMounts(volumes) {
+  const mountPathsByVolumeId = /* @__PURE__ */ new Map();
+  const volumeMounts = [];
+  for (const [mountPath, volume] of Object.entries(volumes ?? {})) {
+    if (!volume) {
+      throw new InvalidError(
+        `Volume mounted at "${mountPath}" must not be null or undefined`
+      );
+    }
+    const mountPaths = mountPathsByVolumeId.get(volume.volumeId) ?? [];
+    mountPaths.push(mountPath);
+    mountPathsByVolumeId.set(volume.volumeId, mountPaths);
+    volumeMounts.push(volumeToMountProto(mountPath, volume));
+  }
+  for (const mountPaths of mountPathsByVolumeId.values()) {
+    if (mountPaths.length > 1) {
+      throw new InvalidError(
+        "The same Volume cannot be mounted at multiple paths in a sidecar: " + mountPaths.sort().join(", ")
+      );
+    }
+  }
+  return volumeMounts;
+}
 function sidecarContainerFromProto(access, info) {
   return new SidecarContainer(
     access,
@@ -70530,6 +70696,7 @@ var SidecarService = class {
     Object.assign(envDict, params?.env ?? {});
     await hydrateSecrets(this.#access.client, resolvableSecrets);
     const secretIds = collectSecretIds(resolvableSecrets);
+    const volumeMounts = buildSidecarVolumeMounts(params?.volumes);
     const ptyInfo = params?.pty ? defaultSandboxPTYInfo() : void 0;
     const networkAccess = buildOutboundNetworkAccess(
       false,
@@ -70549,6 +70716,7 @@ var SidecarService = class {
               entrypointArgs: command,
               workdir: params?.workdir ?? void 0,
               secretIds,
+              volumeMounts,
               networkAccess,
               ptyInfo
             }),
@@ -70566,17 +70734,18 @@ var SidecarService = class {
             env: envDict,
             workdir: params?.workdir ?? "",
             secretIds,
+            volumeMounts,
             networkAccess,
             ptyInfo
           })
         );
       }
     } catch (err) {
-      if (err instanceof ClientError9) {
-        if (err.code === Status9.ALREADY_EXISTS) {
+      if (err instanceof ClientError10) {
+        if (err.code === Status10.ALREADY_EXISTS) {
           throw new AlreadyExistsError(err.details || err.message);
         }
-        if (err.code === Status9.INVALID_ARGUMENT) {
+        if (err.code === Status10.INVALID_ARGUMENT) {
           throw new InvalidError(err.details || err.message);
         }
       }
@@ -70602,7 +70771,7 @@ var SidecarService = class {
         })
       );
     } catch (err) {
-      if (err instanceof ClientError9 && err.code === Status9.NOT_FOUND) {
+      if (err instanceof ClientError10 && err.code === Status10.NOT_FOUND) {
         throw new NotFoundError(`Sidecar container "${name}" not found`);
       }
       throw err;
@@ -70973,147 +71142,6 @@ var SandboxSnapshotService = class {
   }
 };
 
-// src/volume.ts
-import { ClientError as ClientError10, Status as Status10 } from "nice-grpc";
-var VolumeService = class {
-  #client;
-  constructor(client) {
-    this.#client = client;
-  }
-  /**
-   * Reference a {@link Volume} by its name.
-   */
-  async fromName(name, params) {
-    try {
-      const resp = await this.#client.cpClient.volumeGetOrCreate({
-        deploymentName: name,
-        environmentName: this.#client.environmentName(params?.environment),
-        objectCreationType: params?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
-      });
-      this.#client.logger.debug(
-        "Retrieved Volume",
-        "volume_id",
-        resp.volumeId,
-        "volume_name",
-        name
-      );
-      return new Volume(resp.volumeId, name);
-    } catch (err) {
-      if (err instanceof ClientError10 && err.code === Status10.NOT_FOUND)
-        throw new NotFoundError(err.details);
-      throw err;
-    }
-  }
-  /**
-   * Create a nameless, temporary {@link Volume}.
-   * It persists until closeEphemeral() is called, or the process exits.
-   */
-  async ephemeral(params = {}) {
-    const resp = await this.#client.cpClient.volumeGetOrCreate({
-      objectCreationType: 5 /* OBJECT_CREATION_TYPE_EPHEMERAL */,
-      environmentName: this.#client.environmentName(params.environment)
-    });
-    this.#client.logger.debug(
-      "Created ephemeral Volume",
-      "volume_id",
-      resp.volumeId
-    );
-    const ephemeralHbManager = new EphemeralHeartbeatManager(
-      () => this.#client.cpClient.volumeHeartbeat({ volumeId: resp.volumeId })
-    );
-    return new Volume(resp.volumeId, void 0, void 0, ephemeralHbManager);
-  }
-  /**
-   * Delete a named {@link Volume}.
-   *
-   * Warning: Deletion is irreversible and will affect any Apps currently using the Volume.
-   */
-  async delete(name, params) {
-    try {
-      const volume = await this.fromName(name, {
-        environment: params?.environment,
-        createIfMissing: false
-      });
-      await this.#client.cpClient.volumeDelete({
-        volumeId: volume.volumeId
-      });
-      this.#client.logger.debug(
-        "Deleted Volume",
-        "volume_name",
-        name,
-        "volume_id",
-        volume.volumeId
-      );
-    } catch (err) {
-      const isNotFound = err instanceof NotFoundError || err instanceof ClientError10 && err.code === Status10.NOT_FOUND;
-      if (isNotFound && params?.allowMissing) {
-        return;
-      }
-      throw err;
-    }
-  }
-};
-var DEFAULT_MOUNT_OPTIONS = {
-  readOnly: false,
-  subPath: void 0
-};
-var Volume = class _Volume {
-  volumeId;
-  name;
-  /**
-   * @hidden
-   * @internal
-   */
-  _mountOptions = DEFAULT_MOUNT_OPTIONS;
-  #ephemeralHbManager;
-  /** @ignore */
-  constructor(volumeId, name, mountOptions, ephemeralHbManager) {
-    this.volumeId = volumeId;
-    this.name = name;
-    if (mountOptions) {
-      this._mountOptions = mountOptions;
-    }
-    this.#ephemeralHbManager = ephemeralHbManager;
-  }
-  /**
-   * Configure options used when mounting this Volume. Fields left undefined preserve their value
-   * from any previous withMountOptions call on the same Volume (stacking).
-   */
-  withMountOptions(params = {}) {
-    let subPath = this._mountOptions.subPath;
-    if (params.subPath !== void 0) {
-      subPath = params.subPath === "/" ? void 0 : params.subPath;
-    }
-    return new _Volume(
-      this.volumeId,
-      this.name,
-      {
-        readOnly: params.readOnly ?? this._mountOptions.readOnly,
-        subPath
-      },
-      this.#ephemeralHbManager
-    );
-  }
-  /** Delete the ephemeral Volume. Only usable with emphemeral Volumes. */
-  closeEphemeral() {
-    if (this.#ephemeralHbManager) {
-      this.#ephemeralHbManager.stop();
-    } else {
-      throw new InvalidError("Volume is not ephemeral.");
-    }
-  }
-};
-function volumeToMountProto(mountPath, volume) {
-  const opts = volume._mountOptions ?? DEFAULT_MOUNT_OPTIONS;
-  return {
-    volumeId: volume.volumeId,
-    mountPath,
-    allowBackgroundCommits: true,
-    readOnly: opts.readOnly,
-    subPath: opts.subPath
-  };
-}
-
 // src/sandbox.ts
 var SB_LOGS_INITIAL_DELAY_MS = 10;
 var SB_LOGS_DELAY_FACTOR = 2;
@@ -73292,7 +73320,7 @@ var AuthTokenManager = class {
 };
 
 // src/version.ts
-var SDK_VERSION = "0.10.2-dev.5";
+var SDK_VERSION = "0.10.2-dev.6";
 function getSDKVersion() {
   return SDK_VERSION;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modal",
-  "version": "0.10.2-dev.5",
+  "version": "0.10.2-dev.6",
   "description": "Modal SDK for JavaScript/TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs/guide/sdk-javascript-go",