tiny-essentials 1.21.8 → 1.21.9

package/dist/v1/libs/UltraRandomMsgGen.mjs

@@ -351,17 +351,84 @@ const defaultTemplates = [
  */
 class UltraRandomMsgGen {
     /** @type {string[]} */
-    static defaultWords = defaultWords;
+    static #defaultWords = defaultWords;
     /** @type {string[]} */
-    static defaultEmojis = defaultEmojis;
+    static #defaultEmojis = defaultEmojis;
     /** @type {string[]} */
-    static defaultNouns = defaultNouns;
+    static #defaultNouns = defaultNouns;
     /** @type {string[]} */
-    static defaultVerbs = defaultVerbs;
+    static #defaultVerbs = defaultVerbs;
     /** @type {string[]} */
-    static defaultAdjectives = defaultAdjectives;
+    static #defaultAdjectives = defaultAdjectives;
     /** @type {string[]} */
-    static defaultTemplates = defaultTemplates;
+    static #defaultTemplates = defaultTemplates;
+    /**
+     * Utility to validate arrays before setting.
+     * @param {any} value
+     * @param {string} field
+     */
+    static #validateArray(value, field) {
+        if (!Array.isArray(value))
+            throw new TypeError(`${field} must be an array of strings`);
+        if (!value.every((v) => typeof v === 'string'))
+            throw new TypeError(`${field} must contain only strings`);
+        if (value.length === 0)
+            throw new Error(`${field} cannot be empty`);
+    }
+    /** @returns {string[]} */
+    static get defaultWords() {
+        return [...this.#defaultWords];
+    }
+    /** @param {string[]} value */
+    static set defaultWords(value) {
+        this.#validateArray(value, 'defaultWords');
+        this.#defaultWords = [...value];
+    }
+    /** @returns {string[]} */
+    static get defaultEmojis() {
+        return [...this.#defaultEmojis];
+    }
+    /** @param {string[]} value */
+    static set defaultEmojis(value) {
+        this.#validateArray(value, 'defaultEmojis');
+        this.#defaultEmojis = [...value];
+    }
+    /** @returns {string[]} */
+    static get defaultNouns() {
+        return [...this.#defaultNouns];
+    }
+    /** @param {string[]} value */
+    static set defaultNouns(value) {
+        this.#validateArray(value, 'defaultNouns');
+        this.#defaultNouns = [...value];
+    }
+    /** @returns {string[]} */
+    static get defaultVerbs() {
+        return [...this.#defaultVerbs];
+    }
+    /** @param {string[]} value */
+    static set defaultVerbs(value) {
+        this.#validateArray(value, 'defaultVerbs');
+        this.#defaultVerbs = [...value];
+    }
+    /** @returns {string[]} */
+    static get defaultAdjectives() {
+        return [...this.#defaultAdjectives];
+    }
+    /** @param {string[]} value */
+    static set defaultAdjectives(value) {
+        this.#validateArray(value, 'defaultAdjectives');
+        this.#defaultAdjectives = [...value];
+    }
+    /** @returns {string[]} */
+    static get defaultTemplates() {
+        return [...this.#defaultTemplates];
+    }
+    /** @param {string[]} value */
+    static set defaultTemplates(value) {
+        this.#validateArray(value, 'defaultTemplates');
+        this.#defaultTemplates = [...value];
+    }
     /** @type {MsgGenConfig} */
     config = {
         minLength: 10,
@@ -512,18 +579,18 @@ class UltraRandomMsgGen {
                 throw new RangeError('config.line.emojiChance must be a number between 0 and 1');
             }
         }
-        this.config.emojiSet = [...defaultEmojis];
-        this.config.wordSet = [...defaultWords];
-        this.config.grammar.templates = [...defaultTemplates];
-        this.config.grammar.nouns = [...defaultNouns];
-        this.config.grammar.verbs = [...defaultVerbs];
-        this.config.grammar.adjectives = [...defaultAdjectives];
+        this.config.emojiSet = [...UltraRandomMsgGen.#defaultEmojis];
+        this.config.wordSet = [...UltraRandomMsgGen.#defaultWords];
+        this.config.grammar.templates = [...UltraRandomMsgGen.#defaultTemplates];
+        this.config.grammar.nouns = [...UltraRandomMsgGen.#defaultNouns];
+        this.config.grammar.verbs = [...UltraRandomMsgGen.#defaultVerbs];
+        this.config.grammar.adjectives = [...UltraRandomMsgGen.#defaultAdjectives];
         Object.assign(this.config, config);
     }
     /**
      * Merges new configuration values into the current instance.
      * @param {Object} newConfig - Object with one or more configuration overrides.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     configure(newConfig = {}) {
         Object.assign(this.config, newConfig);
@@ -532,7 +599,7 @@ class UltraRandomMsgGen {
     /**
      * Replaces the entire list of grammar templates.
      * @param {...string[]} templates - One or more arrays or strings containing sentence templates.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     setGrammarTemplates(...templates) {
         this.config.grammar.templates = templates.flat();
@@ -541,7 +608,7 @@ class UltraRandomMsgGen {
     /**
      * Adds new grammar templates to the existing list.
      * @param {...string[]} templates - One or more arrays or strings containing sentence templates.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     addGrammarTemplates(...templates) {
         this.config.grammar.templates.push(...templates.flat());
@@ -550,7 +617,7 @@ class UltraRandomMsgGen {
     /**
      * Replaces the list of noun words used in grammar templates.
      * @param {...string[]} nouns - One or more arrays or strings of nouns.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     setGrammarNouns(...nouns) {
         this.config.grammar.nouns = nouns.flat();
@@ -559,7 +626,7 @@ class UltraRandomMsgGen {
     /**
      * Adds noun words to the existing list used in grammar templates.
      * @param {...string[]} nouns - One or more arrays or strings of nouns.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     addGrammarNouns(...nouns) {
         this.config.grammar.nouns.push(...nouns.flat());
@@ -568,7 +635,7 @@ class UltraRandomMsgGen {
     /**
      * Replaces the list of verb words used in grammar templates.
      * @param {...string[]} verbs - One or more arrays or strings of verbs.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     setGrammarVerbs(...verbs) {
         this.config.grammar.verbs = verbs.flat();
@@ -577,7 +644,7 @@ class UltraRandomMsgGen {
     /**
      * Adds verb words to the existing list used in grammar templates.
      * @param {...string[]} verbs - One or more arrays or strings of verbs.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     addGrammarVerbs(...verbs) {
         this.config.grammar.verbs.push(...verbs.flat());
@@ -586,7 +653,7 @@ class UltraRandomMsgGen {
     /**
      * Replaces the list of adjective words used in grammar templates.
      * @param {...string[]} adjectives - One or more arrays or strings of adjectives.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     setGrammarAdjectives(...adjectives) {
         this.config.grammar.adjectives = adjectives.flat();
@@ -595,7 +662,7 @@ class UltraRandomMsgGen {
     /**
      * Adds adjective words to the existing list used in grammar templates.
      * @param {...string[]} adjectives - One or more arrays or strings of adjectives.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     addGrammarAdjectives(...adjectives) {
         this.config.grammar.adjectives.push(...adjectives.flat());
@@ -604,7 +671,7 @@ class UltraRandomMsgGen {
     /**
      * Removes specific grammar templates from the current list.
      * @param {...string[]} templates - One or more arrays or strings of templates to remove.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     removeGrammarTemplates(...templates) {
         const removeSet = new Set(templates.flat());
@@ -614,7 +681,7 @@ class UltraRandomMsgGen {
     /**
      * Removes specific noun words from the grammar noun list.
      * @param {...string[]} nouns - One or more arrays or strings of nouns to remove.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     removeGrammarNouns(...nouns) {
         const removeSet = new Set(nouns.flat());
@@ -624,7 +691,7 @@ class UltraRandomMsgGen {
     /**
      * Removes specific verb words from the grammar verb list.
      * @param {...string[]} verbs - One or more arrays or strings of verbs to remove.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     removeGrammarVerbs(...verbs) {
         const removeSet = new Set(verbs.flat());
@@ -634,7 +701,7 @@ class UltraRandomMsgGen {
     /**
      * Removes specific adjective words from the grammar adjective list.
      * @param {...string[]} adjectives - One or more arrays or strings of adjectives to remove.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     removeGrammarAdjectives(...adjectives) {
         const removeSet = new Set(adjectives.flat());
@@ -644,7 +711,7 @@ class UltraRandomMsgGen {
     /**
      * Replaces the entire word set used in readable/mixed modes.
      * @param {...string[]} words - One or more arrays or strings of words.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     setWords(...words) {
         this.config.wordSet = words.flat();
@@ -653,7 +720,7 @@ class UltraRandomMsgGen {
     /**
      * Adds new words to the word set used in readable/mixed modes.
      * @param {...string[]} words - One or more arrays or strings of words.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     addWords(...words) {
         this.config.wordSet.push(...words.flat());
@@ -662,7 +729,7 @@ class UltraRandomMsgGen {
     /**
      * Removes specific words from the word set.
      * @param {...string[]} words - Words to be removed.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     removeWords(...words) {
         const removeSet = new Set(words.flat());
@@ -672,7 +739,7 @@ class UltraRandomMsgGen {
     /**
      * Replaces the emoji set used in generated output.
      * @param {...string[]} emojis - One or more arrays or strings of emojis.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     setEmojis(...emojis) {
         this.config.emojiSet = emojis.flat();
@@ -681,7 +748,7 @@ class UltraRandomMsgGen {
     /**
      * Adds new emojis to the emoji set.
      * @param {...string[]} emojis - One or more arrays or strings of emojis.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     addEmojis(...emojis) {
         this.config.emojiSet.push(...emojis.flat());
@@ -690,7 +757,7 @@ class UltraRandomMsgGen {
     /**
      * Removes specific emojis from the emoji set.
      * @param {...string[]} emojis - Emojis to be removed.
-     * @returns {UltraRandomMsgGen} - The instance for chaining.
+     * @returns {this} - The instance for chaining.
      */
     removeEmojis(...emojis) {
         const removeSet = new Set(emojis.flat());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.21.8",
+  "version": "1.21.9",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "scripts": {
     "test": "npm run test:mjs && npm run test:cjs && npm run test:js",