@stackfactor/client-api 1.1.11 → 1.1.12-9.2

package/lib/{users.js → users.ts}

@@ -1,12 +1,15 @@
+/* eslint-disable no-undef */
 import { client } from "./axiosClient.js";
 
 /**
  * Add a new API Token
+ * @param {string} name Name of the token
  * @param {Date} expiration Expiration date of the token
- * @param {String} authToken Authorization token
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const addAPIToken = (name, expiration, authToken) => {
-  return new Promise(function (resolve, reject) {
+const addAPIToken = (name: string, expiration: Date, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       name: name,
       expiration: expiration,
@@ -15,7 +18,7 @@ export const addAPIToken = (name, expiration, authToken) => {
       `api/v1/users/addapitoken`,
       requestData,
       {
-        headers: { authorization: authToken },
+        headers: { authorization: token },
       }
     );
     addTokenRequest
@@ -34,10 +37,11 @@ export const addAPIToken = (name, expiration, authToken) => {
 
 /**
  * Confirm email address
- * @param {String} validationCode The code was provided to the user in advance by email
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @returns {Promise<void>}
  */
-export const confirmEmailAddress = (validationCode) => {
-  return new Promise(function (resolve, reject) {
+const confirmEmailAddress = (validationCode: string): Promise<void> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       validationCode: validationCode,
     };
@@ -57,11 +61,12 @@ export const confirmEmailAddress = (validationCode) => {
 
 /**
  * Confirm phone number
- * @param {String} validationCode The code was provided to the user in advance by email
- * @param {String} authToken Authorization token
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const confirmPhone = (validationCode, authToken) => {
-  return new Promise(function (resolve, reject) {
+const confirmPhone = (validationCode: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       validationCode: validationCode,
     };
@@ -69,7 +74,7 @@ export const confirmPhone = (validationCode, authToken) => {
       "api/v1/users/confirmPhone",
       requestData,
       {
-        headers: { authorization: authToken },
+        headers: { authorization: token },
       }
     );
     confirmationRequest
@@ -84,11 +89,12 @@ export const confirmPhone = (validationCode, authToken) => {
 
 /**
  * Generate confirmation code
- * @param {String} phoneNumber Send confirmation code to the phone number
- * @param {String} authToken Authorization token
+ * @param {string} phoneNumber Send confirmation code to the phone number
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const confirmPhoneGenerateCode = (phoneNumber, authToken) => {
-  return new Promise(function (resolve, reject) {
+const confirmPhoneGenerateCode = (phoneNumber: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       phoneNumber: phoneNumber,
     };
@@ -96,7 +102,7 @@ export const confirmPhoneGenerateCode = (phoneNumber, authToken) => {
       "api/v1/users/confirmPhoneGenerateCode",
       requestData,
       {
-        headers: { authorization: authToken },
+        headers: { authorization: token },
       }
     );
     confirmationRequest
@@ -111,23 +117,23 @@ export const confirmPhoneGenerateCode = (phoneNumber, authToken) => {
 
 /**
  * Create a new account (tenant). It returns a promise
- * @param {String} email User's email address
- * @param {String} firstName User's first name
- * @param {String} lastName User's last name
- * @param {String} password User's password
- * @param {String} subSite Subsite where the new account will be created
- * @param {String} inviteCode Invitation code received in advance from one of the account owners
- * @param
+ * @param {string} email User's email address
+ * @param {string} firstName User's first name
+ * @param {string} lastName User's last name
+ * @param {string} password User's password
+ * @param {string} subSite Subsite where the new account will be created
+ * @param {string} inviteCode Invitation code received in advance from one of the account owners
+ * @returns {Promise<object>}
  */
-export const createAccount = (
-  email,
-  firstName,
-  lastName,
-  password,
-  subSite,
-  inviteCode
-) => {
-  return new Promise(function (resolve, reject) {
+const createAccount = (
+  email: string,
+  firstName: string,
+  lastName: string,
+  password: string,
+  subSite: string,
+  inviteCode: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     if (
       email.trim() === "" ||
       firstName.trim() === "" ||
@@ -160,20 +166,21 @@ export const createAccount = (
 
 /**
  * Create a new user account. It returns a promise
- * @param {String} email User's email address
- * @param {String} firstName User's first name
- * @param {String} lastName User's last name
- * @param {String} password User's password
- * @param {String} token Invitation token provided to the user
+ * @param {string} email User's email address
+ * @param {string} firstName User's first name
+ * @param {string} lastName User's last name
+ * @param {string} password User's password
+ * @param {string} token Invitation token provided to the user
+ * @returns {Promise<object>}
  */
-export const createUserAccount = (
-  email,
-  firstName,
-  lastName,
-  password,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+const createUserAccount = (
+  email: string,
+  firstName: string,
+  lastName: string,
+  password: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     if (
       email.trim() === "" ||
       firstName.trim() === "" ||
@@ -204,11 +211,12 @@ export const createUserAccount = (
 
 /**
  * Delete an existing API token
- * @param {String} token Expiration date of the token
- * @param {String} authToken Authorization token
+ * @param {string} token Expiration date of the token
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
  */
-export const deleteAPIToken = (token, authToken) => {
-  return new Promise(function (resolve, reject) {
+const deleteAPIToken = (token: string, authToken: string): Promise<string> => {
+  return new Promise((resolve, reject) => {
     const deleteTokenRequest = client.delete(`api/v1/users/user/token`, {
       headers: { authorization: authToken },
       data: {
@@ -227,13 +235,14 @@ export const deleteAPIToken = (token, authToken) => {
 
 /**
  * Delete existing users
- * @param {Array<String>} userIds The ID of the users to be deleted
- * @param {String} authToken Authorization token
+ * @param {string[]} userIds The ID of the users to be deleted
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const deleteUsers = (userIds, authToken) => {
-  return new Promise(function (resolve, reject) {
+const deleteUsers = (userIds: string[], token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const deleteTokenRequest = client.delete(`api/v1/users/`, {
-      headers: { authorization: authToken },
+      headers: { authorization: token },
       data: {
         userIds: userIds,
       },
@@ -250,12 +259,13 @@ export const deleteUsers = (userIds, authToken) => {
 
 /**
  * Get all the API tokens
- * @param {String} authToken Authorization token
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const getAPITokens = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getAPITokens = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const getTokensRequest = client.get(`api/v1/users/getapitokens`, {
-      headers: { authorization: authToken },
+      headers: { authorization: token },
     });
     getTokensRequest
       .then((result) => {
@@ -269,11 +279,15 @@ export const getAPITokens = (authToken) => {
 
 /**
  * Get the specified user account by Id. It returns a promise
- * @param {String} id Id of the user for which information is being requested
+ * @param {string} id Id of the user for which information is being requested
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const getUserById = (id) => {
-  return new Promise(function (resolve, reject) {
-    const getUserInformationRequest = client.get(`api/v1/users/user/${id}`);
+const getUserById = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const getUserInformationRequest = client.get(`api/v1/users/user/${id}`, {
+      headers: { authorization: token },
+    });
     getUserInformationRequest
       .then((result) => {
         if (result != null) {
@@ -290,14 +304,15 @@ export const getUserById = (id) => {
 
 /**
  * Get user information
- * @param {String} userId User Id
- * @param {String} category User information category
- * @param {String} token Authorization token
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const getUserInformation = (userId, category, token) => {
-  return new Promise(function (resolve, reject) {
+const getUserInformation = (userId: string, category: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
-      `api/v1/users/user/${userId ? userId : 0}/${category ? category : "*"}`,
+      `api/v1/users/user/${userId || 0}/${category || "*"}`,
       {
         headers: { authorization: token },
       }
@@ -314,12 +329,13 @@ export const getUserInformation = (userId, category, token) => {
 
 /**
  * Get the list of users
- * @param {Object} filter Filter to select the users. Ex: {firstName : "John"}
- * @param {Array} fields Fields to be loaded. Ex: ["firstName"]
- * @param {String} token Authorization token
+ * @param {object} filter Filter to select the users. Ex: {firstName : "John"}
+ * @param {string[]} fields Fields to be loaded. Ex: ["firstName"]
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const getUsers = (filter, fields, token) => {
-  return new Promise(function (resolve, reject) {
+const getUsers = (filter: object, fields: string[], token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       filter: filter,
       fields: fields,
@@ -339,13 +355,14 @@ export const getUsers = (filter, fields, token) => {
 
 /**
  * Invite other users to join the same account
- * @param {Array<String>} invitees List of emails of the invitees
- * @param {String} groupId The group the user should be added to
- * @param {String} teamId The team the user should be added to
- * @param {String} token Authorization token
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} groupId The group the user should be added to
+ * @param {string} teamId The team the user should be added to
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
  */
-export const inviteUsers = (invitees, groupId, teamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const inviteUsers = (invitees: string[], groupId: string, teamId: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       invitees: invitees,
       groupId: groupId,
@@ -367,16 +384,15 @@ export const inviteUsers = (invitees, groupId, teamId, authToken) => {
 
 /**
  * Login using email and password. It returns a promise
- * @param {String} email User's email address
- * @param {String} password User's password
- * @param {boolean} rememberMe Set to true if the user wants his account to be saved on the current machine
+ * @param {string} email User's email address
+ * @param {string} password User's password
+ * @returns {Promise<object>}
  */
-export const login = (email, password, rememberMe) => {
-  return new Promise(function (resolve, reject) {
+const login = (email: string, password: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       email: email,
       password: password,
-      rememberMe: rememberMe,
     };
     let request = client.post("api/v1/auth/login", requestData);
     request
@@ -390,15 +406,44 @@ export const login = (email, password, rememberMe) => {
 };
 
 /**
- * Logout from the server. It returns a promise
- * @param {String} token Authorization token
+ * Login callback after authentication to exchange the code token for authentication and refresh tokens
+ * @param {string} code
+ * @param {string} codeVerifier
+ * @param {string} redirectUri
+ * @returns {Promise<object>}
  */
-export const logout = (token) => {
-  return new Promise(function (resolve, reject) {
-    const options = {
-      headers: { authorization: token },
+const loginExchangeKeys = (code: string, codeVerifier: string, redirectUri: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData = {
+      code: code,
+      codeVerifier: codeVerifier,
+      redirectUri: redirectUri,
     };
-    let request = client.post("api/v1/auth/logout", {}, options);
+    let request = client.post("api/v1/auth/loginexchangekeys", requestData);
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Logout from the server. It returns a promise
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const logout = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let request = client.post(
+      "api/v1/auth/logout",
+      {},
+      {
+        headers: { authorization: token },
+      }
+    );
     request
       .then((response) => {
         resolve(response.data);
@@ -412,12 +457,14 @@ export const logout = (token) => {
 /**
  * Checks the current auth token and maintain it alive. It returns a promise. In case the token is invalid
  * a new token can be restablished using login
- * @param {String} token  User's auth token to be refreshed
+ * @param {string} refreshToken User's auth token to be refreshed
+ * @returns {Promise<object>}
  */
-export const refreshToken = (token) => {
-  return new Promise(function (resolve, reject) {
-    let options = { headers: { Authorization: token } };
-    let request = client.post("api/v1/auth/refreshToken", {}, options);
+const refreshToken = (refreshToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let request = client.post("api/v1/auth/refreshToken", {
+      refreshToken: refreshToken,
+    });
     request
       .then((response) => {
         resolve(response.data);
@@ -430,11 +477,12 @@ export const refreshToken = (token) => {
 
 /**
  * Remove an existing API token
- * @param {String} id The ID of the token to be removed
- * @param {String} authToken Authorization token
+ * @param {string} id The ID of the token to be removed
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
  */
-export const removeAPIToken = (id, authToken) => {
-  return new Promise(function (resolve, reject) {
+const removeAPIToken = (id: string, authToken: string): Promise<string> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
     };
@@ -457,11 +505,12 @@ export const removeAPIToken = (id, authToken) => {
 
 /**
  * Resend invitation emails
- * @param {Array<String>} invitees List of emails of the invitees
- * @param {String} token Authorization token
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
  */
-export const resendInvitationEmails = (invitees, authToken) => {
-  return new Promise(function (resolve, reject) {
+const resendInvitationEmails = (invitees: string[], authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       invitees: invitees,
       token: authToken,
@@ -481,12 +530,13 @@ export const resendInvitationEmails = (invitees, authToken) => {
 
 /**
  * Reset the password. It returns a promise
- * @param {String} code Code provided to the user by email
- * @param {String} email User's email address
- * @param {String} password User's new password
+ * @param {string} code Code provided to the user by email
+ * @param {string} email User's email address
+ * @param {string} password User's new password
+ * @returns {Promise<object>}
  */
-export const resetPassword = (email, code, password) => {
-  return new Promise(function (resolve, reject) {
+const resetPassword = (email: string, code: string, password: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let postData = {
       email: email,
       code: code,
@@ -503,12 +553,41 @@ export const resetPassword = (email, code, password) => {
   });
 };
 
+/**
+ * Send email confirmation code
+ * @param {string} email
+ * @param {string} token
+ * @returns {Promise<object>}
+ */
+const sendEmailConfirmationCode = (email: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let postData = {
+      email: email,
+    };
+    let request = client.post(
+      "api/v1/users/sendemailconfirmationcode",
+      postData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
 /**
  * Send an email to the user indicated by the email address to reset the password. It returns a promise
- * @param {String} email Email of the user who needs to reset the password
+ * @param {string} email Email of the user who needs to reset the password
+ * @returns {Promise<object>}
  */
-export const sendPasswordResetNotification = (email) => {
-  return new Promise(function (resolve, reject) {
+const sendPasswordResetNotification = (email: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let postData = {
       email: email,
     };
@@ -528,13 +607,14 @@ export const sendPasswordResetNotification = (email) => {
 
 /**
  * Set user profile information
- * @param {String} userId User Id
- * @param {String} category User information category
- * @param {String} data New or updated user data information
- * @param {Object} token Authorization token
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {object} data New or updated user data information
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const setUserInformation = (userId, category, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setUserInformation = (userId: string, category: string, data: object, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: category ? { [category]: data } : data,
       userId: userId,
@@ -554,14 +634,22 @@ export const setUserInformation = (userId, category, data, token) => {
 
 /**
  * Update user email
- * @param {String} email The new email address
- * @param {String} password The current password
- * @param {String} token Authorization token
+ * @param {string} email The new email address
+ * @param {string} verificationCode The verification code
+ * @param {string} password The current password
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-export const updateUserEmail = (email, password, token) => {
-  return new Promise(function (resolve, reject) {
+const updateUserEmail = (
+  email: string,
+  verificationCode: string,
+  password: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       email: email,
+      verificationCode: verificationCode,
       password: password,
     };
     let confirmationRequest = client.post(
@@ -583,12 +671,17 @@ export const updateUserEmail = (email, password, token) => {
 
 /**
  * Update user groups
- * @param {String} userIds The id of the user
+ * @param {String} userId The id of the user
  * @param {Array<String>} groups The id of the groups the user should belong to
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const updateUserGroups = (userId, groups, token) => {
-  return new Promise(function (resolve, reject) {
+const updateUserGroups = (
+  userId: string,
+  groups: string[],
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       userId: userId,
       groups: groups || [],
@@ -615,9 +708,14 @@ export const updateUserGroups = (userId, groups, token) => {
  * @param {String} password The current password
  * @param {String} newPassword The new password
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const updateUserPassword = (password, newPassword, token) => {
-  return new Promise(function (resolve, reject) {
+const updateUserPassword = (
+  password: string,
+  newPassword: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       password: password,
       newPassword: newPassword,
@@ -643,17 +741,18 @@ export const updateUserPassword = (password, newPassword, token) => {
  * Validate reset password code. It returns a promise
  * @param {String} email User's email address
  * @param {String} code Provided reset code
+ * @returns {Promise<Object>}
  */
-export const validateResetPasswordCode = (email, code) => {
-  return new Promise(function (resolve, reject) {
+const validateResetPasswordCode = (
+  email: string,
+  code: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let postData = {
       email: email,
       code: code,
     };
-    let request = client.post(
-      "api/v1/users/validateresetpasswordcode",
-      postData
-    );
+    let request = client.post("api/v1/users/validateresetpasswordcode", postData);
     request
       .then((response) => {
         resolve(response.data);
@@ -664,7 +763,7 @@ export const validateResetPasswordCode = (email, code) => {
   });
 };
 
-const users = {
+export default {
   addAPIToken,
   confirmEmailAddress,
   confirmPhone,
@@ -679,17 +778,17 @@ const users = {
   getUsers,
   inviteUsers,
   login,
+  loginExchangeKeys,
   logout,
   refreshToken,
   removeAPIToken,
   resendInvitationEmails,
   resetPassword,
+  sendEmailConfirmationCode,
   sendPasswordResetNotification,
   setUserInformation,
   updateUserEmail,
   updateUserGroups,
   updateUserPassword,
   validateResetPasswordCode,
-};
-
-export default users;
+};