@react-pakistan/util-functions 1.24.98 → 1.25.0

package/api/stellar-solutions/payment-mode/index.js

@@ -1,4 +1,18 @@
 "use strict";
+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) {
@@ -46,6 +60,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deletePaymentMode = exports.updatePaymentMode = exports.unitPaymentModeById = exports.listPaymentMode = void 0;
+__exportStar(require("./cache"), exports);
 var multi_part_search_1 = require("../../../general/multi-part-search");
 /**
  * Retrieves a paginated list of payment modes

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

@@ -0,0 +1,85 @@
+import { PreferenceBE } from '../type';
+/**
+ * Synchronous utility function to get preferences from cache only
+ * Returns cached data immediately if available and fresh, otherwise returns empty array
+ * Does not trigger any API calls
+ *
+ * @returns PreferenceBE[] - Array of cached preferences or empty array wrapper ({count, items})
+ *
+ * @example
+ * const preferences = getCachedPreferencesSync();
+ * if (preferences.items.length > 0) {
+ *   console.log(preferences.items[0].onboarding);
+ * }
+ */
+export declare const getCachedPreferencesSync: () => {
+    count: number;
+    items: PreferenceBE[];
+};
+/**
+ * Utility function to get preferences from cache or fetch from API
+ *
+ * This function manages a localStorage cache of preferences with the following logic:
+ * - If preferences exist in cache and are less than 1 day old, return cached version
+ * - If preferences exist but are older than 1 day, fetch fresh data and update cache
+ * - If preferences don't exist in cache, fetch from API and cache them
+ *
+ * @returns Promise<{count:number, items: PreferenceBE[]}> - Paged preferences
+ *
+ * @example
+ * const preferences = await getCachedPreferences();
+ * console.log(preferences.items[0].onboarding);
+ */
+export declare const getCachedPreferences: () => Promise<{
+    count: number;
+    items: PreferenceBE[];
+}>;
+/**
+ * Utility function to get a specific preference by ID from cache
+ * If not found in cache, returns null (does not trigger API call)
+ *
+ * @param preferenceId - The ID of the preference to retrieve
+ * @returns PreferenceBE | null - The preference or null if not found
+ *
+ * @example
+ * const preference = getCachedPreferenceById('pref-123');
+ * if (preference) {
+ *   console.log(preference.onboarding);
+ * }
+ */
+export declare const getCachedPreferenceById: (preferenceId: string) => PreferenceBE | null;
+/**
+ * Utility function to invalidate (remove) preferences from cache
+ * Useful when preferences have been updated and you want to force a refresh
+ *
+ * @example
+ * invalidatePreferencesCache();
+ * const freshPreferences = await getCachedPreferences();
+ */
+export declare const invalidatePreferencesCache: () => void;
+/**
+ * Utility function to preload preferences into cache
+ * Useful to call on app initialization or login
+ *
+ * @returns Promise<{count:number, items: PreferenceBE[]}> - Array of preloaded preferences
+ *
+ * @example
+ * // On app initialization
+ * await preloadPreferences();
+ */
+export declare const preloadPreferences: () => Promise<{
+    count: number;
+    items: PreferenceBE[];
+}>;
+/**
+ * Utility function to check if preferences 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 (isPreferencesCacheStale()) {
+ *   await getCachedPreferences(); // This will fetch fresh data
+ * }
+ */
+export declare const isPreferencesCacheStale: () => boolean;

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

@@ -0,0 +1,229 @@
+"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.isPreferencesCacheStale = exports.preloadPreferences = exports.invalidatePreferencesCache = exports.getCachedPreferenceById = exports.getCachedPreferences = exports.getCachedPreferencesSync = 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 preferences from cache only
+ * Returns cached data immediately if available and fresh, otherwise returns empty array
+ * Does not trigger any API calls
+ *
+ * @returns PreferenceBE[] - Array of cached preferences or empty array wrapper ({count, items})
+ *
+ * @example
+ * const preferences = getCachedPreferencesSync();
+ * if (preferences.items.length > 0) {
+ *   console.log(preferences.items[0].onboarding);
+ * }
+ */
+var getCachedPreferencesSync = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.PREFERENCES);
+        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_WEEK_IN_MS) {
+            return {
+                count: cachedData.preferences.length,
+                items: cachedData.preferences,
+            };
+        }
+        return { count: 0, items: [] };
+    }
+    catch (error) {
+        console.error('Error getting cached preferences:', error);
+        return { count: 0, items: [] };
+    }
+};
+exports.getCachedPreferencesSync = getCachedPreferencesSync;
+/**
+ * Utility function to get preferences from cache or fetch from API
+ *
+ * This function manages a localStorage cache of preferences with the following logic:
+ * - If preferences exist in cache and are less than 1 day old, return cached version
+ * - If preferences exist but are older than 1 day, fetch fresh data and update cache
+ * - If preferences don't exist in cache, fetch from API and cache them
+ *
+ * @returns Promise<{count:number, items: PreferenceBE[]}> - Paged preferences
+ *
+ * @example
+ * const preferences = await getCachedPreferences();
+ * console.log(preferences.items[0].onboarding);
+ */
+var getCachedPreferences = 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.PREFERENCES);
+                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_WEEK_IN_MS) {
+                        return [2 /*return*/, {
+                                count: cachedData.preferences.length,
+                                items: cachedData.preferences,
+                            }];
+                    }
+                }
+                return [4 /*yield*/, (0, fetch_data_1.fetchData)({
+                        url: constants_1.API_ROUTES.PREFERENCES,
+                        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 = {
+                        preferences: response.data.items,
+                        cachedAt: new Date().toISOString(),
+                    };
+                    (0, set_storage_value_1.setStorageValue)(type_1.LS_KEYS.PREFERENCES, updatedCache);
+                    return [2 /*return*/, response.data];
+                }
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 2:
+                error_1 = _b.sent();
+                console.error('Error fetching preferences:', error_1);
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedPreferences = getCachedPreferences;
+/**
+ * Utility function to get a specific preference by ID from cache
+ * If not found in cache, returns null (does not trigger API call)
+ *
+ * @param preferenceId - The ID of the preference to retrieve
+ * @returns PreferenceBE | null - The preference or null if not found
+ *
+ * @example
+ * const preference = getCachedPreferenceById('pref-123');
+ * if (preference) {
+ *   console.log(preference.onboarding);
+ * }
+ */
+var getCachedPreferenceById = function (preferenceId) {
+    if (!preferenceId) {
+        return null;
+    }
+    try {
+        var preferences = (0, exports.getCachedPreferencesSync)().items;
+        return preferences.find(function (pref) { return pref.id === preferenceId; }) || null;
+    }
+    catch (error) {
+        console.error('Error getting cached preference by ID:', error);
+        return null;
+    }
+};
+exports.getCachedPreferenceById = getCachedPreferenceById;
+/**
+ * Utility function to invalidate (remove) preferences from cache
+ * Useful when preferences have been updated and you want to force a refresh
+ *
+ * @example
+ * invalidatePreferencesCache();
+ * const freshPreferences = await getCachedPreferences();
+ */
+var invalidatePreferencesCache = function () {
+    try {
+        localStorage.removeItem(type_1.LS_KEYS.PREFERENCES);
+    }
+    catch (error) {
+        console.error('Error invalidating preferences cache:', error);
+    }
+};
+exports.invalidatePreferencesCache = invalidatePreferencesCache;
+/**
+ * Utility function to preload preferences into cache
+ * Useful to call on app initialization or login
+ *
+ * @returns Promise<{count:number, items: PreferenceBE[]}> - Array of preloaded preferences
+ *
+ * @example
+ * // On app initialization
+ * await preloadPreferences();
+ */
+var preloadPreferences = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, (0, exports.getCachedPreferences)()];
+    });
+}); };
+exports.preloadPreferences = preloadPreferences;
+/**
+ * Utility function to check if preferences 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 (isPreferencesCacheStale()) {
+ *   await getCachedPreferences(); // This will fetch fresh data
+ * }
+ */
+var isPreferencesCacheStale = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.PREFERENCES);
+        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 preferences cache staleness:', error);
+        return true;
+    }
+};
+exports.isPreferencesCacheStale = isPreferencesCacheStale;

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

@@ -1,3 +1,4 @@
+export * from './cache';
 import { PreferenceBE } from '../type';
 type PrismaClient = any;
 export interface ListPreferencesArgs {
@@ -22,4 +23,3 @@ export declare const listPreference: ({ orderByColumn, orderByDirection, prisma,
  * @returns {Promise<PreferenceBE>} Updated preference
  */
 export declare const updatePreference: ({ id, onboarding, prisma, }: PostPreferenceArgs) => Promise<PreferenceBE>;
-export {};

package/api/stellar-solutions/preference/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) {
@@ -48,6 +62,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updatePreference = exports.listPreference = void 0;
+__exportStar(require("./cache"), exports);
 /**
  * Retrieves all preferences
  * @param {ListPreferencesArgs} args - Object containing prisma client and ordering options

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

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