sanity/src/core/releases/store/useReleasesMetadata.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 {useEffect, useState} from 'react'

import {useReleasesMetadataProvider} from '../contexts/ReleasesMetadataProvider'

export interface ReleasesMetadata {
  /**
   * The number of documents with the release version as a prefix
   */
  documentCount: number
  /**
   * The last time a document in the release was edited
   */
  updatedAt: string | null
}

export const useReleasesMetadata = (releaseIds: string[]) => {
  const {
    addReleaseIdsToListener: addBundleIdsToListener,
    removeReleaseIdsFromListener: removeBundleIdsFromListener,
    state,
  } = useReleasesMetadataProvider()
  const [responseData, setResponseData] = useState<Record<string, ReleasesMetadata> | null>(null)

  useEffect(() => {
    if (releaseIds.length) addBundleIdsToListener([...new Set(releaseIds)])

    return () => removeBundleIdsFromListener([...new Set(releaseIds)])
  }, [addBundleIdsToListener, releaseIds, removeBundleIdsFromListener])

  const {data, loading} = state

  useEffect(() => {
    if (!data) return

    const hasUpdatedMetadata =
      !responseData || Object.entries(responseData).some(([key, value]) => value !== data[key])

    if (hasUpdatedMetadata) {
      const nextResponseData = Object.fromEntries(
        releaseIds.map((releaseId) => [releaseId, data[releaseId]]),
      )

      setResponseData(nextResponseData)
    }
  }, [releaseIds, data, responseData])

  return {
    error: state.error,
    // loading is only for initial load
    // changing listened to release IDs will not cause a re-load
    loading,
    data: responseData,
  }
}