@sanity/client 6.27.3-canary.2 → 6.28.0

package/dist/index.browser.d.cts

@@ -401,7 +401,7 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | 'previewDrafts'
+  | DeprecatedPreviewDrafts
   | 'published'
   | 'drafts'
   | 'raw'
@@ -667,6 +667,11 @@ export declare type DeleteAction = {
 declare const deprecatedCreateClient: (config: ClientConfig) => SanityClient
 export default deprecatedCreateClient
 
+/**
+ * @deprecated use 'drafts' instead
+ */
+declare type DeprecatedPreviewDrafts = 'previewDrafts'
+
 /**
  * Delete the draft version of a document.
  * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.

package/dist/index.browser.d.ts

@@ -401,7 +401,7 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | 'previewDrafts'
+  | DeprecatedPreviewDrafts
   | 'published'
   | 'drafts'
   | 'raw'
@@ -667,6 +667,11 @@ export declare type DeleteAction = {
 declare const deprecatedCreateClient: (config: ClientConfig) => SanityClient
 export default deprecatedCreateClient
 
+/**
+ * @deprecated use 'drafts' instead
+ */
+declare type DeprecatedPreviewDrafts = 'previewDrafts'
+
 /**
  * Delete the draft version of a document.
  * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.

package/dist/index.browser.js

@@ -1,7 +1,7 @@
 import { getIt } from "get-it";
 import { adapter, environment } from "get-it";
 import { retry, jsonRequest, jsonResponse, progress, observable } from "get-it/middleware";
-import { Observable, defer, isObservable, of, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, timer, throwError, tap, finalize, share, merge, EMPTY } from "rxjs";
+import { Observable, defer, of, isObservable, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, throwError, timer, tap, finalize, share, merge, EMPTY } from "rxjs";
 import { stegaClean } from "./_chunks-es/stegaClean.js";
 import { combineLatestWith, map, filter, finalize as finalize$1 } from "rxjs/operators";
 class ClientError extends Error {
@@ -171,8 +171,10 @@ const createWarningPrinter = (message) => (
   "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 Sanity client is configured with the `perspective` set to `drafts` or `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."
+]), printPreviewDraftsDeprecationWarning = createWarningPrinter([
+  "The `previewDrafts` perspective has been renamed to  `drafts` and will be removed in a future API version"
 ]), printBrowserTokenWarning = createWarningPrinter([
   "You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.",
   `See ${generateHelpUrl(
@@ -870,10 +872,11 @@ function _requestObservable(client, httpRequest, options) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
     resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
     const perspectiveOption = options.perspective || config.perspective;
-    typeof perspectiveOption < "u" && (validateApiPerspective(perspectiveOption), options.query = {
+    typeof perspectiveOption < "u" && (perspectiveOption === "previewDrafts" && printPreviewDraftsDeprecationWarning(), 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 });
+    }, (Array.isArray(perspectiveOption) && perspectiveOption.length > 0 || // previewDrafts was renamed to drafts, but keep for backwards compat
+    perspectiveOption === "previewDrafts" || perspectiveOption === "drafts") && 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,