@parsrun/payments 0.1.0

package/dist/dunning/index.d.ts

@@ -0,0 +1,310 @@
+import { L as DunningContext, X as DunningLogger, Q as DunningNotification, S as NotificationResult } from '../schema-C5Zcju_j.js';
+export { ah as DrizzleDb, z as DrizzleDunningStorage, a0 as DrizzleDunningStorageConfig, F as DunningAction, U as DunningEvent, V as DunningEventHandler, ad as DunningEventRow, T as DunningEventType, D as DunningManager, W as DunningManagerConfig, b as DunningScheduler, Z as DunningSchedulerConfig, H as DunningSequence, h as DunningSequenceBuilder, a1 as DunningSequenceRow, J as DunningState, a7 as DunningStateRow, I as DunningStatus, G as DunningStep, g as DunningStepBuilder, a3 as DunningStepRow, Y as DunningStorage, _ as ErrorCodeMapping, K as ExecutedStep, a9 as ExecutedStepRow, M as MemoryDunningStorage, ae as NewDunningEvent, a2 as NewDunningSequence, a8 as NewDunningState, a4 as NewDunningStep, aa as NewExecutedStep, a6 as NewPaymentFailure, ag as NewRetryStrategy, ac as NewScheduledStep, N as NotificationChannel, E as PaymentFailure, C as PaymentFailureCategory, a5 as PaymentFailureRow, p as PaymentRetrier, $ as PaymentRetrierConfig, P as PaymentRetryCalculator, O as RetryResult, R as RetryStrategy, af as RetryStrategyRow, ab as ScheduledStepRow, k as aggressiveSequence, x as allErrorCodeMappings, a as createDefaultDunningConfig, A as createDrizzleDunningStorage, e as createDunningCronHandler, f as createDunningEdgeHandler, c as createDunningManager, d as createDunningScheduler, y as createMemoryDunningStorage, r as createPaymentRetrier, q as createPaymentRetryCalculator, t as defaultRetryStrategies, n as defaultSequences, ao as dunningEvents, B as dunningSchema, ai as dunningSequences, al as dunningStates, aj as dunningSteps, am as executedSteps, o as getSequenceByTier, w as iyzicoErrorCodes, l as lenientSequence, m as minimalSequence, v as paddleErrorCodes, ak as paymentFailures, ap as retryStrategies, an as scheduledSteps, i as sequence, j as standardSaasSequence, s as step, u as stripeErrorCodes } from '../schema-C5Zcju_j.js';
+import '../types.js';
+import '@parsrun/types';
+import 'drizzle-orm/pg-core';
+
+/**
+ * @parsrun/payments - Dunning Email Templates
+ * Pre-built email templates for dunning notifications
+ */
+
+/**
+ * Dunning email template data
+ */
+interface DunningEmailData {
+    /** Customer name */
+    customerName?: string;
+    /** Amount owed in display format */
+    amount: string;
+    /** Currency code */
+    currency: string;
+    /** Days since initial failure */
+    daysSinceFailure: number;
+    /** Days until features are limited */
+    daysUntilLimit?: number;
+    /** Days until suspension */
+    daysUntilSuspension?: number;
+    /** Days until cancellation */
+    daysUntilCancellation?: number;
+    /** URL to update payment method */
+    updatePaymentUrl?: string;
+    /** URL to view invoice */
+    invoiceUrl?: string;
+    /** URL for support */
+    supportUrl?: string;
+    /** Brand name */
+    brandName?: string;
+    /** Brand color */
+    brandColor?: string;
+    /** Last 4 digits of card */
+    cardLast4?: string;
+    /** Card brand (Visa, Mastercard, etc.) */
+    cardBrand?: string;
+}
+/**
+ * Rendered email template
+ */
+interface RenderedEmail {
+    subject: string;
+    html: string;
+    text: string;
+}
+/**
+ * Dunning email template
+ */
+interface DunningEmailTemplate {
+    /** Template ID */
+    id: string;
+    /** Template name */
+    name: string;
+    /** Subject template */
+    subject: string;
+    /** HTML template */
+    html: string;
+    /** Plain text template */
+    text: string;
+}
+/**
+ * Format currency amount for display
+ */
+declare function formatAmount(amountCents: number, currency: string): string;
+/**
+ * Payment failed - immediate notification
+ */
+declare const paymentFailedTemplate: DunningEmailTemplate;
+/**
+ * Payment reminder - gentle reminder
+ */
+declare const paymentReminderTemplate: DunningEmailTemplate;
+/**
+ * Payment warning - features may be limited
+ */
+declare const paymentWarningTemplate: DunningEmailTemplate;
+/**
+ * Features limited notification
+ */
+declare const featuresLimitedTemplate: DunningEmailTemplate;
+/**
+ * Account suspension notification
+ */
+declare const accountSuspendedTemplate: DunningEmailTemplate;
+/**
+ * Final warning before cancellation
+ */
+declare const finalWarningTemplate: DunningEmailTemplate;
+/**
+ * Subscription canceled
+ */
+declare const subscriptionCanceledTemplate: DunningEmailTemplate;
+/**
+ * Payment recovered - success notification
+ */
+declare const paymentRecoveredTemplate: DunningEmailTemplate;
+/**
+ * All default dunning templates
+ */
+declare const dunningEmailTemplates: Record<string, DunningEmailTemplate>;
+/**
+ * Render a dunning email template
+ */
+declare function renderDunningEmail(templateId: string, data: DunningEmailData, customTemplates?: Record<string, DunningEmailTemplate>): RenderedEmail;
+/**
+ * Build template data from dunning context
+ */
+declare function buildTemplateData(context: DunningContext, options?: {
+    brandName?: string;
+    brandColor?: string;
+    updatePaymentUrl?: string;
+    invoiceUrl?: string;
+    supportUrl?: string;
+    daysUntilLimit?: number;
+    daysUntilSuspension?: number;
+    daysUntilCancellation?: number;
+}): DunningEmailData;
+
+/**
+ * @parsrun/payments - Dunning Email Integration
+ * Built-in integration with @parsrun/email for sending dunning notifications
+ */
+
+/**
+ * Email service interface (compatible with @parsrun/email)
+ * This allows using @parsrun/email or any compatible email service
+ */
+interface EmailServiceLike {
+    send(options: {
+        to: string | string[];
+        subject: string;
+        html: string;
+        text?: string;
+        replyTo?: string;
+        tags?: string[];
+    }): Promise<{
+        success: boolean;
+        messageId?: string;
+        error?: string;
+    }>;
+}
+/**
+ * Configuration for dunning email integration
+ */
+interface DunningEmailIntegrationConfig {
+    /** Email service instance (from @parsrun/email or compatible) */
+    emailService: EmailServiceLike;
+    /** Brand configuration */
+    brand?: {
+        name?: string;
+        color?: string;
+        logoUrl?: string;
+    };
+    /** URLs for dunning emails */
+    urls?: {
+        updatePayment?: string | ((customerId: string) => string);
+        viewInvoice?: string | ((invoiceId: string) => string);
+        support?: string;
+        unsubscribe?: string | ((customerId: string) => string);
+    };
+    /** Reply-to email address */
+    replyTo?: string;
+    /** Email tags for tracking */
+    tags?: string[];
+    /** Custom email templates (override defaults) */
+    customTemplates?: Record<string, DunningEmailTemplate>;
+    /** Data enrichment function */
+    enrichData?: (data: DunningEmailData, context: DunningContext) => DunningEmailData;
+    /** Logger */
+    logger?: DunningLogger;
+    /** Skip sending to specific customers */
+    skip?: (notification: DunningNotification) => boolean;
+}
+/**
+ * Dunning email notification handler result
+ */
+interface DunningEmailHandler {
+    /** Notification handler to use in DunningManagerConfig */
+    handler: (notification: DunningNotification) => Promise<NotificationResult>;
+    /** Send a one-off dunning email */
+    sendEmail: (templateId: string, to: string, context: DunningContext) => Promise<NotificationResult>;
+    /** Send recovery success email */
+    sendRecoveryEmail: (to: string, context: DunningContext) => Promise<NotificationResult>;
+}
+/**
+ * Create a dunning email notification handler
+ *
+ * @example
+ * ```typescript
+ * import { createEmailService } from '@parsrun/email';
+ * import { createDunningManager, createDunningEmailHandler } from '@parsrun/payments/dunning';
+ *
+ * const emailService = createEmailService({
+ *   provider: 'resend',
+ *   apiKey: process.env.RESEND_API_KEY,
+ *   fromEmail: 'billing@example.com',
+ *   fromName: 'Billing',
+ * });
+ *
+ * const dunningEmail = createDunningEmailHandler({
+ *   emailService,
+ *   brand: { name: 'MyApp', color: '#0070f3' },
+ *   urls: {
+ *     updatePayment: (customerId) => `https://app.example.com/billing?customer=${customerId}`,
+ *     support: 'https://app.example.com/support',
+ *   },
+ * });
+ *
+ * const dunningManager = createDunningManager({
+ *   defaultSequence: standardSaasSequence,
+ *   storage,
+ *   onNotification: dunningEmail.handler,
+ * });
+ * ```
+ */
+declare function createDunningEmailHandler(config: DunningEmailIntegrationConfig): DunningEmailHandler;
+/**
+ * SMS service interface (for future SMS integration)
+ */
+interface SmsServiceLike {
+    send(options: {
+        to: string;
+        message: string;
+    }): Promise<{
+        success: boolean;
+        messageId?: string;
+        error?: string;
+    }>;
+}
+/**
+ * Configuration for multi-channel dunning notifications
+ */
+interface MultiChannelDunningConfig {
+    /** Email service */
+    email?: DunningEmailIntegrationConfig;
+    /** SMS service (future) */
+    sms?: {
+        service: SmsServiceLike;
+        templates?: Record<string, string>;
+    };
+    /** In-app notification handler */
+    inApp?: (notification: DunningNotification) => Promise<NotificationResult>;
+    /** Webhook handler */
+    webhook?: (notification: DunningNotification) => Promise<NotificationResult>;
+    /** Push notification handler */
+    push?: (notification: DunningNotification) => Promise<NotificationResult>;
+    /** Logger */
+    logger?: DunningLogger;
+}
+/**
+ * Create a multi-channel notification handler
+ *
+ * @example
+ * ```typescript
+ * const notificationHandler = createMultiChannelHandler({
+ *   email: {
+ *     emailService,
+ *     brand: { name: 'MyApp' },
+ *   },
+ *   inApp: async (notification) => {
+ *     await pushToInAppNotifications(notification);
+ *     return { success: true, channel: 'in_app', sentAt: new Date() };
+ *   },
+ * });
+ *
+ * const dunningManager = createDunningManager({
+ *   defaultSequence: standardSaasSequence,
+ *   storage,
+ *   onNotification: notificationHandler,
+ * });
+ * ```
+ */
+declare function createMultiChannelHandler(config: MultiChannelDunningConfig): (notification: DunningNotification) => Promise<NotificationResult>;
+/**
+ * Create a simple email-only notification handler
+ * Convenience wrapper for common use case
+ *
+ * @example
+ * ```typescript
+ * import { createEmailService } from '@parsrun/email';
+ * import { createDunningManager, simpleEmailHandler } from '@parsrun/payments/dunning';
+ *
+ * const emailService = createEmailService({ ... });
+ *
+ * const dunningManager = createDunningManager({
+ *   defaultSequence: standardSaasSequence,
+ *   storage,
+ *   onNotification: simpleEmailHandler(emailService, {
+ *     brandName: 'MyApp',
+ *     updatePaymentUrl: 'https://app.example.com/billing',
+ *   }),
+ * });
+ * ```
+ */
+declare function simpleEmailHandler(emailService: EmailServiceLike, options?: {
+    brandName?: string;
+    brandColor?: string;
+    updatePaymentUrl?: string;
+    supportUrl?: string;
+    replyTo?: string;
+}): (notification: DunningNotification) => Promise<NotificationResult>;
+
+export { DunningContext, type DunningEmailData, type DunningEmailHandler, type DunningEmailIntegrationConfig, type DunningEmailTemplate, DunningLogger, DunningNotification, type EmailServiceLike, type MultiChannelDunningConfig, NotificationResult, type RenderedEmail, type SmsServiceLike, accountSuspendedTemplate, buildTemplateData, createDunningEmailHandler, createMultiChannelHandler, dunningEmailTemplates, featuresLimitedTemplate, finalWarningTemplate, formatAmount, paymentFailedTemplate, paymentRecoveredTemplate, paymentReminderTemplate, paymentWarningTemplate, renderDunningEmail, simpleEmailHandler, subscriptionCanceledTemplate };