modal 0.3.12 → 0.3.13

package/dist/index.cjs

@@ -48,6 +48,7 @@ __export(index_exports, {
   Sandbox: () => Sandbox2,
   SandboxFile: () => SandboxFile,
   Secret: () => Secret,
+  Volume: () => Volume,
   initializeClient: () => initializeClient
 });
 module.exports = __toCommonJS(index_exports);
@@ -38079,7 +38080,6 @@ async function fromRegistryInternal(appId, tag, imageRegistryConfig) {
       dockerfileCommands: [`FROM ${tag}`],
       imageRegistryConfig
     },
-    namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
     builderVersion: imageBuilderVersion()
   });
   let result;
@@ -38638,7 +38638,6 @@ var Secret = class _Secret {
     try {
       const resp = await client.secretGetOrCreate({
         deploymentName: name,
-        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options?.environment),
         requiredKeys: options?.requiredKeys ?? []
       });
@@ -38681,6 +38680,12 @@ var App = class _App {
         `Timeout must be a multiple of 1000ms, got ${options.timeout}`
       );
     }
+    const volumeMounts = options.volumes ? Object.entries(options.volumes).map(([mountPath, volume]) => ({
+      volumeId: volume.volumeId,
+      mountPath,
+      allowBackgroundCommits: true,
+      readOnly: false
+    })) : [];
     const createResp = await client.sandboxCreate({
       appId: this.appId,
       definition: {
@@ -38695,7 +38700,8 @@ var App = class _App {
           // https://modal.com/docs/guide/resources
           milliCpu: Math.round(1e3 * (options.cpu ?? 0.125)),
           memoryMb: options.memory ?? 128
-        }
+        },
+        volumeMounts
       }
     });
     return new Sandbox2(createResp.sandboxId);
@@ -39176,7 +39182,9 @@ var InputPlaneInvocation = class _InputPlaneInvocation {
   static async create(inputPlaneUrl, functionId, input) {
     const functionPutInputsItem = {
       idx: 0,
-      input
+      input,
+      r2Failed: false,
+      r2LatencyMs: 0
     };
     const client2 = getOrCreateInputPlaneClient(inputPlaneUrl);
     const attemptStartResponse = await client2.attemptStart({
@@ -39331,7 +39339,6 @@ var Function_ = class _Function_ {
       const resp = await client.functionGet({
         appName,
         objectTag: name,
-        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options.environment)
       });
       return new _Function_(
@@ -39438,11 +39445,13 @@ var Cls = class _Cls {
   #serviceFunctionId;
   #schema;
   #methodNames;
+  #inputPlaneUrl;
   /** @ignore */
-  constructor(serviceFunctionId, schema, methodNames) {
+  constructor(serviceFunctionId, schema, methodNames, inputPlaneUrl) {
     this.#serviceFunctionId = serviceFunctionId;
     this.#schema = schema;
     this.#methodNames = methodNames;
+    this.#inputPlaneUrl = inputPlaneUrl;
   }
   static async lookup(appName, name, options = {}) {
     try {
@@ -39450,7 +39459,6 @@ var Cls = class _Cls {
       const serviceFunction = await client.functionGet({
         appName,
         objectTag: serviceFunctionName,
-        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options.environment)
       });
       const parameterInfo = serviceFunction.handleMetadata?.classParameterInfo;
@@ -39470,7 +39478,12 @@ var Cls = class _Cls {
           "Cls requires Modal deployments using client v0.67 or later."
         );
       }
-      return new _Cls(serviceFunction.functionId, schema, methodNames);
+      return new _Cls(
+        serviceFunction.functionId,
+        schema,
+        methodNames,
+        serviceFunction.handleMetadata?.inputPlaneUrl
+      );
     } catch (err) {
       if (err instanceof import_nice_grpc5.ClientError && err.code === import_nice_grpc5.Status.NOT_FOUND)
         throw new NotFoundError(`Class '${appName}/${name}' not found`);
@@ -39487,7 +39500,7 @@ var Cls = class _Cls {
     }
     const methods = /* @__PURE__ */ new Map();
     for (const name of this.#methodNames) {
-      methods.set(name, new Function_(functionId, name));
+      methods.set(name, new Function_(functionId, name, this.#inputPlaneUrl));
     }
     return new ClsInstance(methods);
   }
@@ -39638,7 +39651,6 @@ var Queue = class _Queue {
     const resp = await client.queueGetOrCreate({
       deploymentName: name,
       objectCreationType: options.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : void 0,
-      namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
       environmentName: environmentName(options.environment)
     });
     return new _Queue(resp.queueId);
@@ -39816,6 +39828,30 @@ var Queue = class _Queue {
     }
   }
 };
+
+// src/volume.ts
+var import_nice_grpc7 = require("nice-grpc");
+var Volume = class _Volume {
+  volumeId;
+  /** @ignore */
+  constructor(volumeId) {
+    this.volumeId = volumeId;
+  }
+  static async fromName(name, options) {
+    try {
+      const resp = await client.volumeGetOrCreate({
+        deploymentName: name,
+        environmentName: environmentName(options?.environment),
+        objectCreationType: options?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
+      });
+      return new _Volume(resp.volumeId);
+    } catch (err) {
+      if (err instanceof import_nice_grpc7.ClientError && err.code === import_nice_grpc7.Status.NOT_FOUND)
+        throw new NotFoundError(err.details);
+      throw err;
+    }
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   App,
@@ -39836,5 +39872,6 @@ var Queue = class _Queue {
   Sandbox,
   SandboxFile,
   Secret,
+  Volume,
   initializeClient
 });

package/dist/index.d.cts

@@ -200,6 +200,19 @@ declare class Secret {
     static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
 }
 
+/** Options for `Volume.fromName()`. */
+type VolumeFromNameOptions = {
+    environment?: string;
+    createIfMissing?: boolean;
+};
+/** Volumes provide persistent storage that can be mounted in Modal functions. */
+declare class Volume {
+    readonly volumeId: string;
+    /** @ignore */
+    constructor(volumeId: string);
+    static fromName(name: string, options?: VolumeFromNameOptions): Promise<Volume>;
+}
+
 /** Options for functions that find deployed Modal objects. */
 type LookupOptions = {
     environment?: string;
@@ -226,6 +239,8 @@ type SandboxCreateOptions = {
      * Default behavior is to sleep indefinitely until timeout or termination.
      */
     command?: string[];
+    /** Mount points for Modal Volumes. */
+    volumes?: Record<string, Volume>;
 };
 /** Represents a deployed Modal App. */
 declare class App {
@@ -296,7 +311,7 @@ declare class Function_ {
 declare class Cls {
     #private;
     /** @ignore */
-    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[]);
+    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[], inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Cls>;
     /** Create a new instance of the Cls with parameters. */
     instance(params?: Record<string, any>): Promise<ClsInstance>;
@@ -437,4 +452,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-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 };
+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, Volume, type VolumeFromNameOptions, initializeClient };

package/dist/index.d.ts

@@ -200,6 +200,19 @@ declare class Secret {
     static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
 }
 
+/** Options for `Volume.fromName()`. */
+type VolumeFromNameOptions = {
+    environment?: string;
+    createIfMissing?: boolean;
+};
+/** Volumes provide persistent storage that can be mounted in Modal functions. */
+declare class Volume {
+    readonly volumeId: string;
+    /** @ignore */
+    constructor(volumeId: string);
+    static fromName(name: string, options?: VolumeFromNameOptions): Promise<Volume>;
+}
+
 /** Options for functions that find deployed Modal objects. */
 type LookupOptions = {
     environment?: string;
@@ -226,6 +239,8 @@ type SandboxCreateOptions = {
      * Default behavior is to sleep indefinitely until timeout or termination.
      */
     command?: string[];
+    /** Mount points for Modal Volumes. */
+    volumes?: Record<string, Volume>;
 };
 /** Represents a deployed Modal App. */
 declare class App {
@@ -296,7 +311,7 @@ declare class Function_ {
 declare class Cls {
     #private;
     /** @ignore */
-    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[]);
+    constructor(serviceFunctionId: string, schema: ClassParameterSpec[], methodNames: string[], inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Cls>;
     /** Create a new instance of the Cls with parameters. */
     instance(params?: Record<string, any>): Promise<ClsInstance>;
@@ -437,4 +452,4 @@ declare class Queue {
     iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>;
 }
 
-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 };
+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, Volume, type VolumeFromNameOptions, initializeClient };

package/dist/index.js

@@ -38031,7 +38031,6 @@ async function fromRegistryInternal(appId, tag, imageRegistryConfig) {
       dockerfileCommands: [`FROM ${tag}`],
       imageRegistryConfig
     },
-    namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
     builderVersion: imageBuilderVersion()
   });
   let result;
@@ -38590,7 +38589,6 @@ var Secret = class _Secret {
     try {
       const resp = await client.secretGetOrCreate({
         deploymentName: name,
-        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options?.environment),
         requiredKeys: options?.requiredKeys ?? []
       });
@@ -38633,6 +38631,12 @@ var App = class _App {
         `Timeout must be a multiple of 1000ms, got ${options.timeout}`
       );
     }
+    const volumeMounts = options.volumes ? Object.entries(options.volumes).map(([mountPath, volume]) => ({
+      volumeId: volume.volumeId,
+      mountPath,
+      allowBackgroundCommits: true,
+      readOnly: false
+    })) : [];
     const createResp = await client.sandboxCreate({
       appId: this.appId,
       definition: {
@@ -38647,7 +38651,8 @@ var App = class _App {
           // https://modal.com/docs/guide/resources
           milliCpu: Math.round(1e3 * (options.cpu ?? 0.125)),
           memoryMb: options.memory ?? 128
-        }
+        },
+        volumeMounts
       }
     });
     return new Sandbox2(createResp.sandboxId);
@@ -39128,7 +39133,9 @@ var InputPlaneInvocation = class _InputPlaneInvocation {
   static async create(inputPlaneUrl, functionId, input) {
     const functionPutInputsItem = {
       idx: 0,
-      input
+      input,
+      r2Failed: false,
+      r2LatencyMs: 0
     };
     const client2 = getOrCreateInputPlaneClient(inputPlaneUrl);
     const attemptStartResponse = await client2.attemptStart({
@@ -39283,7 +39290,6 @@ var Function_ = class _Function_ {
       const resp = await client.functionGet({
         appName,
         objectTag: name,
-        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options.environment)
       });
       return new _Function_(
@@ -39390,11 +39396,13 @@ var Cls = class _Cls {
   #serviceFunctionId;
   #schema;
   #methodNames;
+  #inputPlaneUrl;
   /** @ignore */
-  constructor(serviceFunctionId, schema, methodNames) {
+  constructor(serviceFunctionId, schema, methodNames, inputPlaneUrl) {
     this.#serviceFunctionId = serviceFunctionId;
     this.#schema = schema;
     this.#methodNames = methodNames;
+    this.#inputPlaneUrl = inputPlaneUrl;
   }
   static async lookup(appName, name, options = {}) {
     try {
@@ -39402,7 +39410,6 @@ var Cls = class _Cls {
       const serviceFunction = await client.functionGet({
         appName,
         objectTag: serviceFunctionName,
-        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options.environment)
       });
       const parameterInfo = serviceFunction.handleMetadata?.classParameterInfo;
@@ -39422,7 +39429,12 @@ var Cls = class _Cls {
           "Cls requires Modal deployments using client v0.67 or later."
         );
       }
-      return new _Cls(serviceFunction.functionId, schema, methodNames);
+      return new _Cls(
+        serviceFunction.functionId,
+        schema,
+        methodNames,
+        serviceFunction.handleMetadata?.inputPlaneUrl
+      );
     } catch (err) {
       if (err instanceof ClientError5 && err.code === Status5.NOT_FOUND)
         throw new NotFoundError(`Class '${appName}/${name}' not found`);
@@ -39439,7 +39451,7 @@ var Cls = class _Cls {
     }
     const methods = /* @__PURE__ */ new Map();
     for (const name of this.#methodNames) {
-      methods.set(name, new Function_(functionId, name));
+      methods.set(name, new Function_(functionId, name, this.#inputPlaneUrl));
     }
     return new ClsInstance(methods);
   }
@@ -39590,7 +39602,6 @@ var Queue = class _Queue {
     const resp = await client.queueGetOrCreate({
       deploymentName: name,
       objectCreationType: options.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : void 0,
-      namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
       environmentName: environmentName(options.environment)
     });
     return new _Queue(resp.queueId);
@@ -39768,6 +39779,30 @@ var Queue = class _Queue {
     }
   }
 };
+
+// src/volume.ts
+import { ClientError as ClientError7, Status as Status7 } from "nice-grpc";
+var Volume = class _Volume {
+  volumeId;
+  /** @ignore */
+  constructor(volumeId) {
+    this.volumeId = volumeId;
+  }
+  static async fromName(name, options) {
+    try {
+      const resp = await client.volumeGetOrCreate({
+        deploymentName: name,
+        environmentName: environmentName(options?.environment),
+        objectCreationType: options?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
+      });
+      return new _Volume(resp.volumeId);
+    } catch (err) {
+      if (err instanceof ClientError7 && err.code === Status7.NOT_FOUND)
+        throw new NotFoundError(err.details);
+      throw err;
+    }
+  }
+};
 export {
   App,
   Cls,
@@ -39787,5 +39822,6 @@ export {
   Sandbox2 as Sandbox,
   SandboxFile,
   Secret,
+  Volume,
   initializeClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modal",
-  "version": "0.3.12",
+  "version": "0.3.13",
   "description": "Modal client library for JavaScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs",