Skip to content

Commit 2fff107

Browse files
authored
Dev/feat roadmap support sync (#62)
This pull request updates the project documentation and configuration to introduce a detailed integrations roadmap, clarify the status and scope of framework integrations, and improve coverage reporting and testing for new packages. The changes also include documentation improvements for example apps and minor dependency and TypeScript config updates. **Integrations Roadmap and Documentation:** * Replaced the informal "Planned Integrations" section in `README.md` with an executive-style "Integrations Roadmap," providing a snapshot of integration progress, priorities, and actionable upstream issues. Added a reference to a new detailed roadmap document. * Added a comprehensive `docs/roadmap/integrations.md` file detailing integration progress, checklists, and per-framework status, including new and upcoming integrations like Electrobun. **Example App Documentation Improvements:** * Overhauled `examples/react-nextjs/README.md` and `examples/react-electron/README.md` to clarify integration scope, usage instructions, and roadmap links, making them more useful as reference implementations for framework-specific integration and troubleshooting. [[1]](diffhunk://#diff-76d589e653c7ee8fbed15ab8296b746003aa7b400206ae315a081e44a3623c41L1-R32) [[2]](diffhunk://#diff-3eb07fed6e62d03603644981d28734f2617c8bbe659999306db154c524c5b5feL1-R33) **Testing and Coverage Enhancements:** * Added new Vitest test and coverage scripts for `react-web` and `tauri` packages in the root `package.json`, along with corresponding coverage gates and lanes. * Set explicit `name` fields in the Vitest config for `react-web` and `tauri` to support multi-project test reporting. [[1]](diffhunk://#diff-a99bb638ea9d83f6b46f77f7721094c3756a8345d8ce9ccf4f5fa917febdd168R5) [[2]](diffhunk://#diff-7a03e6df2647711feaae43ff14f14a3c1275bd58e2a827691377d2a8e4769189R5) **Dependency and TypeScript Config Updates:** * Updated `@vue/tsconfig` to version `^0.9.0` in the Vue PWA example. * Enabled the `noUncheckedIndexedAccess` TypeScript compiler option in the Vue PWA example for stricter type safety. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Dokumentace** * Přidán nový Roadmap integracích s detailním přehledem priorit, pokroku a plánů pro jednotlivé integrace. * Aktualizovány příklady dokumentace pro React s Electronem, React s Next.js a Vue aplikace s jasným zaměřením. * **Chores** * Přidány nové skripty pro testování a kontrolu pokrytí kódu. * Aktualizovány konfigurační soubory testů s novými identifikátory projektů. * Aktualizovány závislosti a TypeScript možnosti. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2 parents 55cb458 + d2fe689 commit 2fff107

File tree

10 files changed

+286
-95
lines changed

10 files changed

+286
-95
lines changed

README.md

Lines changed: 51 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -42,34 +42,57 @@ Coverage notes (Statements / Branches):
4242
- `@evolu/bun` (private): `100% / 100%` (`BunDbWorker.ts`)
4343
- Wrapper packages (`@evolu/react`, `@evolu/vue`, `@evolu/svelte`) are still coverage-expansion candidates.
4444

45-
## Planned Integrations (Roadmap View)
46-
47-
| Integration | Priority | Focus |
48-
| -------------------- | -------- | ---------------------------------------------- |
49-
| Next.js (App Router) | P0 | Official web guide + SSR/client boundary docs |
50-
| TanStack Start | P0 | React/web adapter docs + production example |
51-
| Astro | P0 | Client-island starter + worker boot guidance |
52-
| SvelteKit | P1 | Browser-only init reference app |
53-
| Nuxt 3 | P1 | Client plugin/module integration path |
54-
| Remix / React Router | P1 | Explicit browser init in route patterns |
55-
| Tauri | P1 | WebView runtime + optional relay bridge |
56-
| Electron | P1 | Renderer runtime + optional main-process relay |
57-
| Capacitor (Ionic) | P2 | WebView-first runtime hardening |
58-
| Flutter | P2 | Separate SDK/bridge exploration |
59-
60-
Main blockers to track:
61-
62-
- SSR/client boundaries and hydration order in framework runtimes.
63-
- Worker lifecycle consistency across browser, edge, and desktop shells.
64-
- Desktop packaging/process boundaries (Electron/Tauri).
65-
- Mobile WebView storage consistency and background lifecycle.
66-
67-
Current recommendation:
68-
69-
- Build first-class examples for `Next.js`, `TanStack Start`, and `Astro`.
70-
- Follow with `SvelteKit`, `Nuxt`, `Remix`, and `Tauri/Electron` runtime guides.
71-
- Treat `Flutter` as a separate SDK/bridge effort, not a quick wrapper.
72-
- Keep protocol/API parity first; add adapters only where lifecycle/storage semantics are clear.
45+
## Integrations Roadmap (Executive View)
46+
47+
Roadmap snapshot date: `2026-03-03`.
48+
Today execution focus: `Electrobun` foundation (`P0`).
49+
50+
| Integration | Progress | Priority | Size | Local Status | Evidence |
51+
| -------------------- | -------- | -------- | ---- | -------------------- | ----------------------------------------- |
52+
| Electrobun | 0% | P0 | L | Planned architecture | Target package `@evolu/electrobun` |
53+
| Next.js (App Router) | 40% | P0 | L | Active hardening | `examples/react-nextjs` |
54+
| TanStack Start | 60% | P0 | M | Active hardening | `packages/tanstack-start`, example |
55+
| Astro | 60% | P0 | M | Active hardening | `packages/astro`, example |
56+
| SvelteKit | 20% | P1 | M | Planned | `@evolu/svelte` wrapper baseline |
57+
| Nuxt 3 | 0% | P1 | L | Planned | `@evolu/vue` wrapper baseline |
58+
| Remix / React Router | 20% | P1 | M | Planned | `@evolu/react-web` baseline |
59+
| Tauri | 60% | P1 | M | Active hardening | `packages/tauri`, `examples/tauri` |
60+
| Electron | 20% | P1 | M | Planned hardening | `examples/react-electron` |
61+
| Capacitor (Ionic) | 20% | P2 | L | Upstream watch + POC | Android WebView fallback shipped in fork |
62+
| Flutter | 0% | P2 | XL | Research | No runtime bridge yet |
63+
64+
Progress metric uses a weighted checklist (`20%` each):
65+
66+
- Adapter/helper package
67+
- Reference example
68+
- Test lane + coverage gate
69+
- Framework guide (README/docs)
70+
- CI smoke/hardening
71+
72+
Executive progress values use completed-core-item counting only, so valid values are `0%`, `20%`, `40%`, `60%`, `80%`, `100%`.
73+
74+
Detailed integration roadmap with per-framework checklists: [docs/roadmap/integrations.md](./docs/roadmap/integrations.md).
75+
76+
## Upstream Watch (Top Actionable)
77+
78+
Upstream snapshot date: `2026-03-03` (tracked issues remain open).
79+
80+
| Upstream | Local Status | Size | Why now |
81+
| --- | --- | --- | --- |
82+
| [#616](https://github.com/evoluhq/evolu/issues/616) | approved | M | Relay transport status gates runtime decisions |
83+
| [#656](https://github.com/evoluhq/evolu/issues/656) | approved | M | Owner deletion affects compliance and data lifecycle |
84+
| [#655](https://github.com/evoluhq/evolu/issues/655) | approved | M | Relay usage metrics required for ops visibility |
85+
| [#653](https://github.com/evoluhq/evolu/issues/653) | open | M | AppOwner storage model impacts security posture |
86+
| [#520](https://github.com/evoluhq/evolu/issues/520) | open | XS | Security backlog should stay continuously triaged |
87+
| [#593](https://github.com/evoluhq/evolu/issues/593) | in-progress | L | LocalAuth influences account model and DX |
88+
| [#631](https://github.com/evoluhq/evolu/issues/631) | blocked | M | SQLite baseline changes can break adapters |
89+
| [#659](https://github.com/evoluhq/evolu/issues/659) | done + watch | M | Local mitigation shipped, upstream still open |
90+
91+
## Public Issue Sync (Planned)
92+
93+
- Internal planning remains private.
94+
- Selected public-facing topics can be mirrored into GitHub Issues and tracked in GitHub Projects.
95+
- Only explicitly approved items are mirrored to public boards.
7396

7497
## `@evolu/common` Compatibility and Third-Party Dependencies
7598

0 commit comments

Comments
 (0)