@sanity/client 5.4.1 → 5.4.2-dev.0

package/README.md

@@ -27,7 +27,7 @@ export const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
   // token: process.env.SANITY_SECRET_TOKEN // Only if you want to update content with the client
 })
 
@@ -65,6 +65,7 @@ export async function updateDocumentTitle(_id, title) {
     - [UMD](#umd)
   - [Specifying API version](#specifying-api-version)
   - [Performing queries](#performing-queries)
+  - [Get started with Content Source Maps](#get-started-with-content-source-maps)
   - [Listening to queries](#listening-to-queries)
   - [Fetch a single document](#fetch-a-single-document)
   - [Fetch multiple documents in one go](#fetch-multiple-documents-in-one-go)
@@ -130,7 +131,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch(`count(*)`)
@@ -146,7 +147,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 client
@@ -164,7 +165,7 @@ const config: ClientConfig = {
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 }
 const client = createClient(config)
 
@@ -184,7 +185,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const schema = z.number()
@@ -211,7 +212,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch<number>(`count(*)`)
@@ -239,7 +240,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch<number>(`count(*)`)
@@ -272,7 +273,7 @@ export default async function handler(req: NextRequest) {
     projectId: 'your-project-id',
     dataset: 'your-dataset-name',
     useCdn: false, // set to `true` to fetch from edge cache
-    apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+    apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
   })
 
   const count = await client.fetch<number>(`count(*)`)
@@ -303,7 +304,7 @@ Using [esm.sh] you can either load the client using a `<script type="module">` t
     projectId: 'your-project-id',
     dataset: 'your-dataset-name',
     useCdn: false, // set to `true` to fetch from edge cache
-    apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+    apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
   })
 
   const data = await client.fetch(`count(*)`)
@@ -322,7 +323,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: false, // set to `true` to fetch from edge cache
-  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch(`count(*)`)
@@ -344,7 +345,7 @@ Loading the UMD script creates a `SanityClient` global that have the same export
     projectId: 'your-project-id',
     dataset: 'your-dataset-name',
     useCdn: false, // set to `true` to fetch from edge cache
-    apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+    apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
   })
 
   client.fetch(`count(*)`).then((data) => console.log(`Number of documents: ${data}`))
@@ -365,7 +366,7 @@ The `require-unpkg` library lets you consume `npm` packages from `unpkg.com` sim
       projectId: 'your-project-id',
       dataset: 'your-dataset-name',
       useCdn: false, // set to `true` to fetch from edge cache
-      apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
+      apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
     })
 
     const data = await client.fetch(`count(*)`)
@@ -402,6 +403,57 @@ client.fetch(query, params).then((bikes) => {
 
 Perform a query using the given parameters (if any).
 
+### Get started with Content Source Maps
+
+> **Note**
+>
+> [Content Source Maps][content-source-maps-intro] are available [as an API][content-source-maps] for select Sanity enterprise customers. [Contact our sales team for more information.][content-source-maps-cta]
+
+[Visual editing][visual-editing] is available in [`@sanity/preview-kit/client`][preview-kit-client]. It offers both a turn-key solution and a flexible API for custom experiences.
+
+This guide is for developers who want to build custom use cases beyond, or in addition to, [visual editing][visual-editing]. Read the [Content Source Maps introduction](https://www.sanity.io/docs/content-source-maps) before diving in, and keep the [Content Source Maps reference](https://www.sanity.io/docs/content-source-maps) handy.
+
+Enabling Content Source Maps is a two-step process:
+
+1. Update your client configuration with `resultSourceMap`.
+
+   ```js
+   import {createClient} from '@sanity/client'
+
+   const client = createClient({
+     projectId: 'your-project-id',
+     dataset: 'your-dataset-name',
+     useCdn: true, // set to `false` to bypass the edge cache
+     apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+     resultSourceMap: true, // tells the API to start sending source maps, if available
+   })
+   ```
+
+2. On `client.fetch` calls add `{filterResponse: false}` to return the full response on queries.
+
+   ```js
+   // Before
+   // const result = await client.fetch(query, params)
+
+   // After adding `filterResponse: false`
+   const {result, resultSourceMap} = await client.fetch(query, params, {filterResponse: false})
+   // Build something cool with the source map
+   console.log(resultSourceMap)
+   ```
+
+Once enabled, the `resultSourceMap` property will always exist on the response, given your `apiVersion` is recent enough. If there is no source map, it will be an empty object. There's also a TypeScript definition for it:
+
+```ts
+import type {ContentSourceMapping} from '@sanity/client'
+const {result, resultSourceMap} = await client.fetch(query, params, {filterResponse: false})
+
+function useContentSourceMap(resultSourceMap: ContentSourceMapping): unknown {
+  // Sky's the limit
+}
+
+useContentSourceMap(resultSourceMap)
+```
+
 ### Listening to queries
 
 ```js
@@ -1223,3 +1275,8 @@ await client.request<void>({uri: '/auth/logout', method: 'POST'})
 [groqd]: https://github.com/FormidableLabs/groqd#readme
 [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
 [AbortController]: https://developer.mozilla.org/en-US/docs/Web/API/AbortController
+[visual-editing]: https://www.sanity.io/docs/vercel-visual-editing
+[content-source-maps]: https://www.sanity.io/docs/content-source-maps
+[content-source-maps-intro]: https://www.sanity.io/blog/content-source-maps-announce
+[content-source-maps-cta]: https://www.sanity.io/contact/sales
+[preview-kit-client]: https://github.com/sanity-io/preview-kit#sanitypreview-kitclient

package/dist/index.browser.cjs

@@ -808,6 +808,12 @@ function _requestObservable(client, httpRequest, options) {
       ...options.query
     };
   }
+  if (config.resultSourceMap) {
+    options.query = {
+      resultSourceMap: true,
+      ...options.query
+    };
+  }
   const reqOptions = requestOptions(config, Object.assign({}, options, {
     url: _getUrl(client, uri, useCdn)
   }));