sanity/lib/_internal/cli/threads/validateDocuments.d.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 {ClientConfig} from '@sanity/client'
import {ValidationMarker} from '@sanity/types'

/** @internal */
export declare interface ValidateDocumentsWorkerData {
  workDir: string
  configPath?: string
  workspace?: string
  clientConfig?: Partial<ClientConfig>
  projectId?: string
  dataset?: string
  ndjsonFilePath?: string
  level?: ValidationMarker['level']
  maxCustomValidationConcurrency?: number
  maxFetchConcurrency?: number
  studioHost?: string
}

/** @internal */
export declare type ValidationWorkerChannel = WorkerChannel<{
  loadedWorkspace: WorkerChannelEvent<{
    name: string
    projectId: string
    dataset: string
    basePath: string
  }>
  loadedDocumentCount: WorkerChannelEvent<{
    documentCount: number
  }>
  exportProgress: WorkerChannelStream<{
    downloadedCount: number
    documentCount: number
  }>
  exportFinished: WorkerChannelEvent<{
    totalDocumentsToValidate: number
  }>
  loadedReferenceIntegrity: WorkerChannelEvent
  validation: WorkerChannelStream<{
    validatedCount: number
    documentId: string
    documentType: string
    intentUrl?: string
    revision: string
    level: ValidationMarker['level']
    markers: ValidationMarker[]
  }>
}>

/**
 * Represents the definition of a "worker channel" to report progress from the
 * worker to the parent. Worker channels can define named events or streams and
 * the worker will report events and streams while the parent will await them.
 * This allows the control flow of the parent to follow the control flow of the
 * worker 1-to-1.
 */
declare type WorkerChannel<
  TWorkerChannel extends Record<
    string,
    WorkerChannelEvent<unknown> | WorkerChannelStream<unknown>
  > = Record<string, WorkerChannelEvent<unknown> | WorkerChannelStream<unknown>>,
> = TWorkerChannel

declare type WorkerChannelEvent<TPayload = void> = {
  type: 'event'
  payload: TPayload
}

declare type WorkerChannelStream<TPayload = void> = {
  type: 'stream'
  payload: TPayload
}

export {}