@sanity/client 6.4.6-canary.0 → 6.4.6

package/dist/index.d.ts

@@ -1565,6 +1565,8 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   uri?: string
   canUseCdn?: boolean
   tag?: string
+  resultSourceMap?: boolean
+  perspective?: ClientPerspective
 }
 
 /** @public */
@@ -1592,6 +1594,8 @@ export declare interface ResponseEvent<T = unknown> {
 
 /** @public */
 export declare type ResponseQueryOptions<T = 'next'> = RequestOptions & {
+  perspective?: ClientPerspective
+  resultSourceMap?: boolean
   cache?: RequestInit['cache']
   next?: T extends keyof RequestInit ? RequestInit[T] : never
 }

package/dist/index.js

@@ -4,7 +4,7 @@ export { adapter as unstable__adapter, environment as unstable__environment } fr
 import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
 var name = "@sanity/client";
-var version = "6.4.6-canary.0";
+var version = "6.4.6";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
@@ -158,47 +158,9 @@ function shouldRetry(err, attempt, options) {
   if ((isSafe || isQuery) && isRetriableResponse) return true;
   return retry.shouldRetry(err, attempt, options);
 }
-const projectHeader = "X-Sanity-Project-ID";
-function requestOptions(config) {
-  let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  const headers = {};
-  const token = overrides.token || config.token;
-  if (token) {
-    headers.Authorization = "Bearer ".concat(token);
-  }
-  if (!overrides.useGlobalApi && !config.useProjectHostname && config.projectId) {
-    headers[projectHeader] = config.projectId;
-  }
-  const withCredentials = Boolean(typeof overrides.withCredentials === "undefined" ? config.token || config.withCredentials : overrides.withCredentials);
-  const timeout = typeof overrides.timeout === "undefined" ? config.timeout : overrides.timeout;
-  return Object.assign({}, overrides, {
-    headers: Object.assign({}, headers, overrides.headers || {}),
-    timeout: typeof timeout === "undefined" ? 5 * 60 * 1e3 : timeout,
-    proxy: overrides.proxy || config.proxy,
-    json: true,
-    withCredentials,
-    fetch: typeof overrides.fetch === "object" && typeof config.fetch === "object" ? {
-      ...config.fetch,
-      ...overrides.fetch
-    } : overrides.fetch || config.fetch
-  });
-}
-function getSelection(sel) {
-  if (typeof sel === "string" || Array.isArray(sel)) {
-    return {
-      id: sel
-    };
-  }
-  if (typeof sel === "object" && sel !== null && "query" in sel && typeof sel.query === "string") {
-    return "params" in sel && typeof sel.params === "object" && sel.params !== null ? {
-      query: sel.query,
-      params: sel.params
-    } : {
-      query: sel.query
-    };
-  }
-  const selectionOpts = ["* Document ID (<docId>)", "* Array of document IDs", "* Object containing `query`"].join("\n");
-  throw new Error("Unknown selection - must be one of:\n\n".concat(selectionOpts));
+const BASE_URL = "https://www.sanity.io/help/";
+function generateHelpUrl(slug) {
+  return BASE_URL + slug;
 }
 const VALID_ASSET_TYPES = ["image", "file"];
 const VALID_INSERT_LOCATIONS = ["before", "after", "replace"];
@@ -258,6 +220,153 @@ const requestTag = tag => {
   }
   return tag;
 };
+function once(fn) {
+  let didCall = false;
+  let returnValue;
+  return function () {
+    if (didCall) {
+      return returnValue;
+    }
+    returnValue = fn(...arguments);
+    didCall = true;
+    return returnValue;
+  };
+}
+const createWarningPrinter = message =>
+// eslint-disable-next-line no-console
+once(function () {
+  for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+    args[_key] = arguments[_key];
+  }
+  return console.warn(message.join(" "), ...args);
+});
+const printCdnWarning = createWarningPrinter(["Since you haven't set a value for `useCdn`, we will deliver content using our", "global, edge-cached API-CDN. If you wish to have content delivered faster, set", "`useCdn: false` to use the Live API. Note: You may incur higher costs using the live API."]);
+const printBrowserTokenWarning = createWarningPrinter(["You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.", "See ".concat(generateHelpUrl("js-client-browser-token"), " for more information and how to hide this warning.")]);
+const printNoApiVersionSpecifiedWarning = createWarningPrinter(["Using the Sanity client without specifying an API version is deprecated.", "See ".concat(generateHelpUrl("js-client-api-version"))]);
+const printNoDefaultExport = createWarningPrinter(["The default export of @sanity/client has been deprecated. Use the named export `createClient` instead."]);
+const defaultCdnHost = "apicdn.sanity.io";
+const defaultConfig = {
+  apiHost: "https://api.sanity.io",
+  apiVersion: "1",
+  useProjectHostname: true
+};
+const LOCALHOSTS = ["localhost", "127.0.0.1", "0.0.0.0"];
+const isLocal = host => LOCALHOSTS.indexOf(host) !== -1;
+const validateApiVersion = function validateApiVersion2(apiVersion) {
+  if (apiVersion === "1" || apiVersion === "X") {
+    return;
+  }
+  const apiDate = new Date(apiVersion);
+  const apiVersionValid = /^\d{4}-\d{2}-\d{2}$/.test(apiVersion) && apiDate instanceof Date && apiDate.getTime() > 0;
+  if (!apiVersionValid) {
+    throw new Error("Invalid API version string, expected `1` or date in format `YYYY-MM-DD`");
+  }
+};
+const validateApiPerspective = function validateApiPerspective2(perspective) {
+  switch (perspective) {
+    case "previewDrafts":
+    case "published":
+    case "raw":
+      return;
+    default:
+      throw new TypeError("Invalid API perspective string, expected `published`, `previewDrafts` or `raw`");
+  }
+};
+const initConfig = (config, prevConfig) => {
+  const specifiedConfig = Object.assign({}, prevConfig, config);
+  if (!specifiedConfig.apiVersion) {
+    printNoApiVersionSpecifiedWarning();
+  }
+  const newConfig = Object.assign({}, defaultConfig, specifiedConfig);
+  const projectBased = newConfig.useProjectHostname;
+  if (typeof Promise === "undefined") {
+    const helpUrl = generateHelpUrl("js-client-promise-polyfill");
+    throw new Error("No native Promise-implementation found, polyfill needed - see ".concat(helpUrl));
+  }
+  if (projectBased && !newConfig.projectId) {
+    throw new Error("Configuration must contain `projectId`");
+  }
+  if (typeof newConfig.perspective === "string") {
+    validateApiPerspective(newConfig.perspective);
+  }
+  if ("encodeSourceMapAtPath" in newConfig || "encodeSourceMap" in newConfig || "studioUrl" in newConfig || "logger" in newConfig) {
+    throw new Error("It looks like you're using options meant for '@sanity/preview-kit/client', such as 'encodeSourceMapAtPath', 'encodeSourceMap', 'studioUrl' and 'logger'. Make sure you're using the right import.");
+  }
+  const isBrowser = typeof window !== "undefined" && window.location && window.location.hostname;
+  const isLocalhost = isBrowser && isLocal(window.location.hostname);
+  if (isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true) {
+    printBrowserTokenWarning();
+  } else if (typeof newConfig.useCdn === "undefined") {
+    printCdnWarning();
+  }
+  if (projectBased) {
+    projectId(newConfig.projectId);
+  }
+  if (newConfig.dataset) {
+    dataset(newConfig.dataset);
+  }
+  if ("requestTagPrefix" in newConfig) {
+    newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0;
+  }
+  newConfig.apiVersion = "".concat(newConfig.apiVersion).replace(/^v/, "");
+  newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost;
+  newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials;
+  validateApiVersion(newConfig.apiVersion);
+  const hostParts = newConfig.apiHost.split("://", 2);
+  const protocol = hostParts[0];
+  const host = hostParts[1];
+  const cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
+  if (newConfig.useProjectHostname) {
+    newConfig.url = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(host, "/v").concat(newConfig.apiVersion);
+    newConfig.cdnUrl = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(cdnHost, "/v").concat(newConfig.apiVersion);
+  } else {
+    newConfig.url = "".concat(newConfig.apiHost, "/v").concat(newConfig.apiVersion);
+    newConfig.cdnUrl = newConfig.url;
+  }
+  return newConfig;
+};
+const projectHeader = "X-Sanity-Project-ID";
+function requestOptions(config) {
+  let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  const headers = {};
+  const token = overrides.token || config.token;
+  if (token) {
+    headers.Authorization = "Bearer ".concat(token);
+  }
+  if (!overrides.useGlobalApi && !config.useProjectHostname && config.projectId) {
+    headers[projectHeader] = config.projectId;
+  }
+  const withCredentials = Boolean(typeof overrides.withCredentials === "undefined" ? config.token || config.withCredentials : overrides.withCredentials);
+  const timeout = typeof overrides.timeout === "undefined" ? config.timeout : overrides.timeout;
+  return Object.assign({}, overrides, {
+    headers: Object.assign({}, headers, overrides.headers || {}),
+    timeout: typeof timeout === "undefined" ? 5 * 60 * 1e3 : timeout,
+    proxy: overrides.proxy || config.proxy,
+    json: true,
+    withCredentials,
+    fetch: typeof overrides.fetch === "object" && typeof config.fetch === "object" ? {
+      ...config.fetch,
+      ...overrides.fetch
+    } : overrides.fetch || config.fetch
+  });
+}
+function getSelection(sel) {
+  if (typeof sel === "string" || Array.isArray(sel)) {
+    return {
+      id: sel
+    };
+  }
+  if (typeof sel === "object" && sel !== null && "query" in sel && typeof sel.query === "string") {
+    return "params" in sel && typeof sel.params === "object" && sel.params !== null ? {
+      query: sel.query,
+      params: sel.params
+    } : {
+      query: sel.query
+    };
+  }
+  const selectionOpts = ["* Document ID (<docId>)", "* Array of document IDs", "* Object containing `query`"].join("\n");
+  throw new Error("Unknown selection - must be one of:\n\n".concat(selectionOpts));
+}
 const encodeQueryString = _ref2 => {
   let {
     query,
@@ -866,6 +975,7 @@ function _dataRequest(client, httpRequest, endpoint, body) {
     token,
     tag,
     perspective: options.perspective,
+    resultSourceMap: options.resultSourceMap,
     canUseCdn: isQuery,
     signal: options.signal,
     fetch: options.fetch
@@ -901,6 +1011,7 @@ function _create(client, httpRequest, doc, op) {
   }, opts);
 }
 function _requestObservable(client, httpRequest, options) {
+  var _a;
   const uri = options.url || options.uri;
   const config = client.config();
   const canUseCdn = typeof options.canUseCdn === "undefined" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/") === 0 : options.canUseCdn;
@@ -913,15 +1024,17 @@ function _requestObservable(client, httpRequest, options) {
     };
   }
   if (["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/query/") === 0) {
-    if (config.resultSourceMap) {
+    if ((_a = options.resultSourceMap) != null ? _a : config.resultSourceMap) {
       options.query = {
         resultSourceMap: true,
         ...options.query
       };
     }
-    if (typeof config.perspective === "string" && config.perspective !== "raw") {
+    const perspective = options.perspective || config.perspective;
+    if (typeof perspective === "string" && perspective !== "raw") {
+      validateApiPerspective(perspective);
       options.query = {
-        perspective: config.perspective,
+        perspective,
         ...options.query
       };
     }
@@ -1076,115 +1189,6 @@ function optionsFromFile(opts, file) {
     contentType: file.type
   }, opts);
 }
-const BASE_URL = "https://www.sanity.io/help/";
-function generateHelpUrl(slug) {
-  return BASE_URL + slug;
-}
-function once(fn) {
-  let didCall = false;
-  let returnValue;
-  return function () {
-    if (didCall) {
-      return returnValue;
-    }
-    returnValue = fn(...arguments);
-    didCall = true;
-    return returnValue;
-  };
-}
-const createWarningPrinter = message =>
-// eslint-disable-next-line no-console
-once(function () {
-  for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-    args[_key] = arguments[_key];
-  }
-  return console.warn(message.join(" "), ...args);
-});
-const printCdnWarning = createWarningPrinter(["Since you haven't set a value for `useCdn`, we will deliver content using our", "global, edge-cached API-CDN. If you wish to have content delivered faster, set", "`useCdn: false` to use the Live API. Note: You may incur higher costs using the live API."]);
-const printBrowserTokenWarning = createWarningPrinter(["You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.", "See ".concat(generateHelpUrl("js-client-browser-token"), " for more information and how to hide this warning.")]);
-const printNoApiVersionSpecifiedWarning = createWarningPrinter(["Using the Sanity client without specifying an API version is deprecated.", "See ".concat(generateHelpUrl("js-client-api-version"))]);
-const printNoDefaultExport = createWarningPrinter(["The default export of @sanity/client has been deprecated. Use the named export `createClient` instead."]);
-const defaultCdnHost = "apicdn.sanity.io";
-const defaultConfig = {
-  apiHost: "https://api.sanity.io",
-  apiVersion: "1",
-  useProjectHostname: true
-};
-const LOCALHOSTS = ["localhost", "127.0.0.1", "0.0.0.0"];
-const isLocal = host => LOCALHOSTS.indexOf(host) !== -1;
-const validateApiVersion = function validateApiVersion2(apiVersion) {
-  if (apiVersion === "1" || apiVersion === "X") {
-    return;
-  }
-  const apiDate = new Date(apiVersion);
-  const apiVersionValid = /^\d{4}-\d{2}-\d{2}$/.test(apiVersion) && apiDate instanceof Date && apiDate.getTime() > 0;
-  if (!apiVersionValid) {
-    throw new Error("Invalid API version string, expected `1` or date in format `YYYY-MM-DD`");
-  }
-};
-const validateApiPerspective = function validateApiPerspective2(perspective) {
-  switch (perspective) {
-    case "previewDrafts":
-    case "published":
-    case "raw":
-      return;
-    default:
-      throw new TypeError("Invalid API perspective string, expected `published`, `previewDrafts` or `raw`");
-  }
-};
-const initConfig = (config, prevConfig) => {
-  const specifiedConfig = Object.assign({}, prevConfig, config);
-  if (!specifiedConfig.apiVersion) {
-    printNoApiVersionSpecifiedWarning();
-  }
-  const newConfig = Object.assign({}, defaultConfig, specifiedConfig);
-  const projectBased = newConfig.useProjectHostname;
-  if (typeof Promise === "undefined") {
-    const helpUrl = generateHelpUrl("js-client-promise-polyfill");
-    throw new Error("No native Promise-implementation found, polyfill needed - see ".concat(helpUrl));
-  }
-  if (projectBased && !newConfig.projectId) {
-    throw new Error("Configuration must contain `projectId`");
-  }
-  if (typeof newConfig.perspective === "string") {
-    validateApiPerspective(newConfig.perspective);
-  }
-  if ("encodeSourceMapAtPath" in newConfig || "encodeSourceMap" in newConfig || "studioUrl" in newConfig || "logger" in newConfig) {
-    throw new Error("It looks like you're using options meant for '@sanity/preview-kit/client', such as 'encodeSourceMapAtPath', 'encodeSourceMap', 'studioUrl' and 'logger'. Make sure you're using the right import.");
-  }
-  const isBrowser = typeof window !== "undefined" && window.location && window.location.hostname;
-  const isLocalhost = isBrowser && isLocal(window.location.hostname);
-  if (isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true) {
-    printBrowserTokenWarning();
-  } else if (typeof newConfig.useCdn === "undefined") {
-    printCdnWarning();
-  }
-  if (projectBased) {
-    projectId(newConfig.projectId);
-  }
-  if (newConfig.dataset) {
-    dataset(newConfig.dataset);
-  }
-  if ("requestTagPrefix" in newConfig) {
-    newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0;
-  }
-  newConfig.apiVersion = "".concat(newConfig.apiVersion).replace(/^v/, "");
-  newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost;
-  newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials;
-  validateApiVersion(newConfig.apiVersion);
-  const hostParts = newConfig.apiHost.split("://", 2);
-  const protocol = hostParts[0];
-  const host = hostParts[1];
-  const cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
-  if (newConfig.useProjectHostname) {
-    newConfig.url = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(host, "/v").concat(newConfig.apiVersion);
-    newConfig.cdnUrl = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(cdnHost, "/v").concat(newConfig.apiVersion);
-  } else {
-    newConfig.url = "".concat(newConfig.apiHost, "/v").concat(newConfig.apiVersion);
-    newConfig.cdnUrl = newConfig.url;
-  }
-  return newConfig;
-};
 var defaults = (obj, defaults) => Object.keys(defaults).concat(Object.keys(obj)).reduce((target, prop) => {
   target[prop] = typeof obj[prop] === "undefined" ? defaults[prop] : obj[prop];
   return target;