@blackbyte/sugar 1.0.0-beta.1

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

@@ -0,0 +1,41 @@
+/**
+ * @name                    deepMerge
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Deep merge one object with another and return the merged object result. This merging implementation support:
+ * - Merging object with getters/setters
+ * - n numbers of objects as arguments
+ * - Choose beetween cloning first (default) the object or keeping the first passed object as result
+ * Note that by default the resulting object is a clone and do not have the same reference that the first passed object.
+ *
+ * @param           {any[]}                             objects             Pass all the objects you want to merge
+ * @param           {TDeepMergeSettings}                [settings={}]       Some settings to configure your merging process
+ * @return          {Object}                                                The merged object result
+ *
+ * @setting         {Boolean}           [array=false]           Merge or not arrays
+ * @setting         {Boolean}           [clone=true]            Specify if you want the result object to be a clone or the same first passed object
+ *
+ * @feature         Support array merging by passing the last parameter as the { array: true } object
+ * @feature         Support merging object with getters. Can access the source object from the second object property getter using the `this.$source` property
+ *
+ * @todo      tests
+ *
+ * @snippet         deepMerge($1, $2)
+ *
+ * @example           js
+ * import { deepMerge } from '@blackbyte/sugar/object';
+ * deepMerge([{a: {b: {c: 'c', d: 'd'}}}, {a: {b: {e: 'e', f: 'f'}}}]);
+ * // => { a: { b: { c: 'c', d: 'd', e: 'e', f: 'f' } } }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TDeepMergeSettings = {
+    array?: boolean;
+    clone?: boolean;
+};
+export default function deepMerge(objects: any[], settings?: TDeepMergeSettings): any;

package/dist/shared/object/deepMerge.js

@@ -0,0 +1,45 @@
+import isPlainObject from '../is/isPlainObject.js';
+export default function deepMerge(objects, settings) {
+    const finalSettings = Object.assign({ array: false, clone: true }, (settings !== null && settings !== void 0 ? settings : {}));
+    function merge(firstObj, secondObj) {
+        const newObj = finalSettings.clone ? {} : firstObj;
+        if (!secondObj)
+            return firstObj;
+        const firstProps = Object.getOwnPropertyNames(firstObj);
+        firstProps.forEach((key) => {
+            const desc = Object.getOwnPropertyDescriptor(firstObj, key);
+            if ((desc === null || desc === void 0 ? void 0 : desc.set) || (desc === null || desc === void 0 ? void 0 : desc.get)) {
+                Object.defineProperty(newObj, key, desc);
+            }
+            else {
+                newObj[key] = firstObj[key];
+            }
+        });
+        const secondProps = Object.getOwnPropertyNames(secondObj);
+        secondProps.forEach((key) => {
+            const secondObjDesc = Object.getOwnPropertyDescriptor(secondObj, key);
+            if ((secondObjDesc === null || secondObjDesc === void 0 ? void 0 : secondObjDesc.set) || (secondObjDesc === null || secondObjDesc === void 0 ? void 0 : secondObjDesc.get)) {
+                Object.defineProperty(newObj, key, secondObjDesc);
+            }
+            else if (finalSettings.array &&
+                Array.isArray(firstObj[key]) &&
+                Array.isArray(secondObj[key])) {
+                newObj[key] = [...firstObj[key], ...secondObj[key]];
+            }
+            else if (isPlainObject(newObj[key]) && isPlainObject(secondObj[key])) {
+                newObj[key] = merge(newObj[key], secondObj[key]);
+            }
+            else {
+                newObj[key] = secondObj[key];
+            }
+        });
+        return newObj;
+    }
+    let currentObj = finalSettings.clone ? {} : objects[0];
+    for (let i = 0; i < objects.length; i++) {
+        const toMergeObj = objects[i];
+        currentObj = merge(currentObj, toMergeObj);
+    }
+    return currentObj;
+}
+//# sourceMappingURL=deepMerge.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepMerge.js","sourceRoot":"","sources":["../../../src/shared/object/deepMerge.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AA2CnD,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,OAAc,EACd,QAA6B;IAE7B,MAAM,aAAa,mBACjB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,IAAI,IACR,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,SAAS,KAAK,CAAC,QAAQ,EAAE,SAAS;QAChC,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QACnD,IAAI,CAAC,SAAS;YAAE,OAAO,QAAQ,CAAC;QAEhC,MAAM,UAAU,GAAG,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACxD,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC5D,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,MAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAA,EAAE,CAAC;gBAC3B,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAC1D,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC1B,MAAM,aAAa,GAAG,MAAM,CAAC,wBAAwB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAEtE,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,GAAG,MAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,GAAG,CAAA,EAAE,CAAC;gBAC7C,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;YACpD,CAAC;iBAAM,IACL,aAAa,CAAC,KAAK;gBACnB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC5B,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAC7B,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YACtD,CAAC;iBAAM,IAAI,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACvE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9B,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

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

@@ -0,0 +1,18 @@
+export type TDeepProxyActionObj = {
+    object: any;
+    target: string;
+    key: string;
+    path: string;
+    action: 'set' | 'get' | 'delete';
+    fullAction: string;
+    oldValue: any;
+    value: any;
+};
+export type TDeepProxySettings = {
+    deep: boolean;
+    handleSet: boolean;
+    handleGet: boolean;
+    handleDelete: boolean;
+    domElements: boolean;
+};
+export default function deepProxy(object: any, handlerFn: any, settings?: Partial<TDeepProxySettings>): any;

package/dist/shared/object/deepProxy.js

@@ -0,0 +1,201 @@
+import proxyArray from '../array/proxyArray.js';
+import isDomElement from '../is/isDomElement.js';
+import isPlainObject from '../is/isPlainObject.js';
+import clone from '../object/clone.js';
+import deepMap from '../object/deepMap.js';
+/**
+ * @name                            deepProxy
+ * @namespace                       shared.object
+ * @type                            Function
+ * @platform                        js
+ * @platform                        node
+ * @status                          alpha
+ * @private
+ *
+ * This function allows you to add Proxy to an object in deep fashion.
+ * Normally the Proxy process only the level on which it has been added. Here we add Proxy to all the
+ * object levels and to new properties as well.
+ *
+ * On the returned proxied object, you will have access to the ```revoke``` method that you can call to revoke the proxy applied.
+ * This method will return you a shallow version of the proxied object that you can use as you want
+ *
+ * @param          {Object}                 object            The object on which to add the proxy
+ * @param           {Function}                handlerFn       The handler function that will be called with the update object. It can be a property deleted, an array item added, a property updated, etc...:
+ * - set: An object property added or updated
+ * - delete: An object property deleted
+ * - push: An item has been added inside an array
+ * - {methodName}: Every array actions
+ * @param         {Object}                [settings={}]         An object of settings to configure your proxy:
+ * @return          {Object}                                  The proxied object
+ *
+ * @setting         {Boolean}         [deep=true]           Specify if you want to watch the passed object deeply or juste the first level
+ * @setting        {Boolean}           [handleSet=true]        Specify if you want to handle the "set" action
+ * @setting         {Boolean}           [handleGet=false]           Specify if you want to handle the "get" action
+ * @setting         {Boolean}           [handleDelete=true]         Specify if you want to handle the "delete" action
+ * @setting         {Boolean}            [domElements=false]        Specify if you want to proxy dom elements
+ *
+ * @todo      tests
+ *
+ * @example           js
+ * import { deepProxy } from '@blackbyte/sugar/object';
+ * const a = deepProxy({
+ *    hello: 'world'
+ * }, (actionObj) => {
+ *    // do something with the actionObj...
+ * });
+ * a.hello = 'coco';
+ * // stop proxying
+ * a.cancel();
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+const _loopTimeout = new WeakMap();
+export default function deepProxy(object, handlerFn, settings = {}) {
+    let isRevoked = false;
+    settings = Object.assign({ deep: true, handleSet: true, handleGet: false, handleDelete: true, domElements: false }, settings);
+    function makeHandler(path) {
+        return {
+            set(target, key, value) {
+                // stop here if revoked of does not handle set
+                if (isRevoked || !settings.handleSet)
+                    return true;
+                // stop here if the value are the same already
+                if (value === target[key])
+                    return true;
+                // handle deep proxy
+                if (settings.deep &&
+                    typeof value === 'object' &&
+                    isPlainObject(value)) {
+                    value = proxify(value, [...path, key]);
+                }
+                // keep track of the old value
+                const oldValue = target[key];
+                // set the new value
+                target[key] = value;
+                // call the handler function with all the
+                // usefull parameters
+                handlerFn({
+                    object,
+                    target,
+                    key,
+                    path: [...path, key].join('.'),
+                    action: 'set',
+                    fullAction: `Object.set`,
+                    oldValue,
+                    value,
+                });
+                // write update
+                return true;
+            },
+            get(target, key, receiver) {
+                if (Reflect.has(target, key)) {
+                    if (!settings.handleGet)
+                        return target[key];
+                    const value = handlerFn({
+                        object,
+                        target,
+                        key,
+                        path: [...path, key].join('.'),
+                        action: 'get',
+                        fullAction: 'Object.get',
+                    });
+                    if (key === 'revoke')
+                        return receiver.revoke;
+                    if (value === undefined)
+                        return target[key];
+                    return value;
+                }
+                return undefined;
+            },
+            deleteProperty(target, key) {
+                if (isRevoked || !settings.handleDelete)
+                    return true;
+                if (Reflect.has(target, key)) {
+                    // unproxy(target, key);
+                    const oldValue = target[key];
+                    const deleted = Reflect.deleteProperty(target, key);
+                    if (deleted) {
+                        handlerFn({
+                            object,
+                            target,
+                            key,
+                            path: [...path, key].join('.'),
+                            action: 'delete',
+                            fullAction: 'Object.delete',
+                            oldValue,
+                        });
+                    }
+                    return deleted;
+                }
+                return false;
+            },
+        };
+    }
+    function proxify(obj, path) {
+        if (obj === null)
+            return obj;
+        if (!settings.domElements && isDomElement(obj)) {
+            return obj;
+        }
+        if (settings.deep) {
+            for (const key of Object.keys(obj)) {
+                if (Array.isArray(obj[key])) {
+                    obj[key] = proxyArray(obj[key]);
+                    obj[key].watch(Object.getOwnPropertyNames(Array.prototype), (watchObj) => {
+                        handlerFn(Object.assign({ path: [...path, key].join('.') }, watchObj));
+                    });
+                }
+                else if (typeof obj[key] === 'object' && isPlainObject(obj[key])) {
+                    obj[key] = proxify(obj[key], [...path, key]);
+                }
+            }
+        }
+        const p = Proxy.revocable(obj, makeHandler(path));
+        // preproxy.set(p, obj);
+        const revokePropertyObj = {
+            writable: true,
+            configurable: false,
+            enumerable: false,
+            value: () => {
+                // make a shallow copy of the proxy object
+                let __copy = clone(p.proxy, { deep: true });
+                // mark the proxy as revoked
+                isRevoked = true;
+                // sanitize the copy
+                __copy = deepMap(__copy, ({ value, prop }) => {
+                    if (prop === 'revoke' && typeof value === 'function') {
+                        return -1;
+                    }
+                    return value;
+                });
+                // deep revoke the proxies
+                setTimeout(() => {
+                    deepMap(p.proxy, ({ value, prop }) => {
+                        if (prop === 'revoke' && typeof value === 'function') {
+                            value();
+                        }
+                    }, {});
+                    // revoke the proxy at first level
+                    p.revoke();
+                });
+                // return the shallow copy
+                return __copy;
+            },
+        };
+        if (Array.isArray(p.proxy)) {
+            // @ts-ignore
+            p.proxy.revoke = revokePropertyObj.value;
+            // @ts-ignore
+            p.proxy.cancel = revokePropertyObj.value;
+        }
+        else {
+            Object.defineProperties(p.proxy, {
+                revoke: revokePropertyObj,
+            });
+        }
+        return p.proxy;
+    }
+    return proxify(object, []);
+}
+//# sourceMappingURL=deepProxy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepProxy.js","sourceRoot":"","sources":["../../../src/shared/object/deepProxy.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAChD,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,MAAM,oBAAoB,CAAC;AACvC,OAAO,OAAO,MAAM,sBAAsB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,MAAM,YAAY,GAAG,IAAI,OAAO,EAAE,CAAC;AAqBnC,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,MAAM,EACN,SAAS,EACT,WAAwC,EAAE;IAE1C,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,QAAQ,mBACN,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,IAAI,EACf,SAAS,EAAE,KAAK,EAChB,YAAY,EAAE,IAAI,EAClB,WAAW,EAAE,KAAK,IACf,QAAQ,CACZ,CAAC;IAEF,SAAS,WAAW,CAAC,IAAI;QACvB,OAAO;YACL,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK;gBACpB,8CAA8C;gBAC9C,IAAI,SAAS,IAAI,CAAC,QAAQ,CAAC,SAAS;oBAAE,OAAO,IAAI,CAAC;gBAElD,8CAA8C;gBAC9C,IAAI,KAAK,KAAK,MAAM,CAAC,GAAG,CAAC;oBAAE,OAAO,IAAI,CAAC;gBAEvC,oBAAoB;gBACpB,IACE,QAAQ,CAAC,IAAI;oBACb,OAAO,KAAK,KAAK,QAAQ;oBACzB,aAAa,CAAC,KAAK,CAAC,EACpB,CAAC;oBACD,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;gBACzC,CAAC;gBAED,8BAA8B;gBAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBAE7B,oBAAoB;gBACpB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBAEpB,yCAAyC;gBACzC,qBAAqB;gBACrB,SAAS,CAAsB;oBAC7B,MAAM;oBACN,MAAM;oBACN,GAAG;oBACH,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;oBAC9B,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,YAAY;oBACxB,QAAQ;oBACR,KAAK;iBACN,CAAC,CAAC;gBAEH,eAAe;gBACf,OAAO,IAAI,CAAC;YACd,CAAC;YAED,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ;gBACvB,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,SAAS;wBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;oBAE5C,MAAM,KAAK,GAAG,SAAS,CAAsB;wBAC3C,MAAM;wBACN,MAAM;wBACN,GAAG;wBACH,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;wBAC9B,MAAM,EAAE,KAAK;wBACb,UAAU,EAAE,YAAY;qBACzB,CAAC,CAAC;oBACH,IAAI,GAAG,KAAK,QAAQ;wBAAE,OAAO,QAAQ,CAAC,MAAM,CAAC;oBAC7C,IAAI,KAAK,KAAK,SAAS;wBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC5C,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,cAAc,CAAC,MAAM,EAAE,GAAG;gBACxB,IAAI,SAAS,IAAI,CAAC,QAAQ,CAAC,YAAY;oBAAE,OAAO,IAAI,CAAC;gBAErD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;oBAC7B,wBAAwB;oBACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC7B,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;oBACpD,IAAI,OAAO,EAAE,CAAC;wBACZ,SAAS,CAAsB;4BAC7B,MAAM;4BACN,MAAM;4BACN,GAAG;4BACH,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;4BAC9B,MAAM,EAAE,QAAQ;4BAChB,UAAU,EAAE,eAAe;4BAC3B,QAAQ;yBACT,CAAC,CAAC;oBACL,CAAC;oBACD,OAAO,OAAO,CAAC;gBACjB,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CAAC;IACJ,CAAC;IAED,SAAS,OAAO,CAAC,GAAG,EAAE,IAAI;QACxB,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,GAAG,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBAC5B,GAAG,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;oBAChC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CACZ,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,EAC3C,CAAC,QAAQ,EAAE,EAAE;wBACX,SAAS,iBACP,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAC3B,QAAQ,EACX,CAAC;oBACL,CAAC,CACF,CAAC;gBACJ,CAAC;qBAAM,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBACnE,GAAG,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAElD,wBAAwB;QACxB,MAAM,iBAAiB,GAAG;YACxB,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,GAAG,EAAE;gBACV,0CAA0C;gBAC1C,IAAI,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,4BAA4B;gBAC5B,SAAS,GAAG,IAAI,CAAC;gBACjB,oBAAoB;gBACpB,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;oBAC3C,IAAI,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;wBACrD,OAAO,CAAC,CAAC,CAAC;oBACZ,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,0BAA0B;gBAC1B,UAAU,CAAC,GAAG,EAAE;oBACd,OAAO,CACL,CAAC,CAAC,KAAK,EACP,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;wBAClB,IAAI,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;4BACrD,KAAK,EAAE,CAAC;wBACV,CAAC;oBACH,CAAC,EACD,EAAE,CACH,CAAC;oBACF,kCAAkC;oBAClC,CAAC,CAAC,MAAM,EAAE,CAAC;gBACb,CAAC,CAAC,CAAC;gBACH,0BAA0B;gBAC1B,OAAO,MAAM,CAAC;YAChB,CAAC;SACF,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,aAAa;YACb,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC;YACzC,aAAa;YACb,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,EAAE;gBAC/B,MAAM,EAAE,iBAAiB;aAC1B,CAAC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC"}

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

@@ -0,0 +1,44 @@
+/**
+ * @name                        deepSearch
+ * @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 { deepSearch } from '@blackbyte/sugar/object';
+ * deepSearch ({
+ *    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 TDeepSearchFilter = {
+    (item: TDeepSearchItem): undefined | boolean;
+};
+export type TDeepSearchItem = {
+    key: string;
+    value: any;
+};
+export default function deepSearch(object: any, filter: TDeepSearchFilter): any;

package/dist/shared/object/deepSearch.js

@@ -0,0 +1,17 @@
+import flatten from './flatten.js';
+import __set from './set.js';
+export default function deepSearch(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=deepSearch.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepSearch.js","sourceRoot":"","sources":["../../../src/shared/object/deepSearch.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,KAAK,MAAM,UAAU,CAAC;AA+C7B,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,MAAW,EAAE,MAAyB;IACvE,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/deepize.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @name            deepize
+ * @namespace       shared.object
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This function simply take an object like this one:
+ *
+ * ```js
+ * {
+ *    'something.cool': 'hello'
+ * }
+ * ```
+ *
+ * and convert it to something like this:
+ *
+ * ```js
+ * {
+ *    something: {
+ *      cool: 'hello'
+ *    }
+ * }
+ * ```
+ *
+ * @param       {Object}        object        The object to convert
+ * @return      {Object}                      The converted object
+ *
+ * @todo      tests
+ *
+ * @snippet         deepize($1)
+ *
+ * @example       js
+ * import { deepize } from '@blackbyte/sugar/object';
+ * deepize({ 'something.cool': 'hello' }); // => { something: { cool: 'hello' } }
+ *
+ * @see       https://www.npmjs.com/package/flat
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function deepize(object: any): any;

package/dist/shared/object/deepize.js

@@ -0,0 +1,46 @@
+import { inflate } from 'flattenjs';
+/**
+ * @name            deepize
+ * @namespace       shared.object
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This function simply take an object like this one:
+ *
+ * ```js
+ * {
+ *    'something.cool': 'hello'
+ * }
+ * ```
+ *
+ * and convert it to something like this:
+ *
+ * ```js
+ * {
+ *    something: {
+ *      cool: 'hello'
+ *    }
+ * }
+ * ```
+ *
+ * @param       {Object}        object        The object to convert
+ * @return      {Object}                      The converted object
+ *
+ * @todo      tests
+ *
+ * @snippet         deepize($1)
+ *
+ * @example       js
+ * import { deepize } from '@blackbyte/sugar/object';
+ * deepize({ 'something.cool': 'hello' }); // => { something: { cool: 'hello' } }
+ *
+ * @see       https://www.npmjs.com/package/flat
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function deepize(object) {
+    return inflate(object);
+}
+//# sourceMappingURL=deepize.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deepize.js","sourceRoot":"","sources":["../../../src/shared/object/deepize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,MAAW;IACzC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC"}

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

@@ -0,0 +1,26 @@
+/**
+ * @name                    delete
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Delete an object/array property by passing a dotpath to the element you want to remove.
+ *
+ * @param               {Object}                 obj                The object in which to set the value
+ * @param               {String|String[]}                dotpath                The dotted object/array path to delete
+ *
+ * @todo      tests
+ *
+ * @snippet         __delete($1, $2)
+ *
+ * @example             js
+ * import { __delete } from '@blackbyte/sugar/object';
+ * __delete(myObject, 'my.cool.value');
+ * __delete(myObject, 'my.cool.value.0');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __delete(object: any, dotpath: string | string[]): void;

package/dist/shared/object/delete.js

@@ -0,0 +1,57 @@
+/**
+ * @name                    delete
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Delete an object/array property by passing a dotpath to the element you want to remove.
+ *
+ * @param               {Object}                 obj                The object in which to set the value
+ * @param               {String|String[]}                dotpath                The dotted object/array path to delete
+ *
+ * @todo      tests
+ *
+ * @snippet         __delete($1, $2)
+ *
+ * @example             js
+ * import { __delete } from '@blackbyte/sugar/object';
+ * __delete(myObject, 'my.cool.value');
+ * __delete(myObject, 'my.cool.value.0');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __delete(object, dotpath) {
+    // const parentdotpath = dotpath.split('.').slice(0, -1).join('.');
+    if (Array.isArray(dotpath)) {
+        dotpath = dotpath.join('.');
+    }
+    if (!dotpath || dotpath === '' || dotpath === '.')
+        return object;
+    dotpath = dotpath.replace(/\[(\w+)\]/g, '.$1');
+    dotpath = dotpath.replace(/^\./, '');
+    const a = dotpath.split('.');
+    let o = object;
+    while (a.length) {
+        const n = a.shift();
+        if (!n)
+            continue;
+        if (a.length < 1) {
+            if (Array.isArray(o)) {
+                const idx = parseInt(n);
+                o.splice(idx, 1);
+            }
+            else {
+                delete o[n];
+            }
+            // __set(object, parentdotpath, o);
+        }
+        else {
+            o = o[n];
+        }
+    }
+    return object;
+}
+//# sourceMappingURL=delete.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"delete.js","sourceRoot":"","sources":["../../../src/shared/object/delete.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,MAAW,EACX,OAA0B;IAE1B,mEAAmE;IAEnE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,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,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxB,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACd,CAAC;YACD,mCAAmC;QACrC,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/deleteProperty.d.ts

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

package/dist/shared/object/deleteProperty.js

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