@schukai/monster 3.4.2 → 3.7.0

package/source/dom/util.mjs

@@ -5,10 +5,10 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {getGlobal} from "../types/global.mjs";
-import {validateString} from "../types/validate.mjs";
+import { getGlobal } from "../types/global.mjs";
+import { validateString } from "../types/validate.mjs";
 
-export {getDocument, getWindow, getDocumentFragmentFromString}
+export { getDocument, getWindow, getDocumentFragmentFromString };
 
 /**
  * This method fetches the document object
@@ -48,9 +48,9 @@ export {getDocument, getWindow, getDocumentFragmentFromString}
  * @throws {Error} not supported environment
  */
 function getDocument() {
-    let document = getGlobal()?.['document'];
-    if (typeof document !== 'object') {
-        throw new Error("not supported environment")
+    let document = getGlobal()?.["document"];
+    if (typeof document !== "object") {
+        throw new Error("not supported environment");
     }
 
     return document;
@@ -70,7 +70,7 @@ function getDocument() {
  *    });
  *
  *    getGlobal()['window']=window;
- * 
+ *
  *    [
  *        'self',
  *        'document',
@@ -96,15 +96,14 @@ function getDocument() {
  * @throws {Error} not supported environment
  */
 function getWindow() {
-    let window = getGlobal()?.['window'];
-    if (typeof window !== 'object') {
-        throw new Error("not supported environment")
+    let window = getGlobal()?.["window"];
+    if (typeof window !== "object") {
+        throw new Error("not supported environment");
     }
 
     return window;
 }
 
-
 /**
  * This method fetches the document object
  *
@@ -147,7 +146,7 @@ function getDocumentFragmentFromString(html) {
     validateString(html);
 
     const document = getDocument();
-    const template = document.createElement('template');
+    const template = document.createElement("template");
     template.innerHTML = html;
 
     return template.content;

package/source/dom/worker/factory.mjs

@@ -5,17 +5,17 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {internalSymbol} from "../../constants.mjs";
-import {Base} from "../../types/base.mjs";
-import {getGlobal, getGlobalFunction} from "../../types/global.mjs";
-import {isFunction} from "../../types/is.mjs";
-import {validateInstance, validateString} from "../../types/validate.mjs";
+import { internalSymbol } from "../../constants.mjs";
+import { Base } from "../../types/base.mjs";
+import { getGlobal, getGlobalFunction } from "../../types/global.mjs";
+import { isFunction } from "../../types/is.mjs";
+import { validateInstance, validateString } from "../../types/validate.mjs";
 
-export {Factory}
+export { Factory };
 
 /**
  * A factory for creating worker instances.
- * 
+ *
  * @license AGPLv3
  * @since 1.25.0
  * @copyright schukai GmbH
@@ -23,15 +23,14 @@ export {Factory}
  * @summary A small factory to create worker
  */
 class Factory extends Base {
-
     /**
      *
      */
     constructor() {
         super();
         this[internalSymbol] = {
-            worker: new WeakMap
-        }
+            worker: new WeakMap(),
+        };
     }
 
     /**
@@ -43,24 +42,23 @@ class Factory extends Base {
      * @return {Worker}
      */
     createFromURL = function (url, messageHandler, errorHandler) {
-
         if (url instanceof URL) {
             url = url.toString();
         }
 
-        const workerClass = getGlobalFunction('Worker');
+        const workerClass = getGlobalFunction("Worker");
         var worker = new workerClass(validateString(url));
 
         if (isFunction(messageHandler)) {
             worker.onmessage = (event) => {
                 messageHandler.call(worker, event);
-            }
+            };
         }
 
         if (isFunction(errorHandler)) {
             worker.onerror = (event) => {
                 errorHandler.call(worker, event);
-            }
+            };
         }
 
         return worker;
@@ -76,16 +74,17 @@ class Factory extends Base {
      * @see https://developer.mozilla.org/de/docs/Web/API/URL/createObjectURL
      */
     createFromScript = function (content, messageHandler, errorHandler) {
-        const blobFunction = new getGlobalFunction('Blob')
-        const blob = new blobFunction([validateString(content)], {type: 'script/javascript'});
+        const blobFunction = new getGlobalFunction("Blob");
+        const blob = new blobFunction([validateString(content)], {
+            type: "script/javascript",
+        });
 
-        const url = getGlobalFunction('URL').createObjectURL(blob);
+        const url = getGlobalFunction("URL").createObjectURL(blob);
         const worker = this.createFromURL(url, messageHandler, errorHandler);
 
-        this[internalSymbol]['worker'].set(worker, url);
+        this[internalSymbol]["worker"].set(worker, url);
 
         return worker;
-
     };
 
     /**
@@ -95,19 +94,16 @@ class Factory extends Base {
      * @return {Monster.DOM.Worker.Factory}
      */
     terminate(worker) {
-
-        const workerClass = getGlobalFunction('Worker');
+        const workerClass = getGlobalFunction("Worker");
         validateInstance(worker, workerClass);
 
         worker.terminate();
 
-        if (this[internalSymbol]['worker'].has(worker)) {
-            const url = this[internalSymbol]['worker'].get(worker);
+        if (this[internalSymbol]["worker"].has(worker)) {
+            const url = this[internalSymbol]["worker"].get(worker);
             URL.revokeObjectURL(url);
         }
 
         return this;
     }
-
-
 }

package/source/dom/worker/namespace.mjs

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

package/source/i18n/formatter.mjs

@@ -5,20 +5,20 @@
  * 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 { 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 { Formatter as TextFormatter } from "../text/formatter.mjs";
+import { validateInstance, validateString } from "../types/validate.mjs";
+import { Translations } from "./translations.mjs";
 
-export {Formatter}
+export { Formatter };
 
 /**
  * @private
  * @type {symbol}
  */
-const internalTranslationSymbol = Symbol('internalTranslation')
+const internalTranslationSymbol = Symbol("internalTranslation");
 
 /**
  * The Formatter extends the Text.Formatter with the possibility to replace the key by a translation.
@@ -30,7 +30,6 @@ const internalTranslationSymbol = Symbol('internalTranslation')
  * @memberOf Monster.I18n
  */
 class Formatter extends TextFormatter {
-
     /**
      * Default values for the markers are `${` and `}`
      *
@@ -58,13 +57,13 @@ class Formatter extends TextFormatter {
             callbacks: {
                 i18n: (value) => {
                     return self[internalTranslationSymbol].getText(validateString(value));
-                }
+                },
             },
             marker: {
-                open: ['i18n{', '${'],
-                close: ['}'],
+                open: ["i18n{", "${"],
+                close: ["}"],
             },
-        })
+        });
     }
 
     /**
@@ -77,10 +76,10 @@ class Formatter extends TextFormatter {
      * @throws {Error} the closing marker is missing
      */
     format(text) {
-        validateString(text)
+        validateString(text);
 
-        const openMarker = this[internalSymbol]['marker']['open']?.[0];
-        const closeMarker = this[internalSymbol]['marker']['close']?.[0];
+        const openMarker = this[internalSymbol]["marker"]["open"]?.[0];
+        const closeMarker = this[internalSymbol]["marker"]["close"]?.[0];
 
         if (text.indexOf(openMarker) === 0) {
             text = text.substring(openMarker.length);
@@ -88,22 +87,19 @@ class Formatter extends TextFormatter {
             if (text.indexOf(closeMarker) === text.length - closeMarker.length) {
                 text = text.substring(0, text.length - closeMarker.length);
             } else {
-                throw new Error("the closing marker is missing")
+                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();
 
+        const parts = validateString(text).split("::");
+        const translationKey = parts.shift().trim(); // key value delimiter
+        const parameter = parts.join("::").trim();
 
-        let assembledText = openMarker + 'static:' + translationKey + ' | call:i18n';
+        let assembledText = `${openMarker}static:${translationKey} | call:i18n`;
         if (parameter.length > 0) {
-            assembledText += '::' + parameter;
+            assembledText += `::${parameter}`;
         }
         assembledText += closeMarker;
         return super.format(assembledText);
     }
-
-
 }

package/source/i18n/locale.mjs

@@ -5,23 +5,23 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import {Base} from "../types/base.mjs";
-import {validateString} from "../types/validate.mjs";
-import {clone} from "../util/clone.mjs";
+import { Base } from "../types/base.mjs";
+import { validateString } from "../types/validate.mjs";
+import { clone } from "../util/clone.mjs";
 
-export {Locale, parseLocale}
+export { Locale, parseLocale };
 
 /**
  * @memberOf Monster.I18n
  * @type {symbol}
  */
-const propertiesSymbol = Symbol('properties');
+const propertiesSymbol = Symbol("properties");
 
 /**
  * @type {symbol}
  * @memberOf Monster.I18n
  */
-const localeStringSymbol = Symbol('localeString');
+const localeStringSymbol = Symbol("localeString");
 
 /**
  * The Locale class is a base class for the language classes.
@@ -64,7 +64,6 @@ const localeStringSymbol = Symbol('localeString');
  * @see https://datatracker.ietf.org/doc/html/rfc3066
  */
 class Locale extends Base {
-
     /**
      * @param {string} language
      * @param {string} [region]
@@ -78,12 +77,12 @@ class Locale extends Base {
         super();
 
         this[propertiesSymbol] = {
-            language: (language === undefined) ? undefined : validateString(language),
-            script: (script === undefined) ? undefined : validateString(script),
-            region: (region === undefined) ? undefined : validateString(region),
-            variants: (variants === undefined) ? undefined : validateString(variants),
-            extlang: (extlang === undefined) ? undefined : validateString(extlang),
-            privateUse: (privateUse === undefined) ? undefined : validateString(privateUse),
+            language: language === undefined ? undefined : validateString(language),
+            script: script === undefined ? undefined : validateString(script),
+            region: region === undefined ? undefined : validateString(region),
+            variants: variants === undefined ? undefined : validateString(variants),
+            extlang: extlang === undefined ? undefined : validateString(extlang),
+            privateUse: privateUse === undefined ? undefined : validateString(privateUse),
         };
 
         let s = [];
@@ -95,11 +94,10 @@ class Locale extends Base {
         if (privateUse !== undefined) s.push(privateUse);
 
         if (s.length === 0) {
-            throw new Error('unsupported locale');
+            throw new Error("unsupported locale");
         }
 
-        this[localeStringSymbol] = s.join('-');
-
+        this[localeStringSymbol] = s.join("-");
     }
 
     /**
@@ -151,12 +149,11 @@ class Locale extends Base {
         return this[propertiesSymbol].privateValue;
     }
 
-
     /**
      * @return {string}
      */
     toString() {
-        return "" + this.localeString;
+        return `${this.localeString}`;
     }
 
     /**
@@ -165,10 +162,8 @@ class Locale extends Base {
      * @return {Monster.I18n.LocaleMap}
      */
     getMap() {
-        return clone(this[propertiesSymbol])
+        return clone(this[propertiesSymbol]);
     }
-
-
 }
 
 /**
@@ -263,25 +258,30 @@ class Locale extends Base {
  * @throws {Error} unsupported locale
  */
 function parseLocale(locale) {
-
     locale = validateString(locale).replace(/_/g, "-");
 
-    let language, region, variants, parts, script, extlang,
-        regexRegular = "(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)",
-        regexIrregular = "(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)",
-        regexGrandfathered = "(" + regexIrregular + "|" + regexRegular + ")",
-        regexPrivateUse = "(x(-[A-Za-z0-9]{1,8})+)",
-        regexSingleton = "[0-9A-WY-Za-wy-z]",
-        regexExtension = "(" + regexSingleton + "(-[A-Za-z0-9]{2,8})+)",
-        regexVariant = "([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3})",
-        regexRegion = "([A-Za-z]{2}|[0-9]{3})",
-        regexScript = "([A-Za-z]{4})",
-        regexExtlang = "([A-Za-z]{3}(-[A-Za-z]{3}){0,2})",
-        regexLanguage = "(([A-Za-z]{2,3}(-" + regexExtlang + ")?)|[A-Za-z]{4}|[A-Za-z]{5,8})",
-        regexLangtag = "(" + regexLanguage + "(-" + regexScript + ")?" + "(-" + regexRegion + ")?" + "(-" + regexVariant + ")*" + "(-" + regexExtension + ")*" + "(-" + regexPrivateUse + ")?" + ")",
-        regexLanguageTag = "^(" + regexGrandfathered + "|" + regexLangtag + "|" + regexPrivateUse + ")$",
-        regex = new RegExp(regexLanguageTag), match;
-
+    let language;
+    let region;
+    let variants;
+    let parts;
+    let script;
+    let extlang;
+    let regexRegular = "(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)";
+    let regexIrregular =
+        "(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)";
+    let regexGrandfathered = `(${regexIrregular}|${regexRegular})`;
+    let regexPrivateUse = "(x(-[A-Za-z0-9]{1,8})+)";
+    let regexSingleton = "[0-9A-WY-Za-wy-z]";
+    let regexExtension = `(${regexSingleton}(-[A-Za-z0-9]{2,8})+)`;
+    let regexVariant = "([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3})";
+    let regexRegion = "([A-Za-z]{2}|[0-9]{3})";
+    let regexScript = "([A-Za-z]{4})";
+    let regexExtlang = "([A-Za-z]{3}(-[A-Za-z]{3}){0,2})";
+    let regexLanguage = `(([A-Za-z]{2,3}(-${regexExtlang})?)|[A-Za-z]{4}|[A-Za-z]{5,8})`;
+    let regexLangtag = `(${regexLanguage}(-${regexScript})?(-${regexRegion})?(-${regexVariant})*(-${regexExtension})*(-${regexPrivateUse})?)`;
+    let regexLanguageTag = `^(${regexGrandfathered}|${regexLangtag}|${regexPrivateUse})$`;
+    let regex = new RegExp(regexLanguageTag);
+    let match;
 
     if ((match = regex.exec(locale)) !== null) {
         if (match.index === regex.lastIndex) {
@@ -290,18 +290,17 @@ function parseLocale(locale) {
     }
 
     if (match === undefined || match === null) {
-        throw new Error('unsupported locale');
+        throw new Error("unsupported locale");
     }
 
     if (match[6] !== undefined) {
         language = match[6];
 
-        parts = language.split('-');
+        parts = language.split("-");
         if (parts.length > 1) {
             language = parts[0];
             extlang = parts[1];
         }
-
     }
 
     if (match[14] !== undefined) {
@@ -317,5 +316,4 @@ function parseLocale(locale) {
     }
 
     return new Locale(language, region, script, variants, extlang);
-
 }

package/source/i18n/namespace.mjs

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

package/source/i18n/provider.mjs

@@ -5,11 +5,11 @@
  * 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"
+import { BaseWithOptions } from "../types/basewithoptions.mjs";
+import { Locale } from "./locale.mjs";
+import { Translations } from "./translations.mjs";
 
-export {Provider}
+export { Provider };
 
 /**
  * A provider makes a translation object available.
@@ -21,7 +21,6 @@ export {Provider}
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
  */
 class Provider extends BaseWithOptions {
-
     /**
      * @param {Locale|string} locale
      * @return {Promise}
@@ -33,8 +32,6 @@ class Provider extends BaseWithOptions {
             } catch (e) {
                 reject(e);
             }
-
         });
     }
-
 }

package/source/i18n/providers/embed.mjs

@@ -0,0 +1,115 @@
+/**
+ * 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 { getGlobalObject } from "../../types/global.mjs";
+import { 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 { Embed };
+
+/**
+ * The Embed provider retrieves a JSON file from the given Script Tag.
+ *
+ * @externalExample ../../../example/i18n/providers/embed.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 Embed extends Provider {
+    /**
+     * ```html
+     * <script id="translations" type="application/json">
+     * {
+     *     "hello": "Hallo"
+     * }
+     * </script>
+     * ```
+     *
+     *
+     * ```javascript
+     * new Embed('translations')
+     * ```
+     *
+     * @param {string} id
+     * @param {Object} options
+     */
+    constructor(id, options) {
+        super(options);
+
+        if (options === undefined) {
+            options = {};
+        }
+
+        validateString(id);
+
+        /**
+         * @property {string}
+         */
+        this.textId = id;
+
+        /**
+         * @private
+         * @property {Object} options
+         */
+        this[internalSymbol] = extend({}, super.defaults, this.defaults, validateObject(options));
+    }
+
+    /**
+     * Defaults
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API}
+     */
+    get defaults() {
+        return extend({}, super.defaults);
+    }
+
+    /**
+     *
+     * @param {Locale|string} locale
+     * @return {Promise}
+     */
+    getTranslations(locale) {
+        if (isString(locale)) {
+            locale = parseLocale(locale);
+        }
+
+        return new Promise((resolve, reject) => {
+            let text = getGlobalObject("document").getElementById(this.textId);
+
+            if (text === null) {
+                reject(new Error("Text not found"));
+                return;
+            }
+
+            let translations = null;
+            try {
+                translations = JSON.parse(text.innerHTML);
+            } catch (e) {
+                reject(e);
+                return;
+            }
+
+            if (translations === null) {
+                reject(new Error("Translations not found or invalid"));
+                return;
+            }
+
+            const t = new Translations(locale);
+            t.assignTranslations(translations);
+
+            resolve(t);
+        });
+    }
+}