@schukai/monster 3.80.2 → 3.80.3

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 
 
+## [3.80.3] - 2024-10-11
+
+### Bug Fixes
+
+- some minor fixes
+### Changes
+
+- code format
+### Documentation
+
+- fix doc tags
+- clean the fire definitions
+
+
+
 ## [3.80.2] - 2024-10-07
 
 ### Bug Fixes

package/package.json

@@ -1 +1 @@
-{"author":"schukai GmbH","dependencies":{"@floating-ui/dom":"^1.6.11","@popperjs/core":"^2.11.8"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","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"},"type":"module","version":"3.80.2"}
+{"author":"schukai GmbH","dependencies":{"@floating-ui/dom":"^1.6.11","@popperjs/core":"^2.11.8"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","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"},"type":"module","version":"3.80.3"}

package/source/components/content/copy.mjs

@@ -85,7 +85,7 @@ const resizeObserverSymbol = Symbol("resizeObserver");
 class Copy extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/content/copy@@instance");
@@ -94,6 +94,9 @@ class Copy extends CustomElement {
 	/**
 	 *
 	 * @return {Components.Content.Copy
+	 * @fires monster-copy-clicked This event is fired when the copy button is clicked.
+	 * @fires monster-copy-success This event is fired when the copy action is successful.
+	 * @fires monster-copy-error This event is fired when the copy action fails.
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -244,6 +247,9 @@ function attachResizeObserver() {
 	this[resizeObserverSymbol].observe(this.parentElement);
 }
 
+/**
+ * @private
+ */
 function disconnectResizeObserver() {
 	if (this[resizeObserverSymbol] instanceof ResizeObserver) {
 		this[resizeObserverSymbol].disconnect();
@@ -324,9 +330,6 @@ function updatePopper() {
 /**
  * @private
  * @return {initEventHandler}
- * @fires monster-copy-clicked
- * @fires monster-copy-success
- * @fires monster-copy-error
  */
 function initEventHandler() {
 	const self = this;

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

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

package/source/components/datatable/columnbar.mjs

@@ -96,7 +96,7 @@ const popperInstanceSymbol = Symbol("popperInstance");
 class ColumnBar extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/column-bar");

package/source/components/datatable/dataset.mjs

@@ -81,7 +81,7 @@ export { DataSet };
 class DataSet extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/dataset@@instance");
@@ -163,7 +163,7 @@ class DataSet extends CustomElement {
 	/**
 	 * This method is called when the component is created.
 	 * @since 3.70.0
-	 * @returns {DataSet}
+	 * @return {DataSet}
 	 */
 	refresh() {
 		// makes sure that handleDataSourceChanges is called
@@ -173,7 +173,7 @@ class DataSet extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Promise<unknown>}
+	 * @return {Promise<unknown>}
 	 */
 	write() {
 		return new Promise((resolve, reject) => {

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

@@ -52,7 +52,7 @@ const dataChangeEventHandlerSymbol = Symbol("dataChangeEventHandler");
 class Dom extends Datasource {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/datasource/dom@@instance");
@@ -107,7 +107,7 @@ class Dom extends Datasource {
 
 	/**
 	 * Reloads the data
-	 * @returns {Promise<never>|*}
+	 * @return {Promise<never>|*}
 	 */
 	reload() {}
 

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

@@ -93,7 +93,7 @@ class Rest extends Datasource {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/datasource/rest@@instance");
@@ -176,7 +176,7 @@ class Rest extends Datasource {
 	 * @param {string} page
 	 * @param {string} query
 	 * @param {string} orderBy
-	 * @returns {Monster.Components.Datatable.Datasource.Rest}
+	 * @return {Monster.Components.Datatable.Datasource.Rest}
 	 */
 	setParameters({ page, query, orderBy }) {
 		const parameters = this.getOption("read.parameters");
@@ -204,7 +204,7 @@ class Rest extends Datasource {
 
 	/**
 	 * @deprecated 2023-06-25
-	 * @returns {Promise<never>|*}
+	 * @return {Promise<never>|*}
 	 */
 	reload() {
 		return this.fetch();
@@ -212,7 +212,7 @@ class Rest extends Datasource {
 
 	/**
 	 * Fetches the data from the rest api
-	 * @returns {Promise<never>|*}
+	 * @return {Promise<never>|*}
 	 */
 	fetch() {
 		const opt = clone(this.getOption("read"));
@@ -276,7 +276,7 @@ class Rest extends Datasource {
 	 * This method activates the intersection observer manually.
 	 * For this purpose, the option `autoInit.intersectionObserver` must be set to `false`.
 	 *
-	 * @returns {Monster.Components.Datatable.Datasource.Rest}
+	 * @return {Monster.Components.Datatable.Datasource.Rest}
 	 */
 	initIntersectionObserver() {
 		initIntersectionObserver.call(this);
@@ -305,7 +305,7 @@ class Rest extends Datasource {
 	}
 
 	/**
-	 * @returns {Promise<never>|*}
+	 * @return {Promise<never>|*}
 	 */
 	read() {
 		return this.fetch();
@@ -313,7 +313,7 @@ class Rest extends Datasource {
 
 	/**
 	 * Fetches the data from the rest api
-	 * @returns {Promise<never>|*}
+	 * @return {Promise<never>|*}
 	 */
 	write() {
 		const opt = clone(this.getOption("write"));

package/source/components/datatable/datasource.mjs

@@ -58,7 +58,7 @@ class Datasource extends CustomElement {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/datasource@@instance");
@@ -87,7 +87,7 @@ class Datasource extends CustomElement {
 
 	/**
 	 * Get the data, without proxy
-	 * @returns {Object}
+	 * @return {Object}
 	 */
 	get data() {
 		return this[dataSourceSymbol].get();
@@ -103,7 +103,7 @@ class Datasource extends CustomElement {
 
 	/**
 	 * Get the datasource
-	 * @returns {Monster.Data.Datasource}
+	 * @return {Monster.Data.Datasource}
 	 */
 	get datasource() {
 		return this[dataSourceSymbol];

package/source/components/datatable/datatable/header.mjs

@@ -82,7 +82,7 @@ class Header extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/datatable/header@@instance");
@@ -90,7 +90,7 @@ class Header extends Base {
 
 	/**
 	 *
-	 * @returns {object}
+	 * @return {object}
 	 */
 	get internalDefaults() {
 		return {
@@ -174,14 +174,14 @@ class Header extends Base {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get labelKey() {
 		return this.getInternal("labelKey");
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get html() {
 		return this.getInternal("html");
@@ -192,42 +192,42 @@ class Header extends Base {
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get field() {
 		return this.getInternal("field");
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get index() {
 		return this.getInternal("index");
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get classes() {
 		return this.getInternal("classes");
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get label() {
 		return this.getInternal("label");
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get direction() {
 		return this.getInternal("direction");
 	}
 
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get mode() {
 		return this.getInternal("mode");
@@ -237,7 +237,7 @@ class Header extends Base {
 /**
  * @private
  * @param {Array<Header>} headers
- * @returns {string}
+ * @return {string}
  */
 function createOrderStatement(headers) {
 	validateIterable(headers);

package/source/components/datatable/datatable.mjs

@@ -139,14 +139,14 @@ const columnBarElementSymbol = Symbol("columnBarElement");
  * @copyright schukai GmbH
  * @memberOf Monster.Components.Datatable
  * @summary A data table
- * @fire Monster.Components.Datatable.event:monster-datatable-row-copied
- * @fire Monster.Components.Datatable.event:monster-datatable-row-removed
- * @fire Monster.Components.Datatable.event:monster-datatable-row-added
+ * @fires monster-datatable-row-copied
+ * @fires monster-datatable-row-removed
+ * @fires monster-datatable-row-added
  */
 class DataTable extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/datatable@@instance");
@@ -233,7 +233,7 @@ class DataTable extends CustomElement {
 	/**
 	 *
 	 * @param {string} selector
-	 * @returns {NodeListOf<*>}
+	 * @return {NodeListOf<*>}
 	 */
 	getGridElements(selector) {
 		return this[gridElementSymbol].querySelectorAll(selector);
@@ -358,8 +358,8 @@ class DataTable extends CustomElement {
 	 * Copy a row from the datatable
 	 * @param {number} fromIndex
 	 * @param {number} toIndex
-	 * @returns {Monster.Components.Datatable.DataTable}
-	 * @fire Monster.Components.Datatable.event:monster-datatable-row-copied
+	 * @return {Monster.Components.Datatable.DataTable}
+	 * @fires monster-datatable-row-copied
 	 */
 	copyRow(fromIndex, toIndex) {
 		const datasource = this[datasourceLinkedElementSymbol];
@@ -412,8 +412,8 @@ class DataTable extends CustomElement {
 	/**
 	 * Remove a row from the datatable
 	 * @param index
-	 * @returns {Monster.Components.Datatable.DataTable}
-	 * @fire Monster.Components.Datatable.event:monster-datatable-row-removed
+	 * @return {Monster.Components.Datatable.DataTable}
+	 * @fires monster-datatable-row-removed
 	 */
 	removeRow(index) {
 		const datasource = this[datasourceLinkedElementSymbol];
@@ -458,8 +458,8 @@ class DataTable extends CustomElement {
 	/**
 	 * Add a row to the datatable
 	 * @param {Object} data
-	 * @returns {Monster.Components.Datatable.DataTable}
-	 * @fire Monster.Components.Datatable.event:monster-datatable-row-added
+	 * @return {Monster.Components.Datatable.DataTable}
+	 * @fires monster-datatable-row-added
 	 **/
 	addRow(data) {
 		const datasource = this[datasourceLinkedElementSymbol];
@@ -496,7 +496,7 @@ class DataTable extends CustomElement {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getColumnVisibilityConfigKey() {
 	return generateUniqueConfigKey("datatable", this?.id, "columns-visibility");
@@ -504,7 +504,7 @@ function getColumnVisibilityConfigKey() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getFilterConfigKey() {
 	return generateUniqueConfigKey("datatable", this?.id, "filter");
@@ -512,7 +512,7 @@ function getFilterConfigKey() {
 
 /**
  * @private
- * @returns {Promise}
+ * @return {Promise}
  */
 function getHostConfig(callback) {
 	const host = findElementWithSelectorUpwards(this, "monster-host");
@@ -804,7 +804,7 @@ function initGridAndStructs(hostConfig, headerOrderMap) {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 export function getStoredOrderConfigKey() {
 	return generateUniqueConfigKey("datatable", this?.id, "stored-order");

package/source/components/datatable/embedded-pagination.mjs

@@ -62,7 +62,7 @@ export { EmbeddedPagination };
 class EmbeddedPagination extends Pagination {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/embedded-pagination");
@@ -93,7 +93,7 @@ class EmbeddedPagination extends Pagination {
 
 	/**
 	 * @private
-	 * @returns {CSSStyleSheet}
+	 * @return {CSSStyleSheet}
 	 */
 	static getControlCSSStyleSheet() {
 		return EmbeddedPaginationStyleSheet;

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

@@ -149,7 +149,7 @@ class DateRange extends AbstractBase {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -178,7 +178,7 @@ class DateRange extends AbstractBase {
 	}
 
 	/**
-	 * @returns {*}
+	 * @return {*}
 	 */
 	get value() {
 		return this[inputElementSymbol].value;
@@ -190,7 +190,7 @@ class DateRange extends AbstractBase {
 	 *
 	 * The individual configuration values can be found in the table.
 	 *
-	 * @returns {Object}
+	 * @return {Object}
 	 *
 	 * @property {Object} templates
 	 * @property {string} templates.main
@@ -627,7 +627,7 @@ function clearAndDisableFormGroups() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function guessRangeTypeFromCurrentValue() {
 	const value = this[inputElementSymbol].value.trim();
@@ -686,7 +686,7 @@ function getRangeTypeFromForm() {
  *
  * @param {string} date
  * @param {string} unit (day, month, year, week)
- * @returns {number} range
+ * @return {number} range
  */
 function calculateDateRangeFromToday(date, unit) {
 	// calculate the date of today -1

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

@@ -75,7 +75,7 @@ const inputElementSymbol = Symbol("inputElement");
 class Input extends AbstractBase {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/filter/input@@instance");
@@ -139,7 +139,7 @@ class Input extends AbstractBase {
 	}
 
 	/**
-	 * @returns {*}
+	 * @return {*}
 	 */
 	get value() {
 		return this[inputElementSymbol].value;

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

@@ -121,7 +121,7 @@ const arrowElementSymbol = Symbol("arrowElement");
 class Range extends AbstractBase {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/filter/range@@instance");
@@ -148,7 +148,7 @@ class Range extends AbstractBase {
 	}
 
 	/**
-	 * @returns {*}
+	 * @return {*}
 	 */
 	get value() {
 		return this[inputElementSymbol].value;
@@ -160,7 +160,7 @@ class Range extends AbstractBase {
 	 *
 	 * The individual configuration values can be found in the table.
 	 *
-	 * @returns {Object}
+	 * @return {Object}
 	 *
 	 * @property {Object} templates
 	 * @property {string} templates.main

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

@@ -43,7 +43,7 @@ class Settings extends Base {
 	/**
 	 *
 	 * @param value
-	 * @returns {*}
+	 * @return {*}
 	 */
 	get(value) {
 		return this.getInternal("option." + value);
@@ -55,7 +55,7 @@ class Settings extends Base {
 	 * @param value
 	 * @param label
 	 * @param visible
-	 * @returns {Settings}
+	 * @return {Settings}
 	 */
 	set({ value, label, visible = true }) {
 		let d = this.getInternal("option." + value);
@@ -81,7 +81,7 @@ class Settings extends Base {
 
 	/**
 	 *
-	 * @returns {Array}
+	 * @return {Array}
 	 */
 	getOptions() {
 		const option = this.getInternal("option");
@@ -101,7 +101,7 @@ class Settings extends Base {
 	/**
 	 *
 	 * @param options
-	 * @returns {Settings}
+	 * @return {Settings}
 	 */
 	setOptions(options) {
 		for (const key in options) {
@@ -112,7 +112,7 @@ class Settings extends Base {
 
 	/**
 	 *
-	 * @returns {Array}
+	 * @return {Array}
 	 */
 	getSelected() {
 		const option = this.getInternal("option");

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

@@ -16,7 +16,7 @@ import { generateUniqueConfigKey } from "../../host/util.mjs";
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 export function getFilterConfigKey() {
 	return generateUniqueConfigKey("datatable", this?.id, "filter");
@@ -24,7 +24,7 @@ export function getFilterConfigKey() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 export function getStoredFilterConfigKey() {
 	return generateUniqueConfigKey("datatable", this?.id, "stored-filter");
@@ -34,7 +34,7 @@ export function getStoredFilterConfigKey() {
  * @private
  * @param {String} str
  * @param {String} field
- * @returns {String}
+ * @return {String}
  * @throws {Error} if no field is defined
  */
 export function parseDateInput(str, field) {

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

@@ -63,7 +63,7 @@ export { FilterButton };
 class FilterButton extends ToggleButton {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/filter-button@@instance");