@nauth-toolkit/core 0.1.13 → 0.1.17

package/dist/enums/error-codes.enum.d.ts

@@ -1,57 +1,353 @@
+/**
+ * Authentication Error Codes
+ *
+ * Standardized error codes for all nauth-toolkit errors.
+ * Organized by category for easy navigation and maintenance.
+ *
+ * **Benefits:**
+ * - Programmatic error handling (no string parsing)
+ * - Internationalization support
+ * - Better analytics and monitoring
+ * - Type-safe error checking
+ *
+ * @example
+ * ```typescript
+ * // Backend
+ * throw new NAuthException(
+ *   AuthErrorCode.RATE_LIMIT_SMS,
+ *   'Too many SMS sent',
+ *   HttpStatus.TOO_MANY_REQUESTS,
+ *   { retryAfter: 3600 }
+ * );
+ *
+ * // Frontend
+ * if (error.code === AuthErrorCode.RATE_LIMIT_SMS) {
+ *   showRetryTimer(error.details.retryAfter);
+ * }
+ * ```
+ */
 export declare enum AuthErrorCode {
+    /**
+     * Invalid username/email or password
+     *
+     * Used when credentials don't match any user or password is incorrect.
+     */
     INVALID_CREDENTIALS = "AUTH_INVALID_CREDENTIALS",
+    /**
+     * Account has been locked due to too many failed attempts
+     *
+     * Temporary lockout for security. Includes lockout duration in details.
+     */
     ACCOUNT_LOCKED = "AUTH_ACCOUNT_LOCKED",
+    /**
+     * Account is inactive or disabled
+     *
+     * Account exists but has been deactivated by admin or user.
+     */
     ACCOUNT_INACTIVE = "AUTH_ACCOUNT_INACTIVE",
+    /**
+     * Access token has expired
+     *
+     * Client should attempt token refresh.
+     */
     TOKEN_EXPIRED = "AUTH_TOKEN_EXPIRED",
+    /**
+     * Token is invalid or malformed
+     *
+     * Token signature verification failed or token format is invalid.
+     */
     TOKEN_INVALID = "AUTH_TOKEN_INVALID",
+    /**
+     * Bearer tokens are not allowed in the current delivery mode
+     *
+     * Used when tokenDelivery.method is 'cookies' and an Authorization header
+     * (Bearer token) is provided, which would bypass httpOnly protections.
+     */
     BEARER_NOT_ALLOWED = "AUTH_BEARER_NOT_ALLOWED",
+    /**
+     * Cookie-based tokens are not allowed in the current delivery mode
+     *
+     * Used when tokenDelivery.method is 'json' and cookie tokens are present.
+     */
     COOKIES_NOT_ALLOWED = "AUTH_COOKIES_NOT_ALLOWED",
+    /**
+     * CSRF token is invalid or missing
+     *
+     * Used when CSRF protection is enabled and token validation fails.
+     */
     CSRF_TOKEN_INVALID = "AUTH_CSRF_TOKEN_INVALID",
+    /**
+     * CSRF token is missing from request
+     *
+     * Used when CSRF protection is enabled but no token is provided.
+     */
     CSRF_TOKEN_MISSING = "AUTH_CSRF_TOKEN_MISSING",
+    /**
+     * Refresh token reuse detected - security violation
+     *
+     * All sessions have been revoked. User must login again.
+     */
     TOKEN_REUSE_DETECTED = "AUTH_TOKEN_REUSE_DETECTED",
+    /**
+     * Session not found or has been revoked
+     */
     SESSION_NOT_FOUND = "AUTH_SESSION_NOT_FOUND",
+    /**
+     * Session has expired
+     */
     SESSION_EXPIRED = "AUTH_SESSION_EXPIRED",
+    /**
+     * User signup is currently disabled
+     *
+     * Signups are administratively disabled.
+     */
     SIGNUP_DISABLED = "SIGNUP_DISABLED",
+    /**
+     * Email address is already registered
+     *
+     * Another user account exists with this email.
+     */
     EMAIL_EXISTS = "SIGNUP_EMAIL_EXISTS",
+    /**
+     * Username is already taken
+     *
+     * Another user has registered this username.
+     */
     USERNAME_EXISTS = "SIGNUP_USERNAME_EXISTS",
+    /**
+     * Phone number is already registered
+     *
+     * Another user account exists with this phone number.
+     */
     PHONE_EXISTS = "SIGNUP_PHONE_EXISTS",
+    /**
+     * Password doesn't meet security requirements
+     *
+     * Details include which requirements failed (length, complexity, etc.)
+     */
     WEAK_PASSWORD = "SIGNUP_WEAK_PASSWORD",
+    /**
+     * Phone number is required for signup
+     *
+     * Configuration requires phone verification.
+     */
     PHONE_REQUIRED = "SIGNUP_PHONE_REQUIRED",
+    /**
+     * Signup not allowed by hook or policy
+     */
     SIGNUP_NOT_ALLOWED = "SIGNUP_NOT_ALLOWED",
+    /**
+     * Verification code is invalid
+     *
+     * Code doesn't match or has incorrect format.
+     */
     VERIFICATION_CODE_INVALID = "VERIFY_CODE_INVALID",
+    /**
+     * Verification code has expired
+     *
+     * User needs to request a new code.
+     */
     VERIFICATION_CODE_EXPIRED = "VERIFY_CODE_EXPIRED",
+    /**
+     * Too many failed verification attempts
+     *
+     * User exceeded max attempts. Must request new code.
+     */
     VERIFICATION_TOO_MANY_ATTEMPTS = "VERIFY_TOO_MANY_ATTEMPTS",
+    /**
+     * Email or phone is already verified
+     *
+     * No action needed.
+     */
     ALREADY_VERIFIED = "VERIFY_ALREADY_VERIFIED",
+    /**
+     * MFA setup is required before login
+     *
+     * User must set up multi-factor authentication before being allowed to login.
+     * This occurs when enforcement is 'REQUIRED' and grace period has expired (or is disabled).
+     * Details include allowedMethods array.
+     */
     MFA_SETUP_REQUIRED = "MFA_SETUP_REQUIRED",
+    /**
+     * Too many SMS verification requests
+     *
+     * Details include retryAfter (seconds) and resetAt (timestamp).
+     */
     RATE_LIMIT_SMS = "RATE_LIMIT_SMS",
+    /**
+     * Too many email verification requests
+     *
+     * Details include retryAfter (seconds) and resetAt (timestamp).
+     */
     RATE_LIMIT_EMAIL = "RATE_LIMIT_EMAIL",
+    /**
+     * Too many login attempts
+     *
+     * Account may be locked. Details include retryAfter.
+     */
     RATE_LIMIT_LOGIN = "RATE_LIMIT_LOGIN",
+    /**
+     * Too many resend code requests
+     *
+     * User must wait before requesting another code.
+     */
     RATE_LIMIT_RESEND = "RATE_LIMIT_RESEND",
+    /**
+     * Too many password reset requests
+     *
+     * Used for forgot-password flows to prevent abuse.
+     * Details should include retryAfter (seconds).
+     */
     RATE_LIMIT_PASSWORD_RESET = "RATE_LIMIT_PASSWORD_RESET",
+    /**
+     * Social provider token is invalid or expired
+     *
+     * Token verification failed with provider.
+     */
     SOCIAL_TOKEN_INVALID = "SOCIAL_TOKEN_INVALID",
+    /**
+     * Social account is already linked to another user
+     *
+     * This social account cannot be linked because it's in use.
+     */
     SOCIAL_ACCOUNT_LINKED = "SOCIAL_ACCOUNT_LINKED",
+    /**
+     * Social provider is not configured
+     *
+     * Provider credentials or settings are missing.
+     */
     SOCIAL_CONFIG_MISSING = "SOCIAL_CONFIG_MISSING",
+    /**
+     * Email is required from social provider
+     *
+     * Social provider didn't return email or email is not verified.
+     */
     SOCIAL_EMAIL_REQUIRED = "SOCIAL_EMAIL_REQUIRED",
+    /**
+     * Social account not found for this user
+     *
+     * User doesn't have this social provider linked.
+     */
     SOCIAL_ACCOUNT_NOT_FOUND = "SOCIAL_ACCOUNT_NOT_FOUND",
+    /**
+     * Challenge session has expired
+     *
+     * User must restart authentication flow.
+     */
     CHALLENGE_EXPIRED = "CHALLENGE_EXPIRED",
+    /**
+     * Challenge session is invalid
+     *
+     * Session token is malformed or not found.
+     */
     CHALLENGE_INVALID = "CHALLENGE_INVALID",
+    /**
+     * Challenge type mismatch
+     *
+     * Client sent wrong challenge type for this session.
+     */
     CHALLENGE_TYPE_MISMATCH = "CHALLENGE_TYPE_MISMATCH",
+    /**
+     * Max challenge attempts exceeded
+     *
+     * User must request new challenge session.
+     */
     CHALLENGE_MAX_ATTEMPTS = "CHALLENGE_MAX_ATTEMPTS",
+    /**
+     * Challenge has already been completed
+     */
     CHALLENGE_ALREADY_COMPLETED = "CHALLENGE_ALREADY_COMPLETED",
+    /**
+     * Request validation failed
+     *
+     * Details include field-specific validation errors.
+     */
     VALIDATION_FAILED = "VALIDATION_FAILED",
+    /**
+     * Phone number format is invalid
+     *
+     * Must be in E.164 format (e.g., +1234567890).
+     */
     INVALID_PHONE_FORMAT = "VALIDATION_INVALID_PHONE",
+    /**
+     * Email format is invalid
+     */
     INVALID_EMAIL_FORMAT = "VALIDATION_INVALID_EMAIL",
+    /**
+     * Password format is invalid
+     *
+     * Details include specific requirements that failed.
+     */
     INVALID_PASSWORD_FORMAT = "VALIDATION_INVALID_PASSWORD",
+    /**
+     * Current password is incorrect
+     *
+     * Used when changing password.
+     */
     PASSWORD_INCORRECT = "PASSWORD_INCORRECT",
+    /**
+     * Cannot reuse recent passwords
+     *
+     * New password matches one of the recent passwords.
+     */
     PASSWORD_REUSED = "PASSWORD_REUSED",
+    /**
+     * Password change is not allowed
+     *
+     * Social-only users cannot change password.
+     */
     PASSWORD_CHANGE_NOT_ALLOWED = "PASSWORD_CHANGE_NOT_ALLOWED",
+    /**
+     * Password reset verification code is invalid
+     *
+     * Used when confirming a forgot-password code.
+     */
     PASSWORD_RESET_CODE_INVALID = "PASSWORD_RESET_CODE_INVALID",
+    /**
+     * Password reset verification code has expired
+     *
+     * Used when confirming a forgot-password code after TTL.
+     */
     PASSWORD_RESET_CODE_EXPIRED = "PASSWORD_RESET_CODE_EXPIRED",
+    /**
+     * Too many failed password reset code attempts
+     *
+     * Used when confirming a forgot-password code exceeds max attempts.
+     */
     PASSWORD_RESET_MAX_ATTEMPTS = "PASSWORD_RESET_MAX_ATTEMPTS",
+    /**
+     * Requested resource not found
+     */
     NOT_FOUND = "RESOURCE_NOT_FOUND",
+    /**
+     * Internal server error
+     *
+     * Unexpected error occurred. Details may include correlation ID.
+     */
     INTERNAL_ERROR = "INTERNAL_ERROR",
+    /**
+     * Access forbidden
+     *
+     * User doesn't have permission for this action.
+     */
     FORBIDDEN = "FORBIDDEN",
+    /**
+     * Service temporarily unavailable
+     *
+     * May include retryAfter in details.
+     */
     SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
+    /**
+     * Sign-in blocked due to high risk score
+     *
+     * Adaptive MFA evaluated the login attempt and determined it exceeds
+     * the high-risk threshold. Sign-in is blocked for security.
+     *
+     * Details may include:
+     * - riskScore: The calculated risk score (0-100)
+     * - riskFactors: Array of detected risk factors
+     * - expiresAt: When the block expires (if temporary)
+     */
     SIGNIN_BLOCKED_HIGH_RISK = "SIGNIN_BLOCKED_HIGH_RISK"
 }
 //# sourceMappingURL=error-codes.enum.d.ts.map

package/dist/enums/error-codes.enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-codes.enum.d.ts","sourceRoot":"","sources":["../../src/enums/error-codes.enum.ts"],"names":[],"mappings":"AA4BA,oBAAY,aAAa;IAUvB,mBAAmB,6BAA6B;IAOhD,cAAc,wBAAwB;IAOtC,gBAAgB,0BAA0B;IAO1C,aAAa,uBAAuB;IAOpC,aAAa,uBAAuB;IAQpC,kBAAkB,4BAA4B;IAO9C,mBAAmB,6BAA6B;IAOhD,kBAAkB,4BAA4B;IAO9C,kBAAkB,4BAA4B;IAO9C,oBAAoB,8BAA8B;IAKlD,iBAAiB,2BAA2B;IAK5C,eAAe,yBAAyB;IAWxC,eAAe,oBAAoB;IAOnC,YAAY,wBAAwB;IAOpC,eAAe,2BAA2B;IAO1C,YAAY,wBAAwB;IAOpC,aAAa,yBAAyB;IAOtC,cAAc,0BAA0B;IAKxC,kBAAkB,uBAAuB;IAWzC,yBAAyB,wBAAwB;IAOjD,yBAAyB,wBAAwB;IAOjD,8BAA8B,6BAA6B;IAO3D,gBAAgB,4BAA4B;IAa5C,kBAAkB,uBAAuB;IAWzC,cAAc,mBAAmB;IAOjC,gBAAgB,qBAAqB;IAOrC,gBAAgB,qBAAqB;IAOrC,iBAAiB,sBAAsB;IAQvC,yBAAyB,8BAA8B;IAWvD,oBAAoB,yBAAyB;IAO7C,qBAAqB,0BAA0B;IAO/C,qBAAqB,0BAA0B;IAO/C,qBAAqB,0BAA0B;IAO/C,wBAAwB,6BAA6B;IAWrD,iBAAiB,sBAAsB;IAOvC,iBAAiB,sBAAsB;IAOvC,uBAAuB,4BAA4B;IAOnD,sBAAsB,2BAA2B;IAKjD,2BAA2B,gCAAgC;IAW3D,iBAAiB,sBAAsB;IAOvC,oBAAoB,6BAA6B;IAKjD,oBAAoB,6BAA6B;IAOjD,uBAAuB,gCAAgC;IAWvD,kBAAkB,uBAAuB;IAOzC,eAAe,oBAAoB;IAOnC,2BAA2B,gCAAgC;IAW3D,2BAA2B,gCAAgC;IAO3D,2BAA2B,gCAAgC;IAO3D,2BAA2B,gCAAgC;IAS3D,SAAS,uBAAuB;IAOhC,cAAc,mBAAmB;IAOjC,SAAS,cAAc;IAOvB,mBAAmB,wBAAwB;IAiB3C,wBAAwB,6BAA6B;CACtD"}
+{"version":3,"file":"error-codes.enum.d.ts","sourceRoot":"","sources":["../../src/enums/error-codes.enum.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,oBAAY,aAAa;IAKvB;;;;OAIG;IACH,mBAAmB,6BAA6B;IAEhD;;;;OAIG;IACH,cAAc,wBAAwB;IAEtC;;;;OAIG;IACH,gBAAgB,0BAA0B;IAE1C;;;;OAIG;IACH,aAAa,uBAAuB;IAEpC;;;;OAIG;IACH,aAAa,uBAAuB;IAEpC;;;;;OAKG;IACH,kBAAkB,4BAA4B;IAE9C;;;;OAIG;IACH,mBAAmB,6BAA6B;IAEhD;;;;OAIG;IACH,kBAAkB,4BAA4B;IAE9C;;;;OAIG;IACH,kBAAkB,4BAA4B;IAE9C;;;;OAIG;IACH,oBAAoB,8BAA8B;IAElD;;OAEG;IACH,iBAAiB,2BAA2B;IAE5C;;OAEG;IACH,eAAe,yBAAyB;IAMxC;;;;OAIG;IACH,eAAe,oBAAoB;IAEnC;;;;OAIG;IACH,YAAY,wBAAwB;IAEpC;;;;OAIG;IACH,eAAe,2BAA2B;IAE1C;;;;OAIG;IACH,YAAY,wBAAwB;IAEpC;;;;OAIG;IACH,aAAa,yBAAyB;IAEtC;;;;OAIG;IACH,cAAc,0BAA0B;IAExC;;OAEG;IACH,kBAAkB,uBAAuB;IAMzC;;;;OAIG;IACH,yBAAyB,wBAAwB;IAEjD;;;;OAIG;IACH,yBAAyB,wBAAwB;IAEjD;;;;OAIG;IACH,8BAA8B,6BAA6B;IAE3D;;;;OAIG;IACH,gBAAgB,4BAA4B;IAM5C;;;;;;OAMG;IACH,kBAAkB,uBAAuB;IAMzC;;;;OAIG;IACH,cAAc,mBAAmB;IAEjC;;;;OAIG;IACH,gBAAgB,qBAAqB;IAErC;;;;OAIG;IACH,gBAAgB,qBAAqB;IAErC;;;;OAIG;IACH,iBAAiB,sBAAsB;IAEvC;;;;;OAKG;IACH,yBAAyB,8BAA8B;IAMvD;;;;OAIG;IACH,oBAAoB,yBAAyB;IAE7C;;;;OAIG;IACH,qBAAqB,0BAA0B;IAE/C;;;;OAIG;IACH,qBAAqB,0BAA0B;IAE/C;;;;OAIG;IACH,qBAAqB,0BAA0B;IAE/C;;;;OAIG;IACH,wBAAwB,6BAA6B;IAMrD;;;;OAIG;IACH,iBAAiB,sBAAsB;IAEvC;;;;OAIG;IACH,iBAAiB,sBAAsB;IAEvC;;;;OAIG;IACH,uBAAuB,4BAA4B;IAEnD;;;;OAIG;IACH,sBAAsB,2BAA2B;IAEjD;;OAEG;IACH,2BAA2B,gCAAgC;IAM3D;;;;OAIG;IACH,iBAAiB,sBAAsB;IAEvC;;;;OAIG;IACH,oBAAoB,6BAA6B;IAEjD;;OAEG;IACH,oBAAoB,6BAA6B;IAEjD;;;;OAIG;IACH,uBAAuB,gCAAgC;IAMvD;;;;OAIG;IACH,kBAAkB,uBAAuB;IAEzC;;;;OAIG;IACH,eAAe,oBAAoB;IAEnC;;;;OAIG;IACH,2BAA2B,gCAAgC;IAM3D;;;;OAIG;IACH,2BAA2B,gCAAgC;IAE3D;;;;OAIG;IACH,2BAA2B,gCAAgC;IAE3D;;;;OAIG;IACH,2BAA2B,gCAAgC;IAM3D;;OAEG;IACH,SAAS,uBAAuB;IAEhC;;;;OAIG;IACH,cAAc,mBAAmB;IAEjC;;;;OAIG;IACH,SAAS,cAAc;IAEvB;;;;OAIG;IACH,mBAAmB,wBAAwB;IAM3C;;;;;;;;;;OAUG;IACH,wBAAwB,6BAA6B;CACtD"}