Skip to content

SDK v1.0.0 API-stability sweep #124

Description

@truthixify

Extra labels: dx, release
Tier: M (2-4 days) | Type: refactor

Context. Companions declare ^0.x; consumers keep breaking on minor bumps. Before v1.0, mark the public surface, audit exports, snapshot via api-extractor, gate PRs on the snapshot.

Scope.

  • Enumerate public surface in src/index.ts; mark internal helpers @internal.
  • Add @microsoft/api-extractor; snapshot at etc/sdk.api.md.
  • CI blocks a PR that changes surface without updating snapshot.
  • Companions' peerDependencies pin @wraith-protocol/sdk >=1.0.0 <2.

Acceptance.

  • pnpm api:check passes on develop
  • CI fails on undocumented public-API drift
  • Companion peer ranges updated

Files. src/index.ts, api-extractor.json (new), etc/sdk.api.md (new), .github/workflows/ci.yml.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdripsFunded via Drips NetworkdxDeveloper experiencehelp wantedExtra attention is neededrelease

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions