@schukai/monster 1.25.0 → 1.26.0

package/source/types/nodelist.js

@@ -0,0 +1,125 @@
+'use strict';
+
+/**
+ * @author schukai GmbH
+ */
+import {assignToNamespace, Monster} from '../namespace.js';
+import {isArray, isInstance} from "./is.js";
+import {Node} from "./node.js";
+import {validateInstance} from "./validate.js";
+
+/**
+ * You can create the instance via the monster namespace `new Monster.Types.NodeList()`.
+ *
+ * ```
+ * <script type="module">
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * new Monster.Types.NodeList()
+ * </script>
+ * ```
+ *
+ * Alternatively, you can also integrate this function individually.
+ *
+ * ```
+ * <script type="module">
+ * import {NodeList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/nodelist.js';
+ * new NodeList()
+ * </script>
+ * ```
+ *
+ * @since 1.26.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Types
+ * @summary A NodeList class
+ */
+class NodeList extends Set {
+
+    /**
+     * @throws {Error} invalid value type
+     * @param {NodeList|Node|Array<Node>}values
+     */
+    constructor(values) {
+        super();
+
+        const self = this
+
+        if(values===undefined) return;
+        
+        if (isArray(values)) {
+            values.forEach(value => self.add(value));
+        } else if (isInstance(values, NodeList)) {
+            values.forEach(value => self.add(value));
+        } else if (isInstance(values, Node)) {
+            self.add(values);
+        } else {
+            throw new Error('invalid value type');
+        }
+
+
+    }
+
+    /**
+     *
+     * @param {Node} node
+     * @return {Monster.Types.NodeList}
+     */
+    add(node) {
+        super.add(validateInstance(node, Node));
+        return this;
+    }
+
+    /**
+     * @param {Node} node
+     * @returns {NodeList}
+     */
+    remove(node) {
+        super.delete(validateInstance(node, Node));
+        return this;
+    }
+
+    /**
+     * @param {Node} node
+     * @returns {boolean}
+     */
+    has(node) {
+        return super.has(validateInstance(node, Node));
+        return false;
+    }
+
+    /**
+     * @returns {NodeList}
+     */
+    clear() {
+        super.clear();
+        return this;
+    }
+
+    /**
+     * @returns {NodeList}
+     */
+    toArray() {
+        return Array.from(this);
+    }
+
+    /**
+     * @returns {NodeList}
+     */
+    toJSON() {
+        return this.toArray();
+    }
+
+    /**
+     * @returns {NodeList}
+     */
+    toString() {
+        return this.toArray().toString();
+    }
+
+    get length() {
+        return super.size;
+    }
+}
+
+
+assignToNamespace('Monster.Types', NodeList);
+export {Monster, NodeList}

package/source/types/noderecursiveiterator.js

@@ -0,0 +1,126 @@
+'use strict';
+
+/**
+ * @author schukai GmbH
+ */
+
+
+import {internalSymbol} from "../constants.js";
+import {assignToNamespace, Monster} from '../namespace.js';
+import {Base} from './base.js';
+import {validateInstance} from "./validate.js";
+import {Node} from "./node.js";
+
+
+/**
+ * You can create the instance via the monster namespace `new Monster.Types.NodeRecursiveIterator()`.
+ *
+ * ```
+ * <script type="module">
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * new Monster.Types.NodeRecursiveIterator()
+ * </script>
+ * ```
+ *
+ * Alternatively, you can also integrate this function individually.
+ *
+ * ```
+ * <script type="module">
+ * import {NodeRecursiveIterator} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/noderecursiveiterator.js';
+ * new NodeRecursiveIterator()
+ * </script>
+ * ```
+ *
+ * @example
+ * import {Node} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/node.js';
+ * import {NodeRecursiveIterator} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/noderecursiveiterator.js';
+ *
+ * const node =new Node('1')
+ *
+ * // 1
+ * // 2
+ * // ├ 2.1
+ * // ├ 2.2
+ * // └ 2.3
+ * // 3
+ * // 4
+ * // ├ 4.1
+ * // └ 4.2
+ * node.appendChild(
+ * (new Node('2'))
+ *       .appendChild(new Node('2.1'))
+ *       .appendChild(new Node('2.2'))
+ *       .appendChild(new Node('2.3')))
+ * .appendChild(new Node('3'))
+ * .appendChild(new Node('4')
+ *       .appendChild(new Node('4.1'))
+ *       .appendChild(new Node('4.2')));
+ *
+ * const iterator = new NodeRecursiveIterator(node);
+ *
+ * const result = [];
+ * for (const n of iterator) {
+ *      result.push(n.value);
+ * }
+ *
+ * // ↦ ['1', '2', '2.1', '2.2', '2.3', '3', '4', '4.1', '4.2']
+ *
+ * @since 1.26.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Types
+ * @summary An iterator to run recursively through a tree of nodes
+ */
+class NodeRecursiveIterator extends Base {
+
+    /**
+     * @param {Node} [data]
+     */
+    constructor(node) {
+        super();
+        this[internalSymbol] = validateInstance(node, Node);
+    }
+
+    /**
+     * @private
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/yield
+     */
+    [Symbol.iterator] = function* () {
+
+        /**
+         * The end of the generator function is reached. In this case, execution of the generator
+         * ends and an IteratorResult is returned to the caller in which the value is undefined and done is true.
+         * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/yield
+         */
+        if (this[internalSymbol] === undefined) {
+            return;
+        }
+
+        yield this[internalSymbol];
+
+        if (this[internalSymbol].hasChildNodes()) {
+            let childNodes = this[internalSymbol].childNodes;
+
+            for (let node of childNodes) {
+                yield* new NodeRecursiveIterator(node);
+            }
+        }
+
+        return;
+    }
+
+    /**
+     * @param {function} callback
+     * @return {Monster.Types.NodeRecursiveIterator}
+     */
+    forEach(callback) {
+        for (const node of this) {
+            callback(node);
+        }
+        return this;
+    }
+
+}
+
+
+assignToNamespace('Monster.Types', NodeRecursiveIterator);
+export {Monster, NodeRecursiveIterator}

package/source/types/observer.js

@@ -17,7 +17,7 @@ import {UniqueQueue} from './uniquequeue.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/observer.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(new Monster.Types.Observer())
  * </script>
  * ```
@@ -26,7 +26,7 @@ import {UniqueQueue} from './uniquequeue.js';
  *
  * ```
  * <script type="module">
- * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/observer.js';
+ * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/observer.js';
  * console.log(new Observer())
  * </script>
  * ```
@@ -60,7 +60,7 @@ import {UniqueQueue} from './uniquequeue.js';
  *
  * @example
  *
- * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/observer.js';
+ * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/observer.js';
  *
  * const observer = new Observer(function(a, b, c) {
  *      console.log(this, a, b, c); // ↦ "a", 2, true 

package/source/types/observerlist.js

@@ -16,7 +16,7 @@ import {validateInstance} from "./validate.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/observerlist.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(new Monster.Types.ObserverList())
  * console.log(new Monster.Types.ObserverList())
  * </script>
@@ -26,7 +26,7 @@ import {validateInstance} from "./validate.js";
  *
  * ```
  * <script type="module">
- * import {ObserverList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/observerlist.js';
+ * import {ObserverList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/observerlist.js';
  * console.log(ObserverList())
  * console.log(ObserverList())
  * </script>

package/source/types/proxyobserver.js

@@ -18,7 +18,7 @@ import {extend} from "../data/extend.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/proxyobserver.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * new Monster.Types.ProxyObserver()
  * </script>
  * ```
@@ -27,7 +27,7 @@ import {extend} from "../data/extend.js";
  *
  * ```
  * <script type="module">
- * import {ProxyObserver} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/proxyobserver.js';
+ * import {ProxyObserver} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/proxyobserver.js';
  * new ProxyObserver()
  * </script>
  * ```
@@ -38,9 +38,9 @@ import {extend} from "../data/extend.js";
  *
  * @example
  *
- * import {ProxyObserver} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/proxyobserver.js';
- * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/observer.js';
- * import {isObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/is.js';
+ * import {ProxyObserver} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/proxyobserver.js';
+ * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/observer.js';
+ * import {isObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/is.js';
  *
  * const o = new Observer(function () { 
  *   if (isObject(this) && this instanceof ProxyObserver) {

package/source/types/queue.js

@@ -7,11 +7,11 @@ import {assignToNamespace, Monster} from '../namespace.js';
 import {Base} from './base.js';
 
 /**
- * You can call the method via the monster namespace `new Monster.Types.Queue()`.
+ * You can create the instance via the monster namespace `new Monster.Types.Queue()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/queue.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * new Monster.Types.Queue()
  * </script>
  * ```
@@ -20,14 +20,14 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/queue.js';
+ * import {Queue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/queue.js';
  * new Queue()
  * </script>
  * ```
  *
  * @example
  *
- * import {Queue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/queue.js';
+ * import {Queue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/queue.js';
  *
  * const queue = new Queue;
  *

package/source/types/randomid.js

@@ -19,7 +19,7 @@ let internalCounter = 0;
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/randomid.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(new Monster.Types.RandomID())
  * </script>
  * ```
@@ -28,7 +28,7 @@ let internalCounter = 0;
  *
  * ```
  * <script type="module">
- * import {RandomID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/randomid.js';
+ * import {RandomID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/randomid.js';
  * console.log(new RandomID())
  * </script>
  * ```

package/source/types/regex.js

@@ -0,0 +1,49 @@
+'use strict';
+
+/**
+ * @author schukai GmbH
+ */
+
+
+import {assignToNamespace, Monster} from "../namespace.js";
+import {validateString} from "./validate.js";
+
+/**
+ * This function prefixes all special characters that may appear in a regex with a slash.
+ * 
+ * You can call the method via the monster namespace `Monster.Types.escapeString()`.
+ *
+ * ```
+ * <script type="module">
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * Monster.Types.escapeString()
+ * </script>
+ * ```
+ *
+ * Alternatively, you can also integrate this function individually.
+ *
+ * ```
+ * <script type="module">
+ * import {escapeString} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/validate.js';
+ * escapeString()
+ * </script>
+ * ```
+ *
+ * @param {string} value
+ * @return {string}
+ * @since 1.26.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Types
+ * @throws {TypeError} value is not a string
+ */
+function escapeString(value) {
+    return validateString(value)
+        .replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
+        .replace(/-/g, '\\x2d');
+}
+
+assignToNamespace('Monster.Types', escapeString);
+export {
+    Monster,
+    escapeString
+}

package/source/types/stack.js

@@ -12,7 +12,7 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/stack.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(new Monster.Types.Stack())
  * </script>
  * ```
@@ -21,7 +21,7 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/stack.js';
+ * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/stack.js';
  * console.log(new Stack())
  * </script>
  * ```

package/source/types/tokenlist.js

@@ -18,7 +18,7 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/tokenlist.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * new Monster.Types.TokenList("myclass row")
  * </script>
  * ```
@@ -27,7 +27,7 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {TokenList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/tokenlist.js';
+ * import {TokenList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/tokenlist.js';
  * new TokenList("myclass row")
  * </script>
  * ```

package/source/types/typeof.js

@@ -14,7 +14,7 @@ import {assignToNamespace, Monster} from '../namespace.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/typeof.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(Monster.Types.typeOf())
  * </script>
  * ```
@@ -23,14 +23,14 @@ import {assignToNamespace, Monster} from '../namespace.js';
  *
  * ```
  * <script type="module">
- * import {typeOf} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/typeof.js';
+ * import {typeOf} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/typeof.js';
  * console.log(typeOf())
  * </script>
  * ```
  *
  * @example
  *
- * import {typeOf} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/typeof.js';
+ * import {typeOf} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/typeof.js';
  *
  * console.log(typeOf(undefined)); // ↦ undefined
  * console.log(typeOf("")); // ↦ string

package/source/types/uniquequeue.js

@@ -13,7 +13,7 @@ import {validateObject} from "./validate.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/uniquequeue.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * new Monster.Types.UniqueQueue()
  * </script>
  * ```
@@ -22,7 +22,7 @@ import {validateObject} from "./validate.js";
  *
  * ```
  * <script type="module">
- * import {UniqueQueue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/uniquequeue.js';
+ * import {UniqueQueue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/uniquequeue.js';
  * new UniqueQueue()
  * </script>
  * ```

package/source/types/uuid.js

@@ -18,7 +18,7 @@ import {getGlobalObject} from "./global.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/uuid.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * new Monster.Types.UUID()
  * </script>
  * ```
@@ -27,7 +27,7 @@ import {getGlobalObject} from "./global.js";
  *
  * ```
  * <script type="module">
- * import {Base} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.25.0/dist/modules/types/uuid.js';
+ * import {Base} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/uuid.js';
  * new UUID()
  * </script>
  * ```