@temboplus/frontend-core 0.2.2 → 0.2.4

package/script/src/reports/report_manager.js

@@ -0,0 +1,328 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportManager = exports.REPORTS = exports.ReportType = exports.ProjectType = exports.FileFormat = void 0;
+exports.getReportsByProject = getReportsByProject;
+exports.getReportByType = getReportByType;
+exports.isReportAvailableForProject = isReportAvailableForProject;
+const file_saver_1 = __importDefault(require("file-saver"));
+const index_js_1 = require("../config/index.js");
+/**
+ * Available file formats for reports
+ */
+var FileFormat;
+(function (FileFormat) {
+    /** PDF file format */
+    FileFormat["PDF"] = "pdf";
+    /** Excel file format */
+    FileFormat["EXCEL"] = "excel";
+})(FileFormat || (exports.FileFormat = FileFormat = {}));
+/**
+ * Available project types
+ */
+var ProjectType;
+(function (ProjectType) {
+    /** Tembo Dashboard project */
+    ProjectType["DASHBOARD"] = "dashboard";
+    /** Afloat project */
+    ProjectType["AFLOAT"] = "afloat";
+    /** VertoX project */
+    ProjectType["VERTO_X"] = "verto_x";
+})(ProjectType || (exports.ProjectType = ProjectType = {}));
+/**
+ * Available report types with improved naming
+ */
+var ReportType;
+(function (ReportType) {
+    /** Merchant payout statement (Dashboard) */
+    ReportType["MERCHANT_DISBURSEMENT_REPORT"] = "merchant_disbursement_report";
+    /** Transaction revenue summary (Dashboard) */
+    ReportType["TRANSACTION_REVENUE_SUMMARY"] = "transaction_revenue_summary";
+    /** Customer wallet activity (Afloat) */
+    ReportType["CUSTOMER_WALLET_ACTIVITY"] = "customer_wallet_activity";
+    /** Customer profile information (Afloat) */
+    ReportType["CUSTOMER_PROFILE_SNAPSHOT"] = "customer_profile_snapshot";
+    /** Gateway transaction log (VertoX) */
+    ReportType["GATEWAY_TRANSACTION_LOG"] = "gateway_transaction_log";
+})(ReportType || (exports.ReportType = ReportType = {}));
+/**
+ * Registry of all available reports
+ */
+exports.REPORTS = {
+    // Dashboard Reports
+    [ReportType.MERCHANT_DISBURSEMENT_REPORT]: {
+        id: "merchant_disbursement_report",
+        displayName: "Merchant Disbursement Report",
+        endpoint: "/dashboard/merchant_disbursements",
+        availableFormats: [FileFormat.PDF, FileFormat.EXCEL],
+        projectType: ProjectType.DASHBOARD,
+        reportType: ReportType.MERCHANT_DISBURSEMENT_REPORT,
+        description: "Detailed breakdown of payments made to merchants",
+    },
+    [ReportType.TRANSACTION_REVENUE_SUMMARY]: {
+        id: "transaction_revenue_summary",
+        displayName: "Transaction Revenue Summary",
+        endpoint: "/dashboard/revenue_summary",
+        availableFormats: [FileFormat.PDF, FileFormat.EXCEL],
+        projectType: ProjectType.DASHBOARD,
+        reportType: ReportType.TRANSACTION_REVENUE_SUMMARY,
+        description: "Summary of all revenue transactions by period",
+    },
+    // Afloat Reports
+    [ReportType.CUSTOMER_WALLET_ACTIVITY]: {
+        id: "customer_wallet_activity",
+        displayName: "Customer Wallet Activity",
+        endpoint: "/afloat/wallet_activity",
+        availableFormats: [FileFormat.PDF, FileFormat.EXCEL],
+        projectType: ProjectType.AFLOAT,
+        reportType: ReportType.CUSTOMER_WALLET_ACTIVITY,
+        description: "Detailed record of all customer wallet transactions",
+    },
+    [ReportType.CUSTOMER_PROFILE_SNAPSHOT]: {
+        id: "customer_profile_snapshot",
+        displayName: "Customer Profile Snapshot",
+        endpoint: "/afloat/profile_snapshot",
+        availableFormats: [FileFormat.PDF],
+        projectType: ProjectType.AFLOAT,
+        reportType: ReportType.CUSTOMER_PROFILE_SNAPSHOT,
+        description: "Current account information and status",
+    },
+    // VertoX Reports
+    [ReportType.GATEWAY_TRANSACTION_LOG]: {
+        id: "gateway_transaction_log",
+        displayName: "Gateway Transaction Log",
+        endpoint: "/vertox/gateway_transactions",
+        availableFormats: [FileFormat.EXCEL],
+        projectType: ProjectType.VERTO_X,
+        reportType: ReportType.GATEWAY_TRANSACTION_LOG,
+        description: "Log of all payment gateway API transactions",
+    },
+};
+/**
+ * Get all reports for a specific project
+ * @param projectType The project type to filter by
+ * @returns Array of report definitions for the project
+ */
+function getReportsByProject(projectType) {
+    return Object.values(exports.REPORTS).filter((report) => report.projectType === projectType);
+}
+/**
+ * Get a report by its type
+ * @param reportType The report type to retrieve
+ * @returns The report definition or undefined if not found
+ */
+function getReportByType(reportType) {
+    return exports.REPORTS[reportType];
+}
+/**
+ * Validates if a report type is available for a project
+ * @param projectType The project type
+ * @param reportType The report type
+ * @returns True if the report is available for the project, false otherwise
+ */
+function isReportAvailableForProject(projectType, reportType) {
+    const report = exports.REPORTS[reportType];
+    return report !== undefined && report.projectType === projectType;
+}
+/**
+ * Report Manager class for handling report downloads
+ */
+class ReportManager {
+    constructor() {
+        /**
+         * Get the base URL for the report API
+         * @returns The base URL
+         */
+        Object.defineProperty(this, "getBaseURL", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                let url = index_js_1.ConfigService.instance.pdfMakerBaseUrl;
+                if (url.trim().length === 0) {
+                    url = "https://api.afloat.money/pdf-maker";
+                }
+                if (url.endsWith("/"))
+                    return url.slice(0, -1);
+                return url;
+            }
+        });
+        /**
+         * Converts a base64 string to a Blob
+         * @param base64 The base64 string
+         * @returns A Blob
+         */
+        Object.defineProperty(this, "b64toBlob", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (base64) => fetch(base64).then((res) => res.blob())
+        });
+    }
+    /**
+     * Get the singleton instance of ReportManager
+     */
+    static get instance() {
+        return this._instance || (this._instance = new this());
+    }
+    /**
+     * Downloads a report based on project type and report type
+     * @param args Arguments for the report download
+     * @returns Promise that resolves when download is complete
+     */
+    async downloadReport(args) {
+        try {
+            // Get the report from the registry
+            const report = exports.REPORTS[args.reportType];
+            if (!report) {
+                throw new Error(`Report type ${args.reportType} not configured`);
+            }
+            // Validate that the report belongs to the specified project
+            if (report.projectType !== args.projectType) {
+                throw new Error(`Report type ${args.reportType} does not belong to project ${args.projectType}`);
+            }
+            // Check if requested format is supported
+            if (!report.availableFormats.includes(args.fileFormat)) {
+                throw new Error(`File format ${args.fileFormat} not supported for ${report.displayName}`);
+            }
+            // Build URL using the report's endpoint
+            let url = `${this.getBaseURL()}${report.endpoint}`;
+            // Create a properly typed query parameters object
+            // deno-lint-ignore no-explicit-any
+            const queryParams = {
+                ...(args.query || {}),
+                fileFormat: args.fileFormat,
+            };
+            // Build the query string
+            const searchParams = new URLSearchParams();
+            for (const key in queryParams) {
+                if (Object.prototype.hasOwnProperty.call(queryParams, key)) {
+                    const value = queryParams[key];
+                    if (value !== undefined && value !== null) {
+                        if (Array.isArray(value)) {
+                            value.forEach((item) => {
+                                searchParams.append(key + "[]", String(item));
+                            });
+                        }
+                        else {
+                            searchParams.append(key, String(value));
+                        }
+                    }
+                }
+            }
+            const queryString = searchParams.toString();
+            if (queryString) {
+                url += `?${queryString}`;
+            }
+            // Make the request
+            const response = await fetch(url, {
+                method: "GET",
+                headers: {
+                    "Accept": "*/*",
+                    "Content-Type": "application/json",
+                    "Authorization": `Bearer ${args.token}`,
+                },
+            });
+            if (response.status !== 200) {
+                await this.handleErrorResponse(response);
+            }
+            // Process the download
+            await this.processDownload(response, report, args.fileFormat);
+        }
+        catch (error) {
+            console.error("Report download failed:", error);
+            throw error;
+        }
+    }
+    /**
+     * Process the download
+     * @param response The response from the API
+     * @param report The report definition
+     * @param fileFormat The requested file format
+     */
+    async processDownload(response, report, fileFormat) {
+        const contentDisposition = response.headers.get("Content-Disposition");
+        // Get default filename based on report and file format
+        const defaultFilename = this.getDefaultFilename(report, fileFormat);
+        // Try to get filename from Content-Disposition, fall back to default
+        const fileName = this.extractFilenameFromContentDisposition(contentDisposition) ||
+            defaultFilename;
+        // Handle the response based on content type
+        // deno-lint-ignore no-explicit-any
+        const blob = await this.b64toBlob(await response.text());
+        file_saver_1.default.saveAs(blob, fileName);
+    }
+    /**
+     * Handle error responses from the API
+     * @param response The response from the API
+     * @throws Error with appropriate message
+     */
+    async handleErrorResponse(response) {
+        let errorMessage = "Encountered an error while generating report";
+        try {
+            // Try to parse as JSON first
+            const contentType = response.headers.get("Content-Type");
+            if (contentType && contentType.includes("application/json")) {
+                const errorData = await response.json();
+                errorMessage = errorData.message || errorData.error ||
+                    errorMessage;
+            }
+            else {
+                // Try to get error as text
+                const textError = await response.text();
+                if (textError) {
+                    errorMessage = textError;
+                }
+            }
+        }
+        catch (parseError) {
+            console.error("Error parsing error response:", parseError);
+        }
+        throw new Error(errorMessage);
+    }
+    /**
+     * Generates a default filename based on report and file format
+     * @param report The report definition
+     * @param fileFormat The requested file format
+     * @returns A suitable default filename with proper extension
+     */
+    getDefaultFilename(report, fileFormat) {
+        const date = new Date().toISOString().slice(0, 10); // YYYY-MM-DD format
+        // Build the filename with project, report type, and date
+        const baseFilename = `${report.id}_${date}`;
+        // Add the extension based on the file format
+        return fileFormat === FileFormat.PDF
+            ? `${baseFilename}.pdf`
+            : `${baseFilename}.xlsx`;
+    }
+    /**
+     * Extracts the filename from the Content-Disposition header
+     * @param contentDisposition The Content-Disposition header value
+     * @returns The extracted filename or null if not found
+     */
+    extractFilenameFromContentDisposition(contentDisposition) {
+        // Check if the header exists
+        if (!contentDisposition) {
+            return null;
+        }
+        // Try to match the filename pattern
+        const filenameRegex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/;
+        const matches = filenameRegex.exec(contentDisposition);
+        if (matches && matches[1]) {
+            // Clean up the filename by removing quotes if present
+            let filename = matches[1].trim();
+            // Remove surrounding quotes if they exist
+            if (filename.startsWith('"') && filename.endsWith('"')) {
+                filename = filename.substring(1, filename.length - 1);
+            }
+            else if (filename.startsWith("'") && filename.endsWith("'")) {
+                filename = filename.substring(1, filename.length - 1);
+            }
+            return filename;
+        }
+        return null;
+    }
+}
+exports.ReportManager = ReportManager;