feat: add perspective parameter (#224)

sanity-io · May 15, 2023 · 61f36de · 61f36de
1 parent dac8ea6
commit 61f36de
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.0.1",
+  "version": "6.1.0-perspective.2",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

diff --git a/src/data/dataMethods.ts b/src/data/dataMethods.ts
@@ -307,6 +307,9 @@ export function _requestObservable<R>(
     if (config.resultSourceMap) {
       options.query = {resultSourceMap: true, ...options.query}
     }
+    if (typeof config.perspective === 'string' && config.perspective !== 'all') {
+      options.query = {perspective: config.perspective, ...options.query}
+    }
   }
 
   const reqOptions = requestOptions(

diff --git a/src/types.ts b/src/types.ts
@@ -35,6 +35,7 @@ export interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
+  perspective?: 'previewDrafts' | 'published' | 'all'
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -67,6 +68,9 @@ export interface ClientConfig {
    */
   requester?: Requester
 
+  /**
+   * Adds a `resultSourceMap` key to the API response, with the type `ContentSourceMap`
+   */
   resultSourceMap?: boolean
 }