sanity/src/core/preview/useLiveDocumentIdSet.ts

Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches

import {type QueryParams} from '@sanity/client'
import {useMemo} from 'react'
import {useObservable} from 'react-rx'
import {scan} from 'rxjs/operators'

import {useDocumentPreviewStore} from '../store/_legacy/datastores'
import {type DocumentIdSetObserverState} from './liveDocumentIdSet'

const INITIAL_STATE = {status: 'loading' as const, documentIds: []}

export type LiveDocumentSetState =
  | {status: 'loading'; documentIds: string[]}
  | DocumentIdSetObserverState

/**
 * @internal
 * @beta
 * Returns document ids that matches the provided GROQ-filter, and loading state
 * The document ids are returned in ascending order and will update in real-time
 * Whenever a document appears or disappears from the set, a new array with the updated set of IDs will be returned.
 * This provides a lightweight way of subscribing to a list of ids for simple cases where you just want the documents ids
 * that matches a particular filter.
 */
export function useLiveDocumentIdSet(
  filter: string,
  params?: QueryParams,
  options: {
    // how to insert new document ids. Defaults to `sorted`
    insert?: 'sorted' | 'prepend' | 'append'
    apiVersion?: string
  } = {},
) {
  const documentPreviewStore = useDocumentPreviewStore()
  const observable = useMemo(
    () =>
      documentPreviewStore.unstable_observeDocumentIdSet(filter, params, options).pipe(
        scan(
          (currentState: LiveDocumentSetState, nextState) => ({
            ...currentState,
            ...nextState,
          }),
          INITIAL_STATE,
        ),
      ),
    [documentPreviewStore, filter, params, options],
  )
  return useObservable(observable, INITIAL_STATE)
}