@bigbinary/neeto-commons-frontend 2.0.7 → 2.0.9

package/README.md

@@ -7,7 +7,7 @@ The commons frontend library for Neeto Applications.
 Install from npm:
 
 ```bash
-yarn add "@bigbinary/neeto-commons-frontend@2.0.7"
+yarn add "@bigbinary/neeto-commons-frontend@2.0.9"
 ```
 
 This package relies on the host project's tailwind configuration. So add

package/initializers.cjs.js

@@ -113,20 +113,26 @@ var camelToSnakeCase = function camelToSnakeCase(string) {
 };
 
 var transformObjectDeep = function transformObjectDeep(object, keyValueTransformer) {
+  var objectPreProcessor = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
+
+  if (objectPreProcessor && typeof objectPreProcessor === "function") {
+    object = objectPreProcessor(object);
+  }
+
   if (Array.isArray(object)) {
     return object.map(function (obj) {
-      return transformObjectDeep(obj, keyValueTransformer);
+      return transformObjectDeep(obj, keyValueTransformer, objectPreProcessor);
     });
   } else if (object === null || _typeof(object) !== "object") {
     return object;
   }
 
-  return Object.fromEntries(Object.entries(object).map(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+  return Object.fromEntries(Object.entries(object).map(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+        key = _ref4[0],
+        value = _ref4[1];
 
-    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer));
+    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer, objectPreProcessor));
   }));
 };
 var keysToCamelCase = function keysToCamelCase(object) {
@@ -135,21 +141,11 @@ var keysToCamelCase = function keysToCamelCase(object) {
   });
 };
 var serializeKeysToSnakeCase = function serializeKeysToSnakeCase(object) {
-  var serializedObj = typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
-
-  if (Array.isArray(serializedObj)) {
-    return serializedObj.map(serializeKeysToSnakeCase);
-  } else if (serializedObj === null || _typeof(serializedObj) !== "object") {
-    return serializedObj;
-  }
-
-  return Object.fromEntries(Object.entries(serializedObj).map(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
-        key = _ref4[0],
-        value = _ref4[1];
-
-    return [camelToSnakeCase(key), serializeKeysToSnakeCase(value)];
-  }));
+  return transformObjectDeep(object, function (key, value) {
+    return [camelToSnakeCase(key), value];
+  }, function (object) {
+    return typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
+  });
 };
 var deepFreezeObject = function deepFreezeObject(object) {
   if (object && _typeof(object) === "object" && !Object.isFrozen(object)) {

package/initializers.js

@@ -103,20 +103,26 @@ var camelToSnakeCase = function camelToSnakeCase(string) {
 };
 
 var transformObjectDeep = function transformObjectDeep(object, keyValueTransformer) {
+  var objectPreProcessor = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
+
+  if (objectPreProcessor && typeof objectPreProcessor === "function") {
+    object = objectPreProcessor(object);
+  }
+
   if (Array.isArray(object)) {
     return object.map(function (obj) {
-      return transformObjectDeep(obj, keyValueTransformer);
+      return transformObjectDeep(obj, keyValueTransformer, objectPreProcessor);
     });
   } else if (object === null || _typeof(object) !== "object") {
     return object;
   }
 
-  return Object.fromEntries(Object.entries(object).map(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+  return Object.fromEntries(Object.entries(object).map(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+        key = _ref4[0],
+        value = _ref4[1];
 
-    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer));
+    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer, objectPreProcessor));
   }));
 };
 var keysToCamelCase = function keysToCamelCase(object) {
@@ -125,21 +131,11 @@ var keysToCamelCase = function keysToCamelCase(object) {
   });
 };
 var serializeKeysToSnakeCase = function serializeKeysToSnakeCase(object) {
-  var serializedObj = typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
-
-  if (Array.isArray(serializedObj)) {
-    return serializedObj.map(serializeKeysToSnakeCase);
-  } else if (serializedObj === null || _typeof(serializedObj) !== "object") {
-    return serializedObj;
-  }
-
-  return Object.fromEntries(Object.entries(serializedObj).map(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
-        key = _ref4[0],
-        value = _ref4[1];
-
-    return [camelToSnakeCase(key), serializeKeysToSnakeCase(value)];
-  }));
+  return transformObjectDeep(object, function (key, value) {
+    return [camelToSnakeCase(key), value];
+  }, function (object) {
+    return typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
+  });
 };
 var deepFreezeObject = function deepFreezeObject(object) {
   if (object && _typeof(object) === "object" && !Object.isFrozen(object)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "2.0.7",
+  "version": "2.0.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>",
@@ -81,7 +81,7 @@
     "lint-staged": "^12.3.7",
     "mixpanel-browser": "^2.45.0",
     "prettier": "^2.6.2",
-    "query-string": "^7.1.1",
+    "qs": "^6.11.0",
     "ramda": "^0.28.0",
     "react": "^17.0.2",
     "react-dom": "17.0.2",

package/pure.cjs.js

@@ -106,21 +106,43 @@ var truncate = function truncate(string, length) {
   return string.length > length ? ramda.concat(ramda.slice(0, length, string), "...") : string;
 };
 
+var matchesImpl = function matchesImpl(pattern, object) {
+  var __parent = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : object;
+
+  if (object === pattern) return true;
+  if (typeof pattern === "function" && pattern(object, __parent)) return true;
+  if (ramda.isNil(pattern) || ramda.isNil(object)) return false;
+  if (_typeof(pattern) !== "object") return false;
+  return Object.entries(pattern).every(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+
+    return matchesImpl(value, object[key], __parent);
+  });
+};
+
 var transformObjectDeep = function transformObjectDeep(object, keyValueTransformer) {
+  var objectPreProcessor = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
+
+  if (objectPreProcessor && typeof objectPreProcessor === "function") {
+    object = objectPreProcessor(object);
+  }
+
   if (Array.isArray(object)) {
     return object.map(function (obj) {
-      return transformObjectDeep(obj, keyValueTransformer);
+      return transformObjectDeep(obj, keyValueTransformer, objectPreProcessor);
     });
   } else if (object === null || _typeof(object) !== "object") {
     return object;
   }
 
-  return Object.fromEntries(Object.entries(object).map(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+  return Object.fromEntries(Object.entries(object).map(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+        key = _ref4[0],
+        value = _ref4[1];
 
-    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer));
+    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer, objectPreProcessor));
   }));
 };
 var keysToCamelCase = function keysToCamelCase(object) {
@@ -134,21 +156,18 @@ var keysToSnakeCase = function keysToSnakeCase(object) {
   });
 };
 var serializeKeysToSnakeCase = function serializeKeysToSnakeCase(object) {
-  var serializedObj = typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
-
-  if (Array.isArray(serializedObj)) {
-    return serializedObj.map(serializeKeysToSnakeCase);
-  } else if (serializedObj === null || _typeof(serializedObj) !== "object") {
-    return serializedObj;
-  }
-
-  return Object.fromEntries(Object.entries(serializedObj).map(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
-        key = _ref4[0],
-        value = _ref4[1];
-
-    return [camelToSnakeCase(key), serializeKeysToSnakeCase(value)];
-  }));
+  return transformObjectDeep(object, function (key, value) {
+    return [camelToSnakeCase(key), value];
+  }, function (object) {
+    return typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
+  });
+};
+var preprocessForSerialization = function preprocessForSerialization(object) {
+  return transformObjectDeep(object, function (key, value) {
+    return [key, value];
+  }, function (object) {
+    return typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
+  });
 };
 var deepFreezeObject = function deepFreezeObject(object) {
   if (object && _typeof(object) === "object" && !Object.isFrozen(object)) {
@@ -161,30 +180,18 @@ var deepFreezeObject = function deepFreezeObject(object) {
   return object;
 };
 var matches = /*#__PURE__*/ramda.curry(function (pattern, object) {
-  var __parent = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : object;
-
-  if (object === pattern) return true;
-  if (typeof pattern === "function" && pattern(object, __parent)) return true;
-  if (ramda.isNil(pattern) || ramda.isNil(object)) return false;
-  if (_typeof(pattern) !== "object") return false;
-  return Object.entries(pattern).every(function (_ref5) {
-    var _ref6 = _slicedToArray(_ref5, 2),
-        key = _ref6[0],
-        value = _ref6[1];
-
-    return matches(value, object[key], __parent);
-  });
+  return matchesImpl(pattern, object);
 });
 var filterNonNull = function filterNonNull(object) {
-  return Object.fromEntries(Object.entries(object).filter(function (_ref7) {
-    var _ref8 = _slicedToArray(_ref7, 2),
-        v = _ref8[1];
+  return Object.fromEntries(Object.entries(object).filter(function (_ref5) {
+    var _ref6 = _slicedToArray(_ref5, 2),
+        v = _ref6[1];
 
     return !ramda.isNil(v);
-  }).map(function (_ref9) {
-    var _ref10 = _slicedToArray(_ref9, 2),
-        k = _ref10[0],
-        v = _ref10[1];
+  }).map(function (_ref7) {
+    var _ref8 = _slicedToArray(_ref7, 2),
+        k = _ref8[0],
+        v = _ref8[1];
 
     return [k, _typeof(v) === "object" && !Array.isArray(v) ? filterNonNull(v) : v];
   }));
@@ -396,6 +403,7 @@ exports.modifyById = modifyById;
 exports.noop = noop;
 exports.notEquals = notEquals;
 exports.notEqualsDeep = notEqualsDeep;
+exports.preprocessForSerialization = preprocessForSerialization;
 exports.randomPick = randomPick;
 exports.removeBy = removeBy;
 exports.removeById = removeById;

package/pure.d.ts

@@ -170,6 +170,7 @@ export function replaceById<T>(id: any, entityArray: T[]): T[];
 export function replaceById(id: any): <T>(entityArray: T[]) => T[];
 
 export function serializeKeysToSnakeCase(object: object): object;
+export function preprocessForSerialization(object: object): object;
 export function slugify(string: string): string;
 export function snakeToCamelCase(string: string): string;
 export function toLabelAndValue(string: string): {
@@ -178,7 +179,8 @@ export function toLabelAndValue(string: string): {
 };
 export function transformObjectDeep(
   object: object,
-  keyValueTransformer: (key: string | number | symbol, object: any) => any[]
+  keyValueTransformer: (key: string | number | symbol, object: any) => any[],
+  objectPreProcessor?: (object: any) => any
 ): object;
 
 export function truncate(string: string, length: number): string;

package/pure.js

@@ -102,21 +102,43 @@ var truncate = function truncate(string, length) {
   return string.length > length ? concat(slice(0, length, string), "...") : string;
 };
 
+var matchesImpl = function matchesImpl(pattern, object) {
+  var __parent = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : object;
+
+  if (object === pattern) return true;
+  if (typeof pattern === "function" && pattern(object, __parent)) return true;
+  if (isNil(pattern) || isNil(object)) return false;
+  if (_typeof(pattern) !== "object") return false;
+  return Object.entries(pattern).every(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+
+    return matchesImpl(value, object[key], __parent);
+  });
+};
+
 var transformObjectDeep = function transformObjectDeep(object, keyValueTransformer) {
+  var objectPreProcessor = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
+
+  if (objectPreProcessor && typeof objectPreProcessor === "function") {
+    object = objectPreProcessor(object);
+  }
+
   if (Array.isArray(object)) {
     return object.map(function (obj) {
-      return transformObjectDeep(obj, keyValueTransformer);
+      return transformObjectDeep(obj, keyValueTransformer, objectPreProcessor);
     });
   } else if (object === null || _typeof(object) !== "object") {
     return object;
   }
 
-  return Object.fromEntries(Object.entries(object).map(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+  return Object.fromEntries(Object.entries(object).map(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+        key = _ref4[0],
+        value = _ref4[1];
 
-    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer));
+    return keyValueTransformer(key, transformObjectDeep(value, keyValueTransformer, objectPreProcessor));
   }));
 };
 var keysToCamelCase = function keysToCamelCase(object) {
@@ -130,21 +152,18 @@ var keysToSnakeCase = function keysToSnakeCase(object) {
   });
 };
 var serializeKeysToSnakeCase = function serializeKeysToSnakeCase(object) {
-  var serializedObj = typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
-
-  if (Array.isArray(serializedObj)) {
-    return serializedObj.map(serializeKeysToSnakeCase);
-  } else if (serializedObj === null || _typeof(serializedObj) !== "object") {
-    return serializedObj;
-  }
-
-  return Object.fromEntries(Object.entries(serializedObj).map(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
-        key = _ref4[0],
-        value = _ref4[1];
-
-    return [camelToSnakeCase(key), serializeKeysToSnakeCase(value)];
-  }));
+  return transformObjectDeep(object, function (key, value) {
+    return [camelToSnakeCase(key), value];
+  }, function (object) {
+    return typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
+  });
+};
+var preprocessForSerialization = function preprocessForSerialization(object) {
+  return transformObjectDeep(object, function (key, value) {
+    return [key, value];
+  }, function (object) {
+    return typeof (object === null || object === void 0 ? void 0 : object.toJSON) === "function" ? object.toJSON() : object;
+  });
 };
 var deepFreezeObject = function deepFreezeObject(object) {
   if (object && _typeof(object) === "object" && !Object.isFrozen(object)) {
@@ -157,30 +176,18 @@ var deepFreezeObject = function deepFreezeObject(object) {
   return object;
 };
 var matches = /*#__PURE__*/curry(function (pattern, object) {
-  var __parent = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : object;
-
-  if (object === pattern) return true;
-  if (typeof pattern === "function" && pattern(object, __parent)) return true;
-  if (isNil(pattern) || isNil(object)) return false;
-  if (_typeof(pattern) !== "object") return false;
-  return Object.entries(pattern).every(function (_ref5) {
-    var _ref6 = _slicedToArray(_ref5, 2),
-        key = _ref6[0],
-        value = _ref6[1];
-
-    return matches(value, object[key], __parent);
-  });
+  return matchesImpl(pattern, object);
 });
 var filterNonNull = function filterNonNull(object) {
-  return Object.fromEntries(Object.entries(object).filter(function (_ref7) {
-    var _ref8 = _slicedToArray(_ref7, 2),
-        v = _ref8[1];
+  return Object.fromEntries(Object.entries(object).filter(function (_ref5) {
+    var _ref6 = _slicedToArray(_ref5, 2),
+        v = _ref6[1];
 
     return !isNil(v);
-  }).map(function (_ref9) {
-    var _ref10 = _slicedToArray(_ref9, 2),
-        k = _ref10[0],
-        v = _ref10[1];
+  }).map(function (_ref7) {
+    var _ref8 = _slicedToArray(_ref7, 2),
+        k = _ref8[0],
+        v = _ref8[1];
 
     return [k, _typeof(v) === "object" && !Array.isArray(v) ? filterNonNull(v) : v];
   }));
@@ -361,4 +368,4 @@ var isNot = notEquals;
 var notEqualsDeep = /*#__PURE__*/complement(equals);
 var isNotEqualDeep = notEqualsDeep;
 
-export { camelToSnakeCase, capitalize, copyKeys, copyKeysDeep, countBy, deepFreezeObject, dynamicArray, existsBy, existsById, filterBy, filterNonNull, findBy, findById, findIndexBy, findIndexById, findLastBy, findLastIndexBy, getRandomInt, humanize, isNot, isNotEmpty, isNotEqualDeep, isNotNil, keysToCamelCase, keysToSnakeCase, matches, modifyBy, modifyById, noop, notEquals, notEqualsDeep, randomPick, removeBy, removeById, renameKeys, replaceBy, replaceById, serializeKeysToSnakeCase, slugify, snakeToCamelCase, toLabelAndValue, transformObjectDeep, truncate };
+export { camelToSnakeCase, capitalize, copyKeys, copyKeysDeep, countBy, deepFreezeObject, dynamicArray, existsBy, existsById, filterBy, filterNonNull, findBy, findById, findIndexBy, findIndexById, findLastBy, findLastIndexBy, getRandomInt, humanize, isNot, isNotEmpty, isNotEqualDeep, isNotNil, keysToCamelCase, keysToSnakeCase, matches, modifyBy, modifyById, noop, notEquals, notEqualsDeep, preprocessForSerialization, randomPick, removeBy, removeById, renameKeys, replaceBy, replaceById, serializeKeysToSnakeCase, slugify, snakeToCamelCase, toLabelAndValue, transformObjectDeep, truncate };

package/react-utils.cjs.js

@@ -451,7 +451,8 @@ function useDebounce(value) {
 var useFuncDebounce = function useFuncDebounce(func) {
   var delay = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 350;
   var timer = React.useRef(null);
-  return function () {
+
+  var debouncedFunc = function debouncedFunc() {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
@@ -461,6 +462,12 @@ var useFuncDebounce = function useFuncDebounce(func) {
       return func.apply(void 0, args);
     }, delay);
   };
+
+  debouncedFunc.cancel = function () {
+    return clearTimeout(timer.current);
+  };
+
+  return debouncedFunc;
 };
 
 var getStorageValue = function getStorageValue(key, defaultValue) {

package/react-utils.d.ts

@@ -37,10 +37,10 @@ export const Sidebar: React.FC<{
 }>;
 
 export function useDebounce<T>(value: T, delay?: number): T;
-export function useFuncDebounce<A, B, C, D, E>(
-  func: (a?: A, b?: B, c?: C, d?: D, ...e: E[]) => any,
+export function useFuncDebounce<F extends Function>(
+  func: F,
   delay?: number
-): (a?: A, b?: B, c?: C, d?: D, ...e: E[]) => void;
+): (F & { cancel: () => void };
 export function useLocalStorage<T>(
   key: string,
   initialValue?: T

package/react-utils.js

@@ -419,7 +419,8 @@ function useDebounce(value) {
 var useFuncDebounce = function useFuncDebounce(func) {
   var delay = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 350;
   var timer = useRef(null);
-  return function () {
+
+  var debouncedFunc = function debouncedFunc() {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
@@ -429,6 +430,12 @@ var useFuncDebounce = function useFuncDebounce(func) {
       return func.apply(void 0, args);
     }, delay);
   };
+
+  debouncedFunc.cancel = function () {
+    return clearTimeout(timer.current);
+  };
+
+  return debouncedFunc;
 };
 
 var getStorageValue = function getStorageValue(key, defaultValue) {