Add Ability to Annotate Sub-Package Exports As "Internal"

[spmonahan]

Problem

The @fluentui/react-components package represents the officially supported public API surface of Fluent UI React v9 yet it is composed on many "sub-packages" that are published on npm and follow semantic versioning, effectively making the APIs of these sub-packages part of Fluent's public API as well. Yet we don't always re-export an entire sub-package's API from @fluentui/react-components as parts of these APIs are meant for internal use only.

For example, @fluentui/react-components imports @fluentui/react-utilities and then re-exports some of its exports. Some of the exports from react-utilities are only meant for internal use and are not part of the public API but we have no way of communicating this to users our even within the Fluent UI team.

Appetite

3~4 weeks. We should have a solution prior to the release of v9 stable at the end of June.

Solution

Provide a mechanism to mark exports from a sub-package as "internal only".

Risks (Rabbit holes)

Out of scope (No-gos)

1. No breaking changes allowed

Related

• Align react-components Exports with Sub-package Exports #23345

Tasks

• create api-stripping approach RFC | docs(rfc): add api access modifiers style-guide RFC for v9 #23577
• implement api stripping | feat: implement internal/alpha/beta/ API removals from package public API surface #23369
• migrate packages to api stripping during build | will be closed by feat: enable @internal api stripping in all packages and fix export maps #25319, Defined standard for v9 package file organization #24129
• remove all gradual migration required code when previous task is done | chore: remove unused logic used for gradual api-stripping migration #24127
• [Feature]: no-annotation lint rule #25694
• use lint rule in v9 packages

[microsoft-github-policy-service]

This issue has not had activity for over 180 days! We're adding Soft close label and will close it soon for house-keeping purposes.
Still require assistance? Please add comment - "keep open".

[Hotell]

"keep open"

we won't implement this in upcoming quarter/s - but will keep it open as we wanna get this functionality eventually