@schukai/monster 1.31.0 → 2.0.0

package/source/data/{diff.js → diff.mjs}

@@ -1,81 +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 {isArray, isObject} from "../types/is.js";
-import {typeOf} from "../types/typeof.js";
+import {isArray, isObject} from "../types/is.mjs";
+import {typeOf} from "../types/typeof.mjs";
+
+export {diff}
 
 /**
  * With the diff function you can perform the change of one object to another. The result shows the changes of the second object to the first object.
  *
  * The operator `add` means that something has been added to the second object. `delete` means that something has been deleted from the second object compared to the first object.
  *
- * You can call the method via the monster namespace `Monster.Data.Diff()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * Monster.Data.Diff(a, b)
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Diff} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/diff.js';
- * Diff(a, b)
- * </script>
- * ```
- *
- * @example
- *
- * import {Diff} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/diff.js';
- *
- * // given are two objects x and y.
- *
- * let x = {
- *     a: 1,
- *     b: "Hello!"
- * }
- *
- *  let y = {
- *     a: 2,
- *     c: true
- * }
- *
- * // These two objects can be compared with each other.
- *
- * console.log(Diff(x, y));
- *
- * // the result is then the following
- *
- * //
- * // [
- * // {
- * //        operator: 'update',
- * //        path: [ 'a' ],
- * //        first: { value: 1, type: 'number' },
- * //        second: { value: 2, type: 'number' }
- * //    },
- * // {
- * //        operator: 'delete',
- * //        path: [ 'b' ],
- * //        first: { value: 'Hello!', type: 'string' }
- * //    },
- * // {
- * //        operator: 'add',
- * //        path: [ 'c' ],
- * //        second: { value: true, type: 'boolean' }
- * //    }
- * // ]
- *
+ * @externalExample ../../example/data/diff.mjs
  * @param {*} first
  * @param {*} second
  * @return {array}
+ * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data
@@ -244,6 +188,3 @@ function getOperator(a, b) {
     return operator;
 
 }
-
-assignToNamespace('Monster.Data', diff);
-export {Monster, diff}

package/source/data/{extend.js → extend.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 {isArray, isObject} from "../types/is.js";
-import {typeOf} from "../types/typeof.js";
+
+import {isArray, isObject} from "../types/is.mjs";
+import {typeOf} from "../types/typeof.mjs";
+
+export {extend}
 
 /**
  * Extend copies all enumerable own properties from one or
  * more source objects to a target object. It returns the modified target object.
  *
- * You can call the method via the monster namespace `Monster.Data.extend()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * Monster.Data.extend(a, b)
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {extend} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/extend.js';
- * extend(a, b)
- * </script>
- * ```
- *
  * @param {object} target
  * @param {object}
  * @return {object}
+ * @license AGPLv3
  * @since 1.10.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data
@@ -86,7 +72,3 @@ function extend() {
 
     return o;
 }
-
-
-assignToNamespace('Monster.Data', extend);
-export {Monster, extend}

package/source/data/{namespace.js → namespace.mjs}

@@ -1,4 +1,4 @@
-'use strict';
+
 
 /**
  * In this namespace you will find classes and methods for handling data.
@@ -7,10 +7,4 @@
  * @memberOf Monster
  * @author schukai GmbH
  */
-
-
-/**
- * @private
- * @type {string}
- */
-export const namespace = "Monster.Data";
+const ns = {};

package/source/data/{pathfinder.js → pathfinder.mjs}

@@ -1,13 +1,16 @@
-'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 {isArray, isInteger, isObject, isPrimitive} from '../types/is.js';
-import {Stack} from "../types/stack.js";
-import {validateInteger, validateString} from '../types/validate.js';
+
+import {Base} from '../types/base.mjs';
+import {isArray, isInteger, isObject, isPrimitive} from '../types/is.mjs';
+import {Stack} from "../types/stack.mjs";
+import {validateInteger, validateString} from '../types/validate.mjs';
+
+export {Pathfinder, DELIMITER, WILDCARD}
 
 /**
  * path separator
@@ -15,32 +18,16 @@ import {validateInteger, validateString} from '../types/validate.js';
  * @private
  * @type {string}
  */
-export const DELIMITER = '.';
+const DELIMITER = '.';
 
 /**
  * @private
  * @type {string}
  */
-export const WILDCARD = '*';
+const WILDCARD = '*';
 
 /**
- * You can call the method via the monster namespace `new Monster.Data.Pathfinder()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.Data.Pathfinder())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/pathfinder.js';
- * console.log(new Pathfinder())
- * </script>
- * ```
+ * Pathfinder is a class to find a path to an object.
  *
  * With the help of the pathfinder, values can be read and written from an object construct.
  *
@@ -77,54 +64,9 @@ export const WILDCARD = '*';
  * new Pathfinder(obj).setVia('a.b.0.c', true); // ↦ {a:{b:[{c:true}]}}
  * ```
  *
- * @example
- *
- * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/pathfinder.js';
- *
- * let value = new Pathfinder({
- * a: {
- *     b: {
- *         f: [
- *             {
- *                 g: false,
- *             }
- *         ],
- *     }
- * }
- * }).getVia("a.b.f.0.g");
- *
- *  console.log(value);
- *  // ↦ false
- *
- * try {
- *   new Pathfinder({}).getVia("a.b.f.0.g");  
- * } catch(e) {
- *   console.log(e.toString());
- *   // ↦ Error: the journey is not at its end (b.f.0.g)
- * }
- *
- * @example
- *
- * import {Pathfinder} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/pathfinder.js';
- *
- * let p = new Pathfinder({
- *                a: {
- *                    x: [
- *                        {c: 1}, {c: 2}
- *                    ],
- *                    y: true
- *                },
- *                b: {
- *                    x: [
- *                        {c: 1, d: false}, {c: 2}
- *                    ],
- *                    y: true
- *                },
- *            });
- *
- * let r = p.getVia("*.x.*.c");
- * console.log(r);
- *
+ * @externalExample ../../example/data/pathfinder-1.mjs
+ * @externalExample ../../example/data/pathfinder-2.mjs
+ * @license AGPLv3
  * @since 1.4.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data
@@ -232,8 +174,6 @@ class Pathfinder extends Base {
 
 }
 
-assignToNamespace('Monster.Data', Pathfinder);
-export {Monster, Pathfinder}
 
 /**
  *
@@ -444,6 +384,7 @@ function assignProperty(object, key, value) {
  * @throws {TypeError} unsupported type
  * @throws {Error} the journey is not at its end
  * @throws {Error} unsupported action for this data type
+ * @license AGPLv3
  * @since 1.6.0
  * @private
  */

package/source/data/{pipe.js → pipe.mjs}

@@ -1,59 +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 {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from '../types/base.js';
-import {validateString} from '../types/validate.js';
-import {Transformer} from './transformer.js';
+import {Base} from '../types/base.mjs';
+import {validateString} from '../types/validate.mjs';
+import {Transformer} from './transformer.mjs';
 
+export {Pipe}
 
+/**
+ * @private
+ * @type {string}
+ */
 const DELIMITER = '|';
 
 /**
  * The pipe class makes it possible to combine several processing steps.
  *
- * You can call the method via the monster namespace `new Monster.Data.Pipe()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Data.Pipe()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Pipe} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/pipe.js';
- * new Pipe()
- * </script>
- * ```
- *
  * A pipe consists of commands whose input and output are connected with the pipe symbol `|`.
  *
  * With the Pipe, processing steps can be combined. Here, the value of an object is accessed via the pathfinder (path command).
  * the word is then converted to uppercase letters and a prefix Hello is added. the two backslash safe the space char.
  *
- * @example
- * import {Pipe} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/pipe.js';
- *
- * let obj = {
- *    a: {
- *        b: {
- *            c: {
- *                d: "world"
- *            }
- *        }
- *    }
- * }
- *
- * console.log(new Pipe('path:a.b.c.d | toupper | prefix:Hello\\ ').run(obj));
- * // ↦ Hello WORLD
- *
+ * @externalExample  ../../example/data/pipe.mjs
+ * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data
@@ -61,7 +34,6 @@ const DELIMITER = '|';
 class Pipe extends Base {
 
     /**
-     *
      * @param {string} pipe a pipe consists of commands whose input and output are connected with the pipe symbol `|`.
      * @throws {TypeError}
      */
@@ -77,7 +49,6 @@ class Pipe extends Base {
     }
 
     /**
-     *
      * @param {string} name
      * @param {function} callback
      * @param {object} context
@@ -106,6 +77,3 @@ class Pipe extends Base {
         }, value);
     }
 }
-
-assignToNamespace('Monster.Data', Pipe);
-export {Monster, Pipe}

package/source/data/{transformer.js → transformer.mjs}

@@ -1,44 +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 {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from '../types/base.js';
-import {getGlobal, getGlobalObject} from "../types/global.js";
-import {ID} from '../types/id.js';
-import {isArray, isObject, isString} from '../types/is.js';
+
+
+import {Base} from '../types/base.mjs';
+import {getGlobal, getGlobalObject} from "../types/global.mjs";
+import {ID} from '../types/id.mjs';
+import {isArray, isObject, isString} from '../types/is.mjs';
 import {
     validateFunction,
     validateInteger,
     validateObject,
     validatePrimitive,
     validateString
-} from '../types/validate.js';
-import {clone} from "../util/clone.js";
-import {Pathfinder} from "./pathfinder.js";
+} from '../types/validate.mjs';
+import {clone} from "../util/clone.mjs";
+import {Pathfinder} from "./pathfinder.mjs";
+
+export {Transformer}
 
 /**
  * The transformer class is a swiss army knife for manipulating values. especially in combination with the pipe, processing chains can be built up.
  *
- * You can call the method via the monster namespace `new Monster.Data.Transformer()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Data.Transformer()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Transformer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/transformer.js';
- * new Transformer()
- * </script>
- * ```
- *
  * A simple example is the conversion of all characters to lowercase. for this purpose the command `tolower` must be used.
  *
  * ```
@@ -118,18 +106,8 @@ import {Pathfinder} from "./pathfinder.js";
  * global['crypto'] = new Crypto.Crypto();
  * ```
  *
- * @example
- *
- * import {Transformer} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/transformer.js';
- *
- * const transformer = new Transformer("tolower")
- *
- * console.log(transformer.run("HELLO"))
- * // ↦ hello
- *
- * console.log(transformer.run("WORLD"))
- * // ↦ world
- *
+ * @externalExample ../../example/data/transformer.mjs
+ * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data
@@ -185,9 +163,6 @@ class Transformer extends Base {
     }
 }
 
-assignToNamespace('Monster.Data', Transformer);
-export {Monster, Transformer}
-
 /**
  *
  * @param {string} command

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

@@ -1,14 +1,16 @@
-'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} from "../types/global.js";
-import {ProxyObserver} from "../types/proxyobserver.js";
-import {validateInstance, validateString} from "../types/validate.js";
 
+import {Base} from '../types/base.mjs';
+import {getGlobalFunction} from "../types/global.mjs";
+import {ProxyObserver} from "../types/proxyobserver.mjs";
+import {validateInstance, validateString} from "../types/validate.mjs";
+
+export {ATTRIBUTEPREFIX,Assembler}
 
 /**
  * attribute prefix
@@ -19,24 +21,9 @@ import {validateInstance, validateString} from "../types/validate.js";
 const ATTRIBUTEPREFIX = "data-monster-";
 
 /**
- * you can call the method via the monster namespace `new Monster.DOM.Assembler()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.DOM.Assembler())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Assembler} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/dom/assembler.js';
- * console.log(new Assembler())
- * </script>
- * ```
+ * Assembler class
  *
+ * @license AGPLv3
  * @since 1.6.0
  * @copyright schukai GmbH
  * @memberOf Monster.DOM
@@ -95,6 +82,3 @@ class Assembler extends Base {
     }
 
 }
-
-assignToNamespace('Monster.DOM', Assembler);
-export {Monster, ATTRIBUTEPREFIX, Assembler}