@stacksjs/notifications 0.74.37 → 0.74.39

package/dist/delivery.d.ts

@@ -1,6 +1,17 @@
 import type { NotificationChannel, NotificationPayload, NotificationRecipient, NotifyOptions, NotifyResult } from './index';
 export declare function resolveDeliveryRecipient(recipient: NotificationRecipient, channel: NotificationChannel): string;
 export declare function makeDeliveryRecord(recipient: NotificationRecipient, payload: NotificationPayload, result: NotifyResult, options: NotifyOptions, sentAt?: unknown): NotificationDeliveryRecord;
+/**
+ * Whether this channel's deliveries are recorded (stacksjs/stacks#328).
+ *
+ * Read from the `config` proxy rather than a destructured section, so a value
+ * set after this module was first imported is still seen - the sections are
+ * snapshots refreshed once at boot.
+ *
+ * Defaults to ON. The value of delivery tracking is in not having to remember
+ * to enable it before the send you needed to explain.
+ */
+export declare function tracksChannel(channel: NotificationChannel): boolean;
 export declare function recordNotificationDelivery(record: NotificationDeliveryRecord): Promise<void>;
 export declare interface NotificationDeliveryRecord {
   userId?: number

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-import{log as v}from"@stacksjs/cli";import{notification as U}from"@stacksjs/config";import{mail as T}from"@stacksjs/email";import{log as N}from"@stacksjs/cli";var d={async send(e){let t=e.event??"notification",r=e.channel;if(!r)r=e.userId!==void 0?`private-user-${e.userId}`:"notifications";try{let n=await import("@stacksjs/realtime").catch(()=>null),i=n?.emit,a=n?.getServer;if(!i||!a)return{delivered:!1,channel:r,event:t,reason:"@stacksjs/realtime is not available"};if(!a())return{delivered:!1,channel:r,event:t,reason:"realtime server not running"};let u=e.private??e.userId!==void 0;return i(r,t,e.data,{private:u}),N.info(`[notifications] broadcast to '${r}' (${t})`),{delivered:!0,channel:r,event:t}}catch(n){let i=n instanceof Error?n.message:String(n);return N.warn(`[notifications] broadcast failed: ${i}`),{delivered:!1,channel:r,event:t,reason:i}}}};import*as x from"@stacksjs/chat";import{log as O}from"@stacksjs/cli";import{db as c,sqlDateTime as h}from"@stacksjs/database";var l={async send(e){let t=h(),n=await c.insertInto("notifications").values({user_id:e.userId,type:e.type,data:JSON.stringify(e.data),read_at:null,created_at:t,updated_at:t}).execute(),i=Array.isArray(n)?n[0]:n,a=Number(i?.insertId??i?.lastInsertRowid??i?.lastInsertId??0);return O.info(`Database notification sent to user ${e.userId}: ${e.type}`),{id:a,user_id:e.userId,type:e.type,data:JSON.stringify(e.data),read_at:null,created_at:t,updated_at:t}},async getUserNotifications(e){return await c.selectFrom("notifications").selectAll().where("user_id","=",e).orderBy("created_at","desc").execute()},async getUnreadNotifications(e){return await c.selectFrom("notifications").selectAll().where("user_id","=",e).whereNull("read_at").orderBy("created_at","desc").execute()},async markAsRead(e){await c.updateTable("notifications").set({read_at:h()}).where("id","=",e).execute()},async markAllAsRead(e){await c.updateTable("notifications").set({read_at:h()}).where("user_id","=",e).whereNull("read_at").execute()},async unreadCount(e){let t=await c.selectFrom("notifications").select(c.fn.countAll().as("count")).where("user_id","=",e).whereNull("read_at").executeTakeFirst();return Number(t?.count??0)},async deleteNotification(e){await c.deleteFrom("notifications").where("id","=",e).execute()},async deleteAllNotifications(e){await c.deleteFrom("notifications").where("user_id","=",e).execute()}};import*as k from"@stacksjs/push";import*as P from"@stacksjs/sms";import{log as j}from"@stacksjs/cli";import{db as F,sqlDateTime as D}from"@stacksjs/database";function R(e,t){switch(t){case"email":return e.email||"";case"sms":return e.phone||"";case"push":return Array.isArray(e.pushTokens)?e.pushTokens.join(", "):e.pushTokens||"";case"broadcast":return e.broadcastChannel||(e.userId?`private-user-${e.userId}`:"notifications");case"database":return e.userId?`User #${e.userId}`:"";case"chat":return"Configured chat destination"}}function y(e,t,r,n,i=D()){return{userId:e.userId,channel:r.channel,recipient:R(e,r.channel),subject:t.subject,body:t.body,status:r.success?"sent":"failed",error:r.error?.message,metadata:{...t.data,...n.category?{category:n.category}:{}},sentAt:i}}async function b(e){let t=D();try{await F.insertInto("notification_deliveries").values({user_id:e.userId??null,channel:e.channel,recipient:e.recipient,subject:e.subject??null,body:e.body,status:e.status,error:e.error??null,metadata:e.metadata?JSON.stringify(e.metadata):null,sent_at:e.sentAt,created_at:t,updated_at:t}).execute()}catch(r){let n=r instanceof Error?r.message:String(r);j.warn(`[notifications] could not record ${e.channel} delivery: ${n}`)}}import{log as q}from"@stacksjs/cli";import{db as m,sqlDateTime as M}from"@stacksjs/database";var p="notification_preferences";function _(e,t){return t===null?e.whereNull("category"):e.where("category","=",t)}async function g(e,t){let r=new Map;try{let n=m.selectFrom(p).select(["channel","enabled","category"]).where("user_id","=",e);if(t!==void 0)n=n.where("category","=",t);let i=await n.execute();for(let a of i)r.set(a.channel,a.enabled===!0||a.enabled===1)}catch(n){q.debug?.(`[notifications] preferences lookup failed (table missing?): ${n.message}`)}return r}async function I(e,t,r,n){let i=M(),a=n??null,u=m.selectFrom(p).select(["id"]).where("user_id","=",e).where("channel","=",t),o=await _(u,a).executeTakeFirst();if(o?.id){await m.updateTable(p).set({enabled:r,updated_at:i}).where("id","=",o.id).execute();return}await m.insertInto(p).values({user_id:e,channel:t,enabled:r,category:a,created_at:i,updated_at:i}).execute()}async function L(e,t){for(let r of t)await I(e,r.channel,r.enabled,r.category)}async function w(e,t,r){let n=await g(e,r);if(r!==void 0){let i=await g(e,void 0);for(let[a,u]of i)if(!n.has(a))n.set(a,u)}return t.filter((i)=>{let a=n.get(i);return a===void 0?!0:a===!0})}var J=U;function Q(e){if(!e.success)throw Error(e.message||`Email delivery failed through ${e.provider||"the configured provider"}.`)}function E(e){return x[e||"slack"]}function S(e){if(e)try{return T.use(e)}catch(t){v.warn(`[notifications] email driver '${e}' not registered - falling back to default mail singleton (${t.message})`)}return T}function A(e){return P[e||"twilio"]}function H(){return k}function z(){return l}function ge(){return d}function G(e,t){let r=e||J?.default||"email",n=t;switch(r){case"email":return S(n);case"chat":return E(n);case"sms":return A(n);case"database":return z();default:throw Error(`Notification type "${r}" is not supported`)}}function C(e){return!!e&&typeof e==="object"&&"send"in e&&typeof e.send==="function"}async function we(e,t,r=["email"],n={}){let i=r;if(e.userId&&!n.ignorePreferences)try{i=await w(e.userId,r,n.category)}catch(o){v.warn(`[notify] preferences filter failed, sending all channels: ${o.message}`)}let u=(await Promise.allSettled(i.map(async(o)=>{switch(o){case"email":{if(!e.email)throw Error("[notify] email channel requires recipient.email");let f=await S().send({to:e.email,subject:t.subject??"",text:t.body,html:`<p>${K(t.body)}</p>`});Q(f);break}case"sms":{if(!e.phone)throw Error("[notify] sms channel requires recipient.phone");if(n.ignorePreferences!==!0){let{isPhoneOptedOut:f}=await import("@stacksjs/sms");if(await f(e.phone))throw Error("[notify] sms recipient has opted out (STOP)")}let s=A();if(!C(s))throw Error("[notify] sms channel is not configured: no usable SMS driver with a send() method");await s.send({to:e.phone,body:t.body});break}case"chat":{let s=E();if(!C(s))throw Error("[notify] chat channel is not configured: no usable chat driver with a send() method");await s.send({body:t.body});break}case"database":{if(!e.userId)throw Error("[notify] database channel requires recipient.userId");await l.send({userId:e.userId,type:t.subject||"notification",data:{body:t.body,...t.data}});break}case"push":{if(!e.pushTokens||Array.isArray(e.pushTokens)&&e.pushTokens.length===0)throw Error("[notify] push channel requires recipient.pushTokens");await H().send(e.pushTokens,{title:t.subject,body:t.body,data:t.data});break}case"broadcast":{await d.send({channel:e.broadcastChannel,userId:e.userId,event:t.subject??"notification",data:{body:t.body,...t.data}});break}default:throw Error(`Unsupported notification channel: ${o}`)}}))).map((o,s)=>{let f=i[s];if(!f)throw Error(`Missing notification channel for result ${s}`);if(o.status==="rejected"){let B=o.reason instanceof Error?o.reason.message:String(o.reason);v.warn(`[notify] ${f} channel failed: ${B}`)}return{channel:f,success:o.status==="fulfilled",error:o.status==="rejected"?o.reason:void 0}});return await Promise.all(u.map((o)=>b(y(e,t,o,n)))),u}function ve(){return G()}function K(e){return String(e??"").replace(/[&<>"']/g,(t)=>({"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;"})[t])}export{d as BroadcastNotificationDriver,l as DatabaseNotificationDriver,L as bulkSetPreferences,Q as ensureSuccessfulEmailResult,w as filterChannelsByPreferences,g as getNotificationPreferences,y as makeDeliveryRecord,ve as notification,we as notify,b as recordNotificationDelivery,R as resolveDeliveryRecipient,I as setNotificationPreference,ge as useBroadcast,E as useChat,z as useDatabase,S as useEmail,G as useNotification,H as usePush,A as useSMS,_ as wherePreferenceCategory};
+import{log as v}from"@stacksjs/cli";import{notification as Q}from"@stacksjs/config";import{mail as C}from"@stacksjs/email";import{log as N}from"@stacksjs/cli";var l={async send(e){let t=e.event??"notification",n=e.channel;if(!n)n=e.userId!==void 0?`private-user-${e.userId}`:"notifications";try{let r=await import("@stacksjs/realtime").catch(()=>null),i=r?.emit,a=r?.getServer;if(!i||!a)return{delivered:!1,channel:n,event:t,reason:"@stacksjs/realtime is not available"};if(!a())return{delivered:!1,channel:n,event:t,reason:"realtime server not running"};let f=e.private??e.userId!==void 0;return i(n,t,e.data,{private:f}),N.info(`[notifications] broadcast to '${n}' (${t})`),{delivered:!0,channel:n,event:t}}catch(r){let i=r instanceof Error?r.message:String(r);return N.warn(`[notifications] broadcast failed: ${i}`),{delivered:!1,channel:n,event:t,reason:i}}}};import*as x from"@stacksjs/chat";import{log as j}from"@stacksjs/cli";import{db as c,sqlDateTime as h}from"@stacksjs/database";var d={async send(e){let t=h(),r=await c.insertInto("notifications").values({user_id:e.userId,type:e.type,data:JSON.stringify(e.data),read_at:null,created_at:t,updated_at:t}).execute(),i=Array.isArray(r)?r[0]:r,a=Number(i?.insertId??i?.lastInsertRowid??i?.lastInsertId??0);return j.info(`Database notification sent to user ${e.userId}: ${e.type}`),{id:a,user_id:e.userId,type:e.type,data:JSON.stringify(e.data),read_at:null,created_at:t,updated_at:t}},async getUserNotifications(e){return await c.selectFrom("notifications").selectAll().where("user_id","=",e).orderBy("created_at","desc").execute()},async getUnreadNotifications(e){return await c.selectFrom("notifications").selectAll().where("user_id","=",e).whereNull("read_at").orderBy("created_at","desc").execute()},async markAsRead(e){await c.updateTable("notifications").set({read_at:h()}).where("id","=",e).execute()},async markAllAsRead(e){await c.updateTable("notifications").set({read_at:h()}).where("user_id","=",e).whereNull("read_at").execute()},async unreadCount(e){let t=await c.selectFrom("notifications").select(c.fn.countAll().as("count")).where("user_id","=",e).whereNull("read_at").executeTakeFirst();return Number(t?.count??0)},async deleteNotification(e){await c.deleteFrom("notifications").where("id","=",e).execute()},async deleteAllNotifications(e){await c.deleteFrom("notifications").where("user_id","=",e).execute()}};import*as k from"@stacksjs/push";import*as P from"@stacksjs/sms";import{log as F}from"@stacksjs/cli";import{config as D}from"@stacksjs/config";import{db as q,sqlDateTime as R}from"@stacksjs/database";function _(e,t){switch(t){case"email":return e.email||"";case"sms":return e.phone||"";case"push":return Array.isArray(e.pushTokens)?e.pushTokens.join(", "):e.pushTokens||"";case"broadcast":return e.broadcastChannel||(e.userId?`private-user-${e.userId}`:"notifications");case"database":return e.userId?`User #${e.userId}`:"";case"chat":return"Configured chat destination"}}function y(e,t,n,r,i=R()){return{userId:e.userId,channel:n.channel,recipient:_(e,n.channel),subject:t.subject,body:t.body,status:n.success?"sent":"failed",error:n.error?.message,metadata:{...t.data,...r.category?{category:r.category}:{}},sentAt:i}}function M(e){let t=D.notification?.tracking;if(t?.enabled===!1)return!1;let n=t?.channels;if(!n||n.length===0)return!0;return n.includes(e)}async function b(e){if(!M(e.channel))return;let t=R();try{await q.insertInto("notification_deliveries").values({user_id:e.userId??null,channel:e.channel,recipient:e.recipient,subject:e.subject??null,body:D.notification?.tracking?.body===!1?"":e.body,status:e.status,error:e.error??null,metadata:e.metadata?JSON.stringify(e.metadata):null,sent_at:e.sentAt,created_at:t,updated_at:t}).execute()}catch(n){let r=n instanceof Error?n.message:String(n);F.warn(`[notifications] could not record ${e.channel} delivery: ${r}`)}}import{log as L}from"@stacksjs/cli";import{db as m,sqlDateTime as U}from"@stacksjs/database";var p="notification_preferences";function I(e,t){return t===null?e.whereNull("category"):e.where("category","=",t)}async function g(e,t){let n=new Map;try{let r=m.selectFrom(p).select(["channel","enabled","category"]).where("user_id","=",e);if(t!==void 0)r=r.where("category","=",t);let i=await r.execute();for(let a of i)n.set(a.channel,a.enabled===!0||a.enabled===1)}catch(r){L.debug?.(`[notifications] preferences lookup failed (table missing?): ${r.message}`)}return n}async function T(e,t,n,r){let i=U(),a=r??null,f=m.selectFrom(p).select(["id"]).where("user_id","=",e).where("channel","=",t),o=await I(f,a).executeTakeFirst();if(o?.id){await m.updateTable(p).set({enabled:n,updated_at:i}).where("id","=",o.id).execute();return}await m.insertInto(p).values({user_id:e,channel:t,enabled:n,category:a,created_at:i,updated_at:i}).execute()}async function J(e,t){for(let n of t)await T(e,n.channel,n.enabled,n.category)}async function w(e,t,n){let r=await g(e,n);if(n!==void 0){let i=await g(e,void 0);for(let[a,f]of i)if(!r.has(a))r.set(a,f)}return t.filter((i)=>{let a=r.get(i);return a===void 0?!0:a===!0})}var H=Q;function z(e){if(!e.success)throw Error(e.message||`Email delivery failed through ${e.provider||"the configured provider"}.`)}function S(e){return x[e||"slack"]}function A(e){if(e)try{return C.use(e)}catch(t){v.warn(`[notifications] email driver '${e}' not registered - falling back to default mail singleton (${t.message})`)}return C}function B(e){return P[e||"twilio"]}function G(){return k}function K(){return d}function Ne(){return l}function V(e,t){let n=e||H?.default||"email",r=t;switch(n){case"email":return A(r);case"chat":return S(r);case"sms":return B(r);case"database":return K();default:throw Error(`Notification type "${n}" is not supported`)}}function E(e){return!!e&&typeof e==="object"&&"send"in e&&typeof e.send==="function"}async function xe(e,t,n=["email"],r={}){let i=n;if(e.userId&&!r.ignorePreferences)try{i=await w(e.userId,n,r.category)}catch(o){v.warn(`[notify] preferences filter failed, sending all channels: ${o.message}`)}let f=(await Promise.allSettled(i.map(async(o)=>{switch(o){case"email":{if(!e.email)throw Error("[notify] email channel requires recipient.email");let u=await A().send({to:e.email,subject:t.subject??"",text:t.body,html:`<p>${W(t.body)}</p>`});z(u);break}case"sms":{if(!e.phone)throw Error("[notify] sms channel requires recipient.phone");if(r.ignorePreferences!==!0){let{isPhoneOptedOut:u}=await import("@stacksjs/sms");if(await u(e.phone))throw Error("[notify] sms recipient has opted out (STOP)")}let s=B();if(!E(s))throw Error("[notify] sms channel is not configured: no usable SMS driver with a send() method");await s.send({to:e.phone,body:t.body});break}case"chat":{let s=S();if(!E(s))throw Error("[notify] chat channel is not configured: no usable chat driver with a send() method");await s.send({body:t.body});break}case"database":{if(!e.userId)throw Error("[notify] database channel requires recipient.userId");await d.send({userId:e.userId,type:t.subject||"notification",data:{body:t.body,...t.data}});break}case"push":{if(!e.pushTokens||Array.isArray(e.pushTokens)&&e.pushTokens.length===0)throw Error("[notify] push channel requires recipient.pushTokens");await G().send(e.pushTokens,{title:t.subject,body:t.body,data:t.data});break}case"broadcast":{await l.send({channel:e.broadcastChannel,userId:e.userId,event:t.subject??"notification",data:{body:t.body,...t.data}});break}default:throw Error(`Unsupported notification channel: ${o}`)}}))).map((o,s)=>{let u=i[s];if(!u)throw Error(`Missing notification channel for result ${s}`);if(o.status==="rejected"){let O=o.reason instanceof Error?o.reason.message:String(o.reason);v.warn(`[notify] ${u} channel failed: ${O}`)}return{channel:u,success:o.status==="fulfilled",error:o.status==="rejected"?o.reason:void 0}});return await Promise.all(f.map((o)=>b(y(e,t,o,r)))),f}function ke(){return V()}function W(e){return String(e??"").replace(/[&<>"']/g,(t)=>({"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;"})[t])}export{l as BroadcastNotificationDriver,d as DatabaseNotificationDriver,J as bulkSetPreferences,z as ensureSuccessfulEmailResult,w as filterChannelsByPreferences,g as getNotificationPreferences,y as makeDeliveryRecord,ke as notification,xe as notify,b as recordNotificationDelivery,_ as resolveDeliveryRecipient,T as setNotificationPreference,Ne as useBroadcast,S as useChat,K as useDatabase,A as useEmail,V as useNotification,G as usePush,B as useSMS,I as wherePreferenceCategory};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/notifications",
   "type": "module",
   "sideEffects": false,
-  "version": "0.74.37",
+  "version": "0.74.39",
   "description": "The Stacks notifications integration.",
   "author": "Chris Breuer",
   "contributors": [
@@ -64,18 +64,18 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/chat": "0.74.37",
-    "@stacksjs/cli": "0.74.37",
-    "@stacksjs/config": "0.74.37",
-    "@stacksjs/database": "0.74.37",
-    "@stacksjs/email": "0.74.37",
-    "@stacksjs/push": "0.74.37",
-    "@stacksjs/realtime": "0.74.37",
-    "@stacksjs/sms": "0.74.37"
+    "@stacksjs/chat": "0.74.39",
+    "@stacksjs/cli": "0.74.39",
+    "@stacksjs/config": "0.74.39",
+    "@stacksjs/database": "0.74.39",
+    "@stacksjs/email": "0.74.39",
+    "@stacksjs/push": "0.74.39",
+    "@stacksjs/realtime": "0.74.39",
+    "@stacksjs/sms": "0.74.39"
   },
   "devDependencies": {
-    "@stacksjs/error-handling": "0.74.37",
-    "@stacksjs/types": "0.74.37",
+    "@stacksjs/error-handling": "0.74.39",
+    "@stacksjs/types": "0.74.39",
     "better-dx": "^0.2.24"
   }
 }