Files
faunosteo/packages/README.md
T

27 lines
2.2 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` | loader of the Rust core compiled to WebAssembly (`pkg/` built by `pnpm wasm:build`, git-ignored), TypeScript types of the contracts generated by ts-rs (committed), the R0 proofs (panic and stack traps, JSON.stringify parity, Zod readers, size budget) | **created**, R0 (Rust review) |
From R2 on, the Rust core (`crates/core`) replaces the TypeScript business
logic of `domain`, `anatomy` and `pdf` phase by phase
(`docs/development/RUST_ARCHITECTURE_REVIEW.md` Part VI); each TypeScript
package is deleted in the phase that switches its last consumer.
| `@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.