@stackfactor/client-api 1.1.128 → 1.1.129

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

@@ -3,9 +3,10 @@ import { client } from "./axiosClient.js";
 /**
  * Get all permissions
  * @param {String} token The authentication token
+ * @returns {Promise<Object>}
  */
-const getAllUserNotifications = (token) => {
-  return new Promise(function (resolve, reject) {
+const getAllUserNotifications = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/actionnotifications`, {
       headers: { authorization: token },
     });
@@ -24,9 +25,14 @@ const getAllUserNotifications = (token) => {
  * @param {Array<String>} ids The id of the notifications to be marked
  * @param {String} status The new status
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const markNotifications = (ids, status, authToken) => {
-  return new Promise(function (resolve, reject) {
+const markNotifications = (
+  ids: string[],
+  status: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.put(
       `api/v1/actionnotifications/mark`,
       {
@@ -51,9 +57,15 @@ const markNotifications = (ids, status, authToken) => {
  * @param {String} action The action to be executed
  * @param {String} comments The comments to be saved in the notification
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const processNotification = (id, action, comments, authToken) => {
-  return new Promise(function (resolve, reject) {
+const processNotification = (
+  id: string,
+  action: string,
+  comments: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.put(
       `api/v1/actionnotifications/process`,
       {

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

@@ -4,9 +4,10 @@ import { client } from "./axiosClient.js";
  * Validate Address
  * @param {String} input - the address in raw format
  * @param {String} authToken - Authorization token
+ * @returns {Promise<Object>}
  */
-const autoComplete = (input, authToken) => {
-  return new Promise(function (resolve, reject) {
+const autoComplete = (input: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const getAddressesRequest = client.post(
       `api/v1/address/autocomplete/`,
       { input: input },

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

@@ -1,16 +1,40 @@
 import { client } from "./axiosClient.js";
 
+interface AskQuestionData {
+  conversationId: string;
+  question: string;
+  updatedContext: string;
+}
+
+interface EndConversationData {
+  conversationId: string;
+}
+
+interface StartConversationData {
+  autoContextRefresh: boolean;
+  context: string;
+  question: string;
+  elementId: string;
+  elementType: string;
+  conversationId?: string | null;
+}
+
 /**
  * Ask Question to the AI
  * @param {String} conversationId
  * @param {String} question
  * @param {String} updatedContext
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const askQuestion = (conversationId, question, updatedContext, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {
+const askQuestion = (
+  conversationId: string,
+  question: string,
+  updatedContext: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: AskQuestionData = {
       conversationId: conversationId,
       question: question,
       updatedContext: updatedContext,
@@ -36,11 +60,14 @@ const askQuestion = (conversationId, question, updatedContext, token) => {
  * End conversation with the AI
  * @param {String} conversationId
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const endConversation = (conversationId, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {
+const endConversation = (
+  conversationId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: EndConversationData = {
       conversationId: conversationId,
     };
     let confirmationRequest = client.post(
@@ -64,10 +91,13 @@ const endConversation = (conversationId, token) => {
  * Get conversation by elementId
  * @param {String} elementId
  * @param {String} token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const getConversationByElementId = (elementId, token) => {
-  return new Promise(function (resolve, reject) {
+const getConversationByElementId = (
+  elementId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `/api/v1/aiassistant/getconversation/${elementId}`,
       {
@@ -88,10 +118,13 @@ const getConversationByElementId = (elementId, token) => {
  * Get the voice assistant URL
  * @param {String} language
  * @param {String} token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const getVoiceAssistantUrl = (language, token) => {
-  return new Promise(function (resolve, reject) {
+const getVoiceAssistantUrl = (
+  language: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `/api/v1/aiassistant/getvoiceassistanturl/${language}`,
       {
@@ -116,19 +149,19 @@ const getVoiceAssistantUrl = (language, token) => {
  * @param {Boolean} autoContextRefresh
  * @param {String} token
  * @param {String} conversationId Optional
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
 const startConversation = (
-  elementId,
-  elementType,
-  question,
-  context,
-  autoContextRefresh,
-  token,
-  conversationId = null
-) => {
-  return new Promise(function (resolve, reject) {
-    let data = {
+  elementId: string,
+  elementType: string,
+  question: string,
+  context: string,
+  autoContextRefresh: boolean,
+  token: string,
+  conversationId: string | null = null
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: StartConversationData = {
       autoContextRefresh: autoContextRefresh,
       context: context,
       question: question,

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

@@ -7,10 +7,16 @@ import { client } from "./axiosClient.js";
  * @param {Number} width
  * @param {Number} height
  * @param {String} token
- * @returns {Promise}
+ * @returns {Promise<Blob>}
  */
-const getAvatar = (elementId, type, width, height, token) => {
-  return new Promise(function (resolve, reject) {
+const getAvatar = (
+  elementId: string,
+  type: string,
+  width: number,
+  height: number,
+  token: string
+): Promise<Blob> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `/api/v1/avatar/getavatar/${elementId}/${type}/${width}/${height}`,
       {
@@ -22,7 +28,7 @@ const getAvatar = (elementId, type, width, height, token) => {
     );
     confirmationRequest
       .then((response) => {
-        resolve(response);
+        resolve(response.data);
       })
       .catch(() => {
         reject("Error getting avatar");

package/lib/axiosClient.ts

@@ -0,0 +1,92 @@
+import axios, { AxiosError } from "axios";
+import { RESPONSE_TYPE } from "./constants.js";
+import utils from "./utils.js";
+
+const baseUrl = utils.getBaseUrl();
+
+const client = axios.create({
+  baseURL: baseUrl,
+  withCredentials: true,
+});
+
+/**
+ * Returns the error as a string
+ * @param {AxiosError} error
+ * @returns {string}
+ */
+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) => {
+            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 (error.response.statusText) {
+        return error.response.statusText.toString();
+      } else {
+        return (error.response.data as any).toString();
+      }
+    } else {
+      return error.message ? error.message : "Unknown error";
+    }
+  }
+  return "Unknown error";
+};
+
+/**
+ * Returns the code of the error as a number
+ * @param {AxiosError} error
+ * @returns {number} The error code
+ */
+const getErrorType = (error: AxiosError): number => {
+  if (error.response?.status) {
+    return error.response.status;
+  } else return RESPONSE_TYPE.SERVICE_UNAVAILABLE;
+};
+
+/**
+ * Return the error information to include just the status and the message
+ * @param {AxiosError} error
+ * @returns {Object}
+ */
+const getErrorInformation = (
+  error: AxiosError
+): { status: number; message: string } => {
+  return {
+    status: getErrorType(error),
+    message: errorToString(error),
+  };
+};
+
+/**
+ * Returns true if an exception should be handled to the business and presentation layer
+ * @param {boolean} returnAllExceptions - If set true all exceptions will be passed
+ * @param {AxiosError} error - The error returned by the server
+ * @returns {boolean}
+ */
+const shouldReturnError = (
+  returnAllExceptions: boolean,
+  error: AxiosError
+): boolean => {
+  if (getErrorType(error) === RESPONSE_TYPE.UNAUTHORIZED) {
+    return returnAllExceptions;
+  } else {
+    return true;
+  }
+};
+
+export {
+  client,
+  errorToString,
+  getErrorType,
+  getErrorInformation,
+  shouldReturnError,
+};

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

@@ -4,9 +4,13 @@ import { client } from "./axiosClient.js";
  * 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>}
  */
-const getConfigurationById = (id, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getConfigurationById = (
+  id: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const getConfigInformationRequest = client.get(
       `api/v1/configurations/configuration/id/${id}`,
       { headers: { authorization: authToken } }
@@ -25,9 +29,13 @@ const getConfigurationById = (id, authToken) => {
  * 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>}
  */
-const getConfigurationByType = (type, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getConfigurationByType = (
+  type: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const getConfigInformationRequest = client.get(
       `api/v1/configurations/configuration/type/${type}`,
       { headers: { authorization: authToken } }
@@ -47,9 +55,14 @@ const getConfigurationByType = (type, authToken) => {
  * @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>}
  */
-const setConfigurationById = (id, data, authToken) => {
-  return new Promise(function (resolve, reject) {
+const setConfigurationById = (
+  id: string,
+  data: object,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const getConfigInformationRequest = client.post(
       `api/v1/configurations/configuration/${id}`,
       { data: data },

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

@@ -1,78 +1,44 @@
 const DOCUMENT_VERSION = {
   DRAFT: "draft",
   PUBLISHED: "published",
-};
+} as const;
 
 const RESPONSE_TYPE = {
-  //The requested resource corresponds to any one of a set of representations, each with its own specific location.
   MULTIPLE_CHOICES: 300,
-  //The resource has moved permanently. Please refer to the documentation.
   MOVED_PERMANENTLY: 301,
-  //The resource has moved temporarily. Please refer to the documentation.
   FOUND: 302,
-  //The resource can be found under a different URI.
   SEE_OTHER: 303,
-  //The resource is available and not modified.
   NOT_MODIFIED: 304,
-  //The requested resource must be accessed through the proxy given by the Location field.
   USE_PROXY: 305,
-  //The resource resides temporarily under a different URI.
   TEMPORARY_REDIRECT: 307,
-  //Invalid syntax for this request was provided.
   BAD_REQUEST: 400,
-  //You are unauthorized to access the requested resource. Please log in.
   UNAUTHORIZED: 401,
-  //Your account is not authorized to access the requested resource.
   FORBIDDEN: 403,
-  //We could not find the resource you requested. Please refer to the documentation for the list of resources.
   NOT_FOUND: 404,
-  //This method type is not currently supported.
   METHOD_NOT_ALLOWED: 405,
-  //Acceptance header is invalid for this endpoint resource.
   NOT_ACCEPTABLE: 406,
-  //Authentication with proxy is required.
   PROXY_AUTHENTICATION_REQUIRED: 407,
-  //Client did not produce a request within the time that the server was prepared to wait.
   REQUEST_TIMEOUT: 408,
-  //The request could not be completed due to a conflict with the current state of the resource.
   CONFLICT: 409,
-  //The requested resource is no longer available and has been permanently removed.
   GONE: 410,
-  //Length of the content is required, please include it with the request.
   LENGTH_REQUIRED: 411,
-  //The request did not match the pre-conditions of the requested resource.
   PRECONDITION_FAILED: 412,
-  //The request entity is larger than the server is willing or able to process.
   REQUEST_ENTITY_TOO_LARGE: 413,
-  //The request URI is longer than the server is willing to interpret.
   REQUEST_URI_TOO_LONG: 414,
-  //The requested resource does not support the media type provided.
   UNSUPPORTED_MEDIA_TYPE: 415,
-  //The requested range for the resource is not available.
   REQUESTED_RANGE_NOT_SATISFIABLE: 416,
-  //Unable to meet the expectation given in the Expect request header.
   EXPECTATION_FAILED: 417,
-  //The requested resource is missing required arguments.
   MISSING_ARGUMENTS: 419,
-  //The requested resource does not support one or more of the given parameters.
   INVALID_ARGUMENTS: 420,
-  //The request was well-formed but was unable to be followed due to semantic errors.
   UNPROCESSABLE_ENTITY: 422,
-  //Unexpected internal server error.
   INTERNAL_SERVER_ERROR: 500,
-  //The requested resource is recognized but not implemented.
   NOT_IMPLEMENTED: 501,
-  //Invalid response received when acting as a proxy or gateway.
   BAD_GATEWAY: 502,
-  //The server is currently unavailable.
   SERVICE_UNAVAILABLE: 503,
-  //Did not receive a timely response from upstream server while acting as a gateway or proxy.
   GATEWAY_TIMEOUT: 504,
-  //The HTTP protocol version used in the request message is not supported.
   HTTP_VERSION_NOT_SUPPORTED: 505,
-  //A failure occurred during initialization of services. API will be unavailable.
   INITIALIZATION_FAILURE: 550,
-};
+} as const;
 
 const PERMISSIONS = {
   ACCESS_TO_CONTENT_GENERATORS: "651d81d626fb9aafa4077520",
@@ -98,9 +64,9 @@ const PERMISSIONS = {
   MANAGE_USERS: "5dd612e40f0bc559c41a2b29",
   PROMOTE_CONTENT: "5fac2126427ce31f8a92c0cb",
   TALENT_TRANSFORMATION_CHAMPION: "5fac210f7e6539d37a897c95",
-};
+} as const;
 
-const PERMISSION_DESCRIPTIONS = {
+const PERMISSION_DESCRIPTIONS: { [key: string]: string } = {
   "5ea3d1152839450e16e72bba": "Author content",
   "5ea3d10bea252025c8ec351b": "Promote content",
   "61970935cee185acf08111f6": "Manage content providers",
@@ -113,8 +79,7 @@ const PERMISSION_DESCRIPTIONS = {
   "5dd61305a73c68b44c3f0827": "Manage learning paths",
   "5dd612d5338ea9a6ae6326da": "Manage organization information",
   "5fac210e7e6539d37a897c94": "Auto approve own profile information updates",
-  "650fadb23956a2154ac890ac":
-    "Skip assessment when updating own profile information",
+  "650fadb23956a2154ac890ac": "Skip assessment when updating own profile information",
   "5fac21164351c6727a34cd4e": "Auto approve own skill set updates",
   "66ff566a911d938bc00618bf": "Manage security",
   "5e1570e087d836dc77888a5f": "Manage settings",
@@ -129,4 +94,4 @@ export {
   PERMISSIONS,
   PERMISSION_DESCRIPTIONS,
   RESPONSE_TYPE,
-};
+};

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

@@ -6,9 +6,15 @@ import { client } from "./axiosClient.js";
  * @param {Number} position - The position on the dashboard
  * @param {Object} data - The card settings data
  * @param {String} authToken - Authorization token
+ * @returns {Promise<Object>}
  */
-const addCardToDashboard = (id, position, data, authToken) => {
-  return new Promise(function (resolve, reject) {
+const addCardToDashboard = (
+  id: string,
+  position: number,
+  data: object,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.put(
       `/api/v1/dashboard/card`,
       {
@@ -31,9 +37,10 @@ const addCardToDashboard = (id, position, data, authToken) => {
 /**
  * Get the list of the cards from the dashboard
  * @param {String} authToken - Authorization token
+ * @returns {Promise<Object>}
  */
-const getDashboardCardsList = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getDashboardCardsList = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`/api/v1/dashboard/card`, {
       headers: { authorization: authToken },
     });
@@ -51,12 +58,15 @@ const getDashboardCardsList = (authToken) => {
  * Remove a card from the dashboard
  * @param {String} id - the id of the configuration element
  * @param {String} authToken - Authorization token
+ * @returns {Promise<Object>}
  */
-const removeCardFromDashboard = (id, authToken) => {
-  return new Promise(function (resolve, reject) {
+const removeCardFromDashboard = (
+  id: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`/api/v1/dashboard/card`, {
       headers: { authorization: authToken },
-
       data: {
         id: id,
       },

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

@@ -1,20 +1,30 @@
 import { client } from "./axiosClient.js";
 
+interface Activity {
+  // Define the structure of an activity object here
+}
+
+interface Filter {
+  // Define the structure of a filter object here
+}
+
 /**
  * Create department training plan and set information
  * @param {String} name
  * @param {String} summary
- * @param {Array<Object>} activities
+ * @param {String} skill
+ * @param {Array<Activity>} activities
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
 const createDepartmentTrainingPlan = (
-  name,
-  summary,
-  skill,
-  activities,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  name: string,
+  summary: string,
+  skill: string,
+  activities: Activity[],
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       name: name || "",
       summary: summary || "",
@@ -42,12 +52,15 @@ 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>}
  */
-const deleteDepartmentTrainingPlan = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const deleteDepartmentTrainingPlan = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`api/v1/departmenttrainingplans/`, {
       headers: { authorization: token },
-
       data: {
         id: id,
       },
@@ -63,12 +76,18 @@ const deleteDepartmentTrainingPlan = (id, token) => {
 };
 
 /**
- * Get department traing plan information
+ * Get department training plan information
  * @param {Number} id The id of the plan
+ * @param {String} version The version of the plan
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getDepartmentTrainingPlanInformationById = (id, version, token) => {
-  return new Promise(function (resolve, reject) {
+const getDepartmentTrainingPlanInformationById = (
+  id: number,
+  version: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/departmenttrainingplans/${id}/${version}`,
       {
@@ -87,11 +106,17 @@ const getDepartmentTrainingPlanInformationById = (id, version, token) => {
 
 /**
  * Get department training plan list
- * @param {Object} filter The filter used to select the plan
+ * @param {Filter} filter The filter used to select the plan
+ * @param {String} version The version of the plan
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getDepartmentTrainingPlanList = (filter, version, token) => {
-  return new Promise(function (resolve, reject) {
+const getDepartmentTrainingPlanList = (
+  filter: Filter,
+  version: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       filter: filter || "",
       version: version,
@@ -117,9 +142,13 @@ const getDepartmentTrainingPlanList = (filter, version, token) => {
  * Publish department training plan
  * @param {number} id The id of the plan to be published
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const publishDepartmentTrainingPlan = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const publishDepartmentTrainingPlan = (
+  id: number,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.post(
       `api/v1/departmenttrainingplans/publish/${id}`,
       {},
@@ -142,9 +171,14 @@ const publishDepartmentTrainingPlan = (id, token) => {
  * @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>}
  */
-const setDepartmentTrainingPlanInformation = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setDepartmentTrainingPlanInformation = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
@@ -165,7 +199,7 @@ const setDepartmentTrainingPlanInformation = (id, data, token) => {
   });
 };
 
-const departmentTraingPlans = {
+const departmentTrainingPlans = {
   createDepartmentTrainingPlan,
   deleteDepartmentTrainingPlan,
   getDepartmentTrainingPlanInformationById,
@@ -174,4 +208,4 @@ const departmentTraingPlans = {
   setDepartmentTrainingPlanInformation,
 };
 
-export default departmentTraingPlans;
+export default departmentTrainingPlans;