budget-app/docs/WORKSPACE_ARCHITECTURE.md

37 lines
2.5 KiB
Markdown

# Workspace and packaging ownership
Root: `budget-app/{Cargo.toml,app,budget-capture,Readme,docs}`.
Exactly two workspace members: `app` and `budget-capture`; default member `app`.
- `app/src/shell.rs`: shared desktop/Android Makepad application shell.
- `app/src/main.rs`: thin desktop entry. Explicit library target is used by Makepad Android packaging.
- `app/src/lib.rs`: application modules and exported OCR JNI trampoline, ensuring it survives final-library linking.
- `app/src/capture.rs`: budget-facing native facade.
- `app/resources/android`: full app manifest template and tile drawable.
- `app/resources/licenses`: model attribution and licence shipped with the application.
- `app/tests`: actual Makepad UI tests, public model integration, packaging tests, disposable runner and actual APK inspector.
- `budget-capture/src/{lib.rs,permissions.rs,error.rs}`: typed native capability/permission API.
- `budget-capture/src/build.rs`: verified model embedding plus Android javac/D8 compilation.
- `budget-capture/src/ocr.rs`: offline Rust OCR with bounded image inputs.
- `budget-capture/src/sys/android`: all Java, JNI implementation and component/permission manifest contract.
- `budget-capture/tests`: real OCR image fixture/inference tests, native contracts and Java extraction tests.
- `budget-capture/src/sys/ios`: unsupported-overlay boundary; imported-image Swift source remains unwired.
- `docs/Cargo.lock`: versioned workspace dependency lock.
No Gradle directory, Android host project, nested model-test workspace, test under
docs, Nigig workspace membership, or third facade crate remains. Historical
validation documents describe prior revisions, not the current build pipeline.
Makepad's dependency-secondary-DEX packaging is the functional replacement for
the old Gradle host/library. Android can load service/activity classes from the
APK's classesN.dex; this is not a private runtime DexClassLoader workaround.
The full manifest and capture manifest contract are checked for parity.
The installed app has no network permission. Build-time model retrieval fails
closed on SHA-256 mismatch; model bytes are compiled into the native library.
Ocrs models are CC BY-SA 4.0 and remain unmodified. Engine code has its own licence.
The worker stops projection first, recycles its bitmap, and discards results after
service destruction or a newer capture generation. It does not save raw OCR text.
Android package identity and inbox schema are retained. Production update signing
must use the existing key; no production-key/device-update verification is claimed.