rescript-lang / rescript-lang/experimental-rescript-webapi
Simplify package module/type structure
Open
@jderochervlk is already working on this.
Since Apr 18, 2026.
- Dominant language
- ReScript
- Stars
- 40
- Forks
- 11
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 12
Description
Summary
Pre-alpha breaking cleanup to simplify the package structure and make the public surface more consistent.
This issue tracks the refactor to:
- rename root
*APItype-holder modules to*Types - keep the existing folder structure for concrete modules
- export the primary concrete type as
t - selectively re-export additional public helper types from the concrete module that uses them
- remove unrelated
openusage - remove trivial primitive aliases like
string,bool,unit, and low-value callback aliases where they do not add meaning - remove
windowandnavigatorfromGlobalwithout deletingGlobal - shift access toward owner modules such as
Window,Navigator,History,Storage,Performance, and similar modules - avoid introducing any new
includedirectives as part of the simplification
Out Of Scope
- contributor docs
- code-generation conventions
- deleting
Global - flattening the folder structure
Execution Order
- #239 must land first
- #238, #240, #241, and #243 can run in parallel after #239
- #242 is the final integration pass
Linked Issues
- #239 Shared groundwork for package simplification
- #238 Simplify DOM, event, and observer module surfaces
- #240 Simplify fetch, file, canvas, URL, and socket module surfaces
- #241 Move runtime capability access away from Global window and navigator
- #243 Simplify media and device module surfaces
- #242 Final integration for package simplification
Acceptance Criteria
- No root
src/*API.restype-holder files remain; they are replaced bysrc/*Types.res. - The existing folder structure remains in place.
- Each concrete module exports its main type as
t. - Concrete modules selectively re-export secondary public types only where justified.
- Unrelated
openusage is removed. - No new
includedirectives are introduced by this refactor. - Trivial primitive aliases are removed instead of being renamed or moved.
Global.windowandGlobal.navigatorare removed.- Source and tests stop depending on
Global.windowandGlobal.navigator. - The package passes
npm run buildandnpm testafter integration.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.