Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ versions follow [Semantic Versioning](https://semver.org/) with `alpha` prerelea

## [Unreleased]

## [0.1.0-alpha.6] - 2026-11-05

### Upgrading from 0.1.0-alpha.5
- `rn-xtool run` rebuilds and reinstalls the app after this upgrade, which gives it the app icon and, for apps without
expo-dev-client, the reload after Allow.
Expand Down Expand Up @@ -37,11 +39,11 @@ versions follow [Semantic Versioning](https://semver.org/) with `alpha` prerelea
every requirement, downloads the files on your machine into `~/.cache/rn-xtool/pods`, wraps each framework for
SwiftPM (a headers-only xcframework, and its arm64 archive linked once with `-force_load`), and writes the local
package `ios/build/pod-binaries` that the scaffold links. @react-native-ml-kit/text-recognition 2.0.0 builds this way
on bare React Native 0.88.1 (checked by building on 2026-11-05; not run on a device yet): ten Google pods, their
five OCR model bundles at the root of `App.app`, and GoogleToolboxForMac, GoogleUtilities, GoogleDataTransport and
GTMSessionFetcher from their SwiftPM packages through the pod table. The app grows by about 53 MB. Other shapes
(dynamic or Swift frameworks, vendored libraries, compiled sources) stop with a message naming the pod. See
[troubleshooting.md](docs/troubleshooting.md#cocoapods-binaries).
on bare React Native 0.88.1 (checked on a device on 2026-11-05: it recognized printed text from a photo): ten Google
pods, their five OCR model bundles at the root of `App.app`, and GoogleToolboxForMac, GoogleUtilities,
GoogleDataTransport and GTMSessionFetcher from their SwiftPM packages through the pod table. The app grows by about
53 MB. Other shapes (dynamic or Swift frameworks, vendored libraries, compiled sources) stop with a message naming the
pod. See [troubleshooting.md](docs/troubleshooting.md#cocoapods-binaries).
- `rn-xtool-pods.lock.json`, at the project root, records each binary pod's version, URL, size and sha256: "ℹ pods —
recorded the sha256 of 10 downloads in rn-xtool-pods.lock.json; commit it, so other machines check that they get the
same files." Later builds keep the locked versions and check every download against it; a file with another sha256
Expand All @@ -54,7 +56,8 @@ versions follow [Semantic Versioning](https://semver.org/) with `alpha` prerelea
- Scaffolded libraries' `resource_bundles` reach the app: each unconditional entry whose name and globs are plain
strings becomes `<name>.bundle` at the root of `App.app`, as CocoaPods places it, with `.lproj` folders kept.
react-native-svg gets `RNSVGFilters.bundle` with its prebuilt Metal filters, and react-native-device-info its
privacy bundle (checked by building; svg's filters are not checked on a device yet).
privacy bundle (checked by building; svg's filters also on a device on 2026-11-05: a `FeComposite` xor filter
rendered).
- `doctor --project` has a `pods` line for binary pods, from the lock and the cache, or probed online within its 10 s
budget: "✔ pods — 10 CocoaPods binaries for @react-native-ml-kit/text-recognition, in rn-xtool's cache and in
rn-xtool-pods.lock.json", "ℹ pods — …, 10 to download from dl.google.com (40.3 MB)", and the lock entries no library
Expand Down Expand Up @@ -486,7 +489,8 @@ First public release, as `react-native-xtool` (command `rn-xtool`).
- No Xcode tools on Linux: asset catalogs, storyboards and Metal shaders are skipped; library resource bundles and
vendored xcframeworks are not supported yet.

[Unreleased]: https://github.com/WillyAntunez/react-native-xtool/compare/v0.1.0-alpha.5...HEAD
[Unreleased]: https://github.com/WillyAntunez/react-native-xtool/compare/v0.1.0-alpha.6...HEAD
[0.1.0-alpha.6]: https://github.com/WillyAntunez/react-native-xtool/compare/v0.1.0-alpha.5...v0.1.0-alpha.6
[0.1.0-alpha.5]: https://github.com/WillyAntunez/react-native-xtool/compare/v0.1.0-alpha.4...v0.1.0-alpha.5
[0.1.0-alpha.4]: https://github.com/WillyAntunez/react-native-xtool/compare/v0.1.0-alpha.3...v0.1.0-alpha.4
[0.1.0-alpha.3]: https://github.com/WillyAntunez/react-native-xtool/compare/v0.1.0-alpha.2...v0.1.0-alpha.3
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ SwiftPM pipeline.
[![npm](https://img.shields.io/npm/v/react-native-xtool/alpha?label=npm%20%40alpha)](https://www.npmjs.com/package/react-native-xtool)
[![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE)

**Status:** alpha, [`react-native-xtool@0.1.0-alpha.5` on npm](https://www.npmjs.com/package/react-native-xtool) under the
`alpha` tag. Verified end to end on a physical iPhone on 2026-11-04.
**Status:** alpha, [`react-native-xtool@0.1.0-alpha.6` on npm](https://www.npmjs.com/package/react-native-xtool) under the
`alpha` tag. Verified end to end on a physical iPhone on 2026-11-04 and 2026-11-05: the first launch without Reload,
the dev client and the app icon; bare React Native 0.85; react-native-vision-camera, react-native-video,
react-native-device-info and @react-native-community/netinfo, with react-native-app-auth linked and an entitlements
file; and ML Kit text recognition with react-native-svg's Metal filters.

<!-- demo GIF: rn-xtool run → app opens on the iPhone → Fast Refresh -->
Demo video coming soon.
Expand Down Expand Up @@ -119,7 +122,7 @@ rn-xtool's own version) and compares them with the last successful build and ins
Some libraries depend on CocoaPods pods that ship prebuilt static binaries instead of sources, such as Google's ML Kit
behind @react-native-ml-kit/text-recognition. rn-xtool reads their specs from the CocoaPods CDN, downloads the files on
your machine, wraps them for SwiftPM and links them, with no CocoaPods or Ruby. ML Kit text recognition 2.0.0 builds
this way on bare React Native 0.88.1 (checked by building on 2026-11-05; not run on a device yet).
this way on bare React Native 0.88.1, and recognizes text on a physical iPhone (checked on 2026-11-05).

- Before the first download, `build` names the files, their sizes, the host and the vendor, with the vendor's terms:
`ℹ pods — @react-native-ml-kit/text-recognition needs 10 CocoaPods binaries that are not in rn-xtool's cache, 40.3 MB
Expand Down Expand Up @@ -189,7 +192,7 @@ prints a `⚠` line for each key a free team does not get, such as push notifica
script phases, storyboards, asset catalogs (except the app icon) and `.xib` files are not used; entitlements come
from the Debug `CODE_SIGN_ENTITLEMENTS` file ([details](docs/bare-react-native.md#limits)).
- Metal shaders are not compiled on Linux. react-native-svg's filters use the prebuilt `*.metallib` files it ships,
which reach the app in `RNSVGFilters.bundle` (checked by building; not yet on a device).
which reach the app in `RNSVGFilters.bundle` (checked on a physical iPhone on 2026-11-05).
- `doctor --project` and `build` refuse early, with the reason and a link, the setups rn-xtool knows it cannot build
yet: CocoaPods-only libraries with prebuilt binaries of their own (async-storage 3.x) or that depend on a CocoaPods
pod from a git source without a known SwiftPM package, Expo modules that build vendored C sources (expo-sqlite),
Expand Down
14 changes: 9 additions & 5 deletions docs/design/plans/2026-11-05-binary-pods.md
Original file line number Diff line number Diff line change
Expand Up @@ -1595,12 +1595,16 @@ No commit. It needs the owner's OK: a `create-expo-app` download and about 1 GB

No commit by the implementer. Until the owner confirms an item, the docs call it build-verified only.

- [ ] The app from G2 installs and launches (row 52).
- [ ] `TextRecognition.recognize()` on a photo of a printed page returns its blocks and lines, and the first call shows
no "Invalid model path." (rows 54–56).
**Run 2026-11-05 (the owner, iOS 26, install over Wi‑Fi): pass.** The G2 app (bare React Native 0.88.1 with ML Kit
text recognition 2.0.0, react-native-svg 15.16.0 and an entitlements file): install's re-run of the post-pack checks
passed silently, and the app installed and launched. Fast Refresh works. The item left unchecked below was not run.

- [x] The app from G2 installs and launches (row 52).
- [x] `TextRecognition.recognize()` on a photo of a printed page returns its blocks and lines, and the first call shows
no "Invalid model path." (rows 54–56). (A photo of printed text; the text came back.)
- [ ] Optional: one Japanese or Chinese sample through the matching script option.
- [ ] react-native-svg: an `<FeColorMatrix>` or another Metal filter renders (OQ3).
- [ ] The results go into `docs/libraries.md`'s dates, in one `docs:` commit by the controller.
- [x] react-native-svg: an `<FeColorMatrix>` or another Metal filter renders (OQ3). (`FeComposite` xor.)
- [x] The results go into `docs/libraries.md`'s dates, in one `docs:` commit by the controller.

---

Expand Down
18 changes: 14 additions & 4 deletions docs/design/specs/2026-11-04-binary-pods-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,11 +642,11 @@ The process, end to end:
| 49 | SwiftPM fetch | another package pins GoogleUtilities, GTMSessionFetcher or GoogleDataTransport at another exact version (Firebase, GoogleSignIn) | user: SwiftPM's version conflict naming both | accept: block 2's row 25; the docs name the table as the one place to align pins |
| 50 | xtool | a binary target is embedded as a dynamic framework (#130) | user: post-pack check 2 stops the build before install | handle: library-type slices never match `<name>.framework/<name>`; post-pack check |
| 51 | xtool | a bundle is not copied, or lands under another name | user: post-pack check 1 | handle |
| 52 | xtool | a bundle's `Info.plist` is refused at signing or install | user: xtool's or the iPhone's error | handle: CocoaPods' keys (goal 4.1); the owner's device pass |
| 52 | xtool | a bundle's `Info.plist` is refused at signing or install | user: xtool's or the iPhone's error | handle: CocoaPods' keys (goal 4.1); the owner's device pass (2026-11-05: installed) |
| 53 | xtool | the app grows by about 53 MB (G2), so installs over Wi-Fi take longer; the per-app copies in `ios/build/pod-binaries` and `ios-xtool/Resources` take about 66 MB more on disk (58 MB of xcframeworks and archives, 8 MB of models) | user: a slower install | accept: present tense in `docs/libraries.md` |
| 54 | Runtime | the model bundle is not found: "Invalid model path." at the first recognition, not at launch | user on the device | handle: post-pack check 1, and the device pass |
| 55 | Runtime | a `+load` registration is missing: the recognizer is nil, or `process` fails | user on the device | handle: `-force_load`, post-pack check 3, and the device pass |
| 56 | Runtime | dead stripping removes data that is found only by name | user on the device: "Invalid model path." with the bundle present | handle: the device pass decides; the slice is an archive, so d-date's relink-as-dynamic cause does not apply (fact 4) |
| 54 | Runtime | the model bundle is not found: "Invalid model path." at the first recognition, not at launch | user on the device | handle: post-pack check 1, and the device pass (checked 2026-11-05) |
| 55 | Runtime | a `+load` registration is missing: the recognizer is nil, or `process` fails | user on the device | handle: `-force_load`, post-pack check 3, and the device pass (checked 2026-11-05) |
| 56 | Runtime | dead stripping removes data that is found only by name | user on the device: "Invalid model path." with the bundle present | handle: the device pass decides (checked 2026-11-05); the slice is an archive, so d-date's relink-as-dynamic cause does not apply (fact 4) |
| 57 | Runtime | the privacy manifests inside the frameworks are not in the app | nobody for a development build | accept: they are read at App Store submission (Non-goals); the ℹ line names them |
| 58 | Runtime | the iPhone's iOS is older than a pod's minimum | user: a launch crash | accept: rn-xtool's minimum is 16.4, ML Kit's 15.5; row 35 covers the general case |
| 59 | Disk | not enough space for the downloads, their unpacked and wrapped copies and the per-app copies | user: a stop before the first download, with what is needed and where | handle: goal 5.5; the factor is 8 (G2 measured 7.5× with the per-app copies of row 85); with the project on another filesystem than the cache (row 36), the project's filesystem gets its share of the factor, 2 for the per-app copies, and the cache's the other 6 (final review M5); a file HEAD gives no length counts with the size the lock records (E/F review M3), and a cached file that fails its re-hash is announced and counted like a missing one (E/F review M2) |
Expand Down Expand Up @@ -731,6 +731,16 @@ The process, end to end:
- optional: one Japanese or Chinese sample through the matching script option.

Until the owner confirms these, the docs call ML Kit text recognition build-verified only.
- **Device pass, run 2026-11-05** (the owner, iOS 26), on the G2 app (bare React Native 0.88.1 with
@react-native-ml-kit/text-recognition 2.0.0, react-native-svg 15.16.0 and an entitlements file):
- installed over Wi‑Fi: the re-run of the post-pack checks before the install (row 88) passed silently, and the app
installed and launched (row 52);
- `TextRecognition.recognize()` on a photo of printed text returned the text, with no "Invalid model path." (rows
54–56 checked);
- react-native-svg: a Metal filter shape (`FeComposite` xor) rendered from `RNSVGFilters.bundle` (OQ3);
- Fast Refresh works.

Not part of this pass: the optional Japanese or Chinese sample.

## Open questions

Expand Down
3 changes: 2 additions & 1 deletion docs/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,8 @@ the pods' bundles again from the lock and the cache when they are gone since the
GoogleToolboxForMac), with GoogleToolboxForMac's checked `outsideRequirement` and its `emptyTargets`.
`data/pod-terms.json` maps a spec homepage to its vendor's terms page, for the line before the first download.

**ML Kit text recognition**, in the build-only proof on bare React Native 0.88.1 (2026-11-05; not run on a device yet):
**ML Kit text recognition**, in the build-only proof on bare React Native 0.88.1 (2026-11-05; the same app then
recognized printed text on a physical iPhone):
ten binary pods and four source pods; 40.3 MB downloaded from dl.google.com; the `pods` step took 7.5 s on the first
build and 0.1 s offline later; nine `-force_load`s; the cache took 237 MB and the app's copies 66 MB; `App.app` grew by
53 MB (the App binary by 40.3 MB); `ios-xtool/.build` took about 0.84 GB.
Expand Down
Loading
Loading