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

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

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/frontend-core",
-  "version": "0.2.19",
+  "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",