js-generate-password 0.1.9 → 1.1.0

package/src/types.ts

@@ -0,0 +1,57 @@
+export interface GenerateOptions {
+  /**
+   * Length of the generated password.
+   * @default 10
+   */
+  length?: number
+  /**
+   * Should the password include lowercase characters.
+   * @default true
+   */
+  lowercase?: boolean
+  /**
+   * Should the password include uppercase characters.
+   * @default true
+   */
+  uppercase?: boolean
+  /**
+   * Should the password include numbers.
+   * @default true
+   */
+  numbers?: boolean
+  /**
+   * Should the password include symbol characters.
+   * @default false
+   */
+  symbols?: boolean
+  /**
+   * Characters to exclude from the password.
+   * @default ""
+   */
+  exclude?: string
+  /**
+   * Minimum number of lowercase characters. Forced to 0 when `lowercase` is false.
+   * @default 1 when `lowercase` is true, otherwise 0
+   */
+  minLengthLowercase?: number
+  /**
+   * Minimum number of uppercase characters. Forced to 0 when `uppercase` is false.
+   * @default 1 when `uppercase` is true, otherwise 0
+   */
+  minLengthUppercase?: number
+  /**
+   * Minimum number of numeric characters. Forced to 0 when `numbers` is false.
+   * @default 1 when `numbers` is true, otherwise 0
+   */
+  minLengthNumbers?: number
+  /**
+   * Minimum number of symbol characters. Forced to 0 when `symbols` is false.
+   * @default 1 when `symbols` is true, otherwise 0
+   */
+  minLengthSymbols?: number
+}
+
+/**
+ * Every option resolved to a concrete value by `processOption`.
+ */
+export type ResolvedOptions = Required<GenerateOptions>

package/dist/index.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GeneratePassword = void 0;
-const password_generator_1 = require("./lib/password-generator");
-const check_options_error_1 = require("./lib/check-options-error");
-const process_options_1 = require("./lib/process-options");
-function GeneratePassword(options) {
-    let pswd;
-    if (options) {
-        options = (0, process_options_1.processOption)(options);
-        (0, check_options_error_1.checkError)(options);
-        pswd = (0, password_generator_1.generatePswd)(options);
-        return pswd;
-    }
-    else {
-        let opt = {
-            length: 10,
-            lowercase: true,
-            uppercase: true,
-            numbers: true,
-            symbols: false,
-            exclude: "",
-            minLengthLowercase: 1,
-            minLengthUppercase: 1,
-            minLengthNumbers: 1,
-            minLengthSymbols: 0,
-        };
-        options = (0, process_options_1.processOption)(opt);
-        (0, check_options_error_1.checkError)(options);
-        pswd = (0, password_generator_1.generatePswd)(options);
-        return pswd;
-    }
-}
-exports.GeneratePassword = GeneratePassword;
-exports.default = { GeneratePassword };

package/dist/lib/check-options-error.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkError = void 0;
-const checkError = (options) => {
-    const { length, lowercase, uppercase, numbers, symbols, minLengthLowercase, minLengthUppercase, minLengthNumbers, minLengthSymbols, } = options;
-    //Checking if the sum of minimum characters of Lowercase, uppercase, numbers and special case is greater than the total password length.
-    if (minLengthLowercase +
-        minLengthUppercase +
-        minLengthNumbers +
-        minLengthSymbols >
-        length) {
-        throw new Error("Sum of Minimum Characters in the passwords greater than the length of the Password to be generated.");
-    }
-    //Checking if lowercase, uppercase , numbers and special characters have all been set to false.
-    if (lowercase == false &&
-        uppercase == false &&
-        numbers == false &&
-        symbols == false) {
-        throw new Error("Alphabets, Numbers and Symbols are all set to False. No valid Characters to generate the Password.");
-    }
-};
-exports.checkError = checkError;
-// module.exports = checkError;

package/dist/lib/generate-random-number.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateRandomNumbers = void 0;
-const generateRandomNumbers = (upperLimit) => {
-    return Math.floor(Math.random() * upperLimit);
-};
-exports.generateRandomNumbers = generateRandomNumbers;
-// module.exports = generateRandomNumbers;

package/dist/lib/password-generator.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatePswd = void 0;
-// const generategenerateRandomNumberss = require("./generate-random-number");
-// const shuffleString = require("./shuffle-string");
-const generate_random_number_1 = require("./generate-random-number");
-const shuffle_string_1 = require("./shuffle-string");
-const generatePswd = (options) => {
-    let pswd = "";
-    let minChar = "";
-    let { length, lowercase, uppercase, numbers, symbols, minLengthLowercase, minLengthUppercase, minLengthNumbers, minLengthSymbols, exclude, } = options;
-    let lowercaseChar = "abcdefghijklmnopqrstuvwxyz";
-    lowercaseChar = removeExceptions(lowercaseChar, exclude);
-    let uppercaseChar = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-    uppercaseChar = removeExceptions(uppercaseChar, exclude);
-    let numberChar = "0123456789";
-    numberChar = removeExceptions(numberChar, exclude);
-    let specialChar = "!#$%&'()*+,-./:;<=>?@[]^_{|}~";
-    specialChar = removeExceptions(specialChar, exclude);
-    //  Generating a minChar string that holds minimum number of characters on the User Option Selection.
-    // The minChar variable will store the minimum number of characters for each type - lowercase, uppercase, numbers, and symbols.
-    //  Then, the minChar variable is shuffled to make the password random.
-    let upperLimit = lowercaseChar.length;
-    for (let i = 0; i < minLengthLowercase; i++) {
-        minChar += lowercaseChar.charAt((0, generate_random_number_1.generateRandomNumbers)(upperLimit));
-    }
-    upperLimit = uppercaseChar.length;
-    for (let i = 0; i < minLengthUppercase; i++) {
-        minChar += uppercaseChar.charAt((0, generate_random_number_1.generateRandomNumbers)(upperLimit));
-    }
-    upperLimit = numberChar.length;
-    for (let i = 0; i < minLengthNumbers; i++) {
-        minChar += numberChar.charAt((0, generate_random_number_1.generateRandomNumbers)(upperLimit));
-    }
-    upperLimit = specialChar.length;
-    for (let i = 0; i < minLengthSymbols; i++) {
-        minChar += specialChar.charAt((0, generate_random_number_1.generateRandomNumbers)(upperLimit));
-    }
-    //Shuffling the minChar to generate a password that holds minimum criteria.
-    pswd = pswd + (0, shuffle_string_1.shuffleString)(minChar);
-    let characterString = "";
-    characterString = lowercase
-        ? characterString + lowercaseChar
-        : characterString;
-    characterString = uppercase
-        ? characterString + uppercaseChar
-        : characterString;
-    characterString = numbers ? characterString + numberChar : characterString;
-    characterString = symbols ? characterString + specialChar : characterString;
-    let remainingChar = length - pswd.length;
-    upperLimit = characterString.length;
-    for (let i = 0; i < remainingChar; i++) {
-        pswd += characterString.charAt((0, generate_random_number_1.generateRandomNumbers)(upperLimit));
-    }
-    return pswd;
-};
-exports.generatePswd = generatePswd;
-const removeExceptions = (str, EXCEPTIONS) => {
-    EXCEPTIONS === null || EXCEPTIONS === void 0 ? void 0 : EXCEPTIONS.split("").forEach((char) => {
-        str = str.replace(char, "");
-    });
-    return str;
-};
-// module.exports = generatePassword;

package/dist/lib/process-options.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processOption = void 0;
-const processOption = (options) => {
-    {
-        options.length = typeof options.length == "undefined" ? 10 : options.length;
-        options.lowercase =
-            typeof options.lowercase == "undefined" ? true : options.lowercase;
-        options.uppercase =
-            typeof options.uppercase == "undefined" ? true : options.uppercase;
-        options.numbers =
-            typeof options.numbers == "undefined" ? true : options.numbers;
-        options.symbols =
-            typeof options.symbols == "undefined" ? false : options.symbols;
-        if (options.lowercase) {
-            options.minLengthLowercase =
-                typeof options.minLengthLowercase == "undefined"
-                    ? 1
-                    : options.minLengthLowercase;
-        }
-        else {
-            options.minLengthLowercase = 0;
-        }
-        if (options.uppercase) {
-            options.minLengthUppercase =
-                typeof options.minLengthUppercase == "undefined"
-                    ? 1
-                    : options.minLengthUppercase;
-        }
-        else {
-            options.minLengthUppercase = 0;
-        }
-        if (options.numbers) {
-            options.minLengthNumbers =
-                typeof options.minLengthNumbers == "undefined"
-                    ? 1
-                    : options.minLengthNumbers;
-        }
-        else {
-            options.minLengthNumbers = 0;
-        }
-        if (options.symbols) {
-            options.minLengthSymbols =
-                typeof options.minLengthSymbols == "undefined"
-                    ? 1
-                    : options.minLengthSymbols;
-        }
-        else {
-            options.minLengthSymbols = 0;
-        }
-        options.exclude =
-            typeof options.exclude == "undefined" ? "" : options.exclude;
-    }
-    return options;
-};
-exports.processOption = processOption;
-// module.exports = processOption;

package/dist/lib/shuffle-string.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.shuffleString = void 0;
-const shuffleString = (str) => {
-    let arr = str.split("");
-    let n = arr.length;
-    for (let i = n - 1; i > 0; i--) {
-        let j = Math.floor(Math.random() * (i + 1));
-        let tmp = arr[i];
-        arr[i] = arr[j];
-        arr[j] = tmp;
-    }
-    return arr.join("");
-};
-exports.shuffleString = shuffleString;
-// module.exports = shuffleString;

package/dist/lib/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/index.d.ts

@@ -1,58 +0,0 @@
-export interface GenerateOptions {
-  /**
-   * lenght of the password
-   * @default 10
-   */
-  length?: number;
-  /**
-   * Should the password include lowercase characters
-   * @default true
-   */
-  lowercase?: boolean;
-  /**
-   * Should the password include uppercase characters
-   * @default true
-   */
-  uppercase?: boolean;
-  /**
-   * Should the password include numbers
-   * @default true
-   */
-  numbers?: boolean;
-  /**
-   * Should the password include symbol characters
-   * @default false
-   */
-  symbols?: boolean;
-  /**
-   * List of characters to be excluded from the password
-   * @default ""
-   */
-  exclude?: string;
-  /**
-   * min lentgh of lowercase character
-   * @default 1
-   */
-  minLengthLowercase?: number;
-  /**
-   * min lentgh of uppercase character
-   * @default 1
-   */
-  minLengthUppercase?: number;
-  /**
-   * min length of numbers
-   * @default 1
-   */
-  minLengthNumbers?: number;
-  /**
-   * min length of symbols
-   * @default 0
-   */
-  minLengthSymbols?: number;
-}
-
-declare namespace GeneratePassword {}
-
-declare function GeneratePassword(options?: GenerateOptions): string;
-
-export { GeneratePassword };

package/src/lib/types.ts

@@ -1,52 +0,0 @@
-export interface GenerateOptions {
-  /**
-   * lenght of the password
-   * @default 10
-   */
-  length?: number;
-  /**
-   * Should the password include lowercase characters
-   * @default true
-   */
-  lowercase?: boolean;
-  /**
-   * Should the password include uppercase characters
-   * @default true
-   */
-  uppercase?: boolean;
-  /**
-   * Should the password include numbers
-   * @default true
-   */
-  numbers?: boolean;
-  /**
-   * Should the password include symbol characters
-   * @default false
-   */
-  symbols?: boolean;
-  /**
-   * List of characters to be excluded from the password
-   * @default ""
-   */
-  exclude?: string;
-  /**
-   * min lentgh of lowercase character
-   * @default 1
-   */
-  minLengthLowercase?: number;
-  /**
-   * min lentgh of uppercase character
-   * @default 1
-   */
-  minLengthUppercase?: number;
-  /**
-   * min length of numbers
-   * @default 1
-   */
-  minLengthNumbers?: number;
-  /**
-   * min length of symbols
-   * @default 0
-   */
-  minLengthSymbols?: number;
-}