cidaas-javascript-sdk 4.3.2 → 5.0.0

package/dist/consent-service/ConsentService.d.ts

@@ -1,97 +1,101 @@
 import { HTTPRequestHeader } from "../common/Common.model";
+import ConfigUserProvider from "../common/ConfigUserProvider";
 import { AcceptClaimConsentRequest, AcceptConsentRequest, AcceptScopeConsentRequest, GetConsentDetailsRequest, GetConsentVersionDetailsRequest, RevokeClaimConsentRequest } from "./ConsentService.model";
-/**
- * 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
- * });
- * ```
- */
-export declare function getConsentDetails(options: GetConsentDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function acceptConsent(options: AcceptConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function getConsentVersionDetails(options: GetConsentVersionDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * To accept scope consent, call **acceptScopeConsent()**.
- * @example
- * ```js
- * this.cidaas.acceptScopeConsent({
- *   client_id: 'your client id',
- *   sub: 'masked sub',
- *   scopes: [your scope consents]
- *  });
- * ```
- */
-export declare function acceptScopeConsent(options: AcceptScopeConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * To accept claim consent, call **acceptClaimConsent()**.
- * @example
- * ```js
- * this.cidaas.acceptClaimConsent({
- *   client_id: 'your client id',
- *   sub: 'masked sub',
- *   accepted_claims: [your claim consents]
- *  });
- * ```
- */
-export declare function acceptClaimConsent(options: AcceptClaimConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- *  });
- * ```
- */
-export declare function revokeClaimConsent(options: RevokeClaimConsentRequest): Promise<any>;
+export declare class ConsentService {
+    private config;
+    private userManager;
+    constructor(configUserProvider: ConfigUserProvider);
+    /**
+     * 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
+     * cidaasConsentService.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
+     * });
+     * ```
+     */
+    getConsentDetails(options: GetConsentDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * To accept consent, call **acceptConsent()**.
+     * @example
+     * ```js
+     * cidaasConsentService.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
+     * });
+     * ```
+     */
+    acceptConsent(options: AcceptConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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
+     * cidaasConsentService.getConsentVersionDetails({
+     *   consentid: 'your consent id',
+     *   locale: 'browser accept language or custom language',
+     * }).then((response) => {
+     *   // type your code here
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getConsentVersionDetails(options: GetConsentVersionDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * To accept scope consent, call **acceptScopeConsent()**.
+     * @example
+     * ```js
+     * cidaasConsentService.acceptScopeConsent({
+     *   client_id: 'your client id',
+     *   sub: 'masked sub',
+     *   scopes: [your scope consents]
+     *  });
+     * ```
+     */
+    acceptScopeConsent(options: AcceptScopeConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * To accept claim consent, call **acceptClaimConsent()**.
+     * @example
+     * ```js
+     * cidaasConsentService.acceptClaimConsent({
+     *   client_id: 'your client id',
+     *   sub: 'masked sub',
+     *   accepted_claims: [your claim consents]
+     *  });
+     * ```
+     */
+    acceptClaimConsent(options: AcceptClaimConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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
+     * cidaasConsentService.revokeClaimConsent({
+     *    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
+     *  });
+     * ```
+     */
+    revokeClaimConsent(options: RevokeClaimConsentRequest): Promise<any>;
+}

package/dist/consent-service/ConsentService.js

@@ -1,127 +1,130 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.revokeClaimConsent = exports.acceptClaimConsent = exports.acceptScopeConsent = exports.getConsentVersionDetails = exports.acceptConsent = exports.getConsentDetails = void 0;
+exports.ConsentService = void 0;
 const Helper_1 = require("../common/Helper");
-/**
- * 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, headers) {
-    const _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/usage/public/info";
-    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
-}
-exports.getConsentDetails = getConsentDetails;
-/**
- * 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 acceptConsent(options, headers) {
-    const _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/usage/accept";
-    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
-}
-exports.acceptConsent = acceptConsent;
-/**
- * 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 getConsentVersionDetails(options, headers) {
-    let _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/v2/consent/versions/details/" + options.consentid;
-    if (options.locale) {
-        _serviceURL += "?locale=" + options.locale;
+class ConsentService {
+    constructor(configUserProvider) {
+        this.config = configUserProvider.getConfig();
+        this.userManager = configUserProvider.getUserManager();
+    }
+    /**
+     * 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
+     * cidaasConsentService.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
+     * });
+     * ```
+     */
+    getConsentDetails(options, headers) {
+        const _serviceURL = this.config.authority + "/consent-management-srv/v2/consent/usage/public/info";
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+    }
+    /**
+     * To accept consent, call **acceptConsent()**.
+     * @example
+     * ```js
+     * cidaasConsentService.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
+     * });
+     * ```
+     */
+    acceptConsent(options, headers) {
+        const _serviceURL = this.config.authority + "/consent-management-srv/v2/consent/usage/accept";
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+    }
+    /**
+     * 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
+     * cidaasConsentService.getConsentVersionDetails({
+     *   consentid: 'your consent id',
+     *   locale: 'browser accept language or custom language',
+     * }).then((response) => {
+     *   // type your code here
+     * }).catch((err) => {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getConsentVersionDetails(options, headers) {
+        let _serviceURL = this.config.authority + "/consent-management-srv/v2/consent/versions/details/" + options.consentid;
+        if (options.locale) {
+            _serviceURL += "?locale=" + options.locale;
+        }
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", undefined, headers);
+    }
+    /**
+     * To accept scope consent, call **acceptScopeConsent()**.
+     * @example
+     * ```js
+     * cidaasConsentService.acceptScopeConsent({
+     *   client_id: 'your client id',
+     *   sub: 'masked sub',
+     *   scopes: [your scope consents]
+     *  });
+     * ```
+     */
+    acceptScopeConsent(options, headers) {
+        const _serviceURL = this.config.authority + "/consent-management-srv/consent/scope/accept";
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+    }
+    /**
+     * To accept claim consent, call **acceptClaimConsent()**.
+     * @example
+     * ```js
+     * cidaasConsentService.acceptClaimConsent({
+     *   client_id: 'your client id',
+     *   sub: 'masked sub',
+     *   accepted_claims: [your claim consents]
+     *  });
+     * ```
+     */
+    acceptClaimConsent(options, headers) {
+        const _serviceURL = this.config.authority + "/consent-management-srv/consent/claim/accept";
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+    }
+    /**
+     * 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
+     * cidaasConsentService.revokeClaimConsent({
+     *    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
+     *  });
+     * ```
+     */
+    revokeClaimConsent(options) {
+        const _serviceURL = this.config.authority + "/consent-management-srv/consent/claim/revoke";
+        if (options.access_token) {
+            return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", options.access_token);
+        }
+        return Helper_1.Helper.getAccessTokenFromUserStorage(this.userManager).then((accessToken) => {
+            return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", accessToken);
+        });
     }
-    // BREAKING TODO: remove access token as it is not needed to get consent version details
-    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", options.access_token, headers);
-}
-exports.getConsentVersionDetails = getConsentVersionDetails;
-/**
- * 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, headers) {
-    const _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/scope/accept";
-    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
-}
-exports.acceptScopeConsent = acceptScopeConsent;
-/**
- * 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, headers) {
-    const _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/claim/accept";
-    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
-}
-exports.acceptClaimConsent = acceptClaimConsent;
-/**
- * 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) {
-    const _serviceURL = window.webAuthSettings.authority + "/consent-management-srv/consent/claim/revoke";
-    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", options.access_token);
 }
-exports.revokeClaimConsent = revokeClaimConsent;
+exports.ConsentService = ConsentService;

package/dist/consent-service/ConsentService.model.d.ts

@@ -6,12 +6,12 @@ export interface GetConsentDetailsRequest {
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     sub?: string;
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     q?: string;
 }
 export interface AcceptConsentRequest {
@@ -24,12 +24,12 @@ export interface AcceptConsentRequest {
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     sub?: string;
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     q?: string;
     /** Scopes are list of functional definition. Required to be passed on scope consent (Ex: email, profile, openid) */
     scopes?: string[];
@@ -55,48 +55,46 @@ export interface GetConsentVersionDetailsRequest {
     consentid: string;
     /** Response language, which is configured in cidaas admin ui */
     locale?: string;
-    /** DEPRECATED: Access Token is not needed for Getting ConsentVersionDetailsRequest in the current cidaas service. It will be removed in the next Major release */
-    access_token?: string;
 }
 export interface AcceptScopeConsentRequest {
     /** Unique identifier of client app, can be found in app setting under admin ui */
     client_id: string;
+    /** List of scopes, which is included in the scope consent to be accepted */
+    scopes: string[];
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     sub?: string;
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     q?: string;
-    /** List of scopes, which is included in the scope consent to be accepted */
-    scopes: string[];
 }
 export interface AcceptClaimConsentRequest {
     /** Unique identifier of client app, can be found in app setting under admin ui */
     client_id: string;
+    /** List of claims, which is included in the claim consent to be accepted */
+    accepted_claims: string[];
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     sub?: string;
     /**
      * Masked sub (id of user), who will accept the consent.
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     q?: string;
-    /** List of claims, which is included in the claim consent to be accepted */
-    accepted_claims: string[];
 }
 export interface RevokeClaimConsentRequest {
-    /** Access token needed to authorized api call */
-    access_token: string;
     /** Unique identifier of client app, can be found in app setting under admin ui */
     client_id: string;
     /** sub (id of user), who will revoke the consent */
     sub: string;
     /** List of claims, which is included in the claim consent to be revoked */
     revoked_claims: string[];
+    /** Access token needed to authorized api call. If not provided, access token from UserStorage will be used. */
+    access_token?: string;
 }

package/dist/device-service/DeviceService.d.ts

@@ -0,0 +1,49 @@
+import ConfigUserProvider from "../common/ConfigUserProvider";
+import { DeleteDeviceRequest } from "./DeviceService.model";
+export declare class DeviceService {
+    private config;
+    private userManager;
+    constructor(configUserProvider: ConfigUserProvider);
+    /**
+     * To get all devices information associated to the client, call **getDevicesInfo()**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a2feed70303c-get-device-by-user for more details.
+     * @example
+     * ```js
+     * cidaasDeviceService.getDevicesInfo().then(function (resp) {
+     *   // the response will give you devices informations.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getDevicesInfo(access_token?: string): Promise<any>;
+    /**
+     * To delete device associated to the client, call **deleteDevice()**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3d44ad903d6e8-logout-the-user-for-a-device for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   device_id: 'id of device associated to the client.' // call **getDevicesInfo()** to get List of device ids and its details.
+     * };
+     * cidaasDeviceService.deleteDevice(options).then(function (resp) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code
+     * });
+     * ```
+     */
+    deleteDevice(options: DeleteDeviceRequest, access_token?: string): Promise<any>;
+    /**
+     * to generate device info, call **createDeviceInfo()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9b5a892afaf0b-create-device-info for more details.
+     * @example
+     * ```js
+     * cidaasDeviceService.createDeviceInfo().then(function (resp) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code
+     * });
+     * ```
+     */
+    createDeviceInfo(): Promise<any>;
+}