cidaas-javascript-sdk 5.0.0 → 5.1.0

package/CHANGELOG.md

@@ -1,27 +1,16 @@
-# [5.0.0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.3.3...v5.0.0) (2024-12-19)
+# [5.1.0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v5.0.0...v5.1.0) (2025-11-14)
 
 
-* feat()!: upgrade to v5 ([e5ac651](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/e5ac65125adbacf1e38dd21af5aad7d000eeb5e3))
+### Bug Fixes
 
+* update doc ([9e8f48f](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/9e8f48fbe0a296435e7330a6c0cc22a12d506e06))
 
-### BREAKING CHANGES
 
-* ### Changed
-- **Breaking** Rework library to calls functions from various modules
-- **Breaking** Rework renewToken() to store the newly generated token in user storage
-- **Breaking** Move setAcceptLanguageHeader function to Helper class
-- **Breaking** Rename getUserInfo() to getUserInfoFromStorage()
-- **Breaking** Rename getAccessToken() to generateTokenFromCode()
-- **Breaking** Standardize enums
-- **Breaking** Use enum instead of string for some function parameter
+### Features
 
-### Removed
-- **Breaking** Removed silentSignin() & silentSignInCallback() function
-- **Breaking** Removed popupSignInCallback() & popupSignOutCallback()function
-- **Breaking** Removed logoutUser() function
-- **Breaking** Removed validateAccessToken() function
-- **Breaking** Removed createPreloginWebauth function
-- **Breaking** Removed unused & deprecated function parameters
+* **login-service:** improve social login with flexible query parameters ([9492a9e](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/9492a9e52faa6f230662c949039119d84e88df8f))
+* **login-service:** improve social login with flexible query parameters ([21bb073](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/21bb07346878cf2550eeaf258523f1f568270d9c))
+* **login-service:** improve social login with flexible query parameters ([ed7bc6a](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/ed7bc6a46a06ab6bef5d4553e0e78802f2c950e0))
 
 # Changelog
 

package/README.md

@@ -13,13 +13,14 @@
 
 # Cidaas Javascript SDK
 
-This cidaas Javascript SDK library is built on the top of [OIDC client typescript library](https://github.com/authts/oidc-client-ts). 
+This cidaas javascript SDK library is built on the top of [OIDC client typescript library](https://github.com/authts/oidc-client-ts). 
 
-Please check the [Changelog](https://github.com/Cidaas/cidaas-sdk-javascript-v2/blob/master/CHANGELOG.md) for more information about the latest release.
+Please check the [Changelog](https://github.com/Cidaas/cidaas-javascript-sdk/blob/master/CHANGELOG.md) for more information about the latest release.
 
 ## Table of Contents
 
 <!--ts-->
+* [Overview](https://github.com/Cidaas/cidaas-javascript-sdk/blob/master/overview/overview.md)
 * [Documentation](https://cidaas.github.io/cidaas-javascript-sdk)
 * [Installation](#installation)
 * [Initialisation](#initialisation)
@@ -27,6 +28,14 @@ Please check the [Changelog](https://github.com/Cidaas/cidaas-sdk-javascript-v2/
 * [Functions Overview](#functions-overview)
 * [Possible Error](#possible-error)
 
+### Overview
+
+[Here](https://github.com/Cidaas/cidaas-javascript-sdk/blob/master/overview/overview.md) you can find general overview of cidaas javascript SDK
+
+### Documentation
+
+[Here](https://cidaas.github.io/cidaas-javascript-sdk) you can find technical documentation of cidaas javascript SDK
+
 ### Installation
 
 From CDN
@@ -44,9 +53,9 @@ npm install cidaas-javascript-sdk
 
 ### Initialisation
 
-After adding the sdk library, create a local file such as **cidaas.service.ts** and define Cidaas options variable there for initializing cidaas sdk.
+After adding the sdk library, create a local file such as **cidaas.service.ts** and define Oidc settings variable there for initializing cidaas sdk.
 
-Cidaas options variable support every [OIDC Client UserManagerSettings Properties](https://authts.github.io/oidc-client-ts/interfaces/UserManagerSettings.html) which has the following notable properties:
+Oidc settings variable support every [OIDC Client UserManagerSettings Properties](https://authts.github.io/oidc-client-ts/interfaces/UserManagerSettings.html) which has the following notable properties:
 
 | Property Name | Required | Description |
 | ------ | ------ | ------ |
@@ -58,7 +67,7 @@ Cidaas options variable support every [OIDC Client UserManagerSettings Propertie
 | userStore | no | define where authenticated user information will be saved on the client application. The default value is session storage if no properties is being sent. |
 | automaticSilentRenew | no | configure whether automatic token renewal will be activated. The default value is true. |
 
-an example of Cidaas options variable looks like this:
+an example of Oidc settings variable looks like this:
 
 ```js
 const options = {
@@ -79,9 +88,9 @@ The following storages are supported to store authenticated user information, su
 
 additionally, user can also define custom storage in the client side by implementing Storage class.
 
-If there is no userStore properties being send in Cidaas options variable, it will use session storage by default.
+If there is no userStore properties being send in Oidc settings variable, it will use session storage by default.
 
-In case local storage is prefered to be used, then Cidaas options can be modified as following:
+In case local storage is prefered to be used, then Oidc settings can be modified as following:
 
 ```js
 const options = {
@@ -105,7 +114,7 @@ see [usage](#get-tokens-and-user-profile-information-from-user-storage) to get t
 
 ### Configure automatic token renewal (Optional)
 
-By default, The SDK will generate new tokens based on refresh token stored in user storage, one minute before the access token is expiring. To disable this behaviour, Cidaas options can be modified as following:
+By default, The SDK will generate new tokens based on refresh token stored in user storage, one minute before the access token is expiring. To disable this behaviour, Oidc settings can be modified as following:
 
 ```js
 const options = {
@@ -117,7 +126,7 @@ const options = {
 
 ### Initialise the cidaas sdk using the configured options mentioned above:
 
-Cidaas ConfigUserProvider have to be initialise to be added to each of the modules as dependencies:
+Cidaas ConfigUserProvider have to be initialised to be added to each of the modules as dependencies:
 
 Example of Cidaas Service:
 ```js
@@ -137,7 +146,7 @@ export class CidaasService {
     }
 
     // get authentication module
-    getAuthentication() {
+    getAuthenticationService() {
         return this.authenticationService;
     }
 
@@ -169,8 +178,6 @@ this.cidaasVerificationService.getMFAList(getMFAListOptions);
 
 ```
 
-Each of the functions and its module can be looked in the doc.
-
 ### Usage
 
 #### Login With Browser
@@ -181,7 +188,46 @@ To login through cidaas sdk, call **loginWithBrowser()**. This will redirect you
 cidaasAuthenticationService.loginWithBrowser();
 ```
 
-once login is successful, it will automatically redirects you to redirect_uri you have configured in cidaas options. You will get information such as code & state as redirect url parameter (query or fragment), which is needed to get access token.
+once login is successful, it will automatically redirects you to redirect_uri you have configured in Oidc settings. You will get information such as code & state as redirect url parameter (query or fragment), which is needed to get access token.
+
+To complete the login process, call **logincallback()**.
+
+```js
+cidaasAuthenticationService.loginCallback().then(function(response) {
+    // the response will give you login details.
+}).catch(function(ex) {
+    // your failure code here
+});
+```
+
+After successful loginCallback, You will get access token, along with id token and refresh token in the json response, depends on your application configuration.
+
+#### Login With Social Provider
+
+To login with social providers (e.g., Facebook, Google, LinkedIn), initialize the LoginService module and call **loginWithSocial()**. This will redirect you to the social provider's login page.
+
+```js
+cidaasLoginService.loginWithSocial({
+    provider: 'facebook',
+    requestId: 'your requestId'
+});
+```
+
+You can also pass optional query parameters:
+
+```js
+cidaasLoginService.loginWithSocial({
+    provider: 'facebook',
+    requestId: 'your requestId'
+}, {
+    dc: 'device-capacity',
+    device_fp: 'device-fingerprint',
+    // Any additional custom query parameters
+    customParam: 'customValue'
+});
+```
+
+once login is successful, it will automatically redirects you to redirect_uri you have configured in Oidc settings. You will get information such as code & state as redirect url parameter (query or fragment), which is needed to get access token.
 
 To complete the login process, call **logincallback()**.
 
@@ -211,7 +257,7 @@ cidaasAuthenticationService.getUserInfoFromStorage().then(function(response) {
 
 ### Functions Overview
 
-Cidaas Javascript SDK Functions can be found on the [documentation](https://cidaas.github.io/cidaas-javascript-sdk).
+Cidaas javascript SDK functions can be found on the [documentation](https://cidaas.github.io/cidaas-javascript-sdk).
 
 ## Possible Error
 

package/dist/login-service/LoginService.js

@@ -42,15 +42,31 @@ class LoginService {
      * ```
      */
     loginWithSocial(options, queryParams) {
+        if (!options.provider || !options.requestId) {
+            throw new Helper_1.CustomException("provider and requestId cannot be empty", 417);
+        }
         try {
             let _serviceURL = this.config.authority + "/login-srv/social/login/" + options.provider.toLowerCase() + "/" + options.requestId;
-            if (queryParams && queryParams.dc && queryParams.device_fp) {
-                _serviceURL = _serviceURL + "?dc=" + queryParams.dc + "&device_fp=" + queryParams.device_fp;
+            if (queryParams) {
+                const params = new URLSearchParams();
+                Object.keys(queryParams).forEach(key => {
+                    const value = queryParams[key];
+                    if (value !== undefined && value !== null && value !== '') {
+                        params.append(key, value);
+                    }
+                });
+                const queryString = params.toString();
+                if (queryString) {
+                    _serviceURL = _serviceURL + "?" + queryString;
+                }
             }
             window.location.href = _serviceURL;
         }
         catch (ex) {
-            console.log(ex);
+            if (ex instanceof Helper_1.CustomException) {
+                throw ex;
+            }
+            throw new Helper_1.CustomException(String(ex), 417);
         }
     }
     /**
@@ -69,15 +85,31 @@ class LoginService {
      * ```
      */
     registerWithSocial(options, queryParams) {
+        if (!options.provider || !options.requestId) {
+            throw new Helper_1.CustomException("provider and requestId cannot be empty", 417);
+        }
         try {
             let _serviceURL = this.config.authority + "/login-srv/social/register/" + options.provider.toLowerCase() + "/" + options.requestId;
-            if (queryParams && queryParams.dc && queryParams.device_fp) {
-                _serviceURL = _serviceURL + "?dc=" + queryParams.dc + "&device_fp=" + queryParams.device_fp;
+            if (queryParams) {
+                const params = new URLSearchParams();
+                Object.keys(queryParams).forEach(key => {
+                    const value = queryParams[key];
+                    if (value !== undefined && value !== null && value !== '') {
+                        params.append(key, value);
+                    }
+                });
+                const queryString = params.toString();
+                if (queryString) {
+                    _serviceURL = _serviceURL + "?" + queryString;
+                }
             }
             window.location.href = _serviceURL;
         }
         catch (ex) {
-            console.log(ex);
+            if (ex instanceof Helper_1.CustomException) {
+                throw ex;
+            }
+            throw new Helper_1.CustomException(String(ex), 417);
         }
     }
     /**

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

@@ -45,6 +45,8 @@ export interface SocialProviderQueryParameter {
     dc?: string;
     /** Device finger print */
     device_fp?: string;
+    /** Additional custom query parameters */
+    [key: string]: string | undefined;
 }
 export interface PasswordlessLoginRequest {
     /** Request id returned from the authorization call */

package/package.json

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