@schukai/monster 3.80.1 → 3.80.3

package/source/dom/resource/link.mjs

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

package/source/dom/resource/script.mjs

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

package/source/dom/template.mjs

@@ -48,7 +48,7 @@ class Template extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -57,7 +57,7 @@ class Template extends Base {
 
 	/**
 	 *
-	 * @returns {HTMLTemplateElement}
+	 * @return {HTMLTemplateElement}
 	 */
 	getTemplateElement() {
 		return this.template;

package/source/dom/theme.mjs

@@ -43,7 +43,7 @@ class Theme extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -52,7 +52,7 @@ class Theme extends Base {
 
 	/**
 	 *
-	 * @returns {string}
+	 * @return {string}
 	 */
 	getName() {
 		return this.name;

package/source/dom/updater.mjs

@@ -54,11 +54,11 @@ export { Updater, addObjectWithUpdaterToElement };
  * to other values as well, you have to insert the attribute `data-monster-select-this`. This should be
  * done with care, as it can reduce performance.
  *
- * @externalExample ../../example/dom/updater.mjs
+ * @example /examples/libraries/dom/updater/simple/ Simple example
+ *
  * @license AGPLv3
  * @since 1.8.0
  * @copyright schukai GmbH
- * @memberOf Monster.DOM
  * @throws {Error} the value is not iterable
  * @throws {Error} pipes are not allowed when cloning a node.
  * @throws {Error} no template was found with the specified key.
@@ -149,7 +149,7 @@ class Updater extends Base {
 	/**
 	 * With this method, the eventlisteners are hooked in and the magic begins.
 	 *
-	 * ```
+	 * ```js
 	 * updater.run().then(() => {
 	 *   updater.enableEventProcessing();
 	 * });
@@ -198,7 +198,7 @@ class Updater extends Base {
 	 * The run method must be called for the update to start working.
 	 * The method ensures that changes are detected.
 	 *
-	 * ```
+	 * ```js
 	 * updater.run().then(() => {
 	 *   updater.enableEventProcessing();
 	 * });
@@ -244,7 +244,7 @@ class Updater extends Base {
 	 *
 	 * @param {string} name
 	 * @param {function} callback
-	 * @returns {Transformer}
+	 * @return {Transformer}
 	 * @throws {TypeError} value is not a string
 	 * @throws {TypeError} value is not a function
 	 */
@@ -317,7 +317,6 @@ function getControlEventHandler() {
  * @throws {Error} the bind argument must start as a value with a path
  * @param {HTMLElement} element
  * @return void
- * @memberOf Monster.DOM
  * @private
  */
 function retrieveAndSetValue(element) {

package/source/dom/util/extract-keys.mjs

@@ -22,7 +22,7 @@ export { extractKeys };
  * @param {string} keyPrefix
  * @param {string} keySeparator
  * @param {string} valueSeparator
- * @returns {Map<any, any>}
+ * @return {Map<any, any>}
  */
 function extractKeys(
 	obj,

package/source/dom/util/init-options-from-attributes.mjs

@@ -54,7 +54,7 @@ export { initOptionsFromAttributes };
  * @param {Object} options - The options object to be initialized.
  * @param {Object} mapping - A mapping between the attribute value and the property value.
  * @param {string} prefix - The prefix of the attributes to be considered.
- * @returns {Object} - The initialized options object.
+ * @return {Object} - The initialized options object.
  * @this HTMLElement - The context of the DOM element.
  */
 function initOptionsFromAttributes(

package/source/dom/util/set-option-from-attribute.mjs

@@ -46,7 +46,7 @@ export { setOptionFromAttribute };
  * @param {Object} options - The options object to be initialized.
  * @param {Object} mapping - A mapping between the attribute value and the property value.
  * @param {string} prefix - The prefix of the attributes to be considered.
- * @returns {Object} - The initialized options object.
+ * @return {Object} - The initialized options object.
  * @this HTMLElement - The context of the DOM element.
  */
 function setOptionFromAttribute(

package/source/dom/util.mjs

@@ -55,7 +55,7 @@ export {
  * }
  * ```
  *
- * @returns {object}
+ * @return {object}
  * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
@@ -103,7 +103,7 @@ function getDocument() {
  * }
  * ```
  *
- * @returns {object}
+ * @return {object}
  * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
@@ -149,7 +149,7 @@ function getWindow() {
  * }
  * ```
  *
- * @returns {DocumentFragment}
+ * @return {DocumentFragment}
  * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
@@ -173,7 +173,7 @@ function getDocumentFragmentFromString(html) {
  *
  * @param {HTMLElement|ShadowRoot} element - The starting element or shadow root to search from.
  * @param {string} targetId - The ID of the target element to find.
- * @returns {HTMLElement|null} - The ancestor element with the specified ID, or null if not found.
+ * @return {HTMLElement|null} - The ancestor element with the specified ID, or null if not found.
  * @memberOf Monster.DOM
  * @since 3.29.0
  * @license AGPLv3
@@ -222,7 +222,7 @@ function findElementWithIdUpwards(element, targetId) {
  *
  * @param {HTMLElement|ShadowRoot} element - The starting element or shadow root to search from.
  * @param {string} selector - The selector of the target element to find.
- * @returns {HTMLElement|null} - The ancestor element with the specified selector, or null if not found.
+ * @return {HTMLElement|null} - The ancestor element with the specified selector, or null if not found.
  * @memberOf Monster.DOM
  * @since 3.55.0
  */
@@ -259,7 +259,7 @@ function findElementWithSelectorUpwards(element, selector) {
 /**
  * @private
  * @param {HTMLElement} element
- * @returns {HTMLElement|null}
+ * @return {HTMLElement|null}
  */
 function traverseShadowRoots(element) {
 	let currentRoot = element.shadowRoot;
@@ -296,7 +296,7 @@ function traverseShadowRoots(element) {
  * Recursively searches upwards from a given element to find an ancestor element
  *
  * @param {HTMLElement} element
- * @returns {*}
+ * @return {*}
  * @throws {Error} Invalid argument. Expected an HTMLElement.
  * @memberOf Monster.DOM
  * @since 3.36.0
@@ -318,10 +318,10 @@ function getContainingDocument(element) {
 /**
  * Returns a list of all registered custom elements in the current document.
  *
- * @returns {string[]}
+ * @return {string[]}
  * @since 4.0.0
  * @memberOf Monster.DOM
- * @returns {string[]}
+ * @return {string[]}
  */
 function getRegisteredCustomElements() {
 	const customElementTags = Array.from(document.querySelectorAll("*"))

package/source/i18n/formatter.mjs

@@ -30,11 +30,9 @@ const internalTranslationSymbol = Symbol("internalTranslation");
 /**
  * The Formatter extends the Text.Formatter with the possibility to replace the key by a translation.
  *
- * @externalExample ../../example/i18n/formatter.mjs
  * @license AGPLv3
  * @since 1.26.0
  * @copyright schukai GmbH
- * @memberOf Monster.I18n
  */
 class Formatter extends TextFormatter {
 	/**
@@ -53,7 +51,7 @@ class Formatter extends TextFormatter {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {

package/source/i18n/locale.mjs

@@ -20,14 +20,12 @@ import { clone } from "../util/clone.mjs";
 export { Locale, parseLocale };
 
 /**
- * @memberOf Monster.I18n
  * @type {symbol}
  */
 const propertiesSymbol = Symbol("properties");
 
 /**
  * @type {symbol}
- * @memberOf Monster.I18n
  */
 const localeStringSymbol = Symbol("localeString");
 
@@ -111,7 +109,7 @@ class Locale extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {
@@ -256,7 +254,7 @@ class Locale extends Base {
  * ```
  *
  * @param {string} locale
- * @returns {Locale}
+ * @return {Locale}
  * @license AGPLv3
  * @since 1.14.0
  * @copyright schukai GmbH

package/source/i18n/provider.mjs

@@ -26,7 +26,6 @@ import { Translations } from "./translations.mjs";
 export { Provider, translationsLinkSymbol };
 
 /**
- * @memberOf Monster.I18n
  * @type {symbol}
  * @license AGPLv3
  * @since 3.9.0
@@ -42,13 +41,12 @@ const translationsLinkSymbol = Symbol.for(
  * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster.I18n
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
  */
 class Provider extends BaseWithOptions {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {

package/source/i18n/providers/embed.mjs

@@ -30,9 +30,7 @@ export { Embed };
  * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster.I18n.Providers
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
- * @tutorial i18n-locale-and-formatter
  */
 class Embed extends Provider {
 	/**
@@ -148,7 +146,7 @@ class Embed extends Provider {
 	 * `script[data-monster-role=translations]` is searched for and the translations are assigned to the element.
 	 *
 	 * @param element
-	 * @returns {Promise<Awaited<unknown>[]>}
+	 * @returns {Promise<Awaited<*[]>>|Promise<Awaited<unknown>[]>}
 	 */
 	static assignTranslationsToElement(element) {
 		const d = getDocument();

package/source/i18n/translations.mjs

@@ -35,7 +35,6 @@ export { Translations, getDocumentTranslations };
  * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster.I18n
  * @see https://datatracker.ietf.org/doc/html/rfc3066
  */
 class Translations extends Base {
@@ -57,7 +56,7 @@ class Translations extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {
@@ -215,7 +214,7 @@ class Translations extends Base {
  * Returns the translations for the current document.
  *
  * @param {HTMLElement|undefined} [element] - Element to search for translations. Default: element with objectlink @schukai/monster/i18n/translations@@link.
- * @returns {Translations}
+ * @return {Translations}
  * @throws {Error} Element is not an HTMLElement.
  * @throws {Error} Cannot find the element with translations. Add the translation object to the document.
  * @throws {Error} This element has no translations.

package/source/logging/handler/console.mjs

@@ -25,7 +25,6 @@ export { ConsoleHandler };
  * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
- * @memberOf Monster.Logging.Handler
  */
 class ConsoleHandler extends Handler {
 	/**
@@ -35,7 +34,7 @@ class ConsoleHandler extends Handler {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {LogEntry} entry
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	log(entry) {
 		if (super.log(entry)) {

package/source/logging/handler.mjs

@@ -25,7 +25,6 @@ export { Handler };
  * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
- * @memberOf Monster.Logging
  */
 class Handler extends Base {
 	constructor() {
@@ -46,7 +45,7 @@ class Handler extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {LogEntry} entry
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	log(entry) {
 		validateInstance(entry, LogEntry);
@@ -62,7 +61,7 @@ class Handler extends Base {
 	 * set loglevel
 	 *
 	 * @param {integer} loglevel
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setLogLevel(loglevel) {
@@ -74,7 +73,7 @@ class Handler extends Base {
 	/**
 	 * get loglevel
 	 *
-	 * @returns {integer}
+	 * @return {integer}
 	 * @since 1.5.0
 	 */
 	getLogLevel() {
@@ -84,7 +83,7 @@ class Handler extends Base {
 	/**
 	 *  Set log level to All
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setAll() {
@@ -95,7 +94,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Trace
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setTrace() {
@@ -106,7 +105,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Debug
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setDebug() {
@@ -117,7 +116,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Info
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setInfo() {
@@ -128,7 +127,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Warn
 	 *
-	 * @returns {undefined}
+	 * @return {undefined}
 	 * @since 1.5.0
 	 */
 	setWarn() {
@@ -139,7 +138,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Error
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setError() {
@@ -150,7 +149,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Fatal
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setFatal() {
@@ -161,7 +160,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Off
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setOff() {

package/source/logging/logentry.mjs

@@ -41,7 +41,7 @@ class LogEntry extends Base {
 
 	/**
 	 *
-	 * @returns {integerr}
+	 * @return {integerr}
 	 */
 	getLogLevel() {
 		return this.loglevel;
@@ -49,7 +49,7 @@ class LogEntry extends Base {
 
 	/**
 	 *
-	 * @returns {array}
+	 * @return {array}
 	 */
 	getArguments() {
 		return this.arguments;

package/source/logging/logger.mjs

@@ -12,8 +12,8 @@
  * SPDX-License-Identifier: AGPL-3.0
  */
 
-import { Handler } from "../logging/handler.mjs";
-import { LogEntry } from "../logging/logentry.mjs";
+import { Handler } from "./handler.mjs";
+import { LogEntry } from "./logentry.mjs";
 
 import { Base } from "../types/base.mjs";
 import {
@@ -27,49 +27,41 @@ export { Logger, ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF };
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const ALL = 255;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const TRACE = 64;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const DEBUG = 32;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const INFO = 16;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const WARN = 8;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const ERROR = 4;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const FATAL = 2;
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
  * @type {number}
- * @memberOf Monster.Logging
  */
 const OFF = 0;
 
@@ -79,7 +71,6 @@ const OFF = 0;
  * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
- * @memberOf Monster.Logging
  */
 class Logger extends Base {
 	/**
@@ -93,7 +84,7 @@ class Logger extends Base {
 	/**
 	 *
 	 * @param {Handler} handler
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @throws {Error} the handler must be an instance of Handler
 	 */
 	addHandler(handler) {
@@ -109,7 +100,7 @@ class Logger extends Base {
 	/**
 	 *
 	 * @param {Handler} handler
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @throws {Error} the handler must be an instance of Handler
 	 */
 	removeHandler(handler) {
@@ -128,7 +119,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logTrace(...args) {
@@ -146,7 +137,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logDebug(...args) {
@@ -165,7 +156,7 @@ class Logger extends Base {
 	 *
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logInfo(...args) {
@@ -183,7 +174,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logWarn(...args) {
@@ -201,7 +192,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logError(...args) {
@@ -219,7 +210,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logFatal(...args) {
@@ -235,7 +226,7 @@ class Logger extends Base {
 	 * Labels
 	 *
 	 * @param {integer} level
-	 * @returns {string}
+	 * @return {string}
 	 */
 	getLabel(level) {
 		validateInteger(level);
@@ -256,7 +247,7 @@ class Logger extends Base {
 	 * Level
 	 *
 	 * @param {string} label
-	 * @returns {integer}
+	 * @return {integer}
 	 */
 	getLevel(label) {
 		validateString(label);
@@ -279,7 +270,7 @@ class Logger extends Base {
  *
  * @param {integer} loglevel
  * @param {*} args
- * @returns {Logger}
+ * @return {Logger}
  * @private
  */
 function triggerLog(loglevel, ...args) {

package/source/math/random.mjs

@@ -21,7 +21,7 @@ export { random };
  *
  * @param {number} min starting value of the definition set (default is 0)
  * @param {number} max end value of the definition set (default is 1000000000)
- * @returns {number}
+ * @return {number}
  * @memberOf Monster.Math
  * @throws {Error} missing crypt
  * @throws {Error} we cannot generate numbers larger than 53 bits.
@@ -62,7 +62,7 @@ Math.log2 =
  *
  * @param {number} min
  * @param {number} max
- * @returns {number}
+ * @return {number}
  * @private
  * @throws {Error} missing crypt
  * @throws {Error} we cannot generate numbers larger than 53 bits.

package/source/monster.mjs

@@ -106,6 +106,7 @@ export * from "./util/deadmansswitch.mjs";
 export * from "./util/comparator.mjs";
 export * from "./util/freeze.mjs";
 export * from "./util/clone.mjs";
+export * from "./util/processing/callback.mjs";
 export * from "./logging/handler/console.mjs";
 export * from "./logging/logger.mjs";
 export * from "./logging/handler.mjs";