cidaas-javascript-sdk 4.2.0 → 4.2.1

package/CHANGELOG.md

@@ -1,12 +1,31 @@
-# [4.2.0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.1.0...v4.2.0) (2024-03-14)
+## [4.2.1](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.2.0...v4.2.1) (2024-04-05)
 
 
-### Features
+### Bug Fixes
 
-* add get missing fields from social provider ([fde6303](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/fde630370b0869f836363441b261effa5b2a810f))
+* Add missing params to configure web-authentication ([85e3d08](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/85e3d08792e5ddb01d028e1d008ae5d613b4caeb))
 
 # Changelog
 
+## V4.2.1
+
+### Added
+- Add authentication type
+
+### Changed
+- loginWithBrowser can be over-ridden with LoginRedirectOptions 
+- popupSignIn can be over-ridden with PopupSignInOptions
+- silentSignIn can be over-ridden with SilentSignInOptions
+- registerWithBrowser can be over-ridden with LoginRedirectOptions
+- loginCallback accepts url location option
+- popupSignInCallback accepts url and keepOpen option
+- silentSignInCallback accepts url location option
+- logout can be over-ridden with LogoutRedirectOptions
+- popupSignOut can be over-ridden with PopupSignOutOptions
+- logoutCallback accepts url location option
+- popupSignOutCallback accepts url location option
+- getLoginURL can be over-ridden with LoginRequestOptions
+
 ## V4.2.0
 
 ### Added

package/dist/authentication/authentication.model.d.ts

@@ -0,0 +1,61 @@
+import { SigninPopupArgs, SigninRedirectArgs, SigninSilentArgs, SignoutPopupArgs, SignoutRedirectArgs, UserManagerSettings, UserManager, OidcClient, CreateSigninRequestArgs, User as OidcUser, SignoutResponse } from 'oidc-client-ts';
+/**
+ * @augments UserManagerSettings
+ * **/
+export interface OidcSettings extends UserManagerSettings {
+}
+/**
+ * @augments UserManager
+ * */
+export declare class OidcManager extends UserManager {
+    getClient(): OidcClient;
+}
+/***
+ * Login request to generate authz url.
+ * It's based of the parameters in OIDC specs
+ * @augments CreateSigninRequestArgs
+ */
+export interface LoginRequestOptions extends CreateSigninRequestArgs {
+}
+/***
+ * Options to override options during redirect login
+ * @augments SigninRedirectArgs
+ */
+export interface LoginRedirectOptions extends SigninRedirectArgs {
+}
+/**
+ * Response state holding sign out errors if any
+ * @augments SignoutResponse
+ * **/
+export interface LogoutResponse extends SignoutResponse {
+}
+/***
+ * Options to override options during redirect logout
+ * @augments SignoutRedirectArgs
+ */
+export interface LogoutRedirectOptions extends SignoutRedirectArgs {
+}
+/***
+ * Options to override options during popup sign in
+ * @augments SigninPopupArgs
+ */
+export interface PopupSignInOptions extends SigninPopupArgs {
+}
+/***
+ * Options to override options during popup sign out
+ * @augments SignoutPopupArgs
+ */
+export interface PopupSignOutOptions extends SignoutPopupArgs {
+}
+/***
+ * Options to override options during silent sign in
+ * @augments SigninSilentArgs
+ */
+export interface SilentSignInOptions extends SigninSilentArgs {
+}
+/**
+ * Authenticated user information including token, id_token and claims
+ * @augments OidcUser
+ * **/
+export declare class User extends OidcUser {
+}

package/dist/authentication/authentication.model.js

@@ -0,0 +1,45 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+exports.__esModule = true;
+exports.User = exports.OidcManager = void 0;
+var oidc_client_ts_1 = require("oidc-client-ts");
+/**
+ * @augments UserManager
+ * */
+var OidcManager = /** @class */ (function (_super) {
+    __extends(OidcManager, _super);
+    function OidcManager() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    OidcManager.prototype.getClient = function () {
+        return this._client;
+    };
+    return OidcManager;
+}(oidc_client_ts_1.UserManager));
+exports.OidcManager = OidcManager;
+/**
+ * Authenticated user information including token, id_token and claims
+ * @augments OidcUser
+ * **/
+var User = /** @class */ (function (_super) {
+    __extends(User, _super);
+    function User() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return User;
+}(oidc_client_ts_1.User));
+exports.User = User;

package/dist/authentication/index.d.ts

@@ -1,8 +1,9 @@
-import { UserManager, UserManagerSettings } from "oidc-client-ts";
+import { OidcManager, OidcSettings, LoginRedirectOptions, LogoutRedirectOptions, PopupSignInOptions, PopupSignOutOptions, SilentSignInOptions, LogoutResponse } from './authentication.model';
+export * from './authentication.model';
 export declare class Authentication {
-    webAuthSettings: UserManagerSettings;
-    userManager: UserManager;
-    constructor(webAuthSettings: UserManagerSettings, userManager: UserManager);
+    webAuthSettings: OidcSettings;
+    userManager: OidcManager;
+    constructor(webAuthSettings: OidcSettings, userManager: OidcManager);
     /**
      * To login through cidaas sdk, call **loginWithBrowser()**. This will redirect you to the hosted login page.
      * once login successful, it will automatically redirects you to the redirect url whatever you mentioned in the options.
@@ -18,8 +19,9 @@ export declare class Authentication {
      * ```
      *
      * @param view_type: either 'login' or 'register'
+     * @param {LoginRedirectOptions} options optional login options to override the webauth configuration
      */
-    loginOrRegisterWithBrowser(view_type: string): Promise<void>;
+    loginOrRegisterWithBrowser(view_type: string, options?: LoginRedirectOptions): Promise<void>;
     /**
      * 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.
@@ -31,16 +33,18 @@ export declare class Authentication {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read sign in state from
      */
-    loginCallback(): Promise<import("oidc-client-ts").User>;
+    loginCallback(url?: string): Promise<import("oidc-client-ts").User>;
     /**
      * 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();
      * ```
+     * @param {LogoutRedirectOptions} options optional logout options to override webauth configurations
      */
-    logout(): Promise<void>;
+    logout(options?: LogoutRedirectOptions): Promise<void>;
     /**
      * **logoutCallback()** will parses the details of userState after logout.
      * @example
@@ -51,8 +55,9 @@ export declare class Authentication {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read signout state from,
      */
-    logoutCallback(): Promise<import("oidc-client-ts").SignoutResponse>;
+    logoutCallback(url?: string): Promise<LogoutResponse>;
     /**
      * **popupSignIn()** will open the hosted login page in pop up window.
      * @example
@@ -63,8 +68,9 @@ export declare class Authentication {
      *  // your failure code here
      * });
      * ```
+     * @param {LogoutRedirectOptions} options optional popup sign-in options to override webauth configurations
      */
-    popupSignIn(): Promise<import("oidc-client-ts").User>;
+    popupSignIn(options?: PopupSignInOptions): Promise<import("oidc-client-ts").User>;
     /**
      * To complete the popup login process, call **popupSignInCallback()** from the popup login window.
      * Popup window will be closed after doing callback
@@ -72,8 +78,10 @@ export declare class Authentication {
      * ```js
      * 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
      */
-    popupSignInCallback(): Promise<void>;
+    popupSignInCallback(url?: string, keepOpen?: boolean): Promise<void>;
     /**
      * **popupSignOut()** will open the hosted logout page in pop up window.
      * @example
@@ -84,8 +92,10 @@ export declare class Authentication {
      *   // your failure code here
      * });
      * ```
+     *
+     * @param {PopupSignOutOptions} options optional options to over-ride logout options using popup window
      */
-    popupSignOut(): Promise<void>;
+    popupSignOut(options?: PopupSignOutOptions): Promise<void>;
     /**
      * calling **popupSignOutCallback()** from the popup window complete popup logout process.
      * Popup window won't be closed after doing callback
@@ -97,8 +107,11 @@ export declare class Authentication {
      *   // 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
      */
-    popupSignOutCallback(): Promise<void>;
+    popupSignOutCallback(url?: string, keepOpen?: boolean): Promise<void>;
     /**
      * **silentSignIn()** will open the hosted login page in an iframe.
      * this function could only be called from the same domain. Cross Domain is not supported for security purpose.
@@ -110,14 +123,17 @@ export declare class Authentication {
      *  // your failure code here
      * });
      * ```
+     * @param {SilentSignInOptions} options options to over-ride the client config for silent sign in
      */
-    silentSignIn(): Promise<import("oidc-client-ts").User>;
+    silentSignIn(options?: SilentSignInOptions): Promise<import("oidc-client-ts").User>;
     /**
      * To complete the silent login process, call **silentSignInCallback()** from the iframe. This will complete the login process in iframe.
      * @example
      * ```js
      * cidaas.silentSignInCallback();
+     *
      * ```
+     * @param {string} url optional url to read sign in state from
      */
-    silentSignInCallback(callbackurl?: string): Promise<void>;
+    silentSignInCallback(url?: string): Promise<void>;
 }

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,8 +47,9 @@ 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) {
+    Authentication.prototype.loginOrRegisterWithBrowser = function (view_type, options) {
         var _a;
         if (!this.webAuthSettings.extraQueryParams) {
             this.webAuthSettings.extraQueryParams = {};
@@ -31,10 +58,7 @@ var Authentication = /** @class */ (function () {
         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({
-            extraQueryParams: this.webAuthSettings.extraQueryParams,
-            redirect_uri: this.webAuthSettings.redirect_uri
-        });
+        return this.userManager.signinRedirect(__assign({ extraQueryParams: this.webAuthSettings.extraQueryParams, redirect_uri: this.webAuthSettings.redirect_uri }, (options && { options: options } || {})));
     };
     ;
     /**
@@ -48,9 +72,10 @@ var Authentication = /** @class */ (function () {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read sign in state from
      */
-    Authentication.prototype.loginCallback = function () {
-        return this.userManager.signinRedirectCallback();
+    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
@@ -58,9 +83,10 @@ var Authentication = /** @class */ (function () {
      * ```js
      * cidaas.logout();
      * ```
+     * @param {LogoutRedirectOptions} options optional logout options to override webauth configurations
      */
-    Authentication.prototype.logout = function () {
-        return this.userManager.signoutRedirect({ state: this.webAuthSettings });
+    Authentication.prototype.logout = function (options) {
+        return this.userManager.signoutRedirect(options);
     };
     /**
      * **logoutCallback()** will parses the details of userState after logout.
@@ -72,9 +98,10 @@ var Authentication = /** @class */ (function () {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read signout state from,
      */
-    Authentication.prototype.logoutCallback = function () {
-        return this.userManager.signoutRedirectCallback();
+    Authentication.prototype.logoutCallback = function (url) {
+        return this.userManager.signoutRedirectCallback(url);
     };
     ;
     /**
@@ -87,9 +114,10 @@ var Authentication = /** @class */ (function () {
      *  // your failure code here
      * });
      * ```
+     * @param {LogoutRedirectOptions} options optional popup sign-in options to override webauth configurations
      */
-    Authentication.prototype.popupSignIn = function () {
-        return this.userManager.signinPopup();
+    Authentication.prototype.popupSignIn = function (options) {
+        return this.userManager.signinPopup(options);
     };
     ;
     /**
@@ -99,9 +127,11 @@ var Authentication = /** @class */ (function () {
      * ```js
      * 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 () {
-        return this.userManager.signinPopupCallback();
+    Authentication.prototype.popupSignInCallback = function (url, keepOpen) {
+        return this.userManager.signinPopupCallback(url, keepOpen);
     };
     ;
     /**
@@ -114,9 +144,11 @@ var Authentication = /** @class */ (function () {
      *   // your failure code here
      * });
      * ```
+     *
+     * @param {PopupSignOutOptions} options optional options to over-ride logout options using popup window
      */
-    Authentication.prototype.popupSignOut = function () {
-        return this.userManager.signoutPopup({ state: this.webAuthSettings });
+    Authentication.prototype.popupSignOut = function (options) {
+        return this.userManager.signoutPopup(options);
     };
     ;
     /**
@@ -130,9 +162,13 @@ var Authentication = /** @class */ (function () {
      *   // 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 () {
-        return this.userManager.signoutPopupCallback(this.webAuthSettings.post_logout_redirect_uri, true);
+    Authentication.prototype.popupSignOutCallback = function (url, keepOpen) {
+        if (keepOpen === void 0) { keepOpen = true; }
+        return this.userManager.signoutPopupCallback(url, keepOpen);
     };
     ;
     /**
@@ -146,12 +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 () {
-        return this.userManager.signinSilent({
-            state: this.webAuthSettings,
-            silentRequestTimeoutInSeconds: 60
-        });
+    Authentication.prototype.silentSignIn = function (options) {
+        return this.userManager.signinSilent(__assign({ silentRequestTimeoutInSeconds: 60 }, (options && { options: options } || {})));
     };
     ;
     /**
@@ -159,10 +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) {
-        return this.userManager.signinSilentCallback(callbackurl);
+    Authentication.prototype.silentSignInCallback = function (url) {
+        return this.userManager.signinSilentCallback(url);
     };
     ;
     return Authentication;

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,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

package/dist/web-auth/WebAuth.js

@@ -48,7 +48,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 exports.__esModule = true;
 exports.WebAuth = exports.createPreloginWebauth = void 0;
-var oidc_client_ts_1 = require("oidc-client-ts");
 var authentication_1 = require("../authentication");
 var Helper_1 = require("./Helper");
 var LoginService_1 = require("./LoginService");
@@ -72,7 +71,7 @@ var WebAuth = /** @class */ (function () {
             if (settings.authority && settings.authority.charAt(settings.authority.length - 1) === '/') {
                 settings.authority = settings.authority.slice(0, settings.authority.length - 1);
             }
-            var usermanager = new oidc_client_ts_1.UserManager(settings);
+            var usermanager = new authentication_1.OidcManager(settings);
             window.webAuthSettings = settings;
             window.usermanager = usermanager;
             window.localeSettings = null;
@@ -87,76 +86,95 @@ var WebAuth = /** @class */ (function () {
     }
     // prototype methods 
     /**
-     * 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
      */
-    WebAuth.prototype.loginWithBrowser = function () {
+    WebAuth.prototype.loginWithBrowser = function (options) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.loginOrRegisterWithBrowser('login');
+        return window.authentication.loginOrRegisterWithBrowser('login', options);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.popupSignIn = function () {
+    WebAuth.prototype.popupSignIn = function (options) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.popupSignIn();
+        return window.authentication.popupSignIn(options);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.silentSignIn = function () {
+    WebAuth.prototype.silentSignIn = function (options) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.silentSignIn();
+        return window.authentication.silentSignIn(options);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.registerWithBrowser = function () {
+    WebAuth.prototype.registerWithBrowser = function (options) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.loginOrRegisterWithBrowser('register');
+        return window.authentication.loginOrRegisterWithBrowser('register', options);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.loginCallback = function () {
+    WebAuth.prototype.loginCallback = function (url) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.loginCallback();
+        return window.authentication.loginCallback(url);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.popupSignInCallback = function () {
+    WebAuth.prototype.popupSignInCallback = function (url, keepOpen) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.popupSignInCallback();
+        return window.authentication.popupSignInCallback(url, keepOpen);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.silentSignInCallback = function () {
+    WebAuth.prototype.silentSignInCallback = function (url) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.silentSignInCallback();
+        return window.authentication.silentSignInCallback(url);
     };
     ;
     /**
@@ -169,6 +187,7 @@ var WebAuth = /** @class */ (function () {
      *   // your failure code here
      * });
      * ```
+     * @return {Promise<User|null>} returns authenticated user if present, else null
      */
     WebAuth.prototype.getUserInfo = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -187,46 +206,47 @@ var WebAuth = /** @class */ (function () {
     ;
     /**
      * logout by using oidc-client-ts library
-     * @returns
+     * @param {LogoutRedirectOptions} options optional options to over-ride logout options on redirect
      */
-    WebAuth.prototype.logout = function () {
+    WebAuth.prototype.logout = function (options) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.logout();
+        return window.authentication.logout(options);
     };
     ;
     /**
-     * popup signout
-     * @returns
+     * logout by using oidc-client-ts library
+     * @param {PopupSignOutOptions} options optional options to over-ride logout options using popup window
      */
-    WebAuth.prototype.popupSignOut = function () {
+    WebAuth.prototype.popupSignOut = function (options) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.popupSignOut();
+        return window.authentication.popupSignOut(options);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.logoutCallback = function () {
+    WebAuth.prototype.logoutCallback = function (url) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.logoutCallback();
+        return window.authentication.logoutCallback(url);
     };
     ;
     /**
-     * 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
      */
-    WebAuth.prototype.popupSignOutCallback = function () {
+    WebAuth.prototype.popupSignOutCallback = function (url, keepOpen) {
         if (!window.webAuthSettings || !window.authentication) {
             return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
         }
-        return window.authentication.popupSignOutCallback();
+        return window.authentication.popupSignOutCallback(url, keepOpen);
     };
     ;
     /**
@@ -239,11 +259,16 @@ var WebAuth = /** @class */ (function () {
      *   // your failure code here
      * });
      * ```
+     * @param {LoginRequestOptions} options login options to override {@link window.webAuthSettings} provided
+     * @return {Promise<string>} authz url for login
      */
-    WebAuth.prototype.getLoginURL = function (state) {
+    WebAuth.prototype.getLoginURL = function (options) {
+        if (!window.webAuthSettings || !window.authentication) {
+            return Promise.reject(new Helper_1.CustomException("Settings or Authentication instance in OIDC cannot be empty", 417));
+        }
         return new Promise(function (resolve, reject) {
             try {
-                window.usermanager._client.createSigninRequest({ state: state }).then(function (signinRequest) {
+                window.usermanager.getClient().createSigninRequest(__assign(__assign({}, window.webAuthSettings), (options && { options: options } || {}))).then(function (signinRequest) {
                     resolve(signinRequest.url);
                 });
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidaas-javascript-sdk",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "author": "cidaas by Widas ID GmbH",
   "description": "Cidaas native javascript sdk",
   "license": "MIT",