@schukai/monster 3.7.0 → 3.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schukai/monster",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Monster is a simple library for creating fast, robust and lightweight websites.",
   "keywords": [
     "framework",

package/source/data/pathfinder.mjs

@@ -6,9 +6,9 @@
  */
 
 import { Base } from "../types/base.mjs";
-import { isArray, isInteger, isObject, isPrimitive } from "../types/is.mjs";
+import { isArray, isInteger, isObject, isPrimitive, isString } from "../types/is.mjs";
 import { Stack } from "../types/stack.mjs";
-import { validateInteger, validateString } from "../types/validate.mjs";
+import { validateInteger, validateBoolean, validateString } from "../types/validate.mjs";
 
 export { Pathfinder, DELIMITER, WILDCARD };
 
@@ -103,7 +103,7 @@ class Pathfinder extends Base {
 
     /**
      *
-     * @param {string} path
+     * @param {string|array} path
      * @since 1.4.0
      * @returns {*}
      * @throws {TypeError} unsupported type
@@ -113,12 +113,12 @@ class Pathfinder extends Base {
      * @throws {Error} unsupported action for this data type
      */
     getVia(path) {
-        return getValueViaPath.call(this, this.object, validateString(path));
+        return getValueViaPath.call(this, this.object, path);
     }
 
     /**
      *
-     * @param {string} path
+     * @param {string|array} path
      * @param {*} value
      * @returns {Pathfinder}
      * @since 1.4.0
@@ -128,7 +128,6 @@ class Pathfinder extends Base {
      * @throws {Error} unsupported action for this data type
      */
     setVia(path, value) {
-        validateString(path);
         setValueViaPath.call(this, this.object, path, value);
         return this;
     }
@@ -136,7 +135,7 @@ class Pathfinder extends Base {
     /**
      * Delete Via Path
      *
-     * @param {string} path
+     * @param {string|array} path
      * @returns {Pathfinder}
      * @since 1.6.0
      * @throws {TypeError} unsupported type
@@ -145,14 +144,13 @@ class Pathfinder extends Base {
      * @throws {Error} unsupported action for this data type
      */
     deleteVia(path) {
-        validateString(path);
         deleteValueViaPath.call(this, this.object, path);
         return this;
     }
 
     /**
      *
-     * @param {string} path
+     * @param {string|array} path
      * @return {bool}
      * @throws {TypeError} unsupported type
      * @throws {TypeError} value is not a string
@@ -160,7 +158,6 @@ class Pathfinder extends Base {
      * @since 1.4.0
      */
     exists(path) {
-        validateString(path);
         try {
             getValueViaPath.call(this, this.object, path, true);
             return true;
@@ -173,8 +170,8 @@ class Pathfinder extends Base {
 /**
  *
  * @param {*} subject
- * @param {string} path
- * @param {string} check
+ * @param {string|array} path
+ * @param {boolean} check
  * @return {Map}
  * @throws {TypeError} unsupported type
  * @throws {Error} the journey is not at its end
@@ -182,8 +179,17 @@ class Pathfinder extends Base {
  * @private
  */
 function iterate(subject, path, check) {
+    if (check === undefined) {
+        check = false;
+    }
+    validateBoolean(check);
+
     const result = new Map();
 
+    if (isArray(path)) {
+        path = path.join(DELIMITER);
+    }
+
     if (isObject(subject) || isArray(subject)) {
         for (const [key, value] of Object.entries(subject)) {
             result.set(key, getValueViaPath.call(this, value, path, check));
@@ -199,7 +205,7 @@ function iterate(subject, path, check) {
 /**
  *
  * @param {*} subject
- * @param [string} path
+ * @param [string|array} path
  * @param [boolean} check
  * @returns {*}
  * @throws {TypeError} unsupported type
@@ -208,11 +214,24 @@ function iterate(subject, path, check) {
  * @private
  */
 function getValueViaPath(subject, path, check) {
-    if (path === "") {
-        return subject;
+    if (check === undefined) {
+        check = false;
+    }
+    validateBoolean(check);
+
+    if (!(isArray(path) || isString(path))) {
+        throw new Error("type error: path must be a string or an array");
+    }
+
+    let parts;
+    if (isString(path)) {
+        if (path === "") {
+            return subject;
+        }
+
+        parts = path.split(DELIMITER);
     }
 
-    let parts = path.split(DELIMITER);
     let current = parts.shift();
 
     if (current === this.wildCard) {
@@ -261,9 +280,9 @@ function getValueViaPath(subject, path, check) {
 
 /**
  *
- * @param object
- * @param path
- * @param value
+ * @param {object} subject
+ * @param {string|array} path
+ * @param {*} value
  * @returns {void}
  * @throws {TypeError} unsupported type
  * @throws {TypeError} unsupported type
@@ -271,10 +290,22 @@ function getValueViaPath(subject, path, check) {
  * @throws {Error} unsupported action for this data type
  * @private
  */
-function setValueViaPath(object, path, value) {
-    validateString(path);
+function setValueViaPath(subject, path, value) {
+    if (!(isArray(path) || isString(path))) {
+        throw new Error("type error: path must be a string or an array");
+    }
+
+    let parts;
+    if (isArray(path)) {
+        if (path.length === 0) {
+            return subject;
+        }
+
+        parts = path;
+    } else {
+        parts = path.split(DELIMITER);
+    }
 
-    let parts = path.split(DELIMITER);
     let last = parts.pop();
     let subpath = parts.join(DELIMITER);
 
@@ -282,7 +313,7 @@ function setValueViaPath(object, path, value) {
     let current = subpath;
     while (true) {
         try {
-            getValueViaPath.call(this, object, current, true);
+            getValueViaPath.call(this, subject, current, true);
             break;
         } catch (e) {}
 
@@ -304,13 +335,13 @@ function setValueViaPath(object, path, value) {
             }
         }
 
-        setValueViaPath.call(this, object, current, obj);
+        setValueViaPath.call(this, subject, current, obj);
     }
 
-    let anchor = getValueViaPath.call(this, object, subpath);
+    let anchor = getValueViaPath.call(this, subject, subpath);
 
-    if (!(isObject(object) || isArray(object))) {
-        throw TypeError(`unsupported type: ${typeof object}`);
+    if (!(isObject(subject) || isArray(subject))) {
+        throw TypeError(`unsupported type: ${typeof subject}`);
     }
 
     if (anchor instanceof Map || anchor instanceof WeakMap) {
@@ -349,8 +380,8 @@ function assignProperty(object, key, value) {
 
 /**
  *
- * @param object
- * @param path
+ * @param {object} subject
+ * @param {string} path
  * @returns {void}
  * @throws {TypeError} unsupported type
  * @throws {TypeError} unsupported type
@@ -360,12 +391,26 @@ function assignProperty(object, key, value) {
  * @since 1.6.0
  * @private
  */
-function deleteValueViaPath(object, path) {
-    const parts = path.split(DELIMITER);
+function deleteValueViaPath(subject, path) {
+    if (!(isArray(path) || isString(path))) {
+        throw new Error("type error: path must be a string or an array");
+    }
+
+    let parts;
+    if (isArray(path)) {
+        if (path.length === 0) {
+            return subject;
+        }
+
+        parts = path;
+    } else {
+        parts = path.split(DELIMITER);
+    }
+
     let last = parts.pop();
     const subpath = parts.join(DELIMITER);
 
-    const anchor = getValueViaPath.call(this, object, subpath);
+    const anchor = getValueViaPath.call(this, subject, subpath);
 
     if (anchor instanceof Map) {
         anchor.delete(last);

package/source/dom/focusmanager.mjs

@@ -33,7 +33,7 @@ const KEY_CONTEXT = "context";
 const stackSymbol = Symbol("stack");
 
 /**
- * With the focusmanager the focus can be stored in a document, recalled and moved.
+ * With the focus manager the focus can be stored in a document, recalled and moved.
  *
  * @license AGPLv3
  * @since 1.25.0

package/source/dom/locale.mjs

@@ -20,12 +20,13 @@ const DEFAULT_LANGUAGE = "en";
 /**
  * With this function you can read the language version set by the document.
  * For this the attribute `lang` in the html tag is read. If no attribute is set, `en` is used as default.
+ * Alternatively, the language version of the browser is used.
  *
  * ```html
  * <html lang="en">
  * ```
  *
- * You can call the function via the monster namespace `new Monster.DOM.getLocaleOfDocument()`.
+ * You can call the function via `getLocaleOfDocument()`.
  *
  * @license AGPLv3
  * @since 1.13.0

package/source/i18n/locale.mjs

@@ -182,22 +182,11 @@ class Locale extends Base {
  *
  * Limitations: The regex cannot handle multiple variants or private.
  *
- * You can call the method via the monster namespace `Monster.I18n.createLocale()`.
+ * You can call the method via this function individually:
  *
- * ```
- * <script type="module">
- * import {Monster} from '@schukai/monster/source/monster.mjs';
- * new Monster.I18n.createLocale()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
+ * ```javascript
  * import {createLocale} from '@schukai/monster/source/i18n/locale.mjs';
  * createLocale()
- * </script>
  * ```
  *
  * RFC

package/source/i18n/translations.mjs

@@ -112,9 +112,9 @@ class Translations extends Base {
      * Set a text for a key
      *
      * ```
-     * translations.setText("text1": "Make my day!");
+     * translations.setText("text1", "Make my day!");
      * // plural rules
-     * translations.setText("text6": {
+     * translations.setText("text6", {
      *     "zero": "There are no files on Disk.",
      *     "one": "There is one file on Disk.",
      *     "other": "There are files on Disk."

package/source/types/version.mjs

@@ -142,7 +142,7 @@ function getMonsterVersion() {
     }
 
     /** don't touch, replaced by make with package.json version */
-    monsterVersion = new Version("3.7.0");
+    monsterVersion = new Version("3.8.0");
 
     return monsterVersion;
 }

package/test/cases/monster.mjs

@@ -7,7 +7,7 @@ describe('Monster', function () {
         let monsterVersion
 
         /** don´t touch, replaced by make with package.json version */
-        monsterVersion = new Version("3.7.0")
+        monsterVersion = new Version("3.8.0")
 
         let m = getMonsterVersion();