@react-pakistan/util-functions 1.25.9 → 1.25.11

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

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