@schukai/monster 3.80.2 → 3.80.3

package/source/components/state/log/entry.mjs

@@ -55,7 +55,7 @@ class Entry extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/component-state/log/entry");
@@ -63,7 +63,7 @@ class Entry extends Base {
 
 	/**
 	 *
-	 * @returns {object}
+	 * @return {object}
 	 */
 	get internalDefaults() {
 		return {
@@ -75,7 +75,7 @@ class Entry extends Base {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get title() {
 		return this.getInternal("title");
@@ -89,7 +89,7 @@ class Entry extends Base {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get message() {
 		return this.getInternal("message");
@@ -103,7 +103,7 @@ class Entry extends Base {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get user() {
 		return this.getInternal("user");
@@ -117,7 +117,7 @@ class Entry extends Base {
 	}
 
 	/**
-	 * @returns {Date}
+	 * @return {Date}
 	 */
 	get date() {
 		return this.getInternal("date");

package/source/components/state/log.mjs

@@ -38,47 +38,11 @@ const logElementSymbol = Symbol("logElement");
  */
 const emptyStateElementSymbol = Symbol("emptyStateElement");
 
-/**
- * Log is a control to show a log message.
- *
- * <img src="./images/log.png">
- *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- *
- * You can create this control either by specifying the HTML tag <monster-state />` directly in the HTML or using
- * Javascript via the `document.createElement('monster-state');` method.
- *
- * ```html
- * <monster-log></monster-log>
- * ```
- *
- * Or you can create this CustomControl directly in Javascript:
- *
- * ```js
- * import {Log} from '@schukai/component-state/source/log.js';
- * document.createElement('monster-log');
- * ```
- *
- * @externalExample ../../../example/components/state/log.mjs
- * @startuml log.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- Log
- * @enduml
- *
- * @copyright schukai GmbH
- * @memberOf Monster.Components.State
- * @summary Log is a control to show a log message.
- */
-
 /**
  * A Log component
  *
  * @fragments /fragments/components/layout/collapse/
  *
- * @example /examples/components/layout/collapse-simple
- *
  * @since 3.74.0
  * @copyright schukai GmbH
  * @summary A Log component to show a log message.
@@ -96,7 +60,7 @@ class Log extends CustomElement {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/state/log@@instance");
@@ -153,7 +117,7 @@ class Log extends CustomElement {
 	/**
 	 * Add an entry to the log
 	 * @param entry
-	 * @returns {Log}
+	 * @return {Log}
 	 */
 	addEntry(entry) {
 		validateInstance(entry, Entry);
@@ -171,7 +135,7 @@ class Log extends CustomElement {
 	 * Add a log message
 	 * @param message
 	 * @param date
-	 * @returns {Log}
+	 * @return {Log}
 	 */
 	addMessage(message, date) {
 		if (!date) {

package/source/components/state/state.mjs

@@ -50,7 +50,7 @@ class State extends CustomControl {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/state/state@@instance");

package/source/components/tree-menu/dragable-tree-menu.mjs

@@ -128,7 +128,7 @@
 //  * @copyright schukai GmbH
 //  * @memberOf Monster.Components.TreeMenu
 //  * @summary A TreeMenu control
-//  * @fires Monster.Components.TreeMenu.event:monster-fetched
+//  * @fires monster-fetched
 //  */
 // class TreeMenu extends CustomElement {
 // 	/**
@@ -613,7 +613,7 @@
 // //  * @throws {Error} request failed
 // //  * @throws {Error} not found
 // //  * @throws {Error} undefined status or type
-// //  * @fires Monster.Components.TreeMenu.event:monster-fetched
+// //  * @fires monster-fetched
 // //  */
 // // function initIntersectionObserver() {
 // //     const self = this;

package/source/components/tree-menu/tree-menu.mjs

@@ -80,7 +80,7 @@ const openEntryEventHandlerSymbol = Symbol("openEntryEventHandler");
 class TreeMenu extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/tree-menu@@instance");

package/source/constraints/abstract.mjs

@@ -37,7 +37,7 @@ class AbstractConstraint extends Base {
 	 * this method must return a promise containing the result of the check.
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		return Promise.reject(value);
@@ -45,7 +45,7 @@ class AbstractConstraint extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/abstractoperator.mjs

@@ -55,7 +55,7 @@ class AbstractOperator extends AbstractConstraint {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/andoperator.mjs

@@ -23,19 +23,19 @@ export { AndOperator };
  *
  * The AndOperator is used to link several constraints. The constraint is fulfilled if all constraints of the operators are fulfilled.
  *
- * @externalExample ../../example/constraints/andoperator.mjs
+ * @example /examples/libraries/constraints/andoperator/ A simple example
+ *
  * @license AGPLv3
  * @since 1.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Constraints
  * @summary A and operator constraint
  */
 class AndOperator extends AbstractOperator {
 	/**
-	 * this method return a promise containing the result of the check.
+	 * This method returns a promise containing the result of the check.
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		return Promise.all([
@@ -46,7 +46,7 @@ class AndOperator extends AbstractOperator {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/invalid.mjs

@@ -23,19 +23,19 @@ export { Invalid };
  *
  * The invalid constraint allows an always invalid query to be performed. this constraint is mainly intended for testing.
  *
- * @externalExample ../../example/constraints/invalid.mjs
+ * @example /examples/libraries/constraints/invalid/ A simple example
+ *
  * @license AGPLv3
  * @since 1.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Constraints
  * @summary A constraint that always invalid
  */
 class Invalid extends AbstractConstraint {
 	/**
-	 * this method return a rejected promise
+	 * this method returns a rejected promise
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		return Promise.reject(value);
@@ -43,7 +43,7 @@ class Invalid extends AbstractConstraint {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/isarray.mjs

@@ -22,19 +22,19 @@ export { IsArray };
  *
  * The uniform API of the constraints allows chains to be formed.
  *
- * @externalExample ../../example/constraints/isarray.mjs
+ * @example /examples/libraries/constraints/isarray/ A simple example
+ *
  * @license AGPLv3
  * @since 1.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Constraints
  * @summary A constraint to check if a value is an array
  */
 class IsArray extends AbstractConstraint {
 	/**
-	 * this method return a promise containing the result of the check.
+	 * this method returns a promise containing the result of the check.
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		if (isArray(value)) {
@@ -46,7 +46,7 @@ class IsArray extends AbstractConstraint {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/isobject.mjs

@@ -22,19 +22,19 @@ export { IsObject };
  *
  * The uniform API of the constraints allows chains to be formed.
  *
- * @externalExample ../../example/constraints/isobject.mjs
+ * @example /examples/libraries/constraints/isobject/ A simple example
+ *
  * @license AGPLv3
  * @since 1.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Constraints
  * @summary A constraint to check if a value is an object
  */
 class IsObject extends AbstractConstraint {
 	/**
-	 * this method return a promise containing the result of the check.
+	 * this method returns a promise containing the result of the check.
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		if (isObject(value)) {
@@ -46,7 +46,7 @@ class IsObject extends AbstractConstraint {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/oroperator.mjs

@@ -23,19 +23,19 @@ export { OrOperator };
  *
  * The OrOperator is used to link several constraints. The constraint is fulfilled if one of the constraints is fulfilled.
  *
- * @externalExample ../../example/constraints/oroperator.mjs
+ * @example /examples/libraries/constraints/oroperator/ A simple example
+ *
  * @license AGPLv3
  * @since 1.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Constraints
  * @summary A or operator
  */
 class OrOperator extends AbstractOperator {
 	/**
-	 * this method return a promise containing the result of the check.
+	 * this method returns a promise containing the result of the check.
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		var self = this;
@@ -74,7 +74,7 @@ class OrOperator extends AbstractOperator {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/constraints/valid.mjs

@@ -23,11 +23,11 @@ export { Valid };
  *
  * The valid constraint allows an always valid query to be performed. this constraint is mainly intended for testing.
  *
- * @externalExample ../../example/constraints/valid.mjs
+ * @example /examples/libraries/constraints/valid/ A simple example
+ *
  * @license AGPLv3
  * @since 1.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Constraints
  * @summary A constraint that always valid
  */
 class Valid extends AbstractConstraint {
@@ -35,7 +35,7 @@ class Valid extends AbstractConstraint {
 	 * this method return a promise containing the result of the check.
 	 *
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	isValid(value) {
 		return Promise.resolve(value);
@@ -43,7 +43,7 @@ class Valid extends AbstractConstraint {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/data/buildmap.mjs

@@ -33,9 +33,10 @@ const PARENT = "^";
  * The templates determine the appearance of the keys and the value of the map. Either a single value
  * id can be taken or a composite key ${id} ${name} can be used.
  *
- * If you want to access values of the parent data set, you have to use the ^ character, for example ${id} ${^.name}.
+ * If you want to access the values of the parent data set, you have to use the ^ character, for example, ${id} ${^.name}.
  *
  * @externalExample ../../example/data/buildmap.mjs
+ *
  * @param {*} subject - The data object from which the map will be created
  * @param {string|Monster.Data~exampleSelectorCallback} selector - The path to the data object, or a callback that returns a map.
  * @param {string} [valueTemplate] - A template for the value of the map.

package/source/data/datasource/dom.mjs

@@ -40,7 +40,7 @@ class DomStorage extends Datasource {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/data/datasource/storage/dom-storage");

package/source/data/datasource/server/restapi/data-fetch-error.mjs

@@ -40,7 +40,7 @@ class DataFetchError extends Error {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

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

@@ -42,7 +42,7 @@ class WriteError extends Error {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

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

@@ -56,7 +56,7 @@ class RestAPI extends Server {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -189,7 +189,7 @@ class RestAPI extends Server {
  * @param init
  * @param key
  * @param callback
- * @returns {Promise<string>}
+ * @return {Promise<string>}
  */
 function fetchData(init, key, callback) {
 	let response;

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

@@ -67,14 +67,14 @@ class WebConnect extends Server {
 
 	/**
 	 *
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	connect() {
 		return this[webConnectSymbol].connect();
 	}
 
 	/**
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	isConnected() {
 		return this[webConnectSymbol].isConnected();
@@ -82,7 +82,7 @@ class WebConnect extends Server {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/data/datasource/server/webconnect");
@@ -142,7 +142,7 @@ class WebConnect extends Server {
 	/**
 	 * This method closes the connection.
 	 *
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	close() {
 		return this[webConnectSymbol].close();

package/source/data/datasource/server.mjs

@@ -39,7 +39,7 @@ const serverVersionSymbol = Symbol("serverVersion");
 class Server extends Datasource {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/data/datasource/server");
@@ -51,7 +51,7 @@ class Server extends Datasource {
 	 *
 	 * @private
 	 * @param {Object} payload
-	 * @returns {Object}
+	 * @return {Object}
 	 */
 	transformServerPayload(payload) {
 		payload = doTransform.call(this, "read", payload);
@@ -70,7 +70,7 @@ class Server extends Datasource {
 	 *
 	 * @private
 	 * @param {Object} payload
-	 * @returns {Object}
+	 * @return {Object}
 	 */
 	prepareServerPayload(payload) {
 		payload = doTransform.call(this, "write", payload);
@@ -92,7 +92,7 @@ class Server extends Datasource {
 /**
  *
  * @param obj
- * @returns {*}
+ * @return {*}
  */
 function doDiff(obj) {
 	if (
@@ -122,7 +122,7 @@ function doDiff(obj) {
  * @private
  * @param {string} type
  * @param {Object} obj
- * @returns {Object}
+ * @return {Object}
  */
 function doTransform(type, obj) {
 	const transformation = this.getOption(`${type}.mapping.transformer`);

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

@@ -40,7 +40,7 @@ class LocalStorage extends Storage {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

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

@@ -40,7 +40,7 @@ class SessionStorage extends Storage {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/data/datasource/storage.mjs

@@ -48,7 +48,7 @@ class Storage extends Datasource {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/data/datasource.mjs

@@ -52,7 +52,6 @@ const internalDataSymbol = Symbol.for(
  * @license AGPLv3
  * @since 1.22.0
  * @copyright schukai GmbH
- * @memberOf Monster.Data
  * @summary The datasource class encapsulates the access to data objects.
  */
 class Datasource extends Base {
@@ -74,7 +73,7 @@ class Datasource extends Base {
 	 * attach a new observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {Datasource}
+	 * @return {Datasource}
 	 */
 	attachObserver(observer) {
 		this[internalDataSymbol].attachObserver(observer);
@@ -85,7 +84,7 @@ class Datasource extends Base {
 	 * detach a observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {Datasource}
+	 * @return {Datasource}
 	 */
 	detachObserver(observer) {
 		this[internalDataSymbol].detachObserver(observer);
@@ -94,7 +93,7 @@ class Datasource extends Base {
 
 	/**
 	 * @param {Observer} observer
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	containsObserver(observer) {
 		return this[internalDataSymbol].containsObserver(observer);
@@ -204,7 +203,7 @@ class Datasource extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/data/pathfinder.mjs

@@ -81,12 +81,13 @@ const WILDCARD = "*";
  * new Pathfinder(obj).setVia('a.b.0.c', true); // ↦ {a:{b:[{c:true}]}}
  * ```
  *
- * @externalExample ../../example/data/pathfinder-1.mjs
- * @externalExample ../../example/data/pathfinder-2.mjs
+ * @example /examples/libraries/pathfinder/example-1/ Example 1
+ * @example /examples/libraries/pathfinder/example-2/ Example 2
+ *
  * @license AGPLv3
  * @since 1.4.0
  * @copyright schukai GmbH
- * @memberOf Monster.Data
+ * @summary Pathfinder is a class to find a path to an object.
  */
 class Pathfinder extends Base {
 	/**
@@ -124,7 +125,7 @@ class Pathfinder extends Base {
 	 *
 	 * @param {string|array} path
 	 * @since 1.4.0
-	 * @returns {*}
+	 * @return {*}
 	 * @throws {TypeError} unsupported type
 	 * @throws {Error} the journey is not at its end
 	 * @throws {TypeError} value is not a string
@@ -139,7 +140,7 @@ class Pathfinder extends Base {
 	 *
 	 * @param {string|array} path
 	 * @param {*} value
-	 * @returns {Pathfinder}
+	 * @return {Pathfinder}
 	 * @since 1.4.0
 	 * @throws {TypeError} unsupported type
 	 * @throws {TypeError} value is not a string
@@ -155,7 +156,7 @@ class Pathfinder extends Base {
 	 * Delete Via Path
 	 *
 	 * @param {string|array} path
-	 * @returns {Pathfinder}
+	 * @return {Pathfinder}
 	 * @since 1.6.0
 	 * @throws {TypeError} unsupported type
 	 * @throws {TypeError} value is not a string
@@ -226,7 +227,7 @@ function iterate(subject, path, check) {
  * @param subject
  * @param path
  * @param check
- * @returns {V|*|Map}
+ * @return {V|*|Map}
  * @throws {TypeError} unsupported type
  * @throws {Error} the journey is not at its end
  * @throws {Error} unsupported action for this data type
@@ -306,7 +307,7 @@ function getValueViaPath(subject, path, check) {
  * @param {object} subject
  * @param {string|array} path
  * @param {*} value
- * @returns {void}
+ * @return {void}
  * @throws {TypeError} unsupported type
  * @throws {TypeError} unsupported type
  * @throws {Error} the journey is not at its end
@@ -405,7 +406,7 @@ function assignProperty(object, key, value) {
  *
  * @param {object} subject
  * @param {string} path
- * @returns {void}
+ * @return {void}
  * @throws {TypeError} unsupported type
  * @throws {TypeError} unsupported type
  * @throws {Error} the journey is not at its end