Public API contract

Sheetwrite treats each package exports map as the public boundary. The release gate builds the packages first, analyzes the emitted declarations with TypeScript, and rejects undocumented, ambiguous, or accidentally exposed symbols before any package can publish.

Entry-point classifications

Every exported subpath has one explicit classification:

The generated API index lists every package entry point, its classification, and every compiler-visible export. There is no manually maintained symbol inventory beside it.

What the gate records

For every TypeScript export, the canonical manifest records:

• symbol name and declaration kind;
• normalized primary signature;
• owning declaration files and source location;
• source JSDoc and JSDoc tags;
• documented interface and class members.

Named re-exports preserve documentation from both the export statement and the declaration target. Framework-generated declarations are analyzed from the bytes that packages actually ship.

Stability and changes

bun run api:check hashes the normalized manifest. A changed digest must be reviewed with the declaration diff and accepted explicitly; rebuilding alone cannot rewrite the baseline. This catches additions, removals, signature drift, duplicate declaration merges, missing documentation, and dependency types that leak into the public surface.

The API manifest describes type compatibility. Runtime behavior remains protected by package tests, adapter lifecycle contracts, browser scenarios, canonical tarball checks, and delivery-size budgets.

Deprecations and removals

supported entry points get a deprecation period, marked with @deprecated, before removal. internal entry points, such as the WASM engine, may change in a minor release with a changelog entry.