@ackplus/nest-auth 0.1.51 → 1.1.0

package/README.md

@@ -1,518 +1,11 @@
-# Nest Auth
+# nest-auth
 
-A comprehensive authentication module for NestJS applications.
+This library was generated with [Nx](https://nx.dev).
 
-## Table of Contents
+## Building
 
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Configuration](#configuration)
-- [Database Setup](#database-setup)
-- [Testing](#testing)
-- [Authentication Providers](#authentication-providers)
-- [API Documentation](#api-documentation)
-- [Contributing](#contributing)
-- [License](#license)
+Run `nx build nest-auth` to build the library.
 
-## Installation
+## Running unit tests
 
-```bash
-yarn add @ackplus/nest-auth
-```
-
-## Quick Start
-
-```typescript
-import { NestAuthModule } from '@ackplus/nest-auth';
-
-@Module({
-  imports: [
-    NestAuthModule.forRoot({
-      jwt: {
-        secret: 'your-secret-key',
-      },
-      emailAuth: {
-        enabled: true,
-      },
-      // ... other options
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-## Configuration
-
-### Basic Configuration
-
-```typescript
-import { NestAuthModule } from '@ackplus/nest-auth';
-
-@Module({
-  imports: [
-    NestAuthModule.forRoot({
-      jwt: {
-        secret: 'your-secret-key',
-        accessTokenExpiresIn: '15m',
-        refreshTokenExpiresIn: '7d',
-      },
-      emailAuth: {
-        enabled: true,
-      },
-      phoneAuth: {
-        enabled: false,
-      },
-      mfa: {
-        enabled: true,
-        allowUserToggle: true,
-      },
-      isGlobal: true,
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-### Async Configuration
-
-The module supports async configuration using three different approaches:
-
-#### Option 1: Using `useFactory`
-
-```typescript
-import { ConfigModule, ConfigService } from '@nestjs/config';
-import { NestAuthModule } from '@ackplus/nest-auth';
-
-@Module({
-  imports: [
-    ConfigModule.forRoot(),
-    NestAuthModule.forRootAsync({
-      imports: [ConfigModule],
-      useFactory: (configService: ConfigService) => ({
-        jwt: {
-          secret: configService.get<string>('JWT_SECRET'),
-          accessTokenExpiresIn: configService.get<string>('JWT_ACCESS_EXPIRES_IN', '15m'),
-          refreshTokenExpiresIn: configService.get<string>('JWT_REFRESH_EXPIRES_IN', '7d'),
-        },
-        emailAuth: {
-          enabled: configService.get<boolean>('EMAIL_AUTH_ENABLED', true),
-        },
-        phoneAuth: {
-          enabled: configService.get<boolean>('PHONE_AUTH_ENABLED', false),
-        },
-        isGlobal: true,
-      }),
-      inject: [ConfigService],
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-#### Option 2: Using `useClass`
-
-```typescript
-import { Injectable } from '@nestjs/common';
-import { ConfigService } from '@nestjs/config';
-import { NestAuthModule, AuthModuleOptionsFactory, AuthModuleOptions } from '@ackplus/nest-auth';
-
-@Injectable()
-export class AuthConfigFactory implements AuthModuleOptionsFactory {
-  constructor(private configService: ConfigService) {}
-
-  createAuthModuleOptions(): AuthModuleOptions {
-    return {
-      jwt: {
-        secret: this.configService.get<string>('JWT_SECRET'),
-        accessTokenExpiresIn: this.configService.get<string>('JWT_ACCESS_EXPIRES_IN', '15m'),
-        refreshTokenExpiresIn: this.configService.get<string>('JWT_REFRESH_EXPIRES_IN', '7d'),
-      },
-      emailAuth: {
-        enabled: this.configService.get<boolean>('EMAIL_AUTH_ENABLED', true),
-      },
-      phoneAuth: {
-        enabled: this.configService.get<boolean>('PHONE_AUTH_ENABLED', false),
-      },
-      mfa: {
-        enabled: this.configService.get<boolean>('MFA_ENABLED', false),
-      },
-      isGlobal: true,
-    };
-  }
-}
-
-@Module({
-  imports: [
-    ConfigModule.forRoot(),
-    NestAuthModule.forRootAsync({
-      imports: [ConfigModule],
-      useClass: AuthConfigFactory,
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-#### Option 3: Using `useExisting`
-
-```typescript
-// First, provide the factory in another module
-@Module({
-  imports: [ConfigModule],
-  providers: [AuthConfigFactory],
-  exports: [AuthConfigFactory],
-})
-export class AuthConfigModule {}
-
-// Then, use it in your app module
-@Module({
-  imports: [
-    AuthConfigModule,
-    NestAuthModule.forRootAsync({
-      imports: [AuthConfigModule],
-      useExisting: AuthConfigFactory,
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-### Database Configuration
-
-The module supports both PostgreSQL and SQLite databases. Configure your database connection using the `DATABASE_URL` environment variable:
-
-```bash
-# For PostgreSQL
-DATABASE_URL=postgresql://user:password@localhost:5432/dbname
-
-# For SQLite
-DATABASE_URL=:memory:  # For in-memory database
-DATABASE_URL=./database.sqlite  # For file-based database
-```
-
-### Environment Variables
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `DATABASE_URL` | Database connection URL | `:memory:` |
-| `NODE_ENV` | Application environment | `development` |
-| `JWT_SECRET` | JWT signing secret | `secret` |
-| `JWT_ACCESS_EXPIRES_IN` | Access token expiration | `15m` |
-| `JWT_REFRESH_EXPIRES_IN` | Refresh token expiration | `7d` |
-| `EMAIL_AUTH_ENABLED` | Enable email authentication | `true` |
-| `PHONE_AUTH_ENABLED` | Enable phone authentication | `false` |
-| `MFA_ENABLED` | Enable multi-factor authentication | `false` |
-
-### Module Options
-
-```typescript
-interface AuthModuleOptions {
-  isGlobal?: boolean;
-  jwt: {
-    secret: string;
-    accessTokenExpiresIn?: string | number;
-    refreshTokenExpiresIn?: string | number;
-  };
-  emailAuth?: {
-    enabled: boolean;
-  };
-  phoneAuth?: {
-    enabled: boolean;
-  };
-  mfa?: {
-    enabled: boolean;
-    allowUserToggle?: boolean;
-    allowMethodSelection?: boolean;
-    otpLength?: number;
-    otpExpiresIn?: string | number;
-  };
-  google?: {
-    clientId: string;
-    clientSecret: string;
-    redirectUri: string;
-  };
-  facebook?: {
-    appId: string;
-    appSecret: string;
-    redirectUri: string;
-  };
-  apple?: {
-    clientId: string;
-    teamId: string;
-    keyId: string;
-    privateKey: string;
-    redirectUri: string;
-  };
-  // ... other options
-}
-```
-
-## Database Setup
-
-### PostgreSQL
-
-1. Create a new database:
-```sql
-CREATE DATABASE your_database;
-```
-
-2. Run migrations:
-```bash
-yarn typeorm migration:run -d src/typeorm.config.ts
-```
-
-### SQLite
-
-No setup required. The database will be created automatically.
-
-## Testing
-
-### Local Development
-
-1. For PostgreSQL:
-```bash
-DATABASE_URL=postgresql://user:password@localhost:5432/testdb yarn test
-```
-
-2. For SQLite:
-```bash
-DATABASE_URL=:memory: yarn test
-```
-
-### CI/CD (GitHub Actions)
-
-The tests run automatically in GitHub Actions using SQLite for faster execution. No additional setup required.
-
-## Authentication Providers
-
-### Email Authentication
-
-```typescript
-@Post('login')
-async login(@Body() loginDto: LoginRequestDto) {
-  return this.authService.login({
-    providerId: 'email',
-    credentials: {
-      email: loginDto.email,
-      password: loginDto.password,
-    },
-  });
-}
-```
-
-### Phone Authentication
-
-```typescript
-@Post('login')
-async login(@Body() loginDto: LoginRequestDto) {
-  return this.authService.login({
-    providerId: 'phone',
-    credentials: {
-      phone: loginDto.phone,
-      password: loginDto.password,
-    },
-  });
-}
-```
-
-## API Documentation
-
-### Authentication Endpoints
-
-| Endpoint | Method | Description |
-|----------|--------|-------------|
-| `/auth/login` | POST | Login with credentials |
-| `/auth/register` | POST | Register new user |
-| `/auth/refresh` | POST | Refresh access token |
-| `/auth/logout` | POST | Logout user |
-
-### Request/Response Examples
-
-#### Login Request
-```json
-{
-  "providerId": "email",
-  "credentials": {
-    "email": "user@example.com",
-    "password": "password123"
-  }
-}
-```
-
-#### Login Response
-```json
-{
-  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
-  "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
-  "isRequiresMfa": false
-}
-```
-
-## Contributing
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-### Development Setup
-
-1. Clone the repository
-2. Install dependencies:
-```bash
-yarn install
-```
-
-3. Set up the database:
-```bash
-# For PostgreSQL
-DATABASE_URL=postgresql://user:password@localhost:5432/testdb
-
-# For SQLite
-DATABASE_URL=:memory:
-```
-
-4. Run tests:
-```bash
-yarn test
-```
-
-### Testing Guidelines
-
-- Write tests for all new features
-- Ensure tests pass in both PostgreSQL and SQLite
-- Follow the existing test patterns
-- Use appropriate test fixtures
-
-## Default Tenant Configuration
-
-The nest-auth package supports automatic default tenant creation and usage. When configured, a default tenant will be created during module initialization and used when no explicit tenant ID is provided.
-
-### Basic Configuration
-
-```typescript
-NestAuthModule.forRoot({
-  jwt: { secret: 'your-secret' },
-  defaultTenant: {
-    name: 'My Default Organization',
-    domain: 'default_example', // Required
-    description: 'Default tenant', // Optional
-    metadata: { plan: 'basic' }    // Optional
-  },
-  // ... other options
-})
-```
-
-### Benefits
-
-- **Simplified single-tenant apps**: Start with one tenant, expand to multi-tenant later
-- **Automatic tenant resolution**: No need to specify tenant ID in auth operations
-- **Backward compatibility**: Existing apps can add this without breaking changes
-
-For detailed examples and configuration options, see the Default Tenant Configuration section above.
-
-## Debug Logging
-
-The nest-auth package includes comprehensive debug logging to help you troubleshoot issues during development. Debug logging is configurable and can provide detailed insights into authentication flows, user operations, and more.
-
-### Enable Debug Logging
-
-```typescript
-NestAuthModule.forRoot({
-  jwt: { secret: 'your-secret' },
-  debug: {
-    enabled: true,
-    level: 'debug', // 'error' | 'warn' | 'info' | 'debug' | 'verbose'
-    prefix: '[NestAuth]',
-    includeTimestamp: true,
-    includeContext: true
-  },
-  // ... other options
-})
-```
-
-### Debug Configuration Options
-
-- **`enabled`** (default: `false`): Enable/disable debug logging
-- **`level`** (default: `'info'`): Log level - controls which messages are shown
-- **`prefix`** (default: `'[NestAuth]'`): Prefix for all log messages
-- **`includeTimestamp`** (default: `true`): Include timestamp in log messages
-- **`includeContext`** (default: `true`): Include context (service name) in log messages
-
-### Log Levels
-
-- **`error`**: Only error messages
-- **`warn`**: Errors and warnings
-- **`info`**: Errors, warnings, and info messages
-- **`debug`**: All above plus debug messages
-- **`verbose`**: All messages including verbose debugging
-
-### What Gets Logged
-
-With debug logging enabled, you'll see detailed information about:
-
-#### User Operations
-- User creation attempts and results
-- User lookup operations
-- Identity creation and linking
-- User validation steps
-
-#### Authentication Operations
-- Login attempts with provider information
-- Signup processes step-by-step
-- Token generation and validation
-- Session creation and management
-- MFA verification processes
-
-#### Tenant Operations
-- Default tenant resolution
-- Tenant creation and lookup
-- Multi-tenant routing decisions
-
-#### Error Handling
-- Detailed error contexts with stack traces
-- Input data that caused errors (sensitive data masked)
-- Operation states when errors occurred
-
-### Example Debug Output
-
-```
-[NestAuth] [2024-01-15T10:30:45.123Z] [AuthService] Entering function: signup | Data: {
-  "params": {
-    "email": "user@example.com",
-    "hasPassword": true
-  }
-}
-
-[NestAuth] [2024-01-15T10:30:45.125Z] [AuthService] Auth Operation: signup | Data: {
-  "operation": "signup",
-  "providerId": "email|phone",
-  "email": "user@example.com",
-  "resolvedTenantId": "tenant-123"
-}
-
-[NestAuth] [2024-01-15T10:30:45.127Z] [UserService] User Operation: createUser | Data: {
-  "operation": "createUser",
-  "email": true,
-  "resolvedTenantId": "tenant-123"
-}
-```
-
-### Development vs Production
-
-- **Development**: Use `debug` or `verbose` level for detailed troubleshooting
-- **Production**: Use `error` or `warn` level, or disable entirely for performance
-
-### Performance Considerations
-
-Debug logging adds minimal overhead when disabled. When enabled at `debug` or `verbose` levels, there is some performance impact due to:
-- JSON serialization of data objects
-- Additional function calls
-- Console I/O operations
-
-For production use, consider using `info` level or lower.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+Run `nx test nest-auth` to execute the unit tests via [Jest](https://jestjs.io).

package/eslint.config.mjs

@@ -0,0 +1,59 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import nxPlugin from '@nx/eslint-plugin';
+
+const compat = new FlatCompat({
+  baseDirectory: import.meta.dirname,
+  recommendedConfig: js.configs.recommended,
+});
+
+export default [
+  {
+    plugins: {
+      '@nx': nxPlugin,
+    },
+  },
+  {
+    files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
+    rules: {
+      '@nx/enforce-module-boundaries': [
+        'error',
+        {
+          enforceBuildableLibDependency: true,
+          allow: ['^.*/eslint(\\.base)?\\.config\\.[cm]?js$'],
+          depConstraints: [
+            {
+              sourceTag: '*',
+              onlyDependOnLibsWithTags: ['*'],
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    rules: {},
+  },
+  {
+    files: ['**/*.js', '**/*.jsx'],
+    rules: {},
+  },
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}'],
+        },
+      ],
+    },
+    languageOptions: {
+      parser: await import('jsonc-eslint-parser'),
+    },
+  },
+  {
+    ignores: ['**/out-tsc', '**/dist', '**/build', '**/.nx', '**/node_modules', '**/static'],
+  },
+];

package/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'nest-auth',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/packages/nest-auth',
+};

package/package.json

@@ -1,56 +1,26 @@
 {
   "name": "@ackplus/nest-auth",
-  "version": "0.1.51",
+  "version": "1.1.0",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ack-solutions/packages.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "homepage": "https://github.com/ack-solutions/packages.git#readme",
-  "peerDependencies": {
-    "typeorm": "^0.3.23",
-    "@nestjs/typeorm": "^11.0.0",
-    "@nestjs/common": "^10.4.5"
-  },
   "dependencies": {
-    "deepmerge": "4.3.1",
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/platform-express": "^11.0.0",
+    "@nestjs/swagger": "^11.0.0",
+    "@nestjs/typeorm": "^11.0.0",
+    "argon2": "^0.44.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
-    "pluralize": "8.0.0",
-    "lodash": "^4.17.21",
+    "express": "^4.18.2",
+    "jsonwebtoken": "^9.0.2",
+    "ms": "^2.1.3",
+    "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.0",
-    "bcrypt": "^5.1.0",
-    "passport": "^0.6.0",
-    "passport-jwt": "^4.0.1",
-    "uuid": "^9.0.0",
-    "google-auth-library": "^9.0.0",
-    "fb": "^2.0.0",
-    "apple-auth": "^1.0.0",
     "speakeasy": "^2.0.0",
-    "qrcode": "^1.5.3"
-  },
-  "devDependencies": {
-    "@nestjs/common": "^10.4.5",
-    "@nestjs/swagger": "^7.4.2",
     "tslib": "^2.3.0",
-    "typeorm": "^0.3.23",
-    "@nestjs/typeorm": "^11.0.0",
-    "@nestjs/testing": "^10.0.0",
-    "@types/bcrypt": "^5.0.0",
-    "@types/jest": "^29.0.0",
-    "@types/node": "^20.0.0",
-    "@types/passport-jwt": "^3.0.8",
-    "@types/uuid": "^9.0.0",
-    "@types/speakeasy": "^2.0.0",
-    "@types/qrcode": "^1.5.5",
-    "jest": "^29.0.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
+    "typeorm": "^0.3.21",
+    "uuid": "^11.0.5"
   }
-}
+}