API reference@effx/compilerextensions
access-contract
API reference for @effx/compiler/extensions/access-contract
access-contract.ts overview
Exports Grouped by Category
utils
AccessContractData
JSON-only semantic declaration. Neither symbol is invoked by the compiler. The claim key is present only when true, so a declaration without a claim keeps its canonical IR and hash.
Signature
declare const AccessContractData: Schema.Struct<{
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly exposure: Schema.Literals<readonly ["External", "Internal"]>
readonly acceptedCredentials: Schema.UniqueArray<Schema.NonEmptyString>
readonly principalKinds: Schema.UniqueArray<
Schema.Literals<readonly ["Anonymous", "Person", "ServicePrincipal", "CapabilityHolder"]>
>
readonly capabilities: Schema.TaggedUnion<{
readonly Any: Schema.TaggedStruct<"Any", { readonly capabilities: Schema.UniqueArray<Schema.NonEmptyString> }>
readonly None: Schema.TaggedStruct<"None", {}>
readonly One: Schema.TaggedStruct<"One", { readonly capability: Schema.NonEmptyString }>
readonly All: Schema.TaggedStruct<"All", { readonly capabilities: Schema.UniqueArray<Schema.NonEmptyString> }>
}>
readonly requirements: Schema.$Array<
Schema.Struct<{
readonly id: Schema.NonEmptyString
readonly parameters: Schema.optionalKey<
Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>
>
}>
>
readonly canonicalScopeResolver: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly concealment: Schema.TaggedUnion<{
readonly Reveal: Schema.TaggedStruct<"Reveal", {}>
readonly NotFound: Schema.TaggedStruct<"NotFound", { readonly stages: Schema.UniqueArray<Schema.NonEmptyString> }>
}>
readonly decisionTime: Schema.Literals<readonly ["SnapshotRead", "Transaction"]>
readonly snapshotDecisionForCommand: Schema.optionalKey<Schema.Boolean>
}>AccessContractData (type alias)
Signature
type AccessContractData = typeof AccessContractData.TypeaccessContractExtension
Signature
declare const accessContractExtension: Extension