@stackfactor/client-api 1.1.12-9.2 → 1.1.12

package/{exports.ts → exports.js}

@@ -6,8 +6,6 @@ import {
   getErrorType,
   shouldReturnError,
 } from "./lib/axiosClient.js";
-import aiAssistant from "./lib/aiAssistant.js";
-import avatar from "./lib/avatar.js";
 import address from "./lib/address.js";
 import config from "./lib/config.js";
 import {
@@ -25,28 +23,21 @@ 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 microSkillsQuizes from "./lib/microSkillsQuizes.js";
-import quotas from "./lib/quotas.js";
 import role from "./lib/role.js";
 import roleTemplate from "./lib/roleTemplate.js";
-import security from "./lib/security.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 talentTransfromation from "./lib/talentTransfromation.js";
 import team from "./lib/teams.js";
 import tenant from "./lib/tenants.js";
 import trainingPlan from "./lib/trainingPlans.js";
-import trainingPlanProficiencyLevel from "./lib/trainingPlansProficiencyLevels.js";
 import userInformation from "./lib/userInformation.js";
 import users from "./lib/users.js";
 
 export {
   actionNotifications,
   address,
-  aiAssistant,
-  avatar,
   client,
   config,
   contentGenerator,
@@ -62,24 +53,19 @@ export {
   learningContent,
   learningPath,
   logger,
-  microSkillsQuizes,
   PERMISSIONS,
   PERMISSION_DESCRIPTIONS,
-  quotas,
   RESPONSE_TYPE,
   role,
   roleTemplate,
-  security,
   shouldReturnError,
   skill,
   skillAssessment,
   skillAssessmentTestingSession,
   skillTemplate,
-  talentTransfromation,
   team,
   tenant,
   trainingPlan,
-  trainingPlanProficiencyLevel,
   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.ts → actionNotifications.js}

@@ -2,13 +2,12 @@ import { client } from "./axiosClient.js";
 
 /**
  * Get all permissions
- * @param {String} token The authentication token
- * @returns {Promise<Object>}
+ * @param {String} authToken The authentication token
  */
-const getAllUserNotifications = (token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getAllUserNotifications = (authToken) => {
+  return new Promise(function (resolve, reject) {
     const request = client.get(`api/v1/actionnotifications`, {
-      headers: { authorization: token },
+      headers: { authorization: authToken },
     });
     request
       .then((response) => {
@@ -25,14 +24,9 @@ const getAllUserNotifications = (token: string): Promise<object> => {
  * @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: string[],
-  status: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const markNotifications = (ids, status, authToken) => {
+  return new Promise(function (resolve, reject) {
     const request = client.put(
       `api/v1/actionnotifications/mark`,
       {
@@ -57,15 +51,9 @@ const markNotifications = (
  * @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: string,
-  action: string,
-  comments: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const processNotification = (id, action, comments, authToken) => {
+  return new Promise(function (resolve, reject) {
     const request = client.put(
       `api/v1/actionnotifications/process`,
       {
@@ -85,8 +73,10 @@ const processNotification = (
   });
 };
 
-export default {
+const actionNotifications = {
   getAllUserNotifications,
   markNotifications,
   processNotification,
 };
+
+export default actionNotifications;

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

@@ -4,10 +4,9 @@ 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: string, authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const autoComplete = (input, authToken) => {
+  return new Promise(function (resolve, reject) {
     const getAddressesRequest = client.post(
       `api/v1/address/autocomplete/`,
       { input: input },
@@ -23,4 +22,6 @@ const autoComplete = (input: string, authToken: string): Promise<object> => {
   });
 };
 
-export default { autoComplete };
+const address = { autoComplete };
+
+export default address;

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.ts → config.js}

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

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

@@ -1,44 +1,78 @@
 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",
@@ -49,7 +83,6 @@ const PERMISSIONS = {
   BETA_TESTER: "5fac210b6c8f874bd7137b97",
   MANAGE_BILLING: "5e1570cd03f676213bfdcd08",
   MANAGE_CONTENT_PROVIDERS: "5f0fa12f16a720fde58ea820",
-  MANAGE_EXECUTIVE: "5fac2111b7e49e10c779b4a5",
   MANAGE_GROUPS: "5dd612fe59e518ac87b8cf8e",
   MANAGE_LEARNING_CONTENT: "64f54d20b7e49e10c779b4a6",
   MANAGE_LEARNING_PATHS: "5dd61305a73c68b44c3f0827",
@@ -57,31 +90,28 @@ const PERMISSIONS = {
   MANAGE_OWN_PROFILE_INFORMATION_AUTO_APP: "5fac210e7e6539d37a897c94",
   MANAGE_OWN_PROFILE_SKIP_ASSESSMENT: "650fadb23956a2154ac890ac",
   MANAGE_OWN_SKILL_SET_AUTO_APPROVE: "5fac21164351c6727a34cd4e",
-  MANAGE_SECURITY: "66ff566a911d938bc00618bf",
   MANAGE_SETTINGS: "5e1570e087d836dc77888a5f",
   MANAGE_TEAM_INFORMATION_AUTO_APPROVE: "5fac211e6c8f874bd7137b98",
   MANAGE_TEAMS: "5dd61314afc2455a89b1a37b",
   MANAGE_USERS: "5dd612e40f0bc559c41a2b29",
   PROMOTE_CONTENT: "5fac2126427ce31f8a92c0cb",
-  TALENT_TRANSFORMATION_CHAMPION: "5fac210f7e6539d37a897c95",
-} as const;
+};
 
-const PERMISSION_DESCRIPTIONS: { [key: string]: string } = {
+const PERMISSION_DESCRIPTIONS = {
   "5ea3d1152839450e16e72bba": "Author content",
   "5ea3d10bea252025c8ec351b": "Promote content",
   "61970935cee185acf08111f6": "Manage content providers",
   "5fac210560e43de7c6b4a208": "Author content",
   "5e1570cd03f676213bfdcd08": "Manage billing",
   "5f0fa12f16a720fde58ea820": "Manage content providers",
-  "5fac2111b7e49e10c779b4a5": "Manage executive",
   "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",
+  "650fadb23956a2154ac890ac":
+    "Skip assessment when updating own profile information",
   "5fac21164351c6727a34cd4e": "Auto approve own skill set updates",
-  "66ff566a911d938bc00618bf": "Manage security",
   "5e1570e087d836dc77888a5f": "Manage settings",
   "5fac211e6c8f874bd7137b98": "Auto approve own team information updates",
   "5dd61314afc2455a89b1a37b": "Manage teams",
@@ -94,4 +124,4 @@ export {
   PERMISSIONS,
   PERMISSION_DESCRIPTIONS,
   RESPONSE_TYPE,
-};
+};

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

@@ -6,21 +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: string,
-  position: number,
-  data: object,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+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: data ? data : {},
       },
       { headers: { authorization: authToken } }
     );
@@ -37,10 +31,9 @@ const addCardToDashboard = (
 /**
  * Get the list of the cards from the dashboard
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
  */
-const getDashboardCardsList = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getDashboardCardsList = (authToken) => {
+  return new Promise(function (resolve, reject) {
     const request = client.get(`/api/v1/dashboard/card`, {
       headers: { authorization: authToken },
     });
@@ -58,13 +51,9 @@ 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>}
  */
-const removeCardFromDashboard = (
-  id: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const removeCardFromDashboard = (id, authToken) => {
+  return new Promise(function (resolve, reject) {
     const request = client.delete(`/api/v1/dashboard/card`, {
       headers: { authorization: authToken },
       data: {
@@ -81,8 +70,10 @@ const removeCardFromDashboard = (
   });
 };
 
-export default {
+const dashboard = {
   addCardToDashboard,
   getDashboardCardsList,
   removeCardFromDashboard,
 };
+
+export default dashboard;

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

@@ -1,35 +1,25 @@
 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 {String} skill
- * @param {Array<Activity>} activities
+ * @param {Array<Object>} activities
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const createDepartmentTrainingPlan = (
-  name: string,
-  summary: string,
-  skill: string,
-  activities: Activity[],
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const createDepartmentTrainingPlan = (
+  name,
+  summary,
+  skill,
+  activities,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
-      name: name || "",
-      summary: summary || "",
-      skill: skill || "",
-      activities: activities || [],
+      name: name ? name : "",
+      summary: summary ? summary : "",
+      skill: skill ? skill : "",
+      activities: activities ? activities : [],
     };
     let confirmationRequest = client.put(
       "api/v1/departmentTrainingPlans",
@@ -52,13 +42,9 @@ 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: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const deleteDepartmentTrainingPlan = (id, token) => {
+  return new Promise(function (resolve, reject) {
     const request = client.delete(`api/v1/departmenttrainingplans/`, {
       headers: { authorization: token },
       data: {
@@ -76,18 +62,16 @@ const deleteDepartmentTrainingPlan = (
 };
 
 /**
- * Get department training plan information
+ * Get department traing 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: number,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getDepartmentTrainingPlanInformationById = (
+  id,
+  version,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/departmenttrainingplans/${id}/${version}`,
       {
@@ -106,19 +90,13 @@ const getDepartmentTrainingPlanInformationById = (
 
 /**
  * Get department training plan list
- * @param {Filter} filter The filter used to select the plan
- * @param {String} version The version of the plan
+ * @param {Object} filter The filter used to select the plan
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const getDepartmentTrainingPlanList = (
-  filter: Filter,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getDepartmentTrainingPlanList = (filter, version, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
-      filter: filter || "",
+      filter: filter ? filter : "",
       version: version,
     };
     let confirmationRequest = client.post(
@@ -142,13 +120,9 @@ 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>}
  */
-const publishDepartmentTrainingPlan = (
-  id: number,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const publishDepartmentTrainingPlan = (id, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.post(
       `api/v1/departmenttrainingplans/publish/${id}`,
       {},
@@ -171,14 +145,9 @@ 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>}
  */
-const setDepartmentTrainingPlanInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const setDepartmentTrainingPlanInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       data: data,
     };
@@ -199,7 +168,7 @@ const setDepartmentTrainingPlanInformation = (
   });
 };
 
-const departmentTrainingPlans = {
+const departmentTraingPlans = {
   createDepartmentTrainingPlan,
   deleteDepartmentTrainingPlan,
   getDepartmentTrainingPlanInformationById,
@@ -208,4 +177,4 @@ const departmentTrainingPlans = {
   setDepartmentTrainingPlanInformation,
 };
 
-export default departmentTrainingPlans;
+export default departmentTraingPlans;