@sanity/client 6.23.0 → 6.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.23.0",
+  "version": "6.24.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/config.ts

@@ -28,9 +28,34 @@ function validateApiVersion(apiVersion: string) {
   }
 }
 
-export const validateApiPerspective = function validateApiPerspective(perspective: string) {
+/**
+ * @internal - it may have breaking changes in any release
+ */
+export const validateApiPerspective = function validateApiPerspective(perspective: unknown) {
+  if (Array.isArray(perspective)) {
+    for (const perspectiveValue of perspective) {
+      if (perspectiveValue === 'published') {
+        continue
+      }
+      if (perspectiveValue === 'drafts') {
+        continue
+      }
+      if (
+        typeof perspectiveValue === 'string' &&
+        perspectiveValue.startsWith('r') &&
+        perspectiveValue !== 'raw'
+      ) {
+        continue
+      }
+      throw new TypeError(
+        'Invalid API perspective value, expected `published`, `drafts` or a valid release identifier string',
+      )
+    }
+    return
+  }
   switch (perspective as ClientPerspective) {
     case 'previewDrafts':
+    case 'drafts':
     case 'published':
     case 'raw':
       return
@@ -74,7 +99,7 @@ export const initConfig = (
     throw new Error('Configuration must contain `projectId`')
   }
 
-  if (typeof newConfig.perspective === 'string') {
+  if (typeof newConfig.perspective !== 'undefined') {
     validateApiPerspective(newConfig.perspective)
   }
 

package/src/data/dataMethods.ts

@@ -405,12 +405,17 @@ export function _requestObservable<R>(
     if (resultSourceMap !== undefined && resultSourceMap !== false) {
       options.query = {resultSourceMap, ...options.query}
     }
-    const perspective = options.perspective || config.perspective
-    if (typeof perspective === 'string' && perspective !== 'raw') {
-      validateApiPerspective(perspective)
-      options.query = {perspective, ...options.query}
+    const perspectiveOption = options.perspective || config.perspective
+    if (typeof perspectiveOption !== 'undefined') {
+      validateApiPerspective(perspectiveOption)
+      options.query = {
+        perspective: Array.isArray(perspectiveOption)
+          ? perspectiveOption.join(',')
+          : perspectiveOption,
+        ...options.query,
+      }
       // If the perspective is set to `previewDrafts` we can't use the CDN, the API will throw
-      if (perspective === 'previewDrafts' && useCdn) {
+      if (perspectiveOption === 'previewDrafts' && useCdn) {
         useCdn = false
         printCdnPreviewDraftsWarning()
       }

package/src/defineCreateClient.ts

@@ -3,6 +3,7 @@ import type {Middlewares} from 'get-it'
 import {defineHttpRequest} from './http/request'
 import type {Any, ClientConfig, HttpRequest} from './types'
 
+export {validateApiPerspective} from './config'
 export * from './data/patch'
 export * from './data/transaction'
 export {ClientError, CorsOriginError, ServerError} from './http/errors'

package/src/types.ts

@@ -32,7 +32,15 @@ export interface RequestOptions {
 }
 
 /** @public */
-export type ClientPerspective = 'previewDrafts' | 'published' | 'raw'
+export type ReleaseId = `r${string}`
+
+/** @public */
+export type ClientPerspective =
+  | 'previewDrafts'
+  | 'published'
+  | 'drafts'
+  | 'raw'
+  | ('published' | 'drafts' | ReleaseId)[]
 
 /** @public */
 export interface ClientConfig {

package/umd/sanityClient.js

@@ -1178,22 +1178,9 @@
     const isSafe = options.method === "GET" || options.method === "HEAD", isQuery = (options.uri || options.url).startsWith("/data/query"), isRetriableResponse = err.response && (err.response.statusCode === 429 || err.response.statusCode === 502 || err.response.statusCode === 503);
     return (isSafe || isQuery) && isRetriableResponse ? !0 : _$1.shouldRetry(err, attempt, options);
   }
-  function getSelection(sel) {
-    if (typeof sel == "string")
-      return { id: sel };
-    if (Array.isArray(sel))
-      return { query: "*[_id in $ids]", params: { ids: 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(`
-`);
-    throw new Error(`Unknown selection - must be one of:
-
-${selectionOpts}`);
+  const BASE_URL = "https://www.sanity.io/help/";
+  function generateHelpUrl(slug) {
+    return BASE_URL + slug;
   }
   const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before", "after", "replace"], dataset = (name) => {
     if (!/^(~[a-z0-9]{1}[-\w]{0,63}|[a-z0-9]{1}[-\w]{0,63})$/.test(name))
@@ -1237,6 +1224,124 @@ ${selectionOpts}`);
       );
     return tag;
   };
+  function once(fn) {
+    let didCall = !1, returnValue;
+    return (...args) => (didCall || (returnValue = fn(...args), didCall = !0), returnValue);
+  }
+  const createWarningPrinter = (message) => (
+    // eslint-disable-next-line no-console
+    once((...args) => console.warn(message.join(" "), ...args))
+  ), printCdnAndWithCredentialsWarning = createWarningPrinter([
+    "Because you set `withCredentials` to true, we will override your `useCdn`",
+    "setting to be false since (cookie-based) credentials are never set on the CDN"
+  ]), 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."
+  ]), printCdnPreviewDraftsWarning = createWarningPrinter([
+    "The Sanity client is configured with the `perspective` set to `previewDrafts`, which doesn't support the API-CDN.",
+    "The Live API will be used instead. Set `useCdn: false` in your configuration to hide this warning."
+  ]), printBrowserTokenWarning = createWarningPrinter([
+    "You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.",
+    `See ${generateHelpUrl(
+    "js-client-browser-token"
+  )} for more information and how to hide this warning.`
+  ]), printNoApiVersionSpecifiedWarning = createWarningPrinter([
+    "Using the Sanity client without specifying an API version is deprecated.",
+    `See ${generateHelpUrl("js-client-api-version")}`
+  ]), printNoDefaultExport = createWarningPrinter([
+    "The default export of @sanity/client has been deprecated. Use the named export `createClient` instead."
+  ]), defaultCdnHost = "apicdn.sanity.io", defaultConfig = {
+    apiHost: "https://api.sanity.io",
+    apiVersion: "1",
+    useProjectHostname: !0,
+    stega: { enabled: !1 }
+  }, LOCALHOSTS = ["localhost", "127.0.0.1", "0.0.0.0"], isLocal = (host) => LOCALHOSTS.indexOf(host) !== -1;
+  function validateApiVersion(apiVersion) {
+    if (apiVersion === "1" || apiVersion === "X")
+      return;
+    const apiDate = new Date(apiVersion);
+    if (!(/^\d{4}-\d{2}-\d{2}$/.test(apiVersion) && apiDate instanceof Date && apiDate.getTime() > 0))
+      throw new Error("Invalid API version string, expected `1` or date in format `YYYY-MM-DD`");
+  }
+  const validateApiPerspective = function(perspective) {
+    if (Array.isArray(perspective)) {
+      for (const perspectiveValue of perspective)
+        if (perspectiveValue !== "published" && perspectiveValue !== "drafts" && !(typeof perspectiveValue == "string" && perspectiveValue.startsWith("r") && perspectiveValue !== "raw"))
+          throw new TypeError(
+            "Invalid API perspective value, expected `published`, `drafts` or a valid release identifier string"
+          );
+      return;
+    }
+    switch (perspective) {
+      case "previewDrafts":
+      case "drafts":
+      case "published":
+      case "raw":
+        return;
+      default:
+        throw new TypeError(
+          "Invalid API perspective string, expected `published`, `previewDrafts` or `raw`"
+        );
+    }
+  }, initConfig = (config, prevConfig) => {
+    const specifiedConfig = {
+      ...prevConfig,
+      ...config,
+      stega: {
+        ...typeof prevConfig.stega == "boolean" ? { enabled: prevConfig.stega } : prevConfig.stega || defaultConfig.stega,
+        ...typeof config.stega == "boolean" ? { enabled: config.stega } : config.stega || {}
+      }
+    };
+    specifiedConfig.apiVersion || printNoApiVersionSpecifiedWarning();
+    const newConfig = {
+      ...defaultConfig,
+      ...specifiedConfig
+    }, projectBased = newConfig.useProjectHostname;
+    if (typeof Promise > "u") {
+      const helpUrl = generateHelpUrl("js-client-promise-polyfill");
+      throw new Error(`No native Promise-implementation found, polyfill needed - see ${helpUrl}`);
+    }
+    if (projectBased && !newConfig.projectId)
+      throw new Error("Configuration must contain `projectId`");
+    if (typeof newConfig.perspective < "u" && validateApiPerspective(newConfig.perspective), "encodeSourceMap" in newConfig)
+      throw new Error(
+        "It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMap' is not supported in '@sanity/client'. Did you mean 'stega.enabled'?"
+      );
+    if ("encodeSourceMapAtPath" in newConfig)
+      throw new Error(
+        "It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMapAtPath' is not supported in '@sanity/client'. Did you mean 'stega.filter'?"
+      );
+    if (typeof newConfig.stega.enabled != "boolean")
+      throw new Error(`stega.enabled must be a boolean, received ${newConfig.stega.enabled}`);
+    if (newConfig.stega.enabled && newConfig.stega.studioUrl === void 0)
+      throw new Error("stega.studioUrl must be defined when stega.enabled is true");
+    if (newConfig.stega.enabled && typeof newConfig.stega.studioUrl != "string" && typeof newConfig.stega.studioUrl != "function")
+      throw new Error(
+        `stega.studioUrl must be a string or a function, received ${newConfig.stega.studioUrl}`
+      );
+    const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
+    isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === !0 && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== !1 && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
+    const hostParts = newConfig.apiHost.split("://", 2), protocol = hostParts[0], host = hostParts[1], cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
+    return newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), newConfig;
+  };
+  function getSelection(sel) {
+    if (typeof sel == "string")
+      return { id: sel };
+    if (Array.isArray(sel))
+      return { query: "*[_id in $ids]", params: { ids: 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(`
+`);
+    throw new Error(`Unknown selection - must be one of:
+
+${selectionOpts}`);
+  }
   class BasePatch {
     selection;
     operations;
@@ -1550,102 +1655,7 @@ ${selectionOpts}`);
       return this._add({ patch: { id: patchOrDocumentId, ...patchOps } });
     }
   }
-  const BASE_URL = "https://www.sanity.io/help/";
-  function generateHelpUrl(slug) {
-    return BASE_URL + slug;
-  }
-  function once(fn) {
-    let didCall = !1, returnValue;
-    return (...args) => (didCall || (returnValue = fn(...args), didCall = !0), returnValue);
-  }
-  const createWarningPrinter = (message) => (
-    // eslint-disable-next-line no-console
-    once((...args) => console.warn(message.join(" "), ...args))
-  ), printCdnAndWithCredentialsWarning = createWarningPrinter([
-    "Because you set `withCredentials` to true, we will override your `useCdn`",
-    "setting to be false since (cookie-based) credentials are never set on the CDN"
-  ]), 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."
-  ]), printCdnPreviewDraftsWarning = createWarningPrinter([
-    "The Sanity client is configured with the `perspective` set to `previewDrafts`, which doesn't support the API-CDN.",
-    "The Live API will be used instead. Set `useCdn: false` in your configuration to hide this warning."
-  ]), printBrowserTokenWarning = createWarningPrinter([
-    "You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.",
-    `See ${generateHelpUrl(
-    "js-client-browser-token"
-  )} for more information and how to hide this warning.`
-  ]), printNoApiVersionSpecifiedWarning = createWarningPrinter([
-    "Using the Sanity client without specifying an API version is deprecated.",
-    `See ${generateHelpUrl("js-client-api-version")}`
-  ]), printNoDefaultExport = createWarningPrinter([
-    "The default export of @sanity/client has been deprecated. Use the named export `createClient` instead."
-  ]), defaultCdnHost = "apicdn.sanity.io", defaultConfig = {
-    apiHost: "https://api.sanity.io",
-    apiVersion: "1",
-    useProjectHostname: !0,
-    stega: { enabled: !1 }
-  }, LOCALHOSTS = ["localhost", "127.0.0.1", "0.0.0.0"], isLocal = (host) => LOCALHOSTS.indexOf(host) !== -1;
-  function validateApiVersion(apiVersion) {
-    if (apiVersion === "1" || apiVersion === "X")
-      return;
-    const apiDate = new Date(apiVersion);
-    if (!(/^\d{4}-\d{2}-\d{2}$/.test(apiVersion) && apiDate instanceof Date && apiDate.getTime() > 0))
-      throw new Error("Invalid API version string, expected `1` or date in format `YYYY-MM-DD`");
-  }
-  const validateApiPerspective = function(perspective) {
-    switch (perspective) {
-      case "previewDrafts":
-      case "published":
-      case "raw":
-        return;
-      default:
-        throw new TypeError(
-          "Invalid API perspective string, expected `published`, `previewDrafts` or `raw`"
-        );
-    }
-  }, initConfig = (config, prevConfig) => {
-    const specifiedConfig = {
-      ...prevConfig,
-      ...config,
-      stega: {
-        ...typeof prevConfig.stega == "boolean" ? { enabled: prevConfig.stega } : prevConfig.stega || defaultConfig.stega,
-        ...typeof config.stega == "boolean" ? { enabled: config.stega } : config.stega || {}
-      }
-    };
-    specifiedConfig.apiVersion || printNoApiVersionSpecifiedWarning();
-    const newConfig = {
-      ...defaultConfig,
-      ...specifiedConfig
-    }, projectBased = newConfig.useProjectHostname;
-    if (typeof Promise > "u") {
-      const helpUrl = generateHelpUrl("js-client-promise-polyfill");
-      throw new Error(`No native Promise-implementation found, polyfill needed - see ${helpUrl}`);
-    }
-    if (projectBased && !newConfig.projectId)
-      throw new Error("Configuration must contain `projectId`");
-    if (typeof newConfig.perspective == "string" && validateApiPerspective(newConfig.perspective), "encodeSourceMap" in newConfig)
-      throw new Error(
-        "It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMap' is not supported in '@sanity/client'. Did you mean 'stega.enabled'?"
-      );
-    if ("encodeSourceMapAtPath" in newConfig)
-      throw new Error(
-        "It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMapAtPath' is not supported in '@sanity/client'. Did you mean 'stega.filter'?"
-      );
-    if (typeof newConfig.stega.enabled != "boolean")
-      throw new Error(`stega.enabled must be a boolean, received ${newConfig.stega.enabled}`);
-    if (newConfig.stega.enabled && newConfig.stega.studioUrl === void 0)
-      throw new Error("stega.studioUrl must be defined when stega.enabled is true");
-    if (newConfig.stega.enabled && typeof newConfig.stega.studioUrl != "string" && typeof newConfig.stega.studioUrl != "function")
-      throw new Error(
-        `stega.studioUrl must be a string or a function, received ${newConfig.stega.studioUrl}`
-      );
-    const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
-    isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === !0 && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== !1 && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
-    const hostParts = newConfig.apiHost.split("://", 2), protocol = hostParts[0], host = hostParts[1], cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
-    return newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), newConfig;
-  }, projectHeader = "X-Sanity-Project-ID";
+  const projectHeader = "X-Sanity-Project-ID";
   function requestOptions(config, overrides = {}) {
     const headers = {}, token = overrides.token || config.token;
     token && (headers.Authorization = `Bearer ${token}`), !overrides.useGlobalApi && !config.useProjectHostname && config.projectId && (headers[projectHeader] = config.projectId);
@@ -1821,8 +1831,11 @@ ${selectionOpts}`);
     if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/query/") === 0) {
       const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
       resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
-      const perspective = options.perspective || config.perspective;
-      typeof perspective == "string" && perspective !== "raw" && (validateApiPerspective(perspective), options.query = { perspective, ...options.query }, perspective === "previewDrafts" && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
+      const perspectiveOption = options.perspective || config.perspective;
+      typeof perspectiveOption < "u" && (validateApiPerspective(perspectiveOption), options.query = {
+        perspective: Array.isArray(perspectiveOption) ? perspectiveOption.join(",") : perspectiveOption,
+        ...options.query
+      }, perspectiveOption === "previewDrafts" && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
     }
     const reqOptions = requestOptions(
       config,
@@ -4061,6 +4074,7 @@ ${selectionOpts}`);
   exports.requester = requester;
   exports.unstable__adapter = l$1;
   exports.unstable__environment = p$1;
+  exports.validateApiPerspective = validateApiPerspective;
 
   Object.defineProperty(exports, '__esModule', { value: true });