@nauth-toolkit/core 0.1.14 → 0.1.17

package/dist/dto/change-password.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"change-password.dto.js","sourceRoot":"","sources":["../../src/dto/change-password.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAuBA,qDAAiE;AAEjE,MAAa,iBAAiB;IAU5B,WAAW,CAAU;IAoBrB,WAAW,CAAU;CACtB;AA/BD,8CA+BC;AArBC;IADC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;;sDAClC;AAoBrB;IAHC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IACtD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE,CAAC;IACnE,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;;sDAClD"}
+{"version":3,"file":"change-password.dto.js","sourceRoot":"","sources":["../../src/dto/change-password.dto.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;;;;;;;;;;AAEH,qDAAiE;AAEjE,MAAa,iBAAiB;IAC5B;;;;;;;OAOG;IAEH,WAAW,CAAU;IAErB;;;;;;;;;;;;;;OAcG;IAIH,WAAW,CAAU;CACtB;AA/BD,8CA+BC;AArBC;IADC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;;sDAClC;AAoBrB;IAHC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IACtD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE,CAAC;IACnE,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;;sDAClD"}

package/dist/dto/confirm-forgot-password.dto.d.ts

@@ -1,10 +1,69 @@
+/**
+ * Confirm Forgot Password DTO
+ *
+ * Confirms a password reset request by validating the verification code and
+ * setting a new password.
+ *
+ * Security:
+ * - Code format validated (numeric string + fixed length).
+ * - Password policy is enforced in the service layer.
+ *
+ * @example
+ * ```typescript
+ * await authService.confirmForgotPassword({
+ *   identifier: 'user@example.com',
+ *   code: '123456',
+ *   newPassword: 'NewSecurePassword123!'
+ * });
+ * ```
+ */
 export declare class ConfirmForgotPasswordDTO {
+    /**
+     * User identifier used to locate the account.
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased when email format detected (contains '@')
+     */
     identifier: string;
+    /**
+     * Verification code delivered via email/SMS.
+     *
+     * Validation:
+     * - Numeric string
+     * - Exact length 6 (default). If a deployment changes length, the service layer
+     *   can also validate against config for backward compatibility.
+     */
     code: string;
+    /**
+     * New password to set on the account.
+     *
+     * Validation:
+     * - 8-128 characters (baseline)
+     * - NOT trimmed (passwords may intentionally contain leading/trailing spaces)
+     */
     newPassword: string;
 }
+/**
+ * Confirm Forgot Password Response DTO
+ *
+ * Response for a confirmed password reset.
+ *
+ * @example
+ * ```typescript
+ * { success: true, mustChangePassword: false }
+ * ```
+ */
 export declare class ConfirmForgotPasswordResponseDTO {
+    /**
+     * True when reset was confirmed and password updated.
+     */
     success: boolean;
+    /**
+     * Whether user must change password on next sign-in.
+     *
+     * For forgot-password flows this should typically be false (password is just set).
+     */
     mustChangePassword: boolean;
 }
 //# sourceMappingURL=confirm-forgot-password.dto.d.ts.map

package/dist/dto/confirm-forgot-password.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"confirm-forgot-password.dto.d.ts","sourceRoot":"","sources":["../../src/dto/confirm-forgot-password.dto.ts"],"names":[],"mappings":"AAsBA,qBAAa,wBAAwB;IAsBnC,UAAU,EAAG,MAAM,CAAC;IAepB,IAAI,EAAG,MAAM,CAAC;IAad,WAAW,EAAG,MAAM,CAAC;CACtB;AAYD,qBAAa,gCAAgC;IAI3C,OAAO,EAAG,OAAO,CAAC;IAOlB,kBAAkB,EAAG,OAAO,CAAC;CAC9B"}
+{"version":3,"file":"confirm-forgot-password.dto.d.ts","sourceRoot":"","sources":["../../src/dto/confirm-forgot-password.dto.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,wBAAwB;IACnC;;;;;;OAMG;IAeH,UAAU,EAAG,MAAM,CAAC;IAEpB;;;;;;;OAOG;IAMH,IAAI,EAAG,MAAM,CAAC;IAEd;;;;;;OAMG;IAKH,WAAW,EAAG,MAAM,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,qBAAa,gCAAgC;IAC3C;;OAEG;IACH,OAAO,EAAG,OAAO,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,EAAG,OAAO,CAAC;CAC9B"}

package/dist/dto/confirm-forgot-password.dto.js

@@ -12,9 +12,50 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfirmForgotPasswordResponseDTO = exports.ConfirmForgotPasswordDTO = void 0;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
+/**
+ * Confirm Forgot Password DTO
+ *
+ * Confirms a password reset request by validating the verification code and
+ * setting a new password.
+ *
+ * Security:
+ * - Code format validated (numeric string + fixed length).
+ * - Password policy is enforced in the service layer.
+ *
+ * @example
+ * ```typescript
+ * await authService.confirmForgotPassword({
+ *   identifier: 'user@example.com',
+ *   code: '123456',
+ *   newPassword: 'NewSecurePassword123!'
+ * });
+ * ```
+ */
 class ConfirmForgotPasswordDTO {
+    /**
+     * User identifier used to locate the account.
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased when email format detected (contains '@')
+     */
     identifier;
+    /**
+     * Verification code delivered via email/SMS.
+     *
+     * Validation:
+     * - Numeric string
+     * - Exact length 6 (default). If a deployment changes length, the service layer
+     *   can also validate against config for backward compatibility.
+     */
     code;
+    /**
+     * New password to set on the account.
+     *
+     * Validation:
+     * - 8-128 characters (baseline)
+     * - NOT trimmed (passwords may intentionally contain leading/trailing spaces)
+     */
     newPassword;
 }
 exports.ConfirmForgotPasswordDTO = ConfirmForgotPasswordDTO;
@@ -50,8 +91,26 @@ __decorate([
     (0, class_validator_1.MaxLength)(128, { message: 'Password must not exceed 128 characters' }),
     __metadata("design:type", String)
 ], ConfirmForgotPasswordDTO.prototype, "newPassword", void 0);
+/**
+ * Confirm Forgot Password Response DTO
+ *
+ * Response for a confirmed password reset.
+ *
+ * @example
+ * ```typescript
+ * { success: true, mustChangePassword: false }
+ * ```
+ */
 class ConfirmForgotPasswordResponseDTO {
+    /**
+     * True when reset was confirmed and password updated.
+     */
     success;
+    /**
+     * Whether user must change password on next sign-in.
+     *
+     * For forgot-password flows this should typically be false (password is just set).
+     */
     mustChangePassword;
 }
 exports.ConfirmForgotPasswordResponseDTO = ConfirmForgotPasswordResponseDTO;

package/dist/dto/confirm-forgot-password.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"confirm-forgot-password.dto.js","sourceRoot":"","sources":["../../src/dto/confirm-forgot-password.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAqG;AACrG,yDAA8C;AAqB9C,MAAa,wBAAwB;IAsBnC,UAAU,CAAU;IAepB,IAAI,CAAU;IAad,WAAW,CAAU;CACtB;AAnDD,4DAmDC;AA7BC;IAdC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACpD,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACjD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;IACxE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;YAC/B,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;4DACkB;AAepB;IALC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IAC9C,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC3C,IAAA,gCAAc,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IAChE,IAAA,wBAAM,EAAC,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IAC1D,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;;sDAC/D;AAad;IAJC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IACtD,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE,CAAC;IACnE,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;;6DAClD;AAavB,MAAa,gCAAgC;IAI3C,OAAO,CAAW;IAOlB,kBAAkB,CAAW;CAC9B;AAZD,4EAYC"}
+{"version":3,"file":"confirm-forgot-password.dto.js","sourceRoot":"","sources":["../../src/dto/confirm-forgot-password.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAqG;AACrG,yDAA8C;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,wBAAwB;IACnC;;;;;;OAMG;IAeH,UAAU,CAAU;IAEpB;;;;;;;OAOG;IAMH,IAAI,CAAU;IAEd;;;;;;OAMG;IAKH,WAAW,CAAU;CACtB;AAnDD,4DAmDC;AA7BC;IAdC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACpD,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACjD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;IACxE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;YAC/B,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;4DACkB;AAepB;IALC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IAC9C,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC3C,IAAA,gCAAc,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IAChE,IAAA,wBAAM,EAAC,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IAC1D,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;;sDAC/D;AAad;IAJC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;IACtD,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE,CAAC;IACnE,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;;6DAClD;AAGvB;;;;;;;;;GASG;AACH,MAAa,gCAAgC;IAC3C;;OAEG;IACH,OAAO,CAAW;IAElB;;;;OAIG;IACH,kBAAkB,CAAW;CAC9B;AAZD,4EAYC"}

package/dist/dto/error-response.dto.d.ts

@@ -1,9 +1,112 @@
+/**
+ * Standard error response format for all nauth-toolkit errors
+ *
+ * Provides structured error responses with error codes, metadata,
+ * and consistent formatting across all authentication operations.
+ *
+ * @example
+ * ```typescript
+ * // Rate limit error response
+ * {
+ *   statusCode: 429,
+ *   code: 'RATE_LIMIT_SMS',
+ *   message: 'Too many verification SMS sent. Please try again later.',
+ *   details: {
+ *     retryAfter: 3600,
+ *     currentCount: 4,
+ *     maxAttempts: 3,
+ *     resetAt: '2025-11-01T02:43:03.132Z'
+ *   },
+ *   timestamp: '2025-10-31T01:43:03.132Z',
+ *   path: '/auth/verify-phone/send'
+ * }
+ * ```
+ */
 export declare class ErrorResponseDTO {
+    /**
+     * HTTP status code
+     *
+     * Validation:
+     * - Must be a number
+     * - Valid HTTP status code range (100-599)
+     *
+     * @example 400
+     */
     statusCode: number;
+    /**
+     * Error code for programmatic handling
+     *
+     * Allows frontend to identify specific errors without parsing messages.
+     * Useful for i18n, specific error handling, and analytics.
+     *
+     * Validation:
+     * - Must be a string
+     * - Max 100 characters (prevents oversized error codes)
+     * - Alphanumeric and underscores only
+     *
+     * @example "RATE_LIMIT_SMS"
+     */
     code: string;
+    /**
+     * Human-readable error message
+     *
+     * Should be clear and actionable. Can be displayed directly to users
+     * or used as fallback when error code doesn't have a translation.
+     *
+     * Validation:
+     * - Must be a string
+     * - Max 500 characters (prevents oversized messages)
+     *
+     * @example "Too many verification SMS sent. Please try again later."
+     */
     message: string;
+    /**
+     * Additional error details (optional)
+     *
+     * Provides context-specific metadata that can be used for:
+     * - Retry logic (retryAfter, resetAt)
+     * - Validation errors (field names, validation rules)
+     * - Rate limiting (current count, max attempts)
+     * - Debugging (correlation IDs, request IDs)
+     *
+     * Validation:
+     * - Must be an object if present
+     *
+     * @example
+     * ```typescript
+     * {
+     *   retryAfter: 3600,
+     *   currentCount: 4,
+     *   maxAttempts: 3,
+     *   resetAt: '2025-11-01T02:43:03.132Z'
+     * }
+     * ```
+     */
     details?: Record<string, unknown>;
+    /**
+     * Timestamp when error occurred
+     *
+     * ISO 8601 format for consistent timezone handling.
+     *
+     * Validation:
+     * - Must be a string
+     * - Must match ISO 8601 format
+     * - Max 30 characters (ISO 8601 timestamp length)
+     *
+     * @example "2025-10-31T01:43:03.132Z"
+     */
     timestamp: string;
+    /**
+     * Request path where error occurred
+     *
+     * Useful for debugging and error tracking.
+     *
+     * Validation:
+     * - Must be a string if present
+     * - Max 500 characters (prevents oversized paths)
+     *
+     * @example "/auth/verify-phone/send"
+     */
     path?: string;
 }
 //# sourceMappingURL=error-response.dto.d.ts.map

package/dist/dto/error-response.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/error-response.dto.ts"],"names":[],"mappings":"AA0BA,qBAAa,gBAAgB;IAW3B,UAAU,EAAG,MAAM,CAAC;IAoBpB,IAAI,EAAG,MAAM,CAAC;IAgBd,OAAO,EAAG,MAAM,CAAC;IA0BjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmBlC,SAAS,EAAG,MAAM,CAAC;IAgBnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"error-response.dto.d.ts","sourceRoot":"","sources":["../../src/dto/error-response.dto.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,gBAAgB;IAC3B;;;;;;;;OAQG;IAEH,UAAU,EAAG,MAAM,CAAC;IAEpB;;;;;;;;;;;;OAYG;IAMH,IAAI,EAAG,MAAM,CAAC;IAEd;;;;;;;;;;;OAWG;IAGH,OAAO,EAAG,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IAGH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;;;;;;;;;OAWG;IAMH,SAAS,EAAG,MAAM,CAAC;IAEnB;;;;;;;;;;OAUG;IAIH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}

package/dist/dto/error-response.dto.js

@@ -11,12 +11,115 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponseDTO = void 0;
 const class_validator_1 = require("class-validator");
+/**
+ * Standard error response format for all nauth-toolkit errors
+ *
+ * Provides structured error responses with error codes, metadata,
+ * and consistent formatting across all authentication operations.
+ *
+ * @example
+ * ```typescript
+ * // Rate limit error response
+ * {
+ *   statusCode: 429,
+ *   code: 'RATE_LIMIT_SMS',
+ *   message: 'Too many verification SMS sent. Please try again later.',
+ *   details: {
+ *     retryAfter: 3600,
+ *     currentCount: 4,
+ *     maxAttempts: 3,
+ *     resetAt: '2025-11-01T02:43:03.132Z'
+ *   },
+ *   timestamp: '2025-10-31T01:43:03.132Z',
+ *   path: '/auth/verify-phone/send'
+ * }
+ * ```
+ */
 class ErrorResponseDTO {
+    /**
+     * HTTP status code
+     *
+     * Validation:
+     * - Must be a number
+     * - Valid HTTP status code range (100-599)
+     *
+     * @example 400
+     */
     statusCode;
+    /**
+     * Error code for programmatic handling
+     *
+     * Allows frontend to identify specific errors without parsing messages.
+     * Useful for i18n, specific error handling, and analytics.
+     *
+     * Validation:
+     * - Must be a string
+     * - Max 100 characters (prevents oversized error codes)
+     * - Alphanumeric and underscores only
+     *
+     * @example "RATE_LIMIT_SMS"
+     */
     code;
+    /**
+     * Human-readable error message
+     *
+     * Should be clear and actionable. Can be displayed directly to users
+     * or used as fallback when error code doesn't have a translation.
+     *
+     * Validation:
+     * - Must be a string
+     * - Max 500 characters (prevents oversized messages)
+     *
+     * @example "Too many verification SMS sent. Please try again later."
+     */
     message;
+    /**
+     * Additional error details (optional)
+     *
+     * Provides context-specific metadata that can be used for:
+     * - Retry logic (retryAfter, resetAt)
+     * - Validation errors (field names, validation rules)
+     * - Rate limiting (current count, max attempts)
+     * - Debugging (correlation IDs, request IDs)
+     *
+     * Validation:
+     * - Must be an object if present
+     *
+     * @example
+     * ```typescript
+     * {
+     *   retryAfter: 3600,
+     *   currentCount: 4,
+     *   maxAttempts: 3,
+     *   resetAt: '2025-11-01T02:43:03.132Z'
+     * }
+     * ```
+     */
     details;
+    /**
+     * Timestamp when error occurred
+     *
+     * ISO 8601 format for consistent timezone handling.
+     *
+     * Validation:
+     * - Must be a string
+     * - Must match ISO 8601 format
+     * - Max 30 characters (ISO 8601 timestamp length)
+     *
+     * @example "2025-10-31T01:43:03.132Z"
+     */
     timestamp;
+    /**
+     * Request path where error occurred
+     *
+     * Useful for debugging and error tracking.
+     *
+     * Validation:
+     * - Must be a string if present
+     * - Max 500 characters (prevents oversized paths)
+     *
+     * @example "/auth/verify-phone/send"
+     */
     path;
 }
 exports.ErrorResponseDTO = ErrorResponseDTO;

package/dist/dto/error-response.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"error-response.dto.js","sourceRoot":"","sources":["../../src/dto/error-response.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA+F;AA0B/F,MAAa,gBAAgB;IAW3B,UAAU,CAAU;IAoBpB,IAAI,CAAU;IAgBd,OAAO,CAAU;IA0BjB,OAAO,CAA2B;IAmBlC,SAAS,CAAU;IAgBnB,IAAI,CAAU;CACf;AA7GD,4CA6GC;AAlGC;IADC,IAAA,0BAAQ,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;;oDACtC;AAoBpB;IALC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACpD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;IACxE,IAAA,yBAAO,EAAC,cAAc,EAAE;QACvB,OAAO,EAAE,yEAAyE;KACnF,CAAC;;8CACY;AAgBd;IAFC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC;IACvD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC;;iDAC3D;AA0BjB;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC;;iDACvB;AAmBlC;IALC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;IACrE,IAAA,yBAAO,EAAC,kDAAkD,EAAE;QAC3D,OAAO,EAAE,sCAAsC;KAChD,CAAC;;mDACiB;AAgBnB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IAC9C,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,qCAAqC,EAAE,CAAC;;8CACrD"}
+{"version":3,"file":"error-response.dto.js","sourceRoot":"","sources":["../../src/dto/error-response.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA+F;AAE/F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,gBAAgB;IAC3B;;;;;;;;OAQG;IAEH,UAAU,CAAU;IAEpB;;;;;;;;;;;;OAYG;IAMH,IAAI,CAAU;IAEd;;;;;;;;;;;OAWG;IAGH,OAAO,CAAU;IAEjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IAGH,OAAO,CAA2B;IAElC;;;;;;;;;;;OAWG;IAMH,SAAS,CAAU;IAEnB;;;;;;;;;;OAUG;IAIH,IAAI,CAAU;CACf;AA7GD,4CA6GC;AAlGC;IADC,IAAA,0BAAQ,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;;oDACtC;AAoBpB;IALC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACpD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;IACxE,IAAA,yBAAO,EAAC,cAAc,EAAE;QACvB,OAAO,EAAE,yEAAyE;KACnF,CAAC;;8CACY;AAgBd;IAFC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC;IACvD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC;;iDAC3D;AA0BjB;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC;;iDACvB;AAmBlC;IALC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;IACrE,IAAA,yBAAO,EAAC,kDAAkD,EAAE;QAC3D,OAAO,EAAE,sCAAsC;KAChD,CAAC;;mDACiB;AAgBnB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IAC9C,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,qCAAqC,EAAE,CAAC;;8CACrD"}

package/dist/dto/forgot-password.dto.d.ts

@@ -1,10 +1,68 @@
+/**
+ * Forgot Password DTO
+ *
+ * Request a password reset code for a user account.
+ *
+ * Security:
+ * - This endpoint should not reveal whether an account exists.
+ * - Identifier is sanitized (trimmed, email lowercased when detected).
+ *
+ * @example
+ * ```typescript
+ * await authService.forgotPassword({ identifier: 'user@example.com' });
+ * ```
+ */
 export declare class ForgotPasswordDTO {
+    /**
+     * User identifier used to locate the account.
+     *
+     * Accepts email, username, or phone depending on application login policy.
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased when email format detected (contains '@')
+     */
     identifier: string;
 }
+/**
+ * Forgot Password Response DTO
+ *
+ * Response for a password reset request.
+ *
+ * Security:
+ * - `success` should be true even when the identifier does not map to any user,
+ *   to prevent account enumeration.
+ *
+ * @example
+ * ```typescript
+ * {
+ *   success: true,
+ *   destination: "j***@example.com",
+ *   deliveryMedium: "email",
+ *   expiresIn: 900
+ * }
+ * ```
+ */
 export declare class ForgotPasswordResponseDTO {
+    /**
+     * Always true when request accepted (regardless of account existence).
+     */
     success: boolean;
+    /**
+     * Masked delivery destination (email or phone) when available.
+     *
+     * Examples:
+     * - `j***@example.com`
+     * - `+1***1234`
+     */
     destination?: string;
+    /**
+     * Delivery channel used.
+     */
     deliveryMedium?: 'email' | 'sms';
+    /**
+     * Code expiry in seconds.
+     */
     expiresIn?: number;
 }
 //# sourceMappingURL=forgot-password.dto.d.ts.map

package/dist/dto/forgot-password.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forgot-password.dto.d.ts","sourceRoot":"","sources":["../../src/dto/forgot-password.dto.ts"],"names":[],"mappings":"AAiBA,qBAAa,iBAAiB;IAwB5B,UAAU,EAAG,MAAM,CAAC;CACrB;AAqBD,qBAAa,yBAAyB;IAIpC,OAAO,EAAG,OAAO,CAAC;IASlB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAKjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"forgot-password.dto.d.ts","sourceRoot":"","sources":["../../src/dto/forgot-password.dto.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAiB;IAC5B;;;;;;;;OAQG;IAeH,UAAU,EAAG,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,yBAAyB;IACpC;;OAEG;IACH,OAAO,EAAG,OAAO,CAAC;IAElB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/dto/forgot-password.dto.js

@@ -12,7 +12,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForgotPasswordResponseDTO = exports.ForgotPasswordDTO = void 0;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
+/**
+ * Forgot Password DTO
+ *
+ * Request a password reset code for a user account.
+ *
+ * Security:
+ * - This endpoint should not reveal whether an account exists.
+ * - Identifier is sanitized (trimmed, email lowercased when detected).
+ *
+ * @example
+ * ```typescript
+ * await authService.forgotPassword({ identifier: 'user@example.com' });
+ * ```
+ */
 class ForgotPasswordDTO {
+    /**
+     * User identifier used to locate the account.
+     *
+     * Accepts email, username, or phone depending on application login policy.
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased when email format detected (contains '@')
+     */
     identifier;
 }
 exports.ForgotPasswordDTO = ForgotPasswordDTO;
@@ -33,10 +56,45 @@ __decorate([
     }),
     __metadata("design:type", String)
 ], ForgotPasswordDTO.prototype, "identifier", void 0);
+/**
+ * Forgot Password Response DTO
+ *
+ * Response for a password reset request.
+ *
+ * Security:
+ * - `success` should be true even when the identifier does not map to any user,
+ *   to prevent account enumeration.
+ *
+ * @example
+ * ```typescript
+ * {
+ *   success: true,
+ *   destination: "j***@example.com",
+ *   deliveryMedium: "email",
+ *   expiresIn: 900
+ * }
+ * ```
+ */
 class ForgotPasswordResponseDTO {
+    /**
+     * Always true when request accepted (regardless of account existence).
+     */
     success;
+    /**
+     * Masked delivery destination (email or phone) when available.
+     *
+     * Examples:
+     * - `j***@example.com`
+     * - `+1***1234`
+     */
     destination;
+    /**
+     * Delivery channel used.
+     */
     deliveryMedium;
+    /**
+     * Code expiry in seconds.
+     */
     expiresIn;
 }
 exports.ForgotPasswordResponseDTO = ForgotPasswordResponseDTO;

package/dist/dto/forgot-password.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"forgot-password.dto.js","sourceRoot":"","sources":["../../src/dto/forgot-password.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA6E;AAC7E,yDAA8C;AAgB9C,MAAa,iBAAiB;IAwB5B,UAAU,CAAU;CACrB;AAzBD,8CAyBC;AADC;IAdC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACpD,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACjD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;IACxE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;YAC/B,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;qDACkB;AAsBtB,MAAa,yBAAyB;IAIpC,OAAO,CAAW;IASlB,WAAW,CAAU;IAKrB,cAAc,CAAmB;IAKjC,SAAS,CAAU;CACpB;AAxBD,8DAwBC"}
+{"version":3,"file":"forgot-password.dto.js","sourceRoot":"","sources":["../../src/dto/forgot-password.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA6E;AAC7E,yDAA8C;AAE9C;;;;;;;;;;;;;GAaG;AACH,MAAa,iBAAiB;IAC5B;;;;;;;;OAQG;IAeH,UAAU,CAAU;CACrB;AAzBD,8CAyBC;AADC;IAdC,IAAA,0BAAQ,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACpD,IAAA,4BAAU,EAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACjD,IAAA,2BAAS,EAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACnD,IAAA,2BAAS,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;IACxE,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;YAC/B,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;;qDACkB;AAGtB;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,yBAAyB;IACpC;;OAEG;IACH,OAAO,CAAW;IAElB;;;;;;OAMG;IACH,WAAW,CAAU;IAErB;;OAEG;IACH,cAAc,CAAmB;IAEjC;;OAEG;IACH,SAAS,CAAU;CACpB;AAxBD,8DAwBC"}

package/dist/dto/get-available-methods.dto.d.ts

@@ -1,7 +1,44 @@
+/**
+ * DTO for getting available MFA methods
+ *
+ * Used to retrieve all registered and allowed MFA methods that can be set up for a user.
+ *
+ * @example
+ * ```typescript
+ * const methods = await mfaService.getAvailableMethods({
+ *   sub: 'user-uuid'
+ * });
+ * // Returns: ['totp', 'sms', 'passkey']
+ * ```
+ */
+/**
+ * DTO for getting available MFA methods
+ */
 export declare class GetAvailableMethodsDTO {
+    /**
+     * User's unique identifier (UUID v4)
+     *
+     * Validation:
+     * - Must be a valid UUID v4 format
+     * - Matches DB constraint: char(36) or uuid
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased for consistency
+     *
+     * @example "a21b654c-2746-4168-acee-c175083a65cd"
+     */
     sub: string;
 }
+/**
+ * Response DTO for available MFA methods
+ */
 export declare class GetAvailableMethodsResponseDTO {
+    /**
+     * Array of available method names
+     *
+     * @example ['totp', 'sms', 'passkey', 'email']
+     */
     availableMethods: string[];
 }
 //# sourceMappingURL=get-available-methods.dto.d.ts.map

package/dist/dto/get-available-methods.dto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-available-methods.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-available-methods.dto.ts"],"names":[],"mappings":"AAoBA,qBAAa,sBAAsB;IAqBjC,GAAG,EAAG,MAAM,CAAC;CACd;AAKD,qBAAa,8BAA8B;IAMzC,gBAAgB,EAAG,MAAM,EAAE,CAAC;CAC7B"}
+{"version":3,"file":"get-available-methods.dto.d.ts","sourceRoot":"","sources":["../../src/dto/get-available-methods.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAKH;;GAEG;AACH,qBAAa,sBAAsB;IACjC;;;;;;;;;;;;OAYG;IAQH,GAAG,EAAG,MAAM,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,8BAA8B;IACzC;;;;OAIG;IACH,gBAAgB,EAAG,MAAM,EAAE,CAAC;CAC7B"}

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

@@ -1,4 +1,17 @@
 "use strict";
+/**
+ * DTO for getting available MFA methods
+ *
+ * Used to retrieve all registered and allowed MFA methods that can be set up for a user.
+ *
+ * @example
+ * ```typescript
+ * const methods = await mfaService.getAvailableMethods({
+ *   sub: 'user-uuid'
+ * });
+ * // Returns: ['totp', 'sms', 'passkey']
+ * ```
+ */
 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,7 +25,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetAvailableMethodsResponseDTO = exports.GetAvailableMethodsDTO = void 0;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
+/**
+ * DTO for getting available MFA methods
+ */
 class GetAvailableMethodsDTO {
+    /**
+     * User's unique identifier (UUID v4)
+     *
+     * Validation:
+     * - Must be a valid UUID v4 format
+     * - Matches DB constraint: char(36) or uuid
+     *
+     * Sanitization:
+     * - Trimmed
+     * - Lowercased for consistency
+     *
+     * @example "a21b654c-2746-4168-acee-c175083a65cd"
+     */
     sub;
 }
 exports.GetAvailableMethodsDTO = GetAvailableMethodsDTO;
@@ -26,7 +55,15 @@ __decorate([
     }),
     __metadata("design:type", String)
 ], GetAvailableMethodsDTO.prototype, "sub", void 0);
+/**
+ * Response DTO for available MFA methods
+ */
 class GetAvailableMethodsResponseDTO {
+    /**
+     * Array of available method names
+     *
+     * @example ['totp', 'sms', 'passkey', 'email']
+     */
     availableMethods;
 }
 exports.GetAvailableMethodsResponseDTO = GetAvailableMethodsResponseDTO;