@tushardev01/farm-password 1.0.7 → 1.0.8

package/README.md

@@ -1,105 +1,105 @@
-# farm-password
-
-A simple password generator for Node.js with handy character arrays and CLI support.  
-Generates secure random passwords using lowercase, uppercase, numbers, and symbols.
-
-## Package Information
-
-🔗 **npm Package**: [https://www.npmjs.com/package/@tushardev01/farm-password](https://www.npmjs.com/package/@tushardev01/farm-password)
-
----
-
-## Features
-
-- Generate passwords of custom length
-- Built-in arrays: lowercase letters, uppercase letters, numbers, symbols
-- Shuffle characters from multiple arrays
-- CLI support (`genpass`)
-- TypeScript typings included
-
----
-
-## Installation
-
-```bash
-npm install @tushardev01/farm-password
-```
-
-# Usage (JavaScript / ESM)
-```bash
-import { genPassword, shuffleMax, genLowerLetters, genUpperLetters, genNumbers, genSymbols, randomNumIn, shuffle } from '@tushardev01/farm-password';
-
-// Generate a password with default character sets
-const password1 = genPassword(16);
-console.log(password1); // Example: 'aB3@fGh1$Jk2LmN4'
-
-// Create a custom character array
-const customChars = [
-  genLowerLetters(),
-  genUpperLetters(),
-  genNumbers(),
-  genSymbols()
-];
-
-// Shuffle and pick 12 characters
-const shuffled = shuffle(shuffleMax(12, customChars)).join('');
-console.log(shuffled); // Example: '@B3a1C$dEfG2'
-```
-# CLI Usage
-
-After installing, you can run:
-```bash
-npx genpass
-# or, if installed globally
-genpass
-```
-This generates a password with default settings.
-
-### Functions
-
-```bash
-genPassword(charLength?: number): string
-    Generates a password using default arrays
-    charLength ΓÇô optional, default is 25
-
-shuffleMax(charLength?: number, lists: string[][]): string[]
-    Randomly picks characters from multiple character arrays
-    charLength ΓÇô optional, default 25
-    lists ΓÇô array of string arrays, e.g., [genLowerLetters(), genNumbers()]
-
-genLowerLetters(): string[]
-    Returns lowercase letters: ['a','b',...,'z']
-
-genUpperLetters(): string[]
-    Returns uppercase letters: ['A','B',...,'Z']
-
-genNumbers(): string[]
-    Returns numbers: ['0','1',...,'9']
-
-genSymbols(): string[]
-    Returns symbols: ['!','@','#','$','%','^','&','*','(',')']
-
-randomNumIn(x,y): number
-    Returns a random Number [x,y] i.e. including x,y and numbers in between
-
-shuffle(arr: any[],inPlace: boolean): any[]
-    Returns a new array or the same one with items shuffled
-```
-
-### TypeScript Support
-```bash
-import { genPassword, shuffleMax, shuffle, randomNumIn } from '@tushardev01/farm-password';
-
-const password: string = genPassword(16);
-const chars: string[] = shuffleMax(12, [
-  genLowerLetters(),
-  genNumbers(),
-]);
-```
-
-Types are included automatically via index.d.ts.
-
-### License
-
-ISC © Tushar Kumar
-
+# farm-password
+
+A simple password generator for Node.js with handy character arrays and CLI support.  
+Generates secure random passwords using lowercase, uppercase, numbers, and symbols.
+
+## Package Information
+
+🔗 **npm Package**: [https://www.npmjs.com/package/@tushardev01/farm-password](https://www.npmjs.com/package/@tushardev01/farm-password)
+
+---
+
+## Features
+
+- Generate passwords of custom length
+- Built-in arrays: lowercase letters, uppercase letters, numbers, symbols
+- Shuffle characters from multiple arrays
+- CLI support (`genpass`)
+- TypeScript typings included
+
+---
+
+## Installation
+
+```bash
+npm install @tushardev01/farm-password
+```
+
+# Usage (JavaScript / ESM)
+```bash
+import { genPassword, shuffleMax, genLowerLetters, genUpperLetters, genNumbers, genSymbols, randomNumIn, shuffle } from '@tushardev01/farm-password';
+
+// Generate a password with default character sets
+const password1 = genPassword(16);
+console.log(password1); // Example: 'aB3@fGh1$Jk2LmN4'
+
+// Create a custom character array
+const customChars = [
+  genLowerLetters(),
+  genUpperLetters(),
+  genNumbers(),
+  genSymbols()
+];
+
+// Shuffle and pick 12 characters
+const shuffled = shuffle(shuffleMax(12, customChars)).join('');
+console.log(shuffled); // Example: '@B3a1C$dEfG2'
+```
+# CLI Usage
+
+After installing, you can run:
+```bash
+npx genpass
+# or, if installed globally
+genpass
+```
+This generates a password with default settings.
+
+### Functions
+
+```bash
+genPassword(charLength?: number): string
+    Generates a password using default arrays
+    charLength ΓÇô optional, default is 25
+
+shuffleMax(charLength?: number, lists: string[][]): string[]
+    Randomly picks characters from multiple character arrays
+    charLength ΓÇô optional, default 25
+    lists ΓÇô array of string arrays, e.g., [genLowerLetters(), genNumbers()]
+
+genLowerLetters(): string[]
+    Returns lowercase letters: ['a','b',...,'z']
+
+genUpperLetters(): string[]
+    Returns uppercase letters: ['A','B',...,'Z']
+
+genNumbers(): string[]
+    Returns numbers: ['0','1',...,'9']
+
+genSymbols(): string[]
+    Returns symbols: ['!','@','#','$','%','^','&','*','(',')']
+
+randomNumIn(x,y): number
+    Returns a random Number [x,y] i.e. including x,y and numbers in between
+
+shuffle(arr: any[],inPlace: boolean): any[]
+    Returns a new array or the same one with items shuffled
+```
+
+### TypeScript Support
+```bash
+import { genPassword, shuffleMax, shuffle, randomNumIn } from '@tushardev01/farm-password';
+
+const password: string = genPassword(16);
+const chars: string[] = shuffleMax(12, [
+  genLowerLetters(),
+  genNumbers(),
+]);
+```
+
+Types are included automatically via index.d.ts.
+
+### License
+
+ISC © Tushar Kumar
+

package/index.d.ts

@@ -1,52 +1,60 @@
 /**
- * Generates an array of lowercase letters
+ * Generates an array of lowercase alphabetic characters ('a' to 'z').
+ * @returns {string[]} An array containing all lowercase letters.
  */
 export function genLowerLetters(): string[];
 
 /**
- * Generates an array of uppercase letters
+ * Generates an array of uppercase alphabetic characters ('A' to 'Z').
+ * @returns {string[]} An array containing all uppercase letters.
  */
 export function genUpperLetters(): string[];
 
 /**
- * Generates an array of numeric characters
+ * Generates an array of numeric characters ('0' to '9').
+ * @returns {string[]} An array containing all digits from 0 to 9.
  */
 export function genNumbers(): string[];
 
 /**
- * Generates an array of symbol characters
+ * Generates an array of common symbol characters (from ASCII code 33 to 46).
+ * @returns {string[]} An array containing common symbols like '!', '"', '#', etc.
  */
 export function genSymbols(): string[];
 
 /**
- * Generates a random number within a specified range (inclusive)
- * @param x Lower bound
- * @param y Upper bound
+ * Generates a random number between two given values, inclusive.
+ * @param {number} x The lower bound.
+ * @param {number} y The upper bound.
+ * @returns {number} A random number between x and y, inclusive.
  */
 export const randomNumIn: (x: number, y: number) => number;
 
 /**
- * Shuffles an array, with option for in-place modification
- * @param arr Array to shuffle
- * @param inPlace Whether to modify the original array
+ * Shuffles an array, with option for in-place modification.
+ * @param {T[]} arr The array to shuffle.
+ * @param {boolean} [inPlace=false] Whether to modify the original array or return a new one. Default is false.
+ * @returns {T[]} The shuffled array. If `inPlace` is false, returns a new shuffled array. Otherwise, modifies the original array.
  */
 export const shuffle: <T>(arr: T[], inPlace?: boolean) => T[];
 
 /**
- * Randomly picks characters from multiple character lists
- * @param charLength Length of the resulting character array
- * @param lists Array of character arrays
+ * Randomly picks characters from multiple character lists and returns a shuffled array of characters.
+ * @param {number} [charLength=25] The number of characters to generate.
+ * @param {string[][]} lists An array of arrays containing character lists (e.g., letters, symbols, numbers).
+ * @returns {string[]} A shuffled array of randomly picked characters from the provided lists.
  */
 export function shuffleMax(
   charLength?: number,
-  lists?: string[][]
+  lists?: string[][] 
 ): string[];
 
 /**
- * Generate a password using default character lists
- * @param charLength Length of the password
+ * Generates a password by randomly selecting characters from predefined lists (lowercase, uppercase, symbols, numbers),
+ * then shuffling them to create a secure, random password.
+ * @param {number} [charLength=25] The length of the password to generate. Default is 25 characters.
+ * @returns {string} The generated random password.
  */
 export function genPassword(
   charLength?: number
 ): string;
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tushardev01/farm-password",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "type": "module",
   "main": "./app.js",
   "exports": {

package/utility.js

@@ -1,60 +1,90 @@
-
-export const genLowerLetters=()=>{
-	return Array.from({length:26},(_,i)=>String.fromCharCode(i+97));
-
-}
-
-export const genUpperLetters=()=>{
-        return Array.from({length:26},(_,i)=>String.fromCharCode(i+65));
-
-}
-
-export const genSymbols=()=>{
-        return Array.from({length:14},(_,i)=>String.fromCharCode(i+33));
-
-}
-export const genNumbers=()=>{
-        return Array(10).fill(10).map((_,i)=>i)
-
-}
-
-export const randomNumIn=(x,y)=>{
-        return x+Math.round(Math.random()*(y-x));
-
-}
-
-export const shuffle=(arr,inPlace=false)=>{
-        const arrLength=arr.length;
-        if(!inPlace){
-                const protoArr=[...arr];
-                arr=protoArr;
+/**
+ * Generates an array of lowercase alphabetic characters ('a' to 'z').
+ * @returns {string[]} An array containing all lowercase letters.
+ */
+export const genLowerLetters = () => {
+        return Array.from({ length: 26 }, (_, i) => String.fromCharCode(i + 97));
+};
+
+/**
+ * Generates an array of uppercase alphabetic characters ('A' to 'Z').
+ * @returns {string[]} An array containing all uppercase letters.
+ */
+export const genUpperLetters = () => {
+        return Array.from({ length: 26 }, (_, i) => String.fromCharCode(i + 65));
+};
+
+/**
+ * Generates an array of common symbol characters (from ASCII code 33 to 46).
+ * @returns {string[]} An array containing common symbols like '!', '"', '#', etc.
+ */
+export const genSymbols = () => {
+        return Array.from({ length: 14 }, (_, i) => String.fromCharCode(i + 33));
+};
+
+/**
+ * Generates an array of numeric characters ('0' to '9').
+ * @returns {number[]} An array containing all digits from 0 to 9.
+ */
+export const genNumbers = () => {
+        return Array(10).fill(10).map((_, i) => i);
+};
+
+/**
+ * Generates a random number between two given values, inclusive.
+ * @param {number} x The lower bound.
+ * @param {number} y The upper bound.
+ * @returns {number} A random number between x and y, inclusive.
+ */
+export const randomNumIn = (x, y) => {
+        return x + Math.round(Math.random() * (y - x));
+};
+
+/**
+ * Shuffles an array in place or returns a new shuffled array.
+ * @param {Array} arr The array to shuffle.
+ * @param {boolean} [inPlace=false] Whether to modify the original array or return a new one. Default is false.
+ * @returns {Array} The shuffled array. If `inPlace` is false, returns a new shuffled array. Otherwise, modifies the original array.
+ */
+export const shuffle = (arr, inPlace = false) => {
+        const arrLength = arr.length;
+        if (!inPlace) {
+                const protoArr = [...arr];
+                arr = protoArr;
         }
-        for(let i=arrLength-1;i>=0;i--){
-                const j=randomNumIn(0,i);
-                [arr[i],arr[j]]=[arr[j],arr[i]];
+        for (let i = arrLength - 1; i >= 0; i--) {
+                const j = randomNumIn(0, i);
+                [arr[i], arr[j]] = [arr[j], arr[i]];
         }
-        if(!inPlace){
+        if (!inPlace) {
                 return arr;
         }
-}
-
-
-export const shuffleMax=(charLength=25,lists)=>{
-	const arr=[];
-	for (let i=0;i<charLength;i++){
-		const randomListNumber=Math.floor(Math.random()*lists.length);
-		const randomLst=lists[randomListNumber];
-
-		const randomNumber=Math.floor(Math.random()*randomLst.length);
-		arr.push(randomLst[randomNumber]);
-	}
-
-	return arr;
-
-}
-
-const passLists=[genLowerLetters(),genNumbers(),genSymbols(),genUpperLetters()];
-export const genPassword=(charLength=25)=>{
-	const password=shuffle(shuffleMax(charLength,passLists)).join('');
-	return password;
-}
+};
+
+/**
+ * Selects random characters from multiple lists and returns a shuffled array of characters.
+ * @param {number} [charLength=25] The number of characters to generate.
+ * @param {string[][]} lists An array of arrays containing character lists (e.g., letters, symbols, numbers).
+ * @returns {string[]} A shuffled array of randomly picked characters from the provided lists.
+ */
+export const shuffleMax = (charLength = 25, lists) => {
+        const arr = [];
+        for (let i = 0; i < charLength; i++) {
+                const randomListNumber = Math.floor(Math.random() * lists.length);
+                const randomLst = lists[randomListNumber];
+                const randomNumber = Math.floor(Math.random() * randomLst.length);
+                arr.push(randomLst[randomNumber]);
+        }
+        return arr;
+};
+
+/**
+ * Generates a password by randomly selecting characters from predefined lists (lowercase, uppercase, symbols, numbers),
+ * then shuffling them to create a secure, random password.
+ * @param {number} [charLength=25] The length of the password to generate. Default is 25 characters.
+ * @returns {string} The generated random password.
+ */
+export const genPassword = (charLength = 25) => {
+        const password = shuffle(shuffleMax(charLength, passLists)).join('');
+        return password;
+};