nest-authme 1.0.0 → 1.1.0
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.
- package/README.md +39 -3
- package/dist/cli.js +645 -165
- package/dist/cli.js.map +1 -1
- package/dist/gui/gui.html +1095 -0
- package/dist/gui/index.d.ts +3 -0
- package/dist/gui/index.js +1515 -0
- package/dist/gui/index.js.map +1 -0
- package/dist/gui/orchestrator.d.ts +111 -0
- package/dist/gui/orchestrator.js +1046 -0
- package/dist/gui/orchestrator.js.map +1 -0
- package/dist/gui/server.d.ts +33 -0
- package/dist/gui/server.js +1510 -0
- package/dist/gui/server.js.map +1 -0
- package/dist/index.js +18 -1
- package/dist/index.js.map +1 -1
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -24,6 +24,7 @@ Stop writing the same authentication code for every NestJS project. Generate a c
|
|
|
24
24
|
- **Unit Tests** - Generated Jest tests for AuthService and AuthController
|
|
25
25
|
- **Custom Decorators** - `@Public()`, `@CurrentUser()`, `@Roles()`
|
|
26
26
|
- **Security Best Practices** - bcrypt, class-validator, secure defaults, crypto-random secrets
|
|
27
|
+
- **Web GUI Mode** - Optional browser-based visual interface with live preview and real-time progress
|
|
27
28
|
- **`--yes` Flag** - Skip prompts with sensible defaults
|
|
28
29
|
|
|
29
30
|
---
|
|
@@ -35,12 +36,23 @@ cd my-nestjs-app
|
|
|
35
36
|
npx nest-authme
|
|
36
37
|
```
|
|
37
38
|
|
|
38
|
-
|
|
39
|
+
You'll be asked to choose your interface:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
? Choose your interface:
|
|
43
|
+
❯ CLI — Terminal-based prompts
|
|
44
|
+
GUI — Web-based visual interface
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Or launch a specific mode directly:
|
|
39
48
|
|
|
40
49
|
```bash
|
|
41
|
-
npx nest-authme --yes
|
|
50
|
+
npx nest-authme --yes # CLI with sensible defaults
|
|
51
|
+
npx nest-authme --gui # Open web GUI in browser
|
|
42
52
|
```
|
|
43
53
|
|
|
54
|
+
### CLI Mode
|
|
55
|
+
|
|
44
56
|
```
|
|
45
57
|
🔐 NestJS Authentication Module Generator v1.3.2
|
|
46
58
|
|
|
@@ -73,6 +85,31 @@ npm run start:dev
|
|
|
73
85
|
|
|
74
86
|
---
|
|
75
87
|
|
|
88
|
+
## GUI Mode
|
|
89
|
+
|
|
90
|
+
Launch a visual web interface instead of terminal prompts:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npx nest-authme --gui
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
A local server starts and opens your browser automatically. The GUI provides:
|
|
97
|
+
|
|
98
|
+
1. **Project Detection** — Shows your NestJS version, ORM, and source root
|
|
99
|
+
2. **Visual Configuration** — Toggle switches, dropdowns, and checkboxes for all options
|
|
100
|
+
3. **File Preview** — Browse generated files with syntax highlighting before writing
|
|
101
|
+
4. **Real-Time Progress** — Watch each generation step complete live
|
|
102
|
+
5. **Success Summary** — API endpoints table, next steps, and generated file count
|
|
103
|
+
|
|
104
|
+
The server runs on `localhost` only (no external access) and auto-shuts down after generation completes.
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# Custom port
|
|
108
|
+
npx nest-authme --gui --port 4000
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
76
113
|
## API Endpoints
|
|
77
114
|
|
|
78
115
|
| Method | Endpoint | Auth | Description |
|
|
@@ -275,7 +312,6 @@ Check your database credentials in `.env` and ensure the database server is runn
|
|
|
275
312
|
- Session-based authentication
|
|
276
313
|
- Two-factor authentication (TOTP)
|
|
277
314
|
- Account lockout
|
|
278
|
-
- Admin panel UI
|
|
279
315
|
|
|
280
316
|
---
|
|
281
317
|
|