@nauth-toolkit/nestjs 0.2.1 → 0.2.2

package/README.md

@@ -4,6 +4,12 @@ NestJS module for [nauth-toolkit](https://nauth.dev) — the embedded authentica
 
 Provides a `DynamicModule` with `forRoot()` / `forRootAsync()` that wires the nauth-toolkit core into NestJS dependency injection. Adds guards, decorators, and interceptors so authentication integrates with NestJS conventions.
 
+**[Documentation](https://nauth.dev/docs/quick-start/nestjs)** · **[API Reference](https://nauth.dev/docs/api/nestjs/overview)** · **[GitHub](https://github.com/noorixorg/nauth)**
+
+> Part of [nauth-toolkit](https://www.npmjs.com/package/@nauth-toolkit/core). Requires `@nauth-toolkit/core` and a database package.
+
+---
+
 ## What's included
 
 - **AuthModule** — `forRoot()` and `forRootAsync()` registration with full config support
@@ -12,6 +18,111 @@ Provides a `DynamicModule` with `forRoot()` / `forRootAsync()` that wires the na
 - **Interceptors** — context management and cookie-based token delivery
 - **Auto-registration** — MFA and social providers are discovered and registered at bootstrap
 
-Requires `@nauth-toolkit/core` and a database adapter (e.g. `@nauth-toolkit/database-typeorm-postgres`). Add storage, email, SMS, MFA, and social providers as needed.
+---
+
+## Install
+
+```bash
+npm install @nauth-toolkit/core @nauth-toolkit/nestjs \
+  @nauth-toolkit/database-typeorm-postgres \
+  @nauth-toolkit/storage-database \
+  @nauth-toolkit/email-console \
+  @nauth-toolkit/sms-console
+# Or for MySQL: replace database-typeorm-postgres with database-typeorm-mysql
+```
+
+---
+
+## Quick start
+
+```typescript
+// auth.module.ts
+import { Module } from '@nestjs/common';
+import { AuthModule as NAuthModule } from '@nauth-toolkit/nestjs';
+
+@Module({
+  imports: [NAuthModule.forRoot(authConfig)],
+  controllers: [AuthController],
+})
+export class AuthModule {}
+```
+
+```typescript
+// auth.controller.ts
+import { AuthService, SignupDTO, LoginDTO, AuthGuard, Public, CurrentUser, IUser } from '@nauth-toolkit/nestjs';
+
+@UseGuards(AuthGuard)
+@Controller('auth')
+export class AuthController {
+  constructor(private authService: AuthService) {}
+
+  @Public()
+  @Post('signup')
+  @HttpCode(201)
+  signup(@Body() dto: SignupDTO) {
+    return this.authService.signup(dto);
+  }
+
+  @Public()
+  @Post('login')
+  login(@Body() dto: LoginDTO) {
+    return this.authService.login(dto);
+  }
+
+  @Get('me')
+  profile(@CurrentUser() user: IUser) {
+    return user;
+  }
+}
+```
+
+Full guide: [nauth.dev/docs/quick-start/nestjs](https://nauth.dev/docs/quick-start/nestjs)
+
+---
+
+## Adding providers
+
+MFA and social providers auto-register when imported into your module:
+
+```typescript
+import { TOTPMFAModule } from '@nauth-toolkit/mfa-totp/nestjs';
+import { GoogleSocialAuthModule } from '@nauth-toolkit/social-google/nestjs';
+
+@Module({
+  imports: [
+    NAuthModule.forRoot(authConfig),
+    TOTPMFAModule,
+    GoogleSocialAuthModule,
+  ],
+})
+export class AuthModule {}
+```
+
+---
+
+## Related packages
+
+| Package | Purpose |
+| --- | --- |
+| [`@nauth-toolkit/core`](https://www.npmjs.com/package/@nauth-toolkit/core) | Auth engine — required peer dependency |
+| [`@nauth-toolkit/database-typeorm-postgres`](https://www.npmjs.com/package/@nauth-toolkit/database-typeorm-postgres) | PostgreSQL entities |
+| [`@nauth-toolkit/database-typeorm-mysql`](https://www.npmjs.com/package/@nauth-toolkit/database-typeorm-mysql) | MySQL entities |
+| [`@nauth-toolkit/mfa-totp`](https://www.npmjs.com/package/@nauth-toolkit/mfa-totp) | TOTP authenticator apps |
+| [`@nauth-toolkit/social-google`](https://www.npmjs.com/package/@nauth-toolkit/social-google) | Google OAuth |
+
+See the [full package list](https://www.npmjs.com/package/@nauth-toolkit/core#package-ecosystem) in the core README.
+
+---
+
+## Documentation
+
+| Resource | Link |
+| --- | --- |
+| NestJS quick start | [nauth.dev/docs/quick-start/nestjs](https://nauth.dev/docs/quick-start/nestjs) |
+| Configuration | [nauth.dev/docs/concepts/configuration](https://nauth.dev/docs/concepts/configuration) |
+| API reference | [nauth.dev/docs/api/overview](https://nauth.dev/docs/api/overview) |
+| Example app | [github.com/noorixorg/nauth/examples/nestjs](https://github.com/noorixorg/nauth/tree/main/examples/nestjs) |
+
+---
 
-**Docs:** [nauth.dev](https://nauth.dev) · **Examples:** [github.com/noorixorg/nauth](https://github.com/noorixorg/nauth) · **Live demo:** [demo.nauth.dev](https://demo.nauth.dev)
+Free to use. See [license](https://nauth.dev/docs/license).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nauth-toolkit/nestjs",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "NestJS module for nauth-toolkit — guards, decorators, interceptors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -44,7 +44,7 @@
     "typeorm": "^0.3.0"
   },
   "dependencies": {
-    "@nauth-toolkit/core": "^0.2.1"
+    "@nauth-toolkit/core": "^0.2.2"
   },
   "devDependencies": {
     "@nestjs/common": "^11.1.8",