Skip to main content

Module authoring

Module authoring 

Source
Expand description

Runtime-neutral values shared by Authoring V2 execution profiles.

This module does not define a transport envelope. Process and Bun adapters wrap these values in their own versioned protocols. Runtime-neutral Authoring V2 values and validation.

Structs§

AuthoringLimits
Host bounds confirmed during initialization.
CancelAck
CancelParams
Cancellation request. Acknowledgement does not imply execution settlement.
CleanupDiagnostic
ConstructParams
Host-to-runtime factory invocation.
ConstructedResult
EventPublishParams
Host-to-plugin publication for one provided Event operation.
EventPublishResult
InitializeParams
Host-to-runtime initialization value.
InvocationResult
InvocationScope
Invocation ancestry and ambient values that outbound calls must preserve.
InvokeParams
Host-to-plugin operation invocation.
OutboundCallParams
Plugin-to-Host call through one exact Plan route.
OutboundEventPublishParams
Plugin-to-Host Event publication through one exact Plan route.
OutboundStreamOpenParams
Plugin-to-Host Stream open through one exact Plan route.
ProvidedEndpoint
One endpoint exported by the admitted Plugin instance.
RequirementDeclaration
One source-declared dependency, keyed independently from its Capability.
RouteDescriptor
One exact provider selected for a named requirement.
SessionIdentity
Immutable identity of one admitted Plugin generation.
Settlement
Runtime observation that one execution has actually stopped.
StopParams
Fresh cleanup scope with the remaining shared cleanup budget.
StoppedResult
StreamActionResult
StreamOpenParams
Host-to-plugin open request for one provided bidirectional Stream operation.
StreamOpenResult
StreamReceiveParams
One pull for the next observable item from an open Stream session.
StreamReceiveResult
StreamSendParams
One ordered message submitted to an open Stream session.

Enums§

EventPublishOutcome
Commit acknowledgement for one bounded Event admission.
FactoryOutcome
Result of transferring the constructed object to the runtime.
InvocationOutcome
RequirementCardinality
Cardinality of one named requirement.
RuntimeFailure
Portable operation outcome. It is distinct from execution settlement.
SettlementState
StopHookOutcome
StreamActionOutcome
Result of a Stream mutation after it was admitted by the receiver.
StreamOpenOutcome
Result of opening a Stream. The receiver owns the returned stream identity.
StreamReceiveOutcome
Next ordered item observed from a Stream session.
StreamTerminalOutcome
Terminal result belongs to the Stream operation, not to one receive call.

Constants§

AUTHORING_API_VERSION
First interoperable Authoring value API.
DEFAULT_MAX_FRAME_BYTES
Default maximum encoded frame size.

Functions§

decode_frame
Decodes one bounded strict Authoring value.

Type Aliases§

InitializedResult
Runtime echo proving that it admitted exactly the Host initialization.
OutboundCallResult
OutboundEventPublishResult
OutboundStreamOpenResult
StreamCancelParams
Cancels a Stream session idempotently.
StreamCloseSendParams
Half-closes the sender without closing its receive direction.