Expand description
Public package hooks namespace. Use it for the documented package hooks API surface; prefer crate-root re-exports for common imports. Module items must preserve the core ownership and side-effect boundaries described in this file. Runtime-package records and builders. Use these items to describe the immutable per-run package that freezes provider route, capabilities, policies, sidecars, catalogs, and fingerprints. Builders are data-only and must not perform discovery or execution side effects. This file contains the hooks portion of that contract.
Structs§
- Approval
Request Patch - Describes the approval request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Cleanup
Repair Request - Describes the cleanup repair request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Compaction
Request - Describes the compaction request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Context
Injection Request - Describes the context injection request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Deny
Reason - Describes the deny reason portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Detach
Validation Request - Describes the detach validation request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Cancellation Token - Describes the hook cancellation token portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Config - Describes the hook config portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Executor Ref - Describes the hook executor ref portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- HookId
- Describes the hook id portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Input - Describes the hook input portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Mutation Rights - Describes the hook mutation rights portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Ordering - Describes the hook ordering portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Queue Config - Describes the hook queue config portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Spec - Describes the hook spec portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
Timeout Policy - Describes the hook timeout policy portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Hook
View - Describes the hook view portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Process
Request Patch - Describes the process request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Projection
Audit Repair Request - Describes the projection audit repair request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Projection
Patch - Describes the projection patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Repair
Needed Reason - Describes the repair needed reason portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Retry
Request - Describes the retry request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Stop
Reason - Describes the stop reason portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Subagent
Request Patch - Describes the subagent request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Tool
Request Patch - Describes the tool request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Tool
Result Patch - Describes the tool result patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Usage
Rollup Repair Request - Describes the usage rollup repair request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
- Validation
Hint Patch - Describes the validation hint patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
Enums§
- Hook
Execution Mode - Enumerates the finite hook execution mode cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Failure Policy - Enumerates the finite hook failure policy cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Mutation Right - Enumerates the finite hook mutation right cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Ordering Phase - Enumerates the finite hook ordering phase cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Overflow Policy - Enumerates the finite hook overflow policy cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Point - Enumerates the finite hook point cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Privacy Policy - Enumerates the finite hook privacy policy cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Response - Enumerates the finite hook response cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Response Class - Enumerates the finite hook response class cases. Serialized names are part of the SDK contract; update fixtures when variants change.
- Hook
Source - Enumerates the finite hook source cases. Serialized names are part of the SDK contract; update fixtures when variants change.
Constants§
- HOOK_
SIDECAR_ KIND - Constant value for the package::hooks contract. Use it to keep SDK records and tests aligned on the same stable value.
- HOOK_
SIDECAR_ VERSION - Constant value for the package::hooks contract. Use it to keep SDK records and tests aligned on the same stable value.
Functions§
- hook_
policy_ ref - Returns hook policy ref derived from the supplied state. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.
- lower_
code_ hook - Builds the lower code hook value. This is data construction and performs no I/O, journal append, event publication, or process
- ordered_
hooks_ for_ point - Returns the ordered hooks for point currently held by this value. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.
- validate_
hook_ specs - Validates the package::hooks invariants and returns a typed error on failure. Validation is pure and does not perform I/O, dispatch, journal appends, or adapter calls.