@stoplight/graphite/scheduler/types.d.ts

import { Resolver } from '@stoplight/json-ref-resolver';
import { IDisposable } from '@stoplight/lifecycle';
import { IDiagnostic } from '@stoplight/types';
import { IPatchableGraph, SelectableNode } from '../graph';
import { INodeFinder, JsonPatch } from '../graph/dom';
import { INodeSelector, NodeInstance } from '../graph/nodes';
import { ITraceData } from '../types';
export interface ISchedulerStateSnapshot {
    running: Array<{
        id: string;
        op: GraphTaskOp;
        type?: NodeInstance['type'];
        spec?: string;
        path?: NodeInstance['path'];
        language?: string;
    }>;
    tasks: GraphTask[];
    queued: string[];
}
export interface IScheduler {
    queue: (task: GraphTask) => Promise<void>;
    queueAll: (tasks: GraphTask[]) => Array<Promise<void>>;
    queueLength: () => number;
    run: (task: GraphTask) => Promise<void>;
    registerHandler: <T extends GraphTask = GraphTask, N extends NodeInstance = NodeInstance>(op: T['op'], handler: ITaskHandler<T, N>) => IDisposable;
    drain: () => Promise<any>;
    snapshot: () => ISchedulerStateSnapshot;
    isBusy: boolean;
    mightBeStuck: boolean;
    queuedCount: number;
}
export declare enum GraphTaskOp {
    ReadSourceNode = 1,
    WriteSourceNode = 2,
    DeleteSourceNode = 3,
    MoveSourceNode = 4,
    SerializeSourceNode = 5,
    DeserializeSourceNode = 6,
    DiffRawToParsed = 7,
    ComputeSourceMap = 8,
    ResolveSourceNode = 9,
    ValidateSourceNode = 10,
    TransformParsed = 11
}
export declare type GraphTask = IReadSourceNode | IWriteSourceNode | IDeleteSourceNode | IMoveSourceNode | IDeserializeSourceNode | ISerializeSourceNode | IComputeSourceMap | ITransformedParsedData | IResolveSourceNode | IDiagnoseSourceNode;
export declare type GraphTaskResult<T extends GraphTask = GraphTask> = T[] | void;
export declare type TaskRunFunc<T extends GraphTask = GraphTask, N extends NodeInstance = NodeInstance> = (node: N, api: ITaskHandlerApi<T>) => Promise<GraphTaskResult<T>> | GraphTaskResult<T>;
export interface ITaskHandler<T extends GraphTask = GraphTask, N extends NodeInstance = NodeInstance> extends INodeSelector<N> {
    id: string;
    selector(node: SelectableNode): node is N;
    run: TaskRunFunc<T, N>;
}
export interface ITaskHandlerApi<T extends GraphTask = GraphTask> extends Omit<IPatchableGraph, 'setSourceNodeDiagnostics'>, INodeFinder {
    task: T;
    runTask: (task: T) => Promise<void>;
    queueTask: (task: T) => Promise<void>;
    setSourceNodeDiagnostics(id: string, source: string, diagnostics: IDiagnostic[], trace?: ITraceData): void;
    resolver: Resolver;
}
export interface ITaskBase {
    op: GraphTaskOp;
    nodeId: string;
    trace?: ITraceData;
}
export interface IReadSourceNode extends ITaskBase {
    op: GraphTaskOp.ReadSourceNode;
}
export interface IWriteSourceNode extends ITaskBase {
    op: GraphTaskOp.WriteSourceNode;
}
export interface IDeleteSourceNode extends ITaskBase {
    op: GraphTaskOp.DeleteSourceNode;
}
export interface IMoveSourceNode extends ITaskBase {
    op: GraphTaskOp.MoveSourceNode;
    newPath?: string;
    newParentId?: string | null;
}
export interface ISerializeSourceNode extends ITaskBase {
    op: GraphTaskOp.SerializeSourceNode;
}
export interface IDeserializeSourceNode extends ITaskBase {
    op: GraphTaskOp.DeserializeSourceNode;
    recomputeOnly?: boolean;
}
export interface ITransformedParsedData extends ITaskBase {
    op: GraphTaskOp.TransformParsed;
    oldValue?: any;
}
export interface IComputeSourceMap extends ITaskBase {
    op: GraphTaskOp.ComputeSourceMap;
    patch?: JsonPatch;
}
export interface IResolveSourceNode extends ITaskBase {
    op: GraphTaskOp.ResolveSourceNode;
    tabu?: string[];
}
export interface IDiagnoseSourceNode extends ITaskBase {
    op: GraphTaskOp.ValidateSourceNode;
}