modal 0.7.3 → 0.7.4

package/dist/index.d.ts

@@ -524,6 +524,14 @@ interface AppGetLayoutResponse {
     appLayout: AppLayout | undefined;
 }
 declare const AppGetLayoutResponse: MessageFns$1<AppGetLayoutResponse>;
+interface AppGetLifecycleRequest {
+    appId: string;
+}
+declare const AppGetLifecycleRequest: MessageFns$1<AppGetLifecycleRequest>;
+interface AppGetLifecycleResponse {
+    lifecycle: AppLifecycle | undefined;
+}
+declare const AppGetLifecycleResponse: MessageFns$1<AppGetLifecycleResponse>;
 interface AppGetLogsRequest {
     appId: string;
     timeout: number;
@@ -535,6 +543,7 @@ interface AppGetLogsRequest {
     functionCallId: string;
     fileDescriptor: FileDescriptor;
     sandboxId: string;
+    searchText: string;
 }
 declare const AppGetLogsRequest: MessageFns$1<AppGetLogsRequest>;
 interface AppGetObjectsItem {
@@ -589,6 +598,23 @@ interface AppLayout {
     };
 }
 declare const AppLayout: MessageFns$1<AppLayout>;
+interface AppLifecycle {
+    appState: AppState;
+    createdAt: number;
+    /** User or service user name */
+    createdBy: string;
+    /** Most recent deployment event */
+    deployedAt: number;
+    /** User or service user name */
+    deployedBy: string;
+    /** Only meaningful when App is deployed */
+    version: number;
+    /** Unset when App is still running */
+    stoppedAt: number;
+    /** User or service user name, null if running or ephemeral App that finished normally */
+    stoppedBy: string;
+}
+declare const AppLifecycle: MessageFns$1<AppLifecycle>;
 interface AppListRequest {
     environmentName: string;
 }
@@ -659,6 +685,16 @@ interface AppRollbackRequest {
     version: number;
 }
 declare const AppRollbackRequest: MessageFns$1<AppRollbackRequest>;
+interface AppRolloverRequest {
+    appId: string;
+}
+declare const AppRolloverRequest: MessageFns$1<AppRolloverRequest>;
+interface AppRolloverResponse {
+    url: string;
+    serverWarnings: Warning[];
+    deployedAt: number;
+}
+declare const AppRolloverResponse: MessageFns$1<AppRolloverResponse>;
 interface AppSetObjectsRequest {
     appId: string;
     indexedObjectIds: {
@@ -1169,6 +1205,7 @@ interface DictGetOrCreateRequest {
     deploymentName: string;
     environmentName: string;
     objectCreationType: ObjectCreationType;
+    /** Unused after 1.4.0 */
     data: DictEntry[];
 }
 declare const DictGetOrCreateRequest: MessageFns$1<DictGetOrCreateRequest>;
@@ -2460,6 +2497,17 @@ interface PortSpecs {
     ports: PortSpec[];
 }
 declare const PortSpecs: MessageFns$1<PortSpecs>;
+interface Probe$1 {
+    tcpPort?: number | undefined;
+    execCommand?: Probe_ExecCommand | undefined;
+    intervalMs?: number | undefined;
+}
+declare const Probe$1: MessageFns$1<Probe$1>;
+interface Probe_ExecCommand {
+    /** Command and args to execute directly (argv form, not shell-parsed). */
+    argv: string[];
+}
+declare const Probe_ExecCommand: MessageFns$1<Probe_ExecCommand>;
 interface Proxy$1 {
     name: string;
     createdAt: number;
@@ -2717,6 +2765,7 @@ interface Sandbox$1 {
     nfsMounts: SharedVolumeMount[];
     /** For internal debugging use only. */
     runtimeDebug: boolean;
+    /** deprecated, use network_access instead */
     blockNetwork: boolean;
     s3Mounts: S3Mount[];
     cloudBucketMounts: CloudBucketMount$1[];
@@ -2781,6 +2830,8 @@ interface Sandbox$1 {
      * for OIDC-based authentication (e.g. to AWS, GCP).
      */
     includeOidcIdentityToken: boolean;
+    /** Probe used to determine when the sandbox has become ready. */
+    readinessProbe?: Probe$1 | undefined;
 }
 declare const Sandbox$1: MessageFns$1<Sandbox$1>;
 interface SandboxCreateConnectTokenRequest {
@@ -2812,8 +2863,22 @@ declare const SandboxCreateV2Request: MessageFns$1<SandboxCreateV2Request>;
 interface SandboxCreateV2Response {
     sandboxId: string;
     tunnels: TunnelData[];
+    taskId: string;
 }
 declare const SandboxCreateV2Response: MessageFns$1<SandboxCreateV2Response>;
+/**
+ * Used by the sandbox controller to get command router access for V2 sandboxes.
+ * For all other use cases, use TaskGetCommandRouterAccess instead.
+ */
+interface SandboxGetCommandRouterAccessRequest {
+    sandboxId: string;
+}
+declare const SandboxGetCommandRouterAccessRequest: MessageFns$1<SandboxGetCommandRouterAccessRequest>;
+interface SandboxGetCommandRouterAccessResponse {
+    jwt: string;
+    url: string;
+}
+declare const SandboxGetCommandRouterAccessResponse: MessageFns$1<SandboxGetCommandRouterAccessResponse>;
 interface SandboxGetFromNameRequest {
     sandboxName: string;
     environmentName: string;
@@ -2884,6 +2949,7 @@ interface SandboxInfo {
     regions: string[];
     timeoutSecs: number;
     idleTimeoutSecs?: number | undefined;
+    readyAt?: number | undefined;
 }
 declare const SandboxInfo: MessageFns$1<SandboxInfo>;
 interface SandboxListRequest {
@@ -3004,6 +3070,15 @@ interface SandboxWaitResponse {
     result: GenericResult | undefined;
 }
 declare const SandboxWaitResponse: MessageFns$1<SandboxWaitResponse>;
+interface SandboxWaitUntilReadyRequest {
+    sandboxId: string;
+    timeout: number;
+}
+declare const SandboxWaitUntilReadyRequest: MessageFns$1<SandboxWaitUntilReadyRequest>;
+interface SandboxWaitUntilReadyResponse {
+    readyAt: number;
+}
+declare const SandboxWaitUntilReadyResponse: MessageFns$1<SandboxWaitUntilReadyResponse>;
 interface Schedule {
     cron?: Schedule_Cron | undefined;
     period?: Schedule_Period | undefined;
@@ -3220,6 +3295,15 @@ interface TaskGetCommandRouterAccessResponse {
     url: string;
 }
 declare const TaskGetCommandRouterAccessResponse: MessageFns$1<TaskGetCommandRouterAccessResponse>;
+interface TaskGetInfoRequest {
+    taskId: string;
+}
+declare const TaskGetInfoRequest: MessageFns$1<TaskGetInfoRequest>;
+interface TaskGetInfoResponse {
+    appId: string;
+    info: TaskInfo | undefined;
+}
+declare const TaskGetInfoResponse: MessageFns$1<TaskGetInfoResponse>;
 interface TaskInfo {
     id: string;
     startedAt: number;
@@ -3250,6 +3334,8 @@ interface TaskLogs {
     functionCallId: string;
     inputId: string;
     timestampNs: number;
+    containerId: string;
+    containerName: string;
 }
 declare const TaskLogs: MessageFns$1<TaskLogs>;
 interface TaskLogsBatch {
@@ -3299,6 +3385,19 @@ interface TaskTemplate {
     index: number;
 }
 declare const TaskTemplate: MessageFns$1<TaskTemplate>;
+interface TemplateListRequest {
+}
+declare const TemplateListRequest: MessageFns$1<TemplateListRequest>;
+interface TemplateListResponse {
+    items: TemplateListResponse_TemplateListItem[];
+}
+declare const TemplateListResponse: MessageFns$1<TemplateListResponse>;
+interface TemplateListResponse_TemplateListItem {
+    name: string;
+    repo: string;
+    ref: string;
+}
+declare const TemplateListResponse_TemplateListItem: MessageFns$1<TemplateListResponse_TemplateListItem>;
 interface TokenFlowCreateRequest {
     utmSource: string;
     localhostPort: number;
@@ -3769,6 +3868,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly appGetLifecycle: {
+            readonly name: "AppGetLifecycle";
+            readonly requestType: MessageFns$1<AppGetLifecycleRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<AppGetLifecycleResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly appGetLogs: {
             readonly name: "AppGetLogs";
             readonly requestType: MessageFns$1<AppGetLogsRequest>;
@@ -3841,6 +3948,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly appRollover: {
+            readonly name: "AppRollover";
+            readonly requestType: MessageFns$1<AppRolloverRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<AppRolloverResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly appSetObjects: {
             readonly name: "AppSetObjects";
             readonly requestType: MessageFns$1<AppSetObjectsRequest>;
@@ -4696,6 +4811,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly sandboxGetCommandRouterAccess: {
+            readonly name: "SandboxGetCommandRouterAccess";
+            readonly requestType: MessageFns$1<SandboxGetCommandRouterAccessRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<SandboxGetCommandRouterAccessResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly sandboxGetFromName: {
             readonly name: "SandboxGetFromName";
             readonly requestType: MessageFns$1<SandboxGetFromNameRequest>;
@@ -4729,6 +4852,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly sandboxGetTaskIdV2: {
+            readonly name: "SandboxGetTaskIdV2";
+            readonly requestType: MessageFns$1<SandboxGetTaskIdRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<SandboxGetTaskIdResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly sandboxGetTunnels: {
             readonly name: "SandboxGetTunnels";
             readonly requestType: MessageFns$1<SandboxGetTunnelsRequest>;
@@ -4737,6 +4868,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly sandboxGetTunnelsV2: {
+            readonly name: "SandboxGetTunnelsV2";
+            readonly requestType: MessageFns$1<SandboxGetTunnelsRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<SandboxGetTunnelsResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly sandboxList: {
             readonly name: "SandboxList";
             readonly requestType: MessageFns$1<SandboxListRequest>;
@@ -4833,6 +4972,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly sandboxTerminateV2: {
+            readonly name: "SandboxTerminateV2";
+            readonly requestType: MessageFns$1<SandboxTerminateRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<SandboxTerminateResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly sandboxWait: {
             readonly name: "SandboxWait";
             readonly requestType: MessageFns$1<SandboxWaitRequest>;
@@ -4841,6 +4988,22 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly sandboxWaitUntilReady: {
+            readonly name: "SandboxWaitUntilReady";
+            readonly requestType: MessageFns$1<SandboxWaitUntilReadyRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<SandboxWaitUntilReadyResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly sandboxWaitV2: {
+            readonly name: "SandboxWaitV2";
+            readonly requestType: MessageFns$1<SandboxWaitRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<SandboxWaitResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         /** Secrets */
         readonly secretDelete: {
             readonly name: "SecretDelete";
@@ -4972,6 +5135,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly taskGetInfo: {
+            readonly name: "TaskGetInfo";
+            readonly requestType: MessageFns$1<TaskGetInfoRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<TaskGetInfoResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly taskList: {
             readonly name: "TaskList";
             readonly requestType: MessageFns$1<TaskListRequest>;
@@ -4988,6 +5159,15 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        /** Templates */
+        readonly templateList: {
+            readonly name: "TemplateList";
+            readonly requestType: MessageFns$1<TemplateListRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns$1<TemplateListResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         /** Tokens (web auth flow) */
         readonly tokenFlowCreate: {
             readonly name: "TokenFlowCreate";
@@ -5932,6 +6112,12 @@ interface TaskExecStartRequest {
      * internal debugging.
      */
     runtimeDebug: boolean;
+    /** Fully qualified target container ID. Empty targets the main container. */
+    containerId: string;
+    /** Environment variables to set directly for the exec'd command. */
+    env: {
+        [key: string]: string;
+    };
 }
 declare const TaskExecStartRequest: MessageFns<TaskExecStartRequest>;
 interface TaskExecStartResponse {
@@ -6105,6 +6291,19 @@ type StdioBehavior = "pipe" | "ignore";
  * means the data will be read as raw bytes (Uint8Array).
  */
 type StreamMode = "text" | "binary";
+/** Optional parameters for {@link Probe.withTcp} and {@link Probe.withExec}. */
+type ProbeParams = {
+    intervalMs: number;
+};
+/** Probe configuration for sandbox readiness checks. */
+declare class Probe {
+    #private;
+    private constructor();
+    static withTcp(port: number, params?: ProbeParams): Probe;
+    static withExec(argv: string[], params?: ProbeParams): Probe;
+    /** @ignore */
+    toProto(): Probe$1;
+}
 /** Optional parameters for {@link SandboxService#create client.sandboxes.create()}. */
 type SandboxCreateParams = {
     /** Reservation of physical CPU cores for the Sandbox, can be fractional. */
@@ -6136,7 +6335,8 @@ type SandboxCreateParams = {
     volumes?: Record<string, Volume>;
     /** Mount points for {@link CloudBucketMount}s. */
     cloudBucketMounts?: Record<string, CloudBucketMount>;
-    /** Enable a PTY for the Sandbox. */
+    /** Enable a PTY for the Sandbox entrypoint command. When enabled, all output (stdout and
+     * stderr from the process) is multiplexed into stdout, and the stderr stream is effectively empty. */
     pty?: boolean;
     /** List of ports to tunnel into the Sandbox. Encrypted ports are tunneled with TLS. */
     encryptedPorts?: number[];
@@ -6156,6 +6356,8 @@ type SandboxCreateParams = {
     verbose?: boolean;
     /** Reference to a Modal {@link Proxy} to use in front of this Sandbox. */
     proxy?: Proxy;
+    /** Probe used to determine when the Sandbox has become ready. */
+    readinessProbe?: Probe;
     /** Optional name for the Sandbox. Unique within an App. */
     name?: string;
     /** Optional experimental options. */
@@ -6164,6 +6366,8 @@ type SandboxCreateParams = {
      * This requires prior manual setup by Modal and is only available for Enterprise customers.
      */
     customDomain?: string;
+    /** If true, the sandbox will receive a MODAL_IDENTITY_TOKEN env var for OIDC-based auth (e.g. to AWS, GCP). */
+    includeOidcIdentityToken?: boolean;
 };
 /**
  * Service for managing {@link Sandbox}es.
@@ -6232,7 +6436,8 @@ type SandboxExecParams = {
     env?: Record<string, string>;
     /** {@link Secret}s to inject as environment variables for the commmand.*/
     secrets?: Secret[];
-    /** Enable a PTY for the command. */
+    /** Enable a PTY for the command. When enabled, all output (stdout and stderr from the
+     * process) is multiplexed into stdout, and the stderr stream is effectively empty. */
     pty?: boolean;
 };
 /** Optional parameters for {@link Sandbox#createConnectToken Sandbox.createConnectToken()}. */
@@ -6313,6 +6518,16 @@ declare class Sandbox {
      */
     detach(): void;
     wait(): Promise<number>;
+    /**
+     * Wait until the Sandbox readiness probe reports the Sandbox is ready.
+     *
+     * This method only works for Sandboxes configured with a readiness probe.
+     *
+     * @param timeoutMs - Maximum total time to wait, in milliseconds.
+     * @returns A promise that resolves once the Sandbox is ready.
+     * @throws {@link TimeoutError} If readiness is not reported before `timeoutMs`.
+     */
+    waitUntilReady(timeoutMs?: number): Promise<void>;
     /** Get {@link Tunnel} metadata for the Sandbox.
      *
      * Raises {@link SandboxTimeoutError} if the tunnels are not available after the timeout.
@@ -6534,6 +6749,10 @@ declare class App {
     imageFromGcpArtifactRegistry(tag: string, secret: Secret): Promise<Image>;
 }
 
+/** An operation exceeds the allowed time limit. */
+declare class TimeoutError extends Error {
+    constructor(message?: string);
+}
 /** Function execution exceeds the allowed time limit. */
 declare class FunctionTimeoutError extends Error {
     constructor(message: string);
@@ -6577,4 +6796,4 @@ declare class ClientClosedError extends Error {
 
 declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, type ClientOptions, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ContainerProcess, type DeleteOptions, type EphemeralOptions, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, FunctionCallService, type FunctionFromNameParams, FunctionService, type FunctionStats, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, ImageService, InternalFailure, InvalidError, type LogLevel, type Logger, type LookupOptions, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, type SandboxTerminateParams, SandboxTimeoutError, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, VolumeService, checkForRenamedParams, close, initializeClient };
+export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, type ClientOptions, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ContainerProcess, type DeleteOptions, type EphemeralOptions, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, FunctionCallService, type FunctionFromNameParams, FunctionService, type FunctionStats, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, ImageService, InternalFailure, InvalidError, type LogLevel, type Logger, type LookupOptions, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, type SandboxTerminateParams, SandboxTimeoutError, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, VolumeService, checkForRenamedParams, close, initializeClient };