modal 0.5.4 → 0.5.6

package/README.md

@@ -45,6 +45,7 @@ We also provide a number of examples:
 - [Check the status and exit code of a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-poll.ts)
 - [Access Sandbox filesystem](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-filesystem.ts)
 - [Expose ports on a Sandbox using Tunnels](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-tunnels.ts)
+- [Create connect tokens for a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-connect-token.ts)
 - [Include Secrets in Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-secrets.ts)
 - [Mount a Volume to a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-volume.ts), and same but [with an ephemeral Volume](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-volume-ephemeral.ts)
 - [Mount a cloud bucket to a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-cloud-bucket.ts)

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,
@@ -46198,6 +46227,16 @@ var Sandbox2 = class _Sandbox {
     }
     return this.#taskId;
   }
+  /**
+   * Create a token for making HTTP connections to the Sandbox.
+   */
+  async createConnectToken(params) {
+    const resp = await this.#client.cpClient.sandboxCreateConnectToken({
+      sandboxId: this.sandboxId,
+      userMetadata: params?.userMetadata
+    });
+    return { url: resp.url, token: resp.token };
+  }
   async terminate() {
     await this.#client.cpClient.sandboxTerminate({ sandboxId: this.sandboxId });
     this.#taskId = void 0;
@@ -46643,24 +46682,27 @@ var AuthTokenManager = class {
   logger;
   currentToken = "";
   tokenExpiry = 0;
-  stopped = false;
   timeoutId = null;
-  initialTokenPromise = null;
+  running = false;
+  fetchPromise = null;
   constructor(client2, logger) {
     this.client = client2;
     this.logger = logger;
   }
   /**
-   * Returns the current cached token.
-   * If the initial token fetch is still in progress, waits for it to complete.
+   * Returns a valid auth token.
+   * If the current token is expired and the manager is running, triggers an on-demand refresh.
    */
   async getToken() {
-    if (this.initialTokenPromise) {
-      await this.initialTokenPromise;
-    }
     if (this.currentToken && !this.isExpired()) {
       return this.currentToken;
     }
+    if (this.running) {
+      await this.runFetch();
+      if (this.currentToken && !this.isExpired()) {
+        return this.currentToken;
+      }
+    }
     throw new Error("No valid auth token available");
   }
   /**
@@ -46697,7 +46739,7 @@ var AuthTokenManager = class {
    * Background loop that refreshes tokens REFRESH_WINDOW seconds before they expire.
    */
   async backgroundRefresh() {
-    while (!this.stopped) {
+    while (this.running) {
       const now = Math.floor(Date.now() / 1e3);
       const refreshTime = this.tokenExpiry - REFRESH_WINDOW;
       const delay = Math.max(0, refreshTime - now) * 1e3;
@@ -46705,11 +46747,11 @@ var AuthTokenManager = class {
         this.timeoutId = setTimeout(resolve, delay);
         this.timeoutId.unref();
       });
-      if (this.stopped) {
+      if (!this.running) {
         return;
       }
       try {
-        await this.fetchToken();
+        await this.runFetch();
       } catch (error) {
         this.logger.error("Failed to refresh auth token", "error", error);
         await new Promise((resolve) => setTimeout(resolve, 5e3));
@@ -46721,20 +46763,23 @@ var AuthTokenManager = class {
    * Throws an error if the initial token fetch fails.
    */
   async start() {
-    this.initialTokenPromise = this.fetchToken();
+    if (this.running) {
+      return;
+    }
+    this.running = true;
     try {
-      await this.initialTokenPromise;
-    } finally {
-      this.initialTokenPromise = null;
+      await this.runFetch();
+    } catch (error) {
+      this.running = false;
+      throw error;
     }
-    this.stopped = false;
     this.backgroundRefresh();
   }
   /**
    * Stops the background refresh.
    */
   stop() {
-    this.stopped = true;
+    this.running = false;
     if (this.timeoutId) {
       clearTimeout(this.timeoutId);
       this.timeoutId = null;
@@ -46764,6 +46809,18 @@ var AuthTokenManager = class {
     const now = Math.floor(Date.now() / 1e3);
     return now >= this.tokenExpiry;
   }
+  runFetch() {
+    if (!this.fetchPromise) {
+      this.fetchPromise = (async () => {
+        try {
+          await this.fetchToken();
+        } finally {
+          this.fetchPromise = null;
+        }
+      })();
+    }
+    return this.fetchPromise;
+  }
   getCurrentToken() {
     return this.currentToken;
   }
@@ -46775,7 +46832,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.4" : "0.0.0";
+  return true ? "0.5.6" : "0.0.0";
 }
 
 // src/logger.ts
@@ -46885,8 +46942,9 @@ function createLogger(logger, logLevel = "") {
 }
 
 // src/client.ts
-var ModalClient = class {
+var ModalClient2 = class {
   apps;
+  cloudBucketMounts;
   cls;
   functions;
   functionCalls;
@@ -46926,6 +46984,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 +47218,7 @@ var defaultClient;
 var defaultClientOptions;
 function getDefaultClient() {
   if (!defaultClient) {
-    defaultClient = new ModalClient(defaultClientOptions);
+    defaultClient = new ModalClient2(defaultClientOptions);
   }
   return defaultClient;
 }
@@ -47174,7 +47233,7 @@ function initializeClient(options) {
     tokenSecret: options.tokenSecret,
     environment: options.environment
   };
-  defaultClient = new ModalClient(defaultClientOptions);
+  defaultClient = new ModalClient2(defaultClientOptions);
 }
 function close() {
   if (defaultClient) {
@@ -47215,7 +47274,7 @@ var AppService = class {
 };
 function parseGpuConfig(gpu) {
   if (!gpu) {
-    return void 0;
+    return GPUConfig.create({});
   }
   let gpuType = gpu;
   let count = 1;
@@ -47229,12 +47288,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 +47304,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 +47339,7 @@ var App2 = class {
   App,
   AppService,
   CloudBucketMount,
+  CloudBucketMountService,
   Cls,
   ClsInstance,
   ClsService,