@schukai/monster 3.71.2 → 3.72.0

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

@@ -12,14 +12,14 @@
  * SPDX-License-Identifier: AGPL-3.0
  */
 
-import {internalSymbol, instanceSymbol} from "../../../constants.mjs";
-import {isObject, isFunction, isArray} from "../../../types/is.mjs";
-import {diff} from "../../diff.mjs";
-import {Server} from "../server.mjs";
-import {WriteError} from "./restapi/writeerror.mjs";
-import {DataFetchError} from "./restapi/data-fetch-error.mjs";
+import { internalSymbol, instanceSymbol } from "../../../constants.mjs";
+import { isObject, isFunction, isArray } from "../../../types/is.mjs";
+import { diff } from "../../diff.mjs";
+import { Server } from "../server.mjs";
+import { WriteError } from "./restapi/writeerror.mjs";
+import { DataFetchError } from "./restapi/data-fetch-error.mjs";
 
-export {RestAPI};
+export { RestAPI };
 
 /**
  * @type {symbol}
@@ -28,10 +28,9 @@ export {RestAPI};
  * @since 3.12.0
  */
 const rawDataSymbol = Symbol.for(
-    "@schukai/monster/data/datasource/server/restapi/rawdata",
+	"@schukai/monster/data/datasource/server/restapi/rawdata",
 );
 
-
 /**
  * The RestAPI is a class that enables a REST API server.
  *
@@ -43,145 +42,146 @@ const rawDataSymbol = Symbol.for(
  * @summary The RestAPI is a class that binds a REST API server.
  */
 class RestAPI extends Server {
-    /**
-     *
-     * @param {Object} [options] options contains definitions for the datasource.
-     */
-    constructor(options) {
-        super();
-
-        if (isObject(options)) {
-            this.setOptions(options);
-        }
-    }
-
-    /**
-     * This method is called by the `instanceof` operator.
-     * @returns {symbol}
-     * @since 2.1.0
-     */
-    static get [instanceSymbol]() {
-        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}
-     * @property {string} write.init.method=POST
-     * @property {Object} write.init.headers Object containing any custom headers that you want to apply to the request.
-     * @property {string} write.responseCallback Callback function to be executed after the request has been completed.
-     * @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 {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.partial
-     * @property {Function} write.partial.callback Callback function to be executed after the request has been completed. (obj, diffResult) => obj
-     * @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 {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, {
-            write: {
-                init: {
-                    method: "POST",
-                },
-                responseCallback: undefined,
-                acceptedStatus: [200, 201],
-                url: null,
-                mapping: {
-                    transformer: undefined,
-                    callbacks: [],
-                },
-                sheathing: {
-                    object: undefined,
-                    path: undefined,
-                },
-                report: {
-                    path: undefined,
-                },
-
-                partial: {
-                    callback: null,
-                }
-            },
-            read: {
-                init: {
-                    method: "GET",
-                },
-                responseCallback: undefined,
-                acceptedStatus: [200],
-                url: null,
-                mapping: {
-                    transformer: undefined,
-                    callbacks: [],
-                },
-            },
-        });
-    }
-
-    /**
-     * @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() {
-        let init = this.getOption("read.init");
-        if (!isObject(init)) init = {};
-        if (!init["method"]) init["method"] = "GET";
-
-        let callback = this.getOption("read.responseCallback");
-        if (!callback) {
-            callback = (obj) => {
-                this.set(this.transformServerPayload.call(this, obj));
-            };
-        }
-
-        return fetchData.call(this, init, "read", callback);
-    }
-
-    /**
-     * @return {Promise}
-     * @throws {WriteError} the data cannot be written
-     */
-    write() {
-        let init = this.getOption("write.init");
-        if (!isObject(init)) init = {};
-        if (typeof init["headers"] !== "object") {
-            init["headers"] = {
-                "Content-Type": "application/json",
-            };
-        }
-        if (!init["method"]) init["method"] = "POST";
-
-        const obj = this.prepareServerPayload(this.get());
-        init["body"] = JSON.stringify(obj);
-
-        const callback = this.getOption("write.responseCallback");
-        return fetchData.call(this, init, "write", callback);
-    }
-
-    /**
-     * @return {RestAPI}
-     */
-    getClone() {
-        return new RestAPI(
-            this[internalSymbol].getRealSubject()["options"].read,
-            this[internalSymbol].getRealSubject()["options"].write,
-        );
-    }
+	/**
+	 *
+	 * @param {Object} [options] options contains definitions for the datasource.
+	 */
+	constructor(options) {
+		super();
+
+		if (isObject(options)) {
+			this.setOptions(options);
+		}
+	}
+
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @returns {symbol}
+	 * @since 2.1.0
+	 */
+	static get [instanceSymbol]() {
+		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}
+	 * @property {string} write.init.method=POST
+	 * @property {Object} write.init.headers Object containing any custom headers that you want to apply to the request.
+	 * @property {string} write.responseCallback Callback function to be executed after the request has been completed.
+	 * @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 {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.partial
+	 * @property {Function} write.partial.callback Callback function to be executed after the request has been completed. (obj, diffResult) => obj
+	 * @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 {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, {
+			write: {
+				init: {
+					method: "POST",
+				},
+				responseCallback: undefined,
+				acceptedStatus: [200, 201],
+				url: null,
+				mapping: {
+					transformer: undefined,
+					callbacks: [],
+				},
+				sheathing: {
+					object: undefined,
+					path: undefined,
+				},
+				report: {
+					path: undefined,
+				},
+
+				partial: {
+					callback: null,
+				},
+			},
+			read: {
+				init: {
+					method: "GET",
+				},
+				path: null,
+				responseCallback: undefined,
+				acceptedStatus: [200],
+				url: null,
+				mapping: {
+					transformer: undefined,
+					callbacks: [],
+				},
+			},
+		});
+	}
+
+	/**
+	 * @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() {
+		let init = this.getOption("read.init");
+		if (!isObject(init)) init = {};
+		if (!init["method"]) init["method"] = "GET";
+
+		let callback = this.getOption("read.responseCallback");
+		if (!callback) {
+			callback = (obj) => {
+				this.set(this.transformServerPayload.call(this, obj));
+			};
+		}
+
+		return fetchData.call(this, init, "read", callback);
+	}
+
+	/**
+	 * @return {Promise}
+	 * @throws {WriteError} the data cannot be written
+	 */
+	write() {
+		let init = this.getOption("write.init");
+		if (!isObject(init)) init = {};
+		if (typeof init["headers"] !== "object") {
+			init["headers"] = {
+				"Content-Type": "application/json",
+			};
+		}
+		if (!init["method"]) init["method"] = "POST";
+
+		const obj = this.prepareServerPayload(this.get());
+		init["body"] = JSON.stringify(obj);
+
+		const callback = this.getOption("write.responseCallback");
+		return fetchData.call(this, init, "write", callback);
+	}
+
+	/**
+	 * @return {RestAPI}
+	 */
+	getClone() {
+		return new RestAPI(
+			this[internalSymbol].getRealSubject()["options"].read,
+			this[internalSymbol].getRealSubject()["options"].write,
+		);
+	}
 }
 
 /**
@@ -192,47 +192,50 @@ class RestAPI extends Server {
  * @returns {Promise<string>}
  */
 function fetchData(init, key, callback) {
-    let response;
-
-    return fetch(this.getOption(`${key}.url`), init)
-        .then((resp) => {
-            response = resp;
-
-            const acceptedStatus = this.getOption(`${key}.acceptedStatus`, [200]).map(Number);
-
-            if (acceptedStatus.indexOf(resp.status) === -1) {
-                throw new DataFetchError(
-                    `the response does not contain an accepted status (actual: ${resp.status}).`,
-                    response,
-                );
-            }
-
-            return resp.text();
-        })
-        .then((body) => {
-            let obj;
-
-            try {
-                obj = JSON.parse(body);
-
-                response[rawDataSymbol] = obj;
-            } catch (e) {
-                if (body.length > 100) {
-                    body = `${body.substring(0, 97)}...`;
-                }
-
-                throw new DataFetchError(
-                    `the response does not contain a valid json (actual: ${body}).`,
-                    response,
-                );
-            }
-
-            if (callback && isFunction(callback)) {
-                callback(obj);
-            }
-
-            return response;
-        }).catch((e) => {
-            throw e;
-        });
+	let response;
+
+	return fetch(this.getOption(`${key}.url`), init)
+		.then((resp) => {
+			response = resp;
+
+			const acceptedStatus = this.getOption(`${key}.acceptedStatus`, [200]).map(
+				Number,
+			);
+
+			if (acceptedStatus.indexOf(resp.status) === -1) {
+				throw new DataFetchError(
+					`the response does not contain an accepted status (actual: ${resp.status}).`,
+					response,
+				);
+			}
+
+			return resp.text();
+		})
+		.then((body) => {
+			let obj;
+
+			try {
+				obj = JSON.parse(body);
+
+				response[rawDataSymbol] = obj;
+			} catch (e) {
+				if (body.length > 100) {
+					body = `${body.substring(0, 97)}...`;
+				}
+
+				throw new DataFetchError(
+					`the response does not contain a valid json (actual: ${body}).`,
+					response,
+				);
+			}
+
+			if (callback && isFunction(callback)) {
+				callback(obj);
+			}
+
+			return response;
+		})
+		.catch((e) => {
+			throw e;
+		});
 }

package/source/data/datasource/server.mjs

@@ -12,15 +12,14 @@
  * SPDX-License-Identifier: AGPL-3.0
  */
 
-import {instanceSymbol} from "../../constants.mjs";
-import {isArray, isFunction, isObject} from "../../types/is.mjs";
-import {Datasource} from "../datasource.mjs";
-import {diff} from "../diff.mjs";
-import {Pathfinder} from "../pathfinder.mjs";
-import {Pipe} from "../pipe.mjs";
-
-export {Server};
+import { instanceSymbol } from "../../constants.mjs";
+import { isArray, isFunction, isObject } from "../../types/is.mjs";
+import { Datasource } from "../datasource.mjs";
+import { diff } from "../diff.mjs";
+import { Pathfinder } from "../pathfinder.mjs";
+import { Pipe } from "../pipe.mjs";
 
+export { Server };
 
 /**
  * @private
@@ -38,82 +37,85 @@ const serverVersionSymbol = Symbol("serverVersion");
  * @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) {
-        payload = doTransform.call(this, "read", payload);
-        this[serverVersionSymbol] = payload;
-
-        const dataPath = this.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) {
-        payload = doTransform.call(this, "write", payload);
-        payload = doDiff.call(this, payload);
-
-        const sheathingObject = this.getOption("write.sheathing.object");
-        const sheathingPath = this.getOption("write.sheathing.path");
-
-        if (sheathingObject && sheathingPath) {
-            const sub = payload;
-            payload = sheathingObject;
-            new Pathfinder(payload).setVia(sheathingPath, sub);
-        }
-
-        return payload;
-    }
+	/**
+	 * 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) {
+		payload = doTransform.call(this, "read", payload);
+		this[serverVersionSymbol] = payload;
+
+		const dataPath = this.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) {
+		payload = doTransform.call(this, "write", payload);
+		payload = doDiff.call(this, payload);
+
+		const sheathingObject = this.getOption("write.sheathing.object");
+		const sheathingPath = this.getOption("write.sheathing.path");
+
+		if (sheathingObject && sheathingPath) {
+			const sub = payload;
+			payload = sheathingObject;
+			new Pathfinder(payload).setVia(sheathingPath, sub);
+		}
+
+		return payload;
+	}
 }
 
 /**
- * 
+ *
  * @param obj
  * @returns {*}
  */
 function doDiff(obj) {
-    if (this[serverVersionSymbol] === null || this[serverVersionSymbol] === undefined) {
-        return obj;
-    }
-
-    const callback = this.getOption("write.partial.callback");
-    if (!isFunction(callback)) {
-        return obj;
-    }
-
-    const results = diff(this[serverVersionSymbol], obj);
-    if (!results) {
-        return obj;
-    }
-
-    obj = callback(obj, results);
-    this[serverVersionSymbol] = obj;
-
-    return obj;
+	if (
+		this[serverVersionSymbol] === null ||
+		this[serverVersionSymbol] === undefined
+	) {
+		return obj;
+	}
+
+	const callback = this.getOption("write.partial.callback");
+	if (!isFunction(callback)) {
+		return obj;
+	}
+
+	const results = diff(this[serverVersionSymbol], obj);
+	if (!results) {
+		return obj;
+	}
+
+	obj = callback(obj, results);
+	this[serverVersionSymbol] = obj;
+
+	return obj;
 }
 
 /**
@@ -123,32 +125,32 @@ function doDiff(obj) {
  * @returns {Object}
  */
 function doTransform(type, obj) {
-    const transformation = this.getOption(`${type}.mapping.transformer`);
-    if (transformation !== undefined && transformation !== null) {
-        const pipe = new Pipe(transformation);
-        const callbacks = this.getOption(`${type}.mapping.callbacks`);
-
-        if (isArray(callbacks)) {
-            for (const callback of callbacks) {
-                if (typeof callback === "function") {
-                    pipe.setCallback(callback);
-                }
-            }
-        }
-
-        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;
+	const transformation = this.getOption(`${type}.mapping.transformer`);
+	if (transformation !== undefined && transformation !== null) {
+		const pipe = new Pipe(transformation);
+		const callbacks = this.getOption(`${type}.mapping.callbacks`);
+
+		if (isArray(callbacks)) {
+			for (const callback of callbacks) {
+				if (typeof callback === "function") {
+					pipe.setCallback(callback);
+				}
+			}
+		}
+
+		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/data/diff.mjs

@@ -183,4 +183,4 @@ function getOperator(a, b) {
 	}
 
 	return operator;
-}
+}