modal 0.3.9 → 0.3.11

package/dist/index.cjs

@@ -47,7 +47,8 @@ __export(index_exports, {
   RemoteError: () => RemoteError,
   Sandbox: () => Sandbox2,
   SandboxFile: () => SandboxFile,
-  Secret: () => Secret
+  Secret: () => Secret,
+  initializeClient: () => initializeClient
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -37858,12 +37859,11 @@ function readConfigFile() {
     if (err.code === "ENOENT") {
       return {};
     }
-    throw new Error(`Failed to read or parse .modal.toml: ${err.message}`);
+    return {};
   }
 }
 var config = readConfigFile();
 function getProfile(profileName) {
-  profileName = profileName || process.env["MODAL_PROFILE"] || void 0;
   if (!profileName) {
     for (const [name, profileData2] of Object.entries(config)) {
       if (profileData2.active) {
@@ -37872,45 +37872,41 @@ function getProfile(profileName) {
       }
     }
   }
-  if (profileName && !Object.hasOwn(config, profileName)) {
-    throw new Error(
-      `Profile "${profileName}" not found in .modal.toml. Please set the MODAL_PROFILE environment variable or specify a valid profile.`
-    );
-  }
-  const profileData = profileName ? config[profileName] : {};
-  const profile2 = {
+  const profileData = profileName && Object.hasOwn(config, profileName) ? config[profileName] : {};
+  const profile = {
     serverUrl: process.env["MODAL_SERVER_URL"] || profileData.server_url || "https://api.modal.com:443",
     tokenId: process.env["MODAL_TOKEN_ID"] || profileData.token_id,
     tokenSecret: process.env["MODAL_TOKEN_SECRET"] || profileData.token_secret,
     environment: process.env["MODAL_ENVIRONMENT"] || profileData.environment,
     imageBuilderVersion: process.env["MODAL_IMAGE_BUILDER_VERSION"] || profileData.imageBuilderVersion
   };
-  if (!profile2.tokenId || !profile2.tokenSecret) {
-    throw new Error(
-      `Profile "${profileName}" is missing token_id or token_secret. Please set them in .modal.toml or as environment variables.`
-    );
-  }
-  return profile2;
+  return profile;
 }
-var profile = getProfile(process.env["MODAL_PROFILE"] || void 0);
 function environmentName(environment) {
-  return environment || profile.environment || "";
+  return environment || clientProfile.environment || "";
 }
 function imageBuilderVersion(version) {
-  return version || profile.imageBuilderVersion || "2024.10";
+  return version || clientProfile.imageBuilderVersion || "2024.10";
 }
 
 // src/client.ts
-function authMiddleware(profile2) {
+var defaultProfile = getProfile(process.env["MODAL_PROFILE"]);
+function authMiddleware(profile) {
   return async function* authMiddleware2(call, options) {
+    if (!profile.tokenId || !profile.tokenSecret) {
+      throw new Error(
+        `Profile is missing token_id or token_secret. Please set them in .modal.toml, or as environment variables, or initializeClient().`
+      );
+    }
+    const { tokenId, tokenSecret } = profile;
     options.metadata ??= new import_nice_grpc.Metadata();
     options.metadata.set(
       "x-modal-client-type",
       String(7 /* CLIENT_TYPE_LIBMODAL */)
     );
     options.metadata.set("x-modal-client-version", "1.0.0");
-    options.metadata.set("x-modal-token-id", profile2.tokenId);
-    options.metadata.set("x-modal-token-secret", profile2.tokenSecret);
+    options.metadata.set("x-modal-token-id", tokenId);
+    options.metadata.set("x-modal-token-secret", tokenSecret);
     return yield* call.next(call.request, options);
   };
 }
@@ -38016,12 +38012,26 @@ var retryMiddleware = async function* retryMiddleware2(call, options) {
     }
   }
 };
-var channel = (0, import_nice_grpc.createChannel)(profile.serverUrl, void 0, {
-  "grpc.max_receive_message_length": 100 * 1024 * 1024,
-  "grpc.max_send_message_length": 100 * 1024 * 1024,
-  "grpc-node.flow_control_window": 64 * 1024 * 1024
-});
-var client = (0, import_nice_grpc.createClientFactory)().use(authMiddleware(profile)).use(retryMiddleware).use(timeoutMiddleware).create(ModalClientDefinition, channel);
+function createClient(profile) {
+  const channel = (0, import_nice_grpc.createChannel)(profile.serverUrl, void 0, {
+    "grpc.max_receive_message_length": 100 * 1024 * 1024,
+    "grpc.max_send_message_length": 100 * 1024 * 1024,
+    "grpc-node.flow_control_window": 64 * 1024 * 1024
+  });
+  return (0, import_nice_grpc.createClientFactory)().use(authMiddleware(profile)).use(retryMiddleware).use(timeoutMiddleware).create(ModalClientDefinition, channel);
+}
+var clientProfile = defaultProfile;
+var client = createClient(clientProfile);
+function initializeClient(options) {
+  const mergedProfile = {
+    ...defaultProfile,
+    tokenId: options.tokenId,
+    tokenSecret: options.tokenSecret,
+    environment: options.environment || defaultProfile.environment
+  };
+  clientProfile = mergedProfile;
+  client = createClient(mergedProfile);
+}
 
 // src/image.ts
 var Image2 = class {
@@ -38391,7 +38401,9 @@ var Sandbox2 = class {
     const taskId = await this.#getTaskId();
     const resp = await client.containerExec({
       taskId,
-      command
+      command,
+      workdir: options?.workdir,
+      timeoutSecs: options?.timeout ? options.timeout / 1e3 : 0
     });
     return new ContainerProcess(resp.execId, options);
   }
@@ -39700,5 +39712,6 @@ var Queue = class _Queue {
   RemoteError,
   Sandbox,
   SandboxFile,
-  Secret
+  Secret,
+  initializeClient
 });

package/dist/index.d.cts

@@ -139,9 +139,16 @@ type StdioBehavior = "pipe" | "ignore";
 type StreamMode = "text" | "binary";
 /** Options to configure a `Sandbox.exec()` operation. */
 type ExecOptions = {
+    /** Specifies text or binary encoding for input and output streams. */
     mode?: StreamMode;
+    /** Whether to pipe or ignore standard output. */
     stdout?: StdioBehavior;
+    /** Whether to pipe or ignore standard error. */
     stderr?: StdioBehavior;
+    /** Working directory to run the command in. */
+    workdir?: string;
+    /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
+    timeout?: number;
 };
 /** Sandboxes are secure, isolated containers in Modal that boot in seconds. */
 declare class Sandbox {
@@ -232,6 +239,20 @@ declare class App {
     imageFromAwsEcr(tag: string, secret: Secret): Promise<Image>;
 }
 
+/** Options for initializing a client at runtime. */
+type ClientOptions = {
+    tokenId: string;
+    tokenSecret: string;
+    environment?: string;
+};
+/**
+ * Initialize the Modal client, passing in token authentication credentials.
+ *
+ * You should call this function at the start of your application if not
+ * configuring Modal with a `.modal.toml` file or environment variables.
+ */
+declare function initializeClient(options: ClientOptions): void;
+
 /** Options for `FunctionCall.get()`. */
 type FunctionCallGetOptions = {
     timeout?: number;
@@ -414,4 +435,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-export { App, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode };
+export { App, type ClientOptions, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, initializeClient };

package/dist/index.d.ts

@@ -139,9 +139,16 @@ type StdioBehavior = "pipe" | "ignore";
 type StreamMode = "text" | "binary";
 /** Options to configure a `Sandbox.exec()` operation. */
 type ExecOptions = {
+    /** Specifies text or binary encoding for input and output streams. */
     mode?: StreamMode;
+    /** Whether to pipe or ignore standard output. */
     stdout?: StdioBehavior;
+    /** Whether to pipe or ignore standard error. */
     stderr?: StdioBehavior;
+    /** Working directory to run the command in. */
+    workdir?: string;
+    /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
+    timeout?: number;
 };
 /** Sandboxes are secure, isolated containers in Modal that boot in seconds. */
 declare class Sandbox {
@@ -232,6 +239,20 @@ declare class App {
     imageFromAwsEcr(tag: string, secret: Secret): Promise<Image>;
 }
 
+/** Options for initializing a client at runtime. */
+type ClientOptions = {
+    tokenId: string;
+    tokenSecret: string;
+    environment?: string;
+};
+/**
+ * Initialize the Modal client, passing in token authentication credentials.
+ *
+ * You should call this function at the start of your application if not
+ * configuring Modal with a `.modal.toml` file or environment variables.
+ */
+declare function initializeClient(options: ClientOptions): void;
+
 /** Options for `FunctionCall.get()`. */
 type FunctionCallGetOptions = {
     timeout?: number;
@@ -414,4 +435,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-export { App, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode };
+export { App, type ClientOptions, Cls, ClsInstance, ContainerProcess, type DeleteOptions, type EphemeralOptions, type ExecOptions, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, InvalidError, type LookupOptions, type ModalReadStream, type ModalWriteStream, NotFoundError, Queue, type QueueClearOptions, QueueEmptyError, QueueFullError, type QueueGetOptions, type QueueIterateOptions, type QueueLenOptions, type QueuePutOptions, RemoteError, Sandbox, type SandboxCreateOptions, SandboxFile, type SandboxFileMode, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode, initializeClient };

package/dist/index.js

@@ -37811,12 +37811,11 @@ function readConfigFile() {
     if (err.code === "ENOENT") {
       return {};
     }
-    throw new Error(`Failed to read or parse .modal.toml: ${err.message}`);
+    return {};
   }
 }
 var config = readConfigFile();
 function getProfile(profileName) {
-  profileName = profileName || process.env["MODAL_PROFILE"] || void 0;
   if (!profileName) {
     for (const [name, profileData2] of Object.entries(config)) {
       if (profileData2.active) {
@@ -37825,45 +37824,41 @@ function getProfile(profileName) {
       }
     }
   }
-  if (profileName && !Object.hasOwn(config, profileName)) {
-    throw new Error(
-      `Profile "${profileName}" not found in .modal.toml. Please set the MODAL_PROFILE environment variable or specify a valid profile.`
-    );
-  }
-  const profileData = profileName ? config[profileName] : {};
-  const profile2 = {
+  const profileData = profileName && Object.hasOwn(config, profileName) ? config[profileName] : {};
+  const profile = {
     serverUrl: process.env["MODAL_SERVER_URL"] || profileData.server_url || "https://api.modal.com:443",
     tokenId: process.env["MODAL_TOKEN_ID"] || profileData.token_id,
     tokenSecret: process.env["MODAL_TOKEN_SECRET"] || profileData.token_secret,
     environment: process.env["MODAL_ENVIRONMENT"] || profileData.environment,
     imageBuilderVersion: process.env["MODAL_IMAGE_BUILDER_VERSION"] || profileData.imageBuilderVersion
   };
-  if (!profile2.tokenId || !profile2.tokenSecret) {
-    throw new Error(
-      `Profile "${profileName}" is missing token_id or token_secret. Please set them in .modal.toml or as environment variables.`
-    );
-  }
-  return profile2;
+  return profile;
 }
-var profile = getProfile(process.env["MODAL_PROFILE"] || void 0);
 function environmentName(environment) {
-  return environment || profile.environment || "";
+  return environment || clientProfile.environment || "";
 }
 function imageBuilderVersion(version) {
-  return version || profile.imageBuilderVersion || "2024.10";
+  return version || clientProfile.imageBuilderVersion || "2024.10";
 }
 
 // src/client.ts
-function authMiddleware(profile2) {
+var defaultProfile = getProfile(process.env["MODAL_PROFILE"]);
+function authMiddleware(profile) {
   return async function* authMiddleware2(call, options) {
+    if (!profile.tokenId || !profile.tokenSecret) {
+      throw new Error(
+        `Profile is missing token_id or token_secret. Please set them in .modal.toml, or as environment variables, or initializeClient().`
+      );
+    }
+    const { tokenId, tokenSecret } = profile;
     options.metadata ??= new Metadata();
     options.metadata.set(
       "x-modal-client-type",
       String(7 /* CLIENT_TYPE_LIBMODAL */)
     );
     options.metadata.set("x-modal-client-version", "1.0.0");
-    options.metadata.set("x-modal-token-id", profile2.tokenId);
-    options.metadata.set("x-modal-token-secret", profile2.tokenSecret);
+    options.metadata.set("x-modal-token-id", tokenId);
+    options.metadata.set("x-modal-token-secret", tokenSecret);
     return yield* call.next(call.request, options);
   };
 }
@@ -37969,12 +37964,26 @@ var retryMiddleware = async function* retryMiddleware2(call, options) {
     }
   }
 };
-var channel = createChannel(profile.serverUrl, void 0, {
-  "grpc.max_receive_message_length": 100 * 1024 * 1024,
-  "grpc.max_send_message_length": 100 * 1024 * 1024,
-  "grpc-node.flow_control_window": 64 * 1024 * 1024
-});
-var client = createClientFactory().use(authMiddleware(profile)).use(retryMiddleware).use(timeoutMiddleware).create(ModalClientDefinition, channel);
+function createClient(profile) {
+  const channel = createChannel(profile.serverUrl, void 0, {
+    "grpc.max_receive_message_length": 100 * 1024 * 1024,
+    "grpc.max_send_message_length": 100 * 1024 * 1024,
+    "grpc-node.flow_control_window": 64 * 1024 * 1024
+  });
+  return createClientFactory().use(authMiddleware(profile)).use(retryMiddleware).use(timeoutMiddleware).create(ModalClientDefinition, channel);
+}
+var clientProfile = defaultProfile;
+var client = createClient(clientProfile);
+function initializeClient(options) {
+  const mergedProfile = {
+    ...defaultProfile,
+    tokenId: options.tokenId,
+    tokenSecret: options.tokenSecret,
+    environment: options.environment || defaultProfile.environment
+  };
+  clientProfile = mergedProfile;
+  client = createClient(mergedProfile);
+}
 
 // src/image.ts
 var Image2 = class {
@@ -38344,7 +38353,9 @@ var Sandbox2 = class {
     const taskId = await this.#getTaskId();
     const resp = await client.containerExec({
       taskId,
-      command
+      command,
+      workdir: options?.workdir,
+      timeoutSecs: options?.timeout ? options.timeout / 1e3 : 0
     });
     return new ContainerProcess(resp.execId, options);
   }
@@ -39652,5 +39663,6 @@ export {
   RemoteError,
   Sandbox2 as Sandbox,
   SandboxFile,
-  Secret
+  Secret,
+  initializeClient
 };

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "modal",
-  "version": "0.3.9",
+  "version": "0.3.11",
   "description": "Modal client library for JavaScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs",
-  "repository": "github:modal-labs/libmodal",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/modal-labs/libmodal.git"
+  },
   "bugs": "https://github.com/modal-labs/libmodal/issues",
   "type": "module",
   "sideEffects": false,
@@ -30,9 +33,9 @@
     "lint": "eslint",
     "prepare": "scripts/gen-proto.sh",
     "test": "vitest",
-    "preversion": "(git update-index --really-refresh && git diff-index --quiet HEAD) || (echo 'You must commit all changes before running npm version' && exit 1)",
-    "version": "npm run build && git add package.json package-lock.json && git commit -m \"modal-js/v$npm_package_version\" && git tag modal-js/v$npm_package_version",
-    "postversion": "git push && git push --tags && npm publish"
+    "version": "npm run check && git add -A && git commit -m \"modal-js/v$npm_package_version\"",
+    "prepublishOnly": "npm run build && git push",
+    "postpublish": "git tag modal-js/v$npm_package_version && git push --tags"
   },
   "dependencies": {
     "long": "^5.3.1",