@stacksjs/newsletter 0.70.357 → 0.70.362

package/dist/campaigns.d.ts

@@ -10,6 +10,11 @@ import type { CreateCampaignInput, SendCampaignOptions } from './types';
  * through identical machinery.
  */
 declare function resolveListId(input: CreateCampaignInput): Promise<number>;
+export declare function campaignDeliverySnapshot(campaign: any): CampaignDeliverySnapshot;
+export declare function campaignDeliveryDispatchKey(id: number, mode: 'immediate' | 'scheduled', attempt: string, scheduledAt?: string): string;
+export declare function canQueueCampaignStatus(status: unknown): boolean;
+declare function transitionCampaignDelivery(id: number, expected: CampaignDeliverySnapshot, target: CampaignDeliveryTarget): Promise<void>;
+declare function dispatchCampaign(id: number, target: CampaignDeliveryTarget, previous: CampaignDeliverySnapshot, options: SendCampaignOptions, scheduledAt?: string, delaySeconds?: number): Promise<void>;
 export declare function shouldRunScheduledCampaign(campaign: ScheduledCampaignState, expectedScheduledAt?: string): boolean;
 export declare function campaignCreateData(input: CreateCampaignInput, emailListId: number): Record<string, CampaignWriteValue>;
 export declare function campaignUpdateData(patch: Partial<CreateCampaignInput>, emailListId?: number): Record<string, CampaignWriteValue>;
@@ -44,4 +49,18 @@ declare interface ScheduledCampaignState {
   scheduled_at?: unknown
   scheduledAt?: unknown
 }
+declare interface CampaignDeliverySnapshot {
+  status: string
+  scheduledAt: string | null
+  updatedAt: string | null
+}
+declare interface CampaignDeliveryTarget {
+  status: string
+  scheduledAt: string | null
+  updatedAt: string
+  attemptId: string
+}
 declare type CampaignWriteValue = string | number | null;
+export declare class CampaignStateConflictError extends Error {
+  constructor(id: number);
+}

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-var M=import.meta.require;function _(z){return z.toLowerCase().trim().replace(/[^\w\s-]+/g,"").replace(/\s+/g,"-").replace(/-+/g,"-")}function q(z){return{name:z.name,slug:z.slug??_(z.name),description:z.description??null,status:"active",is_public:z.isPublic===!1?0:1,double_opt_in:z.doubleOptIn===!1?0:1,subscriber_count:0,active_count:0,unsubscribed_count:0,bounced_count:0}}var V={async create(z){let{EmailList:F}=await import("@stacksjs/orm");return F.create(q(z))},async find(z){let{EmailList:F}=await import("@stacksjs/orm");if(typeof z==="number")return F.find(z);return F.where("slug",z).first()},async all(){let{EmailList:z}=await import("@stacksjs/orm");return z.where("status","active").get()},async archive(z){let F=await V.find(z);if(!F)throw Error(`[newsletter] List '${String(z)}' not found`);return F.update({status:"archived"})}};async function Z(z){if(z.emailListId)return z.emailListId;if(z.emailListSlug){let F=await V.find(z.emailListSlug);if(!F)throw Error(`[newsletter] List '${z.emailListSlug}' not found`);return F.id}throw Error("[newsletter] Campaign requires emailListId or emailListSlug")}function w(z,F){if(!F)return!0;if(String(z.status||"")!=="scheduled")return!1;let G=z.scheduled_at??z.scheduledAt,H=new Date(String(G||"")).getTime(),J=new Date(F).getTime();return Number.isFinite(H)&&Number.isFinite(J)&&H===J}function N(z,F){return{name:z.name,description:z.description??null,type:"email",status:z.scheduledAt?"scheduled":"draft",subject:z.subject,template:z.template,text:z.text??null,from_name:z.fromName??null,from_address:z.fromAddress??null,email_list_id:F,scheduled_at:z.scheduledAt??null,sent_count:0}}function D(z,F){let G={};if(z.name!==void 0)G.name=z.name;if(z.description!==void 0)G.description=z.description;if(z.subject!==void 0)G.subject=z.subject;if(z.template!==void 0)G.template=z.template;if(z.text!==void 0)G.text=z.text;if(z.fromName!==void 0)G.from_name=z.fromName;if(z.fromAddress!==void 0)G.from_address=z.fromAddress;if(F!==void 0)G.email_list_id=F;if(z.scheduledAt!==void 0)G.scheduled_at=z.scheduledAt||null,G.status=z.scheduledAt?"scheduled":"draft";return G}var Y={async create(z){let{Campaign:F}=await import("@stacksjs/orm"),G=await Z(z);return F.create(N(z,G))},async find(z){let{Campaign:F}=await import("@stacksjs/orm");return F.find(z)},async update(z,F){let G=await Y.find(z);if(!G)throw Error(`[newsletter] Campaign ${z} not found`);if(G.status!=="draft"&&G.status!=="scheduled")throw Error(`[newsletter] Cannot edit campaign in status '${G.status}'`);let J=F.emailListId!==void 0||F.emailListSlug!==void 0?await Z(F):void 0;return G.update(D(F,J))},async sendNow(z,F={}){let G=await Y.find(z);if(!G)throw Error(`[newsletter] Campaign ${z} not found`);if(G.status==="sending"||G.status==="sent")throw Error(`[newsletter] Campaign ${z} already ${G.status}`);await G.update({status:"sending"});let{job:H}=await import("@stacksjs/queue");return await H("SendCampaign",{campaignId:z,chunkSize:F.chunkSize??50,dryRun:F.dryRun??!1}).onQueue("campaigns").dispatch(),{ok:!0,campaignId:z}},async schedule(z,F,G={}){let H=await Y.find(z);if(!H)throw Error(`[newsletter] Campaign ${z} not found`);let J=F instanceof Date?F:new Date(F);if(!Number.isFinite(J.getTime()))throw Error("[newsletter] scheduledAt must be a valid date");let Q=Math.max(0,Math.floor((J.getTime()-Date.now())/1000)),W=J.toISOString();await H.update({status:Q===0?"sending":"scheduled",scheduled_at:W});let{job:X}=await import("@stacksjs/queue");return await X("SendCampaign",{campaignId:z,chunkSize:G.chunkSize??50,dryRun:G.dryRun??!1,...Q>0?{scheduledAt:W}:{}}).onQueue("campaigns").delay(Q).dispatch(),{ok:!0,campaignId:z,scheduledAt:W}},async cancel(z){let F=await Y.find(z);if(!F)throw Error(`[newsletter] Campaign ${z} not found`);if(F.status==="sent")throw Error(`[newsletter] Campaign ${z} already sent \u2014 cannot cancel`);return F.update({status:"cancelled"})}};function f(z){if(!z.url||!/^https?:\/\//i.test(z.url))throw Error("[newsletter] List-Unsubscribe URL must be absolute (http/https)");let F=[];if(z.mailto)F.push(`<mailto:${z.mailto}>`);return F.push(`<${z.url}>`),{"List-Unsubscribe":F.join(", "),"List-Unsubscribe-Post":"List-Unsubscribe=One-Click"}}async function U(z){if(z==null){let G=await V.find("default");if(!G)G=await V.create({name:"Default",slug:"default"});return G.id}let F=await V.find(z);if(!F)throw Error(`[newsletter] List '${String(z)}' not found`);return F.id}async function $(z,F={}){if(!z||!z.includes("@"))throw Error("[newsletter] subscribe() requires a valid email address");let{Subscriber:G,EmailListSubscriber:H}=await import("@stacksjs/orm"),J=await U(F.list),Q=F.source??"api",W=await G.where("email",z).first();if(!W)W=await G.create({email:z,status:"subscribed",source:Q});let X=await H.where("subscriber_id",W.id).where("email_list_id",J).first();if(X){if(X.status==="unsubscribed")await X.update({status:"subscribed",unsubscribed_at:null});return{created:!1,email:z,listId:J,token:X.uuid}}let P=await H.create({subscriber_id:W.id,email_list_id:J,status:"subscribed",source:Q});return{created:!0,email:z,listId:J,token:P.uuid}}async function B(z){if(!z)return{ok:!1};let{EmailListSubscriber:F,Subscriber:G}=await import("@stacksjs/orm"),H=await F.where("uuid",z).first();if(!H)return{ok:!1};if(H.status==="unsubscribed")return{ok:!0,alreadyUnsubscribed:!0,email:(await G.find(H.subscriber_id))?.email,listId:H.email_list_id};return await H.update({status:"unsubscribed",unsubscribed_at:new Date().toISOString()}),{ok:!0,email:(await G.find(H.subscriber_id))?.email,listId:H.email_list_id}}async function K(z){let{Subscriber:F,EmailListSubscriber:G}=await import("@stacksjs/orm"),H=await F.where("email",z).first();if(!H)return 0;let J=await G.where("subscriber_id",H.id).where("status","subscribed").get();for(let Q of J)await Q.update({status:"unsubscribed",unsubscribed_at:new Date().toISOString()});return J.length}var k={lists:V,campaigns:Y,subscribe:$,unsubscribe:B,unsubscribeAll:K};export{K as unsubscribeAll,B as unsubscribe,$ as subscribe,w as shouldRunScheduledCampaign,k as newsletter,V as lists,q as emailListCreateData,Y as campaigns,D as campaignUpdateData,N as campaignCreateData,f as buildUnsubscribeHeaders};
+var Z=import.meta.require;import{db as T,sqlDateTime as _}from"@stacksjs/database";function x(z){return z.toLowerCase().trim().replace(/[^\w\s-]+/g,"").replace(/\s+/g,"-").replace(/-+/g,"-")}function D(z){return{name:z.name,slug:z.slug??x(z.name),description:z.description??null,status:"active",is_public:z.isPublic===!1?0:1,double_opt_in:z.doubleOptIn===!1?0:1,subscriber_count:0,active_count:0,unsubscribed_count:0,bounced_count:0}}var $={async create(z){let{EmailList:F}=await import("@stacksjs/orm");return F.create(D(z))},async find(z){let{EmailList:F}=await import("@stacksjs/orm");if(typeof z==="number")return F.find(z);return F.where("slug",z).first()},async all(){let{EmailList:z}=await import("@stacksjs/orm");return z.where("status","active").get()},async archive(z){let F=await $.find(z);if(!F)throw Error(`[newsletter] List '${String(z)}' not found`);return F.update({status:"archived"})}};async function U(z){if(z.emailListId)return z.emailListId;if(z.emailListSlug){let F=await $.find(z.emailListSlug);if(!F)throw Error(`[newsletter] List '${z.emailListSlug}' not found`);return F.id}throw Error("[newsletter] Campaign requires emailListId or emailListSlug")}class K extends Error{constructor(z){super(`[newsletter] Campaign ${z} changed before delivery could be queued`);this.name="CampaignStateConflictError"}}function N(z,F,G){if(typeof z?.get==="function"){let H=z.get(F);if(H!==void 0)return H;return z.get(G)}return z?.[F]??z?.[G]}function Q(z){let F=N(z,"scheduled_at","scheduledAt"),G=N(z,"updated_at","updatedAt");return{status:String(N(z,"status","status")||""),scheduledAt:F===null||F===void 0||F===""?null:String(F),updatedAt:G===null||G===void 0||G===""?null:String(G)}}function C(z,F,G,H){return`newsletter:campaign:${z}:${F}:${H||"now"}:${G}`}function V(z){return["draft","scheduled","paused","failed"].includes(String(z||"").toLowerCase())}function O(z){if(Array.isArray(z))return z.reduce((H,J)=>H+O(J),0);if(typeof z==="number"||typeof z==="bigint")return Number(z);let F=z,G=F?.changes??F?.affectedRows??F?.numAffectedRows??F?.numUpdatedRows;if(typeof G==="object"&&G!==null)return Number(G.changes||0);return Number(G||0)}function j(z,F){return F===null?z.whereNull("scheduled_at"):z.where("scheduled_at","=",F)}function I(z,F){return F===null?z.whereNull("updated_at"):z.where("updated_at","=",F)}async function M(z,F,G){let J=await I(j(T.updateTable("campaigns").set({status:G.status,scheduled_at:G.scheduledAt,updated_at:G.updatedAt}).where("id","=",z).where("status","=",F.status),F.scheduledAt),F.updatedAt).execute();if(O(J)!==1)throw new K(z)}async function L(z,F,G){await j(T.updateTable("campaigns").set({status:G.status,scheduled_at:G.scheduledAt,updated_at:_()}).where("id","=",z).where("status","=",F.status).where("updated_at","=",F.updatedAt),F.scheduledAt).execute()}async function R(z,F,G,H,J,W=0){let{job:X}=await import("@stacksjs/queue"),Y=J?"scheduled":"immediate";try{await X("SendCampaign",{campaignId:z,chunkSize:H.chunkSize??50,dryRun:H.dryRun??!1,...J?{scheduledAt:J}:{}}).onQueue("campaigns").delay(W).withIdempotencyKey(C(z,Y,F.attemptId,J)).dispatch()}catch(B){try{await L(z,F,G)}catch(w){throw AggregateError([B,w],`[newsletter] Campaign ${z} could not be dispatched or restored`)}throw B}}function h(z,F){if(!F)return!0;if(String(z.status||"")!=="scheduled")return!1;let G=z.scheduled_at??z.scheduledAt,H=new Date(String(G||"")).getTime(),J=new Date(F).getTime();return Number.isFinite(H)&&Number.isFinite(J)&&H===J}function k(z,F){return{name:z.name,description:z.description??null,type:"email",status:z.scheduledAt?"scheduled":"draft",subject:z.subject,template:z.template,text:z.text??null,from_name:z.fromName??null,from_address:z.fromAddress??null,email_list_id:F,scheduled_at:z.scheduledAt??null,sent_count:0}}function v(z,F){let G={};if(z.name!==void 0)G.name=z.name;if(z.description!==void 0)G.description=z.description;if(z.subject!==void 0)G.subject=z.subject;if(z.template!==void 0)G.template=z.template;if(z.text!==void 0)G.text=z.text;if(z.fromName!==void 0)G.from_name=z.fromName;if(z.fromAddress!==void 0)G.from_address=z.fromAddress;if(F!==void 0)G.email_list_id=F;if(z.scheduledAt!==void 0)G.scheduled_at=z.scheduledAt||null,G.status=z.scheduledAt?"scheduled":"draft";return G}var P={async create(z){let{Campaign:F}=await import("@stacksjs/orm"),G=await U(z);return F.create(k(z,G))},async find(z){let{Campaign:F}=await import("@stacksjs/orm");return F.find(z)},async update(z,F){let G=await P.find(z);if(!G)throw Error(`[newsletter] Campaign ${z} not found`);if(G.status!=="draft"&&G.status!=="scheduled")throw Error(`[newsletter] Cannot edit campaign in status '${G.status}'`);let J=F.emailListId!==void 0||F.emailListSlug!==void 0?await U(F):void 0;return G.update(v(F,J))},async sendNow(z,F={}){let G=await P.find(z);if(!G)throw Error(`[newsletter] Campaign ${z} not found`);if(!V(G.status))throw Error(`[newsletter] Campaign ${z} in status '${G.status}' cannot be queued`);let H=Q(G),J={status:"sending",scheduledAt:H.scheduledAt,updatedAt:_(),attemptId:crypto.randomUUID()};return await M(z,H,J),await R(z,J,H,F),{ok:!0,campaignId:z}},async schedule(z,F,G={}){let H=await P.find(z);if(!H)throw Error(`[newsletter] Campaign ${z} not found`);if(!V(H.status))throw Error(`[newsletter] Campaign ${z} in status '${H.status}' cannot be scheduled`);let J=F instanceof Date?F:new Date(F);if(!Number.isFinite(J.getTime()))throw Error("[newsletter] scheduledAt must be a valid date");let W=Math.max(0,Math.floor((J.getTime()-Date.now())/1000)),X=J.toISOString(),Y=Q(H),B={status:W===0?"sending":"scheduled",scheduledAt:X,updatedAt:_(),attemptId:crypto.randomUUID()};return await M(z,Y,B),await R(z,B,Y,G,W>0?X:void 0,W),{ok:!0,campaignId:z,scheduledAt:X}},async cancel(z){let F=await P.find(z);if(!F)throw Error(`[newsletter] Campaign ${z} not found`);if(F.status==="sent")throw Error(`[newsletter] Campaign ${z} already sent. It cannot be cancelled`);let G=Q(F),H={status:"cancelled",scheduledAt:G.scheduledAt,updatedAt:_(),attemptId:crypto.randomUUID()};return await M(z,G,H),P.find(z)}};function m(z){if(!z.url||!/^https?:\/\//i.test(z.url))throw Error("[newsletter] List-Unsubscribe URL must be absolute (http/https)");let F=[];if(z.mailto)F.push(`<mailto:${z.mailto}>`);return F.push(`<${z.url}>`),{"List-Unsubscribe":F.join(", "),"List-Unsubscribe-Post":"List-Unsubscribe=One-Click"}}async function S(z){if(z==null){let G=await $.find("default");if(!G)G=await $.create({name:"Default",slug:"default"});return G.id}let F=await $.find(z);if(!F)throw Error(`[newsletter] List '${String(z)}' not found`);return F.id}async function q(z,F={}){if(!z||!z.includes("@"))throw Error("[newsletter] subscribe() requires a valid email address");let{Subscriber:G,EmailListSubscriber:H}=await import("@stacksjs/orm"),J=await S(F.list),W=F.source??"api",X=await G.where("email",z).first();if(!X)X=await G.create({email:z,status:"subscribed",source:W});let Y=await H.where("subscriber_id",X.id).where("email_list_id",J).first();if(Y){if(Y.status==="unsubscribed")await Y.update({status:"subscribed",unsubscribed_at:null});return{created:!1,email:z,listId:J,token:Y.uuid}}let B=await H.create({subscriber_id:X.id,email_list_id:J,status:"subscribed",source:W});return{created:!0,email:z,listId:J,token:B.uuid}}async function E(z){if(!z)return{ok:!1};let{EmailListSubscriber:F,Subscriber:G}=await import("@stacksjs/orm"),H=await F.where("uuid",z).first();if(!H)return{ok:!1};if(H.status==="unsubscribed")return{ok:!0,alreadyUnsubscribed:!0,email:(await G.find(H.subscriber_id))?.email,listId:H.email_list_id};return await H.update({status:"unsubscribed",unsubscribed_at:new Date().toISOString()}),{ok:!0,email:(await G.find(H.subscriber_id))?.email,listId:H.email_list_id}}async function f(z){let{Subscriber:F,EmailListSubscriber:G}=await import("@stacksjs/orm"),H=await F.where("email",z).first();if(!H)return 0;let J=await G.where("subscriber_id",H.id).where("status","subscribed").get();for(let W of J)await W.update({status:"unsubscribed",unsubscribed_at:new Date().toISOString()});return J.length}var p={lists:$,campaigns:P,subscribe:q,unsubscribe:E,unsubscribeAll:f};export{f as unsubscribeAll,E as unsubscribe,q as subscribe,h as shouldRunScheduledCampaign,p as newsletter,$ as lists,D as emailListCreateData,V as canQueueCampaignStatus,P as campaigns,v as campaignUpdateData,Q as campaignDeliverySnapshot,C as campaignDeliveryDispatchKey,k as campaignCreateData,m as buildUnsubscribeHeaders,K as CampaignStateConflictError};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/newsletter",
   "type": "module",
   "sideEffects": false,
-  "version": "0.70.357",
+  "version": "0.70.362",
   "description": "Promotional email & newsletter primitives for Stacks. Lists, campaigns, subscribers, and one-click unsubscribe — sent through @stacksjs/email.",
   "author": "Chris Breuer",
   "contributors": [
@@ -60,11 +60,16 @@
     "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
+  "dependencies": {
+    "@stacksjs/database": "0.70.362",
+    "@stacksjs/orm": "0.70.362",
+    "@stacksjs/queue": "0.70.362"
+  },
   "devDependencies": {
-    "@stacksjs/cli": "0.70.357",
-    "@stacksjs/config": "0.70.357",
+    "@stacksjs/cli": "0.70.362",
+    "@stacksjs/config": "0.70.362",
     "better-dx": "^0.2.17",
-    "@stacksjs/error-handling": "0.70.357",
-    "@stacksjs/types": "0.70.357"
+    "@stacksjs/error-handling": "0.70.362",
+    "@stacksjs/types": "0.70.362"
   }
 }