@bigbinary/neeto-commons-frontend 3.0.13 → 3.0.16

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

@@ -8,6 +8,7 @@ exports["default"] = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
 var _ramda = require("ramda");
+var _utils = require("../../utils");
 /* eslint-disable @bigbinary/neeto/no-local-storage */
 
 var getStorageValue = function getStorageValue(key, defaultValue) {
@@ -27,12 +28,15 @@ var useLocalStorage = function useLocalStorage(key, defaultValue) {
     storedValue = _useState2[0],
     setStoredValue = _useState2[1];
   var setValue = function setValue(value) {
-    if ((0, _ramda.isNil)(value)) {
-      localStorage.removeItem(key);
-    } else {
-      localStorage.setItem(key, JSON.stringify(value));
-    }
-    setStoredValue(value);
+    return setStoredValue(function (prevStoredValue) {
+      var newValue = typeof value === "function" ? value(prevStoredValue) : value;
+      if ((0, _ramda.isNil)(newValue)) {
+        (0, _utils.removeFromLocalStorage)(key);
+      } else {
+        (0, _utils.setToLocalStorage)(key, newValue);
+      }
+      return newValue;
+    });
   };
   return [storedValue, setValue];
 };

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

@@ -1 +1 @@
-{"version":3,"file":"useLocalStorage.js","names":["_react","require","_ramda","getStorageValue","key","defaultValue","storedValue","localStorage","getItem","JSON","parse","error","logger","useLocalStorage","_useState","useState","_useState2","_slicedToArray2","setStoredValue","setValue","value","isNil","removeItem","setItem","stringify","_default","exports"],"sources":["../../../../src/react-utils/useLocalStorage/useLocalStorage.js"],"sourcesContent":["/* eslint-disable @bigbinary/neeto/no-local-storage */\n\nimport { useState } from \"react\";\n\nimport { isNil } from \"ramda\";\n\nconst getStorageValue = (key, defaultValue) => {\n  try {\n    const storedValue = localStorage.getItem(key);\n\n    return storedValue ? JSON.parse(storedValue) : defaultValue;\n  } catch (error) {\n    logger.error(error);\n\n    return defaultValue;\n  }\n};\n\nconst useLocalStorage = (key, defaultValue) => {\n  const [storedValue, setStoredValue] = useState(() =>\n    getStorageValue(key, defaultValue)\n  );\n\n  const setValue = value => {\n    if (isNil(value)) {\n      localStorage.removeItem(key);\n    } else {\n      localStorage.setItem(key, JSON.stringify(value));\n    }\n    setStoredValue(value);\n  };\n\n  return [storedValue, setValue];\n};\n\nexport default useLocalStorage;\n"],"mappings":";;;;;;;;AAEA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AAJA;;AAMA,IAAME,eAAe,GAAG,SAAlBA,eAAeA,CAAIC,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAI;IACF,IAAMC,WAAW,GAAGC,YAAY,CAACC,OAAO,CAACJ,GAAG,CAAC;IAE7C,OAAOE,WAAW,GAAGG,IAAI,CAACC,KAAK,CAACJ,WAAW,CAAC,GAAGD,YAAY;EAC7D,CAAC,CAAC,OAAOM,KAAK,EAAE;IACdC,MAAM,CAACD,KAAK,CAACA,KAAK,CAAC;IAEnB,OAAON,YAAY;EACrB;AACF,CAAC;AAED,IAAMQ,eAAe,GAAG,SAAlBA,eAAeA,CAAIT,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAAS,SAAA,GAAsC,IAAAC,eAAQ,EAAC;MAAA,OAC7CZ,eAAe,CAACC,GAAG,EAAEC,YAAY,CAAC;IAAA,EACnC;IAAAW,UAAA,OAAAC,eAAA,aAAAH,SAAA;IAFMR,WAAW,GAAAU,UAAA;IAAEE,cAAc,GAAAF,UAAA;EAIlC,IAAMG,QAAQ,GAAG,SAAXA,QAAQA,CAAGC,KAAK,EAAI;IACxB,IAAI,IAAAC,YAAK,EAACD,KAAK,CAAC,EAAE;MAChBb,YAAY,CAACe,UAAU,CAAClB,GAAG,CAAC;IAC9B,CAAC,MAAM;MACLG,YAAY,CAACgB,OAAO,CAACnB,GAAG,EAAEK,IAAI,CAACe,SAAS,CAACJ,KAAK,CAAC,CAAC;IAClD;IACAF,cAAc,CAACE,KAAK,CAAC;EACvB,CAAC;EAED,OAAO,CAACd,WAAW,EAAEa,QAAQ,CAAC;AAChC,CAAC;AAAC,IAAAM,QAAA,GAEaZ,eAAe;AAAAa,OAAA,cAAAD,QAAA"}
+{"version":3,"file":"useLocalStorage.js","names":["_react","require","_ramda","_utils","getStorageValue","key","defaultValue","storedValue","localStorage","getItem","JSON","parse","error","logger","useLocalStorage","_useState","useState","_useState2","_slicedToArray2","setStoredValue","setValue","value","prevStoredValue","newValue","isNil","removeFromLocalStorage","setToLocalStorage","_default","exports"],"sources":["../../../../src/react-utils/useLocalStorage/useLocalStorage.js"],"sourcesContent":["/* eslint-disable @bigbinary/neeto/no-local-storage */\n\nimport { useState } from \"react\";\n\nimport { isNil } from \"ramda\";\nimport { removeFromLocalStorage, setToLocalStorage } from \"utils\";\n\nconst getStorageValue = (key, defaultValue) => {\n  try {\n    const storedValue = localStorage.getItem(key);\n\n    return storedValue ? JSON.parse(storedValue) : defaultValue;\n  } catch (error) {\n    logger.error(error);\n\n    return defaultValue;\n  }\n};\n\nconst useLocalStorage = (key, defaultValue) => {\n  const [storedValue, setStoredValue] = useState(() =>\n    getStorageValue(key, defaultValue)\n  );\n\n  const setValue = value =>\n    setStoredValue(prevStoredValue => {\n      const newValue =\n        typeof value === \"function\" ? value(prevStoredValue) : value;\n\n      if (isNil(newValue)) {\n        removeFromLocalStorage(key);\n      } else {\n        setToLocalStorage(key, newValue);\n      }\n\n      return newValue;\n    });\n\n  return [storedValue, setValue];\n};\n\nexport default useLocalStorage;\n"],"mappings":";;;;;;;;AAEA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAF,OAAA;AALA;;AAOA,IAAMG,eAAe,GAAG,SAAlBA,eAAeA,CAAIC,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAI;IACF,IAAMC,WAAW,GAAGC,YAAY,CAACC,OAAO,CAACJ,GAAG,CAAC;IAE7C,OAAOE,WAAW,GAAGG,IAAI,CAACC,KAAK,CAACJ,WAAW,CAAC,GAAGD,YAAY;EAC7D,CAAC,CAAC,OAAOM,KAAK,EAAE;IACdC,MAAM,CAACD,KAAK,CAACA,KAAK,CAAC;IAEnB,OAAON,YAAY;EACrB;AACF,CAAC;AAED,IAAMQ,eAAe,GAAG,SAAlBA,eAAeA,CAAIT,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAAS,SAAA,GAAsC,IAAAC,eAAQ,EAAC;MAAA,OAC7CZ,eAAe,CAACC,GAAG,EAAEC,YAAY,CAAC;IAAA,EACnC;IAAAW,UAAA,OAAAC,eAAA,aAAAH,SAAA;IAFMR,WAAW,GAAAU,UAAA;IAAEE,cAAc,GAAAF,UAAA;EAIlC,IAAMG,QAAQ,GAAG,SAAXA,QAAQA,CAAGC,KAAK;IAAA,OACpBF,cAAc,CAAC,UAAAG,eAAe,EAAI;MAChC,IAAMC,QAAQ,GACZ,OAAOF,KAAK,KAAK,UAAU,GAAGA,KAAK,CAACC,eAAe,CAAC,GAAGD,KAAK;MAE9D,IAAI,IAAAG,YAAK,EAACD,QAAQ,CAAC,EAAE;QACnB,IAAAE,6BAAsB,EAACpB,GAAG,CAAC;MAC7B,CAAC,MAAM;QACL,IAAAqB,wBAAiB,EAACrB,GAAG,EAAEkB,QAAQ,CAAC;MAClC;MAEA,OAAOA,QAAQ;IACjB,CAAC,CAAC;EAAA;EAEJ,OAAO,CAAChB,WAAW,EAAEa,QAAQ,CAAC;AAChC,CAAC;AAAC,IAAAO,QAAA,GAEab,eAAe;AAAAc,OAAA,cAAAD,QAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "3.0.13",
+  "version": "3.0.16",
   "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>",

package/react-utils/useLocalStorage/useLocalStorage.js

@@ -3,6 +3,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 
 import { useState } from "react";
 import { isNil } from "ramda";
+import { removeFromLocalStorage, setToLocalStorage } from "../../utils";
 var getStorageValue = function getStorageValue(key, defaultValue) {
   try {
     var storedValue = localStorage.getItem(key);
@@ -20,12 +21,15 @@ var useLocalStorage = function useLocalStorage(key, defaultValue) {
     storedValue = _useState2[0],
     setStoredValue = _useState2[1];
   var setValue = function setValue(value) {
-    if (isNil(value)) {
-      localStorage.removeItem(key);
-    } else {
-      localStorage.setItem(key, JSON.stringify(value));
-    }
-    setStoredValue(value);
+    return setStoredValue(function (prevStoredValue) {
+      var newValue = typeof value === "function" ? value(prevStoredValue) : value;
+      if (isNil(newValue)) {
+        removeFromLocalStorage(key);
+      } else {
+        setToLocalStorage(key, newValue);
+      }
+      return newValue;
+    });
   };
   return [storedValue, setValue];
 };

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

@@ -1 +1 @@
-{"version":3,"file":"useLocalStorage.js","names":["useState","isNil","getStorageValue","key","defaultValue","storedValue","localStorage","getItem","JSON","parse","error","logger","useLocalStorage","_useState","_useState2","_slicedToArray","setStoredValue","setValue","value","removeItem","setItem","stringify"],"sources":["../../../src/react-utils/useLocalStorage/useLocalStorage.js"],"sourcesContent":["/* eslint-disable @bigbinary/neeto/no-local-storage */\n\nimport { useState } from \"react\";\n\nimport { isNil } from \"ramda\";\n\nconst getStorageValue = (key, defaultValue) => {\n  try {\n    const storedValue = localStorage.getItem(key);\n\n    return storedValue ? JSON.parse(storedValue) : defaultValue;\n  } catch (error) {\n    logger.error(error);\n\n    return defaultValue;\n  }\n};\n\nconst useLocalStorage = (key, defaultValue) => {\n  const [storedValue, setStoredValue] = useState(() =>\n    getStorageValue(key, defaultValue)\n  );\n\n  const setValue = value => {\n    if (isNil(value)) {\n      localStorage.removeItem(key);\n    } else {\n      localStorage.setItem(key, JSON.stringify(value));\n    }\n    setStoredValue(value);\n  };\n\n  return [storedValue, setValue];\n};\n\nexport default useLocalStorage;\n"],"mappings":";AAAA;;AAEA,SAASA,QAAQ,QAAQ,OAAO;AAEhC,SAASC,KAAK,QAAQ,OAAO;AAE7B,IAAMC,eAAe,GAAG,SAAlBA,eAAeA,CAAIC,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAI;IACF,IAAMC,WAAW,GAAGC,YAAY,CAACC,OAAO,CAACJ,GAAG,CAAC;IAE7C,OAAOE,WAAW,GAAGG,IAAI,CAACC,KAAK,CAACJ,WAAW,CAAC,GAAGD,YAAY;EAC7D,CAAC,CAAC,OAAOM,KAAK,EAAE;IACdC,MAAM,CAACD,KAAK,CAACA,KAAK,CAAC;IAEnB,OAAON,YAAY;EACrB;AACF,CAAC;AAED,IAAMQ,eAAe,GAAG,SAAlBA,eAAeA,CAAIT,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAAS,SAAA,GAAsCb,QAAQ,CAAC;MAAA,OAC7CE,eAAe,CAACC,GAAG,EAAEC,YAAY,CAAC;IAAA,EACnC;IAAAU,UAAA,GAAAC,cAAA,CAAAF,SAAA;IAFMR,WAAW,GAAAS,UAAA;IAAEE,cAAc,GAAAF,UAAA;EAIlC,IAAMG,QAAQ,GAAG,SAAXA,QAAQA,CAAGC,KAAK,EAAI;IACxB,IAAIjB,KAAK,CAACiB,KAAK,CAAC,EAAE;MAChBZ,YAAY,CAACa,UAAU,CAAChB,GAAG,CAAC;IAC9B,CAAC,MAAM;MACLG,YAAY,CAACc,OAAO,CAACjB,GAAG,EAAEK,IAAI,CAACa,SAAS,CAACH,KAAK,CAAC,CAAC;IAClD;IACAF,cAAc,CAACE,KAAK,CAAC;EACvB,CAAC;EAED,OAAO,CAACb,WAAW,EAAEY,QAAQ,CAAC;AAChC,CAAC;AAED,eAAeL,eAAe"}
+{"version":3,"file":"useLocalStorage.js","names":["useState","isNil","removeFromLocalStorage","setToLocalStorage","getStorageValue","key","defaultValue","storedValue","localStorage","getItem","JSON","parse","error","logger","useLocalStorage","_useState","_useState2","_slicedToArray","setStoredValue","setValue","value","prevStoredValue","newValue"],"sources":["../../../src/react-utils/useLocalStorage/useLocalStorage.js"],"sourcesContent":["/* eslint-disable @bigbinary/neeto/no-local-storage */\n\nimport { useState } from \"react\";\n\nimport { isNil } from \"ramda\";\nimport { removeFromLocalStorage, setToLocalStorage } from \"utils\";\n\nconst getStorageValue = (key, defaultValue) => {\n  try {\n    const storedValue = localStorage.getItem(key);\n\n    return storedValue ? JSON.parse(storedValue) : defaultValue;\n  } catch (error) {\n    logger.error(error);\n\n    return defaultValue;\n  }\n};\n\nconst useLocalStorage = (key, defaultValue) => {\n  const [storedValue, setStoredValue] = useState(() =>\n    getStorageValue(key, defaultValue)\n  );\n\n  const setValue = value =>\n    setStoredValue(prevStoredValue => {\n      const newValue =\n        typeof value === \"function\" ? value(prevStoredValue) : value;\n\n      if (isNil(newValue)) {\n        removeFromLocalStorage(key);\n      } else {\n        setToLocalStorage(key, newValue);\n      }\n\n      return newValue;\n    });\n\n  return [storedValue, setValue];\n};\n\nexport default useLocalStorage;\n"],"mappings":";AAAA;;AAEA,SAASA,QAAQ,QAAQ,OAAO;AAEhC,SAASC,KAAK,QAAQ,OAAO;AAC7B,SAASC,sBAAsB,EAAEC,iBAAiB;AAElD,IAAMC,eAAe,GAAG,SAAlBA,eAAeA,CAAIC,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAI;IACF,IAAMC,WAAW,GAAGC,YAAY,CAACC,OAAO,CAACJ,GAAG,CAAC;IAE7C,OAAOE,WAAW,GAAGG,IAAI,CAACC,KAAK,CAACJ,WAAW,CAAC,GAAGD,YAAY;EAC7D,CAAC,CAAC,OAAOM,KAAK,EAAE;IACdC,MAAM,CAACD,KAAK,CAACA,KAAK,CAAC;IAEnB,OAAON,YAAY;EACrB;AACF,CAAC;AAED,IAAMQ,eAAe,GAAG,SAAlBA,eAAeA,CAAIT,GAAG,EAAEC,YAAY,EAAK;EAC7C,IAAAS,SAAA,GAAsCf,QAAQ,CAAC;MAAA,OAC7CI,eAAe,CAACC,GAAG,EAAEC,YAAY,CAAC;IAAA,EACnC;IAAAU,UAAA,GAAAC,cAAA,CAAAF,SAAA;IAFMR,WAAW,GAAAS,UAAA;IAAEE,cAAc,GAAAF,UAAA;EAIlC,IAAMG,QAAQ,GAAG,SAAXA,QAAQA,CAAGC,KAAK;IAAA,OACpBF,cAAc,CAAC,UAAAG,eAAe,EAAI;MAChC,IAAMC,QAAQ,GACZ,OAAOF,KAAK,KAAK,UAAU,GAAGA,KAAK,CAACC,eAAe,CAAC,GAAGD,KAAK;MAE9D,IAAInB,KAAK,CAACqB,QAAQ,CAAC,EAAE;QACnBpB,sBAAsB,CAACG,GAAG,CAAC;MAC7B,CAAC,MAAM;QACLF,iBAAiB,CAACE,GAAG,EAAEiB,QAAQ,CAAC;MAClC;MAEA,OAAOA,QAAQ;IACjB,CAAC,CAAC;EAAA;EAEJ,OAAO,CAACf,WAAW,EAAEY,QAAQ,CAAC;AAChC,CAAC;AAED,eAAeL,eAAe"}

package/react-utils.d.ts

@@ -288,6 +288,29 @@ export function useFuncDebounce<F extends Function>(func: F, delay?: number): F
  *
  * changes to the theme are automatically synchronized with local storage.
  *
+ * The following code snippet illustrates how we can pass a function to the
+ *
+ * setValue method of useLocalStorage
+ *
+ * @example 
+ *
+ * import { useLocalStorage } from "@bigbinary/neeto-commons-frontend/react-utils";
+ * import { append } from "ramda";
+ * 
+ * // here "hiddenColumns" is the storage key and "[]" is the initial value
+ * const [hiddenColumns, setHiddenColumns] = useLocalStorage("hiddenColumns", []);
+ * 
+ * return (
+ *   <Select
+ *     options={[
+ *       { label: "Name", value: "name" },
+ *       { label: "Created at", value: "created_at" },
+ *     ]}
+ *     // when a new column to hide is selected, the same will be appended to the existing list of hidden columns and stored in local storage with the key "hiddenColumns"
+ *     onChange={option => setHiddenColumns(append(option.value))}
+ *   />
+ * );
+ * @endexample
 */
 export function useLocalStorage<T>(key: string, initialValue?: T): [T, (value: T) => void];
 /**