@temboplus/frontend-core 0.1.0 → 0.2.0

package/README.md

@@ -1,72 +1,61 @@
 # @temboplus/frontend-core
 
-This JavaScript/TypeScript package serves as a foundation for TemboPlus front-end development. It provides a collection of reusable utilities and models that can be consumed by other libraries and individual front-end projects within the TemboPlus ecosystem.
+A foundational JavaScript/TypeScript library that powers TemboPlus front-end applications. This library provides essential tools and data models that ensure consistency across all TemboPlus projects.
 
-## Overview
+## What's Inside
 
-The @temboplus/frontend-core package offers a centralized repository of shared resources. This includes:
+The library contains:
 
-* Utilities: Reusable helper functions for common tasks.
-* Models: Standardized data structures and interfaces for consistent data representation across projects.
+* **Utilities**: Ready-to-use helper functions for common development tasks
+* **Data Models**: Standardized structures for handling data like phone numbers, amounts, and bank details
 
-### Model Validation Methods
+## Working with Data Models
 
-This document outlines the standard validation methods implemented across our model classes (`PhoneNumber`, `Amount`, and `Bank`).
-Each model class implements three validation methods with distinct purposes:
+Each data model in our library (PhoneNumber, Amount, and Bank) comes with three key validation methods to ensure your data is always correct and reliable.
 
-#### Static Method: `is`
+### 1. Checking Object Types with `is`
 
-The `is` method determines whether an unknown object is a valid instance of the respective class.
+Use this when you want to verify if an object is a valid model instance.
 
 ```typescript
-public static is(obj: unknown): obj is PhoneNumber
-public static is(obj: unknown): obj is Amount
-public static is(obj: unknown): obj is Bank
-```
-
-*Usage Example:*
-```typescript
-if (PhoneNumber.is(unknownObject)) {
-    // TypeScript now recognizes unknownObject as PhoneNumber
-    const phone = unknownObject;
+// Example: Checking if an object is a valid phone number
+if (PhoneNumber.is(someObject)) {
+    // If true, someObject is confirmed to be a PhoneNumber
+    const phoneNumber = someObject;
+    console.log(phoneNumber.label);
 }
 ```
 
-#### Static Method: `canConstruct`
+### 2. Validating Input Data with `canConstruct`
 
-The `canConstruct` method checks if the provided data can be used to create a new instance of the class.
-
-```typescript
-public static canConstruct(input?: unknown): boolean
-```
+Before creating a new instance, use this to check if your input data is valid.
 
-*Usage Example:*
 ```typescript
+// Example: Validating user input before creating an Amount
 if (Amount.canConstruct(userInput)) {
-    const amount = Amount.from(userInput); // Safe to construct
+    // Input is valid, safe to create a new Amount
+    const amount = Amount.from(userInput);
 }
 ```
 
-#### Instance Method: `validate`
+### 3. Verifying Instance Data with `validate`
 
-Due to TypeScript type system limitations, an additional runtime validation is needed to ensure all internal data of an instance remains valid. The `validate` method performs this check on class instances.
+Use this to ensure an existing instance's data remains valid after changes.
 
 ```typescript
-public validate(): boolean
-```
-
-*Usage Example:*
-```typescript
-const bank = new Bank(data);
-if (!bank.validate()) {
-    throw new Error('Invalid bank instance');
+// Example: Checking if bank data is still valid
+const bank = new Bank(bankData);
+if (bank.validate()) {
+    // Bank instance is valid
+    processBankTransaction(bank);
+} else {
+    showError("Invalid bank information");
 }
 ```
 
-### Implementation Notes
-
-- The `is` method should be used when working with unknown objects that might be instances of your model classes
-- Use `canConstruct` before attempting to create new instances from external data
-- The `validate` method should be called after any operation that might affect the internal state of an instance
-- These methods work together to provide type safety both at compile time and runtime
+## Best Practices
 
+* **Type Checking**: Use `is` when working with data from external sources or APIs
+* **Safe Creation**: Always use `canConstruct` before creating new instances
+* **Data Integrity**: Call `validate` after operations that modify instance data
+* **Error Prevention**: These methods help catch issues early in development

package/esm/src/models/amount/amount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../../../src/src/models/amount/amount.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,YAAY,QAA2C,CAAC;AAE9D,cAAM,MAAM;IACV,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAE9B,OAAO;IAKP;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IA2BvD;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAKlC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAS5D;;;;;;;;;;;;;;;OAeG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAsB7C;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B;AAuGD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../../../src/src/models/amount/amount.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,YAAY,QAA2C,CAAC;AAE9D,cAAM,MAAM;IACV,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAE9B,OAAO;IAKP;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IA0BvD;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAKlC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAS5D;;;;;;;;;;;;;;;OAeG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAsB7C;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B;AAuGD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC"}

package/esm/src/models/amount/amount.js

@@ -27,7 +27,6 @@ class Amount {
      */
     static from(input) {
         let amountText = input.toString().trim();
-        console.log(amountText);
         if (hasComma(amountText)) {
             if (!hasValidCommaPlacement(amountText))
                 return undefined;

package/esm/src/models/phone_number/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./antd_validator.js";
 export * from "./phone_number.js";
-export * from "./telecom.js";
+export * from "./network_operator.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC"}

package/esm/src/models/phone_number/index.js

@@ -1,3 +1,3 @@
 export * from "./antd_validator.js";
 export * from "./phone_number.js";
-export * from "./telecom.js";
+export * from "./network_operator.js";

package/esm/src/models/phone_number/network_operator.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Represents available mobile network operators in Tanzania
+ * @enum {string}
+ */
+export declare enum NetworkOperator {
+    VODACOM = "Vodacom",
+    AIRTEL = "Airtel",
+    TIGO = "Tigo",
+    HALOTEL = "Halotel"
+}
+/**
+ * Defines the structure for a mobile network operator's information
+ */
+export interface NetworkOperatorInfo {
+    /** Unique identifier for the network operator */
+    id: NetworkOperator;
+    /** List of mobile number prefixes assigned to this operator */
+    mobileNumberPrefixes: string[];
+    /** Display name of the network operator */
+    displayName: string;
+    /** Mobile money service name offered by the operator */
+    mobileMoneyService: string;
+    /** Brand color associated with the operator */
+    brandColor: string;
+}
+/**
+ * Comprehensive information about mobile network operators and their services
+ */
+export declare const NETWORK_OPERATOR_CONFIG: Record<NetworkOperator, NetworkOperatorInfo>;
+//# sourceMappingURL=network_operator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"network_operator.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/network_operator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iDAAiD;IACjD,EAAE,EAAE,eAAe,CAAC;IAEpB,+DAA+D;IAC/D,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAE/B,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IAEpB,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,CAAC;IAE3B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAC1C,eAAe,EACf,mBAAmB,CA8BpB,CAAC"}

package/esm/src/models/phone_number/network_operator.js

@@ -0,0 +1,44 @@
+/**
+ * Represents available mobile network operators in Tanzania
+ * @enum {string}
+ */
+export var NetworkOperator;
+(function (NetworkOperator) {
+    NetworkOperator["VODACOM"] = "Vodacom";
+    NetworkOperator["AIRTEL"] = "Airtel";
+    NetworkOperator["TIGO"] = "Tigo";
+    NetworkOperator["HALOTEL"] = "Halotel";
+})(NetworkOperator || (NetworkOperator = {}));
+/**
+ * Comprehensive information about mobile network operators and their services
+ */
+export const NETWORK_OPERATOR_CONFIG = {
+    [NetworkOperator.VODACOM]: {
+        id: NetworkOperator.VODACOM,
+        mobileNumberPrefixes: ["74", "75", "76"],
+        displayName: "Vodacom",
+        mobileMoneyService: "M-Pesa",
+        brandColor: "red",
+    },
+    [NetworkOperator.AIRTEL]: {
+        id: NetworkOperator.AIRTEL,
+        mobileNumberPrefixes: ["78", "79", "68", "69"],
+        displayName: "Airtel",
+        mobileMoneyService: "Airtel Money",
+        brandColor: "volcano",
+    },
+    [NetworkOperator.TIGO]: {
+        id: NetworkOperator.TIGO,
+        mobileNumberPrefixes: ["71", "65", "67", "77"],
+        displayName: "Yas",
+        mobileMoneyService: "Mixx",
+        brandColor: "blue",
+    },
+    [NetworkOperator.HALOTEL]: {
+        id: NetworkOperator.HALOTEL,
+        mobileNumberPrefixes: ["62", "61"],
+        displayName: "Halotel",
+        mobileMoneyService: "HaloPesa",
+        brandColor: "orange",
+    },
+};

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

@@ -14,22 +14,23 @@
  *
  * 2. Valid numbers must:
  *    - Have exactly 9 digits after removing prefixes
- *    - Start with a valid telecom provider prefix
+ *    - Start with a valid network operator prefix
  *    - Contain only numeric characters
  *
- * 3. Each telecom provider has specific prefixes:
+ * 3. Each network operator has specific prefixes:
  *    - Vodacom: 71, 74, 75, etc.
  *    - Airtel: 68, 69, etc.
  *    - Tigo: 65, 67, etc.
+ *    - Halotel: 62, etc.
  *
  * ## Solution
  * The PhoneNumber 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. Telecom provider identification
+ * 4. Network operator identification
  */
-import { type Telecom } from "./telecom.js";
+import { type NetworkOperatorInfo } from "./network_operator.js";
 /**
  * Enumeration for various mobile number formats.
  * @enum {string}
@@ -68,11 +69,11 @@ export declare class PhoneNumber {
      */
     get label(): string;
     /**
-     * Derives the telecom details associated with the phone number by checking its prefix.
+     * Derives the network operator information associated with the phone number by checking its prefix.
      *
-     * @returns The `Telecom` object that matches the phone number prefix.
+     * @returns The `NetworkOperatorInfo` object that matches the phone number prefix.
      */
-    get telecom(): Telecom;
+    get networkOperator(): NetworkOperatorInfo;
     /**
      * Creates a `PhoneNumber` instance from a given string.
      *
@@ -105,7 +106,7 @@ export declare class PhoneNumber {
      * Validates:
      * - Has required compactNumber property
      * - compactNumber is a 9-digit string
-     * - Prefix matches a valid telecom provider
+     * - Prefix matches a valid network operator
      */
     static is(obj: unknown): obj is PhoneNumber;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"phone_number.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/phone_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,EAAE,KAAK,OAAO,EAAkB,MAAM,cAAc,CAAC;AAE5D;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,IAAI,QAAQ,CAAE,mCAAmC;IACjD,KAAK,SAAS,CAAE,oCAAoC;IACpD,EAAE,MAAM,CAAE,iCAAiC;IAC3C,IAAI,KAAK;CACV;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBACS,aAAa,EAAE,MAAM;IAIjC;;;;;OAKG;IACH,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAIvD;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAMrB;IAED;;;;;OAKG;WACW,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAqCtD;;;;;OAKG;WACW,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAW1D;;;;;;;;;;;;;;;;;;;OAmBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW;IAYlD;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B"}
+{"version":3,"file":"phone_number.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/phone_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,IAAI,QAAQ,CAAE,mCAAmC;IACjD,KAAK,SAAS,CAAE,oCAAoC;IACpD,EAAE,MAAM,CAAE,iCAAiC;IAC3C,IAAI,KAAK;CACV;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBACS,aAAa,EAAE,MAAM;IAIjC;;;;;OAKG;IACH,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAIvD;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,mBAAmB,CAMzC;IAED;;;;;OAKG;WACW,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAqCtD;;;;;OAKG;WACW,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAW1D;;;;;;;;;;;;;;;;;;;OAmBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW;IAYlD;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B"}

package/esm/src/models/phone_number/phone_number.js

@@ -14,22 +14,23 @@
  *
  * 2. Valid numbers must:
  *    - Have exactly 9 digits after removing prefixes
- *    - Start with a valid telecom provider prefix
+ *    - Start with a valid network operator prefix
  *    - Contain only numeric characters
  *
- * 3. Each telecom provider has specific prefixes:
+ * 3. Each network operator has specific prefixes:
  *    - Vodacom: 71, 74, 75, etc.
  *    - Airtel: 68, 69, etc.
  *    - Tigo: 65, 67, etc.
+ *    - Halotel: 62, etc.
  *
  * ## Solution
  * The PhoneNumber 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. Telecom provider identification
+ * 4. Network operator identification
  */
-import { telecomDetails } from "./telecom.js";
+import { NETWORK_OPERATOR_CONFIG, } from "./network_operator.js";
 /**
  * Enumeration for various mobile number formats.
  * @enum {string}
@@ -80,13 +81,13 @@ export class PhoneNumber {
         return this.getNumberWithFormat(MobileNumberFormat.s255);
     }
     /**
-     * Derives the telecom details associated with the phone number by checking its prefix.
+     * Derives the network operator information associated with the phone number by checking its prefix.
      *
-     * @returns The `Telecom` object that matches the phone number prefix.
+     * @returns The `NetworkOperatorInfo` object that matches the phone number prefix.
      */
-    get telecom() {
-        const id = this.compactNumber.substring(0, 2);
-        const result = Object.values(telecomDetails).find((e) => e.prefixes.includes(id));
+    get networkOperator() {
+        const prefix = this.compactNumber.substring(0, 2);
+        const result = Object.values(NETWORK_OPERATOR_CONFIG).find((operator) => operator.mobileNumberPrefixes.includes(prefix));
         return result;
     }
     /**
@@ -120,10 +121,10 @@ export class PhoneNumber {
             // Validate that the compact number length is correct.
             if (compactNumber.length !== 9)
                 return;
-            // Check if the compact number matches any telecom provider prefix.
-            const id = compactNumber.substring(0, 2);
-            const telecom = Object.values(telecomDetails).find((e) => e.prefixes.includes(id));
-            if (!telecom)
+            // Check if the compact number matches any network operator prefix.
+            const prefix = compactNumber.substring(0, 2);
+            const operator = Object.values(NETWORK_OPERATOR_CONFIG).find((op) => op.mobileNumberPrefixes.includes(prefix));
+            if (!operator)
                 return;
             return new PhoneNumber(compactNumber);
         }
@@ -164,7 +165,7 @@ export class PhoneNumber {
      * Validates:
      * - Has required compactNumber property
      * - compactNumber is a 9-digit string
-     * - Prefix matches a valid telecom provider
+     * - Prefix matches a valid network operator
      */
     static is(obj) {
         if (!obj || typeof obj !== "object")

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@temboplus/frontend-core",
-  "version": "0.1.0",
-  "description": "A JavaScript/TypeScript package providing common utilities and logic shared across all front-end TemboPlus projects.",
+  "version": "0.2.0",
+  "description": "A JavaScript/TypeScript package providing common utilities and logic shared across front-end TemboPlus projects.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TemboPlus-Frontend/frontend-core-js.git"

package/script/src/models/amount/amount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../../../src/src/models/amount/amount.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,YAAY,QAA2C,CAAC;AAE9D,cAAM,MAAM;IACV,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAE9B,OAAO;IAKP;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IA2BvD;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAKlC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAS5D;;;;;;;;;;;;;;;OAeG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAsB7C;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B;AAuGD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../../../src/src/models/amount/amount.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,YAAY,QAA2C,CAAC;AAE9D,cAAM,MAAM;IACV,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAE9B,OAAO;IAKP;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IA0BvD;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAKlC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAS5D;;;;;;;;;;;;;;;OAeG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAsB7C;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B;AAuGD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC"}

package/script/src/models/amount/amount.js

@@ -31,7 +31,6 @@ class Amount {
      */
     static from(input) {
         let amountText = input.toString().trim();
-        console.log(amountText);
         if (hasComma(amountText)) {
             if (!hasValidCommaPlacement(amountText))
                 return undefined;

package/script/src/models/phone_number/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./antd_validator.js";
 export * from "./phone_number.js";
-export * from "./telecom.js";
+export * from "./network_operator.js";
 //# sourceMappingURL=index.d.ts.map

package/script/src/models/phone_number/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC"}

package/script/src/models/phone_number/index.js

@@ -16,4 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./antd_validator.js"), exports);
 __exportStar(require("./phone_number.js"), exports);
-__exportStar(require("./telecom.js"), exports);
+__exportStar(require("./network_operator.js"), exports);

package/script/src/models/phone_number/network_operator.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Represents available mobile network operators in Tanzania
+ * @enum {string}
+ */
+export declare enum NetworkOperator {
+    VODACOM = "Vodacom",
+    AIRTEL = "Airtel",
+    TIGO = "Tigo",
+    HALOTEL = "Halotel"
+}
+/**
+ * Defines the structure for a mobile network operator's information
+ */
+export interface NetworkOperatorInfo {
+    /** Unique identifier for the network operator */
+    id: NetworkOperator;
+    /** List of mobile number prefixes assigned to this operator */
+    mobileNumberPrefixes: string[];
+    /** Display name of the network operator */
+    displayName: string;
+    /** Mobile money service name offered by the operator */
+    mobileMoneyService: string;
+    /** Brand color associated with the operator */
+    brandColor: string;
+}
+/**
+ * Comprehensive information about mobile network operators and their services
+ */
+export declare const NETWORK_OPERATOR_CONFIG: Record<NetworkOperator, NetworkOperatorInfo>;
+//# sourceMappingURL=network_operator.d.ts.map

package/script/src/models/phone_number/network_operator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network_operator.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/network_operator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iDAAiD;IACjD,EAAE,EAAE,eAAe,CAAC;IAEpB,+DAA+D;IAC/D,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAE/B,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IAEpB,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,CAAC;IAE3B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAC1C,eAAe,EACf,mBAAmB,CA8BpB,CAAC"}

package/script/src/models/phone_number/network_operator.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NETWORK_OPERATOR_CONFIG = exports.NetworkOperator = void 0;
+/**
+ * Represents available mobile network operators in Tanzania
+ * @enum {string}
+ */
+var NetworkOperator;
+(function (NetworkOperator) {
+    NetworkOperator["VODACOM"] = "Vodacom";
+    NetworkOperator["AIRTEL"] = "Airtel";
+    NetworkOperator["TIGO"] = "Tigo";
+    NetworkOperator["HALOTEL"] = "Halotel";
+})(NetworkOperator || (exports.NetworkOperator = NetworkOperator = {}));
+/**
+ * Comprehensive information about mobile network operators and their services
+ */
+exports.NETWORK_OPERATOR_CONFIG = {
+    [NetworkOperator.VODACOM]: {
+        id: NetworkOperator.VODACOM,
+        mobileNumberPrefixes: ["74", "75", "76"],
+        displayName: "Vodacom",
+        mobileMoneyService: "M-Pesa",
+        brandColor: "red",
+    },
+    [NetworkOperator.AIRTEL]: {
+        id: NetworkOperator.AIRTEL,
+        mobileNumberPrefixes: ["78", "79", "68", "69"],
+        displayName: "Airtel",
+        mobileMoneyService: "Airtel Money",
+        brandColor: "volcano",
+    },
+    [NetworkOperator.TIGO]: {
+        id: NetworkOperator.TIGO,
+        mobileNumberPrefixes: ["71", "65", "67", "77"],
+        displayName: "Yas",
+        mobileMoneyService: "Mixx",
+        brandColor: "blue",
+    },
+    [NetworkOperator.HALOTEL]: {
+        id: NetworkOperator.HALOTEL,
+        mobileNumberPrefixes: ["62", "61"],
+        displayName: "Halotel",
+        mobileMoneyService: "HaloPesa",
+        brandColor: "orange",
+    },
+};

package/script/src/models/phone_number/phone_number.d.ts

@@ -14,22 +14,23 @@
  *
  * 2. Valid numbers must:
  *    - Have exactly 9 digits after removing prefixes
- *    - Start with a valid telecom provider prefix
+ *    - Start with a valid network operator prefix
  *    - Contain only numeric characters
  *
- * 3. Each telecom provider has specific prefixes:
+ * 3. Each network operator has specific prefixes:
  *    - Vodacom: 71, 74, 75, etc.
  *    - Airtel: 68, 69, etc.
  *    - Tigo: 65, 67, etc.
+ *    - Halotel: 62, etc.
  *
  * ## Solution
  * The PhoneNumber 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. Telecom provider identification
+ * 4. Network operator identification
  */
-import { type Telecom } from "./telecom.js";
+import { type NetworkOperatorInfo } from "./network_operator.js";
 /**
  * Enumeration for various mobile number formats.
  * @enum {string}
@@ -68,11 +69,11 @@ export declare class PhoneNumber {
      */
     get label(): string;
     /**
-     * Derives the telecom details associated with the phone number by checking its prefix.
+     * Derives the network operator information associated with the phone number by checking its prefix.
      *
-     * @returns The `Telecom` object that matches the phone number prefix.
+     * @returns The `NetworkOperatorInfo` object that matches the phone number prefix.
      */
-    get telecom(): Telecom;
+    get networkOperator(): NetworkOperatorInfo;
     /**
      * Creates a `PhoneNumber` instance from a given string.
      *
@@ -105,7 +106,7 @@ export declare class PhoneNumber {
      * Validates:
      * - Has required compactNumber property
      * - compactNumber is a 9-digit string
-     * - Prefix matches a valid telecom provider
+     * - Prefix matches a valid network operator
      */
     static is(obj: unknown): obj is PhoneNumber;
     /**

package/script/src/models/phone_number/phone_number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"phone_number.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/phone_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,EAAE,KAAK,OAAO,EAAkB,MAAM,cAAc,CAAC;AAE5D;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,IAAI,QAAQ,CAAE,mCAAmC;IACjD,KAAK,SAAS,CAAE,oCAAoC;IACpD,EAAE,MAAM,CAAE,iCAAiC;IAC3C,IAAI,KAAK;CACV;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBACS,aAAa,EAAE,MAAM;IAIjC;;;;;OAKG;IACH,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAIvD;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAMrB;IAED;;;;;OAKG;WACW,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAqCtD;;;;;OAKG;WACW,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAW1D;;;;;;;;;;;;;;;;;;;OAmBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW;IAYlD;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B"}
+{"version":3,"file":"phone_number.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/phone_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,IAAI,QAAQ,CAAE,mCAAmC;IACjD,KAAK,SAAS,CAAE,oCAAoC;IACpD,EAAE,MAAM,CAAE,iCAAiC;IAC3C,IAAI,KAAK;CACV;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBACS,aAAa,EAAE,MAAM;IAIjC;;;;;OAKG;IACH,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAIvD;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,mBAAmB,CAMzC;IAED;;;;;OAKG;WACW,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAqCtD;;;;;OAKG;WACW,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAW1D;;;;;;;;;;;;;;;;;;;OAmBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW;IAYlD;;;OAGG;IACI,QAAQ,IAAI,OAAO;CAO3B"}

package/script/src/models/phone_number/phone_number.js

@@ -15,24 +15,25 @@
  *
  * 2. Valid numbers must:
  *    - Have exactly 9 digits after removing prefixes
- *    - Start with a valid telecom provider prefix
+ *    - Start with a valid network operator prefix
  *    - Contain only numeric characters
  *
- * 3. Each telecom provider has specific prefixes:
+ * 3. Each network operator has specific prefixes:
  *    - Vodacom: 71, 74, 75, etc.
  *    - Airtel: 68, 69, etc.
  *    - Tigo: 65, 67, etc.
+ *    - Halotel: 62, etc.
  *
  * ## Solution
  * The PhoneNumber 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. Telecom provider identification
+ * 4. Network operator identification
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PhoneNumber = exports.MobileNumberFormat = void 0;
-const telecom_js_1 = require("./telecom.js");
+const network_operator_js_1 = require("./network_operator.js");
 /**
  * Enumeration for various mobile number formats.
  * @enum {string}
@@ -83,13 +84,13 @@ class PhoneNumber {
         return this.getNumberWithFormat(MobileNumberFormat.s255);
     }
     /**
-     * Derives the telecom details associated with the phone number by checking its prefix.
+     * Derives the network operator information associated with the phone number by checking its prefix.
      *
-     * @returns The `Telecom` object that matches the phone number prefix.
+     * @returns The `NetworkOperatorInfo` object that matches the phone number prefix.
      */
-    get telecom() {
-        const id = this.compactNumber.substring(0, 2);
-        const result = Object.values(telecom_js_1.telecomDetails).find((e) => e.prefixes.includes(id));
+    get networkOperator() {
+        const prefix = this.compactNumber.substring(0, 2);
+        const result = Object.values(network_operator_js_1.NETWORK_OPERATOR_CONFIG).find((operator) => operator.mobileNumberPrefixes.includes(prefix));
         return result;
     }
     /**
@@ -123,10 +124,10 @@ class PhoneNumber {
             // Validate that the compact number length is correct.
             if (compactNumber.length !== 9)
                 return;
-            // Check if the compact number matches any telecom provider prefix.
-            const id = compactNumber.substring(0, 2);
-            const telecom = Object.values(telecom_js_1.telecomDetails).find((e) => e.prefixes.includes(id));
-            if (!telecom)
+            // Check if the compact number matches any network operator prefix.
+            const prefix = compactNumber.substring(0, 2);
+            const operator = Object.values(network_operator_js_1.NETWORK_OPERATOR_CONFIG).find((op) => op.mobileNumberPrefixes.includes(prefix));
+            if (!operator)
                 return;
             return new PhoneNumber(compactNumber);
         }
@@ -167,7 +168,7 @@ class PhoneNumber {
      * Validates:
      * - Has required compactNumber property
      * - compactNumber is a 9-digit string
-     * - Prefix matches a valid telecom provider
+     * - Prefix matches a valid network operator
      */
     static is(obj) {
         if (!obj || typeof obj !== "object")

package/esm/src/models/phone_number/telecom.d.ts

@@ -1,25 +0,0 @@
-/**
- * Enumeration for telecom identifiers.
- * @enum {string}
- */
-export declare enum TelecomID {
-    vodacom = "vodacom",
-    airtel = "airtel",
-    tigo = "tigo",
-    halotel = "halotel"
-}
-/**
- * Interface representing a telecom provider.
- */
-export interface Telecom {
-    id: TelecomID;
-    prefixes: string[];
-    label: string;
-    company: string;
-    color: string;
-}
-/**
- * Details for each telecom provider including prefixes and branding information.
- */
-export declare const telecomDetails: Record<TelecomID, Telecom>;
-//# sourceMappingURL=telecom.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"telecom.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/telecom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,SAAS;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,SAAS,CAAC;IACd,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CA6BrD,CAAC"}

package/esm/src/models/phone_number/telecom.js

@@ -1,44 +0,0 @@
-/**
- * Enumeration for telecom identifiers.
- * @enum {string}
- */
-export var TelecomID;
-(function (TelecomID) {
-    TelecomID["vodacom"] = "vodacom";
-    TelecomID["airtel"] = "airtel";
-    TelecomID["tigo"] = "tigo";
-    TelecomID["halotel"] = "halotel";
-})(TelecomID || (TelecomID = {}));
-/**
- * Details for each telecom provider including prefixes and branding information.
- */
-export const telecomDetails = {
-    vodacom: {
-        id: TelecomID.vodacom,
-        prefixes: ["74", "75", "76"],
-        label: "Vodacom",
-        company: "M-Pesa",
-        color: "red",
-    },
-    airtel: {
-        id: TelecomID.airtel,
-        prefixes: ["78", "79", "68", "69"],
-        label: "Airtel",
-        company: "Airtel-Money",
-        color: "volcano",
-    },
-    tigo: {
-        id: TelecomID.tigo,
-        prefixes: ["71", "65", "67", "77"],
-        label: "Tigo",
-        company: "Tigo-Pesa",
-        color: "blue",
-    },
-    halotel: {
-        id: TelecomID.halotel,
-        prefixes: ["62", "61"],
-        label: "Halotel",
-        company: "Halo-Pesa",
-        color: "orange",
-    },
-};

package/script/src/models/phone_number/telecom.d.ts

@@ -1,25 +0,0 @@
-/**
- * Enumeration for telecom identifiers.
- * @enum {string}
- */
-export declare enum TelecomID {
-    vodacom = "vodacom",
-    airtel = "airtel",
-    tigo = "tigo",
-    halotel = "halotel"
-}
-/**
- * Interface representing a telecom provider.
- */
-export interface Telecom {
-    id: TelecomID;
-    prefixes: string[];
-    label: string;
-    company: string;
-    color: string;
-}
-/**
- * Details for each telecom provider including prefixes and branding information.
- */
-export declare const telecomDetails: Record<TelecomID, Telecom>;
-//# sourceMappingURL=telecom.d.ts.map

package/script/src/models/phone_number/telecom.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"telecom.d.ts","sourceRoot":"","sources":["../../../../src/src/models/phone_number/telecom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,SAAS;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,SAAS,CAAC;IACd,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CA6BrD,CAAC"}

package/script/src/models/phone_number/telecom.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.telecomDetails = exports.TelecomID = void 0;
-/**
- * Enumeration for telecom identifiers.
- * @enum {string}
- */
-var TelecomID;
-(function (TelecomID) {
-    TelecomID["vodacom"] = "vodacom";
-    TelecomID["airtel"] = "airtel";
-    TelecomID["tigo"] = "tigo";
-    TelecomID["halotel"] = "halotel";
-})(TelecomID || (exports.TelecomID = TelecomID = {}));
-/**
- * Details for each telecom provider including prefixes and branding information.
- */
-exports.telecomDetails = {
-    vodacom: {
-        id: TelecomID.vodacom,
-        prefixes: ["74", "75", "76"],
-        label: "Vodacom",
-        company: "M-Pesa",
-        color: "red",
-    },
-    airtel: {
-        id: TelecomID.airtel,
-        prefixes: ["78", "79", "68", "69"],
-        label: "Airtel",
-        company: "Airtel-Money",
-        color: "volcano",
-    },
-    tigo: {
-        id: TelecomID.tigo,
-        prefixes: ["71", "65", "67", "77"],
-        label: "Tigo",
-        company: "Tigo-Pesa",
-        color: "blue",
-    },
-    halotel: {
-        id: TelecomID.halotel,
-        prefixes: ["62", "61"],
-        label: "Halotel",
-        company: "Halo-Pesa",
-        color: "orange",
-    },
-};