@terreno/mcp 57.15.0 → 57.16.2

package/src/docs/versioned/57.15.0/how-to/upgrade-banner.md

@@ -0,0 +1,172 @@
+# Upgrade Banner
+
+Two-tier system for notifying users about app updates: a soft warning (dismissible toast) and a hard block (full-screen, no dismiss). Admin-configurable thresholds per platform.
+
+## How It Works
+
+1. **Backend** exposes `GET /version-check?version=N&platform=web|mobile` (public, no auth)
+2. **Admin** configures version thresholds via the admin panel
+3. **Client** calls `useUpgradeCheck()` on mount, which compares the app's build number against the thresholds
+4. Result: `ok` (no action), `warning` (persistent toast), or `required` (blocking screen)
+
+## Setup
+
+### 1. Backend: Register the VersionCheckPlugin
+
+```typescript
+import {TerrenoApp, VersionCheckPlugin} from "@terreno/api";
+
+const app = new TerrenoApp({userModel: User})
+  .register(new VersionCheckPlugin())
+  .start();
+```
+
+This adds the public `GET /version-check` endpoint. The admin routes (`GET/PUT /admin/version-config`) are automatically available if you're using `AdminApp`.
+
+### 2. Frontend: Add build number injection
+
+Create or update `app.config.ts` in your Expo app root. Use the `resolveBuildNumber` helper from `@terreno/rtk/buildNumber`:
+
+```typescript
+import {resolveBuildNumber} from "@terreno/rtk/buildNumber";
+import type {ConfigContext, ExpoConfig} from "expo/config";
+
+export default ({config}: ConfigContext): ExpoConfig => ({
+  ...config,
+  extra: {
+    ...config.extra,
+    buildNumber: resolveBuildNumber({configValue: config.extra?.buildNumber}),
+  },
+} as ExpoConfig);
+```
+
+`resolveBuildNumber` resolves the build number in this order:
+
+1. **`override`** option (set to a number for local testing)
+2. **`configValue`** option (e.g. from `app.json` `expo.extra.buildNumber` or EAS Build)
+3. **`EXPO_PUBLIC_BUILD_NUMBER`** env var (customizable via `envVar` option)
+4. **`git rev-list --count HEAD`** (default)
+5. **`undefined`** if git is unavailable (version check will be skipped)
+
+This sets `Constants.expoConfig.extra.buildNumber` when Metro loads the config. By default it tracks the git commit count.
+
+**If you change `buildNumber` and nothing updates:** restart the dev server (`bun expo start` or `expo start --clear`). `expo-constants` is filled when the bundle is built; hot reload does not always re-read `app.config.ts`.
+
+### 3. Frontend: Wire up the hook
+
+In your root layout:
+
+```typescript
+import {useUpgradeCheck} from "@terreno/rtk";
+import {UpgradeRequiredScreen} from "@terreno/ui";
+
+function RootLayoutNav() {
+  const {isRequired, requiredMessage, onUpdate} = useUpgradeCheck();
+
+  if (isRequired) {
+    return (
+      <UpgradeRequiredScreen
+        message={requiredMessage ?? "Please update to continue."}
+        onUpdate={onUpdate}
+      />
+    );
+  }
+
+  return <Stack>{/* normal routes */}</Stack>;
+}
+```
+
+The hook handles:
+- **ok**: Nothing happens, app runs normally
+- **warning**: Shows a persistent toast with the admin-configured message
+- **required**: Returns `isRequired: true` so you can render the blocking screen
+- **No build number**: Skips the check entirely (dev environment)
+
+### 4. Admin: Configure thresholds
+
+Open the admin panel's `/version-config` route directly. The configuration screen is not included in the main sidebar. Set:
+
+- **Web Warning Version**: Build number below which web users see a warning toast
+- **Web Required Version**: Build number below which web users are blocked
+- **Mobile Warning Version**: Same for mobile
+- **Mobile Required Version**: Same for mobile
+- **Warning Message**: Text shown in the toast
+- **Required Message**: Text shown on the blocking screen
+- **Update URL** (optional): App store or download link for mobile updates
+
+All version fields default to `0`, meaning no constraint until configured.
+
+## CI/CD: Build Number in GitHub Actions
+
+### EAS Build
+
+In your `eas.json`, use a pre-build hook or set the build number via environment:
+
+```yaml
+# .github/workflows/build.yml
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for git rev-list --count
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build with EAS
+        run: eas build --platform all --non-interactive
+```
+
+Since `app.config.ts` runs `git rev-list --count HEAD` at build time, the build number is automatically set. The key requirement is `fetch-depth: 0` in the checkout step to ensure the full git history is available.
+
+### Web Deployments
+
+For static web builds (e.g. `expo export`):
+
+```yaml
+jobs:
+  deploy-web:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Export web build
+        run: npx expo export --platform web
+
+      - name: Deploy
+        run: # your deployment step
+```
+
+The `app.config.ts` runs during `expo export`, so the build number is embedded in the static output.
+
+### Verifying the Build Number
+
+After building, you can verify the build number is set correctly:
+
+```bash
+# Check the current commit count locally
+git rev-list --count HEAD
+```
+
+This number should match what `Constants.expoConfig.extra.buildNumber` returns in the running app.
+
+## Architecture
+
+```
+App mounts → useUpgradeCheck() fires
+  → GET /version-check?version=N&platform=web|mobile
+  → "ok"       → normal app
+  → "warning"  → normal app + persistent toast
+  → "required" → UpgradeRequiredScreen (blocks everything)
+```
+
+Update behavior when user taps "Update":
+- **Web**: `window.location.reload()` — picks up the latest deployment
+- **Mobile**: Opens `updateUrl` via `Linking.openURL()` (e.g. App Store link)

package/src/docs/versioned/57.15.0/how-to/upgrade-terreno.md

@@ -0,0 +1,78 @@
+# Upgrade Terreno
+
+Bump every `@terreno/*` package together. Mixing versions is unsupported ([versioning policy](../explanation/versioning-policy.md)).
+
+## 1. Check current versions
+
+From the app root:
+
+```bash
+bun pm ls --all | rg '@terreno/'
+```
+
+Or call MCP `application_info` (`terreno-mcp-local`) and read each `package.json`. Record the lowest `@terreno/*` version as `fromVersion` and the target as `toVersion` (usually the latest tag on [GitHub Releases](https://github.com/TerrenoLabs/terreno/releases)).
+
+## 2. Fetch notes for the range
+
+```text
+terreno_get_upgrade_guide({ fromVersion, toVersion })
+```
+
+Or browse [`mcp-server/src/docs/upgrades/`](../../mcp-server/src/docs/upgrades/). The tool lists recorded notes and names same-major minors with no file — a gap is not “nothing changed.”
+
+## 3. Order (do not skip)
+
+| Step | Why |
+| --- | --- |
+| Clean git tree, work on a branch | Rollback is `git checkout -- .` / `git reset --hard` on that branch. |
+| Backend `@terreno/*` first | `/openapi.json` is the contract the frontend typed client is generated from. Regenerating against an old backend omits new routes; screens fail at compile. |
+| Backend compile + tests | Catch API breaks before touching Expo or UI. |
+| Expo SDK (if the Terreno major tracks a new Expo) | `@terreno/ui` pins `react-native` (for example `~0.86.0` on the 57 line in `ui/package.json` `peerDependencies`). Installing Terreno frontend packages before Expo leaves unmet peers. |
+| Frontend `@terreno/*` | UI, syncdb, admin-frontend, admin-spa, rtk. |
+| Regenerate typed client | Only after the **upgraded** backend is running. |
+| Compile, lint, tests | Whole app. |
+| Run the app | UI verification. |
+
+Use the `upgrading-expo` skill at the Expo step. Do not copy Expo’s checklist into a Terreno-only bump.
+Maintainers watching the next SDK beta use `track-upstream-expo` / [`track-upstream-expo.md`](track-upstream-expo.md) instead of mixing native bumps onto master.
+
+### Backend vs frontend packages
+
+From `publish-on-tag.yml`: **backend** `api`, `test`, `admin-backend`, `blocks`, `ai`, `api-health`, `comms`, `feature-flags`, `mcp`. **frontend** `ui`, `rtk`, `syncdb`, `admin-frontend`, `admin-spa`. `blocks` holds contracts that both `ai` and `ui` depend on, so it moves with the backend step.
+
+## 4. RTK → syncdb is not a version bump
+
+If the range includes the syncdb release (`56.0.0-beta.2` and later), treat collection CRUD as a **platform migration**. Follow [migrate-rtk-to-syncdb.md](migrate-rtk-to-syncdb.md) in a separate change from the routine lockstep bump. Keep `@terreno/rtk` for the OpenAPI SDK, Better Auth, feature flags, and sockets until that migration is done.
+
+## 5. Manual steps
+
+1. Branch from a clean tree. Confirm tests pass on HEAD so later failures are from the upgrade.
+2. Print `fromVersion`, `toVersion`, notes, affected packages, and this order. **Stop until the human confirms.**
+3. Bump backend packages to `toVersion`. `bun install`. `bun run compile` and backend tests.
+4. If Expo must move, run `upgrading-expo`, then rebuild native binaries.
+5. Bump frontend packages. `bun install`.
+6. Start the upgraded backend. `cd <frontend> && bun run sdk`.
+7. `bun run compile`, `bun run lint`, and the app test suite.
+8. Log in and exercise the screens that use changed APIs.
+
+Stop at the first failed compile or test. Do not continue. Compile is a typecheck (`tsc --noEmit`); a bundler that ignores types is not enough.
+
+## 6. Verification
+
+- Every `@terreno/*` version in the lockfile is `toVersion`.
+- `terreno_get_upgrade_guide` verification sections for notes in the range all pass.
+- App boots; auth and one write path work.
+
+## 7. Rollback
+
+On the upgrade branch, with no extra uncommitted work you need:
+
+```bash
+git status --short   # only upgrade edits
+git reset --hard HEAD
+# or restore the previous lockfile commit:
+git checkout <pre-upgrade-sha> -- package.json bun.lock
+bun install
+```
+
+If you already committed, `git revert` the upgrade commit or reset the branch to the pre-upgrade SHA before it was pushed. Do not leave a half-upgraded lockfile on `master`.

package/src/docs/versioned/57.15.0/how-to/use-syncdb-correctly.md

@@ -0,0 +1,111 @@
+# How to Use syncdb Correctly
+
+This page lists `@terreno/syncdb` behavior that a working app has to account for. Each entry says what the library does today, what breaks if you ignore it, and what to do instead. It was checked against `syncdb/src` and `api/src/sync` at 57.13.0. Several entries are library gaps rather than intended behavior. Delete an entry when its gap is fixed.
+
+Read [Local-first data](../explanation/local-first-data.md) and [Migrate from @terreno/rtk to @terreno/syncdb](migrate-rtk-to-syncdb.md) first.
+
+## Startup and snapshots
+
+### Cold start costs one round trip per round, not per stream
+
+A stream is one collection in one scope, so a user has roughly (synced collections) × (tenants they belong to) streams. Reconcile, subscribe catch-up and wipe re-bootstrap page every stream through `POST /sync/snapshot/batch`: one round trip per round, with up to 5,000 rows per response shared across the streams. Empty streams cost nothing extra. `forceResync`, and every pass against a server without the batch route, still page with one `GET /sync/snapshot` per stream, `snapshotConcurrency` streams side by side (default 6). Each stream runs one pass at a time, and a pass that purges (force resync, wipe) waits for the stream's in-flight pass to finish first.
+
+Measured with a fake HTTP channel at 150 ms latency, 13 collections and 2 workspaces (26 streams): 4.1 s to the first full reconcile when paging one stream at a time, 0.95 s at the default concurrency. In a browser with 100 collections and 10k rows, batching cut a reconnect with no changes from 101 requests to 2.
+
+| Do | Why |
+| --- | --- |
+| Sync only the collections the client reads. | Each collection adds one stream per tenant to cold start. |
+| Gate each screen on its **own** stream's bootstrap (see [No loading flag on synced reads](#no-loading-flag-on-synced-reads)), not on "sync finished". | The stream a screen needs may land after others. |
+| Don't call `forceResync()` on a hot path. | It purges and re-pages every stream. |
+| Raise `snapshotConcurrency` only if the backend can take it. | Without the batch route, each in-flight stream is one concurrent snapshot query on the server. |
+
+The startup reconcile and each collection's `sync:subscribed` catch-up both page the same streams. A catch-up queues behind a pass that started before the room join, because that pass may have missed a write. So a cold start still pages each stream twice, one pass after the other.
+
+### No loading flag on synced reads
+
+`useQuery` returns a plain array. `useListQuery` returns `{data}`. The `isPending` on `useEntity`/`useReadQuery` means an outbox write is pending, not that data is loading. An empty array before bootstrap looks the same as an empty collection, so a screen that renders its empty state from `[]` flashes "nothing here" on every cold start.
+
+The per-stream `bootstrapped` mark is the right signal, but `isStreamBootstrapped` is not exported. Read the cell directly:
+
+```typescript
+const isBootstrapped = (stream: string): boolean =>
+  syncDb.store.raw.getCell("_cursors", stream, "bootstrapped") === true;
+```
+
+Don't use the cursor (`useSyncStatus().streams`) for this. A live delta can move the cursor to the head before the snapshot below it has been paged. `useWindowQuery` (query collections only) does expose `isLoading`.
+
+A stream key is `<collection>|<scopeType>:<value>`, for example `documents|tenant:<workspaceId>`. A user with several tenants has one stream per tenant. Treat a collection as loaded only once every known stream for it is bootstrapped (`syncDb.store.getKnownStreams()`).
+
+## Writes
+
+### Mutations return an id, not an outcome
+
+`create`, `update` and `remove` from `useMutate` (and from the generated `useCreate*`/`useUpdate*`/`useDelete*` hooks) return `{mutationId, id}` synchronously. There is no promise for the server ack. The client also drops the ack's `warning`. A `warning` means a server post-hook threw after the write committed.
+
+If a screen needs to know the outcome (close a modal only once the create landed, toast a refusal), wrap the transport and HTTP channel and record ack and nack outcomes by `mutationId`. Then await that `mutationId`. Don't poll the store.
+
+### A 403 from a write halts the whole outbox
+
+The server maps 403/405 to an `unauthorized` nack and 400/404/422 to `validation`. They behave very differently:
+
+| Nack | Client behavior |
+| --- | --- |
+| `unauthorized` | The mutation is re-queued and the **whole drain stops** (auth-pause). On re-auth the same `mutationId` replays, reads the same stored nack, and pauses again. It never settles. |
+| `validation` | The mutation is marked `failed` and the drain continues. That entity's later writes stay blocked until `retryFailed({entityId})`. |
+| `conflict` | That entity's later writes stay blocked (or every write is blocked, with `haltQueueOnConflict: true`) until `resolveConflict`. |
+| `error` | Retried up to the retry budget, then handled like `validation`. |
+
+So a router hook that refuses a synced write for a business reason must throw **422**, not 403. That includes `preCreate`/`preUpdate` membership checks. Keep 403 for real auth failures.
+
+### Don't send a stale tenant field on create
+
+For a tenant-scoped collection, `enforceWriteScope` checks a client-sent scope field (for example `workspaceId`) against the user's memberships **before** `preCreate` runs. A value the user does not belong to is a 403, which halts the outbox (see above). If the field is missing or null, the check is skipped and `preCreate` can fill it in.
+
+Either omit the tenant field and let `preCreate` set it, or send it only from the currently synced row of the parent tenant, never from a persisted id that may be stale.
+
+### The local row never gets server-computed fields from the create
+
+After an ack, the client stamps the row with the ack's seq and keeps the optimistic data. The server's create delta has the same seq, so the client skips it. Whatever `preCreate`, schema defaults or hooks set on the server does not reach the local row until that row changes again or is repaired. If the delta arrives before the ack, the row is marked for repair, but repair only runs on the next `reconcile()` (reconnect, seq jump, or every 5 minutes).
+
+Do one of these:
+
+- Send every field the UI reads in the create payload, matching what the server would compute (defaults, `order`, ownership fields).
+- After the ack, patch the local row yourself.
+
+The local row's `data` is exactly what you passed. Include `_id` in the payload if anything reads `row._id`. Server-written rows carry `_id` and `id`.
+
+### A refused create leaves a phantom row
+
+When a create is nacked as `validation` (or runs out of `error` retries), the repair fetch finds no server row and only clears the repair mark. The optimistic row stays in the store with `stream: ""` and shows up in queries. Only `forceResync` purges such rows.
+
+On a refused create, tombstone the local row yourself and call `retryFailed({entityId})` so later writes to that id are released.
+
+### Conflicts are never resolved for you
+
+A `conflict` nack blocks every later write to that row, and any queued write whose args mention its id, until someone calls `client.resolveConflict({mutationId, strategy: "keepMine" | "useServer"})` (or `useConflicts().resolve`). Local edits keep applying optimistically, so the UI looks fine while nothing reaches the server.
+
+If the app has no conflict UI, run a watcher that resolves each conflict as it is recorded. Use `keepMine` for fields the user types, and `useServer` for everything else.
+
+## Server side
+
+### Write synced models one document at a time, by `_id`
+
+On a synced model, `updateMany`, `deleteMany`, `deleteOne`, `findOneAndDelete` and `bulkWrite` throw. Single-document writes by `_id` without upsert are allowed: `save()`, `updateOne`, `findOneAndUpdate`, `findByIdAndUpdate`, `replaceOne`. Delete by setting `deleted: true`, because a hard delete emits no delta.
+
+In tests, clean up with `Model.collection.deleteMany(...)`, which bypasses Mongoose.
+
+### Deltas don't apply `queryFilter`
+
+Snapshots and `/sync/entities` apply the router's `queryFilter`. Live deltas check only `permissions.read` (or RBAC) per recipient. A router that restricts visibility only through `queryFilter` leaks rows over the socket. Every synced router's `read` permission must enforce the same restriction itself.
+
+### Membership grants arrive late
+
+A user's new tenant is picked up by the socket's session revalidation sweep (`sessionRevalidationIntervalMs`, 60 s by default) or a resubscribe. The client finds the new stream on its next `reconcile()` (`reconcileIntervalMs`, 5 minutes by default, plus reconnects). Until then the new tenant's rows don't appear.
+
+When the product grants membership, push a content-free event to the user's sockets and have the client reconnect syncdb. Reconnecting resubscribes and reconciles. Grants written another way (admin, scripts) still wait for the timers.
+
+## Auth
+
+### Logging out does not wipe local data
+
+The client's own `onAuthChange` handling treats a logout as a pause and **never wipes**. A different user logging in does wipe. To clear one user's data on sign-out, set `wipeOnSignOut: true` and call `client.signOut()` explicitly when the app's user clears.