@sanity/client 7.1.0-views.0 → 7.1.0-views.1

package/dist/_chunks-es/dataMethods.js

@@ -1,16 +1,87 @@
 import { getIt } from "get-it";
 import { retry, jsonRequest, jsonResponse, progress, observable } from "get-it/middleware";
 import { Observable, from } from "rxjs";
+import { isRecord } from "./isRecord.js";
+import { getVersionFromId, isDraftId, getVersionId } from "@sanity/client/csm";
 import { combineLatestWith, map, filter } from "rxjs/operators";
-import { validateObject, validateInsert, requireDocumentId, validateDocumentId, resourceConfig, hasDataset, requestTag, printPreviewDraftsDeprecationWarning, validateApiPerspective, printCdnPreviewDraftsWarning } from "./config.js";
+import { validateObject, validateInsert, requireDocumentId, validateDocumentId, requireDocumentType, resourceConfig, hasDataset, requestTag, printPreviewDraftsDeprecationWarning, validateApiPerspective, printCdnPreviewDraftsWarning } from "./config.js";
 import { stegaClean } from "./stegaClean.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);
   }
 }
@@ -24,7 +95,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,
@@ -32,34 +103,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;
@@ -74,11 +167,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;
   }
 };
@@ -446,7 +539,9 @@ class ObservableTransaction extends BaseTransaction {
 }
 const projectHeader = "X-Sanity-Project-ID";
 function requestOptions(config, overrides = {}) {
-  const headers = {}, token = overrides.token || config.token;
+  const headers = {};
+  config.headers && Object.assign(headers, config.headers);
+  const token = overrides.token || config.token;
   token && (headers.Authorization = `Bearer ${token}`), !overrides.useGlobalApi && !config.useProjectHostname && config.projectId && (headers[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, {
@@ -466,7 +561,7 @@ const encodeQueryString = ({
   const searchParams = new URLSearchParams(), { tag, includeMutations, returnQuery, ...opts } = options;
   tag && searchParams.append("tag", tag), searchParams.append("query", query);
   for (const [key, value] of Object.entries(params))
-    searchParams.append(`$${key}`, JSON.stringify(value));
+    value !== void 0 && searchParams.append(`$${key}`, JSON.stringify(value));
   for (const [key, value] of Object.entries(opts))
     value && searchParams.append(key, `${value}`);
   return returnQuery === !1 && searchParams.append("returnQuery", "false"), includeMutations === !1 && searchParams.append("includeMutations", "false"), `?${searchParams}`;
@@ -482,17 +577,25 @@ function _fetch(config, httpRequest, _stega, query, _params = {}, options = {})
   const stega = "stega" in options ? {
     ..._stega || {},
     ...typeof options.stega == "boolean" ? { enabled: options.stega } : options.stega || {}
-  } : _stega, params = stega.enabled ? stegaClean(_params) : _params, mapResponse = options.filterResponse === !1 ? (res) => res : (res) => res.result, { cache, next, ...opts } = {
+  } : _stega, params = stega.enabled ? stegaClean(_params) : _params, mapResponse = options.filterResponse === !1 ? (res) => res : (res) => res.result, { cache, next, useEmulate, connections, ...opts } = {
     // Opt out of setting a `signal` on an internal `fetch` if one isn't provided.
     // This is necessary in React Server Components to avoid opting out of Request Memoization.
     useAbortSignal: typeof options.signal < "u",
     // Set `resultSourceMap' when stega is enabled, as it's required for encoding.
     resultSourceMap: stega.enabled ? "withKeyArraySelector" : options.resultSourceMap,
+    // Only use emulate if explicitly asked for
+    useEmulate: !1,
+    // Having connections is a special case for views
+    connections: void 0,
     ...options,
     // Default to not returning the query, unless `filterResponse` is `false`,
     // or `returnQuery` is explicitly set. `true` is the default in Content Lake, so skip if truthy
     returnQuery: options.filterResponse === !1 && options.returnQuery !== !1
-  }, reqOpts = typeof cache < "u" || typeof next < "u" ? { ...opts, fetch: { cache, next } } : opts, $request = _dataRequest(config, httpRequest, "query", { query, params }, reqOpts);
+  }, reqOpts = typeof cache < "u" || typeof next < "u" ? { ...opts, fetch: { cache, next } } : opts, $request = _dataRequest(config, httpRequest, useEmulate ? "emulate" : "query", useEmulate ? {
+    query,
+    params,
+    connections
+  } : { query, params }, reqOpts);
   return stega.enabled ? $request.pipe(
     combineLatestWith(
       from(
@@ -512,8 +615,24 @@ function _fetch(config, httpRequest, _stega, query, _params = {}, options = {})
   ) : $request.pipe(map(mapResponse));
 }
 function _getDocument(config, httpRequest, id, opts = {}) {
-  const options = {
-    uri: _getDataUrl(config, "doc", id),
+  const docId = (() => {
+    if (!opts.releaseId)
+      return id;
+    const versionId = getVersionFromId(id);
+    if (!versionId) {
+      if (isDraftId(id))
+        throw new Error(
+          `The document ID (\`${id}\`) is a draft, but \`options.releaseId\` is set as \`${opts.releaseId}\``
+        );
+      return getVersionId(id, opts.releaseId);
+    }
+    if (versionId !== opts.releaseId)
+      throw new Error(
+        `The document ID (\`${id}\`) is already a version of \`${versionId}\` release, but this does not match the provided \`options.releaseId\` (\`${opts.releaseId}\`)`
+      );
+    return id;
+  })(), options = {
+    uri: _getDataUrl(config, "doc", docId),
     json: !0,
     tag: opts.tag,
     signal: opts.signal
@@ -538,12 +657,33 @@ function _getDocuments(config, httpRequest, ids, opts = {}) {
     })
   );
 }
+function _getReleaseDocuments(config, httpRequest, releaseId, opts = {}) {
+  return _dataRequest(
+    config,
+    httpRequest,
+    "query",
+    {
+      query: "*[sanity::partOfRelease($releaseId)]",
+      params: {
+        releaseId
+      }
+    },
+    opts
+  );
+}
 function _createIfNotExists(config, httpRequest, doc, options) {
   return requireDocumentId("createIfNotExists", doc), _create(config, httpRequest, doc, "createIfNotExists", options);
 }
 function _createOrReplace(config, httpRequest, doc, options) {
   return requireDocumentId("createOrReplace", doc), _create(config, httpRequest, doc, "createOrReplace", options);
 }
+function _createVersion(config, httpRequest, doc, publishedId, options) {
+  return requireDocumentId("createVersion", doc), requireDocumentType("createVersion", doc), _action(config, httpRequest, {
+    actionType: "sanity.action.document.version.create",
+    publishedId,
+    document: doc
+  }, options);
+}
 function _delete(config, httpRequest, selection, options) {
   return _dataRequest(
     config,
@@ -553,6 +693,26 @@ function _delete(config, httpRequest, selection, options) {
     options
   );
 }
+function _discardVersion(config, httpRequest, versionId, purge = !1, options) {
+  return _action(config, httpRequest, {
+    actionType: "sanity.action.document.version.discard",
+    versionId,
+    purge
+  }, options);
+}
+function _replaceVersion(config, httpRequest, doc, options) {
+  return requireDocumentId("replaceVersion", doc), requireDocumentType("replaceVersion", doc), _action(config, httpRequest, {
+    actionType: "sanity.action.document.version.replace",
+    document: doc
+  }, options);
+}
+function _unpublishVersion(config, httpRequest, versionId, publishedId, options) {
+  return _action(config, httpRequest, {
+    actionType: "sanity.action.document.version.unpublish",
+    versionId,
+    publishedId
+  }, options);
+}
 function _mutate(config, httpRequest, mutations, options) {
   let mut;
   mutations instanceof Patch || mutations instanceof ObservablePatch ? mut = { patch: mutations.serialize() } : mutations instanceof Transaction || mutations instanceof ObservableTransaction ? mut = mutations.serialize() : mut = mutations;
@@ -570,7 +730,7 @@ function _action(config, httpRequest, actions, options) {
   );
 }
 function _dataRequest(config, httpRequest, endpoint, body, options = {}) {
-  const isMutation = endpoint === "mutate", isAction = endpoint === "actions", isQuery2 = endpoint === "query", strQuery = isMutation || isAction ? "" : encodeQueryString(body), useGet = !isMutation && !isAction && strQuery.length < getQuerySizeLimit, stringQuery = useGet ? strQuery : "", returnFirst = options.returnFirst, { timeout, token, tag, headers, returnQuery, lastLiveEventId, cacheMode } = options, uri = _getDataUrl(config, endpoint, stringQuery), reqOptions = {
+  const isMutation = endpoint === "mutate", isAction = endpoint === "actions", isQuery2 = endpoint === "query", isEmulate2 = endpoint === "emulate", strQuery = isMutation || isAction || isEmulate2 ? "" : encodeQueryString(body), useGet = !isMutation && !isAction && !isEmulate2 && strQuery.length < getQuerySizeLimit, stringQuery = useGet ? strQuery : "", returnFirst = options.returnFirst, { timeout, token, tag, headers, returnQuery, lastLiveEventId, cacheMode } = options, uri = _getDataUrl(config, endpoint, stringQuery), reqOptions = {
     method: useGet ? "GET" : "POST",
     uri,
     json: !0,
@@ -613,12 +773,12 @@ function _create(config, httpRequest, doc, op, options = {}) {
   const mutation = { [op]: doc }, opts = Object.assign({ returnFirst: !0, returnDocuments: !0 }, options);
   return _dataRequest(config, httpRequest, "mutate", { mutations: [mutation] }, opts);
 }
-const hasDataConfig = (config) => config.dataset !== void 0 && config.projectId !== void 0 || config["~experimental_resource"] !== void 0, isQuery = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "query")), isViewQuery = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "views")), isMutate = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "mutate")), isDoc = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "doc", "")), isListener = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "listen")), isHistory = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "history", "")), isData = (config, uri) => uri.startsWith("/data/") || isQuery(config, uri) || isMutate(config, uri) || isDoc(config, uri) || isListener(config, uri) || isHistory(config, uri) || isViewQuery(config, uri);
+const hasDataConfig = (config) => config.dataset !== void 0 && config.projectId !== void 0 || config["~experimental_resource"] !== void 0, isQuery = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "query")), isViewQuery = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "views")), isEmulate = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "emulate")), isMutate = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "mutate")), isDoc = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "doc", "")), isListener = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "listen")), isHistory = (config, uri) => hasDataConfig(config) && uri.startsWith(_getDataUrl(config, "history", "")), isData = (config, uri) => uri.startsWith("/data/") || isQuery(config, uri) || isMutate(config, uri) || isDoc(config, uri) || isListener(config, uri) || isHistory(config, uri) || isViewQuery(config, uri) || isEmulate(config, uri);
 function _requestObservable(config, httpRequest, options) {
   const uri = options.url || options.uri, canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && isData(config, uri) : options.canUseCdn;
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn;
   const tag = options.tag && config.requestTagPrefix ? [config.requestTagPrefix, options.tag].join(".") : options.tag || config.requestTagPrefix;
-  if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && isQuery(config, uri)) {
+  if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && (isQuery(config, uri) || isEmulate(config, uri))) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
     resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
     const perspectiveOption = options.perspective || config.perspective;
@@ -653,7 +813,7 @@ function _getDataUrl(config, operation, path) {
   const catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
   return `/data${path !== void 0 ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
 }
-function _getUrl(config, uri, canUseCdn = !1, options = {}) {
+function _getUrl(config, uri, canUseCdn = !1) {
   const { url, cdnUrl } = config;
   return `${canUseCdn ? cdnUrl : url}/${uri.replace(/^\//, "")}`;
 }
@@ -714,17 +874,24 @@ export {
   _create,
   _createIfNotExists,
   _createOrReplace,
+  _createVersion,
   _dataRequest,
   _delete,
+  _discardVersion,
   _fetch,
   _getDataUrl,
   _getDocument,
   _getDocuments,
+  _getReleaseDocuments,
   _getUrl,
   _mutate,
+  _replaceVersion,
   _request,
   _requestObservable,
+  _unpublishVersion,
   defineHttpRequest,
-  encodeQueryString
+  encodeQueryString,
+  formatQueryParseError,
+  isQueryParseError
 };
 //# sourceMappingURL=dataMethods.js.map