@schukai/monster 3.51.4 → 3.52.0

package/source/data/datasource/storage.mjs

@@ -15,7 +15,9 @@ export { Storage, storageObjectSymbol };
  * @private
  * @type {symbol}
  */
-const storageObjectSymbol = Symbol.for("@schukai/monster/data/datasource/storage/@@storageObject");
+const storageObjectSymbol = Symbol.for(
+	"@schukai/monster/data/datasource/storage/@@storageObject",
+);
 
 /**
  * The class represents a record.
@@ -27,87 +29,86 @@ const storageObjectSymbol = Symbol.for("@schukai/monster/data/datasource/storage
  * @summary The Storage class encapsulates the access to data objects over WebStorageAPI.
  */
 class Storage extends Datasource {
-    /**
-     *
-     * @param {string} key LocalStorage Key
-     * @throws {TypeError} value is not a string
-     */
-    constructor(key) {
-        super();
-        this.setOption("key", validateString(key));
-    }
+	/**
+	 *
+	 * @param {string} key LocalStorage Key
+	 * @throws {TypeError} value is not a string
+	 */
+	constructor(key) {
+		super();
+		this.setOption("key", validateString(key));
+	}
 
-    /**
-     * 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");
-    }
+	/**
+	 * 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");
+	}
 
-    /**
-     * @property {string} key=undefined LocalStorage Key
-     */
-    get defaults() {
-        return Object.assign({}, super.defaults, {
-            key: undefined,
-        });
-    }
+	/**
+	 * @property {string} key=undefined LocalStorage Key
+	 */
+	get defaults() {
+		return Object.assign({}, super.defaults, {
+			key: undefined,
+		});
+	}
 
-    /**
-     * @throws {Error} this method must be implemented by derived classes.
-     * @return {external:Storage}
-     * @private
-     */
-    [storageObjectSymbol]() {
-        throw new Error("this method must be implemented by derived classes");
-    }
+	/**
+	 * @throws {Error} this method must be implemented by derived classes.
+	 * @return {external:Storage}
+	 * @private
+	 */
+	[storageObjectSymbol]() {
+		throw new Error("this method must be implemented by derived classes");
+	}
 
-    /**
-     * @return {Promise}
-     * @throws {Error} the options does not contain a valid json definition
-     * @throws {TypeError} value is not a object
-     * @throws {Error} the data cannot be read
-     */
-    read() {
-        const self = this;
+	/**
+	 * @return {Promise}
+	 * @throws {Error} the options does not contain a valid json definition
+	 * @throws {TypeError} value is not a object
+	 * @throws {Error} the data cannot be read
+	 */
+	read() {
+		const self = this;
 
-        const storage = self[storageObjectSymbol]();
+		const storage = self[storageObjectSymbol]();
 
-        return new Promise(function (resolve) {
-            const data = JSON.parse(storage.getItem(self.getOption("key")));
-            self.set(data ?? {});
-            resolve();
-        });
-    }
+		return new Promise(function (resolve) {
+			const data = JSON.parse(storage.getItem(self.getOption("key")));
+			self.set(data ?? {});
+			resolve();
+		});
+	}
 
-    /**
-     * @return {Storage}
-     * @throws {Error} the data cannot be written
-     */
-    write() {
-        const self = this;
+	/**
+	 * @return {Storage}
+	 * @throws {Error} the data cannot be written
+	 */
+	write() {
+		const self = this;
 
-        const storage = self[storageObjectSymbol]();
+		const storage = self[storageObjectSymbol]();
 
-        return new Promise(function (resolve) {
-            const data = self.get();
-            if (data === undefined) {
-                storage.removeItem(self.getOption("key"));
-            } else {
-                storage.setItem(self.getOption("key"), JSON.stringify(data));
-            }
+		return new Promise(function (resolve) {
+			const data = self.get();
+			if (data === undefined) {
+				storage.removeItem(self.getOption("key"));
+			} else {
+				storage.setItem(self.getOption("key"), JSON.stringify(data));
+			}
 
-            resolve();
-        });
-    }
+			resolve();
+		});
+	}
 
-    /**
-     * @return {Storage}
-     */
-    getClone() {
-        const self = this;
-        return new Storage(self[internalSymbol].getRealSubject()["options"].key);
-    }
+	/**
+	 * @return {Storage}
+	 */
+	getClone() {
+		return new Storage(this[internalSymbol].getRealSubject()["options"].key);
+	}
 }

package/source/data/datasource.mjs

@@ -34,7 +34,9 @@ export { Datasource };
  * @license AGPLv3
  * @since 1.24.0
  */
-const internalDataSymbol = Symbol.for("@schukai/monster/data/datasource/@@data");
+const internalDataSymbol = Symbol.for(
+	"@schukai/monster/data/datasource/@@data",
+);
 
 /**
  * The datasource class is the basis for dealing with different data sources.
@@ -47,155 +49,160 @@ const internalDataSymbol = Symbol.for("@schukai/monster/data/datasource/@@data")
  * @summary The datasource class encapsulates the access to data objects.
  */
 class Datasource extends Base {
-    /**
-     * creates a new datasource
-     *
-     */
-    constructor() {
-        super();
-
-        this[internalSymbol] = new ProxyObserver({
-            options: extend({}, this.defaults),
-        });
-
-        this[internalDataSymbol] = new ProxyObserver({});
-    }
-
-    /**
-     * 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);
-    }
-
-    /**
-     * Derived classes can override and extend this method as follows.
-     *
-     * ```
-     * get defaults() {
-     *    return Object.assign({}, super.defaults, {
-     *        myValue:true
-     *    });
-     * }
-     * ```
-     */
-    get defaults() {
-        return {};
-    }
-
-    /**
-     * Set option
-     *
-     * @param {string} path
-     * @param {*} value
-     * @return {Datasource}
-     */
-    setOption(path, value) {
-        new Pathfinder(this[internalSymbol].getSubject()["options"]).setVia(path, value);
-        return this;
-    }
-
-    /**
-     * @param {string|object} options
-     * @return {Datasource}
-     * @throws {Error} the options does not contain a valid json definition
-     */
-    setOptions(options) {
-        if (isString(options)) {
-            options = parseOptionsJSON(options);
-        }
-
-        const self = this;
-        extend(self[internalSymbol].getSubject()["options"], self.defaults, options);
-
-        return self;
-    }
-
-    /**
-     * nested options can be specified by path `a.b.c`
-     *
-     * @param {string} path
-     * @param {*} defaultValue
-     * @return {*}
-     */
-    getOption(path, defaultValue) {
-        let value;
-
-        try {
-            value = new Pathfinder(this[internalSymbol].getRealSubject()["options"]).getVia(path);
-        } catch (e) {}
-
-        if (value === undefined) return defaultValue;
-        return value;
-    }
-
-    /**
-     * @throws {Error} this method must be implemented by derived classes.
-     * @return {Promise}
-     */
-    read() {
-        throw new Error("this method must be implemented by derived classes");
-    }
-
-    /**
-     * @throws {Error} this method must be implemented by derived classes.
-     * @return {Promise}
-     */
-    write() {
-        throw new Error("this method must be implemented by derived classes");
-    }
-
-    /**
-     * Returns real object
-     *
-     * @return {Object|Array}
-     */
-    get() {
-        const self = this;
-        return self[internalDataSymbol].getRealSubject();
-    }
-
-    /**
-     * @param {Object|Array} data
-     * @return {Datasource}
-     */
-    set(data) {
-        const self = this;
-        self[internalDataSymbol].setSubject(data);
-        return self;
-    }
-
-    /**
-     * This method is called by the `instanceof` operator.
-     * @returns {symbol}
-     * @since 2.1.0
-     */
-    static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/data/datasource");
-    }
+	/**
+	 * creates a new datasource
+	 *
+	 */
+	constructor() {
+		super();
+
+		this[internalSymbol] = new ProxyObserver({
+			options: extend({}, this.defaults),
+		});
+
+		this[internalDataSymbol] = new ProxyObserver({});
+	}
+
+	/**
+	 * 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);
+	}
+
+	/**
+	 * Derived classes can override and extend this method as follows.
+	 *
+	 * ```
+	 * get defaults() {
+	 *    return Object.assign({}, super.defaults, {
+	 *        myValue:true
+	 *    });
+	 * }
+	 * ```
+	 */
+	get defaults() {
+		return {};
+	}
+
+	/**
+	 * Set option
+	 *
+	 * @param {string} path
+	 * @param {*} value
+	 * @return {Datasource}
+	 */
+	setOption(path, value) {
+		new Pathfinder(this[internalSymbol].getSubject()["options"]).setVia(
+			path,
+			value,
+		);
+		return this;
+	}
+
+	/**
+	 * @param {string|object} options
+	 * @return {Datasource}
+	 * @throws {Error} the options does not contain a valid json definition
+	 */
+	setOptions(options) {
+		if (isString(options)) {
+			options = parseOptionsJSON(options);
+		}
+		extend(
+			this[internalSymbol].getSubject()["options"],
+			this.defaults,
+			options,
+		);
+
+		return this;
+	}
+
+	/**
+	 * nested options can be specified by path `a.b.c`
+	 *
+	 * @param {string} path
+	 * @param {*} defaultValue
+	 * @return {*}
+	 */
+	getOption(path, defaultValue) {
+		let value;
+
+		try {
+			value = new Pathfinder(
+				this[internalSymbol].getRealSubject()["options"],
+			).getVia(path);
+		} catch (e) {}
+
+		if (value === undefined) return defaultValue;
+		return value;
+	}
+
+	/**
+	 * @throws {Error} this method must be implemented by derived classes.
+	 * @return {Promise}
+	 */
+	read() {
+		throw new Error("this method must be implemented by derived classes");
+	}
+
+	/**
+	 * @throws {Error} this method must be implemented by derived classes.
+	 * @return {Promise}
+	 */
+	write() {
+		throw new Error("this method must be implemented by derived classes");
+	}
+
+	/**
+	 * Returns real object
+	 *
+	 * @return {Object|Array}
+	 */
+	get() {
+		return this[internalDataSymbol].getRealSubject();
+	}
+
+	/**
+	 * @param {Object|Array} data
+	 * @return {Datasource}
+	 */
+	set(data) {
+		this[internalDataSymbol].setSubject(data);
+		return this;
+	}
+
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @returns {symbol}
+	 * @since 2.1.0
+	 */
+	static get [instanceSymbol]() {
+		return Symbol.for("@schukai/monster/data/datasource");
+	}
 }
 
 /**
@@ -205,21 +212,23 @@ class Datasource extends Base {
  * @throws {Error} the options does not contain a valid json definition
  */
 function parseOptionsJSON(data) {
-    if (isString(data)) {
-        // the configuration can be specified as a data url.
-        try {
-            let dataUrl = parseDataURL(data);
-            data = dataUrl.content;
-        } catch (e) {}
-
-        try {
-            let obj = JSON.parse(data);
-            validateObject(obj);
-            return obj;
-        } catch (e) {
-            throw new Error(`the options does not contain a valid json definition (actual: ${data}).`);
-        }
-    }
-
-    return {};
+	if (isString(data)) {
+		// the configuration can be specified as a data url.
+		try {
+			const dataUrl = parseDataURL(data);
+			data = dataUrl.content;
+		} catch (e) {}
+
+		try {
+			const obj = JSON.parse(data);
+			validateObject(obj);
+			return obj;
+		} catch (e) {
+			throw new Error(
+				`the options does not contain a valid json definition (actual: ${data}).`,
+			);
+		}
+	}
+
+	return {};
 }