Classes
Interfaces
- CapturedRemoteSchema
- CapturedVirtualTable
- Connections
- SourceChanges
- Sources
- ActionSources
- SyncedTableSource
- RetainedResultReader
- ResultPlan
- ResultExplanation
- ResultTransportUsage
- ResultUsage
- ResultCollection
- ResultColumn
- KeptResult
- KeptResultReader
- SealedResults
- VirtualDataset
References
ReportQualificationInspection
Re-exports ReportQualificationInspectionReportQualificationUpdate
Re-exports ReportQualificationUpdateSourceCapacity
Re-exports SourceCapacitySourceControlAction
Re-exports SourceControlActionSourceControlOutcome
Re-exports SourceControlOutcomeSourceControlReceipt
Re-exports SourceControlReceiptSourceControlRequest
Re-exports SourceControlRequestSourceInspection
Re-exports SourceInspectionSourceRefreshRequest
Re-exports SourceRefreshRequestSourceRequestPhase
Re-exports SourceRequestPhaseSourceRequestStatus
Re-exports SourceRequestStatusType Aliases
IntegrationAddress
Ƭ IntegrationAddress:Object
Type declaration
DeclaredBody
Ƭ DeclaredBody<B>: B extends { kind: "grpc" ; _message?: infer T } ? GrpcReply<T> : B extends { kind: "text" } ? string : B extends { kind: "json" | "json_schema" | "document" | "positional" ; validator: infer V } ? V extends Validator<infer T, any, any> ? T : never : B extends { kind: "json_fields" ; fields: readonly infer F[] } ? Record<F, unknown> & B extends { optional_fields: readonly infer O[] } ? Partial<Record<O, unknown>> : {} : B extends { kind: "json_batch" ; selection: { fields: readonly infer F[] } } ? Record<F, unknown>[] : null
Not exported: an exported type refers to it.
Type parameters
HttpResponseBody
Ƭ HttpResponseBody<C>: C extends { response: { statuses: infer S } } ? { [K in keyof S]: DeclaredBody<S[K]> }[keyof S] : never
Not exported: an exported type refers to it.
Type parameters
HttpOutcome
Ƭ HttpOutcome<C>: Object
What one ctx.request produced.
The ordinary outcome carries what the destination answered. The unresolved
outcome carries the opposite fact: the host has no interpretable observation
of this request and evidence is what says so — a retained detail that
failed its own contract, or, for a contract whose file body streams, the
attempt whose body never completed before the ceiling or the connection did.
It is returned rather than thrown, so the rest of a fanout is unaffected, and
the status is the one the destination really answered; nothing here invents
one. headers is empty because a transfer that left no retained response
left no admitted headers to cite either.
The only thing an integration may do with it is record the key unresolved
against this exact evidence. Publication verifies the host’s own basis for
that citation, classifies it — transient or settled — and decides whether
the key keeps its retry responsibility; guest code chooses none of that, and
is deliberately not told which classification the host reached.
The host admits the outcome for exactly two contract shapes: a singleton
detail read, and one declaring a streamed file body. unresolved is not
narrowed to those here because making the shape depend on the contract makes
IntegrationContext invariant in its contract map, which stops a connector
from sharing one reader across its declared handlers.
Type parameters
Type declaration
SyncEvery
Ƭ SyncEvery: {seconds: number } | { minutes: number } | { hours: number }
CommandGoverningResult
Ƭ CommandGoverningResult: [Exclude<GoverningResult, null> & { recheckAt?: never } | null | { recheckAt: number ; validUntil?: never }]
A command rule decides one command and returns a one-element list: the
shared permitting results plus command-only advisory deferral. A bare
value, an empty or longer list, and a rule that falls off its end refuse.
recheckAt denies now and requests a future evaluation; it is never permission.
Its timestamp has the same finite safe-integer epoch-millisecond, strictly
future, at-most-366-day bounds as validUntil. Review, acceptance and send
require a permitting result whose validity extends past the actual commit.
The native decoder rejects unknown fields and mixed permit/defer objects.
A rule that never defers declares returns: readAccessResults.
CommandDeliveryContract
Ƭ CommandDeliveryContract<D>: D extends { kind: string } ? Omit<D, "review"> : never
Not exported: an exported type refers to it.
Type parameters
CommandGoverningInput
Ƭ CommandGoverningInput:Object
Type declaration
RelationalExecutor
Ƭ RelationalExecutor<Engine>: Omit<SourceHandle, "withScope" | "resourceValidator" | "row"> & { kind: "relational" ; engine?: Engine ; execution: () => { kind: "source" ; binding: SourceBinding } }
Declare retained HTTP callbacks and their source collections.
Type parameters
RetainedAccessBinding
Ƭ RetainedAccessBinding<T>: T extends AccessTableBinding<infer R, infer B> ? AccessTableBinding<R, B> : T extends PrincipalSourceTable<infer Field> ? PrincipalSourceTable<Field> : unknown
Not exported: an exported type refers to it.
Type parameters
AccessWriteProgram
Ƭ AccessWriteProgram:Object
Not exported: an exported type refers to it.
Type declaration
HttpProvider
Ƭ HttpProvider:Readonly<{ name: string ; authentication: { kind: "none" } | { kind: "header" ; name: string ; prefix?: string } }>
Provider protocol, independent of the deployed account and credential.
ConnectionRequest
Ƭ ConnectionRequest:Object
Current policy sees the actual invocation’s caller and concrete request.
Source disclosure is checked independently by the native owner.
Type declaration
HttpEffect
Ƭ HttpEffect:Readonly<{ kind: "http" ; connection: DeploymentValue ; provider: HttpProvider ; policy: { name: string } ; method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" ; path: string ; timeoutMs: number ; maxRequestBytes: number ; maxResponseBytes: number }>
HttpConnectionRef
Ƭ HttpConnectionRef:Readonly<{ http: (options: { method: HttpEffect["method"] ; path: string ; timeoutMs?: number ; maxRequestBytes?: number ; maxResponseBytes?: number }) => HttpEffect }>
ActionEffects
Ƭ ActionEffects:Readonly<Record<string, HttpEffect>>
HttpEffectRequest
Ƭ HttpEffectRequest:Readonly<{ query?: Readonly<Record<string, string>> ; json?: unknown }>
HttpEffectResponse
Ƭ HttpEffectResponse:Readonly<{ status: number ; ok: boolean ; headers: Readonly<Record<string, string>> ; text: () => Promise<string> ; json: () => Promise<unknown> }>
EffectContext
Ƭ EffectContext<Effects>: Object
Type parameters
Type declaration
ConnectionCheckSource
Ƭ ConnectionCheckSource:Object
Type declaration
NativeCheckControls
Ƭ NativeCheckControls:Object
Type declaration
ConnectionCheckHistoryEntry
Ƭ ConnectionCheckHistoryEntry:Object
Type declaration
ApplicationConnectionChecks
Ƭ ApplicationConnectionChecks:Object
Type declaration
Context
Ƭ Context:BijectionQueryCtx<any, any>
Not exported: an exported type refers to it.
ApplicationExternalResources
Ƭ ApplicationExternalResources:Object
Installed evidence owner. Callbacks retain the caller and current policy.
Type declaration
BrowserAddress
Ƭ BrowserAddress:Object
Type declaration
BrowserContract
Ƭ BrowserContract<R>: Object
Type parameters
Type declaration
BrowserElement
Ƭ BrowserElement:Object
Type declaration
BrowserPage
Ƭ BrowserPage<R>: Object
Type parameters
Type declaration
BrowserImplementation
Ƭ BrowserImplementation<I, R>: BrowserContract<R> & { run: (page: BrowserPage<keyof R & string>, input: I) => Promise<void> }
Type parameters
BrowserProtocol
Ƭ BrowserProtocol: typeofbrowserProtocols[BrowserConfinement]
BrowserResourceReference
Ƭ BrowserResourceReference<Setup, Confinement>: ResourceReference<Setup, "browser", keyof Setup & string, "http"> & { _browser: Confinement }
Type parameters
BrowserSessionRequest
Ƭ BrowserSessionRequest:Object
Type declaration
BrowserSession
Ƭ BrowserSession:Object
A handoff contains custody identities only. Neither a CDP URL nor a bearer crosses a component API.
Type declaration
BrowserSessionStatus
Ƭ BrowserSessionStatus:Object
Type declaration
Reference
Ƭ Reference<Kind, Args, Result>: FunctionReference<Kind, "public" | "internal", Args, Result>
Not exported: an exported type refers to it.
Type parameters
BrowserProviderApi
Ƭ BrowserProviderApi:Object
Type declaration
VirtualTableEngine
Ƭ VirtualTableEngine:"trino" | "presto" | "bigquery" | "clickhouse" | "snowflake" | "databricks"
ConnectionIntegration
Ƭ ConnectionIntegration: {module: string ; export: string ; label?: string } | IntegrationReference<any> | { isIntegration: true ; exportIntegration: () => string }
ConnectedMcpRequest
Ƭ ConnectedMcpRequest:Readonly<{ method: "POST" | "DELETE" ; headers: Readonly<Record<string, string>> ; body: string | null }>
One Streamable HTTP exchange with an MCP server: the request an MCP
client sends, without its address or credential.
ConnectedMcpResponse
Ƭ ConnectedMcpResponse:Readonly<{ status: number ; headers: Readonly<Record<string, string>> ; body: string }>
The server’s result: its status, its content-type and mcp-session-id
headers and its body.
IntegrationReference
Ƭ IntegrationReference<Setup>: Object
A generated reference to an integration and its connection input.
Type parameters
Type declaration
SetupSupplier
Ƭ SetupSupplier:"administrator" | "account"
Who is holding the answer.
administrator is deployment configuration: the person who deployed this
definition knows it, it is the same for every connection they make, and it
may be recorded. account is the connecting customer’s own: their instance,
their region, their workspace. The distinction is not cosmetic — it decides
who is asked, what may be retained and, for a value that reaches a URL, how
far it is allowed to move.
SetupSlot
Ƭ SetupSlot:"base_url"
The one slot a setup value may fill beyond being recorded.
A value that fills base_url is rendered as prefix + value + suffix and
becomes the connection’s base URL. That is the ONLY way a supplied value
reaches an address, and it is why the rendering is a template the definition
wrote rather than a string the supplier wrote: the supplier contributes one
host label inside an address they did not choose, and the result still has
to pass the deployment’s ordinary base-URL confinement before any request is
built from it.
SetupValidation
Ƭ SetupValidation:Object
What an admitted value has to look like.
pattern is matched against the WHOLE value; there is no need to anchor it
and no way to leave it unanchored. It is restricted to the constructs Rust’s
regular expressions and JavaScript’s agree on, because the same pattern is
compiled on both sides and a pattern that means two things is worse than no
pattern at all: lookaround and backreferences are refused at definition time.
Type declaration
SetupField
Ƭ SetupField:SetupValidation & { key: string ; supplier: SetupSupplier ; label: string ; help?: string ; docUrl?: string ; example?: string ; prefix?: string ; suffix?: string ; secret?: boolean ; optional?: boolean ; derivable?: boolean ; fills?: SetupSlot }
One thing a connection has to be told.
SetupDeclaration
Ƭ SetupDeclaration: readonlySetupField[]
The declaration as it is written on an integration definition.
SetupRefusal
Ƭ SetupRefusal: {kind: "unknown_field" ; key: string } | { kind: "missing_required" ; key: string } | { kind: "pattern_mismatch" ; key: string } | { kind: "not_allowed" ; key: string } | { kind: "too_short" ; key: string ; minLength: number } | { kind: "too_long" ; key: string ; maxLength: number } | { kind: "secret_not_accepted" ; key: string } | { kind: "slot_not_one_label" ; key: string } | { kind: "not_account_supplied" ; key: string }
Why one supplied value was refused.
Exhaustive and typed on both sides of the boundary: the same variants are a
Rust enum the backend matches on, so a new kind of refusal is a compile
error rather than a new string nobody renders.
SetupRequirement
Ƭ SetupRequirement:SetupField & { configured: boolean }
What the deployment says about one declared field when asked what a
connection still needs.
It carries the declaration and ONE fact about the deployment: whether the
value is already held. It never carries a value — not a secret, and not a
recorded administrator value either, because a reader that does not need it
to fill a form does not need it at all.
EwsMailbox
Ƭ EwsMailbox:Object
Not exported: an exported type refers to it.
Type declaration
NativeSetupFor
Ƭ NativeSetupFor<T>: T extends EwsMailbox ? typeof ewsConnectionSetup : T extends { kind: infer K } ? typeof nativeConnectionSchemas[K] : T extends { transport: infer K } ? typeof nativeConnectionSchemas[K] : {} & T extends { kind: "kafka" | "mqtt" | "pubsub" ; correlation: string } ? { commandTopic: ReturnType<typeof string> } : {}
Not exported: an exported type refers to it.
Type parameters
ResourceTable
Ƭ ResourceTable<S, Scope, Contract>: Object
An explicit resource output. Source handles stay inside compiler lowering.
Type parameters
Type declaration
CallPublication
Ƭ CallPublication:"unavailable" | "pending" | "blocked" | "published" | "cancelled"
Remaining local admission of a retained response, independent of delivery.
BrowserLocator
Ƭ BrowserLocator: {kind: "role" ; role: string ; name: string } | { kind: "label" ; text: string } | { kind: "test_id" ; id: string } | { kind: "css" ; selector: string }
BrowserResources
Ƭ BrowserResources:Object
Not exported: an exported type refers to it.
Type declaration
BrowserToken
Ƭ BrowserToken:Object
Not exported: an exported type refers to it.
Type declaration
BrowserCapture
Ƭ BrowserCapture: {kind: "response" } | { kind: "page" ; fields: Record<string, BrowserLocator> ; rows?: BrowserLocator ; empty?: BrowserLocator }
BrowserDiagnostics
Ƭ BrowserDiagnostics:Object
Type declaration
BrowserSessionReference
Ƭ BrowserSessionReference:Object
Opaque links into existing component and native call custody. No provider
URL.
Type declaration
BrowserConfinement
Ƭ BrowserConfinement:"enforced" | "unenforced"
Whether physical isolation enforces that every page request crosses the
native broker. An Unenforced provider still routes page requests through
the broker, but nothing beneath the browser prevents traffic that bypasses
it, so the absence of a brokered request no longer proves nothing was sent.
BrowserScopeFailure
Ƭ BrowserScopeFailure:Object
Type declaration
BrowserPhase
Ƭ BrowserPhase:"starting" | "running" | "complete" | "failed"
Not exported: an exported type refers to it.
BrowserFailure
Ƭ BrowserFailure:"selector" | "scope" | "capture" | "response" | "execution" | "callback" | "deadline" | "unavailable"
Not exported: an exported type refers to it.
BrowserCommandObservation
Ƭ BrowserCommandObservation:Object
Not exported: an exported type refers to it.
Type declaration
BrowserCommandName
Ƭ BrowserCommandName:"goto" | "fill" | "click" | "select_option" | "check" | "wait_for" | "text" | "visible"
Not exported: an exported type refers to it.
BrowserLocation
Ƭ BrowserLocation:Object
Not exported: an exported type refers to it.
Type declaration
ComputeJobReference
Ƭ ComputeJobReference:Object
A job-only function’s reference says how it runs. No value holds this
property; it keeps the execution contract in the type, so hovering a generated
reference shows it and direct calls refuse it during development.
Type declaration
RetainedInterfaceMembership
Ƭ RetainedInterfaceMembership<T>: T extends { [interfaceMembership]: infer M } ? { [interfaceMembership]: M } : unknown & T extends { [interfaceNavigationMappings]: infer M } ? InterfaceNavigationIdentity<M> : unknown & T extends { [interfaceWritableMappings]: infer M } ? { [interfaceWritableMappings]: M } : unknown
Not exported: an exported type refers to it.
Type parameters
ProviderInputRef
Ƭ ProviderInputRef:Readonly<{ source: string ; occurrence: string ; digest: string }>
Original native byte identity. Possession grants no access.
ProviderInputInspection
Ƭ ProviderInputInspection:Readonly<{ input: ProviderInputRef ; owner: { installation: string ; record: string } | null ; acceptedAt: number ; eventType: string | null ; expiresAt: number ; ready: boolean ; files: readonly { part: string ; file: FileRef ; sha256: string ; size: number ; contentType: string }[] }>
ProviderInputFileGrant
Ƭ ProviderInputFileGrant:Readonly<{ input: ProviderInputRef ; part: string ; key: string ; file: FileRef ; sha256: string ; size_bytes: number ; content_type: string ; grant: string ; expires_at: number }>
Exact native content admitted to a child workload. This receipt contains
no delivery credential and does not extend the original input’s lifetime.
ProviderInputFile
Ƭ ProviderInputFile:Readonly<{ input: ProviderInputRef ; owner: { installation: string ; record: string } ; source_expires_at: number ; part: string ; file: FileRef ; sha256: string ; size_bytes: number ; content_type: string }>
Exact inspected input part. File identifiers and owner coordinates carry
identity only; native grants remain the authority to release bytes.
CaseName
Ƭ CaseName: typeofproviderJourneyCases[number]
Not exported: an exported type refers to it.
CaseReference
Ƭ CaseReference:FunctionReference<"action", "internal", { fixture: string ; runId: string }, typeof type>
Not exported: an exported type refers to it.
ProviderCustodyErrorData
Ƭ ProviderCustodyErrorData:Object
A local custody fence. It never proves an earlier remote outcome.
Type declaration
ProviderDeliveryPolicy
Ƭ ProviderDeliveryPolicy:Readonly<{ reconcilable: boolean ; sendUntil: number ; inspectUntil: number ; maxAttempts: number ; attemptMs: number }>
Native physical bounds of one captured command. They fence every
attempt; the delivery component’s protocol chooses how to spend them.
ProviderCommandOrdering
Ƭ ProviderCommandOrdering:Readonly<{ domain: string ; mode: "exclusive" | "shared" | "latest" }>
Facts the delivery component orders a live command by: the native
verified target key and the connector’s declared ordering mode. Native
custody does not order provider commands.
ProviderExchangeSettlement
Ƭ ProviderExchangeSettlement:"settled" | "unsettled" | "unbounded"
ProviderRefusal
Ƭ ProviderRefusal:Readonly<{ kind: "precondition_failed" | "member_missing" | "invariant_violated" | "malformed" | "identity_reused" ; name: string ; member: number | null ; current?: Value }>
ProviderObservation
Ƭ ProviderObservation: {settlement: ProviderExchangeSettlement ; exchangeClosed: boolean ; diagnostic: { code: "IntegrationSourceUnsupported" ; message: string } | null ; interpretation?: { revision: string ; response: string ; requestId: string ; authorizedAtMs: number } } & { kind: "applied" | "not_dispatched" | "not_applied" ; receipt: string } | { kind: "contract_mismatch" ; receipt: string } | { kind: "refused" ; receipt: string ; refusal: ProviderRefusal | null } | { kind: "duplicated" ; count: number ; receipt: string } | { kind: "pending" ; receipt: string ; retryAfterMs: number | null } | { kind: "progress" ; receipt: string ; ordinal: number } | { kind: "unknown" ; receipt: string | null }
ProviderResultArtifact
Ƭ ProviderResultArtifact:Readonly<{ file: string ; sha256: string ; bytes: number ; programDigest: string ; inputDigest: string ; definition: string ; command: ProviderCommandResultContract | null }>
ProviderCommandResultContract
Ƭ ProviderCommandResultContract:Readonly<{ component: string | null ; integration: { module: string ; export: string } ; command: string ; path: readonly string[] ; validator: ValidatorJSON }>
PublishedSourceRecord
Ƭ PublishedSourceRecord: {component: string | null ; table: string ; id: string } | { sourceId: SourceId ; key: string ; entity: string | null }
ProviderPublication
Ƭ ProviderPublication:Object
Type declaration
ProviderStateEvidence
Ƭ ProviderStateEvidence: {kind: "unstated" } | { kind: "unavailable" ; reason: string } | { kind: "observed" ; expected: Record<string, Value> ; actual: Record<string, Value> ; record: { component: string | null ; table: string ; id: string } ; source: string ; incarnation: string ; revision: string }
Readonly current Source facts from one exact original physical intention.
The delivery component owns comparison; these facts never prove delivery.
ProviderSourceEffect
Ƭ ProviderSourceEffect: {kind: "pending" ; reason: string } | { kind: "unsupported" ; reason: string } | { kind: "incorporated" ; source: string ; incarnation: string ; record: PublishedSourceRecord ; representations?: { component: string | null ; dataset: string ; contract: string ; version: string ; checkpoint: string ; publisherGeneration: string }[] ; revision: string ; basis: { kind: "position" ; required: { space: string ; value: string } ; current: { space: string ; value: string } } | { kind: "effect" | "observation" ; command: string ; capture: string ; digest: string ; corroborating?: string | null } }
A current native read incorporating an authentic effect or command observation.
This is read-basis evidence, not a durable grant or population checkpoint.
ProviderExecutionControl
Ƭ ProviderExecutionControl:Readonly<{ hasCancellation: boolean ; termination: "stopped" | "unknown" ; fileUploadStopped?: boolean }>
ModeledProviderConsequence
Ƭ ModeledProviderConsequence: {kind: "modeled" ; capture: string } | { kind: "unavailable" ; reason: string } | { kind: "refused" ; capture: string ; reason: string }
ProviderDeliveryStatus
Ƭ ProviderDeliveryStatus:Readonly<{ operation: string ; custody: "pending" | "held" | "unknown" | "settled" | "withdrawn" ; evidence: "applied" | "duplicated" | "not_applied" | "refused" | null ; refusal: string | null ; generation: number ; publication: "none" | "pending" | "blocked" | "published" | "cancelled" ; interpretation: "mismatch" | "authorized" | null }>
Native custody facts for one provider command call: physical custody and
the authentic observation that settled it. The delivery component decides
what the command means.
ObservationHandle
Ƭ ObservationHandle<S, Kind, Contract>: Object
A typed observation reference. A selection creates a pure consumer; it grants
neither source evidence nor permission to execute an acquisition.
Type parameters
Type declaration
OccurrenceExpressions
Ƭ OccurrenceExpressions<S>: FilterBuilder<{ document: ObjectType<S> ; fieldPaths: DocumentFieldPaths<ObjectType<S>> ; indexes: {} ; searchIndexes: {} ; vectorIndexes: {} }>
Not exported: an exported type refers to it.
Type parameters
LatestSelection
Ƭ LatestSelection<S, Output>: Object
Not exported: an exported type refers to it.
Type parameters
Type declaration
VersionRetention
Ƭ VersionRetention: {days: number } | { hours: number } | { minutes: number }
Retention of immutable acquired file versions, at most one year.
SchemaOf
Ƭ SchemaOf<H>: H extends ObservationHandle<infer S, any, any> ? S : never
Not exported: an exported type refers to it.
Type parameters
ContractOf
Ƭ ContractOf<H>: H extends ObservationHandle<any, any, infer C> ? C : never
Not exported: an exported type refers to it.
Type parameters
Q
Ƭ Q:Omit<GenericQueryCtx<GenericDataModel>, "db">
Not exported: an exported type refers to it.
M
Ƭ M:BijectionMutationCtx<GenericDataModel>
Not exported: an exported type refers to it.
StorageTable
Ƭ StorageTable:TableDefinition<any, any, any, any, false, any>
Not exported: an exported type refers to it.
LocalStorage
Ƭ LocalStorage<T>: T extends { publishedFrom: string } | { seriesBinding: () => unknown } ? never : T
Not exported: an exported type refers to it.
Type parameters
HostSourceFields
Ƭ HostSourceFields:Object
Not exported: an exported type refers to it.
Type declaration
HostSourceFieldValidators
Ƭ HostSourceFieldValidators:Object
Not exported: an exported type refers to it.
Type declaration
SourceDocumentType
Ƭ SourceDocumentType<D>: D extends VObject<infer Type, infer Fields, infer IsOptional, any> ? VObject<Expand<Type & HostSourceFields>, Expand<Fields & HostSourceFieldValidators>, IsOptional> : D
Not exported: an exported type refers to it.
Type parameters
GoverningDefinition
Ƭ GoverningDefinition<Document>: FunctionReference<"query", "public" | "internal", { changes: TableChange<Document>[] }, ReadAccessResults> | { query?: FunctionReference<"query", "public" | "internal", { changes: TableChange<Document>[] }, ReadAccessResults> ; reads?: readonly string[] | () => readonly string[] ; basis?: "original" | "final" ; appliesDelegation?: boolean ; [accessWriteProgram]?: AccessWriteProgram }
Not exported: an exported type refers to it.
Type parameters
SourceFileArtifact
Ƭ SourceFileArtifact:Object
Type declaration
Contracts
Ƭ Contracts:Object
Not exported: an exported type refers to it.
Type declaration
Fields
Ƭ Fields:Record<string, GenericValidator>
Not exported: an exported type refers to it.
SourceEvidence
Ƭ SourceEvidence:SourceStatus["evidence"]
What the engine can prove about one installed source’s population.
Every field is derived from the evidence the capture and acquisition owners
already record for that source alone. There is no credential, destination
name or provider identifier here, and a value read for one source discloses
nothing about another.
SourceCause
Ƭ SourceCause:NonNullable<NonNullable<SourceStatus["sync"]>["cause"]>
SourceSync
Ƭ SourceSync:NonNullable<SourceStatus["sync"]>
What acquisition of one installed source is doing now.
This is a different fact from SourceEvidence: an idle source can be
stale or never acquired, and a held one can still serve a complete
publication, so read both to say “last checked 3 minutes ago, updates
blocked”.
SourceTableName
Ƭ SourceTableName<DataModel>: SourceTableNames<DataModel> & TableNamesInDataModel<DataModel>
Not exported: an exported type refers to it.
Type parameters
SourceSelector
Ƭ SourceSelector<DataModel, Resource>: TableSourceSelector<DataModel> | { sourceId: SourceId ; table?: never ; scope?: never ; resource?: never } | ResourceSourceSelector<Resource>
The one selection every ctx.sources method takes:
{ table }: the one source of a table without application scope;{ table, scope }: the source installed for that complete scope;{ table, sourceId }: that source, checked to publish into the table;{ sourceId }: a source handle, such as a row’s_sourceId;{ resource, collection? }: a declared resource’s source.
Type parameters
TableSourceSelector
Ƭ TableSourceSelector<DataModel, TableName>: { [T in TableName]: Object & TableSourceSelection<NamedTableInfo<DataModel, T>> }[TableName]
A SourceSelector naming one of this component’s tables.
Type parameters
ResourceSourceSelector
Ƭ ResourceSourceSelector<Resource>: Object
Select a declared resource’s installed source: its one table, or the
named collection of a resource group. A sourceId must belong to it.
Type parameters
Type declaration
SourceContract
Ƭ SourceContract<DataModel, TableName>: NamedTableInfo<DataModel, TableName> extends { sourceContract: infer Contract } ? Contract : any
Not exported: an exported type refers to it.
Type parameters
InstallationScope
Ƭ InstallationScope<Scope>: Scope extends Record<string, never> ? { scope?: never } : { scope: Scope }
Not exported: an exported type refers to it.
Type parameters
SourceReadRequirement
Ƭ SourceReadRequirement:Object
Evidence a read of a source-owned table requires.
Declared once on the binding, defineSyncedTable({source: handle, ...{ read: requirement }}), it applies to
every query and mutation read of the table: queries, pagination, point reads
and subscriptions. The required sources are fixed before any row is read:
every source installed under the binding, or the one an index range selects
with .eq("_sourceId", ...). A source with no rows therefore still counts,
and an unestablished source refuses instead of reading as empty. A read may
tighten it with ctx.db.query(table).require(...); repeated requirements
combine, and nothing a read chooses waives the binding’s declared floor.
A refusal names the table and the unmet requirement, never a source; read
ctx.sources.status to show which source is behind. A mutation that catches
the refusal still cannot commit. A view, join or total over the table owes
the same floor, and a read’s own .require(...) of the view adds to every
source-owned relation it reads. A diagnostic screen can use
ctx.sources.status to show unmet requirements while row reads retain the floor.
Type declaration
SourceStatus
Ƭ SourceStatus:SourceStatus
Published evidence and update work at one query basis.
SourceChangePage
Ƭ SourceChangePage: {kind: "page" ; entries: { position: string ; record: string ; version: string | null }[] ; isDone: boolean ; scannedThrough?: string } | { kind: "expired" ; retainedFrom: string }
Read the coverage and freshness of an installed source.
A source is named by the opaque handle the engine stamps on every row it
publishes (_sourceId), and coverage is disclosed under exactly the
authority those rows are: a caller a relation’s read rule refuses for a
source’s rows is refused here for the same reason. The read participates in
dependency tracking like any other, so a result that concluded “we cannot
establish this” is reevaluated when the source’s coverage changes.
SourceBarrier
Ƭ SourceBarrier: {kind: "none" | "eachLatest" | "completeVersions" } | { kind: "publication" ; publicationId: SourcePublicationId } | { kind: "common" ; at: { kind: "revision" ; revision: string } | { kind: "publicationOf" ; sourceId: SourceId } }
A requirement over source publications, evaluated on this transaction’s basis.
SourceBarrierBasis
Ƭ SourceBarrierBasis:Object
Type declaration
SourceTerms
Ƭ SourceTerms<T>: Object
Type parameters
Type declaration
SourceInstallation
Ƭ SourceInstallation<TableInfo>: Object
A source installation resolved against its declaration at this read basis.
Keep resolution in the query or mutation that uses it; a handle is no grant.
Type parameters
Type declaration
SourceRecordWork
Ƭ SourceRecordWork: {kind: "idle" } | { kind: "pending" ; generation: string } | { kind: "retrying" ; generation: string ; attempts: number ; nextAttemptAt: number } | { kind: "blocked" ; generation: string ; attempts: number ; reason: SourceContentBlock }
Native work for one caller-named provider key. idle means no retained
key obligation; it does not prove the item exists or its bytes are ready.
SourceContentBlock
Ƭ SourceContentBlock:"transferLimit" | "providerLimit" | "versionUnavailable" | "providerRejected"
Not exported: an exported type refers to it.
SourceFileContract
Ƭ SourceFileContract: {kind: "metadata" ; collection: string ; selectionDigest: string ; acquisitionOwners: string[] } | { kind: "observedVersions" ; collection: string ; origins: string[] ; retainForMs: number ; permissions: { mode: "application" } } | { kind: "copy" ; collection: string ; maximumBytes: number ; resume: "wholeResponse" ; history: { collection: string ; retainForMs: number }[] ; currentMetadata: boolean ; selectionDigest: string | null ; permissions: { mode: "application" } }
Capabilities derived from this exact installed native file declaration.
SourceFileContent
Ƭ SourceFileContent:Object
Native point state at this query’s exact basis. Previous bytes remain
distinct from current readiness; this value grants no byte authority.
Type declaration
SourceArtifact
Ƭ SourceArtifact:Object
An exact observed copy. A locator grants no future byte access and does
not establish that the provider still exposes this version.
Type declaration
SourceObservationView
Ƭ SourceObservationView<Row>: { kind: "available" ; value: Row } | { kind: "unavailable" ; reason: "retained-observation-required" }
An evidence perspective may require an explicitly authorized historical read.
Type parameters
SourceFieldProvenance
Ƭ SourceFieldProvenance: {origin: "source-observation" } | { origin: "native-identity" } | { origin: "confirmed-command" ; command: string ; response: string ; reconciliation: "awaiting-successor-evidence" | "conflicting-confirmed-commands" }
SourceRecordState
Ƭ SourceRecordState<Row>: Object
The native external projection and its local decision basis. This basis is
not a provider revision or a conditional-write token.
Type parameters
Type declaration
SourceFetchValue
Ƭ SourceFetchValue:string | bigint | boolean | ArrayBuffer
An exact value a fetch filter compares a declared field with: the value
the field is published as. There is no number: an approximate value has
no exact equality. An integer column’s value is a bigint; an exact
decimal, a date or a timestamp is its canonical text, a decimal at its
column’s scale ("12.50", not "12.5").
SourceFetchOptions
Ƭ SourceFetchOptions:Object
One pinned, bounded read of an installed source’s table.
Type declaration
SourceReadPrincipal
Ƭ SourceReadPrincipal: {kind: "user" ; tokenIdentifier: string } | { kind: "administrator" } | { kind: "system" } | { kind: "anonymous" }
The Bijection principal a source read ran under. The source itself is read
through the installation’s own credential, never as this principal.
SourceReadObservation
Ƭ SourceReadObservation:Object
When a source read was answered, of what and under whose authority. It
describes one read: nothing about it is retained as a dataset version.
Type declaration
SourceFetchReceipt
Ƭ SourceFetchReceipt:Object
What a fetch read.
Type declaration
SourceFetchErrorCode
Ƭ SourceFetchErrorCode:"ReadAccess" | "ActionDisclosure" | "IntegrationReinstallRequired" | "SourceFetchArguments" | "SourceFetchUnavailable" | "SourceFetchUnsupported" | "SourceFetchUnpinned" | "SourceFetchUndeclaredField" | "SourceFetchTooManyFilters" | "SourceFetchFilterValue" | "SourceFetchPosition" | "SourceFetchContinuation" | "SourceFetchSourceReplaced" | "SourceFetchHistoryUnavailable" | "SourceFetchRowBound" | "SourceFetchInexactFilter"
Why a fetch was refused. ReadAccess: the source’s read rule refused the
rows the filters name. ActionDisclosure: the action holds protected
information from elsewhere than this source’s rows, which the fetch would
send to the source. SourceFetchHistoryUnavailable: the source no
longer retains the pinned position; fetch again without at.
SourceFetchSourceReplaced: the table is not the installed incarnation.
SourceFetchInexactFilter: the source’s comparison matched a row whose
value differs from a filter’s.
SourceFetchErrorData
Ƭ SourceFetchErrorData:Object
The data of the BijectionError a refused fetch throws.
Type declaration
SourceRefreshOptions
Ƭ SourceRefreshOptions: {requestId?: RequestId ; recover?: false } | { requestId: RequestId ; recover: true }
Recovery observes the original acceptance and cannot create work.
CapturedSourceNavigation
Ƭ CapturedSourceNavigation:Object
Type declaration
ConnectionTaskRequest
Ƭ ConnectionTaskRequest: {connection: string ; controller: { record: string ; protocol: string ; contentRetryMs: readonly string[] } ; request_id?: string } & { task: "setup" ; effect: "inspect" | "verify" } | { task: "setup" ; effect: "install" ; collection: string } | { task: "repair" ; effect: "inspect" | "verify" } | { task: "repair" ; effect: "recover" ; source: string }
Native effects of an operator-admitted credential ticket. Usable only from
its exact, live, deployment-approved controller’s accepted work.
ConnectionTaskObservation
Ƭ ConnectionTaskObservation:Object
Type declaration
Camel
Ƭ Camel<S>: S extends `\{infer A}\_{infer B}` ? `\{A}{Capitalize<Camel<B>>}` : S
Not exported: an exported type refers to it.
Type parameters
SourceCapabilities
Ƭ SourceCapabilities:Infer<typeof capabilities>
PublicIssue
Ƭ PublicIssue<T>: T extends string ? Camel<T> : T extends object ? { [K in keyof T]: PublicIssue<T[K]> } : T
Not exported: an exported type refers to it.
Type parameters
SourceRequestIssue
Ƭ SourceRequestIssue:Exclude<PublicIssue<SourceRequestIssue>, { kind: "syncBlocked" }> | { kind: "syncBlocked" ; cause: NonNullable<Extract<PublicIssue<SourceRequestIssue>, { kind: "syncBlocked" }>["cause"]> } | { kind: "unknown" }
A blocked owner may not have retained a precise diagnosis. unknown is
explicit rather than an invented cause or a nullable failure reason.
SourceUnsupportedCode
Ƭ SourceUnsupportedCode:SourceUnsupportedCode
SourceMissingEvidenceCode
Ƭ SourceMissingEvidenceCode:SourceMissingEvidenceCode
ReadUnavailable
Ƭ ReadUnavailable: {kind: "missingEvidence" ; code: SourceMissingEvidenceCode } | { kind: "unsupported" ; code: SourceUnsupportedCode }
Why the actual read could not establish its requirement.
ReadResult
Ƭ ReadResult<T>: { kind: "ready" ; value: T } | ReadUnavailable
Availability of the actual native read at the caller’s transaction basis.
Type parameters
ReadAvailabilityOptions
Ƭ ReadAvailabilityOptions:Object
Type declaration
SourceRefreshObservation
Ƭ SourceRefreshObservation: typeoftype
ReaderAuthority
Ƭ ReaderAuthority:Object
A recipient’s sealed, finite consent for one snapshot reader.
Type declaration
SourceTableNames
Ƭ SourceTableNames<DataModel>: string extends keyof DataModel ? string : { [Name in TableNamesInDataModel<DataModel>]: DataModel[Name] extends Object ? Name : never }[TableNamesInDataModel<DataModel>]
Not exported: an exported type refers to it.
Type parameters
SourceTable
Ƭ SourceTable<TableInfo>: Object
A source’s exact schema table selected at this transaction basis.
Native reads recheck installation, epoch, policy and evidence.
Type parameters
Type declaration
SourcePartitionSelection
Ƭ SourcePartitionSelection:Object
Not exported: an exported type refers to it.
Type declaration
SourceScope
Ƭ SourceScope<TableInfo>: TableInfo extends { sourceScope: infer Scope } ? keyof Scope extends never ? Record<string, never> : Scope : Record<string, Value>
The application references required by a scoped source declaration.
Type parameters
TableSourceSelection
Ƭ TableSourceSelection<TableInfo>: TableInfo extends { sourceScope: infer Scope } ? [Scope] extends [never] ? { scope?: never ; sourceId?: SourceId } : keyof Scope extends never ? { scope?: never ; sourceId?: SourceId } : { scope: Scope ; sourceId?: never } | { sourceId: SourceId ; scope?: never } : { scope?: Record<string, Value> ; sourceId?: never } | { sourceId: SourceId ; scope?: never }
How a selection picks one of a table’s sources. A table without
application scope may name only itself, selecting its one source; a scoped
table names a complete scope. Either may name a source handle instead.
Type parameters
SourceAcquisitionSelection
Ƭ SourceAcquisitionSelection:Object
A history run can span several requests. Only acquisition_id guards
recovery.
Type declaration
SourceCoverageKind
Ƭ SourceCoverageKind:"records" | "enumeration" | "query_result" | "incremental_snapshot" | "committed_prefix" | "latest_per_key" | "snapshot"
SourceReadProtocol
Ƭ SourceReadProtocol:"dataset" | "record_observation" | "change_feed" | "transactional_feed" | "stream_latest"
SourceConsistency
Ƭ SourceConsistency:"observations" | "snapshot"
SourceAtomicity
Ƭ SourceAtomicity:"record" | "source_transaction" | "snapshot"
SourceHistoryKind
Ƭ SourceHistoryKind:"observations" | "complete_changes" | "complete_occurrences" | "latest_state"
ResponseMovement
Ƭ ResponseMovement:Object
Not exported: an exported type refers to it.
Type declaration
BodyPlacement
Ƭ BodyPlacement:"retained_bytes" | "protected_file"
Not exported: an exported type refers to it.
BodyInterpretation
Ƭ BodyInterpretation:"none" | "opaque" | "text" | "json" | "positional" | "document" | "grpc" | "file_custody"
Not exported: an exported type refers to it.
PlanStep
Ƭ PlanStep:Object
Not exported: an exported type refers to it.
Type declaration
MovementStep
Ƭ MovementStep: {operation: "acquire" ; subject: string ; limitBytes: string | null } | { operation: "retain" ; subject: string ; reason: RepresentationReason ; release: MovementRelease } | { operation: "interpret" ; subject: string ; produces: InterpretedOutput } | { operation: "materialize" ; subject: string ; reason: RepresentationReason ; release: MovementRelease } | { operation: "publish" ; subject: string ; visibility: PublicationVisibility } | { operation: "release" ; subject: string ; reach: ProviderReach }
Not exported: an exported type refers to it.
RepresentationReason
Ƭ RepresentationReason:"recovery" | "artifact" | "serving" | "latest" | "fold" | "archive" | "history" | "series"
Not exported: an exported type refers to it.
MovementRelease
Ƭ MovementRelease:"acquisition_custody" | "replacement" | "source_record" | "output_retention"
Not exported: an exported type refers to it.
InterpretedOutput
Ƭ InterpretedOutput:"records" | "occurrences"
Not exported: an exported type refers to it.
PublicationVisibility
Ƭ PublicationVisibility:"with_acquisition" | "timed"
Not exported: an exported type refers to it.
ProviderReach
Ƭ ProviderReach:"acknowledge" | "request" | "remove" | "archive"
Not exported: an exported type refers to it.
SourceCommandDelivery
Ƭ SourceCommandDelivery:"idempotent" | "single_attempt" | "at_least_once"
Not exported: an exported type refers to it.
SourceCommandCondition
Ƭ SourceCommandCondition:"target_version" | "field_ownership" | "target_state" | "unconditional"
Not exported: an exported type refers to it.
ReportQualificationSubject
Ƭ ReportQualificationSubject:Object
Type declaration
ReportQualificationPolicy
Ƭ ReportQualificationPolicy:Object
Type declaration
QualificationCaseRequirement
Ƭ QualificationCaseRequirement:Object
Not exported: an exported type refers to it.
Type declaration
QualificationEvidenceKind
Ƭ QualificationEvidenceKind:"native_test" | "controlled_provider" | "real_provider" | "operator_fault"
Not exported: an exported type refers to it.
ReportQualificationReceipt
Ƭ ReportQualificationReceipt:Object
Type declaration
ReportQualificationCase
Ƭ ReportQualificationCase:Object
Not exported: an exported type refers to it.
Type declaration
QualificationOutcome
Ƭ QualificationOutcome:"passed" | "failed" | "not_run" | "unresolved"
Not exported: an exported type refers to it.
SourceReplicationStatus
Ƭ SourceReplicationStatus:Object
Type declaration
SourceCapacityResource
Ƭ SourceCapacityResource:"backlog_units" | "backlog_bytes" | "source_custody" | "deployment_custody"
SourceReplicationUnit
Ƭ SourceReplicationUnit:Object
Type declaration
SourceReplicationCursor
Ƭ SourceReplicationCursor:Object
Type declaration
SourceReplicationStaging
Ƭ SourceReplicationStaging:Object
Type declaration
SourceReplicationStage
Ƭ SourceReplicationStage:"indexing" | "preparing" | "compacting" | "validating" | "ready"
ResponseIssue
Ƭ ResponseIssue:"required" | "unexpected" | "type" | "literal" | "semantic"
Not exported: an exported type refers to it.
RetentionObligation
Ƭ RetentionObligation:Object
Not exported: an exported type refers to it.
Type declaration
AcquisitionPin
Ƭ AcquisitionPin:"running" | "archive_pending" | "history_pending" | "open_gap" | "change_capture" | "scheduled_run" | "interpretation_input" | "replay_window" | "current_coverage" | "snapshot_preparation" | "publication_group" | "latest_projection" | "source_progress" | "connection_verification" | "other_owner"
Not exported: an exported type refers to it.
IntegrationFailureReason
Ƭ IntegrationFailureReason:"authentication" | "signature" | "insufficient_scope" | "throttled" | "transport" | "capacity" | "source_busy" | "unavailable" | "invalid_response" | "invalid_result" | "work_limit" | "unclassified"
Not exported: an exported type refers to it.
CheckReceipt
Ƭ CheckReceipt: {kind: "pending" ; admitted_at: string ; expires_at: string } | { kind: "complete" ; admitted_at: string ; expires_at: string ; state: CheckReceiptState ; checked_at: string ; reason: IntegrationFailureReason | null }
Exact native receipt observation; decimal timestamps cross without float
conversion.
CheckReceiptState
Ƭ CheckReceiptState:"confirmed" | "identity_differs" | "unverified" | "failed"
Not exported: an exported type refers to it.
SourceRebuildPreview
Ƭ SourceRebuildPreview:Object
Not exported: an exported type refers to it.
Type declaration
SourceAcquisitionWindow
Ƭ SourceAcquisitionWindow:Object
Type declaration
SourceAcquisitionRun
Ƭ SourceAcquisitionRun:Object
Exact counters are decimal strings; observation times are epoch
milliseconds.
Type declaration
SyncOrigin
Ƭ SyncOrigin:"scheduled" | "manual" | "notification" | "reconciliation" | "repair"
Not exported: an exported type refers to it.
SyncRunState
Ƭ SyncRunState:"running" | "retrying" | "blocked" | "completed" | "cancelled"
Not exported: an exported type refers to it.
ConnectionPage
Ƭ ConnectionPage:Object
Not exported: an exported type refers to it.
Type declaration
ConnectionStatus
Ƭ ConnectionStatus:Object
Not exported: an exported type refers to it.
Type declaration
ConnectionRoute
Ƭ ConnectionRoute:Object
Not exported: an exported type refers to it.
Type declaration
ConnectionRouteKind
Ƭ ConnectionRouteKind:"relay" | "endpoint"
Not exported: an exported type refers to it.
ConnectionRouteTarget
Ƭ ConnectionRouteTarget:Object
Not exported: an exported type refers to it.
Type declaration
ConnectionRouteFact
Ƭ ConnectionRouteFact:Object
Not exported: an exported type refers to it.
Type declaration
ConnectionRepairReceipt
Ƭ ConnectionRepairReceipt:Object
Not exported: an exported type refers to it.
Type declaration
ConnectionRepairState
Ƭ ConnectionRepairState:"stored" | "verifying" | "updating" | "verified" | "blocked" | "reconciliationRequired"
Not exported: an exported type refers to it.
SourceControlReply
Ƭ SourceControlReply: {kind: "accepted" ; receipt: SourceControlReceipt } | { kind: "refused" ; code: string ; message: string }
Not exported: an exported type refers to it.
SourceRequestSelector
Ƭ SourceRequestSelector:Object
Not exported: an exported type refers to it.
Type declaration
ServingSourcePublication
Ƭ ServingSourcePublication:Object
Not exported: an exported type refers to it.
Type declaration
SourceCheckpoint
Ƭ SourceCheckpoint:Object
Not exported: an exported type refers to it.
Type declaration
SourcePosition
Ƭ SourcePosition:Object
Not exported: an exported type refers to it.
Type declaration
SourceDatasetEvidence
Ƭ SourceDatasetEvidence:Object
Not exported: an exported type refers to it.
Type declaration
SourceSyncStatus
Ƭ SourceSyncStatus:"scheduled" | "running" | "retrying" | "blocked" | "paused"
Not exported: an exported type refers to it.
SourceControls
Ƭ SourceControls:Object
Not exported: an exported type refers to it.
Type declaration
SourceRequirementAssessment
Ƭ SourceRequirementAssessment: {kind: "ready" ; next: SourceReadyAction } | { kind: "unsupported" ; code: SourceUnsupportedCode ; next: SourceUnsupportedAction } | { kind: "missingEvidence" ; code: SourceMissingEvidenceCode ; next: SourceEvidenceAction }
Not exported: an exported type refers to it.
SourceReadyAction
Ƭ SourceReadyAction:"none"
Not exported: an exported type refers to it.
SourceUnsupportedAction
Ƭ SourceUnsupportedAction:"changeRequirement"
Not exported: an exported type refers to it.
SourceEvidenceAction
Ƭ SourceEvidenceAction:"requestRefresh" | "wait" | "repairSource" | "inspectSource"
Not exported: an exported type refers to it.
SourcePopulationLayout
Ƭ SourcePopulationLayout:Object
Not exported: an exported type refers to it.
Type declaration
SourcePopulationMember
Ƭ SourcePopulationMember:"current" | "recovery"
Not exported: an exported type refers to it.
SourceRecordRecovery
Ƭ SourceRecordRecovery:Object
Not exported: an exported type refers to it.
Type declaration
SourceRecoveryKind
Ƭ SourceRecoveryKind:"record" | "population"
Not exported: an exported type refers to it.
SourceTableDefinition
Ƭ SourceTableDefinition<Source, Indexes>: SourceTableBuilder<SourceDocumentType<VObject<ObjectType<Source["schema"]>, Source["schema"]>> & { sourceScopeType: Exclude<Source["__scopeType"], undefined> ; sourceContractType: Exclude<Source["__resourceContract"], undefined> }, Indexes>
Not exported: an exported type refers to it.
Type parameters
ResultErrorData
Ƭ ResultErrorData:Object
A native answer refusal, released under the input’s current access rules.
Type declaration
ResultNextAction
Ƭ ResultNextAction:"observe_request" | "raise_author_bound" | "narrow_inputs" | "allow_crossing" | "correct_arguments" | "revise_query" | "refresh_binding" | "update_definition" | "review_access" | "restart_pages" | "run_again_later" | "run_again" | "contact_source_owner"
A safe next step after a refused or failed answer. It names what to do,
never a key, statement, credential or policy. observe_request means
the source may have applied the work: read the existing result’s status
and never ask again for it blindly.
ResultBoundUse
Ƭ ResultBoundUse:Object
One execution-contract bound’s use: the effective limit, who set it and
what was observed. at_least means counting stopped past the limit.
Type declaration
ResultContractRefusal
Ƭ ResultContractRefusal:Object
The execution contract a contract_refused answer violated: names and
counts only, never keys.
Type declaration
ResultAccessPath
Ƭ ResultAccessPath: {kind: "index" ; index: string ; fields: string[] } | { kind: "scan" }
A local read path, by index and range field names.
ResultContracts
Ƭ ResultContracts:Object
A query’s execution contracts in three parts: what the author
required, how the engine honoured each requirement (and placed every other
statement), and what execution measured.
Type declaration
ResultResponse
Ƭ ResultResponse<Result>: { ok: true ; value: Result } | { ok: false ; error: ResultErrorData }
Application actions return refusals as data so they pass the ordinary read
release gate. An uncaught protected action error remains redacted.
Type parameters
ResultValueType
Ƭ ResultValueType:Readonly<{ kind: ResultValueKind | null ; nullable: boolean ; optional: boolean }>
Not exported: an exported type refers to it.
ResultValueKind
Ƭ ResultValueKind:"text" | "boolean" | "integer" | "decimal" | "float" | "date" | "time" | "timestamp" | "timestamp_tz" | "binary" | { geometry: { geometry_type: "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" ; space: GeometrySpace } } | { position: { space: GeometrySpace } } | { reference: { table: string } } | { array: { element: ResultValueType } } | { union: { members: ResultValueType[] } } | { record: { key: ResultValueType ; value: ResultValueType } } | { object: { fields: Readonly<Record<string, ResultValueType>> } }
Not exported: an exported type refers to it.
ResultPlanSummary
Ƭ ResultPlanSummary:Object
The readable first screen of a plan, derived from its other fields: the
steps in the order they run, what moves between sites, how each
requirement was honoured, each input’s basis, and which numbers are
estimates, measurements or enforced limits. Names, counts and bounds only.
Type declaration
ResultOutputColumn
Ƭ ResultOutputColumn:Readonly<{ name: string ; kind: ResultValueKind | null ; nullable: boolean ; optional: boolean }>
ResultOutputDescriptor
Ƭ ResultOutputDescriptor<Output>: Output extends { kind: infer Kind ; row: infer Row } ? Kind extends "one" ? Readonly<{ kind: "value" ; value: Row ; columns: readonly ResultOutputColumn[] }> : Readonly<{ kind: "table" ; row_count: number ; columns: readonly ResultOutputColumn[] }> : never
Not exported: an exported type refers to it.
Type parameters
ResultOutputDescriptors
Ƭ ResultOutputDescriptors<Outputs>: { readonly [Name in keyof Outputs]: ResultOutputDescriptor<Outputs[Name]> }
Not exported: an exported type refers to it.
Type parameters
RelationalCapabilities
Ƭ RelationalCapabilities:Object
Metadata evidence only. Execution re-admits the current declaration and
authority; this is never a capability to bypass admission.
Type declaration
EligibilityRequirement
Ƭ EligibilityRequirement:"placement" | "limit" | "input_count" | "installation" | "adapter" | "input_qualification" | "coherence" | "recovery" | "input_version" | "binding" | "disclosure"
The requirement an executor eligibility refusal names. Adapter support,
installed exposure and per-input qualification are distinct layers.
EligibilityRefusal
Ƭ EligibilityRefusal:Object
One structured eligibility refusal. It names no physical location.
Type declaration
EligibilityInputRequirement
Ƭ EligibilityInputRequirement:Object
One input’s composed requirement: the strongest version and the
strictest maximum age per evidence clock.
Type declaration
InterfacePopulation
Ƭ InterfacePopulation:Object
Not exported: an exported type refers to it.
Type declaration
AdmittedExecution
Ƭ AdmittedExecution:Object
Type declaration
ExecutorPreflight
Ƭ ExecutorPreflight:Object
Type declaration
ResultRefusal
Ƭ ResultRefusal:Object
Not exported: an exported type refers to it.
Type declaration
StatementObservation
Ƭ StatementObservation:Readonly<{ result_id: string ; statement_ordinal: number }>
Coordinates of one native source read unit, including the verified batches
of a pinned probe. They identify the observation without exposing a provider
handle or granting authority.
ResultId
Ƭ ResultId<Row>: string & { __result_id?: true }
A typed reference, never permission to read a result.
Type parameters
UnixNanoseconds
Ƭ UnixNanoseconds:string
Not exported: an exported type refers to it.
ResultReadRequirement
Ƭ ResultReadRequirement:Object
Fixed input versions or independent observations; a context grants no read authority.
Type declaration
SealedResultPage
Ƭ SealedResultPage<Row>: Object
A page is bound to exactly one output of one sealed answer.
Type parameters
Type declaration
SnapshotRowReference
Ƭ SnapshotRowReference:string & { __snapshotRowReference: unique symbol }
Opaque position bound by the native owner to a retained execution and recipe.
Possession grants no authority and does not identify a current object.
SnapshotRow
Ƭ SnapshotRow<Row>: Object
A snapshot value and its identity travel together.
Type parameters
Type declaration
ResultDescriptor
Ƭ ResultDescriptor<Outputs>: Readonly<{ id: ResultId<Outputs> ; program_digest: string ; content_digest: string ; completed_at: UnixNanoseconds ; basis: Readonly<ComputationBasis> ; outputs: ResultOutputDescriptors<Outputs> }>
Immutable metadata of one complete validated answer. Its execution is
its identity; pages and keeps never ask its sources again.
Type parameters
KeptResultRef
Ƭ KeptResultRef:string & { __keptResult?: true }
A kept result’s identity. Possession grants nothing: every read is
decided on the answer’s holder and its file’s current source authority.
ResultRow
Ƭ ResultRow<Expr>: string extends keyof RelationRow<Expr> ? Record<string, Value> : RelationRow<Expr> extends infer Row ? Expand<Row> : never
A relation’s rows; a relation read by table name keeps runtime-checked values.
Type parameters
VirtualNavigation
Ƭ VirtualNavigation<Field>: Object
A declared navigation of a virtual table: field (one field, or one per
key field in key order) names one row of the virtual table to by its
declared key.
Type parameters
Type declaration
VirtualTableDeclaration
Ƭ VirtualTableDeclaration<Fields>: Object
A logical relation an installed executor evaluates. Its physical
catalog, schema, table and columns are a deployment binding installed with
the executor’s connection, never part of the declaration.
Type parameters
Type declaration
RemoteDefinition
Ƭ RemoteDefinition:Object
Not exported: an exported type refers to it.
Type declaration
Variables
connectionPermissionArgs
•Const connectionPermissionArgs: Object
Private connection policy inputs. Native custody derives every field; public
functions must never forward user-authored values to this query. Membership
is an application-owned incarnation that changes on removal and rejoining.
Data access remains governed independently by ordinary read policies.
Type declaration
connectionPermissionResult
•Const connectionPermissionResult: VObject<{ membership: string ; validUntil: null | number ; allowed: boolean ; membershipActive: boolean }, { allowed: VBoolean<boolean, "required"> ; validUntil: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> ; membership: VString<string, "required"> ; membershipActive: VBoolean<boolean, "required"> }, "required", "membership" | "validUntil" | "allowed" | "membershipActive">
browserLocator
•Const browserLocator: Readonly<{ role: (role: string, options: { name: string }) => BrowserLocator ; label: (text: string) => BrowserLocator ; testId: (id: string) => BrowserLocator ; css: (selector: string) => BrowserLocator }>
Serializable locator declarations for bounded captures. The interaction page
exposes the corresponding getByRole/getByLabel/getByTestId/locator methods.
browserCapture
•Const browserCapture: Readonly<{ response: Readonly<{ kind: "response" }> ; page: <Fields>(input: { fields: Fields ; rows?: BrowserLocator ; empty?: BrowserLocator }) => Readonly<{ rows?: BrowserLocator ; empty?: BrowserLocator ; fields: Readonly<Fields> ; kind: "page" }> }>
Captures describe observations, never remote population or causal receipts.
browserProtocols
•Const browserProtocols: Object
The admitted broker transports. Both carry bounded page commands and send
every intercepted page request through the native broker; neither is an
unrestricted CDP endpoint. Only enforced also has isolation beneath the
browser that blocks traffic bypassing the broker.
Type declaration
commandRecoveryValidator
•Const commandRecoveryValidator: VObject<{ next: "none" | "send" | "interpret" | "publish" | "wait" | "reconcile" | "attention" ; reason: null | "attemptInFlight" | "attemptNotDispatched" | "providerOutcomeUnknown" | "sendWindowExpired" | "recoveryWindowExpired" | "authorityUnavailable" | "publicationBlocked" | "recoveryBudgetExhausted" | "earlierAttemptUnsettled" | "cancelledOutcomeUnknown" | "waitingForOrder" | "adapterUnsupported" | "duplicateEffects" | "responseContractMismatch" ; nextAtMs: null | number }, { next: VUnion<"none" | "send" | "interpret" | "publish" | "wait" | "reconcile" | "attention", VLiteral<"none" | "send" | "interpret" | "publish" | "wait" | "reconcile" | "attention", "required">[], "required", never> ; reason: VUnion<null | "attemptInFlight" | "attemptNotDispatched" | "providerOutcomeUnknown" | "sendWindowExpired" | "recoveryWindowExpired" | "authorityUnavailable" | "publicationBlocked" | "recoveryBudgetExhausted" | "earlierAttemptUnsettled" | "cancelledOutcomeUnknown" | "waitingForOrder" | "adapterUnsupported" | "duplicateEffects" | "responseContractMismatch", [VNull<null, "required">, …VLiteral<“attemptInFlight” | “attemptNotDispatched” | “providerOutcomeUnknown” | “sendWindowExpired” | “recoveryWindowExpired” | “authorityUnavailable” | “publicationBlocked” | “recoveryBudgetExhausted” | “earlierAttemptUnsettled” | “cancelledOutcomeUnknown” | “waitingForOrder” | “adapterUnsupported” | “duplicateEffects” | “responseContractMismatch”, “required”>[]], "required", never> ; nextAtMs: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> }, "required", "next" | "reason" | "nextAtMs">
Owner-derived recovery observations. They are neither send permissions nor
a second lifecycle journal. Only the original owner can progress the command.
commandObservationValidator
•Const commandObservationValidator: VObject<{ revision: number ; recovery: { next: “none” | “send” | “interpret” | “publish” | “wait” | “reconcile” | “attention”; reason: “attemptInFlight” | “attemptNotDispatched” | “providerOutcomeUnknown” | “sendWindowExpired” | … 10 more … | null; nextAtMs: number | null; } ; delivery: { phase: “uncertain” | “blocked” | “refused” | “pending” | “cancelled” | “held” | “delivered” | “queued” | “dispatching” | “notApplied” | “duplicated”; mayHaveDispatched: boolean; settlement: “unbounded” | … 1 more … | “unsettled”; } ; execution: { authorityRevoked: boolean; cancelRequested: boolean; } ; publication: "none" | "blocked" | "running" | "pending" | "complete" ; effect: "unknown" | "applied" | "notApplied" | "duplicated" ; canSubmit: boolean ; recoverUntil: number }, { recovery: VObject<{ next: "none" | "send" | "interpret" | "publish" | "wait" | "reconcile" | "attention" ; reason: null | "attemptInFlight" | "attemptNotDispatched" | "providerOutcomeUnknown" | "sendWindowExpired" | "recoveryWindowExpired" | "authorityUnavailable" | "publicationBlocked" | "recoveryBudgetExhausted" | "earlierAttemptUnsettled" | "cancelledOutcomeUnknown" | "waitingForOrder" | "adapterUnsupported" | "duplicateEffects" | "responseContractMismatch" ; nextAtMs: null | number }, { next: VUnion<"none" | "send" | "interpret" | "publish" | "wait" | "reconcile" | "attention", VLiteral<"none" | "send" | "interpret" | "publish" | "wait" | "reconcile" | "attention", "required">[], "required", never> ; reason: VUnion<null | "attemptInFlight" | "attemptNotDispatched" | "providerOutcomeUnknown" | "sendWindowExpired" | "recoveryWindowExpired" | "authorityUnavailable" | "publicationBlocked" | "recoveryBudgetExhausted" | "earlierAttemptUnsettled" | "cancelledOutcomeUnknown" | "waitingForOrder" | "adapterUnsupported" | "duplicateEffects" | "responseContractMismatch", [VNull<null, "required">, …VLiteral<“attemptInFlight” | “attemptNotDispatched” | “providerOutcomeUnknown” | “sendWindowExpired” | “recoveryWindowExpired” | “authorityUnavailable” | “publicationBlocked” | “recoveryBudgetExhausted” | “earlierAttemptUnsettled” | “cancelledOutcomeUnknown” | “waitingForOrder” | “adapterUnsupported” | “duplicateEffects” | “responseContractMismatch”, “required”>[]], "required", never> ; nextAtMs: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> }, "required", "next" | "reason" | "nextAtMs"> = commandRecoveryValidator; revision: VFloat64<number, "required"> ; delivery: VObject<{ phase: "uncertain" | "blocked" | "refused" | "pending" | "cancelled" | "held" | "delivered" | "queued" | "dispatching" | "notApplied" | "duplicated" ; mayHaveDispatched: boolean ; settlement: "unbounded" | "settled" | "unsettled" }, { phase: VUnion<"uncertain" | "blocked" | "refused" | "pending" | "cancelled" | "held" | "delivered" | "queued" | "dispatching" | "notApplied" | "duplicated", VLiteral<"uncertain" | "blocked" | "refused" | "pending" | "cancelled" | "held" | "delivered" | "queued" | "dispatching" | "notApplied" | "duplicated", "required">[], "required", never> ; mayHaveDispatched: VBoolean<boolean, "required"> ; settlement: VUnion<"unbounded" | "settled" | "unsettled", [VLiteral<"settled", "required">, VLiteral<"unsettled", "required">, VLiteral<"unbounded", "required">], "required", never> }, "required", "phase" | "mayHaveDispatched" | "settlement"> ; effect: VUnion<"unknown" | "applied" | "notApplied" | "duplicated", [VLiteral<"applied", "required">, VLiteral<"notApplied", "required">, VLiteral<"duplicated", "required">, VLiteral<"unknown", "required">], "required", never> ; publication: VUnion<"none" | "blocked" | "running" | "pending" | "complete", VLiteral<"none" | "blocked" | "running" | "pending" | "complete", "required">[], "required", never> ; execution: VObject<{ authorityRevoked: boolean ; cancelRequested: boolean }, { authorityRevoked: VBoolean<boolean, "required"> ; cancelRequested: VBoolean<boolean, "required"> }, "required", "authorityRevoked" | "cancelRequested"> ; recoverUntil: VFloat64<number, "required"> ; canSubmit: VBoolean<boolean, "required"> }, "required", "revision" | "recovery" | "delivery" | "execution" | "publication" | "effect" | "canSubmit" | "recoverUntil" | "recovery.next" | "recovery.reason" | "recovery.nextAtMs" | "delivery.phase" | "delivery.mayHaveDispatched" | "delivery.settlement" | "execution.authorityRevoked" | "execution.cancelRequested">
ewsConnectionSetup
•Const ewsConnectionSetup: Object
Not exported: an exported type refers to it.
Type declaration
nativeConnectionSchemas
•Const nativeConnectionSchemas: Object
Not exported: an exported type refers to it.
Type declaration
providerJourneyCases
•Const providerJourneyCases: ["organizationAdmission", "providerClientBinding", "callbackReplay", "interruptedExchange", "recentAuthentication", "originalSecurityRecovery", "invitationRecipient", "sponsorWithdrawal", "taskCompletion", "domainAmbiguity", "domainAdmissionSeparation"]
Executable obligations beyond token admission.
providerJourneyAssertions
•Const providerJourneyAssertions: VArray<{ evidence: string ; passed: boolean ; assertion: string }[], VObject<{ evidence: string ; passed: boolean ; assertion: string }, { assertion: VString<string, "required"> ; passed: VBoolean<boolean, "required"> ; evidence: VString<string, "required"> }, "required", "evidence" | "passed" | "assertion">, "required">
providerCommandResources
•Const providerCommandResources: Object
Type declaration
freshnessClocks
•Const freshnessClocks: Readonly<{ snapshot: (table: string) => Readonly<{ table: string ; kind: FreshnessClockKind }> ; coverage: (table: string) => Readonly<{ table: string ; kind: FreshnessClockKind }> ; publication: (table: string) => Readonly<{ table: string ; kind: FreshnessClockKind }> ; observation: (table: string) => Readonly<{ table: string ; kind: FreshnessClockKind }> ; discovery: (table: string) => Readonly<{ table: string ; kind: FreshnessClockKind }> ; verification: (table: string) => Readonly<{ table: string ; kind: FreshnessClockKind }> }>
sourceArtifact
•Const sourceArtifact: VDerived<ResultRef<{ size: number ; file: GenericId<"_storage"> ; sha256: string ; format: string ; sourceEpoch: string ; sourceEvidence: null | string }, "artifact">, "required", never> | VObject<{ reference: string ; kind: "artifact" ; owner: string ; contract: string ; version: string ; digest: string }, { kind: VLiteral<"artifact", "required"> ; owner: VString<string, "required"> | VLiteral<string, "required"> ; reference: VString<string, "required"> ; version: VString<string, "required"> ; digest: VString<string, "required"> ; contract: VLiteral<string, "required"> }, "required", "reference" | "kind" | "owner" | "contract" | "version" | "digest"> & { type: ResultRef<{ size: number ; file: GenericId<"_storage"> ; sha256: string ; format: string ; sourceEpoch: string ; sourceEvidence: null | string }, "artifact"> }
sourcePopulationLayoutValidator
•Const sourcePopulationLayoutValidator: VObject<{ current: string ; recovery: string ; omissions: string[] ; member: "current" | "recovery" }, { current: VString<string, "required"> ; recovery: VString<string, "required"> ; omissions: VArray<string[], VString<string, "required">, "required"> ; member: VUnion<"current" | "recovery", [VLiteral<"current", "required">, VLiteral<"recovery", "required">], "required", never> = validatorSourcePopulationMember }, "required", "current" | "recovery" | "omissions" | "member"> = sourceValidators.SourcePopulationLayout
Source-owned physical recovery metadata confers no read authority.
sourceRecordRecoveryValidator
•Const sourceRecordRecoveryValidator: VObject<{ kind: "record" | "population" ; origin: string ; observation: string ; seen: string }, { kind: VUnion<"record" | "population", [VLiteral<"record", "required">, VLiteral<"population", "required">], "required", never> = validatorSourceRecoveryKind; observation: VString<string, "required"> ; origin: VString<string, "required"> ; seen: VString<string, "required"> }, "required", "kind" | "origin" | "observation" | "seen"> = sourceValidators.SourceRecordRecovery
capabilities
•Const capabilities: VObject<{ evidence: "native" | "asserted" | "brokered" ; consistency: "snapshot" | "observations" ; coverage: "records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey" ; reconciliation: boolean ; history: "observations" | "completeChanges" | "completeOccurrences" | "latestState" ; protocol: "dataset" | "changeFeed" | "recordObservation" | "transactionalFeed" | "streamLatest" ; atomicity: "record" | "snapshot" | "sourceTransaction" ; recordRefresh: boolean ; notifications: boolean ; snapshotMaxRows: null | string }, { consistency: VUnion<"snapshot" | "observations", [VLiteral<"observations", "required">, VLiteral<"snapshot", "required">], "required", never> = validatorSourceConsistency; evidence: VUnion<"native" | "asserted" | "brokered", [VLiteral<"native", "required">, VLiteral<"brokered", "required">, VLiteral<"asserted", "required">], "required", never> = validatorEvidenceClass; recordRefresh: VBoolean<boolean, "required"> ; reconciliation: VBoolean<boolean, "required"> ; notifications: VBoolean<boolean, "required"> ; snapshotMaxRows: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; protocol: Validator<"dataset" | "changeFeed" | "recordObservation" | "transactionalFeed" | "streamLatest", "required", any> ; coverage: Validator<"records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey", "required", any> ; atomicity: Validator<"record" | "snapshot" | "sourceTransaction", "required", any> ; history: Validator<"observations" | "completeChanges" | "completeOccurrences" | "latestState", "required", any> }, "required", "evidence" | "consistency" | "coverage" | "reconciliation" | "history" | "protocol" | "atomicity" | "recordRefresh" | "notifications" | "snapshotMaxRows" | `coverage.\{any}\` \| \`history.{any}` | `protocol.\{any}\` \| \`atomicity.{any}`>
Not exported: an exported type refers to it.
sourceStatusValidator
•Const sourceStatusValidator: VObject<{ assessment: undefined | { kind: “ready”; next: “none”; } | { kind: “unsupported”; code: “SourceCoherenceUnsupported” | “SourcePopulationUnsupported” | “SourceCompleteVersionNotDataset” | “SourceContinuityUnsupported” | “SourceRequirementUnsupported” | “SourceEvidenceClassUnsupported”; next: “changeRequirement”; } | { kind: “missingEvidence”; code: “ReadServingVersionUnavailable” | “SourceCoherenceUnavailable” | “SourcePopulationCapabilityUnavailable” | “SourcePopulationUnavailable” | … 7 more … | “FreshnessExpired”; next: “requestRefresh” | … 2 more … | “inspectSource”; } ; sourceId: SourceId ; evidence: { dataset?: { component: string | null; dataset: string | null; version: string | null; revision: string | null; publicationId: SourcePublicationId | null; coherent: boolean; completeVersion: boolean; }; … 11 more …; historyInterrupted: boolean; } ; controls: { pauseId?: PauseId; canRefresh: boolean; } ; sync: null | { status: “blocked” | “scheduled” | “running” | “retrying” | “paused”; cause: “throttled” | “accessRefused” | “credentialRejected” | “credentialExpired” | “scopeMissing” | “signatureRejected” | … 26 more … | null; } }, { sourceId: VIdentity<SourceId, "sourceId", "required"> ; assessment: VUnion<undefined | { kind: "ready" ; next: "none" } | { kind: "unsupported" ; code: "SourceCoherenceUnsupported" | "SourcePopulationUnsupported" | "SourceCompleteVersionNotDataset" | "SourceContinuityUnsupported" | "SourceRequirementUnsupported" | "SourceEvidenceClassUnsupported" ; next: "changeRequirement" } | { kind: "missingEvidence" ; code: "ReadServingVersionUnavailable" | "SourceCoherenceUnavailable" | "SourcePopulationCapabilityUnavailable" | "SourcePopulationUnavailable" | "SourceCompleteVersionUnavailable" | "SourceContinuityUnavailable" | "SourceObservationCoverageRequired" | "SourceObservationUnavailable" | "SourceObservationStale" | "SourceObservationBeforeBarrier" | "FreshnessUnavailable" | "FreshnessExpired" ; next: "requestRefresh" | "wait" | "repairSource" | "inspectSource" }, [VObject<{ kind: "ready" ; next: "none" }, { kind: VLiteral<"ready", "required"> ; next: VLiteral<"none", "required"> = validatorSourceReadyAction }, "required", "kind" | "next">, VObject<{ kind: "unsupported" ; code: "SourceCoherenceUnsupported" | "SourcePopulationUnsupported" | "SourceCompleteVersionNotDataset" | "SourceContinuityUnsupported" | "SourceRequirementUnsupported" | "SourceEvidenceClassUnsupported" ; next: "changeRequirement" }, { kind: VLiteral<"unsupported", "required"> ; code: VUnion<"SourceCoherenceUnsupported" | "SourcePopulationUnsupported" | "SourceCompleteVersionNotDataset" | "SourceContinuityUnsupported" | "SourceRequirementUnsupported" | "SourceEvidenceClassUnsupported", [VLiteral<"SourceCoherenceUnsupported", "required">, VLiteral<"SourcePopulationUnsupported", "required">, VLiteral<"SourceCompleteVersionNotDataset", "required">, VLiteral<"SourceContinuityUnsupported", "required">, VLiteral<"SourceRequirementUnsupported", "required">, VLiteral<"SourceEvidenceClassUnsupported", "required">], "required", never> = validatorSourceUnsupportedCode; next: VLiteral<"changeRequirement", "required"> = validatorSourceUnsupportedAction }, "required", "kind" | "code" | "next">, VObject<{ kind: "missingEvidence" ; code: "ReadServingVersionUnavailable" | "SourceCoherenceUnavailable" | "SourcePopulationCapabilityUnavailable" | "SourcePopulationUnavailable" | "SourceCompleteVersionUnavailable" | "SourceContinuityUnavailable" | "SourceObservationCoverageRequired" | "SourceObservationUnavailable" | "SourceObservationStale" | "SourceObservationBeforeBarrier" | "FreshnessUnavailable" | "FreshnessExpired" ; next: "requestRefresh" | "wait" | "repairSource" | "inspectSource" }, { kind: VLiteral<"missingEvidence", "required"> ; code: VUnion<"ReadServingVersionUnavailable" | "SourceCoherenceUnavailable" | "SourcePopulationCapabilityUnavailable" | "SourcePopulationUnavailable" | "SourceCompleteVersionUnavailable" | "SourceContinuityUnavailable" | "SourceObservationCoverageRequired" | "SourceObservationUnavailable" | "SourceObservationStale" | "SourceObservationBeforeBarrier" | "FreshnessUnavailable" | "FreshnessExpired", [VLiteral<"ReadServingVersionUnavailable", "required">, VLiteral<"SourceCoherenceUnavailable", "required">, VLiteral<"SourcePopulationCapabilityUnavailable", "required">, VLiteral<"SourcePopulationUnavailable", "required">, VLiteral<"SourceCompleteVersionUnavailable", "required">], "required", never> = validatorSourceMissingEvidenceCode; next: VUnion<"requestRefresh" | "wait" | "repairSource" | "inspectSource", [VLiteral<"requestRefresh", "required">, VLiteral<"wait", "required">, VLiteral<"repairSource", "required">, VLiteral<"inspectSource", "required">], "required", never> = validatorSourceEvidenceAction }, "required", "kind" | "code" | "next">], "optional", "kind" | "code" | "next"> ; evidence: VObject<{ dataset: undefined | { component: string | null; dataset: string | null; version: string | null; revision: string | null; publicationId: SourcePublicationId | null; coherent: boolean; completeVersion: boolean; } ; recordObservedFrom: undefined | number ; recordObservedTo: undefined | number ; capabilities: null | { evidence: “native” | “asserted” | “brokered”; consistency: “snapshot” | “observations”; coverage: “records” | “enumeration” | “snapshot” | “queryResult” | “incrementalSnapshot” | “committedPrefix” | “latestPerKey”; … 6 more …; snapshotMaxRows: string | null; } ; population: null | "records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey" ; erased: boolean ; publication: null | { sourceId: SourceId; scope: string; publicationId: SourcePublicationId; checkpoint: { position: { value: string; space: string; } | null; captureId: string; } | null; epoch: SourceEpoch; } ; populationCovered: boolean ; populationObservedFrom: null | number ; observedFrom: null | number ; observedTo: null | number ; continuityLost: boolean ; historyInterrupted: boolean }, { publication: VUnion<null | { sourceId: SourceId ; scope: string ; publicationId: SourcePublicationId ; checkpoint: null | { position: { value: string; space: string; } | null; captureId: string; } ; epoch: SourceEpoch }, [VObject<{ sourceId: SourceId ; scope: string ; publicationId: SourcePublicationId ; checkpoint: null | { position: { value: string; space: string; } | null; captureId: string; } ; epoch: SourceEpoch }, { sourceId: VIdentity<SourceId, "sourceId", "required"> ; epoch: VString<SourceEpoch, "required"> ; scope: VString<string, "required"> ; publicationId: VString<SourcePublicationId, "required"> ; checkpoint: VUnion<null | { position: null | { value: string; space: string; } ; captureId: string }, [VObject<{ position: null | { value: string; space: string; } ; captureId: string }, { captureId: VString<string, "required"> ; position: VUnion<null | { value: string ; space: string }, [VObject<{ value: string ; space: string }, { space: VString<string, "required"> ; value: VString<string, "required"> }, "required", "value" | "space">, VNull<null, "required">], "required", "value" | "space"> }, "required", "position" | "captureId" | "position.value" | "position.space">, VNull<null, "required">], "required", "position" | "captureId" | "position.value" | "position.space"> }, "required", "sourceId" | "scope" | "publicationId" | "checkpoint" | "epoch" | "checkpoint.position" | "checkpoint.captureId" | "checkpoint.position.value" | "checkpoint.position.space">, VNull<null, "required">], "required", "sourceId" | "scope" | "publicationId" | "checkpoint" | "epoch" | "checkpoint.position" | "checkpoint.captureId" | "checkpoint.position.value" | "checkpoint.position.space"> ; populationCovered: VBoolean<boolean, "required"> ; populationObservedFrom: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> ; observedFrom: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> ; observedTo: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> ; recordObservedFrom: VFloat64<undefined | number, "optional"> ; recordObservedTo: VFloat64<undefined | number, "optional"> ; continuityLost: VBoolean<boolean, "required"> ; historyInterrupted: VBoolean<boolean, "required"> ; erased: VBoolean<boolean, "required"> ; dataset: VObject<undefined | { component: null | string ; dataset: null | string ; version: null | string ; revision: null | string ; publicationId: null | SourcePublicationId ; coherent: boolean ; completeVersion: boolean }, { component: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; dataset: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; version: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; revision: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; publicationId: VUnion<null | SourcePublicationId, [VString<SourcePublicationId, "required">, VNull<null, "required">], "required", never> ; coherent: VBoolean<boolean, "required"> ; completeVersion: VBoolean<boolean, "required"> }, "optional", "component" | "dataset" | "version" | "revision" | "publicationId" | "coherent" | "completeVersion"> ; capabilities: VUnion<null | { evidence: "native" | "asserted" | "brokered" ; consistency: "snapshot" | "observations" ; coverage: "records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey" ; reconciliation: boolean ; history: "observations" | "completeChanges" | "completeOccurrences" | "latestState" ; protocol: "dataset" | "changeFeed" | "recordObservation" | "transactionalFeed" | "streamLatest" ; atomicity: "record" | "snapshot" | "sourceTransaction" ; recordRefresh: boolean ; notifications: boolean ; snapshotMaxRows: null | string }, [VObject<{ evidence: "native" | "asserted" | "brokered" ; consistency: "snapshot" | "observations" ; coverage: "records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey" ; reconciliation: boolean ; history: "observations" | "completeChanges" | "completeOccurrences" | "latestState" ; protocol: "dataset" | "changeFeed" | "recordObservation" | "transactionalFeed" | "streamLatest" ; atomicity: "record" | "snapshot" | "sourceTransaction" ; recordRefresh: boolean ; notifications: boolean ; snapshotMaxRows: null | string }, { consistency: VUnion<"snapshot" | "observations", [VLiteral<"observations", "required">, VLiteral<"snapshot", "required">], "required", never> = validatorSourceConsistency; evidence: VUnion<"native" | "asserted" | "brokered", [VLiteral<"native", "required">, VLiteral<"brokered", "required">, VLiteral<"asserted", "required">], "required", never> = validatorEvidenceClass; recordRefresh: VBoolean<boolean, "required"> ; reconciliation: VBoolean<boolean, "required"> ; notifications: VBoolean<boolean, "required"> ; snapshotMaxRows: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; protocol: Validator<"dataset" | "changeFeed" | "recordObservation" | "transactionalFeed" | "streamLatest", "required", any> ; coverage: Validator<"records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey", "required", any> ; atomicity: Validator<"record" | "snapshot" | "sourceTransaction", "required", any> ; history: Validator<"observations" | "completeChanges" | "completeOccurrences" | "latestState", "required", any> }, "required", "evidence" | "consistency" | "coverage" | "reconciliation" | "history" | "protocol" | "atomicity" | "recordRefresh" | "notifications" | "snapshotMaxRows" | `coverage.\{any}\` \| \`history.{any}` | `protocol.\{any}\` \| \`atomicity.{any}`>, VNull<null, "required">], "required", "evidence" | "consistency" | "coverage" | "reconciliation" | "history" | "protocol" | "atomicity" | "recordRefresh" | "notifications" | "snapshotMaxRows" | `coverage.\{any}\` \| \`history.{any}` | `protocol.\{any}\` \| \`atomicity.{any}`> ; population: VUnion<null | "records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey", [Validator<"records" | "enumeration" | "snapshot" | "queryResult" | "incrementalSnapshot" | "committedPrefix" | "latestPerKey", "required", any>, VNull<null, "required">], "required", any> }, "required", "dataset" | "capabilities" | "population" | "erased" | "publication" | "populationCovered" | "populationObservedFrom" | "observedFrom" | "observedTo" | "continuityLost" | "historyInterrupted" | "recordObservedFrom" | "recordObservedTo" | "capabilities.evidence" | "capabilities.consistency" | "capabilities.coverage" | "capabilities.reconciliation" | "capabilities.history" | "capabilities.protocol" | "capabilities.atomicity" | "capabilities.recordRefresh" | "capabilities.notifications" | "capabilities.snapshotMaxRows" | "dataset.component" | "dataset.dataset" | "dataset.version" | "dataset.revision" | "dataset.publicationId" | "dataset.coherent" | "dataset.completeVersion" | "publication.sourceId" | "publication.scope" | "publication.publicationId" | "publication.checkpoint" | "publication.epoch" | "publication.checkpoint.position" | "publication.checkpoint.captureId" | "publication.checkpoint.position.value" | "publication.checkpoint.position.space" | `capabilities.coverage.\{any}\` \| \`capabilities.history.{any}` | `capabilities.protocol.\{any}\` \| \`capabilities.atomicity.{any}` | `population.\{any}\`\> ; `controls`: [`VObject`](/api/classes/values.VObject)\<\{ `pauseId`: `undefined` \| [`PauseId`](/api/modules/values#pauseid) ; `canRefresh`: `boolean` \}, \{ `canRefresh`: [`VBoolean`](/api/classes/values.VBoolean)\<`boolean`, ``"required"``\> ; `pauseId`: [`VString`](/api/classes/values.VString)\<`undefined` \| [`PauseId`](/api/modules/values#pauseid), ``"optional"``\> \}, ``"required"``, ``"pauseId"`` \| ``"canRefresh"``\> ; `sync`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| \{ `status`: ``"blocked"`` \| ``"scheduled"`` \| ``"running"`` \| ``"retrying"`` \| ``"paused"`` ; `cause`: ``null`` \| ``"throttled"`` \| ``"accessRefused"`` \| ``"credentialRejected"`` \| ``"credentialExpired"`` \| ``"scopeMissing"`` \| ``"signatureRejected"`` \| ``"credentialInvalid"`` \| ``"connectionRequired"`` \| ``"revocationPending"`` \| ``"providerDisabled"`` \| ``"connectionForbidden"`` \| ``"addressRefused"`` \| ``"providerUnavailable"`` \| ``"engineBusy"`` \| ``"unexpectedStatus"`` \| ``"responseInvalid"`` \| ``"resultInvalid"`` \| ``"reinstallRequired"`` \| ``"definitionChanged"`` \| ``"migrationRequired"`` \| ``"historyLost"`` \| ``"sourceUnsupported"`` \| ``"readRuleRequired"`` \| ``"boundExceeded"`` \| ``"sourceDisabled"`` \| ``"inspectionOnly"`` \| ``"gatewayMismatch"`` \| ``"workFenced"`` \| ``"datasetErasing"`` \| ``"refreshUnsettled"`` \| ``"engineIncompatible"`` \| ``"engineError"`` \}, [[`VObject`](/api/classes/values.VObject)\<\{ `status`: ``"blocked"`` \| ``"scheduled"`` \| ``"running"`` \| ``"retrying"`` \| ``"paused"`` ; `cause`: ``null`` \| ``"throttled"`` \| ``"accessRefused"`` \| ``"credentialRejected"`` \| ``"credentialExpired"`` \| ``"scopeMissing"`` \| ``"signatureRejected"`` \| ``"credentialInvalid"`` \| ``"connectionRequired"`` \| ``"revocationPending"`` \| ``"providerDisabled"`` \| ``"connectionForbidden"`` \| ``"addressRefused"`` \| ``"providerUnavailable"`` \| ``"engineBusy"`` \| ``"unexpectedStatus"`` \| ``"responseInvalid"`` \| ``"resultInvalid"`` \| ``"reinstallRequired"`` \| ``"definitionChanged"`` \| ``"migrationRequired"`` \| ``"historyLost"`` \| ``"sourceUnsupported"`` \| ``"readRuleRequired"`` \| ``"boundExceeded"`` \| ``"sourceDisabled"`` \| ``"inspectionOnly"`` \| ``"gatewayMismatch"`` \| ``"workFenced"`` \| ``"datasetErasing"`` \| ``"refreshUnsettled"`` \| ``"engineIncompatible"`` \| ``"engineError"`` \}, \{ `status`: [`VUnion`](/api/classes/values.VUnion)\<``"blocked"`` \| ``"scheduled"`` \| ``"running"`` \| ``"retrying"`` \| ``"paused"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"scheduled"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"running"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"retrying"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"blocked"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"paused"``, ``"required"``\>], ``"required"``, `never`\> = validatorSourceSyncStatus; `cause`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| ``"throttled"`` \| ``"accessRefused"`` \| ``"credentialRejected"`` \| ``"credentialExpired"`` \| ``"scopeMissing"`` \| ``"signatureRejected"`` \| ``"credentialInvalid"`` \| ``"connectionRequired"`` \| ``"revocationPending"`` \| ``"providerDisabled"`` \| ``"connectionForbidden"`` \| ``"addressRefused"`` \| ``"providerUnavailable"`` \| ``"engineBusy"`` \| ``"unexpectedStatus"`` \| ``"responseInvalid"`` \| ``"resultInvalid"`` \| ``"reinstallRequired"`` \| ``"definitionChanged"`` \| ``"migrationRequired"`` \| ``"historyLost"`` \| ``"sourceUnsupported"`` \| ``"readRuleRequired"`` \| ``"boundExceeded"`` \| ``"sourceDisabled"`` \| ``"inspectionOnly"`` \| ``"gatewayMismatch"`` \| ``"workFenced"`` \| ``"datasetErasing"`` \| ``"refreshUnsettled"`` \| ``"engineIncompatible"`` \| ``"engineError"``, [[`Validator`](/api/modules/values#validator)\<``"throttled"`` \| ``"accessRefused"`` \| ``"credentialRejected"`` \| ``"credentialExpired"`` \| ``"scopeMissing"`` \| ``"signatureRejected"`` \| ``"credentialInvalid"`` \| ``"connectionRequired"`` \| ``"revocationPending"`` \| ``"providerDisabled"`` \| ``"connectionForbidden"`` \| ``"addressRefused"`` \| ``"providerUnavailable"`` \| ``"engineBusy"`` \| ``"unexpectedStatus"`` \| ``"responseInvalid"`` \| ``"resultInvalid"`` \| ``"reinstallRequired"`` \| ``"definitionChanged"`` \| ``"migrationRequired"`` \| ``"historyLost"`` \| ``"sourceUnsupported"`` \| ``"readRuleRequired"`` \| ``"boundExceeded"`` \| ``"sourceDisabled"`` \| ``"inspectionOnly"`` \| ``"gatewayMismatch"`` \| ``"workFenced"`` \| ``"datasetErasing"`` \| ``"refreshUnsettled"`` \| ``"engineIncompatible"`` \| ``"engineError"``, ``"required"``, `any`\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"required"``, `any`\> \}, ``"required"``, ``"status"`` \| ``"cause"`` \| \`cause.{any}`>, VNull<null, "required">], "required", "status" | "cause" | `cause.\{any}\`\> \}, ``"required"``, ``"sourceId"`` \| ``"evidence"`` \| ``"assessment"`` \| ``"controls"`` \| ``"sync"`` \| ``"evidence.dataset"`` \| ``"evidence.capabilities"`` \| ``"evidence.population"`` \| ``"evidence.erased"`` \| ``"evidence.publication"`` \| ``"evidence.populationCovered"`` \| ``"evidence.populationObservedFrom"`` \| ``"evidence.observedFrom"`` \| ``"evidence.observedTo"`` \| ``"evidence.continuityLost"`` \| ``"evidence.historyInterrupted"`` \| ``"evidence.recordObservedFrom"`` \| ``"evidence.recordObservedTo"`` \| ``"evidence.capabilities.evidence"`` \| ``"evidence.capabilities.consistency"`` \| ``"evidence.capabilities.coverage"`` \| ``"evidence.capabilities.reconciliation"`` \| ``"evidence.capabilities.history"`` \| ``"evidence.capabilities.protocol"`` \| ``"evidence.capabilities.atomicity"`` \| ``"evidence.capabilities.recordRefresh"`` \| ``"evidence.capabilities.notifications"`` \| ``"evidence.capabilities.snapshotMaxRows"`` \| ``"evidence.dataset.component"`` \| ``"evidence.dataset.dataset"`` \| ``"evidence.dataset.version"`` \| ``"evidence.dataset.revision"`` \| ``"evidence.dataset.publicationId"`` \| ``"evidence.dataset.coherent"`` \| ``"evidence.dataset.completeVersion"`` \| ``"evidence.publication.sourceId"`` \| ``"evidence.publication.scope"`` \| ``"evidence.publication.publicationId"`` \| ``"evidence.publication.checkpoint"`` \| ``"evidence.publication.epoch"`` \| ``"evidence.publication.checkpoint.position"`` \| ``"evidence.publication.checkpoint.captureId"`` \| ``"evidence.publication.checkpoint.position.value"`` \| ``"evidence.publication.checkpoint.position.space"`` \| ``"assessment.kind"`` \| ``"assessment.code"`` \| ``"assessment.next"`` \| ``"controls.pauseId"`` \| ``"controls.canRefresh"`` \| ``"sync.status"`` \| ``"sync.cause"`` \| \`evidence.capabilities.coverage.{any}` | `evidence.capabilities.history.\{any}\` \| \`evidence.capabilities.protocol.{any}` | `evidence.capabilities.atomicity.\{any}\` \| \`evidence.population.{any}` | `sync.cause.${any}`>
sourceUnsupportedCodes
•Const sourceUnsupportedCodes: readonly ("SourceCoherenceUnsupported" | "SourcePopulationUnsupported" | "SourceCompleteVersionNotDataset" | "SourceContinuityUnsupported" | "SourceRequirementUnsupported" | "SourceEvidenceClassUnsupported")[]
Codes for a requirement the source contract cannot establish; another
refresh cannot change them. Mirrors ReadRefusal::unsupported in
crates/common/src/schemas/source/read.rs.
sourceMissingEvidenceCodes
•Const sourceMissingEvidenceCodes: readonly ("ReadServingVersionUnavailable" | "SourceCoherenceUnavailable" | "SourcePopulationCapabilityUnavailable" | "SourcePopulationUnavailable" | "SourceCompleteVersionUnavailable" | "SourceContinuityUnavailable" | "SourceObservationCoverageRequired" | "SourceObservationUnavailable" | "SourceObservationStale" | "SourceObservationBeforeBarrier" | "FreshnessUnavailable" | "FreshnessExpired")[]
Codes for evidence the source does not currently hold. Mirrors every other
ReadRefusal in crates/common/src/schemas/source/read.rs.
sourceRefreshRequestValidator
•Const sourceRefreshRequestValidator: VObject<{ kind: "sourceRefresh" ; sourceId: SourceId ; requestId: RequestId ; outcome: "requested" | "joined" ; recoverUntil: number }, { kind: VLiteral<"sourceRefresh", "required"> ; requestId: VIdentity<RequestId, "requestId", "required"> ; sourceId: VIdentity<SourceId, "sourceId", "required"> ; outcome: VUnion<"requested" | "joined", [VLiteral<"requested", "required">, VLiteral<"joined", "required">], "required", never> ; recoverUntil: VFloat64<number, "required"> }, "required", "kind" | "sourceId" | "requestId" | "outcome" | "recoverUntil">
Immutable acceptance. Progress never changes this request or its original source.
sourceRefreshObservationValidator
•Const sourceRefreshObservationValidator: VUnion<{ reason: null ; request: { kind: “sourceRefresh”; sourceId: SourceId; requestId: RequestId; outcome: “requested” | “joined”; recoverUntil: number; } ; publicationId: null | SourcePublicationId ; phase: "completed" | "pending" } | { reason: SourceRequestIssue ; request: { kind: “sourceRefresh”; sourceId: SourceId; requestId: RequestId; outcome: “requested” | “joined”; recoverUntil: number; } ; publicationId: null | SourcePublicationId ; phase: "unavailable" | "blocked" }, (VObject<{ reason: null ; request: { kind: “sourceRefresh”; sourceId: SourceId; requestId: RequestId; outcome: “requested” | “joined”; recoverUntil: number; } ; publicationId: null | SourcePublicationId ; phase: "completed" | "pending" }, { request: VObject<{ kind: "sourceRefresh" ; sourceId: SourceId ; requestId: RequestId ; outcome: "requested" | "joined" ; recoverUntil: number }, { kind: VLiteral<"sourceRefresh", "required"> ; requestId: VIdentity<RequestId, "requestId", "required"> ; sourceId: VIdentity<SourceId, "sourceId", "required"> ; outcome: VUnion<"requested" | "joined", [VLiteral<"requested", "required">, VLiteral<"joined", "required">], "required", never> ; recoverUntil: VFloat64<number, "required"> }, "required", "kind" | "sourceId" | "requestId" | "outcome" | "recoverUntil"> = sourceRefreshRequestValidator; phase: VLiteral<"completed" | "pending", "required"> ; publicationId: VUnion<null | SourcePublicationId, [VString<SourcePublicationId, "required">, VNull<null, "required">], "required", never> ; reason: VNull<null, "required"> }, "required", "reason" | "request" | "publicationId" | "phase" | "request.kind" | "request.sourceId" | "request.requestId" | "request.outcome" | "request.recoverUntil"> | VObject<{ reason: SourceRequestIssue ; request: { kind: “sourceRefresh”; sourceId: SourceId; requestId: RequestId; outcome: “requested” | “joined”; recoverUntil: number; } ; publicationId: null | SourcePublicationId ; phase: "unavailable" | "blocked" }, { request: VObject<{ kind: "sourceRefresh" ; sourceId: SourceId ; requestId: RequestId ; outcome: "requested" | "joined" ; recoverUntil: number }, { kind: VLiteral<"sourceRefresh", "required"> ; requestId: VIdentity<RequestId, "requestId", "required"> ; sourceId: VIdentity<SourceId, "sourceId", "required"> ; outcome: VUnion<"requested" | "joined", [VLiteral<"requested", "required">, VLiteral<"joined", "required">], "required", never> ; recoverUntil: VFloat64<number, "required"> }, "required", "kind" | "sourceId" | "requestId" | "outcome" | "recoverUntil"> = sourceRefreshRequestValidator; phase: VLiteral<"unavailable" | "blocked", "required"> ; publicationId: VUnion<null | SourcePublicationId, [VString<SourcePublicationId, "required">, VNull<null, "required">], "required", never> ; reason: Validator<SourceRequestIssue, "required", any> = sourceRequestIssueValidator }, "required", "reason" | "request" | "publicationId" | "phase" | "request.kind" | "request.sourceId" | "request.requestId" | "request.outcome" | "request.recoverUntil" | `reason.\{any}\`\>)[], ``"required"``, ``"reason"`` \| ``"request"`` \| ``"publicationId"`` \| ``"phase"`` \| ``"request.kind"`` \| ``"request.sourceId"`` \| ``"request.requestId"`` \| ``"request.outcome"`` \| ``"request.recoverUntil"`` \| \`reason.{any}`>
syncedTableSource
•Const syncedTableSource: typeof syncedTableSource
Component-owned source adapters reuse native table owners.
resultErrorCodes
•Const resultErrorCodes: ["invalid_reply", "result_not_current", "outcome_unknown", "authority_changed", "invalid_argument", "invalid_binding", "result_unavailable", "request_unavailable", "request_expired", "result_mismatch", "result_cancelled", "pushdown_refused", "placement_unsupported", "recovery_unsupported", "contract_refused", "cardinality_exceeded", "arithmetic_error", "resource_limit_exceeded", "local_evaluation_limit", "spill_failed", "result_limit_exceeded", "source_outcome_unknown", "request_mismatch", "result_expired", "request_closed", "result_not_ready", "result_not_current", "capacity_exceeded", "access_denied", "access_changed", "definition_changed", "cursor_mismatch", "source_failed", "source_format_mismatch", "invalid_definition", "schema_mismatch", "source_freshness_unavailable", "input_basis_unavailable", "provider_error"]
Not exported: an exported type refers to it.
RESULT_RETAINED_LIMITS
•Const RESULT_RETAINED_LIMITS: Readonly<{ max_rows: 10000000 = 10000000; max_bytes: 10737418240 = 10737418240 }> = QUERY_LIMITS.retained
Maximum complete retained result. Pages and one-shot replies keep their
smaller independent bounds; encoded kept files are bounded separately.
Functions
defineConnection
▸ defineConnection(options): HttpConnectionRef
Portable connection requirement. The deployment variable selects an
admitted immutable connection, never a URL or credential. This grants no
authority. Retained invocations capture the original connection identity.
Parameters
Returns
HttpConnectionRef
connectionAccountStatus
▸ connectionAccountStatus(account): Promise<ConnectionStatus | null>
Read the account in this executing component under the current caller. No
supplied component or actor can retarget its authority.
Parameters
Returns
Promise<ConnectionStatus | null>
browser
▸ browser<I, R>(contract, run): BrowserImplementation<I, R>
Run an async callback in the retained integration isolate. Native custody
performs each admitted browser command and the declared final capture.
Type parameters
Parameters
Returns
BrowserImplementation<I, R>
defineBrowserResource
▸ defineBrowserResource<S, C>(options): BrowserResourceReference<ObjectType<S>, C>
A component supplies infrastructure lifecycle through ordinary generated references.
The native binder configures its private provider resource. Installing it allocates nothing.
confinement states what the provider’s isolation actually enforces. A
binding accepts an unenforced capability only by declaring it.
Type parameters
Parameters
Returns
BrowserResourceReference<ObjectType<S>, C>
capturedVirtualTableTargets
▸ capturedVirtualTableTargets<Fields, Engine, Target>(schema, captures, engine): Object
An environment mapping requires an explicit selection before it is a source.
Type parameters
Parameters
Returns
Object
connectedMcpExchange
▸ connectedMcpExchange(integration, input): Promise<ConnectedMcpResponse>
One exchange with the MCP server an account integration connects to, in
an action, as its caller and with the caller’s connected account. Native
custody holds the server’s address and the account’s credential and
checks the account’s current use authority; neither the address nor the
credential enters the action. A refused account answers the same
connection requirement ctx.connections.require does.
Parameters
Returns
Promise<ConnectedMcpResponse>
setupPattern
▸ setupPattern(pattern): RegExp
Compile a declared pattern the one way both sides compile it: anchored
whole, never partially matched.
Parameters
Returns
RegExp
checkSetupValue
▸ checkSetupValue(field, value): SetupRefusal | undefined
Check one supplied value against one field. undefined is admitted.
The same rules the backend applies, in the same order, so a form that says
“that is not a subdomain” and a server that refuses the request are saying
the same thing. It never decides anything: the backend re-checks every value
it is given.
Parameters
Returns
SetupRefusal | undefined
renderSetupBaseUrl
▸ renderSetupBaseUrl(field, value): string
The address a base_url field renders.
Parameters
Returns
string
describeSetupRefusal
▸ describeSetupRefusal(refusal): string
Say why a value was refused, in one line, for a form or a prompt.
Parameters
Returns
string
setupFieldsToAsk
▸ setupFieldsToAsk(requirements): SetupRequirement[]
The fields a person still has to answer, in declaration order.
Secrets are not among them: they are provisioned through the credential
path, and a form that rendered an input for one would be inviting a secret
into a request that has no business carrying it. An already configured
administrator field is not among them either — that is the whole point of
the configured flag.
Parameters
Returns
SetupRequirement[]
accountSetupFields
▸ accountSetupFields(requirements): SetupRequirement[]
The fields a CONNECTING ACCOUNT answers, in declaration order.
An account connecting its own installation answers what its own installation
decides — its instance, its region, its workspace — and nothing about the
deployment. An administrator field is deployment configuration: the person
consenting has no way to know it, the deployment already states it, and the
backend refuses it from this direction by name. Filtering it out here is what
keeps a consent screen from asking a customer to configure somebody else’s
deployment; the backend still decides.
Parameters
Returns
SetupRequirement[]
connectionSetupSchema
▸ connectionSetupSchema<T>(transport): NativeSetupFor<T>
The admitted setting shape of a native transport; this supplies no credentials.
Type parameters
Parameters
Returns
NativeSetupFor<T>
datasetSourceCollection
▸ datasetSourceCollection<S, Scope, Contract>(table): Object
The dataset compiler consumes the same collection and policy as a synced
table. This descriptor names a source; it does not install or acquire it.
Type parameters
Parameters
Returns
Object
isResourceTable
▸ isResourceTable(value): value is ResourceTable<Record<string, GenericValidator>, Object, any>
Parameters
Returns
value is ResourceTable<Record<string, GenericValidator>, Object, any>defineSyncedTable
▸ defineSyncedTable<Row>(definition): PublishedDefinition<Row>
Declare a native representation maintained by its one source owner.
Imports start no work and confer no authority.
Type parameters
Parameters
Returns
PublishedDefinition<Row>
▸ defineSyncedTable<S>(definition): SourceTableDefinition<S, {}>
Type parameters
Parameters
Returns
SourceTableDefinition<S, {}>
defineProviderJourneys
▸ defineProviderJourneys(input): Object
Execute installed fixture owners, record their native source identities,
and run the cleanup owner on every exit. No endpoint accepts reported test
results or caller-selected provenance. Hosted qualification belongs to Atlas;
controlled and emulator diagnostics cannot claim live-provider evidence.
Fixture setup and cleanup must be idempotent on runId, including interrupted
setup; each case must use only that run’s isolated resources.
Parameters
Returns
Object
providerTransportFunctions
▸ providerTransportFunctions(options?): Object
Export these internal functions from an application module and bind
their generated references to the provider delivery component. Each call
derives authority from the actual retained component record or Worker;
the delivery argument is correlation only.
Parameters
Returns
Object
recordSource
▸ recordSource<S, Contract>(observation, input): ResourceTable<S, {}, Contract>
Declare one producer-owned record collection independently of storage.
Feed it to defineTable for operational rows and/or defineDataset for
direct lake publication. Both consume this exact source identity; each
storage owner retains its own publication receipts and current permissions.
The declaration itself installs no native serving table.
Type parameters
Parameters
Returns
ResourceTable<S, {}, Contract>
materialize
▸ materialize<S, Contract>(observation, input?): SourceTableDefinition<SourceHandle<S, {}, Contract>, {}>
Type parameters
Parameters
Returns
SourceTableDefinition<SourceHandle<S, {}, Contract>, {}>
latest
▸ latest<S, Contract>(observation, input): SourceTableDefinition<SourceHandle<S, {}, Contract>>
Type parameters
Parameters
Returns
SourceTableDefinition<SourceHandle<S, {}, Contract>>
▸ latest<S, Output, Contract>(observation, input): SourceTableDefinition<SourceHandle<Output, {}, Contract>>
Type parameters
Parameters
Returns
SourceTableDefinition<SourceHandle<Output, {}, Contract>>
fold
▸ fold<S, Output, Contract, Key>(observation, input): SourceTableDefinition<SourceHandle<Output, {}, Contract>>
Accumulate accepted occurrences in local capture order. The initial state
starts at this installation’s capture boundary and promises no prior history.
The pure reducer runs for every accepted event, independently of publication.
Type parameters
Parameters
Returns
SourceTableDefinition<SourceHandle<Output, {}, Contract>>
archive
▸ archive<S, Contract>(observation): Readonly<{ kind: "archive" ; observation: ObservationHandle<S, "occurrences", Contract> }>
Type parameters
Parameters
Returns
Readonly<{ kind: "archive" ; observation: ObservationHandle<S, "occurrences", Contract> }>
history
▸ history<S, Contract>(observation, retention?): Readonly<{ kind: "history" ; observation: ObservationHandle<S, "occurrences", Contract> ; retention: Readonly<{ version?: number ; retentionDays?: number }> = selected }>
Type parameters
Parameters
Returns
Readonly<{ kind: "history" ; observation: ObservationHandle<S, "occurrences", Contract> ; retention: Readonly<{ version?: number ; retentionDays?: number }> = selected }>
retainVersions
▸ retainVersions<S, Contract>(observation, input): SourceTableDefinition<SourceHandle<S & { acquired_at: VString<string, "required"> ; expires_at: VString<string, "required"> ; representation: VString<string, "required"> }, {}, Contract>, {}>
Retain each immutable file version its records observation acquires, with
its protected content, for a finite window. Rows add acquired_at,
expires_at and representation; an expired version is removed with its
hold. The resource’s own records and current copy are unaffected.
Type parameters
Parameters
Returns
SourceTableDefinition<SourceHandle<S & { acquired_at: VString<string, "required"> ; expires_at: VString<string, "required"> ; representation: VString<string, "required"> }, {}, Contract>, {}>
current
▸ current<Observations, Snapshot, Changes>(composition, input): SourceTableDefinition<SourceHandle<SchemaOf<Observations[Snapshot]>, {}, ContractOf<Observations[Snapshot]>>>
The current state of a composed resource’s entities: its snapshot part’s
records and every later change from its change part, both ordered by one
required int64 field and identified by one required text field. The newer
of a snapshot record and a change wins; a change whose removed field is
true withdraws its record. A snapshot’s absence never removes a record.
Bind the composition with bindComposition.
Type parameters
Parameters
Returns
SourceTableDefinition<SourceHandle<SchemaOf<Observations[Snapshot]>, {}, ContractOf<Observations[Snapshot]>>>
retainedTable
▸ retainedTable<Storage>(definition): RetainedTableResource<Storage> & RetainedAccessBinding<Storage> & RetainedInterfaceMembership<Storage>
Keep derived values and their source-read obligations in local custody.
by names one to four containers: _id, or top-level fields leading active
ordinary indexes. Derived keys name one container; registered keys are
component-created identities. Native admission remains authoritative.
Type parameters
Parameters
Returns
RetainedTableResource<Storage> & RetainedAccessBinding<Storage> & RetainedInterfaceMembership<Storage>
datasetSourceTable
▸ datasetSourceTable<T>(definition): Object
Component boundary for source-derived datasets; naming never grants read authority.
Type parameters
Parameters
Returns
Object
defineSourceArtifactResultOwner
▸ defineSourceArtifactResultOwner(options): Object
Export the returned installation from an application source module. Native
discovery registers its existing report result namespace. authorize must use the application’s
current source policy and reject an obsolete sourceEpoch. Grant creation also
checks the real admitted record attachment; its serialized locator is no grant.
Parameters
Returns
Object
decodeSource
▸ decodeSource<Name>(name, value): Contracts[Name]
Type parameters
Parameters
Returns
Contracts[Name]
observeSource
▸ observeSource(source, options?): Promise<string | null>
One authorized and fenced native source observation. Provider metadata is
optional so a component’s clock deadline never waits for provider I/O.
Parameters
Returns
Promise<string | null>
sourceObservationFunctions
▸ sourceObservationFunctions(collection): Object
Code-owned source discovery and sampling callbacks for an installed product.
Every source is read under its actual caller’s row authority. Installing these
functions confers no service read or disclosure permission.
Parameters
Returns
Object
connectionTaskEffect
▸ connectionTaskEffect(request): Promise<ConnectionTaskObservation | null>
Parameters
Returns
Promise<ConnectionTaskObservation | null>
sourceReadIssue
▸ sourceReadIssue(error): ReadUnavailable | undefined
A native query refusal. Error text and authorization failures are never
interpreted as source availability.
Parameters
Returns
ReadUnavailable | undefined
readResultValidator
▸ readResultValidator<T>(value): VUnion<Expand<{ [Property in “value”]?: Exclude<Infer<Object[Property]>, undefined> } & { [Property in “kind” | “value”]: Infer<Object[Property]> }> | { kind: "missingEvidence" ; code: "ReadServingVersionUnavailable" | "SourceCoherenceUnavailable" | "SourcePopulationCapabilityUnavailable" | "SourcePopulationUnavailable" | "SourceCompleteVersionUnavailable" | "SourceContinuityUnavailable" | "SourceObservationCoverageRequired" | "SourceObservationUnavailable" | "SourceObservationStale" | "SourceObservationBeforeBarrier" | "FreshnessUnavailable" | "FreshnessExpired" } | { kind: "unsupported" ; code: "SourceCoherenceUnsupported" | "SourcePopulationUnsupported" | "SourceCompleteVersionNotDataset" | "SourceContinuityUnsupported" | "SourceRequirementUnsupported" | "SourceEvidenceClassUnsupported" }, [VObject<Expand<{ [Property in “value”]?: Exclude<Infer<Object[Property]>, undefined> } & { [Property in “kind” | “value”]: Infer<Object[Property]> }>, { kind: VLiteral<"ready", "required"> ; value: T }, "required", "kind" | "value" | `value.\{T["fieldPaths"]}\`\>, [`VObject`](/api/classes/values.VObject)\<\{ `kind`: ``"missingEvidence"`` ; `code`: ``"ReadServingVersionUnavailable"`` \| ``"SourceCoherenceUnavailable"`` \| ``"SourcePopulationCapabilityUnavailable"`` \| ``"SourcePopulationUnavailable"`` \| ``"SourceCompleteVersionUnavailable"`` \| ``"SourceContinuityUnavailable"`` \| ``"SourceObservationCoverageRequired"`` \| ``"SourceObservationUnavailable"`` \| ``"SourceObservationStale"`` \| ``"SourceObservationBeforeBarrier"`` \| ``"FreshnessUnavailable"`` \| ``"FreshnessExpired"`` \}, \{ `kind`: [`VLiteral`](/api/classes/values.VLiteral)\<``"missingEvidence"``, ``"required"``\> ; `code`: [`VUnion`](/api/classes/values.VUnion)\<``"ReadServingVersionUnavailable"`` \| ``"SourceCoherenceUnavailable"`` \| ``"SourcePopulationCapabilityUnavailable"`` \| ``"SourcePopulationUnavailable"`` \| ``"SourceCompleteVersionUnavailable"`` \| ``"SourceContinuityUnavailable"`` \| ``"SourceObservationCoverageRequired"`` \| ``"SourceObservationUnavailable"`` \| ``"SourceObservationStale"`` \| ``"SourceObservationBeforeBarrier"`` \| ``"FreshnessUnavailable"`` \| ``"FreshnessExpired"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"ReadServingVersionUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCoherenceUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourcePopulationCapabilityUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourcePopulationUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCompleteVersionUnavailable"``, ``"required"``\>], ``"required"``, `never`\> = readCodeValidators.SourceMissingEvidenceCode \}, ``"required"``, ``"kind"`` \| ``"code"``\>, [`VObject`](/api/classes/values.VObject)\<\{ `kind`: ``"unsupported"`` ; `code`: ``"SourceCoherenceUnsupported"`` \| ``"SourcePopulationUnsupported"`` \| ``"SourceCompleteVersionNotDataset"`` \| ``"SourceContinuityUnsupported"`` \| ``"SourceRequirementUnsupported"`` \| ``"SourceEvidenceClassUnsupported"`` \}, \{ `kind`: [`VLiteral`](/api/classes/values.VLiteral)\<``"unsupported"``, ``"required"``\> ; `code`: [`VUnion`](/api/classes/values.VUnion)\<``"SourceCoherenceUnsupported"`` \| ``"SourcePopulationUnsupported"`` \| ``"SourceCompleteVersionNotDataset"`` \| ``"SourceContinuityUnsupported"`` \| ``"SourceRequirementUnsupported"`` \| ``"SourceEvidenceClassUnsupported"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCoherenceUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourcePopulationUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCompleteVersionNotDataset"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceContinuityUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceRequirementUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceEvidenceClassUnsupported"``, ``"required"``\>], ``"required"``, `never`\> = readCodeValidators.SourceUnsupportedCode \}, ``"required"``, ``"kind"`` \| ``"code"``\>], ``"required"``, ``"kind"`` \| ``"value"`` \| ``"code"`` \| \`value.{T[“fieldPaths”]}`>
Validate a function’s ReadResult return, as
paginationResultValidator validates a page.
Type parameters
Parameters
Returns
VUnion<Expand<{ [Property in “value”]?: Exclude<Infer<Object[Property]>, undefined> } & { [Property in “kind” | “value”]: Infer<Object[Property]> }> | { kind: "missingEvidence" ; code: "ReadServingVersionUnavailable" | "SourceCoherenceUnavailable" | "SourcePopulationCapabilityUnavailable" | "SourcePopulationUnavailable" | "SourceCompleteVersionUnavailable" | "SourceContinuityUnavailable" | "SourceObservationCoverageRequired" | "SourceObservationUnavailable" | "SourceObservationStale" | "SourceObservationBeforeBarrier" | "FreshnessUnavailable" | "FreshnessExpired" } | { kind: "unsupported" ; code: "SourceCoherenceUnsupported" | "SourcePopulationUnsupported" | "SourceCompleteVersionNotDataset" | "SourceContinuityUnsupported" | "SourceRequirementUnsupported" | "SourceEvidenceClassUnsupported" }, [VObject<Expand<{ [Property in “value”]?: Exclude<Infer<Object[Property]>, undefined> } & { [Property in “kind” | “value”]: Infer<Object[Property]> }>, { kind: VLiteral<"ready", "required"> ; value: T }, "required", "kind" | "value" | `value.\{T["fieldPaths"]}\`\>, [`VObject`](/api/classes/values.VObject)\<\{ `kind`: ``"missingEvidence"`` ; `code`: ``"ReadServingVersionUnavailable"`` \| ``"SourceCoherenceUnavailable"`` \| ``"SourcePopulationCapabilityUnavailable"`` \| ``"SourcePopulationUnavailable"`` \| ``"SourceCompleteVersionUnavailable"`` \| ``"SourceContinuityUnavailable"`` \| ``"SourceObservationCoverageRequired"`` \| ``"SourceObservationUnavailable"`` \| ``"SourceObservationStale"`` \| ``"SourceObservationBeforeBarrier"`` \| ``"FreshnessUnavailable"`` \| ``"FreshnessExpired"`` \}, \{ `kind`: [`VLiteral`](/api/classes/values.VLiteral)\<``"missingEvidence"``, ``"required"``\> ; `code`: [`VUnion`](/api/classes/values.VUnion)\<``"ReadServingVersionUnavailable"`` \| ``"SourceCoherenceUnavailable"`` \| ``"SourcePopulationCapabilityUnavailable"`` \| ``"SourcePopulationUnavailable"`` \| ``"SourceCompleteVersionUnavailable"`` \| ``"SourceContinuityUnavailable"`` \| ``"SourceObservationCoverageRequired"`` \| ``"SourceObservationUnavailable"`` \| ``"SourceObservationStale"`` \| ``"SourceObservationBeforeBarrier"`` \| ``"FreshnessUnavailable"`` \| ``"FreshnessExpired"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"ReadServingVersionUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCoherenceUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourcePopulationCapabilityUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourcePopulationUnavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCompleteVersionUnavailable"``, ``"required"``\>], ``"required"``, `never`\> = readCodeValidators.SourceMissingEvidenceCode \}, ``"required"``, ``"kind"`` \| ``"code"``\>, [`VObject`](/api/classes/values.VObject)\<\{ `kind`: ``"unsupported"`` ; `code`: ``"SourceCoherenceUnsupported"`` \| ``"SourcePopulationUnsupported"`` \| ``"SourceCompleteVersionNotDataset"`` \| ``"SourceContinuityUnsupported"`` \| ``"SourceRequirementUnsupported"`` \| ``"SourceEvidenceClassUnsupported"`` \}, \{ `kind`: [`VLiteral`](/api/classes/values.VLiteral)\<``"unsupported"``, ``"required"``\> ; `code`: [`VUnion`](/api/classes/values.VUnion)\<``"SourceCoherenceUnsupported"`` \| ``"SourcePopulationUnsupported"`` \| ``"SourceCompleteVersionNotDataset"`` \| ``"SourceContinuityUnsupported"`` \| ``"SourceRequirementUnsupported"`` \| ``"SourceEvidenceClassUnsupported"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCoherenceUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourcePopulationUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceCompleteVersionNotDataset"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceContinuityUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceRequirementUnsupported"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"SourceEvidenceClassUnsupported"``, ``"required"``\>], ``"required"``, `never`\> = readCodeValidators.SourceUnsupportedCode \}, ``"required"``, ``"kind"`` \| ``"code"``\>], ``"required"``, ``"kind"`` \| ``"value"`` \| ``"code"`` \| \`value.{T[“fieldPaths”]}`>
sourceRequestIssueMessage
▸ sourceRequestIssueMessage(issue): string
Presentation for one retained refresh’s diagnosis. Controls still recheck
current authority and availability in the mutation.
Parameters
Returns
string
acquireSourceSnapshot
▸ acquireSourceSnapshot(scope, key, reader): Promise<string>
The native lease owns bounded history. A changed component definition
expires enumeration rather than interpreting the cut with new code.
Parameters
Returns
Promise<string>
selectSourceSnapshot
▸ selectSourceSnapshot(scope, cut): Promise<string | null>
Parameters
Returns
Promise<string | null>
sourceSnapshotStatus
▸ sourceSnapshotStatus(scope, cut): Promise<{ expiresAt: number } | null>
The original native deadline, including recovery of an existing request
key. Inspection never renews a hold or selects a historical read basis.
Parameters
Returns
Promise<{ expiresAt: number } | null>
releaseSourceSnapshot
▸ releaseSourceSnapshot(scope, cut): Promise<void>
Parameters
Returns
Promise<void>
acceptReaderAuthority
▸ acceptReaderAuthority(options): Promise<ReaderAuthority>
Accept the authenticated caller’s own authority for one installed snapshot
reader query of this installation, with exactly inputs, until
expiresAtMs and while the record this mutation names exists.
Call it from the recipient’s own mutation; the recipient is the caller.
Workers, services, administrators and previews cannot accept. Deleting
record revokes it, and every page rechecks the recipient’s current
authentication, delegation and source policy. It is never a login and
authorizes no mutation.
Parameters
Returns
Promise<ReaderAuthority>
acceptSourceSnapshotWork
▸ acceptSourceSnapshotWork(options): Promise<ReaderAuthority>
Explicit finite consent for snapshot publication work. Unlike the read-only
recipient authority, this permits only captured protected files, the exact
receiving mutations, one format and keys under the accepted prefix. Native
admission requires the actual live person or service and fences its record,
code, source policies, cut and deadline on every page and consumption.
Parameters
Returns
Promise<ReaderAuthority>
readRecipientPage
▸ readRecipientPage(authority, cut, cursor): Promise<{ kind: "observation" ; token: string } | { kind: "expired" }>
In an action: run one page of the accepted reader under its recipient at
the cut’s leased snapshot. The reader receives { inputs, cut, cursor }
with the accepted inputs, and must return a sealed snapshotLeases
observation of that cut’s lease, or null once selectSourceSnapshot
reports the snapshot gone. Only that seal returns; consume it in this
installation’s mutation. Explicit snapshot work consent additionally returns
its native exact-file custody permit; ordinary reader authority grants none.
A guest error inside the reader is refused
without its message.
Parameters
Returns
Promise<{ kind: "observation" ; token: string } | { kind: "expired" }>
unwrapResultResponse
▸ unwrapResultResponse<Result>(response): Result
Return the complete value or throw a refusal with its stable code.
Type parameters
Parameters
Returns
Result
defineVirtualTable
▸ defineVirtualTable<Row>(definition): VirtualTableDefinition<Row>
Type parameters
Parameters
Returns
VirtualTableDefinition<Row>
▸ defineVirtualTable<Source>(definition): VirtualTableDefinition<ObjectType<Source["schema"]>>
Type parameters
Parameters
Returns
VirtualTableDefinition<ObjectType<Source["schema"]>>
▸ defineVirtualTable<Fields>(definition): VirtualTableDefinition<ObjectType<Fields>>
Type parameters
Parameters
Returns
VirtualTableDefinition<ObjectType<Fields>>
▸ defineVirtualTable<Fields>(definition): VirtualTableDefinition<ObjectType<Fields>>
Type parameters
Parameters
Returns
VirtualTableDefinition<ObjectType<Fields>>