Implements the notification system foundation and all v1 delivery channels that need no external infrastructure (specs 00/01/04/05 in docs/superpowers/plans/notifications/): Foundation (spec 01): - episode_availability seeding + per-library seed markers: "newly available" means newly released to this server, so back-catalog imports and first scans never flood (verified on dev: 1.13M episodes seeded silently) - release_events -> profile_series_interest fanout worker with settling delay, per-series burst caps, FOR UPDATE SKIP LOCKED multi-node claims, and a guarded last-notified cursor - interest index maintained via a userstore provider decorator so every favorites/watchlist/progress mutation path (REST, jellycompat, imports, playback) feeds it; progress writes only recompute on state transitions - durable per-profile inbox + read state, forward-sync cursor API, websocket channel with short-lived single-use handshake tickets - web UI: sidebar badge, inbox page, toasts, per-profile preferences - startup/daily tasks: availability seeding, interest rebuild, retention Outbound webhooks (spec 04): - Discord embeds (text-only per the v1 privacy contract) and generic JSON signed Stripe-style with per-webhook secrets - HTTPS-only + private-destination guard enforced at registration and at connect time (DNS-rebinding mitigation); URLs/secrets encrypted at rest - durable per-target outbox enqueued in the fanout transaction, lease-based claims, 24h exponential retry, 3x-consecutive-4xx auto-disable with an in-app notice (loop-guarded) Web push (spec 05): - VAPID keypair self-provisioned at startup (single atomic JSON setting, private half encrypted at rest) — no third-party accounts needed - payloads E2E-encrypted (RFC 8291); 404/410 treated as unsubscribe - service worker + subscribe flow in Settings -> Notifications Shared SMTP core (internal/mail): - feature-agnostic mail.Sender over live email.* settings, STARTTLS or implicit TLS, encrypted password, admin Email settings page with synchronous test send; no consumer yet by design (digest is v1.5) APNs/FCM (specs 02/03) are deferred to v2; the capability endpoint reports them unavailable so clients render truthfully. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
125 lines
3.8 KiB
TypeScript
125 lines
3.8 KiB
TypeScript
import { api } from "@/api/client";
|
|
|
|
/**
|
|
* Browser-side Web Push subscription helpers. The server's VAPID public key
|
|
* comes from the notifications capability endpoint; subscriptions are
|
|
* profile-scoped server-side.
|
|
*/
|
|
|
|
export type WebPushSupport = "supported" | "unsupported" | "denied";
|
|
|
|
export function webPushSupport(): WebPushSupport {
|
|
if (
|
|
!("serviceWorker" in navigator) ||
|
|
!("PushManager" in window) ||
|
|
!("Notification" in window)
|
|
) {
|
|
return "unsupported";
|
|
}
|
|
if (Notification.permission === "denied") {
|
|
return "denied";
|
|
}
|
|
return "supported";
|
|
}
|
|
|
|
function urlBase64ToUint8Array(base64: string): Uint8Array {
|
|
const padding = "=".repeat((4 - (base64.length % 4)) % 4);
|
|
const normalized = (base64 + padding).replace(/-/g, "+").replace(/_/g, "/");
|
|
const raw = window.atob(normalized);
|
|
const output = new Uint8Array(raw.length);
|
|
for (let i = 0; i < raw.length; i += 1) {
|
|
output[i] = raw.charCodeAt(i);
|
|
}
|
|
return output;
|
|
}
|
|
|
|
async function pushRegistration(): Promise<ServiceWorkerRegistration> {
|
|
const registration = await navigator.serviceWorker.register("/sw.js");
|
|
await navigator.serviceWorker.ready;
|
|
return registration;
|
|
}
|
|
|
|
/** Returns the browser's current push subscription, if any. */
|
|
export async function currentWebPushSubscription(): Promise<PushSubscription | null> {
|
|
if (webPushSupport() === "unsupported") {
|
|
return null;
|
|
}
|
|
try {
|
|
const registration = await navigator.serviceWorker.getRegistration("/sw.js");
|
|
return (await registration?.pushManager.getSubscription()) ?? null;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function describeDevice(): string {
|
|
const ua = navigator.userAgent;
|
|
const browser = /firefox/i.test(ua)
|
|
? "Firefox"
|
|
: /edg\//i.test(ua)
|
|
? "Edge"
|
|
: /chrome|chromium/i.test(ua)
|
|
? "Chrome"
|
|
: /safari/i.test(ua)
|
|
? "Safari"
|
|
: "Browser";
|
|
const platform = /windows/i.test(ua)
|
|
? "Windows"
|
|
: /mac os/i.test(ua)
|
|
? "macOS"
|
|
: /android/i.test(ua)
|
|
? "Android"
|
|
: /iphone|ipad/i.test(ua)
|
|
? "iOS"
|
|
: /linux/i.test(ua)
|
|
? "Linux"
|
|
: "";
|
|
return platform ? `${browser} on ${platform}` : browser;
|
|
}
|
|
|
|
/**
|
|
* Requests permission, subscribes this browser, and registers the
|
|
* subscription with the server for the active profile. Throws with a
|
|
* user-presentable message on failure.
|
|
*/
|
|
export async function enableWebPush(vapidPublicKey: string): Promise<void> {
|
|
if (webPushSupport() === "unsupported") {
|
|
throw new Error("This browser does not support push notifications");
|
|
}
|
|
const permission = await Notification.requestPermission();
|
|
if (permission !== "granted") {
|
|
throw new Error("Notification permission was not granted");
|
|
}
|
|
const registration = await pushRegistration();
|
|
const subscription = await registration.pushManager.subscribe({
|
|
userVisibleOnly: true,
|
|
applicationServerKey: urlBase64ToUint8Array(vapidPublicKey) as BufferSource,
|
|
});
|
|
const json = subscription.toJSON();
|
|
if (!json.endpoint || !json.keys?.p256dh || !json.keys?.auth) {
|
|
throw new Error("The browser returned an incomplete push subscription");
|
|
}
|
|
await api("/notifications/web-push/subscriptions", {
|
|
method: "POST",
|
|
body: JSON.stringify({
|
|
endpoint: json.endpoint,
|
|
keys: { p256dh: json.keys.p256dh, auth: json.keys.auth },
|
|
device_name: describeDevice(),
|
|
}),
|
|
});
|
|
}
|
|
|
|
/** Unsubscribes this browser and removes the server-side registration. */
|
|
export async function disableWebPush(): Promise<void> {
|
|
const subscription = await currentWebPushSubscription();
|
|
if (!subscription) {
|
|
return;
|
|
}
|
|
const endpoint = subscription.endpoint;
|
|
await subscription.unsubscribe();
|
|
await api("/notifications/web-push/unsubscribe", {
|
|
method: "POST",
|
|
body: JSON.stringify({ endpoint }),
|
|
});
|
|
}
|