Interfaces
- AccessDescription
- GenericAccessDefinition
- AccessResource
- AccessBindingOwner
- AccessExpression
- AccessArrayExpression
- AccessContributionDefinition
- AccessContribution
- RequirementIndexRange
- AccessProtection
- RequestOperations
- AuthorizationIndexOptions
- AllowancesReader
- AllowancesWriter
References
bothAccessResults
Renames and re-exports __typeservicePrincipal
Renames and re-exports __typeAccessInspection
Re-exports AccessInspectionAccessInspectionBasis
Re-exports AccessInspectionBasisAccessRecoveryOffer
Re-exports AccessRecoveryOfferAccessTrace
Re-exports AccessTraceDisclosureArgs
Re-exports DisclosureArgsExecutionDescriptor
Re-exports ExecutionDescriptorReadAccessArgs
Re-exports ReadAccessArgsType Aliases
RetainedPermission
Ƭ RetainedPermission:Object
Readonly evidence of an actual verified decision subject. The opaque value
is bound to one model, resource check and application request. It cannot be
used as a login, delegation, or permission to perform a mutation.
Type declaration
AccessReadExecution
Ƭ AccessReadExecution: {kind: "key" } | { kind: "unbound" } | { kind: "native" ; ranges: { index: string ; field: string ; labels?: string }[] }
Not exported: an exported type refers to it.
AccessInstallation
Ƭ AccessInstallation:Object
Not exported: an exported type refers to it.
Type declaration
AssignmentListing
Ƭ AssignmentListing:Readonly<{ resourceType: string ; includeGroups: boolean ; index: "by_resource" ; order: "asc" | "desc" ; execution: "indexFilter" }>
AccessResourceDefinition
Ƭ AccessResourceDefinition:Omit<AccessTypeDefinition, "table" | "erasable" | "parent" | "relations" | "read" | "unreadable" | "propertyRestrictions" | "immutable" | "write" | "fieldValidators" | "initialization" | "mutations" | "restrictions" | "integrity" | "conditions" | "resourceSets" | typeof conditionRequiredFields> & { parent?: string ; boundary?: "tenant" ; restrictions?: { root?: { type: string ; category: string } } }
Business meaning, independent of the table storing a resource.
AccessDefinitionInput
Ƭ AccessDefinitionInput:Omit<AccessModelDefinition, "types" | "discoveries" | "observationSources" | "inputValidators" | "confer" | "requirements" | "conditions"> & { resources: Record<string, AccessResourceDefinition> ; assignmentRules?: AccessModelDefinition["confer"] ; requirements?: Record<string, AccessDefinitionRequirement> }
One resource model; physical fields and indexes belong to schema bindings.
AccessDefinitionRequirement
Ƭ AccessDefinitionRequirement:Object
Not exported: an exported type refers to it.
Type declaration
AccessResourceBinding
Ƭ AccessResourceBinding<Field, Permission, Document, Definition, Target, SourceOwned>: Omit<BoundAccessResourceBinding<Field, Permission, Document, Definition, Target>, "read" | "write" | "unreadable" | "immutable" | "propertyRestrictions" | "fieldValidators" | "initialization" | "mutations" | SourceOwned extends true ? "transitions" | "integrity" : never> & { document: { read: AccessReadRequirement<Permission, Field, keyof Definition["resources"] & string> } & SourceOwned extends true ? { create?: never ; delete?: never } : { create: Extract<"create", Permission> | false ; delete: Extract<"delete", Permission> | false } ; fields: AccessFieldProtections<Field, Permission, keyof Definition["resources"] & string, Document, SourceOwned> ; metadata?: { _creationTime?: AccessReadRequirement<Permission, Field, keyof Definition["resources"] & string> | false } } & SourceOwned extends true ? { transitions?: never ; integrity?: never } : unknown
Every field declares read protection. Locally owned tables also declare
creation and update permissions; a source inherently owns those writes.
Type parameters
AccessDocumentBinding
Ƭ AccessDocumentBinding<Field, Permission, Document, Definition, Target, SourceOwned>: Omit<AccessResourceBinding<Field, Permission, Document, Definition, Target, SourceOwned>, "document" | "fields"> & { document?: never ; fields?: AccessFieldExceptions<Field, Permission, keyof Definition["resources"] & string, Document, SourceOwned> }
The short binding: the resource’s read, create, edit and delete
permissions apply to the document, unlisted fields follow it, and fields
names only the exceptions. Everything else a binding declares (its parent,
relations, labels, transitions, integrity, requirements) keeps its meaning.
Declaring document selects the exhaustive AccessResourceBinding.
Type parameters
SourceReadAccessBinding
Ƭ SourceReadAccessBinding<Field, Permission, ParentField>: Object
One read permission over an explicit list of source-owned fields. Every
unlisted field, including one a connector adds later, stays unreadable.
Compiles to the ordinary document and field grants.
Type parameters
Type declaration
PrincipalSourceTable
Ƭ PrincipalSourceTable<Field>: Object
Not exported: an exported type refers to it.
Type parameters
Type declaration
Binding
Ƭ Binding:Object
Not exported: an exported type refers to it.
Type declaration
ClassifiedRead
Ƭ ClassifiedRead<R, Name, Field>: R extends false ? false : { permission: R extends string ? R : R extends { permission: infer P } ? P : never ; restrictions: readonly (R extends { restrictions: readonly infer T[] } ? T : never | { type: Name ; field: Field ; allowed: readonly string[] })[] }
Not exported: an exported type refers to it.
Type parameters
ProfileCondition
Ƭ ProfileCondition: <Resource, Principal, Context>(scope: Parameters<AccessTransitionCondition<Resource, Principal, Context>>[0]) => AccessExpression
Type declaration
▸ <Resource, Principal, Context>(scope): AccessExpression
Not exported: an exported type refers to it.
Type parameters
Parameters
Returns
AccessExpression
ReadPermission
Ƭ ReadPermission<R>: R extends string ? R : R extends { permission: infer P } ? P : never
Not exported: an exported type refers to it.
Type parameters
ProfileReadCondition
Ƭ ProfileReadCondition: <Resource, Principal, Context>(scope: Parameters<AccessCondition<Resource, Principal, Context>>[0]) => AccessExpression
Type declaration
▸ <Resource, Principal, Context>(scope): AccessExpression
Not exported: an exported type refers to it.
Type parameters
Parameters
Returns
AccessExpression
ClassifiedBinding
Ƭ ClassifiedBinding<B, Name, Field>: Omit<B, "document" | "fields" | "metadata" | "labels" | "transitions" | "requirements"> & { document: Omit<B["document"], "read"> & { read: ClassifiedRead<B["document"]["read"], Name, Field> } ; fields: { [K in keyof B[“fields”]]: Omit<B[“fields”][K], “read”> & Object } ; labels: { field: Field ; type: Name } ; metadata?: B["metadata"] extends { _creationTime: infer R } ? { _creationTime: ClassifiedRead<R, Name, Field> } : never ; requirements: B extends { requirements: infer R } ? R : {} & Record<`classification_\{Name}\`, \{ `on`: readonly [[`ReadPermission`](/api/modules/access#readpermission)\<`B`[``"document"``][``"read"``]\>] ; `when`: [`ProfileReadCondition`](/api/modules/access#profilereadcondition) \}\> ; `transitions`: `B` extends \{ `transitions`: infer T \} ? `T` : \{\} & `Record`\<\`classification\_{Name}`, { on: readonly ("create" | "update" | "move")[] ; when: ProfileCondition }> }
Not exported: an exported type refers to it.
Type parameters
ClassificationCategory
Ƭ ClassificationCategory:Object
Not exported: an exported type refers to it.
Type declaration
ClassificationKey
Ƭ ClassificationKey<C>: { [K in keyof C & string]: `\{K}:{C[K][“keys”][number]}` }[keyof C & string]
Not exported: an exported type refers to it.
Type parameters
LabelRegistrySnapshot
Ƭ LabelRegistrySnapshot:Object
The organization’s central label registry as
bijection organization label get --format json prints it. A profile
bound to it compiles exactly these categories; other fields are ignored.
Type declaration
RegistryCategories
Ƭ RegistryCategories<R>: { [K in R[“categories”][number] as K[“name”]]: Object }
Not exported: an exported type refers to it.
Type parameters
RegistryBinding
Ƭ RegistryBinding:Readonly<{ organization: string ; revision: number }>
Not exported: an exported type refers to it.
ClassificationProfile
Ƭ ClassificationProfile<Name, Required, C>: ReturnType<typeof classificationProfile>
A compiled classification profile.
Type parameters
Selection
Ƭ Selection: { readonly [K in keyof C & string]?: readonly C[K][“keys”][number][] } Not exported: an exported type refers to it.Destination
Ƭ Destination:DisclosureArgs["destination"]
Not exported: an exported type refers to it.
ComponentInstallationAccessRequest
Ƭ ComponentInstallationAccessRequest:Object
Not exported: an exported type refers to it.
Type declaration
ComponentWorkerAccessRequest
Ƭ ComponentWorkerAccessRequest<Effects>: Object
Type parameters
Type declaration
ComponentAccessRequest
Ƭ ComponentAccessRequest:ComponentInstallationAccessRequest | ComponentWorkerAccessRequest
ComponentWorkConsentOptions
Ƭ ComponentWorkConsentOptions<Effects>: Object
Type parameters
Type declaration
ComponentDataConsent
Ƭ ComponentDataConsent:Object
The host’s consent to one request, for rows of the from resources.
Type declaration
CompiledComponentBinding
Ƭ CompiledComponentBinding:Object
Not exported: an exported type refers to it.
Type declaration
ComponentWorkBinding
Ƭ ComponentWorkBinding:Omit<ComponentDataConsent, "from">
The host’s consent to one request in a hand-written destination rule, which
decides its own table’s rows.
AccessClaimType
Ƭ AccessClaimType:"String" | "Long" | "Bool" | "Set<String>" | "Set<Long>"
Not exported: an exported type refers to it.
CompiledConferEnvelope
Ƭ CompiledConferEnvelope:Object
Not exported: an exported type refers to it.
Type declaration
AssignmentHolder
Ƭ AssignmentHolder: {holderKind: "person" | "service" ; holderKey: string ; holderType?: never ; holderPermission?: never ; holderProgram?: never } | { holderKind: "group" ; holderKey: string ; holderType: string ; holderPermission: string ; holderProgram?: never } | { holderKind: "program" ; holderKey: string ; holderProgram: ProgramGrantRef ; holderType?: never ; holderPermission?: never }
Not exported: an exported type refers to it.
AssignmentDocument
Ƭ AssignmentDocument:AssignmentHolder & { _id: GenericId<string> ; type: string ; key: string ; role: RoleRef ; expiresAt?: number ; _creationTime?: number ; reason?: string }
AccessCtx
Ƭ AccessCtx:Object
The context a rule or helper needs. Every query context satisfies it.
Type declaration
AccessMutationCtx
Ƭ AccessMutationCtx:Object
The context of the grant mutation helpers.
Type declaration
AccessRefusalReason
Ƭ AccessRefusalReason:"unauthenticated" | "narrowed" | "absent" | "restricted" | "condition" | "requirement" | "evidence_unavailable" | "no_authority" | "policy"
A policy refusal is a decision; an execution failure still throws.
AccessDecision
Ƭ AccessDecision: {kind: "allowed" ; validUntil: number | null } | { kind: "denied" ; code: "not_authorized" } | { kind: "unavailable" ; code: "evaluation_failed" }
A disclosed permission result. Private provenance is never included.
PermissionResult
Ƭ PermissionResult:Object
Not exported: an exported type refers to it.
Type declaration
AccessCheck
Ƭ AccessCheck:Object
One permission check of a batch: permission on the object key of
type, as require takes them.
Type declaration
AccessContractContext
Ƭ AccessContractContext:Readonly<Pick<Compiled, "session" | "users" | "guests" | "services" | "assignments" | "roles">>
Schema-authoring facts only. This context contains no caller or verdict.
ContractRequirement
Ƭ ContractRequirement:Term<AuthorityObligation>
ContractCase
Ƭ ContractCase:Readonly<{ on: "create" | "update" | "delete" ; changes: readonly string[] ; require: ContractRequirement }>
ContractStorage
Ƭ ContractStorage:Readonly<{ table: string ; schema: ValidatorJSON ; indexes: Readonly<Record<string, readonly string[]>> ; inputs: readonly string[] ; read: ReadProgram ; guard: ContractRequirement ; signatures: Readonly<Record<string, Readonly<{ publicKey: string ; usages: readonly string[] }>>> }>
RecordContractDeclaration
Ƭ RecordContractDeclaration:Readonly<{ storage: ContractStorage ; kind: "record" ; cases: Readonly<Record<string, ContractCase>> }>
ReviewedContractDeclaration
Ƭ ReviewedContractDeclaration:Readonly<{ storage: ContractStorage ; kind: "reviewed" ; state: Readonly<{ field: string ; proposed: string ; approved: string ; rejected: string ; withdrawn: string }> ; reviewer: string ; proposer: string ; expiry: string ; maxDuration: number ; propose: ContractRequirement ; approve: ContractRequirement ; reject: ContractRequirement ; withdraw: ContractRequirement }>
AccessContractDeclaration
Ƭ AccessContractDeclaration:RecordContractDeclaration | ReviewedContractDeclaration
DecisionInstallation
Ƭ DecisionInstallation:Object
Not exported: an exported type refers to it.
Type declaration
Term
Ƭ Term<A>: Readonly<{ kind: "atom" ; atom: A }> | Readonly<{ kind: "all" | "any" ; nodes: readonly Term<A>[] }> | Readonly<{ kind: "not" ; node: Term<A> }> | Readonly<{ kind: "choose" ; test: Term<A> ; yes: Term<A> ; no: Term<A> }>
Not exported: an exported type refers to it.
Type parameters
AuthorityInput
Ƭ AuthorityInput: {kind: "key" } | { kind: "literal" ; value: Value } | { kind: "before" | "after" ; field: string } | { kind: "row" ; slot: string ; field: string } | { kind: "absent" } | { kind: "execution" ; field: "principal" | "decisionActor" | "active" | "origin" | "direct" | "transactionTime" | "authenticatedAt" | "verifiedEmail" | "issuer" } | { kind: "present" | "trimmed" | "utf16Length" | "principalKind" ; input: AuthorityInput } | { kind: "fixedHex" ; input: AuthorityInput ; bytes: number } | { kind: "retained" ; input: AuthorityInput ; directory: AccessDirectory | null } | { kind: "deadline" ; duration: number } | { kind: "path" ; input: AuthorityInput ; field: string } | { kind: "default" ; input: AuthorityInput ; value: Value } | { kind: "principal" | "deadlineValue" ; input: AuthorityInput } | { kind: "recorded" ; table: string ; key: AuthorityInput ; image: "before" | "after" } | { kind: "changeCount" ; table: string ; added: boolean }
Not exported: an exported type refers to it.
AuthorityObligation
Ƭ AuthorityObligation: {kind: "witness" ; verifier: string ; usage: string } | { kind: "onlyChanges" ; fields: readonly string[] } | { kind: "beforeExpiry" ; input: AuthorityInput } | { kind: "confer" ; assignment: AuthorityInput ; permissions: AuthorityInput ; operation: "grant" | "revoke" ; source: "original" | "placement" } | { kind: "programCustody" ; assignment: AuthorityInput } | { kind: "clearance" ; assignment: AuthorityInput } | { kind: "scopeChanged" ; assignment: AuthorityInput } | { kind: "construction" ; assignment: AuthorityInput ; resource: string ; permission: string } | { kind: "ceiling" ; key: AuthorityInput ; resource: string ; permission: string } | { kind: "reachability" ; key: AuthorityInput ; resource: string ; ancestor: AuthorityInput ; ancestorResource: string } | { kind: "environment" ; name: string ; bind: string ; body: Term<AuthorityObligation> } | { kind: "equal" ; left: AuthorityInput ; right: AuthorityInput } | { kind: "predicate" ; fields: Record<string, AccessClaimType> ; inputs: Record<string, AuthorityInput> ; expr: Expr } | { kind: "permission" ; basis: "original" ; judgment: PermissionJudgment ; permission: string ; on: ResourceRef ; lifetime: AuthorityLifetime } | { kind: "each" ; input: AuthorityInput ; bind: string ; body: Term<AuthorityObligation> } | { kind: "atMost" ; view: "original" | "final" ; table: string ; index: string ; pins: readonly readonly [string, AuthorityInput][] ; maximum: number } | { kind: "range" ; view: "original" | "final" ; table: string ; index: string ; pins: readonly readonly [string, AuthorityInput][] ; bind: string ; quantifier: "any" | "all" | "empty" ; body: Term<AuthorityObligation> }
Not exported: an exported type refers to it.
AccessDiscoveryRoute
Ƭ AccessDiscoveryRoute:Readonly<{ kind: "get" }> | Readonly<{ kind: "shares" ; table: string ; index: string }> | Readonly<{ kind: "index" ; index: string }> | Readonly<{ kind: "scope" ; table: string ; index: string }>
Not exported: an exported type refers to it.
AccessEmulationConfiguration
Ƭ AccessEmulationConfiguration:Object
An immutable centrally declared scope, authorized through native grants.
Eligibility does not grant any of the scope’s permissions.
Type declaration
ContactKind
Ƭ ContactKind:"phone" | "email"
Typed evidence declarations. These describe propositions, never grants.
ContactField
Ƭ ContactField:Readonly<{ kind: ContactKind ; field: string }>
ContactIdentity
Ƭ ContactIdentity:Readonly<{ kind: ContactKind ; value: string }>
EvidenceType
Ƭ EvidenceType: {kind: "resource" ; resource: string } | { kind: "contact" ; contact: ContactKind } | { kind: "principal" } | { kind: "string" } | { kind: "bool" } | { kind: "long" }
EvidenceDeclaration
Ƭ EvidenceDeclaration:Readonly<{ scope: "participant" | "principal" ; fields: Readonly<Record<string, EvidenceType>> }>
Scope selects the evidence custody/audience namespace. The declared fields
define its statement: consuming requirements bind every field, including any
proposal, input version, program identity and permitted use the statement needs.
A verifier establishes facts; neither its output nor these bindings grants a role.
EvidenceValue
Ƭ EvidenceValue: {kind: "resource" ; resource: string ; key: string } | { kind: "contact" ; contact: ContactIdentity } | { kind: "principal" ; principal: string } | { kind: "string" ; value: string } | { kind: "bool" ; value: boolean } | { kind: "long" ; value: string }
ConditionScalar
Ƭ ConditionScalar:string | bigint | boolean
Not exported: an exported type refers to it.
ConditionValue
Ƭ ConditionValue:ConditionScalar | readonly string[] | readonly bigint[]
Not exported: an exported type refers to it.
Operand
Ƭ Operand<T>: T | AccessExpression<T>
Not exported: an exported type refers to it.
Type parameters
AccessOptionalExpression
Ƭ AccessOptionalExpression<T>: Pick<AccessExpression<T>, "match" | "isPresent">
Not exported: an exported type refers to it.
Type parameters
References
Ƭ References<T>: { readonly [K in keyof T as NonNullable<T[K]> extends ConditionValue ? K : never]-?: 0 extends 1 & T[K] ? AccessExpression<any> : NonNullable<T[K]> extends readonly unknown[] ? undefined extends T[K] ? Pick<AccessArrayExpression<NonNullable<T[K]>>, “isPresent” | “match”> : null extends T[K] ? Pick<AccessArrayExpression<NonNullable<T[K]>>, “isPresent” | “match”> : AccessArrayExpression<NonNullable<T[K]>> : undefined extends T[K] ? AccessOptionalExpression<NonNullable<T[K]>> : null extends T[K] ? AccessOptionalExpression<NonNullable<T[K]>> : AccessExpression<T[K]> }
Not exported: an exported type refers to it.
Type parameters
AccessConditionScope
Ƭ AccessConditionScope<Resource, Principal, Context>: Object
Not exported: an exported type refers to it.
Type parameters
Type declaration
AccessCondition
Ƭ AccessCondition<Resource, Principal, Context>: (scope: AccessConditionScope<Resource, Principal, Context>) => AccessExpression<boolean>
Type parameters
Type declaration
▸ (scope): AccessExpression<boolean>
Not exported: an exported type refers to it.
Parameters
Returns
AccessExpression<boolean>
CompiledConditionBuilder
Ƭ CompiledConditionBuilder: (scope: any) => AccessExpression<boolean>
Type declaration
▸ (scope): AccessExpression<boolean>
Not exported: an exported type refers to it.
Parameters
Returns
AccessExpression<boolean>
StateValue
Ƭ StateValue:string | boolean | bigint
Not exported: an exported type refers to it.
FieldState
Ƭ FieldState<T>: undefined extends T ? { initial?: never ; transitions?: never } : [T] extends [StateValue] ? { initial?: T ; transitions?: readonly readonly [T, T][] } : { initial?: never ; transitions?: never }
Not exported: an exported type refers to it.
Type parameters
AccessReadRequirement
Ƭ AccessReadRequirement<Permission, Field, Resource>: true | Permission | { permission: Permission ; restrictions: readonly (AccessReadRestriction<Resource> | AccessReadLabelField<Field, Resource>)[] }
Additional mandatory protections on a readable row or value.
Type parameters
AccessFieldProtection
Ƭ AccessFieldProtection<Permission, Field, Resource>: Object
One explicit classification for a stored application field.
Type parameters
Type declaration
FieldPolicy
Ƭ FieldPolicy<P, F, R, SourceOwned>: Pick<AccessFieldProtection<P, F, R>, "read"> & SourceOwned extends true ? { create?: never ; update?: never } : Pick<AccessFieldProtection<P, F, R>, "create" | "update">
Not exported: an exported type refers to it.
Type parameters
AccessFieldProtections
Ƭ AccessFieldProtections<Field, Permission, Resource, Document, SourceOwned>: { [K in Field as K extends `_${string}` ? never : K]-?: FieldPolicy<Permission, Field, Resource, SourceOwned> & (K extends keyof Document ? FieldShape<Document[K], Permission, Field, Resource, SourceOwned> & (SourceOwned extends true ? Object : FieldState<Document[K]>) : unknown) }
Every application field is classified, including optional fields.
Type parameters
AccessFieldExceptions
Ƭ AccessFieldExceptions<Field, Permission, Resource, Document, SourceOwned>: { [K in Field as K extends `_${string}` ? never : K]?: Partial<FieldPolicy<Permission, Field, Resource, SourceOwned>> & (K extends keyof Document ? ExceptionShape<Document[K], Permission, Field, Resource, SourceOwned> & (SourceOwned extends true ? Object : FieldState<Document[K]>) : unknown) }
Not exported: an exported type refers to it.
Type parameters
FieldException
Ƭ FieldException<T, P, F, R, SourceOwned>: Partial<FieldPolicy<P, F, R, SourceOwned>> & ExceptionShape<T, P, F, R, SourceOwned>
Not exported: an exported type refers to it.
Type parameters
ExceptionShape
Ƭ ExceptionShape<T, P, F, R, SourceOwned>: 0 extends 1 & T ? { whole?: GenericValidator ; fields?: never ; items?: never } : [NonNullable<T>] extends [Geometry<GeometrySpace> | Position | ObjectRef] ? { whole?: never ; fields?: never ; items?: never } : [NonNullable<T>] extends [readonly infer Item[]] ? true extends Structured<Item> ? { items?: FieldException<Item, P, F, R, SourceOwned> ; fields?: never ; whole?: never } : { fields?: never ; items?: never ; whole?: never } : true extends Structured<T> ? string extends Keys<NonNullable<T>> ? { whole?: GenericValidator ; fields?: never ; items?: never } : { fields?: { [K in Keys<NonNullable<T>> & string]?: FieldException<At<NonNullable<T>, K>, P, F, R, SourceOwned> } ; items?: never ; whole?: never } : { fields?: never ; items?: never ; whole?: never }
Not exported: an exported type refers to it.
Type parameters
Keys
Ƭ Keys<T>: T extends string | number | bigint | boolean | ArrayBuffer | readonly unknown[] ? never : keyof T
Not exported: an exported type refers to it.
Type parameters
At
Ƭ At<T, K>: T extends unknown ? K extends keyof T ? T[K] : never : never
Not exported: an exported type refers to it.
Type parameters
FieldShape
Ƭ FieldShape<T, P, F, R, SourceOwned>: 0 extends 1 & T ? { whole?: GenericValidator ; fields?: never ; items?: never } : [NonNullable<T>] extends [Geometry<GeometrySpace> | Position | ObjectRef] ? { whole?: never ; fields?: never ; items?: never } : [NonNullable<T>] extends [readonly infer Item[]] ? true extends Structured<Item> ? { items: FieldPolicy<P, F, R, SourceOwned> & FieldShape<Item, P, F, R, SourceOwned> ; fields?: never ; whole?: never } : { fields?: never ; items?: never ; whole?: never } : true extends Structured<T> ? string extends Keys<NonNullable<T>> ? { whole: GenericValidator ; fields?: never ; items?: never } : { fields: { [K in Keys<NonNullable<T>> & string]-?: FieldPolicy<P, F, R, SourceOwned> & FieldShape<At<NonNullable<T>, K>, P, F, R, SourceOwned> } ; items?: never ; whole?: never } : { fields?: never ; items?: never ; whole?: never }
Not exported: an exported type refers to it.
Type parameters
Structured
Ƭ Structured<T>: 0 extends 1 & T ? true : T extends readonly infer Item[] ? Structured<Item> : T extends string | number | bigint | boolean | ArrayBuffer | CommitTsPlaceholder | ObjectRef ? false : T extends object ? true : false
Not exported: an exported type refers to it.
Type parameters
AccessIdentity
Ƭ AccessIdentity:Object
Verified request evidence and its application-owned association key.
Resolving a key never rewrites the issuer, subject or session claims.
Type declaration
AccessInformationProtection
Ƭ AccessInformationProtection<Field, Resource>: Object
One reusable protection.
Type parameters
Type declaration
VisibleRead
Ƭ VisibleRead: {id: string ; kind: "object" ; object: Record<string, unknown> } | { id: string ; kind: "absent" } | { id: string ; kind: "restricted" }
One identifier of a visible read: the object, with each selected property
outside its visibility permission wrapped as a VisibleValue; or
absent; or restricted when the reader may not see the object at all.
PermissionExplanation
Ƭ PermissionExplanation: {authenticationRequired?: PermissionAuthentication ; permission: string ; emulation?: "allowed" | "ordinaryAuthority" | "permissionCeiling" | "resourceBounds" | "grantSources" | "clearances" | "unavailable" ; steps: AccessStep[] ; trace?: AccessTrace ; actions?: { kind: "request" ; role: string }[] } & { outcome: "allowed" ; validUntil: number | null ; via: string | null } | { outcome: "denied" ; reason: AccessRefusalReason ; refusedBy: string } | { outcome: "unavailable" ; missingFacts: string[] }
How one permission on one object is decided for a principal.
AccessOutcome
Ƭ AccessOutcome:"allowed" | "denied" | "unavailable"
An inspected permission’s outcome. Invalid security metadata or an
evaluation failure is an error, never an outcome.
PolicyCompilationIdentity
Ƭ PolicyCompilationIdentity:Readonly<{ compilationDigest: string ; declarationDigest: string ; entryDigest: string ; schemaBindingDigest: string | null ; compilerRevision: string ; cedarVersion: string ; clauseCount: number }>
Identity of the admitted compiler plan. This carries no captured rows,
private predicate values, or authority to reuse an inspection as a permit.
ExecutionObservation
Ƭ ExecutionObservation:Object
Type declaration
AccessIntegrity
Ƭ AccessIntegrity<Field>: Object
Closed structural invariants over engine-recorded row images. These constrain
writes; they never grant a permission. They do not track what influenced a
value: information-flow protection belongs in defineInformationProtection.
Type parameters
Type declaration
AccessResolution
Ƭ AccessResolution: {kind: "ready" } | { kind: "interactionRequired" ; offers: AccessRecoveryOffer[] } | { kind: "refused" ; code: "not_authorized" } | { kind: "unavailable" ; code: "evaluation_failed" }
A current inspection’s disclosed next step. Offers remain advisory and
owner-bound; completing one never retries the business operation.
AccessFields
Ƭ AccessFields: readonlystring[] | "rest"
The fields a permission covers: a list, or every field no other
permission of the same map lists.
AccessReadRestriction
Ƭ AccessReadRestriction<Type>: Object
A mandatory classification on values released by one permission.
Type parameters
Type declaration
AccessReadLabelField
Ƭ AccessReadLabelField<Field, Type>: Object
Labels each row carries for one read group: field holds the keys of
the row’s labels, each one of allowed. A reader passes them as a row’s
own labels are passed: every label of an all category, one of each
any category’s. A key outside allowed is invalid security metadata, an
error rather than an empty set. allowed bounds the work a projection
spends resolving passes; it grants nothing.
Type parameters
Type declaration
AccessReadGroup
Ƭ AccessReadGroup<Field, Type>: readonly Field[] | "rest" | { fields: readonly Field[] | "rest" ; restrictions: readonly (AccessReadRestriction<Type> | AccessReadLabelField<Field, Type>)[] }
Fields covered by a read permission and the labels every reader must
pass: fixed labels, each required independently, and labels each row
carries in a field. Roles cannot override them.
Type parameters
AccessCreation
Ƭ AccessCreation:Object
What creating an object also establishes in the same transaction: an
assignment of a fixed role of its type to its creator.
Type declaration
AccessTypeDefinition
Ƭ AccessTypeDefinition:Object
Not exported: an exported type refers to it.
Type declaration
AccessRoleDefinition
Ƭ AccessRoleDefinition: readonlystring[] | { permissions: readonly string[] ; assignment?: { maxDuration?: number ; reasonRequired?: boolean ; selfGrant?: string ; requestable?: boolean ; guests?: boolean ; purpose?: string } ; issuance?: Record<string, never> }
A role: the permissions it bundles, as type:name, type:* or
type:grant.*, on its own type and descendant types. A role may bound
the duration of its grants, require a written reason on each, and let
holders of a permission of its type grant it to themselves: just-in-time
access, which must then be bounded and justified, and which ends no later
than the holder’s own grant of that permission.
AccessDirectory
Ƭ AccessDirectory:Object
A source-owned table of identity-provider memberships assigning role
on (member, object) pairs. index covers [member, object]. A row is
the same assignment a grant record of that role and holder would be: one
evaluator decides both.
A row confers its role only while the source that published it (its
source_id) has not lost continuity and either the exact record or a
completed population acquisition was observed less than maxAge
milliseconds ago, read through ctx.sources.evidence. A removal the provider exposes at time t therefore
takes effect by t + maxAge at the latest, whether or not the sync runs,
and a decision relying on a membership is valid until its source’s
observation is maxAge old. An observation stamped later than the
decision’s clock counts as made then, so no decision outlasts maxAge
from now. A row without a source, or a context without sources, confers
nothing.
Type declaration
AccessDirectoryDeclaration
Ƭ AccessDirectoryDeclaration:Omit<AccessDirectory, "role"> & { role: Extract<RoleRef, { kind: "declared" }> }
A directory as a model declares it. role is a stable reference to a
declared role of type ({ kind: "declared", key }); a tenant role is
tenant data no model can name. A bounded role’s maxDuration runs from
when the source first asserted the membership: refreshing the same
assertion keeps its row, and so its start. A role requiring a reason or
granting itself cannot be a directory’s.
AccessDirectoryCoverage
Ƭ AccessDirectoryCoverage:Pick<SourceEvidence, "populationCovered" | "populationObservedFrom" | "recordObservedFrom" | "continuityLost" | "erased">
What a directory’s freshness rule reads of a source’s coverage.
AccessRoleDefinitions
Ƭ AccessRoleDefinitions:Object
Immutable tenant role bundles, scoped to one tenant root. Definition
authority is separate from data use and bounded by an explicit permission
envelope. Assignments separately require grant.custom on their target.
Type declaration
RoleDefinitionDocument
Ƭ RoleDefinitionDocument:Object
One tenant-defined role: the permissions, as type:name, of a role of
type usable on objects under the scope object scope. maxDuration
bounds its grants as a declared role’s does: each must expire within it,
and renewing one extends it for at most that long.
Type declaration
AccessServiceDefinition
Ƭ AccessServiceDefinition:Object
Not exported: an exported type refers to it.
Type declaration
AccessClientRestrictions
Ƭ AccessClientRestrictions:Object
Not exported: an exported type refers to it.
Type declaration
AccessInitialOwner
Ƭ AccessInitialOwner:string | { environment: string }
A bootstrap identity key, or the deployment variable holding it.
AccessModelDefinition
Ƭ AccessModelDefinition:Object
Not exported: an exported type refers to it.
Type declaration
Fields
Ƭ Fields:Map<string, string> & { rest?: string }
Not exported: an exported type refers to it.
CompiledType
Ƭ CompiledType:Object
Not exported: an exported type refers to it.
Type declaration
CompiledService
Ƭ CompiledService:Object
Not exported: an exported type refers to it.
Type declaration
CompiledRole
Ƭ CompiledRole:Object
Not exported: an exported type refers to it.
Type declaration
Compiled
Ƭ Compiled:Object
Not exported: an exported type refers to it.
Type declaration
PrincipalSource
Ƭ PrincipalSource:Object
Not exported: an exported type refers to it.
Type declaration
WorkspaceStandingRequirement
Ƭ WorkspaceStandingRequirement:Object
Not exported: an exported type refers to it.
Type declaration
StorageBinding
Ƭ StorageBinding:Object
Not exported: an exported type refers to it.
Type declaration
Table
Ƭ Table:GenericSchema[string]
Not exported: an exported type refers to it.
Model
Ƭ Model<T>: DataModelFromSchemaDefinition<SchemaDefinition<{ observation: T }, true>>
Not exported: an exported type refers to it.
Type parameters
Info
Ƭ Info<T>: Model<T>[keyof Model<T>]
Not exported: an exported type refers to it.
Type parameters
Next
Ƭ Next: [1, 2, 3, 4]
Not exported: an exported type refers to it.
BoundValue
Ƭ BoundValue<T>: T extends string | boolean | bigint ? T | AccessExpression<T> : never | T extends GenericId<string> ? AccessExpression<string> : never | T extends string ? Extract<RequirementValue, { kind: "principal" | "program" }> : never | T extends string | boolean | bigint ? Extract<RequirementValue, { kind: "claim" }> : never
Not exported: an exported type refers to it.
Type parameters
Policy
Ƭ Policy:Object
Not exported: an exported type refers to it.
Type declaration
Address
Ƭ Address:Object
Not exported: an exported type refers to it.
Type declaration
InstalledRule
Ƭ InstalledRule:ReturnType<typeof decisionQuery> | ReturnType<typeof expiryMutation>
Not exported: an exported type refers to it.
AssignmentLifecycle
Ƭ AssignmentLifecycle:Object
Not exported: an exported type refers to it.
Type declaration
AccessResourceRef
Ƭ AccessResourceRef: {type: "root" ; id?: never ; key?: never } | { type: string ; id: string ; key?: never } | { type: string ; key: string ; id?: never }
RoleRef
Ƭ RoleRef<Key>: Key | Extract<NativeRoleRef, { kind: "tenant" }>
Type parameters
AccessPrincipal
Ƭ AccessPrincipal<UserId, Service>: { kind: "user" ; userId: UserId } | { kind: "service" ; name: Service } | { kind: "session" ; service: Service ; id: string }
Type parameters
Holder
Ƭ Holder<UserId>: Exclude<AccessPrincipal<UserId>, { kind: "session" }> | { kind: "group" ; resource: AccessResourceRef ; memberPermission: string } | { kind: "program" ; program: ProgramGrantRef }
Type parameters
HolderInput
Ƭ HolderInput:Holder | { kind: "self" } | { kind: "identity" ; tokenIdentifier: string }
Assignment
Ƭ Assignment<AssignmentId>: Object
Type parameters
Type declaration
AssignmentInput
Ƭ AssignmentInput:Omit<Assignment, "id" | "holder"> & { holder: HolderInput }
AccessExplanation
Ƭ AccessExplanation:Omit<AccessExplanation, "resource" | "principal" | "execution"> & { resource: AccessResourceRef ; principal: AccessPrincipal | null ; execution: ExecutionDescriptor | null }
InspectionRequest
Ƭ InspectionRequest:Object
Type declaration
AccessInspector
Ƭ AccessInspector:Object
Type declaration
AccessHolders
Ƭ AccessHolders<Resource, AssignmentId>: Object
Type parameters
Type declaration
AccessRequest
Ƭ AccessRequest:Object
Type declaration
RetainedPermissionBinding
Ƭ RetainedPermissionBinding:AccessRequest & { binding: string }
UnprovenReason
Ƭ UnprovenReason:Object
Type declaration
NativeReceiver
Ƭ NativeReceiver: {kind: "http" ; prefix: string ; methods: string[] | null } | { kind: "integration" ; integration: string ; command: string } | { kind: "dataset" ; dataset: string } | { kind: "executor" ; onward: "unrestricted" ; executor: ExecutorReceiver }
Not exported: an exported type refers to it.
AccessReleaseCondition
Ƭ AccessReleaseCondition<Args>: Object
Closed predicates over exact command arguments. These compile at schema
analysis; no application callback makes a runtime authorization decision.
Type parameters
Type declaration
Releases
Ƭ Releases<D>: D extends { releases: infer R } ? R : {}
Not exported: an exported type refers to it.
Type parameters
Destinations
Ƭ Destinations<D>: D extends { destinations: infer R } ? R : {}
Not exported: an exported type refers to it.
Type parameters
DestinationCommand
Ƭ DestinationCommand<D, Name>: Releases<D>[Name] extends { destination: infer Target } ? Target extends keyof Destinations<D> ? Destinations<D>[Target] extends { receiver: infer C } ? C : never : never : never
Not exported: an exported type refers to it.
Type parameters
ReceiverNames
Ƭ ReceiverNames<D>: { [Name in keyof Releases<D> & string]: [DestinationCommand<D, Name>] extends [never] ? never : Name }[keyof Releases<D> & string]
Not exported: an exported type refers to it.
Type parameters
ReceiverInput
Ƭ ReceiverInput<D, Name>: { args: CommandArgs<DestinationCommand<D, Name>> } & DestinationCommand<D, Name> extends CommandHandle<any, "resource"> ? { target?: { bindingId: string } } : DestinationCommand<D, Name> extends CommandHandle<any, "collection"> ? { target?: CommandTarget } : { target: CommandTarget }
Not exported: an exported type refers to it.
Type parameters
ReceiverRequest
Ƭ ReceiverRequest<D, Name>: { integration: IntegrationAddress ; command: string ; release: Name } & ReceiverInput<D, Name>
Not exported: an exported type refers to it.
Type parameters
ExecutorReceiver
Ƭ ExecutorReceiver: {kind: "python" ; component: string | null ; function: string ; connection: string ; program: { revision: string } } | { kind: "workload" ; component: string | null ; integration: string ; sourceId: string ; definitionRevision: string ; command: string }
Exact executor identity selected by native admission. A receiver admits
this recipient; it never asserts technical confinement.
AccessReceiver
Ƭ AccessReceiver:CommandHandle<any> | { http: string ; methods?: readonly string[] } | { dataset: string } | { executor: ExecutorReceiver ; onward: "unrestricted" }
Something leaving the deployment that a destination may send to: a
binding and the operations on it.
AccessDestinationTarget
Ƭ AccessDestinationTarget: {reader: true } | { table: string } | { receiver: AccessReceiver }
Where a declared destination sends protected rows.
AccessRelease
Ƭ AccessRelease:Object
One transfer contract. A named destination identifies a boundary and grants
no authority; each release independently declares its sources and conditions.
Type declaration
AccessTransform
Ƭ AccessTransform:Object
One transformation a source owner consents to release.
Native release compares the destination’s payload with the return of the
retained call it cites. That call’s exact retained program, never the caller
or recipient, must currently hold requires and the source’s read permission
on every source, through a program grant. declassify is then decided as that
program too, so the caller gains no authority over the protected input. The
release’s own requires still decides who may receive the output.
Every source of the crossing must have been read by that program during the
cited call. A source the caller read separately refuses the route.
Pinning a program establishes which code ran, not what its output reveals: the
grant is the owner’s judgment of that code.
Type declaration
ReleaseFor
Ƭ ReleaseFor<Destinations>: { [Name in keyof Destinations & string]: Omit<AccessRelease, “destination” | “when”> & Object }[keyof Destinations & string]
Not exported: an exported type refers to it.
Type parameters
CompiledDestination
Ƭ CompiledDestination: {kind: "executor" ; executor: ExecutorReceiver ; onward: "unrestricted" } | { kind: "table" ; table: string } | { kind: "http" ; prefix: URL ; methods: Set<string> | null } | { kind: "integration" ; handle: CommandHandle<any> } | { kind: "reader" } | { kind: "dataset" ; dataset: string }
Not exported: an exported type refers to it.
CompiledRelease
Ƭ CompiledRelease:Object
Not exported: an exported type refers to it.
Type declaration
Declaration
Ƭ Declaration<S>: S extends { [selectedAccess]?: infer A } ? A : never
Not exported: an exported type refers to it.
Type parameters
RequestClient
Ƭ RequestClient<S>: RequestAccessModel<Declaration<S>, S extends GenericSchema ? S : GenericSchema>
Not exported: an exported type refers to it.
Type parameters
ReaderMethod
Ƭ ReaderMethod: typeofreaderMethods[number]
Not exported: an exported type refers to it.
WriterMethod
Ƭ WriterMethod: typeofwriterMethods[number]
Not exported: an exported type refers to it.
AccessReader
Ƭ AccessReader<S>: 0 extends 1 & S ? any : Pick<RequestClient<S>, ReaderMethod>
Request-bound permission decisions and authorized discovery.
Type parameters
AccessWriter
Ƭ AccessWriter<S>: 0 extends 1 & S ? any : Pick<RequestClient<S>, Extract<ReaderMethod | WriterMethod | "roles", keyof RequestClient<S>>>
Request-bound assignment and release lifecycle.
Type parameters
AuthorityOrigin
Ƭ AuthorityOrigin:"person" | "service" | "issued" | "delegated" | "worker"
RequirementApplicability
Ƭ RequirementApplicability:Readonly<{ kind: "all" }> | Readonly<{ kind: "origins" ; origins: readonly AuthorityOrigin[] }>
Not exported: an exported type refers to it.
ProgramRequirementField
Ƭ ProgramRequirementField:"implementation" | "function" | "installation" | "record"
RequirementValue
Ƭ RequirementValue: {kind: "target" } | { kind: "principal" } | { kind: "claim" ; name: string } | { kind: "program" ; field: ProgramRequirementField } | { kind: "field" ; field: string } | { kind: "contact" ; field: string ; contact: ContactKind } | { kind: "literal" ; value: EvidenceValue }
RequirementCondition
Ƭ RequirementCondition:AccessExpression<boolean> | (scope: AccessConditionScope) => AccessExpression<boolean>
A permission requirement’s condition: an expression of the one condition
language, built from requirement and, in a builder, the claims,
principal attributes and typed fields of the requirement’s target.
PermissionAuthentication
Ƭ PermissionAuthentication:Readonly<{ maxAgeMs: number ; acrValues: readonly string[] ; requiredMethods: readonly string[] }>
Exact verified OIDC evidence required from a direct actor.
PermissionRequirement
Ƭ PermissionRequirement:Readonly<{ permission: string ; on: string ; applies_to?: RequirementApplicability ; decision?: { actors: readonly ("person" | "service")[] ; direct?: boolean ; authentication?: PermissionAuthentication ; unless?: RequirementCondition } ; when?: RequirementCondition }>
Not exported: an exported type refers to it.
CompiledPermissionRequirement
Ƭ CompiledPermissionRequirement:Readonly<{ permission: string ; on: string ; applies_to: RequirementApplicability ; decision?: { actors: readonly ("person" | "service")[] ; direct: boolean ; authentication?: PermissionAuthentication ; unless?: Expr } ; when: Expr }>
Not exported: an exported type refers to it.
InstalledResourceSet
Ƭ InstalledResourceSet:Object
Not exported: an exported type refers to it.
Type declaration
TransitionOperation
Ƭ TransitionOperation:"create" | "update" | "move" | "delete"
AccessTransitionCondition
Ƭ AccessTransitionCondition<Resource, Principal, Context>: (scope: Omit<AccessConditionScope<Resource, Principal, Context>, "resource"> & { before: References<Resource> ; after: References<Resource> }) => AccessExpression<boolean>
Type parameters
Type declaration
▸ (scope): AccessExpression<boolean>
Parameters
Returns
AccessExpression<boolean>
TransitionConditionDeclaration
Ƭ TransitionConditionDeclaration<Resource, Principal, Context>: Object
Type parameters
Type declaration
CompiledTransitionCondition
Ƭ CompiledTransitionCondition:Object
Not exported: an exported type refers to it.
Type declaration
ProgramGrantRef
Ƭ ProgramGrantRef:Readonly<{ installation: string ; callback: string ; record: string ; implementation: string }>
Exact retained execution. Public locators confer no authority without a
resource assignment and live native record/code custody.
AssignmentMutation
Ƭ AssignmentMutation:FunctionReference<"mutation", "internal", { assignmentId: GenericId<string> }>
A product internal mutation taking an assignment’s id.
AssignmentReminder
Ƭ AssignmentReminder:Object
A review reminder for a bounded assignment: notify, the product’s internal
mutation, runs before milliseconds ahead of the assignment’s expiry (at once
when that moment has passed) with the assignment’s id. It calls reviewDue
and commits the notice.
Type declaration
AssignmentOptions
Ƭ AssignmentOptions:Object
An optional application-owned review reminder; expiry uses the installed handler.
Type declaration
TypeNames
Ƭ TypeNames<D>: "root" | Extract<keyof D["types"], string>
Not exported: an exported type refers to it.
Type parameters
DeclaredPermissions
Ƭ DeclaredPermissions<T>: T extends { permissions: readonly infer P[] } ? P : never
Not exported: an exported type refers to it.
Type parameters
ResourceKey
Ƭ ResourceKey<D, T>: T extends "root" ? "*" : T extends keyof D["types"] ? D["types"][T] extends { table: infer Table } ? string extends Table ? string : GenericId<Table> : string : never
Not exported: an exported type refers to it.
Type parameters
HandlerResource
Ƭ HandlerResource<D, T>: T extends "root" ? { type: "root" } : D["types"][T] extends { table: infer Table } ? string extends Table ? { type: T ; id: string ; key?: never } | { type: T ; key: string ; id?: never } : { type: T ; id: GenericId<Table> ; key?: never } : { type: T ; key: ResourceKey<D, T> ; id?: never }
Not exported: an exported type refers to it.
Type parameters
HandlerTarget
Ƭ HandlerTarget<D>: { [T in TypeNames<D>]: HandlerResource<D, T> }[TypeNames<D>]
Not exported: an exported type refers to it.
Type parameters
PermissionArguments
Ƭ PermissionArguments<D>: string extends AccessPermission<D> ? [permission: string, key?: string] : { [P in AccessPermission<D>]: PermissionTarget<D, P> extends “root” ? [permission: P] : [permission: P, key: ResourceKey<D, PermissionTarget<D, P>>] }[AccessPermission<D>]
Not exported: an exported type refers to it.
Type parameters
ResourceBinding
Ƭ ResourceBinding<D, S, Name>: { [Table in Extract<keyof S, string>]-?: S[Table] extends AccessTableBinding<infer R, infer B> ? R extends AccessResource<any, any, Name & string, D> ? Object & (B extends Object ? Object : Object) & (B extends Object ? Object : Object) : never : never }[Extract<keyof S, string>]
Not exported: an exported type refers to it.
Type parameters
LoweredResources
Ƭ LoweredResources<D, S>: { roles: D["roles"] ; types: { [K in keyof D[“resources”]]: ([ResourceBinding<D, S, K>] extends [never] ? [S] extends [never] ? Object : string extends keyof S ? Object : Object : ResourceBinding<D, S, K>) & Object & (D[“resources”][K] extends Object ? Object : Object) & (D[“resources”][K] extends Object ? Object : Object) } } & D extends { groups: infer G } ? { groups: G } : {} & D extends { audit: infer A } ? { audit: A } : {} & D extends { services: infer Services } ? { services: Services } : {} & D extends { releases: infer Releases } ? { releases: Releases } : {} & D extends { destinations: infer Destinations } ? { destinations: Destinations } : {} & D extends { assignmentListings: infer Listings } ? { assignmentListings: Listings } : {} & D extends { users: infer U } ? { users: U } : {} & D extends { roleDefinitions: infer R } ? { roleDefinitions: R } : {}
Not exported: an exported type refers to it.
Type parameters
AccessPermission
Ƭ AccessPermission<D, S>: AccessPermission<LoweredResources<D, S>>
Permission names inferred from semantic resources and scoped roles.
Type parameters
AssignmentSource
Ƭ AssignmentSource<Definition>: Object
Not exported: an exported type refers to it.
Type parameters
Type declaration
AccessDefinition
Ƭ AccessDefinition<D>: Omit<GenericAccessDefinition, "resource" | "role" | "person" | "service" | "delegate" | "policy" | "assignments"> & { release: <Name>(name: Name, input: ReceiverInput<D, Name>) => ReceiverRequest<D, Name> ; assignments: (…args: Parameters<GenericAccessDefinition["assignments"]>) => ReturnType<GenericAccessDefinition["assignments"]> & AssignmentSource<D> ; policy: (type: TypeNames<LoweredResources<D>>, options?: { alsoTo?: readonly string[] }) => SchemaAccessPolicy ; delegate: (client: DelegationClient, input: Omit<DelegationInput, "recipient" | "restriction"> & { recipient: { kind: "service" ; name: Extract<keyof NonNullable<D["services"]>, string> } | { kind: "user" ; userId: string } ; restriction: AccessRestriction<HandlerTarget<LoweredResources<D>>, AccessPermission<LoweredResources<D>>> }) => Promise<DelegationGrant> ; [accessDefinition]: D ; resources: { root: AccessResource<undefined, "administer", "root", D> } & { readonly [K in keyof D[“resources”]]: AccessResource<D[“resources”][K] extends Object ? P : undefined, D[“resources”][K] extends Object ? P : never, K & string, D> } }
An immutable declaration with typed table-binding handles.
Type parameters
RequestInspection
Ƭ RequestInspection<D, S>: Object
Not exported: an exported type refers to it.
Type parameters
Type declaration
RequestAccess
Ƭ RequestAccess<D, Definition, S>: RequestOperations<D, Definition, S> & string extends keyof D["types"] ? { roles: RequestRoleWriter } : D extends { roleDefinitions: object } ? { roles: RequestRoleWriter } : {}
Not exported: an exported type refers to it.
Type parameters
RequestRoleWriter
Ƭ RequestRoleWriter:Object
Not exported: an exported type refers to it.
Type declaration
RequestAccessModel
Ƭ RequestAccessModel<M, S>: [EndpointDefinition<M>] extends [never] ? RequestAccess<AccessModelDefinition, AccessModelDefinition, GenericSchema> : RequestAccess<LoweredResources<EndpointDefinition<M>, S>, EndpointDefinition<M>, S>
Not exported: an exported type refers to it.
Type parameters
AccessValidators
Ƭ AccessValidators:Record<string, GenericValidator>
AccessInputValidatorJSON
Ƭ AccessInputValidatorJSON: {type: "string" | "boolean" | "bigint" } | { type: "literal" ; value: string | boolean | { $integer: string } } | { type: "array" ; value: AccessInputValidatorJSON } | { type: "union" ; value: AccessInputValidatorJSON[] }
Not exported: an exported type refers to it.
AccessInputValidators
Ƭ AccessInputValidators:Object
Not exported: an exported type refers to it.
Type declaration
AccessSignatureQuestion
Ƭ AccessSignatureQuestion:Readonly<{ table: string ; record: string ; verifier: string ; usage: string }>
AccessSignatureWitness
Ƭ AccessSignatureWitness:Readonly<{ question: AccessSignatureQuestion ; signature: string }>
AdmissionGateKind
Ƭ AdmissionGateKind:"entitlement" | "capacity" | "provider" | "assurance"
Independent owners contribute mandatory conditions; none grants the
operation’s business permission.
AdmissionGate
Ƭ AdmissionGate<Row, Principal, Claims>: Object
A gate compiles to an ordinary mandatory permission requirement. Reading
an entitlement from a source therefore retains that source’s native reads,
freshness and withdrawal controls.
Type parameters
Type declaration
AllowanceReference
Ƭ AllowanceReference:Readonly<{ address: Readonly<{ module: string ; export: string }> ; unit: string }>
AllowanceDefinition
Ƭ AllowanceDefinition:Readonly<{ isAllowance: true ; [reference]: () => AllowanceReference ; exportAllowance: () => string }>
A quantity with one installed address and immutable unit.
AllowanceCharge
Ƭ AllowanceCharge<Argument>: Readonly<{ allowance: AllowanceDefinition ; amount: Argument }>
A charge is derived from final validated effect arguments.
Type parameters
AllowanceAllocation
Ƭ AllowanceAllocation:Readonly<{ allowance: AllowanceDefinition | AllowanceReference ; limit: bigint | "unbounded" }>
Allocation at this level; inherited allocations continue to apply.
AllowanceObservation
Ƭ AllowanceObservation:Object
Type declaration
ApplicationAuthServerOptions
Ƭ ApplicationAuthServerOptions:Object
Server callbacks with HttpOnly cookie custody over native session records.
Type declaration
CliSignInOptions
Ƭ CliSignInOptions:Object
CLI sign-in uses the provider’s public OIDC client with PKCE.
Register loopback redirects with the provider. No client secret is retained.
Type declaration
BrowserSignInOptions
Ƭ BrowserSignInOptions:Object
Browser sign-in uses exact registered HTTPS callback URLs.
Type declaration
ApplicationAuthConfig
Ƭ ApplicationAuthConfig:Object
Ordinary provider admission with optional application-owned sign-in.
Select cli, browser, or both on one OIDC provider. Other admitted providers
may use the same issuer with another audience. An explicit workosAuthkit
declaration adds the public AuthKit PKCE protocol to its custom JWT verifier.
Other custom JWT admission retains its inherited contract.
Type declaration
AuthenticationIsolationCase
Ƭ AuthenticationIsolationCase:Object
Type declaration
ApplicationSessionControl
Ƭ ApplicationSessionControl:Object
A native authority control. The principal is the exact issuer|subject;
provider-session effects intersect it with the issuer, client and sid.
Type declaration
ApplicationSessionControlReceipt
Ƭ ApplicationSessionControlReceipt:Object
Type declaration
AuditEventDeclaration
Ƭ AuditEventDeclaration:Object
Type declaration
AuditEventDefinitions
Ƭ AuditEventDefinitions:Record<string, { resources: string[] ; metadata: GenericValidator["json"] }>
AuditLogBody
Ƭ AuditLogBody:Object
Index signature
▪ [key:string]: AuditLogValue
AuditLogValue
Ƭ AuditLogValue:null | undefined | boolean | number | string | LogVar | AuditLogValue[] | { [key: string]: AuditLogValue; }
AutomationCredential
Ƭ AutomationCredential:Object
Type declaration
PolicyContract
Ƭ PolicyContract<Args, Result>: Object
A package’s validator contract. It contains no application authority.
Type parameters
Type declaration
ComponentAccessPolicy
Ƭ ComponentAccessPolicy<Kind>: Object
Standard resource decisions derived by component schema declarations,
optionally narrowed by the package to the resource kinds it installs.
Type parameters
Type declaration
AuthenticationCeremony
Ƭ AuthenticationCeremony:Object
Type declaration
Configuration
Ƭ Configuration:Object
Not exported: an exported type refers to it.
Type declaration
Observation
Ƭ Observation:Infer<typeof enterpriseProviderObservation>
Not exported: an exported type refers to it.
Proof
Ƭ Proof:Infer<typeof enterpriseSetupProof>
Not exported: an exported type refers to it.
ReadContext
Ƭ ReadContext:BijectionQueryCtx<any, any>
Not exported: an exported type refers to it.
SetupTable
Ƭ SetupTable<Table, Resource>: Table & AccessTableBinding<Resource, any>
Not exported: an exported type refers to it.
Type parameters
Population
Ƭ Population:Infer<typeof identityCorrelationPopulation>
Not exported: an exported type refers to it.
IdentityCorrelation
Ƭ IdentityCorrelation: {kind: "matched" ; person: string ; organization: string ; provider: string ; subject: string ; evidence: InspectionEvidence[] ; validUntil: number } | { kind: "conflict" ; people: string[] ; evidence: InspectionEvidence[] } | { kind: "unmatched" ; evidence: InspectionEvidence[] } | { kind: "unavailable" ; evidence: InspectionEvidence[] }
IdentityFieldAuthority
Ƭ IdentityFieldAuthority<Row, Principal, Claims>: (scope: Omit<AccessConditionScope<Row, Principal, Claims>, "resource"> & { before: References<Row> }) => AccessExpression<boolean>
Type parameters
Type declaration
▸ (scope): AccessExpression<boolean>
Field management is a transition obligation, independent of disclosure and
ordinary edit permission. The authority builder receives only the recorded
original identity; proposed identity fields cannot establish their owner.
Parameters
Returns
AccessExpression<boolean>
PolicySlot
Ƭ PolicySlot<Args, Result>: FunctionReference<"query", "internal", Args, Result>
A component’s typed policy dependency. Each installation’s application
binds it to one policy query in the component’s binding (policies).
Calling it outside native policy evaluation is refused.
Type parameters
QueryPolicy
Ƭ QueryPolicy:Object
Explicit inputs and shared query calls for a query used by a policy.
Type declaration
PolicyExecution
Ƭ PolicyExecution: {kind: "caller" } | { kind: "program" ; program: DerivationProgramExecution } | { kind: "custody" ; component: string | null ; owner: string | null } & { scheduled: { function: string ; job: GenericId<"_scheduled_functions"> } | null }
Native execution of the decision being evaluated. It confers no person or
resource permission. Available only inside a rule with private inputs.
A custody holder is set by native scheduling/worker admission; an ordinary
caller, including an anonymous or administrator caller, cannot select it.
A decision for a delegated human remains a caller decision.
LogVar
Ƭ LogVar: typeofREQUEST_ID | typeof IP | typeof USER_AGENT | typeof NOW | typeof BIJECTION_ACTOR
Not exported: an exported type refers to it.
Workflow
Ƭ Workflow: {role: string ; maxDurationMs: number | null } & { kind: "participation" } | { kind: "task" ; args: GenericValidator ; perform: FunctionReference<"mutation", "internal", any, any> ; completion: FunctionReference<"query", "internal", { invitationId: string ; result: Value }, typeof type> }
Not exported: an exported type refers to it.
Decision
Ƭ Decision<Result>: void | Result | Promise<void | Result>
Not exported: an exported type refers to it.
Type parameters
CommandDecision
Ƭ CommandDecision:null | { validUntil: number } | { recheckAt: number }
One command decision: permit (optionally until validUntil), or defer
with recheckAt, which refuses now and is never permission.
CommandContract
Ƭ CommandContract<Args, Target>: Object
A connector’s protocol contract for one command: its argument
validators and, when the connector fixes it, its target. It carries no
installed source and no application authority.
Type parameters
Type declaration
CommandPolicyDefinition
Ƭ CommandPolicyDefinition<Contract, Target, DataModel>: { reads?: readonly Extract<keyof DataModel, string>[] ; calls?: readonly FunctionReference<"query", "public" | "internal", any, any>[] ; handler: (ctx: BijectionQueryCtx<DataModel>, input: Omit<CommandGoverningInput, "target" | "args"> & { target: Target["type"] ; args: ObjectType<Contract["args"]> }) => Decision<CommandDecision> } & Contract["target"] extends Validator<any, "required", any> ? { target?: never } : { target: Target }
Application admission for one command contract. Completing normally
permits, throwing refuses, and an explicit decision adds an expiry or a
deferral. Omitted reads means no table reads.
Type parameters
ReadAccessRequest
Ƭ ReadAccessRequest:Infer<typeof requests>[number]
One native object or searched-domain authorization obligation.
Crossing
Ƭ Crossing:Infer<typeof crossing>
One crossing out of the backend.
ResourceAuditPage
Ƭ ResourceAuditPage:Object
A scoped statement retains the journal’s native outcome and attribution.
Body fields are authored claims. Source bodies can be withheld independently.
Type declaration
ResourceAuthority
Ƭ ResourceAuthority<Mode>: Object
A programmable policy owner for a table inside an installed component,
installed through .access. Applications declare their tables’ protection
with defineAccess and .access(access.resources.<type>, ...) instead:
activation refuses a programmable policy on an application (root) table.
The queries decide the actual caller or finite programme under current
policy; this declaration grants no component or programme authority itself.
Type parameters
Type declaration
Query
Ƭ Query<A>: FunctionReference<"query", "public" | "internal", A, ReadAccessResults>
Not exported: an exported type refers to it.
Type parameters
ResourceAuthorityOptions
Ƭ ResourceAuthorityOptions:Object
Private policy inputs are ordinary tables in this schema. The fixed query
declarations name their callable policy dependencies separately.
Type declaration
RiskBinding
Ƭ RiskBinding:Infer<typeof riskBinding>
RiskObservation
Ƭ RiskObservation:Infer<typeof riskObservation>
RiskAssessment
Ƭ RiskAssessment:Infer<typeof assessment>
SecuritySection
Ƭ SecuritySection:Readonly<{ owner: InspectionOwner ; population: FunctionReference<"query", "internal", { principal: string ; limit: number ; cursor: string | null }, typeof type> }>
InspectionReader
Ƭ InspectionReader:Pick<BijectionQueryCtx<any, any>, "runQuery" | "auth">
InspectionWriter
Ƭ InspectionWriter:Pick<BijectionMutationCtx<any, any>, "runQuery" | "runMutation" | "auth">
InspectionOwner
Ƭ InspectionOwner<Facts>: Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<Facts>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }>
Type parameters
ApplicationSubjectInspection
Ƭ ApplicationSubjectInspection: readonlyInspectionOwner[]
Variables
accessResource
•Const accessResource: typeof accessResource
Not exported: an exported type refers to it.
accessBindingOwner
•Const accessBindingOwner: typeof accessBindingOwner
Not exported: an exported type refers to it.
accessModelExtension
•Const accessModelExtension: Readonly<{ transactionTime: () => Promise<number> ; signatureChallenge: (question: AccessSignatureQuestion) => Promise<string> ; presentSignatureWitness: (witness: AccessSignatureWitness) => Promise<void> ; accessMetadata: (value: object) => Pick<AccessProtection, "isAccessModel" | "accessAddress" | "accessRules" | "assignmentTableName" | "initializationRole" | "requestsConfigured" | "requestActions" | "assignmentTable" | typeof attachAccess> ; defineAccessContribution: (definition: AccessContributionDefinition) => AccessContribution ; accessContribution: typeof accessContribution ; servicePrincipal: (identity: { issuer: string ; subject?: string }) => { service: string ; session: string | null } | null ; accessScope: <C>(ctx: C) => C ; accessMemo: <T>(ctx: AccessCtx, key: object, resolve: () => Promise<T>) => Promise<T> ; resolveAccessIdentity: (ctx: AccessCtx) => Promise<AccessIdentity | null> ; readIdentityAssociation: (ctx: AccessCtx, source: { table: string ; index: string }, identityKey: string) => Promise<Record<string, any> | null> ; accessProtection: (definitions: Record<string, Policy> | () => Record<string, Policy>, owner?: AccessBindingOwner, decisions?: DecisionInstallation, lifecycle?: AssignmentLifecycle) => AccessProtection ; installAccessMetadata: <T>(target: T, installation: AccessProtection) => T ; accessBindingOwner: typeof accessBindingOwner ; accessResource: typeof accessResource ; markPrincipalSource: <T, Field>(table: T, field: Field) => T & PrincipalSourceTable<Field> ; DELEGATION_CLAIMS: { recipient: "delegatedRecipient" = “delegatedRecipient”; clientLabel: "delegatedClientLabel" = “delegatedClientLabel”; support: "delegatedSupport" = “delegatedSupport”; personal: "delegatedPersonal" = “delegatedPersonal”; credentialScope: "bijectionCredentialScope" = “bijectionCredentialScope”; ancestry: "delegatedAncestry" = “delegatedAncestry”; scope: "delegatedScope" = “delegatedScope”; restriction: "delegatedRestriction" = “delegatedRestriction”; permissions: "delegatedPermissions" = “delegatedPermissions” } ; both: (…results: ReadAccessResult[]) => GoverningResult }>
conditionRequiredFields
•Const conditionRequiredFields: typeof conditionRequiredFields
Not exported: an exported type refers to it.
ROOT_TYPE
•Const ROOT_TYPE: "root"
The one object every tree hangs from. A type without a parent is a child
of the root, so an administrator of everything is an ordinary role on an
ordinary object, and a whole-table read is a scope pinned at the root.
ROOT_KEY
•Const ROOT_KEY: "*"
The key of the single root object.
accessContribution
•Const accessContribution: typeof accessContribution
Not exported: an exported type refers to it.
requirement
•Const requirement: Readonly<{ query: <T>(table: T) => Readonly<{ withIndex: <Name>(name: Name, range: (q: RequirementIndexRange<DocumentByInfo<Info<T>>, NamedIndex<Info<T>, Name>>) => unknown) => Readonly<{ exists: () => AccessExpression<boolean> ; filter: (predicate: AccessCondition<DocumentByInfo<Info<T>>>) => Readonly<{ exists: () => AccessExpression<boolean>; filter: (predicate: AccessCondition<DocumentByInfo<Info<T>>>) => Readonly<…>; }> }> }> = accessPropositionQuery; target: () => RequirementValue ; principal: () => Extract<RequirementValue, { kind: "principal" }> ; claim: (name: string) => Extract<RequirementValue, { kind: "claim" }> ; program: (field: ProgramRequirementField) => Extract<RequirementValue, { kind: "program" }> ; field: (field: string) => RequirementValue ; contact: (contact: ContactKind, field: string) => RequirementValue ; literal: (value: EvidenceValue) => RequirementValue ; evidence: (predicate: string, bindings: Record<string, RequirementValue>, audience: "established" | "any") => AccessExpression<boolean> ; all: (…of: AccessExpression<boolean>[]) => AccessExpression<boolean> ; any: (…of: AccessExpression<boolean>[]) => AccessExpression<boolean> ; not: (condition: AccessExpression<boolean>) => AccessExpression<boolean> }>
attachAccess
•Const attachAccess: typeof attachAccess
Not exported: an exported type refers to it.
readerMethods
•Const readerMethods: ["check", "require", "requirePrincipalPermission", "capturePermission", "recheckPermission", "permissionsOn", "assignments", "holders", "reviewDue", "explain", "simulate", "requestable", "principal", "isInitialOwner"]
Not exported: an exported type refers to it.
writerMethods
•Const writerMethods: ["grant", "renew", "revoke", "revokeAll"]
Not exported: an exported type refers to it.
billablePopulation
•Const billablePopulation: VUnion<{ kind: "unavailable" } | { kind: "counted" ; owner: string ; revision: string ; count: number ; observedAtMs: number ; validUntilMs: number }, [VObject<{ kind: "unavailable" }, { kind: VLiteral<"unavailable", "required"> }, "required", "kind">, VObject<{ kind: "counted" ; owner: string ; revision: string ; count: number ; observedAtMs: number ; validUntilMs: number }, { kind: VLiteral<"counted", "required"> ; owner: VString<string, "required"> ; count: VFloat64<number, "required"> ; revision: VString<string, "required"> ; observedAtMs: VFloat64<number, "required"> ; validUntilMs: VFloat64<number, "required"> }, "required", "kind" | "owner" | "revision" | "count" | "observedAtMs" | "validUntilMs">], "required", "kind" | "owner" | "revision" | "count" | "observedAtMs" | "validUntilMs">
A complete native count from the application’s declared participation
population. Source-backed populations must establish their native coverage
and freshness in this query; unavailable input is never zero seats.
componentAccessPolicy
•Const componentAccessPolicy: ComponentAccessPolicy
discoveryAdmissionArgs
•Const discoveryAdmissionArgs: Object
A metadata decision uses the caller’s ordinary query context and tracked
reads. false withholds this definition; a dependency failure throws.
It grants no row, property, transition, or execution permission.
Type declaration
enterpriseProviderObservation
•Const enterpriseProviderObservation: VUnion<{ kind: "connection" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; active: null | boolean ; observedAt: number ; validUntil: number ; configuration: { issuer: string; clientId: string; providerOrganization: string; } } | { kind: "certificate" ; expiresAt: null | number ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; observedAt: number ; validUntil: number ; configuration: { issuer: string; clientId: string; providerOrganization: string; } } | { kind: "directory" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; observedAt: number ; validUntil: number ; complete: boolean ; checkpoint: null | string ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; publicationRevision: null | string } | { kind: "policy" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; observedAt: number ; validUntil: number ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; ssoEnforced: null | boolean }, [VObject<{ kind: "connection" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; active: null | boolean ; observedAt: number ; validUntil: number ; configuration: { issuer: string; clientId: string; providerOrganization: string; } }, { configuration: VObject<{ issuer: string ; clientId: string ; providerOrganization: string }, { issuer: VString<string, "required"> ; clientId: VString<string, "required"> ; providerOrganization: VString<string, "required"> }, "required", "issuer" | "clientId" | "providerOrganization"> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; revision: VString<string, "required"> ; observedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> ; state: VUnion<"unavailable" | "blocked" | "ready", [VLiteral<"ready", "required">, VLiteral<"blocked", "required">, VLiteral<"unavailable", "required">], "required", never> ; kind: VLiteral<"connection", "required"> ; active: VUnion<null | boolean, [VBoolean<boolean, "required">, VNull<null, "required">], "required", never> }, "required", "kind" | "source" | "revision" | "state" | "active" | "observedAt" | "validUntil" | "configuration" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "configuration.issuer" | "configuration.clientId" | "configuration.providerOrganization">, VObject<{ kind: "certificate" ; expiresAt: null | number ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; observedAt: number ; validUntil: number ; configuration: { issuer: string; clientId: string; providerOrganization: string; } }, { configuration: VObject<{ issuer: string ; clientId: string ; providerOrganization: string }, { issuer: VString<string, "required"> ; clientId: VString<string, "required"> ; providerOrganization: VString<string, "required"> }, "required", "issuer" | "clientId" | "providerOrganization"> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; revision: VString<string, "required"> ; observedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> ; state: VUnion<"unavailable" | "blocked" | "ready", [VLiteral<"ready", "required">, VLiteral<"blocked", "required">, VLiteral<"unavailable", "required">], "required", never> ; kind: VLiteral<"certificate", "required"> ; expiresAt: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> }, "required", "kind" | "expiresAt" | "source" | "revision" | "state" | "observedAt" | "validUntil" | "configuration" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "configuration.issuer" | "configuration.clientId" | "configuration.providerOrganization">, VObject<{ kind: "directory" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; observedAt: number ; validUntil: number ; complete: boolean ; checkpoint: null | string ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; publicationRevision: null | string }, { configuration: VObject<{ issuer: string ; clientId: string ; providerOrganization: string }, { issuer: VString<string, "required"> ; clientId: VString<string, "required"> ; providerOrganization: VString<string, "required"> }, "required", "issuer" | "clientId" | "providerOrganization"> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; revision: VString<string, "required"> ; observedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> ; state: VUnion<"unavailable" | "blocked" | "ready", [VLiteral<"ready", "required">, VLiteral<"blocked", "required">, VLiteral<"unavailable", "required">], "required", never> ; kind: VLiteral<"directory", "required"> ; checkpoint: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; publicationRevision: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; complete: VBoolean<boolean, "required"> }, "required", "kind" | "source" | "revision" | "state" | "observedAt" | "validUntil" | "complete" | "checkpoint" | "configuration" | "publicationRevision" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "configuration.issuer" | "configuration.clientId" | "configuration.providerOrganization">, VObject<{ kind: "policy" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; state: "unavailable" | "blocked" | "ready" ; observedAt: number ; validUntil: number ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; ssoEnforced: null | boolean }, { configuration: VObject<{ issuer: string ; clientId: string ; providerOrganization: string }, { issuer: VString<string, "required"> ; clientId: VString<string, "required"> ; providerOrganization: VString<string, "required"> }, "required", "issuer" | "clientId" | "providerOrganization"> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; revision: VString<string, "required"> ; observedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> ; state: VUnion<"unavailable" | "blocked" | "ready", [VLiteral<"ready", "required">, VLiteral<"blocked", "required">, VLiteral<"unavailable", "required">], "required", never> ; kind: VLiteral<"policy", "required"> ; ssoEnforced: VUnion<null | boolean, [VBoolean<boolean, "required">, VNull<null, "required">], "required", never> }, "required", "kind" | "source" | "revision" | "state" | "observedAt" | "validUntil" | "configuration" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "configuration.issuer" | "configuration.clientId" | "configuration.providerOrganization" | "ssoEnforced">], "required", "kind" | "expiresAt" | "source" | "revision" | "state" | "active" | "observedAt" | "validUntil" | "complete" | "checkpoint" | "configuration" | "publicationRevision" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "configuration.issuer" | "configuration.clientId" | "configuration.providerOrganization" | "ssoEnforced">
A fixed provider owner supplies observed facts. Unknown certificate or
directory state stays unavailable; configuration alone proves neither.
enterpriseSetupProof
•Const enterpriseSetupProof: VObject<{ source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }, { outcome: VUnion<"unavailable" | "blocked" | "ready", [VLiteral<"ready", "required">, VLiteral<"blocked", "required">, VLiteral<"unavailable", "required">], "required", never> ; configurationDigest: VString<string, "required"> ; definitionDigest: VString<string, "required"> ; revision: VString<string, "required"> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; validUntil: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> ; reason: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> }, "required", "source" | "revision" | "reason" | "validUntil" | "outcome" | "configurationDigest" | "definitionDigest" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation">
A proof owner returns current facts about this exact configuration.
identityCorrelationPopulation
•Const identityCorrelationPopulation: VObject<{ coverage: "partial" | "complete" ; records: { subject: string; organization: string; person: string; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; }; revision: string; provider: string; validUntil: number; }[] }, { coverage: VUnion<"partial" | "complete", [VLiteral<"complete", "required">, VLiteral<"partial", "required">], "required", never> ; records: VArray<{ subject: string ; organization: string ; person: string ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; provider: string ; validUntil: number }[], VObject<{ subject: string ; organization: string ; person: string ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; provider: string ; validUntil: number }, { organization: VString<string, "required"> ; provider: VString<string, "required"> ; subject: VString<string, "required"> ; person: VString<string, "required"> ; source: VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> = subjectRefValidator; revision: VString<string, "required"> ; validUntil: VFloat64<number, "required"> }, "required", "subject" | "organization" | "person" | "source" | "revision" | "provider" | "validUntil" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation">, "required"> }, "required", "coverage" | "records">
identityProjectionObservation
•Const identityProjectionObservation: VUnion<{ kind: "blocked" ; reason: "unavailable" | "unmatched" | "conflict" } | { key: string ; kind: "observed" ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; groups: Record<string, { kind: “selected”; values: Record<string, any>; } | { kind: “skipped”; reason: “unavailable” | “conflict” | “sourceNotAuthoritative”; }> ; validUntilMs: number ; identityId: string }, [VObject<{ kind: "blocked" ; reason: "unavailable" | "unmatched" | "conflict" }, { kind: VLiteral<"blocked", "required"> ; reason: VUnion<"unavailable" | "unmatched" | "conflict", [VLiteral<"unmatched", "required">, VLiteral<"conflict", "required">, VLiteral<"unavailable", "required">], "required", never> }, "required", "kind" | "reason">, VObject<{ key: string ; kind: "observed" ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; groups: Record<string, { kind: “selected”; values: Record<string, any>; } | { kind: “skipped”; reason: “unavailable” | “conflict” | “sourceNotAuthoritative”; }> ; validUntilMs: number ; identityId: string }, { kind: VLiteral<"observed", "required"> ; key: VString<string, "required"> ; identityId: VString<string, "required"> ; source: VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> = subjectRefValidator; revision: VString<string, "required"> ; validUntilMs: VFloat64<number, "required"> ; groups: VRecord<Record<string, { kind: "selected" ; values: Record<string, any> } | { kind: "skipped" ; reason: "unavailable" | "conflict" | "sourceNotAuthoritative" }>, VString<string, "required">, VUnion<{ kind: "selected" ; values: Record<string, any> } | { kind: "skipped" ; reason: "unavailable" | "conflict" | "sourceNotAuthoritative" }, [VObject<{ kind: "selected" ; values: Record<string, any> }, { kind: VLiteral<"selected", "required"> ; values: VRecord<Record<string, any>, VString<string, "required">, VAny<any, "required", string>, "required", string> }, "required", "kind" | "values" | `values.\{string}\`\>, [`VObject`](/api/classes/values.VObject)\<\{ `kind`: ``"skipped"`` ; `reason`: ``"unavailable"`` \| ``"conflict"`` \| ``"sourceNotAuthoritative"`` \}, \{ `kind`: [`VLiteral`](/api/classes/values.VLiteral)\<``"skipped"``, ``"required"``\> ; `reason`: [`VUnion`](/api/classes/values.VUnion)\<``"unavailable"`` \| ``"conflict"`` \| ``"sourceNotAuthoritative"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"sourceNotAuthoritative"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"conflict"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"unavailable"``, ``"required"``\>], ``"required"``, `never`\> = skippedReason \}, ``"required"``, ``"kind"`` \| ``"reason"``\>], ``"required"``, ``"kind"`` \| ``"values"`` \| ``"reason"`` \| \`values.{string}`>, "required", string> }, "required", "key" | "kind" | "source" | "revision" | "groups" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "validUntilMs" | "identityId" | `groups.\{string}\`\>], ``"required"``, ``"key"`` \| ``"kind"`` \| ``"source"`` \| ``"revision"`` \| ``"reason"`` \| ``"groups"`` \| ``"source.id"`` \| ``"source.installation"`` \| ``"source.location"`` \| ``"source.protocol"`` \| ``"source.location.incarnation"`` \| ``"source.location.branch"`` \| ``"source.location.deployment_id"`` \| ``"source.location.branch.key"`` \| ``"source.location.branch.generation"`` \| ``"validUntilMs"`` \| ``"identityId"`` \| \`groups.{string}`>
Returned by an installed internal query over current source evidence and a
reviewed immutable-identity association. No public endpoint accepts it.
Native field transitions and ordinary target permissions remain required.
identityProjectionResult
•Const identityProjectionResult: VUnion<{ kind: "blocked" ; reason: "unavailable" | "unmatched" | "conflict" } | { kind: "projected" ; requestId: string ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; sourceRevision: string ; groups: { name: string; reason: “unavailable” | “accepted” | “conflict” | “sourceNotAuthoritative” | “sameValue”; outcome: “unchanged” | “skipped” | “applied”; }[] ; recordedAtMs: number ; identityId: string ; projectionDigest: string ; beforeDigest: string ; afterDigest: string }, [VObject<{ kind: "blocked" ; reason: "unavailable" | "unmatched" | "conflict" }, { kind: VLiteral<"blocked", "required"> ; reason: VUnion<"unavailable" | "unmatched" | "conflict", [VLiteral<"unmatched", "required">, VLiteral<"conflict", "required">, VLiteral<"unavailable", "required">], "required", never> }, "required", "kind" | "reason">, VObject<{ kind: "projected" ; requestId: string ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; sourceRevision: string ; groups: { name: string; reason: “unavailable” | “accepted” | “conflict” | “sourceNotAuthoritative” | “sameValue”; outcome: “unchanged” | “skipped” | “applied”; }[] ; recordedAtMs: number ; identityId: string ; projectionDigest: string ; beforeDigest: string ; afterDigest: string }, { kind: VLiteral<"projected", "required"> ; requestId: VString<string, "required"> ; projectionDigest: VString<string, "required"> ; source: VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> = subjectRefValidator; sourceRevision: VString<string, "required"> ; identityId: VString<string, "required"> ; beforeDigest: VString<string, "required"> ; afterDigest: VString<string, "required"> ; groups: VArray<{ name: string ; reason: "unavailable" | "accepted" | "conflict" | "sourceNotAuthoritative" | "sameValue" ; outcome: "unchanged" | "skipped" | "applied" }[], VObject<{ name: string ; reason: "unavailable" | "accepted" | "conflict" | "sourceNotAuthoritative" | "sameValue" ; outcome: "unchanged" | "skipped" | "applied" }, { name: VString<string, "required"> ; outcome: VUnion<"unchanged" | "skipped" | "applied", [VLiteral<"applied", "required">, VLiteral<"unchanged", "required">, VLiteral<"skipped", "required">], "required", never> ; reason: VUnion<"unavailable" | "accepted" | "conflict" | "sourceNotAuthoritative" | "sameValue", [VLiteral<"accepted", "required">, VLiteral<"sameValue", "required">, VUnion<"unavailable" | "conflict" | "sourceNotAuthoritative", [VLiteral<"sourceNotAuthoritative", "required">, VLiteral<"conflict", "required">, VLiteral<"unavailable", "required">], "required", never>], "required", never> }, "required", "name" | "reason" | "outcome">, "required"> ; recordedAtMs: VFloat64<number, "required"> }, "required", "kind" | "requestId" | "source" | "sourceRevision" | "groups" | "recordedAtMs" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "identityId" | "projectionDigest" | "beforeDigest" | "afterDigest">], "required", "kind" | "requestId" | "source" | "reason" | "sourceRevision" | "groups" | "recordedAtMs" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "identityId" | "projectionDigest" | "beforeDigest" | "afterDigest">
onboardingReceipt
•Const onboardingReceipt: VObject<{ revision: bigint ; state: "revoked" | "completed" | "accepted" | "claimed" | "invited" ; participation: null | string ; invitationId: string }, { invitationId: VString<string, "required"> ; revision: VInt64<bigint, "required"> ; state: VUnion<"revoked" | "completed" | "accepted" | "claimed" | "invited", [VLiteral<"invited", "required">, VLiteral<"claimed", "required">, VLiteral<"accepted", "required">, VLiteral<"completed", "required">, VLiteral<"revoked", "required">], "required", never> ; participation: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> }, "required", "revision" | "state" | "participation" | "invitationId">
onboardingCompletion
•Const onboardingCompletion: VUnion<{ kind: "pending" } | { kind: "complete" ; receipt: string }, [VObject<{ kind: "pending" }, { kind: VLiteral<"pending", "required"> }, "required", "kind">, VObject<{ kind: "complete" ; receipt: string }, { kind: VLiteral<"complete", "required"> ; receipt: VString<string, "required"> }, "required", "kind" | "receipt">], "required", "kind" | "receipt">
PERSON_DECISION_REQUIRED
•Const PERSON_DECISION_REQUIRED: "Only a person signed in directly can make this decision"
The refusal every surface gives a non-person at a person’s decision.
readAccessArgs
•Const readAccessArgs: Object
Arguments for an ordinary query used by .access({ read, reads }).
The native reader constructs the complete batch. Calling the query directly
does not grant private policy-input access or authorize another database read.
properties: null requires the whole document. Otherwise properties include
selected fields and fields contributing to membership, filtering and order,
including _id and _creationTime. Nested paths require their whole top-level
property. Query equalities are guaranteed index bounds, not guessed filters.
An omitted equality value denotes absence; null remains an explicit value.
A query target with covers: true stands for rows the engine does not
present as requests of their own: a maintained total, a count, a table
change token, a whole relation’s status, a range folded past the read
evidence bound (rowsFollowRange) or a retained obligation kept in place of
per-row requests. Its result decides every row it covers. Without the key,
any row the read returned arrives as a request of its own.
Type declaration
readAccessResults
•Const readAccessResults: VArray<(null | { reason: undefined | string ; validUntil: number } | { reason: string })[], VUnion<null | { reason: undefined | string ; validUntil: number } | { reason: string }, [VNull<null, "required">, VObject<{ reason: undefined | string ; validUntil: number }, { validUntil: VFloat64<number, "required"> ; reason: VString<undefined | string, "optional"> }, "required", "reason" | "validUntil">, VObject<{ reason: string }, { reason: VString<string, "required"> }, "required", "reason">], "required", "reason" | "validUntil">, "required">
The return validator of every rule: read, destination, a table’s write rule
(.govern) and an integration command’s rule. A command rule gives no
reason; one that defers with recheckAt declares that member beside
null and { validUntil }.
crossing
•Const crossing: VUnion<{ kind: "rows" ; fields: string[] ; from: string ; to: { site: “compute”; } | { target: string; source: string; site: “source”; } | { dataset: string; site: “catalog”; catalog: string; } } | { kind: "state" ; fields: string[] ; from: string ; to: { site: “compute”; } } | { kind: "keys" ; fields: string[] ; from: string ; to: { target: string; source: string; site: “source”; } } | { kind: "range" ; fields: string[] ; from: string ; to: { target: string; source: string; site: “source”; } } | { kind: "values" ; fields: string[] ; from: null | string ; to: { target: string; source: string; site: “source”; } }, [VObject<{ kind: "rows" ; fields: string[] ; from: string ; to: { site: “compute”; } | { target: string; source: string; site: “source”; } | { dataset: string; site: “catalog”; catalog: string; } }, { kind: VLiteral<"rows", "required"> ; from: VString<string, "required"> ; to: VUnion<{ site: "compute" } | { target: string ; source: string ; site: "source" } | { dataset: string ; site: "catalog" ; catalog: string }, [VObject<{ site: "compute" }, { site: VLiteral<"compute", "required"> }, "required", "site">, VObject<{ target: string ; source: string ; site: "source" }, { site: VLiteral<"source", "required"> ; source: VString<string, "required"> ; target: VString<string, "required"> }, "required", "target" | "source" | "site">, VObject<{ dataset: string ; site: "catalog" ; catalog: string }, { site: VLiteral<"catalog", "required"> ; catalog: VString<string, "required"> ; dataset: VString<string, "required"> }, "required", "dataset" | "site" | "catalog">], "required", "target" | "dataset" | "source" | "site" | "catalog"> ; fields: VArray<string[], VString<string, "required">, "required"> }, "required", "kind" | "fields" | "from" | "to" | "to.target" | "to.dataset" | "to.source" | "to.site" | "to.catalog">, VObject<{ kind: "state" ; fields: string[] ; from: string ; to: { site: “compute”; } }, { kind: VLiteral<"state", "required"> ; from: VString<string, "required"> ; to: VObject<{ site: "compute" }, { site: VLiteral<"compute", "required"> }, "required", "site"> = computeSite; fields: VArray<string[], VString<string, "required">, "required"> }, "required", "kind" | "fields" | "from" | "to" | "to.site">, VObject<{ kind: "keys" ; fields: string[] ; from: string ; to: { target: string; source: string; site: “source”; } }, { kind: VLiteral<"keys", "required"> ; from: VString<string, "required"> ; to: VObject<{ target: string ; source: string ; site: "source" }, { site: VLiteral<"source", "required"> ; source: VString<string, "required"> ; target: VString<string, "required"> }, "required", "target" | "source" | "site"> = sourceSite; fields: VArray<string[], VString<string, "required">, "required"> }, "required", "kind" | "fields" | "from" | "to" | "to.target" | "to.source" | "to.site">, VObject<{ kind: "range" ; fields: string[] ; from: string ; to: { target: string; source: string; site: “source”; } }, { kind: VLiteral<"range", "required"> ; from: VString<string, "required"> ; to: VObject<{ target: string ; source: string ; site: "source" }, { site: VLiteral<"source", "required"> ; source: VString<string, "required"> ; target: VString<string, "required"> }, "required", "target" | "source" | "site"> = sourceSite; fields: VArray<string[], VString<string, "required">, "required"> }, "required", "kind" | "fields" | "from" | "to" | "to.target" | "to.source" | "to.site">, VObject<{ kind: "values" ; fields: string[] ; from: null | string ; to: { target: string; source: string; site: “source”; } }, { kind: VLiteral<"values", "required"> ; from: VUnion<null | string, [VNull<null, "required">, VString<string, "required">], "required", never> ; to: VObject<{ target: string ; source: string ; site: "source" }, { site: VLiteral<"source", "required"> ; source: VString<string, "required"> ; target: VString<string, "required"> }, "required", "target" | "source" | "site"> = sourceSite; fields: VArray<string[], VString<string, "required">, "required"> }, "required", "kind" | "fields" | "from" | "to" | "to.target" | "to.source" | "to.site">], "required", "kind" | "fields" | "from" | "to" | "to.target" | "to.dataset" | "to.source" | "to.site" | "to.catalog">
What one step moves out of the backend, and where. Every place a table’s
data is computed or stored outside the backend is a crossing: an installed
executor or query compute, a customer catalog. fields name fields, never
values. A site may retain what it receives: a crossing is disclosure, not a
claim that the site erases it, and a revocation stops later crossings
without recalling earlier ones.
Two timings decide it:
-
standing, for background work with no caller (a dataset publication to
its catalog):
rowsdecided with no identity (ctx.auth.getUserIdentity()returnsnull) for one request covering every row (target.covers), before every send; - per call (a query step): decided for the protected rows the calling function has read, under its caller, before the call leaves.
-
rows: the named fields offromdisclosed to the installed executor, or to bounded local dataset browsing. The destination is explicit. -
state: aggregate states computed at the source fromfrom’s rows, into compute. Admittedrowsimply it. -
keys: the exact set offrom’s join keys, sent to another source to prune its scan. -
range: only the least and greatest of those keys. Admittedkeysimply it; a join filter refusedkeysand admittedrangesends the range. -
values: a bounded local relationfromuploaded as parameters, or withfrom: nullquery literals (possibly derived from earlier protected reads), whose compared source fields are namedtable.field.
disclosureArgs
•Const disclosureArgs: Object
Arguments for the source’s .access({ destination, export }) queries. The host
supplies actual information dependencies and the exact fixed destination.
A table release gives the resulting record its destination table’s policy;
it does not grant future reads of the source or retract previously released
bytes when a source grant is later revoked.
Type declaration
riskBinding
•Const riskBinding: VObject<{ organization: string ; principal: string ; participant: null | string ; target: { key: string; type: string; } ; operation: string ; request: string ; session: string ; executor: string ; attempt: string ; client: string ; policyVersion: string }, { request: VString<string, "required"> ; attempt: VString<string, "required"> ; principal: VString<string, "required"> ; executor: VString<string, "required"> ; organization: VString<string, "required"> ; target: VObject<{ key: string ; type: string }, { type: VString<string, "required"> ; key: VString<string, "required"> }, "required", "key" | "type"> ; operation: VString<string, "required"> ; client: VString<string, "required"> ; session: VString<string, "required"> ; participant: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; policyVersion: VString<string, "required"> }, "required", "organization" | "principal" | "participant" | "target" | "operation" | "request" | "session" | "executor" | "attempt" | "client" | "target.key" | "policyVersion" | "target.type">
The operation owner captures this from authenticated request context. None
of these identities may be taken from a caller’s proposed risk verdict.
riskObservation
•Const riskObservation: VObject<{ decision: "unavailable" | "challenge" | "allow" | "deny" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; observedAt: number ; validUntil: number ; binding: string ; policyVersion: string }, { binding: VString<string, "required"> ; policyVersion: VString<string, "required"> ; decision: VUnion<"unavailable" | "challenge" | "allow" | "deny", [VLiteral<"allow", "required">, VLiteral<"deny", "required">, VLiteral<"challenge", "required">, VLiteral<"unavailable", "required">], "required", never> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; revision: VString<string, "required"> ; observedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> }, "required", "decision" | "source" | "revision" | "observedAt" | "validUntil" | "binding" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "policyVersion">
assessment
•Const assessment: VObject<{ kind: "unavailable" | "challenge" | "allow" | "deny" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: null | string ; reason: string ; validUntil: null | number ; binding: null | string ; handling: "refuse" | "challenge" }, { kind: VUnion<"unavailable" | "challenge" | "allow" | "deny", [VLiteral<"allow", "required">, VLiteral<"deny", "required">, VLiteral<"challenge", "required">, VLiteral<"unavailable", "required">], "required", never> ; binding: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; reason: VString<string, "required"> ; handling: VUnion<"refuse" | "challenge", [VLiteral<"refuse", "required">, VLiteral<"challenge", "required">], "required", never> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; revision: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; validUntil: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> }, "required", "kind" | "source" | "revision" | "reason" | "validUntil" | "binding" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "handling">
Not exported: an exported type refers to it.
securityPopulation
•Const securityPopulation: VUnion<{ kind: "unsupported" } | { kind: "unavailable" } | { kind: "observed" ; cursor: null | string ; coverage: "partial" | "complete" ; ids: string[] ; observedAtMs: number ; validUntilMs: null | number }, [VObject<{ kind: "unsupported" }, { kind: VLiteral<"unsupported", "required"> }, "required", "kind">, VObject<{ kind: "unavailable" }, { kind: VLiteral<"unavailable", "required"> }, "required", "kind">, VObject<{ kind: "observed" ; cursor: null | string ; coverage: "partial" | "complete" ; ids: string[] ; observedAtMs: number ; validUntilMs: null | number }, { kind: VLiteral<"observed", "required"> ; observedAtMs: VFloat64<number, "required"> ; validUntilMs: VUnion<null | number, [VFloat64<number, "required">, VNull<null, "required">], "required", never> ; coverage: VUnion<"partial" | "complete", [VLiteral<"complete", "required">, VLiteral<"partial", "required">], "required", never> ; ids: VArray<string[], VString<string, "required">, "required"> ; cursor: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> }, "required", "kind" | "cursor" | "coverage" | "ids" | "observedAtMs" | "validUntilMs">], "required", "kind" | "cursor" | "coverage" | "ids" | "observedAtMs" | "validUntilMs">
A population query receives the verified caller, never a caller-selected
person. Its own native reads and the inspection owner still enforce access.
Unsupported and unavailable populations never become empty inventories.
SERVICE_ISSUER
•Const SERVICE_ISSUER: "https://services.bijection.invalid"
The issuer every service principal’s issuer extends.
SESSION_SUBJECT
•Const SESSION_SUBJECT: "session:"
What an issued session’s subject is prefixed with.
CREDENTIAL_CLAIM
•Const CREDENTIAL_CLAIM: "bijectionCredential"
The claim naming the credential that authenticated a service or a session
it issued. Only the deployment’s own credential verification sets it.
workosEnterpriseHealthObservation
•Const workosEnterpriseHealthObservation: VObject<{ directoryEvidence: undefined | null | { 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; }; source: { …; }; directory: string; } ; record: null | { id: string; organization: string; directory: string | null; connectionState: string; ssoEnforced: null; connectionType: string; directoryState: string | null; certificateState: “unavailable” | “observed” | “notApplicable”; certificates: { …; }[]; } ; evidence: null | { dataset?: { component: string | null; dataset: string | null; version: string | null; revision: string | null; publicationId: SourcePublicationId | null; coherent: boolean; completeVersion: boolean; }; … 11 more …; historyInterrupted: boolean; } ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; selection: { connection: string; directory: string | null; } ; configuration: { issuer: string; clientId: string; providerOrganization: string; } }, { configuration: VObject<{ issuer: string ; clientId: string ; providerOrganization: string }, { issuer: VString<string, "required"> ; clientId: VString<string, "required"> ; providerOrganization: VString<string, "required"> }, "required", "issuer" | "clientId" | "providerOrganization"> ; selection: VObject<{ connection: string ; directory: null | string }, { connection: VString<string, "required"> ; directory: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> }, "required", "connection" | "directory"> ; source: VUnion<null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, [VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation">, VNull<null, "required">], "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> ; evidence: VUnion<null | { 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 }, [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}\`\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"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}`> ; directoryEvidence: VUnion<undefined | null | { 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; } ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; directory: string }, [VObject<{ 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; } ; source: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; directory: string }, { directory: VString<string, "required"> ; source: VObject<{ id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string }, { location: VObject<{ incarnation: string ; branch: null | { key: string; generation: string; } ; deployment_id: string }, { deployment_id: VString<string, "required"> ; incarnation: VString<string, "required"> ; branch: VUnion<null | { key: string ; generation: string }, [VNull<null, "required">, VObject<{ key: string ; generation: string }, { key: VString<string, "required"> ; generation: VString<string, "required"> }, "required", "key" | "generation">], "required", "key" | "generation"> }, "required", "incarnation" | "branch" | "deployment_id" | "branch.key" | "branch.generation"> ; installation: VString<string, "required"> ; protocol: VString<string, "required"> ; id: VString<string, "required"> }, "required", "id" | "installation" | "location" | "protocol" | "location.incarnation" | "location.branch" | "location.deployment_id" | "location.branch.key" | "location.branch.generation"> = subjectRefValidator; 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}\`\> = sourceStatusValidator.fields.evidence \}, ``"required"``, ``"evidence"`` \| ``"source"`` \| ``"directory"`` \| ``"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"`` \| \`evidence.capabilities.coverage.{any}` | `evidence.capabilities.history.\{any}\` \| \`evidence.capabilities.protocol.{any}` | `evidence.capabilities.atomicity.\{any}\` \| \`evidence.population.{any}` | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation">, VNull<null, "required">], "optional", "evidence" | "source" | "directory" | "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" | `evidence.capabilities.coverage.\{any}\` \| \`evidence.capabilities.history.{any}` | `evidence.capabilities.protocol.\{any}\` \| \`evidence.capabilities.atomicity.{any}` | `evidence.population.\{any}\` \| ``"source.id"`` \| ``"source.installation"`` \| ``"source.location"`` \| ``"source.protocol"`` \| ``"source.location.incarnation"`` \| ``"source.location.branch"`` \| ``"source.location.deployment_id"`` \| ``"source.location.branch.key"`` \| ``"source.location.branch.generation"``\> ; `record`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| \{ `id`: `string` ; `organization`: `string` ; `directory`: ``null`` \| `string` ; `connectionState`: `string` ; `ssoEnforced`: ``null`` ; `connectionType`: `string` ; `directoryState`: ``null`` \| `string` ; `certificateState`: ``"unavailable"`` \| ``"observed"`` \| ``"notApplicable"`` ; `certificates`: \{ id: string; notBefore: number \| null; notAfter: number \| null; \}[] \}, [[`VObject`](/api/classes/values.VObject)\<\{ `id`: `string` ; `organization`: `string` ; `directory`: ``null`` \| `string` ; `connectionState`: `string` ; `ssoEnforced`: ``null`` ; `connectionType`: `string` ; `directoryState`: ``null`` \| `string` ; `certificateState`: ``"unavailable"`` \| ``"observed"`` \| ``"notApplicable"`` ; `certificates`: \{ id: string; notBefore: number \| null; notAfter: number \| null; \}[] \}, \{ `id`: [`VString`](/api/classes/values.VString)\<`string`, ``"required"``\> ; `organization`: [`VString`](/api/classes/values.VString)\<`string`, ``"required"``\> ; `connectionType`: [`VString`](/api/classes/values.VString)\<`string`, ``"required"``\> ; `connectionState`: [`VString`](/api/classes/values.VString)\<`string`, ``"required"``\> ; `directory`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| `string`, [[`VString`](/api/classes/values.VString)\<`string`, ``"required"``\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"required"``, `never`\> ; `directoryState`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| `string`, [[`VString`](/api/classes/values.VString)\<`string`, ``"required"``\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"required"``, `never`\> ; `certificateState`: [`VUnion`](/api/classes/values.VUnion)\<``"unavailable"`` \| ``"observed"`` \| ``"notApplicable"``, [[`VLiteral`](/api/classes/values.VLiteral)\<``"observed"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"unavailable"``, ``"required"``\>, [`VLiteral`](/api/classes/values.VLiteral)\<``"notApplicable"``, ``"required"``\>], ``"required"``, `never`\> ; `certificates`: [`VArray`](/api/classes/values.VArray)\<\{ `id`: `string` ; `notBefore`: ``null`` \| `number` ; `notAfter`: ``null`` \| `number` \}[], [`VObject`](/api/classes/values.VObject)\<\{ `id`: `string` ; `notBefore`: ``null`` \| `number` ; `notAfter`: ``null`` \| `number` \}, \{ `id`: [`VString`](/api/classes/values.VString)\<`string`, ``"required"``\> ; `notBefore`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| `number`, [[`VFloat64`](/api/classes/values.VFloat64)\<`number`, ``"required"``\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"required"``, `never`\> ; `notAfter`: [`VUnion`](/api/classes/values.VUnion)\<``null`` \| `number`, [[`VFloat64`](/api/classes/values.VFloat64)\<`number`, ``"required"``\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"required"``, `never`\> \}, ``"required"``, ``"id"`` \| ``"notBefore"`` \| ``"notAfter"``\>, ``"required"``\> ; `ssoEnforced`: [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\> \}, ``"required"``, ``"id"`` \| ``"organization"`` \| ``"directory"`` \| ``"connectionState"`` \| ``"ssoEnforced"`` \| ``"connectionType"`` \| ``"directoryState"`` \| ``"certificateState"`` \| ``"certificates"``\>, [`VNull`](/api/classes/values.VNull)\<``null``, ``"required"``\>], ``"required"``, ``"id"`` \| ``"organization"`` \| ``"directory"`` \| ``"connectionState"`` \| ``"ssoEnforced"`` \| ``"connectionType"`` \| ``"directoryState"`` \| ``"certificateState"`` \| ``"certificates"``\> \}, ``"required"``, ``"record"`` \| ``"evidence"`` \| ``"source"`` \| ``"selection"`` \| ``"configuration"`` \| ``"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"`` \| \`evidence.capabilities.coverage.{any}` | `evidence.capabilities.history.\{any}\` \| \`evidence.capabilities.protocol.{any}` | `evidence.capabilities.atomicity.\{any}\` \| \`evidence.population.{any}` | "record.id" | "source.id" | "source.installation" | "source.location" | "source.protocol" | "source.location.incarnation" | "source.location.branch" | "source.location.deployment_id" | "source.location.branch.key" | "source.location.branch.generation" | "configuration.issuer" | "configuration.clientId" | "configuration.providerOrganization" | "directoryEvidence" | "record.organization" | "record.directory" | "record.connectionState" | "record.ssoEnforced" | "record.connectionType" | "record.directoryState" | "record.certificateState" | "record.certificates" | "selection.connection" | "selection.directory" | "directoryEvidence.evidence" | "directoryEvidence.source" | "directoryEvidence.directory" | "directoryEvidence.evidence.dataset" | "directoryEvidence.evidence.capabilities" | "directoryEvidence.evidence.population" | "directoryEvidence.evidence.erased" | "directoryEvidence.evidence.publication" | "directoryEvidence.evidence.populationCovered" | "directoryEvidence.evidence.populationObservedFrom" | "directoryEvidence.evidence.observedFrom" | "directoryEvidence.evidence.observedTo" | "directoryEvidence.evidence.continuityLost" | "directoryEvidence.evidence.historyInterrupted" | "directoryEvidence.evidence.recordObservedFrom" | "directoryEvidence.evidence.recordObservedTo" | "directoryEvidence.evidence.capabilities.evidence" | "directoryEvidence.evidence.capabilities.consistency" | "directoryEvidence.evidence.capabilities.coverage" | "directoryEvidence.evidence.capabilities.reconciliation" | "directoryEvidence.evidence.capabilities.history" | "directoryEvidence.evidence.capabilities.protocol" | "directoryEvidence.evidence.capabilities.atomicity" | "directoryEvidence.evidence.capabilities.recordRefresh" | "directoryEvidence.evidence.capabilities.notifications" | "directoryEvidence.evidence.capabilities.snapshotMaxRows" | "directoryEvidence.evidence.dataset.component" | "directoryEvidence.evidence.dataset.dataset" | "directoryEvidence.evidence.dataset.version" | "directoryEvidence.evidence.dataset.revision" | "directoryEvidence.evidence.dataset.publicationId" | "directoryEvidence.evidence.dataset.coherent" | "directoryEvidence.evidence.dataset.completeVersion" | "directoryEvidence.evidence.publication.sourceId" | "directoryEvidence.evidence.publication.scope" | "directoryEvidence.evidence.publication.publicationId" | "directoryEvidence.evidence.publication.checkpoint" | "directoryEvidence.evidence.publication.epoch" | "directoryEvidence.evidence.publication.checkpoint.position" | "directoryEvidence.evidence.publication.checkpoint.captureId" | "directoryEvidence.evidence.publication.checkpoint.position.value" | "directoryEvidence.evidence.publication.checkpoint.position.space" | `directoryEvidence.evidence.capabilities.coverage.\{any}\` \| \`directoryEvidence.evidence.capabilities.history.{any}` | `directoryEvidence.evidence.capabilities.protocol.\{any}\` \| \`directoryEvidence.evidence.capabilities.atomicity.{any}` | `directoryEvidence.evidence.population.${any}` | "directoryEvidence.source.id" | "directoryEvidence.source.installation" | "directoryEvidence.source.location" | "directoryEvidence.source.protocol" | "directoryEvidence.source.location.incarnation" | "directoryEvidence.source.location.branch" | "directoryEvidence.source.location.deployment_id" | "directoryEvidence.source.location.branch.key" | "directoryEvidence.source.location.branch.generation">
Read only through a fixed internal query which obtains the row and its exact
record evidence from ctx.sources.evidence(…,{record:row._id}).
Functions
defineClassificationProfile
▸ defineClassificationProfile<Name, Required, C>(input): ClassificationProfile<Name, Required, C>
A fixed classification vocabulary with explicit required resource bindings.
Every generated binding protects object identity and readable properties and
refuses empty or unknown classification sets on create, update and move.
A profile either declares its own categories or adopts the organization’s
central label registry. A registry-bound profile cannot redefine a
category: the management registry is the only author, the profile records
the revision it compiled, and clearances declares the directory through
which the deployment acquires central clearances.
Type parameters
Parameters
Returns
ClassificationProfile<Name, Required, C>
▸ defineClassificationProfile<Name, Required, R>(input): ClassificationProfile<Name, Required, RegistryCategories<R>>
Type parameters
Parameters
Returns
ClassificationProfile<Name, Required, RegistryCategories<R>>
classificationProfile
▸ classificationProfile<Name, Required, C>(input, registry): Readonly<{ resources: Readonly<Record<Name, Readonly<{ category: Readonly<{ from: "key" }> ; clearance?: "registry" ; permissions: ["pass", "apply", "declassify"] ; dominates?: Readonly<Record<string, readonly string[]>> }>>> ; categories: Readonly<Record<keyof C & string, "any" | "all">> ; registry: null | Readonly<{ organization: string ; revision: number }> ; clearances: <Table>(options: { table: Table ; maxAge: number ; member?: string ; object?: string ; memberIndex?: string ; objectIndex?: string }) => Readonly<{ roles: Readonly<Record<`\{Name}:cleared\`, readonly [\`{Name}:pass`]>> ; directory: Readonly<{ table: Table = options.table; memberIndex: string ; objectIndex: string ; type: Name = resourceName; role: Readonly<{ kind: "declared" ; key: `${Name}:cleared` = role }> ; member: string ; object: string ; maxAge: number = options.maxAge }> }> ; labelName: (key: ClassificationKey<C>) => string ; labelNames: (selection: Selection) => string[] ; keyOf: (name: string) => ClassificationKey<C> | null ; readers: (options: { member: (ctx: any) => Promise<boolean> ; principalOf?: (ctx: any, actor: string) => Promise<AccessPrincipal | null> }) => Readonly<{ member: (ctx: any) => Promise<boolean> = options.member; cleared: (ctx: any, names: readonly string[]) => Promise<boolean> ; permits: (ctx: any, names: readonly string[]) => Promise<boolean> = cleared; clearedFor: (ctx: any, actor: string, names: readonly string[]) => Promise<boolean> }> ; datasetRelease: (input: { destination: string ; dataset: { dataset: string ; definition: { labels?: readonly string[] } } ; publisher: string ; requires: string }) => AccessRelease ; validator: VArray<ClassificationKey<C>[], VUnion<ClassificationKey<C>, VLiteral<ClassificationKey<C>, "required">[], "required", never>, "required"> ; release: <Destination>(input: { destination: Destination ; requires?: string ; publisher?: string ; when?: NonNullable<AccessRelease["when"]> ; accepts: readonly ClassificationKey<C>[] ; declassify?: boolean }) => AccessRelease & { destination: Destination } ; modelEgress: <Providers>(input: { providers: Providers ; requires: string ; approved: readonly ClassificationKey<C>[] }) => { destinations: { [K in keyof Providers]: Object } ; releases: { [K in keyof Providers]: AccessRelease & Object } } ; bindings: <B>(bindings: B & Record<Exclude<keyof B, Required[number]>, never>) => { [K in string | number | symbol]: B[K] extends Object ? ClassifiedBinding<A, Name, any[any][“field”]> : never } }>
Not exported: an exported type refers to it.
Type parameters
Parameters
Returns
Readonly<{ resources: Readonly<Record<Name, Readonly<{ category: Readonly<{ from: "key" }> ; clearance?: "registry" ; permissions: ["pass", "apply", "declassify"] ; dominates?: Readonly<Record<string, readonly string[]>> }>>> ; categories: Readonly<Record<keyof C & string, "any" | "all">> ; registry: null | Readonly<{ organization: string ; revision: number }> ; clearances: <Table>(options: { table: Table ; maxAge: number ; member?: string ; object?: string ; memberIndex?: string ; objectIndex?: string }) => Readonly<{ roles: Readonly<Record<`\{Name}:cleared\`, readonly [\`{Name}:pass`]>> ; directory: Readonly<{ table: Table = options.table; memberIndex: string ; objectIndex: string ; type: Name = resourceName; role: Readonly<{ kind: "declared" ; key: `${Name}:cleared` = role }> ; member: string ; object: string ; maxAge: number = options.maxAge }> }> ; labelName: (key: ClassificationKey<C>) => string ; labelNames: (selection: Selection) => string[] ; keyOf: (name: string) => ClassificationKey<C> | null ; readers: (options: { member: (ctx: any) => Promise<boolean> ; principalOf?: (ctx: any, actor: string) => Promise<AccessPrincipal | null> }) => Readonly<{ member: (ctx: any) => Promise<boolean> = options.member; cleared: (ctx: any, names: readonly string[]) => Promise<boolean> ; permits: (ctx: any, names: readonly string[]) => Promise<boolean> = cleared; clearedFor: (ctx: any, actor: string, names: readonly string[]) => Promise<boolean> }> ; datasetRelease: (input: { destination: string ; dataset: { dataset: string ; definition: { labels?: readonly string[] } } ; publisher: string ; requires: string }) => AccessRelease ; validator: VArray<ClassificationKey<C>[], VUnion<ClassificationKey<C>, VLiteral<ClassificationKey<C>, "required">[], "required", never>, "required"> ; release: <Destination>(input: { destination: Destination ; requires?: string ; publisher?: string ; when?: NonNullable<AccessRelease["when"]> ; accepts: readonly ClassificationKey<C>[] ; declassify?: boolean }) => AccessRelease & { destination: Destination } ; modelEgress: <Providers>(input: { providers: Providers ; requires: string ; approved: readonly ClassificationKey<C>[] }) => { destinations: { [K in keyof Providers]: Object } ; releases: { [K in keyof Providers]: AccessRelease & Object } } ; bindings: <B>(bindings: B & Record<Exclude<keyof B, Required[number]>, never>) => { [K in string | number | symbol]: B[K] extends Object ? ClassifiedBinding<A, Name, any[any][“field”]> : never } }>
componentWork
▸ componentWork(bindings): (destination: Destination) => Promise<boolean>
Component work in a hand-written destination rule, with the access model’s
meaning: a release is admitted when a binding consents to its component’s
scheduled work holding the rule’s rows (custody), or names an effect that
admits the destination and the release is that component’s own work.
Returns false otherwise, including a consented effect’s destination reached
by other work (a member’s own act, say), for the rule’s own decision. Call
it inside a private policy (declare reads); restrictions stay the rule’s.
Parameters
Returns
fn
▸ (destination): Promise<boolean>
Parameters
Returns
Promise<boolean>
defineAccessContracts
▸ defineAccessContracts<T>(input): Readonly<T>
Native admission independently checks schema and physical index bindings.
Type parameters
Parameters
Returns
Readonly<T>
decisionQuery
▸ decisionQuery(installation): RegisteredQuery<"internal", { checks: { key: string; type: string; permission: string; }[] }, Promise<PermissionResult[]>>
Not exported: an exported type refers to it.
Parameters
Returns
RegisteredQuery<"internal", { checks: { key: string; type: string; permission: string; }[] }, Promise<PermissionResult[]>>
defineEvidence
▸ defineEvidence<T>(declarations): Readonly<T>
Type parameters
Parameters
Returns
Readonly<T>
canonicalContact
▸ canonicalContact(kind, input): ContactIdentity
Canonicalize under an explicitly declared contact type.
Parameters
Returns
ContactIdentity
validateContactField
▸ validateContactField(value): void
Parameters
Returns
void
defineInformationProtection
▸ defineInformationProtection<Field, Resource>(protection): Readonly<{ protect: <P, F>(field: F) => F }>
Name one protection so every field carrying it states the same obligations.
Type parameters
Parameters
Returns
Readonly<{ protect: <P, F>(field: F) => F }>
expiryMutation
▸ expiryMutation(lifecycle): RegisteredMutation<"internal", { assignmentId: GenericId<string> }, Promise<null>>
Not exported: an exported type refers to it.
Parameters
Returns
RegisteredMutation<"internal", { assignmentId: GenericId<string> }, Promise<null>>
principalReference
▸ principalReference<Key>(key): AccessPrincipal<Key>
Type parameters
Parameters
Returns
AccessPrincipal<Key>
defineReleases
▸ defineReleases<Destinations, Releases>(destinations, releases): Releases
Declare reusable transfer contracts against a destination vocabulary. Command
argument predicates retain the exact receiver’s argument type. Native admission
independently resolves every reference; this builder grants no authority.
Type parameters
Parameters
Returns
Releases
receiver
▸ receiver<C>(command): Object
Name an integration command boundary. This declaration supplies no source
permission or transfer consent; releases reference the installed destination.
Type parameters
Parameters
Returns
Object
createAccessReader
▸ createAccessReader<D>(definition, ctx): Pick<RequestAccessModel<D, GenericSchema>, ReaderMethod>
Construct the same request API for a library’s selected declaration.
Type parameters
Parameters
Returns
Pick<RequestAccessModel<D, GenericSchema>, ReaderMethod>
createAccessWriter
▸ createAccessWriter<D>(definition, ctx): RequestAccessModel<D, GenericSchema>
Construct assignment operations for a mutation context.
Type parameters
Parameters
Returns
RequestAccessModel<D, GenericSchema>
assignmentsTable
▸ assignmentsTable():TableDefinition<VUnion<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "person" ; holderKey: string } | { expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "service" ; holderKey: string } | { reason: undefined | string ; key: string ; type: string ; expiresAt: number ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "program" ; holderKey: string ; holderProgram: { record: string; implementation: string; installation: string; callback: string; } } | { expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "group" ; holderType: string ; holderKey: string ; holderPermission: string }, [VObject<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "person" ; holderKey: string }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"person", "required"> }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderKey" | "role.key" | "role.kind" | "role.id">, VObject<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "service" ; holderKey: string }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"service", "required"> }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderKey" | "role.key" | "role.kind" | "role.id">, VObject<{ reason: undefined | string ; key: string ; type: string ; expiresAt: number ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "program" ; holderKey: string ; holderProgram: { record: string; implementation: string; installation: string; callback: string; } }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"program", "required"> ; expiresAt: VFloat64<number, "required"> ; holderProgram: VObject<{ record: string ; implementation: string ; installation: string ; callback: string }, { installation: VString<string, "required"> ; callback: VString<string, "required"> ; record: VString<string, "required"> ; implementation: VString<string, "required"> }, "required", "record" | "implementation" | "installation" | "callback"> = programGrantRefValidator }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderKey" | "role.key" | "role.kind" | "role.id" | "holderProgram" | "holderProgram.record" | "holderProgram.implementation" | "holderProgram.installation" | "holderProgram.callback">, VObject<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "group" ; holderType: string ; holderKey: string ; holderPermission: string }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"group", "required"> ; holderType: VString<string, "required"> ; holderPermission: VString<string, "required"> }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderType" | "holderKey" | "holderPermission" | "role.key" | "role.kind" | "role.id">], "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderType" | "holderKey" | "holderPermission" | "role.key" | "role.kind" | "role.id" | "holderProgram" | "holderProgram.record" | "holderProgram.implementation" | "holderProgram.installation" | "holderProgram.callback">, { by_holder: ["holderKind", "holderType", "holderKey", "holderPermission", "type", "key", "_creationTime"] ; by_resource: ["type", "key", "holderKind", "role.kind", "role.key", "role.id", "holderKey", "_creationTime"] ; by_role: ["role.kind", "role.key", "role.id", "type", "key", "_creationTime"] ; by_key: ["key", "_creationTime"] }, {}, {}, false, {}>
Not exported: an exported type refers to it.
Returns
TableDefinition<VUnion<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "person" ; holderKey: string } | { expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "service" ; holderKey: string } | { reason: undefined | string ; key: string ; type: string ; expiresAt: number ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "program" ; holderKey: string ; holderProgram: { record: string; implementation: string; installation: string; callback: string; } } | { expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "group" ; holderType: string ; holderKey: string ; holderPermission: string }, [VObject<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "person" ; holderKey: string }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"person", "required"> }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderKey" | "role.key" | "role.kind" | "role.id">, VObject<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "service" ; holderKey: string }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"service", "required"> }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderKey" | "role.key" | "role.kind" | "role.id">, VObject<{ reason: undefined | string ; key: string ; type: string ; expiresAt: number ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "program" ; holderKey: string ; holderProgram: { record: string; implementation: string; installation: string; callback: string; } }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"program", "required"> ; expiresAt: VFloat64<number, "required"> ; holderProgram: VObject<{ record: string ; implementation: string ; installation: string ; callback: string }, { installation: VString<string, "required"> ; callback: VString<string, "required"> ; record: VString<string, "required"> ; implementation: VString<string, "required"> }, "required", "record" | "implementation" | "installation" | "callback"> = programGrantRefValidator }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderKey" | "role.key" | "role.kind" | "role.id" | "holderProgram" | "holderProgram.record" | "holderProgram.implementation" | "holderProgram.installation" | "holderProgram.callback">, VObject<{ expiresAt: undefined | number ; reason: undefined | string ; key: string ; type: string ; role: { key: string; kind: “declared”; } | { kind: “tenant”; id: string; } ; holderKind: "group" ; holderType: string ; holderKey: string ; holderPermission: string }, { type: VString<string, "required"> ; key: VString<string, "required"> ; role: VUnion<{ key: string ; kind: "declared" } | { kind: "tenant" ; id: string }, [VObject<{ key: string ; kind: "declared" }, { kind: VLiteral<"declared", "required"> ; key: VString<string, "required"> }, "required", "key" | "kind">, VObject<{ kind: "tenant" ; id: string }, { kind: VLiteral<"tenant", "required"> ; id: VString<string, "required"> }, "required", "kind" | "id">], "required", "key" | "kind" | "id"> ; holderKey: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; reason: VString<undefined | string, "optional"> ; holderKind: VLiteral<"group", "required"> ; holderType: VString<string, "required"> ; holderPermission: VString<string, "required"> }, "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderType" | "holderKey" | "holderPermission" | "role.key" | "role.kind" | "role.id">], "required", "key" | "type" | "expiresAt" | "reason" | "role" | "holderKind" | "holderType" | "holderKey" | "holderPermission" | "role.key" | "role.kind" | "role.id" | "holderProgram" | "holderProgram.record" | "holderProgram.implementation" | "holderProgram.installation" | "holderProgram.callback">, { by_holder: ["holderKind", "holderType", "holderKey", "holderPermission", "type", "key", "_creationTime"] ; by_resource: ["type", "key", "holderKind", "role.kind", "role.key", "role.id", "holderKey", "_creationTime"] ; by_role: ["role.kind", "role.key", "role.id", "type", "key", "_creationTime"] ; by_key: ["key", "_creationTime"] }, {}, {}, false, {}>
requestsTable
▸ requestsTable(assignments, expire): TableDefinition<VObject<{ expiresAt: undefined | number ; comment: undefined | string ; reviewer: undefined | string ; assignmentId: undefined | string ; reviewerLabel: undefined | string ; key: string ; requestId: string ; type: string ; reason: string ; role: string ; updatedAt: number ; status: "pending" | "rejected" | "approved" | "withdrawn" ; acknowledged: boolean ; beneficiary: string ; requester: string ; requesterLabel: string }, { requestId: VString<string, "required"> ; type: VString<string, "required"> ; key: VString<string, "required"> ; role: VString<string, "required"> ; beneficiary: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; requester: VString<string, "required"> ; requesterLabel: VString<string, "required"> ; reason: VString<string, "required"> ; status: VUnion<"pending" | "rejected" | "approved" | "withdrawn", [VLiteral<"pending", "required">, VLiteral<"approved", "required">, VLiteral<"rejected", "required">, VLiteral<"withdrawn", "required">], "required", never> ; acknowledged: VBoolean<boolean, "required"> ; updatedAt: VFloat64<number, "required"> ; reviewer: VString<undefined | string, "optional"> ; reviewerLabel: VString<undefined | string, "optional"> ; comment: VString<undefined | string, "optional"> ; assignmentId: VString<undefined | string, "optional"> }, "required", "key" | "requestId" | "type" | "expiresAt" | "reason" | "role" | "updatedAt" | "status" | "comment" | "reviewer" | "acknowledged" | "assignmentId" | "beneficiary" | "requester" | "requesterLabel" | "reviewerLabel">, { by_status: ["status", "_creationTime"] ; by_requester: ["requester", "status", "_creationTime"] ; by_request: ["requester", "requestId", "_creationTime"] ; by_beneficiary: ["beneficiary", "status", "_creationTime"] ; by_requester_resource: ["requester", "type", "key", "_creationTime"] ; by_beneficiary_resource: ["beneficiary", "type", "key", "_creationTime"] ; by_resource: ["type", "key", "role", "status", "_creationTime"] }, {}, {}, false, {}>
Not exported: an exported type refers to it.
Parameters
Returns
TableDefinition<VObject<{ expiresAt: undefined | number ; comment: undefined | string ; reviewer: undefined | string ; assignmentId: undefined | string ; reviewerLabel: undefined | string ; key: string ; requestId: string ; type: string ; reason: string ; role: string ; updatedAt: number ; status: "pending" | "rejected" | "approved" | "withdrawn" ; acknowledged: boolean ; beneficiary: string ; requester: string ; requesterLabel: string }, { requestId: VString<string, "required"> ; type: VString<string, "required"> ; key: VString<string, "required"> ; role: VString<string, "required"> ; beneficiary: VString<string, "required"> ; expiresAt: VFloat64<undefined | number, "optional"> ; requester: VString<string, "required"> ; requesterLabel: VString<string, "required"> ; reason: VString<string, "required"> ; status: VUnion<"pending" | "rejected" | "approved" | "withdrawn", [VLiteral<"pending", "required">, VLiteral<"approved", "required">, VLiteral<"rejected", "required">, VLiteral<"withdrawn", "required">], "required", never> ; acknowledged: VBoolean<boolean, "required"> ; updatedAt: VFloat64<number, "required"> ; reviewer: VString<undefined | string, "optional"> ; reviewerLabel: VString<undefined | string, "optional"> ; comment: VString<undefined | string, "optional"> ; assignmentId: VString<undefined | string, "optional"> }, "required", "key" | "requestId" | "type" | "expiresAt" | "reason" | "role" | "updatedAt" | "status" | "comment" | "reviewer" | "acknowledged" | "assignmentId" | "beneficiary" | "requester" | "requesterLabel" | "reviewerLabel">, { by_status: ["status", "_creationTime"] ; by_requester: ["requester", "status", "_creationTime"] ; by_request: ["requester", "requestId", "_creationTime"] ; by_beneficiary: ["beneficiary", "status", "_creationTime"] ; by_requester_resource: ["requester", "type", "key", "_creationTime"] ; by_beneficiary_resource: ["beneficiary", "type", "key", "_creationTime"] ; by_resource: ["type", "key", "role", "status", "_creationTime"] }, {}, {}, false, {}>
roleDefinitionsTable
▸ roleDefinitionsTable():TableDefinition<VObject<{ guests: undefined | boolean ; maxDuration: undefined | number ; reasonRequired: undefined | boolean ; name: string ; type: string ; scope: string ; permissions: string[] }, { scope: VString<string, "required"> ; type: VString<string, "required"> ; name: VString<string, "required"> ; permissions: VArray<string[], VString<string, "required">, "required"> ; maxDuration: VFloat64<undefined | number, "optional"> ; reasonRequired: VBoolean<undefined | boolean, "optional"> ; guests: VBoolean<undefined | boolean, "optional"> }, "required", "name" | "type" | "scope" | "permissions" | "guests" | "maxDuration" | "reasonRequired">, { by_scope: ["scope", "type", "name", "_creationTime"] }, {}, {}, false, {}>
Not exported: an exported type refers to it.
Returns
TableDefinition<VObject<{ guests: undefined | boolean ; maxDuration: undefined | number ; reasonRequired: undefined | boolean ; name: string ; type: string ; scope: string ; permissions: string[] }, { scope: VString<string, "required"> ; type: VString<string, "required"> ; name: VString<string, "required"> ; permissions: VArray<string[], VString<string, "required">, "required"> ; maxDuration: VFloat64<undefined | number, "optional"> ; reasonRequired: VBoolean<undefined | boolean, "optional"> ; guests: VBoolean<undefined | boolean, "optional"> }, "required", "name" | "type" | "scope" | "permissions" | "guests" | "maxDuration" | "reasonRequired">, { by_scope: ["scope", "type", "name", "_creationTime"] }, {}, {}, false, {}>
admissionGates
▸ admissionGates<Gates>(gates): Readonly<{ requirements: { readonly [Name in string | number | symbol]: Omit<Gates[Name], “kind”> } ; describe: () => { name: string ; kind: AdmissionGateKind ; permissions: string[] }[] }>
Use .requirements in a resource binding or defineAccess declaration.
Inspection metadata describes the gate’s owner category, never a verdict
about private facts or permission to attempt a business operation.
Type parameters
Parameters
Returns
Readonly<{ requirements: { readonly [Name in string | number | symbol]: Omit<Gates[Name], “kind”> } ; describe: () => { name: string ; kind: AdmissionGateKind ; permissions: string[] }[] }>
defineAllowance
▸ defineAllowance(definition): AllowanceDefinition
Declare once, then import the same definition in charges and allocations.
Parameters
Returns
AllowanceDefinition
allowanceKey
▸ allowanceKey(value): string
Parameters
Returns
string
checkedAllocations
▸ checkedAllocations(allocations, fail?): Readonly<Record<string, bigint | "unbounded">>
Validate allocations when minting a delegation.
Parameters
Returns
Readonly<Record<string, bigint | "unbounded">>
applicationAuth
▸ applicationAuth(options): Object
Mount the returned handler at basePath/* and /connections/callback in
your application’s server. No provider or native refresh grant reaches JS.
Cookies hold opaque references; rotation and exact recovery live in Bijection.
Parameters
Returns
Object
reviewAuthIsolation
▸ reviewAuthIsolation(config, forbidden): { name: string = test.name; issuer: string = test.issuer; audiences: string[] ; outcome: "overlapping" | "isolated" ; matchingProviders: number[] ; evidence: "resolvedConfiguration" }[]
Evaluate resolved issuer/audience admission. This is a configuration review,
independently of whether a token has a valid signature or current lifetime.
Parameters
Returns
{name: string = test.name; issuer: string = test.issuer; audiences: string[] ; outcome: "overlapping" | "isolated" ; matchingProviders: number[] ; evidence: "resolvedConfiguration" }[]
isolateAuthentication
▸ isolateAuthentication<T>(config, forbidden): T
Use as the default export of auth.config.ts so normal deployment analysis
refuses an issuer/audience overlap with the declared unwanted contexts.
Type parameters
Parameters
Returns
T
identityAdmin
▸ identityAdmin(options): Object
Server-only native identity administration. Keep the deployment key in
private server custody and retain the exact control across an unknown result.
Parameters
Returns
Object
applicationSignInClients
▸ applicationSignInClients(_ctx): Promise<{ sourceId: string ; issuer: string ; clientId: string ; revision: string ; digest: string }[]>
Public installed client facts, under the native login policy’s tracked
revisions. A registration proves configuration, never provider health.
Parameters
Returns
Promise<{ sourceId: string ; issuer: string ; clientId: string ; revision: string ; digest: string }[]>
defineAuditEvents
▸ defineAuditEvents<Events>(events): Readonly<{ definitions: AuditEventDefinitions ; describe: () => { resources: string[] ; metadata: ValidatorJSON ; name: string ; digest: string }[] ; record: <Name>(access: object, _ctx: AccessCtx, resource: AccessResourceRef, name: Name, metadata: Infer<Events[Name]["metadata"]>) => Promise<void> }>
Install .definitions in defineSchema({ … }, { auditEvents }). Runtime
recording selects the installed contract; native attribution remains separate
from application-authored metadata.
Type parameters
Parameters
Returns
Readonly<{ definitions: AuditEventDefinitions ; describe: () => { resources: string[] ; metadata: ValidatorJSON ; name: string ; digest: string }[] ; record: <Name>(access: object, _ctx: AccessCtx, resource: AccessResourceRef, name: Name, metadata: Infer<Events[Name]["metadata"]>) => Promise<void> }>
defineAuditSubscriptions
▸ defineAuditSubscriptions(input): Object
Customer-owned journal subscriptions reuse native service grants, scoped
reads and command delivery. Install all three tables and exact writer
functions; a destination is an installed command/binding, never a URL.
The current governing query re-opens and hashes the journal body at every
send, retaining native source/key fences through physical dispatch.
Parameters
Returns
Object
assertAuthorization
▸ assertAuthorization<Args>(authorize, ...args): Promise<void>
Run an authorization assertion. Denial throws; returned values never grant access.
Type parameters
Parameters
Returns
Promise<void>
automationCredentials
▸ automationCredentials(access): Readonly<{ create: (_ctx: AccessCtx, resource: AccessResourceRef, input: { service: string ; permissions: readonly string[] ; label: string ; expiresAt: number ; requestId: string ; functions?: readonly string[] ; participation?: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean }> ; list: (_ctx: AccessCtx, resource: AccessResourceRef) => Promise<{ credentials: AutomationCredential[] }> ; rotate: (_ctx: AccessCtx, credential: string, input: { label: string ; expiresAt: number ; overlapMs: number ; requestId: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean ; predecessor: string ; overlapUntil: number }> ; usage: (ctx: AccessCtx, resource: AccessResourceRef, input: { credential: string ; limit: number ; cursor?: string | null ; from?: number ; to?: number }) => Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }> ; revoke: (_ctx: AccessCtx, credential: string) => Promise<{ credential: string ; revoked: boolean }> ; functions: { create: RegisteredMutation<"public", { participation: undefined | string ; functions: undefined | string[] ; requestId: string ; resource: { key: string; type: string; } ; service: string ; expiresAt: number ; label: string ; permissions: string[] }, Promise<{ credential: string ; secret: null | string ; created: boolean }>> ; list: RegisteredQuery<"public", { resource: { key: string; type: string; } }, Promise<{ credentials: AutomationCredential[] }>> ; rotate: RegisteredMutation<"public", { requestId: string ; credential: string ; expiresAt: number ; label: string ; overlapMs: number }, Promise<{ credential: string ; secret: null | string ; created: boolean ; predecessor: string ; overlapUntil: number }>> ; usage: RegisteredQuery<"public", { cursor: undefined | null | string ; from: undefined | number ; to: undefined | number ; resource: { key: string; type: string; } ; credential: string ; limit: number }, Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }>> ; revoke: RegisteredMutation<"public", { credential: string }, Promise<{ credential: string ; revoked: boolean }>> } }>
Customer-owned automation uses deployment-minted service secrets under
native permission/resource restrictions. A retry recovers the original ID;
the secret is returned only once.
Parameters
Returns
Readonly<{ create: (_ctx: AccessCtx, resource: AccessResourceRef, input: { service: string ; permissions: readonly string[] ; label: string ; expiresAt: number ; requestId: string ; functions?: readonly string[] ; participation?: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean }> ; list: (_ctx: AccessCtx, resource: AccessResourceRef) => Promise<{ credentials: AutomationCredential[] }> ; rotate: (_ctx: AccessCtx, credential: string, input: { label: string ; expiresAt: number ; overlapMs: number ; requestId: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean ; predecessor: string ; overlapUntil: number }> ; usage: (ctx: AccessCtx, resource: AccessResourceRef, input: { credential: string ; limit: number ; cursor?: string | null ; from?: number ; to?: number }) => Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }> ; revoke: (_ctx: AccessCtx, credential: string) => Promise<{ credential: string ; revoked: boolean }> ; functions: { create: RegisteredMutation<"public", { participation: undefined | string ; functions: undefined | string[] ; requestId: string ; resource: { key: string; type: string; } ; service: string ; expiresAt: number ; label: string ; permissions: string[] }, Promise<{ credential: string ; secret: null | string ; created: boolean }>> ; list: RegisteredQuery<"public", { resource: { key: string; type: string; } }, Promise<{ credentials: AutomationCredential[] }>> ; rotate: RegisteredMutation<"public", { requestId: string ; credential: string ; expiresAt: number ; label: string ; overlapMs: number }, Promise<{ credential: string ; secret: null | string ; created: boolean ; predecessor: string ; overlapUntil: number }>> ; usage: RegisteredQuery<"public", { cursor: undefined | null | string ; from: undefined | number ; to: undefined | number ; resource: { key: string; type: string; } ; credential: string ; limit: number }, Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }>> ; revoke: RegisteredMutation<"public", { credential: string }, Promise<{ credential: string ; revoked: boolean }>> } }>
personalCredentials
▸ personalCredentials(access): Readonly<{ create: (_ctx: AccessCtx, resource: AccessResourceRef, input: { service: string ; permissions: readonly string[] ; label: string ; expiresAt: number ; requestId: string ; functions?: readonly string[] ; participation?: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean }> ; list: (_ctx: AccessCtx, resource: AccessResourceRef) => Promise<{ credentials: AutomationCredential[] }> ; rotate: (_ctx: AccessCtx, credential: string, input: { label: string ; expiresAt: number ; overlapMs: number ; requestId: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean ; predecessor: string ; overlapUntil: number }> ; usage: (ctx: AccessCtx, resource: AccessResourceRef, input: { credential: string ; limit: number ; cursor?: string | null ; from?: number ; to?: number }) => Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }> ; revoke: (_ctx: AccessCtx, credential: string) => Promise<{ credential: string ; revoked: boolean }> ; functions: { create: RegisteredMutation<"public", { participation: undefined | string ; functions: undefined | string[] ; requestId: string ; resource: { key: string; type: string; } ; service: string ; expiresAt: number ; label: string ; permissions: string[] }, Promise<{ credential: string ; secret: null | string ; created: boolean }>> ; list: RegisteredQuery<"public", { resource: { key: string; type: string; } }, Promise<{ credentials: AutomationCredential[] }>> ; rotate: RegisteredMutation<"public", { requestId: string ; credential: string ; expiresAt: number ; label: string ; overlapMs: number }, Promise<{ credential: string ; secret: null | string ; created: boolean ; predecessor: string ; overlapUntil: number }>> ; usage: RegisteredQuery<"public", { cursor: undefined | null | string ; from: undefined | number ; to: undefined | number ; resource: { key: string; type: string; } ; credential: string ; limit: number }, Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }>> ; revoke: RegisteredMutation<"public", { credential: string }, Promise<{ credential: string ; revoked: boolean }>> } }>
Durable personal access retains live participation and the person’s current
authority, independently of browser sign-in. It supplies no provider claims
or human authentication assurance.
Parameters
Returns
Readonly<{ create: (_ctx: AccessCtx, resource: AccessResourceRef, input: { service: string ; permissions: readonly string[] ; label: string ; expiresAt: number ; requestId: string ; functions?: readonly string[] ; participation?: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean }> ; list: (_ctx: AccessCtx, resource: AccessResourceRef) => Promise<{ credentials: AutomationCredential[] }> ; rotate: (_ctx: AccessCtx, credential: string, input: { label: string ; expiresAt: number ; overlapMs: number ; requestId: string }) => Promise<{ credential: string ; secret: string | null ; created: boolean ; predecessor: string ; overlapUntil: number }> ; usage: (ctx: AccessCtx, resource: AccessResourceRef, input: { credential: string ; limit: number ; cursor?: string | null ; from?: number ; to?: number }) => Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }> ; revoke: (_ctx: AccessCtx, credential: string) => Promise<{ credential: string ; revoked: boolean }> ; functions: { create: RegisteredMutation<"public", { participation: undefined | string ; functions: undefined | string[] ; requestId: string ; resource: { key: string; type: string; } ; service: string ; expiresAt: number ; label: string ; permissions: string[] }, Promise<{ credential: string ; secret: null | string ; created: boolean }>> ; list: RegisteredQuery<"public", { resource: { key: string; type: string; } }, Promise<{ credentials: AutomationCredential[] }>> ; rotate: RegisteredMutation<"public", { requestId: string ; credential: string ; expiresAt: number ; label: string ; overlapMs: number }, Promise<{ credential: string ; secret: null | string ; created: boolean ; predecessor: string ; overlapUntil: number }>> ; usage: RegisteredQuery<"public", { cursor: undefined | null | string ; from: undefined | number ; to: undefined | number ; resource: { key: string; type: string; } ; credential: string ; limit: number }, Promise<{ items: { id: string ; revision: string ; recordedAtMs: number ; source: string ; outcome: "refused" | "observed" | "committed" | "execution_failed" | "authorized" ; observed_at_ms: number ; request_id: null | string ; function: null | string ; actor: null | Record<string, Value> ; body: Value }[] = observations; latestAuthenticationInPage: null | number ; coverage: { authentication: "nativeCustomerSecretPresentations" ; authorizedUse: "notCollected" ; range: "retainedJournalPage" ; complete: boolean = !page.hasMore } ; cursor: null | string ; hasMore: boolean ; retentionDays: number ; earliestRecordingTimeMs: number ; snapshotRevision: string }>> ; revoke: RegisteredMutation<"public", { credential: string }, Promise<{ credential: string ; revoked: boolean }>> } }>
defineBillableParticipation
▸ defineBillableParticipation(input): Object
Retains one exact meter report and its original native command. The count
comes only from an installed query. Install table/state and export functions
under module; current report and meter policy still authorize every send.
Parameters
Returns
Object
componentAccessPolicyFor
▸ componentAccessPolicyFor<Kind>(...kinds): ComponentAccessPolicy<Kind>
A package-owned access contract whose handlers see only these resource
kinds. A decision about any other kind refuses before the handler runs.
Type parameters
Parameters
Returns
ComponentAccessPolicy<Kind>
exposeFunctions
▸ exposeFunctions<T>(registrations, metadata): T
Publish the ordinary public functions returned by a component’s root
application helper. Internal helpers and native operation doors keep their
own declarations. The supplied admission is shared, never a new policy.
Type parameters
Parameters
Returns
T
domainName
▸ domainName(value): string
Parameters
Returns
string
domainRoutingResources
▸ domainRoutingResources<Owner>(owner?): Object
Public discovery contains only deliberately published route descriptors.
Claims remain private children of their actual organization.
Type parameters
Parameters
Returns
Object
defineDomainRouting
▸ defineDomainRouting(input): Object
Install claims, routes and exact internal exports. DNS is read in an action;
only its internal recorder can publish evidence. The recorder rechecks the
original challenge, actor, revision and current owner permission. Routes are
explicit publications and cannot grant an assignment or admit an identity.
The same domain may have multiple owners and multiple routes.
Parameters
Returns
Object
applicationAuthentication
▸ applicationAuthentication(_ctx): Promise<AuthenticationCeremony | null>
Immutable facts from a successful native provider exchange. A refresh does
not create another ceremony or advance authentication time.
Parameters
Returns
Promise<AuthenticationCeremony | null>
defineEnterpriseAuthentication
▸ defineEnterpriseAuthentication(input): Readonly<{ table: TableDefinition<VObject<{ requestId: string ; owner: string ; validUntil: number ; configurationDigest: string ; definitionDigest: string ; recordedAt: number ; recordedBy: string ; evidenceJson: string }, { owner: Validator<string, "required", any> = input.owner; configurationDigest: VString<string, "required"> ; definitionDigest: VString<string, "required"> ; requestId: VString<string, "required"> ; recordedBy: VString<string, "required"> ; evidenceJson: VString<string, "required"> ; recordedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> }, "required", "requestId" | "owner" | "validUntil" | "configurationDigest" | "definitionDigest" | `owner.${any}` | "recordedAt" | "recordedBy" | "evidenceJson">, { by_owner: ["owner", "_creationTime"] ; by_owner_configuration: ["owner", "configurationDigest", "_creationTime"] ; by_request: ["owner", "requestId", "_creationTime"] }, {}, {}, false, {}> & { isWriterOwned: true } & AccessTableBinding<AccessResource<any, any, any, AccessDefinitionInput>, any> ; definitionDigest: string ; inspectionOwner: () => Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<any>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }> ; functions: { observe: RegisteredMutation<"internal", { owner: string ; configurationDigest: string ; requestId: string }, Promise<{ observation: any = previous._id; recovered: boolean = true }>> ; proof: RegisteredQuery<"internal", { owner: string ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; configurationDigest: string }, Promise<{ configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "blocked" ; reason: string = “No successful native authentication has been observed for this configuration” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "unavailable" ; reason: string = “The authentication observation expired” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "ready" ; reason: null = null }>> } ; endpoints: { observe: RegisteredMutation<"public", { requestId: string ; owner: string ; configurationDigest: string }, Promise<any>> ; status: RegisteredQuery<"public", { owner: string }, Promise<{ tested: boolean ; successful: boolean ; proof: { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "blocked" ; reason: string = “No successful native authentication has been observed for this configuration” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "unavailable" ; reason: string = “The authentication observation expired” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "ready" ; reason: null = null } = current }>> } }>
Observed enterprise authentication is application-owned history. The only
writer captures native facts itself; no endpoint accepts a caller’s claim
that SSO succeeded. Install the table and exact internal writer module.
Parameters
Returns
Readonly<{ table: TableDefinition<VObject<{ requestId: string ; owner: string ; validUntil: number ; configurationDigest: string ; definitionDigest: string ; recordedAt: number ; recordedBy: string ; evidenceJson: string }, { owner: Validator<string, "required", any> = input.owner; configurationDigest: VString<string, "required"> ; definitionDigest: VString<string, "required"> ; requestId: VString<string, "required"> ; recordedBy: VString<string, "required"> ; evidenceJson: VString<string, "required"> ; recordedAt: VFloat64<number, "required"> ; validUntil: VFloat64<number, "required"> }, "required", "requestId" | "owner" | "validUntil" | "configurationDigest" | "definitionDigest" | `owner.${any}` | "recordedAt" | "recordedBy" | "evidenceJson">, { by_owner: ["owner", "_creationTime"] ; by_owner_configuration: ["owner", "configurationDigest", "_creationTime"] ; by_request: ["owner", "requestId", "_creationTime"] }, {}, {}, false, {}> & { isWriterOwned: true } & AccessTableBinding<AccessResource<any, any, any, AccessDefinitionInput>, any> ; definitionDigest: string ; inspectionOwner: () => Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<any>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }> ; functions: { observe: RegisteredMutation<"internal", { owner: string ; configurationDigest: string ; requestId: string }, Promise<{ observation: any = previous._id; recovered: boolean = true }>> ; proof: RegisteredQuery<"internal", { owner: string ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; configurationDigest: string }, Promise<{ configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "blocked" ; reason: string = “No successful native authentication has been observed for this configuration” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "unavailable" ; reason: string = “The authentication observation expired” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "ready" ; reason: null = null }>> } ; endpoints: { observe: RegisteredMutation<"public", { requestId: string ; owner: string ; configurationDigest: string }, Promise<any>> ; status: RegisteredQuery<"public", { owner: string }, Promise<{ tested: boolean ; successful: boolean ; proof: { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "blocked" ; reason: string = “No successful native authentication has been observed for this configuration” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "unavailable" ; reason: string = “The authentication observation expired” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; validUntil: any ; outcome: "ready" ; reason: null = null } = current }>> } }>
defineEnterpriseProviderProof
▸ defineEnterpriseProviderProof(input): RegisteredQuery<"internal", { owner: string ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; configurationDigest: string }, Promise<{ configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } = facts.source; validUntil: null | number ; outcome: "unavailable" | "blocked" = facts.state; reason: string = “Provider state is not ready” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } = facts.source; validUntil: number ; outcome: "ready" ; reason: null = null }>>
Adapt an acquired provider observation to the existing enterprise proof
owner. The query is fixed by installed code; proof evaluation does no HTTP.
Certificate expiry, source checkpoints and policy enforcement retain their
own meaning and deadlines.
Parameters
Returns
RegisteredQuery<"internal", { owner: string ; configuration: { issuer: string; clientId: string; providerOrganization: string; } ; configurationDigest: string }, Promise<{ configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } = facts.source; validUntil: null | number ; outcome: "unavailable" | "blocked" = facts.state; reason: string = “Provider state is not ready” } | { configurationDigest: string = args.configurationDigest; definitionDigest: string ; revision: string ; source: null | { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } = facts.source; validUntil: number ; outcome: "ready" ; reason: null = null }>>
defineEnterpriseSetup
▸ defineEnterpriseSetup(input): Readonly<{ table: SetupTable<TableDefinition<VObject<{ owner: any ; revision: bigint ; configurationDigest: string ; definitionDigest: string ; configurationJson: string ; activationJson: null | string ; lastRequest: string }, { owner: GenericValidator = input.owner; configurationJson: VString<string, "required"> ; configurationDigest: VString<string, "required"> ; definitionDigest: VString<string, "required"> ; revision: VInt64<bigint, "required"> ; activationJson: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; lastRequest: VString<string, "required"> }, "required", "owner" | "revision" | "configurationDigest" | "definitionDigest" | "configurationJson" | "activationJson" | "lastRequest" | `owner.${any}`>, { by_owner: ["owner", "_creationTime"] }, {}, {}, false, {}> & { isWriterOwned: true }, AccessResource<any, any, any, AccessDefinitionInput>> ; requests: SetupTable<TableDefinition<VObject<{ requestId: string ; action: string ; revision: bigint ; setup: GenericId<string> ; termsDigest: string ; recordedAt: number }, { setup: VId<GenericId<string>, "required"> ; requestId: VString<string, "required"> ; termsDigest: VString<string, "required"> ; action: VString<string, "required"> ; revision: VInt64<bigint, "required"> ; recordedAt: VFloat64<number, "required"> }, "required", "requestId" | "action" | "revision" | "setup" | "termsDigest" | "recordedAt">, { by_setup: ["setup", "_creationTime"] ; by_request: ["setup", "requestId", "_creationTime"] }, {}, {}, false, {}> & { isWriterOwned: true }, AccessResource<any, any, any, AccessDefinitionInput>> ; definitionDigest: string ; inspect: (ctx: Pick<ReadContext, "db" | "runQuery">, owner: string) => Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }> ; functions: { status: RegisteredQuery<"public", { owner: any }, Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }>> ; configure: RegisteredMutation<"internal", { owner: any ; configuration: any ; requestId: string ; expectedRevision: bigint }, Promise<{ setup: any = row._id; revision: any ; recovered: boolean = true }>> ; activate: RegisteredMutation<"internal", { owner: any ; requestId: string ; expectedRevision: bigint ; configurationDigest: string }, Promise<{ setup: any = row._id; revision: any ; recovered: boolean = true }>> ; deactivate: RegisteredMutation<"internal", { owner: any ; requestId: string ; expectedRevision: bigint ; configurationDigest: string }, Promise<{ setup: any = row._id; revision: any ; recovered: boolean = true }>> } ; endpoints: { status: RegisteredQuery<"public", { owner: any }, Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }>> ; configure: RegisteredMutation<"public", {}, Promise<any>> ; activate: RegisteredMutation<"public", {}, Promise<any>> ; deactivate: RegisteredMutation<"public", {}, Promise<any>> } ; inspectionOwner: (anchor: FunctionReference<"query", any, { owner: string }, any>) => Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<{ configured: any = status.configured; active: any = status.active; ready: any = status.ready; revision: any ; configurationDigest: any ; definitionDigest: any = status.definitionDigest; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> }>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }> ; requireActive: (ctx: Pick<ReadContext, "db" | "runQuery">, owner: string) => Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }> }>
Application-owned enterprise setup. Install both returned tables and export
the internal writer functions under the exact configured module. The native
committer refuses every other writer, including direct mutations.
Parameters
Returns
Readonly<{ table: SetupTable<TableDefinition<VObject<{ owner: any ; revision: bigint ; configurationDigest: string ; definitionDigest: string ; configurationJson: string ; activationJson: null | string ; lastRequest: string }, { owner: GenericValidator = input.owner; configurationJson: VString<string, "required"> ; configurationDigest: VString<string, "required"> ; definitionDigest: VString<string, "required"> ; revision: VInt64<bigint, "required"> ; activationJson: VUnion<null | string, [VString<string, "required">, VNull<null, "required">], "required", never> ; lastRequest: VString<string, "required"> }, "required", "owner" | "revision" | "configurationDigest" | "definitionDigest" | "configurationJson" | "activationJson" | "lastRequest" | `owner.${any}`>, { by_owner: ["owner", "_creationTime"] }, {}, {}, false, {}> & { isWriterOwned: true }, AccessResource<any, any, any, AccessDefinitionInput>> ; requests: SetupTable<TableDefinition<VObject<{ requestId: string ; action: string ; revision: bigint ; setup: GenericId<string> ; termsDigest: string ; recordedAt: number }, { setup: VId<GenericId<string>, "required"> ; requestId: VString<string, "required"> ; termsDigest: VString<string, "required"> ; action: VString<string, "required"> ; revision: VInt64<bigint, "required"> ; recordedAt: VFloat64<number, "required"> }, "required", "requestId" | "action" | "revision" | "setup" | "termsDigest" | "recordedAt">, { by_setup: ["setup", "_creationTime"] ; by_request: ["setup", "requestId", "_creationTime"] }, {}, {}, false, {}> & { isWriterOwned: true }, AccessResource<any, any, any, AccessDefinitionInput>> ; definitionDigest: string ; inspect: (ctx: Pick<ReadContext, "db" | "runQuery">, owner: string) => Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }> ; functions: { status: RegisteredQuery<"public", { owner: any }, Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }>> ; configure: RegisteredMutation<"internal", { owner: any ; configuration: any ; requestId: string ; expectedRevision: bigint }, Promise<{ setup: any = row._id; revision: any ; recovered: boolean = true }>> ; activate: RegisteredMutation<"internal", { owner: any ; requestId: string ; expectedRevision: bigint ; configurationDigest: string }, Promise<{ setup: any = row._id; revision: any ; recovered: boolean = true }>> ; deactivate: RegisteredMutation<"internal", { owner: any ; requestId: string ; expectedRevision: bigint ; configurationDigest: string }, Promise<{ setup: any = row._id; revision: any ; recovered: boolean = true }>> } ; endpoints: { status: RegisteredQuery<"public", { owner: any }, Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }>> ; configure: RegisteredMutation<"public", {}, Promise<any>> ; activate: RegisteredMutation<"public", {}, Promise<any>> ; deactivate: RegisteredMutation<"public", {}, Promise<any>> } ; inspectionOwner: (anchor: FunctionReference<"query", any, { owner: string }, any>) => Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<{ configured: any = status.configured; active: any = status.active; ready: any = status.ready; revision: any ; configurationDigest: any ; definitionDigest: any = status.definitionDigest; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> }>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }> ; requireActive: (ctx: Pick<ReadContext, "db" | "runQuery">, owner: string) => Promise<{ configured: false ; definitionDigest: string ; active: boolean = false; ready: boolean = false; proofs: {} = {} } | { ready: boolean ; proofs: Record<string, { source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string ; reason: null | string ; validUntil: null | number ; outcome: "unavailable" | "blocked" | "ready" ; configurationDigest: string ; definitionDigest: string }> = observed; configured: true ; setup: any = row._id; revision: any = row.revision; definitionDigest: string ; configurationDigest: any = row.configurationDigest; configuration: Value ; active: boolean ; activation: any }> }>
defineIdentityCorrelation
▸ defineIdentityCorrelation(providers): Readonly<{ resolve: (ctx: Pick<BijectionQueryCtx<any, any>, "auth" | "runQuery">, name: string) => Promise<IdentityCorrelation> ; status: RegisteredQuery<"public", { provider: string }, Promise<IdentityCorrelation>> ; inspectionOwner: (anchor: FunctionReference<"query", any, { provider: string }, IdentityCorrelation>) => Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<{ outcome: "unavailable" | "unmatched" | "matched" | "conflict" = current.kind; people: string[] ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] = current.evidence }>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }> ; request: (ctx: Parameters<typeof resolve>[0], provider: string, review: (person: string, correlation: Extract<IdentityCorrelation, { kind: "matched" }>) => Promise<unknown>) => Promise<{ correlation: { kind: "conflict" ; people: string[] ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] } | { kind: "unmatched" ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] } | { kind: "unavailable" ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] } ; request: null = null } | { correlation: { kind: "matched" ; person: string ; organization: string ; provider: string ; subject: string ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] ; validUntil: number } ; request: unknown }> }>
Each installed provider maps verified immutable IDs to an authorized source
query. Correlation proposes an association; reviewed identity linking keeps
ownership of the actual decision. Emails establish no association.
Parameters
Returns
Readonly<{ resolve: (ctx: Pick<BijectionQueryCtx<any, any>, "auth" | "runQuery">, name: string) => Promise<IdentityCorrelation> ; status: RegisteredQuery<"public", { provider: string }, Promise<IdentityCorrelation>> ; inspectionOwner: (anchor: FunctionReference<"query", any, { provider: string }, IdentityCorrelation>) => Readonly<{ protocol: string ; anchor: FunctionReference<"query", any, any, any> ; facts: GenericValidator ; read: (ctx: InspectionReader, subject: SubjectRef) => Promise<SubjectInspection<{ outcome: "unavailable" | "unmatched" | "matched" | "conflict" = current.kind; people: string[] ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] = current.evidence }>> ; control?: (ctx: InspectionWriter, input: InspectionControlIntent) => Promise<InspectionControlReceipt> ; recoverControl?: (ctx: InspectionReader, input: InspectionControlIntent) => Promise<InspectionControlReceipt | null> }> ; request: (ctx: Parameters<typeof resolve>[0], provider: string, review: (person: string, correlation: Extract<IdentityCorrelation, { kind: "matched" }>) => Promise<unknown>) => Promise<{ correlation: { kind: "conflict" ; people: string[] ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] } | { kind: "unmatched" ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] } | { kind: "unavailable" ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] } ; request: null = null } | { correlation: { kind: "matched" ; person: string ; organization: string ; provider: string ; subject: string ; evidence: { subject: { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: string }[] ; validUntil: number } ; request: unknown }> }>
identityFieldAuthority
▸ identityFieldAuthority<Row, Principal, Claims>(fields): Record<string, TransitionConditionDeclaration<Row, Principal, Claims>>
Compile identity-field management through the existing native transition
language. Install the returned declarations in the identity table’s access
binding. Creation and deletion keep their ordinary native permissions.
Type parameters
Parameters
Returns
Record<string, TransitionConditionDeclaration<Row, Principal, Claims>>
defineIdentityProjection
▸ defineIdentityProjection(input): Object
One governed transaction applies independent field groups and records their
actual outcomes. Install receipts and the exact internal apply export.
Add writer to the target table’s writers and retain identityFieldAuthority
transitions there. Source precedence is supplied by the installed observation
query; it cannot bypass the target’s native authority or uniqueness rules.
Parameters
Returns
Object
definePolicySlot
▸ definePolicySlot<Args, Returns>(definition): PolicySlot<ObjectType<Args>, Infer<Returns>>
Declare a policy dependency of this component. Name it in a policy query’s
policy.calls; the application binds a query with exactly these validators
and declared policy.reads per installation. Deployment refuses a missing,
extra or incompatible binding. The decision stays current: no code is
retained.
Type parameters
Parameters
Returns
PolicySlot<ObjectType<Args>, Infer<Returns>>
currentPolicyQuery
▸ currentPolicyQuery<Q>(query, args): Promise<FunctionReturnType<Q>>
Consult an explicitly declared shared policy query at the live parent.
Its actual current read dependencies fence this decision’s release. The
executing query must list the reference in policy.calls; both the branch
and current parent declarations must admit it. Available only in private
policy evaluation, with the same actual requester and program provenance.
Ordinary data queries retain their selected snapshot basis.
Type parameters
Parameters
Returns
Promise<FunctionReturnType<Q>>
policyExecution
▸ policyExecution():Promise<PolicyExecution>
Inspect the actual execution holder inside a private policy.
Returns
Promise<PolicyExecution>
invitationEmail
▸ invitationEmail(value): string
Parameters
Returns
string
onboardingResources
▸ onboardingResources():Object
Invitations and receipts each enforce their mandatory participant condition.
Sharing an organization grants no access to either resource.
Bind both resources with defineOnboarding.
Returns
Object
onboardingVisibility
▸ onboardingVisibility(service): AccessCondition
Install on a root-level invitation resource with public read/manage audiences.
This mandatory native condition limits disclosure to the issuer, the exact
verified recipient and the declared native finalizer. Creation stays behind
the factory’s exclusive issuer writer and its native grant-permission check.
Declare issuer, subject, email and emailVerified claim types in the model.
Parameters
Returns
AccessCondition
defineOnboarding
▸ defineOnboarding(input): Object
Invitations and one-purpose administration tasks share native assignments,
retained sponsor decisions and ordinary request receipts. Acceptance records
the verified recipient; a declared external finalizer then atomically creates
the participation and acceptance receipt under its own native grant authority.
No callback restores an issuer’s identity or accepts a caller-supplied role.
Install table/receipts, export functions under module, and endpoints separately.
Parameters
Returns
Object
operatorIdentity
▸ operatorIdentity():AuthProvider
Explicitly trust this installation’s member identities in auth.config.ts.
The deployment owner supplies the issuer and immutable deployment audience.
Authentication grants no operation, read, or approval permission.
Returns
AuthProvider
organizationAdmission
▸ organizationAdmission<Permission>(input): Readonly<{ requirements: Readonly<Record<string, { on: [Permission, …Permission[]] ; onOrigins: readonly AuthorityOrigin[] ; when: AccessCondition ; decision?: { actors: readonly ("service" | "person")[] ; authentication: Readonly<{ maxAgeMs: number ; acrValues: readonly string[] ; requiredMethods: readonly string[] }> ; unless: AccessCondition } }>> ; describe: () => { permissions: Permission[] ; origins: AuthorityOrigin[] ; profiles: { name: string ; authentication: null | Readonly<{ maxAgeMs: number ; acrValues: readonly string[] ; requiredMethods: readonly string[] }> }[] } }>
Organization admission narrows tenant pass; it never creates membership.
Choose the covered origins explicitly. Delegated claims cannot satisfy a
direct authentication requirement; mediated admission needs its own reviewed
native approval requirement.
Type parameters
Parameters
Returns
Readonly<{ requirements: Readonly<Record<string, { on: [Permission, …Permission[]] ; onOrigins: readonly AuthorityOrigin[] ; when: AccessCondition ; decision?: { actors: readonly ("service" | "person")[] ; authentication: Readonly<{ maxAgeMs: number ; acrValues: readonly string[] ; requiredMethods: readonly string[] }> ; unless: AccessCondition } }>> ; describe: () => { permissions: Permission[] ; origins: AuthorityOrigin[] ; profiles: { name: string ; authentication: null | Readonly<{ maxAgeMs: number ; acrValues: readonly string[] ; requiredMethods: readonly string[] }> }[] } }>
organizationShares
▸ organizationShares(access): Object
Organization shares are standing, source-reviewed positive projections.
Source approval requires current <type>:share on the exact source.
Executing the review records recipient acceptance with <type>:acceptShare.
Reads require current recipient <type>:pass; either side can revoke with
<type>:revokeShare. Source tenant membership is never conferred.
Parameters
Returns
Object
readPolicy
▸ readPolicy<DataModel>(decide, options?): RegisteredQuery<"internal", { requests: { properties: string[] | null; target: { kind: “object”; id: string; } | { covers?: true; interval?: { field: string | null; index: string; lower: { value?: Value; inclusive: boolean; } | null; upper: { …; } | null; }; kind: “query”; equalities: { …; }[]; }; table: string; }[] }, Promise<ReadAccessResults>>
A read rule that decides each request of the native batch on its own.
decide sees one request; the batch and its result list stay native.
Type parameters
Parameters
Returns
RegisteredQuery<"internal", { requests: { properties: string[] | null; target: { kind: “object”; id: string; } | { covers?: true; interval?: { field: string | null; index: string; lower: { value?: Value; inclusive: boolean; } | null; upper: { …; } | null; }; kind: “query”; equalities: { …; }[]; }; table: string; }[] }, Promise<ReadAccessResults>>
mandatePolicy
▸ mandatePolicy<Target, Args, DataModel>(command, decide): RegisteredQuery<"internal", [{ phase: VUnion<"review_mandate" | "issue_mandate" | "revoke_mandate", [VLiteral<"review_mandate", "required">, VLiteral<"issue_mandate", "required">, VLiteral<"revoke_mandate", "required">], "required", never> ; actor: VString<string, "required"> ; initiator: VString<string, "required"> ; requester: VString<string, "required"> ; continuation: VObject<{ kind: "organization" ; service: string ; credential: string ; expiresAt: number }, { kind: VLiteral<"organization", "required"> ; service: VString<string, "required"> ; credential: VString<string, "required"> ; expiresAt: VFloat64<number, "required"> }, "required", "kind" | "service" | "credential" | "expiresAt"> ; delivery: VAny<any, "required", string> ; condition: VAny<any, "required", string> ; target: Target = command.target; args: VObject<Expand<{ [Property in string | number | symbol]?: Exclude<Infer<Args[Property]>, undefined> } & { [Property in string | number | symbol]: Infer<Args[Property]> }>, Args, "required", { [Property in string | number | symbol]: Property | `\{Property & string}.{Args[Property][“fieldPaths”]}` }[keyof Args] & string> ; approval: VAny<any, "required", string> ; terms: VAny<any, "optional", string> }] extends [PropertyValidators] ? [{}] : OneArgArray<DefaultFunctionArgs>[0], Promise<(null | { validUntil: number } | { recheckAt: number })[]>>
Consent to issue, review or withdraw one organizational commitment.
Every ordinary command decision and source disclosure remains required.
The native owner supplies the actor and exact retained effect.
Type parameters
Parameters
Returns
RegisteredQuery<"internal", [{ phase: VUnion<"review_mandate" | "issue_mandate" | "revoke_mandate", [VLiteral<"review_mandate", "required">, VLiteral<"issue_mandate", "required">, VLiteral<"revoke_mandate", "required">], "required", never> ; actor: VString<string, "required"> ; initiator: VString<string, "required"> ; requester: VString<string, "required"> ; continuation: VObject<{ kind: "organization" ; service: string ; credential: string ; expiresAt: number }, { kind: VLiteral<"organization", "required"> ; service: VString<string, "required"> ; credential: VString<string, "required"> ; expiresAt: VFloat64<number, "required"> }, "required", "kind" | "service" | "credential" | "expiresAt"> ; delivery: VAny<any, "required", string> ; condition: VAny<any, "required", string> ; target: Target = command.target; args: VObject<Expand<{ [Property in string | number | symbol]?: Exclude<Infer<Args[Property]>, undefined> } & { [Property in string | number | symbol]: Infer<Args[Property]> }>, Args, "required", { [Property in string | number | symbol]: Property | `\{Property & string}.{Args[Property][“fieldPaths”]}` }[keyof Args] & string> ; approval: VAny<any, "required", string> ; terms: VAny<any, "optional", string> }] extends [PropertyValidators] ? [{}] : OneArgArray<DefaultFunctionArgs>[0], Promise<(null | { validUntil: number } | { recheckAt: number })[]>>
requireDirectPerson
▸ requireDirectPerson():Promise<void>
Require a directly signed-in person using host-owned authentication.
Native conversation grants are deliberately absent from public identity facts,
so inspecting those facts cannot authorize consent or another personal decision.
Backend only; this check makes no permission grant.
Returns
Promise<void>
isPerson
▸ isPerson(identity): boolean
Whether identity is a person signed in directly: the only caller whose
approval, review, grant or share may be recorded as a person’s decision.
Parameters
Returns
boolean
decideEach
▸ decideEach<R>(requests, decide): Promise<ReadAccessResults>
Decide each request of a batch on its own, in order. A return inside
decide settles only its own request; a throw refuses the batch.
Type parameters
Parameters
Returns
Promise<ReadAccessResults>
resourceAudit
▸ resourceAudit(access): Object
Resource audit uses the original sealed deployment journal. Recording
requires <type>:pass; every query page requires current <type>:audit.
One audited invocation belongs to one resource scope. This API runs in
application queries/mutations, against the current deployment journal.
Parameters
Returns
Object
resourceAuthority
▸ resourceAuthority(options): ResourceAuthority<"readWrite">
Declare one complete programmable resource authority for a table inside an
installed component. Application tables use the native access model
(defineAccess with .access(access.resources.<type>, ...)); activation
refuses a programmable policy at the application root. Use a read-only
handle for component source tables and views, and a handle with write for
component-owned local tables. All checks retain the runtime’s ordinary dependency, current-policy,
original/final write, delegation and per-release enforcement.
Parameters
Returns
ResourceAuthority<"readWrite">
▸ resourceAuthority(options): ResourceAuthority<"read">
Parameters
Returns
ResourceAuthority<"read">
riskBindingDigest
▸ riskBindingDigest(binding): string
Exact request identity shared by the immutable operation owner and its
authenticated external assessment. Changing any context changes the digest.
Parameters
Returns
string
defineRiskCheck
▸ defineRiskCheck(input): Readonly<{ evidence: Readonly<{}> ; check: RegisteredQuery<"internal", { request: string }, Promise<{ kind: "matched" ; values: Record<string, string> } | { kind: "unmatched" }>> ; inspect: RegisteredQuery<"internal", { request: string }, Promise<{ kind: "unavailable" | "challenge" | "allow" | "deny" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: null | string ; reason: string ; validUntil: null | number ; binding: null | string ; handling: "refuse" | "challenge" }>> ; requirement: (permission: string, bindingField: string) => PermissionRequirement ; verification: (check: CheckContractReference<{ request: string }, ContextCheckResult>, request?: string) => KnowledgeDeclaration }>
External risk narrows existing authority through native expiring evidence.
The two queries are fixed by installed code. Their owner authenticates the
provider and captures the original request; evaluation performs no HTTP.
Export check, analyze it, then pass its generated check contract to
verification. The ordinary interaction owns attempts, facts and expiry.
Parameters
Returns
Readonly<{ evidence: Readonly<{}> ; check: RegisteredQuery<"internal", { request: string }, Promise<{ kind: "matched" ; values: Record<string, string> } | { kind: "unmatched" }>> ; inspect: RegisteredQuery<"internal", { request: string }, Promise<{ kind: "unavailable" | "challenge" | "allow" | "deny" ; source: null | { id: string; installation: string; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; }; protocol: string; } ; revision: null | string ; reason: string ; validUntil: null | number ; binding: null | string ; handling: "refuse" | "challenge" }>> ; requirement: (permission: string, bindingField: string) => PermissionRequirement ; verification: (check: CheckContractReference<{ request: string }, ContextCheckResult>, request?: string) => KnowledgeDeclaration }>
defineSecurityModule
▸ defineSecurityModule(input): Object
Security management composes existing owners and their original receipts.
Install these endpoints in the application’s security module. Provider
inventories are fixed internal queries; factor secrets stay with providers.
Parameters
Returns
Object
defineNativeSessionSecurity
▸ defineNativeSessionSecurity(input): Object
Ready-to-install native session section. Export functions in module, then
pass section to defineSecurityModule. Provider sessions remain a separate
inventory and revocation owner.
Parameters
Returns
Object
serviceIssuer
▸ serviceIssuer(service): string
The issuer of service’s tokens.
Parameters
Returns
string
serviceTokenIdentifier
▸ serviceTokenIdentifier(service): string
The token identifier of service itself: the subject its grants name.
Parameters
Returns
string
defineInspectionOwner
▸ defineInspectionOwner<Facts>(owner): InspectionOwner<Facts>
Configuration is authored code; subjects can only select an admitted anchor.
Type parameters
Parameters
Returns
InspectionOwner<Facts>
ownerObservation
▸ ownerObservation<Facts>(subject, input): SubjectInspection<Facts>
Construct an observation, without storing or inferring another lifecycle.
Type parameters
Parameters
Returns
SubjectInspection<Facts>
inspectionSubject
▸ inspectionSubject(owner, id): Promise<SubjectRef>
Parameters
Returns
Promise<SubjectRef>
defineWorkosEnterpriseHealthReader
▸ defineWorkosEnterpriseHealthReader(input): RegisteredQuery<"internal", { owner: string }, Promise<{ selection: { connection: string ; directory: null | string } ; configuration: { issuer: string ; clientId: string ; providerOrganization: string } ; source: { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; evidence: { 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 } ; record: { id: string ; organization: string ; directory: null | string ; connectionState: string ; ssoEnforced: null ; connectionType: string ; directoryState: null | string ; certificateState: "unavailable" | "observed" | "notApplicable" ; certificates: { id: string; notBefore: number | null; notAfter: number | null; }[] } } | { selection: { connection: string ; directory: null | string } ; configuration: { issuer: string ; clientId: string ; providerOrganization: string } ; source: { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; record: null = null; evidence: null = null }>>
Install the concrete source reader beside the health proof module. The
table, owner index, reviewed configuration and inspection anchor are fixed by
code. It always reads the exact row’s evidence, never population freshness.
Parameters
Returns
RegisteredQuery<"internal", { owner: string }, Promise<{ selection: { connection: string ; directory: null | string } ; configuration: { issuer: string ; clientId: string ; providerOrganization: string } ; source: { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; evidence: { 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 } ; record: { id: string ; organization: string ; directory: null | string ; connectionState: string ; ssoEnforced: null ; connectionType: string ; directoryState: null | string ; certificateState: "unavailable" | "observed" | "notApplicable" ; certificates: { id: string; notBefore: number | null; notAfter: number | null; }[] } } | { selection: { connection: string ; directory: null | string } ; configuration: { issuer: string ; clientId: string ; providerOrganization: string } ; source: { id: string ; installation: string ; location: { incarnation: string; branch: { key: string; generation: string; } | null; deployment_id: string; } ; protocol: string } ; record: null = null; evidence: null = null }>>
defineWorkosEnterpriseHealth
▸ defineWorkosEnterpriseHealth(input): Object
Concrete WorkOS interpretation over native acquired observations. Export the
returned internal functions under module. Missing provider APIs and gaps never
become positive readiness evidence. This factory performs no network I/O.
Parameters
Returns
Object