diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 251a8a5..358a618 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -24,6 +24,6 @@ jobs: uses: actions/setup-node@v6 with: node-version: ${{ matrix.node-version }} - - run: npm install + - run: npm ci - run: npm run build - run: npm run test diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 07ee17e..e6ec48b 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -10,6 +10,7 @@ on: jobs: pkg-pr-new: + if: github.repository == 'rescript-lang/rescript-react' runs-on: ubuntu-latest steps: diff --git a/.gitignore b/.gitignore index 1976ae1..b0a8f93 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,4 @@ src/legacy/*.bs.js !/src/react/*.js # ReScript -lib/ \ No newline at end of file +lib/ diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000..895e98e --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,86 @@ +# WebAPI DOM types + +This prerelease uses WebAPI types throughout the DOM bindings. It requires +ReScript 13.0.0-alpha.7 and a compatible `@rescript/runtime`. + +## Dependency release requirement + +The WebAPI dependency is pinned to the immutable source snapshot +`691bc3f20dc5d621d22f5bf9931b4ec086542d5f`. Its `DOMTree`, `History`, +`Location`, `Touch`, `DataTransfer`, and `FormData` feature selection is not +yet available in a published release. `FileEntries` is included transitively; +the selection compiles 27 WebAPI source modules. +Before a production release, replace the snapshot with a published WebAPI +version containing those features and rerun the packed-consumer tests. +The compiler peer range follows the snapshot's supported v13 prerelease range; +ReScript 12 is not supported by this migration. + +## Elements and refs + +Use `WebAPI.DOMTree.element` for React roots, portals, DOM refs, and +`ReactTestUtils` DOM helpers. Ref callbacks still receive nullable elements +and may return a cleanup function. JSX, style, and synthetic-event tag +identities are unchanged. + +Consumers that name WebAPI modules directly should declare `@rescript/webapi` +in their package and ReScript dependencies. Select the features needed by +their code, for example: + +```json +{ + "dependencies": [ + "@rescript/react", + { + "name": "@rescript/webapi", + "features": ["WebAPI.DOMTree", "WebAPI.Event"] + } + ] +} +``` + +During this prerelease, use the same WebAPI snapshot as `@rescript/react` to +avoid installing incompatible copies. Consumers that do not name WebAPI +modules can depend only on `@rescript/react`. + +## Events + +| Getter | Return type | +| --- | --- | +| `nativeEvent` in every event family | `WebAPI.DOM.event` | +| `target` in every event family | `WebAPI.DOM.eventTarget` | +| `currentTarget` in every event family | `option` | +| Focus, Mouse, and Pointer `relatedTarget` | `option` | +| UI and Pointer `view` | `option` | +| Pointer `pointerId` | `int` | +| Clipboard `clipboardData` | `option` | +| Touch `changedTouches`, `targetTouches`, and `touches` | `WebAPI.TouchList.t` | + +The `Synthetic` getters accept all synthetic event families. Synthetic events +remain React-specific values; they are not native DOM events. + +Event targets are not necessarily elements. Access concrete element fields +only after runtime narrowing with an appropriately typed DOM binding; do not +replace open-object field access with an unchecked cast. + +React clears `currentTarget` after invoking each handler, even after +`persist()`. Match `Some(target)` / `None`, and capture a present target inside +the handler if it is needed later. `view` can be null on a native UI event or +absent on a scroll event; both produce `None`. Related targets likewise map +both null and undefined to `None`. + +Returning a WebAPI type does not enable all its operations. For example, +select `WebAPI.Event` to use native event operations. + +Clipboard data can be absent on script-created events; match the option before +using `WebAPI.DataTransfer` operations. Touch lists are not arrays. Use +`WebAPI.TouchList.item` to retrieve a nullable `WebAPI.Touch.t`. + +## FormData and files + +`ReactDOM.FormData.t` aliases `WebAPI.FormData.t`, so React form actions and +status data interoperate directly with WebAPI FormData operations. +`ReactDOM.FormData.file` aliases `WebAPI.DOM.file`, so files interoperate with +`WebAPI.File.t` without conversion. Select `WebAPI.File` for file operations. +The React helper names and boxed `String`/`File` return variants retain their +behavior. Those boxed variants are distinct from WebAPI's unboxed +`FormDataEntryValue`; do not treat the two value representations as aliases. diff --git a/README.md b/README.md index 38bba91..1d1dd38 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,23 @@ npm install npm start ``` +Run `npm ci`, `npm run build`, and `npm test` with Node.js 24 and Python 3. +The tests install the packed library into a disposable consumer and check +type interoperability, feature selection, and JavaScript binding behavior. + +### WebAPI types + +DOM elements, native events, event targets, clipboard data, touch lists, and +FormData use WebAPI types. The library selects `WebAPI.DOMTree`, +`WebAPI.History`, `WebAPI.Location`, `WebAPI.Touch`, `WebAPI.DataTransfer`, +and `WebAPI.FormData`; consumers can enable additional WebAPI features for +the operations they use. + +This prerelease requires ReScript 13.0.0-alpha.7 and pins a WebAPI source +snapshot while its required features await release. See the +[migration notes](MIGRATION.md) for public type changes and the dependency +release requirement. + ### Acknowledgements This project is the next evolution of the original [reason-react](https://github.com/reasonml/reason-react) bindings. diff --git a/package-lock.json b/package-lock.json index 8c33cde..9c80c4e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,107 +8,100 @@ "name": "@rescript/react", "version": "0.16.0-beta.1", "license": "MIT", + "dependencies": { + "@rescript/webapi": "https://codeload.github.com/rescript-lang/experimental-rescript-webapi/tar.gz/691bc3f20dc5d621d22f5bf9931b4ec086542d5f" + }, "devDependencies": { "pkg-pr-new": "^0.0.75", "react": "^19.2.0", "react-dom": "^19.2.0", - "rescript": "^13.0.0-alpha.5" + "rescript": "13.0.0-alpha.7" }, "peerDependencies": { - "@rescript/runtime": ">=13.0.0-alpha.5", + "@rescript/runtime": ">=13.0.0-alpha.7", "react": ">=19.2.0", - "react-dom": ">=19.2.0" + "react-dom": ">=19.2.0", + "rescript": ">=13.0.0-alpha.7 <13.0.0" } }, "node_modules/@rescript/darwin-arm64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/darwin-arm64/-/darwin-arm64-13.0.0-alpha.5.tgz", - "integrity": "sha512-OCpT4VYLkxTjm56y+CG4SfrqotMLCaqKY5pxGq75hOPRZLZ5n5BG3OvA1rBsmz5+gT7VpKm1Do9YhmO0JvYZfg==", + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/darwin-arm64/-/darwin-arm64-13.0.0-alpha.7.tgz", + "integrity": "sha512-jAoS+bjMRQ2HEvZAo/I3gETmp5lZ/wOMtj9XklbcJvttDwhZUuZ3r8NFYwhbY+hFiCe5mWKgJaBKzMM1glKKLQ==", "cpu": [ "arm64" ], - "dev": true, "license": "(LGPL-3.0-or-later AND MIT)", "optional": true, "os": [ "darwin" ], "engines": { - "node": ">=20.11.0" - } - }, - "node_modules/@rescript/darwin-x64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/darwin-x64/-/darwin-x64-13.0.0-alpha.5.tgz", - "integrity": "sha512-UT143XnOVmUUayrD/1ceKrXb8rbhNmXKhhfnTnRGRLWp1Hxyiq5uq3OGNorSIW6jHsszsP0VvjKA+Z31h04E6Q==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "(LGPL-3.0-or-later AND MIT)", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=20.11.0" + "node": ">=22" } }, "node_modules/@rescript/linux-arm64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/linux-arm64/-/linux-arm64-13.0.0-alpha.5.tgz", - "integrity": "sha512-lQ3trljExrH1uqS3hsjjoi6fnaImG/tYppcF2X4Yk8u0AP1t6AC6LUM0KR2kjctG5b7OVUrujOu91NnjovN46A==", + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/linux-arm64/-/linux-arm64-13.0.0-alpha.7.tgz", + "integrity": "sha512-wVwmKc64b6dQWuC6bfCh4F/ULSyEwZx7zQx07uQ6lvVJg+VonfEEr1J8R3SVVWvvUycYYCYnaXaCheH1V28Lpw==", "cpu": [ "arm64" ], - "dev": true, "license": "(LGPL-3.0-or-later AND MIT)", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=20.11.0" + "node": ">=22" } }, "node_modules/@rescript/linux-x64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/linux-x64/-/linux-x64-13.0.0-alpha.5.tgz", - "integrity": "sha512-Cu73xGa2nMcSgW274tAJDexlBqJGFKpv/v9wHAxqFxXzIwSkET51N9xkf42GljejeVzwyDEfgQId2Znme/PWkg==", + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/linux-x64/-/linux-x64-13.0.0-alpha.7.tgz", + "integrity": "sha512-bm2FdxeJe61/5rk7q1qfdX74OjhdIqByKub+hg+t6XgiSXYUx5dW12hBfxzrM+IzoTNeZetuIfjbZKvH8Q9JAQ==", "cpu": [ "x64" ], - "dev": true, "license": "(LGPL-3.0-or-later AND MIT)", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=20.11.0" + "node": ">=22" } }, "node_modules/@rescript/runtime": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/runtime/-/runtime-13.0.0-alpha.5.tgz", - "integrity": "sha512-k0iQhrDasCD5K5orSrps21ZVgvMgOIwh03QjUAxtMkVwyPclg6LbgG5eAAgduyecXXm3ii30o3nDaXvCryu/Tw==", + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/runtime/-/runtime-13.0.0-alpha.7.tgz", + "integrity": "sha512-NUXP0XgObn1lg9p9ZHQqq72xDf0wqh0yUYmQvO3JFrQdeNM6c+LfDoJkFoJob5pWS0C3vSxy77MqTneoYodC+A==", "license": "MIT" }, + "node_modules/@rescript/webapi": { + "version": "1.0.0-alpha.1", + "resolved": "https://codeload.github.com/rescript-lang/experimental-rescript-webapi/tar.gz/691bc3f20dc5d621d22f5bf9931b4ec086542d5f", + "integrity": "sha512-XHhr4gkYSXjVRX3TXrtFgBSrq+GCrtfEQI0i8mQuWo+Xbw3uYzToSBbsiDlDbk0tQKXpRZnHXeoTh8LAT2hHaA==", + "license": "MIT", + "peerDependencies": { + "rescript": ">=13.0.0-alpha.7 <13.0.0" + } + }, "node_modules/@rescript/win32-x64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/win32-x64/-/win32-x64-13.0.0-alpha.5.tgz", - "integrity": "sha512-7uUkUY0pXDdPB5znHQYWsGml3E2pQ68KSaM7HZoFfnOEIuPqGz/hssgLgsXHkfHxrHB0waX9fsqx2Qckn6IGsw==", + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/win32-x64/-/win32-x64-13.0.0-alpha.7.tgz", + "integrity": "sha512-9gxxtwYt4N5FbyFnqka6xpwtu4AP7UlvdXK9nz2zNUusjqNmggXOAvSd9zI/RuvG08nEEAXPfF7dkZ/hM9aJ1w==", "cpu": [ - "x64" + "x64", + "arm64" ], - "dev": true, "license": "(LGPL-3.0-or-later AND MIT)", "optional": true, "os": [ "win32" ], "engines": { - "node": ">=20.11.0" + "node": ">=22" } }, "node_modules/pkg-pr-new": { @@ -145,10 +138,9 @@ } }, "node_modules/rescript": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/rescript/-/rescript-13.0.0-alpha.5.tgz", - "integrity": "sha512-rv/xA1OQLN5l90/szD82IR8p/bNzwKNPLnEVaR89oiuBZYG7IhHfRxEKAvpOHqlrpnV8zKmc16IXcjCQxlni/w==", - "dev": true, + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/rescript/-/rescript-13.0.0-alpha.7.tgz", + "integrity": "sha512-xsQALc6IlT7bUAXDw/I9HEcruE1py7OB0z9GQ/4bp8XSAhCTLhNkGQo9QBkAzl9fUaOji3EymYetJ3TYD1tPVg==", "license": "(LGPL-3.0-or-later AND MIT)", "workspaces": [ "packages/dev-playground", @@ -157,6 +149,7 @@ "tests/dependencies/**", "tests/analysis_tests/**", "tests/docstring_tests", + "tests/belt_tests", "tests/gentype_tests/**", "tests/tests", "tests/tools_tests", @@ -164,22 +157,22 @@ "scripts/res" ], "dependencies": { - "@rescript/runtime": "13.0.0-alpha.5" + "@rescript/runtime": "13.0.0-alpha.7" }, "bin": { "bsc": "cli/bsc.js", "rescript": "cli/rescript.js", + "rescript-rust": "cli/rescript-rust.js", "rescript-tools": "cli/rescript-tools.js" }, "engines": { "node": ">=22" }, "optionalDependencies": { - "@rescript/darwin-arm64": "13.0.0-alpha.5", - "@rescript/darwin-x64": "13.0.0-alpha.5", - "@rescript/linux-arm64": "13.0.0-alpha.5", - "@rescript/linux-x64": "13.0.0-alpha.5", - "@rescript/win32-x64": "13.0.0-alpha.5" + "@rescript/darwin-arm64": "13.0.0-alpha.7", + "@rescript/linux-arm64": "13.0.0-alpha.7", + "@rescript/linux-x64": "13.0.0-alpha.7", + "@rescript/win32-x64": "13.0.0-alpha.7" } }, "node_modules/scheduler": { @@ -192,43 +185,37 @@ }, "dependencies": { "@rescript/darwin-arm64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/darwin-arm64/-/darwin-arm64-13.0.0-alpha.5.tgz", - "integrity": "sha512-OCpT4VYLkxTjm56y+CG4SfrqotMLCaqKY5pxGq75hOPRZLZ5n5BG3OvA1rBsmz5+gT7VpKm1Do9YhmO0JvYZfg==", - "dev": true, - "optional": true - }, - "@rescript/darwin-x64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/darwin-x64/-/darwin-x64-13.0.0-alpha.5.tgz", - "integrity": "sha512-UT143XnOVmUUayrD/1ceKrXb8rbhNmXKhhfnTnRGRLWp1Hxyiq5uq3OGNorSIW6jHsszsP0VvjKA+Z31h04E6Q==", - "dev": true, + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/darwin-arm64/-/darwin-arm64-13.0.0-alpha.7.tgz", + "integrity": "sha512-jAoS+bjMRQ2HEvZAo/I3gETmp5lZ/wOMtj9XklbcJvttDwhZUuZ3r8NFYwhbY+hFiCe5mWKgJaBKzMM1glKKLQ==", "optional": true }, "@rescript/linux-arm64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/linux-arm64/-/linux-arm64-13.0.0-alpha.5.tgz", - "integrity": "sha512-lQ3trljExrH1uqS3hsjjoi6fnaImG/tYppcF2X4Yk8u0AP1t6AC6LUM0KR2kjctG5b7OVUrujOu91NnjovN46A==", - "dev": true, + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/linux-arm64/-/linux-arm64-13.0.0-alpha.7.tgz", + "integrity": "sha512-wVwmKc64b6dQWuC6bfCh4F/ULSyEwZx7zQx07uQ6lvVJg+VonfEEr1J8R3SVVWvvUycYYCYnaXaCheH1V28Lpw==", "optional": true }, "@rescript/linux-x64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/linux-x64/-/linux-x64-13.0.0-alpha.5.tgz", - "integrity": "sha512-Cu73xGa2nMcSgW274tAJDexlBqJGFKpv/v9wHAxqFxXzIwSkET51N9xkf42GljejeVzwyDEfgQId2Znme/PWkg==", - "dev": true, + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/linux-x64/-/linux-x64-13.0.0-alpha.7.tgz", + "integrity": "sha512-bm2FdxeJe61/5rk7q1qfdX74OjhdIqByKub+hg+t6XgiSXYUx5dW12hBfxzrM+IzoTNeZetuIfjbZKvH8Q9JAQ==", "optional": true }, "@rescript/runtime": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/runtime/-/runtime-13.0.0-alpha.5.tgz", - "integrity": "sha512-k0iQhrDasCD5K5orSrps21ZVgvMgOIwh03QjUAxtMkVwyPclg6LbgG5eAAgduyecXXm3ii30o3nDaXvCryu/Tw==" + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/runtime/-/runtime-13.0.0-alpha.7.tgz", + "integrity": "sha512-NUXP0XgObn1lg9p9ZHQqq72xDf0wqh0yUYmQvO3JFrQdeNM6c+LfDoJkFoJob5pWS0C3vSxy77MqTneoYodC+A==" + }, + "@rescript/webapi": { + "version": "https://codeload.github.com/rescript-lang/experimental-rescript-webapi/tar.gz/691bc3f20dc5d621d22f5bf9931b4ec086542d5f", + "integrity": "sha512-XHhr4gkYSXjVRX3TXrtFgBSrq+GCrtfEQI0i8mQuWo+Xbw3uYzToSBbsiDlDbk0tQKXpRZnHXeoTh8LAT2hHaA==", + "requires": {} }, "@rescript/win32-x64": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/@rescript/win32-x64/-/win32-x64-13.0.0-alpha.5.tgz", - "integrity": "sha512-7uUkUY0pXDdPB5znHQYWsGml3E2pQ68KSaM7HZoFfnOEIuPqGz/hssgLgsXHkfHxrHB0waX9fsqx2Qckn6IGsw==", - "dev": true, + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/@rescript/win32-x64/-/win32-x64-13.0.0-alpha.7.tgz", + "integrity": "sha512-9gxxtwYt4N5FbyFnqka6xpwtu4AP7UlvdXK9nz2zNUusjqNmggXOAvSd9zI/RuvG08nEEAXPfF7dkZ/hM9aJ1w==", "optional": true }, "pkg-pr-new": { @@ -253,17 +240,15 @@ } }, "rescript": { - "version": "13.0.0-alpha.5", - "resolved": "https://registry.npmjs.org/rescript/-/rescript-13.0.0-alpha.5.tgz", - "integrity": "sha512-rv/xA1OQLN5l90/szD82IR8p/bNzwKNPLnEVaR89oiuBZYG7IhHfRxEKAvpOHqlrpnV8zKmc16IXcjCQxlni/w==", - "dev": true, + "version": "13.0.0-alpha.7", + "resolved": "https://registry.npmjs.org/rescript/-/rescript-13.0.0-alpha.7.tgz", + "integrity": "sha512-xsQALc6IlT7bUAXDw/I9HEcruE1py7OB0z9GQ/4bp8XSAhCTLhNkGQo9QBkAzl9fUaOji3EymYetJ3TYD1tPVg==", "requires": { - "@rescript/darwin-arm64": "13.0.0-alpha.5", - "@rescript/darwin-x64": "13.0.0-alpha.5", - "@rescript/linux-arm64": "13.0.0-alpha.5", - "@rescript/linux-x64": "13.0.0-alpha.5", - "@rescript/runtime": "13.0.0-alpha.5", - "@rescript/win32-x64": "13.0.0-alpha.5" + "@rescript/darwin-arm64": "13.0.0-alpha.7", + "@rescript/linux-arm64": "13.0.0-alpha.7", + "@rescript/linux-x64": "13.0.0-alpha.7", + "@rescript/runtime": "13.0.0-alpha.7", + "@rescript/win32-x64": "13.0.0-alpha.7" } }, "scheduler": { diff --git a/package.json b/package.json index c957e3b..33d1360 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "description": "React bindings for ReScript", "files": [ "README.md", + "MIGRATION.md", "CHANGELOG.md", "LICENSE", "rescript.json", @@ -15,7 +16,7 @@ "start": "rescript watch", "clean": "rescript clean", "format": "rescript format", - "test": "echo 'tests disabled for now'" + "test": "python3 tests/check-consumer.py" }, "keywords": [ "rescript", @@ -28,14 +29,18 @@ "url": "git+https://github.com/rescript-lang/rescript-react.git" }, "homepage": "https://rescript-lang.org/docs/react/latest/introduction", + "dependencies": { + "@rescript/webapi": "https://codeload.github.com/rescript-lang/experimental-rescript-webapi/tar.gz/691bc3f20dc5d621d22f5bf9931b4ec086542d5f" + }, "devDependencies": { "pkg-pr-new": "^0.0.75", "react": "^19.2.0", "react-dom": "^19.2.0", - "rescript": "^13.0.0-alpha.5" + "rescript": "13.0.0-alpha.7" }, "peerDependencies": { - "@rescript/runtime": ">=13.0.0-alpha.5", + "@rescript/runtime": ">=13.0.0-alpha.7", + "rescript": ">=13.0.0-alpha.7 <13.0.0", "react": ">=19.2.0", "react-dom": ">=19.2.0" } diff --git a/rescript.json b/rescript.json index a0897f3..171dd17 100644 --- a/rescript.json +++ b/rescript.json @@ -3,6 +3,19 @@ "jsx": { "version": 4 }, + "dependencies": [ + { + "name": "@rescript/webapi", + "features": [ + "WebAPI.DOMTree", + "WebAPI.History", + "WebAPI.Location", + "WebAPI.Touch", + "WebAPI.DataTransfer", + "WebAPI.FormData" + ] + } + ], "sources": [ { "dir": "src" diff --git a/src/ReactDOM.res b/src/ReactDOM.res index 64670af..3936a36 100644 --- a/src/ReactDOM.res +++ b/src/ReactDOM.res @@ -7,7 +7,7 @@ // Helper so that ReactDOM itself doesn't bring any runtime @val @return(nullable) -external querySelector: string => option = "document.querySelector" +external querySelector: string => option = "document.querySelector" module Client = { module Root = { @@ -19,16 +19,16 @@ module Client = { } @module("react-dom/client") - external createRoot: Dom.element => Root.t = "createRoot" + external createRoot: WebAPI.DOMTree.element => Root.t = "createRoot" @module("react-dom/client") - external hydrateRoot: (Dom.element, React.element) => Root.t = "hydrateRoot" + external hydrateRoot: (WebAPI.DOMTree.element, React.element) => Root.t = "hydrateRoot" } // Very rudimentary form data bindings module FormData = { - type t - type file + type t = WebAPI.FormData.t + type file = WebAPI.DOM.file type formValue = | String(string) @@ -72,9 +72,9 @@ module FormData = { } @module("react-dom") -external createPortal: (React.element, Dom.element) => React.element = "createPortal" +external createPortal: (React.element, WebAPI.DOMTree.element) => React.element = "createPortal" -external domElementToObj: Dom.element => {..} = "%identity" +external domElementToObj: WebAPI.DOMTree.element => {..} = "%identity" type style = ReactDOMStyle.t @@ -82,8 +82,8 @@ type domRef = JsxDOM.domRef module Ref = { type t = domRef - type currentDomRef = React.ref> - type callbackDomRef = nullable => option unit> + type currentDomRef = React.ref> + type callbackDomRef = nullable => option unit> external domRef: currentDomRef => domRef = "%identity" external callbackDomRef: callbackDomRef => domRef = "%identity" diff --git a/src/ReactDOM.res.js b/src/ReactDOM.res.js index 766ec05..e720134 100644 --- a/src/ReactDOM.res.js +++ b/src/ReactDOM.res.js @@ -1,6 +1,6 @@ // Generated by ReScript, PLEASE EDIT WITH CARE -import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.js"; +import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.mjs"; let Root = {}; @@ -18,7 +18,7 @@ function getString(formData, name) { function getFile(formData, name) { let value = formData.get(name); if (!(value == null) && typeof value !== "string") { - return Primitive_option.some(value); + return value; } } diff --git a/src/ReactEvent.res b/src/ReactEvent.res index 54ac591..d2427a6 100644 --- a/src/ReactEvent.res +++ b/src/ReactEvent.res @@ -7,19 +7,26 @@ module MakeEventWithType = ( ) => { @get external bubbles: Type.t => bool = "bubbles" @get external cancelable: Type.t => bool = "cancelable" - @get - external currentTarget: Type.t => {..} = "currentTarget" /* Should return Dom.eventTarget */ + + /** React clears currentTarget after invoking the handler, even after persist(). */ + @get @return(nullable) + external currentTarget: Type.t => option = "currentTarget" + @get external defaultPrevented: Type.t => bool = "defaultPrevented" @get external eventPhase: Type.t => int = "eventPhase" @get external isTrusted: Type.t => bool = "isTrusted" - @get external nativeEvent: Type.t => {..} = "nativeEvent" /* Should return Dom.event */ + @get external nativeEvent: Type.t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: Type.t => unit = "preventDefault" + @send external isDefaultPrevented: Type.t => bool = "isDefaultPrevented" + @send external stopPropagation: Type.t => unit = "stopPropagation" + @send external isPropagationStopped: Type.t => bool = "isPropagationStopped" - @get external target: Type.t => {..} = "target" /* Should return Dom.eventTarget */ + + @get external target: Type.t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: Type.t => float = "timeStamp" @get external type_: Type.t => string = "type" @send external persist: Type.t => unit = "persist" @@ -30,24 +37,32 @@ module Synthetic = { type t = synthetic @get external bubbles: synthetic<'a> => bool = "bubbles" @get external cancelable: synthetic<'a> => bool = "cancelable" - @get - external currentTarget: synthetic<'a> => {..} = - "currentTarget" /* Should return Dom.eventTarget */ + + @get @return(nullable) + external currentTarget: synthetic<'a> => option = "currentTarget" + @get external defaultPrevented: synthetic<'a> => bool = "defaultPrevented" + @get external eventPhase: synthetic<'a> => int = "eventPhase" @get external isTrusted: synthetic<'a> => bool = "isTrusted" + @get - external nativeEvent: synthetic<'a> => {..} = "nativeEvent" /* Should return Dom.event */ + external nativeEvent: synthetic<'a> => WebAPI.DOM.event = "nativeEvent" + @send external preventDefault: synthetic<'a> => unit = "preventDefault" + @send external isDefaultPrevented: synthetic<'a> => bool = "isDefaultPrevented" + @send external stopPropagation: synthetic<'a> => unit = "stopPropagation" + @send external isPropagationStopped: synthetic<'a> => bool = "isPropagationStopped" - @get external target: synthetic<'a> => {..} = "target" /* Should return Dom.eventTarget */ + + @get external target: synthetic<'a> => WebAPI.DOM.eventTarget = "target" @get external timeStamp: synthetic<'a> => float = "timeStamp" @get external type_: synthetic<'a> => string = "type" @send external persist: synthetic<'a> => unit = "persist" @@ -60,7 +75,9 @@ module Clipboard = { type tag = JsxEvent.Clipboard.tag type t = synthetic include MakeEventWithType({type t = t}) - @get external clipboardData: t => {..} = "clipboardData" /* Should return Dom.dataTransfer */ + + @get @return(nullable) + external clipboardData: t => option = "clipboardData" } module Composition = { @@ -78,8 +95,10 @@ module Keyboard = { @get external charCode: t => int = "charCode" @get external code: t => string = "code" @get external ctrlKey: t => bool = "ctrlKey" + @send external getModifierState: (t, string) => bool = "getModifierState" + @get external key: t => string = "key" @get external keyCode: t => int = "keyCode" @get external locale: t => string = "locale" @@ -94,8 +113,9 @@ module Focus = { type tag = JsxEvent.Focus.tag type t = synthetic include MakeEventWithType({type t = t}) + @get @return(nullable) - external relatedTarget: t => option<{..}> = "relatedTarget" /* Should return Dom.eventTarget */ + external relatedTarget: t => option = "relatedTarget" } module Form = { @@ -114,15 +134,19 @@ module Mouse = { @get external clientX: t => int = "clientX" @get external clientY: t => int = "clientY" @get external ctrlKey: t => bool = "ctrlKey" + @send external getModifierState: (t, string) => bool = "getModifierState" + @get external metaKey: t => bool = "metaKey" @get external movementX: t => int = "movementX" @get external movementY: t => int = "movementY" @get external pageX: t => int = "pageX" @get external pageY: t => int = "pageY" + @get @return(nullable) - external relatedTarget: t => option<{..}> = "relatedTarget" /* Should return Dom.eventTarget */ + external relatedTarget: t => option = "relatedTarget" + @get external screenX: t => int = "screenX" @get external screenY: t => int = "screenY" @get external shiftKey: t => bool = "shiftKey" @@ -135,7 +159,10 @@ module Pointer = { // UIEvent @get external detail: t => int = "detail" - @get external view: t => Dom.window = "view" /* Should return DOMAbstractView/WindowProxy */ + + /** None when the native event has no associated view. */ + @get @return(nullable) + external view: t => option = "view" // MouseEvent @get external screenX: t => int = "screenX" @@ -151,6 +178,7 @@ module Pointer = { @get external shiftKey: t => bool = "shiftKey" @get external altKey: t => bool = "altKey" @get external metaKey: t => bool = "metaKey" + @send external getModifierState: (t, string) => bool = "getModifierState" @@ -158,10 +186,10 @@ module Pointer = { @get external buttons: t => int = "buttons" @get @return(nullable) - external relatedTarget: t => option<{..}> = "relatedTarget" /* Should return Dom.eventTarget */ + external relatedTarget: t => option = "relatedTarget" // PointerEvent - @get external pointerId: t => Dom.eventPointerId = "pointerId" + @get external pointerId: t => int = "pointerId" @get external width: t => float = "width" @get external height: t => float = "height" @get external pressure: t => float = "pressure" @@ -184,14 +212,16 @@ module Touch = { type t = synthetic include MakeEventWithType({type t = t}) @get external altKey: t => bool = "altKey" - @get external changedTouches: t => {..} = "changedTouches" /* Should return Dom.touchList */ + @get external changedTouches: t => WebAPI.TouchList.t = "changedTouches" @get external ctrlKey: t => bool = "ctrlKey" + @send external getModifierState: (t, string) => bool = "getModifierState" + @get external metaKey: t => bool = "metaKey" @get external shiftKey: t => bool = "shiftKey" - @get external targetTouches: t => {..} = "targetTouches" /* Should return Dom.touchList */ - @get external touches: t => {..} = "touches" /* Should return Dom.touchList */ + @get external targetTouches: t => WebAPI.TouchList.t = "targetTouches" + @get external touches: t => WebAPI.TouchList.t = "touches" } module UI = { @@ -199,7 +229,10 @@ module UI = { type t = synthetic include MakeEventWithType({type t = t}) @get external detail: t => int = "detail" - @get external view: t => Dom.window = "view" /* Should return DOMAbstractView/WindowProxy */ + + /** None when the native event has no associated view. */ + @get @return(nullable) + external view: t => option = "view" } module Wheel = { diff --git a/src/ReactEvent.resi b/src/ReactEvent.resi index 61b5d4b..0a62798 100644 --- a/src/ReactEvent.resi +++ b/src/ReactEvent.resi @@ -43,23 +43,33 @@ module Synthetic: { type t = synthetic @get external bubbles: synthetic<'a> => bool = "bubbles" @get external cancelable: synthetic<'a> => bool = "cancelable" - @get - external currentTarget: synthetic<'a> => {..} = "currentTarget" + + /** React clears currentTarget after invoking the handler, even after persist(). */ + @get @return(nullable) + external currentTarget: synthetic<'a> => option = "currentTarget" + @get external defaultPrevented: synthetic<'a> => bool = "defaultPrevented" + @get external eventPhase: synthetic<'a> => int = "eventPhase" @get external isTrusted: synthetic<'a> => bool = "isTrusted" + @get - external nativeEvent: synthetic<'a> => {..} = "nativeEvent" + external nativeEvent: synthetic<'a> => WebAPI.DOM.event = "nativeEvent" + @send external preventDefault: synthetic<'a> => unit = "preventDefault" + @send external isDefaultPrevented: synthetic<'a> => bool = "isDefaultPrevented" + @send external stopPropagation: synthetic<'a> => unit = "stopPropagation" + @send external isPropagationStopped: synthetic<'a> => bool = "isPropagationStopped" - @get external target: synthetic<'a> => {..} = "target" + + @get external target: synthetic<'a> => WebAPI.DOM.eventTarget = "target" @get external timeStamp: synthetic<'a> => float = "timeStamp" @get external type_: synthetic<'a> => string = "type" @send external persist: synthetic<'a> => unit = "persist" @@ -73,20 +83,25 @@ module Clipboard: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" - @get external clipboardData: t => {..} = "clipboardData" /* Should return Dom.dataTransfer */ + + @get @return(nullable) + external clipboardData: t => option = "clipboardData" } module Composition: { @@ -94,16 +109,19 @@ module Composition: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -115,16 +133,19 @@ module Keyboard: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -132,8 +153,10 @@ module Keyboard: { @get external charCode: t => int = "charCode" @get external code: t => string = "code" @get external ctrlKey: t => bool = "ctrlKey" + @send external getModifierState: (t, string) => bool = "getModifierState" + @get external key: t => string = "key" @get external keyCode: t => int = "keyCode" @get external locale: t => string = "locale" @@ -149,21 +172,25 @@ module Focus: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" + @get @return(nullable) - external relatedTarget: t => option<{..}> = "relatedTarget" /* Should return Dom.eventTarget */ + external relatedTarget: t => option = "relatedTarget" } module Form: { @@ -171,16 +198,19 @@ module Form: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -191,16 +221,19 @@ module Mouse: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -210,15 +243,19 @@ module Mouse: { @get external clientX: t => int = "clientX" @get external clientY: t => int = "clientY" @get external ctrlKey: t => bool = "ctrlKey" + @send external getModifierState: (t, string) => bool = "getModifierState" + @get external metaKey: t => bool = "metaKey" @get external movementX: t => int = "movementX" @get external movementY: t => int = "movementY" @get external pageX: t => int = "pageX" @get external pageY: t => int = "pageY" + @get @return(nullable) - external relatedTarget: t => option<{..}> = "relatedTarget" /* Should return Dom.eventTarget */ + external relatedTarget: t => option = "relatedTarget" + @get external screenX: t => int = "screenX" @get external screenY: t => int = "screenY" @get external shiftKey: t => bool = "shiftKey" @@ -230,8 +267,10 @@ module Pointer: { // Event @get external type_: t => string = "type" - @get external target: t => {..} = "target" - @get external currentTarget: t => {..} = "currentTarget" + @get external target: t => WebAPI.DOM.eventTarget = "target" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" @get external eventPhase: t => int = "eventPhase" @@ -245,14 +284,17 @@ module Pointer: { @get external timeStamp: t => float = "timeStamp" // SyntheticEvent - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external isPropagationStopped: t => bool = "isPropagationStopped" @send external persist: t => unit = "persist" // UIEvent @get external detail: t => int = "detail" - @get external view: t => Dom.window = "view" /* Should return DOMAbstractView/WindowProxy */ + + /** None when the native event has no associated view. */ + @get @return(nullable) + external view: t => option = "view" // MouseEvent @get external screenX: t => int = "screenX" @@ -268,6 +310,7 @@ module Pointer: { @get external shiftKey: t => bool = "shiftKey" @get external altKey: t => bool = "altKey" @get external metaKey: t => bool = "metaKey" + @send external getModifierState: (t, string) => bool = "getModifierState" @@ -275,10 +318,10 @@ module Pointer: { @get external buttons: t => int = "buttons" @get @return(nullable) - external relatedTarget: t => option<{..}> = "relatedTarget" /* Should return Dom.eventTarget */ + external relatedTarget: t => option = "relatedTarget" // PointerEvent - @get external pointerId: t => Dom.eventPointerId = "pointerId" + @get external pointerId: t => int = "pointerId" @get external width: t => float = "width" @get external height: t => float = "height" @get external pressure: t => float = "pressure" @@ -295,16 +338,19 @@ module Selection: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -315,28 +361,33 @@ module Touch: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @get external altKey: t => bool = "altKey" - @get external changedTouches: t => {..} = "changedTouches" /* Should return Dom.touchList */ + @get external changedTouches: t => WebAPI.TouchList.t = "changedTouches" @get external ctrlKey: t => bool = "ctrlKey" + @send external getModifierState: (t, string) => bool = "getModifierState" + @get external metaKey: t => bool = "metaKey" @get external shiftKey: t => bool = "shiftKey" - @get external targetTouches: t => {..} = "targetTouches" /* Should return Dom.touchList */ - @get external touches: t => {..} = "touches" /* Should return Dom.touchList */ + @get external targetTouches: t => WebAPI.TouchList.t = "targetTouches" + @get external touches: t => WebAPI.TouchList.t = "touches" } module UI: { @@ -344,21 +395,27 @@ module UI: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @get external detail: t => int = "detail" - @get external view: t => Dom.window = "view" /* Should return DOMAbstractView/WindowProxy */ + + /** None when the native event has no associated view. */ + @get @return(nullable) + external view: t => option = "view" } module Wheel: { @@ -366,16 +423,19 @@ module Wheel: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -390,16 +450,19 @@ module Media: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -410,16 +473,19 @@ module Image: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -430,16 +496,19 @@ module Animation: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" @@ -453,16 +522,19 @@ module Transition: { type t = synthetic @get external bubbles: t => bool = "bubbles" @get external cancelable: t => bool = "cancelable" - @get external currentTarget: t => {..} = "currentTarget" + + @get @return(nullable) + external currentTarget: t => option = "currentTarget" + @get external defaultPrevented: t => bool = "defaultPrevented" @get external eventPhase: t => int = "eventPhase" @get external isTrusted: t => bool = "isTrusted" - @get external nativeEvent: t => {..} = "nativeEvent" + @get external nativeEvent: t => WebAPI.DOM.event = "nativeEvent" @send external preventDefault: t => unit = "preventDefault" @send external isDefaultPrevented: t => bool = "isDefaultPrevented" @send external stopPropagation: t => unit = "stopPropagation" @send external isPropagationStopped: t => bool = "isPropagationStopped" - @get external target: t => {..} = "target" + @get external target: t => WebAPI.DOM.eventTarget = "target" @get external timeStamp: t => float = "timeStamp" @get external type_: t => string = "type" @send external persist: t => unit = "persist" diff --git a/src/ReactTestUtils.res b/src/ReactTestUtils.res index 3b92614..38f7c74 100644 --- a/src/ReactTestUtils.res +++ b/src/ReactTestUtils.res @@ -39,15 +39,20 @@ external isCompositeComponentWithType: ('element, React.component<'props>) => bo module Simulate = { @module("react-dom/test-utils") @scope("Simulate") - external click: Dom.element => unit = "click" + external click: WebAPI.DOMTree.element => unit = "click" + @module("react-dom/test-utils") @scope("Simulate") - external clickWithEvent: (Dom.element, 'event) => unit = "click" + external clickWithEvent: (WebAPI.DOMTree.element, 'event) => unit = "click" + @module("react-dom/test-utils") @scope("Simulate") - external change: Dom.element => unit = "change" + external change: WebAPI.DOMTree.element => unit = "change" + @module("react-dom/test-utils") @scope("Simulate") - external blur: Dom.element => unit = "blur" + external blur: WebAPI.DOMTree.element => unit = "blur" + @module("react-dom/test-utils") @scope("Simulate") - external changeWithEvent: (Dom.element, 'event) => unit = "change" + external changeWithEvent: (WebAPI.DOMTree.element, 'event) => unit = "change" + let changeWithValue = (element, value) => { let event = { "target": { @@ -56,6 +61,7 @@ module Simulate = { } changeWithEvent(element, event) } + let changeWithChecked = (element, value) => { let event = { "target": { @@ -64,38 +70,51 @@ module Simulate = { } changeWithEvent(element, event) } + @module("react-dom/test-utils") @scope("Simulate") - external canPlay: Dom.element => unit = "canPlay" + external canPlay: WebAPI.DOMTree.element => unit = "canPlay" + @module("react-dom/test-utils") @scope("Simulate") - external timeUpdate: Dom.element => unit = "timeUpdate" + external timeUpdate: WebAPI.DOMTree.element => unit = "timeUpdate" + @module("react-dom/test-utils") @scope("Simulate") - external ended: Dom.element => unit = "ended" + external ended: WebAPI.DOMTree.element => unit = "ended" + @module("react-dom/test-utils") @scope("Simulate") - external focus: Dom.element => unit = "focus" + external focus: WebAPI.DOMTree.element => unit = "focus" } -@val external document: Dom.document = "document" +@val external document: WebAPI.DOM.document = "document" -@send -external querySelector: (Dom.element, string) => option = "querySelector" +@send @return(nullable) +external querySelector: (WebAPI.DOMTree.element, string) => option = + "querySelector" @send -external querySelectorAll: (Dom.element, string) => Array.arrayLike = - "querySelectorAll" +external querySelectorAll: ( + WebAPI.DOMTree.element, + string, +) => Array.arrayLike = "querySelectorAll" + +@get external textContent: WebAPI.DOMTree.element => string = "textContent" + +@get @return(nullable) +external body: WebAPI.DOM.document => option = "body" -@get external textContent: Dom.element => string = "textContent" -@get external body: Dom.document => option = "body" @send -external createElement: (Dom.document, string) => Dom.element = "createElement" -@send external remove: Dom.element => unit = "remove" +external createElement: (WebAPI.DOM.document, string) => WebAPI.DOMTree.element = "createElement" + +@send external remove: WebAPI.DOMTree.element => unit = "remove" + @send -external appendChild: (Dom.element, Dom.element) => Dom.element = "appendChild" +external appendChild: (WebAPI.DOMTree.element, WebAPI.DOMTree.element) => WebAPI.DOMTree.element = + "appendChild" let querySelectorAll = (element, string) => Array.fromArrayLike(querySelectorAll(element, string)) module DOM = { @return(nullable) @get - external value: Dom.element => option = "value" + external value: WebAPI.DOMTree.element => option = "value" let findBySelector = (element, selector) => querySelector(element, selector) @@ -110,7 +129,7 @@ module DOM = { ) } -let prepareContainer = (container: ref>, ()) => { +let prepareContainer = (container: ref>, ()) => { let containerElement = document->createElement("div") switch document->body { | Some(body) => body->appendChild(containerElement)->ignore @@ -119,7 +138,7 @@ let prepareContainer = (container: ref>, ()) => { container := Some(containerElement) } -let cleanupContainer = (container: ref>, ()) => { +let cleanupContainer = (container: ref>, ()) => { switch container.contents { | Some(contents) => remove(contents) | None => () diff --git a/src/ReactTestUtils.res.js b/src/ReactTestUtils.res.js index 2166cce..dfcdac8 100644 --- a/src/ReactTestUtils.res.js +++ b/src/ReactTestUtils.res.js @@ -1,6 +1,6 @@ // Generated by ReScript, PLEASE EDIT WITH CARE -import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.js"; +import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.mjs"; import * as TestUtils from "react-dom/test-utils"; function act(func) { @@ -38,7 +38,7 @@ let Simulate = { }; function findBySelector(element, selector) { - return element.querySelector(selector); + return Primitive_option.fromNullable(element.querySelector(selector)); } function findByAllSelector(element, selector) { @@ -63,16 +63,16 @@ let DOM = { function prepareContainer(container, param) { let containerElement = document.createElement("div"); let body = document.body; - if (body !== undefined) { - Primitive_option.valFromOption(body).appendChild(containerElement); + if (!(body == null)) { + body.appendChild(containerElement); } - container.contents = Primitive_option.some(containerElement); + container.contents = containerElement; } function cleanupContainer(container, param) { let contents = container.contents; if (contents !== undefined) { - Primitive_option.valFromOption(contents).remove(); + contents.remove(); } container.contents = undefined; } diff --git a/src/ReactTestUtils.resi b/src/ReactTestUtils.resi index f87e6d1..a29b726 100644 --- a/src/ReactTestUtils.resi +++ b/src/ReactTestUtils.resi @@ -20,37 +20,56 @@ external isCompositeComponentWithType: ('element, React.component<'props>) => bo module Simulate: { @module("react-dom/test-utils") @scope("Simulate") - external click: Dom.element => unit = "click" + external click: WebAPI.DOMTree.element => unit = "click" + @module("react-dom/test-utils") @scope("Simulate") - external clickWithEvent: (Dom.element, 'event) => unit = "click" + external clickWithEvent: (WebAPI.DOMTree.element, 'event) => unit = "click" + @module("react-dom/test-utils") @scope("Simulate") - external change: Dom.element => unit = "change" + external change: WebAPI.DOMTree.element => unit = "change" + @module("react-dom/test-utils") @scope("Simulate") - external blur: Dom.element => unit = "blur" + external blur: WebAPI.DOMTree.element => unit = "blur" + @module("react-dom/test-utils") @scope("Simulate") - external changeWithEvent: (Dom.element, 'event) => unit = "change" - let changeWithValue: (Dom.element, string) => unit - let changeWithChecked: (Dom.element, bool) => unit + external changeWithEvent: (WebAPI.DOMTree.element, 'event) => unit = "change" + + let changeWithValue: (WebAPI.DOMTree.element, string) => unit + let changeWithChecked: (WebAPI.DOMTree.element, bool) => unit + @module("react-dom/test-utils") @scope("Simulate") - external canPlay: Dom.element => unit = "canPlay" + external canPlay: WebAPI.DOMTree.element => unit = "canPlay" + @module("react-dom/test-utils") @scope("Simulate") - external timeUpdate: Dom.element => unit = "timeUpdate" + external timeUpdate: WebAPI.DOMTree.element => unit = "timeUpdate" + @module("react-dom/test-utils") @scope("Simulate") - external ended: Dom.element => unit = "ended" + external ended: WebAPI.DOMTree.element => unit = "ended" + @module("react-dom/test-utils") @scope("Simulate") - external focus: Dom.element => unit = "focus" + external focus: WebAPI.DOMTree.element => unit = "focus" } module DOM: { @return(nullable) @get - external value: Dom.element => option = "value" + external value: WebAPI.DOMTree.element => option = "value" + + let findBySelector: (WebAPI.DOMTree.element, string) => option + let findByAllSelector: (WebAPI.DOMTree.element, string) => array + + let findBySelectorAndTextContent: ( + WebAPI.DOMTree.element, + string, + string, + ) => option - let findBySelector: (Dom.element, string) => option - let findByAllSelector: (Dom.element, string) => array - let findBySelectorAndTextContent: (Dom.element, string, string) => option - let findBySelectorAndPartialTextContent: (Dom.element, string, string) => option + let findBySelectorAndPartialTextContent: ( + WebAPI.DOMTree.element, + string, + string, + ) => option } -let prepareContainer: (ref>, unit) => unit -let cleanupContainer: (ref>, unit) => unit -let getContainer: ref> => Dom.element +let prepareContainer: (ref>, unit) => unit +let cleanupContainer: (ref>, unit) => unit +let getContainer: ref> => WebAPI.DOMTree.element diff --git a/src/RescriptReactRouter.res b/src/RescriptReactRouter.res index 7471541..b487b1e 100644 --- a/src/RescriptReactRouter.res +++ b/src/RescriptReactRouter.res @@ -1,40 +1,51 @@ @scope("globalThis") -external window: option = "window" +external window: option = "window" @scope("globalThis") -external history: option = "history" +external history: option = "history" -@get external location: Dom.window => Dom.location = "location" +@get external location: WebAPI.DOM.window => WebAPI.Location.t = "location" -/* actually the cb is Dom.event => unit, but let's restrict the access for now */ +/* actually the cb is WebAPI.DOM.event => unit, but let's restrict the access for now */ @send -external addEventListener: (Dom.window, string, unit => unit) => unit = "addEventListener" +external addEventListener: (WebAPI.DOM.window, string, unit => unit) => unit = "addEventListener" @send -external removeEventListener: (Dom.window, string, unit => unit) => unit = "removeEventListener" +external removeEventListener: (WebAPI.DOM.window, string, unit => unit) => unit = + "removeEventListener" @send -external dispatchEvent: (Dom.window, Dom.event) => unit = "dispatchEvent" +external dispatchEvent: (WebAPI.DOM.window, WebAPI.DOM.event) => unit = "dispatchEvent" -@get external pathname: Dom.location => string = "pathname" +@get external pathname: WebAPI.Location.t => string = "pathname" -@get external hash: Dom.location => string = "hash" +@get external hash: WebAPI.Location.t => string = "hash" -@get external search: Dom.location => string = "search" +@get external search: WebAPI.Location.t => string = "search" @send -external pushState: (Dom.history, @as(json`null`) _, @as("") _, ~href: string) => unit = "pushState" +external pushState: ( + WebAPI.History.Types.history, + @as(json`null`) _, + @as("") _, + ~href: string, +) => unit = "pushState" @send -external replaceState: (Dom.history, @as(json`null`) _, @as("") _, ~href: string) => unit = - "replaceState" +external replaceState: ( + WebAPI.History.Types.history, + @as(json`null`) _, + @as("") _, + ~href: string, +) => unit = "replaceState" type makeEventOptions = { bubbles?: bool, cancelable?: bool, composed?: bool, } -@new external makeEvent: (string, ~options: makeEventOptions=?) => Dom.event = "Event" + +@new external makeEvent: (string, ~options: makeEventOptions=?) => WebAPI.DOM.event = "Event" /* This is copied from array.ml. We want to cut dependencies for rescript-react so that it's friendlier to use in size-constrained codebases */ @@ -47,6 +58,7 @@ let arrayToList = a => { } tolist(a->Array.length - 1, list{}) } + /* if we ever roll our own parser in the future, make sure you test all url combinations e.g. foo.com/?#bar */ @@ -74,16 +86,18 @@ let pathParse = str => raw->String.split("/")->Array.filter(item => item->String.length != 0)->arrayToList } + let path = (~serverUrlString=?, ()) => switch (serverUrlString, window) { | (None, None) => list{} | (Some(serverUrlString), _) => pathParse(serverUrlString) - | (_, Some(window: Dom.window)) => pathParse(window->location->pathname) + | (_, Some(window: WebAPI.DOM.window)) => pathParse(window->location->pathname) } + let hash = () => switch window { | None => "" - | Some(window: Dom.window) => + | Some(window: WebAPI.DOM.window) => switch window->location->hash { | "" | "#" => "" @@ -93,6 +107,7 @@ let hash = () => raw->String.slice(~start=1) } } + let searchParse = str => switch str { | "" @@ -108,14 +123,14 @@ let search = (~serverUrlString=?, ()) => switch (serverUrlString, window) { | (None, None) => "" | (Some(serverUrlString), _) => searchParse(serverUrlString) - | (_, Some(window: Dom.window)) => searchParse(window->location->search) + | (_, Some(window: WebAPI.DOM.window)) => searchParse(window->location->search) } let push = path => switch (history, window) { | (None, _) | (_, None) => () - | (Some(history: Dom.history), Some(window: Dom.window)) => + | (Some(history: WebAPI.History.Types.history), Some(window: WebAPI.DOM.window)) => pushState(history, ~href=path) dispatchEvent(window, makeEvent("popstate", ~options={bubbles: true, cancelable: true})) } @@ -124,7 +139,7 @@ let replace = path => switch (history, window) { | (None, _) | (_, None) => () - | (Some(history: Dom.history), Some(window: Dom.window)) => + | (Some(history: WebAPI.History.Types.history), Some(window: WebAPI.DOM.window)) => replaceState(history, ~href=path) dispatchEvent(window, makeEvent("popstate", ~options={bubbles: true, cancelable: true})) } @@ -165,7 +180,7 @@ let dangerouslyGetInitialUrl = url let watchUrl = callback => switch window { | None => () => () - | Some(window: Dom.window) => + | Some(window: WebAPI.DOM.window) => let watcherID = () => callback(url()) addEventListener(window, "popstate", watcherID) watcherID @@ -174,7 +189,7 @@ let watchUrl = callback => let unwatchUrl = watcherID => switch window { | None => () - | Some(window: Dom.window) => removeEventListener(window, "popstate", watcherID) + | Some(window: WebAPI.DOM.window) => removeEventListener(window, "popstate", watcherID) } let useUrl = (~serverUrl=?, ()) => { diff --git a/src/RescriptReactRouter.res.js b/src/RescriptReactRouter.res.js index 0a17734..a6aa045 100644 --- a/src/RescriptReactRouter.res.js +++ b/src/RescriptReactRouter.res.js @@ -1,7 +1,6 @@ // Generated by ReScript, PLEASE EDIT WITH CARE import * as React from "react"; -import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.js"; function pathParse(str) { switch (str) { @@ -23,10 +22,7 @@ function pathParse(str) { if (i < 0) { return res; } - _res = { - hd: a[i], - tl: res - }; + _res = {hd: a[i], tl: res}; _i = i - 1 | 0; continue; }; @@ -38,7 +34,7 @@ function path(serverUrlString, param) { if (serverUrlString !== undefined) { return pathParse(serverUrlString); } else if (match !== undefined) { - return pathParse(Primitive_option.valFromOption(match).location.pathname); + return pathParse(match.location.pathname); } else { return /* [] */0; } @@ -49,7 +45,7 @@ function hash() { if (window === undefined) { return ""; } - let raw = Primitive_option.valFromOption(window).location.hash; + let raw = window.location.hash; switch (raw) { case "" : case "#" : @@ -79,7 +75,7 @@ function search(serverUrlString, param) { if (serverUrlString !== undefined) { return searchParse(serverUrlString); } else if (match !== undefined) { - return searchParse(Primitive_option.valFromOption(match).location.search); + return searchParse(match.location.search); } else { return ""; } @@ -89,8 +85,8 @@ function push(path) { let match = globalThis.history; let match$1 = globalThis.window; if (match !== undefined && match$1 !== undefined) { - Primitive_option.valFromOption(match).pushState(null, "", path); - Primitive_option.valFromOption(match$1).dispatchEvent(new Event("popstate", { + match.pushState(null, "", path); + match$1.dispatchEvent(new Event("popstate", { bubbles: true, cancelable: true })); @@ -102,8 +98,8 @@ function replace(path) { let match = globalThis.history; let match$1 = globalThis.window; if (match !== undefined && match$1 !== undefined) { - Primitive_option.valFromOption(match).replaceState(null, "", path); - Primitive_option.valFromOption(match$1).dispatchEvent(new Event("popstate", { + match.replaceState(null, "", path); + match$1.dispatchEvent(new Event("popstate", { bubbles: true, cancelable: true })); @@ -150,14 +146,14 @@ function watchUrl(callback) { return () => {}; } let watcherID = () => callback(url(undefined, undefined)); - Primitive_option.valFromOption(window).addEventListener("popstate", watcherID); + window.addEventListener("popstate", watcherID); return watcherID; } function unwatchUrl(watcherID) { let window = globalThis.window; if (window !== undefined) { - Primitive_option.valFromOption(window).removeEventListener("popstate", watcherID); + window.removeEventListener("popstate", watcherID); return; } } diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..388945f --- /dev/null +++ b/tests/README.md @@ -0,0 +1,22 @@ +# Packed consumer checks + +Run `npm ci`, `npm run build`, and `npm test` using Node.js 24 and Python 3. +`npm test` packs the library and installs it into a system temporary directory +outside the checkout, using the compiler, runtime, and React versions installed by +the root lockfile. It requires registry access (or a populated npm cache). +No checkout symlinks, ancestor dependency fallback, or precompiled library +artifacts are used. + +The suite checks: + +- The published file inventory, including migration documentation. +- A consumer depending only on React and consumers explicitly selecting WebAPI. +- Element, ref, style, event, clipboard, touch, FormData, and file interoperability. +- Rejection of invalid target, currentTarget, view, file, clipboard, and touch-list assumptions. +- Excluded WebAPI operations, opt-in feature expansion, and recovery to the + narrow selection after each build. +- Compiled JavaScript getter identity and null/undefined conversion, native + FormData/File values, shared form-action/status types, and DOM helper/container behavior. + +The Node assertions exercise binding contracts, not browser rendering or +React's real event dispatch. Fixtures are removed on both success and failure. diff --git a/tests/check-consumer.py b/tests/check-consumer.py new file mode 100644 index 0000000..9ba3069 --- /dev/null +++ b/tests/check-consumer.py @@ -0,0 +1,213 @@ +#!/usr/bin/env python3 +"""Check downstream type interoperability and transitive feature exclusion.""" + +import json +from pathlib import Path +import shutil +import subprocess +import tempfile + + +ROOT = Path(__file__).resolve().parents[1] +CONSUMER = ROOT / "tests" / "consumer" + + +def build(fixture): + result = subprocess.run( + [str(fixture / "node_modules/.bin/rescript"), "build"], + cwd=fixture, capture_output=True, text=True, + ) + return result.returncode, result.stdout + result.stderr + + +def run(command, cwd): + result = subprocess.run(command, cwd=cwd, capture_output=True, text=True) + if result.returncode: + raise RuntimeError(f"{command} failed:\n{result.stdout}\n{result.stderr}") + return result.stdout + + +def pack(fixture): + result = json.loads(run( + ["npm", "pack", "--json", "--ignore-scripts", "--pack-destination", str(fixture)], ROOT + ))[0] + paths = {entry["path"] for entry in result["files"]} + required = {"package.json", "rescript.json", "README.md", "MIGRATION.md", "src/ReactDOM.res"} + if not required <= paths or any(path.startswith(("tests/", "benchmarks/")) for path in paths): + raise RuntimeError(f"Unexpected package contents: {sorted(paths)}") + print("PASS: packed package includes migration docs and excludes development fixtures") + return fixture / result["filename"] + + +def installed_version(package): + manifest = ROOT / "node_modules" / package / "package.json" + return json.loads(manifest.read_text())["version"] + + +def prepare(fixture): + (fixture / "src").mkdir() + write_config(fixture, []) + (fixture / "package.json").write_text( + '{"name":"webapi-react-consumer-check","private":true,"type":"module"}\n' + ) + dependencies = [ + f"{package}@{installed_version(package)}" + for package in ("rescript", "@rescript/runtime", "react", "react-dom") + ] + run([ + "npm", "install", "--ignore-scripts", "--no-audit", "--no-fund", + "--package-lock=false", str(pack(fixture)), *dependencies, + ], fixture) + shutil.copy(CONSUMER / "ReactOnly.res", fixture / "src") + + +def write_config(fixture, extra_dependencies): + config = { + "name": "webapi-react-consumer-check", + "sources": ["src"], + "jsx": {"version": 4}, + "dependencies": ["@rescript/react", *extra_dependencies], + "package-specs": {"module": "esmodule", "in-source": True}, + "suffix": ".res.js", + } + (fixture / "rescript.json").write_text(json.dumps(config, indent=2) + "\n") + + +def assert_narrow_inventory(fixture): + library = fixture / "node_modules" / "@rescript" / "webapi" / "lib" / "bs" + for module in ("Element", "Node", "HTMLCollection", "Event", "Animation", "DOMRect", "MediaQueryList", "Window", "Document", "OffscreenCanvas"): + if list(library.rglob(f"{module}-WebAPI.cmj")): + raise RuntimeError(f"Excluded {module} compiler artifact is still present") + sources = list((library / "src").rglob("*.cmj")) + if len(sources) != 27: + raise RuntimeError(f"Expected 27 selective DOM/data sources, found {len(sources)}") + + +def require_build(fixture, description): + code, log = build(fixture) + if code: + raise RuntimeError(f"{description}:\n{log}") + print(f"PASS: {description}") + + +def add_direct_webapi(fixture): + react = fixture / "node_modules/@rescript/react" + manifest = json.loads((react / "package.json").read_text()) + specifier = manifest["dependencies"]["@rescript/webapi"] + run([ + "npm", "install", "--ignore-scripts", "--no-audit", "--no-fund", + "--package-lock=false", f"@rescript/webapi@{specifier}", + ], fixture) + if (react / "node_modules/@rescript/webapi").exists(): + raise RuntimeError("React and its consumer installed separate WebAPI copies") + print("PASS: matching direct WebAPI dependency deduplicates with React") + + +def verify(fixture): + require_build(fixture, "downstream consumer builds with only @rescript/react") + assert_narrow_inventory(fixture) + add_direct_webapi(fixture) + config = json.loads((fixture / "node_modules/@rescript/react/rescript.json").read_text()) + dependency = next(dep for dep in config["dependencies"] if dep["name"] == "@rescript/webapi") + write_config(fixture, [dependency]) + for source in ("Interop.res", "CSSCoreInterop.res", "EventInterop.res", "TestUtilsInterop.res", "DataInterop.res"): + shutil.copy(CONSUMER / source, fixture / "src") + require_build(fixture, "narrow WebAPI types interoperate with React") + verify_event_types(fixture) + window = {"name": "@rescript/webapi", "features": ["WebAPI.Window"]} + nodes = {"name": "@rescript/webapi", "features": ["WebAPI.DOMNodes"]} + for name, source, expanded in ( + ("Element", "ExcludedElement.res", nodes), + ("Node", "ExcludedNode.res", nodes), + ("HTMLCollection", "ExcludedHTMLCollection.res", nodes), + ("Event", "ExcludedEvent.res", nodes), + ("Animation", "ExcludedAnimation.res", nodes), + ("DOMRect", "ExcludedDOMRect.res", nodes), + ("MediaQueryList", "ExcludedMediaQueryList.res", nodes), + ("Window", "ExcludedWindow.res", window), + ("Document", "ExcludedDocument.res", window), + ("OffscreenCanvas", "Excluded.res", "@rescript/webapi"), + ): + verify_exclusion(fixture, dependency, name, source, expanded) + verify_broad_consumer(fixture, dependency, nodes, "DOMNodesInterop.res") + verify_broad_consumer(fixture, dependency, window, "WindowInterop.res") + files = {"name": "@rescript/webapi", "features": ["WebAPI.File"]} + verify_broad_consumer(fixture, dependency, files, "FileInterop.res") + + +def verify_event_types(fixture): + subprocess.run( + ["node", str(CONSUMER / "event-runtime.mjs"), + str(fixture / "src/EventInterop.res.js")], + check=True, + ) + subprocess.run( + ["node", str(CONSUMER / "dom-runtime.mjs"), + str(fixture / "src/TestUtilsInterop.res.js")], + check=True, + ) + subprocess.run( + ["node", str(CONSUMER / "data-runtime.mjs"), + str(fixture / "src/DataInterop.res.js")], + check=True, + ) + for filename, diagnostic in ( + ("InvalidEventTarget.res", "eventTarget"), + ("InvalidCurrentTarget.res", "option"), + ("InvalidView.res", "option"), + ("InvalidFile.res", "private"), + ("InvalidClipboard.res", "option"), + ("InvalidTouches.res", "TouchList"), + ): + source = fixture / "src" / filename + shutil.copy(CONSUMER / filename, source) + try: + code, log = build(fixture) + if code == 0 or diagnostic not in log: + raise RuntimeError(f"Expected {filename} to reject the invalid type:\n{log}") + print(f"PASS: {filename} rejects the invalid type") + finally: + source.unlink() + require_build(fixture, "narrow consumer recovers after event/file type checks") + assert_narrow_inventory(fixture) + + +def verify_exclusion(fixture, dependency, module, source, expanded): + excluded = fixture / "src" / source + shutil.copy(CONSUMER / source, excluded) + try: + code, log = build(fixture) + if code == 0 or module not in log or "can't be found" not in log: + raise RuntimeError(f"Expected an excluded-module error, got:\n{log}") + print(f"PASS: WebAPI.{module} is excluded by the narrow selection") + write_config(fixture, [expanded]) + require_build(fixture, f"broader direct dependency enables WebAPI.{module}") + finally: + excluded.unlink() + write_config(fixture, [dependency]) + require_build(fixture, f"narrow consumer recovers after {module} check") + assert_narrow_inventory(fixture) + + +def verify_broad_consumer(fixture, dependency, broad, filename): + source = fixture / "src" / filename + shutil.copy(CONSUMER / source.name, source) + try: + write_config(fixture, [broad]) + require_build(fixture, f"{filename} retains public type interoperability") + finally: + source.unlink() + write_config(fixture, [dependency]) + require_build(fixture, f"narrow consumer recovers after {filename} check") + assert_narrow_inventory(fixture) + + +def main(): + with tempfile.TemporaryDirectory(prefix="rescript-react-consumer-") as path: + fixture = Path(path) + prepare(fixture) + verify(fixture) + + +if __name__ == "__main__": + main() diff --git a/tests/consumer/CSSCoreInterop.res b/tests/consumer/CSSCoreInterop.res new file mode 100644 index 0000000..139f050 --- /dev/null +++ b/tests/consumer/CSSCoreInterop.res @@ -0,0 +1,3 @@ +// CSS declaration modules stay intact to avoid duplicating their rich record signatures. +let color = (element: WebAPI.DOMTree.htmlElement) => + WebAPI.CSSStyleDeclaration.getPropertyValue(element.style, "color") diff --git a/tests/consumer/DOMNodesInterop.res b/tests/consumer/DOMNodesInterop.res new file mode 100644 index 0000000..a5f1687 --- /dev/null +++ b/tests/consumer/DOMNodesInterop.res @@ -0,0 +1,14 @@ +let toPublic = (element: WebAPI.DOMTree.element): WebAPI.Element.t => element +let fromPublic = (element: WebAPI.Element.t): WebAPI.DOMTree.element => element + +let createRootFromElement = (parent: WebAPI.Element.t) => + parent + ->WebAPI.Element.querySelector("#root") + ->Null.toOption + ->Option.map(ReactDOM.Client.createRoot) + +let capturePointer = (element: WebAPI.DOMTree.element, event: ReactEvent.Pointer.t) => + element->WebAPI.Element.setPointerCapture(event->ReactEvent.Pointer.pointerId) + +let cancelNativeEvent = (event: ReactEvent.Mouse.t) => + event->ReactEvent.Mouse.nativeEvent->WebAPI.Event.preventDefault diff --git a/tests/consumer/DataInterop.res b/tests/consumer/DataInterop.res new file mode 100644 index 0000000..f6f4269 --- /dev/null +++ b/tests/consumer/DataInterop.res @@ -0,0 +1,31 @@ +let clipboard = (event: ReactEvent.Clipboard.t): option => + event->ReactEvent.Clipboard.clipboardData + +let clipboardText = (event: ReactEvent.Clipboard.t) => + event->clipboard->Option.map(data => data->WebAPI.DataTransfer.getData("text/plain")) + +let touches = (event: ReactEvent.Touch.t): WebAPI.TouchList.t => event->ReactEvent.Touch.touches + +let changedTouches = (event: ReactEvent.Touch.t): WebAPI.TouchList.t => + event->ReactEvent.Touch.changedTouches + +let targetTouches = (event: ReactEvent.Touch.t): WebAPI.TouchList.t => + event->ReactEvent.Touch.targetTouches + +let firstTouch = (event: ReactEvent.Touch.t): Null.t => + event->touches->WebAPI.TouchList.item(0) + +let toForm = (form: ReactDOM.FormData.t): WebAPI.FormData.t => form +let fromForm = (form: WebAPI.FormData.t): ReactDOM.FormData.t => form +let getString = ReactDOM.FormData.getString +let getFile = ReactDOM.FormData.getFile +let getAll = ReactDOM.FormData.getAll +let makeForm = ReactDOM.FormData.make +let getNative = WebAPI.FormData.get + +let action: ReactDOM.formStatusAction = form => { + form->WebAPI.FormData.append(~name="action", ~value="called") + ReactDOM.Sync +} + +let statusData = (status: ReactDOM.formStatus): nullable => status.data diff --git a/tests/consumer/EventInterop.res b/tests/consumer/EventInterop.res new file mode 100644 index 0000000..59875b4 --- /dev/null +++ b/tests/consumer/EventInterop.res @@ -0,0 +1,67 @@ +// Every family must expose the same precise shared event contract. +module CheckEvent = ( + Event: { + type t + let target: t => WebAPI.DOM.eventTarget + let currentTarget: t => option + let nativeEvent: t => WebAPI.DOM.event + }, +) => { + let nativeType = event => { + let native: WebAPI.DOM.event = event->Event.nativeEvent + native.type_ + } +} + +module Clipboard = CheckEvent(ReactEvent.Clipboard) +module Composition = CheckEvent(ReactEvent.Composition) +module Keyboard = CheckEvent(ReactEvent.Keyboard) +module Focus = CheckEvent(ReactEvent.Focus) +module Form = CheckEvent(ReactEvent.Form) +module Mouse = CheckEvent(ReactEvent.Mouse) +module Pointer = CheckEvent(ReactEvent.Pointer) +module Selection = CheckEvent(ReactEvent.Selection) +module Touch = CheckEvent(ReactEvent.Touch) +module UI = CheckEvent(ReactEvent.UI) +module Wheel = CheckEvent(ReactEvent.Wheel) +module Media = CheckEvent(ReactEvent.Media) +module Image = CheckEvent(ReactEvent.Image) +module Animation = CheckEvent(ReactEvent.Animation) +module Transition = CheckEvent(ReactEvent.Transition) + +let target = (event: ReactEvent.Mouse.t): WebAPI.DOM.eventTarget => event->ReactEvent.Mouse.target + +let currentTarget = (event: ReactEvent.Mouse.t): option => + event->ReactEvent.Mouse.currentTarget + +let nativeEvent = (event: ReactEvent.Mouse.t): WebAPI.DOM.event => + event->ReactEvent.Mouse.nativeEvent + +let syntheticTarget = (event: ReactEvent.Mouse.t): WebAPI.DOM.eventTarget => + event->ReactEvent.Synthetic.target + +let syntheticCurrentTarget = (event: ReactEvent.Mouse.t): option => + event->ReactEvent.Synthetic.currentTarget + +let syntheticNativeEvent = (event: ReactEvent.Mouse.t): WebAPI.DOM.event => + event->ReactEvent.Synthetic.nativeEvent + +let focusRelatedTarget = (event: ReactEvent.Focus.t): option => + event->ReactEvent.Focus.relatedTarget + +let mouseRelatedTarget = (event: ReactEvent.Mouse.t): option => + event->ReactEvent.Mouse.relatedTarget + +let pointerRelatedTarget = (event: ReactEvent.Pointer.t): option => + event->ReactEvent.Pointer.relatedTarget + +let uiView = (event: ReactEvent.UI.t): option => event->ReactEvent.UI.view + +let pointerView = (event: ReactEvent.Pointer.t): option => + event->ReactEvent.Pointer.view + +let toFile = (file: ReactDOM.FormData.file): WebAPI.DOM.file => file +let fromFile = (file: WebAPI.DOM.file): ReactDOM.FormData.file => file +let fileName = (file: ReactDOM.FormData.file) => file.name +let getFile = ReactDOM.FormData.getFile +let getAll = ReactDOM.FormData.getAll diff --git a/tests/consumer/Excluded.res b/tests/consumer/Excluded.res new file mode 100644 index 0000000..de9b94e --- /dev/null +++ b/tests/consumer/Excluded.res @@ -0,0 +1,2 @@ +// Must fail with the narrow or Window selection; must pass with an unrestricted dependency. +module Canvas = WebAPI.OffscreenCanvas diff --git a/tests/consumer/ExcludedAnimation.res b/tests/consumer/ExcludedAnimation.res new file mode 100644 index 0000000..1612b37 --- /dev/null +++ b/tests/consumer/ExcludedAnimation.res @@ -0,0 +1 @@ +module Animation = WebAPI.Animation diff --git a/tests/consumer/ExcludedDOMRect.res b/tests/consumer/ExcludedDOMRect.res new file mode 100644 index 0000000..bbc0a64 --- /dev/null +++ b/tests/consumer/ExcludedDOMRect.res @@ -0,0 +1 @@ +module DOMRect = WebAPI.DOMRect diff --git a/tests/consumer/ExcludedDocument.res b/tests/consumer/ExcludedDocument.res new file mode 100644 index 0000000..636aecf --- /dev/null +++ b/tests/consumer/ExcludedDocument.res @@ -0,0 +1,2 @@ +// The document type is in DOM, but Document's API module belongs to Window. +module Document = WebAPI.Document diff --git a/tests/consumer/ExcludedElement.res b/tests/consumer/ExcludedElement.res new file mode 100644 index 0000000..9577e32 --- /dev/null +++ b/tests/consumer/ExcludedElement.res @@ -0,0 +1 @@ +module Element = WebAPI.Element diff --git a/tests/consumer/ExcludedEvent.res b/tests/consumer/ExcludedEvent.res new file mode 100644 index 0000000..e6ce8b1 --- /dev/null +++ b/tests/consumer/ExcludedEvent.res @@ -0,0 +1 @@ +module Event = WebAPI.Event diff --git a/tests/consumer/ExcludedHTMLCollection.res b/tests/consumer/ExcludedHTMLCollection.res new file mode 100644 index 0000000..76b2d74 --- /dev/null +++ b/tests/consumer/ExcludedHTMLCollection.res @@ -0,0 +1 @@ +module HTMLCollection = WebAPI.HTMLCollection diff --git a/tests/consumer/ExcludedMediaQueryList.res b/tests/consumer/ExcludedMediaQueryList.res new file mode 100644 index 0000000..7d8b104 --- /dev/null +++ b/tests/consumer/ExcludedMediaQueryList.res @@ -0,0 +1 @@ +module MediaQueryList = WebAPI.MediaQueryList diff --git a/tests/consumer/ExcludedNode.res b/tests/consumer/ExcludedNode.res new file mode 100644 index 0000000..1a4ef01 --- /dev/null +++ b/tests/consumer/ExcludedNode.res @@ -0,0 +1 @@ +module Node = WebAPI.Node diff --git a/tests/consumer/ExcludedWindow.res b/tests/consumer/ExcludedWindow.res new file mode 100644 index 0000000..c667a5b --- /dev/null +++ b/tests/consumer/ExcludedWindow.res @@ -0,0 +1,2 @@ +// The narrow selection must not expose Window's API module. +module Window = WebAPI.Window diff --git a/tests/consumer/FileInterop.res b/tests/consumer/FileInterop.res new file mode 100644 index 0000000..b8a5c0b --- /dev/null +++ b/tests/consumer/FileInterop.res @@ -0,0 +1,4 @@ +// Opting into operations must not require converting the core-backed File type. +let toPublic = (file: ReactDOM.FormData.file): WebAPI.File.t => file +let fromPublic = (file: WebAPI.File.t): ReactDOM.FormData.file => file +let fileName = (file: ReactDOM.FormData.file) => file.name diff --git a/tests/consumer/Interop.res b/tests/consumer/Interop.res new file mode 100644 index 0000000..f936b32 --- /dev/null +++ b/tests/consumer/Interop.res @@ -0,0 +1,21 @@ +// Selective consumer: rich types and CSS declarations, without DOMNodes or Window operations. +let createRootFromElement = (element: WebAPI.DOMTree.element) => ReactDOM.Client.createRoot(element) +let pointerId = (event: ReactEvent.Pointer.t): int => ReactEvent.Pointer.pointerId(event) + +let eventWindow = (event: ReactEvent.UI.t): option => event->ReactEvent.UI.view + +let elementWithRef = (ref: ReactDOM.Ref.currentDomRef) =>
+ +let elementWithCallbackRef = (ref: ReactDOM.Ref.callbackDomRef) => +
+ +let findChild = (element: WebAPI.DOMTree.element) => + ReactTestUtils.DOM.findBySelector(element, ".child") + +let container = (element: WebAPI.DOMTree.element) => { + let container = ref(Some(element)) + ReactTestUtils.cleanupContainer(container, ()) +} + +let historyState = (history: WebAPI.History.Types.history) => history.state +let locationPath = (location: WebAPI.Location.t) => location.pathname diff --git a/tests/consumer/InvalidClipboard.res b/tests/consumer/InvalidClipboard.res new file mode 100644 index 0000000..5807315 --- /dev/null +++ b/tests/consumer/InvalidClipboard.res @@ -0,0 +1,2 @@ +let withoutNullCheck = (event: ReactEvent.Clipboard.t): WebAPI.DataTransfer.t => + event->ReactEvent.Clipboard.clipboardData diff --git a/tests/consumer/InvalidCurrentTarget.res b/tests/consumer/InvalidCurrentTarget.res new file mode 100644 index 0000000..40d0830 --- /dev/null +++ b/tests/consumer/InvalidCurrentTarget.res @@ -0,0 +1,3 @@ +// React clears this after dispatch; consumers must handle None. +let withoutNullCheck = (event: ReactEvent.Mouse.t): WebAPI.DOM.eventTarget => + event->ReactEvent.Mouse.currentTarget diff --git a/tests/consumer/InvalidEventTarget.res b/tests/consumer/InvalidEventTarget.res new file mode 100644 index 0000000..d015c1f --- /dev/null +++ b/tests/consumer/InvalidEventTarget.res @@ -0,0 +1,3 @@ +// EventTarget is not necessarily an Element (it may be a Window or Document). +let asElement = (event: ReactEvent.Mouse.t): WebAPI.DOMTree.element => + event->ReactEvent.Mouse.target diff --git a/tests/consumer/InvalidFile.res b/tests/consumer/InvalidFile.res new file mode 100644 index 0000000..d0bbda1 --- /dev/null +++ b/tests/consumer/InvalidFile.res @@ -0,0 +1,8 @@ +// A lookalike object is not a browser File. +let fake: ReactDOM.FormData.file = { + name: "fake.txt", + size: 0, + type_: "text/plain", + lastModified: 0, + webkitRelativePath: "", +} diff --git a/tests/consumer/InvalidTouches.res b/tests/consumer/InvalidTouches.res new file mode 100644 index 0000000..5bd2fc4 --- /dev/null +++ b/tests/consumer/InvalidTouches.res @@ -0,0 +1,2 @@ +let notAnArray = (event: ReactEvent.Touch.t): array => + event->ReactEvent.Touch.touches diff --git a/tests/consumer/InvalidView.res b/tests/consumer/InvalidView.res new file mode 100644 index 0000000..d460b7e --- /dev/null +++ b/tests/consumer/InvalidView.res @@ -0,0 +1,2 @@ +// A native event may have a null view or no view property at all. +let withoutNullCheck = (event: ReactEvent.UI.t): WebAPI.DOM.window => event->ReactEvent.UI.view diff --git a/tests/consumer/ReactOnly.res b/tests/consumer/ReactOnly.res new file mode 100644 index 0000000..d27d705 --- /dev/null +++ b/tests/consumer/ReactOnly.res @@ -0,0 +1,3 @@ +// The React package's WebAPI dependency is sufficient when not naming WebAPI directly. +let createRoot = element => ReactDOM.Client.createRoot(element) +let elementWithRef = ref =>
diff --git a/tests/consumer/TestUtilsInterop.res b/tests/consumer/TestUtilsInterop.res new file mode 100644 index 0000000..0a7a0cb --- /dev/null +++ b/tests/consumer/TestUtilsInterop.res @@ -0,0 +1,5 @@ +let findBySelector = ReactTestUtils.DOM.findBySelector +let makeContainer = () => ref(None) +let prepareContainer = container => ReactTestUtils.prepareContainer(container, ()) +let getContainer = ReactTestUtils.getContainer +let cleanupContainer = container => ReactTestUtils.cleanupContainer(container, ()) diff --git a/tests/consumer/WindowInterop.res b/tests/consumer/WindowInterop.res new file mode 100644 index 0000000..9becf8c --- /dev/null +++ b/tests/consumer/WindowInterop.res @@ -0,0 +1,13 @@ +// Only compiled by the broader consumer that explicitly selects WebAPI.Window. +let createRootFromDocument = (document: WebAPI.DOM.document) => + document + ->WebAPI.Document.querySelector("#root") + ->Null.toOption + ->Option.map(ReactDOM.Client.createRoot) + +let eventWindow = (event: ReactEvent.UI.t): option => event->ReactEvent.UI.view + +let history = (window: WebAPI.DOM.window): WebAPI.History.Types.history => + window->WebAPI.Window.history + +let location = (window: WebAPI.DOM.window): WebAPI.Location.t => window->WebAPI.Window.location diff --git a/tests/consumer/data-runtime.mjs b/tests/consumer/data-runtime.mjs new file mode 100644 index 0000000..4a668b7 --- /dev/null +++ b/tests/consumer/data-runtime.mjs @@ -0,0 +1,38 @@ +import assert from "node:assert/strict"; +import { pathToFileURL } from "node:url"; + +const bindings = await import(pathToFileURL(process.argv[2]).href); +// Exercise synthetic wrapper FFI contracts, not browser event dispatch. +const transfer = { getData: (format) => format === "text/plain" ? "hello" : "" }; +assert.equal(bindings.clipboard({ clipboardData: transfer }), transfer); +assert.equal(bindings.clipboardText({ clipboardData: transfer }), "hello"); +assert.equal(bindings.clipboard({ clipboardData: null }), undefined); +assert.equal(bindings.clipboard({}), undefined); +const touch = { identifier: 7 }; +const list = { length: 1, item: (index) => index === 0 ? touch : null }; +const empty = { length: 0, item: () => null }; +assert.equal(bindings.touches({ touches: list }), list); +assert.equal(bindings.changedTouches({ changedTouches: list }), list); +assert.equal(bindings.targetTouches({ targetTouches: list }), list); +assert.equal(bindings.firstTouch({ touches: list }), touch); +assert.equal(bindings.firstTouch({ touches: empty }), null); + +const form = bindings.makeForm(); +assert.ok(form instanceof FormData); +assert.equal(bindings.toForm(form), form); +assert.equal(bindings.fromForm(form), form); +form.append("text", "value"); +const file = new File(["data"], "sample.txt"); +form.append("file", file); +assert.equal(bindings.getString(form, "text"), "value"); +assert.equal(bindings.getFile(form, "file"), file); +assert.equal(bindings.getNative(form, "text"), "value"); +assert.equal(bindings.getNative(form, "file"), file); +assert.equal(bindings.getNative(form, "missing"), null); +assert.deepEqual(bindings.getAll(form, "text"), [{ TAG: "String", _0: "value" }]); +assert.deepEqual(bindings.getAll(form, "file"), [{ TAG: "File", _0: file }]); +bindings.action(form); +assert.equal(form.get("action"), "called"); +assert.equal(bindings.statusData({ data: form }), form); +assert.equal(bindings.statusData({ data: null }), null); +console.log("PASS: clipboard/touch getters and shared FormData identity, actions, boxed values"); diff --git a/tests/consumer/dom-runtime.mjs b/tests/consumer/dom-runtime.mjs new file mode 100644 index 0000000..42a00dd --- /dev/null +++ b/tests/consumer/dom-runtime.mjs @@ -0,0 +1,48 @@ +import assert from "node:assert/strict"; +import { pathToFileURL } from "node:url"; + +const bindings = await import(pathToFileURL(process.argv[2]).href); + +// Check the compiled DOM FFI contract without replacing React's dispatch. +const element = {}; +for (const result of [element, null, undefined]) { + const parent = { querySelector: () => result }; + assert.equal(bindings.findBySelector(parent, ".child"), result ?? undefined); +} + +const originalDocument = Object.getOwnPropertyDescriptor(globalThis, "document"); +try { + for (const absentBody of [null, undefined]) { + let removed = false; + const containerElement = { remove: () => { removed = true; } }; + globalThis.document = { + body: absentBody, + createElement: () => containerElement, + }; + const container = bindings.makeContainer(); + bindings.prepareContainer(container); + assert.equal(bindings.getContainer(container), containerElement); + bindings.cleanupContainer(container); + assert.equal(removed, true); + assert.throws(() => bindings.getContainer(container)); + bindings.cleanupContainer(container); + } + + const appended = []; + const containerElement = { remove() {} }; + globalThis.document = { + body: { appendChild: element => appended.push(element) }, + createElement: () => containerElement, + }; + const container = bindings.makeContainer(); + bindings.prepareContainer(container); + assert.deepEqual(appended, [containerElement]); + bindings.cleanupContainer(container); +} finally { + if (originalDocument) { + Object.defineProperty(globalThis, "document", originalDocument); + } else { + delete globalThis.document; + } +} +console.log("PASS: nullable DOM lookup and container lifecycle"); diff --git a/tests/consumer/event-runtime.mjs b/tests/consumer/event-runtime.mjs new file mode 100644 index 0000000..cf4e04c --- /dev/null +++ b/tests/consumer/event-runtime.mjs @@ -0,0 +1,44 @@ +import assert from "node:assert/strict"; +import { pathToFileURL } from "node:url"; + +const bindings = await import(pathToFileURL(process.argv[2]).href); +const target = new EventTarget(); +const nativeEvent = new Event("click"); +// Exercise the FFI contract, not React's dispatch implementation. +const synthetic = { target, currentTarget: target, nativeEvent }; +assert.equal(bindings.target(synthetic), target); +assert.equal(bindings.syntheticTarget(synthetic), target); +assert.equal(bindings.nativeEvent(synthetic), nativeEvent); +assert.equal(bindings.syntheticNativeEvent(synthetic), nativeEvent); +for (const getter of [bindings.currentTarget, bindings.syntheticCurrentTarget]) { + assert.equal(getter(synthetic), target); + assert.equal(getter({ ...synthetic, currentTarget: null }), undefined); + assert.equal(getter({ ...synthetic, currentTarget: undefined }), undefined); +} +for (const getter of [ + bindings.focusRelatedTarget, + bindings.mouseRelatedTarget, + bindings.pointerRelatedTarget, +]) { + assert.equal(getter({ relatedTarget: target }), target); + assert.equal(getter({ relatedTarget: null }), undefined); +} +for (const getter of [bindings.uiView, bindings.pointerView]) { + const view = {}; + assert.equal(getter({ view }), view); + assert.equal(getter({ view: null }), undefined); + assert.equal(getter({}), undefined); +} +const file = new File(["contents"], "example.txt", { type: "text/plain" }); +assert.equal(bindings.toFile(file), file); +assert.equal(bindings.fromFile(file), file); +assert.equal(bindings.fileName(file), "example.txt"); +const data = new FormData(); +data.append("file", file); +data.append("text", "hello"); +assert.equal(bindings.getFile(data, "file"), file); +assert.equal(bindings.getFile(data, "text"), undefined); +assert.equal(bindings.getFile(data, "missing"), undefined); +assert.deepEqual(bindings.getAll(data, "file"), [{ TAG: "File", _0: file }]); +assert.deepEqual(bindings.getAll(data, "text"), [{ TAG: "String", _0: "hello" }]); +console.log("PASS: event getter identity/nullability and native FormData/File interop");