@schukai/monster 1.22.0 → 1.26.0

package/source/text/formatter.js

@@ -1,12 +1,47 @@
 'use strict';
 
-import {Pipe} from "../data/pipe.js";
 /**
  * @author schukai GmbH
  */
+
+import {internalSymbol} from "../constants.js";
+import {extend} from "../data/extend.js";
+import {Pipe} from "../data/pipe.js";
 import {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from "../types/base.js";
-import {validateObject, validateString} from "../types/validate.js";
+import {BaseWithOptions} from "../types/basewithoptions.js";
+import {isObject, isString} from "../types/is.js";
+import {validateArray, validateString} from "../types/validate.js";
+
+
+/**
+ * @private
+ * @type {symbol}
+ */
+const internalObjectSymbol = Symbol('internalObject');
+
+/**
+ * @private
+ * @type {symbol}
+ */
+const watchdogSymbol = Symbol('watchdog');
+
+/**
+ * @private
+ * @type {symbol}
+ */
+const markerOpenIndexSymbol = Symbol('markerOpenIndex');
+
+/**
+ * @private
+ * @type {symbol}
+ */
+const markerCloseIndexSymbol = Symbol('markercloseIndex');
+
+/**
+ * @private
+ * @type {symbol}
+ */
+const workingDataSymbol = Symbol('workingData');
 
 
 /**
@@ -14,12 +49,12 @@ import {validateObject, validateString} from "../types/validate.js";
  *
  * Look at the example below. The placeholders use the logic of Pipe.
  *
- * You can call the method via the monster namespace `new Monster.Text.Formatter()`.
+ * You can create an instance via the monster namespace `new Monster.Text.Formatter()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/text/formatter.js';
- * console.log(new Monster.Text.Formatter())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * new Monster.Text.Formatter()
  * </script>
  * ```
  *
@@ -27,13 +62,53 @@ import {validateObject, validateString} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {Formatter} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/text/formatter.js';
- * console.log(new Formatter())
+ * import {Formatter} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/text/formatter.js';
+ * new Formatter()
  * </script>
  * ```
  *
+ * ## Marker in marker
+ *
+ * Markers can be nested. Here, the inner marker is resolved first `${subkey} ↦ 1 = ${mykey2}` and then the outer marker `${mykey2}`.
+ *
+ * ```
+ * const text = '${mykey${subkey}}';
+ * let obj = {
+ *  mykey2: "1",
+ *  subkey: "2"
+ * };
+ *
+ * new Formatter(obj).format(text);
+ * // ↦ 1
+ * ```
+ *
+ * ## Callbacks
+ *
+ * The values in a formatter can be adjusted via the commands of the `Transformer` or the`Pipe`.
+ * There is also the possibility to use callbacks.
+ *
+ * const formatter = new Formatter({x: '1'}, {
+ *                callbacks: {
+ *                    quote: (value) => {
+ *                        return '"' + value + '"'
+ *                    }
+ *                }
+ *            });
+ *
+ * formatter.format('${x | call:quote}'))
+ * // ↦ "1"
+ *
+ * ## Marker with parameter
+ *
+ * A string can also bring its own values. These must then be separated from the key by a separator `::`.
+ * The values themselves must be specified in key/value pairs. The key must be separated from the value by a separator `=`.
+ *
+ * When using a pipe, you must pay attention to the separators.
+ *
  * @example
  *
+ * import {Formatter} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/text/formatter.js';
+ *
  * new Formatter({
  *       a: {
  *           b: {
@@ -41,7 +116,7 @@ import {validateObject, validateString} from "../types/validate.js";
  *           },
  *           d: "world",
  *       }
- *   }).format("${a.b.c} ${a.d | ucfirst}!");
+ *   }).format("${a.b.c} ${a.d | ucfirst}!"); // with pipe
  *
  * // ↦ Hello World!
  *
@@ -49,7 +124,7 @@ import {validateObject, validateString} from "../types/validate.js";
  * @copyright schukai GmbH
  * @memberOf Monster.Text
  */
-class Formatter extends Base {
+class Formatter extends BaseWithOptions {
 
     /**
      * Default values for the markers are `${` and `}`
@@ -57,11 +132,65 @@ class Formatter extends Base {
      * @param {object} object
      * @throws {TypeError} value is not a object
      */
-    constructor(object) {
-        super();
-        this.object = validateObject(object);
-        this.openMarker = '${';
-        this.closeMarker = '}';
+    constructor(object, options) {
+        super(options);
+        this[internalObjectSymbol] = object || {}
+        this[markerOpenIndexSymbol] = 0;
+        this[markerCloseIndexSymbol] = 0;
+    }
+
+    /**
+     * @property {object} marker
+     * @property {array} marker.open=["${"]
+     * @property {array} marker.close=["${"]
+     * @property {object} parameter
+     * @property {string} parameter.delimiter="::"
+     * @property {string} parameter.assignment="="
+     * @property {object} callbacks={}
+     */
+    get defaults() {
+        return extend({}, super.defaults, {
+            marker: {
+                open: ['${'],
+                close: ['}']
+            },
+            parameter: {
+                delimiter: '::',
+                assignment: '='
+            },
+            callbacks: {},
+        })
+    }
+
+
+    /**
+     * Set new Parameter Character
+     *
+     * Default values for the chars are `::` and `=`
+     *
+     * ```
+     * formatter.setParameterChars('#');
+     * formatter.setParameterChars('[',']');
+     * formatter.setParameterChars('i18n{','}');
+     * ```
+     *
+     * @param {string} delimiter
+     * @param {string} assignment
+     * @return {Formatter}
+     * @since 1.24.0
+     * @throws {TypeError} value is not a string
+     */
+    setParameterChars(delimiter, assignment) {
+
+        if (delimiter !== undefined) {
+            this[internalSymbol]['parameter']['delimiter'] = validateString(delimiter);
+        }
+
+        if (assignment !== undefined) {
+            this[internalSymbol]['parameter']['assignment'] = validateString(assignment);
+        }
+
+        return this;
     }
 
     /**
@@ -75,8 +204,8 @@ class Formatter extends Base {
      * formatter.setMarker('i18n{','}');
      * ```
      *
-     * @param {string} open
-     * @param {string} close
+     * @param {array|string} open
+     * @param {array|string|undefined} close
      * @return {Formatter}
      * @since 1.12.0
      * @throws {TypeError} value is not a string
@@ -87,8 +216,11 @@ class Formatter extends Base {
             close = open;
         }
 
-        this.openMarker = validateString(open);
-        this.closeMarker = validateString(close);
+        if (isString(open)) open = [open];
+        if (isString(close)) close = [close];
+
+        this[internalSymbol]['marker']['open'] = validateArray(open);
+        this[internalSymbol]['marker']['close'] = validateArray(close);
         return this;
     }
 
@@ -97,11 +229,51 @@ class Formatter extends Base {
      * @param {string} text
      * @return {string}
      * @throws {TypeError} value is not a string
+     * @throws {Error} too deep nesting
      */
     format(text) {
-        return tokenizer.call(this, validateString(text))
+        this[watchdogSymbol] = 0;
+        this[markerOpenIndexSymbol] = 0;
+        this[markerCloseIndexSymbol] = 0;
+        this[workingDataSymbol] = {};
+        return format.call(this, text);
+    }
+
+}
+
+/**
+ * @private
+ * @return {string}
+ */
+function format(text) {
+    const self = this;
+
+    self[watchdogSymbol]++;
+    if (this[watchdogSymbol] > 20) {
+        throw new Error('too deep nesting')
+    }
+
+    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)
+
+    if (self[internalSymbol]['marker']['open']?.[this[markerOpenIndexSymbol] + 1]) {
+        this[markerOpenIndexSymbol]++;
+    }
+
+    if (self[internalSymbol]['marker']['close']?.[this[markerCloseIndexSymbol] + 1]) {
+        this[markerCloseIndexSymbol]++;
     }
 
+    result = format.call(self, result)
+
+    return result;
 }
 
 /**
@@ -110,15 +282,18 @@ class Formatter extends Base {
  * @param text
  * @return {string}
  */
-function tokenizer(text) {
+function tokenize(text, openMarker, closeMarker) {
     const self = this;
 
     let formatted = [];
 
-    while (true) {
+    const parameterAssignment = self[internalSymbol]['parameter']['assignment']
+    const parameterDelimiter = self[internalSymbol]['parameter']['delimiter']
+    const callbacks = self[internalSymbol]['callbacks'];
 
+    while (true) {
 
-        let startIndex = text.indexOf(self.openMarker);
+        let startIndex = text.indexOf(openMarker);
         // no marker 
         if (startIndex === -1) {
             formatted.push(text);
@@ -128,18 +303,60 @@ function tokenizer(text) {
             text = text.substring(startIndex)
         }
 
-        let endIndex = text.substring(self.openMarker.length).indexOf(self.closeMarker) + self.openMarker.length;
+        let endIndex = text.substring(openMarker.length).indexOf(closeMarker);
+        if (endIndex !== -1) endIndex += openMarker.length;
+        let insideStartIndex = text.substring(openMarker.length).indexOf(openMarker);
+        if (insideStartIndex !== -1) {
+            insideStartIndex += openMarker.length;
+            if (insideStartIndex < endIndex) {
+                let result = tokenize.call(self, text.substring(insideStartIndex), openMarker, closeMarker);
+                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;
         }
 
-        let command = "path:" + text.substring(self.openMarker.length, endIndex);
+        let key = text.substring(openMarker.length, endIndex);
+        let parts = key.split(parameterDelimiter);
+        let currentPipe = parts.shift();
+
+        self[workingDataSymbol] = extend({}, self[internalObjectSymbol], self[workingDataSymbol]);
+
+        for (const kv of parts) {
+            const [k, v] = kv.split(parameterAssignment);
+            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:';
+
+        let command = "";
+        if (prefix && key.indexOf(prefix) !== 0
+            && key.indexOf('path:') !== 0
+            && key.indexOf('static:') !== 0) {
+            command = prefix;
+        }
+
+        command += currentPipe;
+
+        const pipe = new Pipe(command);
+
+        if (isObject(callbacks)) {
+            for (const [name, callback] of Object.entries(callbacks)) {
+                pipe.setCallback(name, callback);
+            }
+        }
 
-        formatted.push(validateString(new Pipe(command).run(self.object)));
+        formatted.push(validateString(pipe.run(self[workingDataSymbol])));
 
-        text = text.substring(endIndex + self.closeMarker.length);
+        text = text.substring(endIndex + closeMarker.length);
 
     }
 

package/source/types/base.js

@@ -13,8 +13,8 @@ import {assignToNamespace, Monster} from '../namespace.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/base.js';
- * console.log(new Monster.Types.Base())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * new Monster.Types.Base()
  * </script>
  * ```
  *
@@ -22,8 +22,8 @@ import {assignToNamespace, Monster} from '../namespace.js';
  *
  * ```
  * <script type="module">
- * import {Base} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/base.js';
- * console.log(new Base())
+ * import {Base} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/base.js';
+ * new Base()
  * </script>
  * ```
  *

package/source/types/basewithoptions.js

@@ -1,21 +1,16 @@
 'use strict';
 
-import {PROPERTY_KEY_INTERNALDATA} from "../constants.js";
-import {extend} from "../data/extend.js";
-import {Pathfinder} from "../data/pathfinder.js";
 /**
  * @author schukai GmbH
  */
+
+import {internalSymbol} from "../constants.js";
+import {extend} from "../data/extend.js";
+import {Pathfinder} from "../data/pathfinder.js";
 import {assignToNamespace, Monster} from '../namespace.js';
 import {Base} from "./base.js";
 import {validateObject} from "./validate.js";
 
-/**
- * @private
- * @type {symbol}
- */
-const optionsSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
-
 /**
  * This is the base class with options from which some monster classes are derived.
  *
@@ -23,8 +18,8 @@ const optionsSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/basewithoptions.js';
- * console.log(new Monster.Types.BaseWithOptions())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * new Monster.Types.BaseWithOptions()
  * </script>
  * ```
  *
@@ -32,8 +27,8 @@ const optionsSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
  *
  * ```
  * <script type="module">
- * import {BaseWithOptions} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/basewithoptions.js';
- * console.log(new BaseWithOptions())
+ * import {BaseWithOptions} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/basewithoptions.js';
+ * new BaseWithOptions()
  * </script>
  * ```
  *
@@ -56,7 +51,7 @@ class BaseWithOptions extends Base {
             options = {};
         }
 
-        this[optionsSymbol] = extend({}, this.defaults, validateObject(options));
+        this[internalSymbol] = extend({}, this.defaults, validateObject(options));
 
     }
 
@@ -81,7 +76,7 @@ class BaseWithOptions extends Base {
         let value;
 
         try {
-            value = new Pathfinder(this[optionsSymbol]).getVia(path);
+            value = new Pathfinder(this[internalSymbol]).getVia(path);
         } catch (e) {
 
         }

package/source/types/binary.js

@@ -13,8 +13,8 @@ import {Monster, validateString} from "./validate.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/binary.js';
- * console.log(Monster.Types.toBinary())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * Monster.Types.toBinary()
  * </script>
  * ```
  *
@@ -22,8 +22,8 @@ import {Monster, validateString} from "./validate.js";
  *
  * ```
  * <script type="module">
- * import {toBinary} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/binary.js';
- * console.log(toBinary())
+ * import {toBinary} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/binary.js';
+ * toBinary()
  * </script>
  * ```
  *
@@ -54,8 +54,8 @@ function toBinary(string) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/binary.js';
- * console.log(Monster.Types.fromBinary())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * Monster.Types.fromBinary()
  * </script>
  * ```
  *
@@ -63,8 +63,8 @@ function toBinary(string) {
  *
  * ```
  * <script type="module">
- * import {fromBinary} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/binary.js';
- * console.log(fromBinary())
+ * import {fromBinary} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/binary.js';
+ * fromBinary()
  * </script>
  * ```
  *

package/source/types/dataurl.js

@@ -20,8 +20,8 @@ const internal = Symbol('internal');
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/dataurl.js';
- * console.log(new Monster.Types.DataUrl())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * new Monster.Types.DataUrl()
  * </script>
  * ```
  *
@@ -29,8 +29,8 @@ const internal = Symbol('internal');
  *
  * ```
  * <script type="module">
- * import {DataUrl} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/dataurl.js';
- * console.log(new DataUrl())
+ * import {DataUrl} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/dataurl.js';
+ * new DataUrl()
  * </script>
  * ```
  *
@@ -98,7 +98,7 @@ class DataUrl extends Base {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/dataurl.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(Monster.Types.parseDataURL())
  * </script>
  * ```
@@ -107,7 +107,7 @@ class DataUrl extends Base {
  *
  * ```
  * <script type="module">
- * import {parseDataURL} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/dataurl.js';
+ * import {parseDataURL} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/dataurl.js';
  * console.log(parseDataURL())
  * </script>
  * ```

package/source/types/global.js

@@ -78,8 +78,9 @@ function getGlobal() {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/global.js';
- * console.log(Monster.Types.getGlobalObject('document')) // ↦ { }
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
+ * Monster.Types.getGlobalObject('document') 
+ * // ↦ { }
  * </script>
  * ```
  *
@@ -87,8 +88,9 @@ function getGlobal() {
  *
  * ```
  * <script type="module">
- * import {getGlobalObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/global.js';
- * console.log(getGlobalObject('document')) // ↦ { }
+ * import {getGlobalObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/global.js';
+ * getGlobalObject('document') 
+ * // ↦ { }
  * </script>
  * ```
  *
@@ -115,7 +117,7 @@ function getGlobalObject(name) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/global.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(Monster.Types.getGlobalFunction('parseInt')) // ↦ f parseInt() { }
  * </script>
  * ```
@@ -124,7 +126,7 @@ function getGlobalObject(name) {
  *
  * ```
  * <script type="module">
- * import {getGlobalFunction} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/global.js';
+ * import {getGlobalFunction} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/global.js';
  * console.log(getGlobalFunction('parseInt')) // ↦ f parseInt() { }
  * </script>
  * ```
@@ -132,7 +134,7 @@ function getGlobalObject(name) {
  * @since 1.6.0
  * @memberOf Monster.Types
  * @param {string} name
- * @returns {objec}
+ * @return {objec}
  * @throws {TypeError} value is not a function
  * @throws {Error} the function is not defined
  * @throws {TypeError} value is not a string

package/source/types/id.js

@@ -24,7 +24,7 @@ let internalCounter = new Map;
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/id.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/monster.js';
  * console.log(new Monster.Types.ID())
  * </script>
  * ```
@@ -33,7 +33,7 @@ let internalCounter = new Map;
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.22.0/dist/modules/types/id.js';
+ * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.26.0/dist/modules/types/id.js';
  * console.log(new ID())
  * </script>
  * ```
@@ -43,11 +43,14 @@ let internalCounter = new Map;
  * @since 1.0.0
  * @copyright schukai GmbH
  * @memberOf Monster.Types
+ * @summary Automatic generation of ids
  */
 class ID extends Base {
 
     /**
-     * create new object
+     * create new id with prefix
+     *
+     * @param {string} prefix
      */
     constructor(prefix) {
         super();