@react-pakistan/util-functions 1.24.99 → 1.25.1

package/api/stellar-solutions/currency/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.isCurrenciesCacheStale = exports.preloadCurrencies = exports.invalidateCurrenciesCache = exports.getCachedCurrencyByCode = exports.getCachedCurrencyById = exports.getCachedCurrencies = exports.getCachedCurrenciesSync = 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 currencies from cache only
+ * Returns cached data immediately if available and fresh, otherwise returns empty array
+ * Does not trigger any API calls
+ *
+ * @returns CurrencyBE[] - Array of cached currencies or empty array wrapper ({count, items})
+ *
+ * @example
+ * const currencies = getCachedCurrenciesSync();
+ * if (currencies.items.length > 0) {
+ *   console.log(currencies.items[0].label);
+ * }
+ */
+var getCachedCurrenciesSync = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.CURRENCIES);
+        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.currencies.length,
+                items: cachedData.currencies,
+            };
+        }
+        return { count: 0, items: [] };
+    }
+    catch (error) {
+        console.error('Error getting cached currencies:', error);
+        return { count: 0, items: [] };
+    }
+};
+exports.getCachedCurrenciesSync = getCachedCurrenciesSync;
+/**
+ * Utility function to get currencies from cache or fetch from API
+ *
+ * This function manages a localStorage cache of currencies with the following logic:
+ * - If currencies exist in cache and are less than 1 week old, return cached version
+ * - If currencies exist but are older than 1 week, fetch fresh data and update cache
+ * - If currencies don't exist in cache, fetch from API and cache them
+ *
+ * @returns Promise<{count:number, items: CurrencyBE[]}> - Paged currencies
+ *
+ * @example
+ * const currencies = await getCachedCurrencies();
+ * console.log(currencies.items[0].label);
+ */
+var getCachedCurrencies = 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.CURRENCIES);
+                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.currencies.length,
+                                items: cachedData.currencies,
+                            }];
+                    }
+                }
+                return [4 /*yield*/, (0, fetch_data_1.fetchData)({
+                        url: constants_1.API_ROUTES.CURRENCIES,
+                        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 = {
+                        currencies: response.data.items,
+                        cachedAt: new Date().toISOString(),
+                    };
+                    (0, set_storage_value_1.setStorageValue)(type_1.LS_KEYS.CURRENCIES, updatedCache);
+                    return [2 /*return*/, response.data];
+                }
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 2:
+                error_1 = _b.sent();
+                console.error('Error fetching currencies:', error_1);
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedCurrencies = getCachedCurrencies;
+/**
+ * Utility function to get a specific currency by ID from cache
+ * If not found in cache, returns null (does not trigger API call)
+ *
+ * @param currencyId - The ID of the currency to retrieve
+ * @returns CurrencyBE | null - The currency or null if not found
+ *
+ * @example
+ * const currency = getCachedCurrencyById('curr-123');
+ * if (currency) {
+ *   console.log(currency.label);
+ * }
+ */
+var getCachedCurrencyById = function (currencyId) {
+    if (!currencyId) {
+        return null;
+    }
+    try {
+        var currencies = (0, exports.getCachedCurrenciesSync)().items;
+        return currencies.find(function (curr) { return curr.id === currencyId; }) || null;
+    }
+    catch (error) {
+        console.error('Error getting cached currency by ID:', error);
+        return null;
+    }
+};
+exports.getCachedCurrencyById = getCachedCurrencyById;
+/**
+ * Utility function to get a specific currency by code from cache
+ * If not found in cache, returns null (does not trigger API call)
+ *
+ * @param code - The code of the currency to retrieve (e.g., 'USD', 'EUR')
+ * @returns CurrencyBE | null - The currency or null if not found
+ *
+ * @example
+ * const currency = getCachedCurrencyByCode('USD');
+ * if (currency) {
+ *   console.log(currency.label);
+ * }
+ */
+var getCachedCurrencyByCode = function (code) {
+    if (!code) {
+        return null;
+    }
+    try {
+        var currencies = (0, exports.getCachedCurrenciesSync)().items;
+        return currencies.find(function (curr) { return curr.code === code; }) || null;
+    }
+    catch (error) {
+        console.error('Error getting cached currency by code:', error);
+        return null;
+    }
+};
+exports.getCachedCurrencyByCode = getCachedCurrencyByCode;
+/**
+ * Utility function to invalidate (remove) currencies from cache
+ * Useful when currencies have been updated and you want to force a refresh
+ *
+ * @example
+ * invalidateCurrenciesCache();
+ * const freshCurrencies = await getCachedCurrencies();
+ */
+var invalidateCurrenciesCache = function () {
+    try {
+        localStorage.removeItem(type_1.LS_KEYS.CURRENCIES);
+    }
+    catch (error) {
+        console.error('Error invalidating currencies cache:', error);
+    }
+};
+exports.invalidateCurrenciesCache = invalidateCurrenciesCache;
+/**
+ * Utility function to preload currencies into cache
+ * Useful to call on app initialization or login
+ *
+ * @returns Promise<{count:number, items: CurrencyBE[]}> - Array of preloaded currencies
+ *
+ * @example
+ * // On app initialization
+ * await preloadCurrencies();
+ */
+var preloadCurrencies = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, (0, exports.getCachedCurrencies)()];
+    });
+}); };
+exports.preloadCurrencies = preloadCurrencies;
+/**
+ * Utility function to check if currencies 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 (isCurrenciesCacheStale()) {
+ *   await getCachedCurrencies(); // This will fetch fresh data
+ * }
+ */
+var isCurrenciesCacheStale = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.CURRENCIES);
+        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 currencies cache staleness:', error);
+        return true;
+    }
+};
+exports.isCurrenciesCacheStale = isCurrenciesCacheStale;

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

@@ -1,4 +1,5 @@
-import { CurrencyTypeBE } from '../type';
+export * from './cache';
+import { CurrencyBE } from '../type';
 type PrismaClient = any;
 export interface ListCurrencyArgs {
     currentPage?: number;
@@ -30,26 +31,25 @@ export interface DeleteCurrencyArgs {
 /**
  * Retrieves currencies with pagination and filtering
  * @param {ListCurrencyArgs} args - Object containing prisma client, pagination, and query options
- * @returns {Promise<[number, Array<CurrencyTypeBE>]>} Tuple containing total count and array of currencies
+ * @returns {Promise<[number, Array<CurrencyBE>]>} Tuple containing total count and array of currencies
  */
-export declare const listCurrency: ({ currentPage, includePreference, orderByColumn, orderByDirection, pageLimit, prisma, searchQuery, }: ListCurrencyArgs) => Promise<[number, Array<CurrencyTypeBE>]>;
+export declare const listCurrency: ({ currentPage, includePreference, orderByColumn, orderByDirection, pageLimit, prisma, searchQuery, }: ListCurrencyArgs) => Promise<[number, Array<CurrencyBE>]>;
 /**
  * Retrieves a single currency by ID
  * @param {UnitCurrencyByIdArgs} args - Object containing prisma client and query where conditions
- * @returns {Promise<CurrencyTypeBE | null>} Currency if found, null otherwise
+ * @returns {Promise<CurrencyBE | null>} Currency if found, null otherwise
  */
-export declare const unitCurrencyById: ({ id, includePreference, prisma, }: UnitCurrencyByIdArgs) => Promise<CurrencyTypeBE | null>;
+export declare const unitCurrencyById: ({ id, includePreference, prisma, }: UnitCurrencyByIdArgs) => Promise<CurrencyBE | null>;
 /**
  * Creates or updates a currency
  * @param {UpdateCurrencyArgs} args - Object containing prisma client and currency data
- * @returns {Promise<CurrencyTypeBE>} Created or updated currency
+ * @returns {Promise<CurrencyBE>} Created or updated currency
  */
-export declare const updateCurrency: ({ code, enabled, id, isDefault, label, preferenceId, prisma, }: UpdateCurrencyArgs) => Promise<CurrencyTypeBE>;
+export declare const updateCurrency: ({ code, enabled, id, isDefault, label, preferenceId, prisma, }: UpdateCurrencyArgs) => Promise<CurrencyBE>;
 /**
  * Deletes a currency by ID
  * @param {DeleteCurrencyArgs} args - Object containing prisma client and query where conditions
- * @returns {Promise<CurrencyTypeBE>} Deleted currency
+ * @returns {Promise<CurrencyBE>} Deleted currency
  * @throws {Error} If currency ID is not provided or currency not found
  */
-export declare const deleteCurrency: ({ id, prisma, }: DeleteCurrencyArgs) => Promise<CurrencyTypeBE>;
-export {};
+export declare const deleteCurrency: ({ id, prisma, }: DeleteCurrencyArgs) => Promise<CurrencyBE>;

package/api/stellar-solutions/currency/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.deleteCurrency = exports.updateCurrency = exports.unitCurrencyById = exports.listCurrency = void 0;
+__exportStar(require("./cache"), exports);
 var multi_part_search_1 = require("../../../general/multi-part-search");
 /**
  * Retrieves currencies with pagination and filtering
  * @param {ListCurrencyArgs} args - Object containing prisma client, pagination, and query options
- * @returns {Promise<[number, Array<CurrencyTypeBE>]>} Tuple containing total count and array of currencies
+ * @returns {Promise<[number, Array<CurrencyBE>]>} Tuple containing total count and array of currencies
  */
 var listCurrency = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var orderBy, include, idSearchQuery, labelSearchQuery, where, _c, count, items;
@@ -115,7 +130,7 @@ exports.listCurrency = listCurrency;
 /**
  * Retrieves a single currency by ID
  * @param {UnitCurrencyByIdArgs} args - Object containing prisma client and query where conditions
- * @returns {Promise<CurrencyTypeBE | null>} Currency if found, null otherwise
+ * @returns {Promise<CurrencyBE | null>} Currency if found, null otherwise
  */
 var unitCurrencyById = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var include, where, currency;
@@ -146,7 +161,7 @@ exports.unitCurrencyById = unitCurrencyById;
 /**
  * Creates or updates a currency
  * @param {UpdateCurrencyArgs} args - Object containing prisma client and currency data
- * @returns {Promise<CurrencyTypeBE>} Created or updated currency
+ * @returns {Promise<CurrencyBE>} Created or updated currency
  */
 var updateCurrency = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var currencyData, where, currency;
@@ -185,7 +200,7 @@ exports.updateCurrency = updateCurrency;
 /**
  * Deletes a currency by ID
  * @param {DeleteCurrencyArgs} args - Object containing prisma client and query where conditions
- * @returns {Promise<CurrencyTypeBE>} Deleted currency
+ * @returns {Promise<CurrencyBE>} Deleted currency
  * @throws {Error} If currency ID is not provided or currency not found
  */
 var deleteCurrency = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {

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

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