@k-msg/messaging 0.1.1 → 0.1.3

package/dist/delivery/tracker.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Delivery tracking system for messages
+ */
+import { EventEmitter } from "events";
+import { type DeliveryReport, MessageEventType, MessageStatus } from "../types/message.types";
+export interface DeliveryTrackingOptions {
+    trackingInterval: number;
+    maxTrackingDuration: number;
+    batchSize: number;
+    enableWebhooks: boolean;
+    webhookRetries: number;
+    webhookTimeout: number;
+    persistence: {
+        enabled: boolean;
+        retentionDays: number;
+    };
+}
+export interface DeliveryWebhook {
+    url: string;
+    events: MessageEventType[];
+    secret?: string;
+    headers?: Record<string, string>;
+    timeout: number;
+    retries: number;
+}
+export interface TrackingRecord {
+    messageId: string;
+    phoneNumber: string;
+    templateId: string;
+    provider: string;
+    currentStatus: MessageStatus;
+    statusHistory: StatusHistoryEntry[];
+    deliveryReport: DeliveryReport;
+    webhooks: DeliveryWebhook[];
+    createdAt: Date;
+    updatedAt: Date;
+    expiresAt: Date;
+    metadata: Record<string, any>;
+}
+export interface StatusHistoryEntry {
+    status: MessageStatus;
+    timestamp: Date;
+    provider: string;
+    details?: Record<string, any>;
+    source: "provider" | "webhook" | "manual" | "system";
+}
+export interface DeliveryStats {
+    totalMessages: number;
+    byStatus: Record<MessageStatus, number>;
+    byProvider: Record<string, number>;
+    averageDeliveryTime: number;
+    deliveryRate: number;
+    failureRate: number;
+    lastUpdated: Date;
+}
+export interface WebhookDeliveryResult {
+    success: boolean;
+    statusCode?: number;
+    error?: string;
+    responseTime: number;
+    attempt: number;
+}
+export declare class DeliveryTracker extends EventEmitter {
+    private options;
+    private trackingRecords;
+    private statusIndex;
+    private trackingTimer?;
+    private webhookQueue;
+    private isRunning;
+    private stats;
+    private defaultOptions;
+    constructor(options: DeliveryTrackingOptions);
+    /**
+     * Start delivery tracking
+     */
+    start(): void;
+    /**
+     * Stop delivery tracking
+     */
+    stop(): void;
+    /**
+     * Start tracking a message
+     */
+    trackMessage(messageId: string, phoneNumber: string, templateId: string, provider: string, options?: {
+        webhooks?: DeliveryWebhook[];
+        metadata?: Record<string, any>;
+        initialStatus?: MessageStatus;
+    }): Promise<void>;
+    /**
+     * Update message status
+     */
+    updateStatus(messageId: string, status: MessageStatus, details?: {
+        provider?: string;
+        error?: {
+            code: string;
+            message: string;
+            details?: any;
+        };
+        metadata?: Record<string, any>;
+        source?: "provider" | "webhook" | "manual" | "system";
+        sentAt?: Date;
+        deliveredAt?: Date;
+        clickedAt?: Date;
+        failedAt?: Date;
+    }): Promise<boolean>;
+    /**
+     * Get delivery report for a message
+     */
+    getDeliveryReport(messageId: string): DeliveryReport | undefined;
+    /**
+     * Get tracking record for a message
+     */
+    getTrackingRecord(messageId: string): TrackingRecord | undefined;
+    /**
+     * Get messages by status
+     */
+    getMessagesByStatus(status: MessageStatus): TrackingRecord[];
+    /**
+     * Get delivery statistics
+     */
+    getStats(): DeliveryStats;
+    /**
+     * Get delivery statistics for a specific time range
+     */
+    getStatsForPeriod(startDate: Date, endDate: Date): DeliveryStats;
+    /**
+     * Clean up expired tracking records
+     */
+    cleanup(): number;
+    /**
+     * Stop tracking a specific message
+     */
+    stopTracking(messageId: string): boolean;
+    private scheduleTracking;
+    private processTracking;
+    private processWebhookQueue;
+    private deliverWebhook;
+    private sendWebhook;
+    private queueWebhook;
+    private isStatusProgression;
+    private isTerminalStatus;
+    private getEventTypeForStatus;
+    private updateStats;
+}

package/dist/hooks.d.ts

@@ -0,0 +1,11 @@
+import type { KMsgError, SendOptions, SendResult } from "@k-msg/core";
+export interface HookContext {
+    messageId: string;
+    options: SendOptions;
+    timestamp: number;
+}
+export interface KMsgHooks {
+    onBeforeSend?: (context: HookContext) => void | Promise<void>;
+    onSuccess?: (context: HookContext, result: SendResult) => void | Promise<void>;
+    onError?: (context: HookContext, error: KMsgError) => void | Promise<void>;
+}