@blackbyte/sugar 1.0.0-beta.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteProperty.js","sourceRoot":"","sources":["../../../src/shared/object/deleteProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,UAAU,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;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.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.js

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

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../src/shared/object/diff.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AA2DnD,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.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.js

@@ -0,0 +1,38 @@
+import __get from './get.js';
+import __set from './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.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensurePropertyExists.js","sourceRoot":"","sources":["../../../src/shared/object/ensurePropertyExists.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,KAAK,MAAM,UAAU,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;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.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.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 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

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

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

@@ -0,0 +1,33 @@
+/**
+ * @name                        filterObject
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Allow to filter an object using a function. 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
+ *
+ * @todo      tests
+ *
+ * @snippet         filterObject($1, $2)
+ * filterObject
+ *
+ * @example           js
+ * import { filterObject } from '@blackbyte/sugar/object';
+ * filterObject({
+ *    coco: 'hello',
+ *    plop: true
+ * }, (key, item) => typeof item === 'string');
+ * // { coco: 'hello' }
+ *
+ * @since         1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function filterObject(object: any, filter: (key: string, value: any) => boolean): any;

package/dist/shared/object/filterObject.js

@@ -0,0 +1,47 @@
+/**
+ * @name                        filterObject
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Allow to filter an object using a function. 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
+ *
+ * @todo      tests
+ *
+ * @snippet         filterObject($1, $2)
+ * filterObject
+ *
+ * @example           js
+ * import { filterObject } from '@blackbyte/sugar/object';
+ * filterObject({
+ *    coco: 'hello',
+ *    plop: true
+ * }, (key, item) => typeof item === 'string');
+ * // { coco: 'hello' }
+ *
+ * @since         1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function filterObject(object, filter) {
+    // init the new object to return
+    const result = {};
+    // loop on the object keys
+    Object.keys(object).forEach((propertyName) => {
+        // pass the property in the filter function
+        if (filter(propertyName, object[propertyName])) {
+            // add the property in the new object
+            result[propertyName] = object[propertyName];
+        }
+    });
+    // return the filtered object
+    return result;
+}
+//# sourceMappingURL=filterObject.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filterObject.js","sourceRoot":"","sources":["../../../src/shared/object/filterObject.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,MAAW,EACX,MAA4C;IAE5C,gCAAgC;IAChC,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,0BAA0B;IAC1B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;QAC3C,2CAA2C;QAC3C,IAAI,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YAC/C,qCAAqC;YACrC,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,6BAA6B;IAC7B,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,44 @@
+/**
+ * @name                        findDeep
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * This function take an object and a filter function that will be called for each properties of the object
+ * and that will return true or false depending on the property you want to keep or not.
+ *
+ * @param               {Object}                object                The object to search in
+ * @param               {Function}              filter                The filter function that take as parameter the property itself, and the property name
+ * @return              {Object}                                      The searched object
+ *
+ * @todo      tests
+ *
+ * @example           js
+ * import { findDeep } from '@blackbyte/sugar/object';
+ * findDeep ({
+ *    coco: 'hello',
+ *    plop: true,
+ *    sub: {
+ *      property: 'world'
+ *    }
+ * }, ({key, item}) => typeof item === 'string');
+ * // {
+ * //   coco: 'hello',
+ * //   sub: {
+ * //     property: 'world'
+ * //   }
+ * // }
+ *
+ * @since         1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFindDeepFilter = {
+    (item: TFindDeepItem): undefined | boolean;
+};
+export type TFindDeepItem = {
+    key: string;
+    value: any;
+};
+export default function findDeep(object: any, filter: TFindDeepFilter): any;

package/dist/shared/object/findDeep.js

@@ -0,0 +1,17 @@
+import flatten from './flatten.js';
+import __set from './set.js';
+export default function findDeep(object, filter) {
+    // make sure the object is a copy
+    object = JSON.parse(JSON.stringify(object));
+    // flatten the object
+    const flatObj = flatten(object);
+    const res = {};
+    // iterate over the flattened object
+    for (let [key, value] of Object.entries(flatObj)) {
+        if (filter({ key, value })) {
+            __set(res, key, value);
+        }
+    }
+    return res;
+}
+//# sourceMappingURL=findDeep.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"findDeep.js","sourceRoot":"","sources":["../../../src/shared/object/findDeep.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,KAAK,MAAM,UAAU,CAAC;AA+C7B,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,MAAW,EAAE,MAAuB;IACnE,iCAAiC;IACjC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5C,qBAAqB;IACrB,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,MAAM,GAAG,GAAQ,EAAE,CAAC;IAEpB,oCAAoC;IACpC,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,IAAI,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}

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

@@ -0,0 +1,31 @@
+/**
+ * @name                        flatten
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Transform the passed multiple level object into a single level one
+ *
+ * @param               {Object}                          object                    The object to flatten
+ * @param               {Object}                          [settings={}]             An object of settings to configure your flatten process
+ * @return              {Object}                                                    The flatten object
+ *
+ * @todo      tests
+ *
+ * @snippet         flatten($1)
+ *
+ * @example             js
+ * import { flatten } from '@blackbyte/sugar/object';
+ * flatten({
+ *    hello: {
+ *      world: 'Coco'
+ *    }
+ * });
+ *
+ * @see.     https://www.npmjs.com/package/flat
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function _flatten(obj: any): Record<string, any>;

package/dist/shared/object/flatten.js

@@ -0,0 +1,35 @@
+import { flatten } from 'flattenjs';
+/**
+ * @name                        flatten
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Transform the passed multiple level object into a single level one
+ *
+ * @param               {Object}                          object                    The object to flatten
+ * @param               {Object}                          [settings={}]             An object of settings to configure your flatten process
+ * @return              {Object}                                                    The flatten object
+ *
+ * @todo      tests
+ *
+ * @snippet         flatten($1)
+ *
+ * @example             js
+ * import { flatten } from '@blackbyte/sugar/object';
+ * flatten({
+ *    hello: {
+ *      world: 'Coco'
+ *    }
+ * });
+ *
+ * @see.     https://www.npmjs.com/package/flat
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function _flatten(obj) {
+    return flatten(obj);
+}
+//# sourceMappingURL=flatten.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"flatten.js","sourceRoot":"","sources":["../../../src/shared/object/flatten.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,GAAG;IAClC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC"}

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

@@ -0,0 +1,29 @@
+/**
+ * @name                get
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Retreive an object value using a dotted path like "myObject.myProperty.myValue"
+ *
+ * @feature       Support optional property in the doted path like "something.cool?.hello.world"
+ *
+ * @param               {Object}                 obj                The object in which to set the value
+ * @param               {String}                path                The dotted object path to get
+ * @return              {Mixed}                                     The getted value or "undefined" if nothing found...
+ *
+ * @todo      tests
+ *
+ * @snippet         get($1, $2)
+ *
+ * @example             js
+ * import { get } from '@blackbyte/sugar/object';
+ * get(myObject, 'my.cool.value'); // => 'Hello world'
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+declare function get(obj: any, path: string | string[]): any;
+export default get;

package/dist/shared/object/get.js

@@ -0,0 +1,87 @@
+import __unique from '../array/unique.js';
+import __unquote from '../string/unquote.js';
+/**
+ * @name                get
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Retreive an object value using a dotted path like "myObject.myProperty.myValue"
+ *
+ * @feature       Support optional property in the doted path like "something.cool?.hello.world"
+ *
+ * @param               {Object}                 obj                The object in which to set the value
+ * @param               {String}                path                The dotted object path to get
+ * @return              {Mixed}                                     The getted value or "undefined" if nothing found...
+ *
+ * @todo      tests
+ *
+ * @snippet         get($1, $2)
+ *
+ * @example             js
+ * import { get } from '@blackbyte/sugar/object';
+ * get(myObject, 'my.cool.value'); // => 'Hello world'
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+function get(obj, path) {
+    if (Array.isArray(path)) {
+        return __get(obj, path);
+    }
+    if (obj[path] !== undefined)
+        return obj[path];
+    if (!path || path === '' || path === '.')
+        return obj;
+    path = path.replace(/\[(\w+)\]/g, '.$1');
+    path = path.replace(/\\\./g, '_dot_');
+    path = path.replace(/^\./, '');
+    let potentialPaths = [path.replace(/\?/gm, '')];
+    const parts = path.split('.');
+    for (let i = parts.length - 1; i >= 0; i--) {
+        const part = parts[i];
+        if (part.match(/\?$/)) {
+            const before = parts.slice(0, i);
+            const after = parts.slice(i + 1);
+            potentialPaths.push([...before, ...after].join('.'));
+            potentialPaths.push([...before, ...after.filter((a) => !a.match(/\?$/))].join('.'));
+        }
+    }
+    potentialPaths = __unique(potentialPaths.map((s) => s.replace(/\?/gm, '')));
+    for (let i = 0; i < potentialPaths.length; i++) {
+        const path = potentialPaths[i];
+        const result = __get(obj, path);
+        if (result !== undefined)
+            return result;
+    }
+}
+function __get(obj, path) {
+    let o = obj, a;
+    if (typeof path === 'string') {
+        if (obj[path] !== undefined)
+            return obj[path];
+        if (!path || path === '' || path === '.')
+            return obj;
+        path = path.split(/(?!\B"[^"]*)\.(?![^"]*"\B)/gm);
+    }
+    a = [...path].map((p) => {
+        if (typeof p === 'string')
+            return __unquote(p);
+        return p;
+    });
+    while (a.length) {
+        let n = a.shift();
+        if (typeof n === 'string') {
+            n = n.replace(/\?$/, '');
+        }
+        if (typeof o !== 'object' || !(o && n in o)) {
+            return;
+        }
+        o = o[n];
+    }
+    return o;
+}
+export default get;
+//# sourceMappingURL=get.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/shared/object/get.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,oBAAoB,CAAC;AAC1C,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAS,GAAG,CAAC,GAAQ,EAAE,IAAuB;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,GAAG,CAAC;IACrD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACzC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACtC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE/B,IAAI,cAAc,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;IAEhD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACjC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACjC,cAAc,CAAC,IAAI,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACrD,cAAc,CAAC,IAAI,CACjB,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAC/D,CAAC;QACJ,CAAC;IACH,CAAC;IAED,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAE5E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAS,KAAK,CAAC,GAAQ,EAAE,IAAuB;IAC9C,IAAI,CAAC,GAAG,GAAG,EACT,CAAC,CAAC;IAEJ,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC;QACrD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACpD,CAAC;IAED,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACtB,IAAI,OAAO,CAAC,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QAChB,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC1B,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;QACD,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,eAAe,GAAG,CAAC"}