modal 0.8.1 → 0.8.2

package/README.md

@@ -61,6 +61,7 @@ We also provide a number of examples:
   and same but
   [with an ephemeral Volume](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-volume-ephemeral.ts)
 - [Mount a cloud bucket to a Sandbox](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-cloud-bucket.ts)
+- [Update the outbound network policy of a running Sandbox](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-network-policy.ts)
 - [Eagerly build an Image for a Sandbox](https://github.com/modal-labs/modal-client/blob/main/js/examples/sandbox-prewarm.ts)
 - [Building custom Images](https://github.com/modal-labs/modal-client/blob/main/js/examples/image-building.ts)
 - [Add telemetry and tracing with custom middleware](https://github.com/modal-labs/modal-client/blob/main/js/examples/telemetry.ts)

package/dist/index.cjs

@@ -13486,13 +13486,16 @@ var ContainerReloadVolumesResponse = {
   }
 };
 function createBaseContainerStopRequest() {
-  return { taskId: "" };
+  return { taskId: "", graceful: false };
 }
 var ContainerStopRequest = {
   encode(message, writer = new BinaryWriter()) {
     if (message.taskId !== "") {
       writer.uint32(10).string(message.taskId);
     }
+    if (message.graceful !== false) {
+      writer.uint32(16).bool(message.graceful);
+    }
     return writer;
   },
   decode(input, length) {
@@ -13509,6 +13512,13 @@ var ContainerStopRequest = {
           message.taskId = reader.string();
           continue;
         }
+        case 2: {
+          if (tag !== 16) {
+            break;
+          }
+          message.graceful = reader.bool();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -13518,13 +13528,19 @@ var ContainerStopRequest = {
     return message;
   },
   fromJSON(object) {
-    return { taskId: isSet5(object.taskId) ? globalThis.String(object.taskId) : "" };
+    return {
+      taskId: isSet5(object.taskId) ? globalThis.String(object.taskId) : "",
+      graceful: isSet5(object.graceful) ? globalThis.Boolean(object.graceful) : false
+    };
   },
   toJSON(message) {
     const obj = {};
     if (message.taskId !== "") {
       obj.taskId = message.taskId;
     }
+    if (message.graceful !== false) {
+      obj.graceful = message.graceful;
+    }
     return obj;
   },
   create(base) {
@@ -13533,6 +13549,7 @@ var ContainerStopRequest = {
   fromPartial(object) {
     const message = createBaseContainerStopRequest();
     message.taskId = object.taskId ?? "";
+    message.graceful = object.graceful ?? false;
     return message;
   }
 };
@@ -26043,7 +26060,8 @@ function createBaseFunctionOptions() {
     cloudProviderStr: void 0,
     replaceCloudBucketMounts: false,
     cloudBucketMounts: [],
-    pinnedAppVersion: void 0
+    pinnedAppVersion: void 0,
+    routingRegion: void 0
   };
 }
 var FunctionOptions = {
@@ -26111,6 +26129,9 @@ var FunctionOptions = {
     if (message.pinnedAppVersion !== void 0) {
       writer.uint32(168).int32(message.pinnedAppVersion);
     }
+    if (message.routingRegion !== void 0) {
+      writer.uint32(178).string(message.routingRegion);
+    }
     return writer;
   },
   decode(input, length) {
@@ -26267,6 +26288,13 @@ var FunctionOptions = {
           message.pinnedAppVersion = reader.int32();
           continue;
         }
+        case 22: {
+          if (tag !== 178) {
+            break;
+          }
+          message.routingRegion = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -26297,7 +26325,8 @@ var FunctionOptions = {
       cloudProviderStr: isSet5(object.cloudProviderStr) ? globalThis.String(object.cloudProviderStr) : void 0,
       replaceCloudBucketMounts: isSet5(object.replaceCloudBucketMounts) ? globalThis.Boolean(object.replaceCloudBucketMounts) : false,
       cloudBucketMounts: globalThis.Array.isArray(object?.cloudBucketMounts) ? object.cloudBucketMounts.map((e) => CloudBucketMount.fromJSON(e)) : [],
-      pinnedAppVersion: isSet5(object.pinnedAppVersion) ? globalThis.Number(object.pinnedAppVersion) : void 0
+      pinnedAppVersion: isSet5(object.pinnedAppVersion) ? globalThis.Number(object.pinnedAppVersion) : void 0,
+      routingRegion: isSet5(object.routingRegion) ? globalThis.String(object.routingRegion) : void 0
     };
   },
   toJSON(message) {
@@ -26365,6 +26394,9 @@ var FunctionOptions = {
     if (message.pinnedAppVersion !== void 0) {
       obj.pinnedAppVersion = Math.round(message.pinnedAppVersion);
     }
+    if (message.routingRegion !== void 0) {
+      obj.routingRegion = message.routingRegion;
+    }
     return obj;
   },
   create(base) {
@@ -26393,6 +26425,7 @@ var FunctionOptions = {
     message.replaceCloudBucketMounts = object.replaceCloudBucketMounts ?? false;
     message.cloudBucketMounts = object.cloudBucketMounts?.map((e) => CloudBucketMount.fromPartial(e)) || [];
     message.pinnedAppVersion = object.pinnedAppVersion ?? void 0;
+    message.routingRegion = object.routingRegion ?? void 0;
     return message;
   }
 };
@@ -30426,7 +30459,7 @@ var ImageRegistryConfig = {
   }
 };
 function createBaseImageTagRevisionsItem() {
-  return { imageId: "", revisionId: "", createdAt: 0 };
+  return { imageId: "", revisionId: "", createdAt: 0, publishedBy: "" };
 }
 var ImageTagRevisionsItem = {
   encode(message, writer = new BinaryWriter()) {
@@ -30439,6 +30472,9 @@ var ImageTagRevisionsItem = {
     if (message.createdAt !== 0) {
       writer.uint32(25).double(message.createdAt);
     }
+    if (message.publishedBy !== "") {
+      writer.uint32(34).string(message.publishedBy);
+    }
     return writer;
   },
   decode(input, length) {
@@ -30469,6 +30505,13 @@ var ImageTagRevisionsItem = {
           message.createdAt = reader.double();
           continue;
         }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+          message.publishedBy = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -30481,7 +30524,8 @@ var ImageTagRevisionsItem = {
     return {
       imageId: isSet5(object.imageId) ? globalThis.String(object.imageId) : "",
       revisionId: isSet5(object.revisionId) ? globalThis.String(object.revisionId) : "",
-      createdAt: isSet5(object.createdAt) ? globalThis.Number(object.createdAt) : 0
+      createdAt: isSet5(object.createdAt) ? globalThis.Number(object.createdAt) : 0,
+      publishedBy: isSet5(object.publishedBy) ? globalThis.String(object.publishedBy) : ""
     };
   },
   toJSON(message) {
@@ -30495,6 +30539,9 @@ var ImageTagRevisionsItem = {
     if (message.createdAt !== 0) {
       obj.createdAt = message.createdAt;
     }
+    if (message.publishedBy !== "") {
+      obj.publishedBy = message.publishedBy;
+    }
     return obj;
   },
   create(base) {
@@ -30505,6 +30552,7 @@ var ImageTagRevisionsItem = {
     message.imageId = object.imageId ?? "";
     message.revisionId = object.revisionId ?? "";
     message.createdAt = object.createdAt ?? 0;
+    message.publishedBy = object.publishedBy ?? "";
     return message;
   }
 };
@@ -51444,6 +51492,231 @@ var WorkspaceNameLookupResponse = {
     return message;
   }
 };
+function createBaseWorkspaceSetDefaultEnvironmentRequest() {
+  return { environmentName: "" };
+}
+var WorkspaceSetDefaultEnvironmentRequest = {
+  encode(message, writer = new BinaryWriter()) {
+    if (message.environmentName !== "") {
+      writer.uint32(10).string(message.environmentName);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseWorkspaceSetDefaultEnvironmentRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.environmentName = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return { environmentName: isSet5(object.environmentName) ? globalThis.String(object.environmentName) : "" };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.environmentName !== "") {
+      obj.environmentName = message.environmentName;
+    }
+    return obj;
+  },
+  create(base) {
+    return WorkspaceSetDefaultEnvironmentRequest.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseWorkspaceSetDefaultEnvironmentRequest();
+    message.environmentName = object.environmentName ?? "";
+    return message;
+  }
+};
+function createBaseWorkspaceSetImageBuilderVersionRequest() {
+  return { newImageBuilderVersion: "" };
+}
+var WorkspaceSetImageBuilderVersionRequest = {
+  encode(message, writer = new BinaryWriter()) {
+    if (message.newImageBuilderVersion !== "") {
+      writer.uint32(10).string(message.newImageBuilderVersion);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseWorkspaceSetImageBuilderVersionRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.newImageBuilderVersion = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return {
+      newImageBuilderVersion: isSet5(object.newImageBuilderVersion) ? globalThis.String(object.newImageBuilderVersion) : ""
+    };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.newImageBuilderVersion !== "") {
+      obj.newImageBuilderVersion = message.newImageBuilderVersion;
+    }
+    return obj;
+  },
+  create(base) {
+    return WorkspaceSetImageBuilderVersionRequest.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseWorkspaceSetImageBuilderVersionRequest();
+    message.newImageBuilderVersion = object.newImageBuilderVersion ?? "";
+    return message;
+  }
+};
+function createBaseWorkspaceSetImageBuilderVersionResponse() {
+  return { imageBuilderVersion: "" };
+}
+var WorkspaceSetImageBuilderVersionResponse = {
+  encode(message, writer = new BinaryWriter()) {
+    if (message.imageBuilderVersion !== "") {
+      writer.uint32(10).string(message.imageBuilderVersion);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseWorkspaceSetImageBuilderVersionResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.imageBuilderVersion = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return {
+      imageBuilderVersion: isSet5(object.imageBuilderVersion) ? globalThis.String(object.imageBuilderVersion) : ""
+    };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.imageBuilderVersion !== "") {
+      obj.imageBuilderVersion = message.imageBuilderVersion;
+    }
+    return obj;
+  },
+  create(base) {
+    return WorkspaceSetImageBuilderVersionResponse.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseWorkspaceSetImageBuilderVersionResponse();
+    message.imageBuilderVersion = object.imageBuilderVersion ?? "";
+    return message;
+  }
+};
+function createBaseWorkspaceSettingsResponse() {
+  return { defaultEnvironmentName: "", imageBuilderVersion: "" };
+}
+var WorkspaceSettingsResponse = {
+  encode(message, writer = new BinaryWriter()) {
+    if (message.defaultEnvironmentName !== "") {
+      writer.uint32(10).string(message.defaultEnvironmentName);
+    }
+    if (message.imageBuilderVersion !== "") {
+      writer.uint32(18).string(message.imageBuilderVersion);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseWorkspaceSettingsResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.defaultEnvironmentName = reader.string();
+          continue;
+        }
+        case 2: {
+          if (tag !== 18) {
+            break;
+          }
+          message.imageBuilderVersion = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return {
+      defaultEnvironmentName: isSet5(object.defaultEnvironmentName) ? globalThis.String(object.defaultEnvironmentName) : "",
+      imageBuilderVersion: isSet5(object.imageBuilderVersion) ? globalThis.String(object.imageBuilderVersion) : ""
+    };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.defaultEnvironmentName !== "") {
+      obj.defaultEnvironmentName = message.defaultEnvironmentName;
+    }
+    if (message.imageBuilderVersion !== "") {
+      obj.imageBuilderVersion = message.imageBuilderVersion;
+    }
+    return obj;
+  },
+  create(base) {
+    return WorkspaceSettingsResponse.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseWorkspaceSettingsResponse();
+    message.defaultEnvironmentName = object.defaultEnvironmentName ?? "";
+    message.imageBuilderVersion = object.imageBuilderVersion ?? "";
+    return message;
+  }
+};
 var ModalClientDefinition = {
   name: "ModalClient",
   fullName: "modal.client.ModalClient",
@@ -53228,6 +53501,30 @@ var ModalClientDefinition = {
       responseType: WorkspaceNameLookupResponse,
       responseStream: false,
       options: {}
+    },
+    workspaceSetDefaultEnvironment: {
+      name: "WorkspaceSetDefaultEnvironment",
+      requestType: WorkspaceSetDefaultEnvironmentRequest,
+      requestStream: false,
+      responseType: Empty,
+      responseStream: false,
+      options: {}
+    },
+    workspaceSetImageBuilderVersion: {
+      name: "WorkspaceSetImageBuilderVersion",
+      requestType: WorkspaceSetImageBuilderVersionRequest,
+      requestStream: false,
+      responseType: WorkspaceSetImageBuilderVersionResponse,
+      responseStream: false,
+      options: {}
+    },
+    workspaceSettings: {
+      name: "WorkspaceSettings",
+      requestType: Empty,
+      requestStream: false,
+      responseType: WorkspaceSettingsResponse,
+      responseStream: false,
+      options: {}
     }
   }
 };
@@ -58501,6 +58798,94 @@ var TaskMountDirectoryRequest = {
     return message;
   }
 };
+function createBaseTaskReloadVolumesRequest() {
+  return { taskId: "" };
+}
+var TaskReloadVolumesRequest = {
+  encode(message, writer = new BinaryWriter()) {
+    if (message.taskId !== "") {
+      writer.uint32(10).string(message.taskId);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseTaskReloadVolumesRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.taskId = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return { taskId: isSet6(object.taskId) ? globalThis.String(object.taskId) : "" };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.taskId !== "") {
+      obj.taskId = message.taskId;
+    }
+    return obj;
+  },
+  create(base) {
+    return TaskReloadVolumesRequest.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseTaskReloadVolumesRequest();
+    message.taskId = object.taskId ?? "";
+    return message;
+  }
+};
+function createBaseTaskReloadVolumesResponse() {
+  return {};
+}
+var TaskReloadVolumesResponse = {
+  encode(_, writer = new BinaryWriter()) {
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseTaskReloadVolumesResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(_) {
+    return {};
+  },
+  toJSON(_) {
+    const obj = {};
+    return obj;
+  },
+  create(base) {
+    return TaskReloadVolumesResponse.fromPartial(base ?? {});
+  },
+  fromPartial(_) {
+    const message = createBaseTaskReloadVolumesResponse();
+    return message;
+  }
+};
 function createBaseTaskSetNetworkAccessRequest() {
   return { taskId: "", networkAccess: void 0 };
 }
@@ -59146,6 +59531,15 @@ var TaskCommandRouterDefinition = {
       responseStream: false,
       options: {}
     },
+    /** Reload all Volumes mounted in the task to reflect their latest committed state. */
+    taskReloadVolumes: {
+      name: "TaskReloadVolumes",
+      requestType: TaskReloadVolumesRequest,
+      requestStream: false,
+      responseType: TaskReloadVolumesResponse,
+      responseStream: false,
+      options: {}
+    },
     /** Replace the task's outbound network allowlist (domains + CIDRs). */
     taskSetNetworkAccess: {
       name: "TaskSetNetworkAccess",
@@ -59536,8 +59930,9 @@ var AuthTokenManager = class {
 };
 
 // src/version.ts
+var SDK_VERSION = "0.8.2";
 function getSDKVersion() {
-  return true ? "0.8.1" : "0.0.0";
+  return SDK_VERSION;
 }
 
 // src/logger.ts
@@ -60433,6 +60828,13 @@ var TaskCommandRouterClientImpl = class _TaskCommandRouterClientImpl {
   async unmountDirectory(request) {
     await this.callUnary(() => this.stub.taskUnmountDirectory(request));
   }
+  async setNetworkAccess(request) {
+    await this.callUnary(() => this.stub.taskSetNetworkAccess(request));
+  }
+  /** Reload all Volumes mounted in the task to reflect their latest committed state. */
+  async reloadVolumes(request) {
+    await this.callUnary(() => this.stub.taskReloadVolumes(request));
+  }
   async sandboxWaitUntilReady(taskId, timeoutMs) {
     const deadlineMs = Date.now() + timeoutMs;
     try {
@@ -62079,6 +62481,41 @@ var SandboxService = class {
       }
     }
   }
+  /**
+   * List the V2 {@link Sandbox}es in an {@link App}.
+   *
+   * This lists V2 Sandboxes, i.e. Sandboxes created via
+   * {@link SandboxService#experimentalCreate client.sandboxes.experimentalCreate()}.
+   * Such Sandboxes are not returned by
+   * {@link SandboxService#list client.sandboxes.list()}. Filtering based on tags
+   * is not yet supported.
+   *
+   * Yields {@link Sandbox} objects that are currently running in the App.
+   *
+   * EXPERIMENTAL: the API is subject to change.
+   */
+  async *experimentalList(params) {
+    if (!params?.appId) {
+      throw new InvalidError(
+        'experimentalList requires an `appId`:\n\nconst app = await modal.apps.fromName("my-app");\nmodal.sandboxes.experimentalList({ appId: app.appId });'
+      );
+    }
+    let beforeTimestamp = void 0;
+    while (true) {
+      const resp = await this.#client.cpClient.sandboxListV2({
+        appId: params.appId,
+        beforeTimestamp,
+        includeFinished: false
+      });
+      if (!resp.sandboxes || resp.sandboxes.length === 0) {
+        return;
+      }
+      for (const info of resp.sandboxes) {
+        yield new Sandbox2(this.#client, info.id, { isV2: true });
+      }
+      beforeTimestamp = resp.sandboxes[resp.sandboxes.length - 1].createdAt;
+    }
+  }
 };
 var Tunnel = class {
   /** @ignore */
@@ -62674,6 +63111,48 @@ var Sandbox2 = class _Sandbox {
     });
     await commandRouterClient.unmountDirectory(request);
   }
+  /**
+   * Updates the outbound network policy of a running Sandbox.
+   *
+   * Established connections that the new policy no longer permits are terminated.
+   *
+   * @param params - Both `outboundCidrAllowlist` and `outboundDomainAllowlist` must be provided.
+   */
+  async updateNetworkPolicy(params) {
+    this.#ensureAttached();
+    if (params.outboundCidrAllowlist === void 0 || params.outboundDomainAllowlist === void 0) {
+      throw new InvalidError(
+        "updateNetworkPolicy currently requires both outboundCidrAllowlist and outboundDomainAllowlist to be set"
+      );
+    }
+    const [taskId, commandRouterClient] = await this.#getCommandRouter();
+    const request = TaskSetNetworkAccessRequest.create({
+      taskId,
+      networkAccess: NetworkAccess.create({
+        networkAccessType: 3 /* ALLOWLIST */,
+        allowedCidrs: params.outboundCidrAllowlist,
+        allowedDomains: params.outboundDomainAllowlist
+      })
+    });
+    await commandRouterClient.setNetworkAccess(request);
+  }
+  /**
+   * Reload all Volumes mounted in the Sandbox.
+   */
+  async reloadVolumes() {
+    this.#ensureAttached();
+    const taskId = await this.#getTaskId();
+    if (this.#isV2) {
+      const commandRouterClient = await this.#getOrCreateCommandRouterClient(taskId);
+      await commandRouterClient.reloadVolumes(
+        TaskReloadVolumesRequest.create({ taskId })
+      );
+    } else {
+      await this.#client.cpClient.containerReloadVolumes(
+        ContainerReloadVolumesRequest.create({ taskId })
+      );
+    }
+  }
   /**
    * Snapshots and creates a new {@link Image} from a directory in the running sandbox.
    *