@bigbinary/neeto-commons-frontend 3.1.5 → 3.1.9

package/cjs/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useNavigationCheckpoints = exports["default"] = void 0;
+exports.useRemoveNavigationCheckpoint = exports.useNavigationCheckpoints = exports["default"] = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");
 var _ramda = require("ramda");
@@ -19,6 +19,13 @@ var useCheckpointStore = (0, _zustand.create)((0, _withImmutableActions["default
       return set((0, _ramda.mergeDeepLeft)({
         checkpoints: (0, _defineProperty2["default"])({}, key, path)
       }));
+    },
+    removeCheckpoint: function removeCheckpoint(key) {
+      return set(function (state) {
+        return {
+          checkpoints: (0, _ramda.dissoc)(key, state.checkpoints)
+        };
+      });
     }
   };
 }));
@@ -38,6 +45,10 @@ var useNavigationCheckpoints = function useNavigationCheckpoints() {
   }, _shallow.shallow);
 };
 exports.useNavigationCheckpoints = useNavigationCheckpoints;
+var useRemoveNavigationCheckpoint = function useRemoveNavigationCheckpoint() {
+  return useCheckpointStore((0, _ramda.prop)("removeCheckpoint"));
+};
+exports.useRemoveNavigationCheckpoint = useRemoveNavigationCheckpoint;
 var _default = useRegisterNavigationCheckpoint;
 exports["default"] = _default;
 //# sourceMappingURL=useRegisterNavigationCheckpoint.js.map

package/cjs/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"useRegisterNavigationCheckpoint.js","names":["_react","require","_ramda","_withImmutableActions","_interopRequireDefault","_zustand","_shallow","useCheckpointStore","create","withImmutableActions","set","checkpoints","setCheckpoint","key","path","mergeDeepLeft","_defineProperty2","useRegisterNavigationCheckpoint","arguments","length","undefined","window","location","pathname","search","prop","useEffect","useNavigationCheckpoints","_len","keys","Array","_key","store","pick","shallow","exports","_default"],"sources":["../../../../src/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js"],"sourcesContent":["import { useEffect } from \"react\";\n\nimport { mergeDeepLeft, pick, prop } from \"ramda\";\nimport withImmutableActions from \"react-utils/withImmutableActions\";\nimport { create } from \"zustand\";\nimport { shallow } from \"zustand/shallow\";\n\n/** @type {import(\"neetocommons/react-utils\").ZustandStoreHook} */\nconst useCheckpointStore = create(\n  withImmutableActions(set => ({\n    checkpoints: {},\n    setCheckpoint: (key, path) =>\n      set(mergeDeepLeft({ checkpoints: { [key]: path } })),\n  }))\n);\n\nconst useRegisterNavigationCheckpoint = (\n  key,\n  path = window.location.pathname + window.location.search\n) => {\n  const setCheckpoint = useCheckpointStore(prop(\"setCheckpoint\"));\n\n  useEffect(() => {\n    setCheckpoint(key, path);\n  }, [key, path]);\n};\n\nexport const useNavigationCheckpoints = (...keys) =>\n  useCheckpointStore(store => pick(keys, store.checkpoints), shallow);\n\nexport default useRegisterNavigationCheckpoint;\n"],"mappings":";;;;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,qBAAA,GAAAC,sBAAA,CAAAH,OAAA;AACA,IAAAI,QAAA,GAAAJ,OAAA;AACA,IAAAK,QAAA,GAAAL,OAAA;AAEA;AACA,IAAMM,kBAAkB,GAAG,IAAAC,eAAM,EAC/B,IAAAC,gCAAoB,EAAC,UAAAC,GAAG;EAAA,OAAK;IAC3BC,WAAW,EAAE,CAAC,CAAC;IACfC,aAAa,EAAE,SAAAA,cAACC,GAAG,EAAEC,IAAI;MAAA,OACvBJ,GAAG,CAAC,IAAAK,oBAAa,EAAC;QAAEJ,WAAW,MAAAK,gBAAA,iBAAKH,GAAG,EAAGC,IAAI;MAAG,CAAC,CAAC,CAAC;IAAA;EACxD,CAAC;AAAA,CAAC,CAAC,CACJ;AAED,IAAMG,+BAA+B,GAAG,SAAlCA,+BAA+BA,CACnCJ,GAAG,EAEA;EAAA,IADHC,IAAI,GAAAI,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGG,MAAM,CAACC,QAAQ,CAACC,QAAQ,GAAGF,MAAM,CAACC,QAAQ,CAACE,MAAM;EAExD,IAAMZ,aAAa,GAAGL,kBAAkB,CAAC,IAAAkB,WAAI,EAAC,eAAe,CAAC,CAAC;EAE/D,IAAAC,gBAAS,EAAC,YAAM;IACdd,aAAa,CAACC,GAAG,EAAEC,IAAI,CAAC;EAC1B,CAAC,EAAE,CAACD,GAAG,EAAEC,IAAI,CAAC,CAAC;AACjB,CAAC;AAEM,IAAMa,wBAAwB,GAAG,SAA3BA,wBAAwBA,CAAA;EAAA,SAAAC,IAAA,GAAAV,SAAA,CAAAC,MAAA,EAAOU,IAAI,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;IAAJF,IAAI,CAAAE,IAAA,IAAAb,SAAA,CAAAa,IAAA;EAAA;EAAA,OAC9CxB,kBAAkB,CAAC,UAAAyB,KAAK;IAAA,OAAI,IAAAC,WAAI,EAACJ,IAAI,EAAEG,KAAK,CAACrB,WAAW,CAAC;EAAA,GAAEuB,gBAAO,CAAC;AAAA;AAACC,OAAA,CAAAR,wBAAA,GAAAA,wBAAA;AAAA,IAAAS,QAAA,GAEvDnB,+BAA+B;AAAAkB,OAAA,cAAAC,QAAA"}
+{"version":3,"file":"useRegisterNavigationCheckpoint.js","names":["_react","require","_ramda","_withImmutableActions","_interopRequireDefault","_zustand","_shallow","useCheckpointStore","create","withImmutableActions","set","checkpoints","setCheckpoint","key","path","mergeDeepLeft","_defineProperty2","removeCheckpoint","state","dissoc","useRegisterNavigationCheckpoint","arguments","length","undefined","window","location","pathname","search","prop","useEffect","useNavigationCheckpoints","_len","keys","Array","_key","store","pick","shallow","exports","useRemoveNavigationCheckpoint","_default"],"sources":["../../../../src/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js"],"sourcesContent":["import { useEffect } from \"react\";\n\nimport { mergeDeepLeft, pick, prop, dissoc } from \"ramda\";\nimport withImmutableActions from \"react-utils/withImmutableActions\";\nimport { create } from \"zustand\";\nimport { shallow } from \"zustand/shallow\";\n\n/** @type {import(\"neetocommons/react-utils\").ZustandStoreHook} */\nconst useCheckpointStore = create(\n  withImmutableActions(set => ({\n    checkpoints: {},\n    setCheckpoint: (key, path) =>\n      set(mergeDeepLeft({ checkpoints: { [key]: path } })),\n    removeCheckpoint: key =>\n      set(state => ({ checkpoints: dissoc(key, state.checkpoints) })),\n  }))\n);\n\nconst useRegisterNavigationCheckpoint = (\n  key,\n  path = window.location.pathname + window.location.search\n) => {\n  const setCheckpoint = useCheckpointStore(prop(\"setCheckpoint\"));\n\n  useEffect(() => {\n    setCheckpoint(key, path);\n  }, [key, path]);\n};\n\nexport const useNavigationCheckpoints = (...keys) =>\n  useCheckpointStore(store => pick(keys, store.checkpoints), shallow);\n\nexport const useRemoveNavigationCheckpoint = () =>\n  useCheckpointStore(prop(\"removeCheckpoint\"));\n\nexport default useRegisterNavigationCheckpoint;\n"],"mappings":";;;;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,qBAAA,GAAAC,sBAAA,CAAAH,OAAA;AACA,IAAAI,QAAA,GAAAJ,OAAA;AACA,IAAAK,QAAA,GAAAL,OAAA;AAEA;AACA,IAAMM,kBAAkB,GAAG,IAAAC,eAAM,EAC/B,IAAAC,gCAAoB,EAAC,UAAAC,GAAG;EAAA,OAAK;IAC3BC,WAAW,EAAE,CAAC,CAAC;IACfC,aAAa,EAAE,SAAAA,cAACC,GAAG,EAAEC,IAAI;MAAA,OACvBJ,GAAG,CAAC,IAAAK,oBAAa,EAAC;QAAEJ,WAAW,MAAAK,gBAAA,iBAAKH,GAAG,EAAGC,IAAI;MAAG,CAAC,CAAC,CAAC;IAAA;IACtDG,gBAAgB,EAAE,SAAAA,iBAAAJ,GAAG;MAAA,OACnBH,GAAG,CAAC,UAAAQ,KAAK;QAAA,OAAK;UAAEP,WAAW,EAAE,IAAAQ,aAAM,EAACN,GAAG,EAAEK,KAAK,CAACP,WAAW;QAAE,CAAC;MAAA,CAAC,CAAC;IAAA;EACnE,CAAC;AAAA,CAAC,CAAC,CACJ;AAED,IAAMS,+BAA+B,GAAG,SAAlCA,+BAA+BA,CACnCP,GAAG,EAEA;EAAA,IADHC,IAAI,GAAAO,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGG,MAAM,CAACC,QAAQ,CAACC,QAAQ,GAAGF,MAAM,CAACC,QAAQ,CAACE,MAAM;EAExD,IAAMf,aAAa,GAAGL,kBAAkB,CAAC,IAAAqB,WAAI,EAAC,eAAe,CAAC,CAAC;EAE/D,IAAAC,gBAAS,EAAC,YAAM;IACdjB,aAAa,CAACC,GAAG,EAAEC,IAAI,CAAC;EAC1B,CAAC,EAAE,CAACD,GAAG,EAAEC,IAAI,CAAC,CAAC;AACjB,CAAC;AAEM,IAAMgB,wBAAwB,GAAG,SAA3BA,wBAAwBA,CAAA;EAAA,SAAAC,IAAA,GAAAV,SAAA,CAAAC,MAAA,EAAOU,IAAI,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;IAAJF,IAAI,CAAAE,IAAA,IAAAb,SAAA,CAAAa,IAAA;EAAA;EAAA,OAC9C3B,kBAAkB,CAAC,UAAA4B,KAAK;IAAA,OAAI,IAAAC,WAAI,EAACJ,IAAI,EAAEG,KAAK,CAACxB,WAAW,CAAC;EAAA,GAAE0B,gBAAO,CAAC;AAAA;AAACC,OAAA,CAAAR,wBAAA,GAAAA,wBAAA;AAE/D,IAAMS,6BAA6B,GAAG,SAAhCA,6BAA6BA,CAAA;EAAA,OACxChC,kBAAkB,CAAC,IAAAqB,WAAI,EAAC,kBAAkB,CAAC,CAAC;AAAA;AAACU,OAAA,CAAAC,6BAAA,GAAAA,6BAAA;AAAA,IAAAC,QAAA,GAEhCpB,+BAA+B;AAAAkB,OAAA,cAAAE,QAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "3.1.5",
+  "version": "3.1.9",
   "description": "A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.",
   "repository": "git@github.com:bigbinary/neeto-commons-frontend.git",
   "author": "Amaljith K <amaljith.k@bigbinary.com>",
@@ -97,4 +97,4 @@
     "tailwindcss": "npm:@tailwindcss/postcss7-compat",
     "webpack": "^5.75.0"
   }
-}
+}

package/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useEffect } from "react";
-import { mergeDeepLeft, pick, prop } from "ramda";
+import { mergeDeepLeft, pick, prop, dissoc } from "ramda";
 import withImmutableActions from "../withImmutableActions";
 import { create } from "zustand";
 import { shallow } from "zustand/shallow";
@@ -13,6 +13,13 @@ var useCheckpointStore = create(withImmutableActions(function (set) {
       return set(mergeDeepLeft({
         checkpoints: _defineProperty({}, key, path)
       }));
+    },
+    removeCheckpoint: function removeCheckpoint(key) {
+      return set(function (state) {
+        return {
+          checkpoints: dissoc(key, state.checkpoints)
+        };
+      });
     }
   };
 }));
@@ -31,5 +38,8 @@ export var useNavigationCheckpoints = function useNavigationCheckpoints() {
     return pick(keys, store.checkpoints);
   }, shallow);
 };
+export var useRemoveNavigationCheckpoint = function useRemoveNavigationCheckpoint() {
+  return useCheckpointStore(prop("removeCheckpoint"));
+};
 export default useRegisterNavigationCheckpoint;
 //# sourceMappingURL=useRegisterNavigationCheckpoint.js.map

package/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"useRegisterNavigationCheckpoint.js","names":["useEffect","mergeDeepLeft","pick","prop","withImmutableActions","create","shallow","useCheckpointStore","set","checkpoints","setCheckpoint","key","path","_defineProperty","useRegisterNavigationCheckpoint","arguments","length","undefined","window","location","pathname","search","useNavigationCheckpoints","_len","keys","Array","_key","store"],"sources":["../../../src/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js"],"sourcesContent":["import { useEffect } from \"react\";\n\nimport { mergeDeepLeft, pick, prop } from \"ramda\";\nimport withImmutableActions from \"react-utils/withImmutableActions\";\nimport { create } from \"zustand\";\nimport { shallow } from \"zustand/shallow\";\n\n/** @type {import(\"neetocommons/react-utils\").ZustandStoreHook} */\nconst useCheckpointStore = create(\n  withImmutableActions(set => ({\n    checkpoints: {},\n    setCheckpoint: (key, path) =>\n      set(mergeDeepLeft({ checkpoints: { [key]: path } })),\n  }))\n);\n\nconst useRegisterNavigationCheckpoint = (\n  key,\n  path = window.location.pathname + window.location.search\n) => {\n  const setCheckpoint = useCheckpointStore(prop(\"setCheckpoint\"));\n\n  useEffect(() => {\n    setCheckpoint(key, path);\n  }, [key, path]);\n};\n\nexport const useNavigationCheckpoints = (...keys) =>\n  useCheckpointStore(store => pick(keys, store.checkpoints), shallow);\n\nexport default useRegisterNavigationCheckpoint;\n"],"mappings":";AAAA,SAASA,SAAS,QAAQ,OAAO;AAEjC,SAASC,aAAa,EAAEC,IAAI,EAAEC,IAAI,QAAQ,OAAO;AACjD,OAAOC,oBAAoB;AAC3B,SAASC,MAAM,QAAQ,SAAS;AAChC,SAASC,OAAO,QAAQ,iBAAiB;;AAEzC;AACA,IAAMC,kBAAkB,GAAGF,MAAM,CAC/BD,oBAAoB,CAAC,UAAAI,GAAG;EAAA,OAAK;IAC3BC,WAAW,EAAE,CAAC,CAAC;IACfC,aAAa,EAAE,SAAAA,cAACC,GAAG,EAAEC,IAAI;MAAA,OACvBJ,GAAG,CAACP,aAAa,CAAC;QAAEQ,WAAW,EAAAI,eAAA,KAAKF,GAAG,EAAGC,IAAI;MAAG,CAAC,CAAC,CAAC;IAAA;EACxD,CAAC;AAAA,CAAC,CAAC,CACJ;AAED,IAAME,+BAA+B,GAAG,SAAlCA,+BAA+BA,CACnCH,GAAG,EAEA;EAAA,IADHC,IAAI,GAAAG,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGG,MAAM,CAACC,QAAQ,CAACC,QAAQ,GAAGF,MAAM,CAACC,QAAQ,CAACE,MAAM;EAExD,IAAMX,aAAa,GAAGH,kBAAkB,CAACJ,IAAI,CAAC,eAAe,CAAC,CAAC;EAE/DH,SAAS,CAAC,YAAM;IACdU,aAAa,CAACC,GAAG,EAAEC,IAAI,CAAC;EAC1B,CAAC,EAAE,CAACD,GAAG,EAAEC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,OAAO,IAAMU,wBAAwB,GAAG,SAA3BA,wBAAwBA,CAAA;EAAA,SAAAC,IAAA,GAAAR,SAAA,CAAAC,MAAA,EAAOQ,IAAI,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;IAAJF,IAAI,CAAAE,IAAA,IAAAX,SAAA,CAAAW,IAAA;EAAA;EAAA,OAC9CnB,kBAAkB,CAAC,UAAAoB,KAAK;IAAA,OAAIzB,IAAI,CAACsB,IAAI,EAAEG,KAAK,CAAClB,WAAW,CAAC;EAAA,GAAEH,OAAO,CAAC;AAAA;AAErE,eAAeQ,+BAA+B"}
+{"version":3,"file":"useRegisterNavigationCheckpoint.js","names":["useEffect","mergeDeepLeft","pick","prop","dissoc","withImmutableActions","create","shallow","useCheckpointStore","set","checkpoints","setCheckpoint","key","path","_defineProperty","removeCheckpoint","state","useRegisterNavigationCheckpoint","arguments","length","undefined","window","location","pathname","search","useNavigationCheckpoints","_len","keys","Array","_key","store","useRemoveNavigationCheckpoint"],"sources":["../../../src/react-utils/useRegisterNavigationCheckpoint/useRegisterNavigationCheckpoint.js"],"sourcesContent":["import { useEffect } from \"react\";\n\nimport { mergeDeepLeft, pick, prop, dissoc } from \"ramda\";\nimport withImmutableActions from \"react-utils/withImmutableActions\";\nimport { create } from \"zustand\";\nimport { shallow } from \"zustand/shallow\";\n\n/** @type {import(\"neetocommons/react-utils\").ZustandStoreHook} */\nconst useCheckpointStore = create(\n  withImmutableActions(set => ({\n    checkpoints: {},\n    setCheckpoint: (key, path) =>\n      set(mergeDeepLeft({ checkpoints: { [key]: path } })),\n    removeCheckpoint: key =>\n      set(state => ({ checkpoints: dissoc(key, state.checkpoints) })),\n  }))\n);\n\nconst useRegisterNavigationCheckpoint = (\n  key,\n  path = window.location.pathname + window.location.search\n) => {\n  const setCheckpoint = useCheckpointStore(prop(\"setCheckpoint\"));\n\n  useEffect(() => {\n    setCheckpoint(key, path);\n  }, [key, path]);\n};\n\nexport const useNavigationCheckpoints = (...keys) =>\n  useCheckpointStore(store => pick(keys, store.checkpoints), shallow);\n\nexport const useRemoveNavigationCheckpoint = () =>\n  useCheckpointStore(prop(\"removeCheckpoint\"));\n\nexport default useRegisterNavigationCheckpoint;\n"],"mappings":";AAAA,SAASA,SAAS,QAAQ,OAAO;AAEjC,SAASC,aAAa,EAAEC,IAAI,EAAEC,IAAI,EAAEC,MAAM,QAAQ,OAAO;AACzD,OAAOC,oBAAoB;AAC3B,SAASC,MAAM,QAAQ,SAAS;AAChC,SAASC,OAAO,QAAQ,iBAAiB;;AAEzC;AACA,IAAMC,kBAAkB,GAAGF,MAAM,CAC/BD,oBAAoB,CAAC,UAAAI,GAAG;EAAA,OAAK;IAC3BC,WAAW,EAAE,CAAC,CAAC;IACfC,aAAa,EAAE,SAAAA,cAACC,GAAG,EAAEC,IAAI;MAAA,OACvBJ,GAAG,CAACR,aAAa,CAAC;QAAES,WAAW,EAAAI,eAAA,KAAKF,GAAG,EAAGC,IAAI;MAAG,CAAC,CAAC,CAAC;IAAA;IACtDE,gBAAgB,EAAE,SAAAA,iBAAAH,GAAG;MAAA,OACnBH,GAAG,CAAC,UAAAO,KAAK;QAAA,OAAK;UAAEN,WAAW,EAAEN,MAAM,CAACQ,GAAG,EAAEI,KAAK,CAACN,WAAW;QAAE,CAAC;MAAA,CAAC,CAAC;IAAA;EACnE,CAAC;AAAA,CAAC,CAAC,CACJ;AAED,IAAMO,+BAA+B,GAAG,SAAlCA,+BAA+BA,CACnCL,GAAG,EAEA;EAAA,IADHC,IAAI,GAAAK,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGG,MAAM,CAACC,QAAQ,CAACC,QAAQ,GAAGF,MAAM,CAACC,QAAQ,CAACE,MAAM;EAExD,IAAMb,aAAa,GAAGH,kBAAkB,CAACL,IAAI,CAAC,eAAe,CAAC,CAAC;EAE/DH,SAAS,CAAC,YAAM;IACdW,aAAa,CAACC,GAAG,EAAEC,IAAI,CAAC;EAC1B,CAAC,EAAE,CAACD,GAAG,EAAEC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,OAAO,IAAMY,wBAAwB,GAAG,SAA3BA,wBAAwBA,CAAA;EAAA,SAAAC,IAAA,GAAAR,SAAA,CAAAC,MAAA,EAAOQ,IAAI,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;IAAJF,IAAI,CAAAE,IAAA,IAAAX,SAAA,CAAAW,IAAA;EAAA;EAAA,OAC9CrB,kBAAkB,CAAC,UAAAsB,KAAK;IAAA,OAAI5B,IAAI,CAACyB,IAAI,EAAEG,KAAK,CAACpB,WAAW,CAAC;EAAA,GAAEH,OAAO,CAAC;AAAA;AAErE,OAAO,IAAMwB,6BAA6B,GAAG,SAAhCA,6BAA6BA,CAAA;EAAA,OACxCvB,kBAAkB,CAACL,IAAI,CAAC,kBAAkB,CAAC,CAAC;AAAA;AAE9C,eAAec,+BAA+B"}

package/react-utils.d.ts

@@ -1191,6 +1191,51 @@ export function useRegisterNavigationCheckpoint(key: string, path?: string): voi
 export function useNavigationCheckpoints(...keys: string[]): {
   [key: string]: string;
 };
+/**
+ *
+ * The useRemoveNavigationCheckpoint hook is a utility for removing a navigation
+ *
+ * checkpoint from the navigation checkpoints stored in the Zustand store.
+ *
+ * In web applications, users frequently move between various pages or routes, and
+ *
+ * useRegisterNavigationCheckpoint empowers us to store particular paths or
+ *
+ * states as checkpoints. By employing the useNavigationCheckpoints hook, you can
+ *
+ * access these checkpoints by specifying their associated keys. There might arise
+ *
+ * a case where you want to remove a particular checkpoint from the Zustand store,
+ *
+ * useRemoveNavigationCheckpoint can be used for this.
+ *
+ * We recommend reviewing the documentation for the
+ *
+ * useRegisterNavigationCheckpoint and useNavigationCheckpoints hooks for
+ *
+ * gaining a deeper understanding of the checkpoint concept.
+ *
+ * The following code snippet demonstrates the usage of
+ *
+ * useRemoveNavigationCheckpoint in removing a navigation checkpoint from the
+ *
+ * Zustand store.
+ *
+ * @example 
+ *
+ * // Import the useRemoveNavigationCheckpoint hook
+ * import { useRemoveNavigationCheckpoint } from "@bigbinary/neeto-commons-frontend/react-utils";
+ * 
+ * const removeCheckpoint = useRemoveNavigationCheckpoint();
+ * 
+ * removeCheckpoint("home");
+ * @endexample
+ * The above code removes the navigation checkpoint corresponding to the home key
+ *
+ * using the useRemoveNavigationCheckpoint hook.
+ *
+*/
+export function useRemoveNavigationCheckpoint(): (key: string) => void;
 /**
  *
  * The useFuncDebounce hook is a utility that extends the benefits of debouncing