@schukai/monster 4.154.0 → 4.154.2

package/package.json

@@ -1 +1 @@
-{"author":"Volker Schukai","dependencies":{"@floating-ui/dom":"^1.7.6"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","exports":{".":"./source/monster.mjs","./CHANGELOG.md":"./CHANGELOG.md","./LICENSE":"./LICENSE","./README.md":"./README.md","./package.json":"./package.json","./source/*":"./source/*","./test/*":"./test/*"},"files":["source","test/cases","test/util","CHANGELOG.md"],"homepage":"https://monsterjs.org/","keywords":["framework","web","dom","css","sass","mobile-first","app","front-end","templates","schukai","core","shopcloud","alvine","monster","buildmap","stack","observer","observable","uuid","node","nodelist","css-in-js","logger","log","theme"],"license":"AGPL 3.0","main":"source/monster.mjs","module":"source/monster.mjs","name":"@schukai/monster","repository":{"type":"git","url":"https://gitlab.schukai.com/oss/libraries/javascript/monster.git"},"sideEffects":["./source/monster.mjs","./source/components/**","./source/i18n/**","./test/**"],"type":"module","version":"4.154.0"}
+{"author":"Volker Schukai","dependencies":{"@floating-ui/dom":"^1.7.6"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","exports":{".":"./source/monster.mjs","./CHANGELOG.md":"./CHANGELOG.md","./LICENSE":"./LICENSE","./README.md":"./README.md","./package.json":"./package.json","./source/*":"./source/*","./test/*":"./test/*"},"files":["source","test/cases","test/util","CHANGELOG.md"],"homepage":"https://monsterjs.org/","keywords":["framework","web","dom","css","sass","mobile-first","app","front-end","templates","schukai","core","shopcloud","alvine","monster","buildmap","stack","observer","observable","uuid","node","nodelist","css-in-js","logger","log","theme"],"license":"AGPL 3.0","main":"source/monster.mjs","module":"source/monster.mjs","name":"@schukai/monster","repository":{"type":"git","url":"https://gitlab.schukai.com/oss/libraries/javascript/monster.git"},"sideEffects":["./source/monster.mjs","./source/components/**","./source/i18n/**","./test/**"],"type":"module","version":"4.154.2"}

package/source/components/accessibility/locale-picker.mjs

@@ -89,7 +89,7 @@ const detectedLanguagesSymbol = Symbol("detectedLanguages");
 class LocalePicker extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -255,7 +255,7 @@ class LocalePicker extends CustomElement {
 	/**
 	 * Resets the locale picker by removing the stored value from the local storage.
 	 *
-	 * @returns {LocalePicker}
+	 * @return {LocalePicker}
 	 */
 	reset() {
 		sessionStorage.removeItem(buildStorageKey.call(this));
@@ -266,7 +266,7 @@ class LocalePicker extends CustomElement {
 	/**
 	 * Hides the locale picker.
 	 *
-	 * @returns {LocalePicker}
+	 * @return {LocalePicker}
 	 */
 	hide() {
 		this.style.display = "none";
@@ -281,7 +281,7 @@ class LocalePicker extends CustomElement {
 
 	/**
 	 * Shows the locale picker.
-	 * @returns {LocalePicker}
+	 * @return {LocalePicker}
 	 */
 	show() {
 		this.style.display = "block";
@@ -401,7 +401,7 @@ function initEventHandler() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  * Builds the session storage key for the picker.
  */
 function buildStorageKey() {
@@ -411,7 +411,7 @@ function buildStorageKey() {
 /**
  * @private
  * @param lang
- * @returns {Object}
+ * @return {Object}
  * Returns translations for the given language.
  */
 function getTranslations(lang) {

package/source/components/accessibility/locale-select.mjs

@@ -120,7 +120,7 @@ function getLocalizedLabel() {
 class LocaleSelect extends CustomElement {
 	/**
 	 * Used by the instanceof operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

package/source/components/content/camera-capture.mjs

@@ -166,7 +166,7 @@ class CameraCapture extends CustomElement {
 	/**
 	 * Retrieve the next image from the queue.
 	 * If the queue is empty, it returns `null`.
-	 * @returns {string|null}
+	 * @return {string|null}
 	 */
 	getNextImage() {
 		if (!this[queueSymbol].isEmpty()) {
@@ -182,7 +182,7 @@ class CameraCapture extends CustomElement {
 	/**
 	 * Capture an image from the camera and add it to the queue.
 	 * The image is returned as a data URL.
-	 * @returns {string}
+	 * @return {string}
 	 */
 	capture() {
 		this[canvasElementSymbol].width = this[videoElementSymbol].videoWidth;
@@ -318,7 +318,7 @@ function startCameraWithDeviceId(deviceId) {
 
 /**
  * @private
- * @returns {{takePicture: string}}
+ * @return {{takePicture: string}}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/content/copy.mjs

@@ -452,7 +452,7 @@ function initEventHandler() {
 
 /**
  * @private
- * @returns {Set<any>|string}
+ * @return {Set<any>|string}
  */
 function getSlottedCopyContent() {
 	const self = this;

package/source/components/content/fetch-box.mjs

@@ -44,7 +44,7 @@ export const fetchBoxElementSymbol = Symbol("fetchBoxElement");
 class FetchBox extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

package/source/components/content/image-editor.mjs

@@ -476,9 +476,7 @@ class ImageEditor extends CustomElement {
 	 * Sets the image source from binary data or a URL.
 	 *
 	 * @param {(Blob|ArrayBuffer|Uint8Array|string)} data
-	 * @param {Object} [options]
-	 * @param {string} [options.contentType]
-	 * @param {boolean} [options.storeOriginal]
+	 * @param {Object} [options] Optional content type and original-image storage settings.
 	 * @return {Promise<void>}
 	 */
 	setImage(data, options = {}) {
@@ -2622,7 +2620,7 @@ function blobToDataUrl(blob) {
 
 /**
  * @private
- * @returns {{save:string,reset:string,crop:string,select:string,filter:string,intensity:string,zoom:string,rotation:string,empty:string,filterNone:string,filterGrayscale:string,filterSepia:string,filterContrast:string,filterSaturate:string,filterInvert:string,filterBlur:string,cropX:string,cropY:string,cropWidth:string,cropHeight:string,applyFilter:string,rotateLeft:string,rotateRight:string,rotateReset:string}}
+ * @return {{save:string,reset:string,crop:string,select:string,filter:string,intensity:string,zoom:string,rotation:string,empty:string,filterNone:string,filterGrayscale:string,filterSepia:string,filterContrast:string,filterSaturate:string,filterInvert:string,filterBlur:string,cropX:string,cropY:string,cropWidth:string,cropHeight:string,applyFilter:string,rotateLeft:string,rotateRight:string,rotateReset:string}}
  */
 function getTranslations() {
 	const language = getLocaleOfDocument().language || "en";

package/source/components/content/viewer/html.mjs

@@ -81,7 +81,7 @@ class HtmlContent extends CustomElement {
 
 	/**
 	 * Returns the updater transformer methods for this component.
-	 * @returns {{sanitizeHtml: ((function(*): (*))|*)}}
+	 * @return {{sanitizeHtml: ((function(*): (*))|*)}}
 	 */
 	[updaterTransformerMethodsSymbol]() {
 		return {
@@ -115,7 +115,7 @@ class HtmlContent extends CustomElement {
 	/**
 	 * Sets the content of the HtmlContent component.
 	 * @param content
-	 * @returns {HtmlContent}
+	 * @return {HtmlContent}
 	 */
 	setContent(content) {
 		this.setOption("content", content);

package/source/components/content/viewer/message.mjs

@@ -158,7 +158,7 @@ class MessageContent extends CustomElement {
 
 	/**
 	 * Returns the updater transformer methods for this component.
-	 * @returns {{sanitizeHtml: ((function(*): (*))|*)}}
+	 * @return {{sanitizeHtml: ((function(*): (*))|*)}}
 	 */
 	[updaterTransformerMethodsSymbol]() {
 		return {
@@ -174,7 +174,7 @@ class MessageContent extends CustomElement {
 	/**
 	 * Sets the content of the MessageContent component.
 	 * @param {Object} message The message object containing parts, headers, etc.
-	 * @returns {MessageContent}
+	 * @return {MessageContent}
 	 */
 	setMessage(message) {
 		const self = this;
@@ -818,7 +818,7 @@ function downloadAttachmentByIndex(index, attachments) {
 /**
  * Initializes the event handler for the MessageContent component.
  * @private
- * @returns {initEventHandler}
+ * @return {initEventHandler}
  */
 function initEventHandler() {
 	this[showPrivacyImagesSymbol].addEventListener("click", (event) => {

package/source/components/content/viewer/sanitize-html.mjs

@@ -55,7 +55,7 @@ const SAFE_VIEWER_LINK_PROTOCOLS = new Set([
  * Sanitizes untrusted HTML specifically for rendering inside Monster viewers.
  *
  * @param {string} html Untrusted viewer HTML.
- * @returns {string} Sanitized viewer HTML.
+ * @return {string} Sanitized viewer HTML.
  */
 function sanitizeViewerHtml(html) {
 	const sanitizedHtml = sanitizeHtml(html, {

package/source/components/data/kpi-tile.mjs

@@ -40,7 +40,7 @@ class KpiTile extends CustomElement {
 	}
 
 	/**
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @summary Returns the instance symbol for the KPI Tile control.
 	 */
 	[assembleMethodSymbol]() {
@@ -59,7 +59,7 @@ class KpiTile extends CustomElement {
 	 * @property {string} values.small The small value displayed in the tile.
 	 * @property {string} values.top The top value displayed in the tile.
 	 * @property {string} values.bottom The bottom value displayed in the tile.
-	 * @returns {Object}
+	 * @return {Object}
 	 * @summary Returns the default options for the KPI Tile control.
 	 */
 	get defaults() {
@@ -77,7 +77,7 @@ class KpiTile extends CustomElement {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 * @summary Returns the role of the control.
 	 */
 	static getTag() {
@@ -85,7 +85,7 @@ class KpiTile extends CustomElement {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 * @summary Returns the role of the control.
 	 */
 	static getCSSStyleSheet() {
@@ -95,7 +95,7 @@ class KpiTile extends CustomElement {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  * @summary Returns the template for the KPI Tile control.
  */
 function getTemplate() {

package/source/components/data/metric-graph.mjs

@@ -54,7 +54,7 @@ export const metricGraphControlElementSymbol = Symbol(
 class MetricGraph extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/data/metric-graph@@instance");
@@ -119,7 +119,7 @@ class MetricGraph extends CustomElement {
 
 	/**
 	 *
-	 * @returns {{tosparkline: ((function(*): (string|string))|*)}}
+	 * @return {{tosparkline: ((function(*): (string|string))|*)}}
 	 */
 	[updaterTransformerMethodsSymbol]() {
 		return {

package/source/components/data/metric.mjs

@@ -50,7 +50,7 @@ export const metricControlElementSymbol = Symbol("metricControlElement");
 class Metric extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/data/metric@@instance");

package/source/components/datatable/change-button.mjs

@@ -229,7 +229,7 @@ function initControlReferences() {
 
 /**
  * @private
- * @returns {number}
+ * @return {number}
  * @throws {TypeError}
  * @throws {Error}
  */

package/source/components/datatable/columnbar.mjs

@@ -151,7 +151,7 @@ class ColumnBar extends CustomElement {
 
 	/**
 	 * This method is called to customize the component.
-	 * @returns {Map<unknown, unknown>}
+	 * @return {Map<unknown, unknown>}
 	 */
 	get customization() {
 		return new Map([...super.customization, ["templateFormatter.i18n", true]]);
@@ -286,7 +286,7 @@ class ColumnBar extends CustomElement {
 
 /**
  * @private
- * @returns {{settings: string}}
+ * @return {{settings: string}}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/datasource/rest.mjs

@@ -210,9 +210,7 @@ class Rest extends Datasource {
 	 * With this method, you can set the parameters for the rest api. The parameters are
 	 * used for building the url.
 	 *
-	 * @param {string} page
-	 * @param {string} query
-	 * @param {string} order
+	 * @param {object} parameters Page, query and order parameters.
 	 * @return {Rest}
 	 */
 	setParameters({ page, query, order }) {
@@ -593,7 +591,7 @@ function initFilter() {
  * @param json
  * @param response
  * @param filterControl
- * @returns {Promise<never>|Promise<Awaited<unknown>>}
+ * @return {Promise<never>|Promise<Awaited<unknown>>}
  */
 function handleIntersectionObserver(json, response, filterControl) {
 	const path = new Pathfinder(json);

package/source/components/datatable/datatable.mjs

@@ -346,7 +346,7 @@ class DataTable extends CustomElement {
 	/**
 	 * Get the row number of the selected rows as an array
 	 *
-	 * @returns {number[]}
+	 * @return {number[]}
 	 */
 	getSelectedRows() {
 		const rows = this.getGridElements(`[data-monster-role="select-row"]`);
@@ -1350,7 +1350,7 @@ function initEventHandler() {
  * @private
  * @param {HTMLInputElement} checkbox
  * @param {boolean} selected
- * @returns {string|null}
+ * @return {string|null}
  */
 function setRowSelectionState(checkbox, selected) {
 	const parentNode = checkbox.parentNode;
@@ -1564,7 +1564,7 @@ function initGridAndStructs(hostConfig, headerOrderMap) {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/filter/date-presets.mjs

@@ -119,7 +119,7 @@ class DatePresets extends CustomControl {
 
 /**
  * @private
- * @returns {Object}
+ * @return {Object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/filter/input.mjs

@@ -114,7 +114,7 @@ class Input extends AbstractBase {
 
 /**
  * @private
- * @returns {{filter: string}}
+ * @return {{filter: string}}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/filter/range.mjs

@@ -269,7 +269,7 @@ class Range extends AbstractBase {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/filter/settings.mjs

@@ -50,9 +50,7 @@ class Settings extends Base {
 	/**
 	 * value = "id"
 	 *
-	 * @param value
-	 * @param label
-	 * @param visible
+	 * @param {object} option Value, label and visibility settings.
 	 * @return {Settings}
 	 */
 	set({ value, label, visible = true }) {

package/source/components/datatable/filter/text-operator.mjs

@@ -149,7 +149,7 @@ class TextOperator extends CustomControl {
 
 /**
  * @private
- * @returns {Object}
+ * @return {Object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/filter.mjs

@@ -425,7 +425,7 @@ class Filter extends CustomElement {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/datatable/pagination.mjs

@@ -199,9 +199,7 @@ class Pagination extends CustomElement {
 	 * Sets the pagination state directly, without requiring a datasource.
 	 * This is useful for controlling the component programmatically.
 	 *
-	 * @param {object} state - The state object for the pagination.
-	 * @param {number} state.currentPage - The current active page number.
-	 * @param {number} state.totalPages - The total number of available pages.
+	 * @param {object} state The current page and total page count.
 	 * @return {void}
 	 */
 	setPaginationState({ currentPage, totalPages }) {
@@ -958,7 +956,7 @@ function buildPagination(current, max) {
 /**
  * @private
  * @param {object} pagination
- * @returns {void}
+ * @return {void}
  */
 function syncPaginationStateToDom(pagination) {
 	if (!this.shadowRoot || !pagination) {

package/source/components/datatable/status.mjs

@@ -137,7 +137,7 @@ class DatasourceStatus extends CustomElement {
 	 *
 	 * @param message
 	 * @param timeout
-	 * @returns {DatasourceStatus}
+	 * @return {DatasourceStatus}
 	 */
 	setErrorMessage(message, timeout) {
 		this[errorElementSymbol].setErrorMessage(message, timeout);

package/source/components/files/file-manager.mjs

@@ -2072,7 +2072,7 @@ function getEmptyStateIcon() {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/form/action-button.mjs

@@ -175,7 +175,7 @@ function initEventHandler() {
 
 /**
  * @private
- * @returns {updateButtonsI18n}
+ * @return {updateButtonsI18n}
  */
 function updateButtonsI18n() {
 	const translations = getDocumentTranslations();

package/source/components/form/api-bar.mjs

@@ -60,7 +60,7 @@ export { ApiBar };
 class ApiBar extends ButtonBar {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/api-bar@@instance");

package/source/components/form/buy-box.mjs

@@ -2132,7 +2132,7 @@ function getTemplate() {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/form/cart-control.mjs

@@ -541,7 +541,7 @@ function getTemplate() {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/form/checklist.mjs

@@ -96,7 +96,7 @@ class Checklist extends CustomControl {
 	}
 
 	/**
-	 * @returns {Array}
+	 * @return {Array}
 	 */
 	get value() {
 		return getCheckedIds.call(this);

package/source/components/form/digits.mjs

@@ -52,7 +52,7 @@ class Digits extends CustomControl {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/digits@@instance");
@@ -260,7 +260,7 @@ function updateDigitControls() {
 /**
  * @private
  * @param value
- * @returns {boolean}
+ * @return {boolean}
  */
 function checkCharacter(value) {
 	const characterSet = this.getOption("characterSet");
@@ -269,7 +269,7 @@ function checkCharacter(value) {
 
 /**
  * @private
- * @returns {initEventHandler}
+ * @return {initEventHandler}
  */
 function initEventHandler() {
 	const self = this;
@@ -381,7 +381,7 @@ function collectValues() {
 /**
  * @private
  * @param {Array<{value:string}>} controls
- * @returns {void}
+ * @return {void}
  */
 function syncInputValues(controls) {
 	if (!this[digitsElementSymbol]) return;

package/source/components/form/dropzone.mjs

@@ -1051,7 +1051,7 @@ function getTemplate() {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/form/field-set.mjs

@@ -256,7 +256,7 @@ class FieldSet extends CustomControl {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();

package/source/components/form/input-group.mjs

@@ -40,7 +40,7 @@ export const inputGroupElementSymbol = Symbol("inputGroupElement");
 class InputGroup extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/input-group@@instance");