chore(core): move events story to structure

packages/sanity/src/core/store/_legacy/history/history/chunker.ts

@@ -21,6 +21,10 @@ const mergeEvents = (
   }
 }
 
+/**
+ * @internal
+ * Decides whether to merge two chunks or not according to their type and timestamp
+ */
 export function mergeChunk(left: Chunk, right: Chunk): Chunk | [Chunk, Chunk] {
   if (left.end !== right.start) throw new Error('chunks are not next to each other')
   if (
@@ -42,6 +46,10 @@ export function mergeChunk(left: Chunk, right: Chunk): Chunk | [Chunk, Chunk] {
   return [left, right]
 }
 
+/**
+ * @internal
+ * Creates a chunk for the timeline from a transaction.
+ */
 export function chunkFromTransaction(
   publishedId: string,
   transaction: Transaction,

packages/sanity/src/core/store/_legacy/history/history/index.ts

@@ -1,3 +1,4 @@
+export * from './chunker'
 export * from './Timeline'
 export * from './TimelineController'
 export * from './types'

packages/sanity/src/core/store/events/getDocumentEvents.ts

@@ -93,7 +93,13 @@ function isDeletePatch(patch: MendozaPatch): boolean {
   return patch[0] === 0 && patch[1] === null
 }
 
-// This assumes the view is from the publishedDocument having only drafts. (Versions are not yet supported here)
+/**
+ * @internal
+ * @beta
+ * This might change, don't use.
+ * This function receives a transaction and returns a document group event.
+ * Assumes the user is viewing the published document with only drafts. (Versions are not yet supported here)
+ */
 export function getEventFromTransaction(
   documentId: string,
   transaction: Transaction,
@@ -312,6 +318,12 @@ const isDocumentGroupEvent = (event: unknown): event is DocumentGroupEvent => {
   return eventType ? documentVersionEventTypes.includes(eventType) : false
 }
 
+/**
+ *
+ * @internal
+ * @beta
+ * This function receives a transaction and returns a transaction with the draft and published effects.
+ */
 export const addTransactionEffect = (
   documentId: string,
   transaction: TransactionLogEventWithEffects,

packages/sanity/src/core/store/index.ts

@@ -1,2 +1,3 @@
 export * from './_legacy'
+export * from './events/getDocumentEvents'
 export * from './user'

packages/sanity/src/core/store/events/__workshop__/DocumentGroupEvent.tsx → packages/sanity/src/structure/panes/document/timeline/__workshop__/DocumentGroupEvent.tsx

@@ -6,12 +6,19 @@ import {useString} from '@sanity/ui-workshop'
 import {useMemo, useState} from 'react'
 import {useObservable} from 'react-rx'
 import {catchError, map, type Observable, of, startWith, Subject, switchMap} from 'rxjs'
-import {type Chunk, getDraftId, getPublishedId, useClient} from 'sanity'
+import {
+  addTransactionEffect,
+  type Chunk,
+  chunkFromTransaction,
+  getDocumentEvents,
+  getDraftId,
+  getPublishedId,
+  mergeChunk,
+  useClient,
+} from 'sanity'
 
-import {Timeline} from '../../../../structure/panes/document/timeline/timeline'
-import {Button} from '../../../../ui-components'
-import {chunkFromTransaction, mergeChunk} from '../../_legacy/history/history/chunker'
-import {addTransactionEffect, getDocumentEvents} from '../getDocumentEvents'
+import {Button} from '../../../../../ui-components'
+import {Timeline} from '../timeline'
 
 const query = {
   excludeContent: 'true',

packages/sanity/src/structure/panes/document/timeline/__workshop__/index.ts

@@ -10,5 +10,10 @@ export default defineScope({
       title: 'Default',
       component: lazy(() => import('./DefaultStory')),
     },
+    {
+      name: 'get-document-events',
+      title: 'Document group events',
+      component: lazy(() => import('./DocumentGroupEvent')),
+    },
   ],
 })