@terreno/announcements 57.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Flourish Health, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# @terreno/announcements
+
+In-app product update announcements for Terreno backends.
+
+## Install
+
+```bash
+bun add @terreno/announcements
+```
+
+Peer dependency: `mongoose ^8.0.0 || ^9.0.0`. `@terreno/api` is required at runtime.
+
+## Quick start
+
+```typescript
+import {AnnouncementsApp} from "@terreno/announcements";
+import {TerrenoApp} from "@terreno/api";
+
+new TerrenoApp({userModel: User})
+  .register(
+    new AnnouncementsApp({
+      defaultAcknowledgementPolicy: "dismiss-only",
+      help: {enabled: true},
+      isStaff: (user) => user.admin === true,
+      matchAudience: (user, announcement) => true,
+    })
+  )
+  .start();
+```
+
+Wrap authenticated app content with `AnnouncementNavigator` from `@terreno/ui` on the frontend.
+
+## What's included
+
+- `AnnouncementsApp` — user routes (`/pending`, `/feed`, acknowledge, impression, click) plus admin CRUD
+- Optional help API for MCP and agent search (`/announcements/help/*`)
+- First-class `audienceType` (`staff` | `patient` | `all`) composed via exported `matchAudienceByType` and optional `isStaff`
+- Custom segments via `matchAudience` and opaque `audience` JSON on each announcement
+- Per-announcement `acknowledgementPolicy` with consumer `defaultAcknowledgementPolicy`
+- Platform targeting (`ios`, `android`, `web`) with user-agent fallback when `platform` is omitted
+
+## Documentation
+
+- Reference: [docs/reference/announcements.md](https://github.com/FlourishHealth/terreno/blob/master/docs/reference/announcements.md)
+- How-to: [docs/how-to/product-announcements.md](https://github.com/FlourishHealth/terreno/blob/master/docs/how-to/product-announcements.md)
+- Implementation plan: [docs/implementationPlans/announcements.md](https://github.com/FlourishHealth/terreno/blob/master/docs/implementationPlans/announcements.md)
+
+## License and Contributing
+
+Licensed under the [MIT License](https://github.com/FlourishHealth/terreno/blob/master/LICENSE). See [CONTRIBUTING.md](https://github.com/FlourishHealth/terreno/blob/master/CONTRIBUTING.md) for contribution guidelines.

package/biome.jsonc

@@ -0,0 +1,20 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": ["../biome.jsonc"],
+  "files": {
+    "includes": [
+      "package.json",
+      "src/**/*.ts",
+      "src/**/*.tsx",
+      "!!**/node_modules",
+      "!!node_modules",
+      "!!**/dist",
+      "!!dist",
+      "!!**/build",
+      "!!build",
+      "!!**/coverage",
+      "!!coverage"
+    ]
+  },
+  "root": true
+}

package/bunfig.toml

@@ -0,0 +1,2 @@
+[test]
+preload = ["./src/tests/bunSetup.ts"]

package/dist/announcementsApp.d.ts

@@ -0,0 +1,9 @@
+import { type AdminContribution, type TerrenoPlugin } from "@terreno/api";
+import { type Application } from "express";
+import type { AnnouncementsOptions } from "./types";
+export declare class AnnouncementsApp implements TerrenoPlugin {
+    private options;
+    constructor(options?: AnnouncementsOptions);
+    adminContribution(): AdminContribution;
+    register(app: Application, openApi?: unknown): void;
+}