passlens 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +94 -0
  2. package/package.json +2 -1
  3. package/.env +0 -1
package/README.md ADDED
@@ -0,0 +1,94 @@
1
+ # PassLens 🔍
2
+
3
+ A lightweight password strength analyzer built with TypeScript. PassLens evaluates password security by checking multiple factors and returns a strength score, validation status, and improvement suggestions.
4
+
5
+ ## Features
6
+
7
+ - ✅ Password strength scoring
8
+ - ✅ Detects weak passwords
9
+ - ✅ Checks password complexity
10
+ - ✅ Provides security feedback
11
+ - ✅ TypeScript support
12
+ - ✅ Easy integration into Node.js projects
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install passlens
18
+ ```
19
+
20
+ ## Usage
21
+
22
+ ### JavaScript
23
+
24
+ ```javascript
25
+ const { checkPassword } = require("passlens");
26
+
27
+ const result = checkPassword("MySecurePassword123!");
28
+
29
+ console.log(result);
30
+ ```
31
+
32
+ ### TypeScript
33
+
34
+ ```typescript
35
+ import { checkPassword } from "passlens";
36
+
37
+ const result = checkPassword("MySecurePassword123!");
38
+
39
+ console.log(result);
40
+ ```
41
+
42
+ ## Example Output
43
+
44
+ ```json
45
+ {
46
+ "score": 5,
47
+ "strength": "very-strong",
48
+ "valid": true,
49
+ "issues": []
50
+ }
51
+ ```
52
+
53
+ ## API
54
+
55
+ ### `checkPassword(password)`
56
+
57
+ Analyzes a password and returns:
58
+
59
+ | Property | Description |
60
+ | ---------- | --------------------------------------- |
61
+ | `score` | Password strength score |
62
+ | `strength` | Strength level |
63
+ | `valid` | Whether the password meets requirements |
64
+ | `issues` | List of detected weaknesses |
65
+
66
+ ## Development
67
+
68
+ Clone the repository:
69
+
70
+ ```bash
71
+ git clone <your-repository-url>
72
+ ```
73
+
74
+ Install dependencies:
75
+
76
+ ```bash
77
+ npm install
78
+ ```
79
+
80
+ Build the package:
81
+
82
+ ```bash
83
+ npm run build
84
+ ```
85
+
86
+ ## Tech Stack
87
+
88
+ - TypeScript
89
+ - Node.js
90
+ - npm
91
+
92
+ ## License
93
+
94
+ MIT License
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "passlens",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "description": "",
5
5
  "main": "index.js",
6
+ "readme": "README.md",
6
7
  "scripts": {
7
8
  "dev": "tsx watch src/index.ts",
8
9
  "build": "tsc",
package/.env DELETED
@@ -1 +0,0 @@
1
- PORT=8000