@schukai/monster 1.31.0 → 2.0.2

package/source/i18n/{formatter.js → formatter.mjs}

@@ -1,16 +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.mjs";
+import {extend} from "../data/extend.mjs";
+
+import {Formatter as TextFormatter} from "../text/formatter.mjs";
+import {validateInstance, validateString} from "../types/validate.mjs";
+import {Translations} from "./translations.mjs";
 
-import {internalSymbol} from "../constants.js";
-import {extend} from "../data/extend.js";
-import {assignToNamespace, Monster} from '../namespace.js';
-import {Formatter as TextFormatter} from "../text/formatter.js";
-import {validateInstance, validateString} from "../types/validate.js";
-import {Translations} from "./translations.js";
+export {Formatter}
 
 /**
  * @private
@@ -21,37 +23,8 @@ const internalTranslationSymbol = Symbol('internalTranslation')
 /**
  * The Formatter extends the Text.Formatter with the possibility to replace the key by a translation.
  *
- * You can create an instance via the monster namespace `new Monster.I18n.Formatter()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.I18n.Formatter()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Formatter} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/formatter.js';
- * new Formatter()
- * </script>
- * ```
- *
- * @example
- *
- * import {Formatter} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/formatter.js';
- * import {Translations} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/translations.js';
- *
- * const translations = new Translations('en')
- *     .assignTranslations({
- *         thekey: "${animal} has eaten the ${food}!"
- *     });
- *
- * new Formatter({}, translations).format("thekey:animal=dog::food=cake")
- * // ↦ dog has eaten the cake!
- *
+ * @externalExample ../../example/i18n/formatter.mjs
+ * @license AGPLv3
  * @since 1.26.0
  * @copyright schukai GmbH
  * @memberOf Monster.I18n
@@ -118,8 +91,7 @@ class Formatter extends TextFormatter {
                 throw new Error("the closing marker is missing")
             }
         }
-
-
+        
         const parts = validateString(text).split('::')
         const translationKey = parts.shift().trim(); // key value delimiter
         const parameter = parts.join('::').trim();
@@ -135,6 +107,3 @@ class Formatter extends TextFormatter {
 
 
 }
-
-assignToNamespace('Monster.I18n', Formatter);
-export {Monster, Formatter}

package/source/i18n/{locale.js → locale.mjs}

@@ -1,12 +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 {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from "../types/base.js";
-import {validateString} from "../types/validate.js";
-import {clone} from "../util/clone.js";
+
+import {Base} from "../types/base.mjs";
+import {validateString} from "../types/validate.mjs";
+import {clone} from "../util/clone.mjs";
+
+export {Locale, parseLocale}
 
 /**
  * @memberOf Monster.I18n
@@ -21,23 +24,7 @@ const propertiesSymbol = Symbol('properties');
 const localeStringSymbol = Symbol('localeString');
 
 /**
- * You can create an instance via the monster namespace `new Monster.I18n.Locale()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.I18n.Locale()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this class individually.
- *
- * ```
- * <script type="module">
- * import {Locale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/locale.js';
- * new Locale()
- * </script>
- * ```
+ * The Locale class is a base class for the language classes.
  *
  * RFC
  *
@@ -70,6 +57,7 @@ const localeStringSymbol = Symbol('localeString');
  *                 in the middle)
  * ```
  *
+ * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
  * @memberOf Monster.I18n
@@ -203,7 +191,7 @@ class Locale extends Base {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
+ * import {Monster} from '@schukai/monster/source//monster.mjs';
  * new Monster.I18n.createLocale()
  * </script>
  * ```
@@ -212,7 +200,7 @@ class Locale extends Base {
  *
  * ```
  * <script type="module">
- * import {createLocale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/locale.js';
+ * import {createLocale} from '@schukai/monster/source/i18n/locale.mjs';
  * createLocale()
  * </script>
  * ```
@@ -267,6 +255,7 @@ class Locale extends Base {
  *
  * @param {string} locale
  * @returns {Locale}
+ * @license AGPLv3
  * @since 1.14.0
  * @copyright schukai GmbH
  * @memberOf Monster.I18n
@@ -330,7 +319,3 @@ function parseLocale(locale) {
     return new Locale(language, region, script, variants, extlang);
 
 }
-
-
-assignToNamespace('Monster.I18n', Locale, parseLocale);
-export {Monster, Locale, parseLocale}

package/source/i18n/{namespace.js → namespace.mjs}

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * In this namespace you will find classes and methods for handling locale and localized texts.
  *
@@ -7,10 +5,4 @@
  * @memberOf Monster
  * @author schukai GmbH
  */
-
-
-/**
- * @private
- * @type {string}
- */
-export const namespace = "Monster.I18n";
+const ns = {};

package/source/i18n/provider.mjs

@@ -0,0 +1,40 @@
+/**
+ * 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 {BaseWithOptions} from "../types/basewithoptions.mjs";
+import {Locale} from "./locale.mjs"
+import {Translations} from "./translations.mjs"
+
+export {Provider}
+
+/**
+ * A provider makes a translation object available.
+ *
+ * @license AGPLv3
+ * @since 1.13.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.I18n
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
+ */
+class Provider extends BaseWithOptions {
+
+    /**
+     * @param {Locale|string} locale
+     * @return {Promise}
+     */
+    getTranslations(locale) {
+        return new Promise((resolve, reject) => {
+            try {
+                resolve(new Translations(locale));
+            } catch (e) {
+                reject(e);
+            }
+
+        });
+    }
+
+}

package/source/i18n/providers/{fetch.js → fetch.mjs}

@@ -1,56 +1,34 @@
-'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 {extend} from "../../data/extend.js";
-import {assignToNamespace, Monster} from '../../namespace.js';
-import {Formatter} from "../../text/formatter.js";
-import {getGlobalFunction} from "../../types/global.js";
-import {isInstance, isString} from "../../types/is.js";
-import {validateObject, validateString} from "../../types/validate.js";
-import {parseLocale} from "../locale.js";
-import {Provider} from "../provider.js";
-import {Translations} from "../translations.js";
+import {internalSymbol} from "../../constants.mjs";
+import {extend} from "../../data/extend.mjs";
+import {Formatter} from "../../text/formatter.mjs";
+import {getGlobalFunction} from "../../types/global.mjs";
+import {isInstance, isString} from "../../types/is.mjs";
+import {validateObject, validateString} from "../../types/validate.mjs";
+import {parseLocale} from "../locale.mjs";
+import {Provider} from "../provider.mjs";
+import {Translations} from "../translations.mjs";
+
+export {Fetch}
 
 /**
  * The fetch provider retrieves a JSON file from the given URL and returns a translation object.
- *
- * You can create the object via the monster namespace `new Monster.I18n.Provider.Fetch()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.I18n.Providers.Fetch()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {Fetch} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/providers/fetch.js';
- * new Fetch()
- * </script>
- * ```
- * 
- * @example <caption>das ist ein test</caption>
  * 
- * import {Fetch} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/providers/fetch.js';
- * 
- * // fetch from API
- * const translation = new Fetch('https://example.com/${language}.json').getTranslation('en-GB');
- * // ↦ https://example.com/en.json
- *
+ * @externalExample ../../../example/i18n/providers/fetch.mjs
+ * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
  * @memberOf Monster.I18n.Providers
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
  * @tutorial i18n-locale-and-formatter
  */
-class Fetch extends Provider {
+ class Fetch extends Provider {
 
     /**
      * As options the key `fetch` can be passed. This config object is passed to the fetch method as init.
@@ -142,6 +120,3 @@ class Fetch extends Provider {
 
 }
 
-
-assignToNamespace('Monster.I18n.Providers', Fetch);
-export {Monster, Fetch}

package/source/i18n/providers/namespace.mjs

@@ -0,0 +1,8 @@
+/**
+ * In this namespace you will find classes and methods for handling locale and localized texts.
+ *
+ * @namespace Monster.I18n.Providers
+ * @memberOf Monster
+ * @author schukai GmbH
+ */
+const ns = {};

package/source/i18n/{translations.js → translations.mjs}

@@ -1,59 +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 {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";
 
+import {Base} from "../types/base.mjs";
+import {isObject, isString} from "../types/is.mjs";
+import {validateInstance, validateInteger, validateObject, validateString} from "../types/validate.mjs";
+import {Locale, parseLocale} from "./locale.mjs";
+
+export {Translations}
 
 /**
  * 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.31.0/dist/monster.js';
- * 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.31.0/dist/modules/i18n/translations.js';
- * new Translations()
- * </script>
- * ```
- *
- * @example
- *
- * import {Translations} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/translations.js';
- * import {parseLocale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/i18n/locale.js';
- *
- * const translation = new Translations(parseLocale('en-GB'));
- *
- * translation.assignTranslations({
- *           text1: "click",
- *           text2: {
- *             'one': 'click once',
- *             'other': 'click n times'
- *           }
- *        });
- *
- * console.log(translation.getText('text1'));
- * // ↦ click
- *
- * console.log(translation.getPluralRuleText('text2',1));
- * // -> click once
- * console.log(translation.getPluralRuleText('text2',2));
- * // -> click n times
- *
+ * @externalExample ../../example/i18n/translations.mjs
+ * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
  * @memberOf Monster.I18n
@@ -214,6 +177,3 @@ class Translations extends Base {
     }
 
 }
-
-assignToNamespace('Monster.I18n', Translations);
-export {Monster, Translations}

package/source/logging/handler/console.mjs

@@ -0,0 +1,50 @@
+/**
+ * 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 {Base} from '../../types/base.mjs';
+import {getGlobalObject} from "../../types/global.mjs";
+import {Handler} from '../handler.mjs';
+import {LogEntry} from "../logentry.mjs";
+
+export {ConsoleHandler}
+
+/**
+ * You can create an object of the class simply by using the namespace `new Monster.Logging.Handler.ConsoleHandler()`.
+ * 
+ * @license AGPLv3
+ * @since 1.5.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Logging.Handler
+ */
+ class ConsoleHandler extends Handler {
+    constructor() {
+        super();
+    }
+
+    /**
+     * This is the central log function. this method must be
+     * overwritten by derived handlers with their own logic.
+     *
+     * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
+     *
+     * @param {LogEntry} entry
+     * @returns {boolean}
+     */
+    log(entry) {
+        if (super.log(entry)) {
+            let console = getGlobalObject('console');
+            if (!console) return false;
+            console.log(entry.toString());
+            return true;
+        }
+
+        return false;
+    }
+
+}
+
+

package/source/logging/handler/namespace.mjs

@@ -0,0 +1,6 @@
+/**
+ * @namespace Monster.Logging.Handler
+ * @memberOf Monster.Logging
+ * @author schukai GmbH
+ */
+const ns = {};

package/source/logging/{handler.js → handler.mjs}

@@ -1,39 +1,26 @@
-'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 {Base} from '../types/base.js';
-import {validateInstance, validateInteger} from "../types/validate.js";
-import {LogEntry} from "./logentry.js";
-import {ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN} from "./logger.js";
+import {Base} from '../types/base.mjs';
+import {validateInstance, validateInteger} from "../types/validate.mjs";
+import {LogEntry} from "./logentry.mjs";
+import {ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN} from "./logger.mjs";
+
+export {Handler}
 
 /**
- * you can call the method via the monster namespace `new Monster.Logging.Handler()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * console.log(new Monster.Logging.Handler())
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this function individually.
- *
- * ```
- * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/logging/handler.js';
- * console.log(new Handler())
- * </script>
- * ```
+ * The log handler is the interface between the log entries and the log listeners.
  *
+ * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
  * @memberOf Monster.Logging
  */
-class Handler extends Base {
+ class Handler extends Base {
     constructor() {
         super();
 
@@ -178,7 +165,3 @@ class Handler extends Base {
 
 
 }
-
-
-assignToNamespace('Monster.Logging', Handler);
-export {Monster, Handler};

package/source/logging/logentry.mjs

@@ -0,0 +1,51 @@
+/**
+ * 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 {Base} from '../types/base.mjs';
+import {validateInteger} from '../types/validate.mjs';
+
+export {LogEntry}
+
+/**
+ * A log entry for the logger
+ *
+ * @license AGPLv3
+ * @since 1.5.0
+ * @copyright schukai GmbH
+ * @memberOf Monster.Logging
+ */
+ class LogEntry extends Base {
+    /**
+     *
+     * @param {Integer} loglevel
+     * @param {...*} args
+     */
+    constructor(loglevel, ...args) {
+        super();
+        validateInteger(loglevel);
+
+        this.loglevel = loglevel
+        this.arguments = args
+    }
+
+    /**
+     *
+     * @returns {integerr}
+     */
+    getLogLevel() {
+        return this.loglevel
+    }
+
+    /**
+     *
+     * @returns {array}
+     */
+    getArguments() {
+        return this.arguments
+    }
+
+}

package/source/logging/{logger.js → logger.mjs}

@@ -1,15 +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 {Handler} from '../logging/handler.js';
-import {LogEntry} from '../logging/logentry.js';
-import {assignToNamespace, Monster} from '../namespace.js';
-import {Base} from '../types/base.js';
-import {validateInteger, validateObject, validateString} from '../types/validate.js';
+import {Handler} from '../logging/handler.mjs';
+import {LogEntry} from '../logging/logentry.mjs';
+
+import {Base} from '../types/base.mjs';
+import {validateInteger, validateObject, validateString} from '../types/validate.mjs';
 
+export {Logger, ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF};
 
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
@@ -61,24 +63,9 @@ const FATAL = 2;
 const OFF = 0;
 
 /**
- * You can create an object of the class simply by using the namespace `new Monster.Logging.Logger()`.
- *
- * ```
- * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/monster.js';
- * new Monster.Logging.Logger()
- * </script>
- * ```
- *
- * Alternatively, you can also integrate this class individually.
- *
- * ```
- * <script type="module">
- * import {ID} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.31.0/dist/modules/logging/logger.js';
- * new Logger()
- * </script>
- * ```
+ * The logger is a class that takes care of logging.
  *
+ * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
  * @memberOf Monster.Logging
@@ -256,9 +243,6 @@ class Logger extends Base {
 
 }
 
-assignToNamespace('Monster.Logging', Logger);
-export {Monster, Logger, ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF};
-
 
 /**
  * Log triggern

package/source/logging/{namespace.js → namespace.mjs}

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

package/source/math/{namespace.js → namespace.mjs}

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