@schukai/monster 1.23.0 → 1.26.1

package/source/data/datasource/restapi.js

@@ -4,25 +4,20 @@
  * @author schukai GmbH
  */
 
-import {PROPERTY_KEY_INTERNALDATA} from "../../constants.js";
+import {internalSymbol} from "../../constants.js";
 import {assignToNamespace, Monster} from '../../namespace.js';
 import {isObject} from "../../types/is.js";
 import {Datasource} from "../datasource.js";
-
-
-
-/**
- * @private
- * @type {symbol}
- */
-const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
+import {Pathfinder} from "../pathfinder.js";
+import {Pipe} from "../pipe.js";
+import {WriteError} from "./restapi/writeerror.js";
 
 /**
  * You can create an object of this class using the monster namespace `Monster.Data.Datasource.RestAPI()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/restapi.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
  * Monster.Data.Datasource.RestAPI()
  * </script>
  * ```
@@ -31,14 +26,14 @@ const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {RestAPI} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/restapi.js';
+ * import {RestAPI} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource/restapi.js';
  * new RestAPI()
  * </script>
  * ```
  *
  * @example
  *
- * import {RestAPI} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/restapi.js';
+ * import {RestAPI} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource/restapi.js';
  *
  * const ds = new RestAPI({
  *   url: 'https://httpbin.org/get'
@@ -82,10 +77,18 @@ class RestAPI extends Datasource {
      * @property {string} write.init.method=POST
      * @property {string} write.acceptedStatus=[200,201]
      * @property {string} write.url URL
+     * @property {Object} write.mapping the mapping is applied before writing.
+     * @property {String} write.mapping.transformer Transformer to select the appropriate entries
+     * @property {Object} write.report
+     * @property {String} write.report.path Path to validations
+     * @property {Monster.Data.Datasource~exampleCallback[]} write.mapping.callback with the help of the callback, the structures can be adjusted before writing.
      * @property {Object} read.init={} An options object containing any custom settings that you want to apply to the request. The parameters are identical to those of the {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request|Request constructor}
      * @property {string} read.init.method=GET
      * @property {string} read.acceptedStatus=[200]
      * @property {string} read.url URL
+     * @property {Object} read.mapping the mapping is applied after reading.
+     * @property {String} read.mapping.transformer Transformer to select the appropriate entries
+     * @property {Monster.Data.Datasource~exampleCallback[]} read.mapping.callback with the help of the callback, the structures can be adjusted after reading.
      */
     get defaults() {
         return Object.assign({}, super.defaults, {
@@ -94,14 +97,25 @@ class RestAPI extends Datasource {
                     method: 'POST',
                 },
                 acceptedStatus: [200, 201],
-                url: undefined
+                url: undefined,
+                mapping: {
+                    transformer: undefined,
+                    callbacks: []
+                },
+                report: {
+                    path: undefined
+                }
             },
             read: {
                 init: {
                     method: 'GET'
                 },
                 acceptedStatus: [200],
-                url: undefined
+                url: undefined,
+                mapping: {
+                    transformer: undefined,
+                    callbacks: []
+                },
             },
 
         });
@@ -143,19 +157,23 @@ class RestAPI extends Datasource {
                     body = body.substring(0, 97) + '...';
                 }
 
-
                 throw new Error('the response does not contain a valid json (actual: ' + body + ').');
             }
 
-            self.set(obj);
+            let transformation = self.getOption('read.mapping.transformer');
+            if (transformation !== undefined) {
+                const pipe = new Pipe(transformation);
+                obj = pipe.run(obj);
+            }
 
+            self.set(obj);
             return response;
         })
     }
 
     /**
      * @return {Promise}
-     * @throws {Error} the data cannot be written
+     * @throws {WriteError} the data cannot be written
      */
     write() {
         const self = this;
@@ -169,14 +187,52 @@ class RestAPI extends Datasource {
             }
         }
 
-        init['body'] = JSON.stringify(self.get());
+        let obj = self.get();
+        let transformation = self.getOption('write.mapping.transformer');
+        if (transformation !== undefined) {
+            const pipe = new Pipe(transformation);
+            obj = pipe.run(obj);
+        }
+
+        let sheathingObject = self.getOption('write.sheathing.object');
+        let sheathingPath = self.getOption('write.sheathing.path');
+        let reportPath = self.getOption('write.report.path');
+
+        if (sheathingObject && sheathingPath) {
+            const sub = obj;
+            obj = sheathingObject;
+            (new Pathfinder(obj)).setVia(sheathingPath, sub);
+        }
+
+        init['body'] = JSON.stringify(obj);
 
         return fetch(self.getOption('write.url'), init).then(response => {
 
             const acceptedStatus = self.getOption('write.acceptedStatus', [200, 2001]);
 
             if (acceptedStatus.indexOf(response.status) === -1) {
-                throw Error('the data cannot be written (response ' + response.status + ')')
+
+                return response.text().then((body) => {
+
+                    let obj, validation;
+                    try {
+                        obj = JSON.parse(body);
+                        validation = new Pathfinder(obj).getVia(reportPath)
+
+                    } catch (e) {
+
+                        if (body.length > 100) {
+                            body = body.substring(0, 97) + '...';
+                        }
+
+                        throw new Error('the response does not contain a valid json (actual: ' + body + ').');
+                    }
+
+                    throw new WriteError('the data cannot be written (response ' + response.status + ')', response, validation)
+
+                })
+
+
             }
 
             return response;
@@ -189,11 +245,22 @@ class RestAPI extends Datasource {
      */
     getClone() {
         const self = this;
-        return new RestAPI(self[internalDataSymbol].getRealSubject()['options'].read, self[internalDataSymbol].getRealSubject()['options'].write);
+        return new RestAPI(self[internalSymbol].getRealSubject()['options'].read, self[internalSymbol].getRealSubject()['options'].write);
     }
 
 }
 
 
+/**
+ * This callback can be passed to a datasource and is used to adapt data structures.
+ *
+ * @callback Monster.Data.Datasource~exampleCallback
+ * @param {*} value Value
+ * @param {string} key  Key
+ * @memberOf Monster.Data
+ * @see Monster.Data.Datasource
+ */
+
+
 assignToNamespace('Monster.Data.Datasource', RestAPI);
 export {Monster, RestAPI}

package/source/data/datasource/storage/localstorage.js

@@ -4,19 +4,13 @@
  * @author schukai GmbH
  */
 
-import {PROPERTY_KEY_INTERNALDATA} from "../../../constants.js";
+import {internalSymbol} from "../../../constants.js";
 import {assignToNamespace, Monster} from '../../../namespace.js';
 import {getGlobalObject} from "../../../types/global.js";
 import {Datasource} from "../../datasource.js";
 import {Storage, storageObjectSymbol} from "../storage.js";
 
 
-/**
- * @private
- * @type {symbol}
- */
-const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
-
 /**
  * 
  * 
@@ -24,7 +18,7 @@ const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage/localstorage.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
  * Monster.Data.Datasource.Storage.LocalStorage()
  * </script>
  * ```
@@ -33,7 +27,7 @@ const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {LocalStorage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage/localstorage.js';
+ * import {LocalStorage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource/storage/localstorage.js';
  * new LocalStorage()
  * </script>
  * ```
@@ -60,7 +54,7 @@ class LocalStorage extends Storage {
      */
     getClone() {
         const self = this;
-        return new LocalStorage(self[internalDataSymbol].getRealSubject()['options'].key);
+        return new LocalStorage(self[internalSymbol].getRealSubject()['options'].key);
     }
 
 

package/source/data/datasource/storage/sessionstorage.js

@@ -4,26 +4,18 @@
  * @author schukai GmbH
  */
 
-import {PROPERTY_KEY_INTERNALDATA} from "../../../constants.js";
+import {internalSymbol} from "../../../constants.js";
 import {assignToNamespace, Monster} from '../../../namespace.js';
 import {getGlobalObject} from "../../../types/global.js";
 import {Datasource} from "../../datasource.js";
 import {Storage, storageObjectSymbol} from "../storage.js";
 
-
-
-/**
- * @private
- * @type {symbol}
- */
-const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
-
 /**
  * You can create an object of this class using the monster namespace `Monster.Data.Datasource.Storage.SessionStorage()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage/sessionstorage.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
  * Monster.Data.Datasource.Storage.SessionStorage()
  * </script>
  * ```
@@ -32,7 +24,7 @@ const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {SessionStorage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage/sessionstorage.js';
+ * import {SessionStorage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource/storage/sessionstorage.js';
  * new SessionStorage()
  * </script>
  * ```
@@ -60,7 +52,7 @@ class SessionStorage extends Storage {
      */
     getClone() {
         const self = this;
-        return new SessionStorage(self[internalDataSymbol].getRealSubject()['options'].key);
+        return new SessionStorage(self[internalSymbol].getRealSubject()['options'].key);
     }
 
 }

package/source/data/datasource/storage.js

@@ -4,18 +4,11 @@
  * @author schukai GmbH
  */
 
-import {PROPERTY_KEY_INTERNALDATA} from "../../constants.js";
+import {internalSymbol} from "../../constants.js";
 import {assignToNamespace, Monster} from '../../namespace.js';
 import {validateString} from "../../types/validate.js";
 import {Datasource} from "../datasource.js";
 
-
-/**
- * @private
- * @type {symbol}
- */
-const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
-
 /**
  * @private
  * @type {symbol}
@@ -27,7 +20,7 @@ const storageObjectSymbol = Symbol('storageObject');
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
  * Monster.Data.Datasource.Storage()
  * </script>
  * ```
@@ -36,14 +29,14 @@ const storageObjectSymbol = Symbol('storageObject');
  *
  * ```
  * <script type="module">
- * import {Storage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage.js';
+ * import {Storage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource/storage.js';
  * new Storage()
  * </script>
  * ```
  *
  * @example
  *
- * import {Storage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource/storage.js';
+ * import {Storage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource/storage.js';
  *
  * new Datasource();
  *
@@ -95,7 +88,7 @@ class Storage extends Datasource {
 
         return new Promise(function (resolve) {
             const data = JSON.parse(storage.getItem(self.getOption('key')));
-            self.set(data);
+            self.set(data??{});
             resolve();
         })
 
@@ -116,7 +109,7 @@ class Storage extends Datasource {
             if (data === undefined) {
                 storage.removeItem(self.getOption('key'));
             } else {
-                storage.setItem(self.getOption('key'), JSON.stringify(self.get()));
+                storage.setItem(self.getOption('key'), JSON.stringify(data));
             }
 
             resolve();
@@ -128,7 +121,7 @@ class Storage extends Datasource {
      */
     getClone() {
         const self=this;
-        return new Storage(self[internalDataSymbol].getRealSubject()['options'].key);
+        return new Storage(self[internalSymbol].getRealSubject()['options'].key);
     } 
     
 }

package/source/data/datasource.js

@@ -4,7 +4,7 @@
  * @author schukai GmbH
  */
 
-import {PROPERTY_KEY_INTERNALDATA} from "../constants.js";
+import {internalSymbol} from "../constants.js";
 import {assignToNamespace, Monster} from '../namespace.js';
 import {Base} from "../types/base.js";
 import {parseDataURL} from "../types/dataurl.js";
@@ -18,18 +18,20 @@ import {Pathfinder} from "./pathfinder.js";
 /**
  * @private
  * @type {symbol}
+ * @memberOf Monster.Data
+ * @since 1.24.0
  */
-const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
+const internalDataSymbol = Symbol('internalData');
 
 /**
  * The datasource class is the basis for dealing with different data sources.
  * It provides a unified interface for accessing data
- * 
+ *
  * You can create an object of this class using the monster namespace `Monster.Data.Datasource()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
  * Monster.Data.Datasource()
  * </script>
  * ```
@@ -38,19 +40,19 @@ const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {Datasource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource.js';
+ * import {Datasource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource.js';
  * new Datasource()
  * </script>
  * ```
  *
  * @example
  *
- * import {Datasource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/datasource.js'
- * 
+ * import {Datasource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/datasource.js'
+ *
  * class MyDatasource extends Datasource {
  *  
  * }
- * 
+ *
  * const ds = new MyDatasource();
  *
  * @since 1.22.0
@@ -65,11 +67,45 @@ class Datasource extends Base {
      */
     constructor() {
         super();
+        this[internalSymbol] = new ProxyObserver({
+            'options': extend({}, this.defaults)
+        });
+        
         this[internalDataSymbol] = new ProxyObserver({
-            'options': extend({}, this.defaults),
-            'data': undefined
+
         });
+        
+    
+    }
+
+    /**
+     * attach a new observer
+     *
+     * @param {Observer} observer
+     * @returns {Datasource}
+     */
+    attachObserver(observer) {
+        this[internalDataSymbol].attachObserver(observer)
+        return this;
+    }
 
+    /**
+     * detach a observer
+     *
+     * @param {Observer} observer
+     * @returns {Datasource}
+     */
+    detachObserver(observer) {
+        this[internalDataSymbol].detachObserver(observer)
+        return this;
+    }
+
+    /**
+     * @param {Observer} observer
+     * @returns {boolean}
+     */
+    containsObserver(observer) {
+        return this[internalDataSymbol].containsObserver(observer);
     }
 
     /**
@@ -95,7 +131,7 @@ class Datasource extends Base {
      * @return {Datasource}
      */
     setOption(path, value) {
-        new Pathfinder(this[internalDataSymbol].getSubject()['options']).setVia(path, value);
+        new Pathfinder(this[internalSymbol].getSubject()['options']).setVia(path, value);
         return this;
     }
 
@@ -111,7 +147,7 @@ class Datasource extends Base {
         }
 
         const self = this;
-        extend(self[internalDataSymbol].getSubject()['options'], self.defaults, options);
+        extend(self[internalSymbol].getSubject()['options'], self.defaults, options);
 
         return self;
     }
@@ -127,7 +163,7 @@ class Datasource extends Base {
         let value;
 
         try {
-            value = new Pathfinder(this[internalDataSymbol].getRealSubject()['options']).getVia(path);
+            value = new Pathfinder(this[internalSymbol].getRealSubject()['options']).getVia(path);
         } catch (e) {
 
         }
@@ -154,20 +190,22 @@ class Datasource extends Base {
 
 
     /**
-     * @return {*}
+     * Returns real object
+     * 
+     * @return {Object|Array}
      */
     get() {
         const self = this;
-        return self[internalDataSymbol].getSubject()['data'];
+        return self[internalDataSymbol].getRealSubject();
     }
 
     /**
-     * @param {*} data
+     * @param {Object|Array} data
      * @return {Datasource}
      */
     set(data) {
         const self = this;
-        self[internalDataSymbol].getSubject()['data'] = data;
+        self[internalDataSymbol].setSubject(data);
         return self;
     }
 

package/source/data/diff.js

@@ -17,8 +17,8 @@ import {typeOf} from "../types/typeof.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/diff.js';
- * console.log(Monster.Data.Diff(a, b))
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
+ * Monster.Data.Diff(a, b)
  * </script>
  * ```
  *
@@ -26,14 +26,14 @@ import {typeOf} from "../types/typeof.js";
  *
  * ```
  * <script type="module">
- * import {Diff} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/diff.js';
- * console.log(Diff(a, b))
+ * import {Diff} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/diff.js';
+ * Diff(a, b)
  * </script>
  * ```
  *
  * @example
  *
- * import {Diff} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/diff.js';
+ * import {Diff} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/diff.js';
  *
  * // given are two objects x and y.
  *
@@ -80,7 +80,7 @@ import {typeOf} from "../types/typeof.js";
  * @copyright schukai GmbH
  * @memberOf Monster.Data
  */
-function Diff(first, second) {
+function diff(first, second) {
     return doDiff(first, second)
 }
 
@@ -245,5 +245,5 @@ function getOperator(a, b) {
 
 }
 
-assignToNamespace('Monster.Data', Diff);
-export {Monster, Diff}
+assignToNamespace('Monster.Data', diff);
+export {Monster, diff}

package/source/data/extend.js

@@ -8,15 +8,15 @@ import {isArray, isObject} from "../types/is.js";
 import {typeOf} from "../types/typeof.js";
 
 /**
- * extend copies all enumerable own properties from one or
+ * Extend copies all enumerable own properties from one or
  * more source objects to a target object. It returns the modified target object.
  *
  * You can call the method via the monster namespace `Monster.Data.extend()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/extend.js';
- * console.log(Monster.Data.extend(a, b))
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
+ * Monster.Data.extend(a, b)
  * </script>
  * ```
  *
@@ -24,8 +24,8 @@ import {typeOf} from "../types/typeof.js";
  *
  * ```
  * <script type="module">
- * import {extend} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/extend.js';
- * console.log(extend(a, b))
+ * import {extend} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/extend.js';
+ * extend(a, b)
  * </script>
  * ```
  *

package/source/data/pathfinder.js

@@ -27,7 +27,7 @@ export const WILDCARD = '*';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/pathfinder.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/monster.js';
  * console.log(new Monster.Data.Pathfinder())
  * </script>
  * ```
@@ -36,7 +36,7 @@ export const WILDCARD = '*';
  *
  * ```
  * <script type="module">
- * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/pathfinder.js';
+ * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/pathfinder.js';
  * console.log(new Pathfinder())
  * </script>
  * ```
@@ -78,7 +78,7 @@ export const WILDCARD = '*';
  *
  * @example
  *
- * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/pathfinder.js';
+ * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/pathfinder.js';
  *
  * let value = new Pathfinder({
  * a: {
@@ -104,7 +104,7 @@ export const WILDCARD = '*';
  *
  * @example
  *
- * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.23.0/dist/modules/data/pathfinder.js';
+ * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.1/dist/modules/data/pathfinder.js';
  *
  * let p = new Pathfinder({
  *                a: {
@@ -317,8 +317,14 @@ function getValueViaPath(subject, path, check) {
             throw Error("the journey is not at its end (" + parts.join(DELIMITER) + ")");
         }
 
-        if (check === true && !subject.hasOwnProperty(current)) {
-            throw Error('unknown value');
+
+        if (check === true) {
+            const descriptor = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(subject), current);
+
+            if (!subject.hasOwnProperty(current) && descriptor === undefined) {
+                throw Error('unknown value');
+            }
+
         }
 
         return anchor;