Add a public API report for exported types

[Lakes41]

Difficulty: Advanced

Type: Test

Summary

Add a public API report to detect accidental breaking changes to exported classes, types, subpath exports, and configuration interfaces.

Current Behaviour

The SDK has TypeScript types and build smoke tests, but there is no explicit reviewed API surface report that catches accidental export removals or signature changes.

Expected Behaviour

Pull requests that change the public SDK surface should produce a clear API diff for maintainers to review.

Suggested Implementation

Use a tool such as API Extractor or a lightweight generated declaration snapshot. Include root and subpath exports in the report and require intentional updates when the public API changes.

Files or Areas Likely Affected

• package.json
• src/index.ts
• src/client.ts
• src/types.ts
• src/utils.ts
• src/errors.ts
• api-report/
• .github/workflows/

Acceptance Criteria

• A command generates or validates the public API report
• Root exports are included in the report
• Subpath exports are included in the report
• CI fails when public exports change without updating the report
• Contributor documentation explains how to update the report
• Internal implementation details are excluded where possible

Additional Notes

This complements package smoke tests by focusing on intentional API compatibility.

[Meet-hybrid]

Can I work on this please?

[Oluwasuyi-Timilehin]

Hello maintainers I'm a full stack developer with experience in building scalable systems I can handle this perfectly if assigned

[gloskull]

Hello, I have 4 years of experience delivering solutions for projects like this, covering backend, frontend, and smart contract development. After carefully reviewing your requirements, I have a clear understanding of the task and am confident in my ability to deliver a clean, efficient, and thoroughly tested solution on time. I prioritize code quality, maintainability, and industry best practices throughout the development process.
My PR will be submitted in under 10hours.

[grantfox-oss]

🦊 GrantFox — @Oluwasuyi-Timilehin has been assigned to this issue as part of the Official Campaign campaign!

Next steps:

1. Open a Pull Request referencing this issue (e.g., Closes #91)
2. Your PR will be reviewed by the Adamantine-guild maintainers

Good luck! Track your progress on GrantFox.