cidaas-javascript-sdk 3.1.5 → 4.0.1

package/dist/web-auth/ConsentService.js

@@ -2,71 +2,134 @@
 exports.__esModule = true;
 exports.ConsentService = void 0;
 var Helper_1 = require("./Helper");
+/**
+ * Consent Management
+ * For the first time login, the user needs to accept the terms and conditions.
+ */
 var ConsentService;
 (function (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) {
         var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/usage/public/info";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
-    ConsentService.getConsentDetailsV2 = getConsentDetailsV2;
+    ConsentService.getConsentDetails = getConsentDetails;
     ;
     /**
-     * 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) {
+    function acceptConsent(options) {
         var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/usage/accept";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
-    ConsentService.acceptConsentV2 = acceptConsentV2;
+    ConsentService.acceptConsent = acceptConsent;
     ;
     /**
-     * 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) {
-        var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/versions/details/" + options.scopeid + "?locale=" + options.locale;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, false, "GET", options.access_token);
+    function getConsentVersionDetails(options) {
+        var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/versions/details/" + options.consentid + "?locale=" + options.locale;
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", options.access_token);
     }
-    ConsentService.getScopeConsentVersionDetailsV2 = getScopeConsentVersionDetailsV2;
+    ConsentService.getConsentVersionDetails = getConsentVersionDetails;
     ;
     /**
-     * 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) {
         var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/scope/accept";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     ConsentService.acceptScopeConsent = acceptScopeConsent;
     ;
     /**
-     * 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) {
         var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/claim/accept";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     ConsentService.acceptClaimConsent = acceptClaimConsent;
     ;
     /**
-     * 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) {
         var _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/claim/revoke";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", options.access_token);
     }
     ConsentService.revokeClaimConsent = revokeClaimConsent;
     ;

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

@@ -1,4 +1,3 @@
-import { UserManagerSettings } from "oidc-client-ts";
 export interface AcceptResetPasswordEntity {
     resetRequestId: string;
     exchangeId: string;
@@ -93,7 +92,6 @@ export interface ChangePasswordEntity {
     old_password: string;
     new_password: string;
     confirm_password: string;
-    accessToken: string;
 }
 export interface FidoSetupEntity {
     track_id: string;
@@ -191,37 +189,22 @@ export interface IEnrollVerificationSetupRequestEntity {
     verification_type: string;
 }
 export interface IInitVerificationAuthenticationRequestEntity {
-    q: string;
-    sub: string;
-    email: string;
-    mobile_number: string;
-    username: string;
-    client_id: string;
-    request_id: string;
     usage_type: string;
-    medium_id: string;
-    single_factor_auth: boolean;
-    push_id: string;
-    device_id: string;
-    single_factor_sub_ref: string;
-    verification_types: string[];
-    device_fp: string;
-    provider: string;
     processingType: string;
-    trackId: string;
+    q?: string;
+    sub?: string;
+    email?: string;
+    mobile_number?: string;
+    username?: string;
+    client_id?: string;
+    request_id: string;
     type?: string;
-    verification_type?: string;
-}
-export interface IMobileEntity {
-    given_phone: string;
-    phone: string;
-    country: string;
-    dail_code: string;
-    carrier_type: string;
-    carrier_name: string;
-    national_format: string;
-    international_format: string;
-    E164_format: string;
+    medium_id?: string;
+    push_id?: string;
+    device_id?: string;
+    single_factor_auth?: boolean;
+    single_factor_sub_ref?: string;
+    trackId?: string;
 }
 export interface ISuggestedMFAActionConfig {
     sub?: string;
@@ -269,12 +252,6 @@ export interface IUserEntity {
     trackId: string;
     need_reset_password: boolean;
 }
-export interface IUserGroupMap {
-    sub: string;
-    groupId: string;
-    roles: string[];
-    appendRole: boolean;
-}
 export interface IUserLinkEntity {
     master_sub: string;
     user_name_type: string;
@@ -527,7 +504,13 @@ export interface IChangePasswordEntity {
     loginSettingsId: string;
     client_id?: string;
 }
-export interface ICidaasSDKSettings extends UserManagerSettings {
-    mode?: string;
-    cidaas_version?: number;
+export interface IUserActivityPayloadEntity {
+    sub: string;
+    size?: number;
+    from?: number;
+    descending?: boolean;
+    dateFilter: {
+        from_date: string;
+        to_date: string;
+    };
 }

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

@@ -15,7 +15,7 @@ export declare class Helper {
     * @param headers??
     * @returns
     */
-    static createPostPromise(options: any, serviceurl: string, errorResolver: boolean, method: string, access_token?: string, headers?: any): Promise<unknown>;
+    static createHttpPromise(options: any, serviceurl: string, errorResolver: boolean, method: string, access_token?: string, headers?: any, formPayload?: FormData): Promise<unknown>;
 }
 export declare class CustomException {
     errorMessage: string;

package/dist/web-auth/Helper.js

@@ -35,7 +35,7 @@ var Helper = /** @class */ (function () {
     * @param headers??
     * @returns
     */
-    Helper.createPostPromise = function (options, serviceurl, errorResolver, method, access_token, headers) {
+    Helper.createHttpPromise = function (options, serviceurl, errorResolver, method, access_token, headers, formPayload) {
         return new Promise(function (resolve, reject) {
             try {
                 var http = new XMLHttpRequest();
@@ -50,7 +50,9 @@ var Helper = /** @class */ (function () {
                     }
                 };
                 http.open(method, serviceurl, true);
-                http.setRequestHeader("Content-type", "application/json");
+                if (!formPayload) {
+                    http.setRequestHeader("Content-type", "application/json");
+                }
                 if (headers) {
                     for (var key in headers) {
                         if (headers.hasOwnProperty(key)) {
@@ -61,10 +63,23 @@ var Helper = /** @class */ (function () {
                 if (access_token) {
                     http.setRequestHeader("Authorization", "Bearer ".concat(access_token));
                 }
-                if (window.localeSettings) {
-                    http.setRequestHeader("accept-language", window.localeSettings);
+                var acceptlanguage = void 0;
+                if (headers === null || headers === void 0 ? void 0 : headers.acceptlanguage) {
+                    acceptlanguage = headers.acceptlanguage;
+                }
+                else if (options === null || options === void 0 ? void 0 : options.acceptlanguage) {
+                    acceptlanguage = options.acceptlanguage;
+                }
+                else {
+                    acceptlanguage = window === null || window === void 0 ? void 0 : window.localeSettings;
+                }
+                if (acceptlanguage) {
+                    http.setRequestHeader("accept-language", acceptlanguage);
+                }
+                if (formPayload) {
+                    http.send(formPayload);
                 }
-                if (options) {
+                else if (options) {
                     http.send(JSON.stringify(options));
                 }
                 else {

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

@@ -0,0 +1,7 @@
+export declare class JwtHelper {
+    static decodeTokenHeader(token: string): any;
+    static decodeToken(token: string): any;
+    static urlBase64Decode(str: string): string;
+    static b64DecodeUnicode(str: any): string;
+    static b64decode(str: any): any;
+}

package/dist/web-auth/JwtHelper.js

@@ -0,0 +1,90 @@
+"use strict";
+exports.__esModule = true;
+exports.JwtHelper = void 0;
+var JwtHelper = /** @class */ (function () {
+    function JwtHelper() {
+    }
+    JwtHelper.decodeTokenHeader = function (token) {
+        if (token === null) {
+            return null;
+        }
+        var parts = token.split('.');
+        if (parts.length !== 3) {
+            throw new Error('The inspected token doesn\'t appear to be a JWT. Check to make sure it has three parts and see https://jwt.io for more.');
+        }
+        var decoded = this.urlBase64Decode(parts[0]);
+        if (!decoded) {
+            throw new Error('Cannot decode the token.');
+        }
+        return JSON.parse(decoded);
+    };
+    JwtHelper.decodeToken = function (token) {
+        if (token === null) {
+            return null;
+        }
+        var parts = token.split('.');
+        if (parts.length !== 3) {
+            throw new Error('The inspected token doesn\'t appear to be a JWT. Check to make sure it has three parts and see https://jwt.io for more.');
+        }
+        var decoded = this.urlBase64Decode(parts[1]);
+        if (!decoded) {
+            throw new Error('Cannot decode the token.');
+        }
+        return JSON.parse(decoded);
+    };
+    JwtHelper.urlBase64Decode = function (str) {
+        var output = str.replace(/-/g, '+').replace(/_/g, '/');
+        switch (output.length % 4) {
+            case 0: {
+                break;
+            }
+            case 2: {
+                output += '==';
+                break;
+            }
+            case 3: {
+                output += '=';
+                break;
+            }
+            default: {
+                throw new Error('Illegal base64url string!');
+            }
+        }
+        return this.b64DecodeUnicode(output);
+    };
+    JwtHelper.b64DecodeUnicode = function (str) {
+        return decodeURIComponent(Array.prototype.map
+            .call(this.b64decode(str), function (c) {
+            return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
+        })
+            .join(''));
+    };
+    // credits for decoder goes to https://github.com/atk
+    JwtHelper.b64decode = function (str) {
+        var chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+        var output = '';
+        str = String(str).replace(/=+$/, '');
+        if (str.length % 4 === 1) {
+            throw new Error("'atob' failed: The string to be decoded is not correctly encoded.");
+        }
+        for (
+        // initialize result and counters
+        var bc = 0, bs = void 0, buffer = void 0, idx = 0; 
+        // get next character
+        (buffer = str.charAt(idx++)); 
+        // character found in table? initialize bit storage and add its ascii value;
+        ~buffer &&
+            ((bs = bc % 4 ? bs * 64 + buffer : buffer),
+                // and if not first of each 4 characters,
+                // convert the first 8 bits to one ascii character
+                bc++ % 4)
+            ? (output += String.fromCharCode(255 & (bs >> ((-2 * bc) & 6))))
+            : 0) {
+            // try to find character in table (0-63, not found => -1)
+            buffer = chars.indexOf(buffer);
+        }
+        return output;
+    };
+    return JwtHelper;
+}());
+exports.JwtHelper = JwtHelper;

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

@@ -1,20 +1,29 @@
-import { IUserEntity, LoginFormRequestEntity, PhysicalVerificationLoginRequest, LoginFormRequestAsyncEntity, IChangePasswordEntity } from "./Entities";
+import { IUserEntity, LoginFormRequestEntity, PhysicalVerificationLoginRequest, IChangePasswordEntity } from "./Entities";
 export declare namespace 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: LoginFormRequestEntity): void;
     /**
-   * login with username and password and return response
-   * @param options
-   * @returns
-   */
-    function loginWithCredentialsAsynFn(options: LoginFormRequestAsyncEntity): Promise<Response>;
-    /**
-     * 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: {
         provider: string;
@@ -24,9 +33,19 @@ export declare namespace LoginService {
         device_fp: string;
     }): void;
     /**
-     *  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: {
         provider: string;
@@ -36,68 +55,90 @@ export declare namespace LoginService {
         device_fp: string;
     }): void;
     /**
-    * 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: PhysicalVerificationLoginRequest): void;
     /**
-     * scope consent continue after token pre check
-     * @param options
-     */
-    function scopeConsentContinue(options: {
-        track_id: string;
-    }): void;
-    /**
-     * claim consent continue login
-     * @param options
-     */
-    function claimConsentContinue(options: {
-        track_id: string;
-    }): void;
-    /**
-    * 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: {
-        client_id: string;
-        consent_refs: string[];
-        sub: string;
-        scopes: string[];
-        matcher: any;
         track_id: string;
     }): void;
     /**
-     * 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: PhysicalVerificationLoginRequest & {
         track_id: string;
     }): void;
     /**
-     * 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: IChangePasswordEntity): void;
     /**
-     * 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: IUserEntity, headers: {
         requestId: string;
         trackId: string;
         acceptlanguage: string;
     }): Promise<unknown>;
-    /**
-     * loginAfterRegister
-     * @param options
-     */
-    function loginAfterRegister(options: {
-        device_id?: string;
-        dc?: string;
-        rememberMe?: boolean;
-        trackId?: string;
-        device_fp?: string;
-    }): void;
 }