API reference

The API reference is generated from the compiled declaration entrypoint shipped with @byfungsi/sapa. It documents the package consumers install, rather than the repository’s internal workspace modules.

Browse the reference

• All public exports
• Sapa runtime composition
• Offer schema and operations
• Create checkout
• Register offers
• Check access

The generated navigation groups value exports, type aliases, and interfaces. Some Schema declarations intentionally have both a runtime value and a TypeScript type with the same name.

Public operations use SapaOperation<Success, Failure> so their declarations keep the success and expected-error contracts readable without expanding Effect internals. Each operation accepts unknown deliberately: it decodes untrusted boundary input with its documented public Schema before orchestration begins.

Public boundary

Only names exported from @byfungsi/sapa are supported consumer APIs. Internal @sapa/* packages, source paths, provider payloads, and persistence models are not part of this reference.

Generated content

Reference pages are regenerated during every docs build after rebuilding the npm package declarations. Edit TSDoc at the public symbol’s original declaration; do not edit generated Markdown.