modal 0.5.4 → 0.5.5

package/dist/index.cjs

@@ -34,6 +34,7 @@ __export(index_exports, {
   App: () => App2,
   AppService: () => AppService,
   CloudBucketMount: () => CloudBucketMount2,
+  CloudBucketMountService: () => CloudBucketMountService,
   Cls: () => Cls,
   ClsInstance: () => ClsInstance,
   ClsService: () => ClsService,
@@ -47,7 +48,7 @@ __export(index_exports, {
   ImageService: () => ImageService,
   InternalFailure: () => InternalFailure,
   InvalidError: () => InvalidError,
-  ModalClient: () => ModalClient,
+  ModalClient: () => ModalClient2,
   NotFoundError: () => NotFoundError,
   Proxy: () => Proxy3,
   ProxyService: () => ProxyService,
@@ -43324,6 +43325,89 @@ function isSet4(value) {
 var import_uuid = require("uuid");
 var import_nice_grpc10 = require("nice-grpc");
 
+// src/cloud_bucket_mount.ts
+var CloudBucketMountService = class {
+  #client;
+  constructor(client2) {
+    this.#client = client2;
+  }
+  create(bucketName, params = {}) {
+    let bucketType = 1 /* S3 */;
+    if (params.bucketEndpointUrl) {
+      const url = new URL(params.bucketEndpointUrl);
+      if (url.hostname.endsWith("r2.cloudflarestorage.com")) {
+        bucketType = 2 /* R2 */;
+      } else if (url.hostname.endsWith("storage.googleapis.com")) {
+        bucketType = 3 /* GCP */;
+      } else {
+        bucketType = 1 /* S3 */;
+        this.#client.logger.debug(
+          "CloudBucketMount received unrecognized bucket endpoint URL. Assuming AWS S3 configuration as fallback.",
+          "bucketEndpointUrl",
+          params.bucketEndpointUrl
+        );
+      }
+    }
+    if (params.requesterPays && !params.secret) {
+      throw new Error("Credentials required in order to use Requester Pays.");
+    }
+    if (params.keyPrefix && !params.keyPrefix.endsWith("/")) {
+      throw new Error(
+        "keyPrefix will be prefixed to all object paths, so it must end in a '/'"
+      );
+    }
+    return new CloudBucketMount2(
+      bucketName,
+      params.secret,
+      params.readOnly ?? false,
+      params.requesterPays ?? false,
+      params.bucketEndpointUrl,
+      params.keyPrefix,
+      params.oidcAuthRoleArn,
+      bucketType
+    );
+  }
+};
+var CloudBucketMount2 = class {
+  bucketName;
+  secret;
+  readOnly;
+  requesterPays;
+  bucketEndpointUrl;
+  keyPrefix;
+  oidcAuthRoleArn;
+  #bucketType;
+  constructor(bucketName, secretOrParams, readOnly, requesterPays, bucketEndpointUrl, keyPrefix, oidcAuthRoleArn, bucketType) {
+    if (bucketType !== void 0) {
+      this.bucketName = bucketName;
+      this.secret = secretOrParams;
+      this.readOnly = readOnly;
+      this.requesterPays = requesterPays;
+      this.bucketEndpointUrl = bucketEndpointUrl;
+      this.keyPrefix = keyPrefix;
+      this.oidcAuthRoleArn = oidcAuthRoleArn;
+      this.#bucketType = bucketType;
+    } else {
+      const params = secretOrParams === void 0 ? {} : secretOrParams;
+      return getDefaultClient().cloudBucketMounts.create(bucketName, params);
+    }
+  }
+  /** @ignore */
+  toProto(mountPath) {
+    return {
+      bucketName: this.bucketName,
+      mountPath,
+      credentialsSecretId: this.secret?.secretId ?? "",
+      readOnly: this.readOnly,
+      bucketType: this.#bucketType,
+      requesterPays: this.requesterPays,
+      bucketEndpointUrl: this.bucketEndpointUrl,
+      keyPrefix: this.keyPrefix,
+      oidcAuthRoleArn: this.oidcAuthRoleArn
+    };
+  }
+};
+
 // src/cls.ts
 var import_nice_grpc3 = require("nice-grpc");
 
@@ -44224,7 +44308,8 @@ var Cls = class _Cls {
     const bindResp = await this.#client.cpClient.functionBindParams({
       functionId: this.#serviceFunctionId,
       serializedParams,
-      functionOptions
+      functionOptions,
+      environmentName: this.#client.environmentName()
     });
     return bindResp.boundFunctionId;
   }
@@ -45647,68 +45732,6 @@ async function consumeIterator(iter) {
   }
 }
 
-// src/cloud_bucket_mount.ts
-var CloudBucketMount2 = class {
-  bucketName;
-  secret;
-  readOnly;
-  requesterPays;
-  bucketEndpointUrl;
-  keyPrefix;
-  oidcAuthRoleArn;
-  constructor(bucketName, params = {}) {
-    this.bucketName = bucketName;
-    this.secret = params.secret;
-    this.readOnly = params.readOnly ?? false;
-    this.requesterPays = params.requesterPays ?? false;
-    this.bucketEndpointUrl = params.bucketEndpointUrl;
-    this.keyPrefix = params.keyPrefix;
-    this.oidcAuthRoleArn = params.oidcAuthRoleArn;
-    if (this.bucketEndpointUrl) {
-      const url = new URL(this.bucketEndpointUrl);
-      if (!url.hostname.endsWith("r2.cloudflarestorage.com") && !url.hostname.endsWith("storage.googleapis.com")) {
-        console.warn(
-          "CloudBucketMount received unrecognized bucket endpoint URL. Assuming AWS S3 configuration as fallback."
-        );
-      }
-    }
-    if (this.requesterPays && !this.secret) {
-      throw new Error("Credentials required in order to use Requester Pays.");
-    }
-    if (this.keyPrefix && !this.keyPrefix.endsWith("/")) {
-      throw new Error(
-        "keyPrefix will be prefixed to all object paths, so it must end in a '/'"
-      );
-    }
-  }
-};
-function endpointUrlToBucketType(bucketEndpointUrl) {
-  if (!bucketEndpointUrl) {
-    return 1 /* S3 */;
-  }
-  const url = new URL(bucketEndpointUrl);
-  if (url.hostname.endsWith("r2.cloudflarestorage.com")) {
-    return 2 /* R2 */;
-  } else if (url.hostname.endsWith("storage.googleapis.com")) {
-    return 3 /* GCP */;
-  } else {
-    return 1 /* S3 */;
-  }
-}
-function cloudBucketMountToProto(mount, mountPath) {
-  return {
-    bucketName: mount.bucketName,
-    mountPath,
-    credentialsSecretId: mount.secret?.secretId ?? "",
-    readOnly: mount.readOnly,
-    bucketType: endpointUrlToBucketType(mount.bucketEndpointUrl),
-    requesterPays: mount.requesterPays,
-    bucketEndpointUrl: mount.bucketEndpointUrl,
-    keyPrefix: mount.keyPrefix,
-    oidcAuthRoleArn: mount.oidcAuthRoleArn
-  };
-}
-
 // src/sandbox.ts
 async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
   checkForRenamedParams(params, {
@@ -45738,32 +45761,38 @@ async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
     readOnly: volume.isReadOnly
   })) : [];
   const cloudBucketMounts = params.cloudBucketMounts ? Object.entries(params.cloudBucketMounts).map(
-    ([mountPath, mount]) => cloudBucketMountToProto(mount, mountPath)
+    ([mountPath, mount]) => mount.toProto(mountPath)
   ) : [];
   const openPorts = [];
   if (params.encryptedPorts) {
     openPorts.push(
-      ...params.encryptedPorts.map((port) => ({
-        port,
-        unencrypted: false
-      }))
+      ...params.encryptedPorts.map(
+        (port) => PortSpec.create({
+          port,
+          unencrypted: false
+        })
+      )
     );
   }
   if (params.h2Ports) {
     openPorts.push(
-      ...params.h2Ports.map((port) => ({
-        port,
-        unencrypted: false,
-        tunnelType: 1 /* TUNNEL_TYPE_H2 */
-      }))
+      ...params.h2Ports.map(
+        (port) => PortSpec.create({
+          port,
+          unencrypted: false,
+          tunnelType: 1 /* TUNNEL_TYPE_H2 */
+        })
+      )
     );
   }
   if (params.unencryptedPorts) {
     openPorts.push(
-      ...params.unencryptedPorts.map((port) => ({
-        port,
-        unencrypted: true
-      }))
+      ...params.unencryptedPorts.map(
+        (port) => PortSpec.create({
+          port,
+          unencrypted: true
+        })
+      )
     );
   }
   const secretIds = (params.secrets || []).map((secret) => secret.secretId);
@@ -45789,9 +45818,9 @@ async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
       allowedCidrs: []
     };
   }
-  const schedulerPlacement = SchedulerPlacement.create({
-    regions: params.regions ?? []
-  });
+  const schedulerPlacement = params.regions?.length ? SchedulerPlacement.create({
+    regions: params.regions
+  }) : void 0;
   let ptyInfo;
   if (params.pty) {
     ptyInfo = defaultSandboxPTYInfo();
@@ -45848,18 +45877,18 @@ async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
       idleTimeoutSecs: params.idleTimeoutMs != void 0 ? params.idleTimeoutMs / 1e3 : void 0,
       workdir: params.workdir ?? void 0,
       networkAccess,
-      resources: {
+      resources: Resources.create({
         milliCpu,
         milliCpuMax,
         memoryMb,
         memoryMbMax,
         gpuConfig
-      },
+      }),
       volumeMounts,
       cloudBucketMounts,
       ptyInfo,
       secretIds,
-      openPorts: openPorts.length > 0 ? { ports: openPorts } : void 0,
+      openPorts: PortSpecs.create({ ports: openPorts }),
       cloudProviderStr: params.cloud ?? "",
       schedulerPlacement,
       verbose: params.verbose ?? false,
@@ -46775,7 +46804,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.4" : "0.0.0";
+  return true ? "0.5.5" : "0.0.0";
 }
 
 // src/logger.ts
@@ -46885,8 +46914,9 @@ function createLogger(logger, logLevel = "") {
 }
 
 // src/client.ts
-var ModalClient = class {
+var ModalClient2 = class {
   apps;
+  cloudBucketMounts;
   cls;
   functions;
   functionCalls;
@@ -46926,6 +46956,7 @@ var ModalClient = class {
     this.cpClient = params?.cpClient ?? this.createClient(this.profile);
     this.logger.debug("Modal client initialized successfully");
     this.apps = new AppService(this);
+    this.cloudBucketMounts = new CloudBucketMountService(this);
     this.cls = new ClsService(this);
     this.functions = new FunctionService(this);
     this.functionCalls = new FunctionCallService(this);
@@ -47159,7 +47190,7 @@ var defaultClient;
 var defaultClientOptions;
 function getDefaultClient() {
   if (!defaultClient) {
-    defaultClient = new ModalClient(defaultClientOptions);
+    defaultClient = new ModalClient2(defaultClientOptions);
   }
   return defaultClient;
 }
@@ -47174,7 +47205,7 @@ function initializeClient(options) {
     tokenSecret: options.tokenSecret,
     environment: options.environment
   };
-  defaultClient = new ModalClient(defaultClientOptions);
+  defaultClient = new ModalClient2(defaultClientOptions);
 }
 function close() {
   if (defaultClient) {
@@ -47215,7 +47246,7 @@ var AppService = class {
 };
 function parseGpuConfig(gpu) {
   if (!gpu) {
-    return void 0;
+    return GPUConfig.create({});
   }
   let gpuType = gpu;
   let count = 1;
@@ -47229,12 +47260,10 @@ function parseGpuConfig(gpu) {
       );
     }
   }
-  return {
-    type: 0,
-    // Deprecated field, but required by proto
+  return GPUConfig.create({
     count,
     gpuType: gpuType.toUpperCase()
-  };
+  });
 }
 var App2 = class {
   appId;
@@ -47247,6 +47276,7 @@ var App2 = class {
   /**
    * @deprecated Use {@link AppService#fromName client.apps.fromName()} instead.
    */
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   static async lookup(name, options = {}) {
     return getDefaultClient().apps.fromName(name, options);
   }
@@ -47281,6 +47311,7 @@ var App2 = class {
   App,
   AppService,
   CloudBucketMount,
+  CloudBucketMountService,
   Cls,
   ClsInstance,
   ClsService,

package/dist/index.d.cts

@@ -4971,6 +4971,98 @@ interface MessageFns<T> {
     fromPartial(object: DeepPartial<T>): T;
 }
 
+/** Optional parameters for {@link SecretService#fromName client.secrets.fromName()}. */
+type SecretFromNameParams = {
+    environment?: string;
+    requiredKeys?: string[];
+};
+/** Optional parameters for {@link SecretService#fromObject client.secrets.fromObject()}. */
+type SecretFromObjectParams = {
+    environment?: string;
+};
+/** Optional parameters for {@link SecretService#delete client.secrets.delete()}. */
+type SecretDeleteParams = {
+    environment?: string;
+    allowMissing?: boolean;
+};
+/**
+ * Service for managing {@link Secret Secrets}.
+ *
+ * Normally only ever accessed via the client as:
+ * ```typescript
+ * const modal = new ModalClient();
+ * const secret = await modal.secrets.fromName("my-secret");
+ * ```
+ */
+declare class SecretService {
+    #private;
+    constructor(client: ModalClient);
+    /** Reference a {@link Secret} by its name. */
+    fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
+    /** Create a {@link Secret} from a plain object of key-value pairs. */
+    fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
+    /**
+     * Delete a named {@link Secret}.
+     *
+     * Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
+     */
+    delete(name: string, params?: SecretDeleteParams): Promise<void>;
+}
+/** Secrets provide a dictionary of environment variables for {@link Image}s. */
+declare class Secret {
+    readonly secretId: string;
+    readonly name?: string;
+    /** @ignore */
+    constructor(secretId: string, name?: string);
+    /**
+     * @deprecated Use {@link SecretService#fromName client.secrets.fromName()} instead.
+     */
+    static fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
+    /**
+     * @deprecated Use {@link SecretService#fromObject client.secrets.fromObject()} instead.
+     */
+    static fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
+}
+
+declare class CloudBucketMountService {
+    #private;
+    constructor(client: ModalClient);
+    create(bucketName: string, params?: {
+        secret?: Secret;
+        readOnly?: boolean;
+        requesterPays?: boolean;
+        bucketEndpointUrl?: string;
+        keyPrefix?: string;
+        oidcAuthRoleArn?: string;
+    }): CloudBucketMount;
+}
+/** Cloud Bucket Mounts provide access to cloud storage buckets within Modal Functions. */
+declare class CloudBucketMount {
+    #private;
+    readonly bucketName: string;
+    readonly secret?: Secret;
+    readonly readOnly: boolean;
+    readonly requesterPays: boolean;
+    readonly bucketEndpointUrl?: string;
+    readonly keyPrefix?: string;
+    readonly oidcAuthRoleArn?: string;
+    /**
+     * @deprecated Use {@link CloudBucketMountService#create client.cloudBucketMounts.create()} instead.
+     */
+    constructor(bucketName: string, params?: {
+        secret?: Secret;
+        readOnly?: boolean;
+        requesterPays?: boolean;
+        bucketEndpointUrl?: string;
+        keyPrefix?: string;
+        oidcAuthRoleArn?: string;
+    });
+    /** @ignore */
+    constructor(bucketName: string, secret: Secret | undefined, readOnly: boolean, requesterPays: boolean, bucketEndpointUrl: string | undefined, keyPrefix: string | undefined, oidcAuthRoleArn: string | undefined, bucketType: CloudBucketMount_BucketType);
+    /** @ignore */
+    toProto(mountPath: string): CloudBucketMount$1;
+}
+
 /**
  * Service for managing {@link FunctionCall}s.
  *
@@ -5073,59 +5165,6 @@ declare class Function_ {
     getWebUrl(): Promise<string | undefined>;
 }
 
-/** Optional parameters for {@link SecretService#fromName client.secrets.fromName()}. */
-type SecretFromNameParams = {
-    environment?: string;
-    requiredKeys?: string[];
-};
-/** Optional parameters for {@link SecretService#fromObject client.secrets.fromObject()}. */
-type SecretFromObjectParams = {
-    environment?: string;
-};
-/** Optional parameters for {@link SecretService#delete client.secrets.delete()}. */
-type SecretDeleteParams = {
-    environment?: string;
-    allowMissing?: boolean;
-};
-/**
- * Service for managing {@link Secret Secrets}.
- *
- * Normally only ever accessed via the client as:
- * ```typescript
- * const modal = new ModalClient();
- * const secret = await modal.secrets.fromName("my-secret");
- * ```
- */
-declare class SecretService {
-    #private;
-    constructor(client: ModalClient);
-    /** Reference a {@link Secret} by its name. */
-    fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
-    /** Create a {@link Secret} from a plain object of key-value pairs. */
-    fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
-    /**
-     * Delete a named {@link Secret}.
-     *
-     * Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
-     */
-    delete(name: string, params?: SecretDeleteParams): Promise<void>;
-}
-/** Secrets provide a dictionary of environment variables for {@link Image}s. */
-declare class Secret {
-    readonly secretId: string;
-    readonly name?: string;
-    /** @ignore */
-    constructor(secretId: string, name?: string);
-    /**
-     * @deprecated Use {@link SecretService#fromName client.secrets.fromName()} instead.
-     */
-    static fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
-    /**
-     * @deprecated Use {@link SecretService#fromObject client.secrets.fromObject()} instead.
-     */
-    static fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
-}
-
 /** Retry policy configuration for a Modal Function/Cls. */
 declare class Retries {
     readonly maxRetries: number;
@@ -5648,25 +5687,6 @@ interface ModalWriteStream<R = any> extends WritableStream<R> {
     writeBytes(bytes: Uint8Array): Promise<void>;
 }
 
-/** Cloud Bucket Mounts provide access to cloud storage buckets within Modal Functions. */
-declare class CloudBucketMount {
-    readonly bucketName: string;
-    readonly secret?: Secret;
-    readonly readOnly: boolean;
-    readonly requesterPays: boolean;
-    readonly bucketEndpointUrl?: string;
-    readonly keyPrefix?: string;
-    readonly oidcAuthRoleArn?: string;
-    constructor(bucketName: string, params?: {
-        secret?: Secret;
-        readOnly?: boolean;
-        requesterPays?: boolean;
-        bucketEndpointUrl?: string;
-        keyPrefix?: string;
-        oidcAuthRoleArn?: string;
-    });
-}
-
 /**
  * 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.
@@ -5694,7 +5714,7 @@ type SandboxCreateParams = {
     gpu?: string;
     /** Timeout of the Sandbox container in milliseconds, defaults to 10 minutes. */
     timeoutMs?: number;
-    /** The amount of time in milliseconds that a sandbox can be idle before being terminated. */
+    /** The amount of time in milliseconds that a Sandbox can be idle before being terminated. */
     idleTimeoutMs?: number;
     /** Working directory of the Sandbox. */
     workdir?: string;
@@ -5740,7 +5760,7 @@ type SandboxCreateParams = {
  * Normally only ever accessed via the client as:
  * ```typescript
  * const modal = new ModalClient();
- * const sandbox = await modal.sandboxes.create(app, image);
+ * const sb = await modal.sandboxes.create(app, image);
  * ```
  */
 declare class SandboxService {
@@ -5949,11 +5969,12 @@ type ModalGrpcClient = Client<typeof ModalClientDefinition, TimeoutOptions & Ret
  *
  * const app = await modal.apps.fromName("my-app");
  * const image = modal.images.fromRegistry("python:3.13");
- * const sandbox = await modal.sandboxes.create(app, image);
+ * const sb = await modal.sandboxes.create(app, image);
  * ```
  */
 declare class ModalClient {
     readonly apps: AppService;
+    readonly cloudBucketMounts: CloudBucketMountService;
     readonly cls: ClsService;
     readonly functions: FunctionService;
     readonly functionCalls: FunctionCallService;
@@ -6118,4 +6139,4 @@ declare class SandboxTimeoutError extends Error {
 
 declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, type ClientOptions, CloudBucketMount, 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 SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, 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, 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 SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, 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 };

package/dist/index.d.ts

@@ -4971,6 +4971,98 @@ interface MessageFns<T> {
     fromPartial(object: DeepPartial<T>): T;
 }
 
+/** Optional parameters for {@link SecretService#fromName client.secrets.fromName()}. */
+type SecretFromNameParams = {
+    environment?: string;
+    requiredKeys?: string[];
+};
+/** Optional parameters for {@link SecretService#fromObject client.secrets.fromObject()}. */
+type SecretFromObjectParams = {
+    environment?: string;
+};
+/** Optional parameters for {@link SecretService#delete client.secrets.delete()}. */
+type SecretDeleteParams = {
+    environment?: string;
+    allowMissing?: boolean;
+};
+/**
+ * Service for managing {@link Secret Secrets}.
+ *
+ * Normally only ever accessed via the client as:
+ * ```typescript
+ * const modal = new ModalClient();
+ * const secret = await modal.secrets.fromName("my-secret");
+ * ```
+ */
+declare class SecretService {
+    #private;
+    constructor(client: ModalClient);
+    /** Reference a {@link Secret} by its name. */
+    fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
+    /** Create a {@link Secret} from a plain object of key-value pairs. */
+    fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
+    /**
+     * Delete a named {@link Secret}.
+     *
+     * Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
+     */
+    delete(name: string, params?: SecretDeleteParams): Promise<void>;
+}
+/** Secrets provide a dictionary of environment variables for {@link Image}s. */
+declare class Secret {
+    readonly secretId: string;
+    readonly name?: string;
+    /** @ignore */
+    constructor(secretId: string, name?: string);
+    /**
+     * @deprecated Use {@link SecretService#fromName client.secrets.fromName()} instead.
+     */
+    static fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
+    /**
+     * @deprecated Use {@link SecretService#fromObject client.secrets.fromObject()} instead.
+     */
+    static fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
+}
+
+declare class CloudBucketMountService {
+    #private;
+    constructor(client: ModalClient);
+    create(bucketName: string, params?: {
+        secret?: Secret;
+        readOnly?: boolean;
+        requesterPays?: boolean;
+        bucketEndpointUrl?: string;
+        keyPrefix?: string;
+        oidcAuthRoleArn?: string;
+    }): CloudBucketMount;
+}
+/** Cloud Bucket Mounts provide access to cloud storage buckets within Modal Functions. */
+declare class CloudBucketMount {
+    #private;
+    readonly bucketName: string;
+    readonly secret?: Secret;
+    readonly readOnly: boolean;
+    readonly requesterPays: boolean;
+    readonly bucketEndpointUrl?: string;
+    readonly keyPrefix?: string;
+    readonly oidcAuthRoleArn?: string;
+    /**
+     * @deprecated Use {@link CloudBucketMountService#create client.cloudBucketMounts.create()} instead.
+     */
+    constructor(bucketName: string, params?: {
+        secret?: Secret;
+        readOnly?: boolean;
+        requesterPays?: boolean;
+        bucketEndpointUrl?: string;
+        keyPrefix?: string;
+        oidcAuthRoleArn?: string;
+    });
+    /** @ignore */
+    constructor(bucketName: string, secret: Secret | undefined, readOnly: boolean, requesterPays: boolean, bucketEndpointUrl: string | undefined, keyPrefix: string | undefined, oidcAuthRoleArn: string | undefined, bucketType: CloudBucketMount_BucketType);
+    /** @ignore */
+    toProto(mountPath: string): CloudBucketMount$1;
+}
+
 /**
  * Service for managing {@link FunctionCall}s.
  *
@@ -5073,59 +5165,6 @@ declare class Function_ {
     getWebUrl(): Promise<string | undefined>;
 }
 
-/** Optional parameters for {@link SecretService#fromName client.secrets.fromName()}. */
-type SecretFromNameParams = {
-    environment?: string;
-    requiredKeys?: string[];
-};
-/** Optional parameters for {@link SecretService#fromObject client.secrets.fromObject()}. */
-type SecretFromObjectParams = {
-    environment?: string;
-};
-/** Optional parameters for {@link SecretService#delete client.secrets.delete()}. */
-type SecretDeleteParams = {
-    environment?: string;
-    allowMissing?: boolean;
-};
-/**
- * Service for managing {@link Secret Secrets}.
- *
- * Normally only ever accessed via the client as:
- * ```typescript
- * const modal = new ModalClient();
- * const secret = await modal.secrets.fromName("my-secret");
- * ```
- */
-declare class SecretService {
-    #private;
-    constructor(client: ModalClient);
-    /** Reference a {@link Secret} by its name. */
-    fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
-    /** Create a {@link Secret} from a plain object of key-value pairs. */
-    fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
-    /**
-     * Delete a named {@link Secret}.
-     *
-     * Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
-     */
-    delete(name: string, params?: SecretDeleteParams): Promise<void>;
-}
-/** Secrets provide a dictionary of environment variables for {@link Image}s. */
-declare class Secret {
-    readonly secretId: string;
-    readonly name?: string;
-    /** @ignore */
-    constructor(secretId: string, name?: string);
-    /**
-     * @deprecated Use {@link SecretService#fromName client.secrets.fromName()} instead.
-     */
-    static fromName(name: string, params?: SecretFromNameParams): Promise<Secret>;
-    /**
-     * @deprecated Use {@link SecretService#fromObject client.secrets.fromObject()} instead.
-     */
-    static fromObject(entries: Record<string, string>, params?: SecretFromObjectParams): Promise<Secret>;
-}
-
 /** Retry policy configuration for a Modal Function/Cls. */
 declare class Retries {
     readonly maxRetries: number;
@@ -5648,25 +5687,6 @@ interface ModalWriteStream<R = any> extends WritableStream<R> {
     writeBytes(bytes: Uint8Array): Promise<void>;
 }
 
-/** Cloud Bucket Mounts provide access to cloud storage buckets within Modal Functions. */
-declare class CloudBucketMount {
-    readonly bucketName: string;
-    readonly secret?: Secret;
-    readonly readOnly: boolean;
-    readonly requesterPays: boolean;
-    readonly bucketEndpointUrl?: string;
-    readonly keyPrefix?: string;
-    readonly oidcAuthRoleArn?: string;
-    constructor(bucketName: string, params?: {
-        secret?: Secret;
-        readOnly?: boolean;
-        requesterPays?: boolean;
-        bucketEndpointUrl?: string;
-        keyPrefix?: string;
-        oidcAuthRoleArn?: string;
-    });
-}
-
 /**
  * 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.
@@ -5694,7 +5714,7 @@ type SandboxCreateParams = {
     gpu?: string;
     /** Timeout of the Sandbox container in milliseconds, defaults to 10 minutes. */
     timeoutMs?: number;
-    /** The amount of time in milliseconds that a sandbox can be idle before being terminated. */
+    /** The amount of time in milliseconds that a Sandbox can be idle before being terminated. */
     idleTimeoutMs?: number;
     /** Working directory of the Sandbox. */
     workdir?: string;
@@ -5740,7 +5760,7 @@ type SandboxCreateParams = {
  * Normally only ever accessed via the client as:
  * ```typescript
  * const modal = new ModalClient();
- * const sandbox = await modal.sandboxes.create(app, image);
+ * const sb = await modal.sandboxes.create(app, image);
  * ```
  */
 declare class SandboxService {
@@ -5949,11 +5969,12 @@ type ModalGrpcClient = Client<typeof ModalClientDefinition, TimeoutOptions & Ret
  *
  * const app = await modal.apps.fromName("my-app");
  * const image = modal.images.fromRegistry("python:3.13");
- * const sandbox = await modal.sandboxes.create(app, image);
+ * const sb = await modal.sandboxes.create(app, image);
  * ```
  */
 declare class ModalClient {
     readonly apps: AppService;
+    readonly cloudBucketMounts: CloudBucketMountService;
     readonly cls: ClsService;
     readonly functions: FunctionService;
     readonly functionCalls: FunctionCallService;
@@ -6118,4 +6139,4 @@ declare class SandboxTimeoutError extends Error {
 
 declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, type ClientOptions, CloudBucketMount, 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 SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, 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, 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 SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, 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 };

package/dist/index.js

@@ -43257,6 +43257,89 @@ import {
   Status as Status9
 } from "nice-grpc";
 
+// src/cloud_bucket_mount.ts
+var CloudBucketMountService = class {
+  #client;
+  constructor(client2) {
+    this.#client = client2;
+  }
+  create(bucketName, params = {}) {
+    let bucketType = 1 /* S3 */;
+    if (params.bucketEndpointUrl) {
+      const url = new URL(params.bucketEndpointUrl);
+      if (url.hostname.endsWith("r2.cloudflarestorage.com")) {
+        bucketType = 2 /* R2 */;
+      } else if (url.hostname.endsWith("storage.googleapis.com")) {
+        bucketType = 3 /* GCP */;
+      } else {
+        bucketType = 1 /* S3 */;
+        this.#client.logger.debug(
+          "CloudBucketMount received unrecognized bucket endpoint URL. Assuming AWS S3 configuration as fallback.",
+          "bucketEndpointUrl",
+          params.bucketEndpointUrl
+        );
+      }
+    }
+    if (params.requesterPays && !params.secret) {
+      throw new Error("Credentials required in order to use Requester Pays.");
+    }
+    if (params.keyPrefix && !params.keyPrefix.endsWith("/")) {
+      throw new Error(
+        "keyPrefix will be prefixed to all object paths, so it must end in a '/'"
+      );
+    }
+    return new CloudBucketMount2(
+      bucketName,
+      params.secret,
+      params.readOnly ?? false,
+      params.requesterPays ?? false,
+      params.bucketEndpointUrl,
+      params.keyPrefix,
+      params.oidcAuthRoleArn,
+      bucketType
+    );
+  }
+};
+var CloudBucketMount2 = class {
+  bucketName;
+  secret;
+  readOnly;
+  requesterPays;
+  bucketEndpointUrl;
+  keyPrefix;
+  oidcAuthRoleArn;
+  #bucketType;
+  constructor(bucketName, secretOrParams, readOnly, requesterPays, bucketEndpointUrl, keyPrefix, oidcAuthRoleArn, bucketType) {
+    if (bucketType !== void 0) {
+      this.bucketName = bucketName;
+      this.secret = secretOrParams;
+      this.readOnly = readOnly;
+      this.requesterPays = requesterPays;
+      this.bucketEndpointUrl = bucketEndpointUrl;
+      this.keyPrefix = keyPrefix;
+      this.oidcAuthRoleArn = oidcAuthRoleArn;
+      this.#bucketType = bucketType;
+    } else {
+      const params = secretOrParams === void 0 ? {} : secretOrParams;
+      return getDefaultClient().cloudBucketMounts.create(bucketName, params);
+    }
+  }
+  /** @ignore */
+  toProto(mountPath) {
+    return {
+      bucketName: this.bucketName,
+      mountPath,
+      credentialsSecretId: this.secret?.secretId ?? "",
+      readOnly: this.readOnly,
+      bucketType: this.#bucketType,
+      requesterPays: this.requesterPays,
+      bucketEndpointUrl: this.bucketEndpointUrl,
+      keyPrefix: this.keyPrefix,
+      oidcAuthRoleArn: this.oidcAuthRoleArn
+    };
+  }
+};
+
 // src/cls.ts
 import { ClientError as ClientError3, Status as Status3 } from "nice-grpc";
 
@@ -44157,7 +44240,8 @@ var Cls = class _Cls {
     const bindResp = await this.#client.cpClient.functionBindParams({
       functionId: this.#serviceFunctionId,
       serializedParams,
-      functionOptions
+      functionOptions,
+      environmentName: this.#client.environmentName()
     });
     return bindResp.boundFunctionId;
   }
@@ -45580,68 +45664,6 @@ async function consumeIterator(iter) {
   }
 }
 
-// src/cloud_bucket_mount.ts
-var CloudBucketMount2 = class {
-  bucketName;
-  secret;
-  readOnly;
-  requesterPays;
-  bucketEndpointUrl;
-  keyPrefix;
-  oidcAuthRoleArn;
-  constructor(bucketName, params = {}) {
-    this.bucketName = bucketName;
-    this.secret = params.secret;
-    this.readOnly = params.readOnly ?? false;
-    this.requesterPays = params.requesterPays ?? false;
-    this.bucketEndpointUrl = params.bucketEndpointUrl;
-    this.keyPrefix = params.keyPrefix;
-    this.oidcAuthRoleArn = params.oidcAuthRoleArn;
-    if (this.bucketEndpointUrl) {
-      const url = new URL(this.bucketEndpointUrl);
-      if (!url.hostname.endsWith("r2.cloudflarestorage.com") && !url.hostname.endsWith("storage.googleapis.com")) {
-        console.warn(
-          "CloudBucketMount received unrecognized bucket endpoint URL. Assuming AWS S3 configuration as fallback."
-        );
-      }
-    }
-    if (this.requesterPays && !this.secret) {
-      throw new Error("Credentials required in order to use Requester Pays.");
-    }
-    if (this.keyPrefix && !this.keyPrefix.endsWith("/")) {
-      throw new Error(
-        "keyPrefix will be prefixed to all object paths, so it must end in a '/'"
-      );
-    }
-  }
-};
-function endpointUrlToBucketType(bucketEndpointUrl) {
-  if (!bucketEndpointUrl) {
-    return 1 /* S3 */;
-  }
-  const url = new URL(bucketEndpointUrl);
-  if (url.hostname.endsWith("r2.cloudflarestorage.com")) {
-    return 2 /* R2 */;
-  } else if (url.hostname.endsWith("storage.googleapis.com")) {
-    return 3 /* GCP */;
-  } else {
-    return 1 /* S3 */;
-  }
-}
-function cloudBucketMountToProto(mount, mountPath) {
-  return {
-    bucketName: mount.bucketName,
-    mountPath,
-    credentialsSecretId: mount.secret?.secretId ?? "",
-    readOnly: mount.readOnly,
-    bucketType: endpointUrlToBucketType(mount.bucketEndpointUrl),
-    requesterPays: mount.requesterPays,
-    bucketEndpointUrl: mount.bucketEndpointUrl,
-    keyPrefix: mount.keyPrefix,
-    oidcAuthRoleArn: mount.oidcAuthRoleArn
-  };
-}
-
 // src/sandbox.ts
 async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
   checkForRenamedParams(params, {
@@ -45671,32 +45693,38 @@ async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
     readOnly: volume.isReadOnly
   })) : [];
   const cloudBucketMounts = params.cloudBucketMounts ? Object.entries(params.cloudBucketMounts).map(
-    ([mountPath, mount]) => cloudBucketMountToProto(mount, mountPath)
+    ([mountPath, mount]) => mount.toProto(mountPath)
   ) : [];
   const openPorts = [];
   if (params.encryptedPorts) {
     openPorts.push(
-      ...params.encryptedPorts.map((port) => ({
-        port,
-        unencrypted: false
-      }))
+      ...params.encryptedPorts.map(
+        (port) => PortSpec.create({
+          port,
+          unencrypted: false
+        })
+      )
     );
   }
   if (params.h2Ports) {
     openPorts.push(
-      ...params.h2Ports.map((port) => ({
-        port,
-        unencrypted: false,
-        tunnelType: 1 /* TUNNEL_TYPE_H2 */
-      }))
+      ...params.h2Ports.map(
+        (port) => PortSpec.create({
+          port,
+          unencrypted: false,
+          tunnelType: 1 /* TUNNEL_TYPE_H2 */
+        })
+      )
     );
   }
   if (params.unencryptedPorts) {
     openPorts.push(
-      ...params.unencryptedPorts.map((port) => ({
-        port,
-        unencrypted: true
-      }))
+      ...params.unencryptedPorts.map(
+        (port) => PortSpec.create({
+          port,
+          unencrypted: true
+        })
+      )
     );
   }
   const secretIds = (params.secrets || []).map((secret) => secret.secretId);
@@ -45722,9 +45750,9 @@ async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
       allowedCidrs: []
     };
   }
-  const schedulerPlacement = SchedulerPlacement.create({
-    regions: params.regions ?? []
-  });
+  const schedulerPlacement = params.regions?.length ? SchedulerPlacement.create({
+    regions: params.regions
+  }) : void 0;
   let ptyInfo;
   if (params.pty) {
     ptyInfo = defaultSandboxPTYInfo();
@@ -45781,18 +45809,18 @@ async function buildSandboxCreateRequestProto(appId, imageId, params = {}) {
       idleTimeoutSecs: params.idleTimeoutMs != void 0 ? params.idleTimeoutMs / 1e3 : void 0,
       workdir: params.workdir ?? void 0,
       networkAccess,
-      resources: {
+      resources: Resources.create({
         milliCpu,
         milliCpuMax,
         memoryMb,
         memoryMbMax,
         gpuConfig
-      },
+      }),
       volumeMounts,
       cloudBucketMounts,
       ptyInfo,
       secretIds,
-      openPorts: openPorts.length > 0 ? { ports: openPorts } : void 0,
+      openPorts: PortSpecs.create({ ports: openPorts }),
       cloudProviderStr: params.cloud ?? "",
       schedulerPlacement,
       verbose: params.verbose ?? false,
@@ -46708,7 +46736,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.4" : "0.0.0";
+  return true ? "0.5.5" : "0.0.0";
 }
 
 // src/logger.ts
@@ -46818,8 +46846,9 @@ function createLogger(logger, logLevel = "") {
 }
 
 // src/client.ts
-var ModalClient = class {
+var ModalClient2 = class {
   apps;
+  cloudBucketMounts;
   cls;
   functions;
   functionCalls;
@@ -46859,6 +46888,7 @@ var ModalClient = class {
     this.cpClient = params?.cpClient ?? this.createClient(this.profile);
     this.logger.debug("Modal client initialized successfully");
     this.apps = new AppService(this);
+    this.cloudBucketMounts = new CloudBucketMountService(this);
     this.cls = new ClsService(this);
     this.functions = new FunctionService(this);
     this.functionCalls = new FunctionCallService(this);
@@ -47092,7 +47122,7 @@ var defaultClient;
 var defaultClientOptions;
 function getDefaultClient() {
   if (!defaultClient) {
-    defaultClient = new ModalClient(defaultClientOptions);
+    defaultClient = new ModalClient2(defaultClientOptions);
   }
   return defaultClient;
 }
@@ -47107,7 +47137,7 @@ function initializeClient(options) {
     tokenSecret: options.tokenSecret,
     environment: options.environment
   };
-  defaultClient = new ModalClient(defaultClientOptions);
+  defaultClient = new ModalClient2(defaultClientOptions);
 }
 function close() {
   if (defaultClient) {
@@ -47148,7 +47178,7 @@ var AppService = class {
 };
 function parseGpuConfig(gpu) {
   if (!gpu) {
-    return void 0;
+    return GPUConfig.create({});
   }
   let gpuType = gpu;
   let count = 1;
@@ -47162,12 +47192,10 @@ function parseGpuConfig(gpu) {
       );
     }
   }
-  return {
-    type: 0,
-    // Deprecated field, but required by proto
+  return GPUConfig.create({
     count,
     gpuType: gpuType.toUpperCase()
-  };
+  });
 }
 var App2 = class {
   appId;
@@ -47180,6 +47208,7 @@ var App2 = class {
   /**
    * @deprecated Use {@link AppService#fromName client.apps.fromName()} instead.
    */
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   static async lookup(name, options = {}) {
     return getDefaultClient().apps.fromName(name, options);
   }
@@ -47213,6 +47242,7 @@ export {
   App2 as App,
   AppService,
   CloudBucketMount2 as CloudBucketMount,
+  CloudBucketMountService,
   Cls,
   ClsInstance,
   ClsService,
@@ -47226,7 +47256,7 @@ export {
   ImageService,
   InternalFailure,
   InvalidError,
-  ModalClient,
+  ModalClient2 as ModalClient,
   NotFoundError,
   Proxy3 as Proxy,
   ProxyService,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modal",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Modal SDK for JavaScript/TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs/guide/sdk-javascript-go",