@ackplus/nest-auth 1.1.30 → 1.1.31-beta.10

package/dist/lib/admin-console/static/nest-auth.json

@@ -11,7 +11,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/SignupRequestDto"
+                "$ref": "#/components/schemas/NestAuthSignupRequestDto"
               }
             }
           }
@@ -44,7 +44,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/LoginRequestDto"
+                "$ref": "#/components/schemas/NestAuthLoginRequestDto"
               }
             }
           }
@@ -77,7 +77,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/RefreshTokenRequestDto"
+                "$ref": "#/components/schemas/NestAuthRefreshTokenRequestDto"
               }
             }
           }
@@ -100,31 +100,41 @@
         ]
       }
     },
-    "/auth/send-2fa-code": {
+    "/auth/mfa/challenge": {
       "post": {
-        "operationId": "AuthController_send2faCode",
+        "operationId": "MfaController_challenge",
         "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/NestAuthSendMfaCodeRequestDto"
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthMfaCodeSentResponseDto"
                 }
               }
             }
           }
         },
-        "summary": "Send 2FA Code",
+        "summary": "Send MFA code for setup/verification",
         "tags": [
-          "Auth"
+          "Mfa"
         ]
       }
     },
-    "/auth/verify-2fa": {
+    "/auth/mfa/verify": {
       "post": {
-        "description": "Verify two-factor authentication. Response format depends on accessTokenType configuration:\n- Header mode (default): Returns tokens in response body\n- Cookie mode: Sets tokens in HTTP-only cookies and returns success message",
+        "description": "Verify multi-factor authentication. Response format depends on accessTokenType configuration:\n- Header mode (default): Returns tokens in response body\n- Cookie mode: Sets tokens in HTTP-only cookies and returns success message",
         "operationId": "AuthController_verify2fa",
         "parameters": [],
         "requestBody": {
@@ -132,7 +142,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/Verify2faRequestDto"
+                "$ref": "#/components/schemas/NestAuthVerify2faRequestDto"
               }
             }
           }
@@ -149,7 +159,7 @@
             }
           }
         },
-        "summary": "Verify 2FA",
+        "summary": "Verify MFA",
         "tags": [
           "Auth"
         ]
@@ -165,7 +175,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthLogoutResponseDto"
                 }
               }
             }
@@ -187,7 +197,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthLogoutAllResponseDto"
                 }
               }
             }
@@ -208,7 +218,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/ChangePasswordRequestDto"
+                "$ref": "#/components/schemas/NestAuthChangePasswordRequestDto"
               }
             }
           }
@@ -240,7 +250,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/ForgotPasswordRequestDto"
+                "$ref": "#/components/schemas/NestAuthForgotPasswordRequestDto"
               }
             }
           }
@@ -251,13 +261,13 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthPasswordResetLinkSentResponseDto"
                 }
               }
             }
           }
         },
-        "summary": "Forgot Password",
+        "summary": "Forgot password",
         "tags": [
           "Auth"
         ]
@@ -272,7 +282,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/VerifyForgotPasswordOtpRequestDto"
+                "$ref": "#/components/schemas/NestAuthVerifyForgotPasswordOtpRequestDto"
               }
             }
           }
@@ -304,7 +314,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/ResetPasswordRequestDto"
+                "$ref": "#/components/schemas/NestAuthResetPasswordWithTokenRequestDto"
               }
             }
           }
@@ -315,53 +325,44 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthPasswordResetResponseDto"
                 }
               }
             }
           }
         },
-        "summary": "Reset Password (Legacy - using OTP)",
+        "summary": "Reset password",
         "tags": [
           "Auth"
         ]
       }
     },
-    "/auth/reset-password-with-token": {
-      "post": {
-        "operationId": "AuthController_resetPasswordWithToken",
+    "/auth/user": {
+      "get": {
+        "operationId": "AuthController_getUser",
         "parameters": [],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/ResetPasswordWithTokenRequestDto"
-              }
-            }
-          }
-        },
         "responses": {
           "200": {
             "description": "",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/UserResponseDto"
                 }
               }
             }
           }
         },
-        "summary": "Reset Password with Token",
+        "summary": "Get Logged In User",
         "tags": [
           "Auth"
         ]
       }
     },
-    "/auth/user": {
+    "/auth/verify-session": {
       "get": {
-        "operationId": "AuthController_getUser",
+        "description": "Lightweight endpoint to verify if the current session is valid. Returns minimal information without fetching full user data.",
+        "operationId": "AuthController_verifySession",
         "parameters": [],
         "responses": {
           "200": {
@@ -369,13 +370,26 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/UserResponseDto"
+                  "properties": {
+                    "valid": {
+                      "type": "boolean",
+                      "example": true
+                    },
+                    "userId": {
+                      "type": "string",
+                      "example": "123e4567-e89b-12d3-a456-426614174000"
+                    },
+                    "expiresAt": {
+                      "type": "string",
+                      "example": "2024-01-01T12:00:00.000Z"
+                    }
+                  }
                 }
               }
             }
           }
         },
-        "summary": "Get Logged In User",
+        "summary": "Verify Session",
         "tags": [
           "Auth"
         ]
@@ -390,7 +404,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/SendEmailVerificationRequestDto"
+                "$ref": "#/components/schemas/NestAuthSendEmailVerificationRequestDto"
               }
             }
           }
@@ -401,13 +415,13 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthEmailVerificationSentResponseDto"
                 }
               }
             }
           }
         },
-        "summary": "Send Email Verification",
+        "summary": "Send email verification",
         "tags": [
           "Auth"
         ]
@@ -422,7 +436,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/VerifyEmailRequestDto"
+                "$ref": "#/components/schemas/NestAuthVerifyEmailRequestDto"
               }
             }
           }
@@ -433,7 +447,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MessageResponseDto"
+                  "$ref": "#/components/schemas/NestAuthEmailVerifiedResponseDto"
                 }
               }
             }
@@ -524,14 +538,21 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/ToggleMfaRequestDto"
+                "$ref": "#/components/schemas/NestAuthToggleMfaRequestDto"
               }
             }
           }
         },
         "responses": {
           "200": {
-            "description": ""
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NestAuthMfaToggleResponseDto"
+                }
+              }
+            }
           }
         },
         "summary": "Enable or disable MFA for the current user",
@@ -580,35 +601,17 @@
         ],
         "responses": {
           "200": {
-            "description": ""
-          }
-        },
-        "summary": "Remove a registered MFA device",
-        "tags": [
-          "Mfa"
-        ]
-      }
-    },
-    "/auth/mfa/send-mfa-code": {
-      "post": {
-        "operationId": "MfaController_sendMfaCode",
-        "parameters": [],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/SendMfaCodeRequestDto"
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NestAuthMfaDeviceRemovedResponseDto"
+                }
               }
             }
           }
         },
-        "responses": {
-          "200": {
-            "description": ""
-          }
-        },
-        "summary": "Send MFA Code",
+        "summary": "Remove a registered MFA device",
         "tags": [
           "Mfa"
         ]
@@ -638,14 +641,21 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/VerifyTotpSetupRequestDto"
+                "$ref": "#/components/schemas/NestAuthVerifyTotpSetupRequestDto"
               }
             }
           }
         },
         "responses": {
           "200": {
-            "description": ""
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NestAuthMfaDeviceVerifiedResponseDto"
+                }
+              }
+            }
           }
         },
         "summary": "Verify TOTP Setup",
@@ -675,7 +685,14 @@
         "parameters": [],
         "responses": {
           "200": {
-            "description": ""
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NestAuthMfaResetResponseDto"
+                }
+              }
+            }
           }
         },
         "summary": "Reset TOTP Device",
@@ -688,7 +705,7 @@
   "info": {
     "title": "@ackplus/nest-auth API",
     "description": "OpenAPI specification generated from the Nest Auth module",
-    "version": "1.1.29",
+    "version": "1.1.31-beta.10",
     "contact": {}
   },
   "tags": [],
@@ -702,7 +719,7 @@
       }
     },
     "schemas": {
-      "SignupRequestDto": {
+      "NestAuthSignupRequestDto": {
         "type": "object",
         "properties": {
           "email": {
@@ -791,6 +808,32 @@
             "description": "Whether multi-factor authentication is required",
             "example": false
           },
+          "mfaMethods": {
+            "type": "array",
+            "description": "Available MFA methods when isRequiresMfa is true",
+            "example": [
+              "email",
+              "totp"
+            ],
+            "items": {
+              "type": "string",
+              "enum": [
+                "email",
+                "sms",
+                "totp"
+              ]
+            }
+          },
+          "defaultMfaMethod": {
+            "type": "string",
+            "description": "Default/recommended MFA method",
+            "example": "email",
+            "enum": [
+              "email",
+              "sms",
+              "totp"
+            ]
+          },
           "user": {
             "description": "User information",
             "allOf": [
@@ -849,17 +892,17 @@
       "SocialCredentialsDto": {
         "type": "object",
         "properties": {
-          "accessToken": {
+          "token": {
             "type": "string",
             "description": "OAuth token or ID token from social provider",
             "example": "ya29.a0AfH6SMBx1234567890abcdefghijklmnop"
           }
         },
         "required": [
-          "accessToken"
+          "token"
         ]
       },
-      "LoginRequestDto": {
+      "NestAuthLoginRequestDto": {
         "type": "object",
         "properties": {
           "providerName": {
@@ -896,7 +939,8 @@
               "socialLogin": {
                 "summary": "Social Login (Google/Facebook/etc)",
                 "value": {
-                  "token": "ya29.a0AfH6SMBx..."
+                  "token": "ya29.a0AfH6SMBx...",
+                  "type": "idToken"
                 }
               }
             },
@@ -922,9 +966,12 @@
             "description": "Auto-create user if not exists (for social auth)",
             "default": false
           }
-        }
+        },
+        "required": [
+          "credentials"
+        ]
       },
-      "RefreshTokenRequestDto": {
+      "NestAuthRefreshTokenRequestDto": {
         "type": "object",
         "properties": {
           "refreshToken": {
@@ -937,27 +984,28 @@
           "refreshToken"
         ]
       },
-      "MessageResponseDto": {
+      "NestAuthMfaCodeSentResponseDto": {
         "type": "object",
         "properties": {
           "message": {
             "type": "string",
-            "description": "Response message"
+            "description": "Response message",
+            "example": "MFA code sent successfully"
           }
         },
         "required": [
           "message"
         ]
       },
-      "MFAMethodEnum": {
+      "NestAuthMFAMethodEnum": {
         "type": "string",
         "enum": [
-          "totp",
+          "email",
           "sms",
-          "email"
+          "totp"
         ]
       },
-      "Verify2faRequestDto": {
+      "NestAuthVerify2faRequestDto": {
         "type": "object",
         "properties": {
           "method": {
@@ -965,7 +1013,7 @@
             "example": "totp",
             "allOf": [
               {
-                "$ref": "#/components/schemas/MFAMethodEnum"
+                "$ref": "#/components/schemas/NestAuthMFAMethodEnum"
               }
             ]
           },
@@ -1011,7 +1059,33 @@
           "refreshToken"
         ]
       },
-      "ChangePasswordRequestDto": {
+      "NestAuthLogoutResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "Logged out successfully"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthLogoutAllResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "Logged out from all devices"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthChangePasswordRequestDto": {
         "type": "object",
         "properties": {
           "currentPassword": {
@@ -1032,7 +1106,7 @@
           "newPassword"
         ]
       },
-      "ForgotPasswordRequestDto": {
+      "NestAuthForgotPasswordRequestDto": {
         "type": "object",
         "properties": {
           "email": {
@@ -1052,7 +1126,20 @@
           }
         }
       },
-      "VerifyForgotPasswordOtpRequestDto": {
+      "NestAuthPasswordResetLinkSentResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "If your email is registered, you will receive a password reset link"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthVerifyForgotPasswordOtpRequestDto": {
         "type": "object",
         "properties": {
           "email": {
@@ -1098,64 +1185,40 @@
           "message"
         ]
       },
-      "ResetPasswordRequestDto": {
+      "NestAuthResetPasswordWithTokenRequestDto": {
         "type": "object",
         "properties": {
-          "email": {
-            "type": "string",
-            "description": "User email address (required if phone not provided)",
-            "example": "user@example.com"
-          },
-          "phone": {
-            "type": "string",
-            "description": "User phone number (required if email not provided)",
-            "example": "+1234567890"
-          },
-          "otp": {
+          "token": {
             "type": "string",
-            "description": "One-time password (OTP) received via email or SMS",
-            "example": "123456",
-            "minLength": 6,
-            "maxLength": 8
+            "description": "Password reset token (JWT) received after OTP verification",
+            "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0eXBlIjoicGFzc3dvcmQtcmVzZXQifQ.xyz"
           },
           "newPassword": {
             "type": "string",
             "description": "New password",
             "example": "NewSecurePass123!",
             "minLength": 8
-          },
-          "tenantId": {
-            "type": "string",
-            "description": "Tenant ID for multi-tenant applications",
-            "example": "123e4567-e89b-12d3-a456-426614174000"
           }
         },
         "required": [
-          "otp",
+          "token",
           "newPassword"
         ]
       },
-      "ResetPasswordWithTokenRequestDto": {
+      "NestAuthPasswordResetResponseDto": {
         "type": "object",
         "properties": {
-          "token": {
-            "type": "string",
-            "description": "Password reset token (JWT) received after OTP verification",
-            "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0eXBlIjoicGFzc3dvcmQtcmVzZXQifQ.xyz"
-          },
-          "newPassword": {
+          "message": {
             "type": "string",
-            "description": "New password",
-            "example": "NewSecurePass123!",
-            "minLength": 8
+            "description": "Response message",
+            "example": "Password has been reset successfully"
           }
         },
         "required": [
-          "token",
-          "newPassword"
+          "message"
         ]
       },
-      "SendEmailVerificationRequestDto": {
+      "NestAuthSendEmailVerificationRequestDto": {
         "type": "object",
         "properties": {
           "tenantId": {
@@ -1165,7 +1228,20 @@
           }
         }
       },
-      "VerifyEmailRequestDto": {
+      "NestAuthEmailVerificationSentResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "Verification email sent"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthVerifyEmailRequestDto": {
         "type": "object",
         "properties": {
           "otp": {
@@ -1185,6 +1261,19 @@
           "otp"
         ]
       },
+      "NestAuthEmailVerifiedResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "Email verified successfully"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
       "EmailAuthConfigDto": {
         "type": "object",
         "properties": {
@@ -1468,9 +1557,9 @@
             "type": "string",
             "description": "MFA method this device supports",
             "enum": [
-              "totp",
+              "email",
               "sms",
-              "email"
+              "totp"
             ],
             "example": "totp"
           },
@@ -1517,9 +1606,9 @@
             "items": {
               "type": "string",
               "enum": [
-                "totp",
+                "email",
                 "sms",
-                "email"
+                "totp"
               ]
             }
           },
@@ -1534,9 +1623,9 @@
             "items": {
               "type": "string",
               "enum": [
-                "totp",
+                "email",
                 "sms",
-                "email"
+                "totp"
               ]
             }
           },
@@ -1573,7 +1662,7 @@
           "hasRecoveryCode"
         ]
       },
-      "ToggleMfaRequestDto": {
+      "NestAuthToggleMfaRequestDto": {
         "type": "object",
         "properties": {
           "enabled": {
@@ -1586,7 +1675,33 @@
           "enabled"
         ]
       },
-      "SendMfaCodeRequestDto": {
+      "NestAuthMfaToggleResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "MFA enabled successfully"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthMfaDeviceRemovedResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "Device removed successfully"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthSendMfaCodeRequestDto": {
         "type": "object",
         "properties": {
           "method": {
@@ -1608,7 +1723,7 @@
             },
             "allOf": [
               {
-                "$ref": "#/components/schemas/MFAMethodEnum"
+                "$ref": "#/components/schemas/NestAuthMFAMethodEnum"
               }
             ]
           }
@@ -1617,7 +1732,7 @@
           "method"
         ]
       },
-      "VerifyTotpSetupRequestDto": {
+      "NestAuthVerifyTotpSetupRequestDto": {
         "type": "object",
         "properties": {
           "otp": {
@@ -1637,6 +1752,32 @@
           "otp",
           "secret"
         ]
+      },
+      "NestAuthMfaDeviceVerifiedResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "Device setup successfully"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "NestAuthMfaResetResponseDto": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Response message",
+            "example": "MFA reset successfully"
+          }
+        },
+        "required": [
+          "message"
+        ]
       }
     }
   }