@mongez/reinforcements 2.0.12 → 2.2.0

package/README.md

@@ -14,43 +14,18 @@ or using `npm`
 
 ## Usage
 
-## Collections
+## Getting value from an object
 
-Reinforcements is shipped with a powerful collection class that can be used to manipulate arrays of objects, here are some example of usage.
+To get a value from an object using `dot.notation` syntax, you can use `get` function.
 
 ```ts
-import { collect } from '@mongez/reinforcements';
-
-const collection = collect([
-    { name: 'John', age: 20 },
-    { name: 'Jane', age: 25 },
-    { name: 'Jack', age: 30 },
-]);
-
-// get the first item
-const firstItem = collection.first();
-
-// get the last item
-const lastItem = collection.last();
-
-// get the item at index 1
-const itemAtIndex1 = collection.at(1);
-
-// get users with age greater than 25
-const users = collection.where('age', '>', 25);
-
-// get users with age greater than 25 and less than 30
-const users = collection.where('age', '>', 25).where('age', '<', 30);
+get(object: object, key: string, defaultValue?: any): any
 ```
 
-You can see the entire documentation in [Collection](./docs/collection.md) Page.
-
-## Working with objects
-
-Reinforcements is shipped with `Obj` object which provides good utilities for working with objects.
+Let's see an example:
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { get } from "@mongez/reinforcements";
 
 let user = {
   id: 1,
@@ -69,12 +44,12 @@ let user = {
   },
 };
 
-Obj.get(user, "id"); // 1
-Obj.get(user, "name"); // {first: 'Hasan', last: 'Zohdy'}
-Obj.get(user, "name.first"); // Hasan
-Obj.get(user, "address.country"); // Egypt
-Obj.get(user, "address.building.number"); // 12
-Obj.get(user, "address.building.floor.number"); // 3
+get(user, "id"); // 1
+get(user, "name"); // {first: 'Hasan', last: 'Zohdy'}
+get(user, "name.first"); // Hasan
+get(user, "address.country"); // Egypt
+get(user, "address.building.number"); // 12
+get(user, "address.building.floor.number"); // 3
 ```
 
 As we can see in the previous example, we can get values from objects using **dot.notation.syntax**.
@@ -82,23 +57,15 @@ As we can see in the previous example, we can get values from objects using **do
 If the key is missing in the object, we may return default value instead.
 
 ```ts
-Obj.get(user, "email", "no-email"); // no-email
-```
-
-You can also import `get` function directly from the package.
-
-```ts
-import { get } from "@mongez/reinforcements";
-
-get(user, "id"); // 1
+get(user, "email", "no-email"); // no-email
 ```
 
 ### Setting value in object
 
-This works exactly but `Obj.set(object, key, value)` will set the value to the given object, which means it won't return **a new object** but the same object.
+This works exactly but `set(object, key, value)` will set the value to the given object, which means it won't return **a new object** but the same object.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { set } from "@mongez/reinforcements";
 
 let user = {
   id: 1,
@@ -117,14 +84,14 @@ let user = {
   },
 };
 
-Obj.set(user, "email", "hassanzohdy@gmail.com");
-Obj.set(user, "address.building.floor.apartment", 36);
-Obj.set(user, "job.title", "Software Engineer");
+set(user, "email", "hassanzohdy@gmail.com");
+set(user, "address.building.floor.apartment", 36);
+set(user, "job.title", "Software Engineer");
 ```
 
-In the previous example, we've three different cases, first case which would not be used with `Obj.set` which is setting one level key to the given object `user`, in this case we added `email` key.
+In the previous example, we've three different cases, first case which would not be used with `set` which is setting one level key to the given object `user`, in this case we added `email` key.
 
-In the second scenario, we added a new nested key in `address.building.floor` object, which is `apartment`, this would be a nice case to use `Obj.set`.
+In the second scenario, we added a new nested key in `address.building.floor` object, which is `apartment`, this would be a nice case to use `set`.
 
 The last scenario, we don't have `job` key, the function will create `job` key then set `job.title` inside it.
 
@@ -154,22 +121,12 @@ The final user object will be:
 }
 ```
 
-You can also import `set` function directly from the package.
-
-```ts
-import { set } from "@mongez/reinforcements";
-
-set(user, "email", "hassanzohdy@gmail.com");
-```
-
 ### Merging objects deeply
 
-Another good feature from `Obj` object is to merge objects deeply.
-
-You may use `Obj.merge` or import `merge` directly from the package.
+To merge two objects deeply, you can use `merge` function.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { merge } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -183,7 +140,7 @@ const userJob = {
   },
 };
 
-const userWithJob = Obj.merge(user, userJob);
+const userWithJob = merge(user, userJob);
 ```
 
 Final output:
@@ -222,7 +179,7 @@ const userWithJob = Object.assign({}, user, userJob);
 In the previous example, that would be the proper approach as the merging depth here is simple, but let's take another example.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { merge } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -238,7 +195,7 @@ const userJob = {
   },
 };
 
-const userWithJob = Obj.merge(user, userJob);
+const userWithJob = merge(user, userJob);
 ```
 
 The output will be:
@@ -286,17 +243,9 @@ const userWithJob = Object.assign({}, user, userJob);
 }
 ```
 
-You can also import `merge` function directly from the package.
-
-```ts
-import { merge } from "@mongez/reinforcements";
-
-const userWithJob = merge(user, userJob);
-```
-
 ### Clone objects
 
-You can also make a **deep copy** for the given object using `Obj.clone` or `clone`
+You can also make a **deep copy** for the given object using `clone`
 
 ```ts
 const user = {
@@ -315,10 +264,10 @@ console.log(normalClonedUser.name.first); // Ali
 console.log(user.name.first); // Ali
 ```
 
-Now using `Obj.clone`
+Now using `clone` method
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { clone } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -327,7 +276,7 @@ const user = {
   },
 };
 
-const normalClonedUser = Obj.clone(user);
+const normalClonedUser = clone(user);
 
 cloned.name.first = "Ali";
 
@@ -338,10 +287,10 @@ console.log(user.name.first); // Hasan
 
 ### Getting certain values from object
 
-To get a new object from the base object with only list of keys, use `Obj.only(object: object, keys: string[]): object`
+To get a new object from the base object with only list of keys, use `only(object: object, keys: string[]): object`
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { only } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -361,23 +310,15 @@ const user = {
   },
 };
 
-const simpleUserData = Obj.only(user, ["id", "name", "email"]); // {id: 1, name: 'Hasan Zohdy', email: 'hassanzohdy@gmail.com'}
-```
-
-You can also import `only` function directly from the package.
-
-```ts
-import { only } from "@mongez/reinforcements";
-
-const simpleUserData = only(user, ["id", "name", "email"]);
+const simpleUserData = only(user, ["id", "name", "email"]); // {id: 1, name: 'Hasan Zohdy', email: 'hassanzohdy@gmail.com'}
 ```
 
 ### Getting all object except for certain keys
 
-This is the reverse of `obj.only`, which returns the entire object except for the given keys.
+This is the reverse of `only`, which returns the entire object except for the given keys.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { except } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -397,15 +338,37 @@ const user = {
   },
 };
 
-const simpleUserData = Obj.except(user, ["id", "address", "email"]); // { name: 'Hasan Zohdy', email: 'hassanzohdy@gmail.com', job: {title: 'Software Engineer'}}
+const simpleUserData = except(user, ["id", "address", "email"]); // { name: 'Hasan Zohdy', email: 'hassanzohdy@gmail.com', job: {title: 'Software Engineer'}}
 ```
 
-You can also import `except` function directly from the package.
+### Unset keys from object
+
+> Added in 2.1.0
+
+To remove certain keys from the object, use `unset(object: object, keys: string[]): object`
 
 ```ts
-import { except } from "@mongez/reinforcements";
+import { unset } from "@mongez/reinforcements";
 
-const simpleUserData = except(user, ["id", "address", "email"]);
+const user = {
+  id: 1,
+  name: "Hasan Zohdy",
+  email: "hassanzohdy@gmail.com",
+  job: {
+    title: "Software Engineer",
+  },
+  address: {
+    country: "Egypt",
+    building: {
+      number: 12,
+      floor: {
+        number: 3,
+      },
+    },
+  },
+};
+
+const simpleUserData = unset(user, ["id", "address", "email"]); // { name: 'Hasan Zohdy', job: {title: 'Software Engineer'}}
 ```
 
 ### Flatten objects
@@ -413,7 +376,7 @@ const simpleUserData = except(user, ["id", "address", "email"]);
 We can flatten any big fat objects into one object, with only one dimension.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { flatten } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -433,7 +396,7 @@ const user = {
   },
 };
 
-console.log(Obj.flatten(user));
+console.log(flatten(user));
 ```
 
 Output:
@@ -453,7 +416,7 @@ Output:
 You may set the separator by passing second argument to the function.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { flatten } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -473,7 +436,7 @@ const user = {
   },
 };
 
-console.log(Obj.flatten(user, "->"));
+console.log(flatten(user, "->"));
 ```
 
 Output:
@@ -490,18 +453,10 @@ Output:
 }
 ```
 
-You can also import `flatten` function directly from the package.
-
-```ts
-import { flatten } from "@mongez/reinforcements";
-
-console.log(flatten(user));
-```
-
 If the object has an instance of class, all class members will be included in the flattened object.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { flatten } from "@mongez/reinforcements";
 
 class User {
   id = 1;
@@ -523,7 +478,7 @@ class User {
 
 const user = new User();
 
-console.log(Obj.flatten(user));
+console.log(flatten(user));
 ```
 
 Output:
@@ -542,10 +497,10 @@ Output:
 
 ### Sort object by its keys
 
-To sort objects based on their keys alphabets recursively use `Obj.sort(object: object, recursive: boolean = true): object` function.
+To sort objects based on their keys alphabets recursively use `sort(object: object, recursive: boolean = true): object` function.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { sort } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -565,7 +520,7 @@ const user = {
   },
 };
 
-console.log(Obj.sort(user));
+console.log(sort(user));
 ```
 
 Output:
@@ -593,7 +548,7 @@ Output:
 To sort the object only the first level, pass the second argument as false.
 
 ```ts
-import { Obj } from "@mongez/reinforcements";
+import { sort } from "@mongez/reinforcements";
 
 const user = {
   id: 1,
@@ -613,7 +568,7 @@ const user = {
   },
 };
 
-console.log(Obj.sort(user, false));
+console.log(sort(user, false));
 ```
 
 Output:
@@ -638,14 +593,6 @@ Output:
 }
 ```
 
-You can also import `sort` function directly from the package.
-
-```ts
-import { sort } from "@mongez/reinforcements";
-
-console.log(sort(user));
-```
-
 ## Equal Values
 
 Using `areEqual` function will check if the given two values equal to each other, it will validate against any type such as objects, arrays, strings, numbers, booleans, null, undefined, symbols.
@@ -1258,12 +1205,13 @@ function sendEmail(e: any) {
 
 To run tests run `npm run test` or `yarn test`
 
-## TODO
-
-If you want to contribute to this package, you can check the [todo list page](./docs/todo.md).
-
 ## Change Log
 
+- 2.2.0 (08 Nov 2022)
+  - Migrated Collections From Package to separate package.
+- 2.1.0 (06 Nov 2022)
+  - Added [unset](#unset-keys-from-object) function.
+  - Fixed `except` and `only` functions to accept dot notation syntax.
 - 2.0.5 (25 Oct 2022)
   - Added `toKebabCase` function
 - 2.0.0 (24 Oct 2022)

package/cjs/Random/random.js

@@ -1,40 +1,26 @@
 "use strict";
 
-var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
-var Random = {
+const possible =
+  "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+const Random = {
   /**
    * Get a random integer
    */
-  int: function (min, max) {
-    if (min === void 0) {
-      min = 1;
-    }
-    if (max === void 0) {
-      max = 9999999;
-    }
+  int(min = 1, max = 9999999) {
     return Math.floor(Math.random() * (max - min + 1)) + min;
   },
   /**
    * @alias Random.int
    */
-  integer: function (min, max) {
-    if (min === void 0) {
-      min = 1;
-    }
-    if (max === void 0) {
-      max = 9999999;
-    }
+  integer(min = 1, max = 9999999) {
     return this.int(min, max);
   },
   /**
    * Generate random string
    */
-  string: function (length) {
-    if (length === void 0) {
-      length = 32;
-    }
-    var text = "";
-    for (var i = 0; i < length; i++) {
+  string(length = 32) {
+    let text = "";
+    for (let i = 0; i < length; i++) {
       text += possible.charAt(Math.floor(Math.random() * possible.length));
     }
     return text;
@@ -42,44 +28,38 @@ var Random = {
   /**
    * Generate random id
    */
-  id: function (length, startsWith) {
-    if (length === void 0) {
-      length = 6;
-    }
-    if (startsWith === void 0) {
-      startsWith = "el-";
-    }
+  id(length = 6, startsWith = "el-") {
     return startsWith + Random.string(length);
   },
   /**
    * Generate random boolean value
    */
-  bool: function () {
+  bool() {
     return Random.int(0, 1) === 1;
   },
   /**
    * Alias to bool method
    */
-  boolean: function () {
+  boolean() {
     return Random.int(0, 1) === 1;
   },
   /**
    * Get random date
    */
-  date: function (minDate, maxDate) {
+  date(minDate, maxDate) {
     if (minDate && !maxDate) {
       return new Date(Random.int(minDate.getTime(), Date.now()));
     }
     if (!minDate && maxDate) {
       return new Date(Random.int(0, maxDate.getTime()));
     }
-    var now = Date.now();
+    const now = Date.now();
     return new Date(Random.int(now - 100000000000, now));
   },
   /**
    * Get random color
    */
-  color: function () {
+  color() {
     return "#" + Math.floor(Math.random() * 16777215).toString(16);
   },
 };

package/cjs/array/chunk.js

@@ -5,8 +5,8 @@
  */
 function chunk(array, size) {
   if (!Array.isArray(array) && typeof array !== "string") return [];
-  var result = [];
-  for (var i = 0; i < array.length; i += size) {
+  const result = [];
+  for (let i = 0; i < array.length; i += size) {
     result.push(array.slice(i, i + size));
   }
   return result;

package/cjs/array/count.js

@@ -2,16 +2,14 @@
 
 var get = require("../object/get.js");
 
-var notFound = Symbol("notFound");
+const notFound = Symbol("notFound");
 /**
  * Count data by the given key or callback
  */
 function count(data, key) {
   if (!Array.isArray(data)) return 0;
   if (typeof key === "string") {
-    return data.filter(function (item) {
-      return get(item, key, notFound) !== notFound;
-    }).length;
+    return data.filter(item => get(item, key, notFound) !== notFound).length;
   }
   return data.filter(key).length;
 }

package/cjs/array/even.js

@@ -9,8 +9,8 @@ var get = require("../object/get.js");
  */
 function even(array, key) {
   if (!Array.isArray(array)) return [];
-  return array.filter(function (item) {
-    var value = key ? get(item, key) : item;
+  return array.filter(item => {
+    const value = key ? get(item, key) : item;
     return typeof value !== "number" ? false : value % 2 === 0;
   });
 }

package/cjs/array/evenIndexes.js

@@ -5,9 +5,7 @@
  */
 function evenIndexes(array) {
   if (!Array.isArray(array)) return [];
-  return array.filter(function (_item, index) {
-    return index % 2 === 0;
-  });
+  return array.filter((_item, index) => index % 2 === 0);
 }
 
 module.exports = evenIndexes;