notte-sdk 1.9.4 → 1.9.5

package/dist/index.js

@@ -92,6 +92,7 @@ __export(index_exports, {
   deleteSecret: () => deleteSecret,
   deleteSessionFile: () => deleteSessionFile,
   disconnectPaymentWallet: () => disconnectPaymentWallet,
+  downloadRunPayload: () => downloadRunPayload,
   downloadSessionFile: () => downloadSessionFile,
   functionCreate: () => functionCreate,
   functionDelete: () => functionDelete,
@@ -148,6 +149,7 @@ __export(index_exports, {
   personaSmsList: () => personaSmsList,
   personaUpdate: () => personaUpdate,
   prepareAgentRequest: () => prepareAgentRequest,
+  prepareRunPayloadUpload: () => prepareRunPayloadUpload,
   processScrapeResponse: () => processScrapeResponse,
   profileCookiesGet: () => profileCookiesGet,
   profileCookiesSet: () => profileCookiesSet,
@@ -195,7 +197,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/version.ts
-var SDK_VERSION = true ? "1.9.4" : "dev";
+var SDK_VERSION = true ? "1.9.5" : "dev";
 var SDK_PACKAGE_NAME = true ? "notte-sdk" : "notte-sdk";
 
 // src/version-check.ts
@@ -1392,6 +1394,20 @@ var functionRunUpdateMetadata = (options) => (options.client ?? client).patch({
     ...options.headers
   }
 });
+var prepareRunPayloadUpload = (options) => (options.client ?? client).post({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/functions/{function_id}/runs/{run_id}/payloads/{field}/upload",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
+var downloadRunPayload = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/functions/{function_id}/runs/{run_id}/payloads/{field}",
+  ...options
+});
 var listFunctionRunsByFunctionId = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/functions/{function_id}/runs",
@@ -1669,6 +1685,7 @@ var connectLinkSubmit = (options) => (options.client ?? client).post({
 });
 var connectLinkStatus = (options) => (options.client ?? client).get({ url: "/managed-auth/connect-links/status", ...options });
 var improvePrompt = (options) => (options.client ?? client).post({
+  security: [{ scheme: "bearer", type: "http" }],
   url: "/prompts/improve",
   ...options,
   headers: {
@@ -1677,6 +1694,7 @@ var improvePrompt = (options) => (options.client ?? client).post({
   }
 });
 var nudgePrompt = (options) => (options.client ?? client).post({
+  security: [{ scheme: "bearer", type: "http" }],
   url: "/prompts/nudge",
   ...options,
   headers: {
@@ -2079,8 +2097,8 @@ function createResources(client2, getApiKey) {
         return response.data;
       },
       /** sessionOffset: /sessions/{session_id}/offset. Returns the API response body. */
-      offset: async (sessionId, requestOptions = {}) => {
-        const response = await sessionOffset({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "session_id": sessionId } });
+      offset: async (sessionId, query = void 0, requestOptions = {}) => {
+        const response = await sessionOffset({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "session_id": sessionId }, query });
         return response.data;
       },
       /** pageScreenshot: /sessions/{session_id}/page/screenshot. Returns the API response body. */
@@ -2172,6 +2190,11 @@ function createResources(client2, getApiKey) {
         const response = await functionScheduleDelete({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId } });
         return response.data;
       },
+      /** downloadRunPayload: /functions/{function_id}/runs/{run_id}/payloads/{field}. Returns the API response body. */
+      downloadRunPayload: async (functionId, runId, field, requestOptions = {}) => {
+        const response = await downloadRunPayload({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId, "run_id": runId, "field": field } });
+        return response.data;
+      },
       /** functionDownloadUrl: /functions/{function_id}. Returns the API response body. */
       downloadUrl: async (functionId, query = void 0, requestOptions = {}) => {
         const response = await functionDownloadUrl({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId }, query });
@@ -2197,14 +2220,19 @@ function createResources(client2, getApiKey) {
         const response = await functionMetadataUpdate({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId }, body });
         return response.data;
       },
+      /** prepareRunPayloadUpload: /functions/{function_id}/runs/{run_id}/payloads/{field}/upload. Returns the API response body. */
+      prepareRunPayloadUpload: async (functionId, runId, field, body, requestOptions = {}) => {
+        const response = await prepareRunPayloadUpload({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId, "run_id": runId, "field": field }, body });
+        return response.data;
+      },
       /** functionRollback: /functions/{function_id}/rollback. Returns the API response body. */
       rollback: async (functionId, body, query = void 0, requestOptions = {}) => {
         const response = await functionRollback({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId }, body, query });
         return response.data;
       },
       /** functionRunGetMetadata: /functions/{function_id}/runs/{run_id}. Returns the API response body. */
-      runGetMetadata: async (functionId, runId, requestOptions = {}) => {
-        const response = await functionRunGetMetadata({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId, "run_id": runId } });
+      runGetMetadata: async (functionId, runId, requestOptions = {}, query = void 0) => {
+        const response = await functionRunGetMetadata({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "function_id": functionId, "run_id": runId }, query });
         return response.data;
       },
       /** functionRunStart: /functions/{function_id}/runs/start. Returns the API response body. */
@@ -2428,6 +2456,12 @@ async function executeWithCaptcha(action, budgetSeconds, request) {
     if (status.state === "cancelled" && status.cancel_reason === "navigation" && original) {
       return { ...original, captcha: status };
     }
+    if (status.state === "cancelled" && status.cancel_reason === "navigation" && action.type === "wait" && result.action_executed === false) {
+      params = { captcha_timeout_seconds: remaining() };
+      requestAction = action;
+      await pause();
+      continue;
+    }
     if (status.state === "failed" || status.state === "cancelled") {
       return failure(status.message || `CAPTCHA ${status.state}`, `captcha_${status.state}`);
     }
@@ -2753,6 +2787,126 @@ function isNotFound(error) {
   return typeof error === "object" && error !== null && error.code === "ENOENT";
 }
 
+// src/utils.ts
+var import_node_child_process = require("child_process");
+function formatError(error) {
+  if (typeof error === "object" && error !== null) {
+    if ("message" in error && typeof error.message === "string") {
+      return error.message;
+    }
+    try {
+      return JSON.stringify(error, null, 2);
+    } catch {
+      return String(error);
+    }
+  }
+  if (error instanceof Error) {
+    return error.message;
+  }
+  return String(error);
+}
+function openBrowser(url) {
+  const platform = process.platform;
+  let command;
+  let args;
+  if (platform === "darwin") {
+    command = "open";
+    args = [url];
+  } else if (platform === "win32") {
+    command = "rundll32";
+    args = ["url.dll,FileProtocolHandler", url];
+  } else {
+    command = "xdg-open";
+    args = [url];
+  }
+  const child = (0, import_node_child_process.spawn)(command, args, {
+    detached: true,
+    stdio: "ignore"
+  });
+  child.on("error", () => {
+  });
+  child.unref();
+}
+var SCHEMA_KEYWORDS = /* @__PURE__ */ new Set([
+  "items",
+  "additionalItems",
+  "additionalProperties",
+  "contains",
+  "propertyNames",
+  "not",
+  "if",
+  "then",
+  "else",
+  "unevaluatedItems",
+  "unevaluatedProperties"
+]);
+var SCHEMA_ARRAY_KEYWORDS = /* @__PURE__ */ new Set(["anyOf", "oneOf", "allOf", "prefixItems"]);
+var TYPE_SCOPED_KEYWORDS = /* @__PURE__ */ new Set([
+  "items",
+  "prefixItems",
+  "additionalItems",
+  "contains",
+  "unevaluatedItems",
+  "properties",
+  "patternProperties",
+  "required",
+  "additionalProperties",
+  "propertyNames",
+  "unevaluatedProperties",
+  "format"
+]);
+var SCHEMA_MAP_KEYWORDS = /* @__PURE__ */ new Set(["properties", "patternProperties", "$defs", "definitions", "dependentSchemas"]);
+function normalizeJsonSchema(schema) {
+  if (schema === null || typeof schema !== "object" || Array.isArray(schema)) return schema;
+  const out = {};
+  for (const [key, value] of Object.entries(schema)) {
+    if (SCHEMA_KEYWORDS.has(key) || key === "items" && Array.isArray(value)) {
+      out[key] = Array.isArray(value) ? value.map(normalizeJsonSchema) : normalizeJsonSchema(value);
+    } else if (SCHEMA_ARRAY_KEYWORDS.has(key) && Array.isArray(value)) {
+      out[key] = value.map(normalizeJsonSchema);
+    } else if (SCHEMA_MAP_KEYWORDS.has(key) && value !== null && typeof value === "object" && !Array.isArray(value)) {
+      out[key] = Object.fromEntries(
+        Object.entries(value).map(([name, sub]) => [name, normalizeJsonSchema(sub)])
+      );
+    } else {
+      out[key] = value;
+    }
+  }
+  if (Array.isArray(out.type)) {
+    const { type, anyOf: existing, ...rest } = out;
+    const types = type;
+    const parent = {};
+    const scoped = {};
+    for (const [key, value] of Object.entries(rest)) {
+      (TYPE_SCOPED_KEYWORDS.has(key) ? scoped : parent)[key] = value;
+    }
+    const typed = (t) => t === "null" ? { type: t } : { type: t, ...scoped };
+    let branches;
+    if (Array.isArray(existing)) {
+      const seen = /* @__PURE__ */ new Set();
+      branches = [];
+      const push = (b) => {
+        const key = JSON.stringify(b);
+        if (!seen.has(key)) {
+          seen.add(key);
+          branches.push(b);
+        }
+      };
+      for (const branch of existing) {
+        if (typeof branch.type === "string") {
+          if (types.includes(branch.type)) push(branch.type === "null" ? branch : { ...scoped, ...branch });
+        } else {
+          for (const t of types) push({ ...typed(t), ...branch });
+        }
+      }
+    } else {
+      branches = types.map(typed);
+    }
+    return { ...parent, anyOf: branches };
+  }
+  return out;
+}
+
 // src/scrape.ts
 function isZodSchema(value) {
   return typeof value === "object" && value !== null && typeof value.parse === "function";
@@ -2768,7 +2922,7 @@ async function buildScrapeBody(options) {
       body.response_format = json_schema;
     } else {
       const { z: z2 } = await import("zod");
-      body.response_format = z2.toJSONSchema(response_format);
+      body.response_format = normalizeJsonSchema(z2.toJSONSchema(response_format));
     }
   } else if (response_format) {
     body.response_format = response_format;
@@ -2805,47 +2959,6 @@ function processScrapeResponse(scrapeResponse, options) {
   return scrapeResponse.markdown;
 }
 
-// src/utils.ts
-var import_node_child_process = require("child_process");
-function formatError(error) {
-  if (typeof error === "object" && error !== null) {
-    if ("message" in error && typeof error.message === "string") {
-      return error.message;
-    }
-    try {
-      return JSON.stringify(error, null, 2);
-    } catch {
-      return String(error);
-    }
-  }
-  if (error instanceof Error) {
-    return error.message;
-  }
-  return String(error);
-}
-function openBrowser(url) {
-  const platform = process.platform;
-  let command;
-  let args;
-  if (platform === "darwin") {
-    command = "open";
-    args = [url];
-  } else if (platform === "win32") {
-    command = "rundll32";
-    args = ["url.dll,FileProtocolHandler", url];
-  } else {
-    command = "xdg-open";
-    args = [url];
-  }
-  const child = (0, import_node_child_process.spawn)(command, args, {
-    detached: true,
-    stdio: "ignore"
-  });
-  child.on("error", () => {
-  });
-  child.unref();
-}
-
 // src/session.ts
 var SESSION_START_TRIES = 3;
 var CLUSTER_OVERLOAD_RETRY_DELAY_MS = 3e4;
@@ -3595,7 +3708,7 @@ function prepareAgentRequest(data) {
   const apiData = { ...data };
   const rf = data.response_format;
   if (rf && typeof rf.parse === "function" && typeof rf.safeParse === "function") {
-    apiData.response_format = import_zod.z.toJSONSchema(rf);
+    apiData.response_format = normalizeJsonSchema(import_zod.z.toJSONSchema(rf));
     return { apiData, zodSchema: rf };
   }
   return { apiData, zodSchema: null };
@@ -4641,6 +4754,90 @@ function decryptFernet(token, key) {
   return Buffer.concat([decipher.update(ciphertext), decipher.final()]).toString("utf8");
 }
 
+// src/run-payloads.ts
+var import_node_crypto2 = require("crypto");
+var INLINE_FIELD_BYTES = 1024 * 1024;
+var MAX_PAYLOAD_BYTES = 256 * 1024 * 1024;
+async function offloadRunPayloads(client2, path, fields) {
+  const data = { ...fields };
+  const references = {};
+  if (data.result != null && typeof data.result !== "string") data.result = JSON.stringify(data.result);
+  for (const field of ["result", "logs", "variables"]) {
+    if (data[field] == null) continue;
+    const payload = Buffer.from(JSON.stringify(data[field]), "utf8");
+    if (payload.length > MAX_PAYLOAD_BYTES) throw new Error(`Function run ${field} exceeds the payload limit`);
+    if (payload.length <= INLINE_FIELD_BYTES) continue;
+    const checksum = (0, import_node_crypto2.createHash)("sha256").update(payload).digest("base64");
+    const prepared = await client2.post({
+      url: "/functions/{function_id}/runs/{run_id}/payloads/{field}/upload",
+      path: { ...path, field },
+      body: { size_bytes: payload.length, sha256: checksum },
+      headers: { "Content-Type": "application/json" },
+      throwOnError: true
+    });
+    const upload = prepared.data;
+    if (upload.reference.size_bytes !== payload.length || upload.reference.sha256 !== checksum) {
+      throw new Error("Run payload upload reference does not match the local payload");
+    }
+    if (new URL(upload.url).protocol !== "https:") throw new Error("Invalid run payload URL");
+    const response = await fetch(upload.url, {
+      method: "PUT",
+      body: payload,
+      headers: upload.headers,
+      redirect: "error",
+      signal: AbortSignal.timeout(3e5)
+    });
+    await response.body?.cancel();
+    if (!response.ok) throw new Error(`Run payload upload failed (${response.status})`);
+    references[field] = upload.reference;
+    if (field === "result" && typeof data.result === "string") data.result_preview = data.result.slice(0, 16e3);
+    delete data[field];
+  }
+  if (Object.keys(references).length) data.payloads = references;
+  return data;
+}
+async function resolveRunPayloads(input) {
+  const run = { ...input };
+  for (const [field, reference] of Object.entries(run.payloads ?? {})) {
+    if (!["result", "logs", "variables"].includes(field)) throw new Error("Unknown run payload field");
+    if (!Number.isSafeInteger(reference.size_bytes) || reference.size_bytes <= 0 || reference.size_bytes > 256 * 1024 * 1024) {
+      throw new Error("Invalid run payload size");
+    }
+    const url = run.payload_urls?.[field];
+    if (!url || new URL(url).protocol !== "https:") throw new Error("Invalid run payload URL");
+    const response = await fetch(url, { redirect: "error", signal: AbortSignal.timeout(3e5) });
+    if (!response.ok || !response.body) throw new Error(`Run payload download failed (${response.status})`);
+    const reader = response.body.getReader();
+    const chunks = [];
+    const hash = (0, import_node_crypto2.createHash)("sha256");
+    let size = 0;
+    try {
+      while (true) {
+        const { done, value: value2 } = await reader.read();
+        if (done) break;
+        size += value2.length;
+        if (size > reference.size_bytes) throw new Error("Run payload exceeds its declared size");
+        hash.update(value2);
+        chunks.push(value2);
+      }
+    } finally {
+      await reader.cancel();
+      reader.releaseLock();
+    }
+    if (size !== reference.size_bytes || hash.digest("base64") !== reference.sha256) {
+      throw new Error("Run payload failed size/checksum verification");
+    }
+    const value = JSON.parse(Buffer.concat(chunks, size).toString("utf8"));
+    if (field === "result" && value !== null && typeof value !== "string") throw new Error("Invalid stored result");
+    if (field === "logs" && (!Array.isArray(value) || !value.every((line) => typeof line === "string"))) throw new Error("Invalid stored logs");
+    if (field === "variables" && value !== null && (typeof value !== "object" || Array.isArray(value))) throw new Error("Invalid stored variables");
+    Object.assign(run, { [field]: value });
+  }
+  delete run.payloads;
+  delete run.payload_urls;
+  return run;
+}
+
 // src/functions.ts
 var DOWNLOAD_TIMEOUT_MS = 3e4;
 var FUNCTION_RUN_TIMEOUT_MS = 5 * 60 * 1e3;
@@ -4868,10 +5065,35 @@ var NotteFunction = class {
    */
   async getRun(functionRunId) {
     const functionId = await this.ensureInitialized();
-    const response = await functionRunGetMetadata({
-      client: this.client.getClient(),
-      throwOnError: true,
-      path: { function_id: functionId, run_id: functionRunId }
+    const response = await this.client.getClient().get({
+      url: "/functions/{function_id}/runs/{run_id}",
+      path: { function_id: functionId, run_id: functionRunId },
+      query: { payload_mode: "references" },
+      throwOnError: true
+    });
+    return resolveRunPayloads(response.data);
+  }
+  /**
+   * Update a run, uploading fields above 1 MiB directly to private storage.
+   *
+   * @param functionRunId - ID of a run belonging to this function.
+   * @param fields - Status and fields to update. Omitted fields remain unchanged.
+   * @returns Confirmation of the persisted update.
+   * @throws Error if a field exceeds 256 MiB or an upload fails; the update is not finalized.
+   * @example
+   * await fn.updateRun(runId, { status: 'closed', result: { records } });
+   */
+  async updateRun(functionRunId, fields) {
+    const functionId = await this.ensureInitialized();
+    const client2 = this.client.getClient();
+    const path = { function_id: functionId, run_id: functionRunId };
+    const body = await offloadRunPayloads(client2, path, fields);
+    const response = await client2.patch({
+      url: "/functions/{function_id}/runs/{run_id}",
+      path,
+      body,
+      headers: { "Content-Type": "application/json" },
+      throwOnError: true
     });
     return response.data;
   }
@@ -5228,7 +5450,7 @@ async function readFunctionStream(body, onLog, path, signal) {
 var import_node_fs2 = require("fs");
 var import_promises6 = require("fs/promises");
 var import_node_path4 = require("path");
-var import_node_crypto2 = require("crypto");
+var import_node_crypto3 = require("crypto");
 var import_node_stream = require("stream");
 var import_promises7 = require("stream/promises");
 var FileNotFoundError = class extends NotteError {
@@ -5495,7 +5717,7 @@ var RemoteFileStorage = class _RemoteFileStorage {
       }
     }
     const body = await files.stream(fileId);
-    const temporary = (0, import_node_path4.join)(localDir, `.${safeName}.${(0, import_node_crypto2.randomBytes)(8).toString("hex")}.part`);
+    const temporary = (0, import_node_path4.join)(localDir, `.${safeName}.${(0, import_node_crypto3.randomBytes)(8).toString("hex")}.part`);
     try {
       await (0, import_promises7.pipeline)(
         import_node_stream.Readable.fromWeb(body),
@@ -6274,6 +6496,7 @@ var createClient2 = (config) => {
   deleteSecret,
   deleteSessionFile,
   disconnectPaymentWallet,
+  downloadRunPayload,
   downloadSessionFile,
   functionCreate,
   functionDelete,
@@ -6330,6 +6553,7 @@ var createClient2 = (config) => {
   personaSmsList,
   personaUpdate,
   prepareAgentRequest,
+  prepareRunPayloadUpload,
   processScrapeResponse,
   profileCookiesGet,
   profileCookiesSet,