@vex-chat/spire 1.10.4 → 1.11.0

package/dist/NotificationService.js

@@ -0,0 +1,386 @@
+/**
+ * Copyright (c) 2020-2026 Vex Heavy Industries LLC
+ * Licensed under AGPL-3.0. See LICENSE for details.
+ * Commercial licenses available at vex.wtf
+ */
+const EXPO_PUSH_ENDPOINT = "https://exp.host/--/api/v2/push/send";
+const EXPO_RECEIPT_ENDPOINT = "https://exp.host/--/api/v2/push/getReceipts";
+const EXPO_BATCH_SIZE = 100;
+const EXPO_RECEIPT_DELAY_MS = 15 * 60 * 1000;
+const EXPO_REQUEST_TIMEOUT_MS = 10_000;
+const ANDROID_PUSH_CHANNEL_ID = "vex-push-messages-v2";
+const MESSAGE_PUSH_COLLAPSE_ID = "vex-message-summary";
+export class NotificationService {
+    clients;
+    db;
+    pendingReceipts = new Map();
+    receiptDelayMs;
+    removeClient;
+    constructor(db, clients, removeClient, options = {}) {
+        this.clients = clients;
+        this.db = db;
+        this.receiptDelayMs = options.receiptDelayMs ?? EXPO_RECEIPT_DELAY_MS;
+        this.removeClient = removeClient;
+    }
+    notify(dispatch) {
+        this.notifyWebSocket(dispatch);
+        void this.notifyPush(dispatch).catch((err) => {
+            // Push is best-effort; websocket/inbox delivery remain authoritative.
+            console.warn("[spire-notify] Expo push fanout failed", {
+                event: dispatch.event,
+                message: err instanceof Error ? err.message : String(err),
+                transmissionID: dispatch.transmissionID,
+                userID: dispatch.userID,
+            });
+        });
+    }
+    async checkExpoReceipts(receiptIDs) {
+        const pendingIDs = receiptIDs.filter((id) => this.pendingReceipts.has(id));
+        if (pendingIDs.length === 0)
+            return;
+        let payload;
+        try {
+            const res = await fetchWithTimeout(EXPO_RECEIPT_ENDPOINT, {
+                body: JSON.stringify({ ids: pendingIDs }),
+                headers: {
+                    Accept: "application/json",
+                    "Content-Type": "application/json",
+                },
+                method: "POST",
+            }, "Expo receipt request");
+            if (!res.ok) {
+                throw new Error(`Expo receipt request failed with status ${res.status.toString()}`);
+            }
+            payload = parseExpoReceiptResponse(await res.json());
+        }
+        catch (err) {
+            this.dropPendingReceipts(pendingIDs);
+            throw err;
+        }
+        if (payload.errors.length > 0) {
+            console.warn("[spire-notify] Expo receipt request errors", {
+                errors: payload.errors,
+                receiptIDs: pendingIDs,
+            });
+        }
+        const receipts = payload.receipts;
+        for (const receiptID of pendingIDs) {
+            const receipt = receipts[receiptID];
+            if (!receipt) {
+                console.warn("[spire-notify] Expo receipt missing", {
+                    receiptID,
+                });
+                this.pendingReceipts.delete(receiptID);
+                continue;
+            }
+            const pending = this.pendingReceipts.get(receiptID);
+            this.pendingReceipts.delete(receiptID);
+            if (!pending || receipt.status === "ok")
+                continue;
+            await this.handleExpoDeliveryError("receipt", pending.subscription, {
+                event: pending.event,
+                transmissionID: pending.transmissionID,
+            }, receipt);
+        }
+    }
+    dropPendingReceipts(receiptIDs) {
+        for (const receiptID of receiptIDs) {
+            this.pendingReceipts.delete(receiptID);
+        }
+    }
+    async handleExpoDeliveryError(stage, subscription, dispatch, err) {
+        const code = err.details?.error;
+        console.warn("[spire-notify] Expo push delivery error", {
+            code,
+            event: dispatch.event,
+            message: err.message,
+            stage,
+            subscriptionID: subscription.subscriptionID,
+            transmissionID: dispatch.transmissionID,
+        });
+        if (code !== "DeviceNotRegistered")
+            return;
+        await this.db.removeNotificationSubscription({
+            deviceID: subscription.deviceID,
+            subscriptionID: subscription.subscriptionID,
+            userID: subscription.userID,
+        });
+    }
+    async notifyPush(dispatch) {
+        const query = {
+            event: dispatch.event,
+            userID: dispatch.userID,
+        };
+        const subscriptions = await this.db.retrieveNotificationSubscriptions(dispatch.deviceID
+            ? { ...query, deviceID: dispatch.deviceID }
+            : query);
+        const expoSubscriptions = subscriptions;
+        if (expoSubscriptions.length === 0) {
+            console.info("[spire-notify] no Expo push subscriptions", {
+                deviceScoped: Boolean(dispatch.deviceID),
+                event: dispatch.event,
+                transmissionID: dispatch.transmissionID,
+                userID: dispatch.userID,
+            });
+            return;
+        }
+        for (let i = 0; i < expoSubscriptions.length; i += EXPO_BATCH_SIZE) {
+            const batch = expoSubscriptions.slice(i, i + EXPO_BATCH_SIZE);
+            await this.sendExpoBatch(batch, dispatch);
+        }
+    }
+    notifyWebSocket(dispatch) {
+        const msg = {
+            data: dispatch.data,
+            event: dispatch.event,
+            transmissionID: dispatch.transmissionID,
+            type: "notify",
+        };
+        const snapshot = this.clients.slice();
+        for (const client of snapshot) {
+            try {
+                if (client.hasFailed()) {
+                    this.removeClient(client);
+                    continue;
+                }
+                if (dispatch.deviceID) {
+                    const currentDeviceID = client.getDeviceID();
+                    if (currentDeviceID === null) {
+                        this.removeClient(client);
+                        continue;
+                    }
+                    if (currentDeviceID === dispatch.deviceID) {
+                        client.send(msg);
+                    }
+                    continue;
+                }
+                const currentUserID = client.getUserID();
+                if (currentUserID === null) {
+                    this.removeClient(client);
+                    continue;
+                }
+                if (currentUserID === dispatch.userID) {
+                    client.send(msg);
+                }
+            }
+            catch (_err) {
+                this.removeClient(client);
+            }
+        }
+    }
+    scheduleReceiptCheck(receiptIDs) {
+        const timer = setTimeout(() => {
+            void this.checkExpoReceipts(receiptIDs).catch((err) => {
+                console.warn("[spire-notify] Expo receipt check failed", err instanceof Error ? err.message : String(err));
+            });
+        }, this.receiptDelayMs);
+        timer.unref?.();
+    }
+    async sendExpoBatch(subscriptions, dispatch) {
+        const headless = shouldSendHeadlessPush(dispatch);
+        const messages = subscriptions.map((sub) => expoMessageForSubscription(sub, dispatch, headless));
+        console.info("[spire-notify] sending Expo push batch", {
+            channelIDs: [
+                ...new Set(messages
+                    .map((msg) => msg["channelId"])
+                    .filter((value) => {
+                    return typeof value === "string";
+                })),
+            ],
+            event: dispatch.event,
+            headless,
+            platforms: [...new Set(subscriptions.map((sub) => sub.platform))],
+            size: subscriptions.length,
+            transmissionID: dispatch.transmissionID,
+        });
+        const res = await fetchWithTimeout(EXPO_PUSH_ENDPOINT, {
+            body: JSON.stringify(messages),
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+            },
+            method: "POST",
+        }, "Expo push request");
+        if (!res.ok) {
+            const body = await res.text().catch(() => "");
+            throw new Error(`Expo push request failed with status ${res.status.toString()}${body ? `: ${body.slice(0, 500)}` : ""}`);
+        }
+        const payload = parseExpoPushResponse(await res.json());
+        if (payload.errors.length > 0) {
+            console.warn("[spire-notify] Expo push request errors", {
+                errors: payload.errors,
+                event: dispatch.event,
+                transmissionID: dispatch.transmissionID,
+            });
+        }
+        const tickets = payload.tickets;
+        console.info("[spire-notify] Expo push tickets received", {
+            errors: tickets.filter((ticket) => ticket.status === "error")
+                .length,
+            event: dispatch.event,
+            ok: tickets.filter((ticket) => ticket.status === "ok").length,
+            transmissionID: dispatch.transmissionID,
+        });
+        for (const [idx, ticket] of tickets.entries()) {
+            const subscription = subscriptions[idx];
+            if (!subscription)
+                continue;
+            if (ticket.status === "error") {
+                await this.handleExpoDeliveryError("ticket", subscription, dispatch, ticket);
+                continue;
+            }
+            this.pendingReceipts.set(ticket.id, {
+                event: dispatch.event,
+                subscription,
+                transmissionID: dispatch.transmissionID,
+            });
+        }
+        const receiptIDs = tickets.flatMap((ticket) => ticket.status === "ok" ? [ticket.id] : []);
+        if (receiptIDs.length > 0) {
+            this.scheduleReceiptCheck(receiptIDs);
+        }
+    }
+}
+function bodyForEvent(event) {
+    if (event === "mail")
+        return undefined;
+    if (event === "deviceRequest")
+        return "Review the device request.";
+    if (event === "deviceListChanged")
+        return "Your device list changed.";
+    return "Open Vex for the latest update.";
+}
+function expoMessageForSubscription(subscription, dispatch, headless) {
+    if (headless) {
+        return {
+            _contentAvailable: true,
+            data: {
+                deviceID: dispatch.deviceID ?? null,
+                event: dispatch.event,
+                headless: true,
+                transmissionID: dispatch.transmissionID,
+            },
+            priority: subscription.platform === "android" ? "high" : undefined,
+            to: subscription.token,
+        };
+    }
+    const title = titleForEvent(dispatch.event);
+    const body = bodyForEvent(dispatch.event);
+    const data = {
+        deviceID: dispatch.deviceID ?? null,
+        event: dispatch.event,
+        title,
+        transmissionID: dispatch.transmissionID,
+    };
+    const message = {
+        channelId: subscription.platform === "android"
+            ? ANDROID_PUSH_CHANNEL_ID
+            : undefined,
+        data,
+        priority: subscription.platform === "android" ? "high" : undefined,
+        // Do not set `sound: "default"` here. Current mobile native
+        // notification modules can treat it as a custom sound resource named
+        // "default" instead of the platform default, which causes warnings when
+        // no such bundled resource exists.
+        title,
+        to: subscription.token,
+    };
+    if (body) {
+        message["body"] = body;
+    }
+    if (dispatch.event === "mail") {
+        message["collapseId"] = MESSAGE_PUSH_COLLAPSE_ID;
+        if (subscription.platform === "android") {
+            message["tag"] = MESSAGE_PUSH_COLLAPSE_ID;
+        }
+    }
+    return message;
+}
+async function fetchWithTimeout(input, init, label) {
+    const controller = new AbortController();
+    const timer = setTimeout(() => {
+        controller.abort();
+    }, EXPO_REQUEST_TIMEOUT_MS);
+    timer.unref?.();
+    try {
+        return await fetch(input, {
+            ...init,
+            signal: controller.signal,
+        });
+    }
+    catch (err) {
+        if (err instanceof Error &&
+            (err.name === "AbortError" || err.name === "TimeoutError")) {
+            throw new Error(`${label} timed out after ${EXPO_REQUEST_TIMEOUT_MS.toString()}ms`, { cause: err });
+        }
+        throw err;
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+function isExpoPushReceipt(value) {
+    if (!isRecord(value))
+        return false;
+    return value["status"] === "ok" || value["status"] === "error";
+}
+function isExpoPushTicket(value) {
+    if (!isRecord(value))
+        return false;
+    if (value["status"] === "ok") {
+        return typeof value["id"] === "string";
+    }
+    return value["status"] === "error";
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null;
+}
+function normalizeExpoTickets(data) {
+    if (!data)
+        return [];
+    const tickets = Array.isArray(data) ? data : [data];
+    return tickets.filter(isExpoPushTicket);
+}
+function parseExpoPushResponse(raw) {
+    if (!isRecord(raw)) {
+        return { errors: [], tickets: [] };
+    }
+    return {
+        errors: Array.isArray(raw["errors"]) ? raw["errors"] : [],
+        tickets: normalizeExpoTickets(raw["data"]),
+    };
+}
+function parseExpoReceiptResponse(raw) {
+    if (!isRecord(raw)) {
+        return { errors: [], receipts: {} };
+    }
+    return {
+        errors: Array.isArray(raw["errors"]) ? raw["errors"] : [],
+        receipts: parseExpoReceipts(raw["data"]),
+    };
+}
+function parseExpoReceipts(data) {
+    if (!isRecord(data))
+        return {};
+    const receipts = {};
+    for (const [receiptID, receipt] of Object.entries(data)) {
+        if (isExpoPushReceipt(receipt)) {
+            receipts[receiptID] = receipt;
+        }
+    }
+    return receipts;
+}
+function shouldSendHeadlessPush(dispatch) {
+    return (dispatch.headlessPushUserID !== undefined &&
+        dispatch.userID === dispatch.headlessPushUserID);
+}
+function titleForEvent(event) {
+    if (event === "mail")
+        return "New Message";
+    if (event === "deviceRequest")
+        return "Device approval request";
+    if (event === "deviceListChanged")
+        return "Vex device update";
+    return "Vex notification";
+}
+//# sourceMappingURL=NotificationService.js.map

package/dist/NotificationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationService.js","sourceRoot":"","sources":["../src/NotificationService.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,MAAM,kBAAkB,GAAG,sCAAsC,CAAC;AAClE,MAAM,qBAAqB,GAAG,6CAA6C,CAAC;AAC5E,MAAM,eAAe,GAAG,GAAG,CAAC;AAC5B,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAC7C,MAAM,uBAAuB,GAAG,MAAM,CAAC;AACvC,MAAM,uBAAuB,GAAG,sBAAsB,CAAC;AACvD,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;AAyDvD,MAAM,OAAO,mBAAmB;IACX,OAAO,CAAkB;IACzB,EAAE,CAAW;IACb,eAAe,GAAG,IAAI,GAAG,EAA0B,CAAC;IACpD,cAAc,CAAS;IACvB,YAAY,CAAkC;IAE/D,YACI,EAAY,EACZ,OAAwB,EACxB,YAA6C,EAC7C,UAAsC,EAAE;QAExC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,qBAAqB,CAAC;QACtE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,QAA8B;QACxC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC/B,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;YAClD,sEAAsE;YACtE,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE;gBACnD,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;gBACzD,cAAc,EAAE,QAAQ,CAAC,cAAc;gBACvC,MAAM,EAAE,QAAQ,CAAC,MAAM;aAC1B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,UAAoB;QAChD,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CACxC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAC/B,CAAC;QACF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEpC,IAAI,OAAkC,CAAC;QACvC,IAAI,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAC9B,qBAAqB,EACrB;gBACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;gBACzC,OAAO,EAAE;oBACL,MAAM,EAAE,kBAAkB;oBAC1B,cAAc,EAAE,kBAAkB;iBACrC;gBACD,MAAM,EAAE,MAAM;aACjB,EACD,sBAAsB,CACzB,CAAC;YAEF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CACX,2CAA2C,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CACrE,CAAC;YACN,CAAC;YAED,OAAO,GAAG,wBAAwB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACpB,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YACrC,MAAM,GAAG,CAAC;QACd,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE;gBACvD,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,UAAU,EAAE,UAAU;aACzB,CAAC,CAAC;QACP,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE;oBAChD,SAAS;iBACZ,CAAC,CAAC;gBACH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACvC,SAAS;YACb,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACvC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI;gBAAE,SAAS;YAElD,MAAM,IAAI,CAAC,uBAAuB,CAC9B,SAAS,EACT,OAAO,CAAC,YAAY,EACpB;gBACI,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,cAAc,EAAE,OAAO,CAAC,cAAc;aACzC,EACD,OAAO,CACV,CAAC;QACN,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,UAAoB;QAC5C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACjC,KAA2B,EAC3B,YAAsC,EACtC,QAAgE,EAChE,GAAqD;QAErD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE;YACpD,IAAI;YACJ,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK;YACL,cAAc,EAAE,YAAY,CAAC,cAAc;YAC3C,cAAc,EAAE,QAAQ,CAAC,cAAc;SAC1C,CAAC,CAAC;QAEH,IAAI,IAAI,KAAK,qBAAqB;YAAE,OAAO;QAE3C,MAAM,IAAI,CAAC,EAAE,CAAC,8BAA8B,CAAC;YACzC,QAAQ,EAAE,YAAY,CAAC,QAAQ;YAC/B,cAAc,EAAE,YAAY,CAAC,cAAc;YAC3C,MAAM,EAAE,YAAY,CAAC,MAAM;SAC9B,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,QAA8B;QACnD,MAAM,KAAK,GAAG;YACV,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;SAC1B,CAAC;QACF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,iCAAiC,CACjE,QAAQ,CAAC,QAAQ;YACb,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;YAC3C,CAAC,CAAC,KAAK,CACd,CAAC;QACF,MAAM,iBAAiB,GAAG,aAAa,CAAC;QACxC,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,IAAI,CAAC,2CAA2C,EAAE;gBACtD,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACxC,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,cAAc,EAAE,QAAQ,CAAC,cAAc;gBACvC,MAAM,EAAE,QAAQ,CAAC,MAAM;aAC1B,CAAC,CAAC;YACH,OAAO;QACX,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC;YACjE,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,QAA8B;QAClD,MAAM,GAAG,GAAc;YACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,cAAc,EAAE,QAAQ,CAAC,cAAc;YACvC,IAAI,EAAE,QAAQ;SACjB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACtC,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACD,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;oBACrB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;oBAC1B,SAAS;gBACb,CAAC;gBAED,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBACpB,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;oBAC7C,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;wBAC3B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;wBAC1B,SAAS;oBACb,CAAC;oBACD,IAAI,eAAe,KAAK,QAAQ,CAAC,QAAQ,EAAE,CAAC;wBACxC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACrB,CAAC;oBACD,SAAS;gBACb,CAAC;gBAED,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACzC,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;oBACzB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;oBAC1B,SAAS;gBACb,CAAC;gBACD,IAAI,aAAa,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACpC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC;YACL,CAAC;YAAC,OAAO,IAAa,EAAE,CAAC;gBACrB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;IACL,CAAC;IAEO,oBAAoB,CAAC,UAAoB;QAC7C,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC1B,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;gBAC3D,OAAO,CAAC,IAAI,CACR,0CAA0C,EAC1C,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CACnD,CAAC;YACN,CAAC,CAAC,CAAC;QACP,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACvB,KAAgC,CAAC,KAAK,EAAE,EAAE,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,aAAa,CACvB,aAAyC,EACzC,QAA8B;QAE9B,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACvC,0BAA0B,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,CACtD,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE;YACnD,UAAU,EAAE;gBACR,GAAG,IAAI,GAAG,CACN,QAAQ;qBACH,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;qBAC9B,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE;oBAC/B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;gBACrC,CAAC,CAAC,CACT;aACJ;YACD,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,QAAQ;YACR,SAAS,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;YACjE,IAAI,EAAE,aAAa,CAAC,MAAM;YAC1B,cAAc,EAAE,QAAQ,CAAC,cAAc;SAC1C,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAC9B,kBAAkB,EAClB;YACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC9B,OAAO,EAAE;gBACL,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACrC;YACD,MAAM,EAAE,MAAM;SACjB,EACD,mBAAmB,CACtB,CAAC;QAEF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACV,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YAC9C,MAAM,IAAI,KAAK,CACX,wCAAwC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1G,CAAC;QACN,CAAC;QAED,MAAM,OAAO,GAAG,qBAAqB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACxD,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE;gBACpD,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,cAAc,EAAE,QAAQ,CAAC,cAAc;aAC1C,CAAC,CAAC;QACP,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,2CAA2C,EAAE;YACtD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,OAAO,CAAC;iBACxD,MAAM;YACX,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,MAAM;YAC7D,cAAc,EAAE,QAAQ,CAAC,cAAc;SAC1C,CAAC,CAAC;QACH,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5C,MAAM,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,YAAY;gBAAE,SAAS;YAE5B,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC5B,MAAM,IAAI,CAAC,uBAAuB,CAC9B,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,MAAM,CACT,CAAC;gBACF,SAAS;YACb,CAAC;YAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE;gBAChC,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,YAAY;gBACZ,cAAc,EAAE,QAAQ,CAAC,cAAc;aAC1C,CAAC,CAAC;QACP,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAC1C,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAC5C,CAAC;QACF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;IACL,CAAC;CACJ;AAED,SAAS,YAAY,CAAC,KAAa;IAC/B,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,SAAS,CAAC;IACvC,IAAI,KAAK,KAAK,eAAe;QAAE,OAAO,4BAA4B,CAAC;IACnE,IAAI,KAAK,KAAK,mBAAmB;QAAE,OAAO,2BAA2B,CAAC;IACtE,OAAO,iCAAiC,CAAC;AAC7C,CAAC;AAED,SAAS,0BAA0B,CAC/B,YAAsC,EACtC,QAA8B,EAC9B,QAAiB;IAEjB,IAAI,QAAQ,EAAE,CAAC;QACX,OAAO;YACH,iBAAiB,EAAE,IAAI;YACvB,IAAI,EAAE;gBACF,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,IAAI;gBACnC,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,QAAQ,EAAE,IAAI;gBACd,cAAc,EAAE,QAAQ,CAAC,cAAc;aAC1C;YACD,QAAQ,EAAE,YAAY,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;YAClE,EAAE,EAAE,YAAY,CAAC,KAAK;SACzB,CAAC;IACN,CAAC;IAED,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG;QACT,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,IAAI;QACnC,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,KAAK;QACL,cAAc,EAAE,QAAQ,CAAC,cAAc;KAC1C,CAAC;IAEF,MAAM,OAAO,GAA4B;QACrC,SAAS,EACL,YAAY,CAAC,QAAQ,KAAK,SAAS;YAC/B,CAAC,CAAC,uBAAuB;YACzB,CAAC,CAAC,SAAS;QACnB,IAAI;QACJ,QAAQ,EAAE,YAAY,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QAClE,4DAA4D;QAC5D,qEAAqE;QACrE,wEAAwE;QACxE,mCAAmC;QACnC,KAAK;QACL,EAAE,EAAE,YAAY,CAAC,KAAK;KACzB,CAAC;IACF,IAAI,IAAI,EAAE,CAAC;QACP,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,CAAC,YAAY,CAAC,GAAG,wBAAwB,CAAC;QACjD,IAAI,YAAY,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,CAAC,KAAK,CAAC,GAAG,wBAAwB,CAAC;QAC9C,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC3B,KAAa,EACb,IAAiB,EACjB,KAAa;IAEb,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;QAC1B,UAAU,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,EAAE,uBAAuB,CAAC,CAAC;IAC3B,KAAgC,CAAC,KAAK,EAAE,EAAE,CAAC;IAC5C,IAAI,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,KAAK,EAAE;YACtB,GAAG,IAAI;YACP,MAAM,EAAE,UAAU,CAAC,MAAM;SAC5B,CAAC,CAAC;IACP,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACpB,IACI,GAAG,YAAY,KAAK;YACpB,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,IAAI,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,EAC5D,CAAC;YACC,MAAM,IAAI,KAAK,CACX,GAAG,KAAK,oBAAoB,uBAAuB,CAAC,QAAQ,EAAE,IAAI,EAClE,EAAE,KAAK,EAAE,GAAG,EAAE,CACjB,CAAC;QACN,CAAC;QACD,MAAM,GAAG,CAAC;IACd,CAAC;YAAS,CAAC;QACP,YAAY,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACrC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC;AACnE,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC;IAC3C,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC;AACvC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACvD,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAa;IACvC,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAY;IACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACvC,CAAC;IACD,OAAO;QACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;QACzD,OAAO,EAAE,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAC7C,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,GAAY;IAC1C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACxC,CAAC;IACD,OAAO;QACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;QACzD,QAAQ,EAAE,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAC3C,CAAC;AACN,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAa;IACpC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAoC,EAAE,CAAC;IACrD,KAAK,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACtD,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC;QAClC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,SAAS,sBAAsB,CAAC,QAA8B;IAC1D,OAAO,CACH,QAAQ,CAAC,kBAAkB,KAAK,SAAS;QACzC,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,kBAAkB,CAClD,CAAC;AACN,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAChC,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,aAAa,CAAC;IAC3C,IAAI,KAAK,KAAK,eAAe;QAAE,OAAO,yBAAyB,CAAC;IAChE,IAAI,KAAK,KAAK,mBAAmB;QAAE,OAAO,mBAAmB,CAAC;IAC9D,OAAO,kBAAkB,CAAC;AAC9B,CAAC"}

package/dist/Spire.d.ts

@@ -34,6 +34,7 @@ export declare class Spire extends EventEmitter {
     private dbReady;
     private deviceChallenges;
     private mailPruneInterval;
+    private notifications;
     private queuedRequestIncrements;
     private requestsTotal;
     private requestsTotalLoaded;

package/dist/Spire.js

@@ -20,6 +20,7 @@ import { WebSocketServer } from "ws";
 import { z } from "zod/v4";
 import { ClientManager } from "./ClientManager.js";
 import { Database, hashPasswordArgon2, verifyPassword } from "./Database.js";
+import { NotificationService } from "./NotificationService.js";
 import { initApp, protect } from "./server/index.js";
 import { MailIngressValidationError, validateMailIngress, } from "./server/mailIngress.js";
 import { authLimiter, devApiKeySkipsRateLimits } from "./server/rateLimit.js";
@@ -69,6 +70,12 @@ const mailPostPayload = z.object({
     header: z.custom((val) => val instanceof Uint8Array),
     mail: MailWSSchema,
 });
+const notificationSubscribePayload = z.object({
+    channel: z.literal("expo"),
+    events: z.array(z.string().min(1)).default(["mail"]),
+    platform: z.enum(["android", "ios", "web"]).optional(),
+    token: z.string().min(1),
+});
 const directories = ["files", "avatars", "emoji"];
 for (const dir of directories) {
     if (!fs.existsSync(dir)) {
@@ -132,6 +139,7 @@ export class Spire extends EventEmitter {
     dbReady = false;
     deviceChallenges = new Map();
     mailPruneInterval = null;
+    notifications;
     queuedRequestIncrements = 0;
     requestsTotal = 0;
     requestsTotalLoaded = false;
@@ -164,6 +172,7 @@ export class Spire extends EventEmitter {
         // If spire is deployed without a proxy, set this to 0 instead.
         this.api.set("trust proxy", 1);
         this.db = new Database(options);
+        this.notifications = new NotificationService(this.db, this.clients, this.removeClient.bind(this));
         this.db.on("ready", () => {
             this.dbReady = true;
             void this.db.pruneExpiredMail().catch(() => {
@@ -618,7 +627,52 @@ export class Spire extends EventEmitter {
             }
             await this.db.saveMail(mail, header, senderDeviceDetails.deviceID, authorUserDetails.userID);
             res.sendStatus(200);
-            this.notify(recipientDeviceDetails.owner, "mail", crypto.randomUUID(), null, mail.recipient);
+            this.notify(recipientDeviceDetails.owner, "mail", crypto.randomUUID(), null, mail.recipient, mail.authorID);
+        });
+        this.api.post("/device/:id/notifications/subscriptions", protect, async (req, res) => {
+            const device = req.device;
+            if (!device) {
+                res.sendStatus(401);
+                return;
+            }
+            if (device.deviceID !== getParam(req, "id")) {
+                res.sendStatus(403);
+                return;
+            }
+            const parsed = notificationSubscribePayload.safeParse(req.body);
+            if (!parsed.success) {
+                res.status(400).json({
+                    error: "Invalid notification subscription payload",
+                    issues: parsed.error.issues,
+                });
+                return;
+            }
+            const subscription = await this.db.saveNotificationSubscription({
+                channel: parsed.data.channel,
+                deviceID: device.deviceID,
+                events: parsed.data.events,
+                platform: parsed.data.platform ?? null,
+                token: parsed.data.token,
+                userID: getUser(req).userID,
+            });
+            res.status(201).json(subscription);
+        });
+        this.api.delete("/device/:id/notifications/subscriptions/:subscriptionID", protect, async (req, res) => {
+            const device = req.device;
+            if (!device) {
+                res.sendStatus(401);
+                return;
+            }
+            if (device.deviceID !== getParam(req, "id")) {
+                res.sendStatus(403);
+                return;
+            }
+            const removed = await this.db.removeNotificationSubscription({
+                deviceID: device.deviceID,
+                subscriptionID: getParam(req, "subscriptionID"),
+                userID: getUser(req).userID,
+            });
+            res.sendStatus(removed ? 204 : 404);
         });
         this.api.post("/auth", authLimiter, async (req, res) => {
             const parsed = authPayload.safeParse(req.body);
@@ -759,47 +813,15 @@ export class Spire extends EventEmitter {
             });
         });
     }
-    notify(userID, event, transmissionID, data, deviceID) {
-        const msg = {
+    notify(userID, event, transmissionID, data, deviceID, headlessPushUserID) {
+        this.notifications.notify({
             data,
             event,
+            ...(headlessPushUserID ? { headlessPushUserID } : {}),
             transmissionID,
-            type: "notify",
-        };
-        // Snapshot the array so that a synchronous fail/prune inside send
-        // cannot corrupt the iteration. Each client is isolated so one stale
-        // manager cannot abort delivery to later recipients.
-        const snapshot = this.clients.slice();
-        for (const client of snapshot) {
-            try {
-                if (client.hasFailed()) {
-                    this.removeClient(client);
-                    continue;
-                }
-                if (deviceID) {
-                    const currentDeviceID = client.getDeviceID();
-                    if (currentDeviceID === null) {
-                        this.removeClient(client);
-                        continue;
-                    }
-                    if (currentDeviceID === deviceID) {
-                        client.send(msg);
-                    }
-                    continue;
-                }
-                const currentUserID = client.getUserID();
-                if (currentUserID === null) {
-                    this.removeClient(client);
-                    continue;
-                }
-                if (currentUserID === userID) {
-                    client.send(msg);
-                }
-            }
-            catch (_err) {
-                this.removeClient(client);
-            }
-        }
+            userID,
+            ...(deviceID ? { deviceID } : {}),
+        });
     }
     removeClient(client) {
         const idx = this.clients.indexOf(client);