tango-app-api-payment-subscription 3.5.7 → 3.5.8

package/src/controllers/paymentReminderTrigger.controller.js

@@ -0,0 +1,194 @@
+import * as paymentReminderService from '../services/paymentReminder.service.js';
+import * as invoiceService from '../services/invoice.service.js';
+import * as clientService from '../services/clientPayment.services.js';
+import dayjs from 'dayjs';
+import fs from 'fs';
+import path from 'path';
+import Handlebars from '../utils/validations/helper/handlebar.helper.js';
+import { logger, sendEmailWithSES } from 'tango-app-api-middleware';
+import { symbolFor } from '../utils/currency.js';
+
+// ---------------------------------------------------------------------------
+// Payment reminder sender. Triggered by a cron job (POST /…/trigger). For each
+// brand that has a reminder config, it finds the unpaid invoices and decides
+// which single reminder stage applies based on the OLDEST unpaid invoice's
+// days-past-due, then emails the enabled template to the configured recipients.
+//
+//   Stage          When                              Template
+//   beforeDue      due in N days (config daysBefore) reminderBeforeDue
+//   onDue          due today                         reminderOnDue
+//   onHold         1..29 days overdue                reminderOnHold
+//   suspend        30..59 days overdue               reminderSuspended
+//   deactivated    60+ days overdue                  reminderDeactivated
+//
+// One email per brand per run (the most severe applicable stage), listing all
+// that brand's unpaid invoices. Disabled stages are skipped.
+// ---------------------------------------------------------------------------
+
+const HBS_DIR = path.resolve( path.dirname( '' ) ) + '/src/hbs';
+let partialsRegistered = false;
+function ensurePartials() {
+  if ( partialsRegistered ) {
+    return;
+  }
+  const partial = fs.readFileSync( `${HBS_DIR}/partials/invoiceSummaryTable.hbs`, 'utf8' );
+  Handlebars.registerPartial( 'invoiceSummaryTable', partial );
+  partialsRegistered = true;
+}
+
+const TEMPLATE_FILE = {
+  beforeDue: 'reminderBeforeDue.hbs',
+  onDue: 'reminderOnDue.hbs',
+  onHold: 'reminderOnHold.hbs',
+  suspend: 'reminderSuspended.hbs',
+  deactivated: 'reminderDeactivated.hbs',
+};
+const SUBJECT = {
+  beforeDue: ( v ) => `Payment reminder — due on ${v.dueDate}`,
+  onDue: ( v ) => `Payment due today — ${v.totalDue} outstanding`,
+  onHold: () => 'Action needed: payment overdue — your account is on hold',
+  suspend: () => 'Important: account suspended — payment 30+ days overdue',
+  deactivated: () => 'Final notice: account deactivated — payment 60+ days overdue',
+};
+
+const templateCache = {};
+function renderTemplate( stage, data ) {
+  ensurePartials();
+  if ( !templateCache[stage] ) {
+    const html = fs.readFileSync( `${HBS_DIR}/${TEMPLATE_FILE[stage]}`, 'utf8' );
+    templateCache[stage] = Handlebars.compile( html );
+  }
+  return templateCache[stage]( data );
+}
+
+// Resolve the single applicable stage from days-past-due (negative = not yet
+// due) of the OLDEST unpaid invoice, honoring which stages are enabled.
+function resolveStage( daysPastDue, templates ) {
+  const t = templates || {};
+  if ( daysPastDue >= 60 ) {
+    return t.deactivated?.enabled ? 'deactivated' : null;
+  }
+  if ( daysPastDue >= 30 ) {
+    return t.suspend?.enabled ? 'suspend' : null;
+  }
+  if ( daysPastDue >= 1 ) {
+    return t.onHold?.enabled ? 'onHold' : null;
+  }
+  if ( daysPastDue === 0 ) {
+    return t.onDue?.enabled ? 'onDue' : null;
+  }
+  // Not yet due — only fire the pre-due heads-up on exactly the configured
+  // lead day (e.g. 3 days before), so the cron doesn't email every day.
+  const lead = Number( t.preDue?.daysBefore ) || 3;
+  if ( t.preDue?.enabled && daysPastDue === -lead ) {
+    return 'beforeDue';
+  }
+  return null;
+}
+
+export async function triggerPaymentReminders( req, res ) {
+  try {
+    const today = dayjs().startOf( 'day' );
+    // Optional dry-run: ?dryRun=true renders + reports but sends nothing.
+    const dryRun = String( req.query?.dryRun || req.body?.dryRun || '' ) === 'true';
+    const SES = JSON.parse( process.env.SES );
+    const fromEmail = SES.accountsEmail || SES.adminEmail;
+    const logo = `${JSON.parse( process.env.URL ).apiDomain}/logo.png`;
+
+    const configs = await paymentReminderService.find( {} );
+    const summary = { brandsProcessed: 0, emailsSent: 0, skipped: 0, byStage: {}, errors: [] };
+
+    for ( const cfg of configs ) {
+      summary.brandsProcessed++;
+      const clientId = cfg.clientId;
+      const recipients = ( cfg.reminderEmails || [] ).filter( Boolean );
+      if ( !clientId || !recipients.length ) {
+        summary.skipped++;
+        continue;
+      }
+
+      // Unpaid invoices for this brand (unpaid OR partial — anything with a
+      // remaining balance). Newest data only; paid invoices excluded.
+      const invoices = await invoiceService.find(
+          { clientId, paymentStatus: { $ne: 'paid' } },
+          { invoice: 1, billingDate: 1, dueDate: 1, amount: 1, totalAmount: 1, paidAmount: 1, currency: 1, companyName: 1 },
+      );
+      if ( !invoices.length ) {
+        summary.skipped++;
+        continue;
+      }
+
+      // Oldest due date drives the stage.
+      let oldestDue = null;
+      for ( const inv of invoices ) {
+        if ( !inv.dueDate ) {
+          continue;
+        }
+        const d = dayjs( inv.dueDate ).startOf( 'day' );
+        if ( !oldestDue || d.isBefore( oldestDue ) ) {
+          oldestDue = d;
+        }
+      }
+      if ( !oldestDue ) {
+        summary.skipped++;
+        continue;
+      }
+      const daysPastDue = today.diff( oldestDue, 'day' );
+      const stage = resolveStage( daysPastDue, cfg.templates );
+      if ( !stage ) {
+        summary.skipped++;
+        continue;
+      }
+
+      // Build the invoice rows + total (convert nothing — show each invoice in
+      // its own currency symbol; total assumes a single currency per brand).
+      let total = 0;
+      let currency = 'inr';
+      const rows = invoices.map( ( inv ) => {
+        const sym = symbolFor( inv.currency );
+        currency = inv.currency || currency;
+        const remaining = Math.max( 0, ( Number( inv.totalAmount ) || Number( inv.amount ) || 0 ) - ( Number( inv.paidAmount ) || 0 ) );
+        total += remaining;
+        return {
+          invoiceNumber: inv.invoice,
+          invoiceDate: inv.billingDate ? dayjs( inv.billingDate ).format( 'DD MMM YYYY' ) : '',
+          dueDate: inv.dueDate ? dayjs( inv.dueDate ).format( 'DD MMM YYYY' ) : '',
+          amountDue: `${sym} ${remaining.toLocaleString( 'en-IN', { minimumFractionDigits: 2, maximumFractionDigits: 2 } )}`,
+        };
+      } );
+      const totalDue = `${symbolFor( currency )} ${total.toLocaleString( 'en-IN', { minimumFractionDigits: 2, maximumFractionDigits: 2 } )}`;
+
+      const client = await clientService.findOne( { clientId }, { clientName: 1 } );
+      const data = {
+        clientName: client?.clientName || invoices[0]?.companyName || 'Customer',
+        companyName: 'Team Tango',
+        dueDate: oldestDue.format( 'DD MMM YYYY' ),
+        totalDue,
+        invoices: rows,
+        logo,
+      };
+
+      const html = renderTemplate( stage, data );
+      const subject = SUBJECT[stage]( data );
+
+      summary.byStage[stage] = ( summary.byStage[stage] || 0 ) + 1;
+      if ( dryRun ) {
+        continue;
+      }
+      try {
+        await sendEmailWithSES( recipients, subject, html, '', fromEmail );
+        console.log( '🚀 ~ triggerPaymentReminders ~ recipients:', recipients );
+        summary.emailsSent++;
+      } catch ( sendErr ) {
+        logger.error( { error: sendErr, function: 'triggerPaymentReminders.send', clientId } );
+        summary.errors.push( { clientId, error: String( sendErr?.message || sendErr ) } );
+      }
+    }
+
+    logger.info?.( { function: 'triggerPaymentReminders', dryRun, summary } );
+    return res.sendSuccess( summary );
+  } catch ( error ) {
+    logger.error( { error: error, function: 'triggerPaymentReminders' } );
+    return res.sendError( error, 500 );
+  }
+}