modal 0.3.11 → 0.3.12

package/dist/index.cjs

@@ -37891,6 +37891,7 @@ function imageBuilderVersion(version) {
 
 // src/client.ts
 var defaultProfile = getProfile(process.env["MODAL_PROFILE"]);
+var modalAuthToken;
 function authMiddleware(profile) {
   return async function* authMiddleware2(call, options) {
     if (!profile.tokenId || !profile.tokenSecret) {
@@ -37907,6 +37908,25 @@ function authMiddleware(profile) {
     options.metadata.set("x-modal-client-version", "1.0.0");
     options.metadata.set("x-modal-token-id", tokenId);
     options.metadata.set("x-modal-token-secret", tokenSecret);
+    if (modalAuthToken) {
+      options.metadata.set("x-modal-auth-token", modalAuthToken);
+    }
+    const prevOnHeader = options.onHeader;
+    options.onHeader = (header) => {
+      const token = header.get("x-modal-auth-token");
+      if (token) {
+        modalAuthToken = token;
+      }
+      prevOnHeader?.(header);
+    };
+    const prevOnTrailer = options.onTrailer;
+    options.onTrailer = (trailer) => {
+      const token = trailer.get("x-modal-auth-token");
+      if (token) {
+        modalAuthToken = token;
+      }
+      prevOnTrailer?.(trailer);
+    };
     return yield* call.next(call.request, options);
   };
 }
@@ -38012,6 +38032,17 @@ var retryMiddleware = async function* retryMiddleware2(call, options) {
     }
   }
 };
+var inputPlaneClients = {};
+var getOrCreateInputPlaneClient = (serverUrl) => {
+  const client2 = inputPlaneClients[serverUrl];
+  if (client2) {
+    return client2;
+  }
+  const profile = { ...clientProfile, serverUrl };
+  const newClient = createClient(profile);
+  inputPlaneClients[serverUrl] = newClient;
+  return newClient;
+};
 function createClient(profile) {
   const channel = (0, import_nice_grpc.createChannel)(profile.serverUrl, void 0, {
     "grpc.max_receive_message_length": 100 * 1024 * 1024,
@@ -38669,8 +38700,20 @@ var App = class _App {
     });
     return new Sandbox2(createResp.sandboxId);
   }
-  async imageFromRegistry(tag) {
-    return await fromRegistryInternal(this.appId, tag);
+  async imageFromRegistry(tag, secret) {
+    let imageRegistryConfig;
+    if (secret) {
+      if (!(secret instanceof Secret)) {
+        throw new TypeError(
+          "secret must be a reference to an existing Secret, e.g. `await Secret.fromName('my_secret')`"
+        );
+      }
+      imageRegistryConfig = {
+        registryAuthType: 4 /* REGISTRY_AUTH_TYPE_STATIC_CREDS */,
+        secretId: secret.secretId
+      };
+    }
+    return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
   }
   async imageFromAwsEcr(tag, secret) {
     if (!(secret instanceof Secret)) {
@@ -38684,6 +38727,18 @@ var App = class _App {
     };
     return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
   }
+  async imageFromGcpArtifactRegistry(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: 2 /* REGISTRY_AUTH_TYPE_GCP */,
+      secretId: secret.secretId
+    };
+    return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
+  }
 };
 
 // src/cls.ts
@@ -39074,7 +39129,22 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
     return new _ControlPlaneInvocation(functionCallId);
   }
   async awaitOutput(timeout) {
-    return await pollFunctionOutput(this.functionCallId, timeout);
+    return await pollFunctionOutput(
+      (timeoutMillis) => this.#getOutput(timeoutMillis),
+      timeout
+    );
+  }
+  async #getOutput(timeoutMillis) {
+    const response = await client.functionGetOutputs({
+      functionCallId: this.functionCallId,
+      maxValues: 1,
+      timeout: timeoutMillis / 1e3,
+      // Backend needs seconds
+      lastEntryId: "0-0",
+      clearOnSuccess: true,
+      requestedAt: timeNowSeconds()
+    });
+    return response.outputs ? response.outputs[0] : void 0;
   }
   async retry(retryCount) {
     if (!this.input) {
@@ -39092,33 +39162,70 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
     this.inputJwt = functionRetryResponse.inputJwts[0];
   }
 };
+var InputPlaneInvocation = class _InputPlaneInvocation {
+  client;
+  functionId;
+  input;
+  attemptToken;
+  constructor(client2, functionId, input, attemptToken) {
+    this.client = client2;
+    this.functionId = functionId;
+    this.input = input;
+    this.attemptToken = attemptToken;
+  }
+  static async create(inputPlaneUrl, functionId, input) {
+    const functionPutInputsItem = {
+      idx: 0,
+      input
+    };
+    const client2 = getOrCreateInputPlaneClient(inputPlaneUrl);
+    const attemptStartResponse = await client2.attemptStart({
+      functionId,
+      input: functionPutInputsItem
+    });
+    return new _InputPlaneInvocation(
+      client2,
+      functionId,
+      functionPutInputsItem,
+      attemptStartResponse.attemptToken
+    );
+  }
+  async awaitOutput(timeout) {
+    return await pollFunctionOutput(
+      (timeoutMillis) => this.#getOutput(timeoutMillis),
+      timeout
+    );
+  }
+  async #getOutput(timeoutMillis) {
+    const response = await this.client.attemptAwait({
+      attemptToken: this.attemptToken,
+      requestedAt: timeNowSeconds(),
+      timeoutSecs: timeoutMillis / 1e3
+    });
+    return response.output;
+  }
+  async retry(_retryCount) {
+    const attemptRetryResponse = await this.client.attemptRetry({
+      functionId: this.functionId,
+      input: this.input,
+      attemptToken: this.attemptToken
+    });
+    this.attemptToken = attemptRetryResponse.attemptToken;
+  }
+};
 function timeNowSeconds() {
   return Date.now() / 1e3;
 }
-async function pollFunctionOutput(functionCallId, timeout) {
+async function pollFunctionOutput(getOutput, timeout) {
   const startTime = Date.now();
   let pollTimeout = outputsTimeout;
   if (timeout !== void 0) {
     pollTimeout = Math.min(timeout, outputsTimeout);
   }
   while (true) {
-    let response;
-    try {
-      response = await client.functionGetOutputs({
-        functionCallId,
-        maxValues: 1,
-        timeout: pollTimeout / 1e3,
-        // Backend needs seconds
-        lastEntryId: "0-0",
-        clearOnSuccess: true,
-        requestedAt: timeNowSeconds()
-      });
-    } catch (err) {
-      throw new Error(`FunctionGetOutputs failed: ${err}`);
-    }
-    const outputs = response.outputs;
-    if (outputs.length > 0) {
-      return await processResult(outputs[0].result, outputs[0].dataFormat);
+    const output = await getOutput(pollTimeout);
+    if (output) {
+      return await processResult(output.result, output.dataFormat);
     }
     if (timeout !== void 0) {
       const remainingTime = timeout - (Date.now() - startTime);
@@ -39212,10 +39319,12 @@ var maxSystemRetries = 8;
 var Function_ = class _Function_ {
   functionId;
   methodName;
+  inputPlaneUrl;
   /** @ignore */
-  constructor(functionId, methodName) {
+  constructor(functionId, methodName, inputPlaneUrl) {
     this.functionId = functionId;
     this.methodName = methodName;
+    this.inputPlaneUrl = inputPlaneUrl;
   }
   static async lookup(appName, name, options = {}) {
     try {
@@ -39225,7 +39334,11 @@ var Function_ = class _Function_ {
         namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options.environment)
       });
-      return new _Function_(resp.functionId);
+      return new _Function_(
+        resp.functionId,
+        void 0,
+        resp.handleMetadata?.inputPlaneUrl
+      );
     } catch (err) {
       if (err instanceof import_nice_grpc4.ClientError && err.code === import_nice_grpc4.Status.NOT_FOUND)
         throw new NotFoundError(`Function '${appName}/${name}' not found`);
@@ -39235,11 +39348,7 @@ var Function_ = class _Function_ {
   // Execute a single input into a remote Function.
   async remote(args = [], kwargs = {}) {
     const input = await this.#createInput(args, kwargs);
-    const invocation = await ControlPlaneInvocation.create(
-      this.functionId,
-      input,
-      4 /* FUNCTION_CALL_INVOCATION_TYPE_SYNC */
-    );
+    const invocation = await this.#createRemoteInvocation(input);
     let retryCount = 0;
     while (true) {
       try {
@@ -39254,6 +39363,20 @@ var Function_ = class _Function_ {
       }
     }
   }
+  async #createRemoteInvocation(input) {
+    if (this.inputPlaneUrl) {
+      return await InputPlaneInvocation.create(
+        this.inputPlaneUrl,
+        this.functionId,
+        input
+      );
+    }
+    return await ControlPlaneInvocation.create(
+      this.functionId,
+      input,
+      4 /* FUNCTION_CALL_INVOCATION_TYPE_SYNC */
+    );
+  }
   // Spawn a single input into a remote function.
   async spawn(args = [], kwargs = {}) {
     const input = await this.#createInput(args, kwargs);

package/dist/index.d.cts

@@ -235,8 +235,9 @@ declare class App {
     /** Lookup a deployed app by name, or create if it does not exist. */
     static lookup(name: string, options?: LookupOptions): Promise<App>;
     createSandbox(image: Image, options?: SandboxCreateOptions): Promise<Sandbox>;
-    imageFromRegistry(tag: string): Promise<Image>;
+    imageFromRegistry(tag: string, secret?: Secret): Promise<Image>;
     imageFromAwsEcr(tag: string, secret: Secret): Promise<Image>;
+    imageFromGcpArtifactRegistry(tag: string, secret: Secret): Promise<Image>;
 }
 
 /** Options for initializing a client at runtime. */
@@ -283,8 +284,9 @@ declare class Function_ {
     #private;
     readonly functionId: string;
     readonly methodName: string | undefined;
+    readonly inputPlaneUrl: string | undefined;
     /** @ignore */
-    constructor(functionId: string, methodName?: string);
+    constructor(functionId: string, methodName?: string, inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Function_>;
     remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
     spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;

package/dist/index.d.ts

@@ -235,8 +235,9 @@ declare class App {
     /** Lookup a deployed app by name, or create if it does not exist. */
     static lookup(name: string, options?: LookupOptions): Promise<App>;
     createSandbox(image: Image, options?: SandboxCreateOptions): Promise<Sandbox>;
-    imageFromRegistry(tag: string): Promise<Image>;
+    imageFromRegistry(tag: string, secret?: Secret): Promise<Image>;
     imageFromAwsEcr(tag: string, secret: Secret): Promise<Image>;
+    imageFromGcpArtifactRegistry(tag: string, secret: Secret): Promise<Image>;
 }
 
 /** Options for initializing a client at runtime. */
@@ -283,8 +284,9 @@ declare class Function_ {
     #private;
     readonly functionId: string;
     readonly methodName: string | undefined;
+    readonly inputPlaneUrl: string | undefined;
     /** @ignore */
-    constructor(functionId: string, methodName?: string);
+    constructor(functionId: string, methodName?: string, inputPlaneUrl?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Function_>;
     remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
     spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;

package/dist/index.js

@@ -37843,6 +37843,7 @@ function imageBuilderVersion(version) {
 
 // src/client.ts
 var defaultProfile = getProfile(process.env["MODAL_PROFILE"]);
+var modalAuthToken;
 function authMiddleware(profile) {
   return async function* authMiddleware2(call, options) {
     if (!profile.tokenId || !profile.tokenSecret) {
@@ -37859,6 +37860,25 @@ function authMiddleware(profile) {
     options.metadata.set("x-modal-client-version", "1.0.0");
     options.metadata.set("x-modal-token-id", tokenId);
     options.metadata.set("x-modal-token-secret", tokenSecret);
+    if (modalAuthToken) {
+      options.metadata.set("x-modal-auth-token", modalAuthToken);
+    }
+    const prevOnHeader = options.onHeader;
+    options.onHeader = (header) => {
+      const token = header.get("x-modal-auth-token");
+      if (token) {
+        modalAuthToken = token;
+      }
+      prevOnHeader?.(header);
+    };
+    const prevOnTrailer = options.onTrailer;
+    options.onTrailer = (trailer) => {
+      const token = trailer.get("x-modal-auth-token");
+      if (token) {
+        modalAuthToken = token;
+      }
+      prevOnTrailer?.(trailer);
+    };
     return yield* call.next(call.request, options);
   };
 }
@@ -37964,6 +37984,17 @@ var retryMiddleware = async function* retryMiddleware2(call, options) {
     }
   }
 };
+var inputPlaneClients = {};
+var getOrCreateInputPlaneClient = (serverUrl) => {
+  const client2 = inputPlaneClients[serverUrl];
+  if (client2) {
+    return client2;
+  }
+  const profile = { ...clientProfile, serverUrl };
+  const newClient = createClient(profile);
+  inputPlaneClients[serverUrl] = newClient;
+  return newClient;
+};
 function createClient(profile) {
   const channel = createChannel(profile.serverUrl, void 0, {
     "grpc.max_receive_message_length": 100 * 1024 * 1024,
@@ -38621,8 +38652,20 @@ var App = class _App {
     });
     return new Sandbox2(createResp.sandboxId);
   }
-  async imageFromRegistry(tag) {
-    return await fromRegistryInternal(this.appId, tag);
+  async imageFromRegistry(tag, secret) {
+    let imageRegistryConfig;
+    if (secret) {
+      if (!(secret instanceof Secret)) {
+        throw new TypeError(
+          "secret must be a reference to an existing Secret, e.g. `await Secret.fromName('my_secret')`"
+        );
+      }
+      imageRegistryConfig = {
+        registryAuthType: 4 /* REGISTRY_AUTH_TYPE_STATIC_CREDS */,
+        secretId: secret.secretId
+      };
+    }
+    return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
   }
   async imageFromAwsEcr(tag, secret) {
     if (!(secret instanceof Secret)) {
@@ -38636,6 +38679,18 @@ var App = class _App {
     };
     return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
   }
+  async imageFromGcpArtifactRegistry(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: 2 /* REGISTRY_AUTH_TYPE_GCP */,
+      secretId: secret.secretId
+    };
+    return await fromRegistryInternal(this.appId, tag, imageRegistryConfig);
+  }
 };
 
 // src/cls.ts
@@ -39026,7 +39081,22 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
     return new _ControlPlaneInvocation(functionCallId);
   }
   async awaitOutput(timeout) {
-    return await pollFunctionOutput(this.functionCallId, timeout);
+    return await pollFunctionOutput(
+      (timeoutMillis) => this.#getOutput(timeoutMillis),
+      timeout
+    );
+  }
+  async #getOutput(timeoutMillis) {
+    const response = await client.functionGetOutputs({
+      functionCallId: this.functionCallId,
+      maxValues: 1,
+      timeout: timeoutMillis / 1e3,
+      // Backend needs seconds
+      lastEntryId: "0-0",
+      clearOnSuccess: true,
+      requestedAt: timeNowSeconds()
+    });
+    return response.outputs ? response.outputs[0] : void 0;
   }
   async retry(retryCount) {
     if (!this.input) {
@@ -39044,33 +39114,70 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
     this.inputJwt = functionRetryResponse.inputJwts[0];
   }
 };
+var InputPlaneInvocation = class _InputPlaneInvocation {
+  client;
+  functionId;
+  input;
+  attemptToken;
+  constructor(client2, functionId, input, attemptToken) {
+    this.client = client2;
+    this.functionId = functionId;
+    this.input = input;
+    this.attemptToken = attemptToken;
+  }
+  static async create(inputPlaneUrl, functionId, input) {
+    const functionPutInputsItem = {
+      idx: 0,
+      input
+    };
+    const client2 = getOrCreateInputPlaneClient(inputPlaneUrl);
+    const attemptStartResponse = await client2.attemptStart({
+      functionId,
+      input: functionPutInputsItem
+    });
+    return new _InputPlaneInvocation(
+      client2,
+      functionId,
+      functionPutInputsItem,
+      attemptStartResponse.attemptToken
+    );
+  }
+  async awaitOutput(timeout) {
+    return await pollFunctionOutput(
+      (timeoutMillis) => this.#getOutput(timeoutMillis),
+      timeout
+    );
+  }
+  async #getOutput(timeoutMillis) {
+    const response = await this.client.attemptAwait({
+      attemptToken: this.attemptToken,
+      requestedAt: timeNowSeconds(),
+      timeoutSecs: timeoutMillis / 1e3
+    });
+    return response.output;
+  }
+  async retry(_retryCount) {
+    const attemptRetryResponse = await this.client.attemptRetry({
+      functionId: this.functionId,
+      input: this.input,
+      attemptToken: this.attemptToken
+    });
+    this.attemptToken = attemptRetryResponse.attemptToken;
+  }
+};
 function timeNowSeconds() {
   return Date.now() / 1e3;
 }
-async function pollFunctionOutput(functionCallId, timeout) {
+async function pollFunctionOutput(getOutput, timeout) {
   const startTime = Date.now();
   let pollTimeout = outputsTimeout;
   if (timeout !== void 0) {
     pollTimeout = Math.min(timeout, outputsTimeout);
   }
   while (true) {
-    let response;
-    try {
-      response = await client.functionGetOutputs({
-        functionCallId,
-        maxValues: 1,
-        timeout: pollTimeout / 1e3,
-        // Backend needs seconds
-        lastEntryId: "0-0",
-        clearOnSuccess: true,
-        requestedAt: timeNowSeconds()
-      });
-    } catch (err) {
-      throw new Error(`FunctionGetOutputs failed: ${err}`);
-    }
-    const outputs = response.outputs;
-    if (outputs.length > 0) {
-      return await processResult(outputs[0].result, outputs[0].dataFormat);
+    const output = await getOutput(pollTimeout);
+    if (output) {
+      return await processResult(output.result, output.dataFormat);
     }
     if (timeout !== void 0) {
       const remainingTime = timeout - (Date.now() - startTime);
@@ -39164,10 +39271,12 @@ var maxSystemRetries = 8;
 var Function_ = class _Function_ {
   functionId;
   methodName;
+  inputPlaneUrl;
   /** @ignore */
-  constructor(functionId, methodName) {
+  constructor(functionId, methodName, inputPlaneUrl) {
     this.functionId = functionId;
     this.methodName = methodName;
+    this.inputPlaneUrl = inputPlaneUrl;
   }
   static async lookup(appName, name, options = {}) {
     try {
@@ -39177,7 +39286,11 @@ var Function_ = class _Function_ {
         namespace: 1 /* DEPLOYMENT_NAMESPACE_WORKSPACE */,
         environmentName: environmentName(options.environment)
       });
-      return new _Function_(resp.functionId);
+      return new _Function_(
+        resp.functionId,
+        void 0,
+        resp.handleMetadata?.inputPlaneUrl
+      );
     } catch (err) {
       if (err instanceof ClientError4 && err.code === Status4.NOT_FOUND)
         throw new NotFoundError(`Function '${appName}/${name}' not found`);
@@ -39187,11 +39300,7 @@ var Function_ = class _Function_ {
   // Execute a single input into a remote Function.
   async remote(args = [], kwargs = {}) {
     const input = await this.#createInput(args, kwargs);
-    const invocation = await ControlPlaneInvocation.create(
-      this.functionId,
-      input,
-      4 /* FUNCTION_CALL_INVOCATION_TYPE_SYNC */
-    );
+    const invocation = await this.#createRemoteInvocation(input);
     let retryCount = 0;
     while (true) {
       try {
@@ -39206,6 +39315,20 @@ var Function_ = class _Function_ {
       }
     }
   }
+  async #createRemoteInvocation(input) {
+    if (this.inputPlaneUrl) {
+      return await InputPlaneInvocation.create(
+        this.inputPlaneUrl,
+        this.functionId,
+        input
+      );
+    }
+    return await ControlPlaneInvocation.create(
+      this.functionId,
+      input,
+      4 /* FUNCTION_CALL_INVOCATION_TYPE_SYNC */
+    );
+  }
   // Spawn a single input into a remote function.
   async spawn(args = [], kwargs = {}) {
     const input = await this.#createInput(args, kwargs);

package/package.json

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