@vicacha-devs/strapi-plugin-broadcasts 0.0.0-stage → 0.1.0

package/dist/server/src/services/campaignService.d.ts

@@ -0,0 +1,54 @@
+import { Core } from '@strapi/strapi';
+import { BroadcastSettings, CampaignRecord, CampaignStats, ChannelDispatchResult, SubscriberRecipient } from '../../../shared';
+import { TransportServiceContract } from './campaignChannelDispatch';
+import { RawDispatchOptions } from './campaignLifecycle';
+declare const createCampaignService: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    getSettingsService(): {
+        getSettings(): Promise<BroadcastSettings>;
+    };
+    getTransportService(): TransportServiceContract;
+    listCampaigns(params?: {
+        status?: string;
+        topic?: string;
+    }): Promise<CampaignRecord[]>;
+    listPublicArchive(params?: {
+        topic?: string;
+        limit?: number;
+    }): Promise<{
+        slug: string;
+        title: string;
+        topic: string;
+        subject: string;
+        bodyText: string;
+        ctaLabel: string | undefined;
+        ctaUrl: string | undefined;
+        sentAt: string | undefined;
+        secondaryDateLabel: string | undefined;
+        translations: Record<string, import('../../../shared').CampaignTranslation> | undefined;
+    }[]>;
+    getCampaignBySlug(slug: string): Promise<CampaignRecord | null>;
+    findCampaignByDocIdOrSlug(documentIdOrSlug: string): Promise<CampaignRecord | null>;
+    createCampaign(input: Partial<CampaignRecord>): Promise<CampaignRecord>;
+    updateCampaign(documentIdOrSlug: string, input: Partial<CampaignRecord>): Promise<CampaignRecord>;
+    createFromStarterTemplate(templateId: string): Promise<CampaignRecord>;
+    seedStarterCampaigns(): Promise<number>;
+    resolveRecipientsForTopic(topic: string): Promise<SubscriberRecipient[]>;
+    selectCampaignRecipients(campaign: CampaignRecord, settings: BroadcastSettings, options: RawDispatchOptions): Promise<{
+        isTestDispatch: boolean;
+        testTelegramChatId?: string;
+        recipients: SubscriberRecipient[];
+    }>;
+    finalizeDispatchedCampaign(campaign: CampaignRecord, secondaryDate: CampaignRecord["secondaryDate"], secondaryDateLabel: string, stats: CampaignStats): Promise<CampaignRecord>;
+    dispatchCampaign(documentIdOrSlug: string, options?: {
+        customRecipients?: SubscriberRecipient[];
+        testRecipientEmail?: string;
+        testRecipientPhone?: string;
+        testTelegramChatId?: string;
+    }): Promise<{
+        campaign: CampaignRecord;
+        results: ChannelDispatchResult[];
+    }>;
+};
+export default createCampaignService;

package/dist/server/src/services/deliveryLedger.d.ts

@@ -0,0 +1,18 @@
+import { Core } from '@strapi/strapi';
+import { BroadcastChannel, BroadcastSettings, ChannelDispatchResult, DeliveryLogRecord } from '../../../shared';
+import { EmailSendPayload } from './transportService';
+export declare function buildSafeListUnsubscribeHeader(rawUnsubscribeUrl?: string): Record<string, string>;
+export declare function hasAlreadyDeliveredInDb(strapi: Core.Strapi, idempotencyKey: string): Promise<boolean>;
+export declare function upsertDeliveryLogInDb(strapi: Core.Strapi, entry: Omit<DeliveryLogRecord, "documentId" | "sentAt">, secrets?: Array<string | undefined>): Promise<DeliveryLogRecord>;
+export declare function listDeliveryLogsFromDb(strapi: Core.Strapi, params?: {
+    campaignSlug?: string;
+    channel?: BroadcastChannel;
+    limit?: number;
+}): Promise<DeliveryLogRecord[]>;
+export declare function extractSecretList(settings?: BroadcastSettings): Array<string | undefined>;
+export declare function sanitizeDispatchResult(result: ChannelDispatchResult, secrets: Array<string | undefined>): ChannelDispatchResult;
+export declare function sendLiveEmailViaProviders(strapi: Core.Strapi, payload: EmailSendPayload, settings: BroadcastSettings, effectiveTemplateRef: string): Promise<{
+    driver: string;
+    status: "sent" | "simulated";
+    externalMessageId: string;
+}>;

package/dist/server/src/services/emailDesignerBridge.d.ts

@@ -0,0 +1,30 @@
+import { Core } from '@strapi/strapi';
+import { EmailDesignerTemplateSummary } from '../../../shared';
+export declare const EMAIL_DESIGNER_TEMPLATE_UID = "plugin::email-designer-5.email-designer-template";
+export interface EmailDesignerTemplateRow {
+    id?: number;
+    documentId?: string;
+    templateReferenceId?: number;
+    name?: string;
+    subject?: string;
+    bodyHtml?: string;
+    bodyText?: string;
+    tags?: string[];
+    updatedAt?: string;
+}
+export declare function fetchRawEmailDesignerTemplates(strapi: Core.Strapi): Promise<EmailDesignerTemplateRow[]>;
+export declare function listEmailDesignerTemplatesFromDb(strapi: Core.Strapi): Promise<EmailDesignerTemplateSummary[]>;
+export declare function resolveEmailDesignerTemplateFromDb(strapi: Core.Strapi, templateRef: string, locale?: string): Promise<EmailDesignerTemplateRow | null>;
+export declare function trySendEmailViaDesigner5(params: {
+    strapi: Core.Strapi;
+    effectiveTemplateRef: string;
+    locale: string;
+    recipientEmail: string;
+    fromAddress: string;
+    replyToAddress: string;
+    subject: string;
+    text: string;
+    headers: Record<string, string>;
+    templateVars: Record<string, string | number | undefined>;
+    interpolate: (tpl: string, vars: Record<string, string | number | undefined>) => string;
+}): Promise<string | null>;

package/dist/server/src/services/idempotency.d.ts

@@ -0,0 +1,5 @@
+export declare function computeIdempotencyKey(campaignSlug: string, channel: string, recipient: string, options?: {
+    isTest?: boolean;
+}): string;
+export declare function generateUniqueSlugSuffix(): string;
+export declare function redactSecretsFromMessage(rawMessage: string, secrets?: Array<string | undefined>): string;

package/dist/server/src/services/index.d.ts

@@ -0,0 +1,119 @@
+declare const _default: {
+    settings: ({ strapi }: {
+        strapi: import("@strapi/strapi").Core.Strapi;
+    }) => {
+        getPluginStore(): import("@strapi/strapi").Core.PluginStore;
+        getConfigDefaults(): import('../../../shared').BroadcastSettings;
+        getSettings(): Promise<import('../../../shared').BroadcastSettings>;
+        getPublicSafeSettings(): Promise<import('../../../shared').BroadcastSettings>;
+        updateSettings(rawPartial: Partial<import('../../../shared').BroadcastSettings>): Promise<import('../../../shared').BroadcastSettings>;
+    };
+    transportService: ({ strapi }: {
+        strapi: import("@strapi/strapi").Core.Strapi;
+    }) => {
+        getSettingsService(): {
+            getSettings(): Promise<import('../../../shared').BroadcastSettings>;
+        };
+        fetchRawEmailDesignerTemplates(): Promise<import('./emailDesignerBridge').EmailDesignerTemplateRow[]>;
+        listEmailDesignerTemplates(): Promise<import('../../../shared').EmailDesignerTemplateSummary[]>;
+        resolveEmailDesignerTemplate(templateRef: string, locale?: string): Promise<import('./emailDesignerBridge').EmailDesignerTemplateRow | null>;
+        hasAlreadyDelivered(idempotencyKey: string): Promise<boolean>;
+        recordDeliveryLog(entry: Omit<import('../../../shared').DeliveryLogRecord, "documentId" | "sentAt">, secrets?: Array<string | undefined>): Promise<import('../../../shared').DeliveryLogRecord>;
+        listDeliveryLogs(params?: {
+            campaignSlug?: string;
+            channel?: import('../../../shared').BroadcastChannel;
+            limit?: number;
+        }): Promise<import('../../../shared').DeliveryLogRecord[]>;
+        persistResult(campaignSlug: string, secondaryDateLabel: string | undefined, result: import('../../../shared').ChannelDispatchResult, settings?: import('../../../shared').BroadcastSettings): Promise<import('../../../shared').ChannelDispatchResult>;
+        logOutcome(p: {
+            campaignSlug: string;
+            locale: string;
+            secondaryDateLabel?: string;
+        }, channel: import('../../../shared').BroadcastChannel, driver: string, recipientMasked: string, status: import('../../../shared').ChannelDispatchResult["status"], idempotencyKey: string, extra?: Partial<import('../../../shared').ChannelDispatchResult>, settings?: import('../../../shared').BroadcastSettings): Promise<import('../../../shared').ChannelDispatchResult>;
+        simulateDryRunEmail(payload: import('./transportService').EmailSendPayload, effectiveTemplateRef: string, recipientMasked: string, idempotencyKey: string, settings: import('../../../shared').BroadcastSettings): Promise<import('../../../shared').ChannelDispatchResult>;
+        executeLiveEmailSend(payload: import('./transportService').EmailSendPayload, settings: import('../../../shared').BroadcastSettings, effectiveTemplateRef: string, recipientMasked: string, idempotencyKey: string): Promise<import('../../../shared').ChannelDispatchResult>;
+        sendEmailBroadcast(payload: import('./transportService').EmailSendPayload): Promise<import('../../../shared').ChannelDispatchResult>;
+        sendTelegramBroadcast(payload: import('./transportService').TelegramSendPayload): Promise<import('../../../shared').ChannelDispatchResult>;
+        sendWhatsAppBroadcast(payload: import('./transportService').WhatsAppSendPayload): Promise<import('../../../shared').ChannelDispatchResult>;
+    };
+    campaignService: ({ strapi }: {
+        strapi: import("@strapi/strapi").Core.Strapi;
+    }) => {
+        getSettingsService(): {
+            getSettings(): Promise<import('../../../shared').BroadcastSettings>;
+        };
+        getTransportService(): import('./campaignChannelDispatch').TransportServiceContract;
+        listCampaigns(params?: {
+            status?: string;
+            topic?: string;
+        }): Promise<import('../../../shared').CampaignRecord[]>;
+        listPublicArchive(params?: {
+            topic?: string;
+            limit?: number;
+        }): Promise<{
+            slug: string;
+            title: string;
+            topic: string;
+            subject: string;
+            bodyText: string;
+            ctaLabel: string | undefined;
+            ctaUrl: string | undefined;
+            sentAt: string | undefined;
+            secondaryDateLabel: string | undefined;
+            translations: Record<string, import('../../../shared').CampaignTranslation> | undefined;
+        }[]>;
+        getCampaignBySlug(slug: string): Promise<import('../../../shared').CampaignRecord | null>;
+        findCampaignByDocIdOrSlug(documentIdOrSlug: string): Promise<import('../../../shared').CampaignRecord | null>;
+        createCampaign(input: Partial<import('../../../shared').CampaignRecord>): Promise<import('../../../shared').CampaignRecord>;
+        updateCampaign(documentIdOrSlug: string, input: Partial<import('../../../shared').CampaignRecord>): Promise<import('../../../shared').CampaignRecord>;
+        createFromStarterTemplate(templateId: string): Promise<import('../../../shared').CampaignRecord>;
+        seedStarterCampaigns(): Promise<number>;
+        resolveRecipientsForTopic(topic: string): Promise<import('../../../shared').SubscriberRecipient[]>;
+        selectCampaignRecipients(campaign: import('../../../shared').CampaignRecord, settings: import('../../../shared').BroadcastSettings, options: import('./campaignLifecycle').RawDispatchOptions): Promise<{
+            isTestDispatch: boolean;
+            testTelegramChatId?: string;
+            recipients: import('../../../shared').SubscriberRecipient[];
+        }>;
+        finalizeDispatchedCampaign(campaign: import('../../../shared').CampaignRecord, secondaryDate: import('../../../shared').CampaignRecord["secondaryDate"], secondaryDateLabel: string, stats: import('../../../shared').CampaignStats): Promise<import('../../../shared').CampaignRecord>;
+        dispatchCampaign(documentIdOrSlug: string, options?: {
+            customRecipients?: import('../../../shared').SubscriberRecipient[];
+            testRecipientEmail?: string;
+            testRecipientPhone?: string;
+            testTelegramChatId?: string;
+        }): Promise<{
+            campaign: import('../../../shared').CampaignRecord;
+            results: import('../../../shared').ChannelDispatchResult[];
+        }>;
+    };
+    automationService: ({ strapi }: {
+        strapi: import("@strapi/strapi").Core.Strapi;
+    }) => {
+        getSettingsService(): {
+            getSettings(): Promise<import('../../../shared').BroadcastSettings>;
+        };
+        getCampaignService(): {
+            createCampaign(input: Partial<import('../../../shared').CampaignRecord>): Promise<import('../../../shared').CampaignRecord>;
+            dispatchCampaign(documentIdOrSlug: string): Promise<{
+                campaign: import('../../../shared').CampaignRecord;
+                results: import('../../../shared').ChannelDispatchResult[];
+            }>;
+        };
+        listRules(): Promise<import('../../../shared').AutomationRuleRecord[]>;
+        getRuleBySlug(slug: string): Promise<import('../../../shared').AutomationRuleRecord | null>;
+        findRuleByDocIdOrSlug(documentIdOrSlug: string): Promise<import('../../../shared').AutomationRuleRecord | null>;
+        createRule(input: Partial<import('../../../shared').AutomationRuleRecord>): Promise<import('../../../shared').AutomationRuleRecord>;
+        updateRule(documentIdOrSlug: string, input: Partial<import('../../../shared').AutomationRuleRecord>): Promise<import('../../../shared').AutomationRuleRecord>;
+        seedStarterRules(): Promise<number>;
+        executeSingleTriggerRule(rule: import('../../../shared').AutomationRuleRecord, vars: Record<string, string | number | undefined>): Promise<{
+            ruleSlug: string;
+            campaignSlug: string;
+            results: import('../../../shared').ChannelDispatchResult[];
+        }>;
+        handleEventTrigger(eventName: string, payload?: Record<string, unknown>): Promise<Array<{
+            ruleSlug: string;
+            campaignSlug: string;
+            results: import('../../../shared').ChannelDispatchResult[];
+        }>>;
+    };
+};
+export default _default;

package/dist/server/src/services/settings.d.ts

@@ -0,0 +1,12 @@
+import { Core } from '@strapi/strapi';
+import { BroadcastSettings } from '../../../shared';
+declare const createSettingsService: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    getPluginStore(): Core.PluginStore;
+    getConfigDefaults(): BroadcastSettings;
+    getSettings(): Promise<BroadcastSettings>;
+    getPublicSafeSettings(): Promise<BroadcastSettings>;
+    updateSettings(rawPartial: Partial<BroadcastSettings>): Promise<BroadcastSettings>;
+};
+export default createSettingsService;

package/dist/server/src/services/transportService.d.ts

@@ -0,0 +1,70 @@
+import { Core } from '@strapi/strapi';
+import { BroadcastChannel, BroadcastSettings, ChannelDispatchResult, DeliveryLogRecord, EmailDesignerTemplateSummary } from '../../../shared';
+import { EMAIL_DESIGNER_TEMPLATE_UID, EmailDesignerTemplateRow } from './emailDesignerBridge';
+export { EMAIL_DESIGNER_TEMPLATE_UID, type EmailDesignerTemplateRow };
+export interface EmailSendPayload {
+    campaignSlug: string;
+    recipientEmail: string;
+    locale: string;
+    subject: string;
+    text: string;
+    html?: string;
+    ctaLabel?: string;
+    ctaUrl?: string;
+    unsubscribeUrl?: string;
+    emailTemplateRef?: string;
+    secondaryDateLabel?: string;
+    templateData?: Record<string, string | number | undefined>;
+    isTestDispatch?: boolean;
+}
+export interface TelegramSendPayload {
+    campaignSlug: string;
+    chatId: string;
+    threadId?: number;
+    locale: string;
+    subject: string;
+    htmlBody: string;
+    ctaLabel?: string;
+    ctaUrl?: string;
+    secondaryDateLabel?: string;
+    isTestDispatch?: boolean;
+}
+export interface WhatsAppSendPayload {
+    campaignSlug: string;
+    recipientPhone: string;
+    locale: string;
+    textBody: string;
+    templateName?: string;
+    ctaUrl?: string;
+    secondaryDateLabel?: string;
+    isTestDispatch?: boolean;
+}
+declare const createTransportService: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    getSettingsService(): {
+        getSettings(): Promise<BroadcastSettings>;
+    };
+    fetchRawEmailDesignerTemplates(): Promise<EmailDesignerTemplateRow[]>;
+    listEmailDesignerTemplates(): Promise<EmailDesignerTemplateSummary[]>;
+    resolveEmailDesignerTemplate(templateRef: string, locale?: string): Promise<EmailDesignerTemplateRow | null>;
+    hasAlreadyDelivered(idempotencyKey: string): Promise<boolean>;
+    recordDeliveryLog(entry: Omit<DeliveryLogRecord, "documentId" | "sentAt">, secrets?: Array<string | undefined>): Promise<DeliveryLogRecord>;
+    listDeliveryLogs(params?: {
+        campaignSlug?: string;
+        channel?: BroadcastChannel;
+        limit?: number;
+    }): Promise<DeliveryLogRecord[]>;
+    persistResult(campaignSlug: string, secondaryDateLabel: string | undefined, result: ChannelDispatchResult, settings?: BroadcastSettings): Promise<ChannelDispatchResult>;
+    logOutcome(p: {
+        campaignSlug: string;
+        locale: string;
+        secondaryDateLabel?: string;
+    }, channel: BroadcastChannel, driver: string, recipientMasked: string, status: ChannelDispatchResult["status"], idempotencyKey: string, extra?: Partial<ChannelDispatchResult>, settings?: BroadcastSettings): Promise<ChannelDispatchResult>;
+    simulateDryRunEmail(payload: EmailSendPayload, effectiveTemplateRef: string, recipientMasked: string, idempotencyKey: string, settings: BroadcastSettings): Promise<ChannelDispatchResult>;
+    executeLiveEmailSend(payload: EmailSendPayload, settings: BroadcastSettings, effectiveTemplateRef: string, recipientMasked: string, idempotencyKey: string): Promise<ChannelDispatchResult>;
+    sendEmailBroadcast(payload: EmailSendPayload): Promise<ChannelDispatchResult>;
+    sendTelegramBroadcast(payload: TelegramSendPayload): Promise<ChannelDispatchResult>;
+    sendWhatsAppBroadcast(payload: WhatsAppSendPayload): Promise<ChannelDispatchResult>;
+};
+export default createTransportService;

package/dist/shared/index.d.ts

@@ -0,0 +1 @@
+export * from '../../shared/index.js';