@schukai/monster 1.31.0 → 2.0.2

package/source/dom/{resourcemanager.js → resourcemanager.mjs}

@@ -1,46 +1,32 @@
-'use strict';
-
 /**
- * @author schukai GmbH
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {extend} from "../data/extend.js";
-import {assignToNamespace, Monster} from "../namespace.js";
-import {BaseWithOptions} from "../types/basewithoptions.js";
-import {getGlobalObject} from "../types/global.js";
-import {isArray} from "../types/is.js";
-import {ATTRIBUTE_HREF, ATTRIBUTE_SRC} from "./constants.js";
-import {Resource} from "./resource.js";
-import {Data} from "./resource/data.js";
-import {Stylesheet} from "./resource/link/stylesheet.js";
-import {Script} from "./resource/script.js";
+import {extend} from "../data/extend.mjs";
+import {BaseWithOptions} from "../types/basewithoptions.mjs";
+import {getGlobalObject} from "../types/global.mjs";
+import {isArray} from "../types/is.mjs";
+import {ATTRIBUTE_HREF, ATTRIBUTE_SRC} from "./constants.mjs";
+import {Resource} from "./resource.mjs";
+import {Data} from "./resource/data.mjs";
+import {Stylesheet} from "./resource/link/stylesheet.mjs";
+import {Script} from "./resource/script.mjs";
 
+export {ResourceManager}
 
 /**
- * You can call the method via the monster namespace `new Monster.DOM.ResourceManager()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.DOM.ResourceManager()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Resource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/resourcemanager.js';
- * new ResourceManager()
- * </script>
- * ```
+ * The ResourceManager is a singleton that manages all resources.
  *
+ * @license AGPLv3
  * @since 1.25.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
  * @summary A Resource class
  */
-class ResourceManager extends BaseWithOptions {
+ class ResourceManager extends BaseWithOptions {
 
     /**
      *
@@ -208,7 +194,3 @@ function addResource(type, url, options) {
     (self.getOption('resources')?.[type]).push(resource);
     return self;
 }
-
-
-assignToNamespace('Monster.DOM', ResourceManager);
-export {Monster, ResourceManager}

package/source/dom/{template.js → template.mjs}

@@ -1,34 +1,22 @@
-'use strict';
-
 /**
- * @author schukai GmbH
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
-import {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from '../types/base.js';
-import {getGlobalFunction, getGlobalObject} from '../types/global.js';
-import {validateInstance, validateString} from "../types/validate.js";
-import {ATTRIBUTE_TEMPLATE_PREFIX} from "./constants.js";
-import {getDocumentTheme} from "./theme.js";
+
+import {Base} from '../types/base.mjs';
+import {getGlobalFunction, getGlobalObject} from '../types/global.mjs';
+import {validateInstance, validateString} from "../types/validate.mjs";
+import {ATTRIBUTE_TEMPLATE_PREFIX} from "./constants.mjs";
+import {getDocumentTheme} from "./theme.mjs";
+
+export {Template}
 
 /**
- * you can call the method via the monster namespace `new Monster.DOM.Template()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.DOM.Template()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Template} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/template.js';
- * new Template()
- * </script>
- * ```
+ * The template class provides methods for creating templates.
  *
+ * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -86,23 +74,14 @@ class Template extends Base {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * Monster.DOM.findDocumentTemplate()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {findTemplate} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/template.js';
+ * import {findTemplate} from '@schukai/monster/source/dom/template.mjs';
  * findDocumentTemplate()
  * </script>
  * ```
  *
  * @example
  *
- * import { findDocumentTemplate } from "https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/template.js";
+ * import { findDocumentTemplate } from "https://cdn.jsdelivr.net/npm/@schukai/monster@latest/source/dom/template.mjs";
  *
  * const template = document.createElement("template");
  * template.id = "myTemplate";
@@ -133,13 +112,14 @@ class Template extends Base {
  * @param {string} id
  * @param {Node} currentNode
  * @return {Monster.DOM.Template}
+ * @license AGPLv3
  * @since 1.7.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
  * @throws {Error} template id not found.
  * @throws {TypeError} value is not a string
  */
-function findDocumentTemplate(id, currentNode) {
+export function findDocumentTemplate(id, currentNode) {
     validateString(id);
 
     const document = getGlobalObject('document');
@@ -219,8 +199,3 @@ function findDocumentTemplate(id, currentNode) {
     throw new Error("template " + id + " not found.")
 }
 
-
-assignToNamespace('Monster.DOM', Template, findDocumentTemplate);
-export {Monster, Template, findDocumentTemplate}
-
-

package/source/dom/{theme.js → theme.mjs}

@@ -1,42 +1,22 @@
-'use strict';
-
 /**
- * @author schukai GmbH
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
-import {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from '../types/base.js';
-import {getGlobalObject} from '../types/global.js';
-import {validateString} from "../types/validate.js";
-import {ATTRIBUTE_THEME_NAME, DEFAULT_THEME} from "./constants.js";
 
+import {Base} from '../types/base.mjs';
+import {getGlobalObject} from '../types/global.mjs';
+import {validateString} from "../types/validate.mjs";
+import {ATTRIBUTE_THEME_NAME, DEFAULT_THEME} from "./constants.mjs";
+
+export {Theme, getDocumentTheme}
 
 /**
- * You can call the method via the monster namespace `new Monster.DOM.Theme()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.DOM.Theme())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Theme} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/theme.js';
- * console.log(new Theme())
- * </script>
- * ```
- *
- * @example
- *
- * import {getDocumentTheme} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/theme.js';
- *
- * const theme = getDocumentTheme();
- * console.log(theme.getName());
- * // ↦ monster
+ * The Theme class provides the functionality for the theme.
  *
+ * @externalExample ../../example/dom/theme.mjs
+ * @license AGPLv3
  * @since 1.7.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -79,6 +59,7 @@ class Theme extends Base {
  *
  * @return {Theme}
  * @memberOf Monster.DOM
+ * @license AGPLv3
  * @since 1.7.0
  */
 function getDocumentTheme() {
@@ -96,6 +77,3 @@ function getDocumentTheme() {
     return new Theme(name);
 
 }
-
-assignToNamespace('Monster.DOM', Theme, getDocumentTheme);
-export {Monster, Theme, getDocumentTheme}

package/source/dom/{updater.js → updater.mjs}

@@ -1,13 +1,14 @@
-'use strict';
-
 /**
- * @author schukai GmbH
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol} from "../constants.js";
-import {diff} from "../data/diff.js";
-import {Pathfinder} from "../data/pathfinder.js";
-import {Pipe} from "../data/pipe.js";
+import {internalSymbol} from "../constants.mjs";
+import {diff} from "../data/diff.mjs";
+import {Pathfinder} from "../data/pathfinder.mjs";
+import {Pipe} from "../data/pipe.mjs";
 import {
     ATTRIBUTE_ERRORMESSAGE,
     ATTRIBUTE_UPDATER_ATTRIBUTES,
@@ -17,19 +18,20 @@ import {
     ATTRIBUTE_UPDATER_REMOVE,
     ATTRIBUTE_UPDATER_REPLACE,
     ATTRIBUTE_UPDATER_SELECT_THIS
-} from "../dom/constants.js";
-import {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from "../types/base.js";
-import {isArray, isInstance, isIterable} from "../types/is.js";
-import {Observer} from "../types/observer.js";
-import {ProxyObserver} from "../types/proxyobserver.js";
-import {validateArray, validateInstance} from "../types/validate.js";
-import {clone} from "../util/clone.js";
-import {trimSpaces} from "../util/trimspaces.js";
-import {findTargetElementFromEvent} from "./events.js";
-import {findDocumentTemplate} from "./template.js";
-import {getDocument} from "./util.js";
+} from "../dom/constants.mjs";
+
+import {Base} from "../types/base.mjs";
+import {isArray, isInstance, isIterable} from "../types/is.mjs";
+import {Observer} from "../types/observer.mjs";
+import {ProxyObserver} from "../types/proxyobserver.mjs";
+import {validateArray, validateInstance} from "../types/validate.mjs";
+import {clone} from "../util/clone.mjs";
+import {trimSpaces} from "../util/trimspaces.mjs";
+import {findTargetElementFromEvent} from "./events.mjs";
+import {findDocumentTemplate} from "./template.mjs";
+import {getDocument} from "./util.mjs";
 
+export {Updater}
 
 /**
  * The updater class connects an object with the dom. In this way, structures and contents in the DOM can be programmatically adapted via attributes.
@@ -40,50 +42,8 @@ import {getDocument} from "./util.js";
  * Changes to attributes are made only when the direct values are changed. If you want to assign changes 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.
  *
- * You can create an object of this class using the monster namespace `new Monster.DOM.Updater()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.DOM.Updater()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Updater} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/updater.js';
- * new Updater()
- * </script>
- * ```
- *
- * @example
- *
- * import {Updater} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/updater.js';
- *
- * // First we prepare the html document.
- * // This is done here via script, but can also be inserted into the document as pure html.
- * // To do this, simply insert the tag <h1 data-monster-replace="path:headline"></h1>.
- * const body = document.querySelector('body');
- * const headline = document.createElement('h1');
- * headline.setAttribute('data-monster-replace','path:headline')
- * body.appendChild(headline);
- *
- * // the data structure
- * let obj = {
- *    headline: "Hello World",
- * };
- *
- * // Now comes the real magic. we pass the updater the parent HTMLElement
- * // and the desired data structure.
- * const updater = new Updater(body, obj);
- * updater.run();
- *
- * // Now you can change the data structure and the HTML will follow these changes.
- * const subject = updater.getSubject();
- * subject['headline'] = "Hello World!"
- *
+ * @externalExample ../../example/dom/updater.mjs
+ * @license AGPLv3
  * @since 1.8.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -263,6 +223,7 @@ class Updater extends Base {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.9.0
  * @return {function
  * @this Updater
@@ -402,6 +363,7 @@ function retrieveAndSetValue(element) {
 }
 
 /**
+ * @license AGPLv3
  * @since 1.27.0
  * @return void
  * @private
@@ -421,6 +383,7 @@ function retrieveFromBindings() {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.8.0
  * @param {object} change
  * @return {void}
@@ -435,6 +398,7 @@ function removeElement(change) {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.8.0
  * @param {object} change
  * @return {void}
@@ -568,6 +532,7 @@ function insertElement(change) {
 /**
  *
  * @private
+ * @license AGPLv3
  * @since 1.8.0
  * @param {HTMLElement} container
  * @param {string} key
@@ -593,6 +558,7 @@ function appendNewDocumentFragment(container, key, ref, path) {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.10.0
  * @param {HTMLElement} node
  * @param {string} key
@@ -621,6 +587,7 @@ function applyRecursive(node, key, path) {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.8.0
  * @param {object} change
  * @return {void}
@@ -647,6 +614,7 @@ function updateContent(change) {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.8.0
  * @param {HTMLElement} container
  * @param {array} parts
@@ -677,7 +645,7 @@ function runUpdateContent(container, parts, subject) {
         }
 
         /**
-         * @type {HTMLElement} element
+         * @type {HTMLElement}
          */
         for (const [element] of iterator.entries()) {
 
@@ -704,7 +672,7 @@ function runUpdateContent(container, parts, subject) {
                 while (element.firstChild) {
                     element.removeChild(element.firstChild);
                 }
-                
+
                 try {
                     element.appendChild(value);
                 } catch (e) {
@@ -724,6 +692,7 @@ function runUpdateContent(container, parts, subject) {
 
 /**
  * @private
+ * @license AGPLv3
  * @since 1.8.0
  * @param {string} path
  * @param {object} change
@@ -900,6 +869,3 @@ function handleInputControlAttributeUpdate(element, name, value) {
     }
 
 }
-
-assignToNamespace('Monster.DOM', Updater);
-export {Monster, Updater}

package/source/dom/{util.js → util.mjs}

@@ -1,33 +1,19 @@
-'use strict';
-
 /**
- * @author schukai GmbH
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
-import {assignToNamespace, Monster} from '../namespace.js';
-import {getGlobal} from "../types/global.js";
-import {validateString} from "../types/validate.js";
 
+import {getGlobal} from "../types/global.mjs";
+import {validateString} from "../types/validate.mjs";
+
+export {getDocument, getWindow, getDocumentFragmentFromString}
 
 /**
- * this method fetches the document object
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(Monster.DOM.getDocument())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {getDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/util.js';
- * console.log(getDocument())
- * </script>
- * ```
+ * This method fetches the document object
  *
- * in nodejs this functionality can be performed with [jsdom](https://www.npmjs.com/package/jsdom).
+ * In nodejs this functionality can be performed with [jsdom](https://www.npmjs.com/package/jsdom).
  *
  * ```
  * import {JSDOM} from "jsdom"
@@ -55,6 +41,7 @@ import {validateString} from "../types/validate.js";
  * ```
  *
  * @returns {object}
+ * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -70,25 +57,9 @@ function getDocument() {
 }
 
 /**
- * this method fetches the window object
+ * This method fetches the window object
  *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(Monster.DOM.getWindow())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {getWindow} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/util.js';
- * console.log(getWindow(null))
- * </script>
- * ```
- *
- * in nodejs this functionality can be performed with [jsdom](https://www.npmjs.com/package/jsdom).
+ * In nodejs this functionality can be performed with [jsdom](https://www.npmjs.com/package/jsdom).
  *
  * ```
  * import {JSDOM} from "jsdom"
@@ -118,6 +89,7 @@ function getDocument() {
  * ```
  *
  * @returns {object}
+ * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -134,27 +106,9 @@ function getWindow() {
 
 
 /**
+ * This method fetches the document object
  *
- *
- * this method fetches the document object
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(Monster.DOM.getDocumentFragmentFromString())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {getDocumentFragmentFromString} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/util.js';
- * console.log(getDocumentFragmentFromString('<div></div>'))
- * </script>
- * ```
- *
- * in nodejs this functionality can be performed with [jsdom](https://www.npmjs.com/package/jsdom).
+ * In nodejs this functionality can be performed with [jsdom](https://www.npmjs.com/package/jsdom).
  *
  * ```
  * import {JSDOM} from "jsdom"
@@ -182,6 +136,7 @@ function getWindow() {
  * ```
  *
  * @returns {DocumentFragment}
+ * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -197,7 +152,3 @@ function getDocumentFragmentFromString(html) {
 
     return template.content;
 }
-
-
-assignToNamespace('Monster.DOM', getWindow, getDocument, getDocumentFragmentFromString);
-export {Monster, getWindow, getDocument, getDocumentFragmentFromString}

package/source/dom/worker/{factory.js → factory.mjs}

@@ -1,39 +1,22 @@
-'use strict';
-
-
 /**
- * @author schukai GmbH
+ * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+ * Node module: @schukai/monster
+ * This file is licensed under the AGPLv3 License.
+ * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
+import {internalSymbol} from "../../constants.mjs";
+import {Base} from "../../types/base.mjs";
+import {getGlobal, getGlobalFunction} from "../../types/global.mjs";
+import {isFunction} from "../../types/is.mjs";
+import {validateInstance, validateString} from "../../types/validate.mjs";
 
-import {internalSymbol} from "../../constants.js";
-import {assignToNamespace, Monster} from "../../namespace.js";
-import {Base} from "../../types/base.js";
-import {getGlobal, getGlobalFunction} from "../../types/global.js";
-import {isFunction} from "../../types/is.js";
-import {validateInstance, validateString} from "../../types/validate.js";
-
-
+export {Factory}
 
 /**
- * You can call the function via the monster namespace `new Monster.DOM.Worker.getLocaleOfDocument()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.DOM.Worker.Factory())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Factory} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/worker/factory.js';
- * console.log(new Factory())
- * </script>
- * ```
- *
+ * A factory for creating worker instances.
+ * 
+ * @license AGPLv3
  * @since 1.25.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM.Worker
@@ -41,7 +24,6 @@ import {validateInstance, validateString} from "../../types/validate.js";
  */
 class Factory extends Base {
 
-
     /**
      *
      */
@@ -129,6 +111,3 @@ class Factory extends Base {
 
 
 }
-
-assignToNamespace('Monster.DOM.Worker', Factory);
-export {Monster, Factory}

package/source/dom/worker/namespace.mjs

@@ -0,0 +1,8 @@
+/**
+ * In this namespace you will find classes and methods for handling the DOM.
+ *
+ * @namespace Monster.DOM.Worker
+ * @memberOf Monster
+ * @author schukai GmbH
+ */
+const ns = {};