@andrewthecoder/secure-password-generator 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andrew S Erwin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# Secure Password Generator
+
+A secure password generator written in TypeScript that generates cryptographically strong random passwords.
+
+## Installation
+
+```bash
+npm install @andrewthecoder/secure-password-generator
+```
+
+## Usage
+
+```typescript
+import { generate } from '@andrewthecoder/secure-password-generator';
+
+// Generate a password between 8 and 12 characters
+const password = generate(8, 12);
+console.log(password);
+```
+
+## Features
+
+- Cryptographically secure random number generation
+- Configurable password length range
+- Unbiased character selection
+- Written in TypeScript with full type definitions
+- Comprehensive test suite
+
+## API
+
+### generate(minLength: number, maxLength: number): string
+
+Generates a random password with length between minLength and maxLength (inclusive).
+
+Parameters:
+
+- minLength: Minimum password length (must be >= 1)
+- maxLength: Maximum password length (must be >= minLength)
+
+Returns:
+
+- A random password string
+
+Throws:
+
+- PasswordGenerationError if parameters are invalid
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export declare class PasswordGenerationError extends Error {
+    constructor(message: string);
+}
+export declare function generate(minLength: number, maxLength: number): string;

package/dist/index.js

@@ -0,0 +1,35 @@
+import { randomBytes } from 'crypto';
+export class PasswordGenerationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'PasswordGenerationError';
+    }
+}
+export function generate(minLength, maxLength) {
+    // Input validation
+    if (minLength < 1)
+        throw new PasswordGenerationError('Minimum length must be at least 1');
+    if (maxLength < minLength)
+        throw new PasswordGenerationError('Maximum length must be greater than or equal to minimum length');
+    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*()-_=+,.?/:;{}[]`~';
+    // Generate random length between minLength and maxLength
+    const lengthRange = maxLength - minLength + 1;
+    const randomBytesForLength = randomBytes(4);
+    const length = minLength + (randomBytesForLength.readUInt32BE(0) % lengthRange);
+    // Calculate values needed for unbiased selection
+    const charLen = chars.length;
+    const maxrb = 256 - (256 % charLen);
+    let result = '';
+    // Generate password
+    while (result.length < length) {
+        const randomChunk = randomBytes(Math.ceil(length * 1.25)); // Get more bytes than needed to account for rejected values
+        for (const byte of randomChunk) {
+            if (byte >= maxrb)
+                continue; // Skip values that would bias the selection
+            result += chars[byte % charLen];
+            if (result.length === length)
+                break;
+        }
+    }
+    return result;
+}

package/jest.config.js

@@ -0,0 +1,16 @@
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@andrewthecoder/secure-password-generator",
+  "version": "0.1.2",
+  "description": "A secure password generator written in TypeScript",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "password",
+    "generator",
+    "typescript",
+    "security"
+  ],
+  "author": "Andrew S Erwin",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.0"
+  }
+}

package/src/__tests__/index.test.ts

@@ -0,0 +1,25 @@
+import { generate, PasswordGenerationError } from '../index.js';
+
+describe('Password Generator', () => {
+  test('generates password with correct length range', () => {
+    const minLength = 8;
+    const maxLength = 12;
+    const password = generate(minLength, maxLength);
+    expect(password.length).toBeGreaterThanOrEqual(minLength);
+    expect(password.length).toBeLessThanOrEqual(maxLength);
+  });
+
+  test('throws error for invalid minimum length', () => {
+    expect(() => generate(0, 10)).toThrow(PasswordGenerationError);
+  });
+
+  test('throws error when max length is less than min length', () => {
+    expect(() => generate(10, 5)).toThrow(PasswordGenerationError);
+  });
+
+  test('generates different passwords', () => {
+    const password1 = generate(10, 10);
+    const password2 = generate(10, 10);
+    expect(password1).not.toBe(password2);
+  });
+});

package/src/index.ts

@@ -0,0 +1,41 @@
+import { randomBytes } from 'crypto';
+
+export class PasswordGenerationError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'PasswordGenerationError';
+  }
+}
+
+export function generate(minLength: number, maxLength: number): string {
+  // Input validation
+  if (minLength < 1) throw new PasswordGenerationError('Minimum length must be at least 1');
+  if (maxLength < minLength) throw new PasswordGenerationError('Maximum length must be greater than or equal to minimum length');
+
+  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*()-_=+,.?/:;{}[]`~';
+
+  // Generate random length between minLength and maxLength
+  const lengthRange = maxLength - minLength + 1;
+  const randomBytesForLength = randomBytes(4);
+  const length = minLength + (randomBytesForLength.readUInt32BE(0) % lengthRange);
+
+  // Calculate values needed for unbiased selection
+  const charLen = chars.length;
+  const maxrb = 256 - (256 % charLen);
+
+  let result = '';
+
+  // Generate password
+  while (result.length < length) {
+    const randomChunk = randomBytes(Math.ceil(length * 1.25)); // Get more bytes than needed to account for rejected values
+
+    for (const byte of randomChunk) {
+      if (byte >= maxrb) continue; // Skip values that would bias the selection
+
+      result += chars[byte % charLen];
+      if (result.length === length) break;
+    }
+  }
+
+  return result;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/__tests__/*"
+  ]
+}