@nauth-toolkit/core 0.1.14 → 0.1.17

package/dist/entities/auth-audit.entity.js

@@ -1,32 +1,198 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseAuthAudit = void 0;
+/**
+ * Base Authentication Audit Entity
+ *
+ * Core audit record with all fields and business logic.
+ * Database adapters extend this class and add ORM-specific decorators.
+ *
+ * @remarks
+ * This class is database-agnostic. TypeORM, Prisma, or other ORMs
+ * extend this class in their respective packages.
+ *
+ * **Design Notes:**
+ * - Only stores `userId` (integer internal ID) - no `userSub` duplication
+ * - Risk tracking fields are infrastructure for future adaptive MFA (no business logic)
+ * - All audit integrations are non-blocking (errors logged, don't throw)
+ */
 class BaseAuthAudit {
+    /**
+     * Internal audit record ID (auto-increment integer)
+     */
     id;
+    /**
+     * Internal user ID (foreign key to users table)
+     * Uses integer for optimal performance in joins and lookups.
+     * API methods accepting userSub will resolve to userId before querying.
+     *
+     * @remarks
+     * No userSub field to avoid duplication. All queries use userId
+     * for efficient database operations.
+     */
     userId;
+    /**
+     * Type of authentication/security event
+     */
     eventType;
+    /**
+     * Event classification status
+     * - SUCCESS: Operation completed successfully
+     * - FAILURE: Operation failed (login failed, verification failed, etc.)
+     * - INFO: Informational event (profile update, device added, etc.)
+     * - SUSPICIOUS: Security violation or suspicious activity detected
+     */
     eventStatus;
+    // ============================================================================
+    // Risk Assessment Fields (Infrastructure for Future Adaptive MFA)
+    // ============================================================================
+    /**
+     * Risk factor score (0-100)
+     * Calculated during adaptive MFA evaluation (future implementation).
+     * null if not applicable (non-adaptive flows).
+     *
+     * @remarks
+     * This is infrastructure for future adaptive MFA. The audit service
+     * records risk data but does NOT calculate risk scores. Risk calculation
+     * and adaptive MFA business logic will be implemented in future phases.
+     */
     riskFactor;
+    /**
+     * Risk factors that contributed to the risk score
+     * Examples: ['new_device', 'new_ip', 'new_country', 'impossible_travel']
+     *
+     * @remarks
+     * Infrastructure field for future adaptive MFA implementation.
+     */
     riskFactors;
+    /**
+     * Whether adaptive MFA was triggered for this event
+     * true if MFA was conditionally required based on risk (future implementation).
+     * null if not applicable.
+     *
+     * @remarks
+     * Infrastructure field for future adaptive MFA implementation.
+     */
     adaptiveMfaTriggered;
+    // ============================================================================
+    // Client Information
+    // ============================================================================
+    /**
+     * IP address where event occurred
+     */
     ipAddress;
+    /**
+     * Country from IP geolocation (optional, for geographic risk assessment)
+     */
     ipCountry;
+    /**
+     * City from IP geolocation (optional, for geographic risk assessment)
+     */
     ipCity;
+    /**
+     * Latitude from IP geolocation (optional, for impossible travel detection)
+     */
     ipLatitude;
+    /**
+     * Longitude from IP geolocation (optional, for impossible travel detection)
+     */
     ipLongitude;
+    /**
+     * User agent string
+     */
     userAgent;
+    /**
+     * Platform extracted from user agent
+     * Examples: "iOS", "Android", "Windows", "macOS"
+     */
     platform;
+    /**
+     * Browser extracted from user agent
+     * Examples: "Chrome", "Safari", "Firefox"
+     */
     browser;
+    /**
+     * Device identifier (UUID)
+     * Unique identifier for the device/browser
+     */
     deviceId;
+    /**
+     * User-friendly device name
+     * Examples: "iPhone 15 Pro", "Chrome on MacBook"
+     */
     deviceName;
+    /**
+     * Device type
+     * Examples: "mobile", "desktop", "tablet"
+     */
     deviceType;
+    // ============================================================================
+    // Context Information
+    // ============================================================================
+    /**
+     * Session ID (if event is related to a session)
+     * Foreign key to sessions table
+     */
     sessionId;
+    /**
+     * Challenge session ID (if event is related to a challenge)
+     * Foreign key to challenge_sessions table
+     */
     challengeSessionId;
+    /**
+     * Authentication method used
+     * Examples: "password", "google", "apple", "facebook"
+     * Used for social login provider tracking
+     */
     authMethod;
+    /**
+     * Who performed this action (for admin/CLI/automated operations)
+     * - Admin user ID or email for manual admin actions
+     * - CLI identifier for command-line operations
+     * - 'system' for automated actions
+     * - null for user-initiated actions
+     *
+     * @example
+     * performedBy: 'admin@example.com'
+     * performedBy: 'cli-migration-2025'
+     * performedBy: 'system'
+     */
     performedBy;
+    // ============================================================================
+    // Event Details
+    // ============================================================================
+    /**
+     * Reason for the event (optional)
+     * Used for security events, account locks, etc.
+     */
     reason;
+    /**
+     * Detailed description of the event
+     */
     description;
+    /**
+     * Rich metadata (JSON)
+     * Event-specific data stored without requiring schema changes.
+     *
+     * @example
+     * ```typescript
+     * // Social login
+     * metadata: { provider: 'google', isNewUser: true }
+     *
+     * // Challenge event
+     * metadata: { challengeName: 'VERIFY_EMAIL', challengeSessionId: 123 }
+     *
+     * // MFA device
+     * metadata: { deviceType: 'totp', deviceName: 'iPhone Authenticator' }
+     *
+     * // Token reuse
+     * metadata: { tokenFamily: 'abc123', action: 'token_family_revoked' }
+     * ```
+     */
     metadata;
+    /**
+     * Timestamp when event occurred
+     */
     createdAt;
 }
 exports.BaseAuthAudit = BaseAuthAudit;

package/dist/entities/auth-audit.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth-audit.entity.js","sourceRoot":"","sources":["../../src/entities/auth-audit.entity.ts"],"names":[],"mappings":";;;AAwBA,MAAa,aAAa;IAIxB,EAAE,CAAU;IAWZ,MAAM,CAAU;IAKhB,SAAS,CAAsB;IAS/B,WAAW,CAAwB;IAgBnC,UAAU,CAAiB;IAS3B,WAAW,CAAmB;IAU9B,oBAAoB,CAAkB;IAStC,SAAS,CAAiB;IAK1B,SAAS,CAAiB;IAK1B,MAAM,CAAiB;IAKvB,UAAU,CAAiB;IAK3B,WAAW,CAAiB;IAK5B,SAAS,CAAiB;IAM1B,QAAQ,CAAiB;IAMzB,OAAO,CAAiB;IAMxB,QAAQ,CAAiB;IAMzB,UAAU,CAAiB;IAM3B,UAAU,CAAiB;IAU3B,SAAS,CAAiB;IAM1B,kBAAkB,CAAiB;IAOnC,UAAU,CAAiB;IAc3B,WAAW,CAAiB;IAU5B,MAAM,CAAiB;IAKvB,WAAW,CAAiB;IAqB5B,QAAQ,CAAkC;IAK1C,SAAS,CAAQ;CAClB;AA/MD,sCA+MC"}
+{"version":3,"file":"auth-audit.entity.js","sourceRoot":"","sources":["../../src/entities/auth-audit.entity.ts"],"names":[],"mappings":";;;AASA;;;;;;;;;;;;;;GAcG;AACH,MAAa,aAAa;IACxB;;OAEG;IACH,EAAE,CAAU;IAEZ;;;;;;;;OAQG;IACH,MAAM,CAAU;IAEhB;;OAEG;IACH,SAAS,CAAsB;IAE/B;;;;;;OAMG;IACH,WAAW,CAAwB;IAEnC,+EAA+E;IAC/E,kEAAkE;IAClE,+EAA+E;IAE/E;;;;;;;;;OASG;IACH,UAAU,CAAiB;IAE3B;;;;;;OAMG;IACH,WAAW,CAAmB;IAE9B;;;;;;;OAOG;IACH,oBAAoB,CAAkB;IAEtC,+EAA+E;IAC/E,qBAAqB;IACrB,+EAA+E;IAE/E;;OAEG;IACH,SAAS,CAAiB;IAE1B;;OAEG;IACH,SAAS,CAAiB;IAE1B;;OAEG;IACH,MAAM,CAAiB;IAEvB;;OAEG;IACH,UAAU,CAAiB;IAE3B;;OAEG;IACH,WAAW,CAAiB;IAE5B;;OAEG;IACH,SAAS,CAAiB;IAE1B;;;OAGG;IACH,QAAQ,CAAiB;IAEzB;;;OAGG;IACH,OAAO,CAAiB;IAExB;;;OAGG;IACH,QAAQ,CAAiB;IAEzB;;;OAGG;IACH,UAAU,CAAiB;IAE3B;;;OAGG;IACH,UAAU,CAAiB;IAE3B,+EAA+E;IAC/E,sBAAsB;IACtB,+EAA+E;IAE/E;;;OAGG;IACH,SAAS,CAAiB;IAE1B;;;OAGG;IACH,kBAAkB,CAAiB;IAEnC;;;;OAIG;IACH,UAAU,CAAiB;IAE3B;;;;;;;;;;;OAWG;IACH,WAAW,CAAiB;IAE5B,+EAA+E;IAC/E,gBAAgB;IAChB,+EAA+E;IAE/E;;;OAGG;IACH,MAAM,CAAiB;IAEvB;;OAEG;IACH,WAAW,CAAiB;IAE5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAkC;IAE1C;;OAEG;IACH,SAAS,CAAQ;CAClB;AA/MD,sCA+MC"}

package/dist/entities/challenge-session.entity.d.ts

@@ -1,17 +1,104 @@
+/**
+ * Base Challenge Session Entity
+ *
+ * Stores temporary authentication challenge sessions.
+ * These are short-lived sessions used to track pending challenges
+ * that must be completed before full authentication is granted.
+ * Database adapters extend this class and add ORM-specific decorators.
+ *
+ * @remarks
+ * Similar to AWS Cognito's challenge sessions, these are NOT full JWT tokens.
+ * They expire quickly (typically 15 minutes) and are deleted after completion.
+ * This class is database-agnostic. TypeORM, Prisma, or other ORMs
+ * extend this class in their respective packages.
+ *
+ * @example
+ * ```typescript
+ * // Creating a challenge session after signup
+ * const challengeSession = new ChallengeSession();
+ * challengeSession.userId = user.id;
+ * challengeSession.challengeName = 'VERIFY_EMAIL';
+ * challengeSession.sessionToken = randomUUID();
+ * challengeSession.expiresAt = new Date(Date.now() + 15 * 60 * 1000);
+ * challengeSession.metadata = { email: user.email };
+ * ```
+ */
 export declare class BaseChallengeSession {
+    /**
+     * Primary key
+     */
     id: number;
+    /**
+     * User ID foreign key
+     * References the user this challenge session belongs to
+     */
     userId: number;
+    /**
+     * Challenge type that must be completed
+     *
+     * @example 'VERIFY_EMAIL', 'VERIFY_PHONE', 'MFA_REQUIRED', 'FORCE_CHANGE_PASSWORD'
+     */
     challengeName: string;
+    /**
+     * Temporary session token (UUID)
+     * This is returned to the client and must be submitted when responding to challenge
+     */
     sessionToken: string;
+    /**
+     * Session expiration time
+     * Challenge sessions are short-lived (typically 15 minutes)
+     */
     expiresAt: Date;
+    /**
+     * Whether this challenge has been completed successfully
+     * Completed challenges cannot be attempted again
+     */
     isCompleted?: boolean;
+    /**
+     * When the challenge was completed successfully
+     * NULL if not yet completed
+     */
     completedAt?: Date | null;
+    /**
+     * Number of failed attempts to complete this challenge
+     * Used to prevent brute-force attacks on verification codes
+     */
     attempts: number;
+    /**
+     * Maximum allowed attempts before session is invalidated
+     */
     maxAttempts: number;
+    /**
+     * Challenge-specific metadata
+     * Stores information needed for challenge completion
+     *
+     * @example
+     * ```typescript
+     * {
+     *   email: 'user@example.com',
+     *   phone: '+1234567890',
+     *   verificationTokenId: 123
+     * }
+     * ```
+     */
     challengeParameters: Record<string, unknown> | null;
+    /**
+     * Additional metadata (alias for challengeParameters for backwards compatibility)
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * IP address where the challenge session was created
+     * For security auditing
+     */
     ipAddress: string | null;
+    /**
+     * User agent where the challenge session was created
+     * For security auditing
+     */
     userAgent: string | null;
+    /**
+     * Creation timestamp
+     */
     createdAt: Date;
 }
 //# sourceMappingURL=challenge-session.entity.d.ts.map

package/dist/entities/challenge-session.entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"challenge-session.entity.d.ts","sourceRoot":"","sources":["../../src/entities/challenge-session.entity.ts"],"names":[],"mappings":"AAyBA,qBAAa,oBAAoB;IAI/B,EAAE,EAAG,MAAM,CAAC;IAMZ,MAAM,EAAG,MAAM,CAAC;IAOhB,aAAa,EAAG,MAAM,CAAC;IAMvB,YAAY,EAAG,MAAM,CAAC;IAMtB,SAAS,EAAG,IAAI,CAAC;IAMjB,WAAW,CAAC,EAAE,OAAO,CAAC;IAMtB,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAM1B,QAAQ,EAAG,MAAM,CAAC;IAKlB,WAAW,EAAG,MAAM,CAAC;IAerB,mBAAmB,EAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAKrD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAM1C,SAAS,EAAG,MAAM,GAAG,IAAI,CAAC;IAM1B,SAAS,EAAG,MAAM,GAAG,IAAI,CAAC;IAK1B,SAAS,EAAG,IAAI,CAAC;CAClB"}
+{"version":3,"file":"challenge-session.entity.d.ts","sourceRoot":"","sources":["../../src/entities/challenge-session.entity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,oBAAoB;IAC/B;;OAEG;IACH,EAAE,EAAG,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,EAAG,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,EAAG,MAAM,CAAC;IAEvB;;;OAGG;IACH,YAAY,EAAG,MAAM,CAAC;IAEtB;;;OAGG;IACH,SAAS,EAAG,IAAI,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAG,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAG,MAAM,CAAC;IAErB;;;;;;;;;;;;OAYG;IACH,mBAAmB,EAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,SAAS,EAAG,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,SAAS,EAAG,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAG,IAAI,CAAC;CAClB"}

package/dist/entities/challenge-session.entity.js

@@ -1,20 +1,107 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseChallengeSession = void 0;
+/**
+ * Base Challenge Session Entity
+ *
+ * Stores temporary authentication challenge sessions.
+ * These are short-lived sessions used to track pending challenges
+ * that must be completed before full authentication is granted.
+ * Database adapters extend this class and add ORM-specific decorators.
+ *
+ * @remarks
+ * Similar to AWS Cognito's challenge sessions, these are NOT full JWT tokens.
+ * They expire quickly (typically 15 minutes) and are deleted after completion.
+ * This class is database-agnostic. TypeORM, Prisma, or other ORMs
+ * extend this class in their respective packages.
+ *
+ * @example
+ * ```typescript
+ * // Creating a challenge session after signup
+ * const challengeSession = new ChallengeSession();
+ * challengeSession.userId = user.id;
+ * challengeSession.challengeName = 'VERIFY_EMAIL';
+ * challengeSession.sessionToken = randomUUID();
+ * challengeSession.expiresAt = new Date(Date.now() + 15 * 60 * 1000);
+ * challengeSession.metadata = { email: user.email };
+ * ```
+ */
 class BaseChallengeSession {
+    /**
+     * Primary key
+     */
     id;
+    /**
+     * User ID foreign key
+     * References the user this challenge session belongs to
+     */
     userId;
+    /**
+     * Challenge type that must be completed
+     *
+     * @example 'VERIFY_EMAIL', 'VERIFY_PHONE', 'MFA_REQUIRED', 'FORCE_CHANGE_PASSWORD'
+     */
     challengeName;
+    /**
+     * Temporary session token (UUID)
+     * This is returned to the client and must be submitted when responding to challenge
+     */
     sessionToken;
+    /**
+     * Session expiration time
+     * Challenge sessions are short-lived (typically 15 minutes)
+     */
     expiresAt;
+    /**
+     * Whether this challenge has been completed successfully
+     * Completed challenges cannot be attempted again
+     */
     isCompleted;
+    /**
+     * When the challenge was completed successfully
+     * NULL if not yet completed
+     */
     completedAt;
+    /**
+     * Number of failed attempts to complete this challenge
+     * Used to prevent brute-force attacks on verification codes
+     */
     attempts;
+    /**
+     * Maximum allowed attempts before session is invalidated
+     */
     maxAttempts;
+    /**
+     * Challenge-specific metadata
+     * Stores information needed for challenge completion
+     *
+     * @example
+     * ```typescript
+     * {
+     *   email: 'user@example.com',
+     *   phone: '+1234567890',
+     *   verificationTokenId: 123
+     * }
+     * ```
+     */
     challengeParameters;
+    /**
+     * Additional metadata (alias for challengeParameters for backwards compatibility)
+     */
     metadata;
+    /**
+     * IP address where the challenge session was created
+     * For security auditing
+     */
     ipAddress;
+    /**
+     * User agent where the challenge session was created
+     * For security auditing
+     */
     userAgent;
+    /**
+     * Creation timestamp
+     */
     createdAt;
 }
 exports.BaseChallengeSession = BaseChallengeSession;

package/dist/entities/challenge-session.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"challenge-session.entity.js","sourceRoot":"","sources":["../../src/entities/challenge-session.entity.ts"],"names":[],"mappings":";;;AAyBA,MAAa,oBAAoB;IAI/B,EAAE,CAAU;IAMZ,MAAM,CAAU;IAOhB,aAAa,CAAU;IAMvB,YAAY,CAAU;IAMtB,SAAS,CAAQ;IAMjB,WAAW,CAAW;IAMtB,WAAW,CAAe;IAM1B,QAAQ,CAAU;IAKlB,WAAW,CAAU;IAerB,mBAAmB,CAAkC;IAKrD,QAAQ,CAAkC;IAM1C,SAAS,CAAiB;IAM1B,SAAS,CAAiB;IAK1B,SAAS,CAAQ;CAClB;AA1FD,oDA0FC"}
+{"version":3,"file":"challenge-session.entity.js","sourceRoot":"","sources":["../../src/entities/challenge-session.entity.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,oBAAoB;IAC/B;;OAEG;IACH,EAAE,CAAU;IAEZ;;;OAGG;IACH,MAAM,CAAU;IAEhB;;;;OAIG;IACH,aAAa,CAAU;IAEvB;;;OAGG;IACH,YAAY,CAAU;IAEtB;;;OAGG;IACH,SAAS,CAAQ;IAEjB;;;OAGG;IACH,WAAW,CAAW;IAEtB;;;OAGG;IACH,WAAW,CAAe;IAE1B;;;OAGG;IACH,QAAQ,CAAU;IAElB;;OAEG;IACH,WAAW,CAAU;IAErB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAkC;IAErD;;OAEG;IACH,QAAQ,CAAkC;IAE1C;;;OAGG;IACH,SAAS,CAAiB;IAE1B;;;OAGG;IACH,SAAS,CAAiB;IAE1B;;OAEG;IACH,SAAS,CAAQ;CAClB;AA1FD,oDA0FC"}

package/dist/entities/index.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Base Entity Classes
+ *
+ * Database-agnostic entity classes containing all fields and business logic.
+ * Database adapters (TypeORM, Prisma, etc.) extend these classes and add ORM-specific decorators.
+ *
+ * @remarks
+ * These base classes provide:
+ * - Field definitions
+ * - Business logic methods
+ * - JSDoc documentation
+ * - Type safety
+ *
+ * Database packages add:
+ * - ORM decorators (@Entity, @Column, etc.)
+ * - Database-specific configuration
+ * - Indexes and constraints
+ */
 export { BaseUser } from './user.entity';
 export { BaseSession } from './session.entity';
 export { BaseTrustedDevice } from './trusted-device.entity';

package/dist/entities/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/entities/index.js

@@ -1,6 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseStorageLock = exports.BaseRateLimit = exports.BaseAuthAudit = exports.BaseMFADevice = exports.BaseChallengeSession = exports.BaseSocialAccount = exports.BaseVerificationToken = exports.BaseLoginAttempt = exports.BaseTrustedDevice = exports.BaseSession = exports.BaseUser = void 0;
+/**
+ * Base Entity Classes
+ *
+ * Database-agnostic entity classes containing all fields and business logic.
+ * Database adapters (TypeORM, Prisma, etc.) extend these classes and add ORM-specific decorators.
+ *
+ * @remarks
+ * These base classes provide:
+ * - Field definitions
+ * - Business logic methods
+ * - JSDoc documentation
+ * - Type safety
+ *
+ * Database packages add:
+ * - ORM decorators (@Entity, @Column, etc.)
+ * - Database-specific configuration
+ * - Indexes and constraints
+ */
 var user_entity_1 = require("./user.entity");
 Object.defineProperty(exports, "BaseUser", { enumerable: true, get: function () { return user_entity_1.BaseUser; } });
 var session_entity_1 = require("./session.entity");

package/dist/entities/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":";;;AAkBA,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AACjB,mDAA+C;AAAtC,6GAAA,WAAW,OAAA;AACpB,iEAA4D;AAAnD,0HAAA,iBAAiB,OAAA;AAC1B,+DAA0D;AAAjD,wHAAA,gBAAgB,OAAA;AACzB,yEAAoE;AAA3D,kIAAA,qBAAqB,OAAA;AAC9B,iEAA4D;AAAnD,0HAAA,iBAAiB,OAAA;AAC1B,uEAAkE;AAAzD,gIAAA,oBAAoB,OAAA;AAC7B,yDAAoD;AAA3C,kHAAA,aAAa,OAAA;AACtB,yDAA+E;AAAtE,kHAAA,aAAa,OAAA;AACtB,yDAAoD;AAA3C,kHAAA,aAAa,OAAA;AACtB,6DAAwD;AAA/C,sHAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AACjB,mDAA+C;AAAtC,6GAAA,WAAW,OAAA;AACpB,iEAA4D;AAAnD,0HAAA,iBAAiB,OAAA;AAC1B,+DAA0D;AAAjD,wHAAA,gBAAgB,OAAA;AACzB,yEAAoE;AAA3D,kIAAA,qBAAqB,OAAA;AAC9B,iEAA4D;AAAnD,0HAAA,iBAAiB,OAAA;AAC1B,uEAAkE;AAAzD,gIAAA,oBAAoB,OAAA;AAC7B,yDAAoD;AAA3C,kHAAA,aAAa,OAAA;AACtB,yDAA+E;AAAtE,kHAAA,aAAa,OAAA;AACtB,yDAAoD;AAA3C,kHAAA,aAAa,OAAA;AACtB,6DAAwD;AAA/C,sHAAA,eAAe,OAAA"}

package/dist/entities/login-attempt.entity.d.ts

@@ -1,13 +1,56 @@
+/**
+ * Base Login Attempt Entity
+ *
+ * Failed login tracking for security auditing and rate limiting.
+ * Database adapters extend this class and add ORM-specific decorators.
+ *
+ * @remarks
+ * This class is database-agnostic. TypeORM, Prisma, or other ORMs
+ * extend this class in their respective packages.
+ */
 export declare class BaseLoginAttempt {
+    /**
+     * Internal login attempt ID
+     */
     id: number;
+    /**
+     * Email/username used in login attempt
+     * May be NULL for malformed requests
+     */
     email?: string | null;
+    /**
+     * Internal user ID (foreign key to users table)
+     * Nullable since login attempt might be for non-existent user
+     */
     userId?: number | null;
+    /**
+     * IP address of login attempt
+     */
     ipAddress?: string | null;
+    /**
+     * User agent string
+     */
     userAgent?: string | null;
+    /**
+     * Whether login was successful
+     */
     success: boolean;
+    /**
+     * Reason for login failure
+     * Examples: "invalid_credentials", "account_locked", "mfa_required"
+     */
     failureReason?: string | null;
+    /**
+     * Whether MFA was required for this attempt
+     */
     mfaRequired: boolean;
+    /**
+     * Additional metadata (JSON)
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * Login attempt timestamp
+     */
     createdAt: Date;
 }
 //# sourceMappingURL=login-attempt.entity.d.ts.map

package/dist/entities/login-attempt.entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"login-attempt.entity.d.ts","sourceRoot":"","sources":["../../src/entities/login-attempt.entity.ts"],"names":[],"mappings":"AAUA,qBAAa,gBAAgB;IAI3B,EAAE,EAAG,MAAM,CAAC;IAMZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAKvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAK1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAK1B,OAAO,EAAG,OAAO,CAAC;IAMlB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAK9B,WAAW,EAAG,OAAO,CAAC;IAKtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAK1C,SAAS,EAAG,IAAI,CAAC;CAClB"}
+{"version":3,"file":"login-attempt.entity.d.ts","sourceRoot":"","sources":["../../src/entities/login-attempt.entity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,EAAE,EAAG,MAAM,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAG,OAAO,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAG,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,SAAS,EAAG,IAAI,CAAC;CAClB"}

package/dist/entities/login-attempt.entity.js

@@ -1,16 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseLoginAttempt = void 0;
+/**
+ * Base Login Attempt Entity
+ *
+ * Failed login tracking for security auditing and rate limiting.
+ * Database adapters extend this class and add ORM-specific decorators.
+ *
+ * @remarks
+ * This class is database-agnostic. TypeORM, Prisma, or other ORMs
+ * extend this class in their respective packages.
+ */
 class BaseLoginAttempt {
+    /**
+     * Internal login attempt ID
+     */
     id;
+    /**
+     * Email/username used in login attempt
+     * May be NULL for malformed requests
+     */
     email;
+    /**
+     * Internal user ID (foreign key to users table)
+     * Nullable since login attempt might be for non-existent user
+     */
     userId;
+    /**
+     * IP address of login attempt
+     */
     ipAddress;
+    /**
+     * User agent string
+     */
     userAgent;
+    /**
+     * Whether login was successful
+     */
     success;
+    /**
+     * Reason for login failure
+     * Examples: "invalid_credentials", "account_locked", "mfa_required"
+     */
     failureReason;
+    /**
+     * Whether MFA was required for this attempt
+     */
     mfaRequired;
+    /**
+     * Additional metadata (JSON)
+     */
     metadata;
+    /**
+     * Login attempt timestamp
+     */
     createdAt;
 }
 exports.BaseLoginAttempt = BaseLoginAttempt;

package/dist/entities/login-attempt.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"login-attempt.entity.js","sourceRoot":"","sources":["../../src/entities/login-attempt.entity.ts"],"names":[],"mappings":";;;AAUA,MAAa,gBAAgB;IAI3B,EAAE,CAAU;IAMZ,KAAK,CAAiB;IAMtB,MAAM,CAAiB;IAKvB,SAAS,CAAiB;IAK1B,SAAS,CAAiB;IAK1B,OAAO,CAAW;IAMlB,aAAa,CAAiB;IAK9B,WAAW,CAAW;IAKtB,QAAQ,CAAkC;IAK1C,SAAS,CAAQ;CAClB;AArDD,4CAqDC"}
+{"version":3,"file":"login-attempt.entity.js","sourceRoot":"","sources":["../../src/entities/login-attempt.entity.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,EAAE,CAAU;IAEZ;;;OAGG;IACH,KAAK,CAAiB;IAEtB;;;OAGG;IACH,MAAM,CAAiB;IAEvB;;OAEG;IACH,SAAS,CAAiB;IAE1B;;OAEG;IACH,SAAS,CAAiB;IAE1B;;OAEG;IACH,OAAO,CAAW;IAElB;;;OAGG;IACH,aAAa,CAAiB;IAE9B;;OAEG;IACH,WAAW,CAAW;IAEtB;;OAEG;IACH,QAAQ,CAAkC;IAE1C;;OAEG;IACH,SAAS,CAAQ;CAClB;AArDD,4CAqDC"}