@terreno/announcements 57.20.0 → 58.0.0-beta.1

package/CHANGELOG.md

@@ -20,6 +20,99 @@ Upgrade notes for consumer action live in [`mcp-server/src/docs/upgrades/`](mcp-
 
 Unreleased changes live in [`changelog/unreleased/`](changelog/unreleased/). Add one Markdown file per feature (see that directory's README) instead of editing this section.
 
+## [58.0.0-beta.1] - 2026-11-02
+
+Upgrade note: [`mcp-server/src/docs/upgrades/58.0.0-beta.1.md`](mcp-server/src/docs/upgrades/58.0.0-beta.1.md).
+
+### Breaking
+
+- Terreno 58 targets Expo SDK 58 (`~58.0.14`), React Native `0.88.0`, and React `19.3.0`. `@terreno/ui` peers `react-native` `0.88.0`. Native catalog moves with the SDK: `react-native-gesture-handler` `~3.3.0`, `react-native-reanimated` `4.7.1` + `react-native-worklets` `0.13.0`, `react-native-screens` `~4.30.0`, `react-native-webview` `14.0.1`, `@sentry/react-native` `~8.28.0`, `@shopify/flash-list` `2.3.2`, `@shopify/react-native-skia` `2.14.0`. Rebuild dev clients and store binaries.
+- Expo Router 58: set `export const unstable_settings = {initialRouteName}` on the layout instead of passing `initialRouteName` to `<Slot>` / navigators. `SidebarNavigation` ignores the prop.
+- Expo Router 58 static rendering: a custom `app/+html.tsx` must render `headNodes` and `bodyNodes` from `useServerDocumentContext()` (`expo-router/html`), or exported pages ship without their JavaScript. `example-frontend` is updated.
+- React Native 0.88 generated types: type refs as `ViewInstance`, `TextInstance`, `ScrollViewInstance`, and `TextInputInstance` (`Box.scrollRef`, `TextField.inputRef`, `Text` `ref`).
+- `create-terreno-app` scaffolds Expo `~58.0.14`, React Native `0.88.0`, and React `19.3.0`.
+- The Terreno 58 native module baseline lands in `example-frontend` and `demo`: `@stripe/stripe-react-native` 0.81.0, `react-native-purchases` and `react-native-purchases-ui` 10.12.2, `expo-device`, `expo-crypto`, `expo-local-authentication`, `expo-system-ui`, and `expo-build-properties` (Android Kotlin 2.2.21 and `compileSdkVersion` 37 pins). Rebuild every dev client and store binary. `react-native-otp-verify` is left out because it does not support the New Architecture. The demo has a hidden **Native Modules** page that shows each module's version and whether the running binary links it. See the 58.0.0 upgrade note.
+- `TerrenoApp` turns HTTP rate limiting on by default. Omitting `rateLimit` now mounts the limiter with the memory store (auth 20 / 15 min, api 600 / 15 min). Pass `rateLimit: false` to turn it off. On Cloud Run pass `rateLimit: {trustProxy: 1}` so unauthenticated traffic keys by client IP. See the 58.0.0 upgrade note.
+- `@terreno/admin-frontend` no longer takes an RTK `api`. The `api` prop is removed from every admin component (`AdminProvider`, `AdminShellLayout`, `AdminHome`, `AdminModelList`, `AdminModelTable`, `AdminModelForm`, `AdminScreenRouter`, `ConfigurationScreen`, `DocumentStorageBrowser`, `ConsentHistory`, comms, jobs, org, consent, and announcement screens, and widget props), and admin hooks drop their `api` argument (`useAdminConfig(apiBase)`, `useAdminScripts(apiBase)`, `useAdminRoles(apiBase)`, `useConfigurationApi({basePath})`, `useDocumentStorageApi(basePath)`, `useConsentHistory(baseUrl)`, `useOrganizationsApi(basePath)`, `useCommsDashboardApi()`, `useJobsDashboardApi()`, and the `useAiObservability*Api()` hooks).
+- `useAdminApi(api, routePath, modelName)` is removed. Use `useAdminModelApi(routePath, modelName)`, which keeps the same hook names and calls the same `/admin/{routePath}` URLs through the admin fetch client. `AdminApi`, `EndpointBuilder`, and admin `injectEndpoints` are gone; `@reduxjs/toolkit` and `react-redux` are no longer peers of admin-frontend.
+- `AdminProvider` is now the required auth binding for every admin request, including ObjectId and API-only model CRUD. Cookie SPAs pass `credentials="same-origin"`; embedded apps pass `apiOrigin` and `getAuthHeaders`. Product screens that reuse admin components wrap them in `AdminProvider`. See the 58.0.0 upgrade guide.
+- Removed the legacy RTK realtime path. Use `sync` on `modelRouter` with `@terreno/syncdb` for live collection updates. `RealtimeApp`, `SyncApp`, socket auth, `sync:delta`, and admin `admin:model.changed` events are unchanged. See the 58.0.0 upgrade note.
+- `@terreno/api`: `modelRouter` no longer accepts `realtime` (now a TypeScript error), and the change stream no longer emits the `sync` websocket event. Removed `RealtimeConfig`, `RealtimeEvent`, `DocumentSubscription`, `QuerySubscription`, `registerRealtime`, `getRealtimeRegistry`, `findRegistryEntryByCollection`, `findRegistryEntryByRoutePath`, `updateRealtimeRegistryOptions`, `clearRealtimeRegistry`, `RealtimeRegistryEntry`, the query-subscription store (`addQuerySubscription`, `removeQuerySubscription`, `removeAllSocketQueries`, `getQuerySubscriptionsForCollection`, `computeQueryId`, `clearQueryStore`), and `MAX_MODEL_SUBSCRIPTIONS` / `MAX_DOCUMENT_SUBSCRIPTIONS` / `MAX_QUERY_SUBSCRIPTIONS`. Sockets no longer handle `subscribe:model`, `subscribe:document`, or `subscribe:query`.
+- `@terreno/rtk`: removed `realtimeList`, `realtimeDocument`, `setRealtimeSocket`, `getRealtimeSocket`, `useSyncConnection`, and the `RealtimeEvent` type. The rest of `@terreno/rtk` (including `useSocketConnection` and `useRealtimeDebug`) is removed in the same release; see `remove-rtk.md`.
+- Removed `@terreno/rtk` and every Redux dependency (`@reduxjs/toolkit`, `react-redux`, `redux-persist`, `@rtk-query/codegen-openapi`). `@terreno/rtk` is not published for 58. `@terreno/syncdb` is the only frontend data, request, and session layer. Follow `docs/how-to/migrate-rtk-to-syncdb.md`, which maps every removed export to its replacement, and the 58.0.0 upgrade note.
+- `@terreno/syncdb` adds `@terreno/syncdb/api` (`createApiClient`, `ApiError`), request hooks in `@terreno/syncdb/react` (`ApiClientProvider`, `useApiQuery`, `useLazyApiQuery`, `useApiMutation`, `useSocketEvent`), `@terreno/syncdb/config` (`baseUrl`, `baseWebsocketsUrl`, `appHeaders`), `@terreno/syncdb/auth` (`createBetterAuthClient`, `SessionProvider`, `useSession`, `jwtAuthAdapter`, `useJwtAuth`, token-expiry helpers), `@terreno/syncdb/flags` (`useFeatureFlags`, `useTerrenoFeatureFlags` on the sync socket), `@terreno/syncdb/app` (`useUpgradeCheck`, `hasPermission`, `canOpenAdminPage`, `installDevConsoleLogger`, `useMCPTools`), and `@terreno/syncdb/buildNumber`.
+- `terreno-syncdb-codegen --api-out` generates typed hooks for every non-synced OpenAPI operation (same names as the RTK codegen), replacing `@rtk-query/codegen-openapi`. `bun run sdk` writes `store/apiSdk.ts`.
+- `@terreno/ui` `ConsentNavigator`, `AnnouncementNavigator`, `useConsentForms`, `useSubmitConsent`, `useAnnouncements`, and `useAcknowledgeAnnouncement` take a request `client` instead of an RTK `api`.
+- `GptHistory` (`gpt/histories`) and `McpServiceToken` (`mcp/service-tokens`, read-only) are synced collections with String ids. Run the `gptHistoryStringIdsMigration` (`@terreno/ai`) and `mcpServiceTokenStringIdsMigration` (`@terreno/api`) before deploying 58 frontends.
+- `create-terreno-app`, the `terreno_bootstrap` prompt, and the `terreno_generate_screen` tool scaffold apps without Redux or `@terreno/rtk`. The terreno-mcp-local `get_rtk_state` tool, the MCP resource `terreno://docs/rtk`, and `terreno state --slice rtk` are removed; use `get_syncdb_state` and `terreno state`.
+
+### Added
+
+- `DataTable` columns size themselves when `width` is omitted. Each auto column starts at the wider of its header and its content (sampled from at most 50 rows, measured with a canvas on web and estimated on native), clamped to 80–360px, and auto columns grow to fill the table's container. Columns that set `width` keep it. `DataTableColumn.width` is now optional.
+
+### Changed
+
+- The repository's agent rules now generate with rulesync 17 (up from 9). The root rule `.rulesync/rules/00-root.md` now generates `AGENTS.md`, which Devin and other AGENTS.md readers load, in place of `.devin/rules/00-root.md`. Never edit `AGENTS.md` by hand: edit the root rule and run `bun run rules`. The examples that existed only in the old hand-edited `AGENTS.md` (syncdb and RTK SDK usage) moved into the root rule, so `CLAUDE.md`, the Cursor root rule, and Copilot instructions get them too. Links in the root rule now resolve from the repository root. Generated Copilot hooks use the portable `command` field. Generated Copilot subagents no longer list `agent/runSubagent` as their only tool, so they get every default tool. Generated skills carry their `license`, `disable-model-invocation`, and Devin `triggers` frontmatter.
+- `@terreno/syncdb/auth` `SessionProvider`: `logout()` no longer clears the session before the server answers. The session stays in the state until `authClient.signOut()` finishes (`signOutTimeoutMs`, default 10 seconds), and then it is cleared. Meanwhile the new `isSigningOut` state (`useSession().isSigningOut`) is true; `isLoading` is left alone, so a navigator gated on it keeps its screen. Before, a login screen that opened at once could find the still-live session and sign the user straight back in. A sign-out that fails or times out checks the session first. A session that is still live, or a cookie or native session the server cannot be asked about, stays signed in, and `error` is set to `SIGN_OUT_FAILED_MESSAGE` ("Couldn't sign out. Check your connection and try again."). A web bearer client, which drops its token before the request leaves, ends signed out. The global `auth/logout` action (a refused session) now ends signed out even when the sign-out request fails. With `apisToReset` (57.17.0), `logout()` purges the cache when the session clears, not when it is dispatched: a purge at dispatch refetched every mounted screen mid-sign-out, and a refetch that could not reach the server answered 401 and signed the user out even though the sign-out failed. A failed sign-out keeps both the session and the cache. The global `auth/logout` action still purges at once (only the first of several in flight) and again when the session clears. A sign-in for another user that lands while a sign-out is in flight is kept; a sign-out that started signed out asks `getSession` first, so a restore of the session it revoked is cleared. Show `selectBetterAuthIsSigningOut` on the sign-out control and `selectBetterAuthError` after a failed sign-out.
+
+### Removed
+
+- `@terreno/ui` no longer exports the `Filter` and `FilterProps` aliases deprecated in 57.7.0. Import `DropdownPanel` and `DropdownPanelProps` instead. `FilterSelectMenu`, `FilterBoolean`, `FilterAccordion`, and `FilterChangesBadge` keep their names.
+
+### Fixed
+
+- `@terreno/syncdb`: logging out while `syncDb.start()` is still running no longer loses local writes or logs errors. `start()` now resolves the web encryption key from `GET /sync/key` before it loads the store, so the flush in `stop()` never needs the network after the session has ended. A `stop()` or `signOut()` call now cancels a `start()` that is running or queued ahead of it, so the transport never connects without a session. A failed key fetch is now retried on the next save instead of failing every save for the rest of the session.
+
+## [57.21.0] - 2026-11-01
+
+Upgrade note: [`mcp-server/src/docs/upgrades/57.21.0.md`](mcp-server/src/docs/upgrades/57.21.0.md).
+
+### Breaking
+
+- The `terreno-scan` plugin is now `terreno-loop`, and its skills are renamed from `terreno-scan-*` to `terreno-loop-*`. The resident loop `terreno-scan-loop` is now `terreno-loop-run`: `/terreno-loop:run` in Claude Code, `/terreno-loop-run` in Cursor, `$terreno-loop-run` in Codex. Claude Code moves existing installs over through the marketplace `renames` entry. In Cursor and Codex, uninstall `terreno-scan` and install `terreno-loop`. Campaign state stays at `.terreno/scan/<goal>.json`, so campaigns already in progress resume.
+
+### Added
+
+- `@terreno/admin-spa` serves an MCP OAuth consent screen at `/console/oauth/consent`, so a backend with no product frontend can set `mcpOAuth.consentUrl` to `${issuer}/console/oauth/consent`. Any signed-in user can approve or deny a request with their Better Auth session; signed-out users sign in and return through the login screen's new `returnTo` parameter, which accepts only in-app paths.
+- Claude Code plugins now publish to npm with every release, as `@terreno/agent-plugin` and `@terreno/agent-plugin-loop`. A new `terreno-releases` marketplace installs them at the latest stable release. To pin one release, add `TerrenoLabs/terreno#<version>` instead. See [Install agent skills](docs/how-to/install-agent-skills.md#pick-a-channel).
+- The generated Claude plugin manifest no longer pins `version`. Before this change, plugins installed from the `TerrenoLabs/terreno` marketplace stayed on the `2.12.0` copy, because their version never changed. They now update on every commit. Run `/plugin update terreno@terreno-plugins` once to leave `2.12.0`.
+- The `terreno-planning` lifecycle plugin (2.13.0) plans e2e tests and manual regression cases in every IP:
+
+  - Grow requires `## E2E tests` and `## Regression cases` sections (either may be `None — <reason>`), read from the e2e guide at `docs/testing/e2e.md` or a `## Testing conventions` override in AGENTS.md or CLAUDE.md.
+  - Regression cases stay minimal: most features add none. A case is only for what a developer or QA must check by hand, such as push notifications, and Roast fails one that repeats an existing case.
+  - Pick writes each planned spec in the task that delivers it, and Roast runs it; a missing or failing row is `FAIL`.
+  - Brew gates on every planned spec and merges regression cases into `docs/regression/<area>.md` with the next free ID.
+  - Taste re-checks both sections after behaviour-changing fixes and renumbers regression ID collisions with `master`.
+  - `bun run check:lifecycle-skills` enforces these phrases in every stage.
+  - New `backfill-regression` skill proposes manual regression cases one area at a time and writes only the sets the human approves.
+  - A consumer opts out of manual regression suites with `Regression suites | none` in its `## Testing conventions` table.
+- The `terreno-planning` lifecycle plugin (2.14.0) grows an end-user guide with every feature:
+
+  - Every IP has a `## User guide` section listing the guide pages it adds, updates, or retires, or `None — <reason>`. Pages live in `docs/user-guide/<area>/<feature>.md`, one feature per page, with `title`, `audience`, `platforms`, and `questions` frontmatter that chat agents use to answer "how do I…" questions.
+  - Pick writes each page in the task that ships the feature, Roast checks it against the shipped screens, Brew gates on it and the index, and Taste keeps it current after fixes.
+  - A repo opts out with `| User guide | none — <reason> |` in a `## User guide conventions` table in AGENTS.md or CLAUDE.md.
+  - New `backfill-user-guide` skill drafts pages for features that shipped without one, one area at a time, and writes only the pages the human approves.
+  - `bun run check:user-guide` validates the pages and index (CI `repo-policies`); `--uncovered <app dir>` lists screens no page names.
+  - Terreno's own guide covers the example app's main features.
+- `@terreno/api`: opt-in `mcpRequestLog` on `TerrenoApp` records one metadata-only `McpRequestLog` row per MCP tool call (tool, user, credential, service token or OAuth client, duration, outcome, error class; never arguments, results, or error text), expiring after `retentionDays` (default 30).
+- `@terreno/api`: opt-in `mcpToolSettings` on `TerrenoApp` registers every MCP tool in `McpToolSetting` at startup; tools an admin switches off are hidden from `tools/list` and rejected by `tools/call`.
+- `@terreno/api`: deleting an `McpOAuthToken` row revokes its whole connection (token family) and keeps the rows. New `McpOAuthToken.revokeAllForUser` and `McpServiceToken.revokeAllForUser`.
+- `@terreno/admin-backend`: `mcpAdminModels()` adds MCP admin screens (service tokens, OAuth clients, OAuth connections, request log, tool switches), `mcpAdminStatements` for RBAC, and `mcpAdminScripts()` adds `mcp-sign-out-everywhere`. See [Manage MCP from the admin panel](docs/how-to/manage-mcp-in-admin.md).
+- Docs: [Expose an MCP server safely](docs/how-to/expose-mcp-server-safely.md) (OAuth, service tokens, Cloudflare Tunnel, Access) and the `bootstrap-mcp-server` skill for a single-binary MCP server with the admin console embedded.
+- Every workspace package has a real-process smoke test and an e2e page:
+
+  - Each package's `e2e/smoke.ts` (or `smoke.spec.ts` for browser packages) runs its built output through its public entry: a server on a real port, the compiled binary, or a page in Chromium. `bun run --cwd <package> smoke` runs one; `bun run smoke` runs them all and prints each package's time. The CircleCI `smoke` job runs them on every package change.
+  - `@terreno/test` adds the smoke helpers `smokeMongoUri()`, `spawnUntilReady()`, `spawnExampleBackend()`, `runBin()`, and `freePort()`.
+  - The [E2E testing guide](docs/testing/e2e.md) explains the test tiers and links one page per package under `docs/testing/e2e/`.
+  - Manual regression cases live in `docs/regression/<area>.md`, one file per area, and `bun run check:regression-suites` validates them.
+  - example-frontend's smoke serves a web export that `bun run --cwd example-frontend export:smoke` builds once with a placeholder API URL; the smoke swaps in a `freePort()` API URL as it serves the bundle, so the 30 s smoke no longer rebuilds the export. `spawnUntilReady()` takes `stopGraceMs`, and `spawnExampleBackend()` stops example-backend after 0.5 s instead of 5 s.
+- Every workspace package has a `typecheck` script that runs `tsc` over source and test files through a new `tsconfig.typecheck.json`. Root `bun run lint` ends with `bun run typecheck`, and CircleCI runs it in a new `typecheck` job. Test files that had type errors were fixed.
+
+### Changed
+
+- `@terreno/api`: deleting an `McpOAuthToken` row with document or query `deleteOne` now revokes that row's whole token family (the connection) and keeps the rows instead of removing one pair. `deleteMany` is unchanged.
+- `@terreno/ui`: new `theme.field` tokens (`background`, `backgroundDisabled`, `border`, `borderFocus`, `borderError`, `borderDisabled`) style form inputs. `TextField`, `SelectField`, `DateTimeField`, `HeightField`, and `OtpField` read them instead of `surface.base` and `border.dark`. Defaults equal the old colors, but overriding `surface` or `border` no longer recolors those fields; use `setTheme({field: ...})`.
+
 ## [57.20.0] - 2026-10-30
 
 Upgrade note: [`mcp-server/src/docs/upgrades/57.20.0.md`](mcp-server/src/docs/upgrades/57.20.0.md).

package/biome.jsonc

@@ -6,6 +6,7 @@
       "package.json",
       "src/**/*.ts",
       "src/**/*.tsx",
+      "e2e/**/*.ts",
       "!!**/node_modules",
       "!!node_modules",
       "!!**/dist",

package/dist/announcementsApp.js

@@ -74,6 +74,40 @@ const requireVisibleAnnouncement = async ({ announcement, isStaff, matchAudience
     }
     return announcement;
 };
+/** `AnnouncementPublic`: the shape user-facing announcement routes return. */
+const announcementPublicOpenApiSchema = {
+    properties: {
+        body: { description: "Markdown body", type: "string" },
+        displayMode: { enum: ["modal", "banner", "feed"], type: "string" },
+        id: { type: "string" },
+        primaryAction: {
+            properties: { label: { type: "string" }, url: { type: "string" } },
+            required: ["label", "url"],
+            type: "object",
+        },
+        priority: { type: "number" },
+        publishedAt: { format: "date-time", type: "string" },
+        requiresAcknowledgement: { type: "boolean" },
+        title: { type: "string" },
+        version: { type: "number" },
+    },
+    required: [
+        "body",
+        "displayMode",
+        "id",
+        "priority",
+        "requiresAcknowledgement",
+        "title",
+        "version",
+    ],
+    type: "object",
+};
+const platformQueryParameter = {
+    enum: ["ios", "android", "web"],
+    type: "string",
+};
+const PLATFORM_QUERY_DESCRIPTION = "Client platform. Defaults from the User-Agent, then web.";
+const VERSION_QUERY_DESCRIPTION = "Client build number, compared with each announcement's minimum.";
 class AnnouncementsApp {
     options;
     constructor(options) {
@@ -205,8 +239,35 @@ class AnnouncementsApp {
             queryFields: ["status", "priority", "title"],
             sort: "-priority,-publishedAt",
         };
+        const routeOpenApi = openApi ? { openApi: openApi } : undefined;
+        // User routes: documentation only. Validation stays off; the handlers parse their own input.
+        const userRouteDocs = () => (0, api_1.createOpenApiBuilder)(routeOpenApi ?? {})
+            .withTags(["announcements"])
+            .withValidation({ enabled: false });
+        const recordedResponse = (field) => ({
+            data: { properties: { [field]: { type: "boolean" } }, required: [field], type: "object" },
+        });
         const userRouter = (0, express_1.Router)();
-        userRouter.get("/pending", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(async (req, res) => {
+        userRouter.get("/pending", (0, api_1.authenticateMiddleware)(), userRouteDocs()
+            .withSummary("Get the next announcement the current user should see")
+            .withQueryParameter("platform", platformQueryParameter, {
+            description: PLATFORM_QUERY_DESCRIPTION,
+        })
+            .withQueryParameter("version", { type: "integer" }, { description: VERSION_QUERY_DESCRIPTION })
+            .withResponse(200, {
+            data: {
+                properties: {
+                    current: { ...announcementPublicOpenApiSchema, nullable: true },
+                    remainingCount: {
+                        description: "Pending announcements after the current one",
+                        type: "number",
+                    },
+                },
+                required: ["current", "remainingCount"],
+                type: "object",
+            },
+        }, { required: ["data"] })
+            .build(), (0, api_1.asyncHandler)(async (req, res) => {
             const user = req.user;
             if (!user) {
                 throw new api_1.APIError({ status: 401, title: "Authentication required" });
@@ -250,7 +311,21 @@ class AnnouncementsApp {
             });
             return res.json({ data: { current, remainingCount } });
         }));
-        userRouter.get("/feed", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(async (req, res) => {
+        userRouter.get("/feed", (0, api_1.authenticateMiddleware)(), userRouteDocs()
+            .withSummary("List announcements visible to the current user")
+            .withQueryParameter("platform", platformQueryParameter, {
+            description: PLATFORM_QUERY_DESCRIPTION,
+        })
+            .withQueryParameter("version", { type: "integer" }, { description: VERSION_QUERY_DESCRIPTION })
+            .withQueryParameter("limit", { type: "integer" }, { description: "Page size, 1 to 100 (default 20)" })
+            .withQueryParameter("page", { type: "integer" }, { description: "Page number, from 1" })
+            .withResponse(200, {
+            data: { items: announcementPublicOpenApiSchema, type: "array" },
+            more: { description: "Whether a later page has more announcements", type: "boolean" },
+            page: { type: "number" },
+            total: { description: "Visible announcements across all pages", type: "number" },
+        }, { required: ["data", "more", "page", "total"] })
+            .build(), (0, api_1.asyncHandler)(async (req, res) => {
             const user = req.user;
             if (!user) {
                 throw new api_1.APIError({ status: 401, title: "Authentication required" });
@@ -291,11 +366,20 @@ class AnnouncementsApp {
                 .map((announcement) => (0, announcement_1.toAnnouncementPublic)(announcement, defaultAcknowledgementPolicy));
             return res.json({
                 data: pageItems,
+                more: start + limit < sorted.length,
                 page,
                 total: sorted.length,
             });
         }));
-        userRouter.post("/:id/acknowledge", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(async (req, res) => {
+        userRouter.post("/:id/acknowledge", (0, api_1.authenticateMiddleware)(), userRouteDocs()
+            .withSummary("Acknowledge an announcement for the current user")
+            .withPathParameter("id", { type: "string" }, { description: "Announcement id" })
+            .withQueryParameter("platform", platformQueryParameter, {
+            description: PLATFORM_QUERY_DESCRIPTION,
+        })
+            .withQueryParameter("version", { type: "integer" }, { description: VERSION_QUERY_DESCRIPTION })
+            .withResponse(200, recordedResponse("acknowledged"), { required: ["data"] })
+            .build(), (0, api_1.asyncHandler)(async (req, res) => {
             const user = req.user;
             if (!user) {
                 throw new api_1.APIError({ status: 401, title: "Authentication required" });
@@ -324,7 +408,16 @@ class AnnouncementsApp {
             }
             return res.json({ data: { acknowledged: true } });
         }));
-        userRouter.post("/:id/impression", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(async (req, res) => {
+        userRouter.post("/:id/impression", (0, api_1.authenticateMiddleware)(), userRouteDocs()
+            .withSummary("Record that the current user saw an announcement")
+            .withPathParameter("id", { type: "string" }, { description: "Announcement id" })
+            .withQueryParameter("platform", platformQueryParameter, {
+            description: "Used when the body has no platform. Defaults from the User-Agent.",
+        })
+            .withQueryParameter("version", { type: "integer" }, { description: VERSION_QUERY_DESCRIPTION })
+            .withRequestBody({ platform: platformQueryParameter }, { required: false })
+            .withResponse(200, recordedResponse("recorded"), { required: ["data"] })
+            .build(), (0, api_1.asyncHandler)(async (req, res) => {
             const user = req.user;
             if (!user) {
                 throw new api_1.APIError({ status: 401, title: "Authentication required" });
@@ -352,7 +445,19 @@ class AnnouncementsApp {
             });
             return res.json({ data: { recorded: true } });
         }));
-        userRouter.post("/:id/click", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(async (req, res) => {
+        userRouter.post("/:id/click", (0, api_1.authenticateMiddleware)(), userRouteDocs()
+            .withSummary("Record that the current user clicked an announcement's primary action")
+            .withPathParameter("id", { type: "string" }, { description: "Announcement id" })
+            .withQueryParameter("platform", platformQueryParameter, {
+            description: "Used when the body has no platform. Defaults from the User-Agent.",
+        })
+            .withQueryParameter("version", { type: "integer" }, { description: VERSION_QUERY_DESCRIPTION })
+            .withRequestBody({
+            action: { enum: ["primaryAction"], required: true, type: "string" },
+            platform: platformQueryParameter,
+        })
+            .withResponse(200, recordedResponse("recorded"), { required: ["data"] })
+            .build(), (0, api_1.asyncHandler)(async (req, res) => {
             const user = req.user;
             if (!user) {
                 throw new api_1.APIError({ status: 401, title: "Authentication required" });
@@ -386,7 +491,6 @@ class AnnouncementsApp {
             return res.json({ data: { recorded: true } });
         }));
         const adminRouter = (0, express_1.Router)();
-        const routeOpenApi = openApi ? { openApi: openApi } : undefined;
         adminRouter.get("/config", [
             (0, api_1.authenticateMiddleware)(),
             ...(routeOpenApi

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { PermissionMethod } from "@terreno/api";
+import type { FindExactlyOnePlugin, FindOneOrNonePlugin, PermissionMethod } from "@terreno/api";
 import type { Model, Types } from "mongoose";
 export type AnnouncementStatus = "draft" | "published" | "archived";
 export type AnnouncementPlatform = "ios" | "android" | "web";
@@ -39,7 +39,7 @@ export interface AnnouncementDocument {
     created: Date;
     updated: Date;
 }
-export type AnnouncementModel = Model<AnnouncementDocument>;
+export type AnnouncementModel = Model<AnnouncementDocument> & FindExactlyOnePlugin<AnnouncementDocument> & FindOneOrNonePlugin<AnnouncementDocument>;
 export interface AnnouncementAcknowledgementDocument {
     _id: Types.ObjectId;
     userId: Types.ObjectId;

package/e2e/smoke.ts

@@ -0,0 +1,188 @@
+/**
+ * Real-process smoke for @terreno/announcements. Run `bun e2e/smoke.ts` after `bun run compile`.
+ *
+ * The smoke re-runs this file with `serve` as a child process: a minimal TerrenoApp from the
+ * compiled `@terreno/api` with the compiled `AnnouncementsApp` registered, on a free port, against
+ * `smokeMongoUri()`. The parent then checks over real HTTP that a release pipeline holding the
+ * upload token can import and publish an announcement, and that a newly signed-up user sees it
+ * in their feed. Exits non-zero on the first failed check.
+ */
+import {
+  freePort,
+  type SpawnedProcess,
+  smokeMongoUri,
+  spawnUntilReady,
+  stopSmokeMongo,
+} from "@terreno/test";
+import type express from "express";
+import {DateTime} from "luxon";
+import type {Schema} from "mongoose";
+
+const SERVE_ARG = "serve";
+const UPLOAD_TOKEN = "announcements-smoke-upload-token";
+const ANNOUNCEMENT_TITLE = "Smoke announcement";
+
+interface ImportResult {
+  announcements: Array<{id: string; status: string}>;
+  published: number;
+}
+
+interface FeedItem {
+  id: string;
+  title: string;
+}
+
+/**
+ * Child: the compiled API with auth, the compiled announcements plugin, and a health plugin.
+ * Both packages are imported here, not at the top, so the parent process never loads them.
+ */
+const serve = async (): Promise<void> => {
+  const {createdUpdatedPlugin, logger, TerrenoApp} = await import("@terreno/api");
+  const {AnnouncementsApp} = await import("@terreno/announcements");
+  const {default: mongoose} = await import("mongoose");
+  const {default: passportLocalMongoose} = await import("passport-local-mongoose");
+
+  const userSchema = new mongoose.Schema({
+    admin: {default: false, description: "Whether the user is an admin", type: Boolean},
+    email: {description: "Sign-in email", type: String},
+    name: {description: "Display name", type: String},
+  });
+  userSchema.plugin(passportLocalMongoose as unknown as (schema: Schema, options: object) => void, {
+    usernameCaseInsensitive: true,
+    usernameField: "email",
+  });
+  userSchema.plugin(createdUpdatedPlugin);
+  const User = mongoose.model("User", userSchema);
+
+  const healthPlugin = {
+    register: (app: express.Application): void => {
+      app.get("/health", (_req, res) => {
+        res.json({healthy: mongoose.connection.readyState === 1});
+      });
+    },
+  };
+
+  await mongoose.connect(process.env.MONGO_URI as string);
+  const app = new TerrenoApp({
+    loggingOptions: {logRequests: false},
+    userModel: User as unknown as ConstructorParameters<typeof TerrenoApp>[0]["userModel"],
+  })
+    .register(new AnnouncementsApp({uploadToken: process.env.ANNOUNCEMENTS_UPLOAD_TOKEN}))
+    .register(healthPlugin);
+  app.start();
+  await app.whenReady();
+  logger.info(`[announcementsSmoke] serving on port ${process.env.PORT}`);
+};
+
+const expectStatus = async (res: Response, status: number, step: string): Promise<unknown> => {
+  const body = await res.text();
+  if (res.status !== status) {
+    throw new Error(`${step}: expected ${status}, got ${res.status}: ${body}`);
+  }
+  return body ? JSON.parse(body) : undefined;
+};
+
+const bearer = (token: string): Record<string, string> => ({
+  Authorization: `Bearer ${token}`,
+  "Content-Type": "application/json",
+});
+
+/** Parent: boots the child and walks the publish-to-feed path over HTTP. */
+const run = async (): Promise<void> => {
+  const startedAt = DateTime.now();
+  const port = await freePort();
+  const baseUrl = `http://127.0.0.1:${port}`;
+  let server: SpawnedProcess | undefined;
+
+  try {
+    server = await spawnUntilReady({
+      cmd: [process.execPath, __filename, SERVE_ARG],
+      env: {
+        ANNOUNCEMENTS_UPLOAD_TOKEN: UPLOAD_TOKEN,
+        MONGO_URI: await smokeMongoUri({databaseName: "announcementsSmoke"}),
+        PORT: String(port),
+        REFRESH_TOKEN_SECRET: "announcements-smoke-refresh-secret",
+        SESSION_SECRET: "announcements-smoke-session-secret",
+        TOKEN_ISSUER: "announcements-smoke",
+        TOKEN_SECRET: "announcements-smoke-token-secret",
+      },
+      timeoutMs: 30000,
+      url: `${baseUrl}/health`,
+    });
+
+    const imported = (await expectStatus(
+      await fetch(`${baseUrl}/announcements/import-release`, {
+        body: JSON.stringify({
+          announcements: [
+            {body: "Smoke test body.", slug: "smoke-announcement", title: ANNOUNCEMENT_TITLE},
+          ],
+          publish: true,
+          release: {product: "announcements-smoke", version: String(startedAt.toMillis())},
+        }),
+        headers: bearer(UPLOAD_TOKEN),
+        method: "POST",
+      }),
+      200,
+      "POST /announcements/import-release"
+    )) as {data: ImportResult};
+    const announcement = imported.data.announcements[0];
+    if (imported.data.published !== 1 || announcement?.status !== "published") {
+      throw new Error(
+        `POST /announcements/import-release: expected one published announcement, got ${JSON.stringify(imported.data)}`
+      );
+    }
+    console.info("✅ POST /announcements/import-release publishes an announcement");
+
+    const signup = (await expectStatus(
+      await fetch(`${baseUrl}/auth/signup`, {
+        body: JSON.stringify({
+          email: `announcements-smoke-${startedAt.toMillis()}@example.com`,
+          password: "announcements-smoke-password-1",
+        }),
+        headers: {"Content-Type": "application/json"},
+        method: "POST",
+      }),
+      200,
+      "POST /auth/signup"
+    )) as {data: {token: string}};
+    console.info("✅ POST /auth/signup signs in a user");
+
+    const feed = (await expectStatus(
+      await fetch(`${baseUrl}/announcements/feed?platform=web`, {
+        headers: bearer(signup.data.token),
+      }),
+      200,
+      "GET /announcements/feed"
+    )) as {data: FeedItem[]};
+    const item = feed.data.find((entry) => entry.id === announcement.id);
+    if (item?.title !== ANNOUNCEMENT_TITLE) {
+      throw new Error(
+        `GET /announcements/feed: the published announcement is missing: ${JSON.stringify(feed.data)}`
+      );
+    }
+    console.info("✅ GET /announcements/feed lists it for the user");
+  } catch (error: unknown) {
+    if (server) {
+      console.error(`--- server output ---\n${server.output()}`);
+    }
+    throw error;
+  } finally {
+    await server?.stop();
+    await stopSmokeMongo();
+  }
+
+  console.info(`announcements smoke passed in ${DateTime.now().diff(startedAt).toMillis()} ms`);
+};
+
+const main = process.argv[2] === SERVE_ARG ? serve : run;
+main().then(
+  () => {
+    if (main === run) {
+      process.exit(0);
+    }
+  },
+  (error: unknown) => {
+    console.error(`❌ ${error instanceof Error ? error.message : String(error)}`);
+    process.exit(1);
+  }
+);

package/package.json

@@ -4,14 +4,14 @@
     "url": "https://github.com/TerrenoLabs/terreno/issues"
   },
   "dependencies": {
-    "@terreno/api": "57.20.0",
+    "@terreno/api": "58.0.0-beta.1",
     "express": "^5.2.1",
     "luxon": "^3.7.2"
   },
   "description": "In-app product update announcements plugin for @terreno/api — part of Terreno, the batteries-included TypeScript framework for universal apps.",
   "devDependencies": {
     "@biomejs/biome": "^2.3.6",
-    "@terreno/test": "57.20.0",
+    "@terreno/test": "58.0.0-beta.1",
     "@types/bun": "^1.4.0",
     "@types/express": "^5.0.6",
     "@types/supertest": "^7.2.0",
@@ -45,13 +45,15 @@
     "compile": "bun tsc",
     "compile:watch": "bun tsc -w",
     "dev": "bun tsc -w",
-    "lint": "biome check ./src",
-    "lint:fix": "biome check --write ./src",
+    "lint": "biome check ./src ./e2e",
+    "lint:fix": "biome check --write ./src ./e2e",
+    "smoke": "bun e2e/smoke.ts",
     "test": "bun test",
     "test:agent": "AGENT=1 bun test --only-failures",
     "test:ci": "bun test",
-    "test:coverage": "bun run ../scripts/check-coverage.ts"
+    "test:coverage": "bun run ../scripts/check-coverage.ts",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
   },
   "types": "dist/index.d.ts",
-  "version": "57.20.0"
+  "version": "58.0.0-beta.1"
 }

package/src/announcementsApp.ts

@@ -9,6 +9,7 @@ import {
   type ModelRouterOptions,
   modelRouter,
   type OpenApiMiddleware,
+  type OpenApiSchemaProperty,
   type PermissionMethod,
   Permissions,
   type TerrenoPlugin,
@@ -141,6 +142,43 @@ const requireVisibleAnnouncement = async ({
   return announcement;
 };
 
+/** `AnnouncementPublic`: the shape user-facing announcement routes return. */
+const announcementPublicOpenApiSchema: OpenApiSchemaProperty = {
+  properties: {
+    body: {description: "Markdown body", type: "string"},
+    displayMode: {enum: ["modal", "banner", "feed"], type: "string"},
+    id: {type: "string"},
+    primaryAction: {
+      properties: {label: {type: "string"}, url: {type: "string"}},
+      required: ["label", "url"],
+      type: "object",
+    },
+    priority: {type: "number"},
+    publishedAt: {format: "date-time", type: "string"},
+    requiresAcknowledgement: {type: "boolean"},
+    title: {type: "string"},
+    version: {type: "number"},
+  },
+  required: [
+    "body",
+    "displayMode",
+    "id",
+    "priority",
+    "requiresAcknowledgement",
+    "title",
+    "version",
+  ],
+  type: "object",
+};
+
+const platformQueryParameter: OpenApiSchemaProperty = {
+  enum: ["ios", "android", "web"],
+  type: "string",
+};
+
+const PLATFORM_QUERY_DESCRIPTION = "Client platform. Defaults from the User-Agent, then web.";
+const VERSION_QUERY_DESCRIPTION = "Client build number, compared with each announcement's minimum.";
+
 export class AnnouncementsApp implements TerrenoPlugin {
   private options: AnnouncementsOptions;
 
@@ -283,11 +321,45 @@ export class AnnouncementsApp implements TerrenoPlugin {
       sort: "-priority,-publishedAt",
     };
 
+    const routeOpenApi = openApi ? {openApi: openApi as OpenApiMiddleware} : undefined;
+    // User routes: documentation only. Validation stays off; the handlers parse their own input.
+    const userRouteDocs = (): ReturnType<typeof createOpenApiBuilder> =>
+      createOpenApiBuilder(routeOpenApi ?? {})
+        .withTags(["announcements"])
+        .withValidation({enabled: false});
+    const recordedResponse = (field: string): Record<string, OpenApiSchemaProperty> => ({
+      data: {properties: {[field]: {type: "boolean"}}, required: [field], type: "object"},
+    });
+
     const userRouter = Router();
 
     userRouter.get(
       "/pending",
       authenticateMiddleware(),
+      userRouteDocs()
+        .withSummary("Get the next announcement the current user should see")
+        .withQueryParameter("platform", platformQueryParameter, {
+          description: PLATFORM_QUERY_DESCRIPTION,
+        })
+        .withQueryParameter("version", {type: "integer"}, {description: VERSION_QUERY_DESCRIPTION})
+        .withResponse(
+          200,
+          {
+            data: {
+              properties: {
+                current: {...announcementPublicOpenApiSchema, nullable: true},
+                remainingCount: {
+                  description: "Pending announcements after the current one",
+                  type: "number",
+                },
+              },
+              required: ["current", "remainingCount"],
+              type: "object",
+            },
+          },
+          {required: ["data"]}
+        )
+        .build(),
       asyncHandler(async (req: Request, res: Response) => {
         const user = req.user;
         if (!user) {
@@ -349,6 +421,29 @@ export class AnnouncementsApp implements TerrenoPlugin {
     userRouter.get(
       "/feed",
       authenticateMiddleware(),
+      userRouteDocs()
+        .withSummary("List announcements visible to the current user")
+        .withQueryParameter("platform", platformQueryParameter, {
+          description: PLATFORM_QUERY_DESCRIPTION,
+        })
+        .withQueryParameter("version", {type: "integer"}, {description: VERSION_QUERY_DESCRIPTION})
+        .withQueryParameter(
+          "limit",
+          {type: "integer"},
+          {description: "Page size, 1 to 100 (default 20)"}
+        )
+        .withQueryParameter("page", {type: "integer"}, {description: "Page number, from 1"})
+        .withResponse(
+          200,
+          {
+            data: {items: announcementPublicOpenApiSchema, type: "array"},
+            more: {description: "Whether a later page has more announcements", type: "boolean"},
+            page: {type: "number"},
+            total: {description: "Visible announcements across all pages", type: "number"},
+          },
+          {required: ["data", "more", "page", "total"]}
+        )
+        .build(),
       asyncHandler(async (req: Request, res: Response) => {
         const user = req.user;
         if (!user) {
@@ -397,6 +492,7 @@ export class AnnouncementsApp implements TerrenoPlugin {
 
         return res.json({
           data: pageItems,
+          more: start + limit < sorted.length,
           page,
           total: sorted.length,
         });
@@ -406,6 +502,15 @@ export class AnnouncementsApp implements TerrenoPlugin {
     userRouter.post(
       "/:id/acknowledge",
       authenticateMiddleware(),
+      userRouteDocs()
+        .withSummary("Acknowledge an announcement for the current user")
+        .withPathParameter("id", {type: "string"}, {description: "Announcement id"})
+        .withQueryParameter("platform", platformQueryParameter, {
+          description: PLATFORM_QUERY_DESCRIPTION,
+        })
+        .withQueryParameter("version", {type: "integer"}, {description: VERSION_QUERY_DESCRIPTION})
+        .withResponse(200, recordedResponse("acknowledged"), {required: ["data"]})
+        .build(),
       asyncHandler(async (req: Request, res: Response) => {
         const user = req.user;
         if (!user) {
@@ -444,6 +549,16 @@ export class AnnouncementsApp implements TerrenoPlugin {
     userRouter.post(
       "/:id/impression",
       authenticateMiddleware(),
+      userRouteDocs()
+        .withSummary("Record that the current user saw an announcement")
+        .withPathParameter("id", {type: "string"}, {description: "Announcement id"})
+        .withQueryParameter("platform", platformQueryParameter, {
+          description: "Used when the body has no platform. Defaults from the User-Agent.",
+        })
+        .withQueryParameter("version", {type: "integer"}, {description: VERSION_QUERY_DESCRIPTION})
+        .withRequestBody({platform: platformQueryParameter}, {required: false})
+        .withResponse(200, recordedResponse("recorded"), {required: ["data"]})
+        .build(),
       asyncHandler(async (req: Request, res: Response) => {
         const user = req.user;
         if (!user) {
@@ -480,6 +595,19 @@ export class AnnouncementsApp implements TerrenoPlugin {
     userRouter.post(
       "/:id/click",
       authenticateMiddleware(),
+      userRouteDocs()
+        .withSummary("Record that the current user clicked an announcement's primary action")
+        .withPathParameter("id", {type: "string"}, {description: "Announcement id"})
+        .withQueryParameter("platform", platformQueryParameter, {
+          description: "Used when the body has no platform. Defaults from the User-Agent.",
+        })
+        .withQueryParameter("version", {type: "integer"}, {description: VERSION_QUERY_DESCRIPTION})
+        .withRequestBody({
+          action: {enum: ["primaryAction"], required: true, type: "string"},
+          platform: platformQueryParameter,
+        })
+        .withResponse(200, recordedResponse("recorded"), {required: ["data"]})
+        .build(),
       asyncHandler(async (req: Request, res: Response) => {
         const user = req.user;
         if (!user) {
@@ -521,7 +649,6 @@ export class AnnouncementsApp implements TerrenoPlugin {
     );
 
     const adminRouter = Router();
-    const routeOpenApi = openApi ? {openApi: openApi as OpenApiMiddleware} : undefined;
 
     adminRouter.get(
       "/config",

package/src/tests/openApi.test.ts

@@ -0,0 +1,248 @@
+/** Verifies `/openapi.json` documents the user-facing announcement routes. */
+import {afterEach, beforeEach, describe, expect, it} from "bun:test";
+import {TerrenoApp, type UserModel as UserModelType} from "@terreno/api";
+import {
+  authAsUser,
+  expectDocumentedResponse,
+  type OpenApiResponseSpec,
+  setupDb,
+  UserModel,
+} from "@terreno/api/testing";
+import type express from "express";
+import {DateTime} from "luxon";
+import supertest from "supertest";
+import {AnnouncementsApp} from "../announcementsApp";
+import {Announcement} from "../models/announcement";
+import {AnnouncementAcknowledgement} from "../models/announcementAcknowledgement";
+import {AnnouncementClickEvent} from "../models/announcementClickEvent";
+import {AnnouncementImpression} from "../models/announcementImpression";
+
+interface SchemaNode {
+  enum?: string[];
+  items?: SchemaNode;
+  nullable?: boolean;
+  properties?: Record<string, SchemaNode>;
+  required?: string[];
+  type?: string;
+}
+
+interface Operation {
+  parameters?: {in: string; name: string; schema: SchemaNode}[];
+  requestBody?: {content: Record<string, {schema: SchemaNode}>; required?: boolean};
+  responses: Record<string, {content?: Record<string, {schema: SchemaNode}>}>;
+  tags?: string[];
+}
+
+const buildApp = (): express.Application =>
+  new TerrenoApp({
+    rateLimit: false,
+    skipListen: true,
+    userModel: UserModel as unknown as UserModelType,
+  })
+    .register(new AnnouncementsApp())
+    .build();
+
+const response200 = (operation: Operation | undefined): SchemaNode | undefined =>
+  operation?.responses["200"]?.content?.["application/json"]?.schema;
+
+const parameterNames = (operation: Operation | undefined): string[] =>
+  (operation?.parameters ?? []).map((parameter) => `${parameter.in}:${parameter.name}`).sort();
+
+const clearAnnouncements = async (): Promise<void> => {
+  await Announcement.deleteMany({});
+  await AnnouncementAcknowledgement.deleteMany({});
+  await AnnouncementImpression.deleteMany({});
+  await AnnouncementClickEvent.deleteMany({});
+};
+
+describe("AnnouncementsApp OpenAPI", () => {
+  let app: express.Application;
+  let paths: Record<string, Record<string, Operation>>;
+
+  beforeEach(async () => {
+    await setupDb();
+    await clearAnnouncements();
+    app = buildApp();
+    const res = await supertest(app).get("/openapi.json").expect(200);
+    paths = res.body.paths;
+  });
+
+  afterEach(async () => {
+    await clearAnnouncements();
+  });
+
+  it("documents GET /announcements/pending", () => {
+    const operation = paths["/announcements/pending"]?.get;
+    expect(operation?.tags).toEqual(["announcements"]);
+    expect(parameterNames(operation)).toEqual(["query:platform", "query:version"]);
+    const body = response200(operation);
+    expect(body?.required).toEqual(["data"]);
+    const current = body?.properties?.data?.properties?.current;
+    expect(current?.nullable).toBe(true);
+    expect(current?.properties?.displayMode?.enum).toEqual(["modal", "banner", "feed"]);
+    expect(body?.properties?.data?.properties?.remainingCount?.type).toBe("number");
+  });
+
+  it("documents GET /announcements/feed with its pagination fields", () => {
+    const operation = paths["/announcements/feed"]?.get;
+    expect(parameterNames(operation)).toEqual([
+      "query:limit",
+      "query:page",
+      "query:platform",
+      "query:version",
+    ]);
+    const body = response200(operation);
+    expect(body?.required).toEqual(["data", "more", "page", "total"]);
+    expect(body?.properties?.more?.type).toBe("boolean");
+    expect(body?.properties?.data?.type).toBe("array");
+    expect(body?.properties?.data?.items?.properties?.id?.type).toBe("string");
+    expect(body?.properties?.data?.items?.nullable).toBeUndefined();
+  });
+
+  it("documents the acknowledge, impression, and click actions", () => {
+    const acknowledge = paths["/announcements/{id}/acknowledge"]?.post;
+    expect(parameterNames(acknowledge)).toEqual(["path:id", "query:platform", "query:version"]);
+    expect(acknowledge?.requestBody).toBeUndefined();
+    expect(response200(acknowledge)?.properties?.data?.properties?.acknowledged?.type).toBe(
+      "boolean"
+    );
+
+    const impression = paths["/announcements/{id}/impression"]?.post;
+    expect(parameterNames(impression)).toEqual(["path:id", "query:platform", "query:version"]);
+    expect(impression?.requestBody?.required).toBe(false);
+    expect(
+      impression?.requestBody?.content["application/json"]?.schema.properties?.platform?.enum
+    ).toEqual(["ios", "android", "web"]);
+    expect(response200(impression)?.properties?.data?.properties?.recorded?.type).toBe("boolean");
+
+    const click = paths["/announcements/{id}/click"]?.post;
+    const clickBody = click?.requestBody?.content["application/json"]?.schema;
+    expect(click?.requestBody?.required).toBe(true);
+    expect(clickBody?.required).toEqual(["action"]);
+    expect(clickBody?.properties?.action?.enum).toEqual(["primaryAction"]);
+    expect(response200(click)?.properties?.data?.required).toEqual(["recorded"]);
+  });
+
+  it("documents every field pending and feed return", async () => {
+    await Announcement.create({
+      body: "Body",
+      primaryAction: {label: "Open", url: "https://example.com"},
+      publishedAt: DateTime.utc().minus({minutes: 1}).toJSDate(),
+      status: "published",
+      title: "Documented",
+    });
+    const agent = await authAsUser(app, "notAdmin");
+    const announcementProperties = Object.keys(
+      response200(paths["/announcements/feed"]?.get)?.properties?.data?.items?.properties ?? {}
+    );
+
+    const pending = await agent.get("/announcements/pending?platform=web").expect(200);
+    expect(announcementProperties).toEqual(
+      expect.arrayContaining(Object.keys(pending.body.data.current))
+    );
+    const pendingDataFields = Object.keys(
+      response200(paths["/announcements/pending"]?.get)?.properties?.data?.properties ?? {}
+    );
+    expect(pendingDataFields).toEqual(expect.arrayContaining(Object.keys(pending.body.data)));
+
+    const feed = await agent.get("/announcements/feed?platform=web").expect(200);
+    expect(announcementProperties).toEqual(expect.arrayContaining(Object.keys(feed.body.data[0])));
+    const feedFields = Object.keys(
+      response200(paths["/announcements/feed"]?.get)?.properties ?? {}
+    );
+    expect([...feedFields, "requestId"]).toEqual(expect.arrayContaining(Object.keys(feed.body)));
+  });
+
+  it("returns bodies that match the documented schemas for every user route", async () => {
+    const spec = (await supertest(app).get("/openapi.json").expect(200))
+      .body as OpenApiResponseSpec;
+    const agent = await authAsUser(app, "notAdmin");
+    const empty = await agent.get("/announcements/pending?platform=web").expect(200);
+    expect(empty.body.data.current).toBeNull();
+    expectDocumentedResponse({
+      method: "get",
+      path: "/announcements/pending",
+      response: empty,
+      spec,
+    });
+
+    const publishedAt = DateTime.utc().minus({minutes: 1}).toJSDate();
+    const withAction = await Announcement.create({
+      acknowledgementPolicy: "required",
+      body: "Body",
+      primaryAction: {label: "Open", url: "https://example.com"},
+      publishedAt,
+      status: "published",
+      title: "With action",
+    });
+    await Announcement.create({body: "Body", publishedAt, status: "published", title: "Plain"});
+    const id = withAction._id.toString();
+
+    const pending = await agent.get("/announcements/pending?platform=web").expect(200);
+    expectDocumentedResponse({
+      method: "get",
+      path: "/announcements/pending",
+      response: pending,
+      spec,
+    });
+
+    const impression = await agent
+      .post(`/announcements/${id}/impression`)
+      .send({platform: "web"})
+      .expect(200);
+    expectDocumentedResponse({
+      method: "post",
+      path: "/announcements/{id}/impression",
+      response: impression,
+      spec,
+    });
+
+    const click = await agent
+      .post(`/announcements/${id}/click?platform=web`)
+      .send({action: "primaryAction"})
+      .expect(200);
+    expectDocumentedResponse({
+      method: "post",
+      path: "/announcements/{id}/click",
+      response: click,
+      spec,
+    });
+
+    const acknowledge = await agent
+      .post(`/announcements/${id}/acknowledge?platform=web`)
+      .expect(200);
+    expectDocumentedResponse({
+      method: "post",
+      path: "/announcements/{id}/acknowledge",
+      response: acknowledge,
+      spec,
+    });
+
+    for (const page of [1, 2]) {
+      const feed = await agent
+        .get(`/announcements/feed?platform=web&limit=1&page=${page}`)
+        .expect(200);
+      expectDocumentedResponse({method: "get", path: "/announcements/feed", response: feed, spec});
+    }
+  });
+
+  it("reports more on every feed page but the last so clients keep the list envelope", async () => {
+    const publishedAt = DateTime.utc().minus({minutes: 1}).toJSDate();
+    for (const title of ["One", "Two", "Three"]) {
+      await Announcement.create({body: "Body", publishedAt, status: "published", title});
+    }
+    const agent = await authAsUser(app, "notAdmin");
+
+    const pages: {count: number; more: boolean; total: number}[] = [];
+    for (const page of [1, 2, 3]) {
+      const res = await agent.get(`/announcements/feed?platform=web&limit=2&page=${page}`);
+      pages.push({count: res.body.data.length, more: res.body.more, total: res.body.total});
+    }
+
+    expect(pages).toEqual([
+      {count: 2, more: true, total: 3},
+      {count: 1, more: false, total: 3},
+      {count: 0, more: false, total: 3},
+    ]);
+  });
+});

package/src/tests/pending.test.ts

@@ -20,6 +20,7 @@ const makeAnnouncement = (overrides: Partial<AnnouncementDocument> = {}): Announ
   audience: {},
   body: "Body",
   created: new Date(),
+  deleted: false,
   expiresAt: undefined,
   platforms: ["ios", "android", "web"],
   priority: 0,
@@ -165,7 +166,7 @@ describe("pending helpers", () => {
   it("matchAudienceByType honors staff, patient, and all", () => {
     const staffUser = {admin: true};
     const patientUser = {admin: false};
-    const isStaff = (user: {admin?: boolean}) => user.admin === true;
+    const isStaff = (user: unknown): boolean => (user as {admin?: boolean}).admin === true;
 
     assert.isTrue(
       matchAudienceByType({

package/src/types.ts

@@ -1,4 +1,4 @@
-import type {PermissionMethod} from "@terreno/api";
+import type {FindExactlyOnePlugin, FindOneOrNonePlugin, PermissionMethod} from "@terreno/api";
 import type {Model, Types} from "mongoose";
 
 export type AnnouncementStatus = "draft" | "published" | "archived";
@@ -44,7 +44,9 @@ export interface AnnouncementDocument {
   updated: Date;
 }
 
-export type AnnouncementModel = Model<AnnouncementDocument>;
+export type AnnouncementModel = Model<AnnouncementDocument> &
+  FindExactlyOnePlugin<AnnouncementDocument> &
+  FindOneOrNonePlugin<AnnouncementDocument>;
 
 export interface AnnouncementAcknowledgementDocument {
   _id: Types.ObjectId;

package/tsconfig.typecheck.json

@@ -0,0 +1,18 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "composite": false,
+    "incremental": false,
+    "declaration": false,
+    "declarationMap": false,
+    "types": [
+      "node",
+      "bun"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}