@schukai/monster 3.26.0 → 3.28.0

package/example/i18n/providers/embed.mjs

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

package/package.json

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

package/source/dom/customelement.mjs

@@ -295,25 +295,45 @@ class CustomElement extends HTMLElement {
      * Before you can use this method, you must have loaded the translations.
      *
      * @returns {Monster.DOM.CustomElement}
+     * @throws {Error}  Cannot find element with translations. Add a translations object to the document.
      */
     updateI18n() {
-
         const translations = getDocumentTranslations();
         if (!translations) {
             return this;
         }
 
-        const labels = this.getOption("labels");
-        if (!isIterable(labels)) {
+        let labels = this.getOption("labels");
+        if (!(isObject(labels) || isIterable(labels))) {
             return this;
         }
 
         for (const key in labels) {
-            const text = translations.getText(key, labels[key]);
-            if (text !== labels[key]) {
-                this.setOption("labels." + key, text);
+            const def = labels[key];
+
+            if (isString(def)) {
+                const text = translations.getText(key, def);
+                if (text !== def) {
+                    this.setOption("labels." + key, text);
+                }
+                continue;
+            } else if (isObject(def)) {
+                for (const k in def) {
+                    const d = def[k];
+                    
+                    const text = translations.getPluralRuleText(key, k, d);
+                    if (!isString(text)) {
+                        throw new Error("Invalid labels definition");
+                    }
+                    if (text !== d) {
+                        this.setOption("labels." + key + "." + k, text);
+                    }
+                }
+                continue;
             }
 
+            throw new Error("Invalid labels definition");
+
         }
         return this;
     }
@@ -973,10 +993,10 @@ function registerCustomElement(element) {
     if (customElements === undefined) {
         throw new Error("customElements is not supported.");
     }
-    
+
     if (customElements.get(element.getTag()) !== undefined) {
         return;
     }
-    
+
     customElements.define(element.getTag(), element);
 }

package/source/i18n/formatter.mjs

@@ -5,14 +5,14 @@
  * 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 {instanceSymbol, 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
@@ -41,6 +41,15 @@ class Formatter extends TextFormatter {
         this[internalTranslationSymbol] = validateInstance(translation, Translations);
     }
 
+    /**
+     * This method is called by the `instanceof` operator.
+     * @returns {symbol}
+     * @since 3.27.0
+     */
+    static get [instanceSymbol]() {
+        return Symbol.for("@schukai/monster/i18n/formatter@@instance");
+    }
+
     /**
      * @property {object} marker
      * @property {array} marker.open=["i18n{","${"]

package/source/i18n/locale.mjs

@@ -5,6 +5,7 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
+import {instanceSymbol} from "../constants.mjs";
 import { Base } from "../types/base.mjs";
 import { validateString } from "../types/validate.mjs";
 import { clone } from "../util/clone.mjs";
@@ -100,6 +101,15 @@ class Locale extends Base {
         this[localeStringSymbol] = s.join("-");
     }
 
+    /**
+     * This method is called by the `instanceof` operator.
+     * @returns {symbol}
+     * @since 3.27.0
+     */
+    static get [instanceSymbol]() {
+        return Symbol.for("@schukai/monster/i18n/locale@@instance");
+    }
+
     /**
      * @return {string}
      */

package/source/i18n/provider.mjs

@@ -5,6 +5,7 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
+import {instanceSymbol} from "../constants.mjs";
 import {hasObjectLink, getLinkedObjects,addToObjectLink} from "../dom/attributes.mjs";
 import {getLocaleOfDocument} from "../dom/locale.mjs";
 import {BaseWithOptions} from "../types/basewithoptions.mjs";
@@ -32,6 +33,16 @@ const translationsLinkSymbol = Symbol.for("@schukai/monster/i18n/translations@@l
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
  */
 class Provider extends BaseWithOptions {
+
+    /**
+     * This method is called by the `instanceof` operator.
+     * @returns {symbol}
+     * @since 3.27.0
+     */
+    static get [instanceSymbol]() {
+        return Symbol.for("@schukai/monster/i18n/provider@@instance");
+    }    
+    
     /**
      * @param {Locale|string} locale
      * @return {Promise}

package/source/i18n/translations.mjs

@@ -5,7 +5,8 @@
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
 
-import { getLinkedObjects,hasObjectLink} from "../dom/attributes.mjs";
+import {instanceSymbol} from "../constants.mjs";
+import {getLinkedObjects, hasObjectLink} from "../dom/attributes.mjs";
 import {ATTRIBUTE_OBJECTLINK} from "../dom/constants.mjs";
 import {getDocument} from "../dom/util.mjs";
 import {Base} from "../types/base.mjs";
@@ -44,6 +45,15 @@ class Translations extends Base {
         this.storage = new Map();
     }
 
+    /**
+     * This method is called by the `instanceof` operator.
+     * @returns {symbol}
+     * @since 3.27.0
+     */
+    static get [instanceSymbol]() {
+        return Symbol.for("@schukai/monster/i18n/translations@@instance");
+    }
+
     /**
      * Fetches a text using the specified key.
      * If no suitable key is found, `defaultText` is taken.
@@ -94,7 +104,7 @@ class Translations extends Base {
         } else {
             count = validateInteger(count);
             if (count === 0) {
-                // special handlig for zero count
+                // special handling for zero count
                 if (r.hasOwnProperty("zero")) {
                     return validateString(r["zero"]);
                 }
@@ -107,9 +117,11 @@ class Translations extends Base {
             return validateString(r[keyword]);
         }
 
-        if (r.hasOwnProperty(DEFAULT_KEY)) {
-            return validateString(r[DEFAULT_KEY]);
-        }
+        // @deprecated since 2023-03-14
+        // DEFAULT_KEY is undefined
+        // if (r.hasOwnProperty(DEFAULT_KEY)) {
+        //     return validateString(r[DEFAULT_KEY]);
+        // }
 
         return validateString(defaultText);
     }
@@ -171,7 +183,7 @@ class Translations extends Base {
      */
     assignTranslations(translations) {
         validateObject(translations);
-        
+
         if (translations instanceof Translations) {
             translations.storage.forEach((v, k) => {
                 this.setText(k, v);
@@ -202,7 +214,7 @@ function getDocumentTranslations(element) {
     const d = getDocument()
 
     if (!(element instanceof HTMLElement)) {
-        element = d.querySelector('['+ATTRIBUTE_OBJECTLINK+'~="' + translationsLinkSymbol.toString() + '"]');
+        element = d.querySelector('[' + ATTRIBUTE_OBJECTLINK + '~="' + translationsLinkSymbol.toString() + '"]');
         if (element === null) {
             throw new Error("Cannot find element with translations. Add a translations object to the document.");
         }
@@ -215,9 +227,9 @@ function getDocumentTranslations(element) {
     if (!hasObjectLink(element, translationsLinkSymbol)) {
         throw new Error("This element has no translations.");
     }
-    
+
     let obj = getLinkedObjects(element, translationsLinkSymbol);
-    
+
     for (const t of obj) {
         if (t instanceof Translations) {
             return t;

package/source/types/version.mjs

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

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.26.0")
+        monsterVersion = new Version("3.28.0")
 
         let m = getMonsterVersion();