diff --git a/README.md b/README.md index b54c70aa..b9b6444c 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,46 @@ owner described in The client route policy is user experience only; server authorization remains authoritative. +## Support scope + +Four tiers. The status words on the right are the ones the catalogs and +design documents use; the next table maps them. + +| Tier | What it covers | Status words | +| --- | --- | --- | +| Default | In the default build and covered by the merge gates: the application shell and example routes, the REST HTTP executor, TanStack Query server state, Local/Session Storage registries, cross-tab invalidation, runtime config profiles and the release manifest check, `AUTH_MODE=external` (`demo` only in local/development), the typed message catalog, and the removable reference feature. `dist/` is served by a static host ([`docs/architecture/static-delivery.md`](docs/architecture/static-delivery.md)) | `COMPOSED` | +| Optional (recipe) | Not installed. A project copies one of the recipes in `config/recipes/frontend-capability-recipes.json` and narrows it ([`docs/architecture/optional-adapter-recipes.md`](docs/architecture/optional-adapter-recipes.md)). `realtime`, `offline-indexeddb`, `service-worker-pwa` and `file-transfer` also ship a tested reference runtime that the default build leaves out | `RECIPE_AVAILABLE`, `NOT_INSTALLED`, `AVAILABLE_NOT_COMPOSED` | +| Experimental | Designed and decided, but the runtime is missing or unfinished; finish it before building on it. GraphQL, gRPC-Web, Connect-Web and Protobuf adapters, Range resumable download, IndexedDB query persistence, the local preview decode-safety probe. `src/features/local-draft-feature` is an architecture sample, not installed | `DESIGNED_NOT_IMPLEMENTED` | +| Not supported | Deliberately not selected, or browsers cannot guarantee it: SSR, app-managed background upload and download, directory selection, persistent file handles, product query persistence, exactly-once delivery between tabs | `NOT_SELECTED`, `PLATFORM_LIMITED` | + +The rows come from +[`docs/architecture/browser-data-capability-completion-ledger.md`](docs/architecture/browser-data-capability-completion-ledger.md), +[`docs/architecture/client-cache-and-storage.md`](docs/architecture/client-cache-and-storage.md) +and +[`docs/architecture/api-contract-schema-mapper-and-server-state.md`](docs/architecture/api-contract-schema-mapper-and-server-state.md). + +| Status word | Where it appears | Meaning | Tier | +| --- | --- | --- | --- | +| `COMPOSED` | capability ledger, design documents | wired into the default production path | Default | +| `INSTALLED` | a project's own recipe catalog (step 10 of the recipe procedure) | the project added the recipe | Default, for that project | +| `RECIPE_AVAILABLE` | recipe catalog `status` | a recipe exists to copy; nothing is installed | Optional | +| `NOT_INSTALLED` | recipe catalog `defaultStatus`; a `src/features//NOT_INSTALLED` marker file | not part of the build | Optional (recipe) or Experimental (feature) | +| `AVAILABLE_NOT_COMPOSED` | capability ledger; recipe `referenceRuntime.status` | code and tests exist; the default build leaves it out | Optional | +| `DESIGNED_NOT_IMPLEMENTED` | capability ledger, design documents | design approved, runtime missing | Experimental | +| `NOT_SELECTED` | capability ledger, design documents | deliberately not chosen | Not supported | +| `PLATFORM_LIMITED` | capability ledger | browsers cannot guarantee it; offered only behind a probe and a fallback, if at all | Not supported as a guarantee | + +Gate results (`PASS`, `PASS_SCOPED`, `UNVERIFIED`, `FAIL_UNVERIFIED`) are +verdicts on evidence, not support tiers. + +Browsers: the build targets Chrome and Edge 111, Firefox 128, and Safari and +iOS 16.4. That is the higher of Vite 8's default JavaScript target +(`baseline-widely-available`; `vite.config.ts` sets no `build.target`) and +the CSS targets of Tailwind CSS 4. There is no browserslist. The end-to-end +suite runs on the desktop Chromium, Firefox and WebKit builds that Playwright +1.62 pins, plus one Chromium phone-size smoke (`playwright.config.ts`). Older +versions inside the target range and real mobile browsers are not tested. + ## Architecture This repository is a **Frontend Application Foundation**: a starter/composition