@nauth-toolkit/core 0.1.14 → 0.1.17

package/dist/dto/get-available-methods.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-available-methods.dto.js","sourceRoot":"","sources":["../../src/dto/get-available-methods.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAcA,qDAAyC;AACzC,yDAA8C;AAK9C,MAAa,sBAAsB;IAqBjC,GAAG,CAAU;CACd;AAtBD,wDAsBC;AADC;IAPC,IAAA,wBAAM,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;IACnE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;mDACW;AAMf,MAAa,8BAA8B;IAMzC,gBAAgB,CAAY;CAC7B;AAPD,wEAOC"}
+{"version":3,"file":"get-available-methods.dto.js","sourceRoot":"","sources":["../../src/dto/get-available-methods.dto.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;AAEH,qDAAyC;AACzC,yDAA8C;AAE9C;;GAEG;AACH,MAAa,sBAAsB;IACjC;;;;;;;;;;;;OAYG;IAQH,GAAG,CAAU;CACd;AAtBD,wDAsBC;AADC;IAPC,IAAA,wBAAM,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;IACnE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;mDACW;AAGf;;GAEG;AACH,MAAa,8BAA8B;IACzC;;;;OAIG;IACH,gBAAgB,CAAY;CAC7B;AAPD,wEAOC"}

package/dist/dto/get-challenge-data-response.dto.d.ts

@@ -1,4 +1,28 @@
+/**
+ * Response DTO for getting MFA challenge data
+ *
+ * Used to return method-specific challenge data during MFA verification.
+ * Currently only passkey method requires challenge data (WebAuthn options).
+ *
+ * @example
+ * ```typescript
+ * const challengeData = await mfaService.getChallengeData({
+ *   session: 'challenge-session-token',
+ *   method: 'passkey'
+ * });
+ * // Returns: { publicKey: { challenge: '...', ... } }
+ * ```
+ */
+/**
+ * Response DTO for challenge data
+ */
 export declare class GetChallengeDataResponseDTO {
+    /**
+     * Provider-specific challenge data
+     *
+     * For passkey: WebAuthn public key options
+     * Structure: { publicKey: { challenge: string, allowCredentials: [...], ... } }
+     */
     challengeData: Record<string, unknown>;
 }
 //# sourceMappingURL=get-challenge-data-response.dto.d.ts.map

package/dist/dto/get-challenge-data-response.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-challenge-data-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-challenge-data-response.dto.ts"],"names":[],"mappings":"AAmBA,qBAAa,2BAA2B;IAOtC,aAAa,EAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACzC"}
+{"version":3,"file":"get-challenge-data-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-challenge-data-response.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;GAEG;AACH,qBAAa,2BAA2B;IACtC;;;;;OAKG;IACH,aAAa,EAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACzC"}

package/dist/dto/get-challenge-data-response.dto.js

@@ -1,7 +1,31 @@
 "use strict";
+/**
+ * Response DTO for getting MFA challenge data
+ *
+ * Used to return method-specific challenge data during MFA verification.
+ * Currently only passkey method requires challenge data (WebAuthn options).
+ *
+ * @example
+ * ```typescript
+ * const challengeData = await mfaService.getChallengeData({
+ *   session: 'challenge-session-token',
+ *   method: 'passkey'
+ * });
+ * // Returns: { publicKey: { challenge: '...', ... } }
+ * ```
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetChallengeDataResponseDTO = void 0;
+/**
+ * Response DTO for challenge data
+ */
 class GetChallengeDataResponseDTO {
+    /**
+     * Provider-specific challenge data
+     *
+     * For passkey: WebAuthn public key options
+     * Structure: { publicKey: { challenge: string, allowCredentials: [...], ... } }
+     */
     challengeData;
 }
 exports.GetChallengeDataResponseDTO = GetChallengeDataResponseDTO;

package/dist/dto/get-challenge-data-response.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-challenge-data-response.dto.js","sourceRoot":"","sources":["../../src/dto/get-challenge-data-response.dto.ts"],"names":[],"mappings":";;;AAmBA,MAAa,2BAA2B;IAOtC,aAAa,CAA2B;CACzC;AARD,kEAQC"}
+{"version":3,"file":"get-challenge-data-response.dto.js","sourceRoot":"","sources":["../../src/dto/get-challenge-data-response.dto.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AACH,MAAa,2BAA2B;IACtC;;;;;OAKG;IACH,aAAa,CAA2B;CACzC;AARD,kEAQC"}

package/dist/dto/get-challenge-data.dto.d.ts

@@ -1,8 +1,54 @@
+/**
+ * DTO for requesting MFA challenge data
+ *
+ * Used to get method-specific challenge information during MFA verification.
+ * Currently only passkey method requires challenge data (WebAuthn options).
+ *
+ * Security:
+ * - Session token length limited (prevents DoS)
+ * - Method validated against enum (prevents injection)
+ *
+ * @example
+ * ```typescript
+ * const challengeData = await authService.getChallengeData({
+ *   session: 'challenge-session-token',
+ *   method: 'passkey'
+ * });
+ * // Returns: { publicKey: { challenge: '...', ... } }
+ * ```
+ */
+/**
+ * MFA method enum for challenge data
+ * Currently only passkey requires challenge data
+ */
 export declare enum MFAChallengeMethod {
     PASSKEY = "passkey"
 }
+/**
+ * DTO for getting MFA challenge data
+ */
 export declare class GetChallengeDataDTO {
+    /**
+     * Challenge session token (UUID v4)
+     *
+     * Validation:
+     * - Must be a valid UUID v4 format
+     * - Generated using randomUUID() in challenge service
+     * - Matches DB constraint: varchar(255) but UUID format enforced
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased for consistency
+     *
+     * @example "a21b654c-2746-4168-acee-c175083a65cd"
+     */
     session: string;
+    /**
+     * MFA method requiring challenge data
+     *
+     * Validation:
+     * - Must be 'passkey' (only method that needs challenge data)
+     */
     method: MFAChallengeMethod;
 }
 //# sourceMappingURL=get-challenge-data.dto.d.ts.map

package/dist/dto/get-challenge-data.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-challenge-data.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-challenge-data.dto.ts"],"names":[],"mappings":"AA2BA,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;CACpB;AAKD,qBAAa,mBAAmB;IAsB9B,OAAO,EAAG,MAAM,CAAC;IAWjB,MAAM,EAAG,kBAAkB,CAAC;CAC7B"}
+{"version":3,"file":"get-challenge-data.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-challenge-data.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAKH;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC9B;;;;;;;;;;;;;OAaG;IAQH,OAAO,EAAG,MAAM,CAAC;IAEjB;;;;;OAKG;IAIH,MAAM,EAAG,kBAAkB,CAAC;CAC7B"}

package/dist/dto/get-challenge-data.dto.js

@@ -1,4 +1,23 @@
 "use strict";
+/**
+ * DTO for requesting MFA challenge data
+ *
+ * Used to get method-specific challenge information during MFA verification.
+ * Currently only passkey method requires challenge data (WebAuthn options).
+ *
+ * Security:
+ * - Session token length limited (prevents DoS)
+ * - Method validated against enum (prevents injection)
+ *
+ * @example
+ * ```typescript
+ * const challengeData = await authService.getChallengeData({
+ *   session: 'challenge-session-token',
+ *   method: 'passkey'
+ * });
+ * // Returns: { publicKey: { challenge: '...', ... } }
+ * ```
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -12,12 +31,39 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetChallengeDataDTO = exports.MFAChallengeMethod = void 0;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
+/**
+ * MFA method enum for challenge data
+ * Currently only passkey requires challenge data
+ */
 var MFAChallengeMethod;
 (function (MFAChallengeMethod) {
     MFAChallengeMethod["PASSKEY"] = "passkey";
 })(MFAChallengeMethod || (exports.MFAChallengeMethod = MFAChallengeMethod = {}));
+/**
+ * DTO for getting MFA challenge data
+ */
 class GetChallengeDataDTO {
+    /**
+     * Challenge session token (UUID v4)
+     *
+     * Validation:
+     * - Must be a valid UUID v4 format
+     * - Generated using randomUUID() in challenge service
+     * - Matches DB constraint: varchar(255) but UUID format enforced
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased for consistency
+     *
+     * @example "a21b654c-2746-4168-acee-c175083a65cd"
+     */
     session;
+    /**
+     * MFA method requiring challenge data
+     *
+     * Validation:
+     * - Must be 'passkey' (only method that needs challenge data)
+     */
     method;
 }
 exports.GetChallengeDataDTO = GetChallengeDataDTO;

package/dist/dto/get-challenge-data.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-challenge-data.dto.js","sourceRoot":"","sources":["../../src/dto/get-challenge-data.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAoBA,qDAAiD;AACjD,yDAA8C;AAM9C,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;AACrB,CAAC,EAFW,kBAAkB,kCAAlB,kBAAkB,QAE7B;AAKD,MAAa,mBAAmB;IAsB9B,OAAO,CAAU;IAWjB,MAAM,CAAsB;CAC7B;AAlCD,kDAkCC;AAZC;IAPC,IAAA,wBAAM,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC;IACxE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;oDACe;AAWjB;IAHC,IAAA,wBAAM,EAAC,kBAAkB,EAAE;QAC1B,OAAO,EAAE,yBAAyB;KACnC,CAAC;;mDAC0B"}
+{"version":3,"file":"get-challenge-data.dto.js","sourceRoot":"","sources":["../../src/dto/get-challenge-data.dto.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;AAEH,qDAAiD;AACjD,yDAA8C;AAE9C;;;GAGG;AACH,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;AACrB,CAAC,EAFW,kBAAkB,kCAAlB,kBAAkB,QAE7B;AAED;;GAEG;AACH,MAAa,mBAAmB;IAC9B;;;;;;;;;;;;;OAaG;IAQH,OAAO,CAAU;IAEjB;;;;;OAKG;IAIH,MAAM,CAAsB;CAC7B;AAlCD,kDAkCC;AAZC;IAPC,IAAA,wBAAM,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC;IACxE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;oDACe;AAWjB;IAHC,IAAA,wBAAM,EAAC,kBAAkB,EAAE;QAC1B,OAAO,EAAE,yBAAyB;KACnC,CAAC;;mDAC0B"}

package/dist/dto/get-client-info.dto.d.ts

@@ -1,17 +1,91 @@
+/**
+ * Response DTO for getting client information
+ *
+ * Used to return client information extracted from the current request context.
+ * Includes IP address, user agent, device info, and optional geolocation data.
+ *
+ * @example
+ * ```typescript
+ * const result = await clientInfoService.get();
+ * // Returns: { ipAddress: '192.168.1.100', userAgent: 'Mozilla/5.0...', ... }
+ * ```
+ */
 import { ClientInfo } from '../interfaces/client-info.interface';
+/**
+ * Response DTO for client information
+ */
 export declare class GetClientInfoResponseDTO implements ClientInfo {
+    /**
+     * Client IP address
+     *
+     * Extracted from X-Forwarded-For, CF-Connecting-IP, etc.
+     * Automatically handles proxies and load balancers.
+     * Returns 'unknown' if called outside request context.
+     */
     ipAddress: string;
+    /**
+     * User agent string from the request
+     *
+     * Returns 'unknown' if called outside request context.
+     */
     userAgent: string;
+    /**
+     * Device token for trusted device feature
+     *
+     * Extracted from cookie (nauth_device_token) or header (X-Device-Token).
+     * Optional - only present if device token exists.
+     */
     deviceToken?: string;
+    /**
+     * Optional device name (if provided by client)
+     */
     deviceName?: string;
+    /**
+     * Optional device type (if provided by client)
+     */
     deviceType?: 'mobile' | 'desktop' | 'tablet';
+    /**
+     * Optional IP country (from geolocation, if available)
+     */
     ipCountry?: string;
+    /**
+     * Optional IP city (from geolocation, if available)
+     */
     ipCity?: string;
+    /**
+     * Optional IP latitude (from geolocation, if available)
+     * Used for impossible travel detection
+     */
     ipLatitude?: number;
+    /**
+     * Optional IP longitude (from geolocation, if available)
+     * Used for impossible travel detection
+     */
     ipLongitude?: number;
+    /**
+     * Platform extracted from user agent
+     *
+     * Examples: "iOS", "Android", "Windows", "macOS"
+     */
     platform?: string;
+    /**
+     * Browser extracted from user agent
+     *
+     * Examples: "Chrome", "Safari", "Firefox"
+     */
     browser?: string;
+    /**
+     * Current session ID (if available from authenticated request)
+     *
+     * Extracted from JWT token payload after authentication.
+     */
     sessionId?: number;
+    /**
+     * Current user ID (if available from authenticated request)
+     *
+     * Extracted from JWT token payload (sub claim) after authentication.
+     * Used to identify who performed an action (e.g., for audit trails).
+     */
     userId?: number;
 }
 //# sourceMappingURL=get-client-info.dto.d.ts.map

package/dist/dto/get-client-info.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-client-info.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-client-info.dto.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAKjE,qBAAa,wBAAyB,YAAW,UAAU;IAQzD,SAAS,EAAG,MAAM,CAAC;IAOnB,SAAS,EAAG,MAAM,CAAC;IAQnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAK7C,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAMhB,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAOrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAOlB,OAAO,CAAC,EAAE,MAAM,CAAC;IAOjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAQnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"get-client-info.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-client-info.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAEjE;;GAEG;AACH,qBAAa,wBAAyB,YAAW,UAAU;IACzD;;;;;;OAMG;IACH,SAAS,EAAG,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAG,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/dto/get-client-info.dto.js

@@ -1,19 +1,93 @@
 "use strict";
+/**
+ * Response DTO for getting client information
+ *
+ * Used to return client information extracted from the current request context.
+ * Includes IP address, user agent, device info, and optional geolocation data.
+ *
+ * @example
+ * ```typescript
+ * const result = await clientInfoService.get();
+ * // Returns: { ipAddress: '192.168.1.100', userAgent: 'Mozilla/5.0...', ... }
+ * ```
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetClientInfoResponseDTO = void 0;
+/**
+ * Response DTO for client information
+ */
 class GetClientInfoResponseDTO {
+    /**
+     * Client IP address
+     *
+     * Extracted from X-Forwarded-For, CF-Connecting-IP, etc.
+     * Automatically handles proxies and load balancers.
+     * Returns 'unknown' if called outside request context.
+     */
     ipAddress;
+    /**
+     * User agent string from the request
+     *
+     * Returns 'unknown' if called outside request context.
+     */
     userAgent;
+    /**
+     * Device token for trusted device feature
+     *
+     * Extracted from cookie (nauth_device_token) or header (X-Device-Token).
+     * Optional - only present if device token exists.
+     */
     deviceToken;
+    /**
+     * Optional device name (if provided by client)
+     */
     deviceName;
+    /**
+     * Optional device type (if provided by client)
+     */
     deviceType;
+    /**
+     * Optional IP country (from geolocation, if available)
+     */
     ipCountry;
+    /**
+     * Optional IP city (from geolocation, if available)
+     */
     ipCity;
+    /**
+     * Optional IP latitude (from geolocation, if available)
+     * Used for impossible travel detection
+     */
     ipLatitude;
+    /**
+     * Optional IP longitude (from geolocation, if available)
+     * Used for impossible travel detection
+     */
     ipLongitude;
+    /**
+     * Platform extracted from user agent
+     *
+     * Examples: "iOS", "Android", "Windows", "macOS"
+     */
     platform;
+    /**
+     * Browser extracted from user agent
+     *
+     * Examples: "Chrome", "Safari", "Firefox"
+     */
     browser;
+    /**
+     * Current session ID (if available from authenticated request)
+     *
+     * Extracted from JWT token payload after authentication.
+     */
     sessionId;
+    /**
+     * Current user ID (if available from authenticated request)
+     *
+     * Extracted from JWT token payload (sub claim) after authentication.
+     * Used to identify who performed an action (e.g., for audit trails).
+     */
     userId;
 }
 exports.GetClientInfoResponseDTO = GetClientInfoResponseDTO;

package/dist/dto/get-client-info.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-client-info.dto.js","sourceRoot":"","sources":["../../src/dto/get-client-info.dto.ts"],"names":[],"mappings":";;;AAkBA,MAAa,wBAAwB;IAQnC,SAAS,CAAU;IAOnB,SAAS,CAAU;IAQnB,WAAW,CAAU;IAKrB,UAAU,CAAU;IAKpB,UAAU,CAAmC;IAK7C,SAAS,CAAU;IAKnB,MAAM,CAAU;IAMhB,UAAU,CAAU;IAMpB,WAAW,CAAU;IAOrB,QAAQ,CAAU;IAOlB,OAAO,CAAU;IAOjB,SAAS,CAAU;IAQnB,MAAM,CAAU;CACjB;AArFD,4DAqFC"}
+{"version":3,"file":"get-client-info.dto.js","sourceRoot":"","sources":["../../src/dto/get-client-info.dto.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAIH;;GAEG;AACH,MAAa,wBAAwB;IACnC;;;;;;OAMG;IACH,SAAS,CAAU;IAEnB;;;;OAIG;IACH,SAAS,CAAU;IAEnB;;;;;OAKG;IACH,WAAW,CAAU;IAErB;;OAEG;IACH,UAAU,CAAU;IAEpB;;OAEG;IACH,UAAU,CAAmC;IAE7C;;OAEG;IACH,SAAS,CAAU;IAEnB;;OAEG;IACH,MAAM,CAAU;IAEhB;;;OAGG;IACH,UAAU,CAAU;IAEpB;;;OAGG;IACH,WAAW,CAAU;IAErB;;;;OAIG;IACH,QAAQ,CAAU;IAElB;;;;OAIG;IACH,OAAO,CAAU;IAEjB;;;;OAIG;IACH,SAAS,CAAU;IAEnB;;;;;OAKG;IACH,MAAM,CAAU;CACjB;AArFD,4DAqFC"}

package/dist/dto/get-device-token-response.dto.d.ts

@@ -1,4 +1,25 @@
+/**
+ * Response DTO for getting device token
+ *
+ * Used to return just the device token from the current request context.
+ * Device token is used for trusted device feature.
+ *
+ * @example
+ * ```typescript
+ * const result = await clientInfoService.getDeviceToken();
+ * // Returns: { deviceToken: 'device-token-123' } or { deviceToken: undefined }
+ * ```
+ */
+/**
+ * Response DTO for device token
+ */
 export declare class GetDeviceTokenResponseDTO {
+    /**
+     * Device token for trusted device feature
+     *
+     * Extracted from cookie (nauth_device_token) or header (X-Device-Token).
+     * Optional - undefined if not present.
+     */
     deviceToken?: string;
 }
 //# sourceMappingURL=get-device-token-response.dto.d.ts.map

package/dist/dto/get-device-token-response.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-device-token-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-device-token-response.dto.ts"],"names":[],"mappings":"AAgBA,qBAAa,yBAAyB;IAOpC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"get-device-token-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-device-token-response.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;GAEG;AACH,qBAAa,yBAAyB;IACpC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/dto/get-device-token-response.dto.js

@@ -1,7 +1,28 @@
 "use strict";
+/**
+ * Response DTO for getting device token
+ *
+ * Used to return just the device token from the current request context.
+ * Device token is used for trusted device feature.
+ *
+ * @example
+ * ```typescript
+ * const result = await clientInfoService.getDeviceToken();
+ * // Returns: { deviceToken: 'device-token-123' } or { deviceToken: undefined }
+ * ```
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetDeviceTokenResponseDTO = void 0;
+/**
+ * Response DTO for device token
+ */
 class GetDeviceTokenResponseDTO {
+    /**
+     * Device token for trusted device feature
+     *
+     * Extracted from cookie (nauth_device_token) or header (X-Device-Token).
+     * Optional - undefined if not present.
+     */
     deviceToken;
 }
 exports.GetDeviceTokenResponseDTO = GetDeviceTokenResponseDTO;

package/dist/dto/get-device-token-response.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-device-token-response.dto.js","sourceRoot":"","sources":["../../src/dto/get-device-token-response.dto.ts"],"names":[],"mappings":";;;AAgBA,MAAa,yBAAyB;IAOpC,WAAW,CAAU;CACtB;AARD,8DAQC"}
+{"version":3,"file":"get-device-token-response.dto.js","sourceRoot":"","sources":["../../src/dto/get-device-token-response.dto.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAEH;;GAEG;AACH,MAAa,yBAAyB;IACpC;;;;;OAKG;IACH,WAAW,CAAU;CACtB;AARD,8DAQC"}

package/dist/dto/get-events-by-type.dto.d.ts

@@ -1,17 +1,67 @@
 import { AuthAuditEventType } from '../enums/auth-audit-event-type.enum';
 import { IAuthAudit } from '../interfaces/entities.interface';
+/**
+ * Request DTO for getting events by type
+ *
+ * @example
+ * ```typescript
+ * const result = await auditService.getEventsByType({
+ *   eventType: AuthAuditEventType.SUSPICIOUS_ACTIVITY,
+ *   page: 1,
+ *   limit: 100,
+ *   startDate: new Date('2025-01-01'),
+ * });
+ * ```
+ */
 export declare class GetEventsByTypeDTO {
+    /**
+     * Event type to filter by
+     */
     eventType: AuthAuditEventType;
+    /**
+     * Page number (1-indexed)
+     *
+     * @default 1
+     */
     page?: number;
+    /**
+     * Number of records per page
+     *
+     * @default 50
+     */
     limit?: number;
+    /**
+     * Filter events from this date onwards
+     */
     startDate?: Date;
+    /**
+     * Filter events up to this date
+     */
     endDate?: Date;
 }
+/**
+ * Response DTO for paginated events by type
+ */
 export declare class GetEventsByTypeResponseDTO {
+    /**
+     * Array of audit records
+     */
     data: IAuthAudit[];
+    /**
+     * Total number of records matching the query
+     */
     total: number;
+    /**
+     * Current page number
+     */
     page: number;
+    /**
+     * Number of records per page
+     */
     limit: number;
+    /**
+     * Total number of pages
+     */
     totalPages: number;
 }
 //# sourceMappingURL=get-events-by-type.dto.d.ts.map

package/dist/dto/get-events-by-type.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-events-by-type.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-events-by-type.dto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAe9D,qBAAa,kBAAkB;IAI7B,SAAS,EAAG,kBAAkB,CAAC;IAO/B,IAAI,CAAC,EAAE,MAAM,CAAC;IAOd,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,SAAS,CAAC,EAAE,IAAI,CAAC;IAKjB,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB;AAKD,qBAAa,0BAA0B;IAIrC,IAAI,EAAG,UAAU,EAAE,CAAC;IAKpB,KAAK,EAAG,MAAM,CAAC;IAKf,IAAI,EAAG,MAAM,CAAC;IAKd,KAAK,EAAG,MAAM,CAAC;IAKf,UAAU,EAAG,MAAM,CAAC;CACrB"}
+{"version":3,"file":"get-events-by-type.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-events-by-type.dto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,SAAS,EAAG,kBAAkB,CAAC;IAE/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,0BAA0B;IACrC;;OAEG;IACH,IAAI,EAAG,UAAU,EAAE,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAG,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAG,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAG,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAG,MAAM,CAAC;CACrB"}

package/dist/dto/get-events-by-type.dto.js

@@ -1,19 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetEventsByTypeResponseDTO = exports.GetEventsByTypeDTO = void 0;
+/**
+ * Request DTO for getting events by type
+ *
+ * @example
+ * ```typescript
+ * const result = await auditService.getEventsByType({
+ *   eventType: AuthAuditEventType.SUSPICIOUS_ACTIVITY,
+ *   page: 1,
+ *   limit: 100,
+ *   startDate: new Date('2025-01-01'),
+ * });
+ * ```
+ */
 class GetEventsByTypeDTO {
+    /**
+     * Event type to filter by
+     */
     eventType;
+    /**
+     * Page number (1-indexed)
+     *
+     * @default 1
+     */
     page;
+    /**
+     * Number of records per page
+     *
+     * @default 50
+     */
     limit;
+    /**
+     * Filter events from this date onwards
+     */
     startDate;
+    /**
+     * Filter events up to this date
+     */
     endDate;
 }
 exports.GetEventsByTypeDTO = GetEventsByTypeDTO;
+/**
+ * Response DTO for paginated events by type
+ */
 class GetEventsByTypeResponseDTO {
+    /**
+     * Array of audit records
+     */
     data;
+    /**
+     * Total number of records matching the query
+     */
     total;
+    /**
+     * Current page number
+     */
     page;
+    /**
+     * Number of records per page
+     */
     limit;
+    /**
+     * Total number of pages
+     */
     totalPages;
 }
 exports.GetEventsByTypeResponseDTO = GetEventsByTypeResponseDTO;

package/dist/dto/get-events-by-type.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-events-by-type.dto.js","sourceRoot":"","sources":["../../src/dto/get-events-by-type.dto.ts"],"names":[],"mappings":";;;AAgBA,MAAa,kBAAkB;IAI7B,SAAS,CAAsB;IAO/B,IAAI,CAAU;IAOd,KAAK,CAAU;IAKf,SAAS,CAAQ;IAKjB,OAAO,CAAQ;CAChB;AA7BD,gDA6BC;AAKD,MAAa,0BAA0B;IAIrC,IAAI,CAAgB;IAKpB,KAAK,CAAU;IAKf,IAAI,CAAU;IAKd,KAAK,CAAU;IAKf,UAAU,CAAU;CACrB;AAzBD,gEAyBC"}
+{"version":3,"file":"get-events-by-type.dto.js","sourceRoot":"","sources":["../../src/dto/get-events-by-type.dto.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;;;;;GAYG;AACH,MAAa,kBAAkB;IAC7B;;OAEG;IACH,SAAS,CAAsB;IAE/B;;;;OAIG;IACH,IAAI,CAAU;IAEd;;;;OAIG;IACH,KAAK,CAAU;IAEf;;OAEG;IACH,SAAS,CAAQ;IAEjB;;OAEG;IACH,OAAO,CAAQ;CAChB;AA7BD,gDA6BC;AAED;;GAEG;AACH,MAAa,0BAA0B;IACrC;;OAEG;IACH,IAAI,CAAgB;IAEpB;;OAEG;IACH,KAAK,CAAU;IAEf;;OAEG;IACH,IAAI,CAAU;IAEd;;OAEG;IACH,KAAK,CAAU;IAEf;;OAEG;IACH,UAAU,CAAU;CACrB;AAzBD,gEAyBC"}

package/dist/dto/get-ip-address-response.dto.d.ts

@@ -1,4 +1,24 @@
+/**
+ * Response DTO for getting IP address
+ *
+ * Used to return just the IP address from the current request context.
+ *
+ * @example
+ * ```typescript
+ * const result = await clientInfoService.getIpAddress();
+ * // Returns: { ipAddress: '192.168.1.100' }
+ * ```
+ */
+/**
+ * Response DTO for IP address
+ */
 export declare class GetIpAddressResponseDTO {
+    /**
+     * Client IP address
+     *
+     * Extracted from X-Forwarded-For, CF-Connecting-IP, etc.
+     * Returns 'unknown' if called outside request context.
+     */
     ipAddress: string;
 }
 //# sourceMappingURL=get-ip-address-response.dto.d.ts.map

package/dist/dto/get-ip-address-response.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-ip-address-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-ip-address-response.dto.ts"],"names":[],"mappings":"AAeA,qBAAa,uBAAuB;IAOlC,SAAS,EAAG,MAAM,CAAC;CACpB"}
+{"version":3,"file":"get-ip-address-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-ip-address-response.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,qBAAa,uBAAuB;IAClC;;;;;OAKG;IACH,SAAS,EAAG,MAAM,CAAC;CACpB"}