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

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

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

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

@@ -0,0 +1,17 @@
+import flatten from '../flatten/flatten.js';
+import __set from '../set/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/findDeep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findDeep.js","sourceRoot":"","sources":["../../../../src/shared/object/findDeep/findDeep.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAC5C,OAAO,KAAK,MAAM,eAAe,CAAC;AA+ClC,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/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/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/flatten.js.map

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

@@ -0,0 +1,87 @@
+import __unique from '../../array/unique/unique.js';
+import __unquote from '../../string/unquote/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/get.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../../src/shared/object/get/get.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,8BAA8B,CAAC;AACpD,OAAO,SAAS,MAAM,iCAAiC,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;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"}

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

@@ -0,0 +1,38 @@
+/**
+ * @name                        getGlob
+ * @namespace                   shared.object
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Retreive an object value using a dotted path like "myObject.myProperty.myValue".
+ * It support glob patterns like "something.*.id" and returns you a new object containing
+ * all values with the path that matches the passed glob pattern.
+ *
+ * @param               {Object}                 obj                The object in which to set the value
+ * @param               {String}                glob                A glob to describe what you want into the object
+ * @param               {Object}            [settings={}]           A settings object to configure your glob get process
+ * @return              {Mixed}                                     The getted value or "undefined" if nothing found...
+ *
+ * @setting         {Boolean}               [unflatten=true]          Specify if you want the result object to be unflattend using the ```unflatten``` sugar function
+ *
+ * @todo      tests
+ *
+ * @snippet         getGlob($1, $2)
+ *
+ * @example             js
+ * import { getGlob } from '@blackbyte/sugar/object';
+ * getGlob({
+ *  hello: {
+ *     world: true,
+ *     plop: false
+ * }, 'hello.*');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TGetGlobSettings = {
+    unflatten?: boolean;
+};
+export default function getGlob(obj: any, glob: string, settings?: TGetGlobSettings): any;

package/dist/shared/object/getGlob/getGlob.js

@@ -0,0 +1,17 @@
+import { minimatch as __minimatch } from 'minimatch';
+import unflatten from '../unflatten/unflatten.js';
+import flatten from '../flatten/flatten.js';
+export default function getGlob(obj, glob, settings = {}) {
+    settings = Object.assign({ unflatten: true }, settings);
+    const flat = flatten(obj);
+    const resultObj = {};
+    Object.keys(flat).forEach((path) => {
+        if (__minimatch(path, glob)) {
+            resultObj[path] = flat[path];
+        }
+    });
+    if (settings.unflatten === true)
+        return unflatten(resultObj);
+    return resultObj;
+}
+//# sourceMappingURL=getGlob.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getGlob.js","sourceRoot":"","sources":["../../../../src/shared/object/getGlob/getGlob.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAClD,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAwC5C,MAAM,CAAC,OAAO,UAAU,OAAO,CAC7B,GAAQ,EACR,IAAY,EACZ,WAA6B,EAAE;IAE/B,QAAQ,mBACN,SAAS,EAAE,IAAI,IACZ,QAAQ,CACZ,CAAC;IAEF,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAE1B,MAAM,SAAS,GAAG,EAAE,CAAC;IAErB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAC5B,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,SAAS,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC;IAC7D,OAAO,SAAS,CAAC;AACnB,CAAC"}

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

@@ -0,0 +1,26 @@
+/**
+ * @name                getKeyByValue
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Return the key that correspond to the passed value in the passed object
+ *
+ * @param         {Object}        object        The object in which to search for the value
+ * @param         {Mixed}         value         The value to find in the object
+ * @return        {String}                      The key of the wanted value or false if not found
+ *
+ * @todo      tests
+ *
+ * @snippet         getKeyByValue($1, $2)
+ *
+ * @example       js
+ * import { getKeyByValue } from '@blackbyte/sugar/object';
+ * getKeyByValue({ hello: 'world' }, 'world'); // => hello
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function getKeyByValue(object: any, value: any): any;

package/dist/shared/object/getKeyByValue/getKeyByValue.js

@@ -0,0 +1,29 @@
+/**
+ * @name                getKeyByValue
+ * @namespace           shared.object
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Return the key that correspond to the passed value in the passed object
+ *
+ * @param         {Object}        object        The object in which to search for the value
+ * @param         {Mixed}         value         The value to find in the object
+ * @return        {String}                      The key of the wanted value or false if not found
+ *
+ * @todo      tests
+ *
+ * @snippet         getKeyByValue($1, $2)
+ *
+ * @example       js
+ * import { getKeyByValue } from '@blackbyte/sugar/object';
+ * getKeyByValue({ hello: 'world' }, 'world'); // => hello
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function getKeyByValue(object, value) {
+    return Object.keys(object).find((key) => object[key] === value);
+}
+//# sourceMappingURL=getKeyByValue.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getKeyByValue.js","sourceRoot":"","sources":["../../../../src/shared/object/getKeyByValue/getKeyByValue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,MAAW,EAAE,KAAU;IAC3D,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC;AAClE,CAAC"}

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

@@ -0,0 +1,48 @@
+/**
+ * @name                    map
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * This is the same function as the "Array.map" but for objects. It will iterate over all the properties
+ * of the passed object and pass the value to your process function. It will then save the property
+ * with your processed value
+ *
+ * @param           {Object}            object          The object to process
+ * @param           {Function}          processor       The processor function that will take as parameters the current property value and the property name
+ * @return          {Object}                            The processed object
+ *
+ * @todo      tests
+ *
+ * @snippet         map($1, $2)
+ * map($1, ({value, prop}) => {
+ *      $2
+ * })
+ *
+ * @example         js
+ * import { map } from '@blackbyte/sugar/object';
+ * const myObject = {
+ *    hello: 'world',
+ *    cat: 'Nelson'
+ * };
+ * map(myObject, ({value, prop}) => {
+ *    return prop === 'hello' ? 'universe' : value;
+ * });
+ * {
+ *    hello: 'universe',
+ *    cat: 'Nelson'
+ * }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TMapObjProcessorArg = {
+    value: any;
+    key: string;
+    prop: string;
+    i: number;
+    idx: number;
+};
+export default function map(object: any, processor: (item: TMapObjProcessorArg) => any): any;

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

@@ -0,0 +1,58 @@
+/**
+ * @name                    map
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * This is the same function as the "Array.map" but for objects. It will iterate over all the properties
+ * of the passed object and pass the value to your process function. It will then save the property
+ * with your processed value
+ *
+ * @param           {Object}            object          The object to process
+ * @param           {Function}          processor       The processor function that will take as parameters the current property value and the property name
+ * @return          {Object}                            The processed object
+ *
+ * @todo      tests
+ *
+ * @snippet         map($1, $2)
+ * map($1, ({value, prop}) => {
+ *      $2
+ * })
+ *
+ * @example         js
+ * import { map } from '@blackbyte/sugar/object';
+ * const myObject = {
+ *    hello: 'world',
+ *    cat: 'Nelson'
+ * };
+ * map(myObject, ({value, prop}) => {
+ *    return prop === 'hello' ? 'universe' : value;
+ * });
+ * {
+ *    hello: 'universe',
+ *    cat: 'Nelson'
+ * }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function map(object, processor) {
+    for (let i = 0; i < Object.keys(object).length; i++) {
+        const prop = Object.keys(object)[i];
+        const res = processor({
+            value: object[prop],
+            key: prop,
+            prop,
+            i,
+            idx: i,
+        });
+        if (res === -1)
+            delete object[prop];
+        else
+            object[prop] = res;
+    }
+    return object;
+}
+//# sourceMappingURL=map.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"map.js","sourceRoot":"","sources":["../../../../src/shared/object/map/map.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAUH,MAAM,CAAC,OAAO,UAAU,GAAG,CACzB,MAAW,EACX,SAA6C;IAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,GAAG,GAAG,SAAS,CAAC;YACpB,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC;YACnB,GAAG,EAAE,IAAI;YACT,IAAI;YACJ,CAAC;YACD,GAAG,EAAE,CAAC;SACP,CAAC,CAAC;QACH,IAAI,GAAG,KAAK,CAAC,CAAC;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;;YAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;IAC1B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,44 @@
+/**
+ * @name                mapDeep
+ * @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 mapDeep 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         mapDeep($1, $2)
+ * mapDeep($1, ({object, prop, value, path}) => {
+ *      $2
+ * })
+ *
+ * @example       js
+ * import { mapDeep } from '@blackbyte/sugar/object';
+ * mapDeep({
+ *    hello: 'world'
+ * }, ({object, prop, value, path}) => {
+ *    return '~ ' + value;
+ * });
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TMapDeepSettings = {
+    classInstances?: boolean;
+    array?: boolean;
+    clone?: boolean;
+    privateProps?: boolean;
+};
+export default function mapDeep(objectOrArray: any, processor?: Function, settings?: TMapDeepSettings, _path?: never[]): any;