@tushardev01/farm-password 1.0.4 → 1.0.6

package/README.md

@@ -1,94 +1,94 @@
-# 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.
-
----
-
-## 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 } 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 = 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: ['!','@','#','$','%','^','&','*','(',')']
-```
-
-### TypeScript Support
-```bash
-import { genPassword, shuffleMax } from 'gen-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.
+
+---
+
+## 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 } 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 = 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: ['!','@','#','$','%','^','&','*','(',')']
+```
+
+### TypeScript Support
+```bash
+import { genPassword, shuffleMax } from 'gen-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/app.js

@@ -1,18 +1,23 @@
-#!/usr/bin/env node
-
-import {genLowerLetters,
-	genUpperLetters,
-	genNumbers,
-	genSymbols,
-	shuffleMax,
-	genPassword
-} from './utility.js';
-
-export{
-  genLowerLetters,
-  genUpperLetters,
-  genNumbers,
-  genSymbols,
-  shuffleMax,
-  genPassword
-};
+#!/usr/bin/env node
+
+import {genLowerLetters,
+	genUpperLetters,
+	genNumbers,
+	genSymbols,
+	shuffleMax,
+	genPassword,
+	randomNumIn,
+	shuffle,
+} from './utility.js';
+
+
+export{
+  genLowerLetters,
+  genUpperLetters,
+  genNumbers,
+  genSymbols,
+  shuffleMax,
+  genPassword,
+  randomNumIn,
+  shuffle
+};

package/index.d.ts

@@ -1,27 +1,52 @@
-export function genLowerLetters(): string[];
-export function genUpperLetters(): string[];
-export function genNumbers(): string[];
-export function genSymbols(): string[];
-
-/**
- * Randomly picks characters from multiple character lists
- *
- * @param charLength Length of the resulting character array
- * @param lists Array of character arrays
- * @returns Array of randomly selected characters
- */
-export function shuffleMax(
-  charLength?: number,
-  lists: string[][]
-): string[];
-
-/**
- * Generate a password using default character lists
- * (lowercase, uppercase, numbers, symbols)
- *
- * @param charLength Length of the password
- * @returns Generated password string
- */
-export function genPassword(
-  charLength?: number
-): string;
+/**
+ * Generates an array of lowercase letters
+ */
+export function genLowerLetters(): string[];
+
+/**
+ * Generates an array of uppercase letters
+ */
+export function genUpperLetters(): string[];
+
+/**
+ * Generates an array of numeric characters
+ */
+export function genNumbers(): string[];
+
+/**
+ * Generates an array of symbol characters
+ */
+export function genSymbols(): string[];
+
+/**
+ * Generates a random number within a specified range (inclusive)
+ * @param x Lower bound
+ * @param y Upper bound
+ */
+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
+ */
+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
+ */
+export function shuffleMax(
+  charLength?: number,
+  lists?: string[][]
+): string[];
+
+/**
+ * Generate a password using default character lists
+ * @param charLength Length of the password
+ */
+export function genPassword(
+  charLength?: number
+): string;
+

package/package.json

@@ -1,32 +1,36 @@
-{
-  "name": "@tushardev01/farm-password",
-  "version": "1.0.4",
-  "type": "module",
-  "main": "./app.js",
-  "exports": {
-    ".": "./app.js"
-  },
-  "bin": {
-    "genpass": "./app.js"
-  },
-  "types": "./index.d.ts",
-  "files": [
-    "app.js",
-    "utility.js",
-    "README.md",
-    "index.d.ts"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "password",
-    "password-generator",
-    "cli",
-    "security",
-    "generator"
-  ],
-  "author": "Tushar Kumar",
-  "license": "ISC",
-  "description": "Generates passwords and provides handy character arrays."
-}
+{
+  "name": "@tushardev01/farm-password",
+  "version": "1.0.6",
+  "type": "module",
+  "main": "./app.js",
+  "exports": {
+    ".": "./app.js"
+  },
+  "bin": {
+    "genpass": "./app.js"
+  },
+  "types": "./index.d.ts",
+  "files": [
+    "app.js",
+    "utility.js",
+    "README.md",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "password",
+    "password-generator",
+    "cli",
+    "security",
+    "generator"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TusharKumar1007/farm-password"
+  },
+  "author": "Tushar Kumar",
+  "license": "ISC",
+  "description": "Generates passwords and provides handy character arrays."
+}

package/utility.js

@@ -1,39 +1,60 @@
-
-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 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=shuffleMax(charLength,passLists).join('');
-	return password;
-}
+
+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;
+        }
+        for(let i=arrLength-1;i>=0;i--){
+                const j=randomNumIn(0,i);
+                [arr[i],arr[j]]=[arr[j],arr[i]];
+        }
+        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;
+}