@schukai/monster 3.3.0 → 3.4.1

package/README.md

@@ -73,7 +73,7 @@ We do try to work around some browser bugs, but on the whole we don't use polyfi
 However, many functions can be mapped via [polyfill.io](https://polyfill.io/) and thus the compatibility can be increased.
 
 ```html
-<script id="polyfill" src="https://polyfill.io/v3/polyfill.min.js?features=Array.from,Array.isArray,Array.prototype.entries,Array.prototype.fill,Array.prototype.filter,Array.prototype.forEach,Array.prototype.indexOf,Array.prototype.keys,Array.prototype.lastIndexOf,Array.prototype.map,Array.prototype.reduce,Array.prototype.sort,ArrayBuffer,atob,CustomEvent,DataView,document,Document,DocumentFragment,Element,Event,fetch,globalThis,HTMLDocument,HTMLTemplateElement,Intl,JSON,Map,Math.log2,Number.isInteger,Object.assign,Object.defineProperty,Object.entries,Object.freeze,Object.getOwnPropertyDescriptor,Object.getOwnPropertyNames,Object.getPrototypeOf,Object.keys,Promise,Reflect,Reflect.defineProperty,Reflect.get,Reflect.getOwnPropertyDescriptor,Reflect.setPrototypeOf,Set,String.prototype.endsWith,String.prototype.matchAll,String.prototype.padStart,String.prototype.startsWith,String.prototype.trim,Symbol,Symbol.for,Symbol.hasInstance,Symbol.iterator,Uint16Array,Uint8Array,URL,WeakMap,WeakSet"
+<script id="polyfill" src="https://polyfill.io/v3/polyfill.min.js?features=Array.from,Array.isArray,Array.prototype.entries,Array.prototype.fill,Array.prototype.filter,Array.prototype.forEach,Array.prototype.indexOf,Array.prototype.keys,Array.prototype.lastIndexOf,Array.prototype.map,Array.prototype.reduce,Array.prototype.sort,ArrayBuffer,atob,Blob,CustomEvent,DataView,document,Document,DocumentFragment,Element,Event,fetch,globalThis,HTMLDocument,HTMLTemplateElement,Intl,JSON,Map,Math.log2,Number.isInteger,Object.assign,Object.defineProperty,Object.entries,Object.freeze,Object.getOwnPropertyDescriptor,Object.getOwnPropertyNames,Object.getPrototypeOf,Object.keys,Promise,Reflect,Reflect.defineProperty,Reflect.get,Reflect.getOwnPropertyDescriptor,Reflect.setPrototypeOf,Set,String.prototype.endsWith,String.prototype.matchAll,String.prototype.padStart,String.prototype.startsWith,String.prototype.trim,Symbol,Symbol.for,Symbol.hasInstance,Symbol.iterator,Uint16Array,Uint8Array,URL,WeakMap,WeakSet"
        crossorigin="anonymous"
        referrerpolicy="no-referrer"></script>
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schukai/monster",
-  "version": "3.3.0",
+  "version": "3.4.1",
   "description": "Monster is a simple library for creating fast, robust and lightweight websites.",
   "keywords": [
     "framework",

package/source/data/datasource/{restapi → server}/namespace.mjs

@@ -4,9 +4,9 @@
  */
 
 /**
- * Namespace for storages
+ * Namespace for server
  *
- * @namespace Monster.Data.Datasource.RestAPI
+ * @namespace Monster.Data.Datasource.Server
  * @memberOf Monster.Data.Datasource
  * @author schukai GmbH
  */

package/source/data/datasource/server/restapi/namespace.mjs

@@ -0,0 +1,13 @@
+/**
+ * Copyright 2022 schukai GmbH
+ * SPDX-License-Identifier: AGPL-3.0
+ */
+
+/**
+ * Namespace for storages
+ *
+ * @namespace Monster.Data.Datasource.Server.RestAPI
+ * @memberOf Monster.Data.Datasource.Server
+ * @author schukai GmbH
+ */
+const ns = {};

package/source/data/datasource/{restapi → server/restapi}/writeerror.mjs

@@ -5,7 +5,7 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol,instanceSymbol} from "../../../constants.mjs";
+import {internalSymbol,instanceSymbol} from "../../../../constants.mjs";
 
 export {WriteError}
 
@@ -15,7 +15,7 @@ export {WriteError}
  * @license AGPLv3
  * @since 1.24.0
  * @copyright schukai GmbH
- * @memberOf Monster.Data.Datasource.RestAPI
+ * @memberOf Monster.Data.Datasource.Server.RestAPI
  * @summary the error is thrown by the rest api in case of error
  */
 class WriteError extends Error {
@@ -38,7 +38,7 @@ class WriteError extends Error {
      * @since 2.1.0
      */
     static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource/restapi/writeerror");
+        return Symbol.for("@schukai/monster/data/datasource/server/restapi/writeerror");
     }
 
     /**

package/source/data/datasource/{restapi.mjs → server/restapi.mjs}

@@ -5,11 +5,11 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol,instanceSymbol} from "../../constants.mjs";
-import {isObject} from "../../types/is.mjs";
-import {Datasource} from "../datasource.mjs";
-import {Pathfinder} from "../pathfinder.mjs";
-import {Pipe} from "../pipe.mjs";
+import {internalSymbol, instanceSymbol} from "../../../constants.mjs";
+import {isObject} from "../../../types/is.mjs";
+import {Server} from "../server.mjs";
+import {Pathfinder} from "../../pathfinder.mjs";
+import {Pipe} from "../../pipe.mjs";
 import {WriteError} from "./restapi/writeerror.mjs";
 
 export {RestAPI}
@@ -17,29 +17,25 @@ export {RestAPI}
 /**
  * The RestAPI is a class that enables a REST API server.
  *
- * @externalExample ../../../example/data/storage/restapi.mjs 
+ * @externalExample ../../../example/data/storage/restapi.mjs
  * @license AGPLv3
  * @since 1.22.0
  * @copyright schukai GmbH
- * @memberOf Monster.Data.Datasource
+ * @memberOf Monster.Data.Datasource.Server
  * @summary The RestAPI is a class that binds a REST API server.
  */
-class RestAPI extends Datasource {
+class RestAPI extends Server {
 
     /**
      *
-     * @param {Object} [readDefinition] An options object containing any custom settings that you want to apply to the read request.
-     * @param {Object} [writeDefinition] An options object containing any custom settings that you want to apply to the write request.
+     * @param {Object} [options] options contains definitions for the datasource.
      */
-    constructor(readDefinition, writeDefinition) {
+    constructor(options) {
         super();
 
-        const options = {}
-
-        if (isObject(readDefinition)) options.read = readDefinition;
-        if (isObject(writeDefinition)) options.write = writeDefinition;
-
-        this.setOptions(options);
+        if (isObject(options)) {
+            this.setOptions(options);
+        }
 
     }
 
@@ -49,9 +45,9 @@ class RestAPI extends Datasource {
      * @since 2.1.0
      */
     static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource/restapi");
-    }    
-    
+        return Symbol.for("@schukai/monster/data/datasource/server/restapi");
+    }
+
     /**
      * @property {Object} write={} Options
      * @property {Object} write.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}
@@ -64,9 +60,9 @@ class RestAPI extends Datasource {
      * @property {Monster.Data.Datasource~exampleCallback[]} write.mapping.callback with the help of the callback, the structures can be adjusted before writing.
      * @property {Object} write.report
      * @property {String} write.report.path Path to validations
-     * @property {Object} write.sheathing 
+     * @property {Object} write.sheathing
      * @property {Object} write.sheathing.object Object to be wrapped
-     * @property {string} write.sheathing.path Path to the data 
+     * @property {string} write.sheathing.path Path to the data
      * @property {Object} read={} Options
      * @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
@@ -124,45 +120,37 @@ class RestAPI extends Datasource {
         let init = self.getOption('read.init');
         if (!isObject(init)) init = {};
 
-        return fetch(self.getOption('read.url'), init).then(resp => {
-            response = resp;
+        return new Promise((resolve, reject) => {
+            fetch(self.getOption('read.url'), init).then(resp => {
+                response = resp;
 
-            const acceptedStatus = self.getOption('read.acceptedStatus', [200]);
+                const acceptedStatus = self.getOption('read.acceptedStatus', [200]);
 
-            if (acceptedStatus.indexOf(resp.status) === -1) {
-                throw Error('the data cannot be read (response ' + resp.status + ')')
-            }
+                if (acceptedStatus.indexOf(resp.status) === -1) {
+                    throw Error('the data cannot be read (response ' + resp.status + ')')
+                }
 
-            return resp.text()
-        }).then(body => {
+                return resp.text()
+            }).then(body => {
 
-            let obj;
+                let obj;
 
-            try {
-                obj = JSON.parse(body);
+                try {
+                    obj = JSON.parse(body);
 
-            } catch (e) {
+                } catch (e) {
 
-                if (body.length > 100) {
-                    body = body.substring(0, 97) + '...';
-                }
+                    if (body.length > 100) {
+                        body = body.substring(0, 97) + '...';
+                    }
 
-                throw new Error('the response does not contain a valid json (actual: ' + body + ').');
-            }
+                    throw new Error('the response does not contain a valid json (actual: ' + body + ').');
+                }
 
-            let transformation = self.getOption('read.mapping.transformer');
-            if (transformation !== undefined) {
-                const pipe = new Pipe(transformation);
+                self.set(self.transformServerPayload.call(self, obj));
+                resolve(response);
+            }).catch(reject);
 
-                for (const callback of self.getOption('read.mapping.callbacks')) {
-                    pipe.setCallback(callback.constructor.name, callback);
-                }                
-                
-                obj = pipe.run(obj);
-            }
-
-            self.set(obj);
-            return response;
         })
     }
 
@@ -173,7 +161,6 @@ class RestAPI extends Datasource {
     write() {
         const self = this;
 
-
         let init = self.getOption('write.init');
         if (!isObject(init)) init = {};
         if (typeof init['headers'] !== 'object') {
@@ -182,42 +169,28 @@ class RestAPI extends Datasource {
             }
         }
 
-        let obj = self.get();
-        let transformation = self.getOption('write.mapping.transformer');
-        if (transformation !== undefined) {
-            const pipe = new Pipe(transformation);
-
-            for (const callback of self.getOption('write.mapping.callbacks')) {
-                pipe.setCallback(callback.constructor.name, callback);
-            }
-            
-            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);
-        }
-
+        let obj = self.prepareServerPayload(self.get());
         init['body'] = JSON.stringify(obj);
 
-        return fetch(self.getOption('write.url'), init).then(response => {
+        return new Promise((resolve, reject) => {
+            fetch(self.getOption('write.url'), init).then(response => {
+                const acceptedStatus = self.getOption('write.acceptedStatus', [200, 201]);
 
-            const acceptedStatus = self.getOption('write.acceptedStatus', [200, 2001]);
-
-            if (acceptedStatus.indexOf(response.status) === -1) {
+                if (acceptedStatus.indexOf(response.status) > -1) {
+                    reject(response);
+                    return;
+                }
 
-                return response.text().then((body) => {
+                response.text().then((body) => {
 
-                    let obj, validation;
+                    let obj = {}, validation = {};
                     try {
                         obj = JSON.parse(body);
-                        validation = new Pathfinder(obj).getVia(reportPath)
+
+                        if (reportPath) {
+                            validation = (new Pathfinder(obj)).getVia(reportPath);
+                        }
+
 
                     } catch (e) {
 
@@ -225,18 +198,20 @@ class RestAPI extends Datasource {
                             body = body.substring(0, 97) + '...';
                         }
 
-                        throw new Error('the response does not contain a valid json (actual: ' + body + ').');
+                        reject(new Error('the response does not contain a valid json (actual: ' + body + ').'));
+                        return;
                     }
 
-                    throw new WriteError('the data cannot be written (response ' + response.status + ')', response, validation)
+                    reject(new WriteError('the data cannot be written (response ' + response.status + ')', response, validation))
+                    return;
 
-                })
+                }).catch(reject);
 
 
-            }
+            }).catch(reject);
+
+        })
 
-            return response;
-        });
     }
 
 

package/source/data/datasource/{websocket.mjs → server/webconnect.mjs}

@@ -5,16 +5,13 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol, instanceSymbol} from "../../constants.mjs";
-import {isString, isObject} from "../../types/is.mjs";
-import {WebConnect} from "../../net/webconnect.mjs";
-import {Message} from "../../net/webconnect/message.mjs";
-import {Datasource} from "../datasource.mjs";
-import {Pathfinder} from "../pathfinder.mjs";
-import {Pipe} from "../pipe.mjs";
-
-export {WebSocketDatasource}
+import {internalSymbol, instanceSymbol} from "../../../constants.mjs";
+import {isString, isObject} from "../../../types/is.mjs";
+import {WebConnect as NetWebConnect} from "../../../net/webconnect.mjs";
+import {Message} from "../../../net/webconnect/message.mjs";
+import {Server} from "../server.mjs";
 
+export {WebConnect}
 
 /**
  * @private
@@ -24,32 +21,7 @@ export {WebSocketDatasource}
  */
 const webConnectSymbol = Symbol("connection");
 
-/**
- *
- * @param self
- * @param obj
- * @returns {*}
- */
-function doTransform(type, obj) {
-    const self = this;
-    let transformation = self.getOption(type + '.mapping.transformer');
-    if (transformation !== undefined) {
-        const pipe = new Pipe(transformation);
-        const callbacks = self.getOption(type + '.mapping.callbacks')
 
-        if (isObject(callbacks)) {
-            for (const key in callbacks) {
-                if (callbacks.hasOwnProperty(key) && typeof callbacks[key] === 'function') {
-                    pipe.setCallback(key, callbacks[key]);
-                }
-            }
-        }
-
-        obj = pipe.run(obj);
-    }
-
-    return obj;
-}
 
 /**
  * The RestAPI is a class that enables a REST API server.
@@ -58,10 +30,10 @@ function doTransform(type, obj) {
  * @license AGPLv3
  * @since 3.1.0
  * @copyright schukai GmbH
- * @memberOf Monster.Data.Datasource
+ * @memberOf Monster.Data.Datasource.Server
  * @summary The LocalStorage class encapsulates the access to data objects.
  */
-class WebSocketDatasource extends Datasource {
+class WebConnect extends Server {
 
     /**
      *
@@ -78,7 +50,7 @@ class WebSocketDatasource extends Datasource {
 
         if (!isObject(options)) options = {};
         this.setOptions(options);
-        this[webConnectSymbol] = new WebConnect({
+        this[webConnectSymbol] = new NetWebConnect({
             url: self.getOption('url'),
             connection: {
                 timeout: self.getOption('connection.timeout'),
@@ -111,7 +83,7 @@ class WebSocketDatasource extends Datasource {
      * @returns {symbol}
      */
     static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource/websocket");
+        return Symbol.for("@schukai/monster/data/datasource/server/webconnect");
     }
 
     /**
@@ -195,7 +167,6 @@ class WebSocketDatasource extends Datasource {
                 }
 
                 obj = obj.getData();
-
                 obj = self.transformServerPayload.call(self, obj);
                 self.set( obj);
             }
@@ -206,95 +177,6 @@ class WebSocketDatasource extends Datasource {
 
     };
 
-    // const self = this;
-    // let response;
-    //
-    // if (self[webConnectSymbol]?.socket?.readyState !== 1) {
-    //     return Promise.reject('The connection is not established.');
-    // }
-    //
-    // return new Promise((resolve, reject) => {
-    //     if (self[receiveQueueSymbol].isEmpty()) {
-    //         resolve();
-    //     }
-    //
-    //     while (!self[receiveQueueSymbol].isEmpty()) {
-    //
-    //         const event = self[receiveQueueSymbol].poll();
-    //         const body = event?.data;
-    //         if (!body) continue;
-    //
-    //         let obj;
-    //         try {
-    //             obj = JSON.parse(body);
-    //         } catch (e) {
-    //
-    //             let msg = 'the response does not contain a valid json (actual: ';
-    //
-    //             if (body.length > 100) {
-    //                 msg += body.substring(0, 97) + '...';
-    //             } else {
-    //                 msg += body;
-    //             }
-    //
-    //             msg += "; " + e.message + ')';
-    //
-    //             reject(msg);
-    //             return;
-    //         }
-    //
-    //         obj = self.transformServerPayload.call(self, obj);
-    //
-    //
-    //         self.set(obj);
-    //         return response;
-    //     }
-    // })
-//}
-
-    /**
-     * This prepares the data that comes from the server.
-     * Should not be called directly.
-     *
-     * @private
-     * @param {Object} payload
-     * @returns {Object}
-     */
-    transformServerPayload(payload) {
-        const self = this;
-        payload = doTransform.call(self, 'read', payload);
-
-        const dataPath = self.getOption('read.path');
-        if (dataPath) {
-            payload = (new Pathfinder(payload)).getVia(dataPath);
-        }
-
-        return payload;
-    }
-
-    /**
-     * This prepares the data for writing and should not be called directly.
-     *
-     * @private
-     * @param {Object} payload
-     * @returns {Object}
-     */
-    prepareServerPayload(payload) {
-        const self = this;
-
-        payload = doTransform.call(self, 'write', payload);
-
-        let sheathingObject = self.getOption('write.sheathing.object');
-        let sheathingPath = self.getOption('write.sheathing.path');
-
-        if (sheathingObject && sheathingPath) {
-            const sub = payload;
-            payload = sheathingObject;
-            (new Pathfinder(payload)).setVia(sheathingPath, sub);
-        }
-
-        return payload;
-    }
 
     /**
      * @return {Promise}
@@ -305,13 +187,12 @@ class WebSocketDatasource extends Datasource {
         return self[webConnectSymbol].send(obj)
     }
 
-
     /**
      * @return {RestAPI}
      */
     getClone() {
         const self = this;
-        return new WebSocketDatasource(self[internalSymbol].getRealSubject()['options']);
+        return new WebConnect(self[internalSymbol].getRealSubject()['options']);
     }
 
 }

package/source/data/datasource/server.mjs

@@ -0,0 +1,108 @@
+/**
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
+ */
+
+import {internalSymbol,instanceSymbol} from "../../constants.mjs";
+import {isObject} from "../../types/is.mjs";
+import {Datasource} from "../datasource.mjs";
+import {Pathfinder} from "../pathfinder.mjs";
+import {Pipe} from "../pipe.mjs";
+
+export {Server}
+
+/**
+ * Base class for all server datasources
+ *
+ * @license AGPLv3
+ * @since 3.4.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Data.Datasource
+ * @summary The Server class encapsulates the access to a server datasource
+ */
+class Server extends Datasource {
+
+    /**
+     * This method is called by the `instanceof` operator.
+     * @returns {symbol}
+     */
+    static get [instanceSymbol]() {
+        return Symbol.for("@schukai/monster/data/datasource/server");
+    }
+
+
+    /**
+     * This prepares the data that comes from the server.
+     * Should not be called directly.
+     *
+     * @private
+     * @param {Object} payload
+     * @returns {Object}
+     */
+    transformServerPayload(payload) {
+        const self = this;
+        payload = doTransform.call(self, 'read', payload);
+
+        const dataPath = self.getOption('read.path');
+        if (dataPath) {
+            payload = (new Pathfinder(payload)).getVia(dataPath);
+        }
+
+        return payload;
+    }
+
+    /**
+     * This prepares the data for writing and should not be called directly.
+     *
+     * @private
+     * @param {Object} payload
+     * @returns {Object}
+     */
+    prepareServerPayload(payload) {
+        const self = this;
+
+        payload = doTransform.call(self, 'write', payload);
+
+        let sheathingObject = self.getOption('write.sheathing.object');
+        let sheathingPath = self.getOption('write.sheathing.path');
+
+        if (sheathingObject && sheathingPath) {
+            const sub = payload;
+            payload = sheathingObject;
+            (new Pathfinder(payload)).setVia(sheathingPath, sub);
+        }
+
+        return payload;
+    }
+    
+}
+
+
+/**
+ *
+ * @param self
+ * @param obj
+ * @returns {*}
+ */
+function doTransform(type, obj) {
+    const self = this;
+    let transformation = self.getOption(type + '.mapping.transformer');
+    if (transformation !== undefined) {
+        const pipe = new Pipe(transformation);
+        const callbacks = self.getOption(type + '.mapping.callbacks')
+
+        if (isObject(callbacks)) {
+            for (const key in callbacks) {
+                if (callbacks.hasOwnProperty(key) && typeof callbacks[key] === 'function') {
+                    pipe.setCallback(key, callbacks[key]);
+                }
+            }
+        }
+
+        obj = pipe.run(obj);
+    }
+
+    return obj;
+}

package/source/i18n/locale.mjs

@@ -191,7 +191,7 @@ class Locale extends Base {
  *
  * ```
  * <script type="module">
- * import {Monster} from '@schukai/monster/source//monster.mjs';
+ * import {Monster} from '@schukai/monster/source/monster.mjs';
  * new Monster.I18n.createLocale()
  * </script>
  * ```