@react-pakistan/util-functions 1.25.18 → 1.25.20

package/general/fetch-data.d.ts

@@ -3,8 +3,9 @@ export interface FetchDataParams {
     url: string;
     method?: API_METHODS;
     body?: string;
+    headers?: Record<string, string>;
 }
-export declare const fetchData: ({ url, method, body, }: FetchDataParams) => Promise<{
+export declare const fetchData: ({ url, method, body, headers, }: FetchDataParams) => Promise<{
     data: any | undefined;
     error: Error | undefined;
 }>;

package/general/fetch-data.js

@@ -51,12 +51,12 @@ exports.fetchData = void 0;
 var api_methods_1 = require("../constants/api-methods");
 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;
+    var url = _b.url, _c = _b.method, method = _c === void 0 ? api_methods_1.API_METHODS.GET : _c, body = _b.body, headers = _b.headers;
     return __generator(this, function (_d) {
         switch (_d.label) {
             case 0:
                 _d.trys.push([0, 3, , 4]);
-                return [4 /*yield*/, fetch(url, __assign({ method: method }, (method !== api_methods_1.API_METHODS.GET && body && { body: body })))];
+                return [4 /*yield*/, fetch(url, __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

@@ -13,7 +13,9 @@
  * The main async helper `getCachedData` now accepts a single options object
  * (`GetCachedDataOptions`) which includes `config`, optional `searchQuery`,
  * `filters`, `pageLimit` and extra `params` for the list API. Module cache
- * wrappers should call `getCachedData({ config, searchQuery, filters, pageLimit, params })`.
+ * wrappers should call `getCachedData({ config, searchQuery, filters, pageLimit, params, headers })`.
+ * Both `getCachedData` and `getCachedSingleItem` accept an optional `headers`
+ * object which will be forwarded to the underlying `fetchData` calls.
  *
  * Organization:
  * - Types
@@ -31,6 +33,7 @@ interface CacheConfig {
 interface GetCachedDataOptions {
     config: CacheConfig;
     params?: Record<string, unknown>;
+    headers?: Record<string, string>;
 }
 interface ListResponse<T> {
     count: number;
@@ -117,7 +120,7 @@ export declare const getCachedSingleItemSync: <T>(cacheKey: string, expirationMs
  * const config = { cacheKey: LS_KEYS.WORKSPACE, apiUrl: '/api/workspace', responseKey: 'workspace' };
  * const workspace = await getCachedSingleItem<WorkspaceBE>(config, { subdomain: 'school1' });
  */
-export declare const getCachedSingleItem: <T>(config: CacheConfig, params?: Record<string, string>) => Promise<T | null>;
+export declare const getCachedSingleItem: <T>(config: CacheConfig, params?: Record<string, string>, headers?: Record<string, string>) => Promise<T | null>;
 /**
  * Invalidate (remove) cache for a module
  * Useful after create/update/delete operations

package/general/generic-cache.js

@@ -14,7 +14,9 @@
  * The main async helper `getCachedData` now accepts a single options object
  * (`GetCachedDataOptions`) which includes `config`, optional `searchQuery`,
  * `filters`, `pageLimit` and extra `params` for the list API. Module cache
- * wrappers should call `getCachedData({ config, searchQuery, filters, pageLimit, params })`.
+ * wrappers should call `getCachedData({ config, searchQuery, filters, pageLimit, params, headers })`.
+ * Both `getCachedData` and `getCachedSingleItem` accept an optional `headers`
+ * object which will be forwarded to the underlying `fetchData` calls.
  *
  * Organization:
  * - Types
@@ -79,7 +81,9 @@ function isCachedArrayShape(v) {
     if (!v || typeof v !== 'object')
         return false;
     var o = v;
-    return Array.isArray(o.items) && typeof o.cachedAt === 'string';
+    return (Array.isArray(o.items) &&
+        typeof o.cachedAt === 'string' &&
+        typeof o.count === 'number');
 }
 function isCachedMapShape(v) {
     if (!v || typeof v !== 'object')
@@ -162,12 +166,12 @@ exports.getCachedDataSync = getCachedDataSync;
  * const active = await getCachedData<UserBE>({ config, filters: { enabled: true }, pageLimit: 200 });
  */
 var getCachedData = function (opts) { return __awaiter(void 0, void 0, void 0, function () {
-    var config, params, cacheKey, apiUrl, responseKey, expirationMs, fallBackPageLimit, fallBackCurrentPage, filters, searchQuery, paramsWithoutFilters_1, otherParams_1, queryObj_1, searchParams_1, response_1, items_1, raw, currentTime, cachedTime, ageInMs, cachedTime, ageInMs, itemsArray, paramsWithoutFilters_2, otherParams, queryObj, searchParams, response, itemsRaw, items, count, itemsMap, updatedCache, error_1;
+    var config, params, headers, cacheKey, apiUrl, responseKey, expirationMs, fallBackPageLimit, fallBackCurrentPage, filters, searchQuery, paramsWithoutFilters_1, otherParams_1, queryObj_1, searchParams_1, response_1, items_1, raw, currentTime, cachedTime, ageInMs, cachedTime, ageInMs, itemsArray, paramsWithoutFilters_2, otherParams, queryObj, searchParams, response, itemsRaw, items, count, shouldCache, itemsMap, updatedCache, error_1;
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
     return __generator(this, function (_m) {
         switch (_m.label) {
             case 0:
-                config = opts.config, params = opts.params;
+                config = opts.config, params = opts.params, headers = opts.headers;
                 cacheKey = config.cacheKey, apiUrl = config.apiUrl, responseKey = config.responseKey;
                 expirationMs = (_a = config.expirationMs) !== null && _a !== void 0 ? _a : constants_1.ONE_DAY_IN_MS;
                 fallBackPageLimit = (_c = (_b = params === null || params === void 0 ? void 0 : params.pageLimit) === null || _b === void 0 ? void 0 : _b.toString()) !== null && _c !== void 0 ? _c : '100';
@@ -197,6 +201,7 @@ var getCachedData = function (opts) { return __awaiter(void 0, void 0, void 0, f
                 return [4 /*yield*/, (0, fetch_data_1.fetchData)({
                         url: "".concat(apiUrl, "?").concat(searchParams_1.toString()),
                         method: constants_1.API_METHODS.GET,
+                        headers: headers,
                     })];
             case 2:
                 response_1 = _m.sent();
@@ -238,17 +243,18 @@ var getCachedData = function (opts) { return __awaiter(void 0, void 0, void 0, f
                 return [4 /*yield*/, (0, fetch_data_1.fetchData)({
                         url: "".concat(apiUrl, "?").concat(searchParams.toString()),
                         method: constants_1.API_METHODS.GET,
+                        headers: headers,
                     })];
             case 4:
                 response = _m.sent();
-                itemsRaw = (responseKey
-                    ? (_j = response === null || response === void 0 ? void 0 : response.data) === null || _j === void 0 ? void 0 : _j[responseKey]
-                    : ((_k = response === null || response === void 0 ? void 0 : response.data) === null || _k === void 0 ? void 0 : _k.items) || (response === null || response === void 0 ? void 0 : response.data)) || [];
+                itemsRaw = (responseKey ? (_j = response === null || response === void 0 ? void 0 : response.data) === null || _j === void 0 ? void 0 : _j[responseKey] : (_k = response === null || response === void 0 ? void 0 : response.data) === null || _k === void 0 ? void 0 : _k.items) ||
+                    [];
                 items = Array.isArray(itemsRaw)
                     ? itemsRaw
                     : [itemsRaw];
-                count = ((_l = response === null || response === void 0 ? void 0 : response.data) === null || _l === void 0 ? void 0 : _l.count) || items.length;
-                if (items.length > 0) {
+                count = (_l = response === null || response === void 0 ? void 0 : response.data) === null || _l === void 0 ? void 0 : _l.count;
+                shouldCache = Array.isArray(itemsRaw) && count && items.length > 0;
+                if (shouldCache) {
                     itemsMap = items.reduce(function (acc, item, idx) {
                         var _a, _b;
                         var obj = item;
@@ -260,10 +266,15 @@ var getCachedData = function (opts) { return __awaiter(void 0, void 0, void 0, f
                     updatedCache = {
                         items: itemsMap,
                         cachedAt: new Date().toISOString(),
+                        count: count,
                     };
                     (0, local_storage_1.setStorageValue)(cacheKey, updatedCache);
                 }
-                return [2 /*return*/, { count: count, items: items }];
+                // Return count as number when present, otherwise fallback to items.length
+                return [2 /*return*/, {
+                        count: count,
+                        items: items,
+                    }];
             case 5:
                 error_1 = _m.sent();
                 console.error("Error fetching data for ".concat(cacheKey, ":"), error_1);
@@ -359,7 +370,7 @@ exports.getCachedSingleItemSync = getCachedSingleItemSync;
  * const config = { cacheKey: LS_KEYS.WORKSPACE, apiUrl: '/api/workspace', responseKey: 'workspace' };
  * const workspace = await getCachedSingleItem<WorkspaceBE>(config, { subdomain: 'school1' });
  */
-var getCachedSingleItem = function (config, params) { return __awaiter(void 0, void 0, void 0, function () {
+var getCachedSingleItem = function (config, params, headers) { return __awaiter(void 0, void 0, void 0, function () {
     var cacheKey, apiUrl, expirationMs, cachedData, currentTime, cachedTime, ageInMs, queryParams, response, item, updatedCache, error_2;
     var _a;
     return __generator(this, function (_b) {
@@ -385,6 +396,7 @@ var getCachedSingleItem = function (config, params) { return __awaiter(void 0, v
                 return [4 /*yield*/, (0, fetch_data_1.fetchData)({
                         url: "".concat(apiUrl).concat(queryParams),
                         method: constants_1.API_METHODS.GET,
+                        headers: headers,
                     })];
             case 2:
                 response = _b.sent();

package/hooks/use-module-entity-v2.d.ts

@@ -75,6 +75,8 @@ interface Params {
     listDeps?: Array<any> | Array<string>;
     listParams: object;
     listUrl: string;
+    /** Optional headers to include on every fetch made by this hook */
+    headers?: Record<string, string>;
     searchQuery: string;
     unitByIdUrl: string;
     unitUrl: string;
@@ -96,5 +98,5 @@ interface Return {
     updateFetchNow: (url?: string, config?: FetchConfig) => void;
     updateLoading: boolean;
 }
-export declare const useModuleEntityV2: ({ byIdCallback, byIdDeps, byIdParams, deleteCallback, deleteDeps, deleteParams, listCallback, listDeps, listParams, listUrl, searchQuery, unitByIdUrl, unitUrl, updateCallback, updateDeps, updateParams, }: Params) => Return;
+export declare const useModuleEntityV2: ({ byIdCallback, byIdDeps, byIdParams, deleteCallback, deleteDeps, deleteParams, listCallback, listDeps, listParams, listUrl, headers, searchQuery, unitByIdUrl, unitUrl, updateCallback, updateDeps, updateParams, }: Params) => Return;
 export {};

package/hooks/use-module-entity-v2.js

@@ -74,7 +74,7 @@ var constants_1 = require("../constants");
 var use_fetch_1 = require("./use-fetch");
 var use_debounce_1 = require("./use-debounce");
 var useModuleEntityV2 = function (_a) {
-    var byIdCallback = _a.byIdCallback, _b = _a.byIdDeps, byIdDeps = _b === void 0 ? [] : _b, byIdParams = _a.byIdParams, deleteCallback = _a.deleteCallback, _c = _a.deleteDeps, deleteDeps = _c === void 0 ? [] : _c, deleteParams = _a.deleteParams, listCallback = _a.listCallback, _d = _a.listDeps, listDeps = _d === void 0 ? [] : _d, listParams = _a.listParams, listUrl = _a.listUrl, searchQuery = _a.searchQuery, unitByIdUrl = _a.unitByIdUrl, unitUrl = _a.unitUrl, updateCallback = _a.updateCallback, _e = _a.updateDeps, updateDeps = _e === void 0 ? [] : _e, updateParams = _a.updateParams;
+    var byIdCallback = _a.byIdCallback, _b = _a.byIdDeps, byIdDeps = _b === void 0 ? [] : _b, byIdParams = _a.byIdParams, deleteCallback = _a.deleteCallback, _c = _a.deleteDeps, deleteDeps = _c === void 0 ? [] : _c, deleteParams = _a.deleteParams, listCallback = _a.listCallback, _d = _a.listDeps, listDeps = _d === void 0 ? [] : _d, listParams = _a.listParams, listUrl = _a.listUrl, headers = _a.headers, searchQuery = _a.searchQuery, unitByIdUrl = _a.unitByIdUrl, unitUrl = _a.unitUrl, updateCallback = _a.updateCallback, _e = _a.updateDeps, updateDeps = _e === void 0 ? [] : _e, updateParams = _a.updateParams;
     var debouncedQuery = (0, use_debounce_1.useDebounce)(searchQuery, 800);
     // debounced list refresh to batch multiple updates/deletes
     var refreshTimerRef = (0, react_1.useRef)(null);
@@ -88,6 +88,7 @@ var useModuleEntityV2 = function (_a) {
     var _f = (0, use_fetch_1.useFetch)(listUrl, {
         method: constants_1.API_METHODS.GET,
         params: listParams,
+        headers: headers,
         callback: listCallback,
         credentials: true,
     }, __spreadArray([debouncedQuery, listParams], listDeps, true)), listError = _f.error, listFetchNow = _f.fetchNow, listLoading = _f.loading;
@@ -102,6 +103,7 @@ var useModuleEntityV2 = function (_a) {
                 listFetchNow(undefined, {
                     method: constants_1.API_METHODS.GET,
                     params: listParams,
+                    headers: headers,
                 });
             }
             catch (_a) {
@@ -114,6 +116,7 @@ var useModuleEntityV2 = function (_a) {
     var _g = (0, use_fetch_1.useFetch)(unitUrl, {
         method: constants_1.API_METHODS.PUT,
         body: JSON.stringify(updateParams),
+        headers: headers,
         callback: function (d) {
             if (updateCallback) {
                 try {
@@ -139,12 +142,14 @@ var useModuleEntityV2 = function (_a) {
     var _h = (0, use_fetch_1.useFetch)(unitByIdUrl, {
         method: constants_1.API_METHODS.GET,
         params: byIdParams,
+        headers: headers,
         callback: byIdCallback,
     }, __spreadArray([], byIdDeps, true)), byIdError = _h.error, byIdLoading = _h.loading, byIdFetchNow = _h.fetchNow;
     // delete
     var _j = (0, use_fetch_1.useFetch)(unitUrl, {
         method: constants_1.API_METHODS.DELETE,
         body: JSON.stringify(deleteParams),
+        headers: headers,
         callback: function (d) {
             if (deleteCallback) {
                 try {

package/package.json

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