modal 0.3.13 → 0.3.15

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,7 +163,24 @@ 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 {
+    host: string;
+    port: number;
+    unencryptedHost?: string | undefined;
+    unencryptedPort?: number | undefined;
+    /** @ignore */
+    constructor(host: string, port: number, unencryptedHost?: string | undefined, unencryptedPort?: number | undefined);
+    /** Get the public HTTPS URL of the forwarded port. */
+    get url(): string;
+    /** Get the public TLS socket as a [host, port] tuple. */
+    get tlsSocket(): [string, number];
+    /** Get the public TCP socket as a [host, port] tuple. */
+    get tcpSocket(): [string, number];
+}
 /** Sandboxes are secure, isolated containers in Modal that boot in seconds. */
 declare class Sandbox {
     #private;
@@ -174,6 +205,28 @@ declare class Sandbox {
     }): Promise<ContainerProcess<Uint8Array>>;
     terminate(): Promise<void>;
     wait(): Promise<number>;
+    /** Get Tunnel metadata for the sandbox.
+     *
+     * Raises `SandboxTimeoutError` if the tunnels are not available after the timeout.
+     *
+     * @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;
@@ -186,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;
@@ -239,8 +278,16 @@ 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. */
+    encryptedPorts?: number[];
+    /** List of encrypted ports to tunnel into the sandbox, using HTTP/2. */
+    h2Ports?: number[];
+    /** List of ports to tunnel into the sandbox without encryption. */
+    unencryptedPorts?: number[];
 };
 /** Represents a deployed Modal App. */
 declare class App {
@@ -298,8 +345,7 @@ declare class FunctionCall {
 declare class Function_ {
     #private;
     readonly functionId: string;
-    readonly methodName: string | undefined;
-    readonly inputPlaneUrl: string | undefined;
+    readonly methodName?: string;
     /** @ignore */
     constructor(functionId: string, methodName?: string, inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Function_>;
@@ -351,6 +397,10 @@ declare class QueueEmptyError extends Error {
 declare class QueueFullError extends Error {
     constructor(message: string);
 }
+/** Sandbox operations that exceed the allowed time limit. */
+declare class SandboxTimeoutError extends Error {
+    constructor(message?: string);
+}
 
 /** Options to configure a `Queue.clear()` operation. */
 type QueueClearOptions = {
@@ -452,4 +502,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-export { App, type ClientOptions, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Volume, type VolumeFromNameOptions, initializeClient };
+export { App, type ClientOptions, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, SandboxTimeoutError, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeFromNameOptions, initializeClient };

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,7 +163,24 @@ 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 {
+    host: string;
+    port: number;
+    unencryptedHost?: string | undefined;
+    unencryptedPort?: number | undefined;
+    /** @ignore */
+    constructor(host: string, port: number, unencryptedHost?: string | undefined, unencryptedPort?: number | undefined);
+    /** Get the public HTTPS URL of the forwarded port. */
+    get url(): string;
+    /** Get the public TLS socket as a [host, port] tuple. */
+    get tlsSocket(): [string, number];
+    /** Get the public TCP socket as a [host, port] tuple. */
+    get tcpSocket(): [string, number];
+}
 /** Sandboxes are secure, isolated containers in Modal that boot in seconds. */
 declare class Sandbox {
     #private;
@@ -174,6 +205,28 @@ declare class Sandbox {
     }): Promise<ContainerProcess<Uint8Array>>;
     terminate(): Promise<void>;
     wait(): Promise<number>;
+    /** Get Tunnel metadata for the sandbox.
+     *
+     * Raises `SandboxTimeoutError` if the tunnels are not available after the timeout.
+     *
+     * @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;
@@ -186,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;
@@ -239,8 +278,16 @@ 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. */
+    encryptedPorts?: number[];
+    /** List of encrypted ports to tunnel into the sandbox, using HTTP/2. */
+    h2Ports?: number[];
+    /** List of ports to tunnel into the sandbox without encryption. */
+    unencryptedPorts?: number[];
 };
 /** Represents a deployed Modal App. */
 declare class App {
@@ -298,8 +345,7 @@ declare class FunctionCall {
 declare class Function_ {
     #private;
     readonly functionId: string;
-    readonly methodName: string | undefined;
-    readonly inputPlaneUrl: string | undefined;
+    readonly methodName?: string;
     /** @ignore */
     constructor(functionId: string, methodName?: string, inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Function_>;
@@ -351,6 +397,10 @@ declare class QueueEmptyError extends Error {
 declare class QueueFullError extends Error {
     constructor(message: string);
 }
+/** Sandbox operations that exceed the allowed time limit. */
+declare class SandboxTimeoutError extends Error {
+    constructor(message?: string);
+}
 
 /** Options to configure a `Queue.clear()` operation. */
 type QueueClearOptions = {
@@ -452,4 +502,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-export { App, type ClientOptions, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Volume, type VolumeFromNameOptions, initializeClient };
+export { App, type ClientOptions, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, SandboxTimeoutError, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeFromNameOptions, initializeClient };