@stackfactor/client-api 1.1.128 → 1.1.129

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

@@ -3,12 +3,13 @@ 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} token Authorization token
- * @returns {Promise}
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const addAPIToken = (name, expiration, token) => {
-  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,
@@ -36,11 +37,11 @@ const addAPIToken = (name, expiration, token) => {
 
 /**
  * Confirm email address
- * @param {String} validationCode The code was provided to the user in advance by email
- * @returns {Promise}
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @returns {Promise<void>}
  */
-const confirmEmailAddress = (validationCode) => {
-  return new Promise(function (resolve, reject) {
+const confirmEmailAddress = (validationCode: string): Promise<void> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       validationCode: validationCode,
     };
@@ -60,12 +61,12 @@ const confirmEmailAddress = (validationCode) => {
 
 /**
  * Confirm phone number
- * @param {String} validationCode The code was provided to the user in advance by email
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const confirmPhone = (validationCode, token) => {
-  return new Promise(function (resolve, reject) {
+const confirmPhone = (validationCode: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       validationCode: validationCode,
     };
@@ -88,12 +89,12 @@ const confirmPhone = (validationCode, token) => {
 
 /**
  * Generate confirmation code
- * @param {String} phoneNumber Send confirmation code to the phone number
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string} phoneNumber Send confirmation code to the phone number
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const confirmPhoneGenerateCode = (phoneNumber, token) => {
-  return new Promise(function (resolve, reject) {
+const confirmPhoneGenerateCode = (phoneNumber: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       phoneNumber: phoneNumber,
     };
@@ -116,23 +117,23 @@ const confirmPhoneGenerateCode = (phoneNumber, token) => {
 
 /**
  * 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
- * @returns {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
+ * @returns {Promise<object>}
  */
 const createAccount = (
-  email,
-  firstName,
-  lastName,
-  password,
-  subSite,
-  inviteCode
-) => {
-  return new Promise(function (resolve, reject) {
+  email: string,
+  firstName: string,
+  lastName: string,
+  password: string,
+  subSite: string,
+  inviteCode: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     if (
       email.trim() === "" ||
       firstName.trim() === "" ||
@@ -165,15 +166,21 @@ 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
- * @returns {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
+ * @returns {Promise<object>}
  */
-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,15 +211,14 @@ const createUserAccount = (email, firstName, lastName, password, token) => {
 
 /**
  * Delete an existing API token
- * @param {String} token Expiration date of the token
- * @param {String} authToken Authorization token
- * @returns {Promise}
+ * @param {string} token Expiration date of the token
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
  */
-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: {
         token: token,
       },
@@ -229,15 +235,14 @@ const deleteAPIToken = (token, authToken) => {
 
 /**
  * Delete existing users
- * @param {Array<String>} userIds The ID of the users to be deleted
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string[]} userIds The ID of the users to be deleted
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const deleteUsers = (userIds, token) => {
-  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: token },
-
       data: {
         userIds: userIds,
       },
@@ -254,11 +259,11 @@ const deleteUsers = (userIds, token) => {
 
 /**
  * Get all the API tokens
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const getAPITokens = (token) => {
-  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: token },
     });
@@ -274,12 +279,12 @@ const getAPITokens = (token) => {
 
 /**
  * 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} token Authorization token
- * @returns {Promise}
+ * @param {string} id Id of the user for which information is being requested
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const getUserById = (id, token) => {
-  return new Promise(function (resolve, reject) {
+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 },
     });
@@ -299,13 +304,13 @@ const getUserById = (id, token) => {
 
 /**
  * Get user information
- * @param {String} userId User Id
- * @param {String} category User information category
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-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 || 0}/${category || "*"}`,
       {
@@ -324,13 +329,13 @@ 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
- * @returns {Promise}
+ * @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>}
  */
-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,
@@ -350,14 +355,14 @@ 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
- * @returns {Promise}
+ * @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>}
  */
-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,
@@ -379,12 +384,12 @@ 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
- * @returns {Promise}
+ * @param {string} email User's email address
+ * @param {string} password User's password
+ * @returns {Promise<object>}
  */
-const login = (email, password) => {
-  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,
@@ -402,13 +407,13 @@ const login = (email, password) => {
 
 /**
  * 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}
+ * @param {string} code
+ * @param {string} codeVerifier
+ * @param {string} redirectUri
+ * @returns {Promise<object>}
  */
-const loginExchangeKeys = (code, codeVerifier, redirectUri) => {
-  return new Promise(function (resolve, reject) {
+const loginExchangeKeys = (code: string, codeVerifier: string, redirectUri: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       code: code,
       codeVerifier: codeVerifier,
@@ -427,11 +432,11 @@ const loginExchangeKeys = (code, codeVerifier, redirectUri) => {
 
 /**
  * Logout from the server. It returns a promise
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
  */
-const logout = (token) => {
-  return new Promise(function (resolve, reject) {
+const logout = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let request = client.post(
       "api/v1/auth/logout",
       {},
@@ -452,11 +457,11 @@ 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
- * @returns {Promise}
+ * @param {string} refreshToken User's auth token to be refreshed
+ * @returns {Promise<object>}
  */
-const refreshToken = (refreshToken) => {
-  return new Promise(function (resolve, reject) {
+const refreshToken = (refreshToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let request = client.post("api/v1/auth/refreshToken", {
       refreshToken: refreshToken,
     });
@@ -472,12 +477,12 @@ const refreshToken = (refreshToken) => {
 
 /**
  * Remove an existing API token
- * @param {String} id The ID of the token to be removed
- * @param {String} authToken Authorization token
- * @returns {Promise}
+ * @param {string} id The ID of the token to be removed
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
  */
-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,
     };
@@ -500,12 +505,12 @@ const removeAPIToken = (id, authToken) => {
 
 /**
  * Resend invitation emails
- * @param {Array<String>} invitees List of emails of the invitees
- * @param {String} token Authorization token
- * @returns {Promise}
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
  */
-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,
@@ -525,13 +530,13 @@ 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
- * @returns {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
+ * @returns {Promise<object>}
  */
-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,
@@ -550,12 +555,12 @@ const resetPassword = (email, code, password) => {
 
 /**
  * Send email confirmation code
- * @param {String} email
- * @param {String} token
- * @returns
+ * @param {string} email
+ * @param {string} token
+ * @returns {Promise<object>}
  */
-const sendEmailConfirmationCode = (email, token) => {
-  return new Promise(function (resolve, reject) {
+const sendEmailConfirmationCode = (email: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let postData = {
       email: email,
     };
@@ -578,11 +583,11 @@ const sendEmailConfirmationCode = (email, token) => {
 
 /**
  * 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
- * @returns {Promise}
+ * @param {string} email Email of the user who needs to reset the password
+ * @returns {Promise<object>}
  */
-const sendPasswordResetNotification = (email) => {
-  return new Promise(function (resolve, reject) {
+const sendPasswordResetNotification = (email: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let postData = {
       email: email,
     };
@@ -602,14 +607,14 @@ 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
- * @returns {Promise}
+ * @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>}
  */
-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,
@@ -629,14 +634,19 @@ const setUserInformation = (userId, category, data, token) => {
 
 /**
  * Update user email
- * @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}
+ * @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>}
  */
-const updateUserEmail = (email, verificationCode, 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,
@@ -661,13 +671,17 @@ const updateUserEmail = (email, verificationCode, 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}
+ * @returns {Promise<Object>}
  */
-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 || [],
@@ -694,10 +708,14 @@ const updateUserGroups = (userId, groups, token) => {
  * @param {String} password The current password
  * @param {String} newPassword The new password
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-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,
@@ -723,18 +741,18 @@ 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}
+ * @returns {Promise<Object>}
  */
-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);
@@ -773,4 +791,4 @@ export default {
   updateUserGroups,
   updateUserPassword,
   validateResetPasswordCode,
-};
+};

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

@@ -8,9 +8,9 @@
  * @param {Object} data
  * @returns {Array}
  */
-const objectToArray = (data) => {
+const objectToArray = (data: object): any[] => {
   if (typeof data === "object") {
-    return [...data];
+    return [...Object.values(data)];
   } else throw new Error("Invalid type");
 };
 
@@ -18,7 +18,7 @@ const objectToArray = (data) => {
  * Returns the backend base API URL
  * @returns {String}
  */
-const getBaseUrl = () => {
+const getBaseUrl = (): string => {
   if (process.env.REACT_APP_BACKEND_URL) {
     return process.env.REACT_APP_BACKEND_URL;
   } else {
@@ -46,12 +46,12 @@ const getBaseUrl = () => {
  * @param {Object} object
  * @returns {Object}
  */
-const removeNullProperties = (object) => {
+const removeNullProperties = (object: { [key: string]: any }): object => {
   Object.keys(object).forEach((key) => {
-    let value = object[key.toString()];
+    let value = object[key];
     let hasProperties = value && Object.keys(value).length > 0;
     if (value === null) {
-      delete object[key.toString()];
+      delete object[key];
     } else if (typeof value !== "string" && hasProperties) {
       removeNullProperties(value);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.1.128",
+  "version": "1.1.129",
   "description": "Node.js library for the StackFactor API",
   "main": "index.js",
   "exports": {
@@ -33,6 +33,8 @@
     "node-html-parser": "^6.1.5"
   },
   "devDependencies": {
+    "@types/axios": "^0.14.4",
+    "@types/node": "^22.13.5",
     "eslint": "^8.57.0",
     "eslint-plugin-react": "^7.34.0"
   }