@react-pakistan/util-functions 1.25.7 → 1.25.8

package/hooks/use-fetch.d.ts

@@ -13,6 +13,17 @@ export interface FetchConfig extends Omit<RequestInit, 'credentials'> {
      * (e.g. 'omit' | 'same-origin' | 'include').
      */
     credentials?: boolean | RequestCredentials;
+    /**
+     * Query parameters to append to GET requests.
+     * Supports strings, numbers, booleans, arrays, and objects.
+     * - Primitives (string, number, boolean) are converted to strings
+     * - Arrays are repeated as multiple params with the same key
+     * - Objects are JSON-stringified
+     * - null and undefined values are skipped
+     *
+     * Example: { active: true, page: 1, tags: ['a', 'b'] }
+     * Results in: ?active=true&page=1&tags=a&tags=b
+     */
     params?: Record<string, any>;
 }
 export interface Return {

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

@@ -19,12 +19,18 @@
  *   using a short timeout (default 300ms) to avoid unnecessary list reloads.
  *
  * Parameters (object)
- * - `byIdCallback(data)`, `byIdDeps`, `byIdParams`
- * - `deleteCallback(data)`, `deleteDeps`, `deleteParams`
- * - `listCallback(data)`, `listDeps`, `listParams`, `listUrl`
+ * - `byIdCallback(data)`, `byIdDeps`, `byIdParams` — params for GET by ID request
+ * - `deleteCallback(data)`, `deleteDeps`, `deleteParams` — body for DELETE request
+ * - `listCallback(data)`, `listDeps`, `listParams`, `listUrl` — params for GET list
  * - `searchQuery` (string) — debounced before influencing the list fetch
  * - `unitByIdUrl`, `unitUrl`
- * - `updateCallback(data)`, `updateDeps`, `updateParams`
+ * - `updateCallback(data)`, `updateDeps`, `updateParams` — body for PUT request
+ *
+ * Parameter types
+ * - `listParams` and `byIdParams` support all primitive types including booleans.
+ *   They are appended as URL query parameters for GET requests.
+ *   Example: { active: true, page: 1 } → ?active=true&page=1
+ * - `updateParams` and `deleteParams` are sent as JSON in request body.
  *
  * Return values
  * - `byIdFetchNow(url?, config?)`, `byIdLoading`, `byIdError`
@@ -44,7 +50,7 @@
  * Example
  * const { listFetchNow, updateFetchNow } = useModuleEntityV2({
  *   listUrl: '/items',
- *   listParams: { page: 1 },
+ *   listParams: { page: 1, active: true },
  *   listCallback: (res) => console.log(res),
  *   unitUrl: '/items',
  *   updateCallback: () => {},

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

@@ -20,12 +20,18 @@
  *   using a short timeout (default 300ms) to avoid unnecessary list reloads.
  *
  * Parameters (object)
- * - `byIdCallback(data)`, `byIdDeps`, `byIdParams`
- * - `deleteCallback(data)`, `deleteDeps`, `deleteParams`
- * - `listCallback(data)`, `listDeps`, `listParams`, `listUrl`
+ * - `byIdCallback(data)`, `byIdDeps`, `byIdParams` — params for GET by ID request
+ * - `deleteCallback(data)`, `deleteDeps`, `deleteParams` — body for DELETE request
+ * - `listCallback(data)`, `listDeps`, `listParams`, `listUrl` — params for GET list
  * - `searchQuery` (string) — debounced before influencing the list fetch
  * - `unitByIdUrl`, `unitUrl`
- * - `updateCallback(data)`, `updateDeps`, `updateParams`
+ * - `updateCallback(data)`, `updateDeps`, `updateParams` — body for PUT request
+ *
+ * Parameter types
+ * - `listParams` and `byIdParams` support all primitive types including booleans.
+ *   They are appended as URL query parameters for GET requests.
+ *   Example: { active: true, page: 1 } → ?active=true&page=1
+ * - `updateParams` and `deleteParams` are sent as JSON in request body.
  *
  * Return values
  * - `byIdFetchNow(url?, config?)`, `byIdLoading`, `byIdError`
@@ -45,7 +51,7 @@
  * Example
  * const { listFetchNow, updateFetchNow } = useModuleEntityV2({
  *   listUrl: '/items',
- *   listParams: { page: 1 },
+ *   listParams: { page: 1, active: true },
  *   listCallback: (res) => console.log(res),
  *   unitUrl: '/items',
  *   updateCallback: () => {},
@@ -94,7 +100,7 @@ var useModuleEntityV2 = function (_a) {
             try {
                 // pass current list params explicitly so the fetch uses the latest values
                 listFetchNow(undefined, {
-                    method: constants_1.API_METHODS.POST,
+                    method: constants_1.API_METHODS.GET,
                     params: listParams,
                 });
             }

package/package.json

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