cidaas-javascript-sdk 4.1.0 → 4.2.1

package/dist/authentication/index.js

@@ -1,6 +1,32 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 exports.__esModule = true;
 exports.Authentication = void 0;
+__exportStar(require("./authentication.model"), exports);
 var Authentication = /** @class */ (function () {
     function Authentication(webAuthSettings, userManager) {
         this.webAuthSettings = webAuthSettings;
@@ -21,35 +47,18 @@ var Authentication = /** @class */ (function () {
      * ```
      *
      * @param view_type: either 'login' or 'register'
+     * @param {LoginRedirectOptions} options optional login options to override the webauth configuration
      */
-    Authentication.prototype.loginOrRegisterWithBrowser = function (view_type) {
-        try {
-            if (this.userManager) {
-                if (this.webAuthSettings) {
-                    if (!this.webAuthSettings.extraQueryParams) {
-                        this.webAuthSettings.extraQueryParams = {};
-                    }
-                    this.webAuthSettings.extraQueryParams.view_type = view_type;
-                    if (this.webAuthSettings.scope) {
-                        if (this.webAuthSettings.response_type.indexOf("id_token") == -1 && this.webAuthSettings.scope.indexOf("openid") != -1 && !this.webAuthSettings.extraQueryParams.nonce) {
-                            this.webAuthSettings.extraQueryParams.nonce = new Date().getTime().toString();
-                        }
-                    }
-                }
-                this.userManager.signinRedirect({
-                    extraQueryParams: this.webAuthSettings.extraQueryParams,
-                    redirect_uri: this.webAuthSettings.redirect_uri
-                }).then(function () {
-                    console.log("Redirect logged in using cidaas sdk");
-                });
-            }
-            else {
-                throw "user manager is null";
-            }
+    Authentication.prototype.loginOrRegisterWithBrowser = function (view_type, options) {
+        var _a;
+        if (!this.webAuthSettings.extraQueryParams) {
+            this.webAuthSettings.extraQueryParams = {};
         }
-        catch (ex) {
-            console.log("user manager instance is empty : " + ex);
+        this.webAuthSettings.extraQueryParams.view_type = view_type;
+        if (this.webAuthSettings.response_type.indexOf("id_token") == -1 && ((_a = this.webAuthSettings.scope) === null || _a === void 0 ? void 0 : _a.indexOf("openid")) != -1 && !this.webAuthSettings.extraQueryParams.nonce) {
+            this.webAuthSettings.extraQueryParams.nonce = new Date().getTime().toString();
         }
+        return this.userManager.signinRedirect(__assign({ extraQueryParams: this.webAuthSettings.extraQueryParams, redirect_uri: this.webAuthSettings.redirect_uri }, (options && { options: options } || {})));
     };
     ;
     /**
@@ -63,67 +72,22 @@ var Authentication = /** @class */ (function () {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read sign in state from
      */
-    Authentication.prototype.loginCallback = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            try {
-                if (_this.userManager) {
-                    _this.userManager.signinRedirectCallback()
-                        .then(function (user) {
-                        if (user) {
-                            resolve(user);
-                            return;
-                        }
-                        resolve(undefined);
-                    })["catch"](function (ex) {
-                        reject(ex);
-                    });
-                }
-                else {
-                    throw "user manager is null";
-                }
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+    Authentication.prototype.loginCallback = function (url) {
+        return this.userManager.signinRedirectCallback(url);
     };
     /**
      * To use the **logout()** method, you need set the redirect url, if not it will automatically redirect to the login page
      * @example
      * ```js
-     * cidaas.logout().then(function () {
-     *   // your logout success code here
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
+     * cidaas.logout();
      * ```
+     * @param {LogoutRedirectOptions} options optional logout options to override webauth configurations
      */
-    Authentication.prototype.logout = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            try {
-                if (_this.userManager && _this.webAuthSettings) {
-                    _this.userManager.signoutRedirect({
-                        state: _this.webAuthSettings
-                    }).then(function (resp) {
-                        console.log('signed out', resp);
-                        window.authentication.logoutCallback().then(function (resp) {
-                            resolve(resp);
-                        });
-                    });
-                }
-                else {
-                    throw "user manager or settings is null";
-                }
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+    Authentication.prototype.logout = function (options) {
+        return this.userManager.signoutRedirect(options);
     };
-    ;
     /**
      * **logoutCallback()** will parses the details of userState after logout.
      * @example
@@ -134,49 +98,26 @@ var Authentication = /** @class */ (function () {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read signout state from,
      */
-    Authentication.prototype.logoutCallback = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            try {
-                if (_this.userManager) {
-                    _this.userManager.signoutRedirectCallback().then(function (resp) {
-                        console.log("Signed out");
-                        resolve(resp);
-                    });
-                }
-                else {
-                    resolve(undefined);
-                    throw "user manager is null";
-                }
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+    Authentication.prototype.logoutCallback = function (url) {
+        return this.userManager.signoutRedirectCallback(url);
     };
     ;
     /**
      * **popupSignIn()** will open the hosted login page in pop up window.
      * @example
      * ```js
-     * cidaas.popupSignIn();
+     * cidaas.popupSignIn().then(function (response) {
+     *   // the response will give you user details after finishing popupSignInCallback().
+     * }).catch(function(ex) {
+     *  // your failure code here
+     * });
      * ```
+     * @param {LogoutRedirectOptions} options optional popup sign-in options to override webauth configurations
      */
-    Authentication.prototype.popupSignIn = function () {
-        try {
-            if (this.userManager && this.webAuthSettings) {
-                this.userManager.signinPopup().then(function () {
-                    console.log("signed in");
-                });
-            }
-            else {
-                throw "user manager or settings is null";
-            }
-        }
-        catch (ex) {
-            console.error(ex);
-        }
+    Authentication.prototype.popupSignIn = function (options) {
+        return this.userManager.signinPopup(options);
     };
     ;
     /**
@@ -184,47 +125,30 @@ var Authentication = /** @class */ (function () {
      * Popup window will be closed after doing callback
      * @example
      * ```js
-     * cidaas.popupSignInCallback().then(function (response) {
-     *   // the response will give you login details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
+     * cidaas.popupSignInCallback();
      * ```
+     * @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
      */
-    Authentication.prototype.popupSignInCallback = function () {
-        try {
-            if (this.userManager) {
-                this.userManager.signinPopupCallback();
-            }
-        }
-        catch (ex) {
-            console.error(ex);
-        }
+    Authentication.prototype.popupSignInCallback = function (url, keepOpen) {
+        return this.userManager.signinPopupCallback(url, keepOpen);
     };
     ;
     /**
      * **popupSignOut()** will open the hosted logout page in pop up window.
      * @example
      * ```js
-     * cidaas.popupSignOut()
+     * cidaas.popupSignOut().then(function() {
+     *   // success callback in main application window after finishing popupSignOutCallback().
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
      * ```
+     *
+     * @param {PopupSignOutOptions} options optional options to over-ride logout options using popup window
      */
-    Authentication.prototype.popupSignOut = function () {
-        try {
-            if (this.userManager && this.webAuthSettings) {
-                this.userManager.signoutPopup({
-                    state: this.webAuthSettings
-                }).then(function (resp) {
-                    console.log('signed out', resp);
-                });
-            }
-            else {
-                throw "user manager or settings is null";
-            }
-        }
-        catch (ex) {
-            console.error(ex);
-        }
+    Authentication.prototype.popupSignOut = function (options) {
+        return this.userManager.signoutPopup(options);
     };
     ;
     /**
@@ -232,21 +156,19 @@ var Authentication = /** @class */ (function () {
      * Popup window won't be closed after doing callback
      * @example
      * ```js
-     * cidaas.popupSignOutCallback();
+     * cidaas.popupSignOutCallback().then(function() {
+     *   // success callback in popup window after finishing popupSignOutCallback().
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
      * ```
+     *
+     * @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
      */
-    Authentication.prototype.popupSignOutCallback = function () {
-        try {
-            if (this.userManager) {
-                this.userManager.signoutPopupCallback(this.webAuthSettings.post_logout_redirect_uri, true);
-            }
-            else {
-                throw "user manager is null";
-            }
-        }
-        catch (ex) {
-            console.error(ex);
-        }
+    Authentication.prototype.popupSignOutCallback = function (url, keepOpen) {
+        if (keepOpen === void 0) { keepOpen = true; }
+        return this.userManager.signoutPopupCallback(url, keepOpen);
     };
     ;
     /**
@@ -260,31 +182,10 @@ var Authentication = /** @class */ (function () {
      *  // your failure code here
      * });
      * ```
+     * @param {SilentSignInOptions} options options to over-ride the client config for silent sign in
      */
-    Authentication.prototype.silentSignIn = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            try {
-                if (_this.userManager && _this.webAuthSettings) {
-                    _this.userManager.signinSilent({
-                        state: _this.webAuthSettings,
-                        silentRequestTimeoutInSeconds: 60
-                    }).then(function (user) {
-                        if (user) {
-                            resolve(user);
-                            return;
-                        }
-                        resolve(undefined);
-                    });
-                }
-                else {
-                    throw "user manager or web auth settings is null";
-                }
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+    Authentication.prototype.silentSignIn = function (options) {
+        return this.userManager.signinSilent(__assign({ silentRequestTimeoutInSeconds: 60 }, (options && { options: options } || {})));
     };
     ;
     /**
@@ -292,32 +193,12 @@ var Authentication = /** @class */ (function () {
      * @example
      * ```js
      * cidaas.silentSignInCallback();
+     *
      * ```
+     * @param {string} url optional url to read sign in state from
      */
-    Authentication.prototype.silentSignInCallback = function (callbackurl) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            try {
-                if (_this.userManager) {
-                    _this.userManager.signinSilentCallback(callbackurl)
-                        .then(function (user) {
-                        if (user) {
-                            resolve(user);
-                            return;
-                        }
-                        resolve(undefined);
-                    })["catch"](function (e) {
-                        reject(e);
-                    });
-                }
-                else {
-                    throw "user manager is null";
-                }
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+    Authentication.prototype.silentSignInCallback = function (url) {
+        return this.userManager.signinSilentCallback(url);
     };
     ;
     return Authentication;

package/dist/web-auth/LoginService.js

@@ -178,7 +178,6 @@ var LoginService;
     function firstTimeChangePassword(options) {
         try {
             var url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.loginSettingsId;
-            ;
             var form = Helper_1.Helper.createForm(url, options);
             document.body.appendChild(form);
             form.submit();

package/dist/web-auth/TokenService.js

@@ -102,7 +102,7 @@ var TokenService;
                         options.redirect_uri = window.webAuthSettings.redirect_uri;
                         options.grant_type = "authorization_code";
                         if (!!window.webAuthSettings.disablePKCE) return [3 /*break*/, 2];
-                        return [4 /*yield*/, window.usermanager._client.createSigninRequest(window.webAuthSettings)];
+                        return [4 /*yield*/, window.usermanager.getClient().createSigninRequest(window.webAuthSettings)];
                     case 1:
                         signInRequest = _b.sent();
                         options.code_verifier = (_a = signInRequest.state) === null || _a === void 0 ? void 0 : _a.code_verifier;

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

@@ -1,38 +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(): void;
+    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(): void;
+    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(): Promise<unknown>;
+    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(): void;
+    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(): Promise<unknown>;
+    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(): Promise<unknown>;
+    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(): Promise<unknown>;
+    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
@@ -41,30 +61,32 @@ export declare class WebAuth {
      *   // the response will give you profile details.
      * }).catch(function(ex) {
      *   // 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(): Promise<unknown>;
+    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(): Promise<unknown>;
+    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(): Promise<unknown>;
+    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(): Promise<unknown>;
+    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
@@ -73,10 +95,12 @@ export declare class WebAuth {
      *   // the response will give you login url.
      * }).catch(function(ex) {
      *   // 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
@@ -85,7 +109,7 @@ export declare class WebAuth {
      *   // the response will give you request id.
      * }).catch(function(ex) {
      *   // your failure code here
-     * });;
+     * });
      * ```
      */
     getRequestId(): Promise<unknown>;
@@ -97,7 +121,7 @@ export declare class WebAuth {
      *   // the response will give you tenant details
      * }).catch(function(ex) {
      *   // your failure code here
-     * });;
+     * });
      * ```
      */
     getTenantInfo(): Promise<unknown>;
@@ -590,10 +614,26 @@ export declare class WebAuth {
     }): Promise<unknown>;
     /**
      * getMissingFields
-     * @param trackId
-     * @returns
+     * @param trackId - required. If only trackId is given, it will get missing fields from cidaas after succesfull registration using default provider
+     * @param useSocialProvider - optional. If given, it will get missing fields from social provider after successful registration using social provider
+     *
+     * @example
+     * ```js
+     * const trackId = 'your track id'
+     * const useSocialProvider = {
+     *   requestId: 'request id from cidaas'
+     * };
+     * cidaas.getMissingFields(trackId, useSocialProvider).then(function (resp) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code
+     * });
+     * ```
+     *
      */
-    getMissingFields(trackId: string): Promise<unknown>;
+    getMissingFields(trackId: string, useSocialProvider?: {
+        requestId: string;
+    }): Promise<unknown>;
     /**
      * progressiveRegistration
      * @param options