cidaas-javascript-sdk 3.1.5 → 4.0.1

package/dist/web-auth/UserService.js

@@ -5,143 +5,158 @@ var Helper_1 = require("./Helper");
 var UserService;
 (function (UserService) {
     /**
-     * get user info
-     * @param options
-     * @returns
+     * To get the user profile information by using cidaas internal api, call **getUserProfile()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2zfvjx3vtq6g6-get-user-info for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   access_token: 'your access token'
+     * }
+     * cidaas.getUserProfile(options)
+     * .then(function () {
+     *   // the response will give you user profile information.
+     * }).catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function getUserProfile(options) {
         if (!options.access_token) {
             throw new Helper_1.CustomException("access_token cannot be empty", 417);
         }
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo";
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, undefined, "GET", options.access_token);
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", options.access_token);
     }
     UserService.getUserProfile = getUserProfile;
     ;
     /**
-     * register user
-     * @param options
-     * @param headers
-     * @returns
+     * To register user, call **register()**. This method will create a new user.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/427632e587203-register-a-new-user for more details.
+     * Note: Only requestId in the headers is required.
+     * @example
+     * ```js
+     * const headers = {
+     *   requestId: 'your_received_requestId',
+     *   captcha: 'captcha',
+     *   acceptlanguage: 'acceptlanguage',
+     *   bot_captcha_response: 'bot_captcha_response'
+     * };
+     *
+     * cidaas.register({
+     *   email: 'xxx123@xxx.com',
+     *   given_name: 'xxxxx',
+     *   family_name: 'yyyyy',
+     *   password: '123456',
+     *   password_echo: '123456',
+     *   provider: 'your provider', // FACEBOOK, GOOGLE, SELF
+     *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+     * }, headers).then(function (response) {
+     *   // the response will give you client registration details.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     *```
      */
     function register(options, headers) {
-        return new Promise(function (resolve, reject) {
-            try {
-                var http = new XMLHttpRequest();
-                var _serviceURL = window.webAuthSettings.authority + "/users-srv/register";
-                if (options.invite_id) {
-                    _serviceURL = _serviceURL + "?invite_id=" + options.invite_id;
-                }
-                http.onreadystatechange = function () {
-                    if (http.readyState == 4) {
-                        if (http.responseText) {
-                            resolve(JSON.parse(http.responseText));
-                        }
-                        else {
-                            resolve(false);
-                        }
-                    }
-                };
-                http.open("POST", _serviceURL, true);
-                http.setRequestHeader("Content-type", "application/json");
-                http.setRequestHeader("requestId", headers.requestId);
-                if (headers.captcha) {
-                    http.setRequestHeader("captcha", headers.captcha);
-                }
-                if (headers.acceptlanguage) {
-                    http.setRequestHeader("accept-language", headers.acceptlanguage);
-                }
-                else if (window.localeSettings) {
-                    http.setRequestHeader("accept-language", window.localeSettings);
-                }
-                if (headers.bot_captcha_response) {
-                    http.setRequestHeader("bot_captcha_response", headers.bot_captcha_response);
-                }
-                if (headers.trackId) {
-                    http.setRequestHeader("trackid", headers.trackId);
-                }
-                http.send(JSON.stringify(options));
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+        var _serviceURL = window.webAuthSettings.authority + "/users-srv/register";
+        if (options.invite_id) {
+            _serviceURL = _serviceURL + "?invite_id=" + options.invite_id;
+        }
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
     }
     UserService.register = register;
     ;
     /**
-     * get invite info
-     * @param options
-     * @returns
+     * to get information about invitation details, call **getInviteUserDetails()**
+     * @example
+     * ```js
+     * const options = {
+     *   invite_id: 'id of user invitation'
+     * }
+     * cidaas.getInviteUserDetails(options)
+     * .then(function () {
+     *   // the response will give you information about the invitation.
+     * }).catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function getInviteUserDetails(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/invite/info/" + options.invite_id;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, false, "GET");
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET");
     }
     UserService.getInviteUserDetails = getInviteUserDetails;
     ;
     /**
-     * get Communication status
-     * @param options
-     * @returns
+     * Once registration successful, verify the account based on the flow. To get the details, call **getCommunicationStatus()**.
+     * @example
+     * ```js
+     * cidaas.getCommunicationStatus({
+     *   sub: 'your sub', // which you will get on the registration response
+     * }).then(function (response) {
+     *   // the response will give you account details once its verified.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
-    function getCommunicationStatus(options) {
-        return new Promise(function (resolve, reject) {
-            try {
-                var http = new XMLHttpRequest();
-                var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/communication/status/" + options.sub;
-                http.onreadystatechange = function () {
-                    if (http.readyState == 4) {
-                        if (http.responseText) {
-                            resolve(JSON.parse(http.responseText));
-                        }
-                        else {
-                            resolve(false);
-                        }
-                    }
-                };
-                http.open("GET", _serviceURL, true);
-                http.setRequestHeader("Content-type", "application/json");
-                if (options.requestId) {
-                    http.setRequestHeader("requestId", options.requestId);
-                }
-                if (window.localeSettings) {
-                    http.setRequestHeader("accept-language", window.localeSettings);
-                }
-                http.send();
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+    function getCommunicationStatus(options, headers) {
+        var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/communication/status/" + options.sub;
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", undefined, headers);
     }
     UserService.getCommunicationStatus = getCommunicationStatus;
     ;
     /**
-     * initiate reset password
-     * @param options
-     * @returns
+     * To initiate the password resetting, call **initiateResetPassword()**. This will send verification code to your email or mobile based on the resetMedium you mentioned.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/6b29bac6002f4-initiate-password-reset for more details.
+     * @example
+     * ```js
+     * cidaas.initiateResetPassword({
+     *   email: 'xxxxxx@xxx.com',
+     *   processingType: 'CODE',
+     *   requestId: 'your requestId',
+     *   resetMedium: 'email'
+     * }).then(function (response) {
+     *   // the response will give you password reset details.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function initiateResetPassword(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/resetpassword/initiate";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     UserService.initiateResetPassword = initiateResetPassword;
     ;
     /**
-     * handle reset password
-     * @param options
+     * To handle the reset password by entering the verification code you received, call **handleResetPassword()**. This will check if your verification code was valid or not, and allows you to proceed to the next step.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3t8ztokeb7cfz-handle-reset-password for more details.
+     * @example
+     * ```js
+     * const handleResponseAsJson = 'true if the response need to be handled the old way (as json). In the current handling, the response information will be given as query parameter in redirect url.';
+     * cidaas.handleResetPassword({
+     *   code: 'your code in email or sms or ivr',
+     *   resetRequestId: 'your resetRequestId' // which you will get on initiate reset password response
+     * }, handleResponseAsJson).then(function (response) {
+     *   // the response will give you valid verification code.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
-    function handleResetPassword(options) {
+    function handleResetPassword(options, handleResponseAsJson) {
         try {
             var url = window.webAuthSettings.authority + "/users-srv/resetpassword/validatecode";
-            if (window.webAuthSettings.cidaas_version > 2) {
+            if (!handleResponseAsJson) {
+                // current handling will redirect and give query parameters
                 var form = Helper_1.Helper.createForm(url, options);
                 document.body.appendChild(form);
                 form.submit();
             }
             else {
-                return Helper_1.Helper.createPostPromise(options, url, false, "POST");
+                // older cidaas service handling return json object
+                return Helper_1.Helper.createHttpPromise(options, url, false, "POST");
             }
         }
         catch (ex) {
@@ -151,19 +166,35 @@ var UserService;
     UserService.handleResetPassword = handleResetPassword;
     ;
     /**
-    * reset password
-    * @param options
-    */
-    function resetPassword(options) {
+     * To finish reseting the password, call **resetPassword()**. This will allow you to change your password.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qa9ny0gkzlf6y-accept-reset-password for more details.
+     * @example
+     * ```js
+     * const handleResponseAsJson = 'true if the response need to be handled the old way (as json). In the current handling, user will be redirected to success page after successful reset password.';
+     * cidaas.resetPassword({
+     *   password: '123456',
+     *   confirmPassword: '123456',
+     *   exchangeId: 'your exchangeId', // which you will get on handle reset password response
+     *   resetRequestId: 'your resetRequestId' // which you will get on handle reset password response
+     * }).then(function (response) {
+     *   // the response will give you reset password details.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    function resetPassword(options, handleResponseAsJson) {
         var url = window.webAuthSettings.authority + "/users-srv/resetpassword/accept";
         try {
-            if (window.webAuthSettings.cidaas_version > 2) {
+            if (!handleResponseAsJson) {
+                // current handling will redirect and give query parameters
                 var form = Helper_1.Helper.createForm(url, options);
                 document.body.appendChild(form);
                 form.submit();
             }
             else {
-                return Helper_1.Helper.createPostPromise(options, url, false, "POST");
+                // older cidaas service handling return json object
+                return Helper_1.Helper.createHttpPromise(options, url, false, "POST");
             }
         }
         catch (ex) {
@@ -173,25 +204,39 @@ var UserService;
     UserService.resetPassword = resetPassword;
     ;
     /**
-     * get Deduplication details
-     * @param options
-     * @returns
+     * To get the list of existing users in deduplication, call **getDeduplicationDetails()**.
+     * @example
+     * ```js
+     * this.cidaas.getDeduplicationDetails({
+     *   track_id: 'your track id'
+     * }).then((response) => {
+     *   // the response will give you deduplication details of users.
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
      */
     function getDeduplicationDetails(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/info/" + options.trackId;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "GET", undefined);
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "GET");
     }
     UserService.getDeduplicationDetails = getDeduplicationDetails;
     ;
     /**
-     * deduplication login
-     * @param options
+     * To use the existing users in deduplication, you need to call **deduplicationLogin()**.
+     * @example
+     * ```js
+     * this.cidaas.deduplicationLogin({
+     *   sub: 'your sub',
+     *   requestId: 'request id from deduplication initialisation after register',
+     *   trackId: 'track id from deduplication initialisation after register'
+     * })
+     * ```
      */
     function deduplicationLogin(options) {
         try {
-            var form = document.createElement('form');
-            form.action = window.webAuthSettings.authority + "/users-srv/deduplication/login/redirection?trackId=" + options.trackId + "&requestId=" + options.requestId + "&sub=" + options.sub;
-            form.method = 'POST';
+            var url = window.webAuthSettings.authority + "/users-srv/deduplication/login/redirection?trackId=" + options.trackId + "&requestId=" + options.requestId + "&sub=" + options.sub;
+            var form = Helper_1.Helper.createForm(url, {});
             document.body.appendChild(form);
             form.submit();
         }
@@ -202,109 +247,215 @@ var UserService;
     UserService.deduplicationLogin = deduplicationLogin;
     ;
     /**
-     * register Deduplication
-     * @param options
-     * @returns
+     * To register new user in deduplication, call **registerDeduplication()**.
+     * @example
+     * ```js
+     * this.cidaas.registerDeduplication({
+     *   track_id: 'track id from deduplication initialisation after register',
+     * }).then((response) => {
+     *   // the response will give you new registered deduplication user.
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
      */
     function registerDeduplication(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/register/" + options.trackId;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, undefined, "POST");
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST");
     }
     UserService.registerDeduplication = registerDeduplication;
     ;
     /**
-     * change password
-     * @param options
-     * @param access_token
-     * @returns
+     * To change the password, call **changePassword()**. This will allow you to change your password.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/8221883241464-change-password for more details.
+     * @example
+     * ```js
+     * cidaas.changePassword({
+     *   old_password: 'your old password',
+     *   new_password: 'your new password',
+     *   confirm_password: 'your new password',
+     *   sub: 'your sub',
+     * }, 'your access token')
+     * .then(function () {
+     *   // your success code
+     * }).catch(function (ex) {
+     *   // your failure code
+     * });
+     * ```
      */
     function changePassword(options, access_token) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/changepassword";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST", access_token);
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
     }
     UserService.changePassword = changePassword;
     ;
     /**
-     * update profile
-     * @param options
-     * @param access_token
-     * @param sub
-     * @returns
+     * To update the user profile information, call **updateProfile()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/i3uqnxcpxr19r-update-user-profile for more details.
+     * @example
+     * ```js
+     * cidaas.updateProfile({
+     *   family_name: 'Doe',
+     *   given_name: 'John',
+     *   provider: 'self',
+     *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+     * }, 'your access token', 'your sub').then(function () {
+     *   // the response will give you updated user profile info.
+     * }).catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function updateProfile(options, access_token, sub) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/profile/" + sub;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "PUT", access_token);
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "PUT", access_token);
     }
     UserService.updateProfile = updateProfile;
     ;
     /**
-     * initiate link accoount
-     * @param options
-     * @param access_token
-     * @returns
+     * To initiate account linking, call **initiateLinkAccount()**.
+     * @example
+     * ```js
+     * const options = {
+     *   master_sub: 'sub of the user who initiates the user link',
+     *   user_name_to_link: 'username of the user which should get linked',
+     *   user_name_type: 'type of user name to link. E.g. email'
+     * }
+     * const access_token = 'your access token'
+     * this.cidaas.initiateLinkAccount(options, access_token).then((response) => {
+     *   // your success code
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
      */
     function initiateLinkAccount(options, access_token) {
         options.user_name_type = 'email';
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/link/initiate";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST", access_token);
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
     }
     UserService.initiateLinkAccount = initiateLinkAccount;
     ;
     /**
-     * complete link accoount
-     * @param options
-     * @param access_token
-     * @returns
+     * To complete account linking, call **completeLinkAccount()**.
+     * @example
+     * ```js
+     * const options = {
+     *   code: 'code which is sent to account to be linked',
+     *   link_request_id: 'comes from initiateLinkAccount'
+     * }
+     * const access_token = 'your access token'
+     * this.cidaas.completeLinkAccount(options, access_token).then((response) => {
+     *   // your success code
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
      */
     function completeLinkAccount(options, access_token) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/link/complete";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST", access_token);
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
     }
     UserService.completeLinkAccount = completeLinkAccount;
     ;
     /**
-     * get linked users
-     * @param access_token
-     * @param sub
-     * @returns
+     * To get all the linked accounts, call **getLinkedUsers()**.
+     * @example
+     * ```js
+     * const acccess_token= 'your access token';
+     * const sub = 'your sub';
+     *
+     * cidaas.getLinkedUsers(access_token, sub)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function getLinkedUsers(access_token, sub) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo/social/" + sub;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, false, "POST", access_token);
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", access_token);
     }
     UserService.getLinkedUsers = getLinkedUsers;
     ;
     /**
-     * unlink accoount
-     * @param access_token
-     * @param identityId
-     * @returns
+     * To unlink an account for a user, call **unlinkAccount()**.
+     * @example
+     * ```js
+     * const acccess_token= "your access token";
+     * const identityId = "comes from getLinkedUsers";
+     *
+     * cidaas.unlinkAccount(access_token, identityId)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function unlinkAccount(access_token, identityId) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/unlink/" + identityId;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, false, "POST", access_token);
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "POST", access_token);
     }
     UserService.unlinkAccount = unlinkAccount;
     ;
     /**
-     * deleteUserAccount
-     * @param options
-     * @returns
+     * To delete the user account directly in the application, call **deleteUserAccount()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/x133xdifl1sx9-schedule-user-deletion for more details.
+     * @example
+     * ```js
+     * options = {
+     *   access_token: "your access token",
+     *   sub: "your sub"
+     * }
+     *
+     * cidaas.deleteUserAccount(options).then(function (response) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function deleteUserAccount(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/unregister/scheduler/schedule/" + options.sub;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST", options.access_token);
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", options.access_token);
     }
     UserService.deleteUserAccount = deleteUserAccount;
     ;
     /**
-     * check if an user exists from users-actions-srv
-     * @param options
-     * @returns
+     * To check if user exists, call **userCheckExists()**.
+     * @example
+     * options = {
+     *   requestId: "your request id",
+     *   email: "your email"
+     * }
+     *
+     * cidaas.userCheckExists(options).then(function (response) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function userCheckExists(options) {
-        var _serviceURL = window.webAuthSettings.authority + "/useractions-srv/userexistence/" + options.requestId + "?webfinger=" + options.webfinger + "&rememberMe=" + options.rememberMe;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST");
+        var queryParameter = '';
+        if (options.webfinger || options.rememberMe) {
+            queryParameter += '?';
+            if (options.webfinger) {
+                queryParameter += 'webfinger=' + options.webfinger;
+                if (options.rememberMe) {
+                    queryParameter += '&rememberMe=' + options.rememberMe;
+                }
+            }
+            else if (options.rememberMe) {
+                queryParameter += 'rememberMe=' + options.rememberMe;
+            }
+        }
+        var _serviceURL = window.webAuthSettings.authority + "/useractions-srv/userexistence/" + options.requestId + queryParameter;
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     UserService.userCheckExists = userCheckExists;
     ;