modal 0.3.12 → 0.3.14

package/dist/index.d.cts

@@ -150,6 +150,21 @@ type ExecOptions = {
     /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
     timeout?: number;
 };
+/** 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 +189,13 @@ 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>>;
 }
 declare class ContainerProcess<R extends string | Uint8Array = any> {
     #private;
@@ -200,6 +222,19 @@ declare class Secret {
     static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
 }
 
+/** Options for `Volume.fromName()`. */
+type VolumeFromNameOptions = {
+    environment?: string;
+    createIfMissing?: boolean;
+};
+/** Volumes provide persistent storage that can be mounted in Modal functions. */
+declare class Volume {
+    readonly volumeId: string;
+    /** @ignore */
+    constructor(volumeId: string);
+    static fromName(name: string, options?: VolumeFromNameOptions): Promise<Volume>;
+}
+
 /** Options for functions that find deployed Modal objects. */
 type LookupOptions = {
     environment?: string;
@@ -226,6 +261,14 @@ type SandboxCreateOptions = {
      * Default behavior is to sleep indefinitely until timeout or termination.
      */
     command?: string[];
+    /** 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 {
@@ -283,8 +326,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_>;
@@ -296,7 +338,7 @@ declare class Function_ {
 declare class Cls {
     #private;
     /** @ignore */
-    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[]);
+    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[], inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Cls>;
     /** Create a new instance of the Cls with parameters. */
     instance(params?: Record<string, any>): Promise<ClsInstance>;
@@ -336,6 +378,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 = {
@@ -437,4 +483,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, 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

@@ -150,6 +150,21 @@ type ExecOptions = {
     /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
     timeout?: number;
 };
+/** 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 +189,13 @@ 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>>;
 }
 declare class ContainerProcess<R extends string | Uint8Array = any> {
     #private;
@@ -200,6 +222,19 @@ declare class Secret {
     static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
 }
 
+/** Options for `Volume.fromName()`. */
+type VolumeFromNameOptions = {
+    environment?: string;
+    createIfMissing?: boolean;
+};
+/** Volumes provide persistent storage that can be mounted in Modal functions. */
+declare class Volume {
+    readonly volumeId: string;
+    /** @ignore */
+    constructor(volumeId: string);
+    static fromName(name: string, options?: VolumeFromNameOptions): Promise<Volume>;
+}
+
 /** Options for functions that find deployed Modal objects. */
 type LookupOptions = {
     environment?: string;
@@ -226,6 +261,14 @@ type SandboxCreateOptions = {
      * Default behavior is to sleep indefinitely until timeout or termination.
      */
     command?: string[];
+    /** 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 {
@@ -283,8 +326,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_>;
@@ -296,7 +338,7 @@ declare class Function_ {
 declare class Cls {
     #private;
     /** @ignore */
-    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[]);
+    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[], inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Cls>;
     /** Create a new instance of the Cls with parameters. */
     instance(params?: Record<string, any>): Promise<ClsInstance>;
@@ -336,6 +378,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 = {
@@ -437,4 +483,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, 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 };