cidaas-javascript-sdk 3.1.5 → 4.0.1

package/dist/authentication/index.d.ts

@@ -4,52 +4,116 @@ export declare class Authentication {
     userManager: UserManager;
     constructor(webAuthSettings: UserManagerSettings, userManager: UserManager);
     /**
-     * redirect sign in
-     * @param view_type
+     * 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 view_type: either 'login' or 'register'
      */
-    redirectSignIn(view_type: string): void;
+    loginOrRegisterWithBrowser(view_type: string): void;
     /**
-     * redirect sign in callback
-     * @returns
+     * 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
+     * });
+     * ```
      */
-    redirectSignInCallback(): Promise<unknown>;
+    loginCallback(): Promise<unknown>;
     /**
-     * redirect sign out
-     * @returns
+     * 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
+     * });
+     * ```
      */
-    redirectSignOut(): Promise<unknown>;
+    logout(): Promise<unknown>;
     /**
-     * redirect sign out callback
-     * @returns
+     * **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
+     * });
+     * ```
      */
-    redirectSignOutCallback(): Promise<unknown>;
+    logoutCallback(): Promise<unknown>;
     /**
-     * pop up sign in
+     * **popupSignIn()** will open the hosted login page in pop up window.
+     * @example
+     * ```js
+     * cidaas.popupSignIn();
+     * ```
      */
     popupSignIn(): void;
     /**
-     * pop up sign in callback
+     * 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
+     * });
+     * ```
      */
     popupSignInCallback(): void;
     /**
-     * pop up sign out
+     * **popupSignOut()** will open the hosted logout page in pop up window.
+     * @example
+     * ```js
+     * cidaas.popupSignOut()
+     * ```
      */
     popupSignOut(): void;
     /**
-     * silent sign in
+     * calling **popupSignOutCallback()** from the popup window complete popup logout process.
+     * Popup window won't be closed after doing callback
+     * @example
+     * ```js
+     * cidaas.popupSignOutCallback();
+     * ```
      */
-    silentSignIn(): void;
-    /**
-     * silent sign in callback
-     */
-    silentSignInCallback(): void;
+    popupSignOutCallback(): void;
     /**
-     * silent sign in callback v2
-     * @returns
+     * **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
+     * });
+     * ```
      */
-    silentSignInCallbackV2(): Promise<unknown>;
+    silentSignIn(): Promise<unknown>;
     /**
-     * silent sign out callback
+     * To complete the silent login process, call **silentSignInCallback()** from the iframe. This will complete the login process in iframe.
+     * @example
+     * ```js
+     * cidaas.silentSignInCallback();
+     * ```
      */
-    popupSignOutCallback(): void;
+    silentSignInCallback(callbackurl?: string): Promise<unknown>;
 }

package/dist/authentication/index.js

@@ -7,10 +7,22 @@ var Authentication = /** @class */ (function () {
         this.userManager = userManager;
     }
     /**
-     * redirect sign in
-     * @param view_type
+     * 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 view_type: either 'login' or 'register'
      */
-    Authentication.prototype.redirectSignIn = function (view_type) {
+    Authentication.prototype.loginOrRegisterWithBrowser = function (view_type) {
         try {
             if (this.userManager) {
                 if (this.webAuthSettings) {
@@ -41,10 +53,18 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * redirect sign in callback
-     * @returns
+     * 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
+     * });
+     * ```
      */
-    Authentication.prototype.redirectSignInCallback = function () {
+    Authentication.prototype.loginCallback = function () {
         var _this = this;
         return new Promise(function (resolve, reject) {
             try {
@@ -68,10 +88,17 @@ var Authentication = /** @class */ (function () {
         });
     };
     /**
-     * redirect sign out
-     * @returns
+     * 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
+     * });
+     * ```
      */
-    Authentication.prototype.redirectSignOut = function () {
+    Authentication.prototype.logout = function () {
         var _this = this;
         return new Promise(function (resolve, reject) {
             try {
@@ -80,7 +107,7 @@ var Authentication = /** @class */ (function () {
                         state: _this.webAuthSettings
                     }).then(function (resp) {
                         console.log('signed out', resp);
-                        window.authentication.redirectSignOutCallback().then(function (resp) {
+                        window.authentication.logoutCallback().then(function (resp) {
                             resolve(resp);
                         });
                     });
@@ -96,10 +123,17 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * redirect sign out callback
-     * @returns
+     * **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
+     * });
+     * ```
      */
-    Authentication.prototype.redirectSignOutCallback = function () {
+    Authentication.prototype.logoutCallback = function () {
         var _this = this;
         return new Promise(function (resolve, reject) {
             try {
@@ -121,7 +155,11 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * pop up sign in
+     * **popupSignIn()** will open the hosted login page in pop up window.
+     * @example
+     * ```js
+     * cidaas.popupSignIn();
+     * ```
      */
     Authentication.prototype.popupSignIn = function () {
         try {
@@ -140,7 +178,16 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * pop up sign in callback
+     * 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
+     * });
+     * ```
      */
     Authentication.prototype.popupSignInCallback = function () {
         try {
@@ -154,7 +201,11 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * pop up sign out
+     * **popupSignOut()** will open the hosted logout page in pop up window.
+     * @example
+     * ```js
+     * cidaas.popupSignOut()
+     * ```
      */
     Authentication.prototype.popupSignOut = function () {
         try {
@@ -175,16 +226,17 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * silent sign in
+     * calling **popupSignOutCallback()** from the popup window complete popup logout process.
+     * Popup window won't be closed after doing callback
+     * @example
+     * ```js
+     * cidaas.popupSignOutCallback();
+     * ```
      */
-    Authentication.prototype.silentSignIn = function () {
+    Authentication.prototype.popupSignOutCallback = function () {
         try {
-            if (this.userManager && this.webAuthSettings) {
-                this.userManager.signinSilent({
-                    state: this.webAuthSettings
-                }).then(function (user) {
-                    console.log("signed in : " + user.access_token);
-                });
+            if (this.userManager) {
+                this.userManager.signoutPopupCallback(this.webAuthSettings.post_logout_redirect_uri, true);
             }
             else {
                 throw "user manager is null";
@@ -196,38 +248,64 @@ var Authentication = /** @class */ (function () {
     };
     ;
     /**
-     * silent sign in callback
+     * **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
+     * });
+     * ```
      */
-    Authentication.prototype.silentSignInCallback = function () {
-        try {
-            if (this.userManager) {
-                this.userManager.signinSilentCallback();
+    Authentication.prototype.silentSignIn = function () {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            try {
+                if (_this.userManager && _this.webAuthSettings) {
+                    _this.userManager.signinSilent({
+                        state: _this.webAuthSettings,
+                        silentRequestTimeoutInSeconds: 60
+                    }).then(function (user) {
+                        if (user) {
+                            resolve(user);
+                            return;
+                        }
+                        resolve(undefined);
+                    });
+                }
+                else {
+                    throw "user manager or web auth settings is null";
+                }
             }
-            else {
-                throw "user manager is null";
+            catch (ex) {
+                reject(ex);
             }
-        }
-        catch (ex) {
-            console.error(ex);
-        }
+        });
     };
     ;
     /**
-     * silent sign in callback v2
-     * @returns
+     * To complete the silent login process, call **silentSignInCallback()** from the iframe. This will complete the login process in iframe.
+     * @example
+     * ```js
+     * cidaas.silentSignInCallback();
+     * ```
      */
-    Authentication.prototype.silentSignInCallbackV2 = function () {
+    Authentication.prototype.silentSignInCallback = function (callbackurl) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             try {
                 if (_this.userManager) {
-                    _this.userManager.signinSilentCallback(_this.webAuthSettings.silent_redirect_uri)
+                    _this.userManager.signinSilentCallback(callbackurl)
                         .then(function (user) {
                         if (user) {
                             resolve(user);
                             return;
                         }
                         resolve(undefined);
+                    })["catch"](function (e) {
+                        reject(e);
                     });
                 }
                 else {
@@ -240,23 +318,6 @@ var Authentication = /** @class */ (function () {
         });
     };
     ;
-    /**
-     * silent sign out callback
-     */
-    Authentication.prototype.popupSignOutCallback = function () {
-        try {
-            if (this.userManager) {
-                this.userManager.signoutPopupCallback(this.webAuthSettings.post_logout_redirect_uri, true);
-            }
-            else {
-                throw "user manager is null";
-            }
-        }
-        catch (ex) {
-            console.error(ex);
-        }
-    };
-    ;
     return Authentication;
 }());
 exports.Authentication = Authentication;

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-import { Authentication } from "./authentication";
 import { WebAuth } from "./web-auth/WebAuth";
-export { WebAuth, Authentication };
+export { WebAuth };

package/dist/index.js

@@ -1,7 +1,5 @@
 "use strict";
 exports.__esModule = true;
-exports.Authentication = exports.WebAuth = void 0;
-var authentication_1 = require("./authentication");
-exports.Authentication = authentication_1.Authentication;
+exports.WebAuth = void 0;
 var WebAuth_1 = require("./web-auth/WebAuth");
 exports.WebAuth = WebAuth_1.WebAuth;

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

@@ -1,35 +1,80 @@
 import { IConsentAcceptEntity } from "./Entities";
+/**
+ * Consent Management
+ * For the first time login, the user needs to accept the terms and conditions.
+ */
 export declare namespace ConsentService {
     /**
-    * get user consent details
-    * @param options
-    * @returns
-    */
-    function getConsentDetailsV2(options: {
+     * To get consent details , call **getConsentDetails()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/858fbeb51c62b-find-consent-info for more details.
+     * @example
+     * ```js
+     * this.cidaas.getConsentDetails({
+     *   consent_id: 'consent id',
+     *   consent_version_id: 'consent version id',
+     *   sub: 'masked sub'
+     * })
+     * .then(function (response) {
+     *  // type your code here
+     * })
+     * .catch(function (ex) {
+     *  // your failure code here
+     * });
+     * ```
+     */
+    function getConsentDetails(options: {
         consent_id: string;
         consent_version_id: string;
         sub: string;
     }): Promise<unknown>;
     /**
-     * accept constn v2
-     * @param options
-     * @returns
+     * To accept consent, call **acceptConsent()**.
+     * @example
+     * ```js
+     * this.cidaas.acceptConsent({
+     *   client_id: 'your client id',
+     *   consent_id: 'consent id',
+     *   consent_version: 'consent version id',
+     *   sub: 'masked sub'
+     * }).then((response) => {
+     *   // the response will give you details of accepted consent.
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
      */
-    function acceptConsentV2(options: IConsentAcceptEntity): Promise<unknown>;
+    function acceptConsent(options: IConsentAcceptEntity): Promise<unknown>;
     /**
-     * get scope consent version details
-     * @param options
-     * @returns
+     * To get version details of consent, call **getConsentVersionDetails()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/7e24ac2113315-get-consent-version-details for more details.
+     * @example
+     * ```js
+     * this.cidaas.getConsentVersionDetails({
+     *   consentid: 'your consent id',
+     *   locale: 'browser accept language or custom language',
+     *   access_token: 'your access token',
+     * }).then((response) => {
+     *   // type your code here
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
      */
-    function getScopeConsentVersionDetailsV2(options: {
-        scopeid: string;
+    function getConsentVersionDetails(options: {
+        consentid: string;
         locale: string;
         access_token: string;
     }): Promise<unknown>;
     /**
-     * accept scope Consent
-     * @param options
-     * @returns
+     * To accept scope consent, call **acceptScopeConsent()**.
+     * @example
+     * ```js
+     * this.cidaas.acceptScopeConsent({
+     *   client_id: 'your client id',
+     *   sub: 'masked sub',
+     *   scopes: [your scope consents]
+     *  });
+     * ```
      */
     function acceptScopeConsent(options: {
         client_id: string;
@@ -37,9 +82,15 @@ export declare namespace ConsentService {
         scopes: string[];
     }): Promise<unknown>;
     /**
-     * accept claim Consent
-     * @param options
-     * @returns
+     * To accept claim consent, call **acceptClaimConsent()**.
+     * @example
+     * ```js
+     * this.cidaas.acceptClaimConsent({
+     *   client_id: 'your client id',
+     *   sub: 'masked sub',
+     *   accepted_claims: [your claim consents]
+     *  });
+     * ```
      */
     function acceptClaimConsent(options: {
         client_id: string;
@@ -47,11 +98,24 @@ export declare namespace ConsentService {
         accepted_claims: string[];
     }): Promise<unknown>;
     /**
-     * revoke claim Consent
-     * @param options
-     * @returns
+     * To revoke claim consent, call **revokeClaimConsent()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9ae62e98842fe-revoke-user-consent-claim for more details.
+     * @example
+     * ```js
+     * this.cidaas.revokeClaimConsent({
+     *    access_token: 'your access token',
+     *    client_id: 'your client id',
+     *    sub: 'masked sub'
+     *    revoked_claims: [your claim consents]
+     *  }).then((response) => {
+     *    // the response will give you revoked claim consent.
+     *  }).catch((err) => {
+     *    // your failure code here
+     *  });
+     * ```
      */
     function revokeClaimConsent(options: {
+        access_token?: string;
         client_id: string;
         sub: string;
         revoked_claims: string[];