cidaas-javascript-sdk 3.0.5 → 3.1.0

package/CHANGELOG.md

@@ -1,6 +1,39 @@
-## [3.0.5](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v3.0.4...v3.0.5) (2023-08-04)
+# [3.1.0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v3.0.5...v3.1.0) (2023-08-07)
 
 
 ### Bug Fixes
 
-* store code verifier in pkce flow ([f6f7835](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/f6f783507e6b3d7bc3bf24140e546951d71dd4b5))
+* Code Quality - refactoring 1 ([552094c](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/552094ca64f88bf5e889c6604ec08325cbb00db0))
+* Code Quality - refactoring 1 ([40e0562](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/40e05628c6e7dd2611951f6aaddb88a656c23881))
+* Code Quality - refactoring 2 ([612f175](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/612f17505226f2c8f7b5f5d3b383d6e8905604b6))
+* Code Quality - refactoring 2 ([36db430](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/36db4300914f81e43ba163fc4f96eb49c4b00506))
+* fix package-lock ([3b1adda](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/3b1adda8f315ff21d06d84f828a6366362bb996f))
+* fix package-lock ([aa5c7fc](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/aa5c7fc6aac32c03c6ee8b535170f58066a31ee5))
+* fix pipeline ([d405f47](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/d405f477c73ed672ed62ddba8a09d1d0b915b9e6))
+* fix pipeline ([0967682](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/0967682c1beeba5dc307e9a9b1e3c52362fe490f))
+* gitignore cache cleanup ([3bb6ed6](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/3bb6ed6b4f8fdd1f414229d0e5c65706d14a2a51))
+* gitignore cache cleanup ([1a092f2](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/1a092f2c101189e47a1c5dd2a361229e3882416e))
+* Refactored Helper method to increase reusability ([895f058](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/895f0582a23717bd167c73175c0592a24bb02007))
+* Refactored Helper method to increase reusability ([4d4e8ac](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/4d4e8ac2b0c62b044fe74b4b10957357f4b87133))
+* removed commented code ([6ef3960](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/6ef3960292bb9f20171313ef361ad241a694197e))
+* removed commented code ([7c3c304](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/7c3c3042cf1c77c7a81c144a96cc7b19d03aca9f))
+* removed ds_store ([9773735](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/977373563416f7eaa79918a5018913b3f9c2e313))
+* removed ds_store ([a9e6561](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/a9e6561845a58d6462eabd9af05190c02e26aa62))
+* removed fingerprint for deviceInfo call ([1db4d63](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/1db4d639df2828d528a295b0499e71dd64d2a511))
+* removed fingerprint for deviceInfo call ([1834f27](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/1834f27b88ef42382c2d30d39d0678faebfdf46f))
+* resolve gitignore conflicts ([eb5847b](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/eb5847b9c52c5fcf195c313a0c5aa21565503fae))
+* Semantic Format ([5cec717](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/5cec7175c1bc5c3b8ede6a252b1602c1c84f9f8d))
+* Semantic Format ([676680d](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/676680d14671c0f470f82300f4fc6519e9590d9e))
+* store code verifier in pkce flow ([b24dd99](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/b24dd9979ba04ab75db065e863809e186ad866c2))
+* store code verifier in pkce flow ([3821989](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/3821989e6c41f3ae4d8413e37ff3ccf9560076a7))
+* sync from development ([46b8d1a](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/46b8d1a17c84dabf4e379a5800bc0cb65ad47ffb))
+
+
+### Features
+
+* Added Tests for Coverage ([c894c7a](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/c894c7ae9727d4d6d90bdd154675005e9c1185b3))
+* Added Tests for Coverage ([c2d8fbe](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/c2d8fbea7c6a445ac71fca49eaee73034711eac0))
+* Added Tests for Coverage ([3a127f5](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/3a127f5c175832cdaa8130fde67e87a08df24630))
+* Added Tests for Coverage ([c88ce6b](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/c88ce6b26624960c516a8c5c848cdced3efeb4ed))
+* ignored config files ([7e3cbac](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/7e3cbacaac15404058a70c181c2020583a3e760e))
+* ignored config files ([857fef1](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/857fef12ccc099ce9364ed09126df3b6923906b3))

package/README.md

@@ -2582,4 +2582,4 @@ The SDK will throws Custom Exception if something went wrong during the operatio
 | HTTP Status Code | When could it be thrown |
 |----------------- | ----------------------- |
 |  500 | during creation of WebAuth instance |
-|  417 | if there are any other failure |
+|  417 | if there are any other failure |

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "cidaas-javascript-sdk",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "author": "cidaas by Widas ID GmbH",
   "description": "Cidaas native javascript sdk",
   "license": "MIT",
   "main": "types/main/index.js",
   "types": "types/main/index.d.ts",
+  "testEnvironment": "jsdom",
   "engine": {
     "node": ">=8.9.10"
   },
   "scripts": {
     "dev": "tsc && webpack --config webpack.dev.js",
     "build": "tsc && webpack --config webpack.prod.js",
-    "test": "echo 'test'",
-    "test:coverage": "echo 'test coverage'"
+    "test": "jest --transformIgnorePatterns \"node_modules/(?!@toolz/allow)/\" --env=jsdom",
+    "test:coverage": "jest --coverage --env=jsdom"
   },
   "files": [
     "src",
@@ -27,23 +28,33 @@
   },
   "dependencies": {
     "@fingerprintjs/fingerprintjs": "^3.4.0",
+    "@toolz/is-a-regular-object": "^1.0.1",
     "@types/crypto-js": "^4.1.1",
+    "@types/jest": "^29.5.3",
     "crypto-js": "^4.1.1",
     "oidc-client-ts": "^2.2.1"
   },
   "devDependencies": {
+    "@babel/core": "^7.22.9",
+    "@babel/preset-env": "^7.22.9",
+    "@babel/preset-typescript": "^7.22.5",
+    "babel-jest": "^29.6.1",
+    "@jest/globals": "^29.6.1",
+    "@types/mocha": "5.2.7",
+    "jest": "^29.6.1",
+    "jest-environment-jsdom": "^29.6.1",
+    "jsdom": "^22.1.0",
+    "jsdom-global": "^3.0.2",
+    "mocha": "^10.1.0",
     "terser-webpack-plugin": "^5.2.4",
+    "ts-jest": "^29.1.1",
     "ts-loader": "^9.4.2",
+    "ts-node": "10.9.1",
     "typescript": "^4.5.4",
     "webpack": "^5.59.1",
     "webpack-cli": "^4.9.1",
     "webpack-dev-server": "^4.3.1",
     "webpack-hot-middleware": "^2.25.1",
     "webpack-merge": "^5.8.0"
-  },
-  "jest": {
-    "collectCoverageFrom": [
-      "src/main/**/*.{js,jsx,mjs}"
-    ]
   }
 }

package/src/main/web-auth/ConsentService.ts

@@ -13,7 +13,7 @@ export namespace ConsentService {
     sub: string;
   }) {
     var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/usage/public/info";
-    return Helper.createPostPromise(options, _serviceURL, false);
+    return Helper.createPostPromise(options, _serviceURL, false,"POST");
   };
 
   /**
@@ -23,7 +23,7 @@ export namespace ConsentService {
    */
   export function acceptConsentV2(options: IConsentAcceptEntity) {
     var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/usage/accept";
-    return Helper.createPostPromise(options, _serviceURL, false);
+    return Helper.createPostPromise(options, _serviceURL, false, "POST" );
   };
 
   /**
@@ -36,30 +36,8 @@ export namespace ConsentService {
     locale: string;
     access_token: string;
   }) {
-    return new Promise((resolve, reject) => {
-      try {
-        var http = new XMLHttpRequest();
-        var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/versions/details/" + options.scopeid + "?locale=" + options.locale;
-        http.onreadystatechange = function () {
-          if (http.readyState == 4) {
-            if (http.responseText) {
-              resolve(JSON.parse(http.responseText));
-            } else {
-              resolve(false);
-            }
-          }
-        };
-        http.open("GET", _serviceURL, true);
-        http.setRequestHeader("Content-type", "application/json");
-        http.setRequestHeader("Authorization", `Bearer ${options.access_token}`);
-        if (window.localeSettings) {
-          http.setRequestHeader("accept-language", window.localeSettings);
-        }
-        http.send();
-      } catch (ex) {
-        reject(ex);
-      }
-    });
+    const _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/versions/details/" + options.scopeid + "?locale=" + options.locale;
+    return Helper.createPostPromise(undefined, _serviceURL,false, "GET", options.access_token);
   };
 
   /**
@@ -73,7 +51,7 @@ export namespace ConsentService {
     scopes: string[];
   }) {
     var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/scope/accept";
-    return Helper.createPostPromise(options, _serviceURL, false);
+    return Helper.createPostPromise(options, _serviceURL, false, "POST");
   };
 
   /**
@@ -83,7 +61,7 @@ export namespace ConsentService {
    */
   export function acceptClaimConsent(options: { client_id: string; sub: string; accepted_claims: string[]; }) {
     var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/claim/accept";
-    return Helper.createPostPromise(options, _serviceURL, false);
+    return Helper.createPostPromise(options, _serviceURL, false,  "POST");
   };
 
   /**
@@ -93,6 +71,6 @@ export namespace ConsentService {
    */
   export function revokeClaimConsent(options: { client_id: string; sub: string; revoked_claims: string[]; }) {
     var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/claim/revoke";
-    return Helper.createPostPromise(options, _serviceURL, false);
+    return Helper.createPostPromise(options, _serviceURL, false,  "POST");
   };
 }

package/src/main/web-auth/Entities.ts

@@ -319,49 +319,6 @@ export interface IUserEntity {
 }
 
 
-export interface IUserEntity {
-  userStatus: string;
-  user_status: string;
-  user_status_reason: string;
-  username: string;
-  sub: string;
-  given_name: string;
-  family_name: string;
-  middle_name: string;
-  nickname: string;
-  originalProviderUserId?: string[];
-  email: string;
-  email_verified: boolean;
-  mobile_number: string;
-  mobile_number_obj: IMobileEntity | null;
-  mobile_number_verified: boolean;
-  phone_number: string;
-  phone_number_obj: IMobileEntity | null;
-  phone_number_verified: boolean;
-  profile: string;
-  picture: string;
-  website: string;
-  gender: string;
-  zoneinfo: string;
-  locale: string;
-  birthdate: Date | null;
-  address?: IAddressEntity;
-  customFields?: any;
-  identityCustomFields?: any;
-  password: string;
-  provider: string;
-  providerUserId: string;
-  identityId: string;
-  mfa_enabled?: boolean;
-  roles: string[];
-  userGroups: IUserGroupMap[];
-  groups?: IUserGroupMap[];
-  rawJSON: string;
-  trackId: string;
-  need_reset_password: boolean;
-}
-
-
 export interface IUserGroupMap {
   sub: string;
   groupId: string;

package/src/main/web-auth/Helper.ts

@@ -26,11 +26,11 @@ export class Helper {
   * @param options 
   * @param serviceurl 
   * @param errorResolver 
-  * @param access_token 
-  * @param headers 
+  * @param access_token??
+  * @param headers??
   * @returns 
   */
-  static createPostPromise(options: any, serviceurl: string, errorResolver: boolean, access_token?: string, headers?: any) {
+  static createPostPromise(options: any, serviceurl: string, errorResolver: boolean, method:string, access_token?: string, headers?: any) {
     return new Promise((resolve, reject) => {
       try {
         var http = new XMLHttpRequest();
@@ -43,7 +43,7 @@ export class Helper {
             }
           }
         };
-        http.open("POST", serviceurl, true);
+        http.open(method, serviceurl, true);
         http.setRequestHeader("Content-type", "application/json");
         if (headers) {
           for (var key in headers) {

package/src/main/web-auth/TokenService.ts

@@ -9,30 +9,13 @@ export namespace TokenService {
    * @returns 
    */
   export function renewToken(options: AccessTokenRequest) {
-    return new Promise((resolve, reject) => {
-      try {
-        if (!options.refresh_token) {
-          throw new CustomException("refresh_token cannot be empty", 417);
-        }
-        options.client_id = window.webAuthSettings.client_id;
-        options.grant_type = 'refresh_token';
-        var http = new XMLHttpRequest();
-        var _serviceURL = window.webAuthSettings.authority + "/token-srv/token";
-        http.onreadystatechange = function () {
-          if (http.readyState == 4) {
-            resolve(JSON.parse(http.responseText));
-          }
-        };
-        http.open("POST", _serviceURL, true);
-        http.setRequestHeader("Content-type", "application/json");
-        if (window.localeSettings) {
-          http.setRequestHeader("accept-language", window.localeSettings);
-        }
-        http.send(JSON.stringify(options));
-      } catch (ex) {
-        reject(ex);
-      }
-    });
+    if (!options.refresh_token) {
+      throw new CustomException("refresh_token cannot be empty", 417);
+    }
+    options.client_id = window.webAuthSettings.client_id;
+    options.grant_type = 'refresh_token';
+    const _serviceURL = window.webAuthSettings.authority + "/token-srv/token";
+    return Helper.createPostPromise(options, _serviceURL, undefined, "POST");
   };
 
   /**
@@ -41,38 +24,19 @@ export namespace TokenService {
    * @returns 
    */
   export function getAccessToken(options: AccessTokenRequest) {
-    return new Promise((resolve, reject) => {
-      try {
-        if (!options.code) {
-          throw new CustomException("code cannot be empty", 417);
-        }
-        options.client_id = window.webAuthSettings.client_id;
-        options.redirect_uri = window.webAuthSettings.redirect_uri;
-        options.grant_type = "authorization_code";
-        var http = new XMLHttpRequest();
-        var _serviceURL = window.webAuthSettings.authority + "/token-srv/token";
-        http.onreadystatechange = function () {
-          if (http.readyState == 4) {
-            resolve(JSON.parse(http.responseText));
-          }
-        };
-        http.open("POST", _serviceURL, true);
-        http.setRequestHeader("Content-type", "application/json");
-        if (window.localeSettings) {
-          http.setRequestHeader("accept-language", window.localeSettings);
-        }
-        if (!window.webAuthSettings.disablePKCE) {
-          window.usermanager._client.createSigninRequest(window.webAuthSettings).then((signInRequest: any) => {
-            options.code_verifier = signInRequest.state?.code_verifier;
-            http.send(JSON.stringify(options));
-          }) 
-        } else {
-          http.send(JSON.stringify(options));
-        }
-      } catch (ex) {
-        reject(ex);
-      }
-    });
+    if (!options.code) {
+      throw new CustomException("code cannot be empty", 417);
+    }
+    options.client_id = window.webAuthSettings.client_id;
+    options.redirect_uri = window.webAuthSettings.redirect_uri;
+    options.grant_type = "authorization_code";
+    if (!window.webAuthSettings.disablePKCE) {
+      window.usermanager._client.createSigninRequest(window.webAuthSettings).then((signInRequest: any) => {
+        options.code_verifier = signInRequest.state?.code_verifier;
+      })
+    }
+    const _serviceURL = window.webAuthSettings.authority + "/token-srv/token";
+    return Helper.createPostPromise(options, _serviceURL, undefined, "POST");
   };
 
   /**
@@ -81,28 +45,11 @@ export namespace TokenService {
    * @returns 
    */
   export function validateAccessToken(options: TokenIntrospectionEntity) {
-    return new Promise((resolve, reject) => {
-      try {
-        if (!options.token || !options.token_type_hint) {
-          throw new CustomException("token or token_type_hint cannot be empty", 417);
-        }
-        var http = new XMLHttpRequest();
-        var _serviceURL = window.webAuthSettings.authority + "/token-srv/introspect";
-        http.onreadystatechange = function () {
-          if (http.readyState == 4) {
-            resolve(JSON.parse(http.responseText));
-          }
-        };
-        http.open("POST", _serviceURL, true);
-        http.setRequestHeader("Content-type", "application/json");
-        if (window.localeSettings) {
-          http.setRequestHeader("accept-language", window.localeSettings);
-        }
-        http.send(JSON.stringify(options));
-      } catch (ex) {
-        reject(ex);
-      }
-    });
+    if (!options.token || !options.token_type_hint) {
+      throw new CustomException("token or token_type_hint cannot be empty", 417);
+    }
+    const _serviceURL = window.webAuthSettings.authority + "/token-srv/introspect";
+    return Helper.createPostPromise(options, _serviceURL, false, "POST");
   };
 
   /**
@@ -114,29 +61,8 @@ export namespace TokenService {
     track_id: string;
     locale: string;
   }) {
-    return new Promise((resolve, reject) => {
-      try {
-        var http = new XMLHttpRequest();
-        var _serviceURL = window.webAuthSettings.authority + "/token-srv/prelogin/metadata/" + options.track_id + "?acceptLanguage=" + options.locale;
-        http.onreadystatechange = function () {
-          if (http.readyState == 4) {
-            if (http.responseText) {
-              resolve(JSON.parse(http.responseText));
-            } else {
-              resolve(false);
-            }
-          }
-        };
-        http.open("GET", _serviceURL, true);
-        http.setRequestHeader("Content-type", "application/json");
-        if (window.localeSettings) {
-          http.setRequestHeader("accept-language", window.localeSettings);
-        }
-        http.send();
-      } catch (ex) {
-        reject(ex);
-      }
-    });
+    const _serviceURL = window.webAuthSettings.authority + "/token-srv/prelogin/metadata/" + options.track_id + "?acceptLanguage=" + options.locale;
+    return Helper.createPostPromise(undefined, _serviceURL, false, "GET");
   };
 
   /**
@@ -146,8 +72,8 @@ export namespace TokenService {
    * @returns 
    */
   export function updateSuggestMFA(track_id: string, options: ISuggestedMFAActionConfig) {
-    var _serviceURL = window.webAuthSettings.authority + "/token-srv/prelogin/suggested/mfa/update/" + track_id;
-    return Helper.createPostPromise(options, _serviceURL, false);
+    const _serviceURL = window.webAuthSettings.authority + "/token-srv/prelogin/suggested/mfa/update/" + track_id;
+    return Helper.createPostPromise(options, _serviceURL, false, "POST");
   };
 
   /**
@@ -156,29 +82,8 @@ export namespace TokenService {
    * @returns 
    */
   export function getMissingFieldsLogin(trackId: string) {
-    return new Promise((resolve, reject) => {
-      try {
-        var http = new XMLHttpRequest();
-        var _serviceURL = window.webAuthSettings.authority + "/token-srv/prelogin/metadata/" + trackId;
-        http.onreadystatechange = function () {
-          if (http.readyState == 4) {
-            if (http.responseText) {
-              resolve(JSON.parse(http.responseText));
-            } else {
-              resolve(undefined);
-            }
-          }
-        };
-        http.open("GET", _serviceURL, true);
-        http.setRequestHeader("Content-type", "application/json");
-        if (window.localeSettings) {
-          http.setRequestHeader("accept-language", window.localeSettings);
-        }
-        http.send();
-      } catch (ex) {
-        reject(ex);
-      }
-    });
+    const _serviceURL = window.webAuthSettings.authority + "/token-srv/prelogin/metadata/" + trackId;
+    return Helper.createPostPromise(undefined, _serviceURL, false, "GET");
   };
 
   /**