@react-pakistan/util-functions 1.24.98 → 1.25.0

package/api/stellar-solutions/company/cache.js

@@ -0,0 +1,307 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCompaniesCacheStale = exports.preloadCompanies = exports.invalidateCompaniesCache = exports.getCachedCompaniesByName = exports.getCachedCompanyById = exports.getCachedCompanies = exports.getCachedCompaniesSync = void 0;
+var constants_1 = require("../constants");
+var type_1 = require("../type");
+var api_methods_1 = require("../../../constants/api-methods");
+var fetch_data_1 = require("../../../general/fetch-data");
+var get_storage_value_1 = require("../../../local-storage/get-storage-value");
+var set_storage_value_1 = require("../../../local-storage/set-storage-value");
+/**
+ * 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);
+ * }
+ */
+var getCachedCompaniesSync = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.COMPANIES);
+        if (!cachedData) {
+            return { count: 0, items: [] };
+        }
+        var currentTime = new Date().getTime();
+        var cachedTime = new Date(cachedData.cachedAt).getTime();
+        var ageInMs = currentTime - cachedTime;
+        // If cached data is less than 1 day old, return it
+        if (ageInMs < constants_1.ONE_DAY_IN_MS) {
+            return {
+                count: cachedData.companies.length,
+                items: cachedData.companies,
+            };
+        }
+        return { count: 0, items: [] };
+    }
+    catch (error) {
+        console.error('Error getting cached companies:', error);
+        return { count: 0, items: [] };
+    }
+};
+exports.getCachedCompaniesSync = getCachedCompaniesSync;
+/**
+ * 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' });
+ */
+var getCachedCompanies = function (searchQuery_1, filters_1) {
+    var args_1 = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args_1[_i - 2] = arguments[_i];
+    }
+    return __awaiter(void 0, __spreadArray([searchQuery_1, filters_1], args_1, true), void 0, function (searchQuery, filters, pageLimit) {
+        var response_1, cachedData, currentTime, cachedTime, ageInMs, response, updatedCache, error_1;
+        var _a;
+        if (pageLimit === void 0) { pageLimit = 100; }
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 4, , 5]);
+                    if (!((searchQuery && searchQuery.trim()) ||
+                        (filters && Object.keys(filters).length > 0))) return [3 /*break*/, 2];
+                    return [4 /*yield*/, (0, fetch_data_1.fetchData)({
+                            url: constants_1.API_ROUTES.COMPANIES,
+                            body: JSON.stringify(__assign(__assign({ searchQuery: searchQuery }, filters), { pageLimit: pageLimit, currentPage: 1 })),
+                            method: api_methods_1.API_METHODS.POST,
+                        })];
+                case 1:
+                    response_1 = _b.sent();
+                    return [2 /*return*/, (response_1 === null || response_1 === void 0 ? void 0 : response_1.data) || { count: 0, items: [] }];
+                case 2:
+                    cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.COMPANIES);
+                    currentTime = new Date().getTime();
+                    // Check if cached data exists and is still fresh
+                    if (cachedData) {
+                        cachedTime = new Date(cachedData.cachedAt).getTime();
+                        ageInMs = currentTime - cachedTime;
+                        // If cached data is less than 1 day old, return it
+                        if (ageInMs < constants_1.ONE_DAY_IN_MS) {
+                            return [2 /*return*/, {
+                                    count: cachedData.companies.length,
+                                    items: cachedData.companies,
+                                }];
+                        }
+                    }
+                    return [4 /*yield*/, (0, fetch_data_1.fetchData)({
+                            url: constants_1.API_ROUTES.COMPANIES,
+                            body: JSON.stringify({
+                                pageLimit: pageLimit,
+                                currentPage: 1,
+                            }),
+                            method: api_methods_1.API_METHODS.POST,
+                        })];
+                case 3:
+                    response = _b.sent();
+                    if ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) {
+                        updatedCache = {
+                            companies: response.data.items,
+                            cachedAt: new Date().toISOString(),
+                        };
+                        (0, set_storage_value_1.setStorageValue)(type_1.LS_KEYS.COMPANIES, updatedCache);
+                        return [2 /*return*/, response.data];
+                    }
+                    return [2 /*return*/, { count: 0, items: [] }];
+                case 4:
+                    error_1 = _b.sent();
+                    console.error('Error fetching companies:', error_1);
+                    return [2 /*return*/, { count: 0, items: [] }];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.getCachedCompanies = getCachedCompanies;
+/**
+ * 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);
+ * }
+ */
+var getCachedCompanyById = function (companyId) {
+    if (!companyId) {
+        return null;
+    }
+    try {
+        var companies = (0, exports.getCachedCompaniesSync)().items;
+        return companies.find(function (company) { return company.id === companyId; }) || null;
+    }
+    catch (error) {
+        console.error('Error getting cached company by ID:', error);
+        return null;
+    }
+};
+exports.getCachedCompanyById = getCachedCompanyById;
+/**
+ * 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);
+ */
+var getCachedCompaniesByName = function (name) {
+    if (!name) {
+        return [];
+    }
+    try {
+        var companies = (0, exports.getCachedCompaniesSync)().items;
+        return companies.filter(function (company) {
+            return company.name.toLowerCase().includes(name.toLowerCase());
+        });
+    }
+    catch (error) {
+        console.error('Error getting cached companies by name:', error);
+        return [];
+    }
+};
+exports.getCachedCompaniesByName = getCachedCompaniesByName;
+/**
+ * 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();
+ */
+var invalidateCompaniesCache = function () {
+    try {
+        localStorage.removeItem(type_1.LS_KEYS.COMPANIES);
+    }
+    catch (error) {
+        console.error('Error invalidating companies cache:', error);
+    }
+};
+exports.invalidateCompaniesCache = invalidateCompaniesCache;
+/**
+ * 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();
+ */
+var preloadCompanies = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, (0, exports.getCachedCompanies)()];
+    });
+}); };
+exports.preloadCompanies = preloadCompanies;
+/**
+ * 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
+ * }
+ */
+var isCompaniesCacheStale = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.COMPANIES);
+        if (!cachedData) {
+            return true;
+        }
+        var currentTime = new Date().getTime();
+        var cachedTime = new Date(cachedData.cachedAt).getTime();
+        var ageInMs = currentTime - cachedTime;
+        return ageInMs >= constants_1.ONE_DAY_IN_MS;
+    }
+    catch (error) {
+        console.error('Error checking companies cache staleness:', error);
+        return true;
+    }
+};
+exports.isCompaniesCacheStale = isCompaniesCacheStale;

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

@@ -1,3 +1,4 @@
+export * from './cache';
 import { CompanyBE } from '../type';
 type PrismaClient = any;
 export interface ListCompanyArgs {
@@ -54,4 +55,3 @@ export declare const updateCompany: ({ country, email, id, name, phone, prisma,
  * @throws {Error} If company ID is not provided or company not found
  */
 export declare const deleteCompany: ({ id, prisma, }: DeleteCompanyArgs) => Promise<CompanyBE>;
-export {};

package/api/stellar-solutions/company/index.js

@@ -10,6 +10,20 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -57,6 +71,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteCompany = exports.updateCompany = exports.unitCompanyById = exports.listCompany = void 0;
+__exportStar(require("./cache"), exports);
 var multi_part_search_1 = require("../../../general/multi-part-search");
 /**
  * Retrieves all companies from the database with pagination

package/api/stellar-solutions/constants.d.ts

@@ -0,0 +1,21 @@
+export declare const ONE_DAY_IN_MS: number;
+export declare const ONE_WEEK_IN_MS: number;
+export declare const API_ROUTES: {
+    BANKS: string;
+    BRANCHES: string;
+    COMPANIES: string;
+    CONTACTS: string;
+    CURRENCIES: string;
+    CUSTOMERS: string;
+    EXPENSE_CATEGORIES: string;
+    EXPENSES: string;
+    PAYMENT_MODES: string;
+    PREFERENCES: string;
+    PRODUCT_BY_ID: string;
+    PRODUCT_CATEGORIES: string;
+    PRODUCT_CATEGORY_BY_ID: string;
+    PRODUCT_CATEGORY: string;
+    PRODUCT: string;
+    PRODUCTS: string;
+    TAXES: string;
+};

package/api/stellar-solutions/constants.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_ROUTES = exports.ONE_WEEK_IN_MS = exports.ONE_DAY_IN_MS = void 0;
+exports.ONE_DAY_IN_MS = 1 * 24 * 60 * 60 * 1000; // 1 day in milliseconds
+exports.ONE_WEEK_IN_MS = 7 * 24 * 60 * 60 * 1000; // 1 week in milliseconds
+exports.API_ROUTES = {
+    BANKS: '/api/banks',
+    BRANCHES: '/api/branches',
+    COMPANIES: '/api/companies',
+    CONTACTS: '/api/contacts',
+    CURRENCIES: '/api/currencies',
+    CUSTOMERS: '/api/customers',
+    EXPENSE_CATEGORIES: '/api/expense-categories',
+    EXPENSES: '/api/expenses',
+    PAYMENT_MODES: '/api/payment-modes',
+    PREFERENCES: '/api/preferences',
+    PRODUCT_BY_ID: '/api/product/product-by-id',
+    PRODUCT_CATEGORIES: '/api/product-categories',
+    PRODUCT_CATEGORY_BY_ID: '/api/product-category/product-category-by-id',
+    PRODUCT_CATEGORY: '/api/product-category',
+    PRODUCT: '/api/product',
+    PRODUCTS: '/api/products',
+    TAXES: '/api/taxes',
+};

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

@@ -0,0 +1,108 @@
+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;