cidaas-javascript-sdk 4.2.3 → 4.3.0

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

@@ -1,165 +0,0 @@
-import { IUserEntity, LoginFormRequestEntity, PhysicalVerificationLoginRequest, IChangePasswordEntity } from "./Entities";
-export declare namespace LoginService {
-    /**
-     * 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: LoginFormRequestEntity): void;
-    /**
-     * 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: {
-        provider: string;
-        requestId: string;
-    }, queryParams: {
-        dc: string;
-        device_fp: string;
-    }): void;
-    /**
-     * 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: {
-        provider: string;
-        requestId: string;
-    }, queryParams: {
-        dc: string;
-        device_fp: string;
-    }): void;
-    /**
-    * 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: PhysicalVerificationLoginRequest): void;
-    /**
-    * 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: {
-        track_id: string;
-    }): void;
-    /**
-     * 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: PhysicalVerificationLoginRequest & {
-        track_id: string;
-    }): void;
-    /**
-     * 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: IChangePasswordEntity): void;
-    /**
-     * 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: IUserEntity, headers: {
-        requestId: string;
-        trackId: string;
-        acceptlanguage: string;
-    }): Promise<unknown>;
-    /**
-     * To automatically do user login after successful registration, call **loginAfterRegister()**. Make sure to turn on  "auto login after register" switch on the admin ui to activate loginAfterRegister flow.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qwwamc2f378wi-auto-login-after-register for more details.
-     * @example
-     * ```js
-     * cidaas.loginAfterRegister({
-     *   device_id: 'your device id',
-     *   dc: 'device capacity'
-     *   rememberMe: false,
-     *   trackId: 'your track id',
-     *   device_fp: 'device fingerprint'
-     * });
-     * ```
-     */
-    function loginAfterRegister(options: {
-        device_id?: string;
-        dc?: string;
-        rememberMe?: boolean;
-        trackId?: string;
-        device_fp?: string;
-    }): void;
-}

package/dist/web-auth/LoginService.js

@@ -1,243 +0,0 @@
-import { Helper, CustomException } from "./Helper";
-export var LoginService;
-(function (LoginService) {
-    /**
-     * 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 {
-            const url = window.webAuthSettings.authority + "/login-srv/login";
-            let form = Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new CustomException(ex, 417);
-        }
-    }
-    LoginService.loginWithCredentials = loginWithCredentials;
-    ;
-    /**
-     * 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 {
-            var _serviceURL = window.webAuthSettings.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;
-            }
-            window.location.href = _serviceURL;
-        }
-        catch (ex) {
-            console.log(ex);
-        }
-    }
-    LoginService.loginWithSocial = loginWithSocial;
-    ;
-    /**
-     * 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 {
-            var _serviceURL = window.webAuthSettings.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;
-            }
-            window.location.href = _serviceURL;
-        }
-        catch (ex) {
-            console.log(ex);
-        }
-    }
-    LoginService.registerWithSocial = registerWithSocial;
-    ;
-    /**
-    * 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 {
-            const url = window.webAuthSettings.authority + "/login-srv/verification/login";
-            let form = Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new CustomException(ex, 417);
-        }
-    }
-    LoginService.passwordlessLogin = passwordlessLogin;
-    ;
-    /**
-    * 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 {
-            const url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.track_id;
-            let form = Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new CustomException(ex, 417);
-        }
-    }
-    LoginService.consentContinue = consentContinue;
-    ;
-    /**
-     * 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 {
-            const url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.track_id;
-            let form = Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new CustomException(ex, 417);
-        }
-    }
-    LoginService.mfaContinue = mfaContinue;
-    ;
-    /**
-     * 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 {
-            const url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.loginSettingsId;
-            let form = Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new CustomException(ex, 417);
-        }
-    }
-    LoginService.firstTimeChangePassword = firstTimeChangePassword;
-    ;
-    /**
-     * 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) {
-        var serviceURL = window.webAuthSettings.authority + "/login-srv/progressive/update/user";
-        return Helper.createHttpPromise(options, serviceURL, undefined, "POST", undefined, headers);
-    }
-    LoginService.progressiveRegistration = progressiveRegistration;
-    ;
-    /**
-     * To automatically do user login after successful registration, call **loginAfterRegister()**. Make sure to turn on  "auto login after register" switch on the admin ui to activate loginAfterRegister flow.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qwwamc2f378wi-auto-login-after-register for more details.
-     * @example
-     * ```js
-     * cidaas.loginAfterRegister({
-     *   device_id: 'your device id',
-     *   dc: 'device capacity'
-     *   rememberMe: false,
-     *   trackId: 'your track id',
-     *   device_fp: 'device fingerprint'
-     * });
-     * ```
-     */
-    function loginAfterRegister(options) {
-        try {
-            const url = window.webAuthSettings.authority + "/login-srv/login/handle/afterregister/" + options.trackId;
-            let form = Helper.createForm(url, options);
-            document.body.appendChild(form);
-            form.submit();
-        }
-        catch (ex) {
-            throw new CustomException(ex, 417);
-        }
-    }
-    LoginService.loginAfterRegister = loginAfterRegister;
-    ;
-})(LoginService || (LoginService = {}));

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

@@ -1,143 +0,0 @@
-import { AccessTokenRequest, TokenIntrospectionEntity } from "./Entities";
-export declare namespace TokenService {
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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 loginPrecheck(options: {
-        track_id: string;
-        locale: string;
-    }): Promise<unknown>;
-    /**
-     * 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 getMissingFields(trackId: string): Promise<unknown>;
-    /**
-     * 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 initiateDeviceCode(clientId?: string): Promise<unknown>;
-    /**
-     * 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;
-    };
-}