@schukai/monster 1.30.0 → 2.0.0

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

@@ -1,14 +1,30 @@
-'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 {getGlobalFunction} from "../types/global.js";
-import {TokenList} from "../types/tokenlist.js";
-import {validateInstance, validateString, validateSymbol} from "../types/validate.js";
-import {ATTRIBUTE_OBJECTLINK} from "./constants.js";
+import {getGlobalFunction} from "../types/global.mjs";
+import {TokenList} from "../types/tokenlist.mjs";
+import {validateInstance, validateString, validateSymbol} from "../types/validate.mjs";
+import {ATTRIBUTE_OBJECTLINK} from "./constants.mjs";
+
+export {
+    findClosestObjectLink,
+    addToObjectLink,
+    removeObjectLink,
+    hasObjectLink,
+    getLinkedObjects,
+    toggleAttributeToken,
+    addAttributeToken,
+    removeAttributeToken,
+    containsAttributeToken,
+    replaceAttributeToken,
+    clearAttributeTokens,
+    findClosestByAttribute,
+    findClosestByClass
+}
 
 /**
  * Get the closest object link of a node
@@ -16,26 +32,9 @@ import {ATTRIBUTE_OBJECTLINK} from "./constants.js";
  * if a node is specified without a object link, a recursive search upwards is performed until the corresponding
  * object link is found, or undefined is returned.
  *
- * you can call the method via the monster namespace `Monster.DOM.getUpdaterFromNode()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * console.log(Monster.DOM.findClosestObjectLink())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {getUpdaterFromNode} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/updater.js';
- * console.log(findClosestObjectLink())
- * </script>
- * ```
- *
  * @param {HTMLElement} element
  * @return {HTMLElement|undefined}
+ * @license AGPLv3
  * @since 1.10.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -46,24 +45,9 @@ function findClosestObjectLink(element) {
 }
 
 /**
- * You can call the method via the monster namespace `new Monster.DOM.addToObjectLink()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.addToObjectLink();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {addToObjectLink} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * addToObjectLink();
- * </script>
- * ```
+ * Adds a class attribute to an element.
  *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -88,24 +72,9 @@ function addToObjectLink(element, symbol, object) {
 }
 
 /**
- * You can call the method via the monster namespace `new Monster.DOM.removeObjectLink()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.removeObjectLink();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {removeObjectLink} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * removeObjectLink();
- * </script>
- * ```
+ * Removes an object from an element
  *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -130,24 +99,9 @@ function removeObjectLink(element, symbol) {
 
 
 /**
- * You can call the method via the monster namespace `new Monster.DOM.hasObjectLink()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.hasObjectLink();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {hasObjectLink} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * hasObjectLink();
- * </script>
- * ```
+ * Checks if an element has an object link
  *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -176,24 +130,7 @@ function hasObjectLink(element, symbol) {
  *
  * With the method  {@see {@link addToObjectLink}} the objects can be added.
  *
- * You can call the method via the monster namespace `new Monster.DOM.getLinkedObjects()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.getLinkedObjects();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {getLinkedObjects} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * getLinkedObjects();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -221,24 +158,7 @@ function getLinkedObjects(element, symbol) {
  *
  * Tokens are always separated by a space.
  *
- * You can call the method via the monster namespace `new Monster.DOM.toggleAttributeToken()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.toggleAttributeToken();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {toggleAttributeToken} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * toggleAttributeToken();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -265,24 +185,7 @@ function toggleAttributeToken(element, key, token) {
 /**
  * This method can be used to add a token to an attribute. Tokens are always separated by a space.
  *
- * You can call the method via the monster namespace `new Monster.DOM.addAttributeToken()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.addAttributeToken();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {addAttributeToken} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * addAttributeToken();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -311,24 +214,7 @@ function addAttributeToken(element, key, token) {
  *
  * Tokens are always separated by a space.
  *
- * You can call the method via the monster namespace `new Monster.DOM.removeAttributeToken()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.removeAttributeToken();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {removeAttributeToken} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * removeAttributeToken();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -356,24 +242,7 @@ function removeAttributeToken(element, key, token) {
  *
  * Tokens are always separated by a space.
  *
- * You can call the method via the monster namespace `new Monster.DOM.containsAttributeToken()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.containsAttributeToken();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {containsAttributeToken} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * containsAttributeToken();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -398,24 +267,7 @@ function containsAttributeToken(element, key, token) {
 /**
  * Tokens are always separated by a space.
  *
- * You can call the method via the monster namespace `new Monster.DOM.replaceAttributeToken()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.replaceAttributeToken();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {replaceAttributeToken} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * replaceAttributeToken();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -443,24 +295,7 @@ function replaceAttributeToken(element, key, from, to) {
 /**
  * Tokens are always separated by a space.
  *
- * You can call the method via the monster namespace `new Monster.DOM.clearAttributeTokens()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.clearAttributeTokens();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {clearAttributeTokens} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * clearAttributeTokens();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -500,24 +335,7 @@ function clearAttributeTokens(element, key) {
  * findClosestByAttribute(document.getElementById('1'),'data-my-attribute', '2'); // ↦ node with id 2
  * ```
  *
- * You can call the method via the monster namespace `new Monster.DOM.findClosestByAttribute()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.findClosestByAttribute();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {findClosestByAttribute} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
- * findClosestByAttribute();
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.14.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -565,24 +383,14 @@ function findClosestByAttribute(element, key, value) {
  * findClosestByClass(document.getElementById('2'),'myclass'); // ↦ node with id 2
  * ```
  *
- * You can call the method via the monster namespace `new Monster.DOM.findClosestByClass()`.
- *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/monster.js';
- * Monster.DOM.findClosestByClass();
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {findClosestByClass} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.30.0/dist/modules/dom/attributes.js';
+ * import {findClosestByClass} from '@schukai/monster/source/dom/attributes.mjs';
  * findClosestByClass();
  * </script>
  * ```
  *
+ * @license AGPLv3
  * @since 1.27.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -602,25 +410,6 @@ function findClosestByClass(element, className) {
     if (result instanceof HTMLElement) {
         return result;
     }
-    
-    return undefined;
-}
 
-// exports
-assignToNamespace('Monster.DOM', findClosestByClass, getLinkedObjects, addToObjectLink, removeObjectLink, findClosestByAttribute, hasObjectLink, clearAttributeTokens, replaceAttributeToken, containsAttributeToken, removeAttributeToken, addAttributeToken, toggleAttributeToken);
-export {
-    Monster,
-    addToObjectLink,
-    removeObjectLink,
-    hasObjectLink,
-    findClosestByAttribute,
-    clearAttributeTokens,
-    replaceAttributeToken,
-    containsAttributeToken,
-    removeAttributeToken,
-    addAttributeToken,
-    toggleAttributeToken,
-    getLinkedObjects,
-    findClosestObjectLink,
-    findClosestByClass
+    return undefined;
 }