@schukai/monster 1.31.0 → 2.0.0

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

@@ -1,20 +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 {isFunction, isObject, isString} from "../types/is.js";
-import {validateString} from "../types/validate.js";
-import {clone} from "../util/clone.js";
-import {DELIMITER, Pathfinder, WILDCARD} from "./pathfinder.js";
+import {isFunction, isObject, isString} from "../types/is.mjs";
+import {validateString} from "../types/validate.mjs";
+import {clone} from "../util/clone.mjs";
+import {DELIMITER, Pathfinder, WILDCARD} from "./pathfinder.mjs";
 
+export {buildMap, PARENT, assembleParts}
 
 /**
- * @type {string} parent symbol
+ * @type {string}
+ * @memberOf Monster.Data
  */
-export const PARENT = '^';
+const PARENT = '^';
 
 
 /**
@@ -23,98 +25,12 @@ export const PARENT = '^';
  * Either a simple definition `a.b.c` or a template `${a.b.c}` can be specified as the path.
  * Key and value can be either a definition or a template. The key does not have to be defined.
  *
- * You can call the method via the monster namespace `Monster.Data.buildMap()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(Monster.Data.buildMap())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {buildMap} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/buildmap.js';
- * console.log(buildMap())
- * </script>
- * ```
- *
- * The templates determine the appearance of the keys and the value of the map. Either a single value `id` can be taken or a composite key `${id} ${name}` can be used.
+ * The templates determine the appearance of the keys and the value of the map. Either a single value
+ * `id` can be taken or a composite key `${id} ${name}` can be used.
  *
  * If you want to access values of the parent data set, you have to use the `^` character `${id} ${^.name}`.
  *
- * @example
- *
- * import {buildMap} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/buildmap.js';
- * // a typical data structure as reported by an api
- *
- * let map;
- * let obj = {
- *     "data": [
- *         {
- *             "id": 10,
- *             "name": "Cassandra",
- *             "address": {
- *                 "street": "493-4105 Vulputate Street",
- *                 "city": "Saumur",
- *                 "zip": "52628"
- *             }
- *         },
- *         {
- *             "id": 20,
- *             "name": "Holly",
- *             "address": {
- *                 "street": "1762 Eget Rd.",
- *                 "city": "Schwalbach",
- *                 "zip": "952340"
- *             }
- *         },
- *         {
- *             "id": 30,
- *             "name": "Guy",
- *             "address": {
- *                 "street": "957-388 Sollicitudin Avenue",
- *                 "city": "Panchià",
- *                 "zip": "420729"
- *             }
- *         }
- *     ]
- * };
- *
- * // The function is passed this data structure and with the help of the selector `'data.*'` the data to be considered are selected.
- * // The key is given by a simple definition `'id'` and the value is given by a template `'${name} (${address.zip} ${address.city})'`.
- * map = buildMap(obj, 'data.*', '${name} (${address.zip} ${address.city})', 'id');
- * console.log(map);
- *
- * // ↦ Map(3) {
- * //  '10' => 'Cassandra (52628 Saumur)',
- * //  '20' => 'Holly (952340 Schwalbach)',
- * //  '30' => 'Guy (420729 Panchià)'
- * // }
- *
- * // If no key is specified, the key from the selection, here the array index, is taken.
- * map = buildMap(obj, 'data.*', '${name} (${address.zip} ${address.city})');
- * console.log(map);
- *
- * // ↦ Map(3) {
- * //  '0' => 'Cassandra (52628 Saumur)',
- * //  '1' => 'Holly (952340 Schwalbach)',
- * //  '2' => 'Guy (420729 Panchià)'
- * // }
- *
- * // a filter (function(value, key) {}) can be specified to accept only defined entries.
- * map = buildMap(obj, 'data.*', '${name} (${address.zip} ${address.city})', 'id', function (value, key) {
- *                return (value['id'] >= 20) ? true : false
- *            });
- * console.log(map);
- *
- * // ↦ Map(2) {
- * //  20 => 'Holly (952340 Schwalbach)',
- * //  30 => 'Guy (420729 Panchià)'
- * // }
- *
+ * @externalExample ../../example/data/buildmap.mjs
  * @param {*} subject
  * @param {string|Monster.Data~exampleSelectorCallback} selector
  * @param {string} [valueTemplate]
@@ -134,6 +50,7 @@ function buildMap(subject, selector, valueTemplate, keyTemplate, filter) {
 
 }
 
+
 /**
  * @private
  * @param {*} subject
@@ -261,7 +178,7 @@ function buildFlatMap(subject, selector, key, parentMap) {
  * Alternatively to a string selector a callback can be specified. this must return a map.
  *
  * @example
- * import {buildMap} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/buildmap.js';
+ * import {buildMap} from '@schukai/monster/source/data/buildmap.mjs';
  *
  * let obj = {
  *                "data": [
@@ -384,6 +301,7 @@ function buildFlatMap(subject, selector, key, parentMap) {
  * @callback Monster.Data~exampleSelectorCallback
  * @param {*} subject subject
  * @return Map
+ * @license AGPLv3
  * @since 1.17.0
  * @memberOf Monster.Data
  * @see {@link Monster.Data.buildMap}
@@ -427,7 +345,3 @@ function build(subject, definition, defaultValue) {
     return definition;
 
 }
-
-
-assignToNamespace('Monster.Data', buildMap);
-export {Monster, buildMap, assembleParts}

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

@@ -1,16 +1,17 @@
-'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 {Node} from "../types/node.js";
-import {NodeList} from "../types/nodelist.js";
-import {assembleParts} from "./buildmap.js";
-import {extend} from "./extend.js";
+import {isArray, isObject} from "../types/is.mjs";
+import {Node} from "../types/node.mjs";
+import {NodeList} from "../types/nodelist.mjs";
+import {assembleParts} from "./buildmap.mjs";
+import {extend} from "./extend.mjs";
 
+export {buildTree}
 
 /**
  * @private
@@ -34,24 +35,6 @@ const rootSymbol = Symbol('root');
 /**
  * With the help of the function `buildTree()`, nodes can be easily created from data objects.
  *
- * You can call the method via the monster namespace `Monster.Data.buildTree()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/buildtree.js';
- * Monster.Data.buildTree()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {buildTree} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/buildtree.js';
- * buildTree()
- * </script>
- * ```
- *
  * @param {*} subject
  * @param {string|Monster.Data~exampleSelectorCallback} selector
  * @param {string} idKey
@@ -62,6 +45,7 @@ const rootSymbol = Symbol('root');
  * @throws {TypeError} value is neither a string nor a function
  * @throws {TypeError} the selector callback must return a map
  * @throws {Error} the object has no value for the specified id
+ * @license AGPLv3
  * @since 1.26.0
  */
 function buildTree(subject, selector, idKey, parentIDKey, options) {
@@ -123,7 +107,3 @@ function buildTree(subject, selector, idKey, parentIDKey, options) {
 
     return list;
 }
-
-
-assignToNamespace('Monster.Data', buildTree);
-export {Monster, buildTree}

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

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Namespace for datasources
  *
@@ -7,10 +5,4 @@
  * @memberOf Monster.Data
  * @author schukai GmbH
  */
-
-
-/**
- * @private
- * @type {string}
- */
-export const namespace = "Monster.Data.Datasource";
+const ns = {};

package/source/data/datasource/restapi/namespace.mjs

@@ -0,0 +1,8 @@
+/**
+ * Namespace for storages
+ *
+ * @namespace Monster.Data.Datasource.RestAPI
+ * @memberOf Monster.Data.Datasource
+ * @author schukai GmbH
+ */
+const ns = {};

package/source/data/datasource/restapi/{writeerror.js → writeerror.mjs}

@@ -1,15 +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 {internalSymbol} from "../../../constants.js";
-import {assignToNamespace, Monster} from '../../../namespace.js';
+import {internalSymbol} from "../../../constants.mjs";
+
+export {WriteError}
 
 /**
  * Error message for API requests with extension of request and validation.
  * 
+ * @license AGPLv3
  * @since 1.24.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data.Datasource.RestAPI
@@ -43,7 +46,3 @@ class WriteError extends Error {
         return this[internalSymbol]['validation']
     }
 }
-
-
-assignToNamespace('Monster.Data.Datasource.RestAPI', WriteError);
-export {Monster, WriteError}

package/source/data/datasource/{restapi.js → restapi.mjs}

@@ -1,50 +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 {internalSymbol} from "../../constants.js";
-import {assignToNamespace, Monster} from '../../namespace.js';
-import {isObject} from "../../types/is.js";
-import {Datasource} from "../datasource.js";
-import {Pathfinder} from "../pathfinder.js";
-import {Pipe} from "../pipe.js";
-import {WriteError} from "./restapi/writeerror.js";
+import {internalSymbol} from "../../constants.mjs";
+import {isObject} from "../../types/is.mjs";
+import {Datasource} from "../datasource.mjs";
+import {Pathfinder} from "../pathfinder.mjs";
+import {Pipe} from "../pipe.mjs";
+import {WriteError} from "./restapi/writeerror.mjs";
+
+export {RestAPI}
 
 /**
- * You can create an object of this class using the monster namespace `Monster.Data.Datasource.RestAPI()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * Monster.Data.Datasource.RestAPI()
- * </script>
- * ```
- *
- * Alternatively you can import the class directly
- *
- * ```
- * <script type="module">
- * import {RestAPI} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/datasource/restapi.js';
- * new RestAPI()
- * </script>
- * ```
- *
- * @example
- *
- * import {RestAPI} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/datasource/restapi.js';
- *
- * const ds = new RestAPI({
- *   url: 'https://httpbin.org/get'
- * },{
- *   url: 'https://httpbin.org/post'
- * });
- *
- * ds.set({flag:true})
- * ds.write().then(()=>console.log('done'));
- * ds.read().then(()=>console.log('done'));
+ * The RestAPI is a class that enables a REST API server.
  *
+ * @externalExample ../../../example/data/storage/restapi.mjs 
+ * @license AGPLv3
  * @since 1.22.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data.Datasource
@@ -260,7 +234,3 @@ class RestAPI extends Datasource {
  * @memberOf Monster.Data
  * @see Monster.Data.Datasource
  */
-
-
-assignToNamespace('Monster.Data.Datasource', RestAPI);
-export {Monster, RestAPI}

package/source/data/datasource/storage/localstorage.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 {internalSymbol} from "../../../constants.mjs";
+import {getGlobalObject} from "../../../types/global.mjs";
+import {Datasource} from "../../datasource.mjs";
+import {Storage, storageObjectSymbol} from "../storage.mjs";
+
+export {LocalStorage}
+
+/**
+ * The LocalStorage Datasource provides a data store in the browser localStorage.
+ * 
+ * @license AGPLv3
+ * @since 1.22.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Data.Datasource.Storage
+ * @summary The LocalStorage class encapsulates the access to data objects.
+ */
+class LocalStorage extends Storage {
+
+    /**
+     * @throws {Error} this method must be implemented by derived classes.
+     * @return {external:localStorage}
+     * @private
+     */
+    [storageObjectSymbol]() {
+        return getGlobalObject('localStorage');
+    }
+
+    /**
+     * Create clone
+     * @return {LocalStorage}
+     */
+    getClone() {
+        const self = this;
+        return new LocalStorage(self[internalSymbol].getRealSubject()['options'].key);
+    }
+
+
+}

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

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Namespace for storages
  *
@@ -7,10 +5,4 @@
  * @memberOf Monster.Data.Datasource
  * @author schukai GmbH
  */
-
-
-/**
- * @private
- * @type {string}
- */
-export const namespace = "Monster.Data.Datasource.Storage";
+const ns = {};

package/source/data/datasource/storage/sessionstorage.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 {internalSymbol} from "../../../constants.mjs";
+import {getGlobalObject} from "../../../types/global.mjs";
+import {Datasource} from "../../datasource.mjs";
+import {Storage, storageObjectSymbol} from "../storage.mjs";
+
+export {SessionStorage}
+
+/**
+ * The SessionStorage class provides a data source that uses the SessionStorage API on the client.
+ *
+ * @license AGPLv3
+ * @since 1.22.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Data.Datasource.Storage
+ * @summary The LocalStorage class encapsulates the access to data objects.
+ */
+class SessionStorage extends Storage {
+
+    /**
+     * @throws {Error} this method must be implemented by derived classes.
+     * @return {external:sessionStorage}
+     * @private
+     */
+    [storageObjectSymbol]() {
+        return getGlobalObject('sessionStorage');
+    }
+
+    /**
+     * Create Clone
+     * 
+     * @return {SessionStorage}
+     */
+    getClone() {
+        const self = this;
+        return new SessionStorage(self[internalSymbol].getRealSubject()['options'].key);
+    }
+
+}

package/source/data/datasource/{storage.js → storage.mjs}

@@ -1,13 +1,15 @@
-'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 {assignToNamespace, Monster} from '../../namespace.js';
-import {validateString} from "../../types/validate.js";
-import {Datasource} from "../datasource.js";
+import {internalSymbol} from "../../constants.mjs";
+import {validateString} from "../../types/validate.mjs";
+import {Datasource} from "../datasource.mjs";
+
+export {Storage, storageObjectSymbol}
 
 /**
  * @private
@@ -16,30 +18,9 @@ import {Datasource} from "../datasource.js";
 const storageObjectSymbol = Symbol('storageObject');
 
 /**
- * You can create an object of this class using the monster namespace `Monster.Data.Datasource.Storage()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * Monster.Data.Datasource.Storage()
- * </script>
- * ```
- *
- * Alternatively you can import the class directly
- *
- * ```
- * <script type="module">
- * import {Storage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/datasource/storage.js';
- * new Storage()
- * </script>
- * ```
- *
- * @example
- *
- * import {Storage} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/datasource/storage.js';
- *
- * new Datasource();
- *
+ * The class represents a record.
+ * 
+ * @license AGPLv3
  * @since 1.22.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data.Datasource
@@ -125,7 +106,3 @@ class Storage extends Datasource {
     } 
     
 }
-
-
-assignToNamespace('Monster.Data.Datasource', Storage);
-export {Monster, Storage, storageObjectSymbol}

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

@@ -1,24 +1,27 @@
-'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 {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from "../types/base.js";
-import {parseDataURL} from "../types/dataurl.js";
-import {isString} from "../types/is.js";
-import {ProxyObserver} from "../types/proxyobserver.js";
-import {validateObject} from "../types/validate.js";
-import {extend} from "./extend.js";
-import {Pathfinder} from "./pathfinder.js";
+import {internalSymbol} from "../constants.mjs";
+
+import {Base} from "../types/base.mjs";
+import {parseDataURL} from "../types/dataurl.mjs";
+import {isString} from "../types/is.mjs";
+import {ProxyObserver} from "../types/proxyobserver.mjs";
+import {validateObject} from "../types/validate.mjs";
+import {extend} from "./extend.mjs";
+import {Pathfinder} from "./pathfinder.mjs";
 
+export {Datasource}
 
 /**
  * @private
  * @type {symbol}
  * @memberOf Monster.Data
+ * @license AGPLv3
  * @since 1.24.0
  */
 const internalDataSymbol = Symbol('internalData');
@@ -26,35 +29,8 @@ const internalDataSymbol = Symbol('internalData');
 /**
  * The datasource class is the basis for dealing with different data sources.
  * It provides a unified interface for accessing data
- *
- * You can create an object of this class using the monster namespace `Monster.Data.Datasource()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * Monster.Data.Datasource()
- * </script>
- * ```
- *
- * Alternatively you can import the class directly
- *
- * ```
- * <script type="module">
- * import {Datasource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/datasource.js';
- * new Datasource()
- * </script>
- * ```
- *
- * @example
- *
- * import {Datasource} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/data/datasource.js'
- *
- * class MyDatasource extends Datasource {
- *  
- * }
- *
- * const ds = new MyDatasource();
- *
+ * @externalExample ../../example/data/datasource.mjs
+ * @license AGPLv3
  * @since 1.22.0
  * @copyright schukai GmbH
  * @memberOf Monster.Data
@@ -240,7 +216,3 @@ function parseOptionsJSON(data) {
 
     return {};
 }
-
-
-assignToNamespace('Monster.Data', Datasource);
-export {Monster, Datasource}