@genezio/auth - npm Package Compare versions

Comparing version 2.0.6 to 2.0.7

dist/cjs/authService.sdk.d.ts

@@ -57,2 +57,12 @@ /**
      * @returns {Promise<UserLoginResponse>} An object containing the user's information.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.MISSING_PASSWORD_PARAMETER} If no password was provided.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.EMAIL_ALREADY_EXISTS} If the email is already in use.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -67,2 +77,7 @@ register(email: string, password: string, name?: string): Promise<UserLoginResponse>;
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.INCORRECT_EMAIL_OR_PASSWORD} If the email or password is incorrect.
+     * @throws {ErrorCode.EMAIL_NOT_VERIFIED} If the email is not confirmed.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -75,11 +90,16 @@ login(email: string, password: string): Promise<UserLoginResponse>;
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {Error} If an unexpected error occurs.
      */
     resetPassword(email: string): Promise<void>;
     /**
-     *  @method emailConfirmation
-     *  @description Confirms the user's email address. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *
+     * @method emailConfirmation
+     * @description Confirms the user's email address. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -92,11 +112,21 @@ emailConfirmation(token: string): Promise<void>;
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If no email was provided.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      */
     resendEmailConfirmation(email: string): Promise<void>;
     /**
-     *  @method resetPasswordConfirmation
-     *  @description Confirms the user's new password. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *  @param {string} password - The new password.
+     * @method resetPasswordConfirmation
+     * @description Confirms the user's new password. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
+     * @param {string} password - The new password.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -110,2 +140,4 @@ resetPasswordConfirmation(token: string, password: string): Promise<void>;
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INVALID_TOKEN} If the Google token is incorrect.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -117,2 +149,5 @@ googleRegistration(googleToken: string): Promise<UserLoginResponse>;
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -125,2 +160,4 @@ userInfo(): Promise<User>;
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -127,0 +164,0 @@ userInfoForToken(token: string): Promise<User>;

dist/cjs/authService.sdk.js

@@ -85,2 +85,12 @@ "use strict";
      * @returns {Promise<UserLoginResponse>} An object containing the user's information.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.MISSING_PASSWORD_PARAMETER} If no password was provided.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.EMAIL_ALREADY_EXISTS} If the email is already in use.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -100,2 +110,7 @@ async register(email, password, name) {
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.INCORRECT_EMAIL_OR_PASSWORD} If the email or password is incorrect.
+     * @throws {ErrorCode.EMAIL_NOT_VERIFIED} If the email is not confirmed.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -115,2 +130,5 @@ async login(email, password) {
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -124,8 +142,10 @@ async resetPassword(email) {
     /**
-     *  @method emailConfirmation
-     *  @description Confirms the user's email address. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *
+     * @method emailConfirmation
+     * @description Confirms the user's email address. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -143,2 +163,5 @@ async emailConfirmation(token) {
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If no email was provided.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -152,8 +175,15 @@ async resendEmailConfirmation(email) {
     /**
-     *  @method resetPasswordConfirmation
-     *  @description Confirms the user's new password. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *  @param {string} password - The new password.
+     * @method resetPasswordConfirmation
+     * @description Confirms the user's new password. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
+     * @param {string} password - The new password.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -172,2 +202,4 @@ async resetPasswordConfirmation(token, password) {
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INVALID_TOKEN} If the Google token is incorrect.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -186,2 +218,5 @@ async googleRegistration(googleToken) {
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -199,2 +234,4 @@ async userInfo() {
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -201,0 +238,0 @@ async userInfoForToken(token) {

dist/esm/authService.sdk.d.ts

@@ -57,2 +57,12 @@ /**
      * @returns {Promise<UserLoginResponse>} An object containing the user's information.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.MISSING_PASSWORD_PARAMETER} If no password was provided.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.EMAIL_ALREADY_EXISTS} If the email is already in use.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -67,2 +77,7 @@ register(email: string, password: string, name?: string): Promise<UserLoginResponse>;
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.INCORRECT_EMAIL_OR_PASSWORD} If the email or password is incorrect.
+     * @throws {ErrorCode.EMAIL_NOT_VERIFIED} If the email is not confirmed.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -75,11 +90,16 @@ login(email: string, password: string): Promise<UserLoginResponse>;
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {Error} If an unexpected error occurs.
      */
     resetPassword(email: string): Promise<void>;
     /**
-     *  @method emailConfirmation
-     *  @description Confirms the user's email address. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *
+     * @method emailConfirmation
+     * @description Confirms the user's email address. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -92,11 +112,21 @@ emailConfirmation(token: string): Promise<void>;
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If no email was provided.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      */
     resendEmailConfirmation(email: string): Promise<void>;
     /**
-     *  @method resetPasswordConfirmation
-     *  @description Confirms the user's new password. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *  @param {string} password - The new password.
+     * @method resetPasswordConfirmation
+     * @description Confirms the user's new password. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
+     * @param {string} password - The new password.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -110,2 +140,4 @@ resetPasswordConfirmation(token: string, password: string): Promise<void>;
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INVALID_TOKEN} If the Google token is incorrect.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -117,2 +149,5 @@ googleRegistration(googleToken: string): Promise<UserLoginResponse>;
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -125,2 +160,4 @@ userInfo(): Promise<User>;
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -127,0 +164,0 @@ userInfoForToken(token: string): Promise<User>;

dist/esm/authService.sdk.js

@@ -80,2 +80,12 @@ /**
      * @returns {Promise<UserLoginResponse>} An object containing the user's information.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.MISSING_PASSWORD_PARAMETER} If no password was provided.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.EMAIL_ALREADY_EXISTS} If the email is already in use.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -95,2 +105,7 @@ async register(email, password, name) {
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {ErrorCode.INCORRECT_EMAIL_OR_PASSWORD} If the email or password is incorrect.
+     * @throws {ErrorCode.EMAIL_NOT_VERIFIED} If the email is not confirmed.
+     * @throws {Error} If an unexpected error occurs.
      * */
@@ -110,2 +125,5 @@ async login(email, password) {
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.MISSING_EMAIL_PARAMETER} If no email was provided.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -119,8 +137,10 @@ async resetPassword(email) {
     /**
-     *  @method emailConfirmation
-     *  @description Confirms the user's email address. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *
+     * @method emailConfirmation
+     * @description Confirms the user's email address. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -138,2 +158,5 @@ async emailConfirmation(token) {
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If no email was provided.
+     * @throws {ErrorCode.MAIL_NOT_SENT} If the email could not be sent.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -147,8 +170,15 @@ async resendEmailConfirmation(email) {
     /**
-     *  @method resetPasswordConfirmation
-     *  @description Confirms the user's new password. This method should be called after the user clicks on the link
-     *  received in the email.
-     *  @param {string} token - The token received in the email.
-     *  @param {string} password - The new password.
+     * @method resetPasswordConfirmation
+     * @description Confirms the user's new password. This method should be called after the user clicks on the link
+     * received in the email.
+     * @param {string} token - The token received in the email.
+     * @param {string} password - The new password.
      * @returns void. If the method did not throw, the operation was successful.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {ErrorCode.INVALID_TOKEN} If the token is invalid.
+     * @throws {ErrorCode.PASSWORD_TOO_SHORT} If the password is too short.
+     * @throws {ErrorCode.PASSWORD_CONTAINS_ONLY_NUMBERS} If the password contains only numbers.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER} If the password does not contain any special characters.
+     * @throws {ErrorCode.PASSWORD_MUST_HAVE_AT_LEAST_ONE_UPPERCASE_LETTER} If the password does not contain any uppercase letters.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -167,2 +197,4 @@ async resetPasswordConfirmation(token, password) {
      * @returns {Promise<UserLoginResponse>} An object containing the user's information and the token.
+     * @throws {ErrorCode.INVALID_TOKEN} If the Google token is incorrect.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -181,2 +213,5 @@ async googleRegistration(googleToken) {
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {ErrorCode.INTERNAL_INCORRECT_CONFIGURATION} If the AuthService class was not properly configured.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -194,2 +229,4 @@ async userInfo() {
      * @returns {Promise<User>} An object containing the user's information.
+     * @throws {GenezioErrorCodes.Unauthorized} If the user is not authorized.
+     * @throws {Error} If an unexpected error occurs.
      */
@@ -196,0 +233,0 @@ async userInfoForToken(token) {

package.json

 {
   "name": "@genezio/auth",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "SDK for accessing genezio authentication system.",
@@ -5,0 +5,0 @@ "main": "./dist/cjs/index.js",

No alert changes

Improved metrics

Total package byte prevSize

66571

increased by23.75%

Lines of code

1238

increased by13.58%

No dependency changes