oneentry 1.0.123 → 1.0.125

package/dist/auth-provider/authProviderApi.js

@@ -6,7 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with auth services.
+ *
  * @handle /api/content/users-auth-providers
+ * @class AuthProviderApi
+ * @extends AsyncModules
+ * @implements {IAuthProvider}
+ *
+ * @description This class provides methods for user registration, authentication, and management of authentication providers.
  */
 class AuthProviderApi extends asyncModules_1.default {
     constructor(state) {
@@ -14,38 +20,65 @@ class AuthProviderApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/users-auth-providers';
     }
     /**
-     * User registration
-     *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {ISignUpData} [body] - Request body
-     * @param {string} [langCode] - Optional language field
-     *
-     * @example
-     * const body = {
-     *   "formIdentifier": "reg",
-     *   "authData": [
-     *     {
-     *       "marker": "login",
-     *       "value": "example@oneentry.cloud"
-     *     },
-     *     {
-     *       "marker": "password",
-     *       "value": "12345"
-     *     }
-     *   ],
-     *   "formData": [
-     *       {
-     *         "marker": "last_name",
-     *         "type": "string",
-     *         "value": "Name"
-     *       }
-     *   ],
-     *   "notificationData": {
-     *     "email": "example@oneentry.cloud",
-     *     "phonePush": ["+99999999999"],
-     *     "phoneSMS": "+99999999999"
-     *   }
-     * }
+     * User registration.
+     *
+     * @handleName signUp
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {ISignUpData} body - Request body. Example:
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "login",
+              "value": "example@oneentry.cloud"
+            },
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+              "marker": "last_name",
+              "type": "string",
+              "value": "Name"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          }
+        }
+      * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
+      * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+          [
+            {
+              "marker": "login",
+              "value": "example@oneentry.cloud"
+            },
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ]
+      * @param {IAuthFormData | IAuthFormData[]} body.formData - The form data for the registration, which can be a single object or an array of objects. Example:
+          {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Name"
+          }
+      * @param {Object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+          {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {ISignUpEntity} Returns a user object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
      */
     async signUp(marker, body, langCode = this.state.lang) {
         body['langCode'] = langCode;
@@ -53,11 +86,16 @@ class AuthProviderApi extends asyncModules_1.default {
         return this._normalizeData(result);
     }
     /**
-     * Getting a user activation code. The code is returned via the appropriate user notification method
+     * Getting a user activation code. The code is returned via the appropriate user notification method.
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [userIdentifier] - The text identifier of the user's object (user login)
-     * @param {string} [eventIdentifier] - Text identifier of the event object for which the code is generated
+     * @handleName generateCode
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @return {void} Returns void if the code is successfully generated, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Obtaining a code to activate the user.
      */
     async generateCode(marker, userIdentifier, eventIdentifier) {
         const data = {
@@ -71,10 +109,15 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [userIdentifier] - The text identifier of the user's object (user login)
-     * @param {string} [eventIdentifier] - Text identifier of the event object for which the code is generated
-     * @param {string} [code] - Service code
+     * @handleName checkCode
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @param {string} code - Service code. Example: "123456".
+     * @return {boolean} Returns true if the code is correct, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Checking the user activation code
      */
     async checkCode(marker, userIdentifier, eventIdentifier, code) {
         const data = {
@@ -88,9 +131,14 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * User activate.
      *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} userIdentifier - The text identifier of the user's object (user login)
-     * @param {string} code - Service code
+     * @handleName activateUser
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} code - Service code. Example: "123456".
+     * @return {boolean} Returns true if the user was successfully activated, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User activation.
      */
     async activateUser(marker, userIdentifier, code) {
         const data = {
@@ -101,41 +149,58 @@ class AuthProviderApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * User authorization
-     *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {IAuthPostBody} data - Array of objects contains auth information
-     *
-     * @example
-     * const data = {
-     *   authData: [
-     *     {
-     *       marker: "login",
-     *       value: "test"
-     *     },
-     *     {
-     *       marker: "password",
-     *       value: "12345"
-     *     }
-     *   ]
-     * }
+     * User authorization.
      *
+     * @handleName auth
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IAuthPostBody} body - Objects contains auth information. Example:
+        {
+          "authData": [
+            {
+              "marker": "login",
+              "value": "example@oneentry.cloud"
+            },
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ]
+        }
+     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+        [
+          {
+            "marker": "login",
+            "value": "user@example.com"
+          }
+        ]
+     * @param {string} body.authData[index].marker - The marker for the authentication data. Example: "login".
+     * @param {string} body.authData[index].value - The value for the authentication data. Example: "user@example.com".
+     *
+     * @return {IAuthEntity} Returns an auth entity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User authorization.
      */
-    async auth(marker, data) {
-        const result = await this._fetchPost(`/marker/${marker}/users/auth`, data);
+    async auth(marker, body) {
+        const result = await this._fetchPost(`/marker/${marker}/users/auth`, body);
         this.state.accessToken = result.accessToken;
         this.state.refreshToken = result.refreshToken;
+        // console.log(result);
         if (this.state.saveFunction) {
             this.state.saveFunction(result.refreshToken);
         }
         return result;
     }
     /**
-     * Refresh token
+     * Refresh token.
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [token] - Refresh token
+     * @handleName refresh
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @return {IAuthEntity} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User token refresh.
      */
     async refresh(marker, token) {
         const data = { refreshToken: token };
@@ -148,11 +213,14 @@ class AuthProviderApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * User logout.
+     * User account logout.
      *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} token - Refresh token
+     * @handleName logout
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @return {boolean} Returns true if the logout was successful, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async logout(marker, token) {
@@ -170,22 +238,46 @@ class AuthProviderApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Change password
+     * Logout of user account on all devices.
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [userIdentifier] - The text identifier of the user's object (user login)
-     * @param {string} [type] - Operation type (1 - for changing password, 2 - for recovery)
-     * @param {string} [code] - Service code
-     * @param {string} [newPassword] - New password
-     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation
+     * @handleName logoutAll
      *
-     * @example
-     * await AuthProvider.changePassword('email', userIdentifier, type, code, newPassword, repeatPassword);
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @return {boolean} Returns true if the logout was successful, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     */
+    async logoutAll(marker) {
+        const result = await this._fetchPost(`/marker/${marker}/users/logout-all`);
+        if (result) {
+            this.state.accessToken = undefined;
+            this.state.refreshToken = undefined;
+            if (this.state.saveFunction) {
+                this.state.saveFunction('');
+            }
+        }
+        return result;
+    }
+    /**
+     * Change password.
+     *
+     * @handleName changePassword
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The text identifier of the event. Example: "reg".
+     * @param {string} type - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
+     * @param {string} code - Service code. Example: "123456".
+     * @param {string} newPassword - New password. Example: "newPassword123".
+     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
+     * @return {boolean} Returns true if the password was successfully changed, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User password change (only for tariffs with account activation and the Activation feature enabled).
      */
-    async changePassword(marker, userIdentifier, type, code, newPassword, repeatPassword) {
+    async changePassword(marker, userIdentifier, eventIdentifier, type, code, newPassword, repeatPassword) {
         const data = {
             userIdentifier: userIdentifier,
+            eventIdentifier: eventIdentifier,
             code: code,
             type: type,
             password1: newPassword,
@@ -195,25 +287,72 @@ class AuthProviderApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get all auth providers objects
+     * Get all auth providers objects.
      *
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getAuthProviders
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @return {IAuthProvidersEntity[]} Returns an array of auth provider objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Getting all objects of authorization providers.
      */
     async getAuthProviders(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
         return this._normalizeData(result);
     }
     /**
-     * Get one auth provider object by marker
+     * Get one auth provider object by marker.
+     *
+     * @handleName getAuthProviderByMarker
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [langCode] - Optional parameter language code. Default "en_US"
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {IAuthProvidersEntity} Returns an auth provider object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Getting a single authorization provider object by marker.
      */
-    async getMarker(marker, langCode = this.state.lang) {
+    async getAuthProviderByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result);
     }
+    /**
+     * Getting active user sessions data.
+     *
+     * @handleName getActiveSessions
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @return {IAuthProvidersEntity} Returns an auth provider object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Getting a single authorization provider object by marker.
+     */
+    async getActiveSessionsByMarker(marker) {
+        const result = await this._fetchGet(`/marker/${marker}/users/sessions`);
+        return this._normalizeData(result);
+    }
+    /**
+     * User registration (authorization) via OAUTH.
+     *
+     * @handleName oauthSignUp
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration. Example:
+        {
+          "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
+          "client_secret": "43434343434",
+          "code": "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g",
+          "grant_type": "authorization_code",
+          "redirect_uri": "http://localhost:3000"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {ISignUpEntity} Returns a user object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User registration (authorization) via OAUTH.
+     */
+    async oauthSignUp(marker, body, langCode = this.state.lang) {
+        const result = await this._fetchPost(`/marker/${marker}/oauth`, this._normalizePostBody(body, langCode));
+        return result;
+    }
 }
 exports.default = AuthProviderApi;