feat: support resultSourceMap=withKeyArraySelector (#363)

sanity-io · Oct 19, 2023 · d528e99 · d528e99
1 parent 9090490
commit d528e99
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/src/data/dataMethods.ts b/src/data/dataMethods.ts
@@ -323,8 +323,9 @@ export function _requestObservable<R>(
     ['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 &&
     uri.indexOf('/data/query/') === 0
   ) {
-    if (options.resultSourceMap ?? config.resultSourceMap) {
-      options.query = {resultSourceMap: true, ...options.query}
+    const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap
+    if (resultSourceMap !== undefined && resultSourceMap !== false) {
+      options.query = {resultSourceMap, ...options.query}
     }
     const perspective = options.perspective || config.perspective
     if (typeof perspective === 'string' && perspective !== 'raw') {

diff --git a/src/types.ts b/src/types.ts
@@ -84,7 +84,7 @@ export interface ClientConfig {
   /**
    * Adds a `resultSourceMap` key to the API response, with the type `ContentSourceMap`
    */
-  resultSourceMap?: boolean
+  resultSourceMap?: boolean | 'withKeyArraySelector'
   /**
    *@deprecated set `cache` and `next` options on `client.fetch` instead
    */

diff --git a/test/client.test.ts b/test/client.test.ts
@@ -579,6 +579,31 @@ describe('client', async () => {
       },
     )
 
+    test.skipIf(isEdge)(
+      'can query for documents with resultSourceMap=withKeyArraySelector and perspective',
+      async () => {
+        nock(projectHost())
+          .get(
+            `/vX/data/query/foo?query=*&resultSourceMap=withKeyArraySelector&perspective=previewDrafts`,
+          )
+          .reply(200, {
+            ms: 123,
+            query: '*',
+            result,
+            resultSourceMap,
+          })
+
+        const client = getClient({
+          apiVersion: 'X',
+          resultSourceMap: 'withKeyArraySelector',
+          perspective: 'previewDrafts',
+        })
+        const res = await client.fetch('*', {})
+        expect(res.length, 'length should match').toBe(1)
+        expect(res[0].rating, 'data should match').toBe(5)
+      },
+    )
+
     test.skipIf(isEdge)('automatically useCdn false if perspective is previewDrafts', async () => {
       nock('https://abc123.api.sanity.io')
         .get(`/v1/data/query/foo?query=*&perspective=previewDrafts`)