modal 0.5.5 → 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

@@ -46227,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;
@@ -46672,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");
   }
   /**
@@ -46726,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;
@@ -46734,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));
@@ -46750,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;
@@ -46793,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;
   }
@@ -46804,7 +46832,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.5" : "0.0.0";
+  return true ? "0.5.6" : "0.0.0";
 }
 
 // src/logger.ts

package/dist/index.d.cts

@@ -5824,6 +5824,16 @@ type SandboxExecParams = {
     /** Enable a PTY for the command. */
     pty?: boolean;
 };
+/** Optional parameters for {@link Sandbox#createConnectToken Sandbox.createConnectToken()}. */
+type SandboxCreateConnectTokenParams = {
+    /** Optional user-provided metadata string that will be added to the headers by the proxy when forwarding requests to the Sandbox. */
+    userMetadata?: string;
+};
+/** Credentials returned by {@link Sandbox#createConnectToken Sandbox.createConnectToken()}. */
+type SandboxCreateConnectCredentials = {
+    url: string;
+    token: string;
+};
 /** A port forwarded from within a running Modal {@link Sandbox}. */
 declare class Tunnel {
     host: string;
@@ -5873,6 +5883,10 @@ declare class Sandbox {
     exec(command: string[], params: SandboxExecParams & {
         mode: "binary";
     }): Promise<ContainerProcess<Uint8Array>>;
+    /**
+     * Create a token for making HTTP connections to the Sandbox.
+     */
+    createConnectToken(params?: SandboxCreateConnectTokenParams): Promise<SandboxCreateConnectCredentials>;
     terminate(): Promise<void>;
     wait(): Promise<number>;
     /** Get {@link Tunnel} metadata for the Sandbox.
@@ -6139,4 +6153,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, 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 };
+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 SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, 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

@@ -5824,6 +5824,16 @@ type SandboxExecParams = {
     /** Enable a PTY for the command. */
     pty?: boolean;
 };
+/** Optional parameters for {@link Sandbox#createConnectToken Sandbox.createConnectToken()}. */
+type SandboxCreateConnectTokenParams = {
+    /** Optional user-provided metadata string that will be added to the headers by the proxy when forwarding requests to the Sandbox. */
+    userMetadata?: string;
+};
+/** Credentials returned by {@link Sandbox#createConnectToken Sandbox.createConnectToken()}. */
+type SandboxCreateConnectCredentials = {
+    url: string;
+    token: string;
+};
 /** A port forwarded from within a running Modal {@link Sandbox}. */
 declare class Tunnel {
     host: string;
@@ -5873,6 +5883,10 @@ declare class Sandbox {
     exec(command: string[], params: SandboxExecParams & {
         mode: "binary";
     }): Promise<ContainerProcess<Uint8Array>>;
+    /**
+     * Create a token for making HTTP connections to the Sandbox.
+     */
+    createConnectToken(params?: SandboxCreateConnectTokenParams): Promise<SandboxCreateConnectCredentials>;
     terminate(): Promise<void>;
     wait(): Promise<number>;
     /** Get {@link Tunnel} metadata for the Sandbox.
@@ -6139,4 +6153,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, 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 };
+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 SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, 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

@@ -46159,6 +46159,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;
@@ -46604,24 +46614,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");
   }
   /**
@@ -46658,7 +46671,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;
@@ -46666,11 +46679,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));
@@ -46682,20 +46695,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;
@@ -46725,6 +46741,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;
   }
@@ -46736,7 +46764,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.5" : "0.0.0";
+  return true ? "0.5.6" : "0.0.0";
 }
 
 // src/logger.ts

package/package.json

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