Sanity Library Reference Docs
    Preparing search index...

    Engine-call wrappers that inject the bench-owned client + tag + identity.

    type EngineWrappers = {
        abortInstance: (
            args: BenchAbortInstanceArgs,
        ) => Promise<OperationResult>;
        completeEffect: (args: BenchCompleteEffectArgs) => Promise<OperationResult>;
        deleteDefinition: (
            args: BenchDeleteDefinitionArgs,
        ) => Promise<DeleteDefinitionResult>;
        deployDefinitions: <T extends WorkflowDefinitionInput<T>>(
            args: DeployDefinitionsArgs<T>,
        ) => Promise<DeployDefinitionsResult>;
        editField: (args: BenchEditFieldArgs) => Promise<OperationResult>;
        evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
        fireAction: (args: BenchFireActionArgs) => Promise<OperationResult>;
        guardsForDefinition: (definition: string) => Promise<MutationGuardDoc[]>;
        guardsForInstance: (instanceId: string) => Promise<MutationGuardDoc[]>;
        resetActivity: (args: BenchResetActivityArgs) => Promise<OperationResult>;
        setStage: (args: BenchSetStageArgs) => Promise<OperationResult>;
        startInstance: (args: BenchStartInstanceArgs) => Promise<OperationResult>;
        tick: (args: BenchTickArgs) => Promise<OperationResult>;
    }
    Index

    Properties

    abortInstance: (args: BenchAbortInstanceArgs) => Promise<OperationResult>

    Admin override — hard-stop an in-flight instance where it stands.

    completeEffect: (args: BenchCompleteEffectArgs) => Promise<OperationResult>
    deleteDefinition: (
        args: BenchDeleteDefinitionArgs,
    ) => Promise<DeleteDefinitionResult>
    deployDefinitions: <T extends WorkflowDefinitionInput<T>>(
        args: DeployDefinitionsArgs<T>,
    ) => Promise<DeployDefinitionsResult>
    editField: (args: BenchEditFieldArgs) => Promise<OperationResult>
    evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>
    fireAction: (args: BenchFireActionArgs) => Promise<OperationResult>
    guardsForDefinition: (definition: string) => Promise<MutationGuardDoc[]>
    guardsForInstance: (instanceId: string) => Promise<MutationGuardDoc[]>
    resetActivity: (args: BenchResetActivityArgs) => Promise<OperationResult>

    Admin override — reset a failed/terminal activity in the current stage.

    setStage: (args: BenchSetStageArgs) => Promise<OperationResult>

    Admin override — bypass filters/transitions and force the stage.

    startInstance: (args: BenchStartInstanceArgs) => Promise<OperationResult>
    tick: (args: BenchTickArgs) => Promise<OperationResult>