@oneuptime/common 14.0.7 → 14.0.9

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

@@ -0,0 +1,277 @@
+import URL from "../API/URL";
+/*
+ * The unsubscribe link every status page subscriber notification carries, and
+ * what the status page's unsubscribe page and its API say about one.
+ *
+ * WHY A TOKEN
+ *
+ * The link used to be the subscriber's manage page,
+ * {statusPageUrl}/update-subscription/{subscriberId}. On a private status page
+ * that page, like everything else on the page, needs a signed-in visitor - and
+ * the people a private page emails are often not people who have an account on
+ * it (a site's staff, a mailing list). So an internal audience had no way to
+ * stop the emails. The link now carries a random token that belongs to the one
+ * subscription (StatusPageSubscriber.unsubscribeToken): holding the link is
+ * what lets its recipient unsubscribe, signed in or not, on a public page or a
+ * private one, and nothing about the page itself is shown to them.
+ *
+ * WHY A CONFIRMATION
+ *
+ * Opening the link changes nothing. Mail scanners and link previewers fetch
+ * every link in a message, and a single stray click is not a decision - least
+ * of all for an address a team added on purpose, such as a site's mailing
+ * list, where one reader could otherwise take the whole site off the list. The
+ * page asks, and only its POST unsubscribes.
+ *
+ * THE LINK'S SHAPE
+ *
+ *   {statusPageUrl}/unsubscribe/{subscriberId}-{token}
+ *
+ * The subscriber id and the token travel as ONE path segment on purpose. The
+ * status page registers "unsubscribe" as a route whose next segment is a
+ * bearer credential (Common/Server/Views/Partials/SensitiveUrlToken.ejs), so
+ * the credential is moved out of the address bar before any analytics tag a
+ * status page loads can report it - the same treatment a password reset link
+ * gets. That mechanism strips exactly one segment. The id is kept in the
+ * credential so the server can find the subscription by its primary key and
+ * compare the token in constant time, rather than look the token itself up.
+ *
+ * A credential with no token - just the id - is what an out-of-date link
+ * leads to (see StatusPageSubscriberAPI's old GET route); the page then says
+ * the link has expired instead of offering to unsubscribe.
+ *
+ * Browser-safe: the status page app, the server and the workers all use this
+ * file, so they agree on the link, the credential and the answers.
+ */
+// What the unsubscribe API answers about a link, before and after confirming.
+export var StatusPageSubscriberUnsubscribeState;
+(function (StatusPageSubscriberUnsubscribeState) {
+    // The link is good and the subscription is live: the page asks to confirm.
+    StatusPageSubscriberUnsubscribeState["Subscribed"] = "Subscribed";
+    // The link is good and the subscription is already cancelled.
+    StatusPageSubscriberUnsubscribeState["Unsubscribed"] = "Unsubscribed";
+    /*
+     * Everything else: a wrong token, a subscriber that does not exist or was
+     * deleted, one on another status page, or a malformed link. One answer for
+     * all of them, so the API cannot be used to find out which subscriptions
+     * exist.
+     */
+    StatusPageSubscriberUnsubscribeState["Invalid"] = "Invalid";
+})(StatusPageSubscriberUnsubscribeState || (StatusPageSubscriberUnsubscribeState = {}));
+// Which kind of subscription a link belongs to, so the page can name it.
+export var StatusPageSubscriberUnsubscribeChannel;
+(function (StatusPageSubscriberUnsubscribeChannel) {
+    StatusPageSubscriberUnsubscribeChannel["Email"] = "Email";
+    StatusPageSubscriberUnsubscribeChannel["SMS"] = "SMS";
+    StatusPageSubscriberUnsubscribeChannel["Slack"] = "Slack";
+    StatusPageSubscriberUnsubscribeChannel["MicrosoftTeams"] = "MicrosoftTeams";
+    StatusPageSubscriberUnsubscribeChannel["Webhook"] = "Webhook";
+})(StatusPageSubscriberUnsubscribeChannel || (StatusPageSubscriberUnsubscribeChannel = {}));
+const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+const TOKEN_PATTERN = /^[0-9a-f]{64}$/;
+const CREDENTIAL_PATTERN = new RegExp(`^(${UUID_PATTERN})(?:-([0-9a-fA-F]{64}))?$`);
+/*
+ * An unsubscribe link's credential anywhere in a text: the route segment, the
+ * subscriber id, and the 64 hex characters of its token. No lookahead after
+ * the token, so a token that some template runs straight into more text is
+ * still caught.
+ */
+const LINK_TOKEN_PATTERN = new RegExp(`(/unsubscribe/${UUID_PATTERN})-[0-9a-fA-F]{64}`, "g");
+class StatusPageSubscriberUnsubscribe {
+    static isWellFormedToken(value) {
+        return typeof value === "string" && TOKEN_PATTERN.test(value);
+    }
+    /*
+     * The text with the token of every unsubscribe link in it replaced by
+     * "[redacted]": ".../unsubscribe/{id}-[redacted]".
+     *
+     * For any copy of a message that is kept where people other than its
+     * recipient can read it. The token is the whole of what lets the link's
+     * holder cancel the subscription without signing in, on a private status
+     * page too, so it may only ever leave the server inside the message to the
+     * subscription's own contact. An SMS is the case in point: the SMS log keeps
+     * its text, and project members who may not touch subscribers (Viewer, and
+     * any role with Read SMS Log) can read that log. The id is kept, so the log
+     * still says which subscription the message went to.
+     */
+    static redactCredentials(text) {
+        if (!text || typeof text !== "string") {
+            return text;
+        }
+        return text.replace(LINK_TOKEN_PATTERN, `$1-${StatusPageSubscriberUnsubscribe.REDACTED_TOKEN}`);
+    }
+    /*
+     * The one path segment the link carries: "{subscriberId}-{token}", or just
+     * the id when there is no token.
+     */
+    static buildCredential(data) {
+        const subscriberId = data.subscriberId.toString().toLowerCase();
+        if (!StatusPageSubscriberUnsubscribe.isWellFormedToken(data.unsubscribeToken)) {
+            return subscriberId;
+        }
+        return `${subscriberId}-${data.unsubscribeToken}`;
+    }
+    /*
+     * Read a credential back. Returns null for anything that is not one - a
+     * stale token from another flow that shares the same sessionStorage slot,
+     * a truncated link, a guess - so the page can show its "invalid link"
+     * state without asking the server.
+     */
+    static parseCredential(value) {
+        if (!value || typeof value !== "string") {
+            return null;
+        }
+        const match = value
+            .trim()
+            .match(CREDENTIAL_PATTERN);
+        if (!match || !match[1]) {
+            return null;
+        }
+        return {
+            subscriberId: match[1].toLowerCase(),
+            token: match[2] ? match[2].toLowerCase() : null,
+        };
+    }
+    /*
+     * The link that goes into every subscriber notification. Without a token -
+     * which only a subscription created around the migration could lack - the
+     * link still leads somewhere useful: the page that says the link is out of
+     * date and what to do instead.
+     */
+    static buildLink(data) {
+        return URL.fromString(data.statusPageUrl.toString()).addRoute(`/${StatusPageSubscriberUnsubscribe.PAGE_ROUTE_SEGMENT}/${StatusPageSubscriberUnsubscribe.buildCredential({
+            subscriberId: data.subscriberId,
+            unsubscribeToken: data.unsubscribeToken,
+        })}`);
+    }
+    /*
+     * The link an SMS to this subscriber carries where every other message
+     * carries its unsubscribe link (unsubscribeUrl, from buildLink).
+     *
+     * On a public status page an SMS keeps the subscriber's manage page,
+     * {statusPageUrl}/update-subscription/{subscriberId}, as it always had.
+     * That page works there without signing in, and is 57 characters shorter
+     * than the token link - and an SMS is billed by the 160-character segment,
+     * so the token link would push most default subscriber texts into another
+     * segment, at a cost to every SMS subscriber on every notification, for
+     * nothing the manage page does not already do. Opening either link changes
+     * nothing by itself.
+     *
+     * On a private status page (or when it is not known whether the page is
+     * public) the manage page needs a signed-in visitor, so the SMS carries the
+     * unsubscribe link, the only way its recipient can stop the texts.
+     *
+     * Email, Slack, Microsoft Teams and webhooks carry the unsubscribe link on
+     * every page: length costs nothing there, and its confirmation page is
+     * what keeps mail scanners from unsubscribing anyone.
+     */
+    static buildSmsLink(data) {
+        if (data.isPublicStatusPage === true) {
+            return StatusPageSubscriberUnsubscribe.buildManageSubscriptionLink({
+                statusPageUrl: data.statusPageUrl,
+                subscriberId: data.subscriberId,
+            }).toString();
+        }
+        return data.unsubscribeUrl.toString();
+    }
+    /*
+     * The subscriber's manage page, where a subscriber on a public status page
+     * (or a signed-in one on a private page) chooses which resources and event
+     * types they hear about. It is keyed by the subscriber id alone and is still
+     * what the "manage your subscription" email links to, and what an SMS from
+     * a public status page carries (see buildSmsLink); every other
+     * notification links to the unsubscribe page instead, which offers this one
+     * on public pages.
+     */
+    static buildManageSubscriptionLink(data) {
+        return URL.fromString(data.statusPageUrl.toString()).addRoute(`/update-subscription/${data.subscriberId.toString()}`);
+    }
+    /*
+     * What the unsubscribe page names the subscription by. An email address is
+     * shown in full: it is where the link was sent, and recognising a shared
+     * address such as site03-all@ is the point. A phone number is masked to its
+     * last four digits. Slack and Teams show the workspace name they were
+     * registered with, and a webhook only its host - never a webhook URL, which
+     * is itself a credential.
+     *
+     * The team's own notice about an unsubscribe passes maskPhone: false - the
+     * team can read the number on the dashboard already, and needs it to know
+     * which subscriber left.
+     */
+    static describeContact(subscriber, options) {
+        const text = (value) => {
+            if (value === null || value === undefined) {
+                return "";
+            }
+            return String(value).trim();
+        };
+        const email = text(subscriber.subscriberEmail);
+        if (email) {
+            return {
+                channel: StatusPageSubscriberUnsubscribeChannel.Email,
+                contact: email,
+            };
+        }
+        const phone = text(subscriber.subscriberPhone);
+        if (phone) {
+            return {
+                channel: StatusPageSubscriberUnsubscribeChannel.SMS,
+                contact: (options === null || options === void 0 ? void 0 : options.maskPhone) === false
+                    ? phone
+                    : StatusPageSubscriberUnsubscribe.maskPhone(phone),
+            };
+        }
+        if (text(subscriber.slackIncomingWebhookUrl) ||
+            text(subscriber.slackWorkspaceName)) {
+            return {
+                channel: StatusPageSubscriberUnsubscribeChannel.Slack,
+                contact: text(subscriber.slackWorkspaceName),
+            };
+        }
+        if (text(subscriber.microsoftTeamsIncomingWebhookUrl) ||
+            text(subscriber.microsoftTeamsWorkspaceName)) {
+            return {
+                channel: StatusPageSubscriberUnsubscribeChannel.MicrosoftTeams,
+                contact: text(subscriber.microsoftTeamsWorkspaceName),
+            };
+        }
+        const webhook = text(subscriber.subscriberWebhook);
+        if (webhook) {
+            return {
+                channel: StatusPageSubscriberUnsubscribeChannel.Webhook,
+                contact: StatusPageSubscriberUnsubscribe.hostOf(webhook),
+            };
+        }
+        return null;
+    }
+    // Every digit but the last four replaced, so the number is recognisable only to its owner.
+    static maskPhone(phone) {
+        const digitCount = (phone.match(/\d/g) || []).length;
+        let digitsSeen = 0;
+        return phone.replace(/\d/g, (digit) => {
+            digitsSeen++;
+            return digitsSeen > digitCount - 4 ? digit : "•";
+        });
+    }
+    static hostOf(url) {
+        const match = url.match(/^[a-zA-Z][a-zA-Z0-9+.-]*:\/\/(?:[^@/?#]*@)?([^/?#:]+)/);
+        return match && match[1] ? match[1].toLowerCase() : "";
+    }
+}
+/*
+ * The status page route segment the link opens, on both a custom domain
+ * (/unsubscribe/...) and the page's own address (/status-page/{id}/unsubscribe/...).
+ * SensitiveUrlToken.ejs and Common/UI/Utils/SensitiveUrlToken.ts list it
+ * as a token-bearing route.
+ */
+StatusPageSubscriberUnsubscribe.PAGE_ROUTE_SEGMENT = "unsubscribe";
+/*
+ * 32 random bytes as lowercase hex (StatusPageSubscriberUnsubscribeToken
+ * generates them; the migration backfills the same shape from two random
+ * UUIDs with their dashes removed).
+ */
+StatusPageSubscriberUnsubscribe.TOKEN_LENGTH = 64;
+// What redactCredentials puts where a token was.
+StatusPageSubscriberUnsubscribe.REDACTED_TOKEN = "[redacted]";
+export default StatusPageSubscriberUnsubscribe;
+//# sourceMappingURL=StatusPageSubscriberUnsubscribe.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StatusPageSubscriberUnsubscribe.js","sourceRoot":"","sources":["../../../../Types/StatusPage/StatusPageSubscriberUnsubscribe.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,8EAA8E;AAC9E,MAAM,CAAN,IAAY,oCAYX;AAZD,WAAY,oCAAoC;IAC9C,2EAA2E;IAC3E,iEAAyB,CAAA;IACzB,8DAA8D;IAC9D,qEAA6B,CAAA;IAC7B;;;;;OAKG;IACH,2DAAmB,CAAA;AACrB,CAAC,EAZW,oCAAoC,KAApC,oCAAoC,QAY/C;AAED,yEAAyE;AACzE,MAAM,CAAN,IAAY,sCAMX;AAND,WAAY,sCAAsC;IAChD,yDAAe,CAAA;IACf,qDAAW,CAAA;IACX,yDAAe,CAAA;IACf,2EAAiC,CAAA;IACjC,6DAAmB,CAAA;AACrB,CAAC,EANW,sCAAsC,KAAtC,sCAAsC,QAMjD;AAmDD,MAAM,YAAY,GAChB,6EAA6E,CAAC;AAEhF,MAAM,aAAa,GAAW,gBAAgB,CAAC;AAE/C,MAAM,kBAAkB,GAAW,IAAI,MAAM,CAC3C,KAAK,YAAY,2BAA2B,CAC7C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,kBAAkB,GAAW,IAAI,MAAM,CAC3C,iBAAiB,YAAY,mBAAmB,EAChD,GAAG,CACJ,CAAC;AAEF,MAAqB,+BAA+B;IAmB3C,MAAM,CAAC,iBAAiB,CAAC,KAAc;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,iBAAiB,CAAC,IAAY;QAC1C,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CACjB,kBAAkB,EAClB,MAAM,+BAA+B,CAAC,cAAc,EAAE,CACvD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,IAG7B;QACC,MAAM,YAAY,GAAW,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;QAExE,IACE,CAAC,+BAA+B,CAAC,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EACzE,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,OAAO,GAAG,YAAY,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAC3B,KAAgC;QAEhC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAA4B,KAAK;aACzC,IAAI,EAAE;aACN,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAE7B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;YACpC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI;SAChD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,IAIvB;QACC,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAC3D,IAAI,+BAA+B,CAAC,kBAAkB,IAAI,+BAA+B,CAAC,eAAe,CACvG;YACE,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CACF,EAAE,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,MAAM,CAAC,YAAY,CAAC,IAK1B;QACC,IAAI,IAAI,CAAC,kBAAkB,KAAK,IAAI,EAAE,CAAC;YACrC,OAAO,+BAA+B,CAAC,2BAA2B,CAAC;gBACjE,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,YAAY,EAAE,IAAI,CAAC,YAAY;aAChC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,2BAA2B,CAAC,IAGzC;QACC,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAC3D,wBAAwB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CACvD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,eAAe,CAC3B,UAA6C,EAC7C,OAAyD;QAEzD,MAAM,IAAI,GAA+B,CAAC,KAAc,EAAU,EAAE;YAClE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9B,CAAC,CAAC;QAEF,MAAM,KAAK,GAAW,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QAEvD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO;gBACL,OAAO,EAAE,sCAAsC,CAAC,KAAK;gBACrD,OAAO,EAAE,KAAK;aACf,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAW,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QAEvD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO;gBACL,OAAO,EAAE,sCAAsC,CAAC,GAAG;gBACnD,OAAO,EACL,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,MAAK,KAAK;oBAC1B,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,+BAA+B,CAAC,SAAS,CAAC,KAAK,CAAC;aACvD,CAAC;QACJ,CAAC;QAED,IACE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;YACxC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,EACnC,CAAC;YACD,OAAO;gBACL,OAAO,EAAE,sCAAsC,CAAC,KAAK;gBACrD,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;aAC7C,CAAC;QACJ,CAAC;QAED,IACE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;YACjD,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC,EAC5C,CAAC;YACD,OAAO;gBACL,OAAO,EAAE,sCAAsC,CAAC,cAAc;gBAC9D,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;aACtD,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAW,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QAE3D,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO;gBACL,OAAO,EAAE,sCAAsC,CAAC,OAAO;gBACvD,OAAO,EAAE,+BAA+B,CAAC,MAAM,CAAC,OAAO,CAAC;aACzD,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,SAAS,CAAC,KAAa;QACnC,MAAM,UAAU,GAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QAC7D,IAAI,UAAU,GAAW,CAAC,CAAC;QAE3B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAa,EAAU,EAAE;YACpD,UAAU,EAAE,CAAC;YACb,OAAO,UAAU,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,GAAW;QAC/B,MAAM,KAAK,GAA4B,GAAG,CAAC,KAAK,CAC9C,uDAAuD,CACxD,CAAC;QAEF,OAAO,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,CAAC;;AAtQD;;;;;GAKG;AACoB,kDAAkB,GAAW,aAAa,CAAC;AAElE;;;;GAIG;AACoB,4CAAY,GAAW,EAAE,CAAC;AAEjD,iDAAiD;AAC1B,8CAAc,GAAW,YAAY,CAAC;eAjB1C,+BAA+B"}

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

@@ -0,0 +1,27 @@
+/*
+ * What a subscriber notification says when its send was interrupted: its
+ * worker crashed, was redeployed or lost its database connection part-way,
+ * so nothing was left to settle it, and the sweeper
+ * (StatusPageSubscriber:TimeoutStuckNotifications) marked it Failed rather
+ * than leave it "being sent" forever.
+ *
+ * Shared by the sweeper, which writes it, and anything that wants to tell an
+ * interruption from an ordinary failure.
+ */
+class SubscriberNotificationInterruption {
+    static isInterruptedMessage(message) {
+        return Boolean(message &&
+            message.startsWith(SubscriberNotificationInterruption.messagePrefix));
+    }
+}
+SubscriberNotificationInterruption.messagePrefix = "Interrupted:";
+/*
+ * For the incident created notification, which records the status pages
+ * it has told as it goes (Incident.statusPagesNotifiedOnCreation), so
+ * Retry picks up after them.
+ */
+SubscriberNotificationInterruption.resumesMessage = `${SubscriberNotificationInterruption.messagePrefix} this notification stopped being sent before it finished, because the server sending it restarted or stopped responding. The status pages it finished are recorded, so Retry sends it only to the status pages that were not sent it in full.`;
+// For every other notification, which Retry sends to every status page.
+SubscriberNotificationInterruption.resendsMessage = `${SubscriberNotificationInterruption.messagePrefix} this notification stopped being sent before it finished, because the server sending it restarted or stopped responding, so some subscribers may not have been sent it. Retry sends it again to every status page, including the subscribers who already got it.`;
+export default SubscriberNotificationInterruption;
+//# sourceMappingURL=SubscriberNotificationInterruption.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriberNotificationInterruption.js","sourceRoot":"","sources":["../../../../Types/StatusPage/SubscriberNotificationInterruption.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAqB,kCAAkC;IAa9C,MAAM,CAAC,oBAAoB,CAChC,OAAkC;QAElC,OAAO,OAAO,CACZ,OAAO;YACL,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC,aAAa,CAAC,CACvE,CAAC;IACJ,CAAC;;AAnBsB,gDAAa,GAAW,cAAc,CAAC;AAE9D;;;;GAIG;AACoB,iDAAc,GAAW,GAAG,kCAAkC,CAAC,aAAa,+OAA+O,CAAC;AAEnV,wEAAwE;AACjD,iDAAc,GAAW,GAAG,kCAAkC,CAAC,aAAa,kQAAkQ,CAAC;eAXnV,kCAAkC"}

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

@@ -0,0 +1,190 @@
+import URL from "../API/URL";
+import IncidentSubscriberAudience from "./IncidentSubscriberAudience";
+import StatusPageSubscriberUnsubscribe from "./StatusPageSubscriberUnsubscribe";
+/*
+ * "Preview notification" and "Send test to me": the email a status page's
+ * subscribers would get about an incident, shown before anything is sent -
+ * on the last step of declaring an incident, and while a public note is being
+ * written.
+ *
+ * The server (App/FeatureSet/Notification/API/SubscriberNotificationPreview)
+ * builds each page's email through SubscriberIncidentEmailBuilder, the one
+ * code path the subscriber jobs send through, and renders it with the mailer's
+ * own MailService.render. So the subject and HTML shown here are the ones a
+ * subscriber gets, apart from one thing: every subscriber's unsubscribe link
+ * carries their own token, which a preview has no subscriber to take it from,
+ * so the preview's link is a sample (getPreviewUnsubscribeUrl).
+ *
+ * Only counts ever leave the server: no subscriber address is read out.
+ *
+ * Everything here is shared by the server, which answers, and the dashboard,
+ * which asks and shows, so the two cannot drift apart.
+ */
+// Which email is previewed.
+export var SubscriberNotificationPreviewEvent;
+(function (SubscriberNotificationPreviewEvent) {
+    // "Incident created", for an incident that is being declared.
+    SubscriberNotificationPreviewEvent["IncidentCreated"] = "IncidentCreated";
+    // "Incident update", for a public note being written on an incident.
+    SubscriberNotificationPreviewEvent["IncidentPublicNoteCreated"] = "IncidentPublicNoteCreated";
+})(SubscriberNotificationPreviewEvent || (SubscriberNotificationPreviewEvent = {}));
+/*
+ * Why a status page's subscribers get the email they get. The jobs use the
+ * page's custom email template only when it has a body and the page sends
+ * through its own SMTP server; everything else gets the default email.
+ */
+export var SubscriberEmailTemplateChoiceReason;
+(function (SubscriberEmailTemplateChoiceReason) {
+    // The page's custom template, sent through the page's own SMTP server.
+    SubscriberEmailTemplateChoiceReason["CustomTemplate"] = "CustomTemplate";
+    // No custom email template is linked to the page for this event.
+    SubscriberEmailTemplateChoiceReason["NoCustomTemplate"] = "NoCustomTemplate";
+    // A custom template is linked, but the page has no SMTP server of its own.
+    SubscriberEmailTemplateChoiceReason["CustomTemplateNeedsCustomSmtp"] = "CustomTemplateNeedsCustomSmtp";
+    // A custom template is linked, but its body is empty.
+    SubscriberEmailTemplateChoiceReason["CustomTemplateIsEmpty"] = "CustomTemplateIsEmpty";
+})(SubscriberEmailTemplateChoiceReason || (SubscriberEmailTemplateChoiceReason = {}));
+// Why nothing will be sent, whatever the email would look like.
+export var SubscriberNotificationPreviewNothingSentReason;
+(function (SubscriberNotificationPreviewNothingSentReason) {
+    // No monitor: subscribers hear about an incident through its monitors.
+    SubscriberNotificationPreviewNothingSentReason["NoMonitors"] = "NoMonitors";
+    // The incident exists and is hidden from status pages (or private).
+    SubscriberNotificationPreviewNothingSentReason["HiddenFromStatusPages"] = "HiddenFromStatusPages";
+    // The incident being declared is private.
+    SubscriberNotificationPreviewNothingSentReason["PrivateIncident"] = "PrivateIncident";
+    // 'Notify Status Page Subscribers' is off on the incident being declared.
+    SubscriberNotificationPreviewNothingSentReason["NotifyOff"] = "NotifyOff";
+    // No status page that lists its monitors will show it.
+    SubscriberNotificationPreviewNothingSentReason["NoStatusPages"] = "NoStatusPages";
+})(SubscriberNotificationPreviewNothingSentReason || (SubscriberNotificationPreviewNothingSentReason = {}));
+class SubscriberNotificationPreview {
+    /*
+     * The unsubscribe link a preview and a test email carry. A subscriber's
+     * real link carries its own token (StatusPageSubscriberUnsubscribe), which
+     * a preview has no subscriber for, so this one names no subscription: the
+     * status page opens it as an out-of-date link and changes nothing.
+     */
+    static getPreviewUnsubscribeUrl(statusPageUrl) {
+        return URL.fromString(statusPageUrl)
+            .addRoute(`/${StatusPageSubscriberUnsubscribe.PAGE_ROUTE_SEGMENT}/preview`)
+            .toString();
+    }
+    static toJSON(result) {
+        return {
+            event: result.event,
+            nothingSentReason: result.nothingSentReason,
+            statusPages: result.statusPages.map((statusPage) => {
+                return {
+                    statusPageId: statusPage.statusPageId,
+                    name: statusPage.name,
+                    subscriberCounts: Object.assign({}, statusPage.subscriberCounts),
+                    subject: statusPage.subject,
+                    html: statusPage.html,
+                    templateChoice: {
+                        usesCustomTemplate: statusPage.templateChoice.usesCustomTemplate,
+                        reason: statusPage.templateChoice.reason,
+                        customTemplateName: statusPage.templateChoice.customTemplateName || null,
+                    },
+                };
+            }),
+            audience: IncidentSubscriberAudience.toJSON(result.audience),
+        };
+    }
+    /*
+     * The server's answer as the dashboard receives it. Read defensively: a
+     * field that is missing or of the wrong type reads as "nothing", so a
+     * preview can never break the form it opens from.
+     */
+    static fromJSON(json) {
+        const events = Object.values(SubscriberNotificationPreviewEvent);
+        const reasons = Object.values(SubscriberNotificationPreviewNothingSentReason);
+        const choiceReasons = Object.values(SubscriberEmailTemplateChoiceReason);
+        const statusPagesJson = Array.isArray(json["statusPages"])
+            ? json["statusPages"].filter((item) => {
+                return Boolean(item) && typeof item === "object";
+            })
+            : [];
+        return {
+            event: events.includes(String(json["event"]))
+                ? json["event"]
+                : SubscriberNotificationPreviewEvent.IncidentCreated,
+            nothingSentReason: reasons.includes(String(json["nothingSentReason"]))
+                ? json["nothingSentReason"]
+                : null,
+            statusPages: statusPagesJson.map((item) => {
+                const choice = item["templateChoice"] || {};
+                return {
+                    statusPageId: String(item["statusPageId"] || ""),
+                    name: String(item["name"] || ""),
+                    subscriberCounts: IncidentSubscriberAudience.countsFromJSON(item["subscriberCounts"]),
+                    subject: String(item["subject"] || ""),
+                    html: String(item["html"] || ""),
+                    templateChoice: {
+                        usesCustomTemplate: choice["usesCustomTemplate"] === true,
+                        reason: choiceReasons.includes(String(choice["reason"]))
+                            ? choice["reason"]
+                            : SubscriberEmailTemplateChoiceReason.NoCustomTemplate,
+                        customTemplateName: typeof choice["customTemplateName"] === "string" &&
+                            choice["customTemplateName"]
+                            ? choice["customTemplateName"]
+                            : undefined,
+                    },
+                };
+            }),
+            audience: IncidentSubscriberAudience.fromJSON(json["audience"] || {}),
+        };
+    }
+    // A request as it travels: the dates as ISO strings.
+    static requestToJSON(request) {
+        const json = {
+            event: request.event,
+        };
+        if (request.event === SubscriberNotificationPreviewEvent.IncidentCreated) {
+            json["incident"] = {
+                title: request.incident.title,
+                description: request.incident.description,
+                incidentSeverityId: request.incident.incidentSeverityId,
+                monitorIds: [...request.incident.monitorIds],
+                statusPageIds: [...request.incident.statusPageIds],
+                labelIds: [...request.incident.labelIds],
+                customFields: Object.assign({}, request.incident.customFields),
+                isPrivate: request.incident.isPrivate,
+                shouldStatusPageSubscribersBeNotifiedOnIncidentCreated: request.incident
+                    .shouldStatusPageSubscribersBeNotifiedOnIncidentCreated,
+            };
+        }
+        else {
+            json["incidentId"] = request.incidentId;
+            json["note"] = request.note;
+            json["postedAt"] = request.postedAt
+                ? request.postedAt.toISOString()
+                : null;
+        }
+        if ("statusPageId" in request && request.statusPageId) {
+            json["statusPageId"] = request.statusPageId;
+        }
+        return json;
+    }
+}
+// Where the router is mounted, under the notification API.
+SubscriberNotificationPreview.routerPath = "/subscriber-notification-preview";
+SubscriberNotificationPreview.previewPath = "/preview";
+SubscriberNotificationPreview.sendTestPath = "/send-test";
+// The longest note or description a preview takes.
+SubscriberNotificationPreview.maxTextLength = 100000;
+// The longest title a preview takes.
+SubscriberNotificationPreview.maxTitleLength = 1000;
+/*
+ * The most custom field values an incident being previewed carries, and
+ * how long they may be together, written out as JSON. Each value is
+ * rendered, Markdown included, and goes into every page's email, so
+ * without a bound one request could make the server render as much as it
+ * can be sent. A project's own fields fit many times over.
+ */
+SubscriberNotificationPreview.maxCustomFieldCount = 250;
+SubscriberNotificationPreview.maxCustomFieldsLength = 200000;
+// What a test email's subject starts with, so it reads as a test.
+SubscriberNotificationPreview.testEmailSubjectPrefix = "[Test] ";
+export default SubscriberNotificationPreview;
+//# sourceMappingURL=SubscriberNotificationPreview.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriberNotificationPreview.js","sourceRoot":"","sources":["../../../../Types/StatusPage/SubscriberNotificationPreview.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B,OAAO,0BAGN,MAAM,8BAA8B,CAAC;AACtC,OAAO,+BAA+B,MAAM,mCAAmC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;GAkBG;AAEH,4BAA4B;AAC5B,MAAM,CAAN,IAAY,kCAKX;AALD,WAAY,kCAAkC;IAC5C,8DAA8D;IAC9D,yEAAmC,CAAA;IACnC,qEAAqE;IACrE,6FAAuD,CAAA;AACzD,CAAC,EALW,kCAAkC,KAAlC,kCAAkC,QAK7C;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,mCASX;AATD,WAAY,mCAAmC;IAC7C,uEAAuE;IACvE,wEAAiC,CAAA;IACjC,iEAAiE;IACjE,4EAAqC,CAAA;IACrC,2EAA2E;IAC3E,sGAA+D,CAAA;IAC/D,sDAAsD;IACtD,sFAA+C,CAAA;AACjD,CAAC,EATW,mCAAmC,KAAnC,mCAAmC,QAS9C;AASD,gEAAgE;AAChE,MAAM,CAAN,IAAY,8CAWX;AAXD,WAAY,8CAA8C;IACxD,uEAAuE;IACvE,2EAAyB,CAAA;IACzB,oEAAoE;IACpE,iGAA+C,CAAA;IAC/C,0CAA0C;IAC1C,qFAAmC,CAAA;IACnC,0EAA0E;IAC1E,yEAAuB,CAAA;IACvB,uDAAuD;IACvD,iFAA+B,CAAA;AACjC,CAAC,EAXW,8CAA8C,KAA9C,8CAA8C,QAWzD;AAwED,MAAqB,6BAA6B;IA6BhD;;;;;OAKG;IACI,MAAM,CAAC,wBAAwB,CAAC,aAAqB;QAC1D,OAAO,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC;aACjC,QAAQ,CACP,IAAI,+BAA+B,CAAC,kBAAkB,UAAU,CACjE;aACA,QAAQ,EAAE,CAAC;IAChB,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,MAA2C;QAE3C,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CACjC,CAAC,UAAmD,EAAc,EAAE;gBAClE,OAAO;oBACL,YAAY,EAAE,UAAU,CAAC,YAAY;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,gBAAgB,oBAAO,UAAU,CAAC,gBAAgB,CAAE;oBACpD,OAAO,EAAE,UAAU,CAAC,OAAO;oBAC3B,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,cAAc,EAAE;wBACd,kBAAkB,EAAE,UAAU,CAAC,cAAc,CAAC,kBAAkB;wBAChE,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,MAAM;wBACxC,kBAAkB,EAChB,UAAU,CAAC,cAAc,CAAC,kBAAkB,IAAI,IAAI;qBACvD;iBACF,CAAC;YACJ,CAAC,CACF;YACD,QAAQ,EAAE,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;SAC7D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CACpB,IAAgB;QAEhB,MAAM,MAAM,GAAkB,MAAM,CAAC,MAAM,CACzC,kCAAkC,CACnC,CAAC;QACF,MAAM,OAAO,GAAkB,MAAM,CAAC,MAAM,CAC1C,8CAA8C,CAC/C,CAAC;QACF,MAAM,aAAa,GAAkB,MAAM,CAAC,MAAM,CAChD,mCAAmC,CACpC,CAAC;QAEF,MAAM,eAAe,GAAsB,KAAK,CAAC,OAAO,CACtD,IAAI,CAAC,aAAa,CAAC,CACpB;YACC,CAAC,CAAG,IAAI,CAAC,aAAa,CAAoB,CAAC,MAAM,CAC7C,CAAC,IAAa,EAAW,EAAE;gBACzB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC;YACnD,CAAC,CACoB;YACzB,CAAC,CAAC,EAAE,CAAC;QAEP,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC3C,CAAC,CAAE,IAAI,CAAC,OAAO,CAAwC;gBACvD,CAAC,CAAC,kCAAkC,CAAC,eAAe;YACtD,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;gBACpE,CAAC,CAAE,IAAI,CACH,mBAAmB,CAC+B;gBACtD,CAAC,CAAC,IAAI;YACR,WAAW,EAAE,eAAe,CAAC,GAAG,CAC9B,CAAC,IAAgB,EAA2C,EAAE;gBAC5D,MAAM,MAAM,GACT,IAAI,CAAC,gBAAgB,CAA4B,IAAI,EAAE,CAAC;gBAE3D,OAAO;oBACL,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;oBAChD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBAChC,gBAAgB,EAAE,0BAA0B,CAAC,cAAc,CACzD,IAAI,CAAC,kBAAkB,CAAC,CACzB;oBACD,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;oBACtC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBAChC,cAAc,EAAE;wBACd,kBAAkB,EAAE,MAAM,CAAC,oBAAoB,CAAC,KAAK,IAAI;wBACzD,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;4BACtD,CAAC,CAAE,MAAM,CAAC,QAAQ,CAAyC;4BAC3D,CAAC,CAAC,mCAAmC,CAAC,gBAAgB;wBACxD,kBAAkB,EAChB,OAAO,MAAM,CAAC,oBAAoB,CAAC,KAAK,QAAQ;4BAChD,MAAM,CAAC,oBAAoB,CAAC;4BAC1B,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC;4BAC9B,CAAC,CAAC,SAAS;qBAChB;iBACF,CAAC;YACJ,CAAC,CACF;YACD,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,CAC1C,IAAI,CAAC,UAAU,CAA4B,IAAI,EAAE,CACnD;SACF,CAAC;IACJ,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,aAAa,CACzB,OAEyC;QAEzC,MAAM,IAAI,GAAe;YACvB,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC;QAEF,IAAI,OAAO,CAAC,KAAK,KAAK,kCAAkC,CAAC,eAAe,EAAE,CAAC;YACzE,IAAI,CAAC,UAAU,CAAC,GAAG;gBACjB,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAC7B,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,WAAW;gBACzC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,CAAC,kBAAkB;gBACvD,UAAU,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;gBAC5C,aAAa,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;gBAClD,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACxC,YAAY,oBAAO,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAE;gBAClD,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;gBACrC,sDAAsD,EACpD,OAAO,CAAC,QAAQ;qBACb,sDAAsD;aAC5D,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;YAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,QAAQ;gBACjC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE;gBAChC,CAAC,CAAC,IAAI,CAAC;QACX,CAAC;QAED,IAAI,cAAc,IAAI,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACtD,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;QAC9C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAhLD,2DAA2D;AACpC,wCAAU,GAC/B,kCAAkC,CAAC;AAEd,yCAAW,GAAW,UAAU,CAAC;AAEjC,0CAAY,GAAW,YAAY,CAAC;AAE3D,mDAAmD;AAC5B,2CAAa,GAAW,MAAM,CAAC;AAEtD,qCAAqC;AACd,4CAAc,GAAW,IAAI,CAAC;AAErD;;;;;;GAMG;AACoB,iDAAmB,GAAW,GAAG,CAAC;AAElC,mDAAqB,GAAW,MAAM,CAAC;AAE9D,kEAAkE;AAC3C,oDAAsB,GAAW,SAAS,CAAC;eA3B/C,6BAA6B"}

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

@@ -0,0 +1,102 @@
+import StatusPageSubscriberNotificationStatus from "./StatusPageSubscriberNotificationStatus";
+/*
+ * Sending a status page subscriber notification again: an incident public
+ * note's, or the notification that an incident was created.
+ *
+ * A notification is sent again by putting its status back to Pending; the
+ * job that sends it picks up Pending rows. What that reaches differs:
+ *
+ * - a public note (and a state change) is sent to every status page the
+ *   incident reaches now, including the pages that were sent it before;
+ * - the incident-created notification keeps a record of the pages it was
+ *   sent to in full (Incident.statusPagesNotifiedOnCreation). Retry after a
+ *   failure resumes after them; Resend after a success, and 'Resend to all
+ *   pages' after a failure (IncidentCreatedResend), empty the record so every
+ *   page is sent it again.
+ *
+ * Which of the two a settled notification offers is decided here, so the
+ * dashboard's buttons and the server's checks cannot drift apart:
+ *
+ * - Success offers Resend: it went out, and someone wants it to go out again
+ *   (a list that was fixed, a page added after a scope change);
+ * - Failed offers Retry: not everyone was sent it;
+ * - Skipped offers nothing. A note posted with notify off keeps
+ *   shouldStatusPageSubscribersBeNotifiedOnNoteCreated false - a column no
+ *   one may update - and the job only sends notes with it true, so a skipped
+ *   note put back to Pending would sit there forever. Other skips (a hidden
+ *   incident, no monitors) would only be skipped again; publishing a hidden
+ *   incident offers its own 'notify' checkbox (IncidentCreatedRenotify);
+ * - Pending and InProgress offer nothing: the notification is on its way.
+ */
+export var SubscriberNotificationResendAction;
+(function (SubscriberNotificationResendAction) {
+    // After a failure: send it again to whoever was not sent it.
+    SubscriberNotificationResendAction["Retry"] = "Retry";
+    // After a success: send it again to everyone it reaches now.
+    SubscriberNotificationResendAction["Resend"] = "Resend";
+})(SubscriberNotificationResendAction || (SubscriberNotificationResendAction = {}));
+class SubscriberNotificationResend {
+    /*
+     * What a notification in `status` offers: Retry after a failure, and
+     * Resend after a success where the caller supports resending one
+     * (`isResendAfterSuccessOffered`). Null for anything else.
+     *
+     * A caller that leaves `isResendAfterSuccessOffered` off keeps the old
+     * behaviour: only a failed notification can be sent again.
+     */
+    static getAction(data) {
+        if (data.status === StatusPageSubscriberNotificationStatus.Failed) {
+            return SubscriberNotificationResendAction.Retry;
+        }
+        if (data.status === StatusPageSubscriberNotificationStatus.Success &&
+            data.isResendAfterSuccessOffered) {
+            return SubscriberNotificationResendAction.Resend;
+        }
+        return null;
+    }
+    /*
+     * Why a public note's notification may not be put back to Pending by a
+     * user or an API key, or null when it may:
+     *
+     * - a note posted with notify off: the job never sends it (see the header),
+     *   so the note would sit in Pending forever;
+     * - a notification being sent right now: the send settles its own status
+     *   when it finishes and would overwrite the Pending, so the request would
+     *   be lost without a word.
+     *
+     * Success and Failed are the cases the dashboard offers. Pending is
+     * allowed and changes nothing. A skipped notification of a note that does
+     * notify (the incident was hidden, or had no monitors, when it went out)
+     * is allowed too: the job looks at it afresh, so it goes out if what
+     * skipped it has changed. The dashboard does not offer that one.
+     */
+    static getPublicNoteResendRefusal(data) {
+        if (data.shouldStatusPageSubscribersBeNotifiedOnNoteCreated === false) {
+            return this.notePostedWithoutNotifyingMessage;
+        }
+        if (data.status === StatusPageSubscriberNotificationStatus.InProgress) {
+            return this.beingSentMessage;
+        }
+        return null;
+    }
+    /*
+     * Whether an update asks for a public note's notification to be sent
+     * again: it writes Pending into the note's 'posted' status column. The
+     * workers write that column too, but as root, which is never checked.
+     */
+    static isPublicNoteResendRequested(data) {
+        return ((data === null || data === void 0 ? void 0 : data.subscriberNotificationStatusOnNoteCreated) ===
+            StatusPageSubscriberNotificationStatus.Pending);
+    }
+}
+/*
+ * Why the server refuses to send a public note's notification again,
+ * shown to whoever asked.
+ */
+SubscriberNotificationResend.notePostedWithoutNotifyingMessage = "This note was posted without notifying subscribers, so there is nothing to resend. Post a new note with Notify Status Page Subscribers ticked to tell them.";
+SubscriberNotificationResend.beingSentMessage = "This notification is being sent right now. Wait until it has finished, then send it again.";
+SubscriberNotificationResend.noPermissionToResendNoteMessage = "You do not have permission to send this note's notification again. Sending it again needs the permission to post public notes that notify subscribers, as well as the permission to edit public notes.";
+SubscriberNotificationResend.noPermissionToNotifyAboutEditMessage = "You do not have permission to notify subscribers about this edit. Notifying them needs the permission to post public notes that notify subscribers, as well as the permission to edit public notes. Save the edit without notifying subscribers, or ask someone who can post notifying notes.";
+SubscriberNotificationResend.updateBeingSentMessage = "This note's update notification is being sent right now. Wait until it has finished, then save your edit with Notify subscribers about this update ticked again - or save it without notifying subscribers.";
+export default SubscriberNotificationResend;
+//# sourceMappingURL=SubscriberNotificationResend.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriberNotificationResend.js","sourceRoot":"","sources":["../../../../Types/StatusPage/SubscriberNotificationResend.ts"],"names":[],"mappings":"AAAA,OAAO,sCAAsC,MAAM,0CAA0C,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAN,IAAY,kCAKX;AALD,WAAY,kCAAkC;IAC5C,6DAA6D;IAC7D,qDAAe,CAAA;IACf,6DAA6D;IAC7D,uDAAiB,CAAA;AACnB,CAAC,EALW,kCAAkC,KAAlC,kCAAkC,QAK7C;AAED,MAAqB,4BAA4B;IAoB/C;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAAC,IAGvB;QACC,IAAI,IAAI,CAAC,MAAM,KAAK,sCAAsC,CAAC,MAAM,EAAE,CAAC;YAClE,OAAO,kCAAkC,CAAC,KAAK,CAAC;QAClD,CAAC;QAED,IACE,IAAI,CAAC,MAAM,KAAK,sCAAsC,CAAC,OAAO;YAC9D,IAAI,CAAC,2BAA2B,EAChC,CAAC;YACD,OAAO,kCAAkC,CAAC,MAAM,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,0BAA0B,CAAC,IAMxC;QACC,IAAI,IAAI,CAAC,kDAAkD,KAAK,KAAK,EAAE,CAAC;YACtE,OAAO,IAAI,CAAC,iCAAiC,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,sCAAsC,CAAC,UAAU,EAAE,CAAC;YACtE,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,2BAA2B,CACvC,IAAyE;QAEzE,OAAO,CACL,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,yCAAyC;YAC/C,sCAAsC,CAAC,OAAO,CAC/C,CAAC;IACJ,CAAC;;AA3FD;;;GAGG;AACoB,8DAAiC,GACtD,6JAA6J,CAAC;AAEzI,6CAAgB,GACrC,4FAA4F,CAAC;AAExE,4DAA+B,GACpD,wMAAwM,CAAC;AAEpL,iEAAoC,GACzD,+RAA+R,CAAC;AAE3Q,mDAAsB,GAC3C,6MAA6M,CAAC;eAlB7L,4BAA4B"}