Files
faunosteo/packages/README.md
T

29 lines
2.5 KiB
Markdown

# packages/
Shared code lives here once it has a real owner and real content: an empty
package would only add build configuration to maintain (IMPLEMENTATION_PLAN.md
Step 2, FRONTEND_ARCHITECTURE.md §6). First package: `supabase/` (Step 3).
Planned packages and the step that creates each one:
| Package | Content | Created at |
|---|---|---|
| `@faunosteo/domain` | Zod schemas: anatomical sheet document + integrity rules (**created**, Step 4); report document, entitlement capabilities later | Step 4 (sheet model) |
| `@faunosteo/anatomy` | legacy importer (**created**, Step 4b), curation pipeline: changeset → working draft + report migration map (**created**, Steps 4c/5), pure annotation-layer renderer `@faunosteo/anatomy/render` shared with the app (**created**, Step 5) | Step 4b (importer) |
| `@faunosteo/pdf` | browser-free PDF engine (**created**, Step 6): report archive export from explicit inputs (report, sheet snapshot, branding, labels, rasterizer), layered archive reading, SVG sanitiser, page renderers | Step 6 (PDF archives) |
| `@faunosteo/i18n` | FR/EN dictionaries (no React) + `useT` | first second consumer (public-web or worker) |
| `@faunosteo/supabase` | browser client factory, generated database types, PGlite harness running the pgTAP suite, sheet publish gate | **created**, Step 3 |
| `@faunosteo/core-wasm` | the Rust core compiled to WebAssembly: `CoreRuntime` (lazy load, poison on a trap, offline re-instantiation, sheet handles per instance), Node source, `pkg/` shipped and `pkg-proofs/` (built by `pnpm wasm:build`, git-ignored, BUILD_STAMP), TypeScript types of the contracts generated by ts-rs (committed), the frozen N-1 Zod reader (`./n-1`), the trap, size and measurement tests | **created**, R0; runtime and app consumers R2 |
Since R2 the Rust core (`crates/core`) holds the business logic `domain` held
for the application (`docs/development/RUST.md` §8); `domain` stays frozen
for the PDF engine, the pipeline and the compare CLI. `anatomy` and `pdf`
follow at R3 and R4 (`docs/development/RUST_ARCHITECTURE_REVIEW.md` Part
VI); each TypeScript package is deleted in the phase that switches its last
consumer (`domain` and `anatomy` at R5, `pdf` at R4).
| `@faunosteo/config` | runtime config resolution shared by app, public-web, worker | with public-web |
| `@faunosteo/ui` | UI primitives and design tokens | only when public-web reuses them |
Convention: a package has its own `package.json` (`name`, `exports`, `types`),
`tsconfig.json` extending the root one, and tests beside its sources.