@schukai/monster 3.51.5 → 3.52.1

package/source/data/datasource/server/webconnect.mjs

@@ -15,7 +15,7 @@ export { WebConnect };
 
 /**
  * @private
- * @type {Symbol}
+ * @type {symbol}
  *
  * hint: this name is used in the tests. if you want to change it, please change it in the tests as well.
  */
@@ -32,159 +32,153 @@ const webConnectSymbol = Symbol("connection");
  * @summary The LocalStorage class encapsulates the access to data objects.
  */
 class WebConnect extends Server {
-    /**
-     *
-     * @param {Object} [options] options contains definitions for the datasource.
-     */
-    constructor(options) {
-        super();
-
-        const self = this;
-
-        if (isString(options)) {
-            options = { url: options };
-        }
-
-        if (!isObject(options)) options = {};
-        this.setOptions(options);
-        this[webConnectSymbol] = new NetWebConnect({
-            url: self.getOption("url"),
-            connection: {
-                timeout: self.getOption("connection.timeout"),
-                reconnect: {
-                    timeout: self.getOption("connection.reconnect.timeout"),
-                    attempts: self.getOption("connection.reconnect.attempts"),
-                    enabled: self.getOption("connection.reconnect.enabled"),
-                },
-            },
-        });
-    }
-
-    /**
-     *
-     * @returns {Promise}
-     */
-    connect() {
-        return this[webConnectSymbol].connect();
-    }
-
-    /**
-     * @returns {boolean}
-     */
-    isConnected() {
-        return this[webConnectSymbol].isConnected();
-    }
-
-    /**
-     * This method is called by the `instanceof` operator.
-     * @returns {symbol}
-     */
-    static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource/server/webconnect");
-    }
-
-    /**
-     * @property {string} url=undefined Defines the resource that you wish to fetch.
-     * @property {Object} connection
-     * @property {Object} connection.timeout=5000 Defines the timeout for the connection.
-     * @property {Number} connection.reconnect.timeout The timeout in milliseconds for the reconnect.
-     * @property {Number} connection.reconnect.attempts The maximum number of reconnects.
-     * @property {Bool} connection.reconnect.enabled If the reconnect is enabled.
-     * @property {Object} write={} Options
-     * @property {Object} write.mapping the mapping is applied before writing.
-     * @property {String} write.mapping.transformer Transformer to select the appropriate entries
-     * @property {Monster.Data.Datasource~exampleCallback[]} write.mapping.callback with the help of the callback, the structures can be adjusted before writing.
-     * @property {Object} write.sheathing
-     * @property {Object} write.sheathing.object Object to be wrapped
-     * @property {string} write.sheathing.path Path to the data
-     * @property {Object} read={} Options
-     * @property {String} read.path Path to data
-     * @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, {
-            url: undefined,
-            write: {
-                mapping: {
-                    transformer: undefined,
-                    callbacks: {},
-                },
-                sheathing: {
-                    object: undefined,
-                    path: undefined,
-                },
-            },
-            read: {
-                mapping: {
-                    transformer: undefined,
-                    callbacks: {},
-                },
-                path: undefined,
-            },
-            connection: {
-                timeout: 5000,
-                reconnect: {
-                    timeout: 1000,
-                    attempts: 1,
-                    enabled: false,
-                },
-            },
-        });
-    }
-
-    /**
-     * This method closes the connection.
-     *
-     * @returns {Promise}
-     */
-    close() {
-        return this[webConnectSymbol].close();
-    }
-
-    /**
-     * @return {Promise}
-     */
-    read() {
-        const self = this;
-
-        return new Promise((resolve, reject) => {
-            while (this[webConnectSymbol].dataReceived() === true) {
-                let obj = this[webConnectSymbol].poll();
-                if (!isObject(obj)) {
-                    reject(new Error("The received data is not an object."));
-                    return;
-                }
-
-                if (!(obj instanceof Message)) {
-                    reject(new Error("The received data is not a Message."));
-                    return;
-                }
-
-                obj = obj.getData();
-                obj = self.transformServerPayload.call(self, obj);
-                self.set(obj);
-            }
-
-            resolve(self.get());
-        });
-    }
-
-    /**
-     * @return {Promise}
-     */
-    write() {
-        const self = this;
-        let obj = self.prepareServerPayload(self.get());
-        return self[webConnectSymbol].send(obj);
-    }
-
-    /**
-     * @return {RestAPI}
-     */
-    getClone() {
-        const self = this;
-        return new WebConnect(self[internalSymbol].getRealSubject()["options"]);
-    }
+	/**
+	 *
+	 * @param {Object} [options] options contains definitions for the datasource.
+	 */
+	constructor(options) {
+		super();
+
+		if (isString(options)) {
+			options = { url: options };
+		}
+
+		if (!isObject(options)) options = {};
+		this.setOptions(options);
+		this[webConnectSymbol] = new NetWebConnect({
+			url: this.getOption("url"),
+			connection: {
+				timeout: this.getOption("connection.timeout"),
+				reconnect: {
+					timeout: this.getOption("connection.reconnect.timeout"),
+					attempts: this.getOption("connection.reconnect.attempts"),
+					enabled: this.getOption("connection.reconnect.enabled"),
+				},
+			},
+		});
+	}
+
+	/**
+	 *
+	 * @returns {Promise}
+	 */
+	connect() {
+		return this[webConnectSymbol].connect();
+	}
+
+	/**
+	 * @returns {boolean}
+	 */
+	isConnected() {
+		return this[webConnectSymbol].isConnected();
+	}
+
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @returns {symbol}
+	 */
+	static get [instanceSymbol]() {
+		return Symbol.for("@schukai/monster/data/datasource/server/webconnect");
+	}
+
+	/**
+	 * @property {string} url=undefined Defines the resource that you wish to fetch.
+	 * @property {Object} connection
+	 * @property {Object} connection.timeout=5000 Defines the timeout for the connection.
+	 * @property {Number} connection.reconnect.timeout The timeout in milliseconds for the reconnect.
+	 * @property {Number} connection.reconnect.attempts The maximum number of reconnects.
+	 * @property {Bool} connection.reconnect.enabled If the reconnect is enabled.
+	 * @property {Object} write={} Options
+	 * @property {Object} write.mapping the mapping is applied before writing.
+	 * @property {String} write.mapping.transformer Transformer to select the appropriate entries
+	 * @property {Monster.Data.Datasource~exampleCallback[]} write.mapping.callback with the help of the callback, the structures can be adjusted before writing.
+	 * @property {Object} write.sheathing
+	 * @property {Object} write.sheathing.object Object to be wrapped
+	 * @property {string} write.sheathing.path Path to the data
+	 * @property {Object} read={} Options
+	 * @property {String} read.path Path to data
+	 * @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, {
+			url: undefined,
+			write: {
+				mapping: {
+					transformer: undefined,
+					callbacks: {},
+				},
+				sheathing: {
+					object: undefined,
+					path: undefined,
+				},
+			},
+			read: {
+				mapping: {
+					transformer: undefined,
+					callbacks: {},
+				},
+				path: undefined,
+			},
+			connection: {
+				timeout: 5000,
+				reconnect: {
+					timeout: 1000,
+					attempts: 1,
+					enabled: false,
+				},
+			},
+		});
+	}
+
+	/**
+	 * This method closes the connection.
+	 *
+	 * @returns {Promise}
+	 */
+	close() {
+		return this[webConnectSymbol].close();
+	}
+
+	/**
+	 * @return {Promise}
+	 */
+	read() {
+		return new Promise((resolve, reject) => {
+			while (this[webConnectSymbol].dataReceived() === true) {
+				let obj = this[webConnectSymbol].poll();
+				if (!isObject(obj)) {
+					reject(new Error("The received data is not an object."));
+					return;
+				}
+
+				if (!(obj instanceof Message)) {
+					reject(new Error("The received data is not a Message."));
+					return;
+				}
+
+				obj = obj.getData();
+				obj = this.transformServerPayload.call(this, obj);
+				this.set(obj);
+			}
+
+			resolve(this.get());
+		});
+	}
+
+	/**
+	 * @return {Promise}
+	 */
+	write() {
+		const obj = this.prepareServerPayload(this.get());
+		return this[webConnectSymbol].send(obj);
+	}
+
+	/**
+	 * @return {RestAPI}
+	 */
+	getClone() {
+		return new WebConnect(this[internalSymbol].getRealSubject()["options"]);
+	}
 }

package/source/data/datasource/server.mjs

@@ -14,7 +14,7 @@ import { Pipe } from "../pipe.mjs";
 export { Server };
 
 /**
- * Base class for all server datasources
+ * Base class for all server data sources
  *
  * @license AGPLv3
  * @since 3.4.0
@@ -23,82 +23,81 @@ export { Server };
  * @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 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);
+	/**
+	 * This prepares the data that comes from the server.
+	 * Should not be called directly.
+	 *
+	 * @private
+	 * @param {Object} payload
+	 * @returns {Object}
+	 */
+	transformServerPayload(payload) {
+		payload = doTransform.call(this, "read", payload);
 
-        const dataPath = self.getOption("read.path");
-        if (dataPath) {
-            payload = new Pathfinder(payload).getVia(dataPath);
-        }
+		const dataPath = this.getOption("read.path");
+		if (dataPath) {
+			payload = new Pathfinder(payload).getVia(dataPath);
+		}
 
-        return payload;
-    }
+		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;
+	/**
+	 * This prepares the data for writing and should not be called directly.
+	 *
+	 * @private
+	 * @param {Object} payload
+	 * @returns {Object}
+	 */
+	prepareServerPayload(payload) {
+		payload = doTransform.call(this, "write", payload);
 
-        payload = doTransform.call(self, "write", payload);
+		const sheathingObject = this.getOption("write.sheathing.object");
+		const sheathingPath = this.getOption("write.sheathing.path");
 
-        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);
+		}
 
-        if (sheathingObject && sheathingPath) {
-            const sub = payload;
-            payload = sheathingObject;
-            new Pathfinder(payload).setVia(sheathingPath, sub);
-        }
-
-        return payload;
-    }
+		return payload;
+	}
 }
 
 /**
  * @private
- * @param self
- * @param obj
- * @returns {*}
+ * @param {string} type
+ * @param {Object} obj
+ * @returns {Object}
  */
 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`);
+	const transformation = this.getOption(`${type}.mapping.transformer`);
+	if (transformation !== undefined) {
+		const pipe = new Pipe(transformation);
+		const callbacks = this.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]);
-                }
-            }
-        }
+		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);
-    }
+		obj = pipe.run(obj);
+	}
 
-    return obj;
+	return obj;
 }

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

@@ -22,30 +22,31 @@ export { LocalStorage };
  * @summary The LocalStorage class encapsulates the access to data objects.
  */
 class LocalStorage extends Storage {
-    /**
-     * @throws {Error} this method must be implemented by derived classes.
-     * @return {external:localStorage}
-     * @private
-     */
-    [storageObjectSymbol]() {
-        return getGlobalObject("localStorage");
-    }
+	/**
+	 * @throws {Error} this method must be implemented by derived classes.
+	 * @return {external:localStorage}
+	 * @private
+	 */
+	[storageObjectSymbol]() {
+		return getGlobalObject("localStorage");
+	}
 
-    /**
-     * This method is called by the `instanceof` operator.
-     * @returns {symbol}
-     * @since 2.1.0
-     */
-    static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource/storage/localstorage");
-    }
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @returns {symbol}
+	 * @since 2.1.0
+	 */
+	static get [instanceSymbol]() {
+		return Symbol.for("@schukai/monster/data/datasource/storage/localstorage");
+	}
 
-    /**
-     * Create clone
-     * @return {LocalStorage}
-     */
-    getClone() {
-        const self = this;
-        return new LocalStorage(self[internalSymbol].getRealSubject()["options"].key);
-    }
+	/**
+	 * Create clone
+	 * @return {LocalStorage}
+	 */
+	getClone() {
+		return new LocalStorage(
+			this[internalSymbol].getRealSubject()["options"].key,
+		);
+	}
 }

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

@@ -22,31 +22,34 @@ export { SessionStorage };
  * @summary The LocalStorage class encapsulates the access to data objects.
  */
 class SessionStorage extends Storage {
-    /**
-     * @throws {Error} this method must be implemented by derived classes.
-     * @return {external:sessionStorage}
-     * @private
-     */
-    [storageObjectSymbol]() {
-        return getGlobalObject("sessionStorage");
-    }
+	/**
+	 * @throws {Error} this method must be implemented by derived classes.
+	 * @return {external:sessionStorage}
+	 * @private
+	 */
+	[storageObjectSymbol]() {
+		return getGlobalObject("sessionStorage");
+	}
 
-    /**
-     * This method is called by the `instanceof` operator.
-     * @returns {symbol}
-     * @since 2.1.0
-     */
-    static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource/storage/session-storage");
-    }
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @returns {symbol}
+	 * @since 2.1.0
+	 */
+	static get [instanceSymbol]() {
+		return Symbol.for(
+			"@schukai/monster/data/datasource/storage/session-storage",
+		);
+	}
 
-    /**
-     * Create Clone
-     *
-     * @return {SessionStorage}
-     */
-    getClone() {
-        const self = this;
-        return new SessionStorage(self[internalSymbol].getRealSubject()["options"].key);
-    }
+	/**
+	 * Create Clone
+	 *
+	 * @return {SessionStorage}
+	 */
+	getClone() {
+		return new SessionStorage(
+			this[internalSymbol].getRealSubject()["options"].key,
+		);
+	}
 }