@schukai/monster 3.5.0 → 3.8.0

package/source/text/formatter.mjs

@@ -5,46 +5,45 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol} from "../constants.mjs";
-import {extend} from "../data/extend.mjs";
-import {Pipe} from "../data/pipe.mjs";
+import { internalSymbol } from "../constants.mjs";
+import { extend } from "../data/extend.mjs";
+import { Pipe } from "../data/pipe.mjs";
 
-import {BaseWithOptions} from "../types/basewithoptions.mjs";
-import {isObject, isString} from "../types/is.mjs";
-import {validateArray, validateString} from "../types/validate.mjs";
+import { BaseWithOptions } from "../types/basewithoptions.mjs";
+import { isObject, isString } from "../types/is.mjs";
+import { validateArray, validateString } from "../types/validate.mjs";
 
-export {Formatter}
+export { Formatter };
 
 /**
  * @private
  * @type {symbol}
  */
-const internalObjectSymbol = Symbol('internalObject');
+const internalObjectSymbol = Symbol("internalObject");
 
 /**
  * @private
  * @type {symbol}
  */
-const watchdogSymbol = Symbol('watchdog');
+const watchdogSymbol = Symbol("watchdog");
 
 /**
  * @private
  * @type {symbol}
  */
-const markerOpenIndexSymbol = Symbol('markerOpenIndex');
+const markerOpenIndexSymbol = Symbol("markerOpenIndex");
 
 /**
  * @private
  * @type {symbol}
  */
-const markerCloseIndexSymbol = Symbol('markercloseIndex');
+const markerCloseIndexSymbol = Symbol("markercloseIndex");
 
 /**
  * @private
  * @type {symbol}
  */
-const workingDataSymbol = Symbol('workingData');
-
+const workingDataSymbol = Symbol("workingData");
 
 /**
  * Messages can be formatted with the formatter. To do this, an object with the values must be passed to the formatter. The message can then contain placeholders.
@@ -109,8 +108,7 @@ const workingDataSymbol = Symbol('workingData');
  * @copyright schukai GmbH
  * @memberOf Monster.Text
  */
- class Formatter extends BaseWithOptions {
-
+class Formatter extends BaseWithOptions {
     /**
      * Default values for the markers are `${` and `}`
      *
@@ -119,7 +117,7 @@ const workingDataSymbol = Symbol('workingData');
      */
     constructor(object, options) {
         super(options);
-        this[internalObjectSymbol] = object || {}
+        this[internalObjectSymbol] = object || {};
         this[markerOpenIndexSymbol] = 0;
         this[markerCloseIndexSymbol] = 0;
     }
@@ -136,18 +134,17 @@ const workingDataSymbol = Symbol('workingData');
     get defaults() {
         return extend({}, super.defaults, {
             marker: {
-                open: ['${'],
-                close: ['}']
+                open: ["${"],
+                close: ["}"],
             },
             parameter: {
-                delimiter: '::',
-                assignment: '='
+                delimiter: "::",
+                assignment: "=",
             },
             callbacks: {},
-        })
+        });
     }
 
-
     /**
      * Set new Parameter Character
      *
@@ -166,13 +163,12 @@ const workingDataSymbol = Symbol('workingData');
      * @throws {TypeError} value is not a string
      */
     setParameterChars(delimiter, assignment) {
-
         if (delimiter !== undefined) {
-            this[internalSymbol]['parameter']['delimiter'] = validateString(delimiter);
+            this[internalSymbol]["parameter"]["delimiter"] = validateString(delimiter);
         }
 
         if (assignment !== undefined) {
-            this[internalSymbol]['parameter']['assignment'] = validateString(assignment);
+            this[internalSymbol]["parameter"]["assignment"] = validateString(assignment);
         }
 
         return this;
@@ -196,7 +192,6 @@ const workingDataSymbol = Symbol('workingData');
      * @throws {TypeError} value is not a string
      */
     setMarker(open, close) {
-
         if (close === undefined) {
             close = open;
         }
@@ -204,8 +199,8 @@ const workingDataSymbol = Symbol('workingData');
         if (isString(open)) open = [open];
         if (isString(close)) close = [close];
 
-        this[internalSymbol]['marker']['open'] = validateArray(open);
-        this[internalSymbol]['marker']['close'] = validateArray(close);
+        this[internalSymbol]["marker"]["open"] = validateArray(open);
+        this[internalSymbol]["marker"]["close"] = validateArray(close);
         return this;
     }
 
@@ -223,7 +218,6 @@ const workingDataSymbol = Symbol('workingData');
         this[workingDataSymbol] = {};
         return format.call(this, text);
     }
-
 }
 
 /**
@@ -235,28 +229,28 @@ function format(text) {
 
     self[watchdogSymbol]++;
     if (this[watchdogSymbol] > 20) {
-        throw new Error('too deep nesting')
+        throw new Error("too deep nesting");
     }
 
-    let openMarker = self[internalSymbol]['marker']['open']?.[this[markerOpenIndexSymbol]];
-    let closeMarker = self[internalSymbol]['marker']['close']?.[this[markerCloseIndexSymbol]];
+    let openMarker = self[internalSymbol]["marker"]["open"]?.[this[markerOpenIndexSymbol]];
+    let closeMarker = self[internalSymbol]["marker"]["close"]?.[this[markerCloseIndexSymbol]];
 
     // contains no placeholders
     if (text.indexOf(openMarker) === -1 || text.indexOf(closeMarker) === -1) {
         return text;
     }
 
-    let result = tokenize.call(this, validateString(text), openMarker, closeMarker)
+    let result = tokenize.call(this, validateString(text), openMarker, closeMarker);
 
-    if (self[internalSymbol]['marker']['open']?.[this[markerOpenIndexSymbol] + 1]) {
+    if (self[internalSymbol]["marker"]["open"]?.[this[markerOpenIndexSymbol] + 1]) {
         this[markerOpenIndexSymbol]++;
     }
 
-    if (self[internalSymbol]['marker']['close']?.[this[markerCloseIndexSymbol] + 1]) {
+    if (self[internalSymbol]["marker"]["close"]?.[this[markerCloseIndexSymbol] + 1]) {
         this[markerCloseIndexSymbol]++;
     }
 
-    result = format.call(self, result)
+    result = format.call(self, result);
 
     return result;
 }
@@ -273,20 +267,19 @@ function tokenize(text, openMarker, closeMarker) {
 
     let formatted = [];
 
-    const parameterAssignment = self[internalSymbol]['parameter']['assignment']
-    const parameterDelimiter = self[internalSymbol]['parameter']['delimiter']
-    const callbacks = self[internalSymbol]['callbacks'];
+    const parameterAssignment = self[internalSymbol]["parameter"]["assignment"];
+    const parameterDelimiter = self[internalSymbol]["parameter"]["delimiter"];
+    const callbacks = self[internalSymbol]["callbacks"];
 
     while (true) {
-
         let startIndex = text.indexOf(openMarker);
-        // no marker 
+        // no marker
         if (startIndex === -1) {
             formatted.push(text);
             break;
         } else if (startIndex > 0) {
-            formatted.push(text.substring(0, startIndex))
-            text = text.substring(startIndex)
+            formatted.push(text.substring(0, startIndex));
+            text = text.substring(startIndex);
         }
 
         let endIndex = text.substring(openMarker.length).indexOf(closeMarker);
@@ -296,15 +289,14 @@ function tokenize(text, openMarker, closeMarker) {
             insideStartIndex += openMarker.length;
             if (insideStartIndex < endIndex) {
                 let result = tokenize.call(self, text.substring(insideStartIndex), openMarker, closeMarker);
-                text = text.substring(0, insideStartIndex) + result
+                text = text.substring(0, insideStartIndex) + result;
                 endIndex = text.substring(openMarker.length).indexOf(closeMarker);
                 if (endIndex !== -1) endIndex += openMarker.length;
             }
         }
 
         if (endIndex === -1) {
-            throw new Error("syntax error in formatter template")
-            return;
+            throw new Error("syntax error in formatter template");
         }
 
         let key = text.substring(openMarker.length, endIndex);
@@ -318,15 +310,13 @@ function tokenize(text, openMarker, closeMarker) {
             self[workingDataSymbol][k] = v;
         }
 
-        const t1 = key.split('|').shift().trim(); // pipe symbol
-        const t2 = t1.split('::').shift().trim(); // key value delimiter
-        const t3 = t2.split('.').shift().trim(); // path delimiter
-        let prefix = self[workingDataSymbol]?.[t3] ? 'path:' : 'static:';
+        const t1 = key.split("|").shift().trim(); // pipe symbol
+        const t2 = t1.split("::").shift().trim(); // key value delimiter
+        const t3 = t2.split(".").shift().trim(); // path delimiter
+        let prefix = self[workingDataSymbol]?.[t3] ? "path:" : "static:";
 
         let command = "";
-        if (prefix && key.indexOf(prefix) !== 0
-            && key.indexOf('path:') !== 0
-            && key.indexOf('static:') !== 0) {
+        if (prefix && key.indexOf(prefix) !== 0 && key.indexOf("path:") !== 0 && key.indexOf("static:") !== 0) {
             command = prefix;
         }
 
@@ -343,8 +333,7 @@ function tokenize(text, openMarker, closeMarker) {
         formatted.push(validateString(pipe.run(self[workingDataSymbol])));
 
         text = text.substring(endIndex + closeMarker.length);
-
     }
 
-    return formatted.join('');
+    return formatted.join("");
 }

package/source/types/base.mjs

@@ -5,24 +5,23 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {instanceSymbol} from "../constants.mjs";
-
-export {Base}
+import { instanceSymbol } from "../constants.mjs";
 
+export { Base };
 
 /**
  * This is the base class from which all monster classes are derived.
- * 
+ *
  * This class has besides a `toString` which returns the json representation of the object
  * also a functionality to check if an object is an instance of a class.
- * 
- * Therefor the class has a static method ` [Symbol.hasInstance](that)` which returns true if the object 
- * is an instance of the class. 
+ *
+ * Therefor the class has a static method ` [Symbol.hasInstance](that)` which returns true if the object
+ * is an instance of the class.
  * F
  * @see [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance](developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance)
  *
  * Derived classes should implement a static getter `instanceSymbol` which returns a unique symbol.
- * 
+ *
  * ```javascript
  * static get [instanceSymbol]() {
  *    return Symbol.for("@schukai/monster/types/base");
@@ -37,14 +36,13 @@ export {Base}
  * @memberOf Monster.Types
  */
 class Base extends Object {
-
     /**
      *
      * @returns {string}
      */
     toString() {
         return JSON.stringify(this);
-    };
+    }
 
     /**
      * This method is called by the `instanceof` operator.
@@ -62,13 +60,16 @@ class Base extends Object {
      * @since 2.1.0
      */
     static [Symbol.hasInstance](that) {
-
         if (that === undefined || that === null || (typeof that !== "object" && typeof that !== "function")) {
             return false;
         }
 
-        const thatClass = Object.getPrototypeOf(that)
-        if (thatClass === undefined || thatClass === null || (typeof thatClass !== "object" && typeof thatClass !== "function")) {
+        const thatClass = Object.getPrototypeOf(that);
+        if (
+            thatClass === undefined ||
+            thatClass === null ||
+            (typeof thatClass !== "object" && typeof thatClass !== "function")
+        ) {
             return false;
         }
 
@@ -76,24 +77,20 @@ class Base extends Object {
             return true;
         }
 
-
         // this call the static method of the super class, if there is one
         return super[Symbol.hasInstance](that);
-
     }
-
 }
 
 /**
  * this function checks if the class has a static getter `instanceSymbol` and if the value of this getter is equal to the
- * 
+ *
  * @private
  * @param obj
  * @returns {boolean|any|boolean}
  * @since 2.1.0
  */
 function checkInstanceSymbol(obj) {
-
     if (this.hasOwnProperty(instanceSymbol) === false) {
         return false;
     }
@@ -109,23 +106,16 @@ function checkInstanceSymbol(obj) {
 
     const symbol = proto[instanceSymbol];
     if (symbol === undefined) {
-
         if (obj.__proto__) {
             return checkInstanceSymbol(obj.__proto__);
         } else {
             return false;
         }
-
     }
 
     if (symbol === this[instanceSymbol]) {
         return true;
     }
-    
-    return checkInstanceSymbol.apply(this, [obj.__proto__]);
-
 
+    return checkInstanceSymbol.apply(this, [obj.__proto__]);
 }
-
-
-

package/source/types/basewithoptions.mjs

@@ -5,13 +5,13 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol} from "../constants.mjs";
-import {extend} from "../data/extend.mjs";
-import {Pathfinder} from "../data/pathfinder.mjs";
-import {Base} from "./base.mjs";
-import {validateObject} from "./validate.mjs";
+import { internalSymbol } from "../constants.mjs";
+import { extend } from "../data/extend.mjs";
+import { Pathfinder } from "../data/pathfinder.mjs";
+import { Base } from "./base.mjs";
+import { validateObject } from "./validate.mjs";
 
-export {BaseWithOptions}
+export { BaseWithOptions };
 
 /**
  * This is the base class with options from which some monster classes are derived.
@@ -28,7 +28,6 @@ export {BaseWithOptions}
  * @memberOf Monster.Types
  */
 class BaseWithOptions extends Base {
-
     /**
      *
      * @param {object} options
@@ -41,7 +40,6 @@ class BaseWithOptions extends Base {
         }
 
         this[internalSymbol] = extend({}, this.defaults, validateObject(options));
-
     }
 
     /**
@@ -61,7 +59,7 @@ class BaseWithOptions extends Base {
      * @return {object}
      */
     get defaults() {
-        return {}
+        return {};
     }
 
     /**
@@ -77,13 +75,9 @@ class BaseWithOptions extends Base {
 
         try {
             value = new Pathfinder(this[internalSymbol]).getVia(path);
-        } catch (e) {
-
-        }
+        } catch (e) {}
 
         if (value === undefined) return defaultValue;
         return value;
     }
-
-
 }

package/source/types/binary.mjs

@@ -5,9 +5,9 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {validateString} from "./validate.mjs";
+import { validateString } from "./validate.mjs";
 
-export {toBinary, fromBinary}
+export { toBinary, fromBinary };
 
 /**
  * You can call the function via the monster namespace `Monster.Types.toBinary()`.
@@ -26,7 +26,7 @@ function toBinary(string) {
     }
 
     const charCodes = new Uint8Array(codeUnits.buffer);
-    let result = '';
+    let result = "";
 
     for (let i = 0; i < charCodes.byteLength; i++) {
         result += String.fromCharCode(charCodes[i]);
@@ -51,10 +51,9 @@ function fromBinary(binary) {
         bytes[i] = binary.charCodeAt(i);
     }
     const charCodes = new Uint16Array(bytes.buffer);
-    let result = '';
+    let result = "";
     for (let i = 0; i < charCodes.length; i++) {
         result += String.fromCharCode(charCodes[i]);
     }
     return result;
 }
-

package/source/types/dataurl.mjs

@@ -5,18 +5,18 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {Base} from "./base.mjs";
-import {isString} from "./is.mjs";
-import {MediaType, parseMediaType} from "./mediatype.mjs";
-import {validateBoolean, validateInstance, validateString} from "./validate.mjs";
-import {instanceSymbol} from '../constants.mjs';
-export {DataUrl, parseDataURL}
+import { Base } from "./base.mjs";
+import { isString } from "./is.mjs";
+import { MediaType, parseMediaType } from "./mediatype.mjs";
+import { validateBoolean, validateInstance, validateString } from "./validate.mjs";
+import { instanceSymbol } from "../constants.mjs";
+export { DataUrl, parseDataURL };
 
 /**
  * @private
  * @type {symbol}
  */
-const internal = Symbol('internal');
+const internal = Symbol("internal");
 
 /**
  * You can create an object via the monster namespace `new Monster.Types.DataUrl()`.
@@ -29,7 +29,6 @@ const internal = Symbol('internal');
  * @see https://datatracker.ietf.org/doc/html/rfc2397
  */
 class DataUrl extends Base {
-
     /**
      *
      * @param {String} content
@@ -46,10 +45,8 @@ class DataUrl extends Base {
         this[internal] = {
             content: validateString(content),
             mediatype: validateInstance(mediatype, MediaType),
-            base64: validateBoolean(base64 === undefined ? true : base64)
-        }
-
-
+            base64: validateBoolean(base64 === undefined ? true : base64),
+        };
     }
 
     /**
@@ -61,7 +58,6 @@ class DataUrl extends Base {
         return Symbol.for("@schukai/monster/types/data-url");
     }
 
-
     get content() {
         return this[internal].base64 ? atob(this[internal].content) : this[internal].content;
     }
@@ -70,25 +66,22 @@ class DataUrl extends Base {
         return this[internal].mediatype;
     }
 
-
     /**
      *
      * @return {string}
      * @see https://datatracker.ietf.org/doc/html/rfc2397
      */
     toString() {
-
         let content = this[internal].content;
 
         if (this[internal].base64 === true) {
-            content = ';base64,' + content;
+            content = `;base64,${content}`;
         } else {
-            content = ',' + encodeURIComponent(content);
+            content = `,${encodeURIComponent(content)}`;
         }
 
-        return 'data:' + this[internal].mediatype.toString() + content;
+        return `data:${this[internal].mediatype.toString()}${content}`;
     }
-
 }
 
 /**
@@ -112,31 +105,30 @@ class DataUrl extends Base {
  * @memberOf Monster.Types
  */
 function parseDataURL(dataurl) {
-
     validateString(dataurl);
 
     dataurl = dataurl.trim();
 
-    if (dataurl.substring(0, 5) !== 'data:') {
-        throw new TypeError('incorrect or missing data protocol')
+    if (dataurl.substring(0, 5) !== "data:") {
+        throw new TypeError("incorrect or missing data protocol");
     }
 
     dataurl = dataurl.substring(5);
 
-    let p = dataurl.indexOf(',');
+    let p = dataurl.indexOf(",");
     if (p === -1) {
-        throw new TypeError('malformed data url')
+        throw new TypeError("malformed data url");
     }
 
     let content = dataurl.substring(p + 1);
     let mediatypeAndBase64 = dataurl.substring(0, p).trim();
-    let mediatype = 'text/plain;charset=US-ASCII';
+    let mediatype = "text/plain;charset=US-ASCII";
     let base64Flag = false;
 
     if (mediatypeAndBase64 !== "") {
         mediatype = mediatypeAndBase64;
-        if (mediatypeAndBase64.endsWith('base64')) {
-            let i = mediatypeAndBase64.lastIndexOf(';');
+        if (mediatypeAndBase64.endsWith("base64")) {
+            let i = mediatypeAndBase64.lastIndexOf(";");
             mediatype = mediatypeAndBase64.substring(0, i);
             base64Flag = true;
         } else {

package/source/types/global.mjs

@@ -1,5 +1,3 @@
-
-
 /**
  * Copyright schukai GmbH and contributors 2022. All Rights Reserved.
  * Node module: @schukai/monster
@@ -7,10 +5,9 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
+import { validateFunction, validateObject, validateString } from "./validate.mjs";
 
-import {validateFunction, validateObject, validateString} from "./validate.mjs";
-
-export {getGlobal, getGlobalObject, getGlobalFunction}
+export { getGlobal, getGlobalObject, getGlobalFunction };
 
 /**
  * @type {objec}
@@ -23,28 +20,27 @@ let globalReference;
  * @throws {Error} unsupported environment.
  */
 (function () {
-
-    if (typeof globalThis === 'object') {
+    if (typeof globalThis === "object") {
         globalReference = globalThis;
         return;
     }
 
-    if (typeof self !== 'undefined') {
+    if (typeof self !== "undefined") {
         globalReference = self;
         return;
-    } else if (typeof window !== 'undefined') {
+    } else if (typeof window !== "undefined") {
         globalReference = window;
         return;
     }
 
-    Object.defineProperty(Object.prototype, '__monster__', {
+    Object.defineProperty(Object.prototype, "__monster__", {
         get: function () {
             return this;
         },
-        configurable: true
+        configurable: true,
     });
 
-    if (typeof __monster__ === 'object') {
+    if (typeof __monster__ === "object") {
         __monster__.globalThis = __monster__;
         delete Object.prototype.__monster__;
 
@@ -53,15 +49,11 @@ let globalReference;
     }
 
     try {
-        globalReference = Function('return this')();
-    } catch (e) {
-
-    }
+        globalReference = Function("return this")();
+    } catch (e) {}
 
-    throw new Error("unsupported environment.")
-
-
-}());
+    throw new Error("unsupported environment.");
+})();
 
 /**
  * Return globalThis
@@ -112,7 +104,7 @@ function getGlobal() {
 function getGlobalObject(name) {
     validateString(name);
     let o = globalReference?.[name];
-    if (typeof o === 'undefined') throw new Error('the object ' + name + ' is not defined');
+    if (typeof o === "undefined") throw new Error(`the object ${name} is not defined`);
     validateObject(o);
     return o;
 }
@@ -150,11 +142,7 @@ function getGlobalObject(name) {
 function getGlobalFunction(name) {
     validateString(name);
     let f = globalReference?.[name];
-    if (typeof f === 'undefined') throw new Error('the function ' + name + ' is not defined');
+    if (typeof f === "undefined") throw new Error(`the function ${name} is not defined`);
     validateFunction(f);
     return f;
 }
-
-
-
-