@oneuptime/common 14.0.7 → 14.0.9

package/build/dist/Types/StatusPage/IncidentScopeAddedPagesNotification.js

@@ -0,0 +1,246 @@
+import StatusPageSubscriberNotificationStatus from "./StatusPageSubscriberNotificationStatus";
+/*
+ * An incident can be limited to some status pages (Incident.statusPages), and
+ * the pages it is limited to often change while it is open: a site turns out
+ * to be affected after all, or an incident a monitor created on its own gets
+ * scoped once someone works out who is affected. Subscribers of a page hear
+ * about an incident once, when it is created, so without a way back a page
+ * added later never got the 'created' notification at all.
+ *
+ * Whether a newly added page should hear about it now is the editor's call,
+ * so it is asked when pages are added (the dashboard ticks it by default)
+ * rather than decided automatically, and the answer travels with that update
+ * as a misc data prop - like SubscriberUpdateNotification and
+ * IncidentCreatedRenotify, it is not a column. IncidentService turns it into a
+ * Pending 'created' notification, and the Incident:SendNotificationToSubscribers
+ * job sends it to the pages in the scope that are not yet listed in
+ * Incident.statusPagesNotifiedOnCreation. That record is what keeps the pages
+ * that were already told from hearing it twice: the request re-queues the
+ * notification, and the record decides who it goes to.
+ *
+ * The record only exists once the job has settled a send, so two cases have
+ * none, and each is handled so that only the pages the edit adds are told:
+ *
+ * - the notification went out before the record existed (an incident from an
+ *   earlier release, Success or Failed with no record). It reached every page
+ *   that listed the incident's monitors back then, so there is no way to tell
+ *   an added page from one that was told, and nothing is queued. An empty
+ *   record would otherwise read as "nobody was told" and announce the incident
+ *   a second time;
+ * - the notification was Skipped and never sent (published without
+ *   announcing it, or declared without monitors). The pages the incident was
+ *   limited to before the edit were deliberately not told, so the update
+ *   writes them in as the record when it queues the notification (see
+ *   getRecordToSeedOnQueue): the job then tells the added pages only, not the
+ *   pages the editor chose not to announce it on.
+ *
+ * Everything here is shared by the dashboard, which offers the checkbox, and
+ * the server, which acts on it, so the two cannot drift apart: the dashboard
+ * offers the checkbox exactly when getAction would queue.
+ */
+// What an update that adds status pages does to the 'created' notification.
+export var IncidentScopeAddedPagesNotificationAction;
+(function (IncidentScopeAddedPagesNotificationAction) {
+    /*
+     * Nothing to do: no page was added, every added page was told already, or
+     * the incident is not to be announced.
+     */
+    IncidentScopeAddedPagesNotificationAction["None"] = "None";
+    // Put the 'created' notification back to Pending.
+    IncidentScopeAddedPagesNotificationAction["Queue"] = "Queue";
+    /*
+     * It is Pending, or being sent right now. A queued send reads the scope
+     * when it goes out, and a send that is running reads it again once it has
+     * finished and queues itself once more for any page added meanwhile, so the
+     * added pages are reached without any change here. IncidentService checks
+     * once the update is written, in case the send finished in between.
+     */
+    IncidentScopeAddedPagesNotificationAction["AlreadyQueued"] = "AlreadyQueued";
+})(IncidentScopeAddedPagesNotificationAction || (IncidentScopeAddedPagesNotificationAction = {}));
+class IncidentScopeAddedPagesNotification {
+    /*
+     * Only a real yes counts. The flag arrives over JSON, so accept the string
+     * form a hand-written API request might send, and nothing looser: a stray
+     * "false" or 1 must never email every subscriber of a status page.
+     */
+    static isRequested(miscDataProps) {
+        if (!miscDataProps || typeof miscDataProps !== "object") {
+            return false;
+        }
+        const value = miscDataProps[this.miscDataKey];
+        return value === true || value === "true";
+    }
+    static getMiscDataProps() {
+        return {
+            [this.miscDataKey]: true,
+        };
+    }
+    /*
+     * The status page ids in any shape a status page list arrives in - a model,
+     * a {_id} or {id} object, an ObjectID or a bare string - lower-cased (the
+     * database reads uuids back lower-cased) and without duplicates, in the
+     * order first seen.
+     */
+    static normalizeStatusPageIds(value) {
+        if (value === undefined || value === null) {
+            return [];
+        }
+        const entries = Array.isArray(value) ? value : [value];
+        const ids = [];
+        for (const entry of entries) {
+            const id = this.getStatusPageId(entry);
+            if (id && !ids.includes(id)) {
+                ids.push(id);
+            }
+        }
+        return ids;
+    }
+    // Which pages a change of the scope from `before` to `after` adds and removes.
+    static getScopeChange(data) {
+        const before = this.normalizeStatusPageIds(data.before);
+        const after = this.normalizeStatusPageIds(data.after);
+        return {
+            addedStatusPageIds: after.filter((id) => {
+                return !before.includes(id);
+            }),
+            removedStatusPageIds: before.filter((id) => {
+                return !after.includes(id);
+            }),
+        };
+    }
+    /*
+     * The pages Incident.statusPagesNotifiedOnCreation lists, or null when there
+     * is no record: never written (the job has not settled a send since the
+     * record was introduced), or not a list.
+     */
+    static getRecordedStatusPageIds(value) {
+        if (!Array.isArray(value)) {
+            return null;
+        }
+        return this.normalizeStatusPageIds(value);
+    }
+    /*
+     * What adding `addedStatusPageIds` to an incident's scope does to its
+     * 'created' notification, given where that notification is:
+     *
+     * - no page added: nothing, whatever else the update does;
+     * - notifying on creation is off: nothing. An incident declared with
+     *   notifications off was deliberately kept quiet, and scoping it does not
+     *   change that;
+     * - hidden from status pages or private once the update is written:
+     *   nothing. The job would only skip it again. Publishing the incident
+     *   offers to announce it to the pages that were not told
+     *   (IncidentCreatedRenotify.canRenotifyOnPublish), including pages added
+     *   while it was hidden;
+     * - every added page is in the record: nothing, they were told already
+     *   (a page removed earlier and added back, or an unscoped incident being
+     *   narrowed to pages it reached);
+     * - Success or Failed with no record: nothing. It went out before the
+     *   record existed, to every page that listed the monitors then (see the
+     *   header);
+     * - Success, Skipped or Failed otherwise: queue it again. The job then
+     *   sends it to the pages in the scope it has no record of telling - the
+     *   added pages, plus, after a failure, the pages the failed send did not
+     *   reach;
+     * - Pending or InProgress: already on its way, and it reaches the added
+     *   pages (see AlreadyQueued).
+     */
+    static getAction(data) {
+        const addedStatusPageIds = this.normalizeStatusPageIds(data.addedStatusPageIds);
+        if (addedStatusPageIds.length === 0) {
+            return IncidentScopeAddedPagesNotificationAction.None;
+        }
+        const incident = data.incident;
+        if (incident.shouldStatusPageSubscribersBeNotifiedOnIncidentCreated !== true) {
+            return IncidentScopeAddedPagesNotificationAction.None;
+        }
+        // A null visibility is hidden to the job, so it is here too.
+        if (incident.isVisibleOnStatusPage !== true ||
+            incident.isPrivate === true) {
+            return IncidentScopeAddedPagesNotificationAction.None;
+        }
+        const status = incident.subscriberNotificationStatusOnIncidentCreated;
+        const recorded = this.getRecordedStatusPageIds(incident.statusPagesNotifiedOnCreation);
+        if (recorded === null) {
+            if (status === StatusPageSubscriberNotificationStatus.Success ||
+                status === StatusPageSubscriberNotificationStatus.Failed) {
+                return IncidentScopeAddedPagesNotificationAction.None;
+            }
+        }
+        else if (addedStatusPageIds.every((id) => {
+            return recorded.includes(id);
+        })) {
+            return IncidentScopeAddedPagesNotificationAction.None;
+        }
+        switch (status) {
+            case StatusPageSubscriberNotificationStatus.Pending:
+            case StatusPageSubscriberNotificationStatus.InProgress:
+                return IncidentScopeAddedPagesNotificationAction.AlreadyQueued;
+            default:
+                /*
+                 * Success, Skipped and Failed - and a missing status, which the
+                 * column's Pending default makes impossible but which would otherwise
+                 * never be sent.
+                 */
+                return IncidentScopeAddedPagesNotificationAction.Queue;
+        }
+    }
+    /*
+     * The record an update that queues the notification (action Queue) has to
+     * write along with it, or undefined when the stored record stands.
+     *
+     * With a record, the job already knows who was told. Without one the
+     * notification was never sent (getAction does not queue a Success or
+     * Failed one without a record), so the pages the incident was limited to
+     * before the update were deliberately not told - it was published without
+     * announcing it, or declared without monitors. They are written in as the
+     * record, so the job tells only the pages the update adds. An incident
+     * that was not limited to any page before has nothing to leave out: every
+     * page it is now limited to is one the update adds.
+     */
+    static getRecordToSeedOnQueue(data) {
+        if (this.getRecordedStatusPageIds(data.statusPagesNotifiedOnCreation)) {
+            return undefined;
+        }
+        return this.normalizeStatusPageIds(data.statusPageIdsBeforeUpdate);
+    }
+    static getStatusPageId(entry) {
+        if (!entry) {
+            return undefined;
+        }
+        let id = entry;
+        if (typeof entry === "object") {
+            const relation = entry;
+            // A model, an ObjectID, a {_id}/{id} object or a serialized ObjectID.
+            if (relation._id !== undefined && relation._id !== null) {
+                id = relation._id;
+            }
+            else if (relation.id !== undefined && relation.id !== null) {
+                id = relation.id;
+            }
+            else if (relation._type === "ObjectID" && relation.value) {
+                id = relation.value;
+            }
+        }
+        if (typeof id !== "string" && typeof id !== "object") {
+            return undefined;
+        }
+        const text = String(id).trim().toLowerCase();
+        if (!text || text === "[object object]") {
+            return undefined;
+        }
+        return text;
+    }
+}
+// The misc data prop an update request carries to ask for the notification.
+IncidentScopeAddedPagesNotification.miscDataKey = "notifyAddedStatusPagesOfIncidentCreated";
+IncidentScopeAddedPagesNotification.queuedMessage = "Status pages were added to this incident. Their subscribers will be sent the notification that this incident was created.";
+/*
+ * The status the job leaves when pages were added to the scope while it was
+ * sending: queued again, for the pages it had not reached.
+ */
+IncidentScopeAddedPagesNotification.addedWhileSendingMessage = "Status pages were added to this incident while its subscribers were being sent the notification that it was created. The added pages will be sent it next.";
+IncidentScopeAddedPagesNotification.formFieldTitle = "Send the incident-created notification to newly added pages";
+IncidentScopeAddedPagesNotification.formFieldDescription = "Subscribers of the status pages you add are sent the notification that this incident was created. Pages that were already told are not sent it again.";
+export default IncidentScopeAddedPagesNotification;
+//# sourceMappingURL=IncidentScopeAddedPagesNotification.js.map

package/build/dist/Types/StatusPage/IncidentScopeAddedPagesNotification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncidentScopeAddedPagesNotification.js","sourceRoot":"","sources":["../../../../Types/StatusPage/IncidentScopeAddedPagesNotification.ts"],"names":[],"mappings":"AACA,OAAO,sCAAsC,MAAM,0CAA0C,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,4EAA4E;AAC5E,MAAM,CAAN,IAAY,yCAgBX;AAhBD,WAAY,yCAAyC;IACnD;;;OAGG;IACH,0DAAa,CAAA;IACb,kDAAkD;IAClD,4DAAe,CAAA;IACf;;;;;;OAMG;IACH,4EAA+B,CAAA;AACjC,CAAC,EAhBW,yCAAyC,KAAzC,yCAAyC,QAgBpD;AA0BD,MAAqB,mCAAmC;IAqBtD;;;;OAIG;IACI,MAAM,CAAC,WAAW,CACvB,aAA4C;QAE5C,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAY,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEvD,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,gBAAgB;QAC5B,OAAO;YACL,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI;SACzB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC1C,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAmB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACvE,MAAM,GAAG,GAAkB,EAAE,CAAC;QAE9B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,EAAE,GAAuB,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAE3D,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC5B,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+EAA+E;IACxE,MAAM,CAAC,cAAc,CAAC,IAG5B;QACC,MAAM,MAAM,GAAkB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,KAAK,GAAkB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAErE,OAAO;YACL,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,EAAU,EAAE,EAAE;gBAC9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC9B,CAAC,CAAC;YACF,oBAAoB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAU,EAAE,EAAE;gBACjD,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC7B,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,wBAAwB,CAAC,KAAc;QACnD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,MAAM,CAAC,SAAS,CAAC,IAGvB;QACC,MAAM,kBAAkB,GAAkB,IAAI,CAAC,sBAAsB,CACnE,IAAI,CAAC,kBAAkB,CACxB,CAAC;QAEF,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,OAAO,yCAAyC,CAAC,IAAI,CAAC;QACxD,CAAC;QAED,MAAM,QAAQ,GAA6C,IAAI,CAAC,QAAQ,CAAC;QAEzE,IACE,QAAQ,CAAC,sDAAsD,KAAK,IAAI,EACxE,CAAC;YACD,OAAO,yCAAyC,CAAC,IAAI,CAAC;QACxD,CAAC;QAED,6DAA6D;QAC7D,IACE,QAAQ,CAAC,qBAAqB,KAAK,IAAI;YACvC,QAAQ,CAAC,SAAS,KAAK,IAAI,EAC3B,CAAC;YACD,OAAO,yCAAyC,CAAC,IAAI,CAAC;QACxD,CAAC;QAED,MAAM,MAAM,GACV,QAAQ,CAAC,6CAA6C,CAAC;QAEzD,MAAM,QAAQ,GAAyB,IAAI,CAAC,wBAAwB,CAClE,QAAQ,CAAC,6BAA6B,CACvC,CAAC;QAEF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,IACE,MAAM,KAAK,sCAAsC,CAAC,OAAO;gBACzD,MAAM,KAAK,sCAAsC,CAAC,MAAM,EACxD,CAAC;gBACD,OAAO,yCAAyC,CAAC,IAAI,CAAC;YACxD,CAAC;QACH,CAAC;aAAM,IACL,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAU,EAAW,EAAE;YAC/C,OAAO,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,EACF,CAAC;YACD,OAAO,yCAAyC,CAAC,IAAI,CAAC;QACxD,CAAC;QAED,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,sCAAsC,CAAC,OAAO,CAAC;YACpD,KAAK,sCAAsC,CAAC,UAAU;gBACpD,OAAO,yCAAyC,CAAC,aAAa,CAAC;YACjE;gBACE;;;;mBAIG;gBACH,OAAO,yCAAyC,CAAC,KAAK,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAGpC;QACC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,6BAA6B,CAAC,EAAE,CAAC;YACtE,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACrE,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,KAAc;QAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,EAAE,GAAY,KAAK,CAAC;QAExB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAKV,KAKH,CAAC;YAEF,sEAAsE;YACtE,IAAI,QAAQ,CAAC,GAAG,KAAK,SAAS,IAAI,QAAQ,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;gBACxD,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC;YACpB,CAAC;iBAAM,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,IAAI,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;gBAC7D,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;YACnB,CAAC;iBAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,UAAU,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC3D,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC;YACtB,CAAC;QACH,CAAC;QAED,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YACrD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,IAAI,GAAW,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAErD,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACxC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA9PD,4EAA4E;AACrD,+CAAW,GAChC,yCAAyC,CAAC;AAErB,iDAAa,GAClC,2HAA2H,CAAC;AAE9H;;;GAGG;AACoB,4DAAwB,GAC7C,4JAA4J,CAAC;AAExI,kDAAc,GACnC,6DAA6D,CAAC;AAEzC,wDAAoB,GACzC,uJAAuJ,CAAC;eAnBvI,mCAAmC"}

package/build/dist/Types/StatusPage/IncidentSubscriberAudience.js

@@ -0,0 +1,183 @@
+/*
+ * Who an incident's status page notifications reach, shown before anything is
+ * sent: on the last step of declaring an incident, and above a public note
+ * while it is being written. "Will notify: Site 03 (up to 41 email), Site 07
+ * (up to 18 email)".
+ *
+ * POST /incident/subscriber-audience (IncidentAPI) answers it, from the same
+ * helper the subscriber jobs send through (IncidentStatusPageScope), so the
+ * preview and the send cannot disagree about which pages an incident reaches.
+ * It takes either an incident that is being declared - the monitors and the
+ * status pages picked on the form - or one that exists.
+ *
+ * The counts are "up to": they count the confirmed subscribers of each page
+ * who have not unsubscribed, per channel. A subscriber who picked only some
+ * of a page's resources, or only some event types, is filtered out at send
+ * time; and for an incident limited to specific pages an email address or
+ * phone number on two of them gets one message, not two. Addresses themselves
+ * never leave the server - only counts do.
+ *
+ * Everything here is shared by the server, which builds the answer, and the
+ * dashboard, which reads it, so the two cannot drift apart.
+ */
+// Why a status page that lists the incident's monitors is not notified.
+export var IncidentSubscriberAudienceExclusionReason;
+(function (IncidentSubscriberAudienceExclusionReason) {
+    // The incident is limited to other status pages.
+    IncidentSubscriberAudienceExclusionReason["OutsideIncidentScope"] = "OutsideIncidentScope";
+    // The page only shows incidents limited to it, and this one is not.
+    IncidentSubscriberAudienceExclusionReason["OnlyShowsScopedIncidents"] = "OnlyShowsScopedIncidents";
+    // The page does not show incidents at all (Show Incidents is off).
+    IncidentSubscriberAudienceExclusionReason["HidesIncidents"] = "HidesIncidents";
+    /*
+     * Asked for a Retry of the incident's 'created' notification only: the
+     * page was already sent it in full (Incident.statusPagesNotifiedOnCreation),
+     * and Retry resumes after it.
+     */
+    IncidentSubscriberAudienceExclusionReason["AlreadyNotified"] = "AlreadyNotified";
+})(IncidentSubscriberAudienceExclusionReason || (IncidentSubscriberAudienceExclusionReason = {}));
+// The order channels are listed in, and what each is called on screen.
+export const INCIDENT_SUBSCRIBER_AUDIENCE_CHANNELS = [
+    { channel: "email", label: "email" },
+    { channel: "sms", label: "SMS" },
+    { channel: "slack", label: "Slack" },
+    { channel: "microsoftTeams", label: "Microsoft Teams" },
+    { channel: "webhook", label: "webhook" },
+];
+class IncidentSubscriberAudience {
+    static getEmptyCounts() {
+        return {
+            email: 0,
+            sms: 0,
+            slack: 0,
+            microsoftTeams: 0,
+            webhook: 0,
+        };
+    }
+    static getTotal(counts) {
+        return INCIDENT_SUBSCRIBER_AUDIENCE_CHANNELS.reduce((total, entry) => {
+            return total + (counts[entry.channel] || 0);
+        }, 0);
+    }
+    /*
+     * The channels of one page that reach anyone, in display order, with their
+     * counts: [{channel: "email", label: "email", count: 41}, ...].
+     */
+    static getNonEmptyChannels(counts) {
+        return INCIDENT_SUBSCRIBER_AUDIENCE_CHANNELS.map((entry) => {
+            return {
+                channel: entry.channel,
+                label: entry.label,
+                count: counts[entry.channel] || 0,
+            };
+        }).filter((entry) => {
+            return entry.count > 0;
+        });
+    }
+    // Whether anyone at all will be sent anything.
+    static reachesAnyone(audience) {
+        if (audience.isHiddenFromStatusPages || !audience.hasMonitors) {
+            return false;
+        }
+        return (audience.hiddenStatusPageCount > 0 ||
+            audience.statusPages.some((statusPage) => {
+                return this.getTotal(statusPage.subscriberCounts) > 0;
+            }));
+    }
+    /*
+     * The server's answer as the dashboard receives it. Read defensively: the
+     * summary is advisory, and a field that is missing or of the wrong type
+     * must read as "nothing" rather than break the form it sits on.
+     */
+    static fromJSON(json) {
+        const toArray = (value) => {
+            return Array.isArray(value)
+                ? value.filter((item) => {
+                    return Boolean(item) && typeof item === "object";
+                })
+                : [];
+        };
+        const toCount = (value) => {
+            const count = Number(value);
+            return Number.isFinite(count) && count > 0 ? Math.floor(count) : 0;
+        };
+        const toNamed = (item) => {
+            return {
+                statusPageId: String(item["statusPageId"] || ""),
+                name: String(item["name"] || ""),
+            };
+        };
+        const reasons = Object.values(IncidentSubscriberAudienceExclusionReason);
+        return {
+            hasMonitors: json["hasMonitors"] === true,
+            isScoped: json["isScoped"] === true,
+            isHiddenFromStatusPages: json["isHiddenFromStatusPages"] === true,
+            statusPages: toArray(json["statusPages"]).map((item) => {
+                return Object.assign(Object.assign({}, toNamed(item)), { subscriberCounts: this.countsFromJSON(item["subscriberCounts"]) });
+            }),
+            hiddenStatusPageCount: toCount(json["hiddenStatusPageCount"]),
+            excludedStatusPages: toArray(json["excludedStatusPages"])
+                .filter((item) => {
+                return reasons.includes(String(item["reason"]));
+            })
+                .map((item) => {
+                return Object.assign(Object.assign({}, toNamed(item)), { reason: item["reason"] });
+            }),
+            selectedStatusPagesNotListingMonitors: toArray(json["selectedStatusPagesNotListingMonitors"]).map(toNamed),
+        };
+    }
+    /*
+     * One page's counts as they arrive, each a whole number of at least 0: a
+     * count that is missing or not a number reads as 0.
+     */
+    static countsFromJSON(value) {
+        const counts = value && typeof value === "object" && !Array.isArray(value)
+            ? value
+            : {};
+        const toCount = (count) => {
+            const number = Number(count);
+            return Number.isFinite(number) && number > 0 ? Math.floor(number) : 0;
+        };
+        return {
+            email: toCount(counts["email"]),
+            sms: toCount(counts["sms"]),
+            slack: toCount(counts["slack"]),
+            microsoftTeams: toCount(counts["microsoftTeams"]),
+            webhook: toCount(counts["webhook"]),
+        };
+    }
+    static toJSON(audience) {
+        return {
+            hasMonitors: audience.hasMonitors,
+            isScoped: audience.isScoped,
+            isHiddenFromStatusPages: audience.isHiddenFromStatusPages,
+            statusPages: audience.statusPages.map((statusPage) => {
+                return {
+                    statusPageId: statusPage.statusPageId,
+                    name: statusPage.name,
+                    subscriberCounts: Object.assign({}, statusPage.subscriberCounts),
+                };
+            }),
+            hiddenStatusPageCount: audience.hiddenStatusPageCount,
+            excludedStatusPages: audience.excludedStatusPages.map((statusPage) => {
+                return {
+                    statusPageId: statusPage.statusPageId,
+                    name: statusPage.name,
+                    reason: statusPage.reason,
+                };
+            }),
+            selectedStatusPagesNotListingMonitors: audience.selectedStatusPagesNotListingMonitors.map((statusPage) => {
+                return {
+                    statusPageId: statusPage.statusPageId,
+                    name: statusPage.name,
+                };
+            }),
+        };
+    }
+}
+// The route, under the API's base URL.
+IncidentSubscriberAudience.apiPath = "/incident/subscriber-audience";
+// How many monitors or status pages one request may name.
+IncidentSubscriberAudience.maxIdsPerRequest = 1000;
+export default IncidentSubscriberAudience;
+//# sourceMappingURL=IncidentSubscriberAudience.js.map

package/build/dist/Types/StatusPage/IncidentSubscriberAudience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncidentSubscriberAudience.js","sourceRoot":"","sources":["../../../../Types/StatusPage/IncidentSubscriberAudience.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wEAAwE;AACxE,MAAM,CAAN,IAAY,yCAaX;AAbD,WAAY,yCAAyC;IACnD,iDAAiD;IACjD,0FAA6C,CAAA;IAC7C,oEAAoE;IACpE,kGAAqD,CAAA;IACrD,mEAAmE;IACnE,8EAAiC,CAAA;IACjC;;;;OAIG;IACH,gFAAmC,CAAA;AACrC,CAAC,EAbW,yCAAyC,KAAzC,yCAAyC,QAapD;AAsED,uEAAuE;AACvE,MAAM,CAAC,MAAM,qCAAqC,GAG7C;IACH,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;IACpC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;IAChC,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;IACpC,EAAE,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,iBAAiB,EAAE;IACvD,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;CACzC,CAAC;AAEF,MAAqB,0BAA0B;IAOtC,MAAM,CAAC,cAAc;QAC1B,OAAO;YACL,KAAK,EAAE,CAAC;YACR,GAAG,EAAE,CAAC;YACN,KAAK,EAAE,CAAC;YACR,cAAc,EAAE,CAAC;YACjB,OAAO,EAAE,CAAC;SACX,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,MAAwC;QAC7D,OAAO,qCAAqC,CAAC,MAAM,CACjD,CACE,KAAa,EACb,KAAqD,EAC7C,EAAE;YACV,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,CAAC,EACD,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAC/B,MAAwC;QAMxC,OAAO,qCAAqC,CAAC,GAAG,CAC9C,CAAC,KAGA,EAAE,EAAE;YACH,OAAO;gBACL,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;aAClC,CAAC;QACJ,CAAC,CACF,CAAC,MAAM,CAAC,CAAC,KAAwB,EAAW,EAAE;YAC7C,OAAO,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,+CAA+C;IACxC,MAAM,CAAC,aAAa,CACzB,QAA0C;QAE1C,IAAI,QAAQ,CAAC,uBAAuB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC9D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,CACL,QAAQ,CAAC,qBAAqB,GAAG,CAAC;YAClC,QAAQ,CAAC,WAAW,CAAC,IAAI,CACvB,CAAC,UAAgD,EAAW,EAAE;gBAC5D,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACxD,CAAC,CACF,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAgB;QACrC,MAAM,OAAO,GAA0C,CACrD,KAAc,EACK,EAAE;YACrB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACzB,CAAC,CAAE,KAAK,CAAC,MAAM,CAAC,CAAC,IAAa,EAAW,EAAE;oBACvC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC;gBACnD,CAAC,CAAuB;gBAC1B,CAAC,CAAC,EAAE,CAAC;QACT,CAAC,CAAC;QAEF,MAAM,OAAO,GAA+B,CAAC,KAAc,EAAU,EAAE;YACrE,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC;YACpC,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC;QAEF,MAAM,OAAO,GAEoC,CAC/C,IAAgB,EAC2B,EAAE;YAC7C,OAAO;gBACL,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;gBAChD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;aACjC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,OAAO,GAAkB,MAAM,CAAC,MAAM,CAC1C,yCAAyC,CAC1C,CAAC;QAEF,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI;YACzC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI;YACnC,uBAAuB,EAAE,IAAI,CAAC,yBAAyB,CAAC,KAAK,IAAI;YACjE,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAC3C,CAAC,IAAgB,EAAwC,EAAE;gBACzD,uCACK,OAAO,CAAC,IAAI,CAAC,KAChB,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAC/D;YACJ,CAAC,CACF;YACD,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC7D,mBAAmB,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;iBACtD,MAAM,CAAC,CAAC,IAAgB,EAAW,EAAE;gBACpC,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC;iBACD,GAAG,CACF,CAAC,IAAgB,EAAgD,EAAE;gBACjE,uCACK,OAAO,CAAC,IAAI,CAAC,KAChB,MAAM,EAAE,IAAI,CACV,QAAQ,CACoC,IAC9C;YACJ,CAAC,CACF;YACH,qCAAqC,EAAE,OAAO,CAC5C,IAAI,CAAC,uCAAuC,CAAC,CAC9C,CAAC,GAAG,CAAC,OAAO,CAAC;SACf,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAC1B,KAAc;QAEd,MAAM,MAAM,GACV,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACzD,CAAC,CAAE,KAAoB;YACvB,CAAC,CAAC,EAAE,CAAC;QAET,MAAM,OAAO,GAA+B,CAAC,KAAc,EAAU,EAAE;YACrE,MAAM,MAAM,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC;YACrC,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC;QAEF,OAAO;YACL,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/B,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC3B,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/B,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;YACjD,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SACpC,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,QAA0C;QAC7D,OAAO;YACL,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB;YACzD,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CACnC,CAAC,UAAgD,EAAc,EAAE;gBAC/D,OAAO;oBACL,YAAY,EAAE,UAAU,CAAC,YAAY;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,gBAAgB,oBACX,UAAU,CAAC,gBAAgB,CAC/B;iBACF,CAAC;YACJ,CAAC,CACF;YACD,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB;YACrD,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,CACnD,CACE,UAAwD,EAC5C,EAAE;gBACd,OAAO;oBACL,YAAY,EAAE,UAAU,CAAC,YAAY;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,MAAM,EAAE,UAAU,CAAC,MAAM;iBAC1B,CAAC;YACJ,CAAC,CACF;YACD,qCAAqC,EACnC,QAAQ,CAAC,qCAAqC,CAAC,GAAG,CAChD,CACE,UAAqD,EACzC,EAAE;gBACd,OAAO;oBACL,YAAY,EAAE,UAAU,CAAC,YAAY;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACtB,CAAC;YACJ,CAAC,CACF;SACJ,CAAC;IACJ,CAAC;;AAhND,uCAAuC;AAChB,kCAAO,GAAW,+BAA+B,CAAC;AAEzE,0DAA0D;AACnC,2CAAgB,GAAW,IAAI,CAAC;eALpC,0BAA0B"}