cidaas-javascript-sdk 4.1.0 → 4.2.1

package/CHANGELOG.md

@@ -1,18 +1,44 @@
-# [4.1.0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.0.2...v4.1.0) (2024-01-19)
+## [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
 
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([5917eb0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/5917eb0cf98248c66d0b149cb41cf27be69c41ae))
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([ffc503d](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/ffc503dfde2510c8000e18cb437b5ab0a7578ee8))
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([a3d2860](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/a3d28601490b0303c9f86b60aeda3c5a46788966))
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([88cd3b7](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/88cd3b766de7ede953594cc47d34d6e45dc3e17b))
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([1c347ef](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/1c347efc9a54d787538416b3eee1d609238b4b1d))
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([df4630a](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/df4630a8d8def6ef36d402f230f6ada86875e71e))
-* **[1441](https://gitlab.widas.de/cidaas-v2/framework/issues/-/issues/1441):** Add the new method for Get Invite User details ([3a2ce7e](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/3a2ce7ec82b3ae91ffc8066081f905972f278985))
+* 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
+- add back functionality to get missing field from social provider in getMissingFields() function.
+
+### Changed
+- loginWithBrowser now returning promise
+- registerWithBrowser now returning promise
+- popupSignIn now returning User object after popupSignInCallback is finished
+- popupSignInCallback now returning promise
+- popupSignOut now returning promise
+- popupSignOutCallback now returning promise
+
 ## V4.1.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): 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,20 +33,18 @@ export declare class Authentication {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read sign in state from
      */
-    loginCallback(): Promise<unknown>;
+    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().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
      */
-    logout(): Promise<unknown>;
+    logout(options?: LogoutRedirectOptions): Promise<void>;
     /**
      * **logoutCallback()** will parses the details of userState after logout.
      * @example
@@ -55,46 +55,63 @@ export declare class Authentication {
      *  // your failure code here
      * });
      * ```
+     * @param {string} url optional url to read signout state from,
      */
-    logoutCallback(): Promise<unknown>;
+    logoutCallback(url?: string): Promise<LogoutResponse>;
     /**
      * **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
      */
-    popupSignIn(): void;
+    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
      * @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
      */
-    popupSignInCallback(): void;
+    popupSignInCallback(url?: string, keepOpen?: boolean): Promise<void>;
     /**
      * **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
      */
-    popupSignOut(): 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
      * @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
      */
-    popupSignOutCallback(): 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.
@@ -106,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<unknown>;
+    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<unknown>;
+    silentSignInCallback(url?: string): Promise<void>;
 }