@blackbyte/sugar 1.0.0-beta.27 → 1.0.0-beta.29

package/dist/shared/object/cleanDeep/cleanDeep.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @name                cleanDeep
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function takes an object as input and returns a cleaned version of it.
+ * You can pass a cleaner function that has to returns true or false. If returns true, the element will be
+ * keeped. If false, it will be removed from the output.
+ * The default cleaner function remove all that is either null, "" or undefined.
+ *
+ * @param         {Object}        object          The object you want to map through
+ * @param         {Object}        [settings={}]     An object of settings to configure your mapDeep process:
+ *
+ * @setting         {Function}      [cleaner=null]       The cleaner function that take as parameter the actual property value, the current property name and the full dotted path to the current property
+ * @setting         {Boolean}       [array=true]                    Specify if we want to process also arrays or not
+ * @setting         {Boolean}       [clone=false]          Specify if you want to clone the object passed before cleaning it
+ *
+ * @todo      tests
+ *
+ * @snippet         cleanDeep($1)
+ * cleanDeep($1);
+ *
+ * @example       js
+ * import { cleanDeep } from '@blackbyte/sugar/object';
+ * cleanDeep({
+ *    hello: 'world',
+ *    something: null
+ * });
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TCleanDeepSettings = {
+    array?: boolean;
+    clone?: boolean;
+    cleaner?(value: any): boolean;
+};
+export default function cleanDeep(objectOrArray: any, settings?: TCleanDeepSettings): any;

package/dist/shared/object/cleanDeep/cleanDeep.js

@@ -0,0 +1,43 @@
+import isPlainObject from '../../is/isPlainObject/isPlainObject.js';
+export default function cleanDeep(objectOrArray, settings) {
+    settings = Object.assign({ array: true, clone: false, cleaner(value) {
+            if (value === undefined || value === null || value === '') {
+                return false;
+            }
+            if (isPlainObject(value) && !Object.keys(value).length) {
+                return false;
+            }
+            return true;
+        } }, (settings !== null && settings !== void 0 ? settings : {}));
+    let workingObj;
+    if (settings.clone) {
+        workingObj = Array.isArray(objectOrArray)
+            ? [...objectOrArray]
+            : Object.assign({}, objectOrArray);
+    }
+    else {
+        workingObj = objectOrArray;
+    }
+    if (settings.array && Array.isArray(objectOrArray)) {
+        for (let [i, v] of objectOrArray.entries()) {
+            if (isPlainObject(v) || Array.isArray(v)) {
+                workingObj[i] = cleanDeep(v, settings);
+            }
+            if (!settings.cleaner(workingObj[i])) {
+                workingObj.splice(workingObj.indexOf(v), 1);
+            }
+        }
+    }
+    else if (isPlainObject(objectOrArray)) {
+        for (let [k, v] of Object.entries(objectOrArray)) {
+            if (isPlainObject(v) || Array.isArray(v)) {
+                workingObj[k] = cleanDeep(v, settings);
+            }
+            if (!settings.cleaner(workingObj[k])) {
+                delete workingObj[k];
+            }
+        }
+    }
+    return workingObj;
+}
+//# sourceMappingURL=cleanDeep.js.map

package/dist/shared/object/cleanDeep/cleanDeep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanDeep.js","sourceRoot":"","sources":["../../../../src/shared/object/cleanDeep/cleanDeep.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,yCAAyC,CAAC;AA4CpE,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,aAAkB,EAClB,QAA6B;IAE7B,QAAQ,mBACN,KAAK,EAAE,IAAI,EACX,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,KAAK;YACX,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1D,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBACvD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,IACE,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,UAAU,CAAC;IACf,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YACvC,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC;YACpB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,UAAU,GAAG,aAAa,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QACnD,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3C,IAAI,aAAa,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzC,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YACzC,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACjD,IAAI,aAAa,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzC,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YACzC,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/shared/object/clone/clone.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name                clone
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function allows you to clone an object either at 1 level, or deeply.
+ *
+ * @param       {Object}        object        The object to copy
+ * @param       {Object}       [settings={}]   Specify some settings to configure your clone process
+ * @return      {Object}                      The cloned object
+ *
+ * @setting     {Boolean}       [deep=false]      Specify if you want to clone the object deeply
+ *
+ * @todo      tests
+ *
+ * @snippet         clone($1)
+ *
+ * @example       js
+ * import { clone } from '@blackbyte/sugar/object';
+ * clone({
+ *    hello: 'world'
+ * });
+ *
+ * @see       https://www.npmjs.com/package/lodash
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TCloneSettings = {
+    deep?: boolean;
+};
+export default function clone(object: any, settings?: TCloneSettings): any;

package/dist/shared/object/clone/clone.js

@@ -0,0 +1,10 @@
+import __clone from 'lodash.clone';
+import deepClone from 'lodash.clonedeep';
+export default function clone(object, settings = {}) {
+    settings = Object.assign({ deep: false }, settings);
+    if (settings.deep) {
+        return deepClone(object);
+    }
+    return __clone(object);
+}
+//# sourceMappingURL=clone.js.map

package/dist/shared/object/clone/clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.js","sourceRoot":"","sources":["../../../../src/shared/object/clone/clone.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,SAAS,MAAM,kBAAkB,CAAC;AAoCzC,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,MAAW,EAAE,WAA2B,EAAE;IACtE,QAAQ,mBACN,IAAI,EAAE,KAAK,IACR,QAAQ,CACZ,CAAC;IACF,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC"}

package/dist/shared/object/cloneInstance/cloneInstance.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                cloneInstance
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function allows you to clone an object instance.
+ *
+ * @param       {Object}        instance        The object instance to clone
+ * @return      {Object}                      The cloned object
+ *
+ * @todo      tests
+ *
+ * @snippet         cloneInstance($1)
+ *
+ * @example       js
+ * import { cloneInstance } from '@blackbyte/sugar/object';
+ * const myInstance = new MyClass();
+ * const myInstanceClone = cloneInstance(myInstance);
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function cloneInstance<T = any>(instance: T): T;

package/dist/shared/object/cloneInstance/cloneInstance.js

@@ -0,0 +1,29 @@
+/**
+ * @name                cloneInstance
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function allows you to clone an object instance.
+ *
+ * @param       {Object}        instance        The object instance to clone
+ * @return      {Object}                      The cloned object
+ *
+ * @todo      tests
+ *
+ * @snippet         cloneInstance($1)
+ *
+ * @example       js
+ * import { cloneInstance } from '@blackbyte/sugar/object';
+ * const myInstance = new MyClass();
+ * const myInstanceClone = cloneInstance(myInstance);
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function cloneInstance(instance) {
+    return Object.assign(Object.create(Object.getPrototypeOf(instance)), instance);
+}
+//# sourceMappingURL=cloneInstance.js.map

package/dist/shared/object/cloneInstance/cloneInstance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloneInstance.js","sourceRoot":"","sources":["../../../../src/shared/object/cloneInstance/cloneInstance.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAU,QAAW;IACxD,OAAO,MAAM,CAAC,MAAM,CAClB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EAC9C,QAAQ,CACT,CAAC;AACJ,CAAC"}

package/dist/shared/object/decycle/decycle.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name                decycle
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This method simply remove the circular references in the passed object
+ *
+ * @param     {Object}      obj         The object to process
+ * @return    {Object}                  The new object circular references free
+ *
+ * @snippet         decycle($1)
+ *
+ * @todo     tests
+ *
+ * @example     js
+ * import { decycle } from '@blackbyte/sugar/object';
+ * decycle({
+ *    something: 'cool',
+ *    with: 'circular references',
+ *    //..
+ * });
+ *
+ * @see         https://www.npmjs.com/package/json-cyclic
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function decycle(obj: any): any;

package/dist/shared/object/decycle/decycle.js

@@ -0,0 +1,34 @@
+import { decycle as __decycle } from 'json-cyclic';
+/**
+ * @name                decycle
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This method simply remove the circular references in the passed object
+ *
+ * @param     {Object}      obj         The object to process
+ * @return    {Object}                  The new object circular references free
+ *
+ * @snippet         decycle($1)
+ *
+ * @todo     tests
+ *
+ * @example     js
+ * import { decycle } from '@blackbyte/sugar/object';
+ * decycle({
+ *    something: 'cool',
+ *    with: 'circular references',
+ *    //..
+ * });
+ *
+ * @see         https://www.npmjs.com/package/json-cyclic
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function decycle(obj) {
+    return __decycle(obj);
+}
+//# sourceMappingURL=decycle.js.map

package/dist/shared/object/decycle/decycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decycle.js","sourceRoot":"","sources":["../../../../src/shared/object/decycle/decycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,GAAQ;IACtC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC"}

package/dist/shared/object/deleteProperty/deleteProperty.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @name                        deleteProperty
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Delete an object property using a dotPath like "something.else"
+ *
+ * @param         {Object}          object            The object on which you want to delete the property
+ * @param         {String}          dotPath           The dotpath to the property you want to delete
+ *
+ * @todo      tests
+ *
+ * @snippet         deleteProperty($1, $2)
+ *
+ * @example         js
+ * import { deleteProperty } from '@blackbyte/sugar/object';
+ * const myObject = {
+ *    hello: 'world',
+ *    plop: 'yop'
+ * };
+ * deleteProperty(myObject, 'plop');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function deleteProperty(object: any, dotPath: string): any;

package/dist/shared/object/deleteProperty/deleteProperty.js

@@ -0,0 +1,60 @@
+import __set from '../set/set.js';
+/**
+ * @name                        deleteProperty
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Delete an object property using a dotPath like "something.else"
+ *
+ * @param         {Object}          object            The object on which you want to delete the property
+ * @param         {String}          dotPath           The dotpath to the property you want to delete
+ *
+ * @todo      tests
+ *
+ * @snippet         deleteProperty($1, $2)
+ *
+ * @example         js
+ * import { deleteProperty } from '@blackbyte/sugar/object';
+ * const myObject = {
+ *    hello: 'world',
+ *    plop: 'yop'
+ * };
+ * deleteProperty(myObject, 'plop');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function deleteProperty(object, dotPath) {
+    const parentDotPath = dotPath.split('.').slice(0, -1).join('.');
+    if (!dotPath || dotPath === '' || dotPath === '.')
+        return object;
+    dotPath = dotPath.replace(/\[(\w+)\]/g, '.$1');
+    dotPath = dotPath.replace(/^\./, '');
+    const a = dotPath.split('.');
+    let o = object;
+    while (a.length) {
+        const n = a.shift();
+        if (!n)
+            continue;
+        if (a.length < 1) {
+            if (Array.isArray(o)) {
+                const valueToDelete = o[n];
+                o = o.filter((v) => {
+                    return v !== valueToDelete;
+                });
+            }
+            else {
+                delete o[n];
+            }
+            __set(object, parentDotPath, o);
+        }
+        else {
+            o = o[n];
+        }
+    }
+    return object;
+}
+//# sourceMappingURL=deleteProperty.js.map

package/dist/shared/object/deleteProperty/deleteProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteProperty.js","sourceRoot":"","sources":["../../../../src/shared/object/deleteProperty/deleteProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,eAAe,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,MAAW,EAAE,OAAe;IACjE,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEhE,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,GAAG;QAAE,OAAO,MAAM,CAAC;IACjE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC/C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,MAAM,CAAC;IACf,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,CAAC;YAAE,SAAS;QACjB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3B,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;oBACjB,OAAO,CAAC,KAAK,aAAa,CAAC;gBAC7B,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACd,CAAC;YACD,KAAK,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/object/diff/diff.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @name                    diff
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * This function take two objects and return an object that contains only what has been changed between the two.
+ * This function is a simple wrapper around the nice object-diff package from Thomas Jensen that you can find here: https://www.npmjs.com/package/object-diff
+ *
+ * @param         {Object}          object1            The first object used for the diff process
+ * @param         {Object}          object2            The second object used for the diff process
+ * @param         {Object}          [settings={}]      An object of settings to configure the diff process:
+ * - deep (true) {Boolean}: Specify if you want a deep diff or a simple one level diff
+ * - added (true) {Boolean}: Specify if you want to include the props that does not exist on the object1 but exists on the object2
+ * - deleted (false) {Boolean}: Specify if you want to include the props that exists on the object1 but no more on the object2
+ * - equals (false) {Boolean}: Specify if you want to include the props that are equals from the object1 to the object2
+ * - emptyObject (false) {Boolean}: Specify if you want to keep the empty objects in the resulting one
+ * - updated (true) {Boolean}: Specify if you want to include the updated values
+ * @return        {Object}                             The object that contains only the differences between the two
+ *
+ * @todo      tests
+ *
+ * @snippet         diff($1, $2)
+ *
+ * @example         js
+ * import { diff } from '@blackbyte/sugar/object';
+ * const myObject1 = {
+ *    hello: 'world',
+ *    plop: 'yop'
+ * };
+ * const myObject2 = {
+ *    coco: 'plop',
+ *    hello: 'hey!',
+ *    plop: 'yop'
+ * };
+ * diff(myObject1, myObject2);
+ * {
+ *    coco: 'plop',
+ *    hello: 'hey!'
+ * }
+ *
+ * @see       https://www.npmjs.com/package/is-equal
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TDiffSettings = {
+    deep?: boolean;
+    added?: boolean;
+    deleted?: boolean;
+    equals?: boolean;
+    emptyObject?: boolean;
+    updated?: boolean;
+};
+export default function diff(object1: any, object2: any, settings?: TDiffSettings): any;

package/dist/shared/object/diff/diff.js

@@ -0,0 +1,54 @@
+import isPlainObject from '../../is/isPlainObject/isPlainObject.js';
+export default function diff(object1, object2, settings = {}) {
+    settings = Object.assign({ deep: true, added: true, deleted: false, equals: false, emptyObject: false, updated: true }, settings);
+    const finalObj = {};
+    const keys = Array.from(new Set([...Object.keys(object1), ...Object.keys(object2)]));
+    for (let i = 0; i < keys.length; i++) {
+        const _prop = keys[i];
+        if (settings.deep) {
+            if (isPlainObject(object1[_prop]) && isPlainObject(object2[_prop])) {
+                finalObj[_prop] = diff(object1[_prop], object2[_prop], settings);
+                if (Object.keys(finalObj[_prop]).length === 0)
+                    delete finalObj[_prop];
+                continue;
+            }
+        }
+        if (settings.added) {
+            if (object1[_prop] === undefined && object2[_prop] !== undefined) {
+                finalObj[_prop] = object2[_prop];
+                continue;
+            }
+        }
+        if (settings.deleted) {
+            if (object1[_prop] !== undefined && object2[_prop] === undefined) {
+                // delete object1[_prop];
+                finalObj[_prop] = object1[_prop];
+                continue;
+            }
+        }
+        if (settings.equals) {
+            if (JSON.stringify(object1[_prop]) === JSON.stringify(object2[_prop])) {
+                finalObj[_prop] = object2[_prop];
+                continue;
+            }
+        }
+        if (settings.emptyObject) {
+            if (isPlainObject(object1[_prop]) &&
+                Object.keys(object1[_prop]).length === 0) {
+                finalObj[_prop] = {};
+                continue;
+            }
+        }
+        if (settings.updated) {
+            if (object1[_prop] === undefined || object2[_prop] === undefined) {
+                continue;
+            }
+            if (JSON.stringify(object1[_prop]) !== JSON.stringify(object2[_prop])) {
+                finalObj[_prop] = object2[_prop];
+                continue;
+            }
+        }
+    }
+    return finalObj;
+}
+//# sourceMappingURL=diff.js.map

package/dist/shared/object/diff/diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../../src/shared/object/diff/diff.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,yCAAyC,CAAC;AA2DpE,MAAM,CAAC,OAAO,UAAU,IAAI,CAC1B,OAAY,EACZ,OAAY,EACZ,WAA0B,EAAE;IAE5B,QAAQ,mBACN,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,IAAI,EACX,OAAO,EAAE,KAAK,EACd,MAAM,EAAE,KAAK,EACb,WAAW,EAAE,KAAK,EAClB,OAAO,EAAE,IAAI,IACV,QAAQ,CACZ,CAAC;IAEF,MAAM,QAAQ,GAAG,EAAE,CAAC;IAEpB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CACrB,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAC5D,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtB,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YAClB,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACnE,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACjE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACtE,SAAS;YACX,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBACjE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBACjE,yBAAyB;gBACzB,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YACzB,IACE,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EACxC,CAAC;gBACD,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBACjE,SAAS;YACX,CAAC;YAED,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/shared/object/ensurePropertyExists/ensurePropertyExists.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @name                ensurePropertyExists
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Pass a string like "my.cool.object" and the value it has to be and this function will ensure that this deep object exist
+ *
+ * @param           {Object}            obj                           The object on which to check the path existence
+ * @param           {String}            path                           The dotted object path to check
+ * @param           {Mixed}             value                         The value to set to the object path created if not already exist
+ * @para            {Any}              The value to set to the object path created
+ *
+ * @todo      tests
+ *
+ * @snippet         ensurePropertyExists($1, $2)
+ *
+ * @example           js
+ * import { ensurePropertyExists } from '@blackbyte/sugar/object';
+ * const myObj = { hello: 'world' }«
+ * ensurePropertyExists(myObj, 'cool.object', {});
+ * // { hello: 'world', cool: { object: {} } }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function ensurePropertyExists(obj: any, path: string, value?: any): any;

package/dist/shared/object/ensurePropertyExists/ensurePropertyExists.js

@@ -0,0 +1,38 @@
+import __get from '../get/get.js';
+import __set from '../set/set.js';
+/**
+ * @name                ensurePropertyExists
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Pass a string like "my.cool.object" and the value it has to be and this function will ensure that this deep object exist
+ *
+ * @param           {Object}            obj                           The object on which to check the path existence
+ * @param           {String}            path                           The dotted object path to check
+ * @param           {Mixed}             value                         The value to set to the object path created if not already exist
+ * @para            {Any}              The value to set to the object path created
+ *
+ * @todo      tests
+ *
+ * @snippet         ensurePropertyExists($1, $2)
+ *
+ * @example           js
+ * import { ensurePropertyExists } from '@blackbyte/sugar/object';
+ * const myObj = { hello: 'world' }«
+ * ensurePropertyExists(myObj, 'cool.object', {});
+ * // { hello: 'world', cool: { object: {} } }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function ensurePropertyExists(obj, path, value = {}) {
+    const v = __get(obj, path);
+    if (v === undefined) {
+        __set(obj, path, value);
+    }
+    return v !== null && v !== void 0 ? v : value;
+}
+//# sourceMappingURL=ensurePropertyExists.js.map

package/dist/shared/object/ensurePropertyExists/ensurePropertyExists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensurePropertyExists.js","sourceRoot":"","sources":["../../../../src/shared/object/ensurePropertyExists/ensurePropertyExists.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,KAAK,MAAM,eAAe,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAC1C,GAAQ,EACR,IAAY,EACZ,QAAa,EAAE;IAEf,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3B,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;QACpB,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,CAAC,aAAD,CAAC,cAAD,CAAC,GAAI,KAAK,CAAC;AACpB,CAAC"}

package/dist/shared/object/filterDeep/filterDeep.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @name                        filterDeep
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Allow to filter an object using a function and this through all of the object structure. It works the same as the filter method on the Array object type.
+ * The passed filter function will have as parameter each object properties and must return true or false depending if you want the
+ * passed property in the filtered object
+ *
+ * @param               {Object}                object                The object to filter
+ * @param               {Function}              filter                The filter function that take as parameter the property itself, and the property name
+ * @return              {Object}                                      The filtered object
+ *
+ * @setting             {Boolean}           [clone=true]            Specify if you want to clone the object before filter it
+ *
+ * @todo      tests
+ *
+ * @example           js
+ * import { filterDeep } from '@blackbyte/sugar/object';
+ * filterDeep ({
+ *    coco: 'hello',
+ *    plop: true,
+ *    sub: {
+ *      property: 'world'
+ *    }
+ * }, ({key, value}) => typeof item === 'string');
+ * // {
+ * //   coco: 'hello'
+ * //   sub: {
+ * //     property: 'world'
+ * //   }
+ * // }
+ *
+ * @since         1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFilterDeepSettings = {
+    clone: boolean;
+};
+export type TFilterDeepFilter = {
+    (item: TFilterDeepItem): undefined | boolean;
+};
+export type TFilterDeepItem = {
+    key: string;
+    value: any;
+    isObject: boolean;
+};
+export default function filterDeep(object: any, filter: TFilterDeepFilter, settings?: Partial<TFilterDeepSettings>): any;

package/dist/shared/object/filterDeep/filterDeep.js

@@ -0,0 +1,46 @@
+import isPlainObject from '../../is/isPlainObject/isPlainObject.js';
+function processObj(object, filter, settings) {
+    const newObj = {}, keys = Object.keys(object);
+    // loop on the object keys
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        const value = object[key];
+        // pass the property in the filter function
+        const res = filter({
+            key,
+            value,
+            isObject: isPlainObject(value),
+        });
+        // true mean: we keep this totally
+        if (res === true) {
+            if (isPlainObject(value)) {
+                newObj[key] = settings.clone
+                    ? processObj(Object.assign({}, value), filter, settings)
+                    : processObj(value, filter, settings);
+            }
+            else {
+                newObj[key] = value;
+            }
+        }
+        else if (res === undefined) {
+            if (isPlainObject(value)) {
+                newObj[key] = settings.clone
+                    ? processObj(Object.assign({}, value), filter, settings)
+                    : processObj(value, filter, settings);
+            }
+            else {
+                newObj[key] = value;
+            }
+        }
+        // false mean: we do not keep this
+        else if (res === false) {
+            continue;
+        }
+    }
+    return newObj;
+}
+export default function filterDeep(object, filter, settings) {
+    settings = Object.assign({ clone: true }, (settings !== null && settings !== void 0 ? settings : {}));
+    return processObj(settings.clone ? Object.assign({}, object) : object, filter, settings);
+}
+//# sourceMappingURL=filterDeep.js.map