modal 0.3.14 → 0.3.15

package/dist/index.cjs

@@ -18869,7 +18869,8 @@ function createBaseFunctionHandleMetadata() {
     methodHandleMetadata: {},
     functionSchema: void 0,
     inputPlaneUrl: void 0,
-    inputPlaneRegion: void 0
+    inputPlaneRegion: void 0,
+    maxObjectSizeBytes: void 0
   };
 }
 var FunctionHandleMetadata = {
@@ -18910,6 +18911,9 @@ var FunctionHandleMetadata = {
     if (message.inputPlaneRegion !== void 0) {
       writer.uint32(378).string(message.inputPlaneRegion);
     }
+    if (message.maxObjectSizeBytes !== void 0) {
+      writer.uint32(384).uint64(message.maxObjectSizeBytes);
+    }
     return writer;
   },
   decode(input, length) {
@@ -19006,6 +19010,13 @@ var FunctionHandleMetadata = {
           message.inputPlaneRegion = reader.string();
           continue;
         }
+        case 48: {
+          if (tag !== 384) {
+            break;
+          }
+          message.maxObjectSizeBytes = longToNumber(reader.uint64());
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -19033,7 +19044,8 @@ var FunctionHandleMetadata = {
       ) : {},
       functionSchema: isSet3(object.functionSchema) ? FunctionSchema.fromJSON(object.functionSchema) : void 0,
       inputPlaneUrl: isSet3(object.inputPlaneUrl) ? globalThis.String(object.inputPlaneUrl) : void 0,
-      inputPlaneRegion: isSet3(object.inputPlaneRegion) ? globalThis.String(object.inputPlaneRegion) : void 0
+      inputPlaneRegion: isSet3(object.inputPlaneRegion) ? globalThis.String(object.inputPlaneRegion) : void 0,
+      maxObjectSizeBytes: isSet3(object.maxObjectSizeBytes) ? globalThis.Number(object.maxObjectSizeBytes) : void 0
     };
   },
   toJSON(message) {
@@ -19080,6 +19092,9 @@ var FunctionHandleMetadata = {
     if (message.inputPlaneRegion !== void 0) {
       obj.inputPlaneRegion = message.inputPlaneRegion;
     }
+    if (message.maxObjectSizeBytes !== void 0) {
+      obj.maxObjectSizeBytes = Math.round(message.maxObjectSizeBytes);
+    }
     return obj;
   },
   create(base) {
@@ -19104,6 +19119,7 @@ var FunctionHandleMetadata = {
     message.functionSchema = object.functionSchema !== void 0 && object.functionSchema !== null ? FunctionSchema.fromPartial(object.functionSchema) : void 0;
     message.inputPlaneUrl = object.inputPlaneUrl ?? void 0;
     message.inputPlaneRegion = object.inputPlaneRegion ?? void 0;
+    message.maxObjectSizeBytes = object.maxObjectSizeBytes ?? void 0;
     return message;
   }
 };
@@ -38670,7 +38686,7 @@ function authMiddleware(profile) {
     options.metadata ??= new import_nice_grpc.Metadata();
     options.metadata.set(
       "x-modal-client-type",
-      String(7 /* CLIENT_TYPE_LIBMODAL */)
+      String(8 /* CLIENT_TYPE_LIBMODAL_JS */)
     );
     options.metadata.set("x-modal-client-version", "1.0.0");
     options.metadata.set("x-modal-token-id", tokenId);
@@ -39191,7 +39207,7 @@ var Tunnel = class {
     return [this.unencryptedHost, this.unencryptedPort];
   }
 };
-var Sandbox2 = class {
+var Sandbox2 = class _Sandbox {
   sandboxId;
   stdin;
   stdout;
@@ -39233,11 +39249,13 @@ var Sandbox2 = class {
   }
   async exec(command, options) {
     const taskId = await this.#getTaskId();
+    const secretIds = options?.secrets ? options.secrets.map((secret) => secret.secretId) : [];
     const resp = await client.containerExec({
       taskId,
       command,
       workdir: options?.workdir,
-      timeoutSecs: options?.timeout ? options.timeout / 1e3 : 0
+      timeoutSecs: options?.timeout ? options.timeout / 1e3 : 0,
+      secretIds
     });
     return new ContainerProcess(resp.execId, options);
   }
@@ -39271,7 +39289,7 @@ var Sandbox2 = class {
         timeout: 55
       });
       if (resp.result) {
-        return resp.result.exitcode;
+        return _Sandbox.#getReturnCode(resp.result);
       }
     }
   }
@@ -39304,6 +39322,53 @@ var Sandbox2 = class {
     }
     return this.#tunnels;
   }
+  /**
+   * Snapshot the filesystem of the Sandbox.
+   *
+   * Returns an `Image` object which can be used to spawn a new Sandbox with the same filesystem.
+   *
+   * @param timeout - Timeout for the snapshot operation in milliseconds
+   * @returns Promise that resolves to an Image
+   */
+  async snapshotFilesystem(timeout = 55e3) {
+    const resp = await client.sandboxSnapshotFs({
+      sandboxId: this.sandboxId,
+      timeout: timeout / 1e3
+    });
+    if (resp.result?.status !== 1 /* GENERIC_STATUS_SUCCESS */) {
+      throw new Error(
+        `Sandbox snapshot failed: ${resp.result?.exception || "Unknown error"}`
+      );
+    }
+    if (!resp.imageId) {
+      throw new Error("Sandbox snapshot response missing image ID");
+    }
+    return new Image2(resp.imageId);
+  }
+  /**
+   * Check if the Sandbox has finished running.
+   *
+   * Returns `null` if the Sandbox is still running, else returns the exit code.
+   */
+  async poll() {
+    const resp = await client.sandboxWait({
+      sandboxId: this.sandboxId,
+      timeout: 0
+    });
+    return _Sandbox.#getReturnCode(resp.result);
+  }
+  static #getReturnCode(result) {
+    if (result === void 0 || result.status === 0 /* GENERIC_STATUS_UNSPECIFIED */) {
+      return null;
+    }
+    if (result.status === 4 /* GENERIC_STATUS_TIMEOUT */) {
+      return 124;
+    } else if (result.status === 3 /* GENERIC_STATUS_TERMINATED */) {
+      return 137;
+    } else {
+      return result.exitcode;
+    }
+  }
 };
 var ContainerProcess = class {
   stdin;
@@ -39544,6 +39609,7 @@ var App = class _App {
         }))
       );
     }
+    const secretIds = options.secrets ? options.secrets.map((secret) => secret.secretId) : [];
     const createResp = await client.sandboxCreate({
       appId: this.appId,
       definition: {
@@ -39560,6 +39626,7 @@ var App = class _App {
           memoryMb: options.memory ?? 128
         },
         volumeMounts,
+        secretIds,
         openPorts: openPorts.length > 0 ? { ports: openPorts } : void 0
       }
     });

package/dist/index.d.cts

@@ -124,6 +124,20 @@ interface ModalWriteStream<R = any> extends WritableStream<R> {
     writeBytes(bytes: Uint8Array): Promise<void>;
 }
 
+/** Options for `Secret.fromName()`. */
+type SecretFromNameOptions = {
+    environment?: string;
+    requiredKeys?: string[];
+};
+/** Secrets provide a dictionary of environment variables for images. */
+declare class Secret {
+    readonly secretId: string;
+    /** @ignore */
+    constructor(secretId: string);
+    /** Reference a Secret by its name. */
+    static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
+}
+
 /**
  * Stdin is always present, but this option allow you to drop stdout or stderr
  * if you don't need them. The default is "pipe", matching Node.js behavior.
@@ -149,6 +163,8 @@ type ExecOptions = {
     workdir?: string;
     /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
     timeout?: number;
+    /** Secrets with environment variables for the command. */
+    secrets?: [Secret];
 };
 /** A port forwarded from within a running Modal sandbox. */
 declare class Tunnel {
@@ -196,6 +212,21 @@ declare class Sandbox {
      * @returns A dictionary of Tunnel objects which are keyed by the container port.
      */
     tunnels(timeout?: number): Promise<Record<number, Tunnel>>;
+    /**
+     * Snapshot the filesystem of the Sandbox.
+     *
+     * Returns an `Image` object which can be used to spawn a new Sandbox with the same filesystem.
+     *
+     * @param timeout - Timeout for the snapshot operation in milliseconds
+     * @returns Promise that resolves to an Image
+     */
+    snapshotFilesystem(timeout?: number): Promise<Image>;
+    /**
+     * Check if the Sandbox has finished running.
+     *
+     * Returns `null` if the Sandbox is still running, else returns the exit code.
+     */
+    poll(): Promise<number | null>;
 }
 declare class ContainerProcess<R extends string | Uint8Array = any> {
     #private;
@@ -208,20 +239,6 @@ declare class ContainerProcess<R extends string | Uint8Array = any> {
     wait(): Promise<number>;
 }
 
-/** Options for `Secret.fromName()`. */
-type SecretFromNameOptions = {
-    environment?: string;
-    requiredKeys?: string[];
-};
-/** Secrets provide a dictionary of environment variables for images. */
-declare class Secret {
-    readonly secretId: string;
-    /** @ignore */
-    constructor(secretId: string);
-    /** Reference a Secret by its name. */
-    static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
-}
-
 /** Options for `Volume.fromName()`. */
 type VolumeFromNameOptions = {
     environment?: string;
@@ -261,6 +278,8 @@ type SandboxCreateOptions = {
      * Default behavior is to sleep indefinitely until timeout or termination.
      */
     command?: string[];
+    /** Secrets to inject into the sandbox. */
+    secrets?: Secret[];
     /** Mount points for Modal Volumes. */
     volumes?: Record<string, Volume>;
     /** List of ports to tunnel into the sandbox. Encrypted ports are tunneled with TLS. */

package/dist/index.d.ts

@@ -124,6 +124,20 @@ interface ModalWriteStream<R = any> extends WritableStream<R> {
     writeBytes(bytes: Uint8Array): Promise<void>;
 }
 
+/** Options for `Secret.fromName()`. */
+type SecretFromNameOptions = {
+    environment?: string;
+    requiredKeys?: string[];
+};
+/** Secrets provide a dictionary of environment variables for images. */
+declare class Secret {
+    readonly secretId: string;
+    /** @ignore */
+    constructor(secretId: string);
+    /** Reference a Secret by its name. */
+    static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
+}
+
 /**
  * Stdin is always present, but this option allow you to drop stdout or stderr
  * if you don't need them. The default is "pipe", matching Node.js behavior.
@@ -149,6 +163,8 @@ type ExecOptions = {
     workdir?: string;
     /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
     timeout?: number;
+    /** Secrets with environment variables for the command. */
+    secrets?: [Secret];
 };
 /** A port forwarded from within a running Modal sandbox. */
 declare class Tunnel {
@@ -196,6 +212,21 @@ declare class Sandbox {
      * @returns A dictionary of Tunnel objects which are keyed by the container port.
      */
     tunnels(timeout?: number): Promise<Record<number, Tunnel>>;
+    /**
+     * Snapshot the filesystem of the Sandbox.
+     *
+     * Returns an `Image` object which can be used to spawn a new Sandbox with the same filesystem.
+     *
+     * @param timeout - Timeout for the snapshot operation in milliseconds
+     * @returns Promise that resolves to an Image
+     */
+    snapshotFilesystem(timeout?: number): Promise<Image>;
+    /**
+     * Check if the Sandbox has finished running.
+     *
+     * Returns `null` if the Sandbox is still running, else returns the exit code.
+     */
+    poll(): Promise<number | null>;
 }
 declare class ContainerProcess<R extends string | Uint8Array = any> {
     #private;
@@ -208,20 +239,6 @@ declare class ContainerProcess<R extends string | Uint8Array = any> {
     wait(): Promise<number>;
 }
 
-/** Options for `Secret.fromName()`. */
-type SecretFromNameOptions = {
-    environment?: string;
-    requiredKeys?: string[];
-};
-/** Secrets provide a dictionary of environment variables for images. */
-declare class Secret {
-    readonly secretId: string;
-    /** @ignore */
-    constructor(secretId: string);
-    /** Reference a Secret by its name. */
-    static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
-}
-
 /** Options for `Volume.fromName()`. */
 type VolumeFromNameOptions = {
     environment?: string;
@@ -261,6 +278,8 @@ type SandboxCreateOptions = {
      * Default behavior is to sleep indefinitely until timeout or termination.
      */
     command?: string[];
+    /** Secrets to inject into the sandbox. */
+    secrets?: Secret[];
     /** Mount points for Modal Volumes. */
     volumes?: Record<string, Volume>;
     /** List of ports to tunnel into the sandbox. Encrypted ports are tunneled with TLS. */

package/dist/index.js

@@ -18813,7 +18813,8 @@ function createBaseFunctionHandleMetadata() {
     methodHandleMetadata: {},
     functionSchema: void 0,
     inputPlaneUrl: void 0,
-    inputPlaneRegion: void 0
+    inputPlaneRegion: void 0,
+    maxObjectSizeBytes: void 0
   };
 }
 var FunctionHandleMetadata = {
@@ -18854,6 +18855,9 @@ var FunctionHandleMetadata = {
     if (message.inputPlaneRegion !== void 0) {
       writer.uint32(378).string(message.inputPlaneRegion);
     }
+    if (message.maxObjectSizeBytes !== void 0) {
+      writer.uint32(384).uint64(message.maxObjectSizeBytes);
+    }
     return writer;
   },
   decode(input, length) {
@@ -18950,6 +18954,13 @@ var FunctionHandleMetadata = {
           message.inputPlaneRegion = reader.string();
           continue;
         }
+        case 48: {
+          if (tag !== 384) {
+            break;
+          }
+          message.maxObjectSizeBytes = longToNumber(reader.uint64());
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -18977,7 +18988,8 @@ var FunctionHandleMetadata = {
       ) : {},
       functionSchema: isSet3(object.functionSchema) ? FunctionSchema.fromJSON(object.functionSchema) : void 0,
       inputPlaneUrl: isSet3(object.inputPlaneUrl) ? globalThis.String(object.inputPlaneUrl) : void 0,
-      inputPlaneRegion: isSet3(object.inputPlaneRegion) ? globalThis.String(object.inputPlaneRegion) : void 0
+      inputPlaneRegion: isSet3(object.inputPlaneRegion) ? globalThis.String(object.inputPlaneRegion) : void 0,
+      maxObjectSizeBytes: isSet3(object.maxObjectSizeBytes) ? globalThis.Number(object.maxObjectSizeBytes) : void 0
     };
   },
   toJSON(message) {
@@ -19024,6 +19036,9 @@ var FunctionHandleMetadata = {
     if (message.inputPlaneRegion !== void 0) {
       obj.inputPlaneRegion = message.inputPlaneRegion;
     }
+    if (message.maxObjectSizeBytes !== void 0) {
+      obj.maxObjectSizeBytes = Math.round(message.maxObjectSizeBytes);
+    }
     return obj;
   },
   create(base) {
@@ -19048,6 +19063,7 @@ var FunctionHandleMetadata = {
     message.functionSchema = object.functionSchema !== void 0 && object.functionSchema !== null ? FunctionSchema.fromPartial(object.functionSchema) : void 0;
     message.inputPlaneUrl = object.inputPlaneUrl ?? void 0;
     message.inputPlaneRegion = object.inputPlaneRegion ?? void 0;
+    message.maxObjectSizeBytes = object.maxObjectSizeBytes ?? void 0;
     return message;
   }
 };
@@ -38620,7 +38636,7 @@ function authMiddleware(profile) {
     options.metadata ??= new Metadata();
     options.metadata.set(
       "x-modal-client-type",
-      String(7 /* CLIENT_TYPE_LIBMODAL */)
+      String(8 /* CLIENT_TYPE_LIBMODAL_JS */)
     );
     options.metadata.set("x-modal-client-version", "1.0.0");
     options.metadata.set("x-modal-token-id", tokenId);
@@ -39141,7 +39157,7 @@ var Tunnel = class {
     return [this.unencryptedHost, this.unencryptedPort];
   }
 };
-var Sandbox2 = class {
+var Sandbox2 = class _Sandbox {
   sandboxId;
   stdin;
   stdout;
@@ -39183,11 +39199,13 @@ var Sandbox2 = class {
   }
   async exec(command, options) {
     const taskId = await this.#getTaskId();
+    const secretIds = options?.secrets ? options.secrets.map((secret) => secret.secretId) : [];
     const resp = await client.containerExec({
       taskId,
       command,
       workdir: options?.workdir,
-      timeoutSecs: options?.timeout ? options.timeout / 1e3 : 0
+      timeoutSecs: options?.timeout ? options.timeout / 1e3 : 0,
+      secretIds
     });
     return new ContainerProcess(resp.execId, options);
   }
@@ -39221,7 +39239,7 @@ var Sandbox2 = class {
         timeout: 55
       });
       if (resp.result) {
-        return resp.result.exitcode;
+        return _Sandbox.#getReturnCode(resp.result);
       }
     }
   }
@@ -39254,6 +39272,53 @@ var Sandbox2 = class {
     }
     return this.#tunnels;
   }
+  /**
+   * Snapshot the filesystem of the Sandbox.
+   *
+   * Returns an `Image` object which can be used to spawn a new Sandbox with the same filesystem.
+   *
+   * @param timeout - Timeout for the snapshot operation in milliseconds
+   * @returns Promise that resolves to an Image
+   */
+  async snapshotFilesystem(timeout = 55e3) {
+    const resp = await client.sandboxSnapshotFs({
+      sandboxId: this.sandboxId,
+      timeout: timeout / 1e3
+    });
+    if (resp.result?.status !== 1 /* GENERIC_STATUS_SUCCESS */) {
+      throw new Error(
+        `Sandbox snapshot failed: ${resp.result?.exception || "Unknown error"}`
+      );
+    }
+    if (!resp.imageId) {
+      throw new Error("Sandbox snapshot response missing image ID");
+    }
+    return new Image2(resp.imageId);
+  }
+  /**
+   * Check if the Sandbox has finished running.
+   *
+   * Returns `null` if the Sandbox is still running, else returns the exit code.
+   */
+  async poll() {
+    const resp = await client.sandboxWait({
+      sandboxId: this.sandboxId,
+      timeout: 0
+    });
+    return _Sandbox.#getReturnCode(resp.result);
+  }
+  static #getReturnCode(result) {
+    if (result === void 0 || result.status === 0 /* GENERIC_STATUS_UNSPECIFIED */) {
+      return null;
+    }
+    if (result.status === 4 /* GENERIC_STATUS_TIMEOUT */) {
+      return 124;
+    } else if (result.status === 3 /* GENERIC_STATUS_TERMINATED */) {
+      return 137;
+    } else {
+      return result.exitcode;
+    }
+  }
 };
 var ContainerProcess = class {
   stdin;
@@ -39494,6 +39559,7 @@ var App = class _App {
         }))
       );
     }
+    const secretIds = options.secrets ? options.secrets.map((secret) => secret.secretId) : [];
     const createResp = await client.sandboxCreate({
       appId: this.appId,
       definition: {
@@ -39510,6 +39576,7 @@ var App = class _App {
           memoryMb: options.memory ?? 128
         },
         volumeMounts,
+        secretIds,
         openPorts: openPorts.length > 0 ? { ports: openPorts } : void 0
       }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modal",
-  "version": "0.3.14",
+  "version": "0.3.15",
   "description": "Modal client library for JavaScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs",