Sanity Library Reference Docs
    Preparing search index...

    Classes

    ActionDisabledError
    ActionParamsInvalidError
    CascadeLimitError
    ConcurrentCascadeError
    ConcurrentCommitEffectOpsError
    ConcurrentCompleteEffectError
    ConcurrentEditFieldError
    ConcurrentFireActionError
    ContractViolationError
    DefinitionInUseError
    DefinitionNotFoundError
    EditFieldDeniedError
    EffectCommitQueueOverflowError
    EffectNotFoundError
    EffectOpsInvalidError
    EffectOutputsInvalidError
    FieldValueShapeError
    InitialFieldsInvalidError
    InstanceNotFoundError
    MissingHandlerError
    ModelVersionAheadError
    MutationGuardDeniedError
    PartialGuardDeployError
    PersistedDocShapeError
    ReaderModelAcknowledgementError
    RefResourceUndeclaredError
    RequiredFieldNotProvidedError
    SpawnContractsInvalidError
    StaleEffectClaimError
    StartNotAllowedError
    StartNotPrimedError
    StartNotSettledError
    WorkflowError
    WorkflowStateDivergedError

    Interfaces

    AbortInstanceArgs
    Action
    ActionEvaluation
    ActionParam
    Activity
    ActivityDescription
    ActivityEntry
    ActivityEvaluation
    Actor
    ApplicabilitySource
    AssignmentIdentity
    AssignmentStateCounts
    AtomInsight
    AuthoringActivity
    AuthoringFieldRef
    AuthoringGuard
    AuthoringStage
    AuthoringWorkflow
    AutonomyAnswer
    AvailableAction
    AvailableActionsResult
    CandidateDocument
    ChildrenArgs
    ChoiceOption
    ChoiceOptions
    ClassifiedPrincipal
    ClientProjectUser
    CommitEffectOpsArgs
    CommitOpsRequest
    CompiledQuery
    CompileGuardsArgs
    CompleteEffectArgs
    ConditionAnalysis
    ConditionAtom
    ConditionDescription
    ConditionInsight
    ConditionRead
    ConditionVar
    CreateEngineArgs
    DataModelChange
    DedupableOperationArgs
    DefinitionConditionSite
    DefinitionGroupSite
    DefinitionGuardsQueryArgs
    DefinitionsForDocumentArgs
    DeleteDefinitionArgs
    DeleteDefinitionResult
    DeniedGuardRef
    DeployDefinitionResult
    DeployDefinitionsArgs
    DeployDefinitionsResult
    DeployTarget
    DeriveAutonomyOptions
    DescribeContext
    DiagnoseInput
    DiagnoseResult
    DiffEntry
    DisplayMetadata
    DocumentActionDenialsArgs
    DrainEffectsResult
    EditableFieldEvaluation
    EditFieldArgs
    EditFieldTarget
    Effect
    EffectHistoryEntry
    EffectOrigin
    EffectSettledInfo
    Engine
    EngineEffectsArgs
    EngineLogger
    EngineScopeArgs
    EvaluateArgs
    EvaluateFromSnapshotArgs
    EvaluateStartArgs
    ExecutionContext
    ExplainConditionArgs
    FieldDescription
    FieldEntry
    FieldInsight
    FieldProposal
    FieldShape
    FieldValueMap
    FindPendingEffectsArgs
    FireActionArgs
    FiringConsequence
    GlobalDocumentReference
    Grant
    Guard
    GuardsForDefinitionArgs
    HydratedSnapshot
    InsightPhrase
    InstanceGuardsQueryArgs
    InstanceRefArgs
    InstanceSession
    InstancesForDocumentArgs
    InstancesQueryFilter
    LoadedDoc
    LogicalRef
    MissingHandlerDeployInfo
    MissingHandlerDrainInfo
    MutationContext
    MutationGuardBody
    MutationGuardDoc
    MutationGuardMatch
    NoteItem
    OpAppliedSummary
    OperationArgs
    OperationResult
    ParsedGdr
    PendingEffect
    PendingEffectClaim
    ProcessedRequest
    ProjectUserDirectory
    QueryArgs
    QueryInScopeArgs
    ReleaseRef
    RequirementDescriptor
    ResetActivityArgs
    ResolveAccessArgs
    ResolveClientActorArgs
    ResolvedEngineEffects
    ResourceRefArgs
    ResourceSurface
    ScalarValidation
    ScopeAssignment
    ScopedInitialFieldDeclarations
    SessionArgs
    SetStageArgs
    SiteConsequence
    Stage
    StageAutonomy
    StageEntry
    StageEvaluation
    StageGuardArgs
    StartEvaluation
    StartInstanceArgs
    StartRequirementEvaluation
    StartScope
    StartSliceRow
    StoredFieldRef
    SubjectPermissionDenial
    SubjectResourceAccess
    SubscriptionDocument
    SubworkflowEntry
    Subworkflows
    SuggestedRemediation
    SweepStaleClaimsResult
    TelemetryIntake
    TelemetryIntakeClient
    TodoListItem
    TransitionEvaluation
    ValidationIssue
    VerifyDeployedDefinitionsResult
    WatchSet
    WhatIfOutcome
    WorkflowAccess
    WorkflowActionFiredData
    WorkflowAdminOverrideData
    WorkflowAutonomy
    WorkflowClient
    WorkflowClientConfig
    WorkflowCommitOptions
    WorkflowConfig
    WorkflowDefinition
    WorkflowDefinitionDeletedData
    WorkflowDefinitionDeployedData
    WorkflowEffectCompletedData
    WorkflowEffectsDrainedData
    WorkflowEffectStateReportedData
    WorkflowEvaluation
    WorkflowFetchOptions
    WorkflowFieldEditedData
    WorkflowInstance
    WorkflowInstancePreview
    WorkflowInstancePreviewEffect
    WorkflowInstanceStartedData
    WorkflowInstanceTickedData
    WorkflowMutationOptions
    WorkflowPatch
    WorkflowStageTransitionedData
    WorkflowTelemetryEvent
    WorkflowTelemetryLogger
    WorkflowTransaction

    Type Aliases

    AcknowledgedWorkflowDeployment
    ActionDisabledReason
    ActionName
    ActionSemantic
    ActivityKind
    ActivityName
    ActivityStatus
    ActorKind
    ActorResolution
    Assignee
    AssignmentMatch
    AssignmentState
    AtomRequirement
    AuthoringAction
    AuthoringEditable
    AuthoringFieldEntry
    AuthoringManualTarget
    AuthoringOp
    AuthoringStartBlock
    AuthoringTransition
    AutonomyVerdict
    AutonomyWait
    ChoiceValue
    ClientForGdr
    Clock
    Clocked
    ComparisonOp
    Condition
    ConditionClause
    ConditionOutcome
    ConditionVarBinding
    ContextEntry
    CustomSemantic
    DataModelDocumentType
    DecisionSemantic
    DeclaredExecutionContext
    DefinitionInUseBlocker
    DefinitionSiteAddress
    DeployedDefinition
    Describable
    Described
    DescribedClause
    DescribedDefinitionSite
    DiagnosedTransition
    Diagnosis
    DisabledReason
    DocumentValuePermission
    DrainEffectsArgs
    DriverKind
    Editable
    EditDisabledReason
    EditFieldDeniedReason
    EditMode
    EffectCompletionStatus
    EffectHandler
    EffectHandlerContext
    EffectName
    EffectOriginKind
    EffectRunStatus
    ExecutorClassification
    FieldKind
    FieldMutationOp
    FieldOp
    FieldScope
    FieldSource
    GdrScheme
    GdrUri
    GroqRequirement
    Group
    GroupKind
    GroupMember
    GroupMembership
    GuardAction
    GuardDereference
    GuardMatch
    GuardRead
    HistoryEntry
    InitialFieldIssue
    InitialFieldValue
    InsightSite
    LakeMutationGuardAction
    LoggerFactory
    ManualTarget
    MissingHandlerInfo
    MissingHandlerPolicy
    MutationGuardAction
    MutationGuardDenial
    Op
    PersonActor
    PrincipalNamespace
    ProgressTarget
    ProjectUserLookup
    RemediationVerb
    ResetActivityResult
    ResetActivityTarget
    ResolvedFieldEntry
    ResourceAliases
    ResourceClientResolver
    RoleAliases
    Semantic
    SignalSemantic
    SingleSubjectRequirement
    SpawnContractIssue
    StageName
    StaleClaimReason
    StartBlock
    StartContext
    StartKind
    StartRequirement
    StuckCause
    Telemetered
    TelemetryConsentStatus
    TerminalActivityStatus
    TerminalState
    Transition
    UserAttributes
    ValueExpr
    WorkflowConfigInput
    WorkflowDefinitionInput
    WorkflowDeployment
    WorkflowDeploymentInput
    WorkflowErrorKind
    WorkflowLifecycle
    WorkflowPerspective
    WorkflowResource
    WorkflowVisibility

    Variables

    ACTION_SEMANTICS
    ACTIVITY_KIND_DISPLAY
    ACTIVITY_KINDS
    ACTOR_KINDS
    ANONYMOUS_IDENTITY
    AUTHORING_DISPLAY
    checklistLines
    CONDITION_VARS
    CONTEXT_ENTRY_DISPLAY
    DATA_MODEL_CHANGES
    DATA_MODEL_MAX_READER
    DATA_MODEL_MIN_READER
    DATA_MODEL_VERSION
    DECISION_SEMANTICS
    DEFAULT_CONTENT_PERSPECTIVE
    DEFAULT_EFFECT_LEASE_MS
    DEFAULT_IDEMPOTENCY_TTL_MS
    DEFAULT_TRANSITION_WHEN
    defaultLoggerFactory
    DISPLAY
    DOCUMENT_VALUE_PERMISSIONS
    DRIVER_KIND_DISPLAY
    DRIVER_KINDS
    EFFECT_COMMIT_DISPATCH_CAP
    EFFECT_COMMIT_QUEUE_DEPTH
    ENGINE_API_VERSION
    EXECUTION_KINDS
    EXECUTOR_CLASSIFICATION_DISPLAY
    EXECUTOR_CLASSIFICATIONS
    FIELD_KIND_DISPLAY
    FILTER_SCOPE_VARS
    GROUP_KIND_DISPLAY
    GROUP_KINDS
    GUARD_DOC_TYPE
    GUARD_OWNER
    GUARD_PREDICATE_VARS
    HISTORY_DISPLAY
    MAX_COUNTERFACTUAL_INDEX
    MutationGuardDocSchema
    NEUTRAL_MARK
    noopTelemetry
    OP_DISPLAY
    OUTCOME_MARKS
    READER_MODEL_ROLLOUT_URL
    RESERVED_CONDITION_VARS
    SIGNAL_SEMANTICS
    silentLogger
    START_FILTER_VARS
    START_REQUIREMENT_VARS
    SYSTEM_IDENTITY
    wallClock
    workflow
    WORKFLOW_DEFINITION_TYPE
    WORKFLOW_INSTANCE_TYPE
    WorkflowActionFired
    WorkflowActivityReset
    WorkflowDefinitionDeleted
    WorkflowDefinitionDeployed
    WorkflowEffectCompleted
    WorkflowEffectsDrained
    WorkflowEffectStateReported
    WorkflowFieldEdited
    WorkflowInstanceAborted
    WorkflowInstancePreviewSchema
    WorkflowInstanceSchema
    WorkflowInstanceStarted
    WorkflowInstanceTicked
    WorkflowStageSet
    WorkflowStageTransitioned

    Functions

    abortReason
    acceptsDocumentType
    aclPathForResource
    actionDisabledDetail
    actionRendering
    actionVerdict
    activeAssignmentMembers
    activityAutonomyOf
    actorFulfillsRole
    actorMatchesAssignment
    analyzeCondition
    applicableDefinitions
    assertReadableModel
    assertReaderModelAcknowledgement
    assignmentMatch
    assignmentMembers
    assignmentPrefilter
    assignmentState
    assignmentStateCounts
    atomReadsDataset
    autonomySummary
    availableActions
    buildInitialFields
    buildSnapshot
    classifyPrincipalId
    clientConfigFromResource
    clientGuardDereference
    clientProjectUserDirectory
    compileGuards
    computeDiffEntries
    conditionFieldReadNames
    conditionSitesOf
    contentDocQuery
    contentDraftFallback
    contentReleaseName
    contextMap
    createEngine
    createTelemetryIntake
    datasetResourceParts
    definitionDeployedData
    definitionLookupGroq
    definitionRoleNames
    definitionsListGroq
    definitionTagsGroq
    deniedGuardLabels
    deniedGuardRefs
    denyingGuards
    deployedTagsGroq
    deployStageGuards
    deriveActivityKind
    deriveExecutorClassification
    deriveWorkflowAutonomy
    describeAtom
    describeAutonomyWait
    describeCondition
    describeDefinition
    describeFieldInsight
    describeNode
    describeSite
    describeSiteHeading
    diagnoseInputFromEvaluation
    diagnoseInstance
    diffEntry
    displayDescription
    displayTitle
    documentActionDenials
    documentPrefilter
    documentStuckCause
    driverKind
    effectOutputsMap
    entryDocRefs
    errorMessage
    evaluateFromSnapshot
    evaluateMutationGuard
    evaluateStartFilter
    expandResourceAliases
    explainCondition
    explainStartRequirement
    extractDocumentId
    fieldTreeShape
    findActivityNode
    findCurrentActivityEntry
    findOpenStageEntry
    findStageNode
    formatRead
    gdrFromResource
    gdrRef
    gdrUri
    groupMembershipNames
    groupSitesOf
    guardMatches
    guardsForDefinition
    guardsForInstance
    guardsForResource
    guillemets
    hashDefinitionContent
    hasSingleSubjectRequirement
    humanize
    identityMatchesAssignment
    inFlightFilter
    initialFieldIssues
    instanceAssignmentStateCounts
    instanceChangesQuery
    instanceDocId
    instanceGuardQuery
    instancePreviewsQuery
    instancesGuardQuery
    instancesQuery
    instanceWatchesDocument
    isCascadeFired
    isClaimExpired
    isClientProjectUser
    isComparisonOp
    isDefinitionApplicable
    isFilterScopedOut
    isGdr
    isInputSourced
    isNotesEntry
    isProjectUserNotFoundError
    isRevisionConflict
    isSingleDocRefEntry
    isSingleDocRefKind
    isStartableDefinition
    isSubjectEntry
    isTelemetryEnvDenied
    isTerminalActivityStatus
    isTerminalStage
    isTodoListEntry
    isTodoListItem
    isUnprimed
    lakeGuardId
    lakePrincipalId
    latestDefinitionsGroq
    latestDeployedDefinitions
    lintEffectOutputs
    minReaderModelOf
    missingRequiredInputs
    modelVersionOf
    narrateAutonomyWaits
    openActivityAssignments
    parentRef
    parseDefinitionInput
    parseDefinitionSnapshot
    parseDefinitionSnapshotValue
    parseGdr
    parseGuardDocument
    parseInstanceDocument
    parseInstancePreviewDocument
    parseResourceGdr
    processShellUserProperties
    projectStartSliceRow
    projectToWatchRef
    quoted
    readInstanceDoc
    readInstancePreviewDoc
    readsRaw
    readsRootDocument
    refCanvas
    refDashboard
    refDataset
    refKindAcceptsTypes
    refMediaLibrary
    refsOf
    rejectedRefTypes
    releaseDocId
    releaseRef
    remediationsFor
    requiredDefinitionReaderModel
    requiredModelFeatures
    requiredReaderModel
    resolveAccess
    resolveActor
    resolveClientActor
    resolveFieldEntry
    resolveUserAttributes
    resourceAliasesToMap
    resourceFromParsed
    resourceGdr
    retractStageGuards
    sameResource
    scalarValidationIssues
    schemaTreeShape
    sentenceCase
    singleSubjectRequirementRefused
    snapshotGuardDereference
    stageAutonomyOf
    startFieldsParam
    startKindOf
    startRefusal
    stripSystemFields
    subjectDenialLabels
    subscriptionDocument
    subscriptionDocumentsForInstance
    sweepStaleClaims
    tagScopeFilter
    terminalState
    toBareId
    tryParseGdr
    unboundRequirementReads
    unsatisfiedTransitionSummaries
    userLoginProvider
    validateDefinition
    validateTag
    verdictGuardsForInstance
    whatIfCondition
    withAssignment