Sanity Library Reference Docs
    Preparing search index...

    The OperationArgs of the verbs that own a discrete commit — fireAction, editField, completeEffect, commitEffectOps, setStage, abortInstance. tick deliberately takes the plain base: it owns no commit of its own and re-derives everything, so retrying it blind is already safe.

    interface SetStageArgs {
        grantsFromPath?: string;
        idempotencyKey?: string;
        initialFields?: InitialFieldValue[];
        instanceId: string;
        reason?: string;
        targetStage: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    grantsFromPath?: string

    URL path for grant resolution — see StartInstanceArgs.grantsFromPath.

    idempotencyKey?: string

    Caller-supplied key that makes this call safe to retry blind (a network failure ate the response; a queue redelivered the message). The first commit records the key on the instance's processedRequests[] ledger — in the same CAS write as the operation itself — and a retry carrying the same key replays instead of double-applying (or, for a completed effect, throwing EffectNotFoundError): the operation is NOT re-applied, but the cascade runs to convergence (the original may have died before its own cascade), so changed is false unless that cascade repaired something. Keys live for the engine's idempotencyTtlMs (default 24h); reusing a live key on a different verb throws. The caller owns key uniqueness per logical request.

    Only a commit records the key: a keyed call that no-ops (a setStage already at its target, an abort of a terminal instance) leaves no ledger row, so retrying it later re-evaluates fresh rather than replaying.

    initialFields?: InitialFieldValue[]

    Initial values for field entries on the target stage, in the same shape as startInstance.initialFields; reserved for the stage-field work.

    instanceId: string
    reason?: string

    Free-text reason — surfaces on history entries for audit.

    targetStage: string

    Stage id to force the instance into.