@schukai/monster 3.80.2 → 3.80.4

package/source/components/layout/iframe.mjs

@@ -69,7 +69,7 @@ const timerCallbackSymbol = Symbol("timerCallback");
 class Iframe extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/iframe@@instance");
@@ -191,7 +191,7 @@ function calcHeight() {
 /**
  * Calculate the maximum height of an element based on the window's inner height
  * @param element
- * @returns {*}
+ * @return {*}
  */
 function calculateMaximumHeight(element) {
 	let totalBottomBorder = 0;

package/source/components/layout/panel.mjs

@@ -57,7 +57,7 @@ const timerCallbackSymbol = Symbol("timerCallback");
 class Panel extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/panel");
@@ -84,7 +84,7 @@ class Panel extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Viewer}
+	 * @return {Monster.Components.Host.Viewer}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -152,7 +152,7 @@ function calcHeight() {
 /**
  * Calculate the maximum height of an element based on the window's inner height
  * @param element
- * @returns {*}
+ * @return {*}
  */
 function calculateMaximumHeight(element) {
 	let totalBottomBorder = 0;

package/source/components/layout/popper.mjs

@@ -98,7 +98,7 @@ const arrowElementSymbol = Symbol("arrowElement");
 class Popper extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/popper@@instance");

package/source/components/layout/slider.mjs

@@ -74,7 +74,7 @@ const ATTRIBUTE_CLONE_FROM = ATTRIBUTE_PREFIX + "clone-from";
 class Slider extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/slider@@instance");
@@ -170,7 +170,7 @@ class Slider extends CustomElement {
 	 * moves the slider to the given index
 	 *
 	 * @param index
-	 * @returns {void}
+	 * @return {void}
 	 */
 	moveTo(index) {
 		return moveTo.call(this, index);
@@ -366,7 +366,7 @@ function initCarousel() {
 
 /**
  * @private
- * @returns {{slides: unknown[], totalSlides: number}}
+ * @return {{slides: unknown[], totalSlides: number}}
  */
 function getSlidesAndTotal() {
 	const slides = Array.from(getSlottedElements.call(this, ":scope", null));
@@ -376,7 +376,7 @@ function getSlidesAndTotal() {
 
 /**
  * @private
- * @returns {number}
+ * @return {number}
  */
 function next() {
 	const { slides, totalSlides } = getSlidesAndTotal.call(this);
@@ -399,7 +399,7 @@ function next() {
 
 /**
  * @private
- * @returns {number}
+ * @return {number}
  */
 function prev() {
 	const prevIndex = this[configSymbol].currentIndex - 1;
@@ -584,7 +584,7 @@ function startDragging(e, type) {
  * @private
  * @param e
  * @param type
- * @returns {*|number|number}
+ * @return {*|number|number}
  */
 function getPositionX(e, type) {
 	return type === "mouse" ? e.pageX : e.touches[0].clientX;

package/source/components/layout/split-panel.mjs

@@ -80,7 +80,7 @@ const TYPE_HORIZONTAL = "horizontal";
 class SplitPanel extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/split-panel");
@@ -151,7 +151,7 @@ class SplitPanel extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Viewer}
+	 * @return {Monster.Components.Host.Viewer}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -200,7 +200,7 @@ class SplitPanel extends CustomElement {
 
 /**
  * Set the dimensions of the panel based on the split type.
- * @fires Monster.Components.Layout.event:monster-dimension-changed
+ * @fires monster-dimension-changed
  */
 function applyPanelDimensions() {
 	const splitType = this.getOption("splitType");

package/source/components/layout/tabs.mjs

@@ -154,8 +154,7 @@ const resizeObserverSymbol = Symbol("resizeObserver");
 class Tabs extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
-	 * @since 1.10.0
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/tabs");
@@ -316,7 +315,7 @@ class Tabs extends CustomElement {
 	 *
 	 * The tabs have to be named with the `data-monster-name` attribute.
 	 *
-	 * @returns {string|null}
+	 * @return {string|null}
 	 */
 	getActiveTab() {
 		const nodes = getSlottedElements.call(this);
@@ -664,14 +663,9 @@ function initEventHandler() {
 		}
 	};
 
-	/**
-	 * event:monster-tab-remove
-	 * @event Monster.Components.Layout.event:monster-tab-remove
-	 */
-
 	/**
 	 * @param {Event} event
-	 * @fires Monster.Components.Layout.event:monster-tab-remove
+	 * @fires monster-tab-remove
 	 */
 	this[removeTabEventHandler] = (event) => {
 		const element = findTargetElementFromEvent(

package/source/components/layout/width-toggle.mjs

@@ -70,7 +70,7 @@ const MODE_WIDE = "wide";
 class WidthToggle extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -106,7 +106,7 @@ class WidthToggle extends CustomElement {
 	}
 
 	/**
-	 * @returns {void}
+	 * @return {void}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -126,7 +126,7 @@ class WidthToggle extends CustomElement {
 
 	/**
 	 * @param {string} mode
-	 * @returns {WidthToggle}
+	 * @return {WidthToggle}
 	 * @throws {Error} no shadow-root is defined
 	 */
 	setWidth(mode) {
@@ -143,7 +143,7 @@ class WidthToggle extends CustomElement {
 	}
 
 	/**
-	 * @returns {CSSStyleSheet[]}
+	 * @return {CSSStyleSheet[]}
 	 */
 	static getCSSStyleSheet() {
 		return [WidthToggleStyleSheet];

package/source/components/navigation/table-of-content.mjs

@@ -83,7 +83,7 @@ const scrollableEventHandlerSymbol = Symbol("scrollableEventHandler");
 class TableOfContent extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -354,7 +354,7 @@ function initNavigation() {
  * Recursively creates a nested list (UL) from a list of heading elements.
  * @param {HTMLElement[]} nodeList - The list of heading elements.
  * @param {number} currentLevel - The current heading level we are processing.
- * @returns {{sublist: HTMLUListElement, lastIndex: number}} An object containing the sublist and the index of the last processed element.
+ * @return {{sublist: HTMLUListElement, lastIndex: number}} An object containing the sublist and the index of the last processed element.
  */
 function createListFromHeadings(nodeList, currentLevel = 1) {
 	const self = this;
@@ -409,7 +409,7 @@ function createListFromHeadings(nodeList, currentLevel = 1) {
 
 /**
  * @private
- * @returns {*[]}
+ * @return {*[]}
  */
 function getHeadings() {
 	const allHeadings = [];

package/source/components/notify/message.mjs

@@ -96,7 +96,6 @@ const removeEventHandlerSymbol = Symbol("removeEventHandler");
  * @copyright schukai GmbH
  * @memberOf Monster.Components.Notify
  * @summary A highly configurable select control
- * @fires Monster.Components.Notify.event:monster-xxxx
  */
 class Message extends CustomElement {
 	/**

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(