feat(sanity): move diffView into sanity

In my opinion, this functionality was better organised when it was
isolated as a plugin. However, due to dependencies on
`sanity/structure`, it was necessary to move it into that part of the
codebase.

Some things are now more heavy-handed, such as the way the
"Compare Versions" document action is inserted.

packages/sanity/src/core/config/resolveDefaultPlugins.ts

@@ -1,6 +1,5 @@
 import {comments} from '../comments/plugin'
 import {createIntegration} from '../create/createIntegrationPlugin'
-import {diffView} from '../diffView/plugin'
 import {releases, RELEASES_NAME} from '../releases/plugin'
 import {DEFAULT_SCHEDULED_PUBLISH_PLUGIN_OPTIONS} from '../scheduledPublishing/constants'
 import {SCHEDULED_PUBLISHING_NAME, scheduledPublishing} from '../scheduledPublishing/plugin'
@@ -12,14 +11,7 @@ import {
   type WorkspaceOptions,
 } from './types'
 
-const defaultPlugins = [
-  comments(),
-  tasks(),
-  scheduledPublishing(),
-  createIntegration(),
-  releases(),
-  diffView(),
-]
+const defaultPlugins = [comments(), tasks(), scheduledPublishing(), createIntegration(), releases()]
 
 export function getDefaultPlugins(
   options: DefaultPluginsWorkspaceOptions,

packages/sanity/src/core/releases/hooks/usePerspective.tsx

@@ -74,7 +74,6 @@ export function usePerspective({
     | ReleaseId
     | undefined
 
-  // TODO: When `perspectiveOverride` is set, exclusion should not have an effect.
   const excludedPerspectives = useMemo(
     () =>
       excludedPerspectivesOverride ??

packages/sanity/src/core/releases/i18n/resources.ts

@@ -12,8 +12,6 @@ const releasesLocaleStrings = {
   'action.archive.tooltip': 'Unschedule this release to archive it',
   /** Action text for showing the archived releases */
   'action.archived': 'Archived',
-  /** Action text for comparing document versions */
-  'action.compare-versions': 'Compare versions',
   /** Action text for reverting a release by creating a new release */
   'action.create-revert-release': 'Stage in new release',
   /** Action text for deleting a release */

packages/sanity/src/core/releases/plugin/documentActions/index.ts

@@ -1,6 +1,5 @@
 import {type DocumentActionComponent} from '../../../config/document/actions'
 import {type DocumentActionsContext} from '../../../config/types'
-import {CompareVersionsAction} from './CompareVersionsAction'
 import {DiscardVersionAction} from './DiscardVersionAction'
 import {UnpublishVersionAction} from './UnpublishVersionAction'
 
@@ -15,6 +14,5 @@ export default function resolveDocumentActions(
     ...(context.versionType === 'version'
       ? duplicateAction.concat(DiscardVersionAction).concat(UnpublishVersionAction)
       : existingActions),
-    CompareVersionsAction,
   ]
 }

packages/sanity/src/core/diffView/components/DiffView.tsx → packages/sanity/src/structure/diffView/components/DiffView.tsx

@@ -1,7 +1,7 @@
 import {type ComponentType, useState} from 'react'
+import {type DocumentLayoutProps} from 'sanity'
 
 import {Dialog} from '../../../ui-components/dialog/Dialog'
-import {type DocumentLayoutProps} from '../../config/types'
 import {useCreatePathSyncChannel} from '../hooks/useCreatePathSyncChannel'
 import {useDiffViewRouter} from '../hooks/useDiffViewRouter'
 import {useDiffViewState} from '../hooks/useDiffViewState'

packages/sanity/src/core/diffView/components/DiffViewPane.tsx → packages/sanity/src/structure/diffView/components/DiffViewPane.tsx

@@ -1,14 +1,18 @@
 import {BoundaryElementProvider, Box, Card, DialogProvider, PortalProvider} from '@sanity/ui'
 import {noop} from 'lodash'
 import {type CSSProperties, forwardRef, useRef, useState} from 'react'
+import {
+  ChangeIndicatorsTracker,
+  getPublishedId,
+  getVersionFromId,
+  isDraftId,
+  useEditState,
+  VirtualizerScrollInstanceProvider,
+} from 'sanity'
 import {ConnectorContext} from 'sanity/_singletons'
-import {DocumentPaneProvider, FormViewComponent} from 'sanity/structure'
 import {styled} from 'styled-components'
 
-import {ChangeIndicatorsTracker} from '../../changeIndicators/tracker'
-import {VirtualizerScrollInstanceProvider} from '../../form/inputs/arrays/ArrayOfObjectsInput/List/VirtualizerScrollInstanceProvider'
-import {useEditState} from '../../hooks/useEditState'
-import {getPublishedId, getVersionFromId, isDraftId} from '../../util/draftUtils'
+import {DocumentPaneProvider, FormViewComponent} from '../..'
 import {type PathSyncChannel} from '../types/pathSyncChannel'
 import {PathSyncChannelSubscriber} from './PathSyncChannelSubscriber'
 import {Scroller} from './Scroller'
@@ -33,7 +37,7 @@ interface DiffViewPaneProps {
 // TODO: Switch off comments. Document inspectors cannot currently be shown inside the diff view.
 // TODO: Switch off references pane. It should be a hyperlink instead.
 export const DiffViewPane = forwardRef<HTMLDivElement, DiffViewPaneProps>(function DiffViewPane(
-  {role, documentType, documentId, scrollElement, syncChannel, /*compareValue,*/ compareDocument},
+  {role, documentType, documentId, scrollElement, syncChannel, compareDocument},
   ref,
 ) {
   const paneId = ['diffView', role].join('.')
@@ -103,6 +107,7 @@ export const DiffViewPane = forwardRef<HTMLDivElement, DiffViewPaneProps>(functi
                   paneKey={paneId}
                   itemId={paneId}
                   perspectiveOverride={version}
+                  excludedPerspectivesOverride={[]}
                   pane={{
                     id: paneId,
                     type: 'document',

packages/sanity/src/core/diffView/hooks/useDiffViewRouter.ts → packages/sanity/src/structure/diffView/hooks/useDiffViewRouter.ts

@@ -24,7 +24,7 @@ type NavigateDiffView = (
   >,
 ) => void
 
-interface DiffViewRouter {
+export interface DiffViewRouter {
   navigateDiffView: NavigateDiffView
   exitDiffView: () => void
 }

packages/sanity/src/core/diffView/hooks/useDiffViewState.ts → packages/sanity/src/structure/diffView/hooks/useDiffViewState.ts

@@ -2,19 +2,18 @@ import {type SanityClient} from '@sanity/client'
 import {useEffect, useMemo} from 'react'
 import {useObservable} from 'react-rx'
 import {EMPTY, map, type Observable} from 'rxjs'
-import {useRouter} from 'sanity/router'
-
-import {useClient} from '../../hooks/useClient'
-import {usePerspective} from '../../releases/hooks/usePerspective'
-import {DEFAULT_STUDIO_CLIENT_OPTIONS} from '../../studioClient'
 import {
+  DEFAULT_STUDIO_CLIENT_OPTIONS,
   getDraftId,
   getPublishedId,
   getVersionId,
   isSystemBundle,
-  isVersionId,
   type PublishedId,
-} from '../../util/draftUtils'
+  useClient,
+  usePerspective,
+} from 'sanity'
+import {useRouter} from 'sanity/router'
+
 import {
   DIFF_SEARCH_PARAM_SEPERATOR,
   DIFF_VIEW_NEXT_DOCUMENT_SEARCH_PARAMETER,
@@ -62,9 +61,10 @@ export function useDiffViewState(): DiffViewState {
   const {perspectiveStack} = usePerspective()
   const client = useClient(DEFAULT_STUDIO_CLIENT_OPTIONS)
 
-  // ensure not `""`
-  // ensure not `null`
-  // ensure types are in schema
+  // TODO: Validate parameters.
+  // - Ensure not `""`.
+  // - Ensure not `null`.
+  // - Ensure types are present in schema.
   const [previousDocumentType, previousDocumentId] = (
     searchParams.get(DIFF_VIEW_PREVIOUS_DOCUMENT_SEARCH_PARAMETER) ?? ''
   ).split(DIFF_SEARCH_PARAM_SEPERATOR)
@@ -77,16 +77,15 @@ export function useDiffViewState(): DiffViewState {
   // will be inferred by finding the next existing document in the perspective stack.
   const shouldInferPreviousDocument =
     diffViewMode === 'version' &&
-    searchParams.get(DIFF_VIEW_PREVIOUS_DOCUMENT_SEARCH_PARAMETER) === null &&
-    isVersionId(nextDocumentId)
+    searchParams.get(DIFF_VIEW_PREVIOUS_DOCUMENT_SEARCH_PARAMETER) === null
 
   const inferPreviousDocument = useMemo(() => {
     if (!shouldInferPreviousDocument) {
       return EMPTY
     }
 
-    return getFirstExistentVersion({
-      bundles: perspectiveStack.slice(1),
+    return findPrecedingVersion({
+      bundles: perspectiveStack,
       publishedId: getPublishedId(nextDocumentId),
       client,
     })
@@ -99,6 +98,8 @@ export function useDiffViewState(): DiffViewState {
       return
     }
 
+    // TODO: Navigating like this once the previous document has been inferred causes a redundant
+    // browser history entry to be created, resulting in an unusual experience when navigating back.
     navigateDiffView({
       mode: 'version',
       previousDocument: {
@@ -144,12 +145,12 @@ export function useDiffViewState(): DiffViewState {
 }
 
 /**
- * Find the first existing document id in the provided array of bundles. This can be used to find
- * the id of the document that immediately precedes another when release layering is applied.
+ * Find the first existing document id that precedes the first entry in the provided array of
+ * bundles.
  *
  * This function implicitly includes draft and published documents.
  */
-function getFirstExistentVersion({
+function findPrecedingVersion({
   bundles,
   publishedId,
   client,
@@ -161,6 +162,7 @@ function getFirstExistentVersion({
   const ids = bundles
     .flatMap((bundle) => (isSystemBundle(bundle) ? [] : getVersionId(publishedId, bundle)))
     .concat(getDraftId(publishedId), publishedId)
+    .slice(1)
 
   return client.observable
     .fetch<string | undefined>(

packages/sanity/src/core/diffView/hooks/usePathSyncChannel.ts → packages/sanity/src/structure/diffView/hooks/usePathSyncChannel.ts

@@ -1,9 +1,9 @@
 import {useCallback, useEffect, useMemo} from 'react'
+import deepEquals from 'react-fast-compare'
 import {useObservable} from 'react-rx'
 import {distinctUntilChanged, filter, map} from 'rxjs'
 import {useDocumentPane} from 'sanity/structure'
 
-import {deepEquals} from '../../validation/util/deepEquals'
 import {type PathSyncChannelProps, type PathSyncState} from '../types/pathSyncChannel'
 
 /**

packages/sanity/src/structure/diffView/index.ts

@@ -0,0 +1 @@
+export * from './hooks/useDiffViewRouter'

packages/sanity/src/structure/diffView/plugin/DiffViewDocumentLayout.tsx

@@ -0,0 +1,18 @@
+import {type ComponentType, type PropsWithChildren} from 'react'
+import {type DocumentLayoutProps} from 'sanity'
+
+import {DiffView} from '../components/DiffView'
+import {useDiffViewState} from '../hooks/useDiffViewState'
+
+export const DiffViewDocumentLayout: ComponentType<
+  PropsWithChildren<Pick<DocumentLayoutProps, 'documentId' | 'documentType'>>
+> = ({children, documentId}) => {
+  const {state} = useDiffViewState()
+
+  return (
+    <>
+      {children}
+      {state === 'ready' && <DiffView documentId={documentId} />}
+    </>
+  )
+}