cidaas-javascript-sdk 4.3.3 → 5.0.0

package/dist/public-service/PublicService.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicService = void 0;
+const Helper_1 = require("../common/Helper");
+class PublicService {
+    constructor(configUserProvider) {
+        this.config = configUserProvider.getConfig();
+    }
+    /**
+     * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
+     * @example
+     * ```js
+     * // To get requestId using default configured settings, run the function without parameter
+     * cidaasPublicService.getRequestId().then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     *
+     * // To get requestId using custom settings, run the function with custom setting(s) inside option parameter. Example below will only override client_id & redirect_uri
+     * const option: GetRequestIdRequest = {
+     *   'client_id': 'your client id',
+     *   'redirect_uri': 'your redirect url',
+     * }
+     * cidaasPublicService.getRequestId(option).then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getRequestId(option) {
+        var _a, _b, _c, _d, _e;
+        const ui_locales = this.config.ui_locales;
+        const payload = Object.assign({ 'client_id': (_a = option === null || option === void 0 ? void 0 : option.client_id) !== null && _a !== void 0 ? _a : this.config.client_id, 'redirect_uri': (_b = option === null || option === void 0 ? void 0 : option.redirect_uri) !== null && _b !== void 0 ? _b : this.config.redirect_uri, 'response_type': (_c = option === null || option === void 0 ? void 0 : option.response_type) !== null && _c !== void 0 ? _c : (this.config.response_type || 'token'), 'response_mode': (_d = option === null || option === void 0 ? void 0 : option.response_mode) !== null && _d !== void 0 ? _d : (this.config.response_mode || 'fragment'), 'scope': (_e = option === null || option === void 0 ? void 0 : option.scope) !== null && _e !== void 0 ? _e : this.config.scope, 'nonce': new Date().getTime().toString() }, (ui_locales && { ui_locales } || {}));
+        const serviceURL = this.config.authority + '/authz-srv/authrequest/authz/generate';
+        return Helper_1.Helper.createHttpPromise(payload, serviceURL, false, "POST");
+    }
+    /**
+     * To get the tenant basic information, call **getTenantInfo()**. This will return the basic tenant details such as tenant name and allowed login with types (Email, Mobile, Username).
+     * @example
+     * ```js
+     * cidaasPublicService.getTenantInfo().then(function (response) {
+     *   // the response will give you tenant details
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getTenantInfo() {
+        const _serviceURL = this.config.authority + "/public-srv/tenantinfo/basic";
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET");
+    }
+    /**
+     * To get the client basic information, call **getClientInfo()**. This will return the basic client details such as client name and its details.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/dc8a6cfb28abb-public-page-information for more details.
+     * @example
+     * ```js
+     * cidaasPublicService.getClientInfo({
+     *   requestId: 'your requestId',
+     * }).then(function (resp) {
+     *   // the response will give you client info.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getClientInfo(options) {
+        const _serviceURL = this.config.authority + "/public-srv/public/" + options.requestId;
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET");
+    }
+}
+exports.PublicService = PublicService;

package/dist/public-service/PublicService.model.d.ts

@@ -0,0 +1,20 @@
+export interface GetClientInfoRequest {
+    /** Request id returned from the authorization call */
+    requestId: string;
+}
+export interface GetRequestIdRequest {
+    /** Unique identifier of client app, can be found in app setting under admin ui */
+    client_id?: string;
+    /** Specify the url where the user needs to be redirected after successful login */
+    redirect_uri?: string;
+    /** Permissions that are requested for this requestId */
+    scope?: string;
+    /** Response type expected for the process e.g. token or code */
+    response_type?: string;
+    /** Response mode defines how the redirect_uri will receive the token or code e.g. as query or fragment */
+    response_mode?: string;
+    /** String value used to associate a client session with an id token, and to mitigate replay attacks */
+    nonce?: string;
+    /** Preferred locale of the user */
+    ui_locales?: string;
+}

package/dist/public-service/PublicService.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/token-service/TokenService.d.ts

@@ -1,139 +1,105 @@
-import { GetAccessTokenRequest, RenewTokenRequest, TokenIntrospectionRequest } from "./TokenService.model";
+import { GenerateTokenFromCodeRequest } from "./TokenService.model";
 import { HTTPRequestHeader, LoginPrecheckRequest } from "../common/Common.model";
-/**
- * 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
- *   });
- * ```
- */
-export declare function renewToken(options: RenewTokenRequest): Promise<any>;
-/**
- * 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
- *   });
- * ```
- */
-export declare function getAccessToken(options: GetAccessTokenRequest): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function validateAccessToken(options: TokenIntrospectionRequest): Promise<any>;
-/**
- * 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. DEPRECATED as it is not supported anymore. Will be removed in next major release",
- * }
- *
- * cidaas.loginPrecheck(options)
- * .then(function (response) {
- *   // type your code here
- * })
- * .catch(function (ex) {
- *   // your failure code here
- * });
- * ```
- */
-export declare function loginPrecheck(options: LoginPrecheckRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function getMissingFields(trackId: string, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function initiateDeviceCode(clientId?: string): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare 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');
- * ```
- */
-export declare function offlineTokenCheck(accessToken: string): {
-    isExpiryDateValid: boolean;
-    isScopesValid: boolean;
-    isIssuerValid: boolean;
-};
+import ConfigUserProvider from "../common/ConfigUserProvider";
+export declare class TokenService {
+    private config;
+    private userManager;
+    constructor(configUserProvider: ConfigUserProvider);
+    /**
+     * To generate token(s) with the grant type authorization_code, call **generateTokenFromCode()**
+     * 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 the token(s)",
+     * }
+     *
+     * cidaasTokenService.generateTokenFromCode(options)
+     *   .then(function (response) {
+     *     // type your code here
+     *   })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     *   });
+     * ```
+     */
+    generateTokenFromCode(options: GenerateTokenFromCodeRequest): Promise<any>;
+    /**
+     * 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 = {
+     *   track_id: "your track id from login",
+     * }
+     *
+     * cidaasTokenService.loginPrecheck(options)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    loginPrecheck(options: LoginPrecheckRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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";
+     * cidaasTokenService.getMissingFields(trackId)
+     *   .then(function (response) {
+     *     // type your code here
+     * })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     * });
+     * ```
+     */
+    getMissingFields(trackId: string, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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";
+     * cidaasTokenService.initiateDeviceCode(clientId)
+     *   .then(function (response) {
+     *     // type your code here
+     * })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     * });
+     * ```
+     */
+    initiateDeviceCode(clientId?: string): Promise<any>;
+    /**
+     * To verify device code, call **deviceCodeVerify()**.
+     * @example
+     * ```js
+     * const code = "your code which has been send after initiateDeviceCode()";
+     * cidaasTokenService.deviceCodeVerify(code)
+     *   .then(function (response) {
+     *     // type your code here
+     * })
+     *   .catch(function (ex) {
+     *     // your failure code here
+     * });
+     * ```
+     */
+    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
+     * cidaasTokenService.offlineTokenCheck('your access token');
+     * ```
+     */
+    offlineTokenCheck(accessToken: string): {
+        isExpiryDateValid: boolean;
+        isScopesValid: boolean;
+        isIssuerValid: boolean;
+    };
+}