@react-pakistan/util-functions 1.25.8 → 1.25.10

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

@@ -1,108 +0,0 @@
-import { CustomerBE } from '../type';
-/**
- * Synchronous utility function to get customers from cache only
- * Returns cached data immediately if available and fresh, otherwise returns empty array
- * Does not trigger any API calls
- *
- * @returns CustomerBE[] - Array of cached customers or empty array wrapper ({count, items})
- *
- * @example
- * const customers = getCachedCustomersSync();
- * if (customers.items.length > 0) {
- *   console.log(customers.items[0].firstName);
- * }
- */
-export declare const getCachedCustomersSync: () => {
-    count: number;
-    items: CustomerBE[];
-};
-/**
- * Utility function to get customers from cache or fetch from API
- *
- * This function manages a localStorage cache of customers with the following logic:
- * - If customers exist in cache and are less than 1 day old, return cached version
- * - If customers exist but are older than 1 day, fetch fresh data and update cache
- * - If customers don't exist in cache, fetch from API and cache them
- *
- * @param searchQuery - Optional search query to filter customers
- * @param filters - Optional filters object to apply additional filtering (bypasses cache)
- * @param pageLimit - Number of customers to fetch (default: 100)
- * @returns Promise<{count:number, items: CustomerBE[]}> - Paged customers
- *
- * @example
- * const customers = await getCachedCustomers();
- * console.log(customers.items[0].firstName);
- *
- * // With search
- * const filtered = await getCachedCustomers('John');
- *
- * // With filters
- * const filteredByCountry = await getCachedCustomers(undefined, { country: 'USA' });
- */
-export declare const getCachedCustomers: (searchQuery?: string, filters?: Record<string, unknown>, pageLimit?: number) => Promise<{
-    count: number;
-    items: CustomerBE[];
-}>;
-/**
- * Utility function to get a specific customer by ID from cache
- * If not found in cache, returns null (does not trigger API call)
- *
- * @param customerId - The ID of the customer to retrieve
- * @returns CustomerBE | null - The customer or null if not found
- *
- * @example
- * const customer = getCachedCustomerById('customer-123');
- * if (customer) {
- *   console.log(customer.firstName);
- * }
- */
-export declare const getCachedCustomerById: (customerId: string) => CustomerBE | null;
-/**
- * Utility function to get a specific customer by phone from cache
- * If not found in cache, returns null (does not trigger API call)
- *
- * @param phone - The phone number of the customer to search for
- * @returns CustomerBE | null - The customer or null if not found
- *
- * @example
- * const customer = getCachedCustomerByPhone('+1234567890');
- * if (customer) {
- *   console.log(customer.firstName);
- * }
- */
-export declare const getCachedCustomerByPhone: (phone: string) => CustomerBE | null;
-/**
- * Utility function to invalidate (remove) customers from cache
- * Useful when customers have been updated and you want to force a refresh
- *
- * @example
- * invalidateCustomersCache();
- * const freshCustomers = await getCachedCustomers();
- */
-export declare const invalidateCustomersCache: () => void;
-/**
- * Utility function to preload customers into cache
- * Useful to call on app initialization or login
- *
- * @returns Promise<{count:number, items: CustomerBE[]}> - Array of preloaded customers
- *
- * @example
- * // On app initialization
- * await preloadCustomers();
- */
-export declare const preloadCustomers: () => Promise<{
-    count: number;
-    items: CustomerBE[];
-}>;
-/**
- * Utility function to check if customers cache is stale
- * Returns true if cache is older than 1 day or doesn't exist
- *
- * @returns boolean - True if cache is stale or doesn't exist
- *
- * @example
- * if (isCustomersCacheStale()) {
- *   await getCachedCustomers(); // This will fetch fresh data
- * }
- */
-export declare const isCustomersCacheStale: () => boolean;