@mongez/reinforcements 2.0.5 → 2.0.7

package/README.md

@@ -498,6 +498,48 @@ import { flatten } from "@mongez/reinforcements";
 console.log(flatten(user));
 ```
 
+If the object has an instance of class, all class members (except for the functions) will be included in the flattened object.
+
+```ts
+import { Obj } from "@mongez/reinforcements";
+
+class User {
+  id = 1;
+  name = "Hasan Zohdy";
+  email = "",
+  job = {
+    title: "Software Engineer",
+  };
+  address = {
+    country: "Egypt",
+    building: {
+      number: 12,
+      floor: {
+        number: 3,
+      },
+    },
+  };
+}
+
+const user = new User();
+
+console.log(Obj.flatten(user));
+```
+
+Output:
+
+```json
+{
+  "id": 1,
+  "name": "Hasan Zohdy",
+  "email": "",
+  "job.title": "Software Engineer",
+  "address.country": "Egypt",
+  "address.building.number": 12,
+  "address.building.floor.number": 3
+}
+```
+
 ### Sort object by its keys
 
 To sort objects based on their keys alphabets recursively use `Obj.sort(object: object, recursive: boolean = true): object` function.

package/cjs/index.d.ts

@@ -43,6 +43,7 @@ export { default as rtrim } from "./string/rtrim";
 export { ARABIC_PATTERN, default as startsWithArabic, } from "./string/startsWithArabic";
 export { default as toCamelCase } from "./string/toCamelCase";
 export { default as toInputName } from "./string/toInputName";
+export { default as toKebabCase } from "./string/toKebabCase";
 export { default as toSnakeCase } from "./string/toSnakeCase";
 export { default as toStudlyCase } from "./string/toStudlyCase";
 export { default as trim } from "./string/trim";

package/cjs/index.js

@@ -47,6 +47,7 @@ var rtrim = require("./string/rtrim.js");
 var startsWithArabic = require("./string/startsWithArabic.js");
 var toCamelCase = require("./string/toCamelCase.js");
 var toInputName = require("./string/toInputName.js");
+var toKebabCase = require("./string/toKebabCase.js");
 var toSnakeCase = require("./string/toSnakeCase.js");
 var toStudlyCase = require("./string/toStudlyCase.js");
 var trim = require("./string/trim.js");
@@ -102,6 +103,7 @@ exports.ARABIC_PATTERN = startsWithArabic.ARABIC_PATTERN;
 exports.startsWithArabic = startsWithArabic["default"];
 exports.toCamelCase = toCamelCase;
 exports.toInputName = toInputName;
+exports.toKebabCase = toKebabCase;
 exports.toSnakeCase = toSnakeCase;
 exports.toStudlyCase = toStudlyCase;
 exports.trim = trim;

package/cjs/object/flatten.js

@@ -5,6 +5,24 @@ var tslib_es6 = require('./../__helpers/tslib/tslib.es6.js');
 function canBeFlatten(value) {
   return value !== null && typeof value === "object";
 }
+function toPlainObject(object) {
+  if (Array.isArray(object)) {
+    return object.map(function (item) {
+      return toPlainObject(item);
+    });
+  }
+  if (canBeFlatten(object)) {
+    var clonedObject = Object.keys(object).reduce(function (acc, key) {
+      if (typeof object[key] === "function") return acc;
+      acc[key] = toPlainObject(object[key]);
+      return acc;
+    }, {});
+    // clone the prototype
+    clonedObject.__proto__ = object.__proto__;
+    return clonedObject;
+  }
+  return object;
+}
 /**
  * Flatten the given object into one big fat object
  */
@@ -19,7 +37,10 @@ function flatten(object, separator, keepNestedOriginalObject, parent, root) {
   if (root === void 0) {
     root = {};
   }
-  if (canBeFlatten(object) === false) return object;
+  if (canBeFlatten(object) === false) {
+    return object;
+  }
+  object = toPlainObject(object);
   try {
     for (
       var _b = tslib_es6.__values(Object.keys(object)), _c = _b.next();
@@ -31,9 +52,9 @@ function flatten(object, separator, keepNestedOriginalObject, parent, root) {
       var keyChain = parent ? parent + separator + key : key;
       if (Array.isArray(value) && value.length === 0) {
         root[keyChain] = value;
-      } else if (canBeFlatten(value) === true) {
+      } else if (canBeFlatten(value)) {
         if (keepNestedOriginalObject) {
-          root[keyChain] = value; // add the original object/array as well
+          root[keyChain] = value;
         }
         flatten(value, separator, keepNestedOriginalObject, keyChain, root);
       } else {

package/cjs/string/toKebabCase.js

@@ -0,0 +1,15 @@
+"use strict";
+
+var toSnakeCase = require("./toSnakeCase.js");
+
+/**
+ * Convert current string to kebab case
+ */
+function toKebabCase(string, lowerAll) {
+  if (lowerAll === void 0) {
+    lowerAll = true;
+  }
+  return toSnakeCase(string, "-", lowerAll);
+}
+
+module.exports = toKebabCase;

package/esm/index.d.ts

@@ -43,6 +43,7 @@ export { default as rtrim } from "./string/rtrim";
 export { ARABIC_PATTERN, default as startsWithArabic, } from "./string/startsWithArabic";
 export { default as toCamelCase } from "./string/toCamelCase";
 export { default as toInputName } from "./string/toInputName";
+export { default as toKebabCase } from "./string/toKebabCase";
 export { default as toSnakeCase } from "./string/toSnakeCase";
 export { default as toStudlyCase } from "./string/toStudlyCase";
 export { default as trim } from "./string/trim";

package/esm/index.js

@@ -49,6 +49,7 @@ export {
 } from "./string/startsWithArabic.js";
 export { default as toCamelCase } from "./string/toCamelCase.js";
 export { default as toInputName } from "./string/toInputName.js";
+export { default as toKebabCase } from "./string/toKebabCase.js";
 export { default as toSnakeCase } from "./string/toSnakeCase.js";
 export { default as toStudlyCase } from "./string/toStudlyCase.js";
 export { default as trim } from "./string/trim.js";

package/esm/object/flatten.js

@@ -3,6 +3,24 @@ import { __values } from './../__helpers/tslib/tslib.es6.js';
 function canBeFlatten(value) {
   return value !== null && typeof value === "object";
 }
+function toPlainObject(object) {
+  if (Array.isArray(object)) {
+    return object.map(function (item) {
+      return toPlainObject(item);
+    });
+  }
+  if (canBeFlatten(object)) {
+    var clonedObject = Object.keys(object).reduce(function (acc, key) {
+      if (typeof object[key] === "function") return acc;
+      acc[key] = toPlainObject(object[key]);
+      return acc;
+    }, {});
+    // clone the prototype
+    clonedObject.__proto__ = object.__proto__;
+    return clonedObject;
+  }
+  return object;
+}
 /**
  * Flatten the given object into one big fat object
  */
@@ -17,7 +35,10 @@ function flatten(object, separator, keepNestedOriginalObject, parent, root) {
   if (root === void 0) {
     root = {};
   }
-  if (canBeFlatten(object) === false) return object;
+  if (canBeFlatten(object) === false) {
+    return object;
+  }
+  object = toPlainObject(object);
   try {
     for (
       var _b = __values(Object.keys(object)), _c = _b.next();
@@ -29,9 +50,9 @@ function flatten(object, separator, keepNestedOriginalObject, parent, root) {
       var keyChain = parent ? parent + separator + key : key;
       if (Array.isArray(value) && value.length === 0) {
         root[keyChain] = value;
-      } else if (canBeFlatten(value) === true) {
+      } else if (canBeFlatten(value)) {
         if (keepNestedOriginalObject) {
-          root[keyChain] = value; // add the original object/array as well
+          root[keyChain] = value;
         }
         flatten(value, separator, keepNestedOriginalObject, keyChain, root);
       } else {

package/esm/string/toKebabCase.js

@@ -0,0 +1,13 @@
+import toSnakeCase from "./toSnakeCase.js";
+
+/**
+ * Convert current string to kebab case
+ */
+function toKebabCase(string, lowerAll) {
+  if (lowerAll === void 0) {
+    lowerAll = true;
+  }
+  return toSnakeCase(string, "-", lowerAll);
+}
+
+export { toKebabCase as default };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mongez/reinforcements",
-    "version": "2.0.5",
+    "version": "2.0.7",
     "description": "A lightweight package to give a massive reinforcements to variant types of data in Nodejs/Javascript",
     "main": "./cjs/index.js",
     "dependencies": {