@interop/byoe-react-template 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,11 +1,6 @@
 # Changelog
 
-## 0.1.0 - TBD
-
-### Changed
-
-- Scoped the package name to `@interop/byoe-react-template` (the unscoped
-  `byoe-react-template` npm package is deprecated).
+## 0.1.0-0.1.1 - 2026-07-12
 
 ### Added
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@interop/byoe-react-template",
   "description": "Template for building 'Bring Your Own Everything' (BYOE) apps on Wallet Attached Storage: a Vite + React + TypeScript SPA with DID Auth login via a CHAPI wallet, local-first encrypted storage, and background sync, built on @interop/was-react.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -53,8 +53,24 @@
     "node": ">=24.0"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
+  "keywords": [
+    "byoe",
+    "chapi",
+    "wallet-attached-storage",
+    "did-auth",
+    "local-first",
+    "react",
+    "template"
+  ],
   "author": "Interop Alliance (https://github.com/interop-alliance/)",
-  "license": "MIT"
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/interop-alliance/byoe-react-template.git"
+  },
+  "homepage": "https://github.com/interop-alliance/byoe-react-template",
+  "bugs": "https://github.com/interop-alliance/byoe-react-template/issues"
 }

package/CLAUDE.md

@@ -1,55 +0,0 @@
-# byoe-react-template (BYOE Notes)
-
-A minimal, working "Bring Your Own Everything" (BYOE) app template: a Vite +
-React + TypeScript SPA with DID-Auth login via a CHAPI wallet, local-first
-encrypted storage, and background sync to a WAS server, built on
-`@interop/was-react`. It ships one example "notes" collection. The library owns
-the reusable plumbing (identity, login, session, encrypted replica, sync, hooks,
-MUI components); this repo is the thin app-specific shell around it.
-
-## Source layout
-
-- `src/app.config.ts` -- env-var exports and the one `WasAppConfig` the library
-  consumes (app name, credential type/vocab, `COLLECTIONS` map). First stop when
-  renaming the template.
-- `src/stores/notes.ts` -- the example entity store (`createEntityStore`) plus
-  the `StoreRegistry` the rehydrate mechanism drives.
-- `src/dev/` -- dev-mode bootstrap (`bootstrap.ts` opens the local store from
-  `devSeed.ts` and hydrates) and `devSync.ts` (CHAPI-bypassed replication from a
-  provisioned grants file).
-- `src/components/` -- `AppShell` (top bar, `SyncStatusChip`, `ReconnectBanner`,
-  logout) and `DevGate` (dev-mode router gate; wallet mode uses the library's
-  `ProtectedRoute`).
-- `src/pages/` -- `LoginPage` (CHAPI login) and `NotesPage` (list/add/edit/
-  delete).
-- `scripts/provision-dev-grants.ts` -- provisions a dev Space, collections, and
-  delegated zcaps against a running was-teaching-server.
-- `playwright.config.ts` (offline/mocked, CI), `playwright.was.config.ts` (real
-  WAS server), `playwright.wallet.config.ts` (full wallet login), and `test/`
-  tiers, plus Node unit tests via Vitest.
-
-## Commands
-
-```
-pnpm dev                     # wallet mode; VITE_AUTH_MODE=dev for offline mode
-pnpm run build               # typecheck + Vite build
-pnpm run typecheck
-pnpm run lint
-pnpm run fix                 # eslint --fix + prettier
-pnpm run test:node           # Vitest + fake-indexeddb
-pnpm run test:browser        # Playwright, offline/mocked (CI)
-pnpm run test:browser:was    # Playwright against a real local WAS server
-pnpm run test:browser:wallet # Playwright full wallet login (local/manual)
-pnpm run provision:dev       # provision dev grants (SERVER_URL, default :3002)
-```
-
-## Conventions
-
-- pnpm; Node >= 24; ESM only.
-- Prettier: no semicolons, single quotes, no trailing commas,
-  `arrowParens: avoid`.
-- Never use the right-arrow character (write `to`), em-dash character (write
-  `--`), or ellipsis character (write `...`).
-- Inline single-use option/argument types at the function signature instead of
-  declaring a named type.
-- Keep app-agnostic logic in `@interop/was-react` rather than growing it here.

package/_spec/phase2-handoff.md

@@ -1,143 +0,0 @@
-# Phase 2 handoff: build `byoe-react-template`
-
-Phase 1 is DONE: `@interop/was-react` is fully extracted, tested, documented
-(local checkout at `~/code/Interop/was-react`, for reading source/API), and
-published to npm as `@interop/was-react@0.1.2`. This file gives a fresh
-session everything needed to build
-the template app in THIS repo (`~/code/Interop/byoe-react-template`, currently
-an empty clone).
-
-## Goal (from the original prompt)
-
-A minimal but complete Vite + React + TypeScript SPA, `private: true`, no
-packaging machinery, demonstrating the BYOE pattern end to end by consuming
-`@interop/was-react`. Keep the template thin: anything app-agnostic belongs in
-the library.
-
-Required app content:
-- Login page with DID Auth via CHAPI (wallet polyfill wired up)
-- One protected route behind `ProtectedRoute` (from `@interop/was-react/mui`)
-- One example WAS-backed collection ("notes"): list/add/edit/delete,
-  local-first with sync, `SyncStatusChip` in the app shell
-- MUI app shell with `ReconnectBanner`
-
-Tooling modeled on `~/code/Dima/life-advisor/package.json`: scripts `dev`,
-`build` (typecheck + `vite build`), `fix`, `format`, `lint`, `typecheck`,
-`test`, `test:node`, `test:browser`, `test:browser:was`,
-`test:browser:wallet`, `provision:dev`; pnpm; `engines.node >= 24`; MIT;
-author "Interop Alliance" (https://github.com/interop-alliance/); eslint flat
-config + prettier + tsconfig conventions as in life-advisor /
-isomorphic-lib-template.
-
-Testing: vitest + fake-indexeddb for unit tests; THREE Playwright configs
-(mocked / real WAS server / real wallet) mirroring life-advisor's
-`playwright.config.ts`, `playwright.was.config.ts`,
-`playwright.wallet.config.ts`; plus the dev-grants provisioning script
-(`provision:dev` calls the library's `@interop/was-react/dev`).
-
-README: what BYOE/BYOS is (brief), prerequisites (WAS server, wallet), how to
-rename the template into a new app, how to run each test tier. Also a short
-CLAUDE.md describing structure and conventions.
-
-Constraints: do NOT modify life-advisor, freewallet, or was-react (except:
-publishing reminder below). Check in with the user when the template is done.
-
-## Consuming @interop/was-react
-
-Published: use `"@interop/was-react": "^0.1.2"` from the npm registry (do NOT
-use link:/file: references). was-react peers the template must install:
-`react >= 19`, `react-dom`, `zustand ^5`, `rxdb ^17`, and for the mui entry:
-`@mui/material ^9`, `@mui/icons-material ^9`, `@emotion/react`,
-`@emotion/styled`, `react-router ^8`. Node-only dev entry needs `tsx` to run
-the provision script (or use the installed `was-provision-dev-grants` bin).
-
-## was-react API facts (verified)
-
-- Wrap app above the router:
-  `<WasSessionProvider config={appConfig} registry={storeRegistry}>`.
-- `WasAppConfig`: `{ appName, appOrigin, collections: [{ key, id }],
-  credential: { credentialType, vocabBase }, wasServerUrl?, mediatorBase?,
-  dbName?, storageKeyPrefix?, sync?, expiry? }`. The library builds the
-  documentLoader/LoginConfig internally from this.
-- `StoreRegistry = Record<collectionKey, { hydrate(): Promise<void>;
-  upsert(doc: {id}): void; drop(uuid): void; clear(): void }>` -- one entry
-  per `collections[].key`.
-- `createEntityStore` (zustand factory) exposes
-  `hydrate/insert/update/remove/replaceAll/patch/drop` -- NO `upsert`/`clear`;
-  registry wiring needs small adapters: `upsert -> patch` (with a cast),
-  `clear -> replaceAll([])`. The was-react README quick start shows exactly
-  this for a "notes" store -- FOLLOW IT. (Optional improvement noted with the
-  user: a `toRegistryEntry(store)` helper in was-react could remove this
-  boilerplate; fine to add to was-react during Phase 2 if it proves annoying,
-  it was offered and not rejected.)
-- Hooks: `useLogin()` -> `{ login, status, phase, error }` (phases:
-  `probing`/`storing-key`/`requesting-grants`/`verifying`), `useSession`,
-  `useLogout`, `useReconnect`, `useSyncStatus` (rollup:
-  offline / error > syncing > synced), `useAppReady`.
-- `@interop/was-react/mui`: `ProtectedRoute` (props incl.
-  `loginPath`, default `/login`; calls `restore()` on mount, redirects
-  unauthenticated), `ReconnectBanner`, `SyncStatusChip`. Wallet-mode only (no
-  dev-mode branch; life-advisor's dev `initApp`/`AUTH_MODE` pattern stays
-  app-side -- the template does NOT need a dev mode unless the WAS e2e tier
-  requires dev-sync, see below).
-- Dev sync (no wallet): app-side wiring like life-advisor's `devSync.ts` --
-  fetch a grants JSON, `parseGrants`, `deriveIdentity({ seed })`,
-  `startWasSync({ parsed, zcapClient, localStore,
-  syncController: createSyncController({ collections, sync }),
-  onRemoteChange: (key, event) => patchFromChange(registry, key, event) })`.
-  Library exports all of these from the root entry.
-- `@interop/was-react/dev`: `provisionDevGrants({ serverUrl, seed,
-  collections: string[], spaceName?, outFile?, probe? })`; CLI
-  `was-provision-dev-grants --server-url --seed (hex|base64url)
-  --collections a,b --space-name --out --probe`.
-- CHAPI E2E test bridge globals (for Playwright without a real mediator):
-  `__WAS_REACT_E2E_CHAPI__` (activation flag),
-  `__WAS_REACT_E2E_CHAPI_REQUESTS__`, `__WAS_REACT_E2E_CHAPI_RESPONSES__`;
-  active when `import.meta.env.MODE !== 'production'`.
-- Read `~/code/Interop/was-react/README.md` -- its Quick start section is the
-  authoritative wiring example (all symbols verified against source).
-
-## Playwright tier facts (from life-advisor + freewallet)
-
-- Default config: offline/mocked suite, vite dev server, single chromium.
-- WAS config: serialized, single worker; boots the app AND a real WAS server
-  from a sibling checkout `../was-teaching-server` (env override
-  `WAS_SERVER_DIR`), server started with `pnpm run dev` and env
-  `PORT`/`SERVER_URL`; the server's `SERVER_URL` must EXACTLY equal the
-  client's `VITE_WAS_SERVER_URL` (zcap invocation-target host match).
-  life-advisor's version uses globalSetup/globalTeardown to provision grants.
-- Wallet config: boots 3 servers -- was-teaching-server, freewallet
-  (`../freewallet`, env `FREEWALLET_DIR`), and the app. life-advisor's
-  playwright.wallet.config.ts hardcodes `/Users/dmitriz/...` defaults --
-  use env-overridable relative defaults (`../was-teaching-server`,
-  `../freewallet`) instead.
-- freewallet CI note: only the mocked tier runs in CI; WAS/wallet tiers are
-  local/manual (need sibling checkouts).
-
-## Repo conventions (user's rules)
-
-- pnpm, Node >= 24, MIT, author Interop Alliance. Do not commit or bump
-  versions; user handles that. CHANGELOG dates are `TBD`.
-- Never use the characters `→` (use `to`), mdash (use `--`), `…` (use `...`).
-- Never mention `_spec` dirs, roadmap phases/tracks, or bedrock libraries in
-  CHANGELOG/code comments.
-- TS style: single-use options types inlined at signatures; single-field
-  interfaces inlined at usage.
-- pnpm build-script approvals: if scripts fail with ERR_PNPM_IGNORED_BUILDS,
-  set `allowBuilds: esbuild: true` in pnpm-workspace.yaml (was done in
-  was-react). Lockfile/minimumReleaseAge issues: stop and ask the user.
-- Delegate to Opus 4.8 sub-agents whenever appropriate.
-- Prettier in these repos: no semicolons, single quotes, no trailing commas,
-  arrowParens avoid, proseWrap always.
-
-## Suggested plan
-
-1. Scaffold: Vite React-TS app modeled on life-advisor's tooling (copy its
-   eslint/prettier/tsconfig conventions; `private: true`, no exports/files/
-   publishConfig). `@interop/was-react@^0.1.2` + peers.
-2. App: config + notes entity store + registry + provider + router (login
-   page, protected `/notes` route, MUI shell with ReconnectBanner +
-   SyncStatusChip). Deliberately minimal, every piece demonstrating one part.
-3. Tests: vitest unit (notes store round-trip w/ fake-indexeddb), 3 Playwright
-   tiers, provision:dev script.
-4. README + CLAUDE.md. Check in with user when done.