modal 0.3.6 → 0.3.7

package/dist/index.d.ts

@@ -1,5 +1,55 @@
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 
+declare enum ParameterType {
+    PARAM_TYPE_UNSPECIFIED = 0,
+    PARAM_TYPE_STRING = 1,
+    PARAM_TYPE_INT = 2,
+    /** PARAM_TYPE_PICKLE - currently unused */
+    PARAM_TYPE_PICKLE = 3,
+    PARAM_TYPE_BYTES = 4,
+    /** PARAM_TYPE_UNKNOWN - used in schemas to signify unrecognized or un-annotated types */
+    PARAM_TYPE_UNKNOWN = 5,
+    PARAM_TYPE_LIST = 6,
+    PARAM_TYPE_DICT = 7,
+    PARAM_TYPE_NONE = 8,
+    PARAM_TYPE_BOOL = 9,
+    UNRECOGNIZED = -1
+}
+/** TODO: rename into NamedPayloadType or similar */
+interface ClassParameterSpec {
+    name: string;
+    /** TODO: deprecate - use full_type instead */
+    type: ParameterType;
+    hasDefault: boolean;
+    /** Default *values* are only registered for class parameters */
+    stringDefault?: string | undefined;
+    intDefault?: number | undefined;
+    pickleDefault?: Uint8Array | undefined;
+    bytesDefault?: Uint8Array | undefined;
+    boolDefault?: boolean | undefined;
+    /** supersedes `type` */
+    fullType: GenericPayloadType | undefined;
+}
+declare const ClassParameterSpec: MessageFns<ClassParameterSpec>;
+interface GenericPayloadType {
+    baseType: ParameterType;
+    /** sub-type for generic types like lists */
+    subTypes: GenericPayloadType[];
+}
+declare const GenericPayloadType: MessageFns<GenericPayloadType>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+
 /** A container image, used for starting sandboxes. */
 declare class Image {
     readonly imageId: string;
@@ -92,6 +142,20 @@ declare class ContainerProcess<R extends string | Uint8Array = any> {
     wait(): Promise<number>;
 }
 
+/** Options for `Secret.fromName()`. */
+type SecretFromNameOptions = {
+    environment?: string;
+    requiredKeys?: string[];
+};
+/** Secrets provide a dictionary of environment variables for images. */
+declare class Secret {
+    readonly secretId: string;
+    /** @ignore */
+    constructor(secretId: string);
+    /** Reference a Secret by its name. */
+    static fromName(name: string, options?: SecretFromNameOptions): Promise<Secret>;
+}
+
 /** Options for functions that find deployed Modal objects. */
 type LookupOptions = {
     environment?: string;
@@ -128,56 +192,7 @@ declare class App {
     static lookup(name: string, options?: LookupOptions): Promise<App>;
     createSandbox(image: Image, options?: SandboxCreateOptions): Promise<Sandbox>;
     imageFromRegistry(tag: string): Promise<Image>;
-}
-
-declare enum ParameterType {
-    PARAM_TYPE_UNSPECIFIED = 0,
-    PARAM_TYPE_STRING = 1,
-    PARAM_TYPE_INT = 2,
-    /** PARAM_TYPE_PICKLE - currently unused */
-    PARAM_TYPE_PICKLE = 3,
-    PARAM_TYPE_BYTES = 4,
-    /** PARAM_TYPE_UNKNOWN - used in schemas to signify unrecognized or un-annotated types */
-    PARAM_TYPE_UNKNOWN = 5,
-    PARAM_TYPE_LIST = 6,
-    PARAM_TYPE_DICT = 7,
-    PARAM_TYPE_NONE = 8,
-    PARAM_TYPE_BOOL = 9,
-    UNRECOGNIZED = -1
-}
-/** TODO: rename into NamedPayloadType or similar */
-interface ClassParameterSpec {
-    name: string;
-    /** TODO: deprecate - use full_type instead */
-    type: ParameterType;
-    hasDefault: boolean;
-    /** Default *values* are only registered for class parameters */
-    stringDefault?: string | undefined;
-    intDefault?: number | undefined;
-    pickleDefault?: Uint8Array | undefined;
-    bytesDefault?: Uint8Array | undefined;
-    boolDefault?: boolean | undefined;
-    /** supersedes `type` */
-    fullType: GenericPayloadType | undefined;
-}
-declare const ClassParameterSpec: MessageFns<ClassParameterSpec>;
-interface GenericPayloadType {
-    baseType: ParameterType;
-    /** sub-type for generic types like lists */
-    subTypes: GenericPayloadType[];
-}
-declare const GenericPayloadType: MessageFns<GenericPayloadType>;
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
-    [K in keyof T]?: DeepPartial<T[K]>;
-} : Partial<T>;
-interface MessageFns<T> {
-    encode(message: T, writer?: BinaryWriter): BinaryWriter;
-    decode(input: BinaryReader | Uint8Array, length?: number): T;
-    fromJSON(object: any): T;
-    toJSON(message: T): unknown;
-    create(base?: DeepPartial<T>): T;
-    fromPartial(object: DeepPartial<T>): T;
+    imageFromAwsEcr(tag: string, secret: Secret): Promise<Image>;
 }
 
 /** Options for `FunctionCall.get()`. */
@@ -362,4 +377,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, type StdioBehavior, type StreamMode };
+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, Secret, type SecretFromNameOptions, type StdioBehavior, type StreamMode };

package/dist/index.js

@@ -1,5 +1,5 @@
 // src/app.ts
-import { ClientError as ClientError2, Status as Status2 } from "nice-grpc";
+import { ClientError as ClientError3, Status as Status3 } from "nice-grpc";
 
 // node_modules/@bufbuild/protobuf/dist/esm/wire/varint.js
 function varint64read() {
@@ -37835,7 +37835,8 @@ function getProfile(profileName) {
     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
+    environment: process.env["MODAL_ENVIRONMENT"] || profileData.environment,
+    imageBuilderVersion: process.env["MODAL_IMAGE_BUILDER_VERSION"] || profileData.imageBuilderVersion
   };
   if (!profile2.tokenId || !profile2.tokenSecret) {
     throw new Error(
@@ -37848,6 +37849,9 @@ var profile = getProfile(process.env["MODAL_PROFILE"] || void 0);
 function environmentName(environment) {
   return environment || profile.environment || "";
 }
+function imageBuilderVersion(version) {
+  return version || profile.imageBuilderVersion || "2024.10";
+}
 
 // src/client.ts
 function authMiddleware(profile2) {
@@ -37980,15 +37984,15 @@ var Image2 = class {
     this.imageId = imageId;
   }
 };
-async function fromRegistryInternal(appId, tag) {
+async function fromRegistryInternal(appId, tag, imageRegistryConfig) {
   const resp = await client.imageGetOrCreate({
     appId,
     image: {
-      dockerfileCommands: [`FROM ${tag}`]
+      dockerfileCommands: [`FROM ${tag}`],
+      imageRegistryConfig
     },
     namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
-    builderVersion: "2024.10"
-    // TODO: make this configurable
+    builderVersion: imageBuilderVersion()
   });
   let result;
   let metadata = void 0;
@@ -38403,6 +38407,34 @@ var QueueFullError = class extends Error {
   }
 };
 
+// src/secret.ts
+import { ClientError as ClientError2, Status as Status2 } from "nice-grpc";
+var Secret = class _Secret {
+  secretId;
+  /** @ignore */
+  constructor(secretId) {
+    this.secretId = secretId;
+  }
+  /** Reference a Secret by its name. */
+  static async fromName(name, options) {
+    try {
+      const resp = await client.secretGetOrCreate({
+        deploymentName: name,
+        namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
+        environmentName: environmentName(options?.environment),
+        requiredKeys: options?.requiredKeys ?? []
+      });
+      return new _Secret(resp.secretId);
+    } catch (err) {
+      if (err instanceof ClientError2 && err.code === Status2.NOT_FOUND)
+        throw new NotFoundError(err.details);
+      if (err instanceof ClientError2 && err.code === Status2.FAILED_PRECONDITION && err.details.includes("Secret is missing key"))
+        throw new NotFoundError(err.details);
+      throw err;
+    }
+  }
+};
+
 // src/app.ts
 var App = class _App {
   appId;
@@ -38420,7 +38452,7 @@ var App = class _App {
       });
       return new _App(resp.appId);
     } catch (err) {
-      if (err instanceof ClientError2 && err.code === Status2.NOT_FOUND)
+      if (err instanceof ClientError3 && err.code === Status3.NOT_FOUND)
         throw new NotFoundError(`App '${name}' not found`);
       throw err;
     }
@@ -38453,10 +38485,22 @@ var App = class _App {
   async imageFromRegistry(tag) {
     return await fromRegistryInternal(this.appId, tag);
   }
+  async imageFromAwsEcr(tag, secret) {
+    if (!(secret instanceof Secret)) {
+      throw new TypeError(
+        "secret must be a reference to an existing Secret, e.g. `await Secret.fromName('my_secret')`"
+      );
+    }
+    const imageRegistryConfig = {
+      registryAuthType: 1 /* REGISTRY_AUTH_TYPE_AWS */,
+      secretId: secret.secretId
+    };
+    return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
+  }
 };
 
 // src/cls.ts
-import { ClientError as ClientError4, Status as Status4 } from "nice-grpc";
+import { ClientError as ClientError5, Status as Status5 } from "nice-grpc";
 
 // src/function.ts
 import { createHash } from "node:crypto";
@@ -38548,6 +38592,15 @@ var Reader = class {
     const hi = this.uint32LE() >>> 0;
     return hi * 2 ** 32 + lo;
   }
+  int32LE() {
+    const v = new DataView(
+      this.buf.buffer,
+      this.buf.byteOffset + this.pos,
+      4
+    ).getInt32(0, true);
+    this.pos += 4;
+    return v;
+  }
   float64BE() {
     const v = new DataView(
       this.buf.buffer,
@@ -38680,6 +38733,7 @@ function loads(buf) {
     const size = r.uint64LE();
     void size;
   }
+  const MARK = Symbol("pickle-mark");
   while (!r.eof()) {
     const op = r.byte();
     switch (op) {
@@ -38704,8 +38758,7 @@ function loads(buf) {
         break;
       }
       case 74 /* BININT4 */: {
-        const n = r.uint32LE();
-        push(n >>> 31 ? n - 4294967296 : n);
+        push(r.int32LE());
         break;
       }
       case 71 /* BINFLOAT */:
@@ -38780,6 +38833,43 @@ function loads(buf) {
         const _size = r.uint64LE();
         break;
       }
+      case 40 /* MARK */:
+        push(MARK);
+        break;
+      case 101 /* APPENDS */: {
+        const markIndex = stack.lastIndexOf(MARK);
+        if (markIndex === -1) {
+          throw new PickleError("APPENDS without MARK");
+        }
+        const lst = stack[markIndex - 1];
+        if (!Array.isArray(lst)) {
+          throw new PickleError("APPENDS expects a list below MARK");
+        }
+        const items = stack.slice(markIndex + 1);
+        lst.push(...items);
+        stack.length = markIndex - 1;
+        push(lst);
+        break;
+      }
+      case 117 /* SETITEMS */: {
+        const markIndex = stack.lastIndexOf(MARK);
+        if (markIndex === -1) {
+          throw new PickleError("SETITEMS without MARK");
+        }
+        const d = stack[markIndex - 1];
+        if (typeof d !== "object" || d === null || Array.isArray(d)) {
+          throw new PickleError("SETITEMS expects a dict below MARK");
+        }
+        const items = stack.slice(markIndex + 1);
+        for (let i = 0; i < items.length; i += 2) {
+          if (i + 1 < items.length) {
+            d[items[i]] = items[i + 1];
+          }
+        }
+        stack.length = markIndex - 1;
+        push(d);
+        break;
+      }
       default:
         throw new PickleError(`Unsupported opcode 0x${op.toString(16)}`);
     }
@@ -38788,7 +38878,7 @@ function loads(buf) {
 }
 
 // src/function.ts
-import { ClientError as ClientError3, Status as Status3 } from "nice-grpc";
+import { ClientError as ClientError4, Status as Status4 } from "nice-grpc";
 var maxObjectSizeBytes = 2 * 1024 * 1024;
 var outputsTimeout = 55 * 1e3;
 function timeNowSeconds() {
@@ -38812,7 +38902,7 @@ var Function_ = class _Function_ {
       });
       return new _Function_(resp.functionId);
     } catch (err) {
-      if (err instanceof ClientError3 && err.code === Status3.NOT_FOUND)
+      if (err instanceof ClientError4 && err.code === Status4.NOT_FOUND)
         throw new NotFoundError(`Function '${appName}/${name}' not found`);
       throw err;
     }
@@ -39010,7 +39100,7 @@ var Cls = class _Cls {
       }
       return new _Cls(serviceFunction.functionId, schema, methodNames);
     } catch (err) {
-      if (err instanceof ClientError4 && err.code === Status4.NOT_FOUND)
+      if (err instanceof ClientError5 && err.code === Status5.NOT_FOUND)
         throw new NotFoundError(`Class '${appName}/${name}' not found`);
       throw err;
     }
@@ -39109,7 +39199,7 @@ var ClsInstance = class {
 };
 
 // src/queue.ts
-import { ClientError as ClientError5, Status as Status5 } from "nice-grpc";
+import { ClientError as ClientError6, Status as Status6 } from "nice-grpc";
 var ephemeralObjectHeartbeatSleep = 3e5;
 var queueInitialPutBackoff = 100;
 var queueDefaultPartitionTtl = 24 * 3600 * 1e3;
@@ -39264,7 +39354,7 @@ var Queue = class _Queue {
         });
         break;
       } catch (e) {
-        if (e instanceof ClientError5 && e.code === Status5.RESOURCE_EXHAUSTED) {
+        if (e instanceof ClientError6 && e.code === Status6.RESOURCE_EXHAUSTED) {
           delay = Math.min(delay * 2, 3e4);
           if (deadline !== void 0) {
             const remaining = deadline - Date.now();
@@ -39370,5 +39460,6 @@ export {
   QueueEmptyError,
   QueueFullError,
   RemoteError,
-  Sandbox2 as Sandbox
+  Sandbox2 as Sandbox,
+  Secret
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modal",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "Modal client library for JavaScript",
   "license": "MIT",
   "homepage": "https://modal.com/docs",
@@ -29,7 +29,10 @@
     "format:check": "prettier --check .",
     "lint": "eslint",
     "prepare": "scripts/gen-proto.sh",
-    "test": "vitest"
+    "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"
   },
   "dependencies": {
     "long": "^5.3.1",