@stackfactor/client-api 1.1.134 → 1.1.135

package/src/lib/userInformation.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
@@ -6,7 +7,7 @@ import { client } from "./axiosClient";
  * @param {String} property
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addEntryToArrayBusinessProperty = (
   userId: string,
@@ -18,7 +19,7 @@ const addEntryToArrayBusinessProperty = (
     const requestData = {
       data: data,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/user/arrayproperty/${userId}/${property}`,
       requestData,
       {
@@ -26,10 +27,10 @@ const addEntryToArrayBusinessProperty = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -41,7 +42,7 @@ const addEntryToArrayBusinessProperty = (
  * @param {String} property
  * @param {String} id
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const removeEntryFromArrayBusinessProperty = (
   userId: string,
@@ -57,10 +58,10 @@ const removeEntryFromArrayBusinessProperty = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -73,7 +74,7 @@ const removeEntryFromArrayBusinessProperty = (
  * @param {String} id
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const updateEntryfromArrayBusinessProperty = (
   userId: string,
@@ -86,7 +87,7 @@ const updateEntryfromArrayBusinessProperty = (
     const requestData = {
       data: data,
     };
-    let confirmationRequest = client.patch(
+    const confirmationRequest = client.patch(
       `api/v1/user/arrayproperty/${userId}/${property}/${id}`,
       requestData,
       {
@@ -94,10 +95,10 @@ const updateEntryfromArrayBusinessProperty = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/users.ts

@@ -1,4 +1,4 @@
-/* eslint-disable no-undef */
+import { AxiosResponse, AxiosError } from "axios";
 import { client } from "./axiosClient";
 
 /**
@@ -29,7 +29,7 @@ const addAPIToken = (name: string, expiration: Date, token: string): Promise<obj
           reject(process.env.ERROR_INVALID_INFORMATION);
         }
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -53,7 +53,7 @@ const confirmEmailAddress = (validationCode: string): Promise<void> => {
       .then(() => {
         resolve();
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -78,10 +78,10 @@ const confirmPhone = (validationCode: string, token: string): Promise<object> =>
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -106,10 +106,10 @@ const confirmPhoneGenerateCode = (phoneNumber: string, token: string): Promise<o
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -152,12 +152,12 @@ const createAccount = (
         password: password,
         subSite: subSite,
       };
-      let request = client.post("api/v1/users/createAccount", signupData);
+      const request = client.post("api/v1/users/createAccount", signupData);
       request
         .then((result) => {
           resolve(result.data.user);
         })
-        .catch((error) => {
+        .catch((error : AxiosError) => {
           reject(error);
         });
     }
@@ -197,12 +197,12 @@ const createUserAccount = (
         password: password,
         token: token,
       };
-      let request = client.post("api/v1/users/createUser", signupData);
+      const request = client.post("api/v1/users/createUser", signupData);
       request
         .then((result) => {
           resolve(result.data.user);
         })
-        .catch((error) => {
+        .catch((error : AxiosError) => {
           reject(error);
         });
     }
@@ -227,7 +227,7 @@ const deleteAPIToken = (token: string, authToken: string): Promise<string> => {
       .then(() => {
         resolve(token);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -248,10 +248,10 @@ const deleteUsers = (userIds: string[], token: string): Promise<object> => {
       },
     });
     deleteTokenRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -271,7 +271,7 @@ const getAPITokens = (token: string): Promise<object> => {
       .then((result) => {
         resolve(result.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -296,7 +296,7 @@ const getUserById = (id: string, token: string): Promise<object> => {
           reject(process.env.ERROR_INVALID_INFORMATION);
         }
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -311,17 +311,17 @@ const getUserById = (id: string, token: string): Promise<object> => {
  */
 const getUserInformation = (userId: string, category: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/users/user/${userId || 0}/${category || "*"}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -340,14 +340,14 @@ const getUsers = (filter: object, fields: string[], token: string): Promise<obje
       filter: filter,
       fields: fields,
     };
-    let confirmationRequest = client.post(`api/v1/users/`, requestData, {
+    const confirmationRequest = client.post(`api/v1/users/`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -369,14 +369,14 @@ const inviteUsers = (invitees: string[], groupId: string, teamId: string, authTo
       teamId: teamId,
       token: authToken,
     };
-    let request = client.post("api/v1/users/invite", requestData, {
+    const request = client.post("api/v1/users/invite", requestData, {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -394,12 +394,12 @@ const login = (email: string, password: string): Promise<object> => {
       email: email,
       password: password,
     };
-    let request = client.post("api/v1/auth/login", requestData);
+    const request = client.post("api/v1/auth/login", requestData);
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -419,12 +419,12 @@ const loginExchangeKeys = (code: string, codeVerifier: string, redirectUri: stri
       codeVerifier: codeVerifier,
       redirectUri: redirectUri,
     };
-    let request = client.post("api/v1/auth/loginexchangekeys", requestData);
+    const request = client.post("api/v1/auth/loginexchangekeys", requestData);
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -437,7 +437,7 @@ const loginExchangeKeys = (code: string, codeVerifier: string, redirectUri: stri
  */
 const logout = (token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let request = client.post(
+    const request = client.post(
       "api/v1/auth/logout",
       {},
       {
@@ -445,10 +445,10 @@ const logout = (token: string): Promise<object> => {
       }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -462,14 +462,14 @@ const logout = (token: string): Promise<object> => {
  */
 const refreshToken = (refreshToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let request = client.post("api/v1/auth/refreshToken", {
+    const request = client.post("api/v1/auth/refreshToken", {
       refreshToken: refreshToken,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -497,7 +497,7 @@ const removeAPIToken = (id: string, authToken: string): Promise<string> => {
       .then(() => {
         resolve(id);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -515,14 +515,14 @@ const resendInvitationEmails = (invitees: string[], authToken: string): Promise<
       invitees: invitees,
       token: authToken,
     };
-    let request = client.post("api/v1/users/resendinvite", requestData, {
+    const request = client.post("api/v1/users/resendinvite", requestData, {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -537,17 +537,17 @@ const resendInvitationEmails = (invitees: string[], authToken: string): Promise<
  */
 const resetPassword = (email: string, code: string, password: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let postData = {
+    const postData = {
       email: email,
       code: code,
       password: password,
     };
-    let request = client.post("api/v1/users/resetpassword", postData);
+    const request = client.post("api/v1/users/resetpassword", postData);
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -561,10 +561,10 @@ const resetPassword = (email: string, code: string, password: string): Promise<o
  */
 const sendEmailConfirmationCode = (email: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let postData = {
+    const postData = {
       email: email,
     };
-    let request = client.post(
+    const request = client.post(
       "api/v1/users/sendemailconfirmationcode",
       postData,
       {
@@ -572,10 +572,10 @@ const sendEmailConfirmationCode = (email: string, token: string): Promise<object
       }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -588,18 +588,18 @@ const sendEmailConfirmationCode = (email: string, token: string): Promise<object
  */
 const sendPasswordResetNotification = (email: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let postData = {
+    const postData = {
       email: email,
     };
-    let request = client.post(
+    const request = client.post(
       "api/v1/users/sendpasswordresetnotification",
       postData
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -619,14 +619,14 @@ const setUserInformation = (userId: string, category: string, data: object, toke
       data: category ? { [category]: data } : data,
       userId: userId,
     };
-    let confirmationRequest = client.post("api/v1/users/user", requestData, {
+    const confirmationRequest = client.post("api/v1/users/user", requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response: AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error: AxiosError) => {
         reject(error);
       });
   });
@@ -652,7 +652,7 @@ const updateUserEmail = (
       verificationCode: verificationCode,
       password: password,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "api/v1/users/updateemail",
       requestData,
       {
@@ -660,10 +660,10 @@ const updateUserEmail = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -674,7 +674,7 @@ const updateUserEmail = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const updateUserGroups = (
   userId: string,
@@ -686,7 +686,7 @@ const updateUserGroups = (
       userId: userId,
       groups: groups || [],
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "api/v1/users/user/updategroups",
       requestData,
       {
@@ -697,7 +697,7 @@ const updateUserGroups = (
       .then(() => {
         resolve(requestData);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -708,7 +708,7 @@ const updateUserGroups = (
  * @param {String} password The current password
  * @param {String} newPassword The new password
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const updateUserPassword = (
   password: string,
@@ -720,7 +720,7 @@ const updateUserPassword = (
       password: password,
       newPassword: newPassword,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "api/v1/users/updatepassword",
       requestData,
       {
@@ -728,10 +728,10 @@ const updateUserPassword = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -741,23 +741,23 @@ const updateUserPassword = (
  * Validate reset password code. It returns a promise
  * @param {String} email User's email address
  * @param {String} code Provided reset code
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const validateResetPasswordCode = (
   email: string,
   code: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let postData = {
+    const postData = {
       email: email,
       code: code,
     };
-    let request = client.post("api/v1/users/validateresetpasswordcode", postData);
+    const request = client.post("api/v1/users/validateresetpasswordcode", postData);
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/utils.ts

@@ -1,18 +1,8 @@
-/* eslint-disable no-undef */
-//import dotenv from "dotenv";
+import dotenv from "dotenv";
 // Load environment variables from .env file
-//dotenv.config();
+dotenv.config();
+
 
-/**
- * Convert object to array
- * @param {Object} data
- * @returns {Array}
- */
-const objectToArray = (data: object): any[] => {
-  if (typeof data === "object") {
-    return [...Object.values(data)];
-  } else throw new Error("Invalid type");
-};
 
 /**
  * Returns the backend base API URL
@@ -46,10 +36,11 @@ const getBaseUrl = (): string => {
  * @param {Object} object
  * @returns {Object}
  */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 const removeNullProperties = (object: { [key: string]: any }): object => {
   Object.keys(object).forEach((key) => {
-    let value = object[key];
-    let hasProperties = value && Object.keys(value).length > 0;
+    const value = object[key];
+    const hasProperties = value && Object.keys(value).length > 0;
     if (value === null) {
       delete object[key];
     } else if (typeof value !== "string" && hasProperties) {
@@ -59,6 +50,6 @@ const removeNullProperties = (object: { [key: string]: any }): object => {
   return object;
 };
 
-const utils = { getBaseUrl, objectToArray, removeNullProperties };
+const utils = { getBaseUrl, removeNullProperties };
 
 export default utils;

package/tsconfig.json

@@ -1,12 +1,23 @@
 {
   "compilerOptions": {
-    "target": "ES6",
-    "module": "commonjs",
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Node",
     "strict": true,
+    "declaration": true,
+    "declarationMap": true,
+    "forceConsistentCasingInFileNames": true,
+    "sourceMap": true,
+    "outDir": "dist",
     "esModuleInterop": true,
     "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "outDir": "./dist"
+    "resolveJsonModule": true,
+    "typeRoots": [
+      "./node_modules/@types/axios",
+      "./node_modules/@types/node",
+      "./declarations"
+    ]
   },
-  "include": ["src/**/*", "index.d.ts"]
+  "include": ["src", "index.d.ts"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }