@schukai/monster 1.12.0 → 1.15.0

package/source/i18n/translations.js

@@ -0,0 +1,209 @@
+'use strict';
+
+/**
+ * @author schukai GmbH
+ */
+import {Monster, assignToNamespace} from '../namespace.js';
+import { Base} from "../types/base.js";
+import {isObject, isString} from "../types/is.js";
+import {validateInstance, validateInteger, validateObject, validateString} from "../types/validate.js";
+import {Locale, parseLocale} from "./locale.js";
+
+
+/**
+ * With this class you can manage translations and access the keys.
+ *
+ * You can call the method via the monster namespace `new Monster.I18n.Translations()`.
+ *
+ * ```
+ * <script type="module">
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/i18n/translations.js';
+ * console.log(new Monster.I18n.Translations())
+ * </script>
+ * ```
+ *
+ * Alternatively, you can also integrate this function individually.
+ *
+ * ```
+ * <script type="module">
+ * import {Translations} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/i18n/translations.js';
+ * console.log(new Translations())
+ * </script>
+ * ```
+ *
+ * @example
+ *
+ * const translation = new Translations(parseLocale('en-GB'));
+ *
+ * translation.assignTranslations({
+ *            text1: "abc",
+ *            text2: {'other': 'xyz'}
+ *         });
+ *
+ * translation.getText('text1);
+ * translation.getPluralRuleText('text1',2);
+ *
+ * @since 1.13.0
+ * @copyright schukai GmbH
+ * @memberOf Monster/I18n
+ * @see https://datatracker.ietf.org/doc/html/rfc3066
+ */
+class Translations extends Base {
+
+    /**
+     *
+     * @param {Locale} locale
+     */
+    constructor(locale) {
+        super();
+
+        if (isString(locale)) {
+            locale = parseLocale(locale);
+        }
+
+        this.locale = validateInstance(locale, Locale);
+        this.storage = new Map();
+
+    }
+
+
+    /**
+     * Fetches a text using the specified key.
+     * If no suitable key is found, `defaultText` is taken.
+     *
+     * @param {string} key
+     * @param {string|undefined} defaultText
+     * @return {string}
+     * @throws {Error} key not found
+     */
+    getText(key, defaultText) {
+        if (!this.storage.has(key)) {
+            if (defaultText === undefined) {
+                throw new Error('key ' + key + ' not found');
+            }
+
+            return validateString(defaultText);
+        }
+
+        let r = this.storage.get(key);
+        if (isObject(r)) {
+            return this.getPluralRuleText(key, 'other', defaultText);
+        }
+
+        return this.storage.get(key);
+    }
+
+    /**
+     * A number `count` can be passed to this method. In addition to a number, one of the keywords can also be passed directly.
+     * "zero", "one", "two", "few", "many" and "other". Remember: not every language has all rules.
+     *
+     * The appropriate text for this number is then selected. If no suitable key is found, `defaultText` is taken.
+     *
+     * @param {string} key
+     * @param {integer|count} count
+     * @param {string|undefined} defaultText
+     * @return {string}
+     */
+    getPluralRuleText(key, count, defaultText) {
+        if (!this.storage.has(key)) {
+            return validateString(defaultText);
+        }
+
+        let r = validateObject(this.storage.get(key));
+
+        let keyword;
+        if (isString(count)) {
+            keyword = count.toLocaleString();
+        } else {
+            count = validateInteger(count);
+            if (count === 0) {
+                // special handlig for zero count
+                if (r.hasOwnProperty('zero')) {
+                    return validateString(r['zero']);
+                }
+            }
+
+            keyword = new Intl.PluralRules(this.locale.toString()).select(validateInteger(count));
+        }
+
+        if (r.hasOwnProperty(keyword)) {
+            return validateString(r[keyword]);
+        }
+
+        if (r.hasOwnProperty(DEFAULT_KEY)) {
+            return validateString(r[DEFAULT_KEY]);
+        }
+
+        return validateString(defaultText);
+    }
+
+    /**
+     * Set a text for a key
+     *
+     * ```
+     * translations.setText("text1": "Make my day!");
+     * // plural rules
+     * translations.setText("text6": {
+     *     "zero": "There are no files on Disk.",
+     *     "one": "There is one file on Disk.",
+     *     "other": "There are files on Disk."
+     *     "default": "There are files on Disk."
+     * });
+     * ```
+     *
+     * @param {string} key
+     * @param {string|object} text
+     * @return {Translations}
+     * @throws {TypeError} value is not a string or object
+     */
+    setText(key, text) {
+
+        if (isString(text) || isObject(text)) {
+            this.storage.set(validateString(key), text);
+            return this;
+        }
+
+        throw new TypeError('value is not a string or object');
+
+    }
+
+    /**
+     * This method can be used to transfer overlays from an object. The keys are transferred and the values are entered as text.
+     *
+     * The values can either be character strings or, in the case of texts with plural forms, objects. The plural forms must be stored as text via a standard key "zero", "one", "two", "few", "many" and "other".
+     *
+     * Additionally, the key default can be specified, which will be used if no other key fits.
+     *
+     * In some languages, like for example in german, there is no own more number at the value 0. In these languages the function applies additionally zero.
+     *
+     * ```
+     * translations.assignTranslations({
+     *   "text1": "Make my day!",
+     *   "text2": "I'll be back!",
+     *   "text6": {
+     *     "zero": "There are no files on Disk.",
+     *     "one": "There is one file on Disk.",
+     *     "other": "There are files on Disk."
+     *     "default": "There are files on Disk."
+     * });
+     * ```
+     *
+     * @param {object} translations
+     * @return {Translations}
+     */
+    assignTranslations(translations) {
+        validateObject(translations);
+
+        for (const [k, v] of Object.entries(translations)) {
+            this.setText(k, v);
+        }
+
+        return this;
+
+    }
+
+}
+
+
+assignToNamespace('Monster.I18n', Translations);
+export {Monster, Translations}

package/source/logging/handler/console.js

@@ -4,7 +4,7 @@
  * @author schukai GmbH
  */
 
-import {Monster} from '../../namespace.js';
+import {Monster, assignToNamespace} from '../namespace.js';
 import {Base} from '../../types/base.js';
 import {Handler} from '../../logging/handler.js';
 
@@ -13,7 +13,7 @@ import {Handler} from '../../logging/handler.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/handler/console.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/handler/console.js';
  * console.log(new Monster.Logging.Handler.ConsoleHandler())
  * </script>
  * ```
@@ -22,7 +22,7 @@ import {Handler} from '../../logging/handler.js';
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/handler/console.js';
+ * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/handler/console.js';
  * console.log(new ConsoleHandler())
  * </script>
  * ```
@@ -38,5 +38,5 @@ class ConsoleHandler extends Base {
 }
 
 
-Monster.assignToNamespace('Monster.Logging', ConsoleHandler);
+assignToNamespace('Monster.Logging', ConsoleHandler);
 export {Monster, Handler};

package/source/logging/handler.js

@@ -4,7 +4,7 @@
  * @author schukai GmbH
  */
 
-import {Monster} from '../namespace.js';
+import {Monster, assignToNamespace} from '../namespace.js';
 import {Base} from '../types/base.js';
 import {ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN} from "./logger.js";
 import {LogEntry} from "./logentry.js";
@@ -15,7 +15,7 @@ import {validateInstance, validateInteger} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/handler.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/handler.js';
  * console.log(new Monster.Logging.Handler())
  * </script>
  * ```
@@ -24,7 +24,7 @@ import {validateInstance, validateInteger} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/handler.js';
+ * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/handler.js';
  * console.log(new Handler())
  * </script>
  * ```
@@ -180,5 +180,5 @@ class Handler extends Base {
 }
 
 
-Monster.assignToNamespace('Monster.Logging', Handler);
+assignToNamespace('Monster.Logging', Handler);
 export {Monster, Handler};

package/source/logging/logentry.js

@@ -4,7 +4,7 @@
  * @author schukai GmbH
  */
 
-import {Monster} from '../namespace.js';
+import {Monster, assignToNamespace} from '../namespace.js';
 import {validateInteger} from '../types/validate.js';
 import {Base} from  '../types/base.js';
 
@@ -14,7 +14,7 @@ import {Base} from  '../types/base.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/logentry.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/logentry.js';
  * console.log(new Monster.Logging.LogEntry())
  * </script>
  * ```
@@ -23,7 +23,7 @@ import {Base} from  '../types/base.js';
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/logentry.js';
+ * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/logentry.js';
  * console.log(new LogEntry())
  * </script>
  * ```
@@ -64,5 +64,5 @@ class LogEntry extends Base {
 
 }
 
-Monster.assignToNamespace('Monster.Logging', LogEntry);
+assignToNamespace('Monster.Logging', LogEntry);
 export {Monster, LogEntry}

package/source/logging/logger.js

@@ -4,7 +4,7 @@
  * @author schukai GmbH
  */
 
-import {Monster} from '../namespace.js';
+import {Monster, assignToNamespace} from '../namespace.js';
 import {validateInteger, validateObject, validateString} from '../types/validate.js';
 import {Handler} from '../logging/handler.js';
 import {LogEntry} from '../logging/logentry.js';
@@ -65,7 +65,7 @@ const OFF = 0;
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/logger.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/logger.js';
  * console.log(new Monster.Logging.Logger())
  * </script>
  * ```
@@ -74,7 +74,7 @@ const OFF = 0;
  *
  * ```
  * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/logging/logger.js';
+ * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/logging/logger.js';
  * console.log(new Logger())
  * </script>
  * ```
@@ -256,7 +256,7 @@ class Logger extends Base {
 
 }
 
-Monster.assignToNamespace('Monster.Logging', Logger);
+assignToNamespace('Monster.Logging', Logger);
 export {Monster, Logger, ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF};
 
 

package/source/logging/namespace.js

@@ -1,6 +1,8 @@
 'use strict';
 
 /**
+ * Namespace for logging.
+ * 
  * @namespace Monster/Logging
  * @author schukai GmbH
  */

package/source/math/namespace.js

@@ -1,6 +1,8 @@
 'use strict';
 
 /**
+ * Namespace for math.
+ * 
  * @namespace Monster/Math
  * @author schukai GmbH
  */

package/source/math/random.js

@@ -4,8 +4,8 @@
  * @author schukai GmbH
  */
 
-
-import {Monster, getGlobal} from '../types/global.js';
+import {Monster, assignToNamespace} from '../namespace.js';
+import { getGlobal} from '../types/global.js';
 
 
 /**
@@ -15,7 +15,7 @@ import {Monster, getGlobal} from '../types/global.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/math/random.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/math/random.js';
  * console.log(Monster.Math.random(1,10)) // ↦ 5
  * </script>
  * ```
@@ -24,7 +24,7 @@ import {Monster, getGlobal} from '../types/global.js';
  *
  * ```
  * <script type="module">
- * import {random} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/math/random.js';
+ * import {random} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/math/random.js';
  * console.log(random(1,10)) // ↦ 5
  * </script>
  * ```
@@ -120,7 +120,7 @@ function create(min, max) {
 
 }
 
-Monster.assignToNamespace('Monster.Math', random);
+assignToNamespace('Monster.Math', random);
 export {Monster, random}
 
 

package/source/monster.js

@@ -9,21 +9,8 @@
 
 import {Monster} from './namespace.js';
 
-import './types/base.js';
-import './types/queue.js';
-import './types/observer.js';
-import './types/global.js';
-import './types/observerlist.js';
-import './types/is.js';
-import './types/proxyobserver.js';
-import './types/uniquequeue.js';
-import './types/tokenlist.js';
-import './types/typeof.js';
-import './types/version.js';
-import './types/id.js';
-import './types/randomid.js';
-import './types/validate.js';
-import './types/stack.js';
+// find . -type f -name "*.js" -not -name "*namespace*" -not -iname  "monster.js"
+
 import './constraints/isobject.js';
 import './constraints/valid.js';
 import './constraints/invalid.js';
@@ -36,18 +23,42 @@ import './logging/logger.js';
 import './logging/handler.js';
 import './logging/logentry.js';
 import './logging/handler/console.js';
+import './text/formatter.js';
 import './dom/updater.js';
 import './dom/attributes.js';
 import './dom/template.js';
 import './dom/util.js';
+import './dom/locale.js';
+import './dom/customcontrol.js';
 import './dom/constants.js';
 import './dom/assembler.js';
 import './dom/theme.js';
 import './dom/events.js';
 import './dom/customelement.js';
+import './i18n/providers/fetch.js';
+import './i18n/translations.js';
+import './i18n/locale.js';
+import './i18n/provider.js';
+import './types/queue.js';
+import './types/observer.js';
+import './types/global.js';
+import './types/observerlist.js';
+import './types/basewithoptions.js';
+import './types/is.js';
+import './types/proxyobserver.js';
+import './types/uniquequeue.js';
+import './types/tokenlist.js';
+import './types/typeof.js';
+import './types/base.js';
+import './types/version.js';
+import './types/id.js';
+import './types/randomid.js';
+import './types/validate.js';
+import './types/stack.js';
 import './util/comparator.js';
 import './util/clone.js';
 import './util/freeze.js';
+import './constants.js';
 import './data/pathfinder.js';
 import './data/pipe.js';
 import './data/extend.js';
@@ -55,7 +66,6 @@ import './data/diff.js';
 import './data/buildmap.js';
 import './data/transformer.js';
 import './math/random.js';
-import './text/formatter.js';
 
 Monster.Util.deepFreeze(Monster);
 

package/source/namespace.js

@@ -1,6 +1,8 @@
 'use strict';
 
 /**
+ * Main namespace for Monster.
+ *
  * @namespace Monster
  * @author schukai GmbH
  */
@@ -55,27 +57,27 @@ class Namespace {
 export const Monster = new Namespace("Monster");
 
 /**
- * To expand monster, the `Monster.assignToNamespace()` method can be used. 
+ * To expand monster, the `Monster.assignToNamespace()` method can be used.
  *
  * you must call the method in the monster namespace. this allows you to mount your own classes, objects and functions into the namespace.
- * 
+ *
  * To avoid confusion and so that you do not accidentally overwrite existing functions, you should use the custom namespace `X`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/namespace.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/namespace.js';
  * function hello() {
  *            console.log('Hello World!');
  *        }
  * Monster.assignToNamespace("Monster.X", hello)
  * Monster.X.hello(); // ↦ Hello World!
  * </script>
- * 
+ *
  * ```
  *
  * @param {string} ns
  * @param {function} obj
- * @return {current} 
+ * @return {current}
  * @memberOf Monster
  * @throws {Error} no functions have been passed.
  * @throws {Error} the name of the class or function cannot be resolved.
@@ -86,14 +88,14 @@ export const Monster = new Namespace("Monster");
 function assignToNamespace(ns, ...obj) {
     let current = namespaceFor(ns.split("."));
 
-    if(obj.length===0) {
+    if (obj.length === 0) {
         throw new Error('no functions have been passed.');
     }
-    
+
     for (let i = 0, l = obj.length; i < l; i++) {
         current[objectName(obj[i])] = obj[i];
     }
-    
+
     return current
 }
 

package/source/text/formatter.js

@@ -3,9 +3,8 @@
 /**
  * @author schukai GmbH
  */
-
+import {Monster, assignToNamespace} from '../namespace.js';
 import {Pipe} from "../data/pipe.js";
-import {Monster} from '../namespace.js';
 import {Base} from "../types/base.js";
 import {validateObject, validateString} from "../types/validate.js";
 
@@ -19,7 +18,7 @@ import {validateObject, validateString} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/text/formatter.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/text/formatter.js';
  * console.log(new Monster.Text.Formatter())
  * </script>
  * ```
@@ -28,7 +27,7 @@ import {validateObject, validateString} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {Object} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/text/formatter.js';
+ * import {Formatter} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/text/formatter.js';
  * console.log(new Formatter())
  * </script>
  * ```
@@ -147,5 +146,5 @@ function tokenizer(text) {
     return formatted.join('');
 }
 
-Monster.assignToNamespace('Monster.Text', Formatter);
+assignToNamespace('Monster.Text', Formatter);
 export {Monster, Formatter}

package/source/text/namespace.js

@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * lorem ipsum
+ * Namespace for texts.
  * 
  * @namespace Monster/Text
  * @author schukai GmbH

package/source/types/base.js

@@ -4,8 +4,7 @@
  * @author schukai GmbH
  */
 
-import {Monster} from '../namespace.js';
-
+import {Monster, assignToNamespace} from '../namespace.js';
 
 /**
  * This is the base class from which all monster classes are derived.
@@ -14,8 +13,7 @@ import {Monster} from '../namespace.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/types/base.js';
- * console.log(new Monster.Types.Base())
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/types/base.js';
  * console.log(new Monster.Types.Base())
  * </script>
  * ```
@@ -24,8 +22,7 @@ import {Monster} from '../namespace.js';
  *
  * ```
  * <script type="module">
- * import {Object} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.12.0/dist/modules/types/base.js';
- * console.log(new Base())
+ * import {Base} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.0/dist/modules/types/base.js';
  * console.log(new Base())
  * </script>
  * ```
@@ -49,5 +46,5 @@ class Base extends Object {
 
 }
 
-Monster.assignToNamespace('Monster.Types', Base);
+assignToNamespace('Monster.Types', Base);
 export {Monster, Base}