modal 0.6.0 → 0.6.1

package/dist/index.d.cts

@@ -330,6 +330,12 @@ declare enum CloudBucketMount_BucketType {
     GCP = 3,
     UNRECOGNIZED = -1
 }
+declare enum CloudBucketMount_MetadataTTLType {
+    METADATA_TTL_TYPE_UNSPECIFIED = 0,
+    METADATA_TTL_TYPE_MINIMAL = 1,
+    METADATA_TTL_TYPE_INDEFINITE = 2,
+    UNRECOGNIZED = -1
+}
 declare enum FileEntry_FileType {
     UNSPECIFIED = 0,
     FILE = 1,
@@ -414,6 +420,10 @@ interface AppCreateRequest {
     description: string;
     environmentName: string;
     appState: AppState;
+    /** Additional metadata to attach to the App */
+    tags: {
+        [key: string]: string;
+    };
 }
 declare const AppCreateRequest: MessageFns<AppCreateRequest>;
 interface AppCreateResponse {
@@ -477,6 +487,7 @@ interface AppGetLogsRequest {
     timeout: number;
     lastEntryId: string;
     functionId: string;
+    parametrizedFunctionId: string;
     inputId: string;
     taskId: string;
     functionCallId: string;
@@ -685,14 +696,6 @@ interface AutoscalerSettings {
     scaledownWindow?: number | undefined;
 }
 declare const AutoscalerSettings: MessageFns<AutoscalerSettings>;
-/** Used for flash autoscaling */
-interface AutoscalingMetrics {
-    cpuUsagePercent: number;
-    memoryUsagePercent: number;
-    concurrentRequests: number;
-    timestamp: number;
-}
-declare const AutoscalingMetrics: MessageFns<AutoscalingMetrics>;
 interface BaseImage {
     imageId: string;
     dockerTag: string;
@@ -734,6 +737,7 @@ declare const BuildFunction: MessageFns<BuildFunction>;
 interface CancelInputEvent {
     inputIds: string[];
     terminateContainers: boolean;
+    cancellationReason: string;
 }
 declare const CancelInputEvent: MessageFns<CancelInputEvent>;
 interface CheckpointInfo {
@@ -826,6 +830,9 @@ interface CloudBucketMount$1 {
     bucketEndpointUrl?: string | undefined;
     keyPrefix?: string | undefined;
     oidcAuthRoleArn?: string | undefined;
+    forcePathStyle: boolean;
+    metadataTtlType?: CloudBucketMount_MetadataTTLType | undefined;
+    metadataTtlSeconds?: number | undefined;
 }
 declare const CloudBucketMount$1: MessageFns<CloudBucketMount$1>;
 interface ClusterGetRequest {
@@ -1240,6 +1247,10 @@ interface EnvironmentListItem {
     default: boolean;
     isManaged: boolean;
     environmentId: string;
+    maxConcurrentTasks?: number | undefined;
+    maxConcurrentGpus?: number | undefined;
+    currentConcurrentTasks: number;
+    currentConcurrentGpus: number;
 }
 declare const EnvironmentListItem: MessageFns<EnvironmentListItem>;
 interface EnvironmentListResponse {
@@ -1265,6 +1276,8 @@ interface EnvironmentUpdateRequest {
     currentName: string;
     name: string | undefined;
     webSuffix: string | undefined;
+    maxConcurrentTasks?: number | undefined;
+    maxConcurrentGpus?: number | undefined;
 }
 declare const EnvironmentUpdateRequest: MessageFns<EnvironmentUpdateRequest>;
 /** A file entry when listing files in a volume or network file system. */
@@ -1370,6 +1383,10 @@ interface FunctionMessage {
     checkpoint: CheckpointInfo | undefined;
     objectDependencies: ObjectDependency[];
     blockNetwork: boolean;
+    /**
+     * In the SDK, we've deprecated `max_inputs` (which only every implemented `max_inputs=1`)
+     * in favor of a boolean `single_use_containers` parameter.
+     */
     maxInputs: number;
     s3Mounts: S3Mount[];
     cloudBucketMounts: CloudBucketMount$1[];
@@ -1446,6 +1463,16 @@ interface FunctionMessage {
     /** can be used as inputs */
     supportedInputFormats: DataFormat[];
     supportedOutputFormats: DataFormat[];
+    httpConfig?: HTTPConfig | undefined;
+    /**
+     * Attribute on the module with the implementation, which may differ from function_name
+     * when the user provided a custom name= for the Function inside the Application namespace
+     */
+    implementationName: string;
+    /** When True, containers will shut down after handling a single input */
+    singleUseContainers: boolean;
+    /** When True, the function is a server function */
+    isServer: boolean;
 }
 declare const FunctionMessage: MessageFns<FunctionMessage>;
 interface FunctionAsyncInvokeRequest {
@@ -1501,6 +1528,7 @@ interface FunctionCallGetDataRequest {
     functionCallId?: string | undefined;
     attemptToken?: string | undefined;
     lastIndex: number;
+    useGaplessRead: boolean;
 }
 declare const FunctionCallGetDataRequest: MessageFns<FunctionCallGetDataRequest>;
 interface FunctionCallInfo {
@@ -1629,6 +1657,14 @@ interface FunctionData {
     startupTimeoutSecs: number;
     supportedInputFormats: DataFormat[];
     supportedOutputFormats: DataFormat[];
+    httpConfig?: HTTPConfig | undefined;
+    /**
+     * Attribute on the module with the implementation, which may differ from function_name
+     * when the user provided a custom name= for the Function inside the Application namespace
+     */
+    implementationName: string;
+    /** When True, the function is a server function */
+    isServer: boolean;
 }
 declare const FunctionData: MessageFns<FunctionData>;
 interface FunctionData_RankedFunction {
@@ -1986,6 +2022,15 @@ interface GenericResult {
     propagationReason: string;
 }
 declare const GenericResult: MessageFns<GenericResult>;
+interface HTTPConfig {
+    port: number;
+    proxyRegions: string[];
+    startupTimeout: number;
+    exitGracePeriod: number;
+    h2Enabled: boolean;
+    targetConcurrency: number;
+}
+declare const HTTPConfig: MessageFns<HTTPConfig>;
 interface Image$1 {
     baseImages: BaseImage[];
     dockerfileCommands: string[];
@@ -2366,8 +2411,9 @@ interface Proxy$1 {
     name: string;
     createdAt: number;
     environmentName: string;
-    proxyId: string;
     proxyIps: ProxyIp[];
+    proxyId: string;
+    region: string;
 }
 declare const Proxy$1: MessageFns<Proxy$1>;
 interface ProxyAddIpRequest {
@@ -2381,6 +2427,7 @@ declare const ProxyAddIpResponse: MessageFns<ProxyAddIpResponse>;
 interface ProxyCreateRequest {
     name: string;
     environmentName: string;
+    region: string;
 }
 declare const ProxyCreateRequest: MessageFns<ProxyCreateRequest>;
 interface ProxyCreateResponse {
@@ -2528,6 +2575,25 @@ interface RateLimit {
     interval: RateLimitInterval;
 }
 declare const RateLimit: MessageFns<RateLimit>;
+interface ResourceInfo {
+    /** MiB */
+    memoryMb: ResourceInfo_ResourceValue | undefined;
+    /** milli CPU cores */
+    milliCpu: ResourceInfo_ResourceValue | undefined;
+    gpuType: string;
+    /** MiB */
+    memoryMbMax: number;
+    /** MiB */
+    ephemeralDiskMb: number;
+    /** milli CPU cores */
+    milliCpuMax: number;
+}
+declare const ResourceInfo: MessageFns<ResourceInfo>;
+interface ResourceInfo_ResourceValue {
+    value: number;
+    isDefault: boolean;
+}
+declare const ResourceInfo_ResourceValue: MessageFns<ResourceInfo_ResourceValue>;
 interface Resources {
     /** MiB */
     memoryMb: number;
@@ -2639,6 +2705,14 @@ interface Sandbox$1 {
      * command router running on the Modal worker.
      */
     directSandboxCommandsEnabled: boolean;
+    /**
+     * Internal: restricts sandbox to run on this specific instance type.
+     * Set by server during SandboxRestore to ensure the restored sandbox runs
+     * on the same instance type as the original snapshot.
+     */
+    RestoreInstanceType: string;
+    /** If set, connections to this sandbox will be subdomains of this domain rather than the default. */
+    customDomain: string;
 }
 declare const Sandbox$1: MessageFns<Sandbox$1>;
 interface SandboxCreateConnectTokenRequest {
@@ -2662,22 +2736,6 @@ interface SandboxCreateResponse {
     sandboxId: string;
 }
 declare const SandboxCreateResponse: MessageFns<SandboxCreateResponse>;
-/**
- * Used to get a JWT and URL for direct access to a sandbox router server
- * running on the modal-worker, so the client can issue exec commands (and other
- * operations as they become available) directly to the worker.
- * DEPRECATED: Use TaskGetCommandRouterAccessRequest instead.
- * TODO(saltzm): Remove this.
- */
-interface SandboxGetCommandRouterAccessRequest {
-    sandboxId: string;
-}
-declare const SandboxGetCommandRouterAccessRequest: MessageFns<SandboxGetCommandRouterAccessRequest>;
-interface SandboxGetCommandRouterAccessResponse {
-    jwt: string;
-    url: string;
-}
-declare const SandboxGetCommandRouterAccessResponse: MessageFns<SandboxGetCommandRouterAccessResponse>;
 interface SandboxGetFromNameRequest {
     sandboxName: string;
     environmentName: string;
@@ -2743,6 +2801,11 @@ interface SandboxInfo {
     /** TODO: Not yet exposed in client library. */
     tags: SandboxTag[];
     name: string;
+    imageId: string;
+    resourceInfo: ResourceInfo | undefined;
+    regions: string[];
+    timeoutSecs: number;
+    idleTimeoutSecs?: number | undefined;
 }
 declare const SandboxInfo: MessageFns<SandboxInfo>;
 interface SandboxListRequest {
@@ -2883,20 +2946,17 @@ interface Schedule_Period {
     seconds: number;
 }
 declare const Schedule_Period: MessageFns<Schedule_Period>;
-/**
- * TODO(irfansharif):
- * - Fold in cloud, resource needs here too.
- * - Allow specifying list of zones, cloud, fallback and alternative
- *   GPU types.
- */
+/** Scheduling constraints for Functions and Sandboxes. */
 interface SchedulerPlacement {
     regions: string[];
-    /** TODO(irfansharif): Make these two repeated. */
+    /** @deprecated */
     Zone?: string | undefined;
-    /** admin-only, "on-demand" or "spot", else ignored */
+    /** @deprecated */
     Lifecycle?: string | undefined;
-    /** admin-only */
+    /** @deprecated */
     InstanceTypes: string[];
+    /** Functions only */
+    nonpreemptible: boolean;
 }
 declare const SchedulerPlacement: MessageFns<SchedulerPlacement>;
 interface SecretDeleteRequest {
@@ -2947,6 +3007,12 @@ interface SecretMetadata {
     creationInfo: CreationInfo | undefined;
 }
 declare const SecretMetadata: MessageFns<SecretMetadata>;
+interface ServiceUserIdentity {
+    serviceUserId: string;
+    serviceUserName: string;
+    createdBy: UserIdentity | undefined;
+}
+declare const ServiceUserIdentity: MessageFns<ServiceUserIdentity>;
 interface SharedVolumeDeleteRequest {
     sharedVolumeId: string;
 }
@@ -3051,14 +3117,6 @@ interface TaskCurrentInputsResponse {
     inputIds: string[];
 }
 declare const TaskCurrentInputsResponse: MessageFns<TaskCurrentInputsResponse>;
-interface TaskGetAutoscalingMetricsRequest {
-    taskId: string;
-}
-declare const TaskGetAutoscalingMetricsRequest: MessageFns<TaskGetAutoscalingMetricsRequest>;
-interface TaskGetAutoscalingMetricsResponse {
-    metrics: AutoscalingMetrics | undefined;
-}
-declare const TaskGetAutoscalingMetricsResponse: MessageFns<TaskGetAutoscalingMetricsResponse>;
 /**
  * Used to get a JWT and URL for direct access to a task command router
  * running on the modal-worker, so the client can issue exec commands (and other
@@ -3176,6 +3234,20 @@ interface TokenFlowWaitResponse {
     workspaceUsername: string;
 }
 declare const TokenFlowWaitResponse: MessageFns<TokenFlowWaitResponse>;
+interface TokenInfoGetRequest {
+}
+declare const TokenInfoGetRequest: MessageFns<TokenInfoGetRequest>;
+interface TokenInfoGetResponse {
+    tokenId: string;
+    workspaceId: string;
+    workspaceName: string;
+    userIdentity?: UserIdentity | undefined;
+    serviceUserIdentity?: ServiceUserIdentity | undefined;
+    /** Token metadata */
+    createdAt: Date | undefined;
+    expiresAt: Date | undefined;
+}
+declare const TokenInfoGetResponse: MessageFns<TokenInfoGetResponse>;
 interface TunnelData {
     host: string;
     port: number;
@@ -3209,6 +3281,11 @@ interface UploadUrlList {
     items: string[];
 }
 declare const UploadUrlList: MessageFns<UploadUrlList>;
+interface UserIdentity {
+    userId: string;
+    username: string;
+}
+declare const UserIdentity: MessageFns<UserIdentity>;
 interface VolumeCommitRequest {
     /**
      * NOTE(staffan): Mounting a volume in multiple locations is not supported, so volume_id alone uniquely identifies
@@ -3475,6 +3552,7 @@ declare const WebUrlInfo: MessageFns<WebUrlInfo>;
 interface WebhookConfig {
     type: WebhookType;
     method: string;
+    /** User-supplied "label" component of URL */
     requestedSuffix: string;
     asyncMode: WebhookAsyncMode;
     customDomains: CustomDomainConfig[];
@@ -3482,6 +3560,8 @@ interface WebhookConfig {
     webServerStartupTimeout: number;
     webEndpointDocs: boolean;
     requiresProxyAuth: boolean;
+    /** Additional URL suffix added for ephemeral Apps */
+    ephemeralSuffix: string;
 }
 declare const WebhookConfig: MessageFns<WebhookConfig>;
 interface WorkspaceBillingReportItem {
@@ -4467,14 +4547,6 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
-        readonly sandboxGetCommandRouterAccess: {
-            readonly name: "SandboxGetCommandRouterAccess";
-            readonly requestType: MessageFns<SandboxGetCommandRouterAccessRequest>;
-            readonly requestStream: false;
-            readonly responseType: MessageFns<SandboxGetCommandRouterAccessResponse>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
         readonly sandboxGetFromName: {
             readonly name: "SandboxGetFromName";
             readonly requestType: MessageFns<SandboxGetFromNameRequest>;
@@ -4735,15 +4807,6 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
-        /** Used for flash autoscaling */
-        readonly taskGetAutoscalingMetrics: {
-            readonly name: "TaskGetAutoscalingMetrics";
-            readonly requestType: MessageFns<TaskGetAutoscalingMetricsRequest>;
-            readonly requestStream: false;
-            readonly responseType: MessageFns<TaskGetAutoscalingMetricsResponse>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
         readonly taskGetCommandRouterAccess: {
             readonly name: "TaskGetCommandRouterAccess";
             readonly requestType: MessageFns<TaskGetCommandRouterAccessRequest>;
@@ -4785,6 +4848,14 @@ declare const ModalClientDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly tokenInfoGet: {
+            readonly name: "TokenInfoGet";
+            readonly requestType: MessageFns<TokenInfoGetRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<TokenInfoGetResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         /** Tunnels */
         readonly tunnelStart: {
             readonly name: "TunnelStart";
@@ -5369,7 +5440,14 @@ declare class ImageService {
      */
     fromGcpArtifactRegistry(tag: string, secret: Secret): Image;
     /**
-     * Delete an {@link Image} by ID. Warning: This removes an *entire Image*, and cannot be undone.
+     * Delete an {@link Image} by ID.
+     *
+     * Deletion is irreversible and will prevent Functions/Sandboxes from using the Image.
+     *
+     * Note: When building an Image, each chained method call will create an
+     * intermediate Image layer, each with its own ID. Deleting an Image will not
+     * delete any of its intermediate layers, only the image identified by the
+     * provided ID.
      */
     delete(imageId: string, _?: ImageDeleteParams): Promise<void>;
 }
@@ -5755,6 +5833,10 @@ type SandboxCreateParams = {
     name?: string;
     /** Optional experimental options. */
     experimentalOptions?: Record<string, any>;
+    /** If set, connections to this Sandbox will be subdomains of this domain rather than the default.
+     * This requires prior manual setup by Modal and is only available for Enterprise customers.
+     */
+    customDomain?: string;
 };
 /**
  * Service for managing {@link Sandbox}es.