modal 0.5.3 → 0.5.5

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";
 
@@ -43902,6 +43985,33 @@ var SecretService = class {
       throw err;
     }
   }
+  /**
+   * Delete a named {@link Secret}.
+   *
+   * Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
+   */
+  async delete(name, params) {
+    try {
+      const secret = await this.fromName(name, {
+        environment: params?.environment
+      });
+      await this.#client.cpClient.secretDelete({
+        secretId: secret.secretId
+      });
+      this.#client.logger.debug(
+        "Deleted Secret",
+        "secret_name",
+        name,
+        "secret_id",
+        secret.secretId
+      );
+    } catch (err) {
+      if (err instanceof NotFoundError && params?.allowMissing) {
+        return;
+      }
+      throw err;
+    }
+  }
 };
 var Secret = class {
   secretId;
@@ -44130,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;
   }
@@ -45061,26 +45172,51 @@ var QueueService = class {
    * Reference a {@link Queue} by name.
    */
   async fromName(name, params = {}) {
-    const resp = await this.#client.cpClient.queueGetOrCreate({
-      deploymentName: name,
-      objectCreationType: params.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : void 0,
-      environmentName: this.#client.environmentName(params.environment)
-    });
-    this.#client.logger.debug(
-      "Retrieved Queue",
-      "queue_id",
-      resp.queueId,
-      "queue_name",
-      name
-    );
-    return new Queue(this.#client, resp.queueId, name);
+    try {
+      const resp = await this.#client.cpClient.queueGetOrCreate({
+        deploymentName: name,
+        objectCreationType: params.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : void 0,
+        environmentName: this.#client.environmentName(params.environment)
+      });
+      this.#client.logger.debug(
+        "Retrieved Queue",
+        "queue_id",
+        resp.queueId,
+        "queue_name",
+        name
+      );
+      return new Queue(this.#client, resp.queueId, name);
+    } catch (err) {
+      if (err instanceof ClientError6 && err.code === Status6.NOT_FOUND)
+        throw new NotFoundError(err.details);
+      throw err;
+    }
   }
   /**
    * Delete a {@link Queue} by name.
+   *
+   * Warning: Deletion is irreversible and will affect any Apps currently using the Queue.
    */
   async delete(name, params = {}) {
-    const queue = await this.fromName(name, params);
-    await this.#client.cpClient.queueDelete({ queueId: queue.queueId });
+    try {
+      const queue = await this.fromName(name, {
+        environment: params.environment,
+        createIfMissing: false
+      });
+      await this.#client.cpClient.queueDelete({ queueId: queue.queueId });
+      this.#client.logger.debug(
+        "Deleted Queue",
+        "queue_name",
+        name,
+        "queue_id",
+        queue.queueId
+      );
+    } catch (err) {
+      if (err instanceof NotFoundError && params.allowMissing) {
+        return;
+      }
+      throw err;
+    }
   }
 };
 var Queue = class _Queue {
@@ -45528,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, {
@@ -45619,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);
@@ -45670,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();
@@ -45729,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,
@@ -46398,6 +46478,34 @@ var VolumeService = class {
     );
     return new Volume(resp.volumeId, void 0, false, ephemeralHbManager);
   }
+  /**
+   * Delete a named {@link Volume}.
+   *
+   * Warning: Deletion is irreversible and will affect any Apps currently using the Volume.
+   */
+  async delete(name, params) {
+    try {
+      const volume = await this.fromName(name, {
+        environment: params?.environment,
+        createIfMissing: false
+      });
+      await this.#client.cpClient.volumeDelete({
+        volumeId: volume.volumeId
+      });
+      this.#client.logger.debug(
+        "Deleted Volume",
+        "volume_name",
+        name,
+        "volume_id",
+        volume.volumeId
+      );
+    } catch (err) {
+      if (err instanceof NotFoundError && params?.allowMissing) {
+        return;
+      }
+      throw err;
+    }
+  }
 };
 var Volume = class _Volume {
   volumeId;
@@ -46628,7 +46736,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.3" : "0.0.0";
+  return true ? "0.5.5" : "0.0.0";
 }
 
 // src/logger.ts
@@ -46738,8 +46846,9 @@ function createLogger(logger, logLevel = "") {
 }
 
 // src/client.ts
-var ModalClient = class {
+var ModalClient2 = class {
   apps;
+  cloudBucketMounts;
   cls;
   functions;
   functionCalls;
@@ -46779,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);
@@ -47012,7 +47122,7 @@ var defaultClient;
 var defaultClientOptions;
 function getDefaultClient() {
   if (!defaultClient) {
-    defaultClient = new ModalClient(defaultClientOptions);
+    defaultClient = new ModalClient2(defaultClientOptions);
   }
   return defaultClient;
 }
@@ -47027,7 +47137,7 @@ function initializeClient(options) {
     tokenSecret: options.tokenSecret,
     environment: options.environment
   };
-  defaultClient = new ModalClient(defaultClientOptions);
+  defaultClient = new ModalClient2(defaultClientOptions);
 }
 function close() {
   if (defaultClient) {
@@ -47068,7 +47178,7 @@ var AppService = class {
 };
 function parseGpuConfig(gpu) {
   if (!gpu) {
-    return void 0;
+    return GPUConfig.create({});
   }
   let gpuType = gpu;
   let count = 1;
@@ -47082,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;
@@ -47100,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);
   }
@@ -47133,6 +47242,7 @@ export {
   App2 as App,
   AppService,
   CloudBucketMount2 as CloudBucketMount,
+  CloudBucketMountService,
   Cls,
   ClsInstance,
   ClsService,
@@ -47146,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.3",
+  "version": "0.5.5",
   "description": "Modal SDK for JavaScript/TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs/guide/sdk-javascript-go",