cidaas-javascript-sdk 4.2.4 → 4.3.0

package/dist/user-service/UserService.js

@@ -0,0 +1,451 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userCheckExists = exports.deleteUserAccount = exports.unlinkAccount = exports.getLinkedUsers = exports.completeLinkAccount = exports.initiateLinkAccount = exports.updateProfile = exports.changePassword = exports.registerDeduplication = exports.deduplicationLogin = exports.getDeduplicationDetails = exports.resetPassword = exports.handleResetPassword = exports.initiateResetPassword = exports.getCommunicationStatus = exports.getInviteUserDetails = exports.register = exports.getUserProfile = void 0;
+const Helper_1 = require("../common/Helper");
+/**
+ * To get the user profile information by using cidaas internal api, call **getUserProfile()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2zfvjx3vtq6g6-get-user-info for more details.
+ * @example
+ * ```js
+ * const options = {
+ *   access_token: 'your access token'
+ * }
+ * cidaas.getUserProfile(options)
+ * .then(function () {
+ *   // the response will give you user profile information.
+ * }).catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getUserProfile(options) {
+    if (!options.access_token) {
+        throw new Helper_1.CustomException("access_token cannot be empty", 417);
+    }
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo";
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", options.access_token);
+}
+exports.getUserProfile = getUserProfile;
+/**
+ * To register user, call **register()**. This method will create a new user.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/427632e587203-register-a-new-user for more details.
+ * Note: Only requestId in the headers is required.
+ * @example
+ * ```js
+ * const headers = {
+ *   requestId: 'your_received_requestId',
+ *   captcha: 'captcha',
+ *   acceptlanguage: 'acceptlanguage',
+ *   bot_captcha_response: 'bot_captcha_response'
+ * };
+ *
+ * cidaas.register({
+ *   email: 'xxx123@xxx.com',
+ *   given_name: 'xxxxx',
+ *   family_name: 'yyyyy',
+ *   password: '123456',
+ *   password_echo: '123456',
+ *   provider: 'your provider', // FACEBOOK, GOOGLE, SELF
+ *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+ * }, headers).then(function (response) {
+ *   // the response will give you client registration details.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ *```
+  */
+function register(options, headers) {
+    let _serviceURL = window.webAuthSettings.authority + "/users-srv/register";
+    if (options.invite_id) {
+        _serviceURL = _serviceURL + "?invite_id=" + options.invite_id;
+    }
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+}
+exports.register = register;
+/**
+ * to get information about invitation details, call **getInviteUserDetails()**. This API allows to retrieve invitation details and prefill the registration form.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/0b5efa5a2db5d-prefill-the-user-invitation for more details.
+ * Minimum cidaas version to use latest api is v3.100
+ * @example
+ * ```js
+ * const options = {
+ *   invite_id: 'id of user invitation'
+ *   callLatestAPI: 'true' // call latest api if parameter is given. By default, the older api will be called
+ * }
+ * cidaas.getInviteUserDetails(options)
+ * .then(function () {
+ *   // the response will give you information about the invitation.
+ * }).catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getInviteUserDetails(options) {
+    let _serviceURL = "";
+    if (options.callLatestAPI) {
+        _serviceURL = window.webAuthSettings.authority + "/useractions-srv/invitations/" + options.invite_id;
+    }
+    else {
+        _serviceURL = window.webAuthSettings.authority + "/users-srv/invite/info/" + options.invite_id;
+    }
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET");
+}
+exports.getInviteUserDetails = getInviteUserDetails;
+/**
+ * Once registration successful, verify the account based on the flow. To get the details, call **getCommunicationStatus()**.
+ * @example
+ * ```js
+ * cidaas.getCommunicationStatus({
+ *   sub: 'your sub', // which you will get on the registration response
+ * }).then(function (response) {
+ *   // the response will give you account details once its verified.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getCommunicationStatus(options, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/communication/status/" + options.sub;
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", undefined, headers);
+}
+exports.getCommunicationStatus = getCommunicationStatus;
+/**
+ * To initiate the password resetting, call **initiateResetPassword()**. This will send verification code to your email or mobile based on the resetMedium you mentioned.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/6b29bac6002f4-initiate-password-reset for more details.
+ * @example
+ * ```js
+ * cidaas.initiateResetPassword({
+ *   email: 'xxxxxx@xxx.com',
+ *   processingType: ProcessingType.CODE,
+ *   requestId: 'your requestId',
+ *   resetMedium: ResetMedium.EMAIL
+ * }).then(function (response) {
+ *   // the response will give you password reset details.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function initiateResetPassword(options) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/resetpassword/initiate";
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
+}
+exports.initiateResetPassword = initiateResetPassword;
+/**
+ * To handle the reset password by entering the verification code you received, call **handleResetPassword()**. This will check if your verification code was valid or not, and allows you to proceed to the next step.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3t8ztokeb7cfz-handle-reset-password for more details.
+ * @example
+ * ```js
+ * const handleResponseAsJson = 'true if the response need to be handled the old way (as json). In the current handling, the response information will be given as query parameter in redirect url.';
+ * cidaas.handleResetPassword({
+ *   code: 'your code in email or sms or ivr',
+ *   resetRequestId: 'your resetRequestId' // which you will get on initiate reset password response
+ * }, handleResponseAsJson).then(function (response) {
+ *   // the response will give you valid verification code.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function handleResetPassword(options, handleResponseAsJson) {
+    try {
+        const url = window.webAuthSettings.authority + "/users-srv/resetpassword/validatecode";
+        if (!handleResponseAsJson) {
+            // current handling will redirect and give query parameters
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        else {
+            // older cidaas service handling return json object
+            return Helper_1.Helper.createHttpPromise(options, url, false, "POST");
+        }
+    }
+    catch (ex) {
+        throw new Helper_1.CustomException(String(ex), 417);
+    }
+}
+exports.handleResetPassword = handleResetPassword;
+/**
+ * To finish reseting the password, call **resetPassword()**. This will allow you to change your password.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qa9ny0gkzlf6y-accept-reset-password for more details.
+ * @example
+ * ```js
+ * const handleResponseAsJson = 'true if the response need to be handled the old way (as json). In the current handling, user will be redirected to success page after successful reset password.';
+ * cidaas.resetPassword({
+ *   password: '123456',
+ *   confirmPassword: '123456',
+ *   exchangeId: 'your exchangeId', // which you will get on handle reset password response
+ *   resetRequestId: 'your resetRequestId' // which you will get on handle reset password response
+ * }).then(function (response) {
+ *   // the response will give you reset password details.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function resetPassword(options, handleResponseAsJson) {
+    const url = window.webAuthSettings.authority + "/users-srv/resetpassword/accept";
+    try {
+        if (!handleResponseAsJson) {
+            // current handling will redirect and give query parameters
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        else {
+            // older cidaas service handling return json object
+            return Helper_1.Helper.createHttpPromise(options, url, false, "POST");
+        }
+    }
+    catch (ex) {
+        throw new Helper_1.CustomException(String(ex), 417);
+    }
+}
+exports.resetPassword = resetPassword;
+/**
+ * To get the list of existing users in deduplication, call **getDeduplicationDetails()**.
+ * @example
+ * ```js
+ * this.cidaas.getDeduplicationDetails({
+ *   track_id: 'your track id'
+ * }).then((response) => {
+ *   // the response will give you deduplication details of users.
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getDeduplicationDetails(options) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/info/" + options.trackId;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "GET");
+}
+exports.getDeduplicationDetails = getDeduplicationDetails;
+/**
+ * To use the existing users in deduplication, you need to call **deduplicationLogin()**.
+ * @example
+ * ```js
+ * this.cidaas.deduplicationLogin({
+ *   sub: 'your sub',
+ *   requestId: 'request id from deduplication initialisation after register',
+ *   trackId: 'track id from deduplication initialisation after register'
+ * })
+ * ```
+ */
+function deduplicationLogin(options) {
+    try {
+        const url = window.webAuthSettings.authority + "/users-srv/deduplication/login/redirection?trackId=" + options.trackId + "&requestId=" + options.requestId + "&sub=" + options.sub;
+        const form = Helper_1.Helper.createForm(url, {});
+        document.body.appendChild(form);
+        form.submit();
+    }
+    catch (ex) {
+        throw new Helper_1.CustomException(String(ex), 417);
+    }
+}
+exports.deduplicationLogin = deduplicationLogin;
+/**
+ * To register new user in deduplication, call **registerDeduplication()**.
+ * @example
+ * ```js
+ * this.cidaas.registerDeduplication({
+ *   track_id: 'track id from deduplication initialisation after register',
+ * }).then((response) => {
+ *   // the response will give you new registered deduplication user.
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function registerDeduplication(options) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/deduplication/register/" + options.trackId;
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST");
+}
+exports.registerDeduplication = registerDeduplication;
+/**
+ * To change the password, call **changePassword()**. This will allow you to change your password.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/8221883241464-change-password for more details.
+ * @example
+ * ```js
+ * cidaas.changePassword({
+ *   old_password: 'your old password',
+ *   new_password: 'your new password',
+ *   confirm_password: 'your new password',
+ *   sub: 'your sub',
+ * }, 'your access token')
+ * .then(function () {
+ *   // your success code
+ * }).catch(function (ex) {
+ *   // your failure code
+ * });
+ * ```
+ */
+function changePassword(options, access_token) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/changepassword";
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
+}
+exports.changePassword = changePassword;
+/**
+ * To update the user profile information, call **updateProfile()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/i3uqnxcpxr19r-update-user-profile for more details.
+ * @example
+ * ```js
+ * cidaas.updateProfile({
+ *   family_name: 'Doe',
+ *   given_name: 'John',
+ *   provider: 'self',
+ *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+ * }, 'your access token', 'your sub').then(function () {
+ *   // the response will give you updated user profile info.
+ * }).catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function updateProfile(options, access_token, sub) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/profile/" + sub;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "PUT", access_token);
+}
+exports.updateProfile = updateProfile;
+/**
+ * To initiate account linking, call **initiateLinkAccount()**.
+ * @example
+ * ```js
+ * const options = {
+ *   master_sub: 'sub of the user who initiates the user link',
+ *   user_name_to_link: 'username of the user which should get linked',
+ *   user_name_type: 'type of user name to link. E.g. email'
+ * }
+ * const access_token = 'your access token'
+ * this.cidaas.initiateLinkAccount(options, access_token).then((response) => {
+ *   // your success code
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function initiateLinkAccount(options, access_token) {
+    options.user_name_type = 'email';
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/link/initiate";
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
+}
+exports.initiateLinkAccount = initiateLinkAccount;
+/**
+ * To complete account linking, call **completeLinkAccount()**.
+ * @example
+ * ```js
+ * const options = {
+ *   code: 'code which is sent to account to be linked',
+ *   link_request_id: 'comes from initiateLinkAccount'
+ * }
+ * const access_token = 'your access token'
+ * this.cidaas.completeLinkAccount(options, access_token).then((response) => {
+ *   // your success code
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function completeLinkAccount(options, access_token) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/link/complete";
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", access_token);
+}
+exports.completeLinkAccount = completeLinkAccount;
+/**
+ * To get all the linked accounts, call **getLinkedUsers()**.
+ * @example
+ * ```js
+ * const acccess_token= 'your access token';
+ * const sub = 'your sub';
+ *
+ * cidaas.getLinkedUsers(access_token, sub)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getLinkedUsers(access_token, sub) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/userinfo/social/" + sub;
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "GET", access_token);
+}
+exports.getLinkedUsers = getLinkedUsers;
+/**
+ * To unlink an account for a user, call **unlinkAccount()**.
+ * @example
+ * ```js
+ * const acccess_token= "your access token";
+ * const identityId = "comes from getLinkedUsers";
+ *
+ * cidaas.unlinkAccount(access_token, identityId)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function unlinkAccount(access_token, identityId) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/unlink/" + identityId;
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, false, "POST", access_token);
+}
+exports.unlinkAccount = unlinkAccount;
+/**
+ * To delete the user account directly in the application, call **deleteUserAccount()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/x133xdifl1sx9-schedule-user-deletion for more details.
+ * @example
+ * ```js
+ * options = {
+ *   access_token: "your access token",
+ *   sub: "your sub"
+ * }
+ *
+ * cidaas.deleteUserAccount(options).then(function (response) {
+ *   // your success code
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function deleteUserAccount(options) {
+    const _serviceURL = window.webAuthSettings.authority + "/users-srv/user/unregister/scheduler/schedule/" + options.sub;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", options.access_token);
+}
+exports.deleteUserAccount = deleteUserAccount;
+/**
+ * To check if user exists, call **userCheckExists()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/4yh82qism78xf-find-user-by-identifier for more details.
+ * @example
+ * options = {
+ *   requestId: "your request id",
+ *   email: "your email"
+ * }
+ *
+ * cidaas.userCheckExists(options).then(function (response) {
+ *   // your success code
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function userCheckExists(options) {
+    let queryParameter = '';
+    if (options.webfinger || options.rememberMe) {
+        queryParameter += '?';
+        if (options.webfinger) {
+            queryParameter += 'webfinger=' + options.webfinger;
+            if (options.rememberMe) {
+                queryParameter += '&rememberMe=' + options.rememberMe;
+            }
+        }
+        else if (options.rememberMe) {
+            queryParameter += 'rememberMe=' + options.rememberMe;
+        }
+    }
+    const _serviceURL = window.webAuthSettings.authority + "/useractions-srv/userexistence/" + options.requestId + queryParameter;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+}
+exports.userCheckExists = userCheckExists;

package/dist/user-service/UserService.model.d.ts

@@ -0,0 +1,142 @@
+import { ProcessingType } from "../common/Common.model";
+import { CidaasUser } from "../common/User.model";
+export interface GetUserProfileRequest {
+    /** Access token needed to authorized api call */
+    access_token: string;
+}
+export interface RegisterRequest extends CidaasUser {
+    /** id which is generated during user invitation process */
+    invite_id?: string;
+}
+export interface GetInviteUserDetailsRequest {
+    /** id which is generated during user invitation process */
+    invite_id: string;
+    /** described whether latest api or legacy api should be called */
+    callLatestAPI?: boolean;
+}
+export interface getCommunicationStatusRequest {
+    /** Subject (User) identifier */
+    sub: string;
+}
+export interface InitiateResetPasswordRequest {
+    /**
+     * Type of medium to be used to reset password
+     * BREAKING TODO: change type to ResetMedium only in next major version
+     * */
+    resetMedium: ResetMedium | string;
+    /**
+     * defines whether the password can be resetted via email link or whether the user needs to enter a code to complete the reset password process.
+     * BREAKING TODO: change type to ProcessingType only in next major version
+     * */
+    processingType: ProcessingType | string;
+    /** Email of the user */
+    email?: string;
+    /** Mobile number of the user */
+    mobile?: string;
+    /** Phone number of the user */
+    phone?: string;
+    /** Username of the user */
+    username?: string;
+    /** Request id returned from the authorization call */
+    requestId?: string;
+    /** Provider name indicating the origin of the social identity */
+    provider?: string;
+    /** Id of the reset password process */
+    resetPasswordId?: string;
+    /** Subject (User) identifier */
+    sub?: string;
+}
+export interface HandleResetPasswordRequest {
+    /** Returned from the initiation of password reset call as rprq */
+    resetRequestId: string;
+    /** One time password code send to the user after the initiation of password reset is complete*/
+    code: string;
+}
+export interface ResetPasswordRequest {
+    /** Returned from the initiation of password reset call as rprq */
+    resetRequestId: string;
+    /** Returned from the after handleResetPassword process is completed */
+    exchangeId: string;
+    /** New password to be applied to the user */
+    password: string;
+    /** Confirmation of New password to be applied to the user */
+    confirmPassword: string;
+    /** Provider name indicating the origin of the social identity */
+    provider?: string;
+    /** Request id returned from the authorization call */
+    requestId?: string;
+}
+export interface GetDeduplicationDetailsRequest {
+    /** Identifier generated after successful authentication but unfulfilled prechecks */
+    trackId: string;
+}
+export interface RegisterDeduplicationRequest {
+    /** Identifier generated after successful authentication but unfulfilled prechecks */
+    trackId: string;
+}
+export interface DeduplicationLoginRequest {
+    /** Identifier generated after successful authentication but unfulfilled prechecks */
+    trackId: string;
+    /** Request id returned from the authorization call */
+    requestId: string;
+    /** Subject (User) identifier */
+    sub: string;
+    /** Password of a user */
+    password?: string;
+}
+export interface ChangePasswordRequest {
+    /** Subject (User) identifier */
+    sub: string;
+    /** Unique id of the users identity */
+    identityId?: string;
+    /** Old password of user */
+    old_password: string;
+    /** New password for user */
+    new_password: string;
+    /** Confirmation of user's new password */
+    confirm_password: string;
+}
+export interface InitiateLinkAccountRequest {
+    /** sub of the user who initiates the user link */
+    master_sub: string;
+    /** type of user name to link. E.g. email */
+    user_name_type: string;
+    /** username of the user which should get linked */
+    user_name_to_link: string;
+}
+export interface DeleteUserAccountRequest {
+    /** Access token needed to authorized api call */
+    access_token?: string;
+    /** Subject (User) identifier */
+    sub: string;
+}
+export interface CompleteLinkAccountRequest {
+    /** code will be sent to account to be linked */
+    code?: string;
+    /** value comes from initiateLinkAccount */
+    link_request_id?: string;
+}
+export interface UserCheckExistsRequest {
+    /** Request id returned from the authorization call */
+    requestId?: string;
+    /** Email of user */
+    email?: string;
+    /** Username of user */
+    username?: string;
+    /** Mobile number of user */
+    mobile?: string;
+    /** Custom predefined property to identify user */
+    customFields?: {
+        [key: string]: string;
+    };
+    /** If filled, will be sent as query parameter */
+    rememberMe?: string;
+    /** If filled, will be sent as query parameter */
+    webfinger?: string;
+}
+/** Type of medium to be used to reset password */
+export declare enum ResetMedium {
+    'SMS' = 0,
+    'EMAIL' = 1,
+    'IVR' = 2
+}

package/dist/user-service/UserService.model.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResetMedium = void 0;
+/** Type of medium to be used to reset password */
+var ResetMedium;
+(function (ResetMedium) {
+    ResetMedium[ResetMedium["SMS"] = 0] = "SMS";
+    ResetMedium[ResetMedium["EMAIL"] = 1] = "EMAIL";
+    ResetMedium[ResetMedium["IVR"] = 2] = "IVR";
+})(ResetMedium = exports.ResetMedium || (exports.ResetMedium = {}));