@react-pakistan/util-functions 1.25.8 → 1.25.10

package/api/stellar-solutions/bank/cache.d.ts

@@ -1,104 +0,0 @@
-import { BankBE } from '../type';
-/**
- * Synchronous utility function to get banks from cache only
- * Returns cached data immediately if available and fresh, otherwise returns empty array
- * Does not trigger any API calls
- *
- * @returns BankBE[] - Array of cached banks or empty array wrapper ({count, items})
- *
- * @example
- * const banks = getCachedBanksSync();
- * if (banks.items.length > 0) {
- *   console.log(banks.items[0].bankName);
- * }
- */
-export declare const getCachedBanksSync: () => {
-    count: number;
-    items: BankBE[];
-};
-/**
- * Utility function to get banks from cache or fetch from API
- *
- * This function manages a localStorage cache of banks with the following logic:
- * - If banks exist in cache and are less than 1 week old, return cached version
- * - If banks exist but are older than 1 week, fetch fresh data and update cache
- * - If banks don't exist in cache, fetch from API and cache them
- *
- * @param searchQuery - Optional search query to filter banks
- * @param pageLimit - Number of banks to fetch (default: 100)
- * @returns Promise<{count:number, items: BankBE[]}> - Paged banks
- *
- * @example
- * const banks = await getCachedBanks();
- * console.log(banks.items[0].bankName);
- *
- * // With search
- * const filtered = await getCachedBanks('Chase');
- */
-export declare const getCachedBanks: (searchQuery?: string, pageLimit?: number) => Promise<{
-    count: number;
-    items: BankBE[];
-}>;
-/**
- * Utility function to get a specific bank by ID from cache
- * If not found in cache, returns null (does not trigger API call)
- *
- * @param bankId - The ID of the bank to retrieve
- * @returns BankBE | null - The bank or null if not found
- *
- * @example
- * const bank = getCachedBankById('bank-123');
- * if (bank) {
- *   console.log(bank.bankName);
- * }
- */
-export declare const getCachedBankById: (bankId: string) => BankBE | null;
-/**
- * Utility function to get a specific bank by account number from cache
- * If not found in cache, returns null (does not trigger API call)
- *
- * @param accountNumber - The account number of the bank to retrieve
- * @returns BankBE | null - The bank or null if not found
- *
- * @example
- * const bank = getCachedBankByAccountNumber('1234567890');
- * if (bank) {
- *   console.log(bank.bankName);
- * }
- */
-export declare const getCachedBankByAccountNumber: (accountNumber: string) => BankBE | null;
-/**
- * Utility function to invalidate (remove) banks from cache
- * Useful when banks have been updated and you want to force a refresh
- *
- * @example
- * invalidateBanksCache();
- * const freshBanks = await getCachedBanks();
- */
-export declare const invalidateBanksCache: () => void;
-/**
- * Utility function to preload banks into cache
- * Useful to call on app initialization or login
- *
- * @returns Promise<{count:number, items: BankBE[]}> - Array of preloaded banks
- *
- * @example
- * // On app initialization
- * await preloadBanks();
- */
-export declare const preloadBanks: () => Promise<{
-    count: number;
-    items: BankBE[];
-}>;
-/**
- * Utility function to check if banks cache is stale
- * Returns true if cache is older than 1 week or doesn't exist
- *
- * @returns boolean - True if cache is stale or doesn't exist
- *
- * @example
- * if (isBanksCacheStale()) {
- *   await getCachedBanks(); // This will fetch fresh data
- * }
- */
-export declare const isBanksCacheStale: () => boolean;