@temboplus/afloat 0.1.77-beta.9 → 0.1.78

package/script/npm/src/deps/jsr.io/@temboplus/frontend-core/0.2.21/src/models/bank/bank.d.ts

@@ -0,0 +1,257 @@
+/**
+ * @fileoverview This file contains both the Bank class and BankService class.
+ *
+ * ARCHITECTURE NOTE: Bank and BankService Classes
+ * ===============================================
+ *
+ * These two classes have been intentionally placed in the same file to follow
+ * the established domain model pattern used with Country and Currency classes.
+ *
+ * - Bank class: Defines bank properties and static accessors
+ * - BankService class: Loads bank data and provides instance methods
+ *
+ * Benefits of this approach:
+ * 1. Prevents circular dependencies between the classes
+ * 2. Ensures static properties are immediately available on import
+ * 3. Maintains a consistent architectural pattern across domain models
+ * 4. Encapsulates all bank-related functionality in a single module
+ *
+ * This implementation follows the "Smart Models, Dumb Services" pattern where
+ * the Bank class provides a rich public API through static methods that delegate
+ * to the internal BankService. Meanwhile, BankService handles data loading and
+ * indexing without being directly exposed to external code.
+ */
+/**
+ * Represents a bank with essential details.
+ * @class Bank
+ */
+export declare class Bank {
+    private readonly _fullName;
+    private readonly _shortName;
+    private readonly _swiftCode;
+    static readonly CRDB: Bank;
+    static readonly PBZ: Bank;
+    static readonly SCB: Bank;
+    static readonly STANBIC: Bank;
+    static readonly CITI: Bank;
+    static readonly BOA: Bank;
+    static readonly DTB: Bank;
+    static readonly AKIBA: Bank;
+    static readonly EXIM: Bank;
+    static readonly KILIMANJARO: Bank;
+    static readonly NBC: Bank;
+    static readonly NMB: Bank;
+    static readonly KCB: Bank;
+    static readonly HABIB: Bank;
+    static readonly ICB: Bank;
+    static readonly ABSA: Bank;
+    static readonly IMBANK: Bank;
+    static readonly NCBA: Bank;
+    static readonly DCB: Bank;
+    static readonly BARODA: Bank;
+    static readonly AZANIA: Bank;
+    static readonly UCHUMI: Bank;
+    static readonly BANCABC: Bank;
+    static readonly ACCESS: Bank;
+    static readonly BOI: Bank;
+    static readonly UBA: Bank;
+    static readonly MKOMBOZI: Bank;
+    static readonly ECOBANK: Bank;
+    static readonly MWANGA: Bank;
+    static readonly FNB: Bank;
+    static readonly AMANA: Bank;
+    static readonly EQUITY: Bank;
+    static readonly TCB: Bank;
+    static readonly MAENDELEO: Bank;
+    static readonly CANARA: Bank;
+    static readonly MWALIMU: Bank;
+    static readonly GT_BANK: Bank;
+    static readonly YETU: Bank;
+    static readonly DASHENG: Bank;
+    /**
+     * Creates a new Bank instance. Private constructor - only BankService can create instances.
+     * Clients should use static methods like Bank.from() or Bank.CRDB instead.
+     *
+     * @param {string} _fullName - The full name of the bank
+     * @param {string} _shortName - The short name or abbreviated name of the bank
+     * @param {string} _swiftCode - The SWIFT code associated with the bank
+     */
+    constructor(token: symbol, _fullName: string, _shortName: string, _swiftCode: string);
+    /**
+     * Gets the full name of the bank.
+     * @returns {string} The full name of the bank
+     */
+    get fullName(): string;
+    /**
+     * Gets the short name of the bank.
+     * @returns {string} The short name of the bank
+     */
+    get shortName(): string;
+    /**
+     * Gets the SWIFT code of the bank.
+     * @returns {string} The SWIFT code of the bank
+     */
+    get swiftCode(): string;
+    /**
+     * Creates a string representation of the bank.
+     * @returns {string} String representation of the bank
+     */
+    toString(): string;
+    /**
+     * Retrieves a bank by its SWIFT code.
+     * @param {string} swiftCode The SWIFT code of the bank.
+     * @returns {Bank | undefined} The bank corresponding to the SWIFT code or `undefined` if not found.
+     */
+    static fromSWIFTCode(swiftCode: string): Bank | undefined;
+    /**
+     * Retrieves a bank by its short or full name.
+     * @param {string} bankName The full name of the bank.
+     * @returns {Bank | undefined} The bank corresponding to the full name or `undefined` if not found.
+     */
+    static fromBankName(bankName: string): Bank | undefined;
+    /**
+     * Returns all available banks.
+     * @returns {Bank[]} Array of all banks
+     */
+    static getAll(): Bank[];
+    /**
+     * Validates if a given SWIFT/BIC (Bank Identifier Code) is valid
+     * @param swiftCode The SWIFT/BIC code to validate
+     * @returns True if the SWIFT code is valid
+     */
+    static isValidSwiftCode(swiftCode?: string | null): boolean;
+    /**
+     * Validates if a given bank name is valid
+     * @param bankName The bank name to validate
+     * @returns True if the bank name is valid
+     */
+    static isValidBankName(bankName?: string | null): boolean;
+    /**
+     * Checks the validity of the bank data
+     * @returns true if the bank information is available and valid
+     */
+    validate(): boolean;
+    /**
+     * Attempts to create a Bank instance from a bank name or SWIFT code
+     * @param input The bank name or SWIFT code
+     * @returns A Bank instance if valid input, undefined otherwise
+     */
+    static from(input: string): Bank | undefined;
+    /**
+     * Validates if the input can be used to construct a valid Bank instance
+     * @param input The bank name or SWIFT code to validate
+     * @returns True if input can construct a valid bank, false otherwise
+     */
+    static canConstruct(input?: string | null): boolean;
+    /**
+     * Checks if an unknown value is a Bank instance
+     * @param obj The value to validate
+     * @returns Type predicate indicating if the value is a valid Bank
+     */
+    static is(obj: unknown): obj is Bank;
+}
+/**
+ * Regex pattern to validate SWIFT codes.
+ * The SWIFT code must follow the format: XXXX XX XX XXX (optional last part for branches).
+ * @constant {RegExp}
+ */
+export declare const SWIFT_CODE_REGEX: RegExp;
+/**
+ * Service for managing bank data.
+ * @class BankService
+ */
+export declare class BankService {
+    private static instance;
+    private bankList;
+    private bankRecord;
+    private banksByName;
+    private banksByShortName;
+    private staticReferences;
+    private constructor();
+    /**
+     * Gets the singleton instance of BankService.
+     * Creates the instance if it doesn't exist.
+     * @static
+     * @returns {BankService} The singleton instance
+     */
+    static getInstance(): BankService;
+    /**
+     * Initializes the service with bank data.
+     * Should be called once when your application starts.
+     */
+    private initialize;
+    /**
+     * Gets all banks.
+     * @returns {Bank[]} Array of all banks
+     */
+    getAll(): Bank[];
+    /**
+     * Gets all banks as a record.
+     * @returns {Record<string, Bank>} Record of bank SWIFT codes and bank objects
+     */
+    getAllAsRecord(): Record<string, Bank>;
+    /**
+     * Gets static bank references to be used by the Bank class.
+     * @returns {Map<string, Bank>} Map of static references
+     */
+    getStaticReferences(): Map<string, Bank>;
+    /**
+     * Retrieves a bank by its SWIFT code.
+     * @param {string} swiftCode The SWIFT code of the bank.
+     * @returns {Bank | undefined} The bank corresponding to the SWIFT code or `undefined` if not found.
+     */
+    fromSWIFTCode(swiftCode: string): Bank | undefined;
+    /**
+     * Retrieves a bank by its name.
+     * @param {string} bankName The name of the bank.
+     * @returns {Bank | undefined} The bank corresponding to the name or `undefined` if not found.
+     */
+    fromBankName(bankName: string): Bank | undefined;
+    /**
+     * Validates if a given SWIFT/BIC (Bank Identifier Code) is valid.
+     * @param {string | null | undefined} swiftCode - The SWIFT/BIC code to validate.
+     * @returns {boolean} Returns true if the SWIFT code is valid, false otherwise.
+     */
+    isValidSwiftCode(swiftCode?: string | null): boolean;
+    /**
+     * Validates if a given bank name is valid.
+     * @param {string | null | undefined} bankName - The bank name to validate.
+     * @returns {boolean} Returns true if the bank name is valid, false otherwise.
+     */
+    isValidBankName(bankName?: string | null): boolean;
+    /**
+     * Searches for banks that match the given search term.
+     * @param {string} searchTerm - The partial name or SWIFT code to search for.
+     * @param {number} [limit=10] - Maximum number of results to return.
+     * @returns {Bank[]} Array of matching banks, limited to specified count.
+     */
+    search(searchTerm: string, limit?: number): Bank[];
+    /**
+     * Compares two Bank instances for equality by checking their full name, short name, and SWIFT code
+     *
+     * @param {Bank} bank1 - First bank to compare
+     * @param {Bank} bank2 - Second bank to compare
+     * @returns {boolean} True if banks are equal, false otherwise
+     * @private
+     */
+    compare(bank1: Bank, bank2: Bank): boolean;
+    /**
+     * Retrieves all SWIFT codes from the TZ_BANKS list.
+     * @returns {string[]} A list of all SWIFT codes in uppercase.
+     */
+    getAllSwiftCodes(): string[];
+    /**
+     * Checks whether a given SWIFT code is in the correct format.
+     * @param {string} swiftCode The SWIFT code to check.
+     * @returns {boolean} `true` if the SWIFT code matches the expected format; `false` otherwise.
+     */
+    isValidSwiftCodeFormat(swiftCode: string): boolean;
+    /**
+     * Validates whether a given SWIFT code is correct.
+     * It checks both the SWIFT code format and if the SWIFT code exists in the list of valid codes.
+     * @param {string} [swiftCode] The SWIFT code to validate.
+     * @returns {boolean} `true` if valid, otherwise `false`.
+     */
+    validateSWIFTCode: (swiftCode?: string) => boolean;
+}
+//# sourceMappingURL=bank.d.ts.map

package/script/npm/src/deps/jsr.io/@temboplus/frontend-core/0.2.21/src/models/bank/bank.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bank.d.ts","sourceRoot":"","sources":["../../../../../../../../../../../src/deps/jsr.io/@temboplus/frontend-core/0.2.21/src/models/bank/bank.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAMH;;;GAGG;AACH,qBAAa,IAAI;IAoDb,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IApD7B,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAC9B,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAC5B,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;IAClC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAC5B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAC9B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IAC/B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAC9B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAC5B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAC1B,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IAChC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAC9B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAC9B,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAE9B;;;;;;;OAOG;gBAED,KAAK,EAAE,MAAM,EACI,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM;IAOrC;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAIvD;;;OAGG;IACH,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE;IAIvB;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAM3D;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAMzD;;;OAGG;IACI,QAAQ,IAAI,OAAO;IAY1B;;;;OAIG;WACW,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAYnD;;;;OAIG;WACW,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAY1D;;;;OAIG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,IAAI;CAe5C;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAgD,CAAC;AAE9E;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,gBAAgB,CAA4B;IAGpD,OAAO,CAAC,gBAAgB,CAAgC;IAExD,OAAO;IAEP;;;;;OAKG;IACH,MAAM,CAAC,WAAW,IAAI,WAAW;IAQjC;;;OAGG;IACH,OAAO,CAAC,UAAU;IA0ClB;;;OAGG;IACH,MAAM,IAAI,IAAI,EAAE;IAIhB;;;OAGG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;IAItC;;;OAGG;IACH,mBAAmB,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC;IAIxC;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAKlD;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAqChD;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAKpD;;;;OAIG;IACH,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAKlD;;;;;OAKG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,IAAI,EAAE;IAetD;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO;IAQ1C;;;OAGG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;;;OAIG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIlD;;;;;OAKG;IACH,iBAAiB,eAAgB,MAAM,KAAG,OAAO,CAQ/C;CACH"}