@stackfactor/client-api 1.1.134 → 1.1.135

package/src/lib/aiAssistant.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 interface AskQuestionData {
@@ -25,7 +26,7 @@ interface StartConversationData {
  * @param {String} question
  * @param {String} updatedContext
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const askQuestion = (
   conversationId: string,
@@ -34,12 +35,12 @@ const askQuestion = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: AskQuestionData = {
+    const data: AskQuestionData = {
       conversationId: conversationId,
       question: question,
       updatedContext: updatedContext,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "/api/v1/aiassistant/askquestion",
       data,
       {
@@ -47,10 +48,10 @@ const askQuestion = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -60,17 +61,17 @@ const askQuestion = (
  * End conversation with the AI
  * @param {String} conversationId
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const endConversation = (
   conversationId: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: EndConversationData = {
+    const data: EndConversationData = {
       conversationId: conversationId,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "/api/v1/aiassistant/endconversation",
       data,
       {
@@ -78,10 +79,10 @@ const endConversation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -91,24 +92,24 @@ const endConversation = (
  * Get conversation by elementId
  * @param {String} elementId
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getConversationByElementId = (
   elementId: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `/api/v1/aiassistant/getconversation/${elementId}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -118,24 +119,24 @@ const getConversationByElementId = (
  * Get the voice assistant URL
  * @param {String} language
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getVoiceAssistantUrl = (
   language: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `/api/v1/aiassistant/getvoiceassistanturl/${language}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -149,7 +150,7 @@ const getVoiceAssistantUrl = (
  * @param {Boolean} autoContextRefresh
  * @param {String} token
  * @param {String} conversationId Optional
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const startConversation = (
   elementId: string,
@@ -161,7 +162,7 @@ const startConversation = (
   conversationId: string | null = null
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: StartConversationData = {
+    const data: StartConversationData = {
       autoContextRefresh: autoContextRefresh,
       context: context,
       question: question,
@@ -171,7 +172,7 @@ const startConversation = (
     if (conversationId) {
       data.conversationId = conversationId;
     }
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "/api/v1/aiassistant/startconversation",
       data,
       {
@@ -179,10 +180,10 @@ const startConversation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/avatar.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
@@ -17,7 +18,7 @@ const getAvatar = (
   token: string
 ): Promise<Blob> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `/api/v1/avatar/getavatar/${elementId}/${type}/${width}/${height}`,
       {
         headers: {
@@ -27,7 +28,7 @@ const getAvatar = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
       .catch(() => {

package/src/lib/axiosClient.ts

@@ -1,7 +1,19 @@
-import axios, { AxiosError } from "axios";
+import axios, { AxiosError, AxiosResponse } from "axios";
 import { RESPONSE_TYPE } from "./constants";
 import utils from "./utils";
 
+interface ErrorResponse {
+  msg: string;
+  param: string;
+  value: string;
+  toString: () => string;
+}
+
+interface CustomAxiosResponse extends AxiosResponse {
+  errors?: ErrorResponse[];
+  toString: () => string;
+}
+
 const baseUrl = utils.getBaseUrl();
 
 const client = axios.create({
@@ -18,21 +30,22 @@ const errorToString = (error: AxiosError): string => {
   if (error != null) {
     if (error.response?.data) {
       let asString = "";
-      if (Array.isArray((error.response.data as any).errors)) {
-        (error.response.data as any).errors.forEach(
-          (item: any, index: number) => {
+      const responseData = error.response.data as CustomAxiosResponse;
+      if (Array.isArray(responseData.errors)) {
+        responseData.errors.forEach(
+          (item: ErrorResponse, index: number) => {
             asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
               item.param
             } ${item.value ? `value ${item.value.toString()}` : ""}`;
           }
         );
         return asString;
-      } else if ((error.response.data as any).error) {
-        return (error.response.data as any).error.toString();
+      } else if (responseData.errors) {
+        return JSON.stringify(responseData.errors);
       } else if (error.response.statusText) {
         return error.response.statusText.toString();
       } else {
-        return (error.response.data as any).toString();
+        return responseData.toString();
       }
     } else {
       return error.message ? error.message : "Unknown error";

package/src/lib/config.ts

@@ -1,10 +1,11 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
  * Get the specified configuration by Id. It returns a promise
  * @param {String} id - the id of the configuration element
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getConfigurationById = (
   id: string,
@@ -16,10 +17,10 @@ const getConfigurationById = (
       { headers: { authorization: authToken } }
     );
     getConfigInformationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -29,7 +30,7 @@ const getConfigurationById = (
  * Get the specified configuration by type. It returns a promise
  * @param {String} type - the id of the configuration element
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getConfigurationByType = (
   type: string,
@@ -41,10 +42,10 @@ const getConfigurationByType = (
       { headers: { authorization: authToken } }
     );
     getConfigInformationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -55,7 +56,7 @@ const getConfigurationByType = (
  * @param {String} id - the id of the configuration element
  * @param {Object} data - the object containing the updated configuration element
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setConfigurationById = (
   id: string,
@@ -69,10 +70,10 @@ const setConfigurationById = (
       { headers: { authorization: authToken } }
     );
     getConfigInformationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/dashboard.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
@@ -6,7 +7,7 @@ import { client } from "./axiosClient";
  * @param {Number} position - The position on the dashboard
  * @param {Object} data - The card settings data
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addCardToDashboard = (
   id: string,
@@ -25,10 +26,10 @@ const addCardToDashboard = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -37,7 +38,7 @@ const addCardToDashboard = (
 /**
  * Get the list of the cards from the dashboard
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getDashboardCardsList = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -45,10 +46,10 @@ const getDashboardCardsList = (authToken: string): Promise<object> => {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -58,7 +59,7 @@ const getDashboardCardsList = (authToken: string): Promise<object> => {
  * Remove a card from the dashboard
  * @param {String} id - the id of the configuration element
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const removeCardFromDashboard = (
   id: string,
@@ -72,10 +73,10 @@ const removeCardFromDashboard = (
       },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/departmentTrainingPlans.ts

@@ -1,11 +1,8 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 interface Activity {
-  // Define the structure of an activity object here
-}
-
-interface Filter {
-  // Define the structure of a filter object here
+  _id: string;
 }
 
 /**
@@ -15,13 +12,13 @@ interface Filter {
  * @param {String} skill
  * @param {Array<Activity>} activities
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createDepartmentTrainingPlan = (
   name: string,
   summary: string,
   skill: string,
-  activities: Activity[],
+  activities: Array<Activity>,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -31,7 +28,7 @@ const createDepartmentTrainingPlan = (
       skill: skill || "",
       activities: activities || [],
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/departmentTrainingPlans",
       requestData,
       {
@@ -39,10 +36,10 @@ const createDepartmentTrainingPlan = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -52,7 +49,7 @@ const createDepartmentTrainingPlan = (
  * Delete department training plan
  * @param {String} id The id of the template to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const deleteDepartmentTrainingPlan = (
   id: string,
@@ -66,10 +63,10 @@ const deleteDepartmentTrainingPlan = (
       },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -80,7 +77,7 @@ const deleteDepartmentTrainingPlan = (
  * @param {Number} id The id of the plan
  * @param {String} version The version of the plan
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getDepartmentTrainingPlanInformationById = (
   id: number,
@@ -88,17 +85,17 @@ const getDepartmentTrainingPlanInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/departmenttrainingplans/${id}/${version}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -106,13 +103,13 @@ const getDepartmentTrainingPlanInformationById = (
 
 /**
  * Get department training plan list
- * @param {Filter} filter The filter used to select the plan
+ * @param {String} filter The filter used to select the plan
  * @param {String} version The version of the plan
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getDepartmentTrainingPlanList = (
-  filter: Filter,
+  filter: string,
   version: string,
   token: string
 ): Promise<object> => {
@@ -121,7 +118,7 @@ const getDepartmentTrainingPlanList = (
       filter: filter || "",
       version: version,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/departmenttrainingplans`,
       requestData,
       {
@@ -129,10 +126,10 @@ const getDepartmentTrainingPlanList = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -142,14 +139,14 @@ const getDepartmentTrainingPlanList = (
  * Publish department training plan
  * @param {number} id The id of the plan to be published
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const publishDepartmentTrainingPlan = (
   id: number,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/departmenttrainingplans/publish/${id}`,
       {},
       {
@@ -157,10 +154,10 @@ const publishDepartmentTrainingPlan = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -171,7 +168,7 @@ const publishDepartmentTrainingPlan = (
  * @param {String} id The id of the plan to be updated
  * @param {Object} data Data used to update the plan
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setDepartmentTrainingPlanInformation = (
   id: string,
@@ -182,7 +179,7 @@ const setDepartmentTrainingPlanInformation = (
     const requestData = {
       data: data,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/departmenttrainingplans/${id}`,
       requestData,
       {
@@ -190,10 +187,10 @@ const setDepartmentTrainingPlanInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });