feat(presentation): include perspectiveStack and version in resolvers (#8891)

Author: pedrobonamin

packages/sanity/src/presentation/document/PresentationDocumentHeader.tsx

@@ -18,14 +18,15 @@ const LocationStack = styled(Stack)`
 
 export function PresentationDocumentHeader(props: {
   documentId: PublishedId
+  version: string | undefined
   options: PresentationPluginOptions
   schemaType: ObjectSchemaType
 }): ReactNode {
-  const {documentId, options, schemaType} = props
-
+  const {documentId, options, schemaType, version} = props
   const context = useContext(PresentationDocumentContext)
   const {state, status} = useDocumentLocations({
     id: documentId,
+    version,
     resolvers: options.resolve?.locations || options.locate,
     type: schemaType.name,
   })

packages/sanity/src/presentation/plugin.tsx

@@ -1,6 +1,12 @@
 import {type SanityDocument} from '@sanity/client'
 import {lazy, Suspense} from 'react'
-import {definePlugin, getPublishedId, type InputProps, isDocumentSchemaType} from 'sanity'
+import {
+  definePlugin,
+  getPublishedId,
+  getVersionFromId,
+  type InputProps,
+  isDocumentSchemaType,
+} from 'sanity'
 
 import {DEFAULT_TOOL_ICON, DEFAULT_TOOL_NAME, EDIT_INTENT_MODE} from './constants'
 import {PresentationDocumentHeader} from './document/PresentationDocumentHeader'
@@ -56,13 +62,14 @@ export const presentationTool = definePlugin<PresentationPluginOptions>((options
   function PresentationDocumentInput(props: InputProps) {
     const value = props.value as SanityDocument
     const documentId = value?._id ? getPublishedId(value?._id) : undefined
-
+    const documentVersion = value?._id ? getVersionFromId(value._id) : undefined
     if (isDocumentSchemaType(props.schemaType)) {
       return (
         <PresentationDocumentProvider options={options}>
           {hasLocationsResolver && documentId && (
             <PresentationDocumentHeader
               documentId={documentId}
+              version={documentVersion}
               options={options}
               schemaType={props.schemaType}
             />

packages/sanity/src/presentation/types.ts

@@ -1,4 +1,4 @@
-import {type ClientPerspective} from '@sanity/client'
+import {type ClientPerspective, type StackablePerspective} from '@sanity/client'
 import {type ChannelInstance} from '@sanity/comlink'
 import {
   type LoaderControllerMsg,
@@ -56,7 +56,12 @@ export type DocumentLocationsStatus = 'empty' | 'resolving' | 'resolved'
  * @public
  */
 export type DocumentLocationResolver = (
-  params: {id: string; type: string},
+  params: {
+    id: string
+    type: string
+    version: string | undefined
+    perspectiveStack: StackablePerspective[]
+  },
   context: {documentStore: DocumentStore},
 ) =>
   | DocumentLocationsState

packages/sanity/src/presentation/useDocumentLocations.ts

@@ -10,6 +10,7 @@ import {
   type Previewable,
   type SanityDocument,
   useDocumentStore,
+  usePerspective,
 } from 'sanity'
 
 import {
@@ -128,14 +129,16 @@ function observeForLocations(
 
 export function useDocumentLocations(props: {
   id: string
+  version: string | undefined
   resolvers?: DocumentLocationResolver | DocumentLocationResolvers
   type: string
 }): {
   state: DocumentLocationsState
   status: DocumentLocationsStatus
 } {
-  const {id, resolvers, type} = props
+  const {id, resolvers, type, version} = props
   const documentStore = useDocumentStore()
+  const {perspectiveStack} = usePerspective()
   const [locationsState, setLocationsState] = useState<DocumentLocationsState>(INITIAL_STATE)
 
   const resolver = resolvers && (typeof resolvers === 'function' ? resolvers : resolvers[type])
@@ -149,7 +152,7 @@ export function useDocumentLocations(props: {
 
     // Original/advanced resolver which requires explicit use of Observables
     if (typeof resolver === 'function') {
-      const params = {id, type}
+      const params = {id, type, version, perspectiveStack}
       const context = {documentStore}
       const _result = resolver(params, context)
       return isObservable(_result) ? _result : of(_result)
@@ -162,7 +165,7 @@ export function useDocumentLocations(props: {
 
     // Resolver is explicitly provided state
     return of(resolver)
-  }, [documentStore, id, resolver, type])
+  }, [documentStore, id, resolver, type, version, perspectiveStack])
 
   useEffect(() => {
     const sub = result?.subscribe((state) => {