| name | typescript-api-boundaries |
| description | TypeScript API boundary review workflow for public exports, package entrypoints, type-only exports, barrels, compatibility, and module ownership. Use when Codex must add, remove, or review exported TypeScript contracts or package-facing APIs. |
TypeScript API Boundaries
Use this skill when a TypeScript change touches exported contracts.
- Identify the boundary: package
exports, main, types, index files,
barrel modules, public classes, public functions, and exported types.
- Classify each export as public contract, internal convenience, test fixture,
or accidental exposure.
- Prefer explicit exports over broad barrels when ownership or dependencies
are unclear.
- Keep type-only exports type-only. Avoid importing runtime values solely for
type annotations.
- Check downstream usage before removing or renaming an export. If downstream
usage cannot be inspected, record the compatibility risk.
- Update declaration-oriented tests or compile checks when public types change.
- Verify with typechecking or
check, and summarize any API compatibility
decision in the PR or handoff.
