refactor(sanity): fix type issues with collate, update tests and readQueryResult

packages/sanity/src/core/form/studio/inputs/client-adapters/reference.ts

@@ -243,7 +243,7 @@ export function referenceSearch(
   })
   return search(textTerm, {includeDrafts: true}).pipe(
     map(({hits}) => hits.map(({hit}) => hit)),
-    map((docs) => collate(docs)),
+    map((docs) => collate({documents: docs})),
     // pick the 100 best matches
     map((collated) => collated.slice(0, 100)),
     mergeMap((collated) => {

packages/sanity/src/core/form/studio/inputs/crossDatasetReference/datastores/search.ts

@@ -31,7 +31,7 @@ export function search(
     isCrossDataset: true,
   }).pipe(
     map(({hits}) => hits.map(({hit}) => hit)),
-    map((docs) => collate(docs)),
+    map((docs) => collate({documents: docs})),
     map((collated) =>
       collated.map((entry) => ({
         id: entry.id,

packages/sanity/src/core/util/draftUtils.test.ts

@@ -1,5 +1,5 @@
 import {describe, expect, it, test} from '@jest/globals'
-import {type SanityDocument} from '@sanity/types'
+import {type SanityDocument, type SanityDocumentLike} from '@sanity/types'
 
 import {
   collate,
@@ -11,12 +11,12 @@ import {
 } from './draftUtils'
 
 test('collate()', () => {
-  const foo = {_type: 'foo', _id: 'foo'}
-  const fooDraft = {_type: 'foo', _id: 'drafts.foo'}
-  const barDraft = {_type: 'foo', _id: 'drafts.bar'}
-  const baz = {_type: 'foo', _id: 'baz'}
+  const foo = {_type: 'foo', _id: 'foo'} as SanityDocumentLike
+  const fooDraft = {_type: 'foo', _id: 'drafts.foo'} as SanityDocumentLike
+  const barDraft = {_type: 'foo', _id: 'drafts.bar'} as SanityDocumentLike
+  const baz = {_type: 'foo', _id: 'baz'} as SanityDocumentLike
 
-  expect(collate([foo, fooDraft, barDraft, baz])).toEqual([
+  expect(collate({documents: [foo, fooDraft, barDraft, baz]})).toEqual([
     {type: 'foo', id: 'foo', draft: fooDraft, published: foo},
     {type: 'foo', id: 'bar', draft: barDraft},
     {type: 'foo', id: 'baz', published: baz},

packages/sanity/src/core/util/draftUtils.ts

@@ -180,8 +180,10 @@ export interface CollatedHit<T extends {_id: string} = {_id: string}> {
 }
 
 /** @internal */
-export function collate<T extends {_id: string; _type: string}>(documents: T[]): CollatedHit<T>[] {
-  const byId = documents.reduce((res, doc) => {
+export function collate<T extends {_id: string; _type: string}>(documents: {
+  documents: SanityDocumentLike[]
+}): CollatedHit<T>[] {
+  const byId = documents.documents?.reduce((res, doc) => {
     const publishedId = getPublishedId(doc._id)
     let entry = res.get(publishedId)
     if (!entry) {
@@ -199,7 +201,7 @@ export function collate<T extends {_id: string; _type: string}>(documents: T[]):
 /** @internal */
 // Removes published documents that also has a draft
 export function removeDupes(documents: SanityDocumentLike[]): SanityDocumentLike[] {
-  return collate(documents)
+  return collate({documents})
     .map((entry) => entry.draft || entry.published)
     .filter(isNonNullable)
 }

packages/sanity/src/structure/panes/documentList/helpers.ts

@@ -19,9 +19,9 @@ export function getDocumentKey(value: DocumentListPaneItem, index: number): stri
 }
 
 export function removePublishedWithDrafts(documents: SanityDocumentLike[]): DocumentListPaneItem[] {
-  return collate(documents).map((entry) => {
+  return collate({documents}).map((entry) => {
     const doc = entry.draft || entry.published
-    const isVersion = doc?.id && isVersionId(doc._id)
+    const isVersion = doc?._id && isVersionId(doc._id)
     const hasDraft = Boolean(entry.draft)
 
     return {

packages/sanity/src/structure/panes/documentList/types.ts

@@ -1,6 +1,12 @@
 import {type SanityDocumentLike} from '@sanity/types'
 import {type SearchSort} from 'sanity'
 
+export interface QueryResult {
+  error: {message: string} | null
+  onRetry?: () => void
+  result: {documents: SanityDocumentLike[]} | null
+}
+
 export interface DocumentListPaneItem extends SanityDocumentLike {
   hasPublished: boolean
   hasDraft: boolean