@temboplus/frontend-core 0.2.20-beta.3 → 0.2.20-beta.5

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

@@ -23,6 +23,11 @@ export declare class Bank {
      * The ISO 3166-1 alpha-2 country code (e.g., 'TZ', 'KE').
      */
     readonly countryCode: ISO2CountryCode;
+    /**
+     * Optional list of former names the bank was known by.
+     * Useful for historical reference and search functionality.
+     */
+    readonly formerNames?: string[];
     /**
      * Creates a new Bank instance.
      *
@@ -30,8 +35,19 @@ export declare class Bank {
      * @param shortName The commonly used short name or abbreviation for the bank
      * @param swiftCode The SWIFT/BIC code for the bank's head office
      * @param countryCode The ISO 3166-1 alpha-2 country code
+     * @param formerNames Optional list of former names the bank was known by
+     */
+    constructor(fullName: string, shortName: string, swiftCode: TZBankSwiftCode | KEBankSwiftCode, countryCode: ISO2CountryCode, formerNames?: string[]);
+    /**
+     * Checks if this bank has any former names recorded.
+     * @returns True if the bank has at least one former name, false otherwise.
      */
-    constructor(fullName: string, shortName: string, swiftCode: TZBankSwiftCode | KEBankSwiftCode, countryCode: ISO2CountryCode);
+    hasFormerNames(): boolean;
+    /**
+     * Gets a display string showing the current name with former names in parentheses.
+     * @returns A formatted string, e.g., "Access Bank Tanzania Limited (formerly BancABC)"
+     */
+    getDisplayNameWithHistory(): string;
     /**
      * Returns a string representation of the bank.
      * @returns A formatted string, e.g., "CRDB BANK PLC (CRDB) - SWIFT: CORUTZTZ [TZ]"
@@ -47,17 +63,19 @@ export declare class 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
+     * @returns {string[] | undefined} returns.formerNames - Optional list of former names
      *
      * @example
      * ```typescript
-     * const bank = Bank.from("CORUTZTZ", "TZ");
+     * const bank = Bank.from("FMBZTZTX", "TZ");
      * const obj = bank.toObject();
      * console.log(obj);
      * // {
-     * //   fullName: "CRDB BANK PLC",
-     * //   shortName: "CRDB",
-     * //   swiftCode: "CORUTZTZ",
-     * //   countryCode: "TZ"
+     * //   fullName: "Access Bank Tanzania Limited",
+     * //   shortName: "ABT",
+     * //   swiftCode: "FMBZTZTX",
+     * //   countryCode: "TZ",
+     * //   formerNames: ["BancABC"]
      * // }
      * ```
      */
@@ -66,6 +84,7 @@ export declare class Bank {
         shortName: string;
         swiftCode: TZBankSwiftCode | KEBankSwiftCode;
         countryCode: ISO2CountryCode;
+        formerNames?: string[];
     };
     /**
      * Static method to determine if an unknown object is a valid Bank object.
@@ -78,8 +97,8 @@ export declare class Bank {
      */
     static is(obj: unknown): obj is Bank;
     /**
-   * Serializes the Bank instance to a JSON-compatible object
-   */
+     * Serializes the Bank instance to a JSON-compatible object
+     */
     toJSON(): BankJSON;
     /**
      * Serializes the Bank instance to a JSON string
@@ -142,7 +161,6 @@ export declare class BankService {
     getAllBanks(countryCode: ISO2CountryCode): Bank[];
     /**
      * Retrieves all banks for all supported countries.
-     * @param countryCode The ISO country code.
      * @returns An array of Bank instances, or empty array.
      */
     getAllSupportedBanks(): Bank[];
@@ -151,11 +169,25 @@ export declare class BankService {
      */
     detectBank(swiftCode: string): Bank | undefined;
     /**
-     * Searches for banks within a specific country by name or SWIFT code.
+     * Searches for banks within a specific country by name, SWIFT code, or former names.
      * @param countryCode The ISO country code.
      * @param searchTerm The term to search for (case-insensitive).
      * @param limit Max number of results.
      * @returns An array of matching Bank instances.
      */
     searchBanks(countryCode: ISO2CountryCode, searchTerm: string, limit?: number): Bank[];
+    /**
+     * Searches for banks across all supported countries by name, SWIFT code, or former names.
+     * @param searchTerm The term to search for (case-insensitive).
+     * @param limit Max number of results.
+     * @returns An array of matching Bank instances from all supported countries.
+     */
+    searchAllBanks(searchTerm: string, limit?: number): Bank[];
+    /**
+     * Finds banks that were formerly known by a specific name.
+     * @param formerName The former name to search for (case-insensitive).
+     * @param countryCode Optional country code to limit the search.
+     * @returns An array of Bank instances that match the former name.
+     */
+    findByFormerName(formerName: string, countryCode?: ISO2CountryCode): Bank[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/frontend-core",
-  "version": "0.2.20-beta.3",
+  "version": "0.2.20-beta.5",
   "description": "A JavaScript/TypeScript package providing common utilities and logic shared across front-end TemboPlus projects.",
   "author": "Okello Gerald",
   "license": "MIT",