@temboplus/frontend-core 0.2.1 → 0.2.3

package/esm/src/models/phone_number/tz/phone_number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone_number.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/phone_number/tz/phone_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,qBAAa,aAAa;IACxB;;OAEG;IACH,OAAO,CAAC,cAAc,CAAS;IAE/B;;;;;OAKG;IACH,OAAO;IAIP;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM;IAmBhD;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;;OAGG;IACH,OAAO,CAAC,cAAc;IAMtB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,mBAAmB,CAMzC;IAED;;;;;OAKG;WACW,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAyC5D;;;;;OAKG;WACW,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAW1D;;;;;;;;;;;;;;;;;;;OAmBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa;IAYpD;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B"}

package/esm/src/models/phone_number/{phone_number.js → tz/phone_number.js}

@@ -23,31 +23,28 @@
  *    - Tigo: 65, 67, etc.
  *    - Halotel: 62, etc.
  *
+ * 4. Phone numbers can be formatted in the following ways:
+ *    - International format: "+255 XXX XXX XXX"
+ *    - National format: "0XXX XXX XXX"
+ *    - Compact format: "XXXXXXXXX"
+ *    - RFC3966 format: "tel:+255XXXXXXXXX"
+ *
  * ## Solution
- * The PhoneNumber class provides:
+ * The TZPhoneNumber class provides:
  * 1. Parsing and validation of different input formats
  * 2. Standardized storage in compact format
  * 3. Formatting options for display and API use
  * 4. Network operator identification
  */
 import { NETWORK_OPERATOR_CONFIG, } from "./network_operator.js";
-/**
- * Enumeration for various mobile number formats.
- * @enum {string}
- */
-export var MobileNumberFormat;
-(function (MobileNumberFormat) {
-    MobileNumberFormat["s255"] = "255";
-    MobileNumberFormat["sp255"] = "+255";
-    MobileNumberFormat["s0"] = "0";
-    MobileNumberFormat["none"] = "";
-})(MobileNumberFormat || (MobileNumberFormat = {}));
+import { PhoneNumberFormat } from "../format.js";
 /**
  * Represents a TZ phone number
  */
-export class PhoneNumber {
+export class TZPhoneNumber {
     /**
-     * Constructs a new `PhoneNumber` instance.
+     * Private constructor to prevent direct instantiation.
+     * Use TZPhoneNumber.from() instead.
      *
      * @param compactNumber - The phone number in a compact format (e.g., "712345678").
      */
@@ -55,30 +52,76 @@ export class PhoneNumber {
         /**
          * Stores the phone number in a compact format excluding country code and the initial '0'.
          */
-        Object.defineProperty(this, "compactNumber", {
+        Object.defineProperty(this, "_compactNumber", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        this.compactNumber = compactNumber;
+        this._compactNumber = compactNumber;
     }
     /**
-     * Formats the compact phone number with the specified `MobileNumberFormat`.
+     * Gets the compact number (national number without formatting)
+     */
+    get compactNumber() {
+        return this._compactNumber;
+    }
+    /**
+     * Formats the phone number according to the specified format
      *
-     * @param format - The desired phone number format (e.g., `+255` or `255`).
-     * @returns The phone number formatted as a string.
+     * @param format - The desired format from GlobalPhoneNumberFormat
+     * @returns The formatted phone number string
      */
-    getNumberWithFormat(format) {
-        return `${format}${this.compactNumber}`;
+    getWithFormat(format) {
+        switch (format) {
+            case PhoneNumberFormat.INTERNATIONAL:
+                // Format: +255 XXX XXX XXX
+                return this.formatInternational();
+            case PhoneNumberFormat.NATIONAL:
+                // Format: 0XXX XXX XXX
+                return this.formatNational();
+            case PhoneNumberFormat.COMPACT:
+                // Format: XXXXXXXXX (just the 9 digits)
+                return this._compactNumber;
+            case PhoneNumberFormat.RFC3966:
+                // Format: tel:+255XXXXXXXXX
+                return this.formatRFC3966();
+            default:
+                return `+255${this._compactNumber}`;
+        }
     }
     /**
-     * Returns the formatted label of the phone number using the `s255` format.
+     * Formats the phone number in international format with spaces
+     * Format: +255 XXX XXX XXX
+     */
+    formatInternational() {
+        const num = this._compactNumber;
+        // Insert spaces: +255 XXX XXX XXX
+        return `+255 ${num.substring(0, 3)} ${num.substring(3, 6)} ${num.substring(6)}`;
+    }
+    /**
+     * Formats the phone number in national format with spaces
+     * Format: 0XXX XXX XXX
+     */
+    formatNational() {
+        const num = this._compactNumber;
+        // Insert spaces: 0XXX XXX XXX
+        return `0${num.substring(0, 3)} ${num.substring(3, 6)} ${num.substring(6)}`;
+    }
+    /**
+     * Formats the phone number according to RFC3966
+     * Format: tel:+255XXXXXXXXX
+     */
+    formatRFC3966() {
+        return `tel:+255${this._compactNumber}`;
+    }
+    /**
+     * Returns the formatted label of the phone number using the international format.
      *
-     * @returns The phone number label in `255` format.
+     * @returns The phone number label in international format.
      */
     get label() {
-        return this.getNumberWithFormat(MobileNumberFormat.s255);
+        return this.getWithFormat(PhoneNumberFormat.INTERNATIONAL);
     }
     /**
      * Derives the network operator information associated with the phone number by checking its prefix.
@@ -86,21 +129,24 @@ export class PhoneNumber {
      * @returns The `NetworkOperatorInfo` object that matches the phone number prefix.
      */
     get networkOperator() {
-        const prefix = this.compactNumber.substring(0, 2);
+        const prefix = this._compactNumber.substring(0, 2);
         const result = Object.values(NETWORK_OPERATOR_CONFIG).find((operator) => operator.mobileNumberPrefixes.includes(prefix));
         return result;
     }
     /**
-     * Creates a `PhoneNumber` instance from a given string.
+     * Creates a `TZPhoneNumber` instance from a given string.
      *
      * @param s - The input phone number string in various formats (e.g., "+255712345678", "0712345678").
-     * @returns A `PhoneNumber` instance if valid, otherwise `undefined`.
+     * @returns A `TZPhoneNumber` instance if valid, otherwise `undefined`.
      */
-    static from(s) {
+    static from(input) {
         try {
-            const number = removeSpaces(s.trim());
+            // Clean the input (remove all non-digits except the leading '+')
+            const hasPlus = input.trim().startsWith("+");
+            let number = input.replace(/\D/g, "");
+            number = hasPlus ? `+${number}` : number;
             if (number.length === 0)
-                return;
+                return undefined;
             const isOnlyDigits = isOnlyDigitsOrPlus(number);
             if (!isOnlyDigits)
                 return;
@@ -126,7 +172,7 @@ export class PhoneNumber {
             const operator = Object.values(NETWORK_OPERATOR_CONFIG).find((op) => op.mobileNumberPrefixes.includes(prefix));
             if (!operator)
                 return;
-            return new PhoneNumber(compactNumber);
+            return new TZPhoneNumber(compactNumber);
         }
         catch (_) {
             return;
@@ -144,20 +190,20 @@ export class PhoneNumber {
         const text = removeSpaces(input.trim());
         if (text.length === 0)
             return false;
-        const phone = PhoneNumber.from(text);
+        const phone = TZPhoneNumber.from(text);
         return phone !== undefined;
     }
     /**
-     * Checks if an unknown value contains valid data to construct a PhoneNumber instance.
+     * Checks if an unknown value contains valid data to construct a TZPhoneNumber instance.
      * Validates the structural integrity of the phone number object.
      *
      * @param {unknown} obj - The value to validate.
-     * @returns {obj is PhoneNumber} Type predicate indicating if the value has a valid phone number structure.
+     * @returns {obj is TZPhoneNumber} Type predicate indicating if the value has a valid phone number structure.
      *
      * @example
      * const maybePhone = JSON.parse(someData);
-     * if (PhoneNumber.is(maybePhone)) {
-     *   // maybePhone is typed as PhoneNumber
+     * if (TZPhoneNumber.is(maybePhone)) {
+     *   // maybePhone is typed as TZPhoneNumber
      *   console.log(maybePhone.label);
      * }
      *
@@ -171,11 +217,11 @@ export class PhoneNumber {
         if (!obj || typeof obj !== "object")
             return false;
         const maybePhone = obj;
-        // Check if compactNumber exists and is string
-        if (typeof maybePhone.compactNumber !== "string")
+        // Check if _compactNumber exists and is string
+        if (typeof maybePhone._compactNumber !== "string")
             return false;
-        const compactNumber = maybePhone.compactNumber;
-        return PhoneNumber.canConstruct(compactNumber);
+        const compactNumber = maybePhone._compactNumber;
+        return TZPhoneNumber.canConstruct(compactNumber);
     }
     /**
      * Checks the validity of the phone number data
@@ -183,7 +229,7 @@ export class PhoneNumber {
      */
     validate() {
         try {
-            return PhoneNumber.canConstruct(this.compactNumber);
+            return TZPhoneNumber.canConstruct(this._compactNumber);
         }
         catch (_) {
             return false;

package/esm/src/models/phone_number/tz/phone_number.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone_number.test.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/phone_number/tz/phone_number.test.ts"],"names":[],"mappings":""}

package/esm/src/reports/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./report_manager.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/src/reports/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/src/reports/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA"}

package/esm/src/reports/index.js

@@ -0,0 +1 @@
+export * from "./report_manager.js";

package/esm/src/reports/report_manager.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Available file formats for reports
+ */
+export declare enum FileFormat {
+    /** PDF file format */
+    PDF = "pdf",
+    /** Excel file format */
+    EXCEL = "excel"
+}
+/**
+ * Available project types
+ */
+export declare enum ProjectType {
+    /** Tembo Dashboard project */
+    DASHBOARD = "dashboard",
+    /** Afloat project */
+    AFLOAT = "afloat",
+    /** VertoX project */
+    VERTO_X = "verto_x"
+}
+/**
+ * Available report types with improved naming
+ */
+export declare enum ReportType {
+    /** Merchant payout statement (Dashboard) */
+    MERCHANT_DISBURSEMENT_REPORT = "merchant_disbursement_report",
+    /** Transaction revenue summary (Dashboard) */
+    TRANSACTION_REVENUE_SUMMARY = "transaction_revenue_summary",
+    /** Customer wallet activity (Afloat) */
+    CUSTOMER_WALLET_ACTIVITY = "customer_wallet_activity",
+    /** Customer profile information (Afloat) */
+    CUSTOMER_PROFILE_SNAPSHOT = "customer_profile_snapshot",
+    /** Gateway transaction log (VertoX) */
+    GATEWAY_TRANSACTION_LOG = "gateway_transaction_log"
+}
+/**
+ * Report definition interface
+ */
+export interface ReportDefinition {
+    /** Unique identifier for the report */
+    id: string;
+    /** Human-readable report name for UI display */
+    displayName: string;
+    /** API endpoint path for the report */
+    endpoint: string;
+    /** Available file formats for the report */
+    availableFormats: FileFormat[];
+    /** Optional description of the report */
+    description?: string;
+    /** Project the report belongs to */
+    projectType: ProjectType;
+    /** Type of the report */
+    reportType: ReportType;
+}
+/**
+ * Registry of all available reports
+ */
+export declare const REPORTS: {
+    merchant_disbursement_report: ReportDefinition;
+    transaction_revenue_summary: ReportDefinition;
+    customer_wallet_activity: ReportDefinition;
+    customer_profile_snapshot: ReportDefinition;
+    gateway_transaction_log: ReportDefinition;
+};
+/**
+ * Get all reports for a specific project
+ * @param projectType The project type to filter by
+ * @returns Array of report definitions for the project
+ */
+export declare function getReportsByProject(projectType: ProjectType): ReportDefinition[];
+/**
+ * Get a report by its type
+ * @param reportType The report type to retrieve
+ * @returns The report definition or undefined if not found
+ */
+export declare function getReportByType(reportType: ReportType): ReportDefinition;
+/**
+ * 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
+ */
+export declare function isReportAvailableForProject(projectType: ProjectType, reportType: ReportType): boolean;
+/**
+ * Report Manager class for handling report downloads
+ */
+export declare class ReportManager {
+    private static _instance;
+    private constructor();
+    /**
+     * Get the singleton instance of ReportManager
+     */
+    static get instance(): ReportManager;
+    /**
+     * Get the base URL for the report API
+     * @returns The base URL
+     */
+    private getBaseURL;
+    /**
+     * 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
+     */
+    downloadReport(args: {
+        token: string;
+        projectType: ProjectType;
+        reportType: ReportType;
+        fileFormat: FileFormat;
+        query?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * Process the download
+     * @param response The response from the API
+     * @param report The report definition
+     * @param fileFormat The requested file format
+     */
+    private processDownload;
+    /**
+     * Handle error responses from the API
+     * @param response The response from the API
+     * @throws Error with appropriate message
+     */
+    private handleErrorResponse;
+    /**
+     * 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
+     */
+    private getDefaultFilename;
+    /**
+     * Extracts the filename from the Content-Disposition header
+     * @param contentDisposition The Content-Disposition header value
+     * @returns The extracted filename or null if not found
+     */
+    private extractFilenameFromContentDisposition;
+    /**
+     * Converts a base64 string to a Blob
+     * @param base64 The base64 string
+     * @returns A Blob
+     */
+    private b64toBlob;
+}
+//# sourceMappingURL=report_manager.d.ts.map

package/esm/src/reports/report_manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report_manager.d.ts","sourceRoot":"","sources":["../../../src/src/reports/report_manager.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,UAAU;IACpB,sBAAsB;IACtB,GAAG,QAAQ;IACX,wBAAwB;IACxB,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB,8BAA8B;IAC9B,SAAS,cAAc;IACvB,qBAAqB;IACrB,MAAM,WAAW;IACjB,qBAAqB;IACrB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,4CAA4C;IAC5C,4BAA4B,iCAAiC;IAC7D,8CAA8C;IAC9C,2BAA2B,gCAAgC;IAC3D,wCAAwC;IACxC,wBAAwB,6BAA6B;IACrD,4CAA4C;IAC5C,yBAAyB,8BAA8B;IACvD,uCAAuC;IACvC,uBAAuB,4BAA4B;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,gBAAgB,EAAE,UAAU,EAAE,CAAC;IAC/B,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oCAAoC;IACpC,WAAW,EAAE,WAAW,CAAC;IACzB,yBAAyB;IACzB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,OAAO;kCAUb,gBAAgB;iCAUhB,gBAAgB;8BAWhB,gBAAgB;+BAUhB,gBAAgB;6BAWhB,gBAAgB;CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,WAAW,GACvB,gBAAgB,EAAE,CAIpB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,OAAO,CAGT;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAgB;IAExC,OAAO;IAEP;;OAEG;IACH,WAAkB,QAAQ,kBAEzB;IAED;;;OAGG;IACH,OAAO,CAAC,UAAU,CAIhB;IAEF;;;;OAIG;IACU,cAAc,CAAC,IAAI,EAAE;QAChC,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,WAAW,CAAC;QACzB,UAAU,EAAE,UAAU,CAAC;QACvB,UAAU,EAAE,UAAU,CAAC;QAEvB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC7B,GAAG,OAAO,CAAC,IAAI,CAAC;IAmFjB;;;;;OAKG;YACW,eAAe;IAqB7B;;;;OAIG;YACW,mBAAmB;IAwBjC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAe1B;;;;OAIG;IACH,OAAO,CAAC,qCAAqC;IA6B7C;;;;OAIG;IACH,OAAO,CAAC,SAAS,CACyB;CAC3C"}