cidaas-javascript-sdk 3.1.4 → 4.0.0

package/dist/web-auth/LoginService.js

@@ -5,9 +5,18 @@ var Helper_1 = require("./Helper");
 var LoginService;
 (function (LoginService) {
     /**
-   * login with username and password
-   * @param options
-   */
+     * To login with your credentials, call **loginWithCredentials()**. After successful login, this will redirect you to the redirect_url that you mentioned earlier while initialising the sdk.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/5gphdk6vapp56-classic-login#call-login-api for more details.
+     * @example
+     * ```js
+     * cidaas.loginWithCredentials({
+     *   username: 'xxxx@gmail.com',
+     *   username_type: 'email',
+     *   password: '123456',
+     *   requestId: 'your requestId',
+     * });
+     * ```
+     */
     function loginWithCredentials(options) {
         try {
             var url = window.webAuthSettings.authority + "/login-srv/login";
@@ -22,33 +31,15 @@ var LoginService;
     LoginService.loginWithCredentials = loginWithCredentials;
     ;
     /**
-   * login with username and password and return response
-   * @param options
-   * @returns
-   */
-    function loginWithCredentialsAsynFn(options) {
-        try {
-            var searchParams = new URLSearchParams(options);
-            var response = fetch(window.webAuthSettings.authority + "/login-srv/login", {
-                method: "POST",
-                redirect: "follow",
-                body: searchParams.toString(),
-                headers: {
-                    "Content-Type": "application/x-www-form-urlencoded"
-                }
-            });
-            return response;
-        }
-        catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
-        }
-    }
-    LoginService.loginWithCredentialsAsynFn = loginWithCredentialsAsynFn;
-    ;
-    /**
-     * login with social
-     * @param options
-     * @param queryParams
+     * To login with social providers, call **loginWithSocial()**. This will redirect you to the facebook login page.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9mi5uqxhqlsm5-social-login#call-social-login-api for more details
+     * @example
+     * ```js
+     * cidaas.loginWithSocial({
+     *   provider: 'facebook',
+     *   requestId: 'your requestId',
+     * });
+     * ```
      */
     function loginWithSocial(options, queryParams) {
         try {
@@ -65,9 +56,19 @@ var LoginService;
     LoginService.loginWithSocial = loginWithSocial;
     ;
     /**
-     *  with social
-     * @param options
-     * @param queryParams
+     * To register with social providers, call **registerWithSocial()**. This will redirect you to the facebook login page.
+     * @example
+     * Note: giving the queryParams is not required.
+     * ```js
+     * queryParams = {
+     *   dc: dc,
+     *   device_fp: device_fp
+     *
+     * cidaas.registerWithSocial({
+     *   provider: 'facebook',
+     *   requestId: 'your requestId',
+     * }, queryParams);
+     * ```
      */
     function registerWithSocial(options, queryParams) {
         try {
@@ -84,8 +85,17 @@ var LoginService;
     LoginService.registerWithSocial = registerWithSocial;
     ;
     /**
-    * passwordless login
-    * @param options
+    * To authenticate without using password, call **passwordlessLogin()**.
+    * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/k1lwsraxk0rjc-login-passwordless-request for more details.
+    * @example
+    * ```js
+    * cidaas.passwordlessLogin({
+    *   requestId: 'your requestId',
+    *   sub: 'your user sub',
+    *   statusId: 'status id from authenticateMFA()'
+    *   verificationType: 'your verificationType. e.g. email'
+    * });
+    * ```
     */
     function passwordlessLogin(options) {
         try {
@@ -101,44 +111,17 @@ var LoginService;
     LoginService.passwordlessLogin = passwordlessLogin;
     ;
     /**
-     * scope consent continue after token pre check
-     * @param options
-     */
-    function scopeConsentContinue(options) {
-        try {
-            var form = document.createElement('form');
-            form.action = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.track_id;
-            form.method = 'POST';
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
-        }
-    }
-    LoginService.scopeConsentContinue = scopeConsentContinue;
-    ;
-    /**
-     * claim consent continue login
-     * @param options
-     */
-    function claimConsentContinue(options) {
-        try {
-            var form = document.createElement('form');
-            form.action = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.track_id;
-            form.method = 'POST';
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
-        }
-    }
-    LoginService.claimConsentContinue = claimConsentContinue;
-    ;
-    /**
-    * consent continue login
-    * @param options
+    * To continue after Consent acceptance, call **consentContinue()**.
+    * @example
+    * ```js
+    * cidaas.consentContinue({
+    *   name: 'your consent name',
+    *   version: 'your consent version',
+    *   client_id: 'your client id',
+    *   track_id: 'your track id',
+    *   sub: 'your sub'
+    * });
+    * ```
     */
     function consentContinue(options) {
         try {
@@ -154,8 +137,16 @@ var LoginService;
     LoginService.consentContinue = consentContinue;
     ;
     /**
-     * mfa continue login
-     * @param options
+     * To continue after MFA completion, call **mfaContinue()**.
+     * @example
+     * ```js
+     * cidaas.mfaContinue({
+     *   trackingCode: 'your tracking Code',
+     *   track_id: 'your track id',
+     *   sub: 'your sub',
+     *   requestId: 'your request id'
+     * });
+     * ```
      */
     function mfaContinue(options) {
         try {
@@ -171,8 +162,18 @@ var LoginService;
     LoginService.mfaContinue = mfaContinue;
     ;
     /**
-     * change password continue
-     * @param options
+     * to handle changing password by first login attempt after registration, call **firstTimeChangePassword()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/fd8f478d96f58-continue-authentication-flow-after-prechecks for more details.
+     * @example
+     * ```js
+     * cidaas.firstTimeChangePassword({
+     *   sub: 'your sub',
+     *   old_password: 'your old password',
+     *   new_password: 'your new password',
+     *   confirm_password: 'your new password',
+     *   loginSettingsId: 'loginSettingsId'
+     * });
+     * ```
      */
     function firstTimeChangePassword(options) {
         try {
@@ -189,60 +190,31 @@ var LoginService;
     LoginService.firstTimeChangePassword = firstTimeChangePassword;
     ;
     /**
-     * progressiveRegistration
-     * @param options
-     * @param headers
-     * @returns
+     * For progressive registration, call **progressiveRegistration()**. While logging in If the API returns 417 with the error message MissingRequiredFields, call the **getMissingFields** to get the list of missing fileds and proceed with progressive registration. In the sample request only the required fields are added, however you must provide the missing fields along with the required fields.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/l7sknp2pytryr-progressive-registration for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   sub: 'your sub',
+     * }
+     * const headers = {
+     *   trackId: 'the track id received while logging in',
+     *   requestId: 'request id of the session',
+     *   acceptlanguage: 'your locale/browser locale (OPTIONAL)',
+     * }
+     * cidaas.progressiveRegistration(options, headers)
+     * .then(function(response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function progressiveRegistration(options, headers) {
-        return new Promise(function (resolve, reject) {
-            try {
-                var http = new XMLHttpRequest();
-                var _serviceURL = window.webAuthSettings.authority + "/login-srv/progressive/update/user";
-                http.onreadystatechange = function () {
-                    if (http.readyState == 4) {
-                        if (http.responseText) {
-                            resolve(JSON.parse(http.responseText));
-                        }
-                        else {
-                            resolve(undefined);
-                        }
-                    }
-                };
-                http.open("POST", _serviceURL, true);
-                http.setRequestHeader("Content-type", "application/json");
-                http.setRequestHeader("requestId", headers.requestId);
-                http.setRequestHeader("trackId", headers.trackId);
-                if (headers.acceptlanguage) {
-                    http.setRequestHeader("accept-language", headers.acceptlanguage);
-                }
-                else if (window.localeSettings) {
-                    http.setRequestHeader("accept-language", window.localeSettings);
-                }
-                http.send(JSON.stringify(options));
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+        var serviceURL = window.webAuthSettings.authority + "/login-srv/progressive/update/user";
+        return Helper_1.Helper.createHttpPromise(options, serviceURL, undefined, "POST", undefined, headers);
     }
     LoginService.progressiveRegistration = progressiveRegistration;
     ;
-    /**
-     * loginAfterRegister
-     * @param options
-     */
-    function loginAfterRegister(options) {
-        try {
-            var url = window.webAuthSettings.authority + "/login-srv/login/handle/afterregister/" + options.trackId;
-            var form = Helper_1.Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
-        }
-    }
-    LoginService.loginAfterRegister = loginAfterRegister;
-    ;
 })(LoginService = exports.LoginService || (exports.LoginService = {}));

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

@@ -1,48 +1,143 @@
-import { AccessTokenRequest, TokenIntrospectionEntity, ISuggestedMFAActionConfig } from "./Entities";
+import { AccessTokenRequest, TokenIntrospectionEntity } from "./Entities";
 export declare namespace TokenService {
     /**
-     * renew token using refresh token
-     * @param options
-     * @returns
+     * To get a new token with the grant type refresh_token, call **renewToken()**.
+     * The refresh token to create a new token. The refresh token is received while creating an access token using the token endpoint and later can be used to fetch a new token without using credentials
+     * @example
+     * ```js
+     * const options = {
+     *   refresh_token: "your refresh token",
+     * }
+     *
+     * cidaas.renewToken(options)
+     *   .then(function (response) {
+     *     // type your code here
+     *   })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     *   });
+     * ```
      */
     function renewToken(options: AccessTokenRequest): Promise<unknown>;
     /**
-     * get access token from code
-     * @param options
-     * @returns
+     * To get a new token with the grant type authorization_code, call **getAccessToken()** with code to create a new token.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/4ff850f48629a-generate-token for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   code: "your code to be exchanged with access token",
+     * }
+     *
+     * cidaas.getAccessToken(options)
+     *   .then(function (response) {
+     *     // type your code here
+     *   })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     *   });
+     * ```
      */
     function getAccessToken(options: AccessTokenRequest): Promise<unknown>;
     /**
-     * validate access token
-     * @param options
-     * @returns
+     * To validate an access token, call **validateAccessToken()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/26ff31e2937f1-introspect-with-bearer-token for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   token: "your access token",
+     *   token_type_hint: "accepted token type hints are access_token, id_token, refresh_token, sso",
+     * }
+     *
+     * cidaas.validateAccessToken(options)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function validateAccessToken(options: TokenIntrospectionEntity): Promise<unknown>;
     /**
-     * get scope consent details
-     * @param options
-     * @returns
+     * To get precheck result after login, call **loginPrecheck()**. If there is missing information, user will be redirected to either accepting consent, changing password, continuing MFA process, or do progressive registration
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/aappczju1t3uh-precheck-information for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   trackId: "your track id from login",
+     *   locale: "your preferred locale",
+     * }
+     *
+     * cidaas.loginPrecheck(options)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
-    function getScopeConsentDetails(options: {
+    function loginPrecheck(options: {
         track_id: string;
         locale: string;
     }): Promise<unknown>;
     /**
-     * updateSuggestMFA
-     * @param track_id
-     * @param options
-     * @returns
+     * To get the missing fields after login, call **getMissingFields()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/aappczju1t3uh-precheck-information for more details.
+     * @example
+     * ```js
+     * const trackId = "your track id from login";
+     * cidaas.getMissingFields(trackId)
+     *   .then(function (response) {
+     *     // type your code here
+     * })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     * });
+     * ```
      */
-    function updateSuggestMFA(track_id: string, options: ISuggestedMFAActionConfig): Promise<unknown>;
+    function getMissingFields(trackId: string): Promise<unknown>;
     /**
-     * getMissingFieldsLogin
-     * @param trackId
-     * @returns
+     * To initiate device code, call **initiateDeviceCode()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/b6d284f55be5e-authorization-request for more details.
+     * @example
+     * ```js
+     * const clientId = "your client id";
+     * cidaas.initiateDeviceCode(clientId)
+     *   .then(function (response) {
+     *     // type your code here
+     * })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     * });
+     * ```
      */
-    function getMissingFieldsLogin(trackId: string): Promise<unknown>;
+    function initiateDeviceCode(clientId?: string): Promise<unknown>;
     /**
-     * device code flow - verify
-     * @param code
+     * To verify device code, call **deviceCodeVerify()**.
+     * @example
+     * ```js
+     * const code = "your code which has been send after initiateDeviceCode()";
+     * cidaas.deviceCodeVerify(code)
+     *   .then(function (response) {
+     *     // type your code here
+     * })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     * });
+     * ```
      */
     function deviceCodeVerify(code: string): void;
+    /**
+     * To check access token without having to call cidaas api, call **offlineTokenCheck()**. THe function will return true if the token is valid & false if the token is invalid.
+     * @example
+     * ```js
+     * cidaas.offlineTokenCheck('your access token');
+     * ```
+     */
+    function offlineTokenCheck(accessToken: string): {
+        isExpiryDateValid: boolean;
+        isScopesValid: boolean;
+        isIssuerValid: boolean;
+    };
 }