Solution Framework : Updated the custom mutation hook to handle custo… (#2373)

* Solution Framework : Updated the custom mutation hook to handle custom headers

* Updated the library version and changelog

* Updated usecustomAPI and custom mutation  hook to handle custom method and headers

Author: Tulika-eGov

micro-ui/web/micro-ui-internals/example/package.json

@@ -9,7 +9,7 @@
     "start": "react-scripts start"
   },
   "devDependencies": {
-    "@egovernments/digit-ui-libraries": "1.8.12",
+    "@egovernments/digit-ui-libraries": "1.8.13",
     "@egovernments/digit-ui-module-workbench": "1.0.21",
     "@egovernments/digit-ui-module-pgr": "1.8.12",
     "@egovernments/digit-ui-module-dss": "1.8.12",

micro-ui/web/micro-ui-internals/packages/libraries/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [1.8.13]  [25-Apr-2025]
+- Updated Custom mutation hook and usecutsomAPI hook to handle header and method in request.
+
 ## [1.8.11]  [11-Mar-2025]
 - Added new function to remove localisation cache
 

micro-ui/web/micro-ui-internals/packages/libraries/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@egovernments/digit-ui-libraries",
-  "version": "1.8.12",
+  "version": "1.8.13",
   "main": "dist/index.js",
   "module": "dist/index.modern.js",
   "source": "src/index.js",

micro-ui/web/micro-ui-internals/packages/libraries/src/hooks/useCustomAPIHook.js

@@ -34,6 +34,8 @@ const useCustomAPIHook = ({
   params = {},
   body = {},
   config = {},
+  headers = {},
+  method = "POST",
   plainAccessRequest,
   changeQueryName = "Random",
   options = {},
@@ -48,7 +50,7 @@ const useCustomAPIHook = ({
   // Fetch function with error handling
   const fetchData = async () => {
     try {
-      const response = await CustomService.getResponse({ url, params, body, plainAccessRequest, ...options });
+      const response = await CustomService.getResponse({ url, params, body, plainAccessRequest, headers, method, ...options });
       return response || null; // Ensure it never returns undefined
     } catch (error) {
       console.error("Error fetching data:", error);

micro-ui/web/micro-ui-internals/packages/libraries/src/hooks/useCustomAPIMutationHook.js

@@ -44,11 +44,11 @@ mutation.mutate({
  * @returns {Object} Returns the object which contains data and isLoading flag
  */
 
-const useCustomAPIMutationHook = ({ url, params, body, config = {}, plainAccessRequest, changeQueryName = "Random" }) => {
+const useCustomAPIMutationHook = ({ url, params, body, headers={}, method = "POST", config = {}, plainAccessRequest, changeQueryName = "Random" }) => {
   const client = useQueryClient();
 
   const { isLoading, data, isFetching, ...rest } = useMutation(
-    (data) => CustomService.getResponse({ url, params: { ...params, ...data?.params }, body: { ...body, ...data?.body }, plainAccessRequest }),
+    (data) => CustomService.getResponse({ url, params: { ...params, ...data?.params }, body: { ...body, ...data?.body }, plainAccessRequest, headers: { ...headers, ...data?.headers }, method }),
     {
       cacheTime: 0,
       ...config,

micro-ui/web/micro-ui-internals/packages/libraries/src/services/elements/CustomService.js

@@ -1,14 +1,15 @@
 import { Request } from "../atoms/Utils/Request";
 
 export const CustomService = {
-  getResponse: ({ url, params, body, plainAccessRequest,useCache=true,userService=true,setTimeParam=true,userDownload=false,auth=true}) =>  Request({
+  getResponse: ({ url, params, body, plainAccessRequest,useCache=true,userService=true,setTimeParam=true,userDownload=false,auth=true, headers={}, method="POST"}) =>  Request({
       url: url,
       data: body,
       useCache,
       userService,
-      method: "POST",
+      method: method,
       auth:auth,
       params: params,
+      headers: headers,
       plainAccessRequest: plainAccessRequest,
       userDownload:userDownload,
       setTimeParam

micro-ui/web/package.json

@@ -14,7 +14,7 @@
   ],
   "homepage": "/digit-ui",
   "dependencies": {
-    "@egovernments/digit-ui-libraries": "1.8.12",
+    "@egovernments/digit-ui-libraries": "1.8.13",
     "@egovernments/digit-ui-module-workbench": "1.0.21",
     "@egovernments/digit-ui-module-pgr": "1.8.12",
     "@egovernments/digit-ui-module-dss": "1.8.12",

micro-ui/web/sandbox/package.json

@@ -19,7 +19,7 @@
   ],
   "homepage": "/sandbox-ui",
   "dependencies": {
-    "@egovernments/digit-ui-libraries": "1.8.12",
+    "@egovernments/digit-ui-libraries": "1.8.13",
     "@egovernments/digit-ui-module-workbench": "1.0.21",
     "@egovernments/digit-ui-module-pgr": "1.8.12",
     "@egovernments/digit-ui-module-dss": "1.8.12",