fix(core): update return tye of useEventsStore

sanity-io · Dec 2, 2024 · c970cdf · c970cdf
1 parent ccd45ca
commit c970cdf
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 36 deletions.
diff --git a/packages/sanity/src/core/field/diff/components/DiffTooltip.tsx b/packages/sanity/src/core/field/diff/components/DiffTooltip.tsx
@@ -1,7 +1,6 @@
 import {type Path} from '@sanity/types'
 import {Card, Flex, Inline, Stack, Text} from '@sanity/ui'
 import {type ReactElement, type ReactNode} from 'react'
-import {getDocumentVariantType} from 'sanity'
 
 import {Tooltip, type TooltipProps} from '../../../../ui-components'
 import {LegacyLayerProvider, UserAvatar} from '../../../components'
@@ -81,11 +80,7 @@ function AnnotationItem({annotation}: {annotation: AnnotationDetails}) {
       {annotation.event ? (
         <>
           <Card borderBottom marginBottom={2} />
-          <Event
-            documentVariantType={getDocumentVariantType(annotation.event.documentId)}
-            event={annotation.event}
-            showChangesBy="inline"
-          />
+          <Event event={annotation.event} showChangesBy="inline" />
         </>
       ) : (
         <Inline space={2}>

diff --git a/packages/sanity/src/core/field/diff/components/Event.tsx b/packages/sanity/src/core/field/diff/components/Event.tsx
@@ -15,7 +15,7 @@ import {
 import {css, styled} from 'styled-components'
 
 import {Tooltip} from '../../../../ui-components'
-import {type DocumentVariantType} from '../../../util/getDocumentVariantType'
+import {getDocumentVariantType} from '../../../util/getDocumentVariantType'
 import {
   TIMELINE_ICON_COMPONENTS,
   TIMELINE_ITEM_EVENT_TONE,
@@ -119,14 +119,14 @@ const ChangesBy = ({collaborators}: {collaborators: string[]}) => {
 
 interface TimelineItemProps {
   event: DocumentGroupEvent
-  documentVariantType: DocumentVariantType
   showChangesBy: 'tooltip' | 'inline' | 'hidden'
 }
 /**
  * @internal
  */
-export function Event({event, showChangesBy = 'tooltip', documentVariantType}: TimelineItemProps) {
+export function Event({event, showChangesBy = 'tooltip'}: TimelineItemProps) {
   const {t} = useTranslation('studio')
+  const documentVariantType = getDocumentVariantType(event.id)
   const {type, timestamp} = event
 
   const iconComponent = TIMELINE_ICON_COMPONENTS[type]

diff --git a/packages/sanity/src/core/store/events/types.ts b/packages/sanity/src/core/store/events/types.ts
@@ -137,7 +137,6 @@ import {type SanityDocument} from '@sanity/types'
 import {type Observable} from 'rxjs'
 
 import {type ObjectDiff} from '../../field'
-import {type DocumentVariantType} from '../../util/getDocumentVariantType'
 
 /**
  * Events relevant for the whole document group.
@@ -445,8 +444,6 @@ export interface EventsStoreRevision {
  * @internal
  * */
 export interface EventsStore {
-  enabled: true
-  documentVariantType: DocumentVariantType
   events: DocumentGroupEvent[]
   nextCursor: string | null
   loading: boolean

diff --git a/packages/sanity/src/core/store/events/useEventsStore.ts b/packages/sanity/src/core/store/events/useEventsStore.ts
@@ -185,8 +185,6 @@ export function useEventsStore({
   )
 
   return {
-    documentVariantType,
-    enabled: true as const,
     events,
     nextCursor,
     loading,

diff --git a/packages/sanity/src/structure/panes/document/inspectors/changes/EventsSelector.tsx b/packages/sanity/src/structure/panes/document/inspectors/changes/EventsSelector.tsx
@@ -39,7 +39,6 @@ export function EventsSelector({showList}: {showList: boolean}) {
     loading,
     error,
     revision,
-    documentVariantType,
     loadMoreEvents,
     findRangeForRevision,
     expandEvent,
@@ -97,7 +96,6 @@ export function EventsSelector({showList}: {showList: boolean}) {
                   onLoadMore={loadMoreEvents}
                   onSelect={selectRev}
                   listMaxHeight={`${listHeight}px`}
-                  documentVariantType={documentVariantType}
                 />
               ) : null}
               {loading && <LoadingBlock />}

diff --git a/packages/sanity/src/structure/panes/document/timeline/events/EventTimelineItem.tsx b/packages/sanity/src/structure/panes/document/timeline/events/EventTimelineItem.tsx
@@ -1,6 +1,6 @@
 import {Card, Flex} from '@sanity/ui'
 import {type MouseEvent, useCallback} from 'react'
-import {type DocumentGroupEvent, type DocumentVariantType, Event} from 'sanity'
+import {type DocumentGroupEvent, Event} from 'sanity'
 
 import {Tooltip} from '../../../../../ui-components'
 
@@ -9,7 +9,6 @@ export interface TimelineItemProps {
   isSelected: boolean
   onSelect: (chunk: DocumentGroupEvent) => void
   optionsMenu?: React.ReactNode
-  documentVariantType: DocumentVariantType
 }
 
 const getIsSelectable = (event: DocumentGroupEvent) => {
@@ -23,15 +22,8 @@ const getIsSelectable = (event: DocumentGroupEvent) => {
   )
 }
 
-export function EventTimelineItem({
-  event,
-  isSelected,
-  onSelect,
-  optionsMenu,
-  documentVariantType,
-}: TimelineItemProps) {
+export function EventTimelineItem({event, isSelected, onSelect, optionsMenu}: TimelineItemProps) {
   const isSelectable = getIsSelectable(event)
-
   const handleClick = useCallback(
     (evt: MouseEvent<HTMLDivElement>) => {
       evt.preventDefault()
@@ -69,7 +61,7 @@ export function EventTimelineItem({
             cursor: isSelectable ? 'pointer' : 'default',
           }}
         >
-          <Event event={event} showChangesBy="tooltip" documentVariantType={documentVariantType} />
+          <Event event={event} showChangesBy="tooltip" />
         </Card>
         {optionsMenu}
       </Flex>

diff --git a/packages/sanity/src/structure/panes/document/timeline/events/EventsTimeline.tsx b/packages/sanity/src/structure/panes/document/timeline/events/EventsTimeline.tsx
@@ -5,7 +5,7 @@ import {
   CommandList,
   type CommandListRenderItemCallback,
   type DocumentGroupEvent,
-  type DocumentVariantType,
+  getDocumentVariantType,
   isCreateDocumentVersionEvent,
   isEditDocumentVersionEvent,
   LoadingBlock,
@@ -28,7 +28,6 @@ interface TimelineProps {
    * The list needs a predefined max height for the scroller to work.
    */
   listMaxHeight?: string
-  documentVariantType: DocumentVariantType
 }
 
 const TimelineItemWrapper = motion(Box)
@@ -54,7 +53,6 @@ export const EventsTimeline = ({
   selectedEventId,
   onLoadMore,
   onSelect,
-  documentVariantType,
   listMaxHeight = 'calc(100vh - 280px)',
   onExpand,
 }: TimelineProps) => {
@@ -120,6 +118,7 @@ export const EventsTimeline = ({
 
   const renderOptionsMenu = useCallback(
     (event: DocumentGroupEvent) => {
+      const documentVariantType = getDocumentVariantType(event.id)
       if (event.type === 'PublishDocumentVersion' && documentVariantType === 'published') {
         return <PublishedEventMenu event={event} />
       }
@@ -137,7 +136,7 @@ export const EventsTimeline = ({
       }
       return null
     },
-    [documentVariantType, expandedParents, handleExpandParent],
+    [expandedParents, handleExpandParent],
   )
 
   const renderItem = useCallback<CommandListRenderItemCallback<DocumentGroupEvent[][number]>>(
@@ -189,7 +188,6 @@ export const EventsTimeline = ({
             isSelected={event.id === selectedEventId}
             onSelect={handleSelectChunk}
             optionsMenu={renderOptionsMenu(event)}
-            documentVariantType={documentVariantType}
           />
 
           {isLastEvent && hasMoreEvents && <LoadingBlock />}
@@ -201,7 +199,6 @@ export const EventsTimeline = ({
       selectedEventId,
       handleSelectChunk,
       renderOptionsMenu,
-      documentVariantType,
       events.length,
       hasMoreEvents,
     ],

diff --git a/packages/sanity/src/structure/panes/document/timeline/events/EventsTimelineMenue.tsx b/packages/sanity/src/structure/panes/document/timeline/events/EventsTimelineMenue.tsx
@@ -52,7 +52,6 @@ export function EventsTimelineMenu({event, events, mode, placement}: TimelineMen
     findRangeForRevision,
     findRangeForSince,
     loadMoreEvents,
-    documentVariantType,
     expandEvent,
   } = useEvents()
 
@@ -142,7 +141,6 @@ export function EventsTimelineMenu({event, events, mode, placement}: TimelineMen
         selectedEventId={event?.id}
         onLoadMore={handleLoadMore}
         onSelect={mode === 'rev' ? selectRev : selectSince}
-        documentVariantType={documentVariantType}
       />
     )
   }, [
@@ -154,7 +152,6 @@ export function EventsTimelineMenu({event, events, mode, placement}: TimelineMen
     event?.id,
     handleLoadMore,
     selectSince,
-    documentVariantType,
     selectRev,
   ])