@schukai/monster 1.31.0 → 2.0.0

package/source/types/{observer.js → observer.mjs}

@@ -1,36 +1,24 @@
-'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 './base.js';
-import {isObject} from './is.js';
-import {TokenList} from './tokenlist.js';
-import {UniqueQueue} from './uniquequeue.js';
+import {Base} from './base.mjs';
+import {isObject} from './is.mjs';
+import {TokenList} from './tokenlist.mjs';
+import {UniqueQueue} from './uniquequeue.mjs';
+
+export {Observer}
 
 /**
  * An observer manages a callback function
  *
- * You can call the method via the monster namespace `new Monster.Types.Observer()`.
- *
- * ```
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Types.Observer()
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/observer.js';
- * new Observer()
- * ```
- *
  * The update method is called with the subject object as this pointer. For this reason the callback should not
- * be an arrow function, because it gets the this pointer of its own context.
+ * be an arrow function, because it gets this pointer of its own context.
  *
- * ```
+ * ```js
  * new Observer(()=>{
  *     // this is not subject
  * })
@@ -42,7 +30,7 @@ import {UniqueQueue} from './uniquequeue.js';
  *
  * Additional arguments can be passed to the callback. To do this, simply specify them.
  *
- * ```
+ * ```js
  * Observer(function(a, b, c) {
  *     console.log(a, b, c); // ↦ "a", 2, true 
  * }, "a", 2, true)
@@ -50,17 +38,8 @@ import {UniqueQueue} from './uniquequeue.js';
  *
  * The callback function must have as many parameters as arguments are given.
  *
- * @example
- *
- * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/observer.js';
- *
- * const observer = new Observer(function(a, b, c) {
- *      console.log(this, a, b, c); // ↦ "a", 2, true 
- * }, "a", 2, true);
- *
- * observer.update({value:true}).then(()=>{});
- * // ↦ {value: true} "a" 2 true
- *
+ * @externalExample ../../example/types/observer.mjs
+ * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
@@ -168,9 +147,3 @@ class Observer extends Base {
     };
 
 }
-
-assignToNamespace('Monster.Types', Observer);
-export {Monster, Observer}
-
-
-

package/source/types/{observerlist.js → observerlist.mjs}

@@ -1,37 +1,23 @@
-'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 './base.js';
-import {Observer} from "./observer.js";
-import {validateInstance} from "./validate.js";
+
+import {Base} from './base.mjs';
+import {Observer} from "./observer.mjs";
+import {validateInstance} from "./validate.mjs";
+
+export {ObserverList}
 
 /**
  * With the help of the ObserverList class, observer can be managed.
  *
- * You can call the method via the monster namespace `new Monster.Types.ObserverList()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.Types.ObserverList())
- * console.log(new Monster.Types.ObserverList())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {ObserverList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/observerlist.js';
- * console.log(ObserverList())
- * console.log(ObserverList())
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
@@ -113,6 +99,3 @@ class ObserverList extends Base {
     };
 
 }
-
-assignToNamespace('Monster.Types', ObserverList);
-export {Monster, ObserverList}

package/source/types/{proxyobserver.js → proxyobserver.mjs}

@@ -1,74 +1,34 @@
-'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 './base.js';
-import {isArray, isObject, isPrimitive} from "./is.js";
-import {Observer} from "./observer.js";
-import {ObserverList} from "./observerlist.js";
-import {validateObject} from "./validate.js";
-import {extend} from "../data/extend.js";
+
+import {Base} from './base.mjs';
+import {isArray, isObject, isPrimitive} from "./is.mjs";
+import {Observer} from "./observer.mjs";
+import {ObserverList} from "./observerlist.mjs";
+import {validateObject} from "./validate.mjs";
+import {extend} from "../data/extend.mjs";
+
+export {ProxyObserver}
 
 /**
  * An observer manages a callback function
  *
- * You can call create the class via the monster namespace `new Monster.Types.ProxyObserver()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Types.ProxyObserver()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this class individually.
- *
- * ```
- * <script type="module">
- * import {ProxyObserver} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/proxyobserver.js';
- * new ProxyObserver()
- * </script>
- * ```
- *
- * with the ProxyObserver you can attach observer for observation. with each change at the object to be observed an update takes place.
+ * With the ProxyObserver you can attach observer for observation. 
+ * With each change at the object to be observed an update takes place.
  *
- * this also applies to nested objects.
- *
- * @example
- *
- * import {ProxyObserver} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/proxyobserver.js';
- * import {Observer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/observer.js';
- * import {isObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/is.js';
- *
- * const o = new Observer(function () { 
- *   if (isObject(this) && this instanceof ProxyObserver) {
- *       // do something (this ist ProxyObserver)
- *       const subject = this.getSubject();
- *       console.log(subject);
- *   }
- * });
- *
- * let realSubject = {
- *   a: {
- *       b: {
- *           c: true
- *       },
- *       d: 9
- *   }
- * }
- *
- * const p = new ProxyObserver(realSubject);
- * p.attachObserver(o);
- * const s = p.getSubject();
- * s.a.b.c = false;
+ * This also applies to nested objects.
  *
+ * @externalExample ../../example/types/proxyobserver.mjs
+ * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
  */
-class ProxyObserver extends Base {
+ class ProxyObserver extends Base {
 
     /**
      *
@@ -167,9 +127,6 @@ class ProxyObserver extends Base {
 
 }
 
-assignToNamespace('Monster.Types', ProxyObserver);
-export {Monster, ProxyObserver}
-
 /**
  *
  * @returns {{defineProperty: (function(*=, *=, *=): *), setPrototypeOf: (function(*, *=): boolean), set: (function(*, *, *, *): boolean), get: ((function(*=, *=, *=): (undefined))|*), deleteProperty: ((function(*, *): (boolean))|*)}}

package/source/types/{queue.js → queue.mjs}

@@ -1,53 +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 {Base} from './base.js';
+
+import {Base} from './base.mjs';
+
+export {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.31.0/dist/monster.js';
- * new Monster.Types.Queue()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Queue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/queue.js';
- * new Queue()
- * </script>
- * ```
- *
- * @example
- *
- * import {Queue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/queue.js';
- *
- * const queue = new Queue;
- *
- * queue.add(2);
- * queue.add(true);
- * queue.add("Hello");
- * queue.add(4.5);
- *
- * console.log(queue.poll());
- * // ↦ 2
- * console.log(queue.poll());
- * // ↦ true
- * console.log(queue.poll());
- * // ↦ "Hello"
- * console.log(queue.poll());
- * // ↦ 4.5
- * console.log(queue.poll());
- * // ↦ undefined
- *
- *
+ * @externalExample ../../example/types/queue.mjs
+ * @license AGPLv3
  * @since 1.4.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
@@ -120,6 +86,3 @@ class Queue extends Base {
 
 
 }
-
-assignToNamespace('Monster.Types', Queue);
-export {Monster, Queue}

package/source/types/randomid.mjs

@@ -0,0 +1,45 @@
+/**
+ * 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 {random} from "../math/random.mjs";
+import {getGlobal} from "./global.mjs";
+import {ID} from "./id.mjs";
+
+export {RandomID}
+
+/**
+ * @private
+ * @type {number}
+ */
+let internalCounter = 0;
+
+/**
+ * The `RandomID` class provides a unique ID for an item.
+ *
+ * @license AGPLv3
+ * @since 1.6.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Types
+ * @summary class to generate random numbers
+ */
+class RandomID extends ID {
+
+    /**
+     * create new object
+     */
+    constructor() {
+        super();
+
+        internalCounter += 1;
+
+        this.id = getGlobal().btoa(random(1, 10000))
+            .replace(/=/g, '')
+            /** No numbers at the beginning of the ID, because of possible problems with DOM */
+            .replace(/^[0-9]+/, 'X') + internalCounter;
+    }
+
+}

package/source/types/regex.mjs

@@ -0,0 +1,27 @@
+/**
+ * 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 {validateString} from "./validate.mjs";
+
+export {escapeString}
+
+/**
+ * This function prefixes all special characters that may appear in a regex with a slash.
+ *
+ * @param {string} value
+ * @return {string}
+ * @license AGPLv3
+ * @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');
+}

package/source/types/{stack.js → stack.mjs}

@@ -1,31 +1,18 @@
-'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 './base.js';
+import {Base} from './base.mjs';
+
+export {Stack}
 
 /**
  * You can call the method via the monster namespace `new Monster.Types.Queue()`.
  *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.Types.Stack())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/stack.js';
- * console.log(new Stack())
- * </script>
- * ```
- *
+ * @license AGPLv3
  * @since 1.4.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
@@ -98,6 +85,3 @@ class Stack extends Base {
 
 
 }
-
-assignToNamespace('Monster.Types', Stack);
-export {Monster, Stack}

package/source/types/{tokenlist.js → tokenlist.mjs}

@@ -1,44 +1,25 @@
-'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 {isIterable, isString} from '../types/is.js';
-import {validateFunction, validateString} from '../types/validate.js';
-import {Base} from './base.js';
+import {isIterable, isString} from '../types/is.mjs';
+import {validateFunction, validateString} from '../types/validate.mjs';
+import {Base} from './base.mjs';
+
+export {TokenList}
 
 /**
- * A tokenlist allows you to manage tokens (individual character strings such as css classes in an attribute string).
- *
- * The tokenlist offers various functions to manipulate values. For example, you can add, remove or replace a class in a CSS list.
- *
- * You can call the method via the monster namespace `new Monster.Types.TokenList()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Types.TokenList("myclass row")
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
+ * A `TokenList` allows you to manage tokens (individual character strings such as css classes in an attribute string).
  *
- * ```
- * <script type="module">
- * import {TokenList} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/tokenlist.js';
- * new TokenList("myclass row")
- * </script>
- * ```
+ * The `TokenList` offers various functions to manipulate values. For example, you can add, remove or replace a class in a CSS list.
  *
  * This class implements the [iteration protocol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
  *
- * ```
- * typeof new TokenList("myclass row")[Symbol.iterator]; 
- * // ↦ "function"
- * ```
- *
+ * @externalExample ../../example/types/tokenlist-1.mjs
+ * @license AGPLv3
  * @since 1.2.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
@@ -94,14 +75,7 @@ class TokenList extends Base {
     /**
      * Returns true if it contains token, otherwise false
      *
-     * ```
-     * new TokenList("start middle end").contains('start')); // ↦ true
-     * new TokenList("start middle end").contains('end')); // ↦ true
-     * new TokenList("start middle end").contains('xyz')); // ↦ false
-     * new TokenList("start middle end").contains(['end','start','middle'])); // ↦ true
-     * new TokenList("start middle end").contains(['end','start','xyz'])); // ↦ false
-     * ```
-     *
+     * @externalExample ../../example/types/tokenlist-2.mjs
      * @param {array|string|iteratable} value
      * @returns {boolean}
      */
@@ -130,14 +104,9 @@ class TokenList extends Base {
     }
 
     /**
-     * add tokens
-     *
-     * ```
-     * new TokenList().add("abc xyz").toString(); // ↦ "abc xyz"
-     * new TokenList().add(["abc","xyz"]).toString(); // ↦ "abc xyz"
-     * new TokenList().add(undefined); // ↦ add nothing
-     * ```
+     * Add tokens
      *
+     * @externalExample ../../example/types/tokenlist-3.mjs
      * @param {array|string|iteratable} value
      * @returns {TokenList}
      * @throws {TypeError} unsupported value
@@ -172,12 +141,7 @@ class TokenList extends Base {
     /**
      * Removes token
      *
-     * ```
-     * new TokenList("abc xyz").remove("xyz").toString(); // ↦ "abc"
-     * new TokenList("abc xyz").remove(["xyz"]).toString(); // ↦ "abc"
-     * new TokenList("abc xyz").remove(undefined); // ↦ remove nothing
-     * ```
-     *
+     * @externalExample ../../example/types/tokenlist-4.mjs
      * @param {array|string|iteratable} value
      * @returns {TokenList}
      * @throws {TypeError} unsupported value
@@ -193,7 +157,7 @@ class TokenList extends Base {
                 this.tokens.delete(token.trim());
             }
         } else if (typeof value !== "undefined") {
-            throw new TypeError("unsupported value", "types/tokenlist.js");
+            throw new TypeError("unsupported value", "types/tokenlist.mjs");
         }
 
         return this;
@@ -232,12 +196,7 @@ class TokenList extends Base {
     /**
      * Removes token from string. If token doesn't exist it's added.
      *
-     * ```
-     * new TokenList("abc def ghi").toggle("def xyz").toString(); // ↦ "abc ghi xyz"
-     * new TokenList("abc def ghi").toggle(["abc","xyz"]).toString(); // ↦ "def ghi xyz"
-     * new TokenList().toggle(undefined); // ↦ nothing
-     * ```
-     *
+     * @externalExample ../../example/types/tokenlist-5.mjs
      * @param {array|string|iteratable} value
      * @returns {boolean}
      * @throws {TypeError} unsupported value
@@ -253,7 +212,7 @@ class TokenList extends Base {
                 toggleValue.call(this, token);
             }
         } else if (typeof value !== "undefined") {
-            throw new TypeError("unsupported value", "types/tokenlist.js");
+            throw new TypeError("unsupported value", "types/tokenlist.mjs");
         }
 
         return this;
@@ -309,6 +268,3 @@ function toggleValue(token) {
     this.add(token);
     return this;
 }
-
-assignToNamespace('Monster.Types', TokenList);
-export {Monster, TokenList}

package/source/types/typeof.mjs

@@ -0,0 +1,37 @@
+/**
+ * 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
+ */
+
+export {typeOf}
+
+/**
+ * The built-in typeof method is known to have some historical weaknesses. This function tries to provide a better and more accurate result.
+ *
+ * @externalExample ../../example/types/typeof.mjs
+ * @param {*} value
+ * @return {string}
+ * @license AGPLv3
+ * @since 1.7.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Types
+ * @throws {TypeError} value is not a primitive
+ */
+function typeOf(value) {
+    let type = ({}).toString.call(value).match(/\s([a-zA-Z]+)/)[1];
+    if ('Object' === type) {
+
+        const name = value.constructor.name;
+        if (name) {
+            return name.toLowerCase();
+        }
+
+        const results = (/^(class|function)\s+(\w+)/).exec(value.constructor.toString());
+        type = (results && results.length > 2) ? results[2] : '';
+    }
+
+    return type.toLowerCase();
+}
+

package/source/types/{uniquequeue.js → uniquequeue.mjs}

@@ -1,38 +1,25 @@
-'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 {Queue} from "./queue.js";
-import {validateObject} from "./validate.js";
+import {Queue} from "./queue.mjs";
+import {validateObject} from "./validate.mjs";
+
+export {UniqueQueue}
 
 /**
- * You can call the method via the monster namespace `new Monster.Types.Queue()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Types.UniqueQueue()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {UniqueQueue} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/types/uniquequeue.js';
- * new UniqueQueue()
- * </script>
- * ```
+ * A UniqueQueue is a queue that contains items only once.
  *
+ * @license AGPLv3
  * @since 1.4.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
  * @summary A queue for unique values
  */
-class UniqueQueue extends Queue {
+ class UniqueQueue extends Queue {
 
     /**
      *
@@ -90,6 +77,3 @@ class UniqueQueue extends Queue {
 
 
 }
-
-assignToNamespace('Monster.Types', UniqueQueue);
-export {Monster, UniqueQueue}