modal 0.3.21 → 0.3.23

package/dist/index.d.cts

@@ -1,5 +1,22 @@
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 
+declare enum GPUType {
+    /**
+     * GPU_TYPE_UNSPECIFIED - Note: this enum is no longer used by current clients - don't add new types
+     * Old clients still send it, so we use it server-side for compatibility
+     */
+    GPU_TYPE_UNSPECIFIED = 0,
+    GPU_TYPE_T4 = 1,
+    GPU_TYPE_A100 = 2,
+    GPU_TYPE_A10G = 3,
+    GPU_TYPE_ANY = 4,
+    GPU_TYPE_A100_80GB = 8,
+    GPU_TYPE_L4 = 9,
+    GPU_TYPE_H100 = 10,
+    GPU_TYPE_L40S = 11,
+    GPU_TYPE_H200 = 12,
+    UNRECOGNIZED = -1
+}
 declare enum ParameterType {
     PARAM_TYPE_UNSPECIFIED = 0,
     PARAM_TYPE_STRING = 1,
@@ -40,6 +57,13 @@ interface ClassParameterSpec {
     fullType: GenericPayloadType | undefined;
 }
 declare const ClassParameterSpec: MessageFns<ClassParameterSpec>;
+interface GPUConfig {
+    /** Deprecated, at some point */
+    type: GPUType;
+    count: number;
+    gpuType: string;
+}
+declare const GPUConfig: MessageFns<GPUConfig>;
 interface GenericPayloadType {
     baseType: ParameterType;
     /** sub-type for generic types like lists */
@@ -85,11 +109,27 @@ declare class Secret {
 
 /** Options for deleting an Image. */
 type ImageDeleteOptions = Record<never, never>;
+/** Options for Image.dockerfileCommands(). */
+type ImageDockerfileCommandsOptions = {
+    /** Secrets that will be made available to this layer's build environment. */
+    secrets?: Secret[];
+    /** GPU reservation for this layer's build environment (e.g. "A100", "T4:2", "A100-80GB:4"). */
+    gpu?: string;
+    /** Ignore cached builds for this layer, similar to 'docker build --no-cache'. */
+    forceBuild?: boolean;
+};
+/** Represents a single image layer with its build configuration. */
+type Layer = {
+    commands: string[];
+    secrets?: Secret[];
+    gpuConfig?: GPUConfig;
+    forceBuild?: boolean;
+};
 /** A container image, used for starting Sandboxes. */
 declare class Image {
     #private;
     /** @ignore */
-    constructor(imageId: string, tag: string, imageRegistryConfig?: ImageRegistryConfig);
+    constructor(imageId: string, tag: string, imageRegistryConfig?: ImageRegistryConfig, layers?: Layer[]);
     get imageId(): string;
     /**
      * Creates an Image from an Image ID
@@ -118,6 +158,18 @@ declare class Image {
      * @param secret - A Secret containing credentials for registry authentication.
      */
     static fromGcpArtifactRegistry(tag: string, secret: Secret): Image;
+    private static validateDockerfileCommands;
+    /**
+     * Extend an image with arbitrary Dockerfile-like commands.
+     *
+     * Each call creates a new Image layer that will be built sequentially.
+     * The provided options apply only to this layer.
+     *
+     * @param commands - Array of Dockerfile commands as strings
+     * @param options - Optional configuration for this layer's build
+     * @returns A new Image instance
+     */
+    dockerfileCommands(commands: string[], options?: ImageDockerfileCommandsOptions): Image;
     /**
      * Eagerly builds an Image on Modal.
      *
@@ -231,6 +283,8 @@ type ExecOptions = {
     timeout?: number;
     /** Secrets with environment variables for the command. */
     secrets?: Secret[];
+    /** Enable a PTY for the command. */
+    pty?: boolean;
 };
 /** A port forwarded from within a running Modal Sandbox. */
 declare class Tunnel {
@@ -433,6 +487,8 @@ type SandboxCreateOptions = {
     volumes?: Record<string, Volume>;
     /** Mount points for cloud buckets. */
     cloudBucketMounts?: Record<string, CloudBucketMount>;
+    /** Enable a PTY for the Sandbox. */
+    pty?: boolean;
     /** 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. */
@@ -747,4 +803,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-export { AlreadyExistsError, App, type ClientOptions, CloudBucketMount, Cls, type ClsBatchingOptions, type ClsConcurrencyOptions, ClsInstance, type ClsOptions, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, type FunctionStats, FunctionTimeoutError, Function_, Image, type ImageDeleteOptions, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Proxy, type ProxyFromNameOptions, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Retries, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, type SandboxListOptions, SandboxTimeoutError, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Tunnel, type UpdateAutoscalerOptions, Volume, type VolumeFromNameOptions, initializeClient };
+export { AlreadyExistsError, App, type ClientOptions, CloudBucketMount, Cls, type ClsBatchingOptions, type ClsConcurrencyOptions, ClsInstance, type ClsOptions, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, type FunctionStats, FunctionTimeoutError, Function_, Image, type ImageDeleteOptions, type ImageDockerfileCommandsOptions, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Proxy, type ProxyFromNameOptions, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Retries, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, type SandboxListOptions, SandboxTimeoutError, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Tunnel, type UpdateAutoscalerOptions, Volume, type VolumeFromNameOptions, initializeClient };

package/dist/index.d.ts

@@ -1,5 +1,22 @@
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 
+declare enum GPUType {
+    /**
+     * GPU_TYPE_UNSPECIFIED - Note: this enum is no longer used by current clients - don't add new types
+     * Old clients still send it, so we use it server-side for compatibility
+     */
+    GPU_TYPE_UNSPECIFIED = 0,
+    GPU_TYPE_T4 = 1,
+    GPU_TYPE_A100 = 2,
+    GPU_TYPE_A10G = 3,
+    GPU_TYPE_ANY = 4,
+    GPU_TYPE_A100_80GB = 8,
+    GPU_TYPE_L4 = 9,
+    GPU_TYPE_H100 = 10,
+    GPU_TYPE_L40S = 11,
+    GPU_TYPE_H200 = 12,
+    UNRECOGNIZED = -1
+}
 declare enum ParameterType {
     PARAM_TYPE_UNSPECIFIED = 0,
     PARAM_TYPE_STRING = 1,
@@ -40,6 +57,13 @@ interface ClassParameterSpec {
     fullType: GenericPayloadType | undefined;
 }
 declare const ClassParameterSpec: MessageFns<ClassParameterSpec>;
+interface GPUConfig {
+    /** Deprecated, at some point */
+    type: GPUType;
+    count: number;
+    gpuType: string;
+}
+declare const GPUConfig: MessageFns<GPUConfig>;
 interface GenericPayloadType {
     baseType: ParameterType;
     /** sub-type for generic types like lists */
@@ -85,11 +109,27 @@ declare class Secret {
 
 /** Options for deleting an Image. */
 type ImageDeleteOptions = Record<never, never>;
+/** Options for Image.dockerfileCommands(). */
+type ImageDockerfileCommandsOptions = {
+    /** Secrets that will be made available to this layer's build environment. */
+    secrets?: Secret[];
+    /** GPU reservation for this layer's build environment (e.g. "A100", "T4:2", "A100-80GB:4"). */
+    gpu?: string;
+    /** Ignore cached builds for this layer, similar to 'docker build --no-cache'. */
+    forceBuild?: boolean;
+};
+/** Represents a single image layer with its build configuration. */
+type Layer = {
+    commands: string[];
+    secrets?: Secret[];
+    gpuConfig?: GPUConfig;
+    forceBuild?: boolean;
+};
 /** A container image, used for starting Sandboxes. */
 declare class Image {
     #private;
     /** @ignore */
-    constructor(imageId: string, tag: string, imageRegistryConfig?: ImageRegistryConfig);
+    constructor(imageId: string, tag: string, imageRegistryConfig?: ImageRegistryConfig, layers?: Layer[]);
     get imageId(): string;
     /**
      * Creates an Image from an Image ID
@@ -118,6 +158,18 @@ declare class Image {
      * @param secret - A Secret containing credentials for registry authentication.
      */
     static fromGcpArtifactRegistry(tag: string, secret: Secret): Image;
+    private static validateDockerfileCommands;
+    /**
+     * Extend an image with arbitrary Dockerfile-like commands.
+     *
+     * Each call creates a new Image layer that will be built sequentially.
+     * The provided options apply only to this layer.
+     *
+     * @param commands - Array of Dockerfile commands as strings
+     * @param options - Optional configuration for this layer's build
+     * @returns A new Image instance
+     */
+    dockerfileCommands(commands: string[], options?: ImageDockerfileCommandsOptions): Image;
     /**
      * Eagerly builds an Image on Modal.
      *
@@ -231,6 +283,8 @@ type ExecOptions = {
     timeout?: number;
     /** Secrets with environment variables for the command. */
     secrets?: Secret[];
+    /** Enable a PTY for the command. */
+    pty?: boolean;
 };
 /** A port forwarded from within a running Modal Sandbox. */
 declare class Tunnel {
@@ -433,6 +487,8 @@ type SandboxCreateOptions = {
     volumes?: Record<string, Volume>;
     /** Mount points for cloud buckets. */
     cloudBucketMounts?: Record<string, CloudBucketMount>;
+    /** Enable a PTY for the Sandbox. */
+    pty?: boolean;
     /** 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. */
@@ -747,4 +803,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-export { AlreadyExistsError, App, type ClientOptions, CloudBucketMount, Cls, type ClsBatchingOptions, type ClsConcurrencyOptions, ClsInstance, type ClsOptions, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, type FunctionStats, FunctionTimeoutError, Function_, Image, type ImageDeleteOptions, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Proxy, type ProxyFromNameOptions, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Retries, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, type SandboxListOptions, SandboxTimeoutError, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Tunnel, type UpdateAutoscalerOptions, Volume, type VolumeFromNameOptions, initializeClient };
+export { AlreadyExistsError, App, type ClientOptions, CloudBucketMount, Cls, type ClsBatchingOptions, type ClsConcurrencyOptions, ClsInstance, type ClsOptions, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, type FunctionStats, FunctionTimeoutError, Function_, Image, type ImageDeleteOptions, type ImageDockerfileCommandsOptions, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Proxy, type ProxyFromNameOptions, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Retries, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, type SandboxListOptions, SandboxTimeoutError, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, Tunnel, type UpdateAutoscalerOptions, Volume, type VolumeFromNameOptions, initializeClient };