@react-pakistan/util-functions 1.24.99 → 1.25.0

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

@@ -0,0 +1,256 @@
+"use strict";
+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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBranchesCacheStale = exports.preloadBranches = exports.invalidateBranchesCache = exports.getCachedBranchesByName = exports.getCachedBranchById = exports.getCachedBranches = exports.getCachedBranchesSync = 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 branches from cache only
+ * Returns cached data immediately if available and fresh, otherwise returns empty array
+ * Does not trigger any API calls
+ *
+ * @returns BranchBE[] - Array of cached branches or empty array wrapper ({count, items})
+ *
+ * @example
+ * const branches = getCachedBranchesSync();
+ * if (branches.items.length > 0) {
+ *   console.log(branches.items[0].branchName);
+ * }
+ */
+var getCachedBranchesSync = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.BRANCHES);
+        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 week old, return it
+        if (ageInMs < constants_1.ONE_WEEK_IN_MS) {
+            return {
+                count: cachedData.branches.length,
+                items: cachedData.branches,
+            };
+        }
+        return { count: 0, items: [] };
+    }
+    catch (error) {
+        console.error('Error getting cached branches:', error);
+        return { count: 0, items: [] };
+    }
+};
+exports.getCachedBranchesSync = getCachedBranchesSync;
+/**
+ * Utility function to get branches from cache or fetch from API
+ *
+ * This function manages a localStorage cache of branches with the following logic:
+ * - If branches exist in cache and are less than 1 week old, return cached version
+ * - If branches exist but are older than 1 week, fetch fresh data and update cache
+ * - If branches don't exist in cache, fetch from API and cache them
+ *
+ * @returns Promise<{count:number, items: BranchBE[]}> - Paged branches
+ *
+ * @example
+ * const branches = await getCachedBranches();
+ * console.log(branches.items[0].branchName);
+ */
+var getCachedBranches = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var cachedData, currentTime, cachedTime, ageInMs, response, updatedCache, error_1;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                _b.trys.push([0, 2, , 3]);
+                cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.BRANCHES);
+                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 week old, return it
+                    if (ageInMs < constants_1.ONE_WEEK_IN_MS) {
+                        return [2 /*return*/, {
+                                count: cachedData.branches.length,
+                                items: cachedData.branches,
+                            }];
+                    }
+                }
+                return [4 /*yield*/, (0, fetch_data_1.fetchData)({
+                        url: constants_1.API_ROUTES.BRANCHES,
+                        method: api_methods_1.API_METHODS.GET,
+                    })];
+            case 1:
+                response = _b.sent();
+                if ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) {
+                    updatedCache = {
+                        branches: response.data.items,
+                        cachedAt: new Date().toISOString(),
+                    };
+                    (0, set_storage_value_1.setStorageValue)(type_1.LS_KEYS.BRANCHES, updatedCache);
+                    return [2 /*return*/, response.data];
+                }
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 2:
+                error_1 = _b.sent();
+                console.error('Error fetching branches:', error_1);
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedBranches = getCachedBranches;
+/**
+ * Utility function to get a specific branch by ID from cache
+ * If not found in cache, returns null (does not trigger API call)
+ *
+ * @param branchId - The ID of the branch to retrieve
+ * @returns BranchBE | null - The branch or null if not found
+ *
+ * @example
+ * const branch = getCachedBranchById('branch-123');
+ * if (branch) {
+ *   console.log(branch.branchName);
+ * }
+ */
+var getCachedBranchById = function (branchId) {
+    if (!branchId) {
+        return null;
+    }
+    try {
+        var branches = (0, exports.getCachedBranchesSync)().items;
+        return branches.find(function (branch) { return branch.id === branchId; }) || null;
+    }
+    catch (error) {
+        console.error('Error getting cached branch by ID:', error);
+        return null;
+    }
+};
+exports.getCachedBranchById = getCachedBranchById;
+/**
+ * Utility function to get branches by name from cache
+ * If not found in cache, returns empty array (does not trigger API call)
+ *
+ * @param branchName - The name of the branch to search for
+ * @returns BranchBE[] - Array of matching branches or empty array
+ *
+ * @example
+ * const branches = getCachedBranchesByName('Main Branch');
+ * console.log(branches.length);
+ */
+var getCachedBranchesByName = function (branchName) {
+    if (!branchName) {
+        return [];
+    }
+    try {
+        var branches = (0, exports.getCachedBranchesSync)().items;
+        return branches.filter(function (branch) {
+            return branch.branchName.toLowerCase().includes(branchName.toLowerCase());
+        });
+    }
+    catch (error) {
+        console.error('Error getting cached branches by name:', error);
+        return [];
+    }
+};
+exports.getCachedBranchesByName = getCachedBranchesByName;
+/**
+ * Utility function to invalidate (remove) branches from cache
+ * Useful when branches have been updated and you want to force a refresh
+ *
+ * @example
+ * invalidateBranchesCache();
+ * const freshBranches = await getCachedBranches();
+ */
+var invalidateBranchesCache = function () {
+    try {
+        localStorage.removeItem(type_1.LS_KEYS.BRANCHES);
+    }
+    catch (error) {
+        console.error('Error invalidating branches cache:', error);
+    }
+};
+exports.invalidateBranchesCache = invalidateBranchesCache;
+/**
+ * Utility function to preload branches into cache
+ * Useful to call on app initialization or login
+ *
+ * @returns Promise<{count:number, items: BranchBE[]}> - Array of preloaded branches
+ *
+ * @example
+ * // On app initialization
+ * await preloadBranches();
+ */
+var preloadBranches = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, (0, exports.getCachedBranches)()];
+    });
+}); };
+exports.preloadBranches = preloadBranches;
+/**
+ * Utility function to check if branches 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 (isBranchesCacheStale()) {
+ *   await getCachedBranches(); // This will fetch fresh data
+ * }
+ */
+var isBranchesCacheStale = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.BRANCHES);
+        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_WEEK_IN_MS;
+    }
+    catch (error) {
+        console.error('Error checking branches cache staleness:', error);
+        return true;
+    }
+};
+exports.isBranchesCacheStale = isBranchesCacheStale;

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

@@ -1,4 +1,5 @@
-import { BranchTypeBE } from '../type';
+export * from './cache';
+import { BranchBE } from '../type';
 type PrismaClient = any;
 export interface ListBranchArgs {
     currentPage?: number;
@@ -33,26 +34,25 @@ export interface DeleteBranchArgs {
 /**
  * Retrieves all branches from the database with pagination
  * @param {ListBranchArgs} args - Object containing prisma client, pagination, and filter options
- * @returns {Promise<[number, Array<BranchTypeBE>]>} Tuple of [total count, array of branches]
+ * @returns {Promise<[number, Array<BranchBE>]>} Tuple of [total count, array of branches]
  */
-export declare const listBranch: ({ currentPage, includePreference, orderByColumn, orderByDirection, pageLimit, prisma, searchQuery, }: ListBranchArgs) => Promise<[number, Array<BranchTypeBE>]>;
+export declare const listBranch: ({ currentPage, includePreference, orderByColumn, orderByDirection, pageLimit, prisma, searchQuery, }: ListBranchArgs) => Promise<[number, Array<BranchBE>]>;
 /**
  * Retrieves a single branch by ID
  * @param {UnitBranchByIdArgs} args - Object containing prisma client and branch id
- * @returns {Promise<BranchTypeBE | null>} Branch if found, null otherwise
+ * @returns {Promise<BranchBE | null>} Branch if found, null otherwise
  */
-export declare const unitBranchById: ({ prisma, id, }: UnitBranchByIdArgs) => Promise<BranchTypeBE | null>;
+export declare const unitBranchById: ({ prisma, id, }: UnitBranchByIdArgs) => Promise<BranchBE | null>;
 /**
  * Creates a new branch or updates an existing one
  * @param {UpdateBranchArgs} args - Object containing prisma client and branch data
- * @returns {Promise<BranchTypeBE>} Created or updated branch
+ * @returns {Promise<BranchBE>} Created or updated branch
  */
-export declare const updateBranch: ({ branchAddress, branchName, enabled, id, isDefault, personEmail, personName, personPhone, preferenceId, prisma, }: UpdateBranchArgs) => Promise<BranchTypeBE>;
+export declare const updateBranch: ({ branchAddress, branchName, enabled, id, isDefault, personEmail, personName, personPhone, preferenceId, prisma, }: UpdateBranchArgs) => Promise<BranchBE>;
 /**
  * Deletes a branch by ID
  * @param {DeleteBranchArgs} args - Object containing prisma client and branch id
- * @returns {Promise<BranchTypeBE>} Deleted branch
+ * @returns {Promise<BranchBE>} Deleted branch
  * @throws {Error} If branch ID is not provided or branch not found
  */
-export declare const deleteBranch: ({ id, prisma, }: DeleteBranchArgs) => Promise<BranchTypeBE>;
-export {};
+export declare const deleteBranch: ({ id, prisma, }: DeleteBranchArgs) => Promise<BranchBE>;

package/api/stellar-solutions/branch/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,11 +71,12 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteBranch = exports.updateBranch = exports.unitBranchById = exports.listBranch = void 0;
+__exportStar(require("./cache"), exports);
 var general_1 = require("../../../general");
 /**
  * Retrieves all branches from the database with pagination
  * @param {ListBranchArgs} args - Object containing prisma client, pagination, and filter options
- * @returns {Promise<[number, Array<BranchTypeBE>]>} Tuple of [total count, array of branches]
+ * @returns {Promise<[number, Array<BranchBE>]>} Tuple of [total count, array of branches]
  */
 var listBranch = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var include, orderBy, idSearchQuery, branchNameSearchQuery, personNameSearchQuery, personEmailSearchQuery, where, _c, count, items;
@@ -123,7 +138,7 @@ exports.listBranch = listBranch;
 /**
  * Retrieves a single branch by ID
  * @param {UnitBranchByIdArgs} args - Object containing prisma client and branch id
- * @returns {Promise<BranchTypeBE | null>} Branch if found, null otherwise
+ * @returns {Promise<BranchBE | null>} Branch if found, null otherwise
  */
 var unitBranchById = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var where, branch;
@@ -148,7 +163,7 @@ exports.unitBranchById = unitBranchById;
 /**
  * Creates a new branch or updates an existing one
  * @param {UpdateBranchArgs} args - Object containing prisma client and branch data
- * @returns {Promise<BranchTypeBE>} Created or updated branch
+ * @returns {Promise<BranchBE>} Created or updated branch
  */
 var updateBranch = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var branchData, where, branch;
@@ -195,7 +210,7 @@ exports.updateBranch = updateBranch;
 /**
  * Deletes a branch by ID
  * @param {DeleteBranchArgs} args - Object containing prisma client and branch id
- * @returns {Promise<BranchTypeBE>} Deleted branch
+ * @returns {Promise<BranchBE>} Deleted branch
  * @throws {Error} If branch ID is not provided or branch not found
  */
 var deleteBranch = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {

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

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