@react-pakistan/util-functions 1.25.39 → 1.25.40

package/general/fetch-data.d.ts

@@ -1,11 +1,13 @@
 import { API_METHODS } from '../constants/api-methods';
+export type FetchDataParamValue = string | number | boolean | null | undefined;
 export interface FetchDataParams {
     url: string;
     method?: API_METHODS;
     body?: string;
     headers?: Record<string, string>;
+    params?: Record<string, FetchDataParamValue>;
 }
-export declare const fetchData: ({ url, method, body, headers, }: FetchDataParams) => Promise<{
+export declare const fetchData: ({ url, method, body, headers, params, }: FetchDataParams) => Promise<{
     data: any | undefined;
     error: Error | undefined;
 }>;

package/general/fetch-data.js

@@ -49,14 +49,29 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchData = void 0;
 var api_methods_1 = require("../constants/api-methods");
+var buildUrl = function (url, params) {
+    if (!params)
+        return url;
+    var filteredEntries = Object.entries(params).filter(function (entry) {
+        return entry[1] !== null && entry[1] !== undefined;
+    });
+    if (filteredEntries.length === 0)
+        return url;
+    var searchParams = new URLSearchParams(filteredEntries.map(function (_a) {
+        var key = _a[0], value = _a[1];
+        return [key, String(value)];
+    }));
+    var separator = url.includes('?') ? '&' : '?';
+    return "".concat(url).concat(separator).concat(searchParams.toString());
+};
 var fetchData = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var data, error, res, err_1;
-    var url = _b.url, _c = _b.method, method = _c === void 0 ? api_methods_1.API_METHODS.GET : _c, body = _b.body, headers = _b.headers;
+    var url = _b.url, _c = _b.method, method = _c === void 0 ? api_methods_1.API_METHODS.GET : _c, body = _b.body, headers = _b.headers, params = _b.params;
     return __generator(this, function (_d) {
         switch (_d.label) {
             case 0:
                 _d.trys.push([0, 3, , 4]);
-                return [4 /*yield*/, fetch(url, __assign(__assign({ method: method }, (headers ? { headers: headers } : {})), (method !== api_methods_1.API_METHODS.GET && body && { body: body })))];
+                return [4 /*yield*/, fetch(buildUrl(url, params), __assign(__assign({ method: method }, (headers ? { headers: headers } : {})), (method !== api_methods_1.API_METHODS.GET && body && { body: body })))];
             case 1:
                 res = _d.sent();
                 return [4 /*yield*/, res.json()];

package/general/generic-cache.d.ts

@@ -132,6 +132,27 @@ export declare const getCachedSingleItemSync: <T>(cacheKey: string, expirationMs
  * const workspace = await getCachedSingleItem<WorkspaceBE>(config, { subdomain: 'school1' });
  */
 export declare const getCachedSingleItem: <T>(config: CacheConfig, params?: Record<string, string>, headers?: Record<string, string>) => Promise<T | null>;
+/**
+ * Get cached data but fall back to the API when sync cache is empty.
+ *
+ * This helper first performs a quick synchronous cache check via
+ * `getCachedDataSync`. If that returns an empty result it will call
+ * the async `getCachedData` to fetch fresh data from the API and return
+ * the result. Use this when callers want a fast-path cache read but also
+ * need the ability to recall the API transparently when cache is missing.
+ */
+export declare const getCachedDataWithFallback: <T>(config: CacheConfig, params?: Record<string, unknown>, headers?: Record<string, string>) => Promise<ListResponse<T>>;
+/**
+ * Async variant to get a single item by ID with API fallback.
+ *
+ * Unlike `getCachedItemById` (sync), this function will call the API
+ * (via `getCachedDataWithFallback`) when the item is not available in
+ * the local cache. Requires a full `CacheConfig` so the API URL is
+ * available for fetching.
+ */
+export declare const getCachedItemByIdAsync: <T extends {
+    id: string;
+}>(config: CacheConfig, itemId: string, params?: Record<string, unknown>, headers?: Record<string, string>) => Promise<T | null>;
 /**
  * Invalidate (remove) cache for a module
  * Useful after create/update/delete operations

package/general/generic-cache.js

@@ -72,7 +72,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCacheStale = exports.preloadCache = exports.invalidateCache = exports.getCachedSingleItem = exports.getCachedSingleItemSync = exports.getCachedItemById = exports.getCachedData = exports.getCachedDataSync = void 0;
+exports.isCacheStale = exports.preloadCache = exports.invalidateCache = exports.getCachedItemByIdAsync = exports.getCachedDataWithFallback = exports.getCachedSingleItem = exports.getCachedSingleItemSync = exports.getCachedItemById = exports.getCachedData = exports.getCachedDataSync = void 0;
 var constants_1 = require("../constants");
 var fetch_data_1 = require("./fetch-data");
 var local_storage_1 = require("../local-storage");
@@ -508,6 +508,86 @@ var getCachedSingleItem = function (config, params, headers) { return __awaiter(
     });
 }); };
 exports.getCachedSingleItem = getCachedSingleItem;
+/**
+ * Get cached data but fall back to the API when sync cache is empty.
+ *
+ * This helper first performs a quick synchronous cache check via
+ * `getCachedDataSync`. If that returns an empty result it will call
+ * the async `getCachedData` to fetch fresh data from the API and return
+ * the result. Use this when callers want a fast-path cache read but also
+ * need the ability to recall the API transparently when cache is missing.
+ */
+var getCachedDataWithFallback = function (config, params, headers) { return __awaiter(void 0, void 0, void 0, function () {
+    var expirationMs, sync, error_3;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                expirationMs = (_a = config.expirationMs) !== null && _a !== void 0 ? _a : constants_1.ONE_DAY_IN_MS;
+                _b.label = 1;
+            case 1:
+                _b.trys.push([1, 3, , 4]);
+                sync = (0, exports.getCachedDataSync)(config.cacheKey, expirationMs);
+                if (sync &&
+                    sync.count > 0 &&
+                    Array.isArray(sync.items) &&
+                    sync.items.length > 0) {
+                    return [2 /*return*/, sync];
+                }
+                return [4 /*yield*/, (0, exports.getCachedData)({ config: config, params: params, headers: headers })];
+            case 2: 
+            // Sync cache empty — fetch from API and return result
+            return [2 /*return*/, _b.sent()];
+            case 3:
+                error_3 = _b.sent();
+                console.error("Error in getCachedDataWithFallback for ".concat(config.cacheKey, ":"), error_3);
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedDataWithFallback = getCachedDataWithFallback;
+/**
+ * Async variant to get a single item by ID with API fallback.
+ *
+ * Unlike `getCachedItemById` (sync), this function will call the API
+ * (via `getCachedDataWithFallback`) when the item is not available in
+ * the local cache. Requires a full `CacheConfig` so the API URL is
+ * available for fetching.
+ */
+var getCachedItemByIdAsync = function (config, itemId, params, headers) { return __awaiter(void 0, void 0, void 0, function () {
+    var raw, found, list, error_4;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                if (!itemId)
+                    return [2 /*return*/, null];
+                _a.label = 1;
+            case 1:
+                _a.trys.push([1, 3, , 4]);
+                raw = (0, local_storage_1.getStorageValue)(config.cacheKey);
+                if (isCachedArrayShape(raw)) {
+                    found = raw.items.find(function (i) { return i.id === itemId; });
+                    if (found)
+                        return [2 /*return*/, found];
+                }
+                if (isCachedMapShape(raw)) {
+                    if (raw.items && raw.items[itemId])
+                        return [2 /*return*/, raw.items[itemId]];
+                }
+                return [4 /*yield*/, (0, exports.getCachedDataWithFallback)(config, params, headers)];
+            case 2:
+                list = _a.sent();
+                return [2 /*return*/, list.items.find(function (i) { return i.id === itemId; }) || null];
+            case 3:
+                error_4 = _a.sent();
+                console.error("Error in getCachedItemByIdAsync for ".concat(config.cacheKey, ":"), error_4);
+                return [2 /*return*/, null];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedItemByIdAsync = getCachedItemByIdAsync;
 // ============================================================================
 // CACHE UTILITIES
 // ============================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-pakistan/util-functions",
-  "version": "1.25.39",
+  "version": "1.25.40",
   "description": "A library of all util functions",
   "main": "index.js",
   "scripts": {