cidaas-javascript-sdk 4.2.0 → 4.2.2

package/dist/web-auth/UserService.js

@@ -1,8 +1,5 @@
-"use strict";
-exports.__esModule = true;
-exports.UserService = void 0;
-var Helper_1 = require("./Helper");
-var UserService;
+import { Helper, CustomException } from "./Helper";
+export var UserService;
 (function (UserService) {
     /**
      * To get the user profile information by using cidaas internal api, call **getUserProfile()**.
@@ -22,10 +19,10 @@ var UserService;
      */
     function getUserProfile(options) {
         if (!options.access_token) {
-            throw new Helper_1.CustomException("access_token cannot be empty", 417);
+            throw new CustomException("access_token cannot be empty", 417);
         }
-        var _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo";
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", options.access_token);
+        const _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo";
+        return Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", options.access_token);
     }
     UserService.getUserProfile = getUserProfile;
     ;
@@ -58,11 +55,11 @@ var UserService;
      *```
      */
     function register(options, headers) {
-        var _serviceURL = window.webAuthSettings.authority + "/users-srv/register";
+        let _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);
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
     }
     UserService.register = register;
     ;
@@ -85,14 +82,14 @@ var UserService;
      * ```
      */
     function getInviteUserDetails(options) {
-        var _serviceURL = "";
+        let _serviceURL = "";
         if (options.callLatestAPI) {
             _serviceURL = window.webAuthSettings.authority + "/useractions-srv/invitations/" + options.invite_id;
         }
         else {
             _serviceURL = window.webAuthSettings.authority + "/users-srv/invite/info/" + options.invite_id;
         }
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET");
+        return Helper.createHttpPromise(undefined, _serviceURL, false, "GET");
     }
     UserService.getInviteUserDetails = getInviteUserDetails;
     ;
@@ -110,8 +107,8 @@ var UserService;
      * ```
      */
     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);
+        let _serviceURL = window.webAuthSettings.authority + "/users-srv/user/communication/status/" + options.sub;
+        return Helper.createHttpPromise(undefined, _serviceURL, false, "GET", undefined, headers);
     }
     UserService.getCommunicationStatus = getCommunicationStatus;
     ;
@@ -134,7 +131,7 @@ var UserService;
      */
     function initiateResetPassword(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/resetpassword/initiate";
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     UserService.initiateResetPassword = initiateResetPassword;
     ;
@@ -156,20 +153,20 @@ var UserService;
      */
     function handleResetPassword(options, handleResponseAsJson) {
         try {
-            var url = window.webAuthSettings.authority + "/users-srv/resetpassword/validatecode";
+            const url = window.webAuthSettings.authority + "/users-srv/resetpassword/validatecode";
             if (!handleResponseAsJson) {
                 // current handling will redirect and give query parameters
-                var form = Helper_1.Helper.createForm(url, options);
+                let form = Helper.createForm(url, options);
                 document.body.appendChild(form);
                 form.submit();
             }
             else {
                 // older cidaas service handling return json object
-                return Helper_1.Helper.createHttpPromise(options, url, false, "POST");
+                return Helper.createHttpPromise(options, url, false, "POST");
             }
         }
         catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
+            throw new CustomException(ex, 417);
         }
     }
     UserService.handleResetPassword = handleResetPassword;
@@ -193,21 +190,21 @@ var UserService;
      * ```
      */
     function resetPassword(options, handleResponseAsJson) {
-        var url = window.webAuthSettings.authority + "/users-srv/resetpassword/accept";
+        const url = window.webAuthSettings.authority + "/users-srv/resetpassword/accept";
         try {
             if (!handleResponseAsJson) {
                 // current handling will redirect and give query parameters
-                var form = Helper_1.Helper.createForm(url, options);
+                let form = Helper.createForm(url, options);
                 document.body.appendChild(form);
                 form.submit();
             }
             else {
                 // older cidaas service handling return json object
-                return Helper_1.Helper.createHttpPromise(options, url, false, "POST");
+                return Helper.createHttpPromise(options, url, false, "POST");
             }
         }
         catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
+            throw new CustomException(ex, 417);
         }
     }
     UserService.resetPassword = resetPassword;
@@ -226,8 +223,8 @@ var UserService;
      * ```
      */
     function getDeduplicationDetails(options) {
-        var _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/info/" + options.trackId;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "GET");
+        const _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/info/" + options.trackId;
+        return Helper.createHttpPromise(options, _serviceURL, false, "GET");
     }
     UserService.getDeduplicationDetails = getDeduplicationDetails;
     ;
@@ -244,13 +241,13 @@ var UserService;
      */
     function deduplicationLogin(options) {
         try {
-            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, {});
+            const url = window.webAuthSettings.authority + "/users-srv/deduplication/login/redirection?trackId=" + options.trackId + "&requestId=" + options.requestId + "&sub=" + options.sub;
+            const form = Helper.createForm(url, {});
             document.body.appendChild(form);
             form.submit();
         }
         catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
+            throw new CustomException(ex, 417);
         }
     }
     UserService.deduplicationLogin = deduplicationLogin;
@@ -269,8 +266,8 @@ var UserService;
      * ```
      */
     function registerDeduplication(options) {
-        var _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/register/" + options.trackId;
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST");
+        const _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/register/" + options.trackId;
+        return Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST");
     }
     UserService.registerDeduplication = registerDeduplication;
     ;
@@ -294,7 +291,7 @@ var UserService;
      */
     function changePassword(options, access_token) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/changepassword";
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
     }
     UserService.changePassword = changePassword;
     ;
@@ -316,8 +313,8 @@ var UserService;
      * ```
      */
     function updateProfile(options, access_token, sub) {
-        var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/profile/" + sub;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "PUT", access_token);
+        const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/profile/" + sub;
+        return Helper.createHttpPromise(options, _serviceURL, false, "PUT", access_token);
     }
     UserService.updateProfile = updateProfile;
     ;
@@ -341,7 +338,7 @@ var UserService;
     function initiateLinkAccount(options, access_token) {
         options.user_name_type = 'email';
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/link/initiate";
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
     }
     UserService.initiateLinkAccount = initiateLinkAccount;
     ;
@@ -363,7 +360,7 @@ var UserService;
      */
     function completeLinkAccount(options, access_token) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/link/complete";
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
     }
     UserService.completeLinkAccount = completeLinkAccount;
     ;
@@ -385,7 +382,7 @@ var UserService;
      */
     function getLinkedUsers(access_token, sub) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo/social/" + sub;
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", access_token);
+        return Helper.createHttpPromise(undefined, _serviceURL, false, "GET", access_token);
     }
     UserService.getLinkedUsers = getLinkedUsers;
     ;
@@ -407,7 +404,7 @@ var UserService;
      */
     function unlinkAccount(access_token, identityId) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/unlink/" + identityId;
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "POST", access_token);
+        return Helper.createHttpPromise(undefined, _serviceURL, false, "POST", access_token);
     }
     UserService.unlinkAccount = unlinkAccount;
     ;
@@ -430,7 +427,7 @@ var UserService;
      */
     function deleteUserAccount(options) {
         var _serviceURL = window.webAuthSettings.authority + "/users-srv/user/unregister/scheduler/schedule/" + options.sub;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", options.access_token);
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST", options.access_token);
     }
     UserService.deleteUserAccount = deleteUserAccount;
     ;
@@ -450,7 +447,7 @@ var UserService;
      * ```
      */
     function userCheckExists(options) {
-        var queryParameter = '';
+        let queryParameter = '';
         if (options.webfinger || options.rememberMe) {
             queryParameter += '?';
             if (options.webfinger) {
@@ -464,8 +461,8 @@ var UserService;
             }
         }
         var _serviceURL = window.webAuthSettings.authority + "/useractions-srv/userexistence/" + options.requestId + queryParameter;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     UserService.userCheckExists = userCheckExists;
     ;
-})(UserService = exports.UserService || (exports.UserService = {}));
+})(UserService || (UserService = {}));

package/dist/web-auth/VerificationService.js

@@ -1,8 +1,5 @@
-"use strict";
-exports.__esModule = true;
-exports.VerificationService = void 0;
-var Helper_1 = require("./Helper");
-var VerificationService;
+import { Helper, CustomException } from "./Helper";
+export var VerificationService;
 (function (VerificationService) {
     /**
        * To initiate the account verification, call **initiateAccountVerification()**. This will send verification code  email or sms or ivr based on the verificationMedium you mentioned.
@@ -23,13 +20,13 @@ var VerificationService;
        */
     function initiateAccountVerification(options) {
         try {
-            var url = window.webAuthSettings.authority + "/verification-srv/account/initiate";
-            var form = Helper_1.Helper.createForm(url, options);
+            const url = window.webAuthSettings.authority + "/verification-srv/account/initiate";
+            let form = Helper.createForm(url, options);
             document.body.appendChild(form);
             form.submit();
         }
         catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
+            throw new CustomException(ex, 417);
         }
     }
     VerificationService.initiateAccountVerification = initiateAccountVerification;
@@ -51,7 +48,7 @@ var VerificationService;
      */
     function verifyAccount(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/account/verify";
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     VerificationService.verifyAccount = verifyAccount;
     ;
@@ -72,7 +69,7 @@ var VerificationService;
      */
     function getMFAList(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/list";
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     VerificationService.getMFAList = getMFAList;
     ;
@@ -93,7 +90,7 @@ var VerificationService;
      */
     function cancelMFA(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/cancel/" + options.type;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     VerificationService.cancelMFA = cancelMFA;
     ;
@@ -113,8 +110,8 @@ var VerificationService;
      * ```
      */
     function getAllVerificationList(access_token) {
-        var _serviceURL = "".concat(window.webAuthSettings.authority, "/verification-srv/config/list");
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", access_token);
+        const _serviceURL = `${window.webAuthSettings.authority}/verification-srv/config/list`;
+        return Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", access_token);
     }
     VerificationService.getAllVerificationList = getAllVerificationList;
     ;
@@ -143,7 +140,7 @@ var VerificationService;
      */
     function initiateEnrollment(options, accessToken) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/initiate/" + options.verification_type;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", accessToken);
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST", accessToken);
     }
     VerificationService.initiateEnrollment = initiateEnrollment;
     ;
@@ -163,7 +160,7 @@ var VerificationService;
     */
     function getEnrollmentStatus(status_id, accessToken) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/notification/status/" + status_id;
-        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST", accessToken);
+        return Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST", accessToken);
     }
     VerificationService.getEnrollmentStatus = getEnrollmentStatus;
     ;
@@ -192,7 +189,7 @@ var VerificationService;
      */
     function enrollVerification(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/enroll/" + options.verification_type;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     VerificationService.enrollVerification = enrollVerification;
     ;
@@ -214,7 +211,7 @@ var VerificationService;
      */
     function checkVerificationTypeConfigured(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/check/" + options.verification_type;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     VerificationService.checkVerificationTypeConfigured = checkVerificationTypeConfigured;
     ;
@@ -245,9 +242,9 @@ var VerificationService;
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/initiate/" + options.type;
         // TODO: remove accessToken parameter in the next major release
         if (accessToken) {
-            return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", accessToken);
+            return Helper.createHttpPromise(options, _serviceURL, false, "POST", accessToken);
         }
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     VerificationService.initiateMFA = initiateMFA;
     ;
@@ -271,8 +268,8 @@ var VerificationService;
      */
     function authenticateMFA(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/authenticate/" + options.type;
-        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+        return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     VerificationService.authenticateMFA = authenticateMFA;
     ;
-})(VerificationService = exports.VerificationService || (exports.VerificationService = {}));
+})(VerificationService || (VerificationService = {}));

package/dist/web-auth/WebAuth.d.ts

@@ -1,39 +1,58 @@
-import { SigninState, UserManagerSettings } from "oidc-client-ts";
+import { OidcSettings, LoginRedirectOptions, LogoutRedirectOptions, PopupSignInOptions, PopupSignOutOptions, SilentSignInOptions, LoginRequestOptions, User, LogoutResponse } from '../authentication';
 import { AccessTokenRequest, TokenIntrospectionEntity, UserEntity, ResetPasswordEntity, IConfiguredListRequestEntity, IInitVerificationAuthenticationRequestEntity, FindUserEntity, IUserEntity, IEnrollVerificationSetupRequestEntity, IUserLinkEntity, ChangePasswordEntity, IConsentAcceptEntity, IAuthVerificationAuthenticationRequestEntity, LoginFormRequestEntity, AccountVerificationRequestEntity, ValidateResetPasswordEntity, AcceptResetPasswordEntity, PhysicalVerificationLoginRequest, IChangePasswordEntity, IUserActivityPayloadEntity } from "./Entities";
 export declare const createPreloginWebauth: (authority: string) => WebAuth;
 export declare class WebAuth {
-    constructor(settings: UserManagerSettings);
+    constructor(settings: OidcSettings);
     /**
-     * login
+     * Generate and redirect to authz url in same window for logging in.
+     * @param {LoginRedirectOptions} options options options to over-ride the client config for redirect login
      */
-    loginWithBrowser(): any;
+    loginWithBrowser(options?: LoginRedirectOptions): Promise<void>;
     /**
-     * popupSignIn
+     * Generate and open authz url in a popup window.
+     * On successful sign in, authenticated user is returned.
+     *
+     * @param {PopupSignInOptions} options options to over-ride the client config for popup sign in
+     * @returns {Promise<User>} Authenticated user
+     * @throws error if unable to get the parse and get user
      */
-    popupSignIn(): any;
+    popupSignIn(options?: PopupSignInOptions): Promise<User>;
     /**
-     * silentSignIn
+     * Generate and navigate to authz url in an iFrame.
+     * On successful sign in, authenticated user is returned
+     *
+     * @param {SilentSignInOptions} options options to over-ride the client config for silent sign in
+     * @returns {Promise<User>} Authenticated user
+     * @throws error if unable to get the parse and get user
      */
-    silentSignIn(): any;
+    silentSignIn(options?: SilentSignInOptions): Promise<User>;
     /**
-     * register
+     * Generate and redirect to authz url in same window for register view.
+     * @param {LoginRedirectOptions} options options options to over-ride the client config for redirect login
      */
-    registerWithBrowser(): any;
+    registerWithBrowser(options?: LoginRedirectOptions): Promise<void>;
     /**
-     * login callback
-     * @returns
+     * Once login successful, it will automatically redirects you to the redirect url whatever you mentioned in the options.
+     * To complete the login process, call **loginCallback()**. This will parses the access_token, id_token and whatever in hash in the redirect url.
+     *
+     * @param {string} url optional url from where to process the login state
+     * @returns {Promise<User>} Authenticated user
+     * @throws error if unable to get the parse and get user
      */
-    loginCallback(): any;
+    loginCallback(url?: string): Promise<User>;
     /**
-     * popup signin callback
-     * @returns
+     * To complete the popup login process, call **popupSignInCallback()** from the popup login window.
+     * Popup window will be closed after doing callback
+     *
+     * @param {string} url optional url to read sign-in callback state from
+     * @param {boolean} keepOpen true to keep the popup open even after sign in, else false
      */
-    popupSignInCallback(): any;
+    popupSignInCallback(url?: string, keepOpen?: boolean): Promise<void>;
     /**
-     * silent signin callback
-     * @returns
+     * Returns a promise to notify the parent window of response from authz service
+     * @param {string} url optional url to check authz response, if none window.location is used
      */
-    silentSignInCallback(): any;
+    silentSignInCallback(url?: string): Promise<void>;
     /**
      * To get the user profile information by using oidc-client-ts library, call **getUserInfo()**. This will return the basic user profile details along with groups, roles and whatever scopes you mentioned in the options.
      * @example
@@ -44,28 +63,30 @@ export declare class WebAuth {
      *   // your failure code here
      * });
      * ```
+     * @return {Promise<User|null>} returns authenticated user if present, else null
      */
-    getUserInfo(): Promise<any>;
+    getUserInfo(): Promise<User | null>;
     /**
      * logout by using oidc-client-ts library
-     * @returns
+     * @param {LogoutRedirectOptions} options optional options to over-ride logout options on redirect
      */
-    logout(): any;
+    logout(options?: LogoutRedirectOptions): Promise<void>;
     /**
-     * popup signout
-     * @returns
+     * logout by using oidc-client-ts library
+     * @param {PopupSignOutOptions} options optional options to over-ride logout options using popup window
      */
-    popupSignOut(): any;
+    popupSignOut(options?: PopupSignOutOptions): Promise<void>;
     /**
-     * logout callback
-     * @returns
+     * get the logout call state from the url provided, if none is provided current window url is used
+     * @returns {Promise<LogoutResponse>} logout response from auth service
      */
-    logoutCallback(): any;
+    logoutCallback(url?: string): Promise<LogoutResponse>;
     /**
-     * popup signout callback
-     * @returns
+     * listen to popup sign out event
+     * @param {string} url optional url to override to check for sign out state
+     * @param {boolean} keepOpen true to keep the popup open even after sign out, else false
      */
-    popupSignOutCallback(): any;
+    popupSignOutCallback(url?: string, keepOpen?: boolean): Promise<void>;
     /**
      * To get the generated login url, call **getLoginURL()**. This will call authz service and generate login url to be used.
      * @example
@@ -76,8 +97,10 @@ export declare class WebAuth {
      *   // your failure code here
      * });
      * ```
+     * @param {LoginRequestOptions} options login options to override {@link window.webAuthSettings} provided
+     * @return {Promise<string>} authz url for login
      */
-    getLoginURL(state?: SigninState): Promise<unknown>;
+    getLoginURL(options?: LoginRequestOptions): Promise<string>;
     /**
      * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
      * @example