Merge branch 'main' into main

Author: hepabolu

README.md

@@ -43,7 +43,7 @@ Fundamentally, the repository is a NodeJS project, so it contains the standard N
 * `/buildScripts/` — the folder containing the scripts used to build the bundled versions of the module and the module's documentation site, including its UML diagrams.
 * `/dist/` — the target folder into which the build scripts will publish the bundled versions of the module, ready for distribution. **Do not edit the contents of this folder directly!**
 * `/docs/` — the target folder into which the build scripts will publish the generated documentation. This folder's contents will be published at the project's website. **Do not edit the contents of this folder directly!**
-* `/docs-other/` — the folder containing the parts of the documentation that are not generated from documentation comments.
+* `/docs-other/` — the folder containing the parts of the documentation that are not generated from documentation comments. This folder also includes a **README** file that includes instructions on how to get started.
 * `/docs-other/diagrams/` — the target folder into which the build scripts will publish PNG versions of the project's UML diagrams. The source for these diagrams are the Mermaid files in `/src-diagrams/`. **Do not edit the contents of this folder directly!**
 * `/src/` — the folder containing the module's source code and test suite.
 * `/src-diagrams/` — the folder containing the source code for the UML diagrams describing the module. These files will be in Mermaid format and will be transformed into PNG files in `/docs-other/diagrams/` by a build script.
@@ -99,7 +99,7 @@ This module is versioned using the Semantic Versioning System, or [SemVer](https
    * Until the project reaches version 1.0.0 any contributions that make progress towards the initial implementation can be merged into the `main` branch
    * Once the project reaches version 1.0.0 all contributions must be *atomic*, i.e. must be a complete unit. For code contributions that means:
      1. All tests must pass
-     2. News tests must be included to cover all new functionality
+     2. New tests must be included to cover all new functionality
      3. The Doc Comments must be updated as appropriate
      4. The code must be in the project's style
 

docs-other/README.md

@@ -14,9 +14,15 @@ npm run cov # run the tests again but this time with test coverage. Coverage sho
 
 ## Hot build and reload
 
-The easiest way to achieve this is opening 2 Terminal windows in the root directory of this project.
+The easiest way to achieve this is opening a Terminal window in the root directory of this project.
 
-In one Terminal enter `npm run watch` to start the automatic build of Webpack. Webpack watches for changes in your files and automatically starts the build.
-In the other Terminal enter `npm run start` to start a local webserver that automatically restarts when there is a new build.
+In the Terminal enter `npm run start` to start a local webserver.
+This script will watch for any change in any file, and automatically start a
+a webpack build and restarts the server when there is a new build.
 
 In your webbrowser enter `http://localhost:8080` to find the webapp.
+
+## JS Docs
+
+If you want to see the docs locally, run `npm run docs`.
+You will find them in /dist/docs and also through the webapp in the Actions menu.

src/index.html

@@ -78,5 +78,15 @@ $(() => {
     (tooltipTriggerEl) => new Tooltip(tooltipTriggerEl));
 
   XKP.init();
-});
 
+  // Now that the DOM is ready, find all the 'div' elements that
+  // were identified to have the potential to flash unstyled content
+  // as the page loads and make them visible.
+  const foucElements = document.querySelectorAll('div[fouc=\'true\']');
+  for (const fouc of foucElements) {
+    if (fouc.style !== null) {
+      // Make the element visible.
+      fouc.style.visibility = 'visible';
+    }
+  }
+});

src/index.mjs

@@ -11,16 +11,20 @@
  */
 class Dictionary {
   #wordListLength; // length of the word list, convenience variable
+  #minWordLength; // shortest word length
+  #maxWordLength; // longest word length
 
   /**
    * Constructor for English Dictionary
    * @constructor
    */
   constructor() {
-    if (this.constructor == Dictionary) {
+    if (this.constructor === Dictionary) {
       throw new Error('You cannot instantiate the abstract class');
     }
     this.#wordListLength = 0;
+    this.#minWordLength = 0;
+    this.#maxWordLength = 0;
   }
 
 
@@ -71,6 +75,31 @@ class Dictionary {
   __setLength(len) {
     this.#wordListLength = len;
   }
+
+  /**
+   * set min and max word length
+   *
+   * @ private
+   */
+  __setWordLength() {
+    const list = this.wordList();
+    let minlen = list[0].length;
+    let maxlen = minlen;
+    for (let i = 1 ; i < this.#wordListLength; i++) {
+      minlen = Math.min(minlen, list[i].length);
+      maxlen = Math.max(maxlen, list[i].length);
+    }
+    this.#minWordLength = minlen;
+    this.#maxWordLength = maxlen;
+  }
+
+  getMinWordLength() {
+    return this.#minWordLength;
+  }
+
+  getMaxWordLength() {
+    return this.#maxWordLength;
+  }
 }
 
 export {Dictionary};

src/lib/dictionary.mjs

@@ -1285,6 +1285,7 @@ class DictionaryEN extends Dictionary {
   constructor() {
     super();
     super.__setLength(THE_WORDS.length);
+    super.__setWordLength();
   }
 
 

src/lib/dictionaryEN.mjs

@@ -245,6 +245,11 @@ class Presets {
         }
       }
     };
+
+    // fix the padding and separator alphabet
+    this.#current.config.separator_alphabet = this.getSeparatorAlphabet();
+    this.#current.config.padding_alphabet = this.getPaddingAlphabet();
+
     log.trace(`Preset constructor set to ${this.#presetName}`);
   }
 
@@ -309,10 +314,12 @@ class Presets {
    * @return {Array} the list of characters
    */
   getSeparatorAlphabet() {
-    const alphabet =
+    let alphabet =
         (is.not.undefined(this.#current.config.separator_alphabet) ?
           this.#current.config.separator_alphabet :
           this.#current.config.symbol_alphabet);
+    alphabet = ((is.undefined(alphabet) || (alphabet.length === 0)) ?
+      thePresets.DEFAULT.config.symbol_alphabet : alphabet);
     return alphabet;
   }
 
@@ -323,12 +330,14 @@ class Presets {
    * @return {Array} the list of characters
    */
   getPaddingAlphabet() {
-    const alphabet =
+    let alphabet =
           (is.not.undefined(this.#current.config.padding_alphabet) ?
             this.#current.config.padding_alphabet :
             this.#current.config.symbol_alphabet);
+    alphabet = ((is.undefined(alphabet) || (alphabet.length === 0)) ?
+      thePresets.DEFAULT.config.symbol_alphabet : alphabet);
     return alphabet;
   }
-};
+}
 
 export {Presets};

src/lib/presets.mjs

@@ -30,7 +30,7 @@ class RandomBasic {
   /**
    * Generate a number of random digits
    *
-   * @param {Integer} num - number of random digits to generate,
+   * @param {number} num - number of random digits to generate,
    *  defaults to empty string if not given
    * @return {Array} - array of random digits
    * @throws Exception when parameter is not a number
@@ -41,8 +41,8 @@ class RandomBasic {
     if (is.null(num) || is.undefined(num) || num <= 0) {
       return '';
     }
-    if (is.not.integer(num)) {
-      const errMsg = 'Parameter "num" is not an integer! [' + num + ']';
+    if (is.not.number(num)) {
+      const errMsg = 'Parameter "num" is not a number! [' + num + ']';
       // log.error('ERROR', errMsg);
       throw new Error(errMsg);
     }

src/lib/randombasic.mjs

@@ -62,20 +62,20 @@ class XKPasswd {
   getPreset() {
     return this.#preset;
   }
+
   /**
    * Get all available presets
    *
    * @return {array} keys - names of the Presets
    */
   getPresets() {
-    const keys = new Presets().getPresets();
-    return keys;
+    return new Presets().getPresets();
   }
 
   /**
    * Generate the password(s) and stats
    *
-   * @param {integer} num - number of passwords to generate
+   * @param {number} num - number of passwords to generate
    * @return {object} - contains the passwords and the stats
    */
   generatePassword(num) {
@@ -104,11 +104,11 @@ class XKPasswd {
       // start by generating the needed parts of the password
       //
       log.trace('starting to generate random words');
-      const words = this.__randomWords();
+      let words = this.__randomWords();
       log.trace(`got random words = ${words}`);
 
-      this.__transformCase(words);
-      this.__substituteCharacters(words);
+      words = this.__transformCase(words);
+      words = this.__substituteCharacters(words);
       const separator = this.__separator();
       log.trace(`got separator = ${separator}`);
 
@@ -161,16 +161,17 @@ class XKPasswd {
 
   /**
    * Generate the requested number of passwords
-   * @param {integer} num - the number of passwords requested
+   * @param {number} num - the number of passwords requested
    * @return {array} - the array with num passwords
    */
   passwords(num) {
     if (is.undefined(num) || is.not.number(num) || num < 1) {
       num = 1;
     }
-
-    const passwords =
-    new Array(num).fill('').map( () => this.password() );
+    const passwords = [];
+    for (let i = 0; i < num ; i++) {
+      passwords.push(this.password());
+    }
 
     return passwords;
   }
@@ -180,16 +181,17 @@ class XKPasswd {
    * Pad the password with padChar until the given length
    *
    * @param {string} passwd - password to be padded
-   * @param {character} padChar - padding character
-   * @param  {integer} maxLen - max length of password
+   * @param {string} padChar - padding character
+   * @param  {number} maxLen - max length of password
    * @return {string} - padded password
    *
    * @private
    */
   __adaptivePadding(passwd, padChar, maxLen) {
     const pwlen = passwd.length;
+    padChar = (padChar.length === 0) ? ' ' : padChar;
     if (pwlen < maxLen) {
-      // if the password is shorter than the target length, padd it out
+      // if the password is shorter than the target length, pad it out
       while (passwd.length < maxLen) {
         passwd += padChar;
       }
@@ -219,6 +221,7 @@ class XKPasswd {
     }
 
     const transformation = this.#config.case_transform;
+    log.trace(`__transformCase: ${transformation} on ${words}`);
 
     switch (transformation) {
     case 'NONE':
@@ -242,7 +245,7 @@ class XKPasswd {
 
     case 'ALTERNATE':
       return words.map((el, index) =>
-        el = (index % 2 == 0) ? el.toLowerCase() : el.toUpperCase(),
+        el = ((index % 2) === 0) ? el.toLowerCase() : el.toUpperCase(),
       );
 
     case 'RANDOM':
@@ -277,14 +280,32 @@ class XKPasswd {
    * @private
    */
   __randomWords() {
+
     const numWords = this.#config.num_words;
     const maxDict = this.#dictionary.getLength();
 
-    log.trace(`about to generate ${numWords} words`);
+    log.trace(`__randomwords, mindict: ${this.#dictionary.getMinWordLength()}
+    maxdict: ${this.#dictionary.getMaxWordLength()}`);
+    // get the minimum of the 2 input variables and the longest dictionary word
+    let minLength = Math.min(this.#config.word_length_min, this.#config.word_length_max, this.#dictionary.getMaxWordLength());
+
+    // get the maximum of the 2 input variables and the shortest dictionary word
+    let maxLength = Math.max(this.#config.word_length_min, this.#config.word_length_max, this.#dictionary.getMinWordLength());
+
+    minLength = Math.max(minLength, this.#dictionary.getMinWordLength());
+    maxLength = Math.min(maxLength, this.#dictionary.getMaxWordLength());
+
+    log.trace(`about to generate ${numWords} words ${minLength} - ${maxLength}`);
 
-    const list = new Array(numWords).fill('').map(
-      () => this.#dictionary.word(this.#rng.randomInt(maxDict)),
-    );
+    const list = [];
+    for (let i = 0; i < numWords; i++) {
+      let word = '';
+      do {
+        word = this.#dictionary.word(this.#rng.randomInt(maxDict));
+      }
+      while (word.length < minLength || word.length > maxLength );
+      list.push(word);
+    };
     return list;
   }
 
@@ -294,22 +315,25 @@ class XKPasswd {
    * Notes: The character returned is controlled by the config variable
    *  `separator_character`
    *
-   * @return {character} separator (could be an empty string)
+   * @return {string} separator (could be an empty string)
    *
    * @private
    */
   __separator() {
     // figure out the separator character
     const sep = this.#config.separator_character;
 
-    if (sep == 'NONE') {
+    if (sep === 'NONE') {
       return '';
     }
-    if (sep == 'RANDOM') {
+    if (sep === 'RANDOM') {
       const alphabet = this.#preset.getSeparatorAlphabet();
       return this.#rng.randomChar(alphabet);
     }
-    return '';
+    if (sep.length > 1) {
+      return '';
+    }
+    return sep;
   }
 
   /**
@@ -319,9 +343,9 @@ class XKPasswd {
    *  The character returned is determined by a combination of the
    *  padding_type & padding_character config variables.
    *
-   * @param {character} separator -
+   * @param {string} separator -
    *  the separator character being used to generate the password
-   * @return {character} the padding character, could be an empty string
+   * @return {string} the padding character, could be an empty string
    *
    * @private
    */
@@ -339,7 +363,10 @@ class XKPasswd {
       const alphabet = this.#preset.getPaddingAlphabet();
       return this.#rng.randomChar(alphabet);
     default:
-      return '';
+      if (this.#config.padding_character.length > 1) {
+        return '';
+      }
+      return this.#config.padding_character;
     }
   }