@voltro/plugin-notifications 0.85.0 → 0.87.0

package/dist/rpc.d.ts

@@ -22,6 +22,14 @@ export declare const archiveDescriptor: MutationProcedureDescriptor<"notificatio
  */
 export declare const BASE_NAME = "@voltro/plugin-notifications";
 
+/** One channel switch of the calling subject for one category. */
+export declare const ChannelPreferenceSchema: Schema.Struct<{
+    readonly subjectId: Schema.String;
+    readonly category: Schema.String;
+    readonly channel: Schema.String;
+    readonly enabled: Schema.Boolean;
+}>;
+
 export declare const clearQuietHoursDescriptor: MutationProcedureDescriptor<"notifications.clearQuietHours", Schema.Struct<{}>, Schema.Struct<{
     readonly ok: Schema.Boolean;
 }>, Schema.Never>;
@@ -55,7 +63,15 @@ export declare const markUnreadDescriptor: MutationProcedureDescriptor<"notifica
  *  emitted into the generated client group. Kept in lockstep with the exports. */
 export declare const notificationsRpcClientImports: ReadonlyArray<PluginRpcClientDescriptor>;
 
-export declare const preferencesDescriptor: QueryProcedureDescriptor<"notifications.preferences", Schema.Struct<{}>, Schema.$Array<Schema.$Record<Schema.String, Schema.Unknown>>, Schema.Never>;
+export declare const preferencesDescriptor: QueryProcedureDescriptor<"notifications.preferences", Schema.Struct<{}>, Schema.$Array<Schema.Struct<{
+    readonly subjectId: Schema.String;
+    readonly category: Schema.String;
+    readonly channel: Schema.String;
+    readonly enabled: Schema.Boolean;
+}>>, Schema.Never>;
+
+/** Every preference write publishes this channel, so `notifications.preferences` subscribers see the change live. */
+export declare const preferencesFeed: ReactivityChannel;
 
 export declare const setPreferenceDescriptor: MutationProcedureDescriptor<"notifications.setPreference", Schema.Struct<{
     readonly category: Schema.String;

package/dist/rpc.js

@@ -1,7 +1,12 @@
 import { Schema as e } from "effect";
 import { defineMutation as t, defineQuery as n, reactivityChannel as r } from "@voltro/protocol";
 //#region src/rpc.ts
-var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
+var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = r("notifications-preferences"), s = e.Struct({
+	subjectId: e.String,
+	category: e.String,
+	channel: e.String,
+	enabled: e.Boolean
+}), c = n({
 	name: "notifications.inbox",
 	source: a,
 	input: e.Struct({
@@ -10,43 +15,44 @@ var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
 	}),
 	output: e.Array(e.Record(e.String, e.Unknown)),
 	openAccess: "self-scoped read: returns only the calling subject's own inbox items"
-}), s = n({
+}), l = n({
 	name: "notifications.unreadCount",
 	source: a,
 	input: e.Struct({}),
 	output: e.Struct({ count: e.Number }),
 	openAccess: "self-scoped read: counts only the calling subject's own unread items"
-}), c = t({
+}), u = t({
 	name: "notifications.markRead",
 	input: e.Struct({ id: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: marks an item read only within the calling subject's own inbox"
-}), l = t({
+}), d = t({
 	name: "notifications.markUnread",
 	input: e.Struct({ id: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: marks an item unread only within the calling subject's own inbox"
-}), u = t({
+}), f = t({
 	name: "notifications.markAllRead",
 	input: e.Struct({}),
 	output: e.Struct({ count: e.Number }),
 	openAccess: "self-scoped write: clears unread state only in the calling subject's own inbox"
-}), d = t({
+}), p = t({
 	name: "notifications.archive",
 	input: e.Struct({ id: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: archives an item only within the calling subject's own inbox"
-}), f = t({
+}), m = t({
 	name: "notifications.unarchive",
 	input: e.Struct({ id: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: unarchives an item only within the calling subject's own inbox"
-}), p = n({
+}), h = n({
 	name: "notifications.preferences",
+	source: o,
 	input: e.Struct({}),
-	output: e.Array(e.Record(e.String, e.Unknown)),
+	output: e.Array(s),
 	openAccess: "self-scoped read: returns only the calling subject's own channel preferences"
-}), m = t({
+}), g = t({
 	name: "notifications.setPreference",
 	input: e.Struct({
 		category: e.String,
@@ -55,17 +61,17 @@ var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
 	}),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: toggles a channel only on the calling subject's own preferences"
-}), h = t({
+}), _ = t({
 	name: "notifications.subscribe",
 	input: e.Struct({ topic: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-service: subscribes the calling subject itself to a topic (the subject is never caller-supplied)"
-}), g = t({
+}), v = t({
 	name: "notifications.unsubscribe",
 	input: e.Struct({ topic: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-service: unsubscribes the calling subject itself from a topic"
-}), _ = t({
+}), y = t({
 	name: "notifications.setQuietHours",
 	input: e.Struct({
 		startMinute: e.Number,
@@ -75,17 +81,17 @@ var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
 	}),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: sets only the calling subject's own quiet-hours window"
-}), v = t({
+}), b = t({
 	name: "notifications.clearQuietHours",
 	input: e.Struct({}),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: clears only the calling subject's own quiet-hours window"
-}), y = n({
+}), x = n({
 	name: "notifications.webPushPublicKey",
 	input: e.Struct({}),
 	output: e.Struct({ key: e.String }),
 	openAccess: "public application-server key — the value every subscribing browser is handed by design"
-}), b = t({
+}), S = t({
 	name: "notifications.webPushSubscribe",
 	input: e.Struct({
 		endpoint: e.String,
@@ -95,17 +101,17 @@ var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
 	}),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: registers the calling subject's own browser subscription (the subject is never caller-supplied)"
-}), x = t({
+}), C = t({
 	name: "notifications.webPushUnsubscribe",
 	input: e.Struct({ endpoint: e.String }),
 	output: e.Struct({ ok: e.Boolean }),
 	openAccess: "self-scoped write: removes only a subscription the calling subject owns"
-}), S = n({
+}), w = n({
 	name: "notifications.webPushStatus",
 	input: e.Struct({}),
 	output: e.Struct({ endpoints: e.Number }),
 	openAccess: "self-scoped read: counts only the calling subject's own subscriptions"
-}), C = [
+}), T = [
 	{
 		tag: "notifications.webPushPublicKey",
 		kind: "query",
@@ -138,7 +144,7 @@ var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
 			name: "webPushStatusDescriptor"
 		}
 	}
-], w = [
+], E = [
 	{
 		tag: "notifications.inbox",
 		kind: "query",
@@ -245,4 +251,4 @@ var i = "@voltro/plugin-notifications", a = r("notifications-inbox"), o = n({
 	}
 ];
 //#endregion
-export { i as BASE_NAME, d as archiveDescriptor, v as clearQuietHoursDescriptor, o as inboxDescriptor, a as inboxFeed, u as markAllReadDescriptor, c as markReadDescriptor, l as markUnreadDescriptor, w as notificationsRpcClientImports, p as preferencesDescriptor, m as setPreferenceDescriptor, _ as setQuietHoursDescriptor, h as subscribeDescriptor, f as unarchiveDescriptor, s as unreadCountDescriptor, g as unsubscribeDescriptor, y as webPushPublicKeyDescriptor, C as webPushRpcClientImports, S as webPushStatusDescriptor, b as webPushSubscribeDescriptor, x as webPushUnsubscribeDescriptor };
+export { i as BASE_NAME, s as ChannelPreferenceSchema, p as archiveDescriptor, b as clearQuietHoursDescriptor, c as inboxDescriptor, a as inboxFeed, f as markAllReadDescriptor, u as markReadDescriptor, d as markUnreadDescriptor, E as notificationsRpcClientImports, h as preferencesDescriptor, o as preferencesFeed, g as setPreferenceDescriptor, y as setQuietHoursDescriptor, _ as subscribeDescriptor, m as unarchiveDescriptor, l as unreadCountDescriptor, v as unsubscribeDescriptor, x as webPushPublicKeyDescriptor, T as webPushRpcClientImports, w as webPushStatusDescriptor, S as webPushSubscribeDescriptor, C as webPushUnsubscribeDescriptor };

package/dist/sendNotification.js

@@ -0,0 +1,42 @@
+import { Schema as e } from "effect";
+//#region src/sendNotification.ts
+var t = (e) => {
+	if (typeof e == "object" && e) {
+		let t = e;
+		if (typeof t.userId == "string") return [t.userId];
+		if (Array.isArray(t.userIds)) return t.userIds.filter((e) => typeof e == "string");
+	}
+	throw Error("sendNotification: pass `recipients` — the audience has neither `userId` nor `userIds`");
+}, n = async (n, i, a) => {
+	let o = e.decodeUnknownSync(i.audience)(a.audience), s = e.decodeUnknownSync(i.payload)(a.payload), c = a.recipients ? await a.recipients(o) : t(o), l = [];
+	for (let e of c) {
+		let t = (a.localeFor ? await a.localeFor(e) : null) ?? a.defaultLocale ?? "en", o = await n.send(r(i, s, e, t, a.tenantId));
+		l.push({
+			recipientId: e,
+			locale: t,
+			result: o
+		});
+	}
+	return l;
+}, r = (e, t, n, r, i) => {
+	let a = e.render(t, {
+		locale: r,
+		recipientId: n
+	});
+	return {
+		to: n,
+		category: e.category,
+		title: a.title,
+		body: a.body,
+		data: {
+			...a.data,
+			notification: e.name,
+			...a.image === void 0 ? {} : { image: a.image },
+			...a.actions === void 0 ? {} : { actions: a.actions }
+		},
+		...e.channels === void 0 ? {} : { channels: e.channels },
+		...i === void 0 ? {} : { tenantId: i }
+	};
+};
+//#endregion
+export { t as defaultRecipients, r as sendInputFor, n as sendNotification };

package/dist/service.js

@@ -0,0 +1,246 @@
+import { resolveChannels as e } from "./channels.js";
+import { randomUUID as t } from "node:crypto";
+//#region src/service.ts
+var n = (e) => ({
+	id: "inApp",
+	deliver: async (n) => {
+		await e.addInbox({
+			id: t(),
+			subjectId: n.to,
+			category: n.category,
+			title: n.title,
+			body: n.body,
+			data: n.data ?? {},
+			tenantId: n.tenantId ?? null,
+			createdAt: (/* @__PURE__ */ new Date()).toISOString()
+		});
+	}
+}), r = (e, t) => {
+	try {
+		let n = new Intl.DateTimeFormat("en-US", {
+			timeZone: t,
+			hour: "2-digit",
+			minute: "2-digit",
+			hour12: !1
+		}).formatToParts(e), r = Number(n.find((e) => e.type === "hour")?.value ?? "0") % 24, i = Number(n.find((e) => e.type === "minute")?.value ?? "0");
+		return r * 60 + i;
+	} catch {
+		return e.getUTCHours() * 60 + e.getUTCMinutes();
+	}
+}, i = (e, t) => {
+	if (e.startMinute === e.endMinute) return !1;
+	let n = r(t, e.tz ?? "UTC");
+	return e.startMinute < e.endMinute ? n >= e.startMinute && n < e.endMinute : n >= e.startMinute || n < e.endMinute;
+}, a = (e, t) => {
+	let n = r(t, e.tz ?? "UTC"), i = e.endMinute - n;
+	return i <= 0 && (i += 1440), new Date(t.getTime() + i * 6e4);
+}, o = (n) => {
+	let r = new Map(n.channels.map((e) => [e.id, e])), o = n.channels.map((e) => e.id), c = n.now ?? (() => (/* @__PURE__ */ new Date()).toISOString()), l = n.digestWindowMs ?? 0, u = new Map(Object.entries(n.deliveryGuards ?? {}));
+	if (u.size > 256 || [...u].some(([e, t]) => !/^[a-z][a-zA-Z0-9._-]{0,127}$/.test(e) || typeof t != "function")) throw Error("Invalid notification delivery guard registry");
+	let d = async (e) => {
+		let t = e.deliveryGuard;
+		if (t === void 0) return !0;
+		if (!t || typeof t.id != "string" || !t.payload || typeof t.payload != "object" || Array.isArray(t.payload)) throw Error("Invalid notification delivery guard reference");
+		let n = u.get(t.id);
+		if (!n) throw Error("Notification delivery guard unavailable");
+		let r = JSON.stringify(t.payload);
+		if (typeof r != "string" || r.length > 8192) throw Error("Notification delivery guard payload exceeds budget");
+		let i = JSON.parse(r);
+		if (typeof i != "object" || !i || Array.isArray(i)) throw Error("Invalid notification delivery guard payload");
+		let a = await n({
+			recipientId: e.to,
+			tenantId: e.tenantId ?? null,
+			payload: i
+		});
+		if (a !== !0 && a !== !1) throw Error("Invalid notification delivery guard decision");
+		return a;
+	}, f = () => ({
+		delivered: [],
+		failed: [],
+		skipped: [...o]
+	}), p = async (i) => {
+		if (!await d(i)) return f();
+		let a = await n.store.getPreferences(i.to), s = e(o, i.category, i.channels, a, i.to), l = o.filter((e) => !s.includes(e)), u = [], p = [], m = {
+			to: i.to,
+			category: i.category,
+			title: i.title,
+			body: i.body,
+			...i.data ? { data: i.data } : {},
+			tenantId: i.tenantId ?? null
+		};
+		for (let e of s) {
+			if (!await d(i)) {
+				l.push(e);
+				continue;
+			}
+			let a = r.get(e);
+			if (!a) continue;
+			if (a.deliverDetailed !== void 0) {
+				try {
+					let r = await a.deliverDetailed(m);
+					for (let a of r) await n.store.recordDelivery({
+						id: t(),
+						to: i.to,
+						category: i.category,
+						channel: e,
+						at: c(),
+						status: a.status,
+						endpoint: a.endpoint,
+						...a.error === void 0 ? {} : { error: a.error },
+						...a.clickToken === void 0 ? {} : { clickToken: a.clickToken }
+					});
+					let o = r.filter((e) => e.status === "failed");
+					r.length === 0 || o.length < r.length ? u.push(e) : p.push({
+						channel: e,
+						error: o[0]?.error ?? "all endpoints failed"
+					});
+				} catch (r) {
+					let a = r instanceof Error ? r.message : String(r);
+					p.push({
+						channel: e,
+						error: a
+					}), await n.store.recordDelivery({
+						id: t(),
+						to: i.to,
+						category: i.category,
+						channel: e,
+						at: c(),
+						status: "failed",
+						error: a
+					});
+				}
+				continue;
+			}
+			let o = {
+				id: t(),
+				to: i.to,
+				category: i.category,
+				channel: e,
+				at: c()
+			};
+			try {
+				await a.deliver(m), u.push(e), await n.store.recordDelivery({
+					...o,
+					status: "sent"
+				});
+			} catch (t) {
+				let r = t instanceof Error ? t.message : String(t);
+				p.push({
+					channel: e,
+					error: r
+				}), await n.store.recordDelivery({
+					...o,
+					status: "failed",
+					error: r
+				});
+			}
+		}
+		return {
+			delivered: u,
+			failed: p,
+			skipped: l
+		};
+	}, m = async (e) => {
+		let r = structuredClone(e);
+		if (!await d(r)) return f();
+		let o = await n.store.getQuietHours(r.to), s = new Date(c());
+		if (o && i(o, s)) return (o.policy ?? "hold") === "drop" ? {
+			delivered: [],
+			failed: [],
+			skipped: [],
+			held: "quiet-drop"
+		} : (await n.store.enqueueHeld({
+			id: t(),
+			kind: "quiet",
+			subjectId: r.to,
+			send: r,
+			flushAt: a(o, s).toISOString()
+		}), {
+			delivered: [],
+			failed: [],
+			skipped: [],
+			held: "quiet-held"
+		});
+		if (l > 0 && !r.channels) {
+			let e = (await n.store.pendingDigest(r.to))[0]?.flushAt ?? new Date(s.getTime() + l).toISOString();
+			return await n.store.enqueueHeld({
+				id: t(),
+				kind: "digest",
+				subjectId: r.to,
+				send: r,
+				flushAt: e
+			}), {
+				delivered: [],
+				failed: [],
+				skipped: [],
+				held: "digest"
+			};
+		}
+		return p(r);
+	};
+	return {
+		send: m,
+		inbox: (e, t) => n.store.listInbox(e, t),
+		unreadCount: (e) => n.store.unreadCount(e),
+		markRead: (e, t) => n.store.markRead(e, t),
+		markUnread: (e, t) => n.store.markUnread(e, t),
+		markAllRead: (e) => n.store.markAllRead(e),
+		setArchived: (e, t, r) => n.store.setArchived(e, t, r),
+		getPreferences: (e) => n.store.getPreferences(e),
+		setPreference: (e) => n.store.setPreference(e),
+		subscribe: (e, t, r) => n.store.subscribeTopic({
+			topic: e,
+			subjectId: t,
+			tenantId: r ?? null
+		}),
+		unsubscribe: (e, t) => n.store.unsubscribeTopic(e, t),
+		broadcast: async (e, t) => {
+			let r = await n.store.listTopicSubscribers(e), i = [];
+			for (let e of r) i.push(await m({
+				...t,
+				to: e.subjectId,
+				tenantId: t.tenantId ?? e.tenantId ?? null
+			}));
+			return {
+				recipients: r.length,
+				results: i
+			};
+		},
+		setQuietHours: (e) => n.store.setQuietHours(e),
+		clearQuietHours: (e) => n.store.clearQuietHours(e),
+		getQuietHours: (e) => n.store.getQuietHours(e),
+		flushDue: async (e = new Date(c())) => {
+			let t = await n.store.dueHeld(e.toISOString());
+			if (t.length === 0) return 0;
+			for (let e of t.filter((e) => e.kind === "quiet")) await p(e.send);
+			let r = /* @__PURE__ */ new Map();
+			for (let e of t.filter((e) => e.kind === "digest")) {
+				if (e.send.deliveryGuard !== void 0) {
+					await p(e.send);
+					continue;
+				}
+				let t = JSON.stringify([e.send.tenantId ?? null, e.subjectId]), n = r.get(t) ?? [];
+				n.push(e), r.set(t, n);
+			}
+			for (let e of r.values()) await p(s(e[0].subjectId, e));
+			return await n.store.clearHeld(t.map((e) => e.id)), t.length;
+		}
+	};
+}, s = (e, t) => {
+	if (t.length === 1) return t[0].send;
+	let n = t.map((e) => ({
+		category: e.send.category,
+		title: e.send.title,
+		body: e.send.body
+	}));
+	return {
+		to: e,
+		category: "digest",
+		title: `${t.length} new notifications`,
+		body: n.map((e) => `• ${e.title}`).join("\n"),
+		data: { items: n },
+		tenantId: t[0].send.tenantId ?? null
+	};
+};
+//#endregion
+export { o as buildNotificationService, n as inAppChannel, i as inQuietHours, r as minuteOfDayInZone, a as quietHoursEnd };