@schukai/monster 3.5.0 → 3.8.0

package/source/i18n/providers/fetch.mjs

@@ -5,21 +5,21 @@
  * 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} 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}
+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.
- * 
+ *
  * @externalExample ../../../example/i18n/providers/fetch.mjs
  * @license AGPLv3
  * @since 1.13.0
@@ -28,17 +28,16 @@ export {Fetch}
  * @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.
-     * 
+     *
      * The url may contain placeholders (language, script, region, variants, extlang, privateUse), so you can specify one url for all translations.
-     * 
+     *
      * ```
      * new Fetch('https://www.example.com/assets/${language}.json')
      * ```
-     * 
+     *
      * @param {string|URL} url
      * @param {Object} options see {@link Monster.I18n.Providers.Fetch#defaults}
      * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/fetch}
@@ -66,7 +65,6 @@ export {Fetch}
          * @property {Object} options
          */
         this[internalSymbol] = extend({}, super.defaults, this.defaults, validateObject(options));
-
     }
 
     /**
@@ -83,19 +81,19 @@ export {Fetch}
      * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API}
      */
     get defaults() {
-
         return extend(
             {
                 fetch: {
-                    method: 'GET', // *GET, POST, PUT, DELETE, etc.
-                    mode: 'cors', // no-cors, *cors, same-origin
-                    cache: 'no-cache', // *default, no-cache, reload, force-cache, only-if-cached
-                    credentials: 'omit', // include, *same-origin, omit
-                    redirect: 'follow', // manual, *follow, error
-                    referrerPolicy: 'no-referrer', // no-referrer, *no-referrer-when-downgrade, origin, origin-when-cross-origin, same-origin, strict-origin, strict-origin-when-cross-origin, unsafe-url
-                }
-            }, super.defaults);
-
+                    method: "GET", // *GET, POST, PUT, DELETE, etc.
+                    mode: "cors", // no-cors, *cors, same-origin
+                    cache: "no-cache", // *default, no-cache, reload, force-cache, only-if-cached
+                    credentials: "omit", // include, *same-origin, omit
+                    redirect: "follow", // manual, *follow, error
+                    referrerPolicy: "no-referrer", // no-referrer, *no-referrer-when-downgrade, origin, origin-when-cross-origin, same-origin, strict-origin, strict-origin-when-cross-origin, unsafe-url
+                },
+            },
+            super.defaults,
+        );
     }
 
     /**
@@ -104,20 +102,16 @@ export {Fetch}
      * @return {Promise}
      */
     getTranslations(locale) {
-
         if (isString(locale)) {
             locale = parseLocale(locale);
         }
 
-        let formatter = new Formatter(locale.getMap())
+        let formatter = new Formatter(locale.getMap());
 
-        return getGlobalFunction('fetch')(formatter.format(this.url), this.getOption('fetch', {}))
-            .then((response) => response.json()).then(data => {
+        return getGlobalFunction("fetch")(formatter.format(this.url), this.getOption("fetch", {}))
+            .then((response) => response.json())
+            .then((data) => {
                 return new Translations(locale).assignTranslations(data);
             });
-
     }
-
-
 }
-

package/source/i18n/translations.mjs

@@ -5,12 +5,12 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-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";
+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}
+export { Translations };
 
 /**
  * With this class you can manage translations and access the keys.
@@ -23,7 +23,6 @@ export {Translations}
  * @see https://datatracker.ietf.org/doc/html/rfc3066
  */
 class Translations extends Base {
-
     /**
      *
      * @param {Locale} locale
@@ -37,10 +36,8 @@ class Translations extends Base {
 
         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.
@@ -53,7 +50,7 @@ class Translations extends Base {
     getText(key, defaultText) {
         if (!this.storage.has(key)) {
             if (defaultText === undefined) {
-                throw new Error('key ' + key + ' not found');
+                throw new Error(`key ${key} not found`);
             }
 
             return validateString(defaultText);
@@ -61,7 +58,7 @@ class Translations extends Base {
 
         let r = this.storage.get(key);
         if (isObject(r)) {
-            return this.getPluralRuleText(key, 'other', defaultText);
+            return this.getPluralRuleText(key, "other", defaultText);
         }
 
         return this.storage.get(key);
@@ -92,8 +89,8 @@ class Translations extends Base {
             count = validateInteger(count);
             if (count === 0) {
                 // special handlig for zero count
-                if (r.hasOwnProperty('zero')) {
-                    return validateString(r['zero']);
+                if (r.hasOwnProperty("zero")) {
+                    return validateString(r["zero"]);
                 }
             }
 
@@ -115,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."
@@ -131,26 +128,24 @@ class Translations extends Base {
      * @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');
-
+        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 
+     * 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, 
+     *
+     * 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.
      *
      * ```
@@ -176,7 +171,5 @@ class Translations extends Base {
         }
 
         return this;
-
     }
-
 }

package/source/logging/handler/console.mjs

@@ -5,12 +5,12 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {getGlobalObject} from "../../types/global.mjs";
-import {Handler} from '../handler.mjs';
-import {LogEntry} from "../logentry.mjs";
-import {TRACE, WARN, DEBUG, ERROR, FATAL, INFO} from "../logger.mjs";
+import { getGlobalObject } from "../../types/global.mjs";
+import { Handler } from "../handler.mjs";
+import { LogEntry } from "../logentry.mjs";
+import { TRACE, WARN, DEBUG, ERROR, FATAL, INFO } from "../logger.mjs";
 
-export {ConsoleHandler}
+export { ConsoleHandler };
 
 /**
  * You can create an object of the class simply by using the namespace `new Monster.Logging.Handler.ConsoleHandler()`.
@@ -36,7 +36,7 @@ class ConsoleHandler extends Handler {
      */
     log(entry) {
         if (super.log(entry)) {
-            let console = getGlobalObject('console');
+            let console = getGlobalObject("console");
             if (!console) return false;
 
             if (!console.error) console.error = console.log;
@@ -58,7 +58,6 @@ class ConsoleHandler extends Handler {
                 default:
                     console.log(entry.toString());
                     break;
-
             }
 
             return true;
@@ -66,7 +65,4 @@ class ConsoleHandler extends Handler {
 
         return false;
     }
-
 }
-
-

package/source/logging/handler.mjs

@@ -5,12 +5,12 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-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";
+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}
+export { Handler };
 
 /**
  * The log handler is the interface between the log entries and the log listeners.
@@ -20,7 +20,7 @@ export {Handler}
  * @copyright schukai GmbH
  * @memberOf Monster.Logging
  */
- class Handler extends Base {
+class Handler extends Base {
     constructor() {
         super();
 
@@ -59,7 +59,7 @@ export {Handler}
      * @since 1.5.0
      */
     setLogLevel(loglevel) {
-        validateInteger(loglevel)
+        validateInteger(loglevel);
         this.loglevel = loglevel;
         return this;
     }
@@ -83,7 +83,7 @@ export {Handler}
     setAll() {
         this.setLogLevel(ALL);
         return this;
-    };
+    }
 
     /**
      * Set log level to Trace
@@ -94,7 +94,7 @@ export {Handler}
     setTrace() {
         this.setLogLevel(TRACE);
         return this;
-    };
+    }
 
     /**
      * Set log level to Debug
@@ -105,7 +105,7 @@ export {Handler}
     setDebug() {
         this.setLogLevel(DEBUG);
         return this;
-    };
+    }
 
     /**
      * Set log level to Info
@@ -116,7 +116,7 @@ export {Handler}
     setInfo() {
         this.setLogLevel(INFO);
         return this;
-    };
+    }
 
     /**
      * Set log level to Warn
@@ -127,7 +127,7 @@ export {Handler}
     setWarn() {
         this.setLogLevel(WARN);
         return this;
-    };
+    }
 
     /**
      * Set log level to Error
@@ -138,7 +138,7 @@ export {Handler}
     setError() {
         this.setLogLevel(ERROR);
         return this;
-    };
+    }
 
     /**
      * Set log level to Fatal
@@ -149,8 +149,7 @@ export {Handler}
     setFatal() {
         this.setLogLevel(FATAL);
         return this;
-    };
-
+    }
 
     /**
      * Set log level to Off
@@ -161,7 +160,5 @@ export {Handler}
     setOff() {
         this.setLogLevel(OFF);
         return this;
-    };
-
-
+    }
 }

package/source/logging/logentry.mjs

@@ -5,10 +5,10 @@
  * 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';
+import { Base } from "../types/base.mjs";
+import { validateInteger } from "../types/validate.mjs";
 
-export {LogEntry}
+export { LogEntry };
 
 /**
  * A log entry for the logger
@@ -18,7 +18,7 @@ export {LogEntry}
  * @copyright schukai GmbH
  * @memberOf Monster.Logging
  */
- class LogEntry extends Base {
+class LogEntry extends Base {
     /**
      *
      * @param {Integer} loglevel
@@ -28,8 +28,8 @@ export {LogEntry}
         super();
         validateInteger(loglevel);
 
-        this.loglevel = loglevel
-        this.arguments = args
+        this.loglevel = loglevel;
+        this.arguments = args;
     }
 
     /**
@@ -37,7 +37,7 @@ export {LogEntry}
      * @returns {integerr}
      */
     getLogLevel() {
-        return this.loglevel
+        return this.loglevel;
     }
 
     /**
@@ -45,7 +45,6 @@ export {LogEntry}
      * @returns {array}
      */
     getArguments() {
-        return this.arguments
+        return this.arguments;
     }
-
 }

package/source/logging/logger.mjs

@@ -5,13 +5,13 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {Handler} from '../logging/handler.mjs';
-import {LogEntry} from '../logging/logentry.mjs';
+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';
+import { Base } from "../types/base.mjs";
+import { validateInteger, validateObject, validateString } from "../types/validate.mjs";
 
-export {Logger, ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF};
+export { Logger, ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF };
 
 /**
  * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF
@@ -71,13 +71,12 @@ const OFF = 0;
  * @memberOf Monster.Logging
  */
 class Logger extends Base {
-
     /**
      *
      */
     constructor() {
         super();
-        this.handler = new Set;
+        this.handler = new Set();
     }
 
     /**
@@ -87,12 +86,12 @@ class Logger extends Base {
      * @throws {Error} the handler must be an instance of Handler
      */
     addHandler(handler) {
-        validateObject(handler)
+        validateObject(handler);
         if (!(handler instanceof Handler)) {
-            throw new Error("the handler must be an instance of Handler")
+            throw new Error("the handler must be an instance of Handler");
         }
 
-        this.handler.add(handler)
+        this.handler.add(handler);
         return this;
     }
 
@@ -103,9 +102,9 @@ class Logger extends Base {
      * @throws {Error} the handler must be an instance of Handler
      */
     removeHandler(handler) {
-        validateObject(handler)
+        validateObject(handler);
         if (!(handler instanceof Handler)) {
-            throw new Error("the handler must be an instance of Handler")
+            throw new Error("the handler must be an instance of Handler");
         }
 
         this.handler.delete(handler);
@@ -121,10 +120,14 @@ class Logger extends Base {
      * @returns {Logger}
      * @since 1.5.0
      */
-    logTrace() {
-        triggerLog.apply(this, [TRACE, ...arguments]);
+    logTrace(...args) {
+        if (typeof args !== "object" || args[0] === null) {
+            throw new Error("the first argument must be an object");
+        }
+
+        triggerLog.apply(this, [TRACE, ...args]);
         return this;
-    };
+    }
 
     /**
      * log Debug message
@@ -135,10 +138,14 @@ class Logger extends Base {
      * @returns {Logger}
      * @since 1.5.0
      */
-    logDebug() {
-        triggerLog.apply(this, [DEBUG, ...arguments]);
+    logDebug(...args) {
+        if (typeof args !== "object" || args[0] === null) {
+            throw new Error("the first argument must be an object");
+        }
+
+        triggerLog.apply(this, [DEBUG, ...args]);
         return this;
-    };
+    }
 
     /**
      * log Info message
@@ -150,10 +157,14 @@ class Logger extends Base {
      * @returns {Logger}
      * @since 1.5.0
      */
-    logInfo() {
-        triggerLog.apply(this, [INFO, ...arguments]);
+    logInfo(...args) {
+        if (typeof args !== "object" || args[0] === null) {
+            throw new Error("the first argument must be an object");
+        }
+
+        triggerLog.apply(this, [INFO, ...args]);
         return this;
-    };
+    }
 
     /**
      * log Warn message
@@ -164,10 +175,14 @@ class Logger extends Base {
      * @returns {Logger}
      * @since 1.5.0
      */
-    logWarn() {
-        triggerLog.apply(this, [WARN, ...arguments]);
+    logWarn(...args) {
+        if (typeof args !== "object" || args[0] === null) {
+            throw new Error("the first argument must be an object");
+        }
+
+        triggerLog.apply(this, [WARN, ...args]);
         return this;
-    };
+    }
 
     /**
      * log Error message
@@ -178,10 +193,14 @@ class Logger extends Base {
      * @returns {Logger}
      * @since 1.5.0
      */
-    logError() {
-        triggerLog.apply(this, [ERROR, ...arguments]);
+    logError(...args) {
+        if (typeof args !== "object" || args[0] === null) {
+            throw new Error("the first argument must be an object");
+        }
+
+        triggerLog.apply(this, [ERROR, ...args]);
         return this;
-    };
+    }
 
     /**
      * log Fatal message
@@ -192,11 +211,14 @@ class Logger extends Base {
      * @returns {Logger}
      * @since 1.5.0
      */
-    logFatal() {
-        triggerLog.apply(this, [FATAL, ...arguments]);
-        return this;
-    };
+    logFatal(...args) {
+        if (typeof args !== "object" || args[0] === null) {
+            throw new Error("the first argument must be an object");
+        }
 
+        triggerLog.apply(this, [FATAL, ...args]);
+        return this;
+    }
 
     /**
      * Labels
@@ -207,17 +229,17 @@ class Logger extends Base {
     getLabel(level) {
         validateInteger(level);
 
-        if (level === ALL) return 'ALL';
-        if (level === TRACE) return 'TRACE';
-        if (level === DEBUG) return 'DEBUG';
-        if (level === INFO) return 'INFO';
-        if (level === WARN) return 'WARN';
-        if (level === ERROR) return 'ERROR';
-        if (level === FATAL) return 'FATAL';
-        if (level === OFF) return 'OFF';
+        if (level === ALL) return "ALL";
+        if (level === TRACE) return "TRACE";
+        if (level === DEBUG) return "DEBUG";
+        if (level === INFO) return "INFO";
+        if (level === WARN) return "WARN";
+        if (level === ERROR) return "ERROR";
+        if (level === FATAL) return "FATAL";
+        if (level === OFF) return "OFF";
 
-        return 'unknown';
-    };
+        return "unknown";
+    }
 
     /**
      * Level
@@ -228,22 +250,19 @@ class Logger extends Base {
     getLevel(label) {
         validateString(label);
 
-        if (label === 'ALL') return ALL;
-        if (label === 'TRACE') return TRACE;
-        if (label === 'DEBUG') return DEBUG;
-        if (label === 'INFO') return INFO;
-        if (label === 'WARN') return WARN;
-        if (label === 'ERROR') return ERROR;
-        if (label === 'FATAL') return FATAL;
-        if (label === 'OFF') return OFF;
+        if (label === "ALL") return ALL;
+        if (label === "TRACE") return TRACE;
+        if (label === "DEBUG") return DEBUG;
+        if (label === "INFO") return INFO;
+        if (label === "WARN") return WARN;
+        if (label === "ERROR") return ERROR;
+        if (label === "FATAL") return FATAL;
+        if (label === "OFF") return OFF;
 
         return 0;
-    };
-
-
+    }
 }
 
-
 /**
  * Log triggern
  *
@@ -256,9 +275,8 @@ function triggerLog(loglevel, ...args) {
     var logger = this;
 
     for (let handler of logger.handler) {
-        handler.log(new LogEntry(loglevel, args))
+        handler.log(new LogEntry(loglevel, args));
     }
 
     return logger;
-
 }

package/source/logging/namespace.mjs

@@ -10,4 +10,4 @@
  * @memberOf Monster
  * @author schukai GmbH
  */
-const ns = {};
+const ns = {};