@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/object/_exports.js

@@ -0,0 +1,30 @@
+import camelCaseProps from './camelCaseProps.js';
+import clone from './clone.js';
+import decycle from './decycle.js';
+import cleanDeep from './cleanDeep.js';
+import filterDeep from './filterDeep.js';
+import unflatten from './unflatten.js';
+import mapDeep from './mapDeep.js';
+import mergeDeep from './mergeDeep.js';
+import proxyDeep from './proxyDeep.js';
+import findDeep from './findDeep.js';
+import deleteProperty from './deleteProperty.js';
+import diff from './diff.js';
+import ensurePropertyExists from './ensurePropertyExists.js';
+import filterObject from './filterObject.js';
+import flatten from './flatten.js';
+import get from './get.js';
+import getGlob from './getGlob.js';
+import getKeyByValue from './getKeyByValue.js';
+import map from './map.js';
+import objectHash from './objectHash.js';
+import propertyProxy from './propertyProxy.js';
+import remove from './remove.js';
+import set from './set.js';
+import sort from './sort.js';
+import sortDeep from './sortDeep.js';
+import toJson from './toJson.js';
+import toPlainObject from './toPlainObject.js';
+import toQueryString from './toQueryString.js';
+export { camelCaseProps as __camelCaseProps, clone as __clone, decycle as __decycle, cleanDeep as __cleanDeep, cleanDeep as __deepClean, filterDeep as __filterDeep, filterDeep as __deepFilter, unflatten as __unflatten, unflatten as __deepize, mapDeep as __deepMap, mapDeep as __mapDeep, mergeDeep as __mergeDeep, mergeDeep as __deepMerge, proxyDeep as __proxyDeep, proxyDeep as __deepProxy, findDeep as __findDeep, findDeep as __deepSearch, deleteProperty as __deleteProperty, diff as __diff, ensurePropertyExists as __ensurePropertyExists, filterObject as __filterObject, flatten as __flatten, get as __get, getGlob as __getGlob, getKeyByValue as __getKeyByValue, map as __map, objectHash as __objectHash, propertyProxy as __propertyProxy, remove as __remove, set as __set, sort as __sort, sortDeep as __sortDeep, toJson as __toJson, toPlainObject as __toPlainObject, toQueryString as __toQueryString, camelCaseProps, clone, decycle, cleanDeep, cleanDeep as deepClean, filterDeep, filterDeep as deepFilter, unflatten, unflatten as deepize, mapDeep, mapDeep as deepMap, mergeDeep, mergeDeep as deepMerge, proxyDeep, proxyDeep as deepProxy, findDeep, findDeep as deepSearch, deleteProperty, diff, ensurePropertyExists, filterObject, flatten, get, getGlob, getKeyByValue, map, objectHash, propertyProxy, remove, set, sort, sortDeep, toJson, toPlainObject, toQueryString, };
+//# sourceMappingURL=_exports.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/object/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EACL,cAAc,IAAI,gBAAgB,EAClC,KAAK,IAAI,OAAO,EAChB,OAAO,IAAI,SAAS,EACpB,SAAS,IAAI,WAAW,EACxB,SAAS,IAAI,WAAW,EACxB,UAAU,IAAI,YAAY,EAC1B,UAAU,IAAI,YAAY,EAC1B,SAAS,IAAI,WAAW,EACxB,SAAS,IAAI,SAAS,EACtB,OAAO,IAAI,SAAS,EACpB,OAAO,IAAI,SAAS,EACpB,SAAS,IAAI,WAAW,EACxB,SAAS,IAAI,WAAW,EACxB,SAAS,IAAI,WAAW,EACxB,SAAS,IAAI,WAAW,EACxB,QAAQ,IAAI,UAAU,EACtB,QAAQ,IAAI,YAAY,EACxB,cAAc,IAAI,gBAAgB,EAClC,IAAI,IAAI,MAAM,EACd,oBAAoB,IAAI,sBAAsB,EAC9C,YAAY,IAAI,cAAc,EAC9B,OAAO,IAAI,SAAS,EACpB,GAAG,IAAI,KAAK,EACZ,OAAO,IAAI,SAAS,EACpB,aAAa,IAAI,eAAe,EAChC,GAAG,IAAI,KAAK,EACZ,UAAU,IAAI,YAAY,EAC1B,aAAa,IAAI,eAAe,EAChC,MAAM,IAAI,QAAQ,EAClB,GAAG,IAAI,KAAK,EACZ,IAAI,IAAI,MAAM,EACd,QAAQ,IAAI,UAAU,EACtB,MAAM,IAAI,QAAQ,EAClB,aAAa,IAAI,eAAe,EAChC,aAAa,IAAI,eAAe,EAChC,cAAc,EACd,KAAK,EACL,OAAO,EACP,SAAS,EACT,SAAS,IAAI,SAAS,EACtB,UAAU,EACV,UAAU,IAAI,UAAU,EACxB,SAAS,EACT,SAAS,IAAI,OAAO,EACpB,OAAO,EACP,OAAO,IAAI,OAAO,EAClB,SAAS,EACT,SAAS,IAAI,SAAS,EACtB,SAAS,EACT,SAAS,IAAI,SAAS,EACtB,QAAQ,EACR,QAAQ,IAAI,UAAU,EACtB,cAAc,EACd,IAAI,EACJ,oBAAoB,EACpB,YAAY,EACZ,OAAO,EACP,GAAG,EACH,OAAO,EACP,aAAa,EACb,GAAG,EACH,UAAU,EACV,aAAa,EACb,MAAM,EACN,GAAG,EACH,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,aAAa,EACb,aAAa,GACd,CAAC"}

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

@@ -0,0 +1,35 @@
+/**
+ * @name                camelCaseProps
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function simply take an object as argument and return the same one but with properties in camel case.
+ *
+ * @param           {Object}            object          An object on which to apply the camel case treatment
+ * @param           {IApplyScopeSettings}           [settings={}]           Some settings to configure your scope application process
+ *
+ * @setting         {Boolean}           [deep=true]             Specify if you want to apply the treatment deep in the object or just in the first level
+ *
+ * @todo        tests
+ *
+ * @snippet         camelCaseProps($1)
+ *
+ * @example         js
+ * import { camelCaseProps } from '@blackbyte/sugar/object';
+ * camelCaseProps({
+ *    'hello-world': true
+ * });
+ * // {
+ * //   helloWorld: true
+ * // }
+ *
+ * @since           1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TCamelCasePropsSettings = {
+    deep: boolean;
+};
+export default function camelCaseProps(object: any, settings?: Partial<TCamelCasePropsSettings>): any;

package/dist/shared/object/camelCaseProps.js

@@ -0,0 +1,21 @@
+import isPlainObject from '../is/isPlainObject.js';
+import camelCase from '../string/camelCase.js';
+export default function camelCaseProps(object, settings) {
+    const finalSettings = Object.assign({ deep: true }, (settings !== null && settings !== void 0 ? settings : {}));
+    for (let [key, value] of Object.entries(object)) {
+        const newKey = camelCase(key);
+        // treat deep
+        if (isPlainObject(value) && finalSettings.deep) {
+            object[newKey] = camelCaseProps(object[key], finalSettings);
+        }
+        else {
+            object[newKey] = value;
+        }
+        // delete old key if needed
+        if (newKey !== key) {
+            delete object[key];
+        }
+    }
+    return object;
+}
+//# sourceMappingURL=camelCaseProps.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"camelCaseProps.js","sourceRoot":"","sources":["../../../src/shared/object/camelCaseProps.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAoC/C,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,MAAW,EACX,QAA2C;IAE3C,MAAM,aAAa,mBACjB,IAAI,EAAE,IAAI,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAE9B,aAAa;QACb,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC;QAC9D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACzB,CAAC;QAED,2BAA2B;QAC3B,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/object/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.js

@@ -0,0 +1,43 @@
+import isPlainObject from '../is/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.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanDeep.js","sourceRoot":"","sources":["../../../src/shared/object/cleanDeep.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AA4CnD,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,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrC,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,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/shared/object/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.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.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.js","sourceRoot":"","sources":["../../../src/shared/object/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/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.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.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decycle.js","sourceRoot":"","sources":["../../../src/shared/object/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/deepClean.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @name                deepClean
+ * @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 deepMap 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         deepClean($1)
+ * deepClean($1);
+ *
+ * @example       js
+ * import { deepClean } from '@blackbyte/sugar/object';
+ * deepClean({
+ *    hello: 'world',
+ *    something: null
+ * });
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TDeepCleanSettings = {
+    array?: boolean;
+    clone?: boolean;
+    cleaner(value: any): boolean;
+};
+export default function deepClean(objectOrArray: any, settings?: TDeepCleanSettings): any;

package/dist/shared/object/deepClean.js

@@ -0,0 +1,43 @@
+import isPlainObject from '../is/isPlainObject.js';
+export default function deepClean(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] = deepClean(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] = deepClean(v, settings);
+            }
+            if (!settings.cleaner(workingObj[k])) {
+                delete workingObj[k];
+            }
+        }
+    }
+    return workingObj;
+}
+//# sourceMappingURL=deepClean.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepClean.js","sourceRoot":"","sources":["../../../src/shared/object/deepClean.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AA4CnD,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,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrC,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,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

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

@@ -0,0 +1,51 @@
+/**
+ * @name                        deepFilter
+ * @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 { deepFilter } from '@blackbyte/sugar/object';
+ * deepFilter ({
+ *    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 TDeepFilterSettings = {
+    clone: boolean;
+};
+export type TDeepFilterFilter = {
+    (item: TDeepFilterItem): undefined | boolean;
+};
+export type TDeepFilterItem = {
+    key: string;
+    value: any;
+    isObject: boolean;
+};
+export default function deepFilter(object: any, filter: TDeepFilterFilter, settings?: Partial<TDeepFilterSettings>): any;

package/dist/shared/object/deepFilter.js

@@ -0,0 +1,46 @@
+import isPlainObject from '../is/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 deepFilter(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=deepFilter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepFilter.js","sourceRoot":"","sources":["../../../src/shared/object/deepFilter.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AAwDnD,SAAS,UAAU,CAAC,MAAW,EAAE,MAAyB,EAAE,QAAQ;IAClE,MAAM,MAAM,GAAG,EAAE,EACf,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAE7B,0BAA0B;IAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAE1B,2CAA2C;QAC3C,MAAM,GAAG,GAAG,MAAM,CAAC;YACjB,GAAG;YACH,KAAK;YACL,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC;SAC/B,CAAC,CAAC;QAEH,kCAAkC;QAClC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK;oBAC1B,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC;oBACxD,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACtB,CAAC;QACH,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK;oBAC1B,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC;oBACxD,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACtB,CAAC;QACH,CAAC;QACD,kCAAkC;aAC7B,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YACvB,SAAS;QACX,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,MAAW,EACX,MAAyB,EACzB,QAAuC;IAEvC,QAAQ,mBACN,KAAK,EAAE,IAAI,IACR,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,OAAO,UAAU,CACf,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EACnD,MAAM,EACN,QAAQ,CACT,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,44 @@
+/**
+ * @name                deepMap
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function is the same as the "map" one. The only difference is that this one goes deep into the object
+ *
+ * @param         {Object}        object          The object you want to map through
+ * @param         {Function}      processor       The processor function that take as parameter the actual property value, the current property name and the full dotted path to the current property
+ * @param         {Object}        [settings={}]     An object of settings to configure your deepMap process:
+ *
+ * @setting    {Boolean}              [classInstances=false]            Specify if you want the objects to be processed the same as other values
+ * @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
+ * @setting         {Boolean}      [privateProps=true]     Specify if you want to clean also the private properties that starts with "_"
+ *
+ * @todo      tests
+ *
+ * @snippet         deepMap($1, $2)
+ * deepMap($1, ({object, prop, value, path}) => {
+ *      $2
+ * })
+ *
+ * @example       js
+ * import { deepMap } from '@blackbyte/sugar/object';
+ * deepMap({
+ *    hello: 'world'
+ * }, ({object, prop, value, path}) => {
+ *    return '~ ' + value;
+ * });
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TDeepMapSettings = {
+    classInstances?: boolean;
+    array?: boolean;
+    clone?: boolean;
+    privateProps?: boolean;
+};
+export default function deepMap(objectOrArray: any, processor?: Function, settings?: TDeepMapSettings, _path?: never[]): any;

package/dist/shared/object/deepMap.js

@@ -0,0 +1,59 @@
+import isClassInstance from '../is/isClassInstance.js';
+import isPlainObject from '../is/isPlainObject.js';
+import clone from './clone.js';
+export default function deepMap(objectOrArray, processor, settings, _path = []) {
+    settings = Object.assign({ classInstances: false, array: true, clone: false, privateProps: true }, settings);
+    const isArray = Array.isArray(objectOrArray);
+    let newObject = isArray
+        ? []
+        : (settings === null || settings === void 0 ? void 0 : settings.clone)
+            ? clone(objectOrArray, { deep: true })
+            : objectOrArray;
+    Object.keys(objectOrArray).forEach((prop) => {
+        if (!(settings === null || settings === void 0 ? void 0 : settings.privateProps) && prop.match(/^_/))
+            return;
+        if (isPlainObject(objectOrArray[prop]) ||
+            (isClassInstance(objectOrArray[prop]) && (settings === null || settings === void 0 ? void 0 : settings.classInstances)) ||
+            (Array.isArray(objectOrArray[prop]) && (settings === null || settings === void 0 ? void 0 : settings.array))) {
+            const res = deepMap(objectOrArray[prop], processor, Object.assign(Object.assign({}, settings), { clone: false }), 
+            // @ts-ignore
+            [..._path, prop]);
+            if (isArray) {
+                newObject.push(res);
+            }
+            else {
+                if (prop === '...' && isPlainObject(res)) {
+                    newObject = Object.assign(Object.assign({}, newObject), res);
+                }
+                else {
+                    newObject[prop] = res;
+                }
+            }
+            return;
+        }
+        const res = processor === null || processor === void 0 ? void 0 : processor({
+            object: objectOrArray,
+            prop,
+            value: objectOrArray[prop],
+            path: [..._path, prop].join('.'),
+        });
+        if (res === -1) {
+            delete newObject[prop];
+            return;
+        }
+        if (isArray) {
+            newObject.push(res);
+        }
+        else {
+            if (prop === '...' && isPlainObject(res)) {
+                // console.log('DEFEF', res);
+                newObject = Object.assign(Object.assign({}, newObject), res);
+            }
+            else {
+                newObject[prop] = res;
+            }
+        }
+    });
+    return newObject;
+}
+//# sourceMappingURL=deepMap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepMap.js","sourceRoot":"","sources":["../../../src/shared/object/deepMap.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,0BAA0B,CAAC;AACvD,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,MAAM,YAAY,CAAC;AA+C/B,MAAM,CAAC,OAAO,UAAU,OAAO,CAC7B,aAAkB,EAClB,SAAoB,EACpB,QAA2B,EAC3B,KAAK,GAAG,EAAE;IAEV,QAAQ,mBACN,cAAc,EAAE,KAAK,EACrB,KAAK,EAAE,IAAI,EACX,KAAK,EAAE,KAAK,EACZ,YAAY,EAAE,IAAI,IACf,QAAQ,CACZ,CAAC;IAEF,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAE7C,IAAI,SAAS,GAAG,OAAO;QACrB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK;YACjB,CAAC,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACtC,CAAC,CAAC,aAAa,CAAC;IAElB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1C,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,CAAA,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,OAAO;QAExD,IACE,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc,CAAA,CAAC;YAClE,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAA,CAAC,EACvD,CAAC;YACD,MAAM,GAAG,GAAG,OAAO,CACjB,aAAa,CAAC,IAAI,CAAC,EACnB,SAAS,kCAEJ,QAAQ,KACX,KAAK,EAAE,KAAK;YAEd,aAAa;YACb,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,CACjB,CAAC;YAEF,IAAI,OAAO,EAAE,CAAC;gBACZ,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,IAAI,IAAI,KAAK,KAAK,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzC,SAAS,mCACJ,SAAS,GACT,GAAG,CACP,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;gBACxB,CAAC;YACH,CAAC;YACD,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG;YACtB,MAAM,EAAE,aAAa;YACrB,IAAI;YACJ,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC;YAC1B,IAAI,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;SACjC,CAAC,CAAC;QACH,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;YACvB,OAAO;QACT,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,KAAK,KAAK,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzC,6BAA6B;gBAC7B,SAAS,mCACJ,SAAS,GACT,GAAG,CACP,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC"}