oneentry 1.0.123 → 1.0.124

package/dist/auth-provider/authProviderApi.d.ts

@@ -4,139 +4,150 @@ import type { IError } from '../base/utils';
 import type { IAuthEntity, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ISignUpData, ISignUpEntity } from './authProvidersInterfaces';
 /**
  * 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.
  */
 export default class AuthProviderApi extends AsyncModules implements IAuthProvider {
     protected state: StateModule;
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * 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.
+     *
+     * @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} [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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     signUp(marker: string, body: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
     /**
-     * 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
+     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
     /**
      * 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
+     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     checkCode(marker: string, userIdentifier: string, eventIdentifier: string, code: string): Promise<boolean | IError>;
     /**
      * 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
+     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
     /**
-     * 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.
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IAuthPostBody} data - Array of objects contains auth information. Example: { "authData": [ { "marker": "login", "value": "example@oneentry.cloud" }, { "marker": "password", "value": "12345" } ] } }
+     *
+     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      */
     auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity | IError>;
     /**
-     * Refresh token
+     * Refresh token.
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [token] - Refresh token
+     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
     /**
      * User logout.
      *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} token - Refresh token
+     * @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.
      */
     logout(marker: string, token: string): Promise<boolean | IError>;
     /**
-     * Change password
+     * Change password.
+     *
+     * @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".
      *
-     * @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
+     * @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.
      *
-     * @example
-     * await AuthProvider.changePassword('email', userIdentifier, type, code, newPassword, repeatPassword);
+     * @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.
+     * @example await AuthProvider.changePassword('email', userIdentifier, type, code, newPassword, repeatPassword);
      *
      */
-    changePassword(marker: string, userIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
+    changePassword(marker: string, userIdentifier: string, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
     /**
-     * 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
+     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<Array<IAuthProvidersEntity> | IError>;
     /**
-     * Get one auth provider object by marker
+     * Get one auth provider object by marker.
      *
-     * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
 }

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,16 @@ 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.
+     *
+     * @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} [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 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 signUp(marker, body, langCode = this.state.lang) {
         body['langCode'] = langCode;
@@ -53,11 +37,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
+     * @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 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 generateCode(marker, userIdentifier, eventIdentifier) {
         const data = {
@@ -71,10 +60,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
+     * @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 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 checkCode(marker, userIdentifier, eventIdentifier, code) {
         const data = {
@@ -88,9 +82,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
+     * @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 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 activateUser(marker, userIdentifier, code) {
         const data = {
@@ -101,41 +100,37 @@ 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.
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IAuthPostBody} data - Array of objects contains auth information. Example: { "authData": [ { "marker": "login", "value": "example@oneentry.cloud" }, { "marker": "password", "value": "12345" } ] } }
+     *
+     * @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 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 auth(marker, data) {
         const result = await this._fetchPost(`/marker/${marker}/users/auth`, data);
         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
+     * @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 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 refresh(marker, token) {
         const data = { refreshToken: token };
@@ -150,8 +145,11 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * User logout.
      *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} token - Refresh token
+     * @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.
      */
@@ -170,22 +168,27 @@ class AuthProviderApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Change password
+     * Change password.
+     *
+     * @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".
      *
-     * @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
+     * @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.
      *
-     * @example
-     * await AuthProvider.changePassword('email', userIdentifier, type, code, newPassword, repeatPassword);
+     * @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.
+     * @example await AuthProvider.changePassword('email', userIdentifier, type, code, newPassword, repeatPassword);
      *
      */
-    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,21 +198,31 @@ 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
+     * @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 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 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.
      *
-     * @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 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 getMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);