@react-pakistan/util-functions 1.25.9 → 1.25.11

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

@@ -1,108 +0,0 @@
-import { ContactBE } from '../type';
-/**
- * Synchronous utility function to get contacts from cache only
- * Returns cached data immediately if available and fresh, otherwise returns empty array
- * Does not trigger any API calls
- *
- * @returns ContactBE[] - Array of cached contacts or empty array wrapper ({count, items})
- *
- * @example
- * const contacts = getCachedContactsSync();
- * if (contacts.items.length > 0) {
- *   console.log(contacts.items[0].firstName);
- * }
- */
-export declare const getCachedContactsSync: () => {
-    count: number;
-    items: ContactBE[];
-};
-/**
- * Utility function to get contacts from cache or fetch from API
- *
- * This function manages a localStorage cache of contacts with the following logic:
- * - If contacts exist in cache and are less than 1 day old, return cached version
- * - If contacts exist but are older than 1 day, fetch fresh data and update cache
- * - If contacts don't exist in cache, fetch from API and cache them
- *
- * @param searchQuery - Optional search query to filter contacts
- * @param filters - Optional filters object to apply additional filtering (bypasses cache)
- * @param pageLimit - Number of contacts to fetch (default: 100)
- * @returns Promise<{count:number, items: ContactBE[]}> - Paged contacts
- *
- * @example
- * const contacts = await getCachedContacts();
- * console.log(contacts.items[0].firstName);
- *
- * // With search
- * const filtered = await getCachedContacts('John');
- *
- * // With filters
- * const filteredByCompany = await getCachedContacts(undefined, { companyId: 'company-123' });
- */
-export declare const getCachedContacts: (searchQuery?: string, filters?: Record<string, unknown>, pageLimit?: number) => Promise<{
-    count: number;
-    items: ContactBE[];
-}>;
-/**
- * Utility function to get a specific contact by ID from cache
- * If not found in cache, returns null (does not trigger API call)
- *
- * @param contactId - The ID of the contact to retrieve
- * @returns ContactBE | null - The contact or null if not found
- *
- * @example
- * const contact = getCachedContactById('contact-123');
- * if (contact) {
- *   console.log(contact.firstName);
- * }
- */
-export declare const getCachedContactById: (contactId: string) => ContactBE | null;
-/**
- * Utility function to get contacts by email from cache
- * If not found in cache, returns null (does not trigger API call)
- *
- * @param email - The email of the contact to search for
- * @returns ContactBE | null - The contact or null if not found
- *
- * @example
- * const contact = getCachedContactByEmail('john@example.com');
- * if (contact) {
- *   console.log(contact.firstName);
- * }
- */
-export declare const getCachedContactByEmail: (email: string) => ContactBE | null;
-/**
- * Utility function to invalidate (remove) contacts from cache
- * Useful when contacts have been updated and you want to force a refresh
- *
- * @example
- * invalidateContactsCache();
- * const freshContacts = await getCachedContacts();
- */
-export declare const invalidateContactsCache: () => void;
-/**
- * Utility function to preload contacts into cache
- * Useful to call on app initialization or login
- *
- * @returns Promise<{count:number, items: ContactBE[]}> - Array of preloaded contacts
- *
- * @example
- * // On app initialization
- * await preloadContacts();
- */
-export declare const preloadContacts: () => Promise<{
-    count: number;
-    items: ContactBE[];
-}>;
-/**
- * Utility function to check if contacts 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 (isContactsCacheStale()) {
- *   await getCachedContacts(); // This will fetch fresh data
- * }
- */
-export declare const isContactsCacheStale: () => boolean;