cidaas-javascript-sdk 4.3.1 → 4.3.3

package/CHANGELOG.md

@@ -1,25 +1,23 @@
-## [4.3.1](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.3.0...v4.3.1) (2024-11-14)
+## [4.3.3](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.3.2...v4.3.3) (2024-11-28)
 
 
 ### Bug Fixes
 
-* [#434](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/issues/434) update javascript sdk redirection in documentation ([5c12adb](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/5c12adbc41f3458425e8faad3c48f6f57201be8b))
-* [#438](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/issues/438) review changes ([d60d3ab](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/d60d3ab5944a14768f064ba2d852924c071faf08))
-* [#438](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/issues/438) test coverage fixes ([49e580d](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/49e580d0650963510cfcd9d29d415814b7a90b5c))
-* **[270](https://gitlab.widas.de/cidaas-v2/PortalNDashboard-Team/issues/-/issues/270):**  add accepting parameter lat, lon in headers in required ConsentService functions ([f223ebb](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/f223ebb2f00b5350a65106c861d2daff1dda7a2a))
-* **[270](https://gitlab.widas.de/cidaas-v2/PortalNDashboard-Team/issues/-/issues/270):**  add accepting parameter lat, lon in headers in required ConsentService getConsentDetails function ([b08f870](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/b08f870032c4c24f4bfc51d6a7812964b60b42e0))
-* **[270](https://gitlab.widas.de/cidaas-v2/PortalNDashboard-Team/issues/-/issues/270):**  add accepting parameter lat, lon in headers in required LoginService functions ([f440983](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/f440983d8e19a4a74a5eff0f1bf321c1f1fe5528))
-* **[270](https://gitlab.widas.de/cidaas-v2/PortalNDashboard-Team/issues/-/issues/270):**  add accepting parameter lat, lon in headers in required TokenService functions ([89aaf5a](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/89aaf5a15609e1bda80f1965129ffc596f39a4b3))
-* **[270](https://gitlab.widas.de/cidaas-v2/PortalNDashboard-Team/issues/-/issues/270):**  add accepting parameter lat, lon in headers in required UserService functions ([fa3ad7e](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/fa3ad7e6f93b5bf3d110688c66cf02e2e72924c0))
-* **[270](https://gitlab.widas.de/cidaas-v2/PortalNDashboard-Team/issues/-/issues/270):**  add accepting parameter lat, lon in headers in required VerificationService functions ([5e5c1d0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/5e5c1d00453787c56395f35d1fd732d40b1134c5))
-* 438 [Javascript SDK] make getRequestId function flexible ([ff6f2dd](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/ff6f2ddecf7e9029df95935e3ba7d8eb4569e15b))
-* 438 review changes ([6dd54c0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/6dd54c0f258b98d32de851cb27040374fe71c429))
-* Fix vulnerabilities from npm audit ([9e89a88](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/9e89a8827fda8acf2366b1b737fa06593066bb10))
-* update changelog ([1b236b5](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/1b236b56feaf38ec1cdc1118f56deb1a5be0b3c1))
-* upgrade oidc-client-ts from 2.4.0 to 2.4.1 ([126a62f](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/126a62f354d0200dc772798922e584978291b036))
+* fix vulnerabilty from npm audit ([2f8e0c5](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/2f8e0c5498e45d865ad4bdca8005339d5857c37e))
+* semantic release format ([0d8b601](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/0d8b6014a673098a44d18297777ce1c65ba35602))
 
 # Changelog
 
+## V4.3.3
+
+## Changed
+- Update GetMFAListRequest to support more parameters
+
+## V4.3.2
+
+### Changed
+- Update getRequestId() to support overriding single option
+
 ## V4.3.1
 
 ### Changed

package/README.md

@@ -205,4 +205,3 @@ The SDK will throws Custom Exception if something went wrong during the operatio
 |----------------- | ----------------------- |
 |  500 | during creation of WebAuth instance |
 |  417 | if there are any other failure |
-

package/dist/login-service/LoginService.model.d.ts

@@ -66,12 +66,12 @@ export interface PasswordlessLoginRequest {
      * */
     verificationType: VerificationType | string;
     /**
-     * Masked sub (id of user), who will accept the consent.
+     * 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), who will accept the consent.
+     * Masked sub (id of user)
      * Either sub or q have to be provided, depends on what is given from the query parameter.
      * */
     q?: string;

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

@@ -36,6 +36,12 @@ export declare function initiateAccountVerification(options: InitiateAccountVeri
 export declare function verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
 /**
  * To get all configured multi factor authentication, call **getMFAList()**.
+ *
+ * As Parameter, you need to pass request id & one of the following: email or mobile phone or username.
+ *
+ * In case you are in prelogin page and don't have user information yet (such as mfa-required & account-verification page), you could pass
+ * request id & masked sub (one of the following: sub or q), depends on which one is available in the query parameter generated by cidaas.
+ *
  * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
  * @example
  * ```js

package/dist/verification-service/VerificationService.js

@@ -53,6 +53,12 @@ function verifyAccount(options, headers) {
 exports.verifyAccount = verifyAccount;
 /**
  * To get all configured multi factor authentication, call **getMFAList()**.
+ *
+ * As Parameter, you need to pass request id & one of the following: email or mobile phone or username.
+ *
+ * In case you are in prelogin page and don't have user information yet (such as mfa-required & account-verification page), you could pass
+ * request id & masked sub (one of the following: sub or q), depends on which one is available in the query parameter generated by cidaas.
+ *
  * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
  * @example
  * ```js

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

@@ -39,10 +39,24 @@ export interface VerifyAccountRequest {
     code: string;
 }
 export interface GetMFAListRequest {
-    /** email of user */
-    email: string;
     /** Request id returned from the authorization call */
     request_id: string;
+    /** Email of the user */
+    email?: string;
+    /** Mobile number of the user */
+    mobile_number?: string;
+    /** Username of the user */
+    username?: string;
+    /**
+     * 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 {
     /** comes from initiate MFA process */

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

@@ -114,10 +114,17 @@ export declare class WebAuth {
      * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
      * @example
      * ```js
+     * // To get requestId using default configured settings, run the function without parameter
+     * cidaas.getRequestId().then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     *
+     * // To get requestId using custom settings, run the function with custom setting(s) inside option parameter. Example below will only override client_id & redirect_uri
      * const option: GetRequestIdRequest = {
      *   'client_id': 'your client id',
      *   'redirect_uri': 'your redirect url',
-     *   'scope': 'your scopes',
      * }
      * cidaas.getRequestId(option).then(function (response) {
      *   // the response will give you request id.

package/dist/web-auth/WebAuth.js

@@ -224,10 +224,17 @@ class WebAuth {
      * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
      * @example
      * ```js
+     * // To get requestId using default configured settings, run the function without parameter
+     * cidaas.getRequestId().then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     *
+     * // To get requestId using custom settings, run the function with custom setting(s) inside option parameter. Example below will only override client_id & redirect_uri
      * const option: GetRequestIdRequest = {
      *   'client_id': 'your client id',
      *   'redirect_uri': 'your redirect url',
-     *   'scope': 'your scopes',
      * }
      * cidaas.getRequestId(option).then(function (response) {
      *   // the response will give you request id.
@@ -237,18 +244,9 @@ class WebAuth {
      * ```
      */
     getRequestId(option) {
+        var _a, _b, _c, _d, _e;
         const ui_locales = window.webAuthSettings.ui_locales;
-        const defaultPayload = Object.assign({ 'client_id': window.webAuthSettings.client_id, 'redirect_uri': window.webAuthSettings.redirect_uri, 'response_type': window.webAuthSettings.response_type, 'response_mode': window.webAuthSettings.response_mode, 'scope': window.webAuthSettings.scope }, (ui_locales && { ui_locales } || {}));
-        const payload = option ? option : defaultPayload;
-        if (!payload.response_type) {
-            payload.response_type = 'token';
-        }
-        if (!payload.response_mode) {
-            payload.response_mode = 'fragment';
-        }
-        if (!payload.nonce) {
-            payload.nonce = new Date().getTime().toString();
-        }
+        const payload = Object.assign({ 'client_id': (_a = option === null || option === void 0 ? void 0 : option.client_id) !== null && _a !== void 0 ? _a : window.webAuthSettings.client_id, 'redirect_uri': (_b = option === null || option === void 0 ? void 0 : option.redirect_uri) !== null && _b !== void 0 ? _b : window.webAuthSettings.redirect_uri, 'response_type': (_c = option === null || option === void 0 ? void 0 : option.response_type) !== null && _c !== void 0 ? _c : (window.webAuthSettings.response_type || 'token'), 'response_mode': (_d = option === null || option === void 0 ? void 0 : option.response_mode) !== null && _d !== void 0 ? _d : (window.webAuthSettings.response_mode || 'fragment'), 'scope': (_e = option === null || option === void 0 ? void 0 : option.scope) !== null && _e !== void 0 ? _e : window.webAuthSettings.scope, 'nonce': new Date().getTime().toString() }, (ui_locales && { ui_locales } || {}));
         const serviceURL = window.webAuthSettings.authority + '/authz-srv/authrequest/authz/generate';
         return Helper_1.Helper.createHttpPromise(payload, serviceURL, false, "POST");
     }

package/dist/web-auth/webauth.model.d.ts

@@ -50,11 +50,11 @@ export interface UserActionOnEnrollmentRequest {
 }
 export interface GetRequestIdRequest {
     /** Unique identifier of client app, can be found in app setting under admin ui */
-    client_id: string;
+    client_id?: string;
     /** Specify the url where the user needs to be redirected after successful login */
-    redirect_uri: string;
+    redirect_uri?: string;
     /** Permissions that are requested for this requestId */
-    scope: string;
+    scope?: string;
     /** Response type expected for the process e.g. token or code */
     response_type?: string;
     /** Response mode defines how the redirect_uri will receive the token or code e.g. as query or fragment */

package/package.json

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