sanity/src/structure/structureBuilder/ChildResolver.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 Observable} from 'rxjs'

import {type Collection, type CollectionBuilder, type SerializeOptions} from './StructureNodes'
import {type StructureContext} from './types'

/**
 * Interface for child resolver options
 *
 * @public
 */
// TODO: unify with the RouterSplitPaneContext
export interface ChildResolverOptions {
  /** Child parent */
  parent: unknown
  /** Child index */
  index: number
  splitIndex: number
  /** Child path */
  path: string[]
  /** Child parameters */
  params: Record<string, string | undefined>
  /** Structure context. See {@link StructureContext} */
  structureContext: StructureContext
  /** Serialize options. See {@link SerializeOptions} */
  serializeOptions?: SerializeOptions
}

/**
 * Item Child. See {@link CollectionBuilder} and {@link Collection}
 *
 * @public
 */
export type ItemChild = CollectionBuilder | Collection | undefined

/**
 * Interface for child observable
 *
 * @public
 */
export interface ChildObservable {
  /** Subscribes to the child observable. See {@link ItemChild} */
  subscribe: (child: ItemChild | Promise<ItemChild>) => Record<string, unknown>
}

/**
 * Interface for child resolver
 *
 * @public */
// TODO: unify with PaneNodeResolver in structure-tool
export interface ChildResolver {
  (
    itemId: string,
    options: ChildResolverOptions,
  ): ItemChild | Promise<ItemChild> | ChildObservable | Observable<ItemChild> | undefined
}