@sanity/client 6.8.0-pink-lizard.12 → 6.8.0

package/README.md

@@ -610,6 +610,8 @@ Content Source Maps annotate fragments in your query results with metadata about
 >
 > [Content Source Maps][content-source-maps-intro] are available [as an API][content-source-maps] for select [Sanity enterprise customers][enterprise-cta]. [Contact our sales team for more information.][sales-cta]
 
+A high level API using Content Source Maps for [Visual editing][visual-editing] is also available in [`@sanity/preview-kit/client`][preview-kit-client]. It offers both a turn-key solution and a flexible API for custom experiences.
+
 Read the [Content Source Maps introduction][content-source-maps-intro] before diving in, and keep the [Content Source Maps reference][content-source-maps] handy.
 
 Enabling Content Source Maps is a two-step process:
@@ -654,128 +656,6 @@ function useContentSourceMap(resultSourceMap: ContentSourceMapping): unknown {
 useContentSourceMap(resultSourceMap)
 ```
 
-#### Using [Visual editing][visual-editing] with steganography
-
-A turnkey integration with [Visual editing][visual-editing] is available in [`@sanity/client/stega`]. It creates edit intent links for all the string values in your query result, using [steganography](https://npmjs.com/package/@vercel/stega) under the hood.
-
-```ts
-import {createClient} from '@sanity/client/stega'
-
-const client = createClient({
-  // ...base config options
-  stega: {
-    // Required: for encoded metadata from Content Source Maps
-    enabled: process.env.VERCEL_ENV !== 'production',
-    // Required: when "enabled" is true
-    // Set it to relative or absolute URL of your Sanity Studio
-    studioUrl: '/studio', // or 'https://your-project-name.sanity.studio'
-    // For resolving Cross Dataset References you can pass a function returning a URL
-    studioUrl: (sourceDocument: ContentSourceMapDocument | ContentSourceMapRemoteDocument) => {
-      // If `sourceDocument` has a projectId and dataset, then it's a Cross Dataset Reference
-      if (source._projectId && source._dataset) {
-        return 'https://acme-global.sanity.studio'
-      }
-      return 'https://acme-store.sanity.studio'
-    },
-    // If your Studio has Workspaces: https://www.sanity.io/docs/workspaces
-    // And your Cross Dataset References are available in a workspace then you can return an object to let the client setup the URL
-    studioUrl: (sourceDocument) => {
-      // This organization has a single studio with everything organized in workspaces
-      const baseUrl = 'https://acme.sanity.studio'
-      // If `sourceDocument` has a projectId and dataset, then it's a Cross Dataset Reference
-      if (source._projectId && source._dataset) {
-        return {baseUrl, workspace: 'global'}
-      }
-      return {baseUrl, workspace: 'store'}
-    },
-
-    // Optional, control what fields have stega payloads
-    filter: (props) => {
-      const {resultPath, sourcePath, resultPath} = props
-      if (props.sourcePath[0] === 'externalurl') {
-        return false
-      }
-      // The default behavior is packaged into `filterDefault`, allowing you enable encoding fields that are skipped by default
-      return props.filterDefault(props)
-    },
-
-    // Optional, logs what's encoded and what isn't
-    logger: console,
-  },
-})
-
-// Disable on demand
-client.config({stega: {enabled: false}})
-
-// New client with different stega settings
-const debugClient = client.withConfig({
-  stega: {studioUrl: 'https://your-project-name.sanity.studio'},
-})
-```
-
-Removing stega from part of the result:
-
-```ts
-import {vercelStegaCleanAll} from '@sanity/client/stega'
-const result = await client.fetch('*[_type == "video"][0]')
-
-// Remove stega from the payload sent to a third party library
-const videoAsset = vercelStegaCleanAll(result.videoAsset)
-```
-
-#### Creating Studio edit intent links
-
-If you want to create an edit link to something that isn't a string, or a field that isn't rendered directly, like a `slug` used in a URL but not rendered on the page, you can use the `resolveEditUrl` function.
-
-```ts
-import {createClient} from '@sanity/client' // or '@sanity/client/stega'
-import {resolveEditUrl} from '@sanity/client/csm'
-
-const client = createClient({
-  // ... standard client config
-  // Required: otherwise the `resultSourceMap` property will be empty on `client.fetch`
-  resultSourceMap: 'withKeyArraySelector',
-})
-const {result, resultSourceMap} = await client.fetch(
-  `*[_type == "author" && slug.current == $slug][0]{name, pictures}`,
-  {slug: 'john-doe'},
-  // Required, otherwise you can't access `resultSourceMap`
-  {filterResponse: false},
-)
-
-// The `result` looks like this:
-const result = {
-  name: 'John Doe',
-  pictures: [
-    {
-      _type: 'image',
-      alt: 'A picture of exactly what you think someone named John Doe would look like',
-      _key: 'cee5fbb69da2',
-      asset: {
-        _ref: 'image-a75b03fdd5b5fa36947bf2b776a542e0c940f682-1000x1500-jpg',
-        _type: 'reference',
-      },
-    },
-  ],
-}
-
-// The URL resolver needs to know what the current document is, and the base URL of your Sanity Studio
-const {projectId, dataset} = client.config()
-const studioUrl = 'https://your-project-name.sanity.studio'
-
-resolveEditUrl({
-  projectId,
-  dataset,
-  studioUrl,
-  resultSourceMap,
-  // The path to the field you want to edit, you can pass a string
-  resultPath: 'pictures[0].alt',
-  // Or an array of segments
-  resultPath: ['pictures', 0, 'alt'],
-})
-// ^? 'https://your-project-name.sanity.studio/intent/edit/id=462efcc6-3c8b-47c6-8474-5544e1a4acde;type=author;path=pictures[_key=="cee5fbb69da2"].alt'
-```
-
 ### Listening to queries
 
 ```js

package/dist/_chunks/{nodeMiddleware-XGS8GPhb.cjs → nodeMiddleware-AQIXW8nd.cjs}

@@ -1860,7 +1860,7 @@ function defineCreateClientExports(envMiddleware, ClassConstructor) {
   };
 }
 var name = "@sanity/client";
-var version = "6.8.0-pink-lizard.12";
+var version = "6.8.0";
 const middleware = [middleware$1.debug({
   verbose: true,
   namespace: "sanity:client"
@@ -1894,4 +1894,4 @@ exports.defaultConfig = defaultConfig;
 exports.defineCreateClientExports = defineCreateClientExports;
 exports.middleware = middleware;
 exports.printNoDefaultExport = printNoDefaultExport;
-//# sourceMappingURL=nodeMiddleware-XGS8GPhb.cjs.map
+//# sourceMappingURL=nodeMiddleware-AQIXW8nd.cjs.map