@stackfactor/client-api 1.1.128 → 1.1.130

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

@@ -4,10 +4,10 @@ import { client } from "./axiosClient.js";
  * Create skill and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const createSkill = (data, token) => {
-  return new Promise(function (resolve, reject) {
+const createSkill = (data: object, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.put(
       "api/v1/skills",
       { data: data },
@@ -27,12 +27,15 @@ const createSkill = (data, token) => {
 
 /**
  * Create skills from templates
- * @param {Array<String>} templateIds,
+ * @param {Array<String>} templateIds
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const createSkillsFromTemplates = (templateIds, token) => {
-  return new Promise(function (resolve, reject) {
+const createSkillsFromTemplates = (
+  templateIds: string[],
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       templateIds: templateIds,
     };
@@ -58,17 +61,20 @@ const createSkillsFromTemplates = (templateIds, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const deleteSkill = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    const data = {
+const deleteSkill = (
+  id: string,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const data: { id: string; comments?: string } = {
       id: id,
     };
     if (comments) data.comments = comments;
     const request = client.delete(`api/v1/skills/`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -83,16 +89,15 @@ const deleteSkill = (id, comments, token) => {
 
 /**
  * Discard the skill draft changes
- * @param {String} id The id of the skill to be deleted
+ * @param {String} id The id of the skill to be discarded
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const discardSkillChanges = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const discardSkillChanges = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const data = {};
     const request = client.get(`api/v1/skills/discard/${id}`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -107,16 +112,15 @@ const discardSkillChanges = (id, token) => {
 
 /**
  * Get the list of imported skill templates
- * @param {String} token
- * @returns {Promise}
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getImportedSkillTemplates = (token) => {
-  return new Promise(function (resolve, reject) {
+const getImportedSkillTemplates = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/skills/getimportedskilltemplates`, {
       headers: { authorization: token },
     });
     request
-
       .then((response) => {
         resolve(response.data);
       })
@@ -129,12 +133,16 @@ const getImportedSkillTemplates = (token) => {
 /**
  * Get the skill related roles
  * @param {String} id
- * @param {String} token
+ * @param {String} token Authorization token
  * @param {Boolean} includeRoleInformation
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const getSkillRelatedRoles = (id, token, includeRoleInformation = false) => {
-  return new Promise(function (resolve, reject) {
+const getSkillRelatedRoles = (
+  id: string,
+  token: string,
+  includeRoleInformation = false
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skills/getskillrelatedroles/${id}/${includeRoleInformation}`,
       {
@@ -154,11 +162,14 @@ const getSkillRelatedRoles = (id, token, includeRoleInformation = false) => {
 /**
  * Get skill required assessment type
  * @param {String} id
- * @param {String} token
- * @returns {Promise}
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getSkillRequiredAssessmentType = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const getSkillRequiredAssessmentType = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skills/getrequiredassessmenttype/${id}`,
       {
@@ -176,20 +187,20 @@ const getSkillRequiredAssessmentType = (id, token) => {
 };
 
 /**
- * Get skill skill information
+ * Get 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}
+ * @returns {Promise<Object>}
  */
 const getSkillInformationById = (
-  id,
-  version,
-  returnNullIfVersionNotFound,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  id: string,
+  version: string,
+  returnNullIfVersionNotFound: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skills/skill/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
@@ -214,22 +225,23 @@ 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}
+ * @returns {Promise<Object>}
  */
 const getSkillList = (
-  filter,
-  version,
-  includeDeleted,
-  returnDefaultIfVersionNotAvailable,
-  namesOnly,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  filter: string[],
+  version: string,
+  includeDeleted: boolean,
+  returnDefaultIfVersionNotAvailable: boolean,
+  namesOnly: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((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, {
@@ -251,15 +263,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}
+ * @returns {Promise<Object>}
  */
 const getTeamSkillsById = (
-  teamId,
-  maxDepth,
-  returnNullIfVersionNotFound,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  teamId: string,
+  maxDepth: number,
+  returnNullIfVersionNotFound: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skills/getteambyid/${teamId}/${maxDepth}/${returnNullIfVersionNotFound}`,
       {
@@ -280,10 +292,13 @@ 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}
+ * @returns {Promise<Object>}
  */
-const getCurrentUserTeamSkills = (maxDepth, token) => {
-  return new Promise(function (resolve, reject) {
+const getCurrentUserTeamSkills = (
+  maxDepth: number,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skills/getcurrentuserteam/${maxDepth}`,
       {
@@ -303,11 +318,14 @@ const getCurrentUserTeamSkills = (maxDepth, token) => {
 /**
  * Get skill template updates
  * @param {String} id The skill id
- * @param {String} token
- * @returns {Promise}
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getSkillTemplateUpdates = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const getSkillTemplateUpdates = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skills/getskilltemplateupdates/${id}`,
       {
@@ -328,11 +346,15 @@ const getSkillTemplateUpdates = (id, token) => {
  * 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
- * @returns {Promise}
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const importSkillTemplates = (data, publish, token) => {
-  return new Promise(function (resolve, reject) {
+const importSkillTemplates = (
+  data: string[],
+  publish: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       publish: publish,
@@ -345,7 +367,6 @@ const importSkillTemplates = (data, publish, token) => {
       }
     );
     confirmationRequest
-
       .then((response) => {
         resolve(response.data);
       })
@@ -360,11 +381,15 @@ const importSkillTemplates = (data, publish, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const publishSkill = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {};
+const publishSkill = (
+  id: string,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: { comments?: string } = {};
     if (comments) data.comments = comments;
     let confirmationRequest = client.post(`api/v1/skills/publish/${id}`, data, {
       headers: { authorization: token },
@@ -384,10 +409,14 @@ const publishSkill = (id, comments, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const setSkillInformation = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setSkillInformation = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,
@@ -414,10 +443,14 @@ const setSkillInformation = (id, data, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const setSkillInformationFromTemplate = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setSkillInformationFromTemplate = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,
@@ -443,10 +476,10 @@ const setSkillInformationFromTemplate = (id, data, token) => {
  * Validate skill information
  * @param {String} id The id of the skill to be updated
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const validateSkill = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const validateSkill = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
     };
@@ -472,10 +505,14 @@ const validateSkill = (id, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const watchSkill = (id, watch, token) => {
-  return new Promise(function (resolve, reject) {
+const watchSkill = (
+  id: string,
+  watch: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
       watch: watch,

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

@@ -6,9 +6,15 @@ import { client } from "./axiosClient.js";
  * @param {Object} data
  * @param {String} comments
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const addEntry = (id, data, comments, token) => {
-  return new Promise(function (resolve, reject) {
+const addEntry = (
+  id: string,
+  data: object,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       comments: comments,
       data: data,
@@ -37,9 +43,15 @@ const addEntry = (id, data, comments, token) => {
  * @param {String} comments
  * @param {String} userId
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const create = (data, comments, userId, token) => {
-  return new Promise(function (resolve, reject) {
+const create = (
+  data: object,
+  comments: string,
+  userId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       comments: comments,
       data: data,
@@ -67,16 +79,20 @@ const create = (data, comments, userId, token) => {
  * @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, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    const data = {
+const deleteSkillAssessment = (
+  id: number,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const data: { id: number, comments?: string } = {
       id: id,
     };
     if (comments) data.comments = comments;
     const request = client.delete(`api/v1/skillassessments`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -93,9 +109,10 @@ const deleteSkillAssessment = (id, comments, token) => {
  * Get skill assessment by id
  * @param {String} id
  * @param {String} token
+ * @returns {Promise<Object>}
  */
-const getById = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const getById = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
       headers: { authorization: token },
     });
@@ -114,10 +131,14 @@ const getById = (id, token) => {
  * @param {String} userId
  * @param {String} skillId
  * @param {String} token
- * @returns  {Promise<Object>} The skill assessment
+ * @returns {Promise<Object>} The skill assessment
  */
-const getByUserAndSkill = (userId, skillId, token) => {
-  return new Promise(function (resolve, reject) {
+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}`,
       {
@@ -136,12 +157,13 @@ const getByUserAndSkill = (userId, skillId, token) => {
 
 /**
  * Get list
- * @param {Object} userId The user used to select the skill
+ * @param {String} userId The user used to select the skill
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getList = (userId, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {};
+const getList = (userId: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { userId?: string } = {};
     if (userId) requestData.userId = userId;
     let confirmationRequest = client.post(
       `api/v1/skillassessments`,

package/lib/skillAssessments.ts

@@ -0,0 +1,192 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Add new entry skill assessment
+ * @param {String} id
+ * @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) => {
+    const requestData = {
+      comments: comments,
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.put(
+      "api/v1/skillassessments/addentry",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Create skill assessment
+ * @param {Object} data
+ * @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) => {
+    const requestData = {
+      comments: comments,
+      data: data,
+      userId: userId,
+    };
+    let confirmationRequest = client.put(
+      "api/v1/skillassessments/",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete skill assessment
+ * @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 } = {
+      id: id,
+    };
+    if (comments) data.comments = comments;
+    const request = client.delete(`api/v1/skillassessments`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * 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) => {
+    let confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
+      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 {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 {String} token Authorization token
+ * @returns {Promise<Object>}
+ */
+const getList = (userId: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { userId?: string } = {};
+    if (userId) requestData.userId = userId;
+    let confirmationRequest = client.post(
+      `api/v1/skillassessments`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+export default {
+  addEntry,
+  create,
+  deleteSkillAssessment,
+  getById,
+  getByUserAndSkill,
+  getList,
+};