@terreno/announcements 57.4.0

package/dist/help.d.ts

@@ -0,0 +1,30 @@
+import type { AcknowledgementPolicy, AnnouncementDocument, AnnouncementStatus } from "./types";
+export interface AnnouncementHelpSummary {
+    archivedAt?: string;
+    excerpt: string;
+    id: string;
+    publishedAt?: string;
+    status: AnnouncementStatus;
+    title: string;
+    version: number;
+}
+export interface AnnouncementHelpDetail {
+    archivedAt?: string;
+    body: string;
+    expiresAt?: string;
+    id: string;
+    platforms: AnnouncementDocument["platforms"];
+    primaryAction?: AnnouncementDocument["primaryAction"];
+    priority: number;
+    publishAt?: string;
+    publishedAt?: string;
+    requiresAcknowledgement: boolean;
+    status: AnnouncementStatus;
+    title: string;
+    version: number;
+}
+export declare const buildHelpStatusFilter: (includeArchived: boolean) => AnnouncementStatus[];
+export declare const excerptBody: (body: string, maxLength?: number) => string;
+export declare const matchesHelpQueries: (doc: Pick<AnnouncementDocument, "body" | "title">, queries: string[]) => boolean;
+export declare const toHelpSummary: (doc: AnnouncementDocument) => AnnouncementHelpSummary;
+export declare const toHelpDetail: (doc: AnnouncementDocument, defaultAcknowledgementPolicy?: AcknowledgementPolicy) => AnnouncementHelpDetail;

package/dist/help.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toHelpDetail = exports.toHelpSummary = exports.matchesHelpQueries = exports.excerptBody = exports.buildHelpStatusFilter = void 0;
+var pending_1 = require("./pending");
+var buildHelpStatusFilter = function (includeArchived) {
+    if (includeArchived) {
+        return ["published", "archived"];
+    }
+    return ["published"];
+};
+exports.buildHelpStatusFilter = buildHelpStatusFilter;
+var excerptBody = function (body, maxLength) {
+    if (maxLength === void 0) { maxLength = 240; }
+    var normalized = body.replace(/\s+/g, " ").trim();
+    if (normalized.length <= maxLength) {
+        return normalized;
+    }
+    return "".concat(normalized.slice(0, maxLength), "\u2026");
+};
+exports.excerptBody = excerptBody;
+var matchesSingleQuery = function (doc, query) {
+    var normalized = query.trim().toLowerCase();
+    if (!normalized) {
+        return true;
+    }
+    var haystack = "".concat(doc.title, "\n").concat(doc.body).toLowerCase();
+    return haystack.includes(normalized);
+};
+var matchesHelpQueries = function (doc, queries) {
+    var activeQueries = queries.map(function (query) { return query.trim(); }).filter(Boolean);
+    if (activeQueries.length === 0) {
+        return true;
+    }
+    return activeQueries.some(function (query) { return matchesSingleQuery(doc, query); });
+};
+exports.matchesHelpQueries = matchesHelpQueries;
+var toHelpSummary = function (doc) {
+    var _a, _b;
+    return ({
+        archivedAt: (_a = doc.archivedAt) === null || _a === void 0 ? void 0 : _a.toISOString(),
+        excerpt: (0, exports.excerptBody)(doc.body),
+        id: doc._id.toString(),
+        publishedAt: (_b = doc.publishedAt) === null || _b === void 0 ? void 0 : _b.toISOString(),
+        status: doc.status,
+        title: doc.title,
+        version: doc.version,
+    });
+};
+exports.toHelpSummary = toHelpSummary;
+var toHelpDetail = function (doc, defaultAcknowledgementPolicy) {
+    var _a, _b, _c, _d;
+    if (defaultAcknowledgementPolicy === void 0) { defaultAcknowledgementPolicy = "dismiss-only"; }
+    return ({
+        archivedAt: (_a = doc.archivedAt) === null || _a === void 0 ? void 0 : _a.toISOString(),
+        body: doc.body,
+        expiresAt: (_b = doc.expiresAt) === null || _b === void 0 ? void 0 : _b.toISOString(),
+        id: doc._id.toString(),
+        platforms: doc.platforms,
+        primaryAction: doc.primaryAction,
+        priority: doc.priority,
+        publishAt: (_c = doc.publishAt) === null || _c === void 0 ? void 0 : _c.toISOString(),
+        publishedAt: (_d = doc.publishedAt) === null || _d === void 0 ? void 0 : _d.toISOString(),
+        requiresAcknowledgement: (0, pending_1.requiresAcknowledgementForAnnouncement)({
+            announcement: doc,
+            defaultAcknowledgementPolicy: defaultAcknowledgementPolicy,
+        }),
+        status: doc.status,
+        title: doc.title,
+        version: doc.version,
+    });
+};
+exports.toHelpDetail = toHelpDetail;

package/dist/helpRoutes.d.ts

@@ -0,0 +1,8 @@
+import type { AcknowledgementPolicy, MatchAudienceFunction } from "./types";
+export declare const registerAnnouncementHelpRoutes: ({ app, basePath, defaultAcknowledgementPolicy, isStaff, matchAudience, }: {
+    app: import("express").Application;
+    basePath: string;
+    defaultAcknowledgementPolicy?: AcknowledgementPolicy;
+    isStaff?: (user: unknown) => boolean;
+    matchAudience?: MatchAudienceFunction;
+}) => void;

package/dist/helpRoutes.js

@@ -0,0 +1,233 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerAnnouncementHelpRoutes = void 0;
+var api_1 = require("@terreno/api");
+var express_1 = require("express");
+var help_1 = require("./help");
+var announcement_1 = require("./models/announcement");
+var pending_1 = require("./pending");
+var defaultIsStaff = function (user) { return user.admin === true; };
+var parseHelpQueries = function (req) {
+    var raw = req.query.q;
+    if (typeof raw === "string" && raw.trim()) {
+        return [raw.trim()];
+    }
+    if (Array.isArray(raw)) {
+        return raw.filter(function (value) { return typeof value === "string" && value.trim().length > 0; });
+    }
+    return [];
+};
+var parseIncludeArchived = function (req) {
+    var raw = req.query.includeArchived;
+    if (raw === "true" || raw === "1") {
+        return true;
+    }
+    return false;
+};
+var parseLimit = function (req) {
+    var _a;
+    var parsed = Number((_a = req.query.limit) !== null && _a !== void 0 ? _a : 10);
+    return Math.min(Math.max(parsed, 1), 50);
+};
+var isAnnouncementHelpVisible = function (announcement) {
+    if (announcement.status === "archived") {
+        return true;
+    }
+    return (0, pending_1.isAnnouncementVisibleNow)({ announcement: announcement });
+};
+var sortHelpResults = function (docs) {
+    return __spreadArray([], __read(docs), false).sort(function (left, right) {
+        var _a, _b, _c, _d;
+        if (right.priority !== left.priority) {
+            return right.priority - left.priority;
+        }
+        var rightPublished = (_b = (_a = right.publishedAt) === null || _a === void 0 ? void 0 : _a.getTime()) !== null && _b !== void 0 ? _b : 0;
+        var leftPublished = (_d = (_c = left.publishedAt) === null || _c === void 0 ? void 0 : _c.getTime()) !== null && _d !== void 0 ? _d : 0;
+        return rightPublished - leftPublished;
+    });
+};
+var registerAnnouncementHelpRoutes = function (_a) {
+    var app = _a.app, basePath = _a.basePath, _b = _a.defaultAcknowledgementPolicy, defaultAcknowledgementPolicy = _b === void 0 ? "dismiss-only" : _b, _c = _a.isStaff, isStaff = _c === void 0 ? defaultIsStaff : _c, matchAudience = _a.matchAudience;
+    var audienceMatcher = matchAudience !== null && matchAudience !== void 0 ? matchAudience : (function () { return true; });
+    var matchesAnnouncementAudience = function (user, announcement) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (!(0, pending_1.matchAudienceByType)({ announcement: announcement, isStaff: isStaff, user: user })) {
+                return [2 /*return*/, false];
+            }
+            return [2 /*return*/, audienceMatcher(user, announcement)];
+        });
+    }); };
+    var router = (0, express_1.Router)();
+    router.get("/help/search", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
+        var user, queries, includeArchived, limit, queryVersion, statuses, candidates, matched, candidates_1, candidates_1_1, doc, matchesAudience, e_1_1, page;
+        var e_1, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    user = req.user;
+                    if (!user) {
+                        throw new api_1.APIError({ status: 401, title: "Authentication required" });
+                    }
+                    queries = parseHelpQueries(req);
+                    includeArchived = parseIncludeArchived(req);
+                    limit = parseLimit(req);
+                    queryVersion = (0, pending_1.parseQueryVersion)(req.query.version);
+                    statuses = (0, help_1.buildHelpStatusFilter)(includeArchived);
+                    return [4 /*yield*/, announcement_1.Announcement.find({ status: { $in: statuses } }).lean()];
+                case 1:
+                    candidates = (_b.sent());
+                    matched = [];
+                    _b.label = 2;
+                case 2:
+                    _b.trys.push([2, 7, 8, 9]);
+                    candidates_1 = __values(candidates), candidates_1_1 = candidates_1.next();
+                    _b.label = 3;
+                case 3:
+                    if (!!candidates_1_1.done) return [3 /*break*/, 6];
+                    doc = candidates_1_1.value;
+                    if (!isAnnouncementHelpVisible(doc)) {
+                        return [3 /*break*/, 5];
+                    }
+                    if (!(0, pending_1.passesMinBuildNumber)({ announcement: doc, queryVersion: queryVersion })) {
+                        return [3 /*break*/, 5];
+                    }
+                    return [4 /*yield*/, matchesAnnouncementAudience(user, doc)];
+                case 4:
+                    matchesAudience = _b.sent();
+                    if (!matchesAudience) {
+                        return [3 /*break*/, 5];
+                    }
+                    if (!(0, help_1.matchesHelpQueries)(doc, queries)) {
+                        return [3 /*break*/, 5];
+                    }
+                    matched.push(doc);
+                    _b.label = 5;
+                case 5:
+                    candidates_1_1 = candidates_1.next();
+                    return [3 /*break*/, 3];
+                case 6: return [3 /*break*/, 9];
+                case 7:
+                    e_1_1 = _b.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 9];
+                case 8:
+                    try {
+                        if (candidates_1_1 && !candidates_1_1.done && (_a = candidates_1.return)) _a.call(candidates_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                    return [7 /*endfinally*/];
+                case 9:
+                    page = sortHelpResults(matched).slice(0, limit).map(help_1.toHelpSummary);
+                    return [2 /*return*/, res.json({ data: page, total: matched.length })];
+            }
+        });
+    }); }));
+    router.get("/help/:id", (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
+        var user, includeArchived, queryVersion, statuses, announcement, matchesAudience;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    user = req.user;
+                    if (!user) {
+                        throw new api_1.APIError({ status: 401, title: "Authentication required" });
+                    }
+                    includeArchived = parseIncludeArchived(req);
+                    queryVersion = (0, pending_1.parseQueryVersion)(req.query.version);
+                    statuses = (0, help_1.buildHelpStatusFilter)(includeArchived);
+                    return [4 /*yield*/, announcement_1.Announcement.findById(req.params.id).lean()];
+                case 1:
+                    announcement = (_a.sent());
+                    if (!announcement || !statuses.includes(announcement.status)) {
+                        throw new api_1.APIError({ status: 404, title: "Update note not found" });
+                    }
+                    if (!isAnnouncementHelpVisible(announcement)) {
+                        throw new api_1.APIError({ status: 404, title: "Update note not found" });
+                    }
+                    if (!(0, pending_1.passesMinBuildNumber)({ announcement: announcement, queryVersion: queryVersion })) {
+                        throw new api_1.APIError({ status: 404, title: "Update note not found" });
+                    }
+                    return [4 /*yield*/, matchesAnnouncementAudience(user, announcement)];
+                case 2:
+                    matchesAudience = _a.sent();
+                    if (!matchesAudience) {
+                        throw new api_1.APIError({ status: 404, title: "Update note not found" });
+                    }
+                    return [2 /*return*/, res.json({ data: (0, help_1.toHelpDetail)(announcement, defaultAcknowledgementPolicy) })];
+            }
+        });
+    }); }));
+    app.use(basePath, router);
+};
+exports.registerAnnouncementHelpRoutes = registerAnnouncementHelpRoutes;

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { AnnouncementsApp } from "./announcementsApp";
+export type { AnnouncementHelpDetail, AnnouncementHelpSummary } from "./help";
+export { buildHelpStatusFilter, excerptBody, matchesHelpQueries, toHelpDetail, toHelpSummary, } from "./help";
+export { Announcement, toAnnouncementPublic } from "./models/announcement";
+export { AnnouncementAcknowledgement } from "./models/announcementAcknowledgement";
+export { AnnouncementClickEvent } from "./models/announcementClickEvent";
+export { AnnouncementImpression } from "./models/announcementImpression";
+export { isAnnouncementPendingForUser, isAnnouncementVisibleNow, isAnnouncementVisibleToUser, isInterruptDisplayMode, matchAudienceByType, parseQueryVersion, passesMinBuildNumber, requiresAcknowledgementForAnnouncement, resolveAcknowledgementPolicy, resolveAudienceType, resolveDisplayMode, selectPendingAnnouncements, sortAnnouncementsForQueue, } from "./pending";
+export type { AcknowledgementPolicy, AnnouncementAudienceType, AnnouncementClickAction, AnnouncementDisplayMode, AnnouncementDocument, AnnouncementOverviewMetrics, AnnouncementOverviewResponse, AnnouncementOverviewRow, AnnouncementOverviewTotals, AnnouncementPlatform, AnnouncementPrimaryAction, AnnouncementPublic, AnnouncementsHelpOptions, AnnouncementsOptions, MatchAudienceFunction, } from "./types";

package/dist/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortAnnouncementsForQueue = exports.selectPendingAnnouncements = exports.resolveDisplayMode = exports.resolveAudienceType = exports.resolveAcknowledgementPolicy = exports.requiresAcknowledgementForAnnouncement = exports.passesMinBuildNumber = exports.parseQueryVersion = exports.matchAudienceByType = exports.isInterruptDisplayMode = exports.isAnnouncementVisibleToUser = exports.isAnnouncementVisibleNow = exports.isAnnouncementPendingForUser = exports.AnnouncementImpression = exports.AnnouncementClickEvent = exports.AnnouncementAcknowledgement = exports.toAnnouncementPublic = exports.Announcement = exports.toHelpSummary = exports.toHelpDetail = exports.matchesHelpQueries = exports.excerptBody = exports.buildHelpStatusFilter = exports.AnnouncementsApp = void 0;
+var announcementsApp_1 = require("./announcementsApp");
+Object.defineProperty(exports, "AnnouncementsApp", { enumerable: true, get: function () { return announcementsApp_1.AnnouncementsApp; } });
+var help_1 = require("./help");
+Object.defineProperty(exports, "buildHelpStatusFilter", { enumerable: true, get: function () { return help_1.buildHelpStatusFilter; } });
+Object.defineProperty(exports, "excerptBody", { enumerable: true, get: function () { return help_1.excerptBody; } });
+Object.defineProperty(exports, "matchesHelpQueries", { enumerable: true, get: function () { return help_1.matchesHelpQueries; } });
+Object.defineProperty(exports, "toHelpDetail", { enumerable: true, get: function () { return help_1.toHelpDetail; } });
+Object.defineProperty(exports, "toHelpSummary", { enumerable: true, get: function () { return help_1.toHelpSummary; } });
+var announcement_1 = require("./models/announcement");
+Object.defineProperty(exports, "Announcement", { enumerable: true, get: function () { return announcement_1.Announcement; } });
+Object.defineProperty(exports, "toAnnouncementPublic", { enumerable: true, get: function () { return announcement_1.toAnnouncementPublic; } });
+var announcementAcknowledgement_1 = require("./models/announcementAcknowledgement");
+Object.defineProperty(exports, "AnnouncementAcknowledgement", { enumerable: true, get: function () { return announcementAcknowledgement_1.AnnouncementAcknowledgement; } });
+var announcementClickEvent_1 = require("./models/announcementClickEvent");
+Object.defineProperty(exports, "AnnouncementClickEvent", { enumerable: true, get: function () { return announcementClickEvent_1.AnnouncementClickEvent; } });
+var announcementImpression_1 = require("./models/announcementImpression");
+Object.defineProperty(exports, "AnnouncementImpression", { enumerable: true, get: function () { return announcementImpression_1.AnnouncementImpression; } });
+var pending_1 = require("./pending");
+Object.defineProperty(exports, "isAnnouncementPendingForUser", { enumerable: true, get: function () { return pending_1.isAnnouncementPendingForUser; } });
+Object.defineProperty(exports, "isAnnouncementVisibleNow", { enumerable: true, get: function () { return pending_1.isAnnouncementVisibleNow; } });
+Object.defineProperty(exports, "isAnnouncementVisibleToUser", { enumerable: true, get: function () { return pending_1.isAnnouncementVisibleToUser; } });
+Object.defineProperty(exports, "isInterruptDisplayMode", { enumerable: true, get: function () { return pending_1.isInterruptDisplayMode; } });
+Object.defineProperty(exports, "matchAudienceByType", { enumerable: true, get: function () { return pending_1.matchAudienceByType; } });
+Object.defineProperty(exports, "parseQueryVersion", { enumerable: true, get: function () { return pending_1.parseQueryVersion; } });
+Object.defineProperty(exports, "passesMinBuildNumber", { enumerable: true, get: function () { return pending_1.passesMinBuildNumber; } });
+Object.defineProperty(exports, "requiresAcknowledgementForAnnouncement", { enumerable: true, get: function () { return pending_1.requiresAcknowledgementForAnnouncement; } });
+Object.defineProperty(exports, "resolveAcknowledgementPolicy", { enumerable: true, get: function () { return pending_1.resolveAcknowledgementPolicy; } });
+Object.defineProperty(exports, "resolveAudienceType", { enumerable: true, get: function () { return pending_1.resolveAudienceType; } });
+Object.defineProperty(exports, "resolveDisplayMode", { enumerable: true, get: function () { return pending_1.resolveDisplayMode; } });
+Object.defineProperty(exports, "selectPendingAnnouncements", { enumerable: true, get: function () { return pending_1.selectPendingAnnouncements; } });
+Object.defineProperty(exports, "sortAnnouncementsForQueue", { enumerable: true, get: function () { return pending_1.sortAnnouncementsForQueue; } });

package/dist/models/announcement.d.ts

@@ -0,0 +1,3 @@
+import type { AcknowledgementPolicy, AnnouncementDocument, AnnouncementModel, AnnouncementPublic } from "../types";
+export declare const Announcement: AnnouncementModel;
+export declare const toAnnouncementPublic: (doc: AnnouncementDocument, defaultAcknowledgementPolicy?: AcknowledgementPolicy) => AnnouncementPublic;

package/dist/models/announcement.js

@@ -0,0 +1,214 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toAnnouncementPublic = exports.Announcement = void 0;
+var api_1 = require("@terreno/api");
+var mongoose_1 = __importDefault(require("mongoose"));
+var pending_1 = require("../pending");
+var ALL_PLATFORMS = ["ios", "android", "web"];
+var announcementSchema = new mongoose_1.default.Schema({
+    acknowledgementPolicy: {
+        description: "Whether users must acknowledge (required) or may dismiss with an impression only (dismiss-only). Omitted values resolve from the plugin defaultAcknowledgementPolicy at read time.",
+        enum: ["required", "dismiss-only"],
+        type: String,
+    },
+    archivedAt: {
+        description: "When the announcement was archived",
+        type: Date,
+    },
+    audience: {
+        default: {},
+        description: "Opaque targeting metadata consumed by matchAudience callback",
+        type: mongoose_1.default.Schema.Types.Mixed,
+    },
+    audienceType: {
+        default: "all",
+        description: "First-class audience targeting: staff, patient, or all. Composed with matchAudience via matchAudienceByType.",
+        enum: ["staff", "patient", "all"],
+        type: String,
+    },
+    body: {
+        description: "Markdown body shown in the announcement modal",
+        required: true,
+        trim: true,
+        type: String,
+    },
+    displayMode: {
+        default: "modal",
+        description: "Where the announcement appears: blocking modal, non-blocking banner, or feed-only changelog entry",
+        enum: ["modal", "banner", "feed"],
+        type: String,
+    },
+    expiresAt: {
+        description: "Optional expiry — hidden from pending/feed after this time",
+        type: Date,
+    },
+    minBuildNumber: {
+        description: "Optional minimum client build number. Hidden from pending, feed, and help when query version is a finite integer below this value",
+        min: 1,
+        type: Number,
+    },
+    platforms: {
+        default: ALL_PLATFORMS,
+        description: "Platforms that should receive this announcement",
+        enum: ALL_PLATFORMS,
+        type: [String],
+    },
+    primaryAction: {
+        label: {
+            description: "Button label for optional primary action",
+            type: String,
+        },
+        url: {
+            description: "Deep link or external URL opened by the primary action button",
+            type: String,
+        },
+    },
+    priority: {
+        default: 0,
+        description: "Higher priority announcements appear first in the modal queue",
+        type: Number,
+    },
+    publishAt: {
+        description: "Optional scheduled publish time — hidden until this instant",
+        type: Date,
+    },
+    publishedAt: {
+        description: "When the announcement was first published",
+        type: Date,
+    },
+    status: {
+        default: "draft",
+        description: "Lifecycle status: draft, published, or archived",
+        enum: ["draft", "published", "archived"],
+        required: true,
+        type: String,
+    },
+    title: {
+        description: "Announcement title shown in modal and changelog feed",
+        required: true,
+        trim: true,
+        type: String,
+    },
+    version: {
+        default: 1,
+        description: "Content version — increments when published title/body changes",
+        min: 1,
+        type: Number,
+    },
+}, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
+announcementSchema.plugin(api_1.createdUpdatedPlugin);
+announcementSchema.plugin(api_1.isDeletedPlugin);
+announcementSchema.plugin(api_1.findExactlyOne);
+announcementSchema.plugin(api_1.findOneOrNone);
+announcementSchema.index({ publishAt: 1, status: 1 });
+announcementSchema.index({ priority: -1, publishedAt: -1, status: 1 });
+announcementSchema.pre("save", function bumpVersionOnPublishedEdit() {
+    return __awaiter(this, void 0, void 0, function () {
+        var previous;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (this.isNew) {
+                        return [2 /*return*/];
+                    }
+                    if (this.status !== "published") {
+                        return [2 /*return*/];
+                    }
+                    if (!this.isModified("title") && !this.isModified("body")) {
+                        return [2 /*return*/];
+                    }
+                    return [4 /*yield*/, exports.Announcement.findById(this._id).select("title body status version")];
+                case 1:
+                    previous = _b.sent();
+                    if ((previous === null || previous === void 0 ? void 0 : previous.status) !== "published") {
+                        return [2 /*return*/];
+                    }
+                    if (previous.title === this.title && previous.body === this.body) {
+                        return [2 /*return*/];
+                    }
+                    this.version = ((_a = previous.version) !== null && _a !== void 0 ? _a : 1) + 1;
+                    return [2 /*return*/];
+            }
+        });
+    });
+});
+announcementSchema.pre("validate", function validatePrimaryAction() {
+    var _a, _b;
+    var action = this.primaryAction;
+    if (!action) {
+        return;
+    }
+    var hasLabel = Boolean((_a = action.label) === null || _a === void 0 ? void 0 : _a.trim());
+    var hasUrl = Boolean((_b = action.url) === null || _b === void 0 ? void 0 : _b.trim());
+    if (!hasLabel && !hasUrl) {
+        this.primaryAction = undefined;
+        return;
+    }
+    if (!hasLabel || !hasUrl) {
+        throw new api_1.APIError({
+            status: 400,
+            title: "primaryAction requires both label and url when provided",
+        });
+    }
+});
+exports.Announcement = (_a = mongoose_1.default.models.Announcement) !== null && _a !== void 0 ? _a : mongoose_1.default.model("Announcement", announcementSchema);
+var toAnnouncementPublic = function (doc, defaultAcknowledgementPolicy) {
+    var _a;
+    if (defaultAcknowledgementPolicy === void 0) { defaultAcknowledgementPolicy = "dismiss-only"; }
+    return ({
+        body: doc.body,
+        displayMode: (0, pending_1.resolveDisplayMode)(doc),
+        id: doc._id.toString(),
+        primaryAction: doc.primaryAction,
+        priority: doc.priority,
+        publishedAt: (_a = doc.publishedAt) === null || _a === void 0 ? void 0 : _a.toISOString(),
+        requiresAcknowledgement: (0, pending_1.requiresAcknowledgementForAnnouncement)({
+            announcement: doc,
+            defaultAcknowledgementPolicy: defaultAcknowledgementPolicy,
+        }),
+        title: doc.title,
+        version: doc.version,
+    });
+};
+exports.toAnnouncementPublic = toAnnouncementPublic;

package/dist/models/announcementAcknowledgement.d.ts

@@ -0,0 +1,2 @@
+import type { AnnouncementAcknowledgementModel } from "../types";
+export declare const AnnouncementAcknowledgement: AnnouncementAcknowledgementModel;

package/dist/models/announcementAcknowledgement.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnnouncementAcknowledgement = void 0;
+var api_1 = require("@terreno/api");
+var mongoose_1 = __importDefault(require("mongoose"));
+var announcementAcknowledgementSchema = new mongoose_1.default.Schema({
+    acknowledgedAt: {
+        description: "When the user acknowledged this announcement version",
+        required: true,
+        type: Date,
+    },
+    announcementId: {
+        description: "Announcement that was acknowledged",
+        index: true,
+        ref: "Announcement",
+        required: true,
+        type: mongoose_1.default.Schema.Types.ObjectId,
+    },
+    userId: {
+        description: "User who acknowledged the announcement",
+        index: true,
+        ref: "User",
+        required: true,
+        type: mongoose_1.default.Schema.Types.ObjectId,
+    },
+    version: {
+        description: "Announcement version acknowledged by the user",
+        required: true,
+        type: Number,
+    },
+}, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
+announcementAcknowledgementSchema.plugin(api_1.createdUpdatedPlugin);
+announcementAcknowledgementSchema.plugin(api_1.isDeletedPlugin);
+announcementAcknowledgementSchema.plugin(api_1.findExactlyOne);
+announcementAcknowledgementSchema.plugin(api_1.findOneOrNone);
+announcementAcknowledgementSchema.index({ announcementId: 1, userId: 1, version: 1 }, { unique: true });
+exports.AnnouncementAcknowledgement = (_a = mongoose_1.default.models.AnnouncementAcknowledgement) !== null && _a !== void 0 ? _a : mongoose_1.default.model("AnnouncementAcknowledgement", announcementAcknowledgementSchema);

package/dist/models/announcementClickEvent.d.ts

@@ -0,0 +1,3 @@
+import type { AnnouncementClickAction, AnnouncementClickEventModel } from "../types";
+export declare const AnnouncementClickEvent: AnnouncementClickEventModel;
+export declare const isValidClickAction: (value: unknown) => value is AnnouncementClickAction;