@schukai/monster 4.154.1 → 4.154.3

package/source/components/form/login.mjs

@@ -173,7 +173,7 @@ const digitsCollapseSymbol = Symbol("digitsCollapse");
 class Login extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/login@@instance");
@@ -414,7 +414,7 @@ class Login extends CustomElement {
 	/**
 	 * Opens the login collapse and focuses the username control.
 	 *
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	openLogin() {
 		this[loginCollapseSymbol].open();
@@ -425,7 +425,7 @@ class Login extends CustomElement {
 	/**
 	 * Opens the forgot password collapse. If the feature `forgotPassword` is not enabled, an error will be thrown.
 	 *
-	 * @returns {Login}
+	 * @return {Login}
 	 * @throws {Error} If the feature is not enabled
 	 */
 	openForgotPassword() {
@@ -439,7 +439,7 @@ class Login extends CustomElement {
 
 	/**
 	 * Opens the second factor collapse and focuses the second factor control.
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	openSecondFactor() {
 		this[secondFactorCollapseSymbol].open();
@@ -449,7 +449,7 @@ class Login extends CustomElement {
 
 	/**
 	 * Opens the digits collapse and focuses the digit control.
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	openDigits() {
 		this[digitsCollapseSymbol].open();
@@ -460,7 +460,7 @@ class Login extends CustomElement {
 	/**
 	 * Opens the logged in collapse. If the feature `redirectToFirstSuccessUrl` is enabled, the user will be redirected to the first success URL.
 	 *
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	openLoggedIn() {
 		fireEvent(this, "login-success");
@@ -500,7 +500,7 @@ class Login extends CustomElement {
 	/**
 	 * Opens the custom collapse and focuses the first focusable element if available.
 	 *
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	openCustomCollapse() {
 		this[customCollapseSymbol].open();
@@ -512,7 +512,7 @@ class Login extends CustomElement {
 	 * Replaces the header content of the custom collapse.
 	 *
 	 * @param {string|number|boolean|Node|Array<string|number|boolean|Node>|null|undefined} content
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	setCustomCollapseHeader(content) {
 		setCustomCollapseSectionContent.call(
@@ -527,7 +527,7 @@ class Login extends CustomElement {
 	 * Replaces the main content of the custom collapse.
 	 *
 	 * @param {string|number|boolean|Node|Array<string|number|boolean|Node>|null|undefined} content
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	setCustomCollapseContent(content) {
 		setCustomCollapseSectionContent.call(
@@ -542,7 +542,7 @@ class Login extends CustomElement {
 	 * Replaces the footer content of the custom collapse.
 	 *
 	 * @param {string|number|boolean|Node|Array<string|number|boolean|Node>|null|undefined} content
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	setCustomCollapseFooter(content) {
 		setCustomCollapseSectionContent.call(
@@ -556,7 +556,7 @@ class Login extends CustomElement {
 	/**
 	 * Clears all custom collapse sections.
 	 *
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	clearCustomCollapse() {
 		this[customCollapseHeaderSymbol].replaceChildren();
@@ -569,7 +569,7 @@ class Login extends CustomElement {
 	 * Replaces the custom collapse content and opens it.
 	 *
 	 * @param {string|number|boolean|Node|Array<string|number|boolean|Node>|Object|null|undefined} content
-	 * @returns {Login}
+	 * @return {Login}
 	 */
 	showCustomCollapse(content) {
 		if (isObject(content) && !(content instanceof Node) && !isArray(content)) {
@@ -2157,7 +2157,7 @@ function getTemplate() {
  * @private
  * @param {HTMLElement} target
  * @param {string|number|boolean|Node|Array<string|number|boolean|Node>|null|undefined} content
- * @returns {void}
+ * @return {void}
  */
 function setCustomCollapseSectionContent(target, content) {
 	if (!(target instanceof HTMLElement)) {
@@ -2174,7 +2174,7 @@ function setCustomCollapseSectionContent(target, content) {
 /**
  * @private
  * @param {string|number|boolean|Node|Array<string|number|boolean|Node>|null|undefined} content
- * @returns {Node[]}
+ * @return {Node[]}
  */
 function normalizeCustomCollapseContent(content) {
 	if (content === null || content === undefined) {
@@ -2196,7 +2196,7 @@ function normalizeCustomCollapseContent(content) {
 
 /**
  * @private
- * @returns {void}
+ * @return {void}
  */
 function focusFirstCustomCollapseElement() {
 	setTimeout(() => {

package/source/components/form/password.mjs

@@ -63,7 +63,7 @@ export const inputElementSymbol = Symbol("inputIconElement");
 class Password extends CustomControl {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/password@@instance");

package/source/components/form/popper.mjs

@@ -20,5 +20,6 @@ export { Popper };
  * @since 1.10.0
  * @copyright Volker Schukai
  * @deprecated since 3.65.0
+ * @summary Provides the deprecated form alias for the layout popper component.
  */
 class Popper extends NewPopper {}

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

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

package/source/components/form/select-link.mjs

@@ -30,6 +30,9 @@ const observerSymbol = Symbol("observer");
 const handlerSymbol = Symbol("handler");
 const boundSymbol = Symbol("bound");
 
+/**
+ * @summary Synchronizes the selected values of two select controls.
+ */
 class SelectLink extends CustomElement {
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/select-link@@instance");

package/source/components/form/select.mjs

@@ -1171,7 +1171,7 @@ function processAndApplyRemoteInfoTotal(data) {
  * @param {string|null|undefined} message
  * @param {object} [options]
  * @param {boolean} [options.reserveSpace=false]
- * @returns {void}
+ * @return {void}
  */
 function setRemoteInfoText(message, { reserveSpace = false } = {}) {
 	const normalizedMessage =
@@ -1206,7 +1206,7 @@ function setRemoteInfoText(message, { reserveSpace = false } = {}) {
 
 /**
  * @private
- * @returns {number}
+ * @return {number}
  */
 function bumpOptionsVersion() {
 	if (!isInteger(this[optionsVersionSymbol])) {
@@ -1218,7 +1218,7 @@ function bumpOptionsVersion() {
 
 /**
  * @private
- * @returns {*}
+ * @return {*}
  */
 function getSelectionSyncState() {
 	const attrValue = this.getAttribute("value");
@@ -1331,7 +1331,7 @@ function scheduleSelectionSync(version) {
 /**
  * @private
  * @param data
- * @returns {any}
+ * @return {any}
  */
 function importOptionsIntern(data) {
 	const self = this;
@@ -1505,7 +1505,7 @@ function isEmptyOptionLabel(label) {
 
 /**
  * @private
- * @returns {object}
+ * @return {object}
  */
 function getTranslations() {
 	const locale = getLocaleOfDocument();
@@ -2144,7 +2144,7 @@ function finishTrackedFetch(token) {
  *
  * @param url
  * @param controlOptions
- * @returns {Promise<never>|Promise<unknown>}
+ * @return {Promise<never>|Promise<unknown>}
  */
 function fetchIt(url, controlOptions) {
 	const self = this;
@@ -2719,7 +2719,7 @@ function retryPendingOpenIntent() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getSelectionTemplate() {
 	return `<div data-monster-role="selection" part="selection"
@@ -2738,7 +2738,7 @@ function getSelectionTemplate() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getSummaryTemplate() {
 	return `<div data-monster-role="selection" role="search" part="summary">
@@ -2840,7 +2840,7 @@ function buildSelectionLabel(value) {
 /**
  * @private
  * @param {*} value
- * @returns {string}
+ * @return {string}
  */
 function getSelectionValueLabel(value) {
 	if (isValueIsEmpty.call(this, value)) {
@@ -2873,7 +2873,7 @@ function getSelectionValueLabel(value) {
 /**
  * @private
  * @param {*} value
- * @returns {*}
+ * @return {*}
  */
 function getSelectionStateKey(value) {
 	return this.getOption("features.useStrictValueComparison") === true
@@ -2884,7 +2884,7 @@ function getSelectionStateKey(value) {
 /**
  * @private
  * @param {*} value
- * @returns {*}
+ * @return {*}
  */
 function getSelectionCacheKey(value) {
 	return getSelectionStateKey.call(this, value);
@@ -2894,7 +2894,7 @@ function getSelectionCacheKey(value) {
  * @private
  * @param {*} current
  * @param {*} expected
- * @returns {boolean}
+ * @return {boolean}
  */
 function areLookupValuesEqual(current, expected) {
 	if (this.getOption("features.useStrictValueComparison") === true) {
@@ -2910,7 +2910,7 @@ function areLookupValuesEqual(current, expected) {
 /**
  * @private
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  */
 function markSelectionAsUnresolved(value) {
 	const key = getSelectionStateKey.call(this, value);
@@ -2925,7 +2925,7 @@ function markSelectionAsUnresolved(value) {
 /**
  * @private
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  */
 function clearUnresolvedSelectionValue(value) {
 	const key = getSelectionStateKey.call(this, value);
@@ -2935,7 +2935,7 @@ function clearUnresolvedSelectionValue(value) {
 /**
  * @private
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  */
 function isSelectionValueUnresolved(value) {
 	const key = getSelectionStateKey.call(this, value);
@@ -2945,7 +2945,7 @@ function isSelectionValueUnresolved(value) {
 /**
  * @private
  * @param {*} value
- * @returns {string}
+ * @return {string}
  */
 function getSelectionBadgeClass(value) {
 	const classes = new TokenList(this.getOption("classes.badge"));
@@ -2970,7 +2970,7 @@ function getSelectionBadgeClass(value) {
  * @private
  * @param {*} value
  * @param {string} [preferredLabel]
- * @returns {{class: string, label: string, unresolved: boolean, value: *}}
+ * @return {{class: string, label: string, unresolved: boolean, value: *}}
  */
 function buildSelectionItem(value, preferredLabel) {
 	let label = getSelectionLabel.call(this, value);
@@ -2995,7 +2995,7 @@ function buildSelectionItem(value, preferredLabel) {
 /**
  * @private
  * @param {string} filterValue
- * @returns {{label: string, value: string}}
+ * @return {{label: string, value: string}}
  */
 function buildCreatedOption(filterValue) {
 	return {
@@ -3006,7 +3006,7 @@ function buildCreatedOption(filterValue) {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getRawFilterInputValue() {
 	const element =
@@ -3020,7 +3020,7 @@ function getRawFilterInputValue() {
 /**
  * @private
  * @param {string} filterValue
- * @returns {{label: string, value: *}|null}
+ * @return {{label: string, value: *}|null}
  */
 function buildCreateOptionCandidate(filterValue) {
 	const formatter = this.getOption("formatter.createOption");
@@ -3055,7 +3055,7 @@ function buildCreateOptionCandidate(filterValue) {
  * @private
  * @param {{label: string, value: *}} candidate
  * @param {string} filterValue
- * @returns {boolean}
+ * @return {boolean}
  */
 function hasEquivalentCreateOption(candidate, filterValue) {
 	const normalizedFilter = filterValue.toLocaleLowerCase();
@@ -3080,7 +3080,7 @@ function hasEquivalentCreateOption(candidate, filterValue) {
 
 /**
  * @private
- * @returns {HTMLElement|null}
+ * @return {HTMLElement|null}
  */
 function ensureCreateOptionElement() {
 	if (!this.shadowRoot) {
@@ -3180,7 +3180,7 @@ function updateCreateOptionAction() {
  *
  * @private
  * @param {*} value
- * @returns {Promise<HTMLInputElement>}
+ * @return {Promise<HTMLInputElement>}
  */
 function waitForCreatedOptionControl(value) {
 	return new Promise((resolve, reject) => {
@@ -3216,7 +3216,7 @@ function waitForCreatedOptionControl(value) {
 
 /**
  * @private
- * @returns {Promise<boolean>}
+ * @return {Promise<boolean>}
  */
 async function createFilteredOption() {
 	updateCreateOptionAction.call(this);
@@ -3289,7 +3289,7 @@ async function createFilteredOption() {
 /**
  * @private
  * @param {string} value The value to look up.
- * @returns {Promise<void>}
+ * @return {Promise<void>}
  */
 async function lookupValueAndCache(value) {
 	const lifecycleVersion = getRemoteLifecycleVersion.call(this);
@@ -3554,7 +3554,7 @@ function initOptionObserver() {
 
 /**
  * @private
- * @returns {Translations}
+ * @return {Translations}
  */
 function getDefaultTranslation() {
 	const translation = new Translations("en").assignTranslations(
@@ -3666,7 +3666,7 @@ function getOptionElements() {
 
 /**
  * @private
- * @returns {HTMLElement[]}
+ * @return {HTMLElement[]}
  */
 function getNavigableOptionElements() {
 	if (!(this[optionsElementSymbol] instanceof HTMLElement)) {
@@ -4423,7 +4423,7 @@ function handleFilterInputEvents() {
 
 /**
  * @private
- * @returns {string|undefined}
+ * @return {string|undefined}
  */
 function getCurrentFilterInputValue() {
 	switch (this.getOption("filter.position")) {
@@ -4503,7 +4503,7 @@ function filterFromRemote() {
  * @private
  * @param url
  * @param {object} params
- * @returns {string}
+ * @return {string}
  */
 function formatURL(url, params = {}, formatOptions = {}) {
 	const preserveEmptyFilter = formatOptions?.preserveEmptyFilter === true;
@@ -5264,7 +5264,7 @@ function convertSelectionToValue(selection) {
 /**
  * @private
  * @param value
- * @returns {boolean}
+ * @return {boolean}
  *
  * Empty-equivalent matching is intentionally type-safe. Consumers that want
  * numeric `0` to count as empty must configure `0`, not `"0"`.
@@ -5284,7 +5284,7 @@ function isValueIsEmpty(value) {
 /**
  * @private
  * @param value
- * @returns {*}
+ * @return {*}
  */
 function isValueIsEmptyThenGetNormalize(value) {
 	let emptyDefault = null;
@@ -5305,7 +5305,7 @@ function isValueIsEmptyThenGetNormalize(value) {
  * @private
  * @param {Array} current
  * @param {Array} next
- * @returns {boolean}
+ * @return {boolean}
  */
 function areSelectionValuesEqual(current, next) {
 	if (!isArray(current) || !isArray(next)) {
@@ -5338,7 +5338,7 @@ function areSelectionValuesEqual(current, next) {
 /**
  * @private
  * @param selection
- * @returns {Promise<unknown | void>}
+ * @return {Promise<unknown | void>}
  */
 function setSelection(selection) {
 	if (isString(selection) || isInteger(selection)) {

package/source/components/form/sheet.mjs

@@ -64,6 +64,9 @@ const selectionMoveFrameSymbol = Symbol("sheetSelectionMoveFrame");
 const pendingFillMoveSymbol = Symbol("sheetPendingFillMove");
 const fillMoveFrameSymbol = Symbol("sheetFillMoveFrame");
 
+/**
+ * @summary Provides an editable tabular form control with selection and fill operations.
+ */
 class Sheet extends CustomControl {
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/sheet@@instance");

package/source/components/form/tabs.mjs

@@ -19,5 +19,6 @@ export { Tabs };
  * @since 1.10.0
  * @copyright Volker Schukai
  * @deprecated since 3.59.0 use Layout/Tabs instead
+ * @summary Provides the deprecated form alias for the layout tabs component.
  */
 class Tabs extends NewTabs {}

package/source/components/form/toggle-switch.mjs

@@ -329,7 +329,7 @@ class ToggleSwitch extends CustomControl {
 
 	/**
 	 *
-	 * @returns {string}
+	 * @return {string}
 	 */
 	static getTag() {
 		return "monster-toggle-switch";

package/source/components/form/util/fetch.mjs

@@ -20,7 +20,7 @@ import { validateInstance, validateString } from "../../../types/validate.mjs";
  * Traverse the element's ancestors to find an existing Shadow DOM.
  *
  * @param {HTMLElement} element - The starting element.
- * @returns {ShadowRoot|null} - The found Shadow DOM or null if none exists.
+ * @return {ShadowRoot|null} - The found Shadow DOM or null if none exists.
  */
 function findShadowRoot(element) {
 	while (element) {
@@ -41,7 +41,7 @@ function findShadowRoot(element) {
  * @param {string|URL} url - The URL from which to load the content.
  * @param {Object} options - Options for the fetch call.
  * @param {string} [filter] - Optional CSS selector to filter the loaded content.
- * @returns {Promise<Object>} A promise that resolves to an object containing { content: string, type: string | null }.
+ * @return {Promise<Object>} A promise that resolves to an object containing { content: string, type: string | null }.
  * @throws {Error} When the content cannot be read or the response contains an error.
  * @throws {TypeError} When the provided parameters do not match the expected types.
  */
@@ -104,7 +104,7 @@ function loadAndAssignContent(element, url, options, filter) {
  *
  * @param {string|URL} url - The URL from which to load the content.
  * @param {Object} options - Options for the fetch call.
- * @returns {Promise<Object>} A promise that resolves to an object { content: string, type: string | null }.
+ * @return {Promise<Object>} A promise that resolves to an object { content: string, type: string | null }.
  * @throws {Error} When the content cannot be read or the response contains an error.
  * @throws {TypeError} When the URL cannot be validated as a string.
  */

package/source/components/form/variant-select.mjs

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

package/source/components/form/wizard.mjs

@@ -247,9 +247,7 @@ class Wizard extends CustomElement {
 	 * Navigate to the requested panel index.
 	 *
 	 * @param {number} targetIndex
-	 * @param {Object} [options]
-	 * @param {boolean} [options.force=false]
-	 * @param {string} [options.reason="api"]
+	 * @param {Object} [options] Optional force flag and navigation reason.
 	 * @return {Promise<boolean>}
 	 */
 	async goTo(targetIndex, options = {}) {

package/source/components/host/collapse.mjs

@@ -19,5 +19,6 @@ export { Collapse };
  * @since 1.10.0
  * @copyright Volker Schukai
  * @deprecated since 3.64.0 use Layout.Collapse instead
+ * @summary Provides the deprecated host alias for the layout collapse component.
  */
 class Collapse extends NewCollapse {}

package/source/components/host/config-manager.mjs

@@ -378,7 +378,7 @@ function removeConfig(key) {
 
 /**
  * @private
- * @returns {Promise<unknown>}
+ * @return {Promise<unknown>}
  */
 function openDatabase() {
 	const window = getWindow();
@@ -508,7 +508,7 @@ function deleteBlob(key) {
  * @private
  * @param key
  * @param blob
- * @returns {Promise<unknown>}
+ * @return {Promise<unknown>}
  */
 function setBlob(key, blob) {
 	const store = getObjectStore.call(this, MODE_READ_WRITE);

package/source/components/host/details.mjs

@@ -19,5 +19,6 @@ export { Details };
  * @since 1.10.0
  * @copyright Volker Schukai
  * @deprecated since 3.64.0 use {@link Monster.Components.Layout.Details}
+ * @summary Provides the deprecated host alias for the layout details component.
  */
 class Details extends NewDetails {}

package/source/components/host/host.mjs

@@ -159,7 +159,7 @@ class Host extends CustomElement {
 
 	/**
 	 * @param {string} key
-	 * @returns {*}
+	 * @return {*}
 	 */
 	hasConfig(key) {
 		if (this[configManagerElementSymbol] instanceof HTMLElement === false) {
@@ -171,7 +171,7 @@ class Host extends CustomElement {
 	/**
 	 *
 	 * @param {key} key
-	 * @returns {*}
+	 * @return {*}
 	 */
 	deleteConfig(key) {
 		if (this[configManagerElementSymbol] instanceof HTMLElement === false) {

package/source/components/host/overlay.mjs

@@ -19,5 +19,6 @@ export { Overlay };
  * @since 1.10.0
  * @copyright Volker Schukai
  * @deprecated since 3.116.0 use Layout/Overlay instead
+ * @summary Provides the deprecated host alias for the layout overlay component.
  */
 class Overlay extends NewOverlay {}

package/source/components/host/viewer.mjs

@@ -18,5 +18,6 @@ export { Viewer };
 /**
  * @copyright Volker Schukai
  * @deprecated since 3.102.0 use Content/Viewer instead
+ * @summary Provides the deprecated host alias for the content viewer component.
  */
 class Viewer extends NewViewer {}

package/source/components/layout/board.mjs

@@ -56,7 +56,7 @@ export const parkingElementSymbol = Symbol("parkingElement");
 class Board extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/board@@instance");

package/source/components/layout/collapse.mjs

@@ -286,7 +286,7 @@ function runEventQueue() {
 
 /**
  * @private
- * @returns {handleCloseCommand}
+ * @return {handleCloseCommand}
  */
 function handleCloseCommand() {
 	if (!this[detailsElementSymbol].classList.contains("active")) {
@@ -311,7 +311,7 @@ function handleCloseCommand() {
 
 /**
  * @private
- * @returns {handleOpenCommand}
+ * @return {handleOpenCommand}
  */
 function handleOpenCommand() {
 	let node;

package/source/components/layout/details.mjs

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

package/source/components/layout/full-screen.mjs

@@ -59,7 +59,7 @@ export const fullScreenExitElementSymbol = Symbol("fullScreenExitElement");
 class FullScreen extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -181,7 +181,7 @@ function initControlReferences() {
 
 /**
  * @private
- * @returns {*}
+ * @return {*}
  */
 function findTargetControl() {
 	const rootNode = this.getRootNode?.() ?? document;

package/source/components/layout/popper.mjs

@@ -161,7 +161,7 @@ class Popper extends CustomElement {
 	 * @property {string} popper.contentOverflow - Content clipping mode: both|horizontal|visible|smart
 	 * @property {Object} features - Feature flags
 	 * @property {boolean} features.preventOpenEventSent - Prevent open event
-	 * @returns {Object} Default options merged with parent defaults
+	 * @return {Object} Default options merged with parent defaults
 	 */
 	get defaults() {
 		return Object.assign({}, super.defaults, {