@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/object/propertyProxy.js

@@ -0,0 +1,65 @@
+// @ts-nocheck
+export default function propertyProxy(obj, property, descriptor, applySetterAtStart = false) {
+    // handle property like "something.cool"
+    const objPath = property.split('.').slice(0, -1).join('.');
+    if (objPath) {
+        property = property.split('.').pop();
+        obj = __get(obj, objPath);
+    }
+    // store the current value
+    let val = __get(obj, property);
+    const currentDescriptor = Object.getOwnPropertyDescriptor(obj.prototype || obj, property);
+    // custom setter check
+    const _set = (value) => {
+        if (descriptor.set) {
+            value = descriptor.set(value);
+        }
+        // descriptor
+        if (currentDescriptor && currentDescriptor.set) {
+            const ret = currentDescriptor.set(value);
+            if (ret) {
+                val = ret;
+            }
+            else {
+                val = currentDescriptor.get();
+            }
+        }
+        else {
+            val = value;
+        }
+    };
+    // apply the setter if needed
+    if (applySetterAtStart)
+        _set(val);
+    // make sure we have the good descriptor
+    const d = Object.getOwnPropertyDescriptor(obj, property);
+    Object.defineProperty(obj, property, {
+        get: () => {
+            let _val = val;
+            if (descriptor.get) {
+                _val = descriptor.get(_val);
+            }
+            if (currentDescriptor && currentDescriptor.get) {
+                _val = currentDescriptor.get();
+            }
+            return _val;
+        },
+        set: (v) => {
+            // internal set to use the good setter
+            _set(v);
+        },
+        configurable: descriptor.configurable !== undefined
+            ? descriptor.configurable
+            : currentDescriptor && currentDescriptor.configurable !== undefined
+                ? currentDescriptor.configurable
+                : false,
+        enumarable: descriptor.enumarable !== undefined
+            ? descriptor.enumarable
+            : currentDescriptor && currentDescriptor.enumarable !== undefined
+                ? currentDescriptor.enumarable
+                : true,
+    });
+    // return the value
+    return val;
+}
+//# sourceMappingURL=propertyProxy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"propertyProxy.js","sourceRoot":"","sources":["../../../src/shared/object/propertyProxy.ts"],"names":[],"mappings":"AAAA,cAAc;AAmDd,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,GAAQ,EACR,QAAgB,EAChB,UAAoC,EACpC,qBAA8B,KAAK;IAEnC,wCAAwC;IACxC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,IAAI,OAAO,EAAE,CAAC;QACZ,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QACrC,GAAG,GAAG,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,0BAA0B;IAC1B,IAAI,GAAG,GAAG,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC/B,MAAM,iBAAiB,GAAG,MAAM,CAAC,wBAAwB,CACvD,GAAG,CAAC,SAAS,IAAI,GAAG,EACpB,QAAQ,CACT,CAAC;IAEF,sBAAsB;IACtB,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE;QACrB,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;YACnB,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,aAAa;QACb,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,GAAG,EAAE,CAAC;YAC/C,MAAM,GAAG,GAAG,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACzC,IAAI,GAAG,EAAE,CAAC;gBACR,GAAG,GAAG,GAAG,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG,iBAAiB,CAAC,GAAG,EAAE,CAAC;YAChC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,6BAA6B;IAC7B,IAAI,kBAAkB;QAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAElC,wCAAwC;IACxC,MAAM,CAAC,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACzD,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE;QACnC,GAAG,EAAE,GAAG,EAAE;YACR,IAAI,IAAI,GAAG,GAAG,CAAC;YACf,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;gBACnB,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC;YACD,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,GAAG,EAAE,CAAC;gBAC/C,IAAI,GAAG,iBAAiB,CAAC,GAAG,EAAE,CAAC;YACjC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE;YACT,sCAAsC;YACtC,IAAI,CAAC,CAAC,CAAC,CAAC;QACV,CAAC;QACD,YAAY,EACV,UAAU,CAAC,YAAY,KAAK,SAAS;YACnC,CAAC,CAAC,UAAU,CAAC,YAAY;YACzB,CAAC,CAAC,iBAAiB,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS;gBACjE,CAAC,CAAC,iBAAiB,CAAC,YAAY;gBAChC,CAAC,CAAC,KAAK;QACb,UAAU,EACR,UAAU,CAAC,UAAU,KAAK,SAAS;YACjC,CAAC,CAAC,UAAU,CAAC,UAAU;YACvB,CAAC,CAAC,iBAAiB,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS;gBAC/D,CAAC,CAAC,iBAAiB,CAAC,UAAU;gBAC9B,CAAC,CAAC,IAAI;KACb,CAAC,CAAC;IAEH,mBAAmB;IACnB,OAAO,GAAG,CAAC;AACb,CAAC"}

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

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

package/dist/shared/object/proxyDeep.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 mapDeep from '../object/mapDeep.js';
+/**
+ * @name                            proxyDeep
+ * @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 { proxyDeep } from '@blackbyte/sugar/object';
+ * const a = proxyDeep({
+ *    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 proxyDeep(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 = mapDeep(__copy, ({ value, prop }) => {
+                    if (prop === 'revoke' && typeof value === 'function') {
+                        return -1;
+                    }
+                    return value;
+                });
+                // deep revoke the proxies
+                setTimeout(() => {
+                    mapDeep(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=proxyDeep.js.map

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

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

@@ -0,0 +1,26 @@
+/**
+ * @name                    remove
+ * @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         remove($1, $2)
+ *
+ * @example             js
+ * import { remove } from '@blackbyte/sugar/object';
+ * remove(myObject, 'my.cool.value');
+ * remove(myObject, 'my.cool.value.0');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function remove(object: any, dotpath: string | string[]): void;

package/dist/shared/object/remove.js

@@ -0,0 +1,57 @@
+/**
+ * @name                    remove
+ * @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         remove($1, $2)
+ *
+ * @example             js
+ * import { remove } from '@blackbyte/sugar/object';
+ * remove(myObject, 'my.cool.value');
+ * remove(myObject, 'my.cool.value.0');
+ *
+ * @since     1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function remove(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=remove.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remove.js","sourceRoot":"","sources":["../../../src/shared/object/remove.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,MAAW,EAAE,OAA0B;IACpE,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/set.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @name                    set
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Set an object value using a dotted object path like "myObject.myProperty.myValue" to set his position
+ * If the path parameter is set to '.', it will act like an `Object.assign(obj, value)`.
+ *
+ * @param       {Object}                    obj         The object in which to set the value
+ * @param       {String|String[]}           path        The object path where to set the value
+ * @param       {Mixed}                     value       The value to set
+ * @return      {Mixed}                                 Return the setted value if setted correctly, or undefined if something goes wrong...
+ *
+ * @setting     {Boolean}                   [preferAssign=false]            Specify if you prefer using Object.assign rather than = for objects to keep references
+ *
+ * @todo      tests
+ *
+ * @snippet         set($1, $2)
+ *
+ * @example               js
+ * import { set } from '@blackbyte/sugar/object';
+ *  set('myObject.cool.value', 'Hello world'); // => Hello world
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TSetSettings = {
+    preferAssign: boolean;
+};
+export default function set(obj: any, path: string | string[], value: any, settings?: TSetSettings): void;

package/dist/shared/object/set.js

@@ -0,0 +1,65 @@
+import isPlainObject from '../is/isPlainObject.js';
+import unquote from '../string/unquote.js';
+import get from './get.js';
+export default function set(obj, path, value, settings) {
+    const finalSettings = Object.assign({ preferAssign: false }, (settings !== null && settings !== void 0 ? settings : {}));
+    let o = obj, a;
+    if (Array.isArray(path) && path.length === 1) {
+        path = path[0];
+    }
+    if (typeof path === 'string') {
+        if (!path || path === '' || path === '.') {
+            Object.assign(obj, value);
+            return;
+        }
+        path = path.replace(/\[(\w+)\]/g, '.[$1]');
+        // path = path.replace(/^\./, '');
+        a = unquote(path)
+            .split(/(?!\B"[^"]*)\.(?![^"]*"\B)/gm)
+            .map((p) => unquote(p));
+    }
+    else if (Array.isArray(path)) {
+        a = [...path];
+    }
+    while (a.length - 1) {
+        const n = a.shift();
+        if (!(n in o)) {
+            if (typeof a[0] === 'string') {
+                if (a[0].match(/^\[[0-9]+\]$/))
+                    o[n] = [];
+                else
+                    o[n] = {};
+            }
+            else {
+                o[n] = {};
+            }
+        }
+        if (!o[n]) {
+            o[n] = {};
+        }
+        o = o[n];
+    }
+    if (typeof a[0] === 'string' && a[0].match(/^\[[0-9]+\]$/)) {
+        if (!Array.isArray(o)) {
+            o = [];
+        }
+        o.push(value);
+    }
+    else {
+        if (isPlainObject(o[a[0]]) &&
+            isPlainObject(value) &&
+            finalSettings.preferAssign) {
+            // empty the current obj
+            for (const key in o[a[0]]) {
+                delete o[a[0]][key];
+            }
+            // assigning the new value
+            Object.assign(o[a[0]], value);
+        }
+        else {
+            o[a[0]] = value;
+        }
+    }
+    return get(obj, path);
+}
+//# sourceMappingURL=set.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"set.js","sourceRoot":"","sources":["../../../src/shared/object/set.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,OAAO,MAAM,sBAAsB,CAAC;AAC3C,OAAO,GAAG,MAAM,UAAU,CAAC;AAoC3B,MAAM,CAAC,OAAO,UAAU,GAAG,CACzB,GAAQ,EACR,IAAuB,EACvB,KAAU,EACV,QAAuB;IAEvB,MAAM,aAAa,mBACjB,YAAY,EAAE,KAAK,IAChB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,CAAC,GAAG,GAAG,EACT,CAAC,CAAC;IAEJ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC3C,kCAAkC;QAClC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;aACd,KAAK,CAAC,8BAA8B,CAAC;aACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACd,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC7B,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;oBAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;;oBACrC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACV,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QACZ,CAAC;QAED,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;IAED,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;QAC3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACtB,CAAC,GAAG,EAAE,CAAC;QACT,CAAC;QACD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,IACE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtB,aAAa,CAAC,KAAK,CAAC;YACpB,aAAa,CAAC,YAAY,EAC1B,CAAC;YACD,wBAAwB;YACxB,KAAK,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;YACD,0BAA0B;YAC1B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACxB,CAAC"}

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

@@ -0,0 +1,50 @@
+/**
+ * @name                    sort
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Sort an object properties the same way as the Array.sort do it.
+ * The "a" and "b" argument passed to your sort function will have these properties:
+ * - key: The key of the object
+ * - value: The actual value of the object property
+ *
+ * @param                 {Object}                  object                The object to sort
+ * @param                 {Function}                [sort=null]                  The sort function to use. If not specified, will sort the items by key alphabetically
+ * @return                {Object}                                        The sorted object
+ *
+ * @todo      tests
+ *
+ * @snippet         sort($1, $2)
+ * sort($1, (a, b) => {
+ *      // a.key - a.value | b.key - b.value
+ *      $2
+ * })
+ *
+ * @example               js
+ * import { sort } from '@blackbyte/sugar/object';
+ * sort({
+ *    coco: { weight: 10 },
+ *    lolo: { weight: 2 },
+ *    plop: { weight: 5 }
+ * }, (a, b) => {
+ *   return a.value.weight - b.value.weight;
+ * });
+ * // {
+ * //   lolo: { weight: 2 },
+ * //   plop: { weight: 5 },
+ * //   coco: { weight: 10 }
+ * // }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function sort(object: any, sort?: (a: {
+    key: string;
+    value: any;
+}, b: {
+    key: string;
+    value: any;
+}) => number): any;

package/dist/shared/object/sort.js

@@ -0,0 +1,71 @@
+/**
+ * @name                    sort
+ * @namespace               shared.object
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Sort an object properties the same way as the Array.sort do it.
+ * The "a" and "b" argument passed to your sort function will have these properties:
+ * - key: The key of the object
+ * - value: The actual value of the object property
+ *
+ * @param                 {Object}                  object                The object to sort
+ * @param                 {Function}                [sort=null]                  The sort function to use. If not specified, will sort the items by key alphabetically
+ * @return                {Object}                                        The sorted object
+ *
+ * @todo      tests
+ *
+ * @snippet         sort($1, $2)
+ * sort($1, (a, b) => {
+ *      // a.key - a.value | b.key - b.value
+ *      $2
+ * })
+ *
+ * @example               js
+ * import { sort } from '@blackbyte/sugar/object';
+ * sort({
+ *    coco: { weight: 10 },
+ *    lolo: { weight: 2 },
+ *    plop: { weight: 5 }
+ * }, (a, b) => {
+ *   return a.value.weight - b.value.weight;
+ * });
+ * // {
+ * //   lolo: { weight: 2 },
+ * //   plop: { weight: 5 },
+ * //   coco: { weight: 10 }
+ * // }
+ *
+ * @since       1.0.0
+ * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function sort(object, sort) {
+    // get the object keys
+    const keys = Object.keys(object);
+    // sort the keys
+    const sortedKeys = keys.sort((a, b) => {
+        if (!sort) {
+            if (a < b) {
+                return -1;
+            }
+            if (a > b) {
+                return 1;
+            }
+            return 0;
+        }
+        // call the sort function passed as parameter
+        return sort({ key: a, value: object[a] }, { key: b, value: object[b] });
+    });
+    // create the new sorted object
+    const resultObj = {};
+    // loop on each sorted keys
+    sortedKeys.forEach((k) => {
+        // add the property key with the object value
+        resultObj[k] = object[k];
+    });
+    // return the result sorted object
+    return resultObj;
+}
+//# sourceMappingURL=sort.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../../src/shared/object/sort.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,MAAM,CAAC,OAAO,UAAU,IAAI,CAC1B,MAAW,EACX,IASW;IAEX,sBAAsB;IACtB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEjC,gBAAgB;IAChB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACpC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACV,OAAO,CAAC,CAAC,CAAC;YACZ,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACV,OAAO,CAAC,CAAC;YACX,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;QAED,6CAA6C;QAC7C,OAAO,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,+BAA+B;IAC/B,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,2BAA2B;IAC3B,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACvB,6CAA6C;QAC7C,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,kCAAkC;IAClC,OAAO,SAAS,CAAC;AACnB,CAAC"}