@schukai/monster 4.29.1 → 4.30.1

package/source/i18n/translations.mjs

@@ -12,21 +12,21 @@
  * SPDX-License-Identifier: AGPL-3.0
  */
 
-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";
-import {isObject, isString} from "../types/is.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";
+import { isObject, isString } from "../types/is.mjs";
 import {
-    validateInteger,
-    validateObject,
-    validateString,
+	validateInteger,
+	validateObject,
+	validateString,
 } from "../types/validate.mjs";
-import {Locale, parseLocale} from "./locale.mjs";
-import {translationsLinkSymbol} from "./provider.mjs";
+import { Locale, parseLocale } from "./locale.mjs";
+import { translationsLinkSymbol } from "./provider.mjs";
 
-export {Translations, getDocumentTranslations};
+export { Translations, getDocumentTranslations };
 
 /**
  * With this class you can manage translations and access the keys.
@@ -38,178 +38,178 @@ export {Translations, getDocumentTranslations};
  * @see https://datatracker.ietf.org/doc/html/rfc3066
  */
 class Translations extends Base {
-    /**
-     *
-     * @param {Locale} locale
-     */
-    constructor(locale) {
-        super();
+	/**
+	 *
+	 * @param {Locale} locale
+	 */
+	constructor(locale) {
+		super();
 
-        if (locale instanceof Locale) {
-            this.locale = locale;
-        } else if (isString(locale)) {
-            this.locale = parseLocale(validateString(locale));
-        } else {
-            this.locale = getDocumentTranslations()
-        }
+		if (locale instanceof Locale) {
+			this.locale = locale;
+		} else if (isString(locale)) {
+			this.locale = parseLocale(validateString(locale));
+		} else {
+			this.locale = getDocumentTranslations();
+		}
 
-        this.storage = new Map();
-    }
+		this.storage = new Map();
+	}
 
-    /**
-     * This method is called by the `instanceof` operator.
-     * @return {symbol}
-     * @since 3.27.0
-     */
-    static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/i18n/translations@@instance");
-    }
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @return {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.
-     *
-     * @param {string} key
-     * @param {string|undefined} defaultText
-     * @return {string}
-     * @throws {Error} key not found
-     */
-    getText(key, defaultText) {
-        if (!this.storage.has(key)) {
-            if (defaultText === undefined) {
-                throw new Error(`key ${key} not found`);
-            }
+	/**
+	 * Fetches a text using the specified key.
+	 * If no suitable key is found, `defaultText` is taken.
+	 *
+	 * @param {string} key
+	 * @param {string|undefined} defaultText
+	 * @return {string}
+	 * @throws {Error} key not found
+	 */
+	getText(key, defaultText) {
+		if (!this.storage.has(key)) {
+			if (defaultText === undefined) {
+				throw new Error(`key ${key} not found`);
+			}
 
-            return validateString(defaultText);
-        }
+			return validateString(defaultText);
+		}
 
-        const r = this.storage.get(key);
-        if (isObject(r)) {
-            return this.getPluralRuleText(key, "other", defaultText);
-        }
+		const r = this.storage.get(key);
+		if (isObject(r)) {
+			return this.getPluralRuleText(key, "other", defaultText);
+		}
 
-        return this.storage.get(key);
-    }
+		return this.storage.get(key);
+	}
 
-    /**
-     * A number `count` can be passed to this method. In addition to a number, one of the keywords can also be passed directly.
-     * "zero", "one", "two", "few", "many" and "other". Remember: not every language has all rules.
-     *
-     * The appropriate text for this number is then selected. If no suitable key is found, `defaultText` is taken.
-     *
-     * @param {string} key
-     * @param {integer|string} count
-     * @param {string|undefined} defaultText
-     * @return {string}
-     */
-    getPluralRuleText(key, count, defaultText) {
-        if (!this.storage.has(key)) {
-            return validateString(defaultText);
-        }
+	/**
+	 * A number `count` can be passed to this method. In addition to a number, one of the keywords can also be passed directly.
+	 * "zero", "one", "two", "few", "many" and "other". Remember: not every language has all rules.
+	 *
+	 * The appropriate text for this number is then selected. If no suitable key is found, `defaultText` is taken.
+	 *
+	 * @param {string} key
+	 * @param {integer|string} count
+	 * @param {string|undefined} defaultText
+	 * @return {string}
+	 */
+	getPluralRuleText(key, count, defaultText) {
+		if (!this.storage.has(key)) {
+			return validateString(defaultText);
+		}
 
-        const r = validateObject(this.storage.get(key));
+		const r = validateObject(this.storage.get(key));
 
-        let keyword;
-        if (isString(count)) {
-            keyword = count.toLocaleString();
-        } else {
-            count = validateInteger(count);
-            if (count === 0) {
-                // special handling for zero count
-                if (r.hasOwnProperty("zero")) {
-                    return validateString(r?.zero);
-                }
-            }
+		let keyword;
+		if (isString(count)) {
+			keyword = count.toLocaleString();
+		} else {
+			count = validateInteger(count);
+			if (count === 0) {
+				// special handling for zero count
+				if (r.hasOwnProperty("zero")) {
+					return validateString(r?.zero);
+				}
+			}
 
-            keyword = new Intl.PluralRules(this.locale.toString()).select(
-                validateInteger(count),
-            );
-        }
+			keyword = new Intl.PluralRules(this.locale.toString()).select(
+				validateInteger(count),
+			);
+		}
 
-        if (r.hasOwnProperty(keyword)) {
-            return validateString(r[keyword]);
-        }
+		if (r.hasOwnProperty(keyword)) {
+			return validateString(r[keyword]);
+		}
 
-        // @deprecated since 2023-03-14
-        // DEFAULT_KEY is undefined
-        // 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);
-    }
+		return validateString(defaultText);
+	}
 
-    /**
-     * Set a text for a key
-     *
-     * ```
-     * translations.setText("text1", "Make my day!");
-     * // plural rules
-     * translations.setText("text6", {
-     *     "zero": "There are no files on Disk.",
-     *     "one": "There is one file on Disk.",
-     *     "other": "There are files on Disk."
-     *     "default": "There are files on Disk."
-     * });
-     * ```
-     *
-     * @param {string} key
-     * @param {string|object} text
-     * @return {Translations}
-     * @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;
-        }
+	/**
+	 * Set a text for a key
+	 *
+	 * ```
+	 * translations.setText("text1", "Make my day!");
+	 * // plural rules
+	 * translations.setText("text6", {
+	 *     "zero": "There are no files on Disk.",
+	 *     "one": "There is one file on Disk.",
+	 *     "other": "There are files on Disk."
+	 *     "default": "There are files on Disk."
+	 * });
+	 * ```
+	 *
+	 * @param {string} key
+	 * @param {string|object} text
+	 * @return {Translations}
+	 * @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
-     * 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.
-     *
-     * ```
-     * translations.assignTranslations({
-     *   "text1": "Make my day!",
-     *   "text2": "I'll be back!",
-     *   "text6": {
-     *     "zero": "There are no files on Disk.",
-     *     "one": "There is one file on Disk.",
-     *     "other": "There are files on Disk."
-     *     "default": "There are files on Disk."
-     * });
-     * ```
-     *
-     * @param {object} translations
-     * @return {Translations}
-     */
-    assignTranslations(translations) {
-        validateObject(translations);
+	/**
+	 * 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.
+	 *
+	 * ```
+	 * translations.assignTranslations({
+	 *   "text1": "Make my day!",
+	 *   "text2": "I'll be back!",
+	 *   "text6": {
+	 *     "zero": "There are no files on Disk.",
+	 *     "one": "There is one file on Disk.",
+	 *     "other": "There are files on Disk."
+	 *     "default": "There are files on Disk."
+	 * });
+	 * ```
+	 *
+	 * @param {object} translations
+	 * @return {Translations}
+	 */
+	assignTranslations(translations) {
+		validateObject(translations);
 
-        if (translations instanceof Translations) {
-            translations.storage.forEach((v, k) => {
-                this.setText(k, v);
-            });
-            return this;
-        }
+		if (translations instanceof Translations) {
+			translations.storage.forEach((v, k) => {
+				this.setText(k, v);
+			});
+			return this;
+		}
 
-        for (const [k, v] of Object.entries(translations)) {
-            this.setText(k, v);
-        }
+		for (const [k, v] of Object.entries(translations)) {
+			this.setText(k, v);
+		}
 
-        return this;
-    }
+		return this;
+	}
 }
 
 /**
@@ -223,34 +223,34 @@ class Translations extends Base {
  * @throws {Error} Missing translations.
  */
 function getDocumentTranslations(element) {
-    const d = getDocument();
+	const d = getDocument();
 
-    if (!(element instanceof HTMLElement)) {
-        element = d.querySelector(
-            `[${ATTRIBUTE_OBJECTLINK}~="${translationsLinkSymbol.toString()}"]`,
-        );
-        if (element === null) {
-            throw new Error(
-                "Cannot find the element with translations. Add the translation object to the document.",
-            );
-        }
-    }
+	if (!(element instanceof HTMLElement)) {
+		element = d.querySelector(
+			`[${ATTRIBUTE_OBJECTLINK}~="${translationsLinkSymbol.toString()}"]`,
+		);
+		if (element === null) {
+			throw new Error(
+				"Cannot find the element with translations. Add the translation object to the document.",
+			);
+		}
+	}
 
-    if (!(element instanceof HTMLElement)) {
-        throw new Error("Element is not an HTMLElement.");
-    }
+	if (!(element instanceof HTMLElement)) {
+		throw new Error("Element is not an HTMLElement.");
+	}
 
-    if (!hasObjectLink(element, translationsLinkSymbol)) {
-        throw new Error("This element has no translations.");
-    }
+	if (!hasObjectLink(element, translationsLinkSymbol)) {
+		throw new Error("This element has no translations.");
+	}
 
-    const obj = getLinkedObjects(element, translationsLinkSymbol);
+	const obj = getLinkedObjects(element, translationsLinkSymbol);
 
-    for (const t of obj) {
-        if (t instanceof Translations) {
-            return t;
-        }
-    }
+	for (const t of obj) {
+		if (t instanceof Translations) {
+			return t;
+		}
+	}
 
-    throw new Error("Missing translations.");
+	throw new Error("Missing translations.");
 }

package/source/types/version.mjs

@@ -156,7 +156,7 @@ function getMonsterVersion() {
 	}
 
 	/** don't touch, replaced by make with package.json version */
-	monsterVersion = new Version("4.28.0");
+	monsterVersion = new Version("4.30.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("4.28.0")
+        monsterVersion = new Version("4.30.0")
 
         let m = getMonsterVersion();
 

package/test/web/test.html

@@ -9,8 +9,8 @@
 </head>
 <body>
 <div id="headline" style="display: flex;align-items: center;justify-content: center;flex-direction: column;">
-  <h1 style='margin-bottom: 0.1em;'>Monster 4.28.0</h1>
-  <div id="lastupdate" style='font-size:0.7em'>last update Mo 7. Jul 19:03:48 CEST 2025</div>
+  <h1 style='margin-bottom: 0.1em;'>Monster 4.30.0</h1>
+  <div id="lastupdate" style='font-size:0.7em'>last update Di 8. Jul 03:38:54 CEST 2025</div>
 </div>
 <div id="mocha-errors"
      style="color: red;font-weight: bold;display: flex;align-items: center;justify-content: center;flex-direction: column;margin:20px;"></div>