@stackfactor/client-api 1.0.0

package/lib/axios.js

@@ -0,0 +1,216 @@
+import axios from "axios";
+import utils from "./utils";
+
+const baseUrl = utils.getBaseUrl();
+
+let instance = axios.create({
+  baseURL: baseUrl,
+});
+
+/**
+ * Server response type
+ */
+export const responseType = {
+  /**
+   * 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,
+};
+
+/**
+ * Returns the error as a string
+ * @param {Object} error
+ */
+export const errorToString = (error) => {
+  if (error != null) {
+    if (error?.response?.data) {
+      let asString = "";
+      if (Array.isArray(error.response.data.errors)) {
+        error.response.data.errors.forEach((item, index) => {
+          asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
+            item.param
+          } ${item.value ? `value ${item.value.toString()}` : ""}`;
+        });
+        return asString;
+      } else if (error.response.data.error) {
+        return error.response.data.error.toString();
+      } else if (error.response.statusText) {
+        return error.response.statusText.toString();
+      } else {
+        return error.response.data.toString();
+      }
+    } else {
+      return error.message ? error.message : error.toString();
+    }
+  }
+};
+
+/**
+ * Returns the code of the error as a number
+ * @param {Object} error
+ * @returns {Number} The error code
+ */
+export const getErrorType = (error) => {
+  if (error?.response?.status) {
+    return error.response.status;
+  } else return responseType.SERVICE_UNAVAILABLE;
+};
+
+/**
+ * Return the error information to include just the status and the message
+ * @param {*} error
+ * @returns Object
+ */
+export const getErrorInformation = (error) => {
+  return {
+    status: getErrorType(error),
+    message: errorToString(error),
+  };
+};
+
+/**
+ * Returns true if an exception should be handled to the business and presentation layer
+ * @param {*} returnAllExceptions - If set true all exceptions will be passed
+ * @param {*} error - The error returned by the server
+ */
+export const shouldReturnError = (returnAllExceptions, error) => {
+  if (getErrorType(error) === responseType.UNAUTHORIZED) {
+    return returnAllExceptions;
+  } else {
+    return true;
+  }
+};
+
+export default instance;

package/lib/config.js

@@ -0,0 +1,77 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Get the specified configuration by Id. It returns a promise
+   *
+   * @param {String} id - the id of the configuration element
+   * @param {String} authToken - Authorization token
+   *
+   */
+  getConfigurationById(id, authToken) {
+    return new Promise(function (resolve, reject) {
+      const getConfigInformationRequest = axios.get(
+        `api/v1/configurations/configuration/id/${id}`,
+        { headers: { authorization: authToken } }
+      );
+      getConfigInformationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get the specified configuration by type. It returns a promise
+   *
+   * @param {String} type - the id of the configuration element
+   * @param {String} authToken - Authorization token
+   *
+   */
+  getConfigurationByType(type, authToken) {
+    return new Promise(function (resolve, reject) {
+      const getConfigInformationRequest = axios.get(
+        `api/v1/configurations/configuration/type/${type}`,
+        { headers: { authorization: authToken } }
+      );
+      getConfigInformationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   *
+   * Set the specified configuration by Id. It returns a promise
+   *
+   * @param {String} id - the id of the configuration element
+   * @param {Object} data - the object containing the updated configuration element
+   * @param {String} authToken - Authorization token
+   *
+   */
+  setConfigurationById(id, data, authToken) {
+    return new Promise(function (resolve, reject) {
+      const getConfigInformationRequest = axios.post(
+        `api/v1/configurations/configuration/${id}`,
+        { data: data },
+        { headers: { authorization: authToken } }
+      );
+      getConfigInformationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/dashboard.js

@@ -0,0 +1,75 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Add a card to the dashboard
+   * @param {String} id - the id of the card to be added to the dashboard
+   * @param {Number} position - The position on the dashboard
+   * @param {Object} data - The card settings data
+   * @param {String} authToken - Authorization token
+   */
+  addCardToDashboard(id, position, data, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.put(
+        `/api/v1/dashboard/card`,
+        {
+          id: id,
+          position: position,
+          data: data ? data : {},
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get the list of the cards from the dashboard
+   * @param {String} authToken - Authorization token
+   */
+  getDashboardCardsList(authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.get(`/api/v1/dashboard/card`, {
+        headers: { authorization: authToken },
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Remove a card from the dashboard
+   * @param {String} id - the id of the configuration element
+   * @param {String} authToken - Authorization token
+   */
+  removeCardFromDashboard(id, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.delete(`/api/v1/dashboard/card`, {
+        headers: { authorization: authToken },
+        data: {
+          id: id,
+        },
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/departmentTrainingPlans.js

@@ -0,0 +1,163 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Create training plan template and set information
+   * @param {String} name
+   * @param {String} summary
+   * @param {Array<Object>} activities
+   * @param {String} token Authorization token
+   */
+  createDepartmentTrainingPlan(name, summary, skill, activities, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        name: name ? name : "",
+        summary: summary ? summary : "",
+        skill: skill ? skill : "",
+        activities: activities ? activities : [],
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/departmentTrainingPlans",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete department training plan
+   * @param {String} id The id of the template to be deleted
+   * @param {String} token Authorization token
+   */
+  deleteDepartmentTrainingPlan(id, token) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.delete(`api/v1/departmenttrainingplans/`, {
+        headers: { authorization: token },
+        data: {
+          id: id,
+        },
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get department traing plan information
+   * @param {number} id The id of the plan
+   * @param {String} token Authorization token
+   */
+  getDepartmentTrainingPlanInformationById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/departmenttrainingplans/${id}/${version}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get department training plan list
+   * @param {Object} filter The filter used to select the plan
+   * @param {String} token Authorization token
+   */
+  getDepartmentTrainingPlanList(filter, version, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        filter: filter ? filter : "",
+        version: version,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/departmenttrainingplans`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Publish department training plan
+   * @param {number} id The id of the plan to be published
+   * @param {String} token Authorization token
+   */
+  publishDepartmentTrainingPlan(id, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.post(
+        `api/v1/departmenttrainingplans/publish/${id}`,
+        {},
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set department training plan profile information
+   * @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
+   */
+  setDepartmentTrainingPlanInformation(id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/departmenttrainingplans/${id}`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};