@react-pakistan/util-functions 1.24.99 → 1.25.0

package/api/stellar-solutions/expense/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.isExpensesCacheStale = exports.preloadExpenses = exports.invalidateExpensesCache = exports.getCachedExpensesByName = exports.getCachedExpenseById = exports.getCachedExpenses = exports.getCachedExpensesSync = 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 expenses from cache only
+ * Returns cached data immediately if available and fresh, otherwise returns empty array
+ * Does not trigger any API calls
+ *
+ * @returns ExpenseBE[] - Array of cached expenses or empty array wrapper ({count, items})
+ *
+ * @example
+ * const expenses = getCachedExpensesSync();
+ * if (expenses.items.length > 0) {
+ *   console.log(expenses.items[0].name);
+ * }
+ */
+var getCachedExpensesSync = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.EXPENSES);
+        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.expenses.length,
+                items: cachedData.expenses,
+            };
+        }
+        return { count: 0, items: [] };
+    }
+    catch (error) {
+        console.error('Error getting cached expenses:', error);
+        return { count: 0, items: [] };
+    }
+};
+exports.getCachedExpensesSync = getCachedExpensesSync;
+/**
+ * Utility function to get expenses from cache or fetch from API
+ *
+ * This function manages a localStorage cache of expenses with the following logic:
+ * - If expenses exist in cache and are less than 1 day old, return cached version
+ * - If expenses exist but are older than 1 day, fetch fresh data and update cache
+ * - If expenses don't exist in cache, fetch from API and cache them
+ *
+ * @param searchQuery - Optional search query to filter expenses
+ * @param filters - Optional filters object to apply additional filtering (bypasses cache)
+ * @param pageLimit - Number of expenses to fetch (default: 100)
+ * @returns Promise<{count:number, items: ExpenseBE[]}> - Paged expenses
+ *
+ * @example
+ * const expenses = await getCachedExpenses();
+ * console.log(expenses.items[0].name);
+ *
+ * // With search
+ * const filtered = await getCachedExpenses('Office');
+ *
+ * // With filters
+ * const filteredByCategory = await getCachedExpenses(undefined, { expenseCategoryId: 'cat-123' });
+ */
+var getCachedExpenses = 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.EXPENSES,
+                            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.EXPENSES);
+                    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.expenses.length,
+                                    items: cachedData.expenses,
+                                }];
+                        }
+                    }
+                    return [4 /*yield*/, (0, fetch_data_1.fetchData)({
+                            url: constants_1.API_ROUTES.EXPENSES,
+                            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 = {
+                            expenses: response.data.items,
+                            cachedAt: new Date().toISOString(),
+                        };
+                        (0, set_storage_value_1.setStorageValue)(type_1.LS_KEYS.EXPENSES, updatedCache);
+                        return [2 /*return*/, response.data];
+                    }
+                    return [2 /*return*/, { count: 0, items: [] }];
+                case 4:
+                    error_1 = _b.sent();
+                    console.error('Error fetching expenses:', error_1);
+                    return [2 /*return*/, { count: 0, items: [] }];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.getCachedExpenses = getCachedExpenses;
+/**
+ * Utility function to get a specific expense by ID from cache
+ * If not found in cache, returns null (does not trigger API call)
+ *
+ * @param expenseId - The ID of the expense to retrieve
+ * @returns ExpenseBE | null - The expense or null if not found
+ *
+ * @example
+ * const expense = getCachedExpenseById('expense-123');
+ * if (expense) {
+ *   console.log(expense.name);
+ * }
+ */
+var getCachedExpenseById = function (expenseId) {
+    if (!expenseId) {
+        return null;
+    }
+    try {
+        var expenses = (0, exports.getCachedExpensesSync)().items;
+        return expenses.find(function (expense) { return expense.id === expenseId; }) || null;
+    }
+    catch (error) {
+        console.error('Error getting cached expense by ID:', error);
+        return null;
+    }
+};
+exports.getCachedExpenseById = getCachedExpenseById;
+/**
+ * Utility function to get expenses by name from cache
+ * If not found in cache, returns empty array (does not trigger API call)
+ *
+ * @param name - The name of the expense to search for
+ * @returns ExpenseBE[] - Array of matching expenses or empty array
+ *
+ * @example
+ * const expenses = getCachedExpensesByName('Office');
+ * console.log(expenses.length);
+ */
+var getCachedExpensesByName = function (name) {
+    if (!name) {
+        return [];
+    }
+    try {
+        var expenses = (0, exports.getCachedExpensesSync)().items;
+        return expenses.filter(function (expense) {
+            return expense.name.toLowerCase().includes(name.toLowerCase());
+        });
+    }
+    catch (error) {
+        console.error('Error getting cached expenses by name:', error);
+        return [];
+    }
+};
+exports.getCachedExpensesByName = getCachedExpensesByName;
+/**
+ * Utility function to invalidate (remove) expenses from cache
+ * Useful when expenses have been updated and you want to force a refresh
+ *
+ * @example
+ * invalidateExpensesCache();
+ * const freshExpenses = await getCachedExpenses();
+ */
+var invalidateExpensesCache = function () {
+    try {
+        localStorage.removeItem(type_1.LS_KEYS.EXPENSES);
+    }
+    catch (error) {
+        console.error('Error invalidating expenses cache:', error);
+    }
+};
+exports.invalidateExpensesCache = invalidateExpensesCache;
+/**
+ * Utility function to preload expenses into cache
+ * Useful to call on app initialization or login
+ *
+ * @returns Promise<{count:number, items: ExpenseBE[]}> - Array of preloaded expenses
+ *
+ * @example
+ * // On app initialization
+ * await preloadExpenses();
+ */
+var preloadExpenses = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, (0, exports.getCachedExpenses)()];
+    });
+}); };
+exports.preloadExpenses = preloadExpenses;
+/**
+ * Utility function to check if expenses 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 (isExpensesCacheStale()) {
+ *   await getCachedExpenses(); // This will fetch fresh data
+ * }
+ */
+var isExpensesCacheStale = function () {
+    try {
+        var cachedData = (0, get_storage_value_1.getStorageValue)(type_1.LS_KEYS.EXPENSES);
+        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 expenses cache staleness:', error);
+        return true;
+    }
+};
+exports.isExpensesCacheStale = isExpensesCacheStale;

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

@@ -1,4 +1,5 @@
-import { ExpenseTypeBE } from '../type';
+export * from './cache';
+import { ExpenseBE } from '../type';
 type PrismaClient = any;
 export interface ListExpenseArgs {
     currentPage?: number;
@@ -33,26 +34,25 @@ export interface DeleteExpenseArgs {
 /**
  * Retrieves expenses with pagination and filtering
  * @param {ListExpenseArgs} args - Object containing prisma client, pagination, and query options
- * @returns {Promise<[number, Array<ExpenseTypeBE>]>} Tuple containing total count and array of expenses
+ * @returns {Promise<[number, Array<ExpenseBE>]>} Tuple containing total count and array of expenses
  */
-export declare const listExpense: ({ currentPage, includeExpenseCategory, orderByColumn, orderByDirection, pageLimit, prisma, searchQuery, }: ListExpenseArgs) => Promise<[number, Array<ExpenseTypeBE>]>;
+export declare const listExpense: ({ currentPage, includeExpenseCategory, orderByColumn, orderByDirection, pageLimit, prisma, searchQuery, }: ListExpenseArgs) => Promise<[number, Array<ExpenseBE>]>;
 /**
  * Retrieves a single expense by ID
  * @param {UnitExpenseByIdArgs} args - Object containing prisma client, expense id, and optional query parameters
- * @returns {Promise<ExpenseTypeBE | null>} Expense with optional relations if found, null otherwise
+ * @returns {Promise<ExpenseBE | null>} Expense with optional relations if found, null otherwise
  */
-export declare const unitExpenseById: ({ id, includeExpenseCategory, prisma, }: UnitExpenseByIdArgs) => Promise<ExpenseTypeBE | null>;
+export declare const unitExpenseById: ({ id, includeExpenseCategory, prisma, }: UnitExpenseByIdArgs) => Promise<ExpenseBE | null>;
 /**
  * Creates or updates an expense using upsert
  * @param {UpdateExpenseArgs} args - Object containing prisma client and expense data
- * @returns {Promise<ExpenseTypeBE>} Created or updated expense
+ * @returns {Promise<ExpenseBE>} Created or updated expense
  */
-export declare const updateExpense: ({ currency, description, expenseCategoryId, id, includeExpenseCategory, name, prisma, ref, total, }: UpdateExpenseArgs) => Promise<ExpenseTypeBE>;
+export declare const updateExpense: ({ currency, description, expenseCategoryId, id, includeExpenseCategory, name, prisma, ref, total, }: UpdateExpenseArgs) => Promise<ExpenseBE>;
 /**
  * Deletes an expense by ID
  * @param {DeleteExpenseArgs} args - Object containing prisma client, expense id, and optional query parameters
- * @returns {Promise<ExpenseTypeBE>} Deleted expense
+ * @returns {Promise<ExpenseBE>} Deleted expense
  * @throws {Error} If expense ID is not provided or expense not found
  */
-export declare const deleteExpense: ({ id, includeExpenseCategory, prisma, }: DeleteExpenseArgs) => Promise<ExpenseTypeBE>;
-export {};
+export declare const deleteExpense: ({ id, includeExpenseCategory, prisma, }: DeleteExpenseArgs) => Promise<ExpenseBE>;

package/api/stellar-solutions/expense/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.deleteExpense = exports.updateExpense = exports.unitExpenseById = exports.listExpense = void 0;
+__exportStar(require("./cache"), exports);
 var multi_part_search_1 = require("../../../general/multi-part-search");
 /**
  * Retrieves expenses with pagination and filtering
  * @param {ListExpenseArgs} args - Object containing prisma client, pagination, and query options
- * @returns {Promise<[number, Array<ExpenseTypeBE>]>} Tuple containing total count and array of expenses
+ * @returns {Promise<[number, Array<ExpenseBE>]>} Tuple containing total count and array of expenses
  */
 var listExpense = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var include, orderBy, idSearchQuery, nameSearchQuery, descriptionSearchQuery, refSearchQuery, where, _c, count, items;
@@ -123,7 +138,7 @@ exports.listExpense = listExpense;
 /**
  * Retrieves a single expense by ID
  * @param {UnitExpenseByIdArgs} args - Object containing prisma client, expense id, and optional query parameters
- * @returns {Promise<ExpenseTypeBE | null>} Expense with optional relations if found, null otherwise
+ * @returns {Promise<ExpenseBE | null>} Expense with optional relations if found, null otherwise
  */
 var unitExpenseById = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var include, where, expense;
@@ -154,7 +169,7 @@ exports.unitExpenseById = unitExpenseById;
 /**
  * Creates or updates an expense using upsert
  * @param {UpdateExpenseArgs} args - Object containing prisma client and expense data
- * @returns {Promise<ExpenseTypeBE>} Created or updated expense
+ * @returns {Promise<ExpenseBE>} Created or updated expense
  */
 var updateExpense = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var expenseData, include, where, expense;
@@ -198,7 +213,7 @@ exports.updateExpense = updateExpense;
 /**
  * Deletes an expense by ID
  * @param {DeleteExpenseArgs} args - Object containing prisma client, expense id, and optional query parameters
- * @returns {Promise<ExpenseTypeBE>} Deleted expense
+ * @returns {Promise<ExpenseBE>} Deleted expense
  * @throws {Error} If expense ID is not provided or expense not found
  */
 var deleteExpense = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {

package/api/stellar-solutions/expense-category/cache.d.ts

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