@mobilizehub/payload-plugin 0.4.1 → 0.5.1
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/endpoints/emailWebhookHandler.d.ts +9 -0
- package/dist/endpoints/emailWebhookHandler.js +37 -0
- package/dist/endpoints/emailWebhookHandler.js.map +1 -0
- package/dist/fields/contact-fields.js +18 -6
- package/dist/fields/contact-fields.js.map +1 -1
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -1
- package/dist/tasks/sendBroadcastsTask.js +4 -3
- package/dist/tasks/sendBroadcastsTask.js.map +1 -1
- package/package.json +8 -8
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { PayloadHandler } from 'payload';
|
|
2
|
+
import type { MobilizehubPluginConfig } from '../types/index.js';
|
|
3
|
+
/**
|
|
4
|
+
* Creates the email webhook endpoint handler.
|
|
5
|
+
*
|
|
6
|
+
* Receives webhook events from email providers (e.g., Resend) and delegates
|
|
7
|
+
* processing to the configured email adapter's webhookHandler.
|
|
8
|
+
*/
|
|
9
|
+
export declare const emailWebhookHandler: (config: Pick<MobilizehubPluginConfig, "email">) => PayloadHandler;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
// src/endpoints/emailWebhookHandler.ts
|
|
2
|
+
import { ErrorCodes, errorResponse, successResponse } from '../utils/api-response.js';
|
|
3
|
+
/**
|
|
4
|
+
* Creates the email webhook endpoint handler.
|
|
5
|
+
*
|
|
6
|
+
* Receives webhook events from email providers (e.g., Resend) and delegates
|
|
7
|
+
* processing to the configured email adapter's webhookHandler.
|
|
8
|
+
*/ export const emailWebhookHandler = (config)=>{
|
|
9
|
+
return async (req)=>{
|
|
10
|
+
const { payload } = req;
|
|
11
|
+
const logger = payload.logger;
|
|
12
|
+
try {
|
|
13
|
+
const adapter = config.email({
|
|
14
|
+
payload
|
|
15
|
+
});
|
|
16
|
+
if (!adapter.webhookHandler) {
|
|
17
|
+
logger.warn('Email webhook received but no webhookHandler configured');
|
|
18
|
+
return errorResponse(ErrorCodes.BAD_REQUEST, 'Webhook handler not configured for this email adapter', 501);
|
|
19
|
+
}
|
|
20
|
+
const result = await adapter.webhookHandler(req);
|
|
21
|
+
logger.info('Email webhook processed successfully');
|
|
22
|
+
return successResponse(result?.body ?? {
|
|
23
|
+
received: true
|
|
24
|
+
}, result?.status ?? 200);
|
|
25
|
+
} catch (error) {
|
|
26
|
+
logger.error(error, 'Email webhook processing failed');
|
|
27
|
+
// Return 200 to prevent retry storms from providers
|
|
28
|
+
// Log the error but acknowledge receipt
|
|
29
|
+
return successResponse({
|
|
30
|
+
processed: false,
|
|
31
|
+
received: true
|
|
32
|
+
}, 200);
|
|
33
|
+
}
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
//# sourceMappingURL=emailWebhookHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/endpoints/emailWebhookHandler.ts"],"sourcesContent":["// src/endpoints/emailWebhookHandler.ts\nimport type { PayloadHandler } from 'payload'\n\nimport type { MobilizehubPluginConfig } from '../types/index.js'\n\nimport { ErrorCodes, errorResponse, successResponse } from '../utils/api-response.js'\n\n/**\n * Creates the email webhook endpoint handler.\n *\n * Receives webhook events from email providers (e.g., Resend) and delegates\n * processing to the configured email adapter's webhookHandler.\n */\nexport const emailWebhookHandler = (\n config: Pick<MobilizehubPluginConfig, 'email'>,\n): PayloadHandler => {\n return async (req) => {\n const { payload } = req\n const logger = payload.logger\n\n try {\n const adapter = config.email({ payload })\n\n if (!adapter.webhookHandler) {\n logger.warn('Email webhook received but no webhookHandler configured')\n return errorResponse(\n ErrorCodes.BAD_REQUEST,\n 'Webhook handler not configured for this email adapter',\n 501,\n )\n }\n\n const result = await adapter.webhookHandler(req)\n\n logger.info('Email webhook processed successfully')\n\n return successResponse(result?.body ?? { received: true }, result?.status ?? 200)\n } catch (error) {\n logger.error(error as Error, 'Email webhook processing failed')\n\n // Return 200 to prevent retry storms from providers\n // Log the error but acknowledge receipt\n return successResponse({ processed: false, received: true }, 200)\n }\n }\n}\n"],"names":["ErrorCodes","errorResponse","successResponse","emailWebhookHandler","config","req","payload","logger","adapter","email","webhookHandler","warn","BAD_REQUEST","result","info","body","received","status","error","processed"],"mappings":"AAAA,uCAAuC;AAKvC,SAASA,UAAU,EAAEC,aAAa,EAAEC,eAAe,QAAQ,2BAA0B;AAErF;;;;;CAKC,GACD,OAAO,MAAMC,sBAAsB,CACjCC;IAEA,OAAO,OAAOC;QACZ,MAAM,EAAEC,OAAO,EAAE,GAAGD;QACpB,MAAME,SAASD,QAAQC,MAAM;QAE7B,IAAI;YACF,MAAMC,UAAUJ,OAAOK,KAAK,CAAC;gBAAEH;YAAQ;YAEvC,IAAI,CAACE,QAAQE,cAAc,EAAE;gBAC3BH,OAAOI,IAAI,CAAC;gBACZ,OAAOV,cACLD,WAAWY,WAAW,EACtB,yDACA;YAEJ;YAEA,MAAMC,SAAS,MAAML,QAAQE,cAAc,CAACL;YAE5CE,OAAOO,IAAI,CAAC;YAEZ,OAAOZ,gBAAgBW,QAAQE,QAAQ;gBAAEC,UAAU;YAAK,GAAGH,QAAQI,UAAU;QAC/E,EAAE,OAAOC,OAAO;YACdX,OAAOW,KAAK,CAACA,OAAgB;YAE7B,oDAAoD;YACpD,wCAAwC;YACxC,OAAOhB,gBAAgB;gBAAEiB,WAAW;gBAAOH,UAAU;YAAK,GAAG;QAC/D;IACF;AACF,EAAC"}
|
|
@@ -104,17 +104,29 @@
|
|
|
104
104
|
}
|
|
105
105
|
],
|
|
106
106
|
filterOptions: ({ siblingData })=>{
|
|
107
|
-
const
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
const usedSlugs = blocks?.map((block)=>block.blockType) || [];
|
|
112
|
-
return CONTACT_FIELD_DEFINITIONS.map((def)=>def.name).filter((slug)=>!usedSlugs.includes(slug));
|
|
107
|
+
const allFieldNames = CONTACT_FIELD_DEFINITIONS.map((def)=>def.name);
|
|
108
|
+
const existingBlocks = siblingData?.contactFields ?? [];
|
|
109
|
+
const usedFieldNames = new Set(existingBlocks.map((block)=>block.blockType));
|
|
110
|
+
return allFieldNames.filter((name)=>!usedFieldNames.has(name));
|
|
113
111
|
},
|
|
114
112
|
label: 'Fields',
|
|
115
113
|
labels: {
|
|
116
114
|
plural: 'Fields',
|
|
117
115
|
singular: 'Field'
|
|
116
|
+
},
|
|
117
|
+
validate: (value)=>{
|
|
118
|
+
if (!value || !Array.isArray(value) || value.length === 0) {
|
|
119
|
+
return 'Email field is required';
|
|
120
|
+
}
|
|
121
|
+
const blockTypes = value.map((block)=>block.blockType);
|
|
122
|
+
if (!blockTypes.includes('email')) {
|
|
123
|
+
return 'Email field is required';
|
|
124
|
+
}
|
|
125
|
+
const uniqueTypes = new Set(blockTypes);
|
|
126
|
+
if (blockTypes.length !== uniqueTypes.size) {
|
|
127
|
+
return 'Each contact field can only be added once';
|
|
128
|
+
}
|
|
129
|
+
return true;
|
|
118
130
|
}
|
|
119
131
|
};
|
|
120
132
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/fields/contact-fields.ts"],"sourcesContent":["import type { Field } from 'payload'\n\n/**\n * Definitions for each contact field, including default required status and label.\n */\nexport const CONTACT_FIELD_DEFINITIONS = [\n { name: 'email', defaultLabel: 'Email', defaultRequired: true, label: 'Email' },\n {\n name: 'emailOptIn',\n defaultLabel: 'Receive emails',\n defaultRequired: false,\n label: 'Email Opt-In',\n },\n { name: 'firstName', defaultLabel: 'First Name', defaultRequired: false, label: 'First Name' },\n { name: 'lastName', defaultLabel: 'Last Name', defaultRequired: false, label: 'Last Name' },\n {\n name: 'mobileNumber',\n defaultLabel: 'Mobile Number',\n defaultRequired: false,\n label: 'Mobile Number',\n },\n {\n name: 'mobileOptIn',\n defaultLabel: 'Receive SMS',\n defaultRequired: false,\n label: 'Mobile Opt-In',\n },\n { name: 'address', defaultLabel: 'Address', defaultRequired: false, label: 'Address' },\n { name: 'city', defaultLabel: 'City', defaultRequired: false, label: 'City' },\n { name: 'state', defaultLabel: 'State', defaultRequired: false, label: 'State' },\n { name: 'zip', defaultLabel: 'Zip Code', defaultRequired: false, label: 'Zip Code' },\n { name: 'country', defaultLabel: 'Country', defaultRequired: false, label: 'Country' },\n] as const\n\n/**\n * Creates the contact fields configuration for a Payload CMS collection.\n * Each field can be customized with a label and whether it is required.\n */\nexport const createContactFieldsConfig = (): Field => {\n return {\n name: 'contactFields',\n type: 'blocks',\n admin: {\n description: 'Configure the fields to be included in the contact form.',\n },\n blocks: CONTACT_FIELD_DEFINITIONS.map((def) => ({\n slug: def.name,\n fields: [\n {\n name: 'label',\n type: 'text',\n admin: {\n placeholder: def.label,\n },\n defaultValue: def.defaultLabel,\n },\n {\n name: 'required',\n type: 'checkbox',\n defaultValue: def.defaultRequired,\n },\n ],\n })),\n defaultValue: [\n {\n blockType: 'email',\n label: 'Email',\n required: true,\n },\n ],\n filterOptions: ({ siblingData }) => {\n const
|
|
1
|
+
{"version":3,"sources":["../../src/fields/contact-fields.ts"],"sourcesContent":["import type { Field } from 'payload'\n\n/**\n * Definitions for each contact field, including default required status and label.\n */\nexport const CONTACT_FIELD_DEFINITIONS = [\n { name: 'email', defaultLabel: 'Email', defaultRequired: true, label: 'Email' },\n {\n name: 'emailOptIn',\n defaultLabel: 'Receive emails',\n defaultRequired: false,\n label: 'Email Opt-In',\n },\n { name: 'firstName', defaultLabel: 'First Name', defaultRequired: false, label: 'First Name' },\n { name: 'lastName', defaultLabel: 'Last Name', defaultRequired: false, label: 'Last Name' },\n {\n name: 'mobileNumber',\n defaultLabel: 'Mobile Number',\n defaultRequired: false,\n label: 'Mobile Number',\n },\n {\n name: 'mobileOptIn',\n defaultLabel: 'Receive SMS',\n defaultRequired: false,\n label: 'Mobile Opt-In',\n },\n { name: 'address', defaultLabel: 'Address', defaultRequired: false, label: 'Address' },\n { name: 'city', defaultLabel: 'City', defaultRequired: false, label: 'City' },\n { name: 'state', defaultLabel: 'State', defaultRequired: false, label: 'State' },\n { name: 'zip', defaultLabel: 'Zip Code', defaultRequired: false, label: 'Zip Code' },\n { name: 'country', defaultLabel: 'Country', defaultRequired: false, label: 'Country' },\n] as const\n\n/**\n * Creates the contact fields configuration for a Payload CMS collection.\n * Each field can be customized with a label and whether it is required.\n */\nexport const createContactFieldsConfig = (): Field => {\n return {\n name: 'contactFields',\n type: 'blocks',\n admin: {\n description: 'Configure the fields to be included in the contact form.',\n },\n blocks: CONTACT_FIELD_DEFINITIONS.map((def) => ({\n slug: def.name,\n fields: [\n {\n name: 'label',\n type: 'text',\n admin: {\n placeholder: def.label,\n },\n defaultValue: def.defaultLabel,\n },\n {\n name: 'required',\n type: 'checkbox',\n defaultValue: def.defaultRequired,\n },\n ],\n })),\n defaultValue: [\n {\n blockType: 'email',\n label: 'Email',\n required: true,\n },\n ],\n filterOptions: ({ siblingData }) => {\n const allFieldNames = CONTACT_FIELD_DEFINITIONS.map((def) => def.name)\n const existingBlocks =\n (siblingData as { contactFields?: { blockType: string }[] })?.contactFields ?? []\n const usedFieldNames = new Set(existingBlocks.map((block) => block.blockType))\n\n return allFieldNames.filter((name) => !usedFieldNames.has(name))\n },\n label: 'Fields',\n labels: {\n plural: 'Fields',\n singular: 'Field',\n },\n validate: (value) => {\n if (!value || !Array.isArray(value) || value.length === 0) {\n return 'Email field is required'\n }\n const blockTypes = value.map((block: { blockType: string }) => block.blockType)\n if (!blockTypes.includes('email')) {\n return 'Email field is required'\n }\n const uniqueTypes = new Set(blockTypes)\n if (blockTypes.length !== uniqueTypes.size) {\n return 'Each contact field can only be added once'\n }\n return true\n },\n }\n}\n"],"names":["CONTACT_FIELD_DEFINITIONS","name","defaultLabel","defaultRequired","label","createContactFieldsConfig","type","admin","description","blocks","map","def","slug","fields","placeholder","defaultValue","blockType","required","filterOptions","siblingData","allFieldNames","existingBlocks","contactFields","usedFieldNames","Set","block","filter","has","labels","plural","singular","validate","value","Array","isArray","length","blockTypes","includes","uniqueTypes","size"],"mappings":"AAEA;;CAEC,GACD,OAAO,MAAMA,4BAA4B;IACvC;QAAEC,MAAM;QAASC,cAAc;QAASC,iBAAiB;QAAMC,OAAO;IAAQ;IAC9E;QACEH,MAAM;QACNC,cAAc;QACdC,iBAAiB;QACjBC,OAAO;IACT;IACA;QAAEH,MAAM;QAAaC,cAAc;QAAcC,iBAAiB;QAAOC,OAAO;IAAa;IAC7F;QAAEH,MAAM;QAAYC,cAAc;QAAaC,iBAAiB;QAAOC,OAAO;IAAY;IAC1F;QACEH,MAAM;QACNC,cAAc;QACdC,iBAAiB;QACjBC,OAAO;IACT;IACA;QACEH,MAAM;QACNC,cAAc;QACdC,iBAAiB;QACjBC,OAAO;IACT;IACA;QAAEH,MAAM;QAAWC,cAAc;QAAWC,iBAAiB;QAAOC,OAAO;IAAU;IACrF;QAAEH,MAAM;QAAQC,cAAc;QAAQC,iBAAiB;QAAOC,OAAO;IAAO;IAC5E;QAAEH,MAAM;QAASC,cAAc;QAASC,iBAAiB;QAAOC,OAAO;IAAQ;IAC/E;QAAEH,MAAM;QAAOC,cAAc;QAAYC,iBAAiB;QAAOC,OAAO;IAAW;IACnF;QAAEH,MAAM;QAAWC,cAAc;QAAWC,iBAAiB;QAAOC,OAAO;IAAU;CACtF,CAAS;AAEV;;;CAGC,GACD,OAAO,MAAMC,4BAA4B;IACvC,OAAO;QACLJ,MAAM;QACNK,MAAM;QACNC,OAAO;YACLC,aAAa;QACf;QACAC,QAAQT,0BAA0BU,GAAG,CAAC,CAACC,MAAS,CAAA;gBAC9CC,MAAMD,IAAIV,IAAI;gBACdY,QAAQ;oBACN;wBACEZ,MAAM;wBACNK,MAAM;wBACNC,OAAO;4BACLO,aAAaH,IAAIP,KAAK;wBACxB;wBACAW,cAAcJ,IAAIT,YAAY;oBAChC;oBACA;wBACED,MAAM;wBACNK,MAAM;wBACNS,cAAcJ,IAAIR,eAAe;oBACnC;iBACD;YACH,CAAA;QACAY,cAAc;YACZ;gBACEC,WAAW;gBACXZ,OAAO;gBACPa,UAAU;YACZ;SACD;QACDC,eAAe,CAAC,EAAEC,WAAW,EAAE;YAC7B,MAAMC,gBAAgBpB,0BAA0BU,GAAG,CAAC,CAACC,MAAQA,IAAIV,IAAI;YACrE,MAAMoB,iBACJ,AAACF,aAA6DG,iBAAiB,EAAE;YACnF,MAAMC,iBAAiB,IAAIC,IAAIH,eAAeX,GAAG,CAAC,CAACe,QAAUA,MAAMT,SAAS;YAE5E,OAAOI,cAAcM,MAAM,CAAC,CAACzB,OAAS,CAACsB,eAAeI,GAAG,CAAC1B;QAC5D;QACAG,OAAO;QACPwB,QAAQ;YACNC,QAAQ;YACRC,UAAU;QACZ;QACAC,UAAU,CAACC;YACT,IAAI,CAACA,SAAS,CAACC,MAAMC,OAAO,CAACF,UAAUA,MAAMG,MAAM,KAAK,GAAG;gBACzD,OAAO;YACT;YACA,MAAMC,aAAaJ,MAAMtB,GAAG,CAAC,CAACe,QAAiCA,MAAMT,SAAS;YAC9E,IAAI,CAACoB,WAAWC,QAAQ,CAAC,UAAU;gBACjC,OAAO;YACT;YACA,MAAMC,cAAc,IAAId,IAAIY;YAC5B,IAAIA,WAAWD,MAAM,KAAKG,YAAYC,IAAI,EAAE;gBAC1C,OAAO;YACT;YACA,OAAO;QACT;IACF;AACF,EAAC"}
|
package/dist/index.js
CHANGED
|
@@ -6,6 +6,7 @@ import { generateFormsCollection } from './collections/forms/generateFormsCollec
|
|
|
6
6
|
import { generatePagesCollection } from './collections/pages/generatePagesCollection.js';
|
|
7
7
|
import { generateTagsCollection } from './collections/tags/generateTagsCollection.js';
|
|
8
8
|
import { generateUnsubscribeTokensCollection } from './collections/unsubscribe-tokens/generateUnsubscribeTokens.js';
|
|
9
|
+
import { emailWebhookHandler } from './endpoints/emailWebhookHandler.js';
|
|
9
10
|
import { sendBroadcastHandler } from './endpoints/sendBroadcastHandler.js';
|
|
10
11
|
import { sendTestEmailHandler } from './endpoints/sendTestBroadcastHandler.js';
|
|
11
12
|
import { unsubscribeHandler } from './endpoints/unsubscribeHandler.js';
|
|
@@ -38,6 +39,11 @@ export const mobilizehubPlugin = (pluginOptions)=>(config)=>{
|
|
|
38
39
|
handler: unsubscribeHandler(),
|
|
39
40
|
method: 'post',
|
|
40
41
|
path: '/unsubscribe'
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
handler: emailWebhookHandler(pluginOptions),
|
|
45
|
+
method: 'post',
|
|
46
|
+
path: '/webhooks/email'
|
|
41
47
|
}
|
|
42
48
|
];
|
|
43
49
|
config.endpoints = [
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config, Endpoint, TaskConfig } from 'payload'\n\nimport type { MobilizehubPluginConfig } from './types/index.js'\n\nimport { generateBroadcastsCollection } from './collections/broadcasts/generateBroadcastsCollection.js'\nimport { generateContactsCollection } from './collections/contacts/generateContactsCollection.js'\nimport { generateEmailsCollection } from './collections/emails/generateEmailsCollection.js'\nimport { generateFormSubmissionsCollection } from './collections/form-submissions/generateFormSubmissionsCollection.js'\nimport { generateFormsCollection } from './collections/forms/generateFormsCollection.js'\nimport { generatePagesCollection } from './collections/pages/generatePagesCollection.js'\nimport { generateTagsCollection } from './collections/tags/generateTagsCollection.js'\nimport { generateUnsubscribeTokensCollection } from './collections/unsubscribe-tokens/generateUnsubscribeTokens.js'\nimport { sendBroadcastHandler } from './endpoints/sendBroadcastHandler.js'\nimport { sendTestEmailHandler } from './endpoints/sendTestBroadcastHandler.js'\nimport { unsubscribeHandler } from './endpoints/unsubscribeHandler.js'\nimport { createSendBroadcastsTask } from './tasks/sendBroadcastsTask.js'\nimport { createSendEmailTask } from './tasks/sendEmailTask.js'\n\nexport * from './types/index.js'\n\nexport const mobilizehubPlugin =\n (pluginOptions: MobilizehubPluginConfig) =>\n (config: Config): Config => {\n if (!config.collections) {\n config.collections = []\n }\n\n config.collections.push(\n generateTagsCollection(pluginOptions),\n generateContactsCollection(pluginOptions),\n generateBroadcastsCollection(pluginOptions),\n generateEmailsCollection(pluginOptions),\n generatePagesCollection(pluginOptions),\n generateUnsubscribeTokensCollection(),\n generateFormSubmissionsCollection(pluginOptions),\n generateFormsCollection(pluginOptions),\n )\n\n if (pluginOptions.disabled) {\n return config\n }\n\n if (!config.endpoints) {\n config.endpoints = []\n }\n\n const endpoints: Endpoint[] = [\n {\n handler: sendBroadcastHandler(),\n method: 'post',\n path: '/send-broadcast',\n },\n {\n handler: sendTestEmailHandler(pluginOptions),\n method: 'post',\n path: '/send-test-email',\n },\n {\n handler: unsubscribeHandler(),\n method: 'post',\n path: '/unsubscribe',\n },\n ]\n\n config.endpoints = [...config.endpoints, ...endpoints]\n\n if (!config.jobs) {\n config.jobs = {\n tasks: [],\n }\n }\n\n const tasks: TaskConfig[] = [\n createSendBroadcastsTask(pluginOptions),\n createSendEmailTask(pluginOptions),\n ]\n\n config.jobs.tasks = [...(config.jobs.tasks ?? []), ...tasks]\n\n const incomingOnInit = config.onInit\n\n config.onInit = async (payload) => {\n if (incomingOnInit) {\n await incomingOnInit(payload)\n }\n }\n\n return config\n }\n"],"names":["generateBroadcastsCollection","generateContactsCollection","generateEmailsCollection","generateFormSubmissionsCollection","generateFormsCollection","generatePagesCollection","generateTagsCollection","generateUnsubscribeTokensCollection","sendBroadcastHandler","sendTestEmailHandler","unsubscribeHandler","createSendBroadcastsTask","createSendEmailTask","mobilizehubPlugin","pluginOptions","config","collections","push","disabled","endpoints","handler","method","path","jobs","tasks","incomingOnInit","onInit","payload"],"mappings":"AAIA,SAASA,4BAA4B,QAAQ,2DAA0D;AACvG,SAASC,0BAA0B,QAAQ,uDAAsD;AACjG,SAASC,wBAAwB,QAAQ,mDAAkD;AAC3F,SAASC,iCAAiC,QAAQ,sEAAqE;AACvH,SAASC,uBAAuB,QAAQ,iDAAgD;AACxF,SAASC,uBAAuB,QAAQ,iDAAgD;AACxF,SAASC,sBAAsB,QAAQ,+CAA8C;AACrF,SAASC,mCAAmC,QAAQ,gEAA+D;AACnH,SAASC,oBAAoB,QAAQ,sCAAqC;AAC1E,SAASC,oBAAoB,QAAQ,0CAAyC;AAC9E,SAASC,kBAAkB,QAAQ,oCAAmC;AACtE,SAASC,wBAAwB,QAAQ,gCAA+B;AACxE,SAASC,mBAAmB,QAAQ,2BAA0B;AAE9D,cAAc,mBAAkB;AAEhC,OAAO,MAAMC,oBACX,CAACC,gBACD,CAACC;QACC,IAAI,CAACA,OAAOC,WAAW,EAAE;YACvBD,OAAOC,WAAW,GAAG,EAAE;QACzB;QAEAD,OAAOC,WAAW,CAACC,IAAI,
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config, Endpoint, TaskConfig } from 'payload'\n\nimport type { MobilizehubPluginConfig } from './types/index.js'\n\nimport { generateBroadcastsCollection } from './collections/broadcasts/generateBroadcastsCollection.js'\nimport { generateContactsCollection } from './collections/contacts/generateContactsCollection.js'\nimport { generateEmailsCollection } from './collections/emails/generateEmailsCollection.js'\nimport { generateFormSubmissionsCollection } from './collections/form-submissions/generateFormSubmissionsCollection.js'\nimport { generateFormsCollection } from './collections/forms/generateFormsCollection.js'\nimport { generatePagesCollection } from './collections/pages/generatePagesCollection.js'\nimport { generateTagsCollection } from './collections/tags/generateTagsCollection.js'\nimport { generateUnsubscribeTokensCollection } from './collections/unsubscribe-tokens/generateUnsubscribeTokens.js'\nimport { emailWebhookHandler } from './endpoints/emailWebhookHandler.js'\nimport { sendBroadcastHandler } from './endpoints/sendBroadcastHandler.js'\nimport { sendTestEmailHandler } from './endpoints/sendTestBroadcastHandler.js'\nimport { unsubscribeHandler } from './endpoints/unsubscribeHandler.js'\nimport { createSendBroadcastsTask } from './tasks/sendBroadcastsTask.js'\nimport { createSendEmailTask } from './tasks/sendEmailTask.js'\n\nexport * from './types/index.js'\n\nexport const mobilizehubPlugin =\n (pluginOptions: MobilizehubPluginConfig) =>\n (config: Config): Config => {\n if (!config.collections) {\n config.collections = []\n }\n\n config.collections.push(\n generateTagsCollection(pluginOptions),\n generateContactsCollection(pluginOptions),\n generateBroadcastsCollection(pluginOptions),\n generateEmailsCollection(pluginOptions),\n generatePagesCollection(pluginOptions),\n generateUnsubscribeTokensCollection(),\n generateFormSubmissionsCollection(pluginOptions),\n generateFormsCollection(pluginOptions),\n )\n\n if (pluginOptions.disabled) {\n return config\n }\n\n if (!config.endpoints) {\n config.endpoints = []\n }\n\n const endpoints: Endpoint[] = [\n {\n handler: sendBroadcastHandler(),\n method: 'post',\n path: '/send-broadcast',\n },\n {\n handler: sendTestEmailHandler(pluginOptions),\n method: 'post',\n path: '/send-test-email',\n },\n {\n handler: unsubscribeHandler(),\n method: 'post',\n path: '/unsubscribe',\n },\n {\n handler: emailWebhookHandler(pluginOptions),\n method: 'post',\n path: '/webhooks/email',\n },\n ]\n\n config.endpoints = [...config.endpoints, ...endpoints]\n\n if (!config.jobs) {\n config.jobs = {\n tasks: [],\n }\n }\n\n const tasks: TaskConfig[] = [\n createSendBroadcastsTask(pluginOptions),\n createSendEmailTask(pluginOptions),\n ]\n\n config.jobs.tasks = [...(config.jobs.tasks ?? []), ...tasks]\n\n const incomingOnInit = config.onInit\n\n config.onInit = async (payload) => {\n if (incomingOnInit) {\n await incomingOnInit(payload)\n }\n }\n\n return config\n }\n"],"names":["generateBroadcastsCollection","generateContactsCollection","generateEmailsCollection","generateFormSubmissionsCollection","generateFormsCollection","generatePagesCollection","generateTagsCollection","generateUnsubscribeTokensCollection","emailWebhookHandler","sendBroadcastHandler","sendTestEmailHandler","unsubscribeHandler","createSendBroadcastsTask","createSendEmailTask","mobilizehubPlugin","pluginOptions","config","collections","push","disabled","endpoints","handler","method","path","jobs","tasks","incomingOnInit","onInit","payload"],"mappings":"AAIA,SAASA,4BAA4B,QAAQ,2DAA0D;AACvG,SAASC,0BAA0B,QAAQ,uDAAsD;AACjG,SAASC,wBAAwB,QAAQ,mDAAkD;AAC3F,SAASC,iCAAiC,QAAQ,sEAAqE;AACvH,SAASC,uBAAuB,QAAQ,iDAAgD;AACxF,SAASC,uBAAuB,QAAQ,iDAAgD;AACxF,SAASC,sBAAsB,QAAQ,+CAA8C;AACrF,SAASC,mCAAmC,QAAQ,gEAA+D;AACnH,SAASC,mBAAmB,QAAQ,qCAAoC;AACxE,SAASC,oBAAoB,QAAQ,sCAAqC;AAC1E,SAASC,oBAAoB,QAAQ,0CAAyC;AAC9E,SAASC,kBAAkB,QAAQ,oCAAmC;AACtE,SAASC,wBAAwB,QAAQ,gCAA+B;AACxE,SAASC,mBAAmB,QAAQ,2BAA0B;AAE9D,cAAc,mBAAkB;AAEhC,OAAO,MAAMC,oBACX,CAACC,gBACD,CAACC;QACC,IAAI,CAACA,OAAOC,WAAW,EAAE;YACvBD,OAAOC,WAAW,GAAG,EAAE;QACzB;QAEAD,OAAOC,WAAW,CAACC,IAAI,CACrBZ,uBAAuBS,gBACvBd,2BAA2Bc,gBAC3Bf,6BAA6Be,gBAC7Bb,yBAAyBa,gBACzBV,wBAAwBU,gBACxBR,uCACAJ,kCAAkCY,gBAClCX,wBAAwBW;QAG1B,IAAIA,cAAcI,QAAQ,EAAE;YAC1B,OAAOH;QACT;QAEA,IAAI,CAACA,OAAOI,SAAS,EAAE;YACrBJ,OAAOI,SAAS,GAAG,EAAE;QACvB;QAEA,MAAMA,YAAwB;YAC5B;gBACEC,SAASZ;gBACTa,QAAQ;gBACRC,MAAM;YACR;YACA;gBACEF,SAASX,qBAAqBK;gBAC9BO,QAAQ;gBACRC,MAAM;YACR;YACA;gBACEF,SAASV;gBACTW,QAAQ;gBACRC,MAAM;YACR;YACA;gBACEF,SAASb,oBAAoBO;gBAC7BO,QAAQ;gBACRC,MAAM;YACR;SACD;QAEDP,OAAOI,SAAS,GAAG;eAAIJ,OAAOI,SAAS;eAAKA;SAAU;QAEtD,IAAI,CAACJ,OAAOQ,IAAI,EAAE;YAChBR,OAAOQ,IAAI,GAAG;gBACZC,OAAO,EAAE;YACX;QACF;QAEA,MAAMA,QAAsB;YAC1Bb,yBAAyBG;YACzBF,oBAAoBE;SACrB;QAEDC,OAAOQ,IAAI,CAACC,KAAK,GAAG;eAAKT,OAAOQ,IAAI,CAACC,KAAK,IAAI,EAAE;eAAMA;SAAM;QAE5D,MAAMC,iBAAiBV,OAAOW,MAAM;QAEpCX,OAAOW,MAAM,GAAG,OAAOC;YACrB,IAAIF,gBAAgB;gBAClB,MAAMA,eAAeE;YACvB;QACF;QAEA,OAAOZ;IACT,EAAC"}
|
|
@@ -85,7 +85,8 @@ import z from 'zod';
|
|
|
85
85
|
*/ export const createSendBroadcastsTask = (pluginConfig)=>{
|
|
86
86
|
const BATCH_SIZE = pluginConfig.broadcastConfig?.batchSize || 100;
|
|
87
87
|
const TASK_SCHEDULE = pluginConfig.broadcastConfig?.taskSchedule || '*/5 * * * *';
|
|
88
|
-
const
|
|
88
|
+
const BROADCAST_QUEUE_NAME = pluginConfig.broadcastConfig?.broadcastQueueName || 'send-broadcasts';
|
|
89
|
+
const EMAIL_QUEUE_NAME = pluginConfig.broadcastConfig?.emailQueueName || 'send-emails';
|
|
89
90
|
return {
|
|
90
91
|
slug: 'send-broadcasts',
|
|
91
92
|
handler: async ({ req })=>{
|
|
@@ -157,7 +158,7 @@ import z from 'zod';
|
|
|
157
158
|
broadcastId: broadcast.id,
|
|
158
159
|
contactId: contact.id
|
|
159
160
|
},
|
|
160
|
-
queue:
|
|
161
|
+
queue: EMAIL_QUEUE_NAME,
|
|
161
162
|
task: 'send-email'
|
|
162
163
|
})));
|
|
163
164
|
await payload.update({
|
|
@@ -187,7 +188,7 @@ import z from 'zod';
|
|
|
187
188
|
schedule: [
|
|
188
189
|
{
|
|
189
190
|
cron: TASK_SCHEDULE,
|
|
190
|
-
queue:
|
|
191
|
+
queue: BROADCAST_QUEUE_NAME
|
|
191
192
|
}
|
|
192
193
|
]
|
|
193
194
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/tasks/sendBroadcastsTask.ts"],"sourcesContent":["import type { TaskConfig, Where } from 'payload'\n\nimport z from 'zod'\n\nimport type { MobilizehubPluginConfig } from '../types/index.js'\n\n/**\n * Schema for validating broadcast documents before processing.\n */\nconst BroadcastSchema = z.object({\n id: z.number(),\n content: z.any().refine((val) => val !== undefined && val !== null, {\n message: 'Broadcast content is missing',\n }),\n fromAddress: z.email({ message: 'Invalid from address email format' }),\n fromName: z.string().min(1, { message: 'From name is required' }),\n meta: z.object({\n contactsCount: z.number().min(0),\n lastProcessedContactId: z.number().min(0).default(0),\n processedCount: z.number().min(0),\n }),\n subject: z.string().min(1, { message: 'Subject is required' }),\n tags: z.array(z.any()).optional(),\n to: z.literal('all').or(z.literal('tags')),\n})\n\ntype ParsedBroadcast = z.infer<typeof BroadcastSchema>\n\n/**\n * Validates a broadcast document against the schema.\n * Returns typed data on success, or flattened field errors on failure.\n */\nfunction safeParseBroadcast(broadcast: unknown) {\n const result = BroadcastSchema.safeParse(broadcast)\n\n if (!result.success) {\n return {\n data: null,\n errors: z.flattenError(result.error).fieldErrors,\n success: false as const,\n }\n }\n\n return {\n data: result.data,\n success: true as const,\n }\n}\n\n/**\n * Builds the where clause for fetching the next batch of contacts.\n * Uses cursor-based pagination (id > lastProcessedContactId) for consistent\n * ordering and efficient queries at scale.\n */\nfunction buildContactsWhereClause(\n broadcast: ParsedBroadcast,\n rawBroadcast: Record<string, unknown>,\n): Where {\n const conditions: Where[] = [\n { emailOptIn: { equals: true } },\n { id: { greater_than: broadcast.meta.lastProcessedContactId } },\n ]\n\n // Tags may be populated objects or raw IDs depending on query depth\n if (broadcast.to === 'tags' && Array.isArray(rawBroadcast.tags) && rawBroadcast.tags.length > 0) {\n const tagIds = rawBroadcast.tags.map((t: { id: number | string } | number | string) =>\n typeof t === 'object' ? t.id : t,\n )\n conditions.push({ tags: { in: tagIds } })\n }\n\n return { and: conditions }\n}\n\n/**\n * Extracts a numeric ID from a contact, handling string IDs from some database adapters.\n */\nfunction getLastContactId(contact: { id: number | string }): number {\n return typeof contact.id === 'number' ? contact.id : parseInt(contact.id, 10)\n}\n\n/**\n * Creates the send-broadcasts scheduled task.\n *\n * Processes broadcasts by polling for documents with status 'sending' and\n * queuing batches of send-email jobs. Each invocation processes one broadcast\n * and one batch of contacts, allowing the task to be distributed across\n * multiple schedule intervals.\n */\nexport const createSendBroadcastsTask = (pluginConfig: MobilizehubPluginConfig): TaskConfig => {\n const BATCH_SIZE = pluginConfig.broadcastConfig?.batchSize || 100\n const TASK_SCHEDULE = pluginConfig.broadcastConfig?.taskSchedule || '*/5 * * * *'\n const QUEUE_NAME = pluginConfig.broadcastConfig?.broadcastQueueName || 'send-broadcasts'\n\n return {\n slug: 'send-broadcasts',\n handler: async ({ req }) => {\n const { payload } = req\n const logger = payload.logger\n\n logger.info('Send Broadcast task handler called')\n\n const { docs } = await payload.find({\n collection: 'broadcasts',\n limit: 1,\n sort: 'id',\n where: { status: { equals: 'sending' } },\n })\n\n const rawBroadcast = docs[0]\n\n if (!rawBroadcast) {\n logger.info('No broadcasts with status \"sending\" found')\n return { output: { success: true } }\n }\n\n const parsed = safeParseBroadcast(rawBroadcast)\n\n if (!parsed.success) {\n logger.error({ errors: parsed.errors }, `Broadcast ${rawBroadcast.id} validation failed`)\n await payload.update({\n id: rawBroadcast.id,\n collection: 'broadcasts',\n data: { status: 'failed' },\n })\n return { output: { success: false } }\n }\n\n const broadcast = parsed.data\n const whereClause = buildContactsWhereClause(\n broadcast,\n rawBroadcast as Record<string, unknown>,\n )\n\n const { docs: contacts } = await payload.find({\n collection: 'contacts',\n limit: BATCH_SIZE,\n sort: 'id',\n where: whereClause,\n })\n\n if (contacts.length === 0) {\n logger.info(\n `Broadcast ${broadcast.id} complete. ` +\n `Processed: ${broadcast.meta.processedCount}, Expected: ${broadcast.meta.contactsCount}`,\n )\n await payload.update({\n id: broadcast.id,\n collection: 'broadcasts',\n data: { status: 'sent' },\n })\n return { output: { success: true } }\n }\n\n await Promise.all(\n contacts.map((contact) =>\n payload.jobs.queue({\n input: { broadcastId: broadcast.id, contactId: contact.id },\n queue: 'send-emails',\n task: 'send-email',\n }),\n ),\n )\n\n await payload.update({\n id: broadcast.id,\n collection: 'broadcasts',\n data: {\n meta: {\n lastProcessedContactId: getLastContactId(contacts[contacts.length - 1]),\n processedCount: broadcast.meta.processedCount + contacts.length,\n },\n },\n })\n\n logger.info(\n `Broadcast ${broadcast.id}: queued ${contacts.length} emails, ` +\n `total processed: ${broadcast.meta.processedCount + contacts.length}`,\n )\n\n return { output: { success: true } }\n },\n outputSchema: [\n {\n name: 'success',\n type: 'checkbox',\n },\n ],\n retries: 3,\n schedule: [\n {\n cron: TASK_SCHEDULE,\n queue: QUEUE_NAME,\n },\n ],\n }\n}\n"],"names":["z","BroadcastSchema","object","id","number","content","any","refine","val","undefined","message","fromAddress","email","fromName","string","min","meta","contactsCount","lastProcessedContactId","default","processedCount","subject","tags","array","optional","to","literal","or","safeParseBroadcast","broadcast","result","safeParse","success","data","errors","flattenError","error","fieldErrors","buildContactsWhereClause","rawBroadcast","conditions","emailOptIn","equals","greater_than","Array","isArray","length","tagIds","map","t","push","in","and","getLastContactId","contact","parseInt","createSendBroadcastsTask","pluginConfig","BATCH_SIZE","broadcastConfig","batchSize","TASK_SCHEDULE","taskSchedule","QUEUE_NAME","broadcastQueueName","slug","handler","req","payload","logger","info","docs","find","collection","limit","sort","where","status","output","parsed","update","whereClause","contacts","Promise","all","jobs","queue","input","broadcastId","contactId","task","outputSchema","name","type","retries","schedule","cron"],"mappings":"AAEA,OAAOA,OAAO,MAAK;AAInB;;CAEC,GACD,MAAMC,kBAAkBD,EAAEE,MAAM,CAAC;IAC/BC,IAAIH,EAAEI,MAAM;IACZC,SAASL,EAAEM,GAAG,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC,aAAaD,QAAQ,MAAM;QAClEE,SAAS;IACX;IACAC,aAAaX,EAAEY,KAAK,CAAC;QAAEF,SAAS;IAAoC;IACpEG,UAAUb,EAAEc,MAAM,GAAGC,GAAG,CAAC,GAAG;QAAEL,SAAS;IAAwB;IAC/DM,MAAMhB,EAAEE,MAAM,CAAC;QACbe,eAAejB,EAAEI,MAAM,GAAGW,GAAG,CAAC;QAC9BG,wBAAwBlB,EAAEI,MAAM,GAAGW,GAAG,CAAC,GAAGI,OAAO,CAAC;QAClDC,gBAAgBpB,EAAEI,MAAM,GAAGW,GAAG,CAAC;IACjC;IACAM,SAASrB,EAAEc,MAAM,GAAGC,GAAG,CAAC,GAAG;QAAEL,SAAS;IAAsB;IAC5DY,MAAMtB,EAAEuB,KAAK,CAACvB,EAAEM,GAAG,IAAIkB,QAAQ;IAC/BC,IAAIzB,EAAE0B,OAAO,CAAC,OAAOC,EAAE,CAAC3B,EAAE0B,OAAO,CAAC;AACpC;AAIA;;;CAGC,GACD,SAASE,mBAAmBC,SAAkB;IAC5C,MAAMC,SAAS7B,gBAAgB8B,SAAS,CAACF;IAEzC,IAAI,CAACC,OAAOE,OAAO,EAAE;QACnB,OAAO;YACLC,MAAM;YACNC,QAAQlC,EAAEmC,YAAY,CAACL,OAAOM,KAAK,EAAEC,WAAW;YAChDL,SAAS;QACX;IACF;IAEA,OAAO;QACLC,MAAMH,OAAOG,IAAI;QACjBD,SAAS;IACX;AACF;AAEA;;;;CAIC,GACD,SAASM,yBACPT,SAA0B,EAC1BU,YAAqC;IAErC,MAAMC,aAAsB;QAC1B;YAAEC,YAAY;gBAAEC,QAAQ;YAAK;QAAE;QAC/B;YAAEvC,IAAI;gBAAEwC,cAAcd,UAAUb,IAAI,CAACE,sBAAsB;YAAC;QAAE;KAC/D;IAED,oEAAoE;IACpE,IAAIW,UAAUJ,EAAE,KAAK,UAAUmB,MAAMC,OAAO,CAACN,aAAajB,IAAI,KAAKiB,aAAajB,IAAI,CAACwB,MAAM,GAAG,GAAG;QAC/F,MAAMC,SAASR,aAAajB,IAAI,CAAC0B,GAAG,CAAC,CAACC,IACpC,OAAOA,MAAM,WAAWA,EAAE9C,EAAE,GAAG8C;QAEjCT,WAAWU,IAAI,CAAC;YAAE5B,MAAM;gBAAE6B,IAAIJ;YAAO;QAAE;IACzC;IAEA,OAAO;QAAEK,KAAKZ;IAAW;AAC3B;AAEA;;CAEC,GACD,SAASa,iBAAiBC,OAAgC;IACxD,OAAO,OAAOA,QAAQnD,EAAE,KAAK,WAAWmD,QAAQnD,EAAE,GAAGoD,SAASD,QAAQnD,EAAE,EAAE;AAC5E;AAEA;;;;;;;CAOC,GACD,OAAO,MAAMqD,2BAA2B,CAACC;IACvC,MAAMC,aAAaD,aAAaE,eAAe,EAAEC,aAAa;IAC9D,MAAMC,gBAAgBJ,aAAaE,eAAe,EAAEG,gBAAgB;IACpE,MAAMC,aAAaN,aAAaE,eAAe,EAAEK,sBAAsB;IAEvE,OAAO;QACLC,MAAM;QACNC,SAAS,OAAO,EAAEC,GAAG,EAAE;YACrB,MAAM,EAAEC,OAAO,EAAE,GAAGD;YACpB,MAAME,SAASD,QAAQC,MAAM;YAE7BA,OAAOC,IAAI,CAAC;YAEZ,MAAM,EAAEC,IAAI,EAAE,GAAG,MAAMH,QAAQI,IAAI,CAAC;gBAClCC,YAAY;gBACZC,OAAO;gBACPC,MAAM;gBACNC,OAAO;oBAAEC,QAAQ;wBAAEnC,QAAQ;oBAAU;gBAAE;YACzC;YAEA,MAAMH,eAAegC,IAAI,CAAC,EAAE;YAE5B,IAAI,CAAChC,cAAc;gBACjB8B,OAAOC,IAAI,CAAC;gBACZ,OAAO;oBAAEQ,QAAQ;wBAAE9C,SAAS;oBAAK;gBAAE;YACrC;YAEA,MAAM+C,SAASnD,mBAAmBW;YAElC,IAAI,CAACwC,OAAO/C,OAAO,EAAE;gBACnBqC,OAAOjC,KAAK,CAAC;oBAAEF,QAAQ6C,OAAO7C,MAAM;gBAAC,GAAG,CAAC,UAAU,EAAEK,aAAapC,EAAE,CAAC,kBAAkB,CAAC;gBACxF,MAAMiE,QAAQY,MAAM,CAAC;oBACnB7E,IAAIoC,aAAapC,EAAE;oBACnBsE,YAAY;oBACZxC,MAAM;wBAAE4C,QAAQ;oBAAS;gBAC3B;gBACA,OAAO;oBAAEC,QAAQ;wBAAE9C,SAAS;oBAAM;gBAAE;YACtC;YAEA,MAAMH,YAAYkD,OAAO9C,IAAI;YAC7B,MAAMgD,cAAc3C,yBAClBT,WACAU;YAGF,MAAM,EAAEgC,MAAMW,QAAQ,EAAE,GAAG,MAAMd,QAAQI,IAAI,CAAC;gBAC5CC,YAAY;gBACZC,OAAOhB;gBACPiB,MAAM;gBACNC,OAAOK;YACT;YAEA,IAAIC,SAASpC,MAAM,KAAK,GAAG;gBACzBuB,OAAOC,IAAI,CACT,CAAC,UAAU,EAAEzC,UAAU1B,EAAE,CAAC,WAAW,CAAC,GACpC,CAAC,WAAW,EAAE0B,UAAUb,IAAI,CAACI,cAAc,CAAC,YAAY,EAAES,UAAUb,IAAI,CAACC,aAAa,EAAE;gBAE5F,MAAMmD,QAAQY,MAAM,CAAC;oBACnB7E,IAAI0B,UAAU1B,EAAE;oBAChBsE,YAAY;oBACZxC,MAAM;wBAAE4C,QAAQ;oBAAO;gBACzB;gBACA,OAAO;oBAAEC,QAAQ;wBAAE9C,SAAS;oBAAK;gBAAE;YACrC;YAEA,MAAMmD,QAAQC,GAAG,CACfF,SAASlC,GAAG,CAAC,CAACM,UACZc,QAAQiB,IAAI,CAACC,KAAK,CAAC;oBACjBC,OAAO;wBAAEC,aAAa3D,UAAU1B,EAAE;wBAAEsF,WAAWnC,QAAQnD,EAAE;oBAAC;oBAC1DmF,OAAO;oBACPI,MAAM;gBACR;YAIJ,MAAMtB,QAAQY,MAAM,CAAC;gBACnB7E,IAAI0B,UAAU1B,EAAE;gBAChBsE,YAAY;gBACZxC,MAAM;oBACJjB,MAAM;wBACJE,wBAAwBmC,iBAAiB6B,QAAQ,CAACA,SAASpC,MAAM,GAAG,EAAE;wBACtE1B,gBAAgBS,UAAUb,IAAI,CAACI,cAAc,GAAG8D,SAASpC,MAAM;oBACjE;gBACF;YACF;YAEAuB,OAAOC,IAAI,CACT,CAAC,UAAU,EAAEzC,UAAU1B,EAAE,CAAC,SAAS,EAAE+E,SAASpC,MAAM,CAAC,SAAS,CAAC,GAC7D,CAAC,iBAAiB,EAAEjB,UAAUb,IAAI,CAACI,cAAc,GAAG8D,SAASpC,MAAM,EAAE;YAGzE,OAAO;gBAAEgC,QAAQ;oBAAE9C,SAAS;gBAAK;YAAE;QACrC;QACA2D,cAAc;YACZ;gBACEC,MAAM;gBACNC,MAAM;YACR;SACD;QACDC,SAAS;QACTC,UAAU;YACR;gBACEC,MAAMnC;gBACNyB,OAAOvB;YACT;SACD;IACH;AACF,EAAC"}
|
|
1
|
+
{"version":3,"sources":["../../src/tasks/sendBroadcastsTask.ts"],"sourcesContent":["import type { TaskConfig, Where } from 'payload'\n\nimport z from 'zod'\n\nimport type { MobilizehubPluginConfig } from '../types/index.js'\n\n/**\n * Schema for validating broadcast documents before processing.\n */\nconst BroadcastSchema = z.object({\n id: z.number(),\n content: z.any().refine((val) => val !== undefined && val !== null, {\n message: 'Broadcast content is missing',\n }),\n fromAddress: z.email({ message: 'Invalid from address email format' }),\n fromName: z.string().min(1, { message: 'From name is required' }),\n meta: z.object({\n contactsCount: z.number().min(0),\n lastProcessedContactId: z.number().min(0).default(0),\n processedCount: z.number().min(0),\n }),\n subject: z.string().min(1, { message: 'Subject is required' }),\n tags: z.array(z.any()).optional(),\n to: z.literal('all').or(z.literal('tags')),\n})\n\ntype ParsedBroadcast = z.infer<typeof BroadcastSchema>\n\n/**\n * Validates a broadcast document against the schema.\n * Returns typed data on success, or flattened field errors on failure.\n */\nfunction safeParseBroadcast(broadcast: unknown) {\n const result = BroadcastSchema.safeParse(broadcast)\n\n if (!result.success) {\n return {\n data: null,\n errors: z.flattenError(result.error).fieldErrors,\n success: false as const,\n }\n }\n\n return {\n data: result.data,\n success: true as const,\n }\n}\n\n/**\n * Builds the where clause for fetching the next batch of contacts.\n * Uses cursor-based pagination (id > lastProcessedContactId) for consistent\n * ordering and efficient queries at scale.\n */\nfunction buildContactsWhereClause(\n broadcast: ParsedBroadcast,\n rawBroadcast: Record<string, unknown>,\n): Where {\n const conditions: Where[] = [\n { emailOptIn: { equals: true } },\n { id: { greater_than: broadcast.meta.lastProcessedContactId } },\n ]\n\n // Tags may be populated objects or raw IDs depending on query depth\n if (broadcast.to === 'tags' && Array.isArray(rawBroadcast.tags) && rawBroadcast.tags.length > 0) {\n const tagIds = rawBroadcast.tags.map((t: { id: number | string } | number | string) =>\n typeof t === 'object' ? t.id : t,\n )\n conditions.push({ tags: { in: tagIds } })\n }\n\n return { and: conditions }\n}\n\n/**\n * Extracts a numeric ID from a contact, handling string IDs from some database adapters.\n */\nfunction getLastContactId(contact: { id: number | string }): number {\n return typeof contact.id === 'number' ? contact.id : parseInt(contact.id, 10)\n}\n\n/**\n * Creates the send-broadcasts scheduled task.\n *\n * Processes broadcasts by polling for documents with status 'sending' and\n * queuing batches of send-email jobs. Each invocation processes one broadcast\n * and one batch of contacts, allowing the task to be distributed across\n * multiple schedule intervals.\n */\nexport const createSendBroadcastsTask = (pluginConfig: MobilizehubPluginConfig): TaskConfig => {\n const BATCH_SIZE = pluginConfig.broadcastConfig?.batchSize || 100\n const TASK_SCHEDULE = pluginConfig.broadcastConfig?.taskSchedule || '*/5 * * * *'\n const BROADCAST_QUEUE_NAME = pluginConfig.broadcastConfig?.broadcastQueueName || 'send-broadcasts'\n const EMAIL_QUEUE_NAME = pluginConfig.broadcastConfig?.emailQueueName || 'send-emails'\n\n return {\n slug: 'send-broadcasts',\n handler: async ({ req }) => {\n const { payload } = req\n const logger = payload.logger\n\n logger.info('Send Broadcast task handler called')\n\n const { docs } = await payload.find({\n collection: 'broadcasts',\n limit: 1,\n sort: 'id',\n where: { status: { equals: 'sending' } },\n })\n\n const rawBroadcast = docs[0]\n\n if (!rawBroadcast) {\n logger.info('No broadcasts with status \"sending\" found')\n return { output: { success: true } }\n }\n\n const parsed = safeParseBroadcast(rawBroadcast)\n\n if (!parsed.success) {\n logger.error({ errors: parsed.errors }, `Broadcast ${rawBroadcast.id} validation failed`)\n await payload.update({\n id: rawBroadcast.id,\n collection: 'broadcasts',\n data: { status: 'failed' },\n })\n return { output: { success: false } }\n }\n\n const broadcast = parsed.data\n const whereClause = buildContactsWhereClause(\n broadcast,\n rawBroadcast as Record<string, unknown>,\n )\n\n const { docs: contacts } = await payload.find({\n collection: 'contacts',\n limit: BATCH_SIZE,\n sort: 'id',\n where: whereClause,\n })\n\n if (contacts.length === 0) {\n logger.info(\n `Broadcast ${broadcast.id} complete. ` +\n `Processed: ${broadcast.meta.processedCount}, Expected: ${broadcast.meta.contactsCount}`,\n )\n await payload.update({\n id: broadcast.id,\n collection: 'broadcasts',\n data: { status: 'sent' },\n })\n return { output: { success: true } }\n }\n\n await Promise.all(\n contacts.map((contact) =>\n payload.jobs.queue({\n input: { broadcastId: broadcast.id, contactId: contact.id },\n queue: EMAIL_QUEUE_NAME,\n task: 'send-email',\n }),\n ),\n )\n\n await payload.update({\n id: broadcast.id,\n collection: 'broadcasts',\n data: {\n meta: {\n lastProcessedContactId: getLastContactId(contacts[contacts.length - 1]),\n processedCount: broadcast.meta.processedCount + contacts.length,\n },\n },\n })\n\n logger.info(\n `Broadcast ${broadcast.id}: queued ${contacts.length} emails, ` +\n `total processed: ${broadcast.meta.processedCount + contacts.length}`,\n )\n\n return { output: { success: true } }\n },\n outputSchema: [\n {\n name: 'success',\n type: 'checkbox',\n },\n ],\n retries: 3,\n schedule: [\n {\n cron: TASK_SCHEDULE,\n queue: BROADCAST_QUEUE_NAME,\n },\n ],\n }\n}\n"],"names":["z","BroadcastSchema","object","id","number","content","any","refine","val","undefined","message","fromAddress","email","fromName","string","min","meta","contactsCount","lastProcessedContactId","default","processedCount","subject","tags","array","optional","to","literal","or","safeParseBroadcast","broadcast","result","safeParse","success","data","errors","flattenError","error","fieldErrors","buildContactsWhereClause","rawBroadcast","conditions","emailOptIn","equals","greater_than","Array","isArray","length","tagIds","map","t","push","in","and","getLastContactId","contact","parseInt","createSendBroadcastsTask","pluginConfig","BATCH_SIZE","broadcastConfig","batchSize","TASK_SCHEDULE","taskSchedule","BROADCAST_QUEUE_NAME","broadcastQueueName","EMAIL_QUEUE_NAME","emailQueueName","slug","handler","req","payload","logger","info","docs","find","collection","limit","sort","where","status","output","parsed","update","whereClause","contacts","Promise","all","jobs","queue","input","broadcastId","contactId","task","outputSchema","name","type","retries","schedule","cron"],"mappings":"AAEA,OAAOA,OAAO,MAAK;AAInB;;CAEC,GACD,MAAMC,kBAAkBD,EAAEE,MAAM,CAAC;IAC/BC,IAAIH,EAAEI,MAAM;IACZC,SAASL,EAAEM,GAAG,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC,aAAaD,QAAQ,MAAM;QAClEE,SAAS;IACX;IACAC,aAAaX,EAAEY,KAAK,CAAC;QAAEF,SAAS;IAAoC;IACpEG,UAAUb,EAAEc,MAAM,GAAGC,GAAG,CAAC,GAAG;QAAEL,SAAS;IAAwB;IAC/DM,MAAMhB,EAAEE,MAAM,CAAC;QACbe,eAAejB,EAAEI,MAAM,GAAGW,GAAG,CAAC;QAC9BG,wBAAwBlB,EAAEI,MAAM,GAAGW,GAAG,CAAC,GAAGI,OAAO,CAAC;QAClDC,gBAAgBpB,EAAEI,MAAM,GAAGW,GAAG,CAAC;IACjC;IACAM,SAASrB,EAAEc,MAAM,GAAGC,GAAG,CAAC,GAAG;QAAEL,SAAS;IAAsB;IAC5DY,MAAMtB,EAAEuB,KAAK,CAACvB,EAAEM,GAAG,IAAIkB,QAAQ;IAC/BC,IAAIzB,EAAE0B,OAAO,CAAC,OAAOC,EAAE,CAAC3B,EAAE0B,OAAO,CAAC;AACpC;AAIA;;;CAGC,GACD,SAASE,mBAAmBC,SAAkB;IAC5C,MAAMC,SAAS7B,gBAAgB8B,SAAS,CAACF;IAEzC,IAAI,CAACC,OAAOE,OAAO,EAAE;QACnB,OAAO;YACLC,MAAM;YACNC,QAAQlC,EAAEmC,YAAY,CAACL,OAAOM,KAAK,EAAEC,WAAW;YAChDL,SAAS;QACX;IACF;IAEA,OAAO;QACLC,MAAMH,OAAOG,IAAI;QACjBD,SAAS;IACX;AACF;AAEA;;;;CAIC,GACD,SAASM,yBACPT,SAA0B,EAC1BU,YAAqC;IAErC,MAAMC,aAAsB;QAC1B;YAAEC,YAAY;gBAAEC,QAAQ;YAAK;QAAE;QAC/B;YAAEvC,IAAI;gBAAEwC,cAAcd,UAAUb,IAAI,CAACE,sBAAsB;YAAC;QAAE;KAC/D;IAED,oEAAoE;IACpE,IAAIW,UAAUJ,EAAE,KAAK,UAAUmB,MAAMC,OAAO,CAACN,aAAajB,IAAI,KAAKiB,aAAajB,IAAI,CAACwB,MAAM,GAAG,GAAG;QAC/F,MAAMC,SAASR,aAAajB,IAAI,CAAC0B,GAAG,CAAC,CAACC,IACpC,OAAOA,MAAM,WAAWA,EAAE9C,EAAE,GAAG8C;QAEjCT,WAAWU,IAAI,CAAC;YAAE5B,MAAM;gBAAE6B,IAAIJ;YAAO;QAAE;IACzC;IAEA,OAAO;QAAEK,KAAKZ;IAAW;AAC3B;AAEA;;CAEC,GACD,SAASa,iBAAiBC,OAAgC;IACxD,OAAO,OAAOA,QAAQnD,EAAE,KAAK,WAAWmD,QAAQnD,EAAE,GAAGoD,SAASD,QAAQnD,EAAE,EAAE;AAC5E;AAEA;;;;;;;CAOC,GACD,OAAO,MAAMqD,2BAA2B,CAACC;IACvC,MAAMC,aAAaD,aAAaE,eAAe,EAAEC,aAAa;IAC9D,MAAMC,gBAAgBJ,aAAaE,eAAe,EAAEG,gBAAgB;IACpE,MAAMC,uBAAuBN,aAAaE,eAAe,EAAEK,sBAAsB;IACjF,MAAMC,mBAAmBR,aAAaE,eAAe,EAAEO,kBAAkB;IAEzE,OAAO;QACLC,MAAM;QACNC,SAAS,OAAO,EAAEC,GAAG,EAAE;YACrB,MAAM,EAAEC,OAAO,EAAE,GAAGD;YACpB,MAAME,SAASD,QAAQC,MAAM;YAE7BA,OAAOC,IAAI,CAAC;YAEZ,MAAM,EAAEC,IAAI,EAAE,GAAG,MAAMH,QAAQI,IAAI,CAAC;gBAClCC,YAAY;gBACZC,OAAO;gBACPC,MAAM;gBACNC,OAAO;oBAAEC,QAAQ;wBAAErC,QAAQ;oBAAU;gBAAE;YACzC;YAEA,MAAMH,eAAekC,IAAI,CAAC,EAAE;YAE5B,IAAI,CAAClC,cAAc;gBACjBgC,OAAOC,IAAI,CAAC;gBACZ,OAAO;oBAAEQ,QAAQ;wBAAEhD,SAAS;oBAAK;gBAAE;YACrC;YAEA,MAAMiD,SAASrD,mBAAmBW;YAElC,IAAI,CAAC0C,OAAOjD,OAAO,EAAE;gBACnBuC,OAAOnC,KAAK,CAAC;oBAAEF,QAAQ+C,OAAO/C,MAAM;gBAAC,GAAG,CAAC,UAAU,EAAEK,aAAapC,EAAE,CAAC,kBAAkB,CAAC;gBACxF,MAAMmE,QAAQY,MAAM,CAAC;oBACnB/E,IAAIoC,aAAapC,EAAE;oBACnBwE,YAAY;oBACZ1C,MAAM;wBAAE8C,QAAQ;oBAAS;gBAC3B;gBACA,OAAO;oBAAEC,QAAQ;wBAAEhD,SAAS;oBAAM;gBAAE;YACtC;YAEA,MAAMH,YAAYoD,OAAOhD,IAAI;YAC7B,MAAMkD,cAAc7C,yBAClBT,WACAU;YAGF,MAAM,EAAEkC,MAAMW,QAAQ,EAAE,GAAG,MAAMd,QAAQI,IAAI,CAAC;gBAC5CC,YAAY;gBACZC,OAAOlB;gBACPmB,MAAM;gBACNC,OAAOK;YACT;YAEA,IAAIC,SAAStC,MAAM,KAAK,GAAG;gBACzByB,OAAOC,IAAI,CACT,CAAC,UAAU,EAAE3C,UAAU1B,EAAE,CAAC,WAAW,CAAC,GACpC,CAAC,WAAW,EAAE0B,UAAUb,IAAI,CAACI,cAAc,CAAC,YAAY,EAAES,UAAUb,IAAI,CAACC,aAAa,EAAE;gBAE5F,MAAMqD,QAAQY,MAAM,CAAC;oBACnB/E,IAAI0B,UAAU1B,EAAE;oBAChBwE,YAAY;oBACZ1C,MAAM;wBAAE8C,QAAQ;oBAAO;gBACzB;gBACA,OAAO;oBAAEC,QAAQ;wBAAEhD,SAAS;oBAAK;gBAAE;YACrC;YAEA,MAAMqD,QAAQC,GAAG,CACfF,SAASpC,GAAG,CAAC,CAACM,UACZgB,QAAQiB,IAAI,CAACC,KAAK,CAAC;oBACjBC,OAAO;wBAAEC,aAAa7D,UAAU1B,EAAE;wBAAEwF,WAAWrC,QAAQnD,EAAE;oBAAC;oBAC1DqF,OAAOvB;oBACP2B,MAAM;gBACR;YAIJ,MAAMtB,QAAQY,MAAM,CAAC;gBACnB/E,IAAI0B,UAAU1B,EAAE;gBAChBwE,YAAY;gBACZ1C,MAAM;oBACJjB,MAAM;wBACJE,wBAAwBmC,iBAAiB+B,QAAQ,CAACA,SAAStC,MAAM,GAAG,EAAE;wBACtE1B,gBAAgBS,UAAUb,IAAI,CAACI,cAAc,GAAGgE,SAAStC,MAAM;oBACjE;gBACF;YACF;YAEAyB,OAAOC,IAAI,CACT,CAAC,UAAU,EAAE3C,UAAU1B,EAAE,CAAC,SAAS,EAAEiF,SAAStC,MAAM,CAAC,SAAS,CAAC,GAC7D,CAAC,iBAAiB,EAAEjB,UAAUb,IAAI,CAACI,cAAc,GAAGgE,SAAStC,MAAM,EAAE;YAGzE,OAAO;gBAAEkC,QAAQ;oBAAEhD,SAAS;gBAAK;YAAE;QACrC;QACA6D,cAAc;YACZ;gBACEC,MAAM;gBACNC,MAAM;YACR;SACD;QACDC,SAAS;QACTC,UAAU;YACR;gBACEC,MAAMrC;gBACN2B,OAAOzB;YACT;SACD;IACH;AACF,EAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mobilizehub/payload-plugin",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "Edvocacy plugin for Payload",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"private": false,
|
|
@@ -40,12 +40,12 @@
|
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@changesets/cli": "^2.29.8",
|
|
42
42
|
"@eslint/eslintrc": "^3.2.0",
|
|
43
|
-
"@payloadcms/db-postgres": "3.
|
|
44
|
-
"@payloadcms/db-sqlite": "3.
|
|
43
|
+
"@payloadcms/db-postgres": "3.70.0",
|
|
44
|
+
"@payloadcms/db-sqlite": "3.70.0",
|
|
45
45
|
"@payloadcms/eslint-config": "3.9.0",
|
|
46
|
-
"@payloadcms/next": "3.
|
|
47
|
-
"@payloadcms/richtext-lexical": "3.
|
|
48
|
-
"@payloadcms/ui": "3.
|
|
46
|
+
"@payloadcms/next": "3.70.0",
|
|
47
|
+
"@payloadcms/richtext-lexical": "3.70.0",
|
|
48
|
+
"@payloadcms/ui": "3.70.0",
|
|
49
49
|
"@playwright/test": "1.56.1",
|
|
50
50
|
"@swc-node/register": "1.10.9",
|
|
51
51
|
"@swc/cli": "0.6.0",
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"husky": "^9.1.7",
|
|
61
61
|
"next": "15.4.10",
|
|
62
62
|
"open": "^10.1.0",
|
|
63
|
-
"payload": "3.
|
|
63
|
+
"payload": "3.70.0",
|
|
64
64
|
"prettier": "^3.4.2",
|
|
65
65
|
"qs-esm": "7.0.2",
|
|
66
66
|
"react": "19.2.1",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"vitest": "^3.1.2"
|
|
74
74
|
},
|
|
75
75
|
"peerDependencies": {
|
|
76
|
-
"payload": "^3.
|
|
76
|
+
"payload": "^3.70.0"
|
|
77
77
|
},
|
|
78
78
|
"engines": {
|
|
79
79
|
"node": "^18.20.2 || >=20.9.0",
|