@stackfactor/client-api 1.1.15-8.1 → 1.1.15

package/exports.js

@@ -0,0 +1,71 @@
+import actionNotifications from "./lib/actionNotifications.js";
+import {
+  client,
+  errorToString,
+  getErrorInformation,
+  getErrorType,
+  shouldReturnError,
+} from "./lib/axiosClient.js";
+import address from "./lib/address.js";
+import config from "./lib/config.js";
+import {
+  DOCUMENT_VERSION,
+  PERMISSIONS,
+  PERMISSION_DESCRIPTIONS,
+  RESPONSE_TYPE,
+} from "./lib/constants.js";
+import contentGenerator from "./lib/integrations/contentGenerator.js";
+import dashboard from "./lib/dashboard.js";
+import departmentTraingPlans from "./lib/departmentTrainingPlans.js";
+import integration from "./lib/integration.js";
+import integrationConfiguration from "./lib/integrationConfiguration.js";
+import groups from "./lib/groups.js";
+import learningContent from "./lib/learningContent.js";
+import learningPath from "./lib/learningPath.js";
+import logger from "./lib/logger.js";
+import role from "./lib/role.js";
+import roleTemplate from "./lib/roleTemplate.js";
+import skill from "./lib/skill.js";
+import skillAssessment from "./lib/skillAssessments.js";
+import skillAssessmentTestingSession from "./lib/skillAssessmentTestingSession.js";
+import skillTemplate from "./lib/skillTemplate.js";
+import team from "./lib/teams.js";
+import tenant from "./lib/tenants.js";
+import trainingPlan from "./lib/trainingPlans.js";
+import userInformation from "./lib/userInformation.js";
+import users from "./lib/users.js";
+
+export {
+  actionNotifications,
+  address,
+  client,
+  config,
+  contentGenerator,
+  dashboard,
+  errorToString,
+  getErrorInformation,
+  getErrorType,
+  DOCUMENT_VERSION,
+  integration,
+  integrationConfiguration,
+  departmentTraingPlans,
+  groups,
+  learningContent,
+  learningPath,
+  logger,
+  PERMISSIONS,
+  PERMISSION_DESCRIPTIONS,
+  RESPONSE_TYPE,
+  role,
+  roleTemplate,
+  shouldReturnError,
+  skill,
+  skillAssessment,
+  skillAssessmentTestingSession,
+  skillTemplate,
+  team,
+  tenant,
+  trainingPlan,
+  userInformation,
+  users,
+};

package/index.js

@@ -0,0 +1,3 @@
+import * as api from "./exports.js";
+export * from "./exports.js";
+export default api;

package/lib/actionNotifications.js

@@ -0,0 +1,82 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Get all permissions
+ * @param {String} authToken The authentication token
+ */
+export const getAllUserNotifications = (authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/actionnotifications`, {
+      headers: { authorization: authToken },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Mark notifications as open or viewed
+ * @param {Array<String>} ids The id of the notifications to be marked
+ * @param {String} status The new status
+ * @param {String} authToken The authentication token
+ */
+export const markNotifications = (ids, status, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.put(
+      `api/v1/actionnotifications/mark`,
+      {
+        ids: ids,
+        status: status,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Process a notification
+ * @param {String} id The notification id
+ * @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
+ */
+export const processNotification = (id, action, comments, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.put(
+      `api/v1/actionnotifications/process`,
+      {
+        id: id,
+        action: action,
+        comments: comments,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const actionNotifications = {
+  getAllUserNotifications,
+  markNotifications,
+  processNotification,
+};
+
+export default actionNotifications;

package/lib/address.js

@@ -0,0 +1,27 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Validate Address
+ * @param {String} input - the address in raw format
+ * @param {String} authToken - Authorization token
+ */
+export const autoComplete = (input, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const getAddressesRequest = client.post(
+      `api/v1/address/autocomplete/`,
+      { input: input },
+      { headers: { authorization: authToken } }
+    );
+    getAddressesRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const address = { autoComplete };
+
+export default address;

package/lib/aiAssistant.js

@@ -0,0 +1,131 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Ask Question to the AI
+ * @param {String} conversationId
+ * @param {String} question
+ * @param {String} updatedContext
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const askQuestion = (
+  conversationId,
+  question,
+  updatedContext,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    let data = {
+      conversationId: conversationId,
+      question: question,
+      updatedContext: updatedContext,
+    };
+    let confirmationRequest = client.post(
+      "/api/v1/aiasistant/askquestion",
+      { data: data },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * End conversation with the AI
+ * @param {String} conversationId
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const endConversation = (conversationId, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {
+      conversationId: conversationId,
+    };
+    let confirmationRequest = client.post(
+      "/api/v1/aiasistant/endconversation",
+      { data: data },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get conversation by elementId
+ * @param {String} elementId
+ * @param {String} token
+ * @returns {Promise}
+ */
+const getConversationByElementId = (elementId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `/api/v1/aiasistant/conversation/${elementId}/${userId}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Start conversation with the AI
+ * @param {String} context
+ * @param {String} elementId
+ * @param {String} elementType
+ * @param {String} token
+ * @returns {Promise}
+ */
+const startConversation = (context, elementId, elementType, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {
+      context: context,
+      elementId: elementId,
+      elementType: elementType,
+    };
+    let confirmationRequest = client.post(
+      "/api/v1/aiasistant/startconversation",
+      { data: data },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const aiAssistant = {
+  askQuestion,
+  endConversation,
+  getConversationByElementId,
+  startConversation,
+};
+
+export default aiAssistant;

package/lib/axiosClient.js

@@ -0,0 +1,85 @@
+import axios from "axios";
+import { RESPONSE_TYPE } from "./constants.js";
+import https from "https";
+import utils from "./utils.js";
+
+const baseUrl = utils.getBaseUrl();
+
+const client = axios.create({
+  baseURL: baseUrl,
+  httpsAgent: new https.Agent({
+    rejectUnauthorized: false,
+  }),
+});
+
+/**
+ * Returns the error as a string
+ * @param {Object} error
+ */
+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 : "Unknown error";
+    }
+  }
+};
+
+/**
+ * Returns the code of the error as a number
+ * @param {Object} error
+ * @returns {Number} The error code
+ */
+const getErrorType = (error) => {
+  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 {Object} error
+ * @returns Object
+ */
+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 {Boolean} returnAllExceptions - If set true all exceptions will be passed
+ * @param {Object} error - The error returned by the server
+ */
+const shouldReturnError = (returnAllExceptions, error) => {
+  if (getErrorType(error) === RESPONSE_TYPE.UNAUTHORIZED) {
+    return returnAllExceptions;
+  } else {
+    return true;
+  }
+};
+
+export {
+  client,
+  errorToString,
+  getErrorType,
+  getErrorInformation,
+  shouldReturnError,
+};

package/lib/config.js

@@ -0,0 +1,74 @@
+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
+ */
+export const getConfigurationById = (id, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const getConfigInformationRequest = client.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
+ */
+export const getConfigurationByType = (type, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const getConfigInformationRequest = client.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
+ */
+export const setConfigurationById = (id, data, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const getConfigInformationRequest = client.post(
+      `api/v1/configurations/configuration/${id}`,
+      { data: data },
+      { headers: { authorization: authToken } }
+    );
+    getConfigInformationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const config = {
+  getConfigurationById,
+  getConfigurationByType,
+  setConfigurationById,
+};
+
+export default config;

package/lib/constants.js

@@ -0,0 +1,127 @@
+const DOCUMENT_VERSION = {
+  DRAFT: "draft",
+  PUBLISHED: "published",
+};
+
+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,
+};
+
+const PERMISSIONS = {
+  ACCESS_TO_CONTENT_GENERATORS: "651d81d626fb9aafa4077520",
+  ADMIN_AUTHOR_CONTENT: "5ea3d1152839450e16e72bba",
+  ADMIN_PROMOTE_CONTENT: "5ea3d10bea252025c8ec351b",
+  ADMIN_MANAGE_CONTENT_PROVIDERS: "61970935cee185acf08111f6",
+  AUTHOR_CONTENT: "5fac210560e43de7c6b4a208",
+  BETA_TESTER: "5fac210b6c8f874bd7137b97",
+  MANAGE_BILLING: "5e1570cd03f676213bfdcd08",
+  MANAGE_CONTENT_PROVIDERS: "5f0fa12f16a720fde58ea820",
+  MANAGE_GROUPS: "5dd612fe59e518ac87b8cf8e",
+  MANAGE_LEARNING_CONTENT: "64f54d20b7e49e10c779b4a6",
+  MANAGE_LEARNING_PATHS: "5dd61305a73c68b44c3f0827",
+  MANAGE_ORGANIZATION_INFORMATION: "5dd612d5338ea9a6ae6326da",
+  MANAGE_OWN_PROFILE_INFORMATION_AUTO_APP: "5fac210e7e6539d37a897c94",
+  MANAGE_OWN_PROFILE_SKIP_ASSESSMENT: "650fadb23956a2154ac890ac",
+  MANAGE_OWN_SKILL_SET_AUTO_APPROVE: "5fac21164351c6727a34cd4e",
+  MANAGE_SETTINGS: "5e1570e087d836dc77888a5f",
+  MANAGE_TEAM_INFORMATION_AUTO_APPROVE: "5fac211e6c8f874bd7137b98",
+  MANAGE_TEAMS: "5dd61314afc2455a89b1a37b",
+  MANAGE_USERS: "5dd612e40f0bc559c41a2b29",
+  PROMOTE_CONTENT: "5fac2126427ce31f8a92c0cb",
+};
+
+const PERMISSION_DESCRIPTIONS = {
+  "5ea3d1152839450e16e72bba": "Author content",
+  "5ea3d10bea252025c8ec351b": "Promote content",
+  "61970935cee185acf08111f6": "Manage content providers",
+  "5fac210560e43de7c6b4a208": "Author content",
+  "5e1570cd03f676213bfdcd08": "Manage billing",
+  "5f0fa12f16a720fde58ea820": "Manage content providers",
+  "5dd612fe59e518ac87b8cf8e": "Manage groups",
+  "64f54d20b7e49e10c779b4a6": "Manage learning content",
+  "5dd61305a73c68b44c3f0827": "Manage learning paths",
+  "5dd612d5338ea9a6ae6326da": "Manage organization information",
+  "5fac210e7e6539d37a897c94": "Auto approve own profile information updates",
+  "650fadb23956a2154ac890ac":
+    "Skip assessment when updating own profile information",
+  "5fac21164351c6727a34cd4e": "Auto approve own skill set updates",
+  "5e1570e087d836dc77888a5f": "Manage settings",
+  "5fac211e6c8f874bd7137b98": "Auto approve own team information updates",
+  "5dd61314afc2455a89b1a37b": "Manage teams",
+  "5dd612e40f0bc559c41a2b29": "Manage users",
+  "5fac2126427ce31f8a92c0cb": "Promote content",
+};
+
+export {
+  DOCUMENT_VERSION,
+  PERMISSIONS,
+  PERMISSION_DESCRIPTIONS,
+  RESPONSE_TYPE,
+};

package/lib/dashboard.js

@@ -0,0 +1,79 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * 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
+ */
+export const addCardToDashboard = (id, position, data, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.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
+ */
+export const getDashboardCardsList = (authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.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
+ */
+export const removeCardFromDashboard = (id, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.delete(`/api/v1/dashboard/card`, {
+      headers: { authorization: authToken },
+      data: {
+        id: id,
+      },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const dashboard = {
+  addCardToDashboard,
+  getDashboardCardsList,
+  removeCardFromDashboard,
+};
+
+export default dashboard;