fix(structure): navigate to version when document only has versions

packages/sanity/src/core/index.ts

@@ -39,6 +39,7 @@ export {
   RELEASES_STUDIO_CLIENT_OPTIONS,
   useActiveReleases,
   useArchivedReleases,
+  useDocumentVersionList,
   useDocumentVersions,
   useIsReleaseActive,
   useReleasesIds,

packages/sanity/src/core/releases/components/VersionInlineBadge.tsx

@@ -12,8 +12,8 @@ const StyledVersionInlineBadge = styled.span<{$tone?: BadgeTone}>((props) => {
     color: var(--card-badge-${$tone ?? 'default'}-fg-color);
     background-color: var(--card-badge-${$tone ?? 'default'}-bg-color);
     border-radius: 3px;
-    text-decoration: none;
     padding: 0px 2px;
+    text-decoration: none;
     font-weight: 500;
   `
 })

packages/sanity/src/core/releases/hooks/index.ts

@@ -1,3 +1,4 @@
+export * from './useDocumentVersionList'
 export * from './useDocumentVersions'
 export * from './useIsReleaseActive'
 export * from './useVersionOperations'

packages/sanity/src/core/releases/hooks/useDocumentVersionList.ts

@@ -0,0 +1,49 @@
+import {useMemo} from 'react'
+
+import {getVersionFromId, isVersionId} from '../../util/draftUtils'
+import {type ReleaseDocument, type ReleaseType} from '../store/types'
+import {useActiveReleases} from '../store/useActiveReleases'
+import {getReleaseIdFromReleaseDocumentId} from '../util/getReleaseIdFromReleaseDocumentId'
+import {useDocumentVersions} from './useDocumentVersions'
+
+const orderedReleaseTypes: ReleaseType[] = ['asap', 'scheduled', 'undecided']
+
+interface useDocumentVersionListState {
+  sortedDocumentList: ReleaseDocument[]
+  onlyHasVersions: boolean
+}
+
+export const useDocumentVersionList = ({
+  documentId,
+}: {
+  documentId: string
+}): useDocumentVersionListState => {
+  const {data: releases} = useActiveReleases()
+  const {data: documentVersions} = useDocumentVersions({documentId})
+
+  const sortedDocumentList = releases
+    .filter(({_id}) => {
+      return documentVersions.some(
+        (id) => getVersionFromId(id) === getReleaseIdFromReleaseDocumentId(_id),
+      )
+    })
+    .sort((a, b) => {
+      return (
+        orderedReleaseTypes.indexOf(a.metadata.releaseType) -
+        orderedReleaseTypes.indexOf(b.metadata.releaseType)
+      )
+    })
+
+  const onlyHasVersions =
+    documentVersions &&
+    documentVersions.length > 0 &&
+    !documentVersions.some((version) => !isVersionId(version))
+
+  return useMemo(
+    () => ({
+      sortedDocumentList: sortedDocumentList,
+      onlyHasVersions,
+    }),
+    [sortedDocumentList, onlyHasVersions],
+  )
+}

packages/sanity/src/structure/i18n/resources.ts

@@ -136,6 +136,14 @@ const structureLocaleStrings = defineLocalesResources('structure', {
     'This reference has been removed since you opened it.',
   /** The text that appears for the action button to add the current document to the global release */
   'banners.release.action.add-to-release': 'Add to release',
+  /** The text that appears for the action button to add the current document to the global release */
+  'banners.release.action.open-to-edit': 'Open release to edit',
+  /** The text for the banner that appears when a document only has versions but is in a draft or published pinned release */
+  'banners.release.navigate-to-edit-description': 'The document only exists in the',
+  /** The text for the banner that appears when a document only has versions but is in a draft or published pinned release */
+  'banners.release.navigate-to-edit-description-end_one': 'release',
+  /** The text for the banner that appears when a document only has versions but is in a draft or published pinned release */
+  'banners.release.navigate-to-edit-description-end_other': 'releases',
   /** The text for the banner that appears when a document is not in the current global release */
   'banners.release.not-in-release': 'Not in the <VersionBadge>{{title}}</VersionBadge> release.',
 

packages/sanity/src/structure/panes/document/DocumentPaneProvider.tsx

@@ -22,6 +22,7 @@ import {
   getDraftId,
   getExpandOperations,
   getPublishedId,
+  getReleaseIdFromReleaseDocumentId,
   getVersionFromId,
   isGoingToUnpublish,
   isPublishedPerspective,
@@ -39,6 +40,8 @@ import {
   useCopyPaste,
   useDocumentOperation,
   useDocumentValuePermissions,
+  useDocumentVersionList,
+  useDocumentVersions,
   useEditState,
   useFormState,
   useInitialValue,
@@ -126,6 +129,7 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
   const params = useUnique(paneRouter.params) || EMPTY_PARAMS
 
   const perspective = usePerspective()
+  const {data: documentVersions} = useDocumentVersions({documentId})
 
   const {isReleaseLocked, selectedReleaseId, selectedPerspectiveName} = useMemo(() => {
     // TODO: COREL - Remove this after updating sanity-assist to use <PerspectiveProvider>
@@ -169,9 +173,34 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
   const initialValue = useUnique(initialValueRaw)
   const isInitialValueLoading = initialValue.loading
 
+  // if it only has versions then we need to make sure that whatever the first document that is allowed
+  // is a version document, but also that it has the right order
+  // this will make sure that then the right document appears and so does the right chip within the document header
+  const {sortedDocumentList, onlyHasVersions} = useDocumentVersionList({documentId})
+  const firstVersion =
+    sortedDocumentList.length > 0
+      ? documentVersions.find(
+          (id) =>
+            getVersionFromId(id) === getReleaseIdFromReleaseDocumentId(sortedDocumentList[0]._id),
+        )
+      : undefined
+
   const {patch} = useDocumentOperation(documentId, documentType, selectedReleaseId)
   const schemaType = schema.get(documentType) as ObjectSchemaType | undefined
-  const editState = useEditState(documentId, documentType, 'default', selectedReleaseId)
+  const id = useMemo(() => {
+    if (selectedReleaseId) {
+      return selectedReleaseId
+    }
+    // check if the selected version is the only version, if it isn't and it doesn't exist in hte release
+    // then it needs to use the documentVersions
+    if (!documentVersions || !onlyHasVersions) {
+      return selectedReleaseId
+    }
+    return getVersionFromId(firstVersion ?? '')
+  }, [documentVersions, onlyHasVersions, selectedReleaseId, firstVersion])
+
+  const editState = useEditState(documentId, documentType, 'default', id)
+
   const {validation: validationRaw} = useValidationStatus(
     documentId,
     documentType,
@@ -190,6 +219,10 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
         (liveEdit ? initialValue.value : {_id: documentId, _type: documentType})
       )
     }
+    // if no version is selected, but there is only version, it should default to the version version it finds
+    if (!selectedPerspectiveName && onlyHasVersions) {
+      return editState.version || editState.draft || editState.published || initialValue.value
+    }
     return editState.draft || editState.published || initialValue.value
   }, [
     documentId,
@@ -199,6 +232,7 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
     editState.version,
     initialValue.value,
     liveEdit,
+    onlyHasVersions,
     selectedPerspectiveName,
     selectedReleaseId,
   ])
@@ -607,6 +641,10 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
       return true
     }
 
+    if (!selectedPerspectiveName && onlyHasVersions) {
+      return true
+    }
+
     return (
       willBeUnpublished ||
       !ready ||
@@ -633,6 +671,7 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
     selectedPerspectiveName,
     selectedReleaseId,
     value._id,
+    onlyHasVersions,
     willBeUnpublished,
     ready,
     revisionId,

packages/sanity/src/structure/panes/document/documentPanel/DocumentPanel.tsx

@@ -4,8 +4,10 @@ import {
   getVersionFromId,
   isReleaseDocument,
   isReleaseScheduledOrScheduling,
+  isVersionId,
   type ReleaseDocument,
   ScrollContainer,
+  useDocumentVersions,
   usePerspective,
   VirtualizerScrollInstanceProvider,
 } from 'sanity'
@@ -26,6 +28,7 @@ import {
 import {AddToReleaseBanner} from './banners/AddToReleaseBanner'
 import {ArchivedReleaseDocumentBanner} from './banners/ArchivedReleaseDocumentBanner'
 import {DraftLiveEditBanner} from './banners/DraftLiveEditBanner'
+import {OpenReleaseToEditBanner} from './banners/OpenReleaseToEditBanner'
 import {ScheduledReleaseBanner} from './banners/ScheduledReleaseBanner'
 import {UnpublishedDocumentBanner} from './banners/UnpublishedDocumentBanner'
 import {FormView} from './documentViews'
@@ -80,6 +83,7 @@ export const DocumentPanel = function DocumentPanel(props: DocumentPanelProps) {
   const [_portalElement, setPortalElement] = useState<HTMLDivElement | null>(null)
   const [documentScrollElement, setDocumentScrollElement] = useState<HTMLDivElement | null>(null)
   const formContainerElement = useRef<HTMLDivElement | null>(null)
+  const {data: documentVersions} = useDocumentVersions({documentId})
 
   const requiredPermission = value._createdAt ? 'update' : 'create'
 
@@ -150,18 +154,30 @@ export const DocumentPanel = function DocumentPanel(props: DocumentPanelProps) {
     if (params?.historyVersion) {
       return <ArchivedReleaseDocumentBanner />
     }
-    const isCreatingDocument = displayed && !displayed._createdAt
     const isScheduledRelease =
       isReleaseDocument(selectedPerspective) && isReleaseScheduledOrScheduling(selectedPerspective)
-
     if (isScheduledRelease) {
       return <ScheduledReleaseBanner currentRelease={selectedPerspective as ReleaseDocument} />
     }
+    const isDraftOrPublish: boolean =
+      selectedPerspective === 'drafts' || selectedPerspective === 'published'
+    const onlyHasVersions =
+      documentVersions && documentVersions.length > 0 && isVersionId(documentVersions[0])
+
+    if (isDraftOrPublish && onlyHasVersions) {
+      return (
+        <OpenReleaseToEditBanner
+          documentId={displayed?._id ?? documentId}
+          documentVersions={documentVersions}
+        />
+      )
+    }
+
     if (
       displayed?._id &&
       getVersionFromId(displayed._id) !== selectedReleaseId &&
       ready &&
-      !isCreatingDocument
+      !isDraftOrPublish
     ) {
       return (
         <AddToReleaseBanner
@@ -205,6 +221,7 @@ export const DocumentPanel = function DocumentPanel(props: DocumentPanelProps) {
     params?.historyVersion,
     displayed,
     selectedPerspective,
+    documentVersions,
     selectedReleaseId,
     ready,
     activeView.type,
@@ -213,8 +230,8 @@ export const DocumentPanel = function DocumentPanel(props: DocumentPanelProps) {
     isPermissionsLoading,
     permissions?.granted,
     requiredPermission,
-    value._id,
     documentId,
+    value._id,
     schemaType,
   ])
 

packages/sanity/src/structure/panes/document/documentPanel/banners/OpenReleaseToEditBanner.tsx

@@ -0,0 +1,78 @@
+import {type ReleaseId} from '@sanity/client'
+import {Flex, Text} from '@sanity/ui'
+import {useCallback, useMemo} from 'react'
+import {
+  getReleaseTone,
+  getVersionFromId,
+  useActiveReleases,
+  useSetPerspective,
+  useTranslation,
+  VersionInlineBadge,
+} from 'sanity'
+import {structureLocaleNamespace} from 'sanity/structure'
+
+import {Button} from '../../../../../ui-components'
+import {Banner} from './Banner'
+
+export function OpenReleaseToEditBanner({
+  documentId,
+  documentVersions,
+}: {
+  documentId: string
+  documentVersions: string[]
+}): React.JSX.Element {
+  const {data: activeReleases} = useActiveReleases()
+  const setPerspective = useSetPerspective()
+  const releaseId = getVersionFromId(documentId) ?? ''
+  const currentVersion = useMemo(
+    () => activeReleases.find((version) => version._id.includes(releaseId)),
+    [activeReleases, releaseId],
+  )
+
+  const documentVersionsTitleList = useMemo(
+    () =>
+      activeReleases
+        .filter((version) => {
+          return documentVersions.find((release) => {
+            const r = getVersionFromId(release) ?? ''
+            return version._id.includes(r)
+          })
+        })
+        .map((version) => version.metadata.title),
+    [activeReleases, documentVersions],
+  )
+  const tone = currentVersion && getReleaseTone(currentVersion)
+  const {t} = useTranslation(structureLocaleNamespace)
+
+  const handleGoToEdit = useCallback(async () => {
+    setPerspective(releaseId as ReleaseId)
+  }, [releaseId, setPerspective])
+
+  return (
+    <Banner
+      tone={tone}
+      paddingY={0}
+      content={
+        <Flex direction={'row'} align="center" justify="space-between" flex={1}>
+          <Text size={1}>
+            <Flex direction={'row'} gap={1}>
+              {t('banners.release.navigate-to-edit-description')}
+              {documentVersionsTitleList.map((title) => (
+                <VersionInlineBadge key={`${title}${documentId}`}>{title}</VersionInlineBadge>
+              ))}
+              {t('banners.release.navigate-to-edit-description-end', {
+                count: documentVersionsTitleList.length,
+              })}
+            </Flex>
+          </Text>
+
+          <Button
+            text={t('banners.release.action.open-to-edit')}
+            tone={tone}
+            onClick={handleGoToEdit}
+          />
+        </Flex>
+      }
+    />
+  )
+}

packages/sanity/src/structure/panes/document/documentPanel/header/perspective/DocumentPerspectiveList.tsx

@@ -91,6 +91,7 @@ export const DocumentPerspectiveList = memo(function DocumentPerspectiveList() {
   const {editState, displayed, documentType, documentId} = useDocumentPane()
   const {data: documentVersions} = useDocumentVersions({documentId})
   const isCreatingDocument = displayed && !displayed._createdAt
+  const onlyHasVersions = !editState?.published && !editState?.draft && documentVersions?.length > 0
 
   const filteredReleases: FilterReleases = useMemo(() => {
     if (!documentVersions) return {notCurrentReleases: [], currentReleases: [], inCreation: null}
@@ -230,14 +231,21 @@ export const DocumentPerspectiveList = memo(function DocumentPerspectiveList() {
   ])
 
   const isDraftDisabled: boolean = useMemo(() => {
+    // Draft is disabled when the document has no published or draft but has versions
+    if (onlyHasVersions || (isCreatingDocument && selectedReleaseId)) {
+      return true
+    }
+
     // Draft is disabled when we are creating a new document inside a release
     // or when the document is live edit and there is no draft
-    if (editState?.draft) return false
+    if (!editState?.draft && !isLiveEdit) {
+      return false
+    }
 
     if (isCreatingDocument && selectedReleaseId) return true
     if (isLiveEdit) return true
     return false
-  }, [editState?.draft, isCreatingDocument, isLiveEdit, selectedReleaseId])
+  }, [editState?.draft, isCreatingDocument, isLiveEdit, onlyHasVersions, selectedReleaseId])
 
   return (
     <>