@stackfactor/client-api 1.1.12-9.2 → 1.1.12

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

@@ -4,10 +4,10 @@ import { client } from "./axiosClient.js";
  * Create skill and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const createSkill = (data: object, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const createSkill = (data, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.put(
       "api/v1/skills",
       { data: data },
@@ -27,15 +27,12 @@ const createSkill = (data: object, token: string): Promise<object> => {
 
 /**
  * Create skills from templates
- * @param {Array<String>} templateIds
+ * @param {Array<String>} templateIds,
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const createSkillsFromTemplates = (
-  templateIds: string[],
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const createSkillsFromTemplates = (templateIds, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       templateIds: templateIds,
     };
@@ -61,15 +58,11 @@ const createSkillsFromTemplates = (
  * @param {String} id The id of the skill to be deleted
  * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const deleteSkill = (
-  id: string,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: { id: string; comments?: string } = {
+export const deleteSkill = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
       id: id,
     };
     if (comments) data.comments = comments;
@@ -89,12 +82,12 @@ const deleteSkill = (
 
 /**
  * Discard the skill draft changes
- * @param {String} id The id of the skill to be discarded
+ * @param {String} id The id of the skill to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const discardSkillChanges = (id: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const discardSkillChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
     const data = {};
     const request = client.get(`api/v1/skills/discard/${id}`, {
       headers: { authorization: token },
@@ -112,15 +105,16 @@ const discardSkillChanges = (id: string, token: string): Promise<object> => {
 
 /**
  * Get the list of imported skill templates
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @param {String} token
+ * @returns {Promise}
  */
-const getImportedSkillTemplates = (token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getImportedSkillTemplates = (token) => {
+  return new Promise(function (resolve, reject) {
     const request = client.get(`api/v1/skills/getimportedskilltemplates`, {
       headers: { authorization: token },
     });
     request
+
       .then((response) => {
         resolve(response.data);
       })
@@ -133,18 +127,13 @@ const getImportedSkillTemplates = (token: string): Promise<object> => {
 /**
  * Get the skill related roles
  * @param {String} id
- * @param {String} token Authorization token
- * @param {Boolean} includeRoleInformation
- * @returns {Promise<Object>}
+ * @param {String} token
+ * @returns {Promise}
  */
-const getSkillRelatedRoles = (
-  id: string,
-  token: string,
-  includeRoleInformation = false
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getSkillRelatedRoles = (id, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
-      `api/v1/skills/getskillrelatedroles/${id}/${includeRoleInformation}`,
+      `api/v1/skills/getskillrelatedroles/${id}`,
       {
         headers: { authorization: token },
       }
@@ -162,14 +151,11 @@ const getSkillRelatedRoles = (
 /**
  * Get skill required assessment type
  * @param {String} id
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @param {String} token
+ * @returns {Promise}
  */
-const getSkillRequiredAssessmentType = (
-  id: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getSkillRequiredAssessmentType = (id, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/skills/getrequiredassessmenttype/${id}`,
       {
@@ -187,20 +173,20 @@ const getSkillRequiredAssessmentType = (
 };
 
 /**
- * Get skill information
+ * Get skill skill information
  * @param {String} id The id of the skill
  * @param {String} version The version of the skill
  * @param {Boolean} returnNullIfVersionNotFound When true it will return null if the version is not found
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const getSkillInformationById = (
-  id: string,
-  version: string,
-  returnNullIfVersionNotFound: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getSkillInformationById = (
+  id,
+  version,
+  returnNullIfVersionNotFound,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/skills/skill/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
@@ -225,23 +211,22 @@ const getSkillInformationById = (
  * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
  * @param {Boolean} namesOnly Return only the names of the skills
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const getSkillList = (
-  filter: string[],
-  version: string,
-  includeDeleted: boolean,
-  returnDefaultIfVersionNotAvailable: boolean,
-  namesOnly: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getSkillList = (
+  filter,
+  version,
+  includeDeleted,
+  returnDefaultIfVersionNotAvailable,
+  namesOnly,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       includeDeleted: includeDeleted,
       namesOnly: namesOnly,
       returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
       version: version,
-      filter: filter,
     };
     if (filter) requestData.filter = filter;
     let confirmationRequest = client.post(`api/v1/skills`, requestData, {
@@ -263,15 +248,15 @@ const getSkillList = (
  * @param {Number} maxDepth How many levels down in the organization the skills will be loaded
  * @param {Boolean} returnNullIfVersionNotFound Return null if the version is not found
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const getTeamSkillsById = (
-  teamId: string,
-  maxDepth: number,
-  returnNullIfVersionNotFound: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getTeamSkillsById = (
+  teamId,
+  maxDepth,
+  returnNullIfVersionNotFound,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/skills/getteambyid/${teamId}/${maxDepth}/${returnNullIfVersionNotFound}`,
       {
@@ -292,13 +277,10 @@ const getTeamSkillsById = (
  * Get current user team skills
  * @param {Number} maxDepth How many levels down in the organization the skills will be loaded
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const getCurrentUserTeamSkills = (
-  maxDepth: number,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getCurrentUserTeamSkills = (maxDepth, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/skills/getcurrentuserteam/${maxDepth}`,
       {
@@ -318,14 +300,11 @@ const getCurrentUserTeamSkills = (
 /**
  * Get skill template updates
  * @param {String} id The skill id
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @param {String} token
+ * @returns {Promise}
  */
-const getSkillTemplateUpdates = (
-  id: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getSkillTemplateUpdates = (id, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/skills/getskilltemplateupdates/${id}`,
       {
@@ -346,15 +325,11 @@ const getSkillTemplateUpdates = (
  * Import skill templates
  * @param {Array<String>} data The list of role templates to be imported
  * @param {Boolean} publish If true the imported templates will be published
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @param {String} token
+ * @returns {Promise}
  */
-const importSkillTemplates = (
-  data: string[],
-  publish: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const importSkillTemplates = (data, publish, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       data: data,
       publish: publish,
@@ -367,6 +342,7 @@ const importSkillTemplates = (
       }
     );
     confirmationRequest
+
       .then((response) => {
         resolve(response.data);
       })
@@ -381,15 +357,11 @@ const importSkillTemplates = (
  * @param {String} id The id of the skill to be published
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const publishSkill = (
-  id: string,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: { comments?: string } = {};
+export const publishSkill = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
     if (comments) data.comments = comments;
     let confirmationRequest = client.post(`api/v1/skills/publish/${id}`, data, {
       headers: { authorization: token },
@@ -409,14 +381,10 @@ const publishSkill = (
  * @param {String} id The id of the skill to be updated
  * @param {Object} data Data used to update the skill
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const setSkillInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const setSkillInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       data: data,
       id: id,
@@ -443,14 +411,10 @@ const setSkillInformation = (
  * @param {String} id The id of the skill to be updated
  * @param {Object} data Data used to update the skill
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const setSkillInformationFromTemplate = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const setSkillInformationFromTemplate = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       data: data,
       id: id,
@@ -476,10 +440,10 @@ const setSkillInformationFromTemplate = (
  * Validate skill information
  * @param {String} id The id of the skill to be updated
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const validateSkill = (id: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const validateSkill = (id, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       id: id,
     };
@@ -505,14 +469,10 @@ const validateSkill = (id: string, token: string): Promise<object> => {
  * @param {String} id The id of the skill to be updated
  * @param {Boolean} watch Set to true or false
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise}
  */
-const watchSkill = (
-  id: string,
-  watch: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const watchSkill = (id, watch, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       id: id,
       watch: watch,
@@ -530,7 +490,7 @@ const watchSkill = (
   });
 };
 
-export default {
+const skill = {
   createSkill,
   createSkillsFromTemplates,
   deleteSkill,
@@ -550,3 +510,5 @@ export default {
   validateSkill,
   watchSkill,
 };
+
+export default skill;

package/lib/skillAssessmentTestingSession.js

@@ -0,0 +1,148 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * End an existing testing session
+ * @param {String} testingSessionId
+ * @param {String} token Authorization token
+ */
+export const endSession = (testingSessionId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.put(
+      "api/v1/skillassessmenttestingsession/endsession",
+      { id: testingSessionId },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * End an existing testing session
+ * @param {String} testingSessionId
+ * @param {Array<String>} selectedAnswers
+ * @param {String} token Authorization token
+ */
+export const getNextStep = (testingSessionId, selectedAnswers, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {
+      id: testingSessionId,
+    };
+    if (selectedAnswers) data.selectedAnswers = selectedAnswers;
+    let confirmationRequest = client.post(
+      `api/v1/skillassessmenttestingsession/getnextstep`,
+      data,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get skill assessment by user and skill
+ * @param {String} userId
+ * @param {String} skillId
+ * @param {String} token
+ * @returns
+ */
+export const getSkillTestAssessment = (userId, skillId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.post(
+      `api/v1/skillassessmenttestingsession/getbyuserandskill`,
+      {
+        userId: userId,
+        skillId: skillId,
+      },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Pause skill assessment
+ * @param {String} testingSessionId
+ * @param {String} token
+ * @returns
+ */
+export const pause = (testingSessionId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.post(
+      `api/v1/skillassessmenttestingsession/pausesession`,
+      {
+        id: testingSessionId,
+      },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Start a new test skill test assessment session
+ * @param {String} skillId
+ * @param {Boolean} saveSession
+ * @param {String} token
+ */
+export const startSession = (skillId, saveSession, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.post(
+      "api/v1/skillassessmenttestingsession/startsession",
+      {
+        saveSession: saveSession,
+        skillId: skillId,
+      },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const skillAessementTestingSession = {
+  endSession,
+  getNextStep,
+  getSkillTestAssessment,
+  pause,
+  startSession,
+};
+
+export default skillAessementTestingSession;

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

@@ -6,15 +6,9 @@ import { client } from "./axiosClient.js";
  * @param {Object} data
  * @param {String} comments
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const addEntry = (
-  id: string,
-  data: object,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const addEntry = (id, data, comments, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       comments: comments,
       data: data,
@@ -43,15 +37,9 @@ const addEntry = (
  * @param {String} comments
  * @param {String} userId
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const create = (
-  data: object,
-  comments: string,
-  userId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const create = (data, comments, userId, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       comments: comments,
       data: data,
@@ -79,15 +67,10 @@ const create = (
  * @param {number} id The id of the skill to be deleted
  * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const deleteSkillAssessment = (
-  id: number,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: { id: number, comments?: string } = {
+export const deleteSkillAssessment = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
       id: id,
     };
     if (comments) data.comments = comments;
@@ -109,10 +92,9 @@ const deleteSkillAssessment = (
  * Get skill assessment by id
  * @param {String} id
  * @param {String} token
- * @returns {Promise<Object>}
  */
-const getById = (id: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getById = (id, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
       headers: { authorization: token },
     });
@@ -126,44 +108,14 @@ const getById = (id: string, token: string): Promise<object> => {
   });
 };
 
-/**
- * Get skill assessment by user and skill
- * @param {String} userId
- * @param {String} skillId
- * @param {String} token
- * @returns {Promise<Object>} The skill assessment
- */
-const getByUserAndSkill = (
-  userId: string,
-  skillId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
-      `api/v1/skillassessments/getbyuserandskill/${userId}/${skillId}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
 /**
  * Get list
- * @param {String} userId The user used to select the skill
+ * @param {Object} userId The user used to select the skill
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const getList = (userId: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: { userId?: string } = {};
+export const getList = (userId, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {};
     if (userId) requestData.userId = userId;
     let confirmationRequest = client.post(
       `api/v1/skillassessments`,
@@ -182,11 +134,12 @@ const getList = (userId: string, token: string): Promise<object> => {
   });
 };
 
-export default {
+const skillAssessments = {
   addEntry,
   create,
   deleteSkillAssessment,
   getById,
-  getByUserAndSkill,
   getList,
 };
+
+export default skillAssessments;