@sanity/client/src/context/store.ts

Client for retrieving, creating and patching data from Sanity.io

import {type Observable, throwError} from 'rxjs'
import {map} from 'rxjs/operators'

import {_requestObservable, getQuerySizeLimit} from '../data/dataMethods'
import {encodeQueryString} from '../data/encodeQueryString'
import {
  _connectListenEventSource,
  defaultOptions as defaultListenOptions,
  type ListenEventFromOptions,
  MAX_URL_LENGTH,
  possibleOptions as possibleListenOptions,
} from '../data/listen'
import type {ObservableSanityClient, SanityClient} from '../SanityClient'
import type {HttpRequest, QueryParams, ResumableListenEventNames, SanityDocument} from '../types'
import defaults from '../util/defaults'
import {pick} from '../util/pick'
import {
  type ContextListenOptions,
  type ContextRequestOptions,
  possibleStoreRequestOptions,
} from './types'

type Client = SanityClient | ObservableSanityClient

/** @internal */
export function _organizationId(client: Client): string {
  const organizationId = client.config().context?.organizationId

  if (!organizationId) {
    throw new Error('`context.organizationId` must be configured to query Context documents')
  }

  return organizationId
}

function storeUrl(client: Client, suffix: 'query' | 'listen'): string {
  return `/context/organizations/${encodeURIComponent(_organizationId(client))}/${suffix}`
}

/** @internal */
export function _fetch<R>(
  client: Client,
  httpRequest: HttpRequest,
  query: string,
  params?: QueryParams,
  options?: ContextRequestOptions,
): Observable<R> {
  const url = storeUrl(client, 'query')

  // Mirrors `client.fetch`: GET while the query fits in the URL, POST beyond that.
  const useGet = encodeQueryString({query, params}).length < getQuerySizeLimit
  const request = useGet
    ? {
        method: 'GET',
        url: `${url}${encodeQueryString({query, params})}`,
      }
    : {
        method: 'POST',
        url,
        body: {query, params: params ?? {}},
      }

  return _requestObservable<{result: R}>(client, httpRequest, {
    ...request,
    ...pick(options || {}, possibleStoreRequestOptions),
  }).pipe(map((response) => response.result))
}

/** @internal */
export function _listen<Opts extends ContextListenOptions | undefined = undefined>(
  client: Client,
  query: string,
  params?: QueryParams,
  options?: Opts,
): Observable<ListenEventFromOptions<SanityDocument, Opts>> {
  const opts: ContextListenOptions = options ?? {}

  // Mirrors `_listen` in data/listen.ts, but against the Context store's listen endpoint
  const {requestTagPrefix} = client.config()
  const tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join('.') : opts.tag
  const listenOpts = pick({...defaults(opts, defaultListenOptions), tag}, possibleListenOptions)
  const qs = encodeQueryString({
    query,
    params,
    options: listenOpts,
  })

  const uri = `${client.getUrl(storeUrl(client, 'listen'))}${qs}`
  if (uri.length > MAX_URL_LENGTH) {
    return throwError(() => new Error('Query too large for listener'))
  }

  const events: ResumableListenEventNames[] = opts.events ? opts.events : ['mutation']

  return _connectListenEventSource<ListenEventFromOptions<SanityDocument, Opts>>(
    client,
    uri,
    events,
  )
}