@sanity/client 7.2.2 → 7.4.0

package/dist/index.js

@@ -2,18 +2,88 @@ import { getIt } from "get-it";
 import { adapter, environment } from "get-it";
 import { retry, jsonRequest, jsonResponse, progress, observable, debug, headers, agent } from "get-it/middleware";
 import { Observable, defer, of, isObservable, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, throwError, timer, tap, finalize, share, merge, EMPTY, map as map$1, firstValueFrom } from "rxjs";
+import { isRecord } from "./_chunks-es/isRecord.js";
 import { stegaClean } from "./_chunks-es/stegaClean.js";
 import { combineLatestWith, map, filter, finalize as finalize$1 } from "rxjs/operators";
 import { getVersionFromId, isDraftId, getVersionId, getDraftId, isVersionId, getPublishedId } from "@sanity/client/csm";
 import { customAlphabet } from "nanoid";
 import { validateObject, validateInsert, requireDocumentId, validateDocumentId, requireDocumentType, resourceConfig, hasDataset, requestTag, printPreviewDraftsDeprecationWarning, validateApiPerspective, printCdnPreviewDraftsWarning, validateAssetType, resourceGuard, dataset, validateVersionIdMatch, defaultConfig, initConfig, printNoDefaultExport } from "./_chunks-es/config.js";
+const NEWLINE = /\r\n|[\n\r\u2028\u2029]/;
+function codeFrame(query, location2, message) {
+  const lines = query.split(NEWLINE), loc = {
+    start: columnToLine(location2.start, lines),
+    end: location2.end ? columnToLine(location2.end, lines) : void 0
+  }, { start, end, markerLines } = getMarkerLines(loc, lines), numberMaxWidth = `${end}`.length;
+  return query.split(NEWLINE, end).slice(start, end).map((line, index) => {
+    const number = start + 1 + index, gutter = ` ${` ${number}`.slice(-numberMaxWidth)} |`, hasMarker = markerLines[number], lastMarkerLine = !markerLines[number + 1];
+    if (!hasMarker)
+      return ` ${gutter}${line.length > 0 ? ` ${line}` : ""}`;
+    let markerLine = "";
+    if (Array.isArray(hasMarker)) {
+      const markerSpacing = line.slice(0, Math.max(hasMarker[0] - 1, 0)).replace(/[^\t]/g, " "), numberOfMarkers = hasMarker[1] || 1;
+      markerLine = [
+        `
+ `,
+        gutter.replace(/\d/g, " "),
+        " ",
+        markerSpacing,
+        "^".repeat(numberOfMarkers)
+      ].join(""), lastMarkerLine && message && (markerLine += " " + message);
+    }
+    return [">", gutter, line.length > 0 ? ` ${line}` : "", markerLine].join("");
+  }).join(`
+`);
+}
+function getMarkerLines(loc, source) {
+  const startLoc = { ...loc.start }, endLoc = { ...startLoc, ...loc.end }, linesAbove = 2, linesBelow = 3, startLine = startLoc.line ?? -1, startColumn = startLoc.column ?? 0, endLine = endLoc.line, endColumn = endLoc.column;
+  let start = Math.max(startLine - (linesAbove + 1), 0), end = Math.min(source.length, endLine + linesBelow);
+  startLine === -1 && (start = 0), endLine === -1 && (end = source.length);
+  const lineDiff = endLine - startLine, markerLines = {};
+  if (lineDiff)
+    for (let i = 0; i <= lineDiff; i++) {
+      const lineNumber = i + startLine;
+      if (!startColumn)
+        markerLines[lineNumber] = !0;
+      else if (i === 0) {
+        const sourceLength = source[lineNumber - 1].length;
+        markerLines[lineNumber] = [startColumn, sourceLength - startColumn + 1];
+      } else if (i === lineDiff)
+        markerLines[lineNumber] = [0, endColumn];
+      else {
+        const sourceLength = source[lineNumber - i].length;
+        markerLines[lineNumber] = [0, sourceLength];
+      }
+    }
+  else
+    startColumn === endColumn ? startColumn ? markerLines[startLine] = [startColumn, 0] : markerLines[startLine] = !0 : markerLines[startLine] = [startColumn, endColumn - startColumn];
+  return { start, end, markerLines };
+}
+function columnToLine(column, lines) {
+  let offset = 0;
+  for (let i = 0; i < lines.length; i++) {
+    const lineLength = lines[i].length + 1;
+    if (offset + lineLength > column)
+      return {
+        line: i + 1,
+        // 1-based line
+        column: column - offset
+        // 0-based column
+      };
+    offset += lineLength;
+  }
+  return {
+    line: lines.length,
+    column: lines[lines.length - 1]?.length ?? 0
+  };
+}
+const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
 class ClientError extends Error {
   response;
   statusCode = 400;
   responseBody;
   details;
-  constructor(res) {
-    const props = extractErrorProps(res);
+  constructor(res, context) {
+    const props = extractErrorProps(res, context);
     super(props.message), Object.assign(this, props);
   }
 }
@@ -27,7 +97,7 @@ class ServerError extends Error {
     super(props.message), Object.assign(this, props);
   }
 }
-function extractErrorProps(res) {
+function extractErrorProps(res, context) {
   const body = res.body, props = {
     response: res,
     statusCode: res.statusCode,
@@ -35,34 +105,56 @@ function extractErrorProps(res) {
     message: "",
     details: void 0
   };
-  if (body.error && body.message)
-    return props.message = `${body.error} - ${body.message}`, props;
-  if (isMutationError(body) || isActionError(body)) {
-    const allItems = body.error.items || [], items = allItems.slice(0, 5).map((item) => item.error?.description).filter(Boolean);
+  if (!isRecord(body))
+    return props.message = httpErrorMessage(res, body), props;
+  const error = body.error;
+  if (typeof error == "string" && typeof body.message == "string")
+    return props.message = `${error} - ${body.message}`, props;
+  if (typeof error != "object" || error === null)
+    return typeof error == "string" ? props.message = error : typeof body.message == "string" ? props.message = body.message : props.message = httpErrorMessage(res, body), props;
+  if (isMutationError(error) || isActionError(error)) {
+    const allItems = error.items || [], items = allItems.slice(0, MAX_ITEMS_IN_ERROR_MESSAGE).map((item) => item.error?.description).filter(Boolean);
     let itemsStr = items.length ? `:
 - ${items.join(`
 - `)}` : "";
-    return allItems.length > 5 && (itemsStr += `
-...and ${allItems.length - 5} more`), props.message = `${body.error.description}${itemsStr}`, props.details = body.error, props;
+    return allItems.length > MAX_ITEMS_IN_ERROR_MESSAGE && (itemsStr += `
+...and ${allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE} more`), props.message = `${error.description}${itemsStr}`, props.details = body.error, props;
+  }
+  if (isQueryParseError(error)) {
+    const tag = context?.options?.query?.tag;
+    return props.message = formatQueryParseError(error, tag), props.details = body.error, props;
   }
-  return body.error && body.error.description ? (props.message = body.error.description, props.details = body.error, props) : (props.message = body.error || body.message || httpErrorMessage(res), props);
+  return "description" in error && typeof error.description == "string" ? (props.message = error.description, props.details = error, props) : (props.message = httpErrorMessage(res, body), props);
 }
-function isMutationError(body) {
-  return isPlainObject(body) && isPlainObject(body.error) && body.error.type === "mutationError" && typeof body.error.description == "string";
+function isMutationError(error) {
+  return "type" in error && error.type === "mutationError" && "description" in error && typeof error.description == "string";
 }
-function isActionError(body) {
-  return isPlainObject(body) && isPlainObject(body.error) && body.error.type === "actionError" && typeof body.error.description == "string";
+function isActionError(error) {
+  return "type" in error && error.type === "actionError" && "description" in error && typeof error.description == "string";
 }
-function isPlainObject(obj) {
-  return typeof obj == "object" && obj !== null && !Array.isArray(obj);
+function isQueryParseError(error) {
+  return isRecord(error) && error.type === "queryParseError" && typeof error.query == "string" && typeof error.start == "number" && typeof error.end == "number";
 }
-function httpErrorMessage(res) {
-  const statusMessage = res.statusMessage ? ` ${res.statusMessage}` : "";
-  return `${res.method}-request to ${res.url} resulted in HTTP ${res.statusCode}${statusMessage}`;
+function formatQueryParseError(error, tag) {
+  const { query, start, end, description } = error;
+  if (!query || typeof start > "u")
+    return `GROQ query parse error: ${description}`;
+  const withTag = tag ? `
+
+Tag: ${tag}` : "";
+  return `GROQ query parse error:
+${codeFrame(query, { start, end }, description)}${withTag}`;
+}
+function httpErrorMessage(res, body) {
+  const details = typeof body == "string" ? ` (${sliceWithEllipsis(body, 100)})` : "", statusMessage = res.statusMessage ? ` ${res.statusMessage}` : "";
+  return `${res.method}-request to ${res.url} resulted in HTTP ${res.statusCode}${statusMessage}${details}`;
 }
 function stringifyBody(body, res) {
   return (res.headers["content-type"] || "").toLowerCase().indexOf("application/json") !== -1 ? JSON.stringify(body, null, 2) : body;
 }
+function sliceWithEllipsis(str, max) {
+  return str.length > max ? `${str.slice(0, max)}\u2026` : str;
+}
 class CorsOriginError extends Error {
   projectId;
   addOriginUrl;
@@ -77,11 +169,11 @@ class CorsOriginError extends Error {
   }
 }
 const httpError = {
-  onResponse: (res) => {
+  onResponse: (res, context) => {
     if (res.statusCode >= 500)
       throw new ServerError(res);
     if (res.statusCode >= 400)
-      throw new ClientError(res);
+      throw new ClientError(res, context);
     return res;
   }
 };
@@ -172,7 +264,8 @@ function connectWithESInstance(es, events) {
         return;
       }
       if (message.type === "channelError") {
-        observer.error(new ChannelError(extractErrorMessage(event?.data), event.data));
+        const tag = new URL(es.url).searchParams.get("tag");
+        observer.error(new ChannelError(extractErrorMessage(event?.data, tag), event.data));
         return;
       }
       if (message.type === "disconnect") {
@@ -211,8 +304,9 @@ function parseEvent(message) {
     return [err, null];
   }
 }
-function extractErrorMessage(err) {
-  return err.error ? err.error.description ? err.error.description : typeof err.error == "string" ? err.error : JSON.stringify(err.error, null, 2) : err.message || "Unknown listener error";
+function extractErrorMessage(err, tag) {
+  const error = err.error;
+  return error ? isQueryParseError(error) ? formatQueryParseError(error, tag) : error.description ? error.description : typeof error == "string" ? error : JSON.stringify(error, null, 2) : err.message || "Unknown listener error";
 }
 function isEmptyObject(data) {
   for (const _ in data)
@@ -555,7 +649,9 @@ class ObservableTransaction extends BaseTransaction {
 }
 const projectHeader = "X-Sanity-Project-ID";
 function requestOptions(config, overrides = {}) {
-  const headers2 = {}, token = overrides.token || config.token;
+  const headers2 = {};
+  config.headers && Object.assign(headers2, config.headers);
+  const token = overrides.token || config.token;
   token && (headers2.Authorization = `Bearer ${token}`), !overrides.useGlobalApi && !config.useProjectHostname && config.projectId && (headers2[projectHeader] = config.projectId);
   const withCredentials = !!(typeof overrides.withCredentials > "u" ? config.withCredentials : overrides.withCredentials), timeout = typeof overrides.timeout > "u" ? config.timeout : overrides.timeout;
   return Object.assign({}, overrides, {
@@ -873,6 +969,22 @@ function _generate(client, httpRequest, request) {
     body: request
   });
 }
+function _patch(client, httpRequest, request) {
+  const dataset2 = hasDataset(client.config());
+  return _request(client, httpRequest, {
+    method: "POST",
+    uri: `/agent/action/patch/${dataset2}`,
+    body: request
+  });
+}
+function _prompt(client, httpRequest, request) {
+  const dataset2 = hasDataset(client.config());
+  return _request(client, httpRequest, {
+    method: "POST",
+    uri: `/agent/action/prompt/${dataset2}`,
+    body: request
+  });
+}
 function _transform(client, httpRequest, request) {
   const dataset2 = hasDataset(client.config());
   return _request(client, httpRequest, {
@@ -944,6 +1056,21 @@ class AgentActionsClient {
   translate(request) {
     return lastValueFrom(_translate(this.#client, this.#httpRequest, request));
   }
+  /**
+   * Run a raw instruction and return the result either as text or json
+   * @param request - prompt request
+   */
+  prompt(request) {
+    return lastValueFrom(_prompt(this.#client, this.#httpRequest, request));
+  }
+  /**
+   * Patch a document using a schema aware API.
+   * Does not use an LLM, but uses the schema to ensure paths and values matches the schema.
+   * @param request - instruction request
+   */
+  patch(request) {
+    return lastValueFrom(_patch(this.#client, this.#httpRequest, request));
+  }
 }
 class ObservableAssetsClient {
   #client;
@@ -1050,13 +1177,11 @@ const MAX_URL_LENGTH = 14800, possibleOptions = [
   includeResult: !0
 };
 function _listen(query, params, opts = {}) {
-  const { url, token, withCredentials, requestTagPrefix } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = { ...defaults(opts, defaultOptions), tag }, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({ query, params, options: { tag, ...listenOpts } }), uri = `${url}${_getDataUrl(this, "listen", qs)}`;
+  const { url, token, withCredentials, requestTagPrefix, headers: configHeaders } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = { ...defaults(opts, defaultOptions), tag }, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({ query, params, options: { tag, ...listenOpts } }), uri = `${url}${_getDataUrl(this, "listen", qs)}`;
   if (uri.length > MAX_URL_LENGTH)
     return throwError(() => new Error("Query too large for listener"));
   const listenFor = options.events ? options.events : ["mutation"], esOptions = {};
-  return withCredentials && (esOptions.withCredentials = !0), token && (esOptions.headers = {
-    Authorization: `Bearer ${token}`
-  }), connectEventSource(() => (
+  return withCredentials && (esOptions.withCredentials = !0), (token || configHeaders) && (esOptions.headers = {}, token && (esOptions.headers.Authorization = `Bearer ${token}`), configHeaders && Object.assign(esOptions.headers, configHeaders)), connectEventSource(() => (
     // use polyfill if there is no global EventSource or if we need to set headers
     (typeof EventSource > "u" || esOptions.headers ? eventSourcePolyfill : of(EventSource)).pipe(map((EventSource2) => new EventSource2(uri, esOptions)))
   ), listenFor).pipe(
@@ -1114,7 +1239,8 @@ class LiveClient {
       apiVersion: _apiVersion,
       token,
       withCredentials,
-      requestTagPrefix
+      requestTagPrefix,
+      headers: configHeaders
     } = this.#client.config(), apiVersion = _apiVersion.replace(/^v/, "");
     if (apiVersion !== "X" && apiVersion < requiredApiVersion)
       throw new Error(
@@ -1127,9 +1253,7 @@ class LiveClient {
     const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
     tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
     const esOptions = {};
-    includeDrafts && token && (esOptions.headers = {
-      Authorization: `Bearer ${token}`
-    }), includeDrafts && withCredentials && (esOptions.withCredentials = !0);
+    includeDrafts && withCredentials && (esOptions.withCredentials = !0), (includeDrafts && token || configHeaders) && (esOptions.headers = {}, includeDrafts && token && (esOptions.headers.Authorization = `Bearer ${token}`), configHeaders && Object.assign(esOptions.headers, configHeaders));
     const key = `${url.href}::${JSON.stringify(esOptions)}`, existing = eventsCache.get(key);
     if (existing)
       return existing;
@@ -2386,7 +2510,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "7.2.2";
+var name = "@sanity/client", version = "7.4.0";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),
@@ -2424,6 +2548,8 @@ export {
   connectEventSource,
   createClient,
   deprecatedCreateClient as default,
+  formatQueryParseError,
+  isQueryParseError,
   requester,
   adapter as unstable__adapter,
   environment as unstable__environment,