@schukai/monster 3.4.2 → 3.5.0

package/example/i18n/providers/embed.mjs

@@ -0,0 +1,5 @@
+import {Embed} from '@schukai/monster/source/i18n/providers/embed.mjs';
+
+// read from scritp tag with id i18n
+const translation = new Embed('i18n');
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schukai/monster",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "Monster is a simple library for creating fast, robust and lightweight websites.",
   "keywords": [
     "framework",

package/source/data/datasource/server.mjs

@@ -81,7 +81,7 @@ class Server extends Datasource {
 
 
 /**
- *
+ * @private
  * @param self
  * @param obj
  * @returns {*}

package/source/dom/locale.mjs

@@ -6,8 +6,8 @@
  */
 
 import {parseLocale} from "../i18n/locale.mjs";
-
 import {getDocument} from "./util.mjs";
+import {getGlobalObject} from "../types/global.mjs";
 
 export {getLocaleOfDocument}
 
@@ -46,6 +46,40 @@ function getLocaleOfDocument() {
             return new parseLocale(locale)
         }
     }
+    
+    let navigatorLanguage = getNavigatorLanguage();
+    if (navigatorLanguage) {
+        return parseLocale(navigatorLanguage);
+    }
 
     return parseLocale(DEFAULT_LANGUAGE);
 }
+
+/**
+ * @private
+ * @returns {string|undefined|*}
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/languages
+ */
+const getNavigatorLanguage = () => {
+    const navigator = getGlobalObject('navigator');
+    if (navigator === undefined) {
+        return undefined;
+    }
+
+    if (navigator.hasOwnProperty('language')) {
+        const language = navigator.language;
+        if (typeof language === 'string' && language.length > 0) {
+            return language;
+        }
+        
+    }
+
+    const languages = navigator?.languages;
+    if (Array.isArray(languages) && languages.length>0) {
+        return languages[0];
+    }
+    
+    return undefined;
+
+}

package/source/i18n/providers/embed.mjs

@@ -0,0 +1,125 @@
+/**
+ * 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);
+
+        });
+
+    }
+
+
+}
+

package/source/i18n/providers/fetch.mjs

@@ -84,16 +84,17 @@ export {Fetch}
      */
     get defaults() {
 
-        return {
-            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
-            }
-        }
+        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);
 
     }
 

package/source/i18n/translations.mjs

@@ -142,13 +142,16 @@ class Translations extends Base {
     }
 
     /**
-     * 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".
-     *
+     * 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.
+     * 
+     * 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({

package/source/types/version.mjs

@@ -149,7 +149,7 @@ function getMonsterVersion() {
     }
 
     /** don't touch, replaced by make with package.json version */
-    monsterVersion = new Version('3.4.2')
+    monsterVersion = new Version('3.5.0')
 
     return monsterVersion;
 

package/test/cases/dom/locale.mjs

@@ -2,6 +2,7 @@
 
 import {expect} from "chai"
 
+import {Locale} from "../../../../application/source/i18n/locale.mjs";
 import {getLocaleOfDocument} from "../../../../application/source/dom/locale.mjs";
 import {initJSDOM} from "../../util/jsdom.mjs";
 
@@ -32,10 +33,24 @@ describe('Attributes', function () {
                 node.setAttribute('lang', a);
                 expect(getLocaleOfDocument().toString()).to.be.equal(a);
             })
+            
+            
 
         });
 
 
     });
+    
+    
+    it('return language en', function () {
+        let html = document.getElementsByTagName('html');
+        let node = html.item(0);
+
+        node.removeAttribute('lang');
+        const locale = getLocaleOfDocument();
+        expect(locale).to.be.instanceOf(Locale);
+        expect(locale.localeString).to.be.equal('en-US');
+    })
+    
 
 })

package/test/cases/i18n/providers/embed.mjs

@@ -0,0 +1,72 @@
+import {expect} from "chai"
+
+
+import {Embed} from "../../../../../application/source/i18n/providers/embed.mjs";
+import {Translations} from "../../../../../application/source/i18n/translations.mjs";
+import {getGlobal} from "../../../../../application/source/types/global.mjs";
+import {initJSDOM} from "../../../util/jsdom.mjs";
+
+
+const global = getGlobal();
+
+const html1 = `
+<script id="templocale" type="application/json">
+{
+        "key": "translation"
+}
+</script>
+`;
+
+describe('Translation Provider Embed', function () {
+
+    before(function (done) {
+        initJSDOM().then(() => {
+            done()
+        });
+    });
+
+
+    afterEach(() => {
+        let mocks = document.getElementById('mocks');
+        mocks.innerHTML = "";
+    });
+
+    beforeEach(() => {
+        let mocks = document.getElementById('mocks');
+        mocks.innerHTML = html1;
+
+    })
+
+    describe('get mock data and create translation', function () {
+
+        it('embed', function (done) {
+
+            const e = new Embed('templocale');
+            let p = e.getTranslations('en');
+            expect(p).is.instanceof(Promise);
+
+            p.then(r => {
+
+                try {
+                    expect(r).is.instanceof(Translations);
+ 
+                    let t = r.getText('key')
+                    expect(t).is.equal('translation');
+
+
+                    done();
+                } catch (e) {
+                    done(e);
+                }
+
+
+            }).catch(e => {
+                done(e);
+            })
+
+        });
+
+    });
+
+
+});

package/test/cases/monster.mjs

@@ -7,7 +7,7 @@ describe('Monster', function () {
         let monsterVersion
 
         /** don´t touch, replaced by make with package.json version */
-        monsterVersion = new Version('3.4.2')
+        monsterVersion = new Version('3.5.0')
 
         let m = getMonsterVersion();