refactor: changed how characters are generated.

This update changes how the `generateCharCode` function generates characters. The new method will allow for the expansion of more characters by removing the manual `if else` chaining. Furthermore we also removed the `conformPassword` check step as the new method will always ensure the proper number of attributes exists in the password (at the cost of possibly being a bit less random). This update includes the following changes: * The `generateCharCode` function now recieves a new parameter, a `charCodeRequest` object which contains a string that is the desired character we want to generate. The checks are now performed against a `characterCodeConstraints` object which contains the attributes for each character type. * Removed the `conformPassword` function. * Moved all Interfaces, Enums, Lists and Objects into a Data folder. * Removed any currently unused modifiers such as, *memorable* and *special* * Updated the README * Updated the Demo page: * Clarified the character set being used. * Added a warning about excessive use of the *exclude characters* feature * Removed unneeded JavaScript code for the demo * Updates to the `package.json` file: * removed the `main` attribute, replaced with `browser` * Updated version. * Added more directories. * Changed the `license` attribute to `licenses` and added a URL. * Added two new helper functions: * `shuffle` used to shuffle arrays. * `createModifierList` creates a list of modifiers from an object. Signed-off-by: staticBanter <[email protected]>
staticBanter · Nov 3, 2022 · 416dde3 · 416dde3
1 parent 143da60
commit 416dde3
Show file tree

Hide file tree

Showing 38 changed files with 677 additions and 412 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,17 @@
 simplePass
 =
 
-> [!CAUTION]
-> This project is still in development. Certain features are incomplete or may not function entirely. **Use At Your Own Risk**
+> **CAUTION**
+>
+> This project is in Beta Phase. Some features may still contain a few bugs.
 
 - [simplePass](#simplepass)
 - [About](#about)
 - [Installation](#installation)
 - [Modifier(Options)](#modifieroptions)
+  - [General Modifiers](#general-modifiers)
+    - [Whitespace Modifiers](#whitespace-modifiers)
+  - [Latin Basic Modifiers](#latin-basic-modifiers)
 - [Examples](#examples)
 - [Development](#development)
   - [Requirements](#requirements)
@@ -25,7 +29,7 @@ simplePass is a JavaScript password generator.
 To include simplePass in your project follow these steps:
 
 1. Download the ```simplePass``` directory.
-2. simplePass is built using *ESNext* Modules imports so in your project you will have to import simplePass like so:
+2. simplePass is built using *ESNext* module imports so in your project you will have to import simplePass like so:
 ```javascript
 import simplePass from 'yourLocalPathing/simplePass/simplePass.js';
 ```
@@ -38,28 +42,25 @@ const password = simplePass(modifier);
 
 simplePass may be called a variety of modifiers to change the desired passwords outcome. These modifiers are passed as an object to simplePass.
 
+## General Modifiers
 * length:*number* - The length of the password (default: 8)
   * min: 3
   * max 256
-* lowercase:*boolean* - Ensure lowercase characters (default: true)
-* uppercase:*boolean* - Ensure uppercase characters (default: false)
-* numbers:*boolean* - Ensure numbers (default: false)
-* punctuation:*boolean* - Ensure punctuation (default: false)
 * excludeCharacters: *string* - Ensure the following characters are excluded from the password (default: empty)
-* special:*boolean* - Ensure special characters (default: false) **disabled**
-* memorable: *boolean* - Create a password using a series of regular words (ie HorseRulerBatteryStapler) (default: false). **disabled**
-* **Whitespace Options**
+
+### Whitespace Modifiers
 * w_beginning: *boolean* - Allow whitespace at the beginning of a password.
 * w_beginning_required: *boolean* - Ensure a whitespace character at the beginning of a password.
 * w_end: *boolean* - Allow whitespace at the end of a password.
 * w_end_required: *boolean* - Ensure a whitespace character at the end of a password.
 * w_between: *boolean* - Ensure a whitespace character between the beginning and end of a password.
 
-> [!CAUTION]
-> The *special* option currently does not work and will be silently ignored.
+## Latin Basic Modifiers
+* lowercase:*boolean* - Ensure a lowercase characters (default: true)
+* uppercase:*boolean* - Ensure uppercase characters (default: false)
+* numbers:*boolean* - Ensure numbers (default: false)
+* punctuation:*boolean* - Ensure punctuation (default: false)
 
-> [!CAUTION]
-> The *memorable* option currently does not work and will be silently ignored.
 
 # Examples
 

diff --git a/demo.html b/demo.html
@@ -29,27 +29,22 @@ <h2>Modifiers</h2>
             <label>Length:
                 <input type="number" form="passwordForm" name="length" max="256" min="1" step="1" value="8" required/>
             </label>
-            <label>Lower Case:
-                <input type="checkbox" form="passwordForm" name="lowercase" checked/>
-            </label>
-            <label>Upper Case:
-                <input type="checkbox" form="passwordForm" name="uppercase" />
-            </label>
-            <label>Numbers:
-                <input type="checkbox" form="passwordForm" name="numbers" />
-            </label>
-            <label>Punctuation:
-                <input type="checkbox" form="passwordForm" name="punctuation" />
-            </label>
-            <label>Special Chars(Emojis, Unicode Symbols):
-                <input type="checkbox" form="passwordForm" name="special" disabled/>
-            </label>
-            <label>Memorable:
-                <input type="checkbox" form="passwordForm" name="memorable" disabled/>
-            </label>
-            <label>Allow Whitespace:
-                <input type="checkbox" form="passwordForm" name="allow_whitespace">
-            </label>
+            <fieldset>
+                <legend>Latin Basic</legend>
+                <p>This does not include Control Characters 0-31,127</p>
+                <label>Lower Case:
+                    <input type="checkbox" form="passwordForm" name="lowercase" checked/>
+                </label>
+                <label>Upper Case:
+                    <input type="checkbox" form="passwordForm" name="uppercase" />
+                </label>
+                <label>Numbers:
+                    <input type="checkbox" form="passwordForm" name="numbers" />
+                </label>
+                <label>Punctuation:
+                    <input type="checkbox" form="passwordForm" name="punctuation" />
+                </label>
+            </fieldset>
             <fieldset id="whitespaceOptions" name="whitespaceOptions" form="passwordForm">
                 <legend>Whitespace Options</legend>
                 <fieldset>
@@ -76,6 +71,7 @@ <h2>Modifiers</h2>
             </fieldset>
             <label>Exclude Characters:
                 <input type="text" form="passwordForm" name="excludeCharacters" />
+                <p>* <strong>Warning</strong>: Excessive use of this feature may result in degraded performance or non-performance of the program. *</p>
             </label>
         </form>
     </main>

diff --git a/demo/demo.css b/demo/demo.css
@@ -27,6 +27,9 @@
     border: 1px solid;
     border-radius: 0 0 10px 10px;
     box-shadow: 0 1px 5px;
+}
+
+#passwordForm > fieldset{
     display: flex;
     flex-flow: column;
 }

diff --git a/demo/demo.js b/demo/demo.js
@@ -8,29 +8,6 @@ import simplePass from "../simplePass/simplePass.js";
     const displayPassword = document.body.querySelector("#displayPassword");
     displayPassword.innerText = simplePass();
 
-    // Hide the whitespace options until a user decides to modify them.
-    const whitespaceFieldSet = document.body.querySelector('#whitespaceOptions');
-    whitespaceFieldSet.setAttribute('hidden','hidden');
-
-    // Disable the whitespace options until a user decides to use them.
-    const whitespaceOptions = whitespaceFieldSet.querySelectorAll('input');
-    whitespaceOptions.forEach((option)=>{option.setAttribute('disabled','disabled');});
-
-    /**
-     * If the 'allow whitespace' option is set then unhide the whitespace options and enable them,
-     * Else hide the options and disable them.
-     */
-    document.body.querySelector("input[name='allow_whitespace']").addEventListener('input',function(){
-
-        if(this.checked){
-            whitespaceFieldSet.removeAttribute('hidden');
-            whitespaceOptions.forEach((option)=>{option.removeAttribute('disabled');});
-        }else{
-            whitespaceFieldSet.setAttribute('hidden','hidden');
-            whitespaceOptions.forEach((option)=>{option.setAttribute('disabled','disabled');});
-        }
-    });
-
     // When the user submits the form, call simplePass and display the new form.
     document.body.querySelector("#passwordForm").addEventListener('submit',function(event){
         event.preventDefault();

diff --git a/package.json b/package.json
@@ -4,10 +4,12 @@
   },
   "name": "simplepass",
   "description": "simplePass is a Javascript password generator.",
-  "version": "2.5.1-Development",
-  "main": "bs-config.js",
+  "version": "1.0.0-Beta",
+  "browser": "./simplePass/simplePass.js",
   "directories": {
-    "test": "test"
+    "test": "test",
+    "src": "src",
+    "lib": "simplePass"
   },
   "repository": {
     "type": "git",
@@ -22,7 +24,12 @@
     "email": "[email protected]",
     "url": "https://staticblogs.ca/users/staticBanter"
   },
-  "license":"GPL-3.0",
+  "licenses":[
+    {
+      "type": "GPL-3.0",
+      "url": "https://www.gnu.org/licenses/gpl-3.0.html"
+    }
+  ],
   "bugs": {
     "url": "https://github.com/staticBanter/simplePass/issues"
   },

diff --git a/simplePass/enums/errors.enum.js → simplePass/data/enums/errors.enum.js b/simplePass/enums/errors.enum.js → simplePass/data/enums/errors.enum.js
diff --git a/...faces/charCodeGenerationFlag.interface.js → ...faces/charCodeGenerationFlag.interface.js b/...faces/charCodeGenerationFlag.interface.js → ...faces/charCodeGenerationFlag.interface.js
diff --git a/simplePass/data/interfaces/charCodeRequest.interface.js b/simplePass/data/interfaces/charCodeRequest.interface.js
@@ -0,0 +1,4 @@
+'use strict';
+;
+;
+export {};
diff --git a/.../interfaces/passwordModifier.interface.js → ...ces/characterCodeConstraints.interface.js b/.../interfaces/passwordModifier.interface.js → ...ces/characterCodeConstraints.interface.js
diff --git a/simplePass/data/interfaces/passwordModifier.interface.js b/simplePass/data/interfaces/passwordModifier.interface.js
@@ -0,0 +1,2 @@
+'use strict';
+export {};
diff --git a/simplePass/lists/allowedModifiers.list.js → ...ePass/data/lists/allowedModifiers.list.js b/simplePass/lists/allowedModifiers.list.js → ...ePass/data/lists/allowedModifiers.list.js
diff --git a/simplePass/lists/requiredAttributes.list.js → ...ass/data/lists/requiredAttributes.list.js b/simplePass/lists/requiredAttributes.list.js → ...ass/data/lists/requiredAttributes.list.js
@@ -2,8 +2,9 @@
 const L_requiredAttributes = [
     'lowercase',
     'uppercase',
+    'numbers',
     'punctuation',
     'special',
-    'memorable'
+    'memorable',
 ];
 export default L_requiredAttributes;
diff --git a/simplePass/data/lists/usableAttributes,list.js b/simplePass/data/lists/usableAttributes,list.js
@@ -0,0 +1,14 @@
+'use strict';
+const L_useableAttributes = [
+    'lowercase',
+    'uppercase',
+    'numbers',
+    'punctuation',
+    'special',
+    'memorable',
+    'w_beginning',
+    'w_end',
+    'w_between',
+    'excludeCharacters'
+];
+export default L_useableAttributes;
diff --git a/simplePass/data/lists/whitespaceAttributes.list.js b/simplePass/data/lists/whitespaceAttributes.list.js
@@ -0,0 +1,9 @@
+'use strict';
+const L_whitespaceAttributes = [
+    'w_beginning',
+    'w_end',
+    'w_between',
+    'w_end_required',
+    'w_beginning_required',
+];
+export default L_whitespaceAttributes;
diff --git a/simplePass/data/objects/characterCodeConstraints.object.js b/simplePass/data/objects/characterCodeConstraints.object.js
@@ -0,0 +1,29 @@
+'use strict';
+const characterCodeConstraints = {
+    lowercase: {
+        min: 97,
+        max: 122,
+    },
+    uppercase: {
+        min: 65,
+        max: 90,
+    },
+    numbers: {
+        min: 48,
+        max: 57,
+    },
+    punctuation: {
+        min: 33,
+        max: 126,
+        range: [
+            [33, 47],
+            [58, 64],
+            [91, 96],
+            [123, 126]
+        ]
+    },
+    whitespace: {
+        single: 32
+    },
+};
+export default characterCodeConstraints;
diff --git a/simplePass/helpers/cleanModifier.helper.js b/simplePass/helpers/cleanModifier.helper.js
@@ -1,5 +1,5 @@
 'use strict';
-import L_allowedModifiers from "../lists/allowedModifiers.list.js";
+import L_allowedModifiers from "../data/lists/allowedModifiers.list.js";
 export default function cleanModifier(modifier) {
     const converter = {};
     if (modifier instanceof FormData) {

diff --git a/simplePass/helpers/conformPassword.helper.js b/simplePass/helpers/conformPassword.helper.js
diff --git a/simplePass/helpers/createModifierList.helper.js b/simplePass/helpers/createModifierList.helper.js
@@ -0,0 +1,10 @@
+'use strict';
+export default function createModifierList(modifier, list) {
+    const modifiers = [];
+    Object.keys(modifier).forEach((key) => {
+        if (list.includes(key)) {
+            modifiers.push(key);
+        }
+    });
+    return modifiers;
+}