cidaas-javascript-sdk 4.3.3 → 5.0.0

package/dist/verification-service/VerificationService.model.d.ts

@@ -12,9 +12,8 @@ export interface InitiateAccountVerificationRequest {
     verificationMedium?: string;
     /**
      * can be either CODE, LINK, or GENERAL
-     * BREAKING TODO: change type to ProcessingType only in next major version
-     * */
-    processingType?: ProcessingType | string;
+     */
+    processingType?: ProcessingType;
     /** Request id returned from the authorization call */
     requestId?: string;
     /** Unique identifier of client app, can be found in app setting under admin ui */
@@ -50,12 +49,12 @@ export interface GetMFAListRequest {
     /**
      * Masked sub (id of user)
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     sub?: string;
     /**
      * Masked sub (id of user)
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     q?: string;
 }
 export interface CancelMFARequest {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidaas-javascript-sdk",
-  "version": "4.3.3",
+  "version": "5.0.0",
   "author": "cidaas by Widas ID GmbH",
   "description": "Cidaas native javascript sdk",
   "license": "MIT",
@@ -14,7 +14,8 @@
     "dev": "tsc && webpack --config webpack.dev.js",
     "build": "tsc && webpack --config webpack.prod.js",
     "test": "jest --transformIgnorePatterns \"node_modules/(?!@toolz/allow)/\" --env=jsdom",
-    "test:coverage": "jest --coverage --env=jsdom"
+    "test:coverage": "jest --coverage --env=jsdom",
+    "typedoc": "typedoc"
   },
   "files": [
     "dist",
@@ -27,7 +28,7 @@
   },
   "dependencies": {
     "@toolz/is-a-regular-object": "^1.0.1",
-    "oidc-client-ts": "^2.4.1"
+    "oidc-client-ts": "^3.1.0"
   },
   "devDependencies": {
     "@babel/core": "^7.22.9",
@@ -46,7 +47,8 @@
     "ts-jest": "^29.1.1",
     "ts-loader": "^9.4.2",
     "ts-node": "10.9.1",
-    "typescript": "^4.5.4",
+    "typedoc": "^0.27.5",
+    "typescript": "^5.7.2",
     "webpack": "^5.59.1",
     "webpack-cli": "^4.9.1",
     "webpack-dev-server": "^4.3.1",

package/dist/authentication/Authentication.d.ts

@@ -1,139 +0,0 @@
-import { OidcManager, OidcSettings, LoginRedirectOptions, LogoutRedirectOptions, PopupSignInOptions, PopupSignOutOptions, SilentSignInOptions, LogoutResponse } from './Authentication.model';
-export * from './Authentication.model';
-export declare class Authentication {
-    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.
-     * @example
-     * ```js
-     * cidaas.loginWithBrowser();
-     * ```
-     *
-     * To register through cidaas sdk, call **registerWithBrowser()**. This will redirect you to the hosted registration page.
-     * * @example
-     * ```js
-     * cidaas.registerWithBrowser();
-     * ```
-     *
-     * @param {string} view_type either 'login' or 'register'
-     * @param {LoginRedirectOptions} options optional login options to override the webauth configuration
-     */
-    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.
-     * @example
-     * ```js
-     * cidaas.loginCallback().then(function (response) {
-     *   // the response will give you login details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
-     * ```
-     * @param {string} url optional url to read sign in state from
-     */
-    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(options?: LogoutRedirectOptions): Promise<void>;
-    /**
-     * **logoutCallback()** will parses the details of userState after logout.
-     * @example
-     * ```js
-     * cidaas.logoutCallback().then(function (response) {
-     *   // the response will give you userState details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
-     * ```
-     * @param {string} url optional url to read signout state from,
-     */
-    logoutCallback(url?: string): Promise<LogoutResponse>;
-    /**
-     * **popupSignIn()** will open the hosted login page in pop up window.
-     * @example
-     * ```js
-     * 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(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();
-     * ```
-     * @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(url?: string, keepOpen?: boolean): Promise<void>;
-    /**
-     * **popupSignOut()** will open the hosted logout page in pop up window.
-     * @example
-     * ```js
-     * 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(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().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(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.
-     * @example
-     * ```js
-     * cidaas.silentSignIn().then(function (response) {
-     *   // the response will give you user details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
-     * ```
-     * @param {SilentSignInOptions} options options to over-ride the client config for silent sign in
-     */
-    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(url?: string): Promise<void>;
-}

package/dist/authentication/Authentication.js

@@ -1,186 +0,0 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Authentication = void 0;
-__exportStar(require("./Authentication.model"), exports);
-class Authentication {
-    constructor(webAuthSettings, userManager) {
-        this.webAuthSettings = webAuthSettings;
-        this.userManager = userManager;
-    }
-    /**
-     * 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.
-     * @example
-     * ```js
-     * cidaas.loginWithBrowser();
-     * ```
-     *
-     * To register through cidaas sdk, call **registerWithBrowser()**. This will redirect you to the hosted registration page.
-     * * @example
-     * ```js
-     * cidaas.registerWithBrowser();
-     * ```
-     *
-     * @param {string} view_type either 'login' or 'register'
-     * @param {LoginRedirectOptions} options optional login options to override the webauth configuration
-     */
-    loginOrRegisterWithBrowser(view_type, options) {
-        var _a;
-        if (!this.webAuthSettings.extraQueryParams) {
-            this.webAuthSettings.extraQueryParams = {};
-        }
-        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(Object.assign({ extraQueryParams: this.webAuthSettings.extraQueryParams, redirect_uri: this.webAuthSettings.redirect_uri }, (options && Object.assign({}, options) || {})));
-    }
-    /**
-     * 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.
-     * @example
-     * ```js
-     * cidaas.loginCallback().then(function (response) {
-     *   // the response will give you login details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
-     * ```
-     * @param {string} url optional url to read sign in state from
-     */
-    loginCallback(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();
-     * ```
-     * @param {LogoutRedirectOptions} options optional logout options to override webauth configurations
-     */
-    logout(options) {
-        return this.userManager.signoutRedirect(options);
-    }
-    /**
-     * **logoutCallback()** will parses the details of userState after logout.
-     * @example
-     * ```js
-     * cidaas.logoutCallback().then(function (response) {
-     *   // the response will give you userState details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
-     * ```
-     * @param {string} url optional url to read signout state from,
-     */
-    logoutCallback(url) {
-        return this.userManager.signoutRedirectCallback(url);
-    }
-    /**
-     * **popupSignIn()** will open the hosted login page in pop up window.
-     * @example
-     * ```js
-     * 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(options) {
-        return this.userManager.signinPopup(options);
-    }
-    /**
-     * 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();
-     * ```
-     * @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(url, keepOpen) {
-        return this.userManager.signinPopupCallback(url, keepOpen);
-    }
-    /**
-     * **popupSignOut()** will open the hosted logout page in pop up window.
-     * @example
-     * ```js
-     * 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(options) {
-        return this.userManager.signoutPopup(options);
-    }
-    /**
-     * calling **popupSignOutCallback()** from the popup window complete popup logout process.
-     * Popup window won't be closed after doing callback
-     * @example
-     * ```js
-     * 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(url, keepOpen = true) {
-        url = url !== null && url !== void 0 ? url : this.webAuthSettings.post_logout_redirect_uri;
-        return this.userManager.signoutPopupCallback(url, keepOpen);
-    }
-    /**
-     * **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.
-     * @example
-     * ```js
-     * cidaas.silentSignIn().then(function (response) {
-     *   // the response will give you user details.
-     * }).catch(function(ex) {
-     *  // your failure code here
-     * });
-     * ```
-     * @param {SilentSignInOptions} options options to over-ride the client config for silent sign in
-     */
-    silentSignIn(options) {
-        return this.userManager.signinSilent(Object.assign({ silentRequestTimeoutInSeconds: 60 }, (options && Object.assign({}, options) || {})));
-    }
-    /**
-     * 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(url) {
-        return this.userManager.signinSilentCallback(url);
-    }
-}
-exports.Authentication = Authentication;