@schukai/monster 4.132.0 → 4.134.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1 +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.","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":"4.132.0"}
1
+ {"author":"Volker Schukai","dependencies":{"@floating-ui/dom":"^1.7.6"},"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":"4.134.0"}
@@ -48,7 +48,7 @@ const ATTRIBUTE_CALL = `${ATTRIBUTE_PREFIX}call`;
48
48
  * @example /examples/components/host/call-button-simple Call button
49
49
  *
50
50
  * @copyright Volker Schukai
51
- * @summary A call button component that can call a method of another element.
51
+ * @summary A trigger button that calls a documented method on one or more referenced elements.
52
52
  */
53
53
  class CallButton extends CustomElement {
54
54
  /**
@@ -56,7 +56,7 @@ const MODE_READ_WRITE = "readwrite";
56
56
  * @example /examples/components/host/config-manager-simple Config manager
57
57
  *
58
58
  * @copyright Volker Schukai
59
- * @summary A config manager component
59
+ * @summary A configuration manager for persisting and retrieving client-side settings across sessions.
60
60
  */
61
61
  class ConfigManager extends CustomElement {
62
62
  /**
@@ -26,7 +26,7 @@ export { ToggleButton };
26
26
  * @example /examples/components/host/toggle-button-simple Toggle button
27
27
  *
28
28
  * @copyright Volker Schukai
29
- * @summary A toggle button
29
+ * @summary A specialized call button that triggers toggle behavior on a referenced target element.
30
30
  */
31
31
  class ToggleButton extends CallButton {
32
32
  /**
@@ -68,7 +68,7 @@ const calendarBodyElementSymbol = Symbol("calendarBodyElement");
68
68
  *
69
69
  * @since 3.112.0
70
70
  * @copyright Volker Schukai
71
- * @summary A beautiful month Calendar that can display appointments. It is possible to use a datasource to load the appointments.
71
+ * @summary A month calendar for appointments and date-based planning, with optional datasource-driven event loading.
72
72
  */
73
73
  class MonthCalendar extends CustomElement {
74
74
  /**
@@ -36,7 +36,7 @@ const controlElementSymbol = Symbol("calendarElement");
36
36
  *
37
37
  * @since 3.113.0
38
38
  * @copyright Volker Schukai
39
- * @summary An appointment is a part of the calendar that represents a single appointment.
39
+ * @summary A timeline appointment block that represents one scheduled item within a calendar or timeline view.
40
40
  */
41
41
  class Appointment extends CustomElement {
42
42
  /**
@@ -49,7 +49,7 @@ const controlElementSymbol = Symbol("calendarElement");
49
49
  *
50
50
  * @since 3.112.0
51
51
  * @copyright Volker Schukai
52
- * @summary A calendar segment is a part of the calendar that represents a single appointment.
52
+ * @summary A timeline segment block for labeled schedule ranges such as shifts, phases or reserved periods.
53
53
  */
54
54
  class Segment extends CustomElement {
55
55
  /**
@@ -51,7 +51,7 @@ const internalDataSymbol = Symbol.for(
51
51
  * @license AGPLv3
52
52
  * @since 1.22.0
53
53
  * @copyright Volker Schukai
54
- * @summary The datasource class encapsulates the access to data objects.
54
+ * @summary A datasource abstraction for reading, observing and writing structured application data.
55
55
  */
56
56
  class Datasource extends Base {
57
57
  /**
@@ -87,7 +87,7 @@ const WILDCARD = "*";
87
87
  * @license AGPLv3
88
88
  * @since 1.4.0
89
89
  * @copyright Volker Schukai
90
- * @summary Pathfinder is a class to find a path to an object.
90
+ * @summary A path resolution utility for reading nested values from complex objects and records.
91
91
  */
92
92
  class Pathfinder extends Base {
93
93
  /**
@@ -37,7 +37,7 @@ const DELIMITER = "|";
37
37
  * @license AGPLv3
38
38
  * @since 1.5.0
39
39
  * @copyright Volker Schukai
40
- * @summary The pipe class makes it possible to combine several processing steps.
40
+ * @summary A processing pipeline utility for chaining multiple data transformation steps.
41
41
  */
42
42
  class Pipe extends Base {
43
43
  /**
@@ -52,7 +52,7 @@ export { Transformer };
52
52
  *
53
53
  * @since 1.5.0
54
54
  * @copyright Volker Schukai
55
- * @summary The transformer class is a swiss army knife for manipulating values. especially in combination with the pipe, processing chains can be built up.
55
+ * @summary A value transformation utility for formatting, mapping and reshaping data inside processing chains.
56
56
  */
57
57
  class Transformer extends Base {
58
58
  /**
@@ -32,7 +32,7 @@ const ATTRIBUTEPREFIX = "data-monster-";
32
32
  * @license AGPLv3
33
33
  * @since 1.6.0
34
34
  * @copyright Volker Schukai
35
- * @summary Allows you to build an html fragment
35
+ * @summary A DOM assembler for creating HTML fragments from templates and structured configuration.
36
36
  */
37
37
  class Assembler extends Base {
38
38
  /**
@@ -51,7 +51,7 @@ const attachedInternalSymbol = Symbol("attachedInternal");
51
51
  *
52
52
  * @fragments /fragments/libraries/dom/customcontrol/
53
53
  *
54
- * @summary A base class for custom controls based on CustomElement.
54
+ * @summary A form-oriented base class for Monster controls with value handling, validation and control semantics.
55
55
  * @license AGPLv3
56
56
  * @since 1.14.0
57
57
  */
@@ -194,7 +194,7 @@ let hostVisibilityStyleSheet = null;
194
194
  * @license AGPLv3
195
195
  * @since 1.7.0
196
196
  * @copyright Volker Schukai
197
- * @summary A base class for HTML5 custom controls.
197
+ * @summary The core base class for building Monster custom elements with options, lifecycle hooks and templating support.
198
198
  */
199
199
  class CustomElement extends HTMLElement {
200
200
  /**
@@ -46,7 +46,7 @@ const stackSymbol = Symbol("stack");
46
46
  * @since 1.25.0
47
47
  * @copyright Volker Schukai
48
48
  * @throws {Error} unsupported locale
49
- * @summary Handle the focus
49
+ * @summary A focus management helper for moving and restoring focus across interactive DOM regions.
50
50
  */
51
51
  class FocusManager extends BaseWithOptions {
52
52
  /**
@@ -28,7 +28,7 @@ export { Template };
28
28
  * @license AGPLv3
29
29
  * @since 1.6.0
30
30
  * @copyright Volker Schukai
31
- * @summary A template class
31
+ * @summary A template helper for resolving, cloning and preparing reusable DOM templates.
32
32
  */
33
33
  class Template extends Base {
34
34
  /**
@@ -26,7 +26,7 @@ export { Theme, getDocumentTheme };
26
26
  * @license AGPLv3
27
27
  * @since 1.7.0
28
28
  * @copyright Volker Schukai
29
- * @summary A theme class
29
+ * @summary A theme utility for applying and coordinating Monster theme state in the DOM.
30
30
  */
31
31
  class Theme extends Base {
32
32
  /**
@@ -115,7 +115,7 @@ const queuedSnapshotSymbol = Symbol("queuedSnapshot");
115
115
  * @throws {Error} the maximum depth for the recursion is reached.
116
116
  * @throws {TypeError} value is not a object
117
117
  * @throws {TypeError} value is not an instance of HTMLElement
118
- * @summary The updater class connects an object with the dom
118
+ * @summary A DOM updater that binds structured data objects to templates and rendered document fragments.
119
119
  */
120
120
  class Updater extends Base {
121
121
  /**
@@ -35,6 +35,7 @@ const internalTranslationSymbol = Symbol("internalTranslation");
35
35
  * @license AGPLv3
36
36
  * @since 1.26.0
37
37
  * @copyright Volker Schukai
38
+ * @summary An i18n formatter for locale-aware number, date and text presentation.
38
39
  */
39
40
  class Formatter extends TextFormatter {
40
41
  /**
@@ -68,6 +68,7 @@ const localeStringSymbol = Symbol("localeString");
68
68
  * @license AGPLv3
69
69
  * @since 1.13.0
70
70
  * @copyright Volker Schukai
71
+ * @summary A locale value object for parsing, validating and formatting language-region identifiers.
71
72
  * @see https://datatracker.ietf.org/doc/html/rfc3066
72
73
  */
73
74
  class Locale extends Base {
@@ -41,6 +41,7 @@ const translationsLinkSymbol = Symbol.for(
41
41
  * @license AGPLv3
42
42
  * @since 1.13.0
43
43
  * @copyright Volker Schukai
44
+ * @summary A translation provider base class for loading and attaching locale-dependent text sources.
44
45
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
45
46
  */
46
47
  class Provider extends BaseWithOptions {
@@ -30,6 +30,7 @@ export { Embed };
30
30
  * @license AGPLv3
31
31
  * @since 1.13.0
32
32
  * @copyright Volker Schukai
33
+ * @summary A translation provider that reads embedded locale resources from the current document.
33
34
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
34
35
  */
35
36
  class Embed extends Provider {
@@ -31,6 +31,7 @@ export { Fetch };
31
31
  * @license AGPLv3
32
32
  * @since 1.13.0
33
33
  * @copyright Volker Schukai
34
+ * @summary A translation provider that loads locale resources from remote endpoints via fetch.
34
35
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
35
36
  * @tutorial i18n-locale-and-formatter
36
37
  */
@@ -39,6 +39,7 @@ export { Translations, getDocumentTranslations };
39
39
  * @license AGPLv3
40
40
  * @since 1.13.0
41
41
  * @copyright Volker Schukai
42
+ * @summary A translation registry for storing localized text keys and resolving plural-aware output.
42
43
  * @see https://datatracker.ietf.org/doc/html/rfc3066
43
44
  */
44
45
  class Translations extends Base {
@@ -25,6 +25,7 @@ export { ConsoleHandler };
25
25
  * @license AGPLv3
26
26
  * @since 1.5.0
27
27
  * @copyright Volker Schukai
28
+ * @summary A logging handler that writes Monster log entries to the browser console.
28
29
  */
29
30
  class ConsoleHandler extends Handler {
30
31
  /**
@@ -25,6 +25,7 @@ export { Handler };
25
25
  * @license AGPLv3
26
26
  * @since 1.5.0
27
27
  * @copyright Volker Schukai
28
+ * @summary A logging handler base class for processing and exporting log entries.
28
29
  */
29
30
  class Handler extends Base {
30
31
  constructor() {
@@ -23,6 +23,7 @@ export { LogEntry };
23
23
  * @license AGPLv3
24
24
  * @since 1.5.0
25
25
  * @copyright Volker Schukai
26
+ * @summary A log entry value object that stores level, message, context and timestamp information.
26
27
  */
27
28
  class LogEntry extends Base {
28
29
  /**
@@ -71,6 +71,7 @@ const OFF = 0;
71
71
  * @license AGPLv3
72
72
  * @since 1.5.0
73
73
  * @copyright Volker Schukai
74
+ * @summary A logger for collecting log entries and forwarding them to one or more handlers.
74
75
  */
75
76
  class Logger extends Base {
76
77
  /**
@@ -25,7 +25,7 @@ const dataSymbol = Symbol("@@data");
25
25
  * @license AGPLv3
26
26
  * @since 3.4.0
27
27
  * @copyright Volker Schukai
28
- * @summary The Message class encapsulates a WebSocket message.
28
+ * @summary A structured WebSocket message object for typed payload exchange over WebConnect.
29
29
  */
30
30
  class Message extends Base {
31
31
  /**
@@ -213,7 +213,7 @@ function connectServer(resolve, reject) {
213
213
  * @license AGPLv3
214
214
  * @since 3.1.0
215
215
  * @copyright Volker Schukai
216
- * @summary The LocalStorage class encapsulates the access to data objects.
216
+ * @summary A WebSocket connection wrapper for sending, receiving and observing structured real-time messages.
217
217
  */
218
218
  class WebConnect extends BaseWithOptions {
219
219
  /**