@stacksjs/newsletter 0.70.229 → 0.70.230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/campaigns.d.ts +10 -0
- package/dist/index.js +1 -1
- package/dist/lists.d.ts +2 -8
- package/package.json +5 -5
package/dist/campaigns.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { CreateCampaignInput } from './types';
|
|
1
2
|
/**
|
|
2
3
|
* Campaign CRUD + dispatch.
|
|
3
4
|
*
|
|
@@ -9,6 +10,9 @@
|
|
|
9
10
|
* through identical machinery.
|
|
10
11
|
*/
|
|
11
12
|
declare function resolveListId(input: CreateCampaignInput): Promise<number>;
|
|
13
|
+
export declare function shouldRunScheduledCampaign(campaign: ScheduledCampaignState, expectedScheduledAt?: string): boolean;
|
|
14
|
+
export declare function campaignCreateData(input: CreateCampaignInput, emailListId: number): Record<string, CampaignWriteValue>;
|
|
15
|
+
export declare function campaignUpdateData(patch: Partial<CreateCampaignInput>, emailListId?: number): Record<string, CampaignWriteValue>;
|
|
12
16
|
/**
|
|
13
17
|
* @defaultValue
|
|
14
18
|
* ```ts
|
|
@@ -35,3 +39,9 @@ export declare const campaigns: {
|
|
|
35
39
|
schedule: (id: number, scheduledAt: Date | string, options?: SendCampaignOptions) => Promise<void>;
|
|
36
40
|
cancel: (id: number) => Promise<void>
|
|
37
41
|
};
|
|
42
|
+
declare interface ScheduledCampaignState {
|
|
43
|
+
status?: unknown
|
|
44
|
+
scheduled_at?: unknown
|
|
45
|
+
scheduledAt?: unknown
|
|
46
|
+
}
|
|
47
|
+
declare type CampaignWriteValue = string | number | null;
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
var
|
|
2
|
+
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};
|
package/dist/lists.d.ts
CHANGED
|
@@ -1,11 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
*
|
|
4
|
-
* The model lives in `defaults/app/Models/EmailList.ts`; here we expose
|
|
5
|
-
* a friendlier surface for application code so callers don't depend on
|
|
6
|
-
* raw ORM idioms (which changes across releases).
|
|
7
|
-
*/
|
|
8
|
-
declare function slugify(input: string): string;
|
|
1
|
+
import type { CreateListInput } from './types';
|
|
2
|
+
export declare function emailListCreateData(input: CreateListInput): Record<string, string | number | null>;
|
|
9
3
|
/**
|
|
10
4
|
* @defaultValue
|
|
11
5
|
* ```ts
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@stacksjs/newsletter",
|
|
3
3
|
"type": "module",
|
|
4
4
|
"sideEffects": false,
|
|
5
|
-
"version": "0.70.
|
|
5
|
+
"version": "0.70.230",
|
|
6
6
|
"description": "Promotional email & newsletter primitives for Stacks. Lists, campaigns, subscribers, and one-click unsubscribe — sent through @stacksjs/email.",
|
|
7
7
|
"author": "Chris Breuer",
|
|
8
8
|
"contributors": [
|
|
@@ -56,10 +56,10 @@
|
|
|
56
56
|
"prepublishOnly": "bun run build"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@stacksjs/cli": "0.70.
|
|
60
|
-
"@stacksjs/config": "0.70.
|
|
59
|
+
"@stacksjs/cli": "0.70.230",
|
|
60
|
+
"@stacksjs/config": "0.70.230",
|
|
61
61
|
"better-dx": "^0.2.17",
|
|
62
|
-
"@stacksjs/error-handling": "0.70.
|
|
63
|
-
"@stacksjs/types": "0.70.
|
|
62
|
+
"@stacksjs/error-handling": "0.70.230",
|
|
63
|
+
"@stacksjs/types": "0.70.230"
|
|
64
64
|
}
|
|
65
65
|
}
|