@temboplus/frontend-core 0.2.17 → 0.2.20-beta.0

package/dist/models/amount/amount.d.ts

@@ -1,4 +1,4 @@
-import { CurrencyCode } from "../../models/currency";
+import { CurrencyCode } from "../currency/index.js";
 /**
  * Regular expression for validating amount strings
  * Supports both positive and negative amounts with optional comma separators and decimals

package/dist/models/amount/index.d.ts

@@ -1 +1 @@
-export * from "./amount";
+export * from "./amount.js";

package/dist/models/bank/bank.d.ts

@@ -1,5 +1,5 @@
-import { ISO2CountryCode } from "../country/country.types";
-import type { BankSwiftCode, KEBankSwiftCode, TZBankSwiftCode } from "./bank.types";
+import { ISO2CountryCode } from "../country/country.types.js";
+import type { BankSwiftCode, KEBankSwiftCode, TZBankSwiftCode } from "./bank.types.js";
 export declare class Bank {
     /**
      * The full registered name of the bank.
@@ -32,6 +32,80 @@ export declare class Bank {
      */
     toString(): string;
     static from(swiftCode: BankSwiftCode, countryCode: ISO2CountryCode): Bank;
+    /**
+     * Creates a Bank instance from a JSON string.
+     *
+     * The JSON should contain swiftCode and countryCode fields.
+     * The bank data is then looked up from the bank service to ensure validity.
+     *
+     * @static
+     * @param {string} jsonString - JSON string containing bank data
+     * @returns {Bank | undefined} A new Bank instance if successful, undefined if parsing fails
+     *
+     * @example
+     * ```typescript
+     * const jsonString = '{"swiftCode":"CORUTZTZ","countryCode":"TZ"}';
+     * const bank = Bank.fromJSON(jsonString);
+     * if (bank) {
+     *   console.log(bank.fullName); // "CRDB BANK PLC"
+     * }
+     *
+     * // Also works with full bank data
+     * const fullJson = '{"fullName":"CRDB BANK PLC","shortName":"CRDB","swiftCode":"CORUTZTZ","countryCode":"TZ"}';
+     * const bank2 = Bank.fromJSON(fullJson);
+     * ```
+     */
+    static fromJSON(jsonString: string): Bank | undefined;
+    /**
+     * Converts the Bank instance to a plain JavaScript object.
+     * Suitable for serialization or data transfer.
+     *
+     * @returns {Object} Plain object representation of the bank
+     * @returns {string} returns.fullName - The full registered name of the bank
+     * @returns {string} returns.shortName - The commonly used short name
+     * @returns {string} returns.swiftCode - The SWIFT/BIC code
+     * @returns {ISO2CountryCode} returns.countryCode - The ISO 3166-1 alpha-2 country code
+     *
+     * @example
+     * ```typescript
+     * const bank = Bank.from("CORUTZTZ", "TZ");
+     * const obj = bank.toObject();
+     * console.log(obj);
+     * // {
+     * //   fullName: "CRDB BANK PLC",
+     * //   shortName: "CRDB",
+     * //   swiftCode: "CORUTZTZ",
+     * //   countryCode: "TZ"
+     * // }
+     * ```
+     */
+    toObject(): {
+        fullName: string;
+        shortName: string;
+        swiftCode: TZBankSwiftCode | KEBankSwiftCode;
+        countryCode: ISO2CountryCode;
+    };
+    /**
+     * Serializes the Bank instance to a JSON string.
+     *
+     * @returns {string} JSON string representation of the bank
+     *
+     * @example
+     * ```typescript
+     * const bank = Bank.from("CORUTZTZ", "TZ");
+     * const jsonString = bank.toJSON();
+     * console.log(jsonString);
+     * // '{"fullName":"CRDB BANK PLC","shortName":"CRDB","swiftCode":"CORUTZTZ","countryCode":"TZ"}'
+     *
+     * // Store or transmit
+     * localStorage.setItem('selectedBank', jsonString);
+     *
+     * // Later, retrieve and reconstruct
+     * const stored = localStorage.getItem('selectedBank');
+     * const reconstructed = Bank.fromJSON(stored);
+     * ```
+     */
+    toJSON(): string;
     /**
      * Static method to determine if an unknown object is a valid Bank object.
      *

package/dist/models/bank/bank.validation.d.ts

@@ -1,5 +1,5 @@
-import { ISO2CountryCode } from "../country";
-import { BankSwiftCode } from "./bank.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { BankSwiftCode } from "./bank.types.js";
 export declare const BankValidation: {
     /**
      * Validates a bank account number format for a specific country.

package/dist/models/bank/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./bank";
-export * from "./bank.types";
-export * from "./bank.validation";
-export * from "./bank.schema";
+export * from "./bank.js";
+export * from "./bank.types.js";
+export * from "./bank.validation.js";
+export * from "./bank.schema.js";

package/dist/models/country/country.d.ts

@@ -24,9 +24,9 @@
  * The addition of currency support through the getCurrency() method leverages
  * the Currency model while maintaining a clean separation of concerns.
  */
-import { Currency } from "../../models/currency";
-import type { CurrencyCode } from "../../models/currency";
-import type { CountryCode, ISO2CountryCode, ISO3CountryCode } from "./country.types";
+import { Currency } from "@models/currency/currency.js";
+import { CurrencyCode } from "@models/currency/currency.types.js";
+import { ISO2CountryCode, ISO3CountryCode, CountryCode } from "./country.types.js";
 /**
  * Enum for continents
  */

package/dist/models/country/country.validation.d.ts

@@ -1,5 +1,4 @@
-import { type ISO2CountryCode, type ISO3CountryCode } from "./country.types";
-import type { CountryCode } from "..";
+import { ISO2CountryCode, ISO3CountryCode, CountryCode } from "./country.types.js";
 export declare const CountryValidation: {
     isISO2CountryCode: typeof isISO2CountryCode;
     isISO3CountryCode: typeof isISO3CountryCode;

package/dist/models/country/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./country";
-export * from "./country.types";
-export * from "./country.validation";
-export * from "./country.schema";
+export * from "./country.js";
+export * from "./country.types.js";
+export * from "./country.validation.js";
+export * from "./country.schema.js";

package/dist/models/currency/currency.d.ts

@@ -26,7 +26,7 @@
  * This approach follows the principle that closely related classes with circular
  * dependencies are best managed in a unified module.
  */
-import type { CurrencyCode } from "./currency.types";
+import type { CurrencyCode } from "./currency.types.js";
 /**
  * Represents a currency with essential details.
  * @class Currency

package/dist/models/currency/currency.validation.d.ts

@@ -1,4 +1,4 @@
-import { type CurrencyCode } from "./currency.types";
+import { type CurrencyCode } from "./currency.types.js";
 export declare const CurrencyValidation: {
     isCurrencyCode: typeof isCurrencyCode;
 };

package/dist/models/currency/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./currency";
-export * from "./currency.types";
-export * from "./currency.validation";
-export * from "./currency.schema";
+export * from "./currency.js";
+export * from "./currency.types.js";
+export * from "./currency.validation.js";
+export * from "./currency.schema.js";

package/dist/models/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./amount/index";
-export * from "./bank/index";
-export * from "./phone-number/index";
-export * from "./country/index";
-export * from "./currency/index";
+export * from "./amount/index.js";
+export * from "./bank/index.js";
+export * from "./phone-number/index.js";
+export * from "./country/index.js";
+export * from "./currency/index.js";

package/dist/models/phone-number/index.d.ts

@@ -1,6 +1,6 @@
-export * from "./phone-number.factory";
-export * from "./phone-number.types";
-export * from "./mno/mno.utils";
-export * from "./mno/mno.types";
-export * from "./phone-number";
-export * from "./mno";
+export * from "./phone-number.factory.js";
+export * from "./phone-number.types.js";
+export * from "./mno/mno.utils.js";
+export * from "./mno/mno.types.js";
+export * from "./phone-number.js";
+export * from "./mno/index.js";

package/dist/models/phone-number/mno/index.d.ts

@@ -1,6 +1,6 @@
-export * from "./ke/mobile-number.ke";
-export * from "./ke/mobile-number.ke-mnos";
-export * from "./tz/mobile-number.tz";
-export * from "./tz/mobile-number.tz-mnos";
-export * from "./mno.types";
-export * from "./mno.utils";
+export * from "./ke/mobile-number.ke.js";
+export * from "./ke/mobile-number.ke-mnos.js";
+export * from "./tz/mobile-number.tz.js";
+export * from "./tz/mobile-number.tz-mnos.js";
+export * from "./mno.types.js";
+export * from "./mno.utils.js";

package/dist/models/phone-number/mno/ke/mobile-number.ke-mnos.d.ts

@@ -1,5 +1,5 @@
-import { ISO2CountryCode } from "../../../country/country.types";
-import { CountryMNOImplementation, KEMNOId, MNOInfo } from "../mno.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { CountryMNOImplementation, KEMNOId, MNOInfo } from "@models/phone-number/mno/mno.types.js";
 /**
  * Configuration object for Kenyan mobile network operators.
  * Conforms to the generic MNOInfo interface.

package/dist/models/phone-number/mno/ke/mobile-number.ke.d.ts

@@ -1,8 +1,8 @@
-import { ISO2CountryCode } from "../../../country";
-import { MNOInfo } from "../mno.types";
-import { PhoneNumber } from "../../phone-number";
-import { type ParsedPhoneNumber, PhoneNumberService } from "../../phone-number.service";
-import { type PhoneNumberContract, type PhoneNumberParseOptions, PhoneNumberType } from "../../phone-number.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { MNOInfo } from "@models/phone-number/mno/mno.types.js";
+import { PhoneNumber } from "@models/phone-number/phone-number.js";
+import { type ParsedPhoneNumber, PhoneNumberService } from "@models/phone-number/phone-number.service.js";
+import { type PhoneNumberContract, type PhoneNumberParseOptions, PhoneNumberType } from "@models/phone-number/phone-number.types.js";
 /**
  * Represents a validated Kenyan (KE) **mobile** phone number.
  * Extends the generic PhoneNumber class and implements the common PhoneNumberContract interface.

package/dist/models/phone-number/mno/mno.types.d.ts

@@ -2,7 +2,7 @@
  * Tanzanian mobile network operator identifiers.
  * Values are used in payout channel-code field and should not change.
  */
-import { ISO2CountryCode } from "../../country/country.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
 export declare enum TZMNOId {
     VODACOM = "VODACOM",
     AIRTEL = "AIRTEL",

package/dist/models/phone-number/mno/mno.utils.d.ts

@@ -1,5 +1,5 @@
-import { CountryCode, ISO2CountryCode } from "../../country";
-import { CountryMNOImplementation, MNOInfo } from "./mno.types";
+import { CountryCode, ISO2CountryCode } from "@models/country/country.types.js";
+import { CountryMNOImplementation, MNOInfo } from "./mno.types.js";
 /**
  * Utility functions for working with MNO data across countries.
  */

package/dist/models/phone-number/mno/tz/mobile-number.tz-mnos.d.ts

@@ -1,5 +1,5 @@
-import { ISO2CountryCode } from "../../../country";
-import { CountryMNOImplementation, MNOInfo, TZMNOId } from "../mno.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { CountryMNOImplementation, MNOInfo, TZMNOId } from "@models/phone-number/mno/mno.types.js";
 /**
  * Configuration object for Tanzanian mobile network operators.
  * Conforms to the generic NetworkOperatorInfo interface.

package/dist/models/phone-number/mno/tz/mobile-number.tz.d.ts

@@ -1,8 +1,8 @@
-import { PhoneNumber } from "../../phone-number";
-import { type ParsedPhoneNumber, PhoneNumberService } from "../../phone-number.service";
-import { type PhoneNumberContract, type PhoneNumberParseOptions, PhoneNumberType } from "../../phone-number.types";
-import { ISO2CountryCode } from "../../../country";
-import { MNOInfo } from "../mno.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { MNOInfo } from "@models/phone-number/mno/mno.types.js";
+import { PhoneNumber } from "@models/phone-number/phone-number.js";
+import { type ParsedPhoneNumber, PhoneNumberService } from "@models/phone-number/phone-number.service.js";
+import { type PhoneNumberContract, type PhoneNumberParseOptions, PhoneNumberType } from "@models/phone-number/phone-number.types.js";
 /**
  * Represents a validated Tanzanian (TZ) **mobile** phone number.
  * Extends the generic PhoneNumber class and provides TZ-specific behavior.

package/dist/models/phone-number/phone-number.d.ts

@@ -1,8 +1,8 @@
-import { type ParsedPhoneNumber, PhoneNumberService } from "./phone-number.service";
-import { PhoneNumberContract, PhoneNumberFormat, PhoneNumberParseOptions, PhoneNumberType } from "./phone-number.types";
-import type { ISO2CountryCode } from "../country/country.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
 import type { PhoneNumber as LibPhoneNumberInstance } from "libphonenumber-js";
-import { MNOInfo } from "./mno";
+import { MNOInfo } from "./mno/mno.types.js";
+import { PhoneNumberService, ParsedPhoneNumber } from "./phone-number.service.js";
+import { PhoneNumberContract, PhoneNumberFormat, PhoneNumberType, PhoneNumberParseOptions } from "./phone-number.types.js";
 /**
  * Represents a generic international phone number, validated using libphonenumber-js
  * via the PhoneNumberService. Implements the common PhoneNumberContract interface.

package/dist/models/phone-number/phone-number.factory.d.ts

@@ -1,5 +1,5 @@
-import { type PhoneNumberContract, type PhoneNumberParseOptions } from "./phone-number.types";
-import { MNOInfo } from "./mno";
+import { MNOInfo } from "./mno/mno.types.js";
+import { PhoneNumberParseOptions, PhoneNumberContract } from "./phone-number.types.js";
 /**
  * Factory class for creating phone number objects that conform to PhoneNumberContract.
  * It attempts to use country-specific implementations (like TZMobileNumber, KEMobileNumber)

package/dist/models/phone-number/phone-number.service.d.ts

@@ -1,6 +1,6 @@
 import { type NumberType, type PhoneNumber as LibPhoneNumber } from "libphonenumber-js/max";
-import type { ISO2CountryCode } from "../country";
-import { PhoneNumberFormat } from "./phone-number.types";
+import { PhoneNumberFormat } from "./phone-number.types.js";
+import { ISO2CountryCode } from "@models/country/country.types.js";
 export interface ParsedPhoneNumber {
     libInstance: LibPhoneNumber;
     countryCode: ISO2CountryCode | undefined;

package/dist/models/phone-number/phone-number.types.d.ts

@@ -1,5 +1,5 @@
-import type { ISO2CountryCode } from "../country";
-import { MNOInfo } from "./mno/mno.types";
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { MNOInfo } from "./mno/mno.types.js";
 /**
  * Enumeration for various phone number formats used for display and processing.
  */

package/dist/models/phone-number/phone-number.utils.d.ts

@@ -1,5 +1,5 @@
-import { CountryCode } from "../country";
-export declare const phoneLogger: import("pino").default.Logger<never, boolean>;
+import { CountryCode } from "@models/country/country.types.js";
+export declare const phoneLogger: import("pino").Logger<never, boolean>;
 export declare const PhoneNumberUtils: {
     /**
      * Removes all whitespace characters from the given string.

package/dist/reports/index.d.ts

@@ -1 +1 @@
-export * from "./report-manager";
+export * from "./report-manager.js";

package/dist/services/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./config";
-export * from "./logger";
+export * from "./config.js";
+export * from "./logger.js";

package/dist/services/logger.d.ts

@@ -1 +1,2 @@
-export declare const logger: import("pino").Logger<never, boolean>;
+import pino from "pino";
+export declare const logger: pino.Logger<never, boolean>;

package/dist/utils/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./id";
-export * from "./time";
-export * from "./text";
+export * from "./id.js";
+export * from "./time.js";
+export * from "./text.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/frontend-core",
-  "version": "0.2.17",
+  "version": "0.2.20-beta.0",
   "description": "A JavaScript/TypeScript package providing common utilities and logic shared across front-end TemboPlus projects.",
   "author": "Okello Gerald",
   "license": "MIT",
@@ -9,10 +9,13 @@
     "frontend-core"
   ],
   "type": "module",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js",
       "types": "./dist/index.d.ts"
     }
   },
@@ -23,14 +26,7 @@
     "build": "rollup -c rollup.config.js --configTsconfig tsconfig.build.json",
     "prepare": "npm run build",
     "dev": "npm run build -- --watch",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "test:amount": "jest /src/models/amount/__tests__/amount.test.ts",
-    "test:phone-number": "jest /src/models/phone-number",
-    "test:bank": "jest /src/models/bank/__tests__/bank.test.ts",
-    "test:country": "jest /src/models/country/__tests__/country.test.ts",
-    "test:currency": "jest /src/models/currency/__tests__/currency.test.ts"
+    "test": "vitest"
   },
   "repository": {
     "type": "git",
@@ -43,7 +39,7 @@
   "dependencies": {
     "file-saver": "^2.0.5",
     "libphonenumber-js": "^1.12.6",
-    "pino": "^9.7.0",
+    "pino": "^9.13.1",
     "tslib": "^2.8.1",
     "uuid": "^11.1.0",
     "zod": "^3.24.2"
@@ -56,12 +52,10 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/file-saver": "^2.0.7",
-    "@types/jest": "^29.5.14",
-    "jest": "^29.7.0",
-    "pino-pretty": "^13.0.0",
+    "pino-pretty": "^13.1.1",
     "rollup": "^4.39.0",
-    "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
   }
 }