@stackfactor/client-api 1.1.11 → 1.1.12-9.2

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

@@ -5,9 +5,14 @@ import { client } from "./axiosClient.js";
  * @param {String} teamId The team Id
  * @param {Array<String>} users The users to be added
  * @param {String} authToken - Authentication token
+ * @returns {Promise<Object>}
  */
-export const addUsersToTeam = (teamId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
+const addUsersToTeam = (
+  teamId: string,
+  users: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/users/add`,
       {
@@ -32,9 +37,15 @@ export const addUsersToTeam = (teamId, users, authToken) => {
  * @param {String} managerId The id of the manager
  * @param {String} description The description of the team
  * @param {String} authToken The authorization token
+ * @returns {Promise<Object>}
  */
-export const createTeam = (name, managerId, description, authToken) => {
-  return new Promise(function (resolve, reject) {
+const createTeam = (
+  name: string,
+  managerId: string,
+  description: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/team`,
       {
@@ -59,9 +70,14 @@ export const createTeam = (name, managerId, description, authToken) => {
  * @param {String} teamId The team to be deleted
  * @param {String} defaultTeamId The default team all the users will be moved to
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const deleteTeam = (teamId, defaultTeamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const deleteTeam = (
+  teamId: string,
+  defaultTeamId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`api/v1/teams/delete`, {
       headers: { authorization: authToken },
       data: {
@@ -84,13 +100,14 @@ export const deleteTeam = (teamId, defaultTeamId, authToken) => {
  * @param {String} teamId The team Id
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getTeamById = (
-  teamId,
-  includeUserSummaryInformation,
-  authToken
-) => {
-  return new Promise(function (resolve, reject) {
+const getTeamById = (
+  teamId: string,
+  includeUserSummaryInformation: boolean,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/team/${teamId}`,
       {
@@ -112,9 +129,13 @@ export const getTeamById = (
  * Get team roles
  * @param {String} teamId The team Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getTeamByIdRoles = (teamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTeamByIdRoles = (
+  teamId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/teams/getroles/${teamId}`, {
       headers: { authorization: authToken },
     });
@@ -130,11 +151,11 @@ export const getTeamByIdRoles = (teamId, authToken) => {
 
 /**
  * Get teams for current tenant
- * @param {String} userId
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getTeams = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTeams = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/teams/`, {
       headers: { authorization: authToken },
     });
@@ -153,15 +174,16 @@ export const getTeams = (authToken) => {
  * @param {String} userId
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getTeamByUserId = (
-  userId,
-  includeUserSummaryInformation,
-  authToken
-) => {
-  return new Promise(function (resolve, reject) {
+const getTeamByUserId = (
+  userId: string,
+  includeUserSummaryInformation: boolean,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
-      `/api/v1/teams/getuserteam/${userId ? userId : ""}`,
+      `/api/v1/teams/getuserteam/${userId || ""}`,
       {
         includeUserSummaryInformation: includeUserSummaryInformation,
       },
@@ -181,9 +203,13 @@ export const getTeamByUserId = (
  * Get top team in the organization, usually the executive team
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getTopTeam = (includeUserSummaryInformation, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTopTeam = (
+  includeUserSummaryInformation: boolean,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/gettopteam`,
       {
@@ -206,9 +232,14 @@ export const getTopTeam = (includeUserSummaryInformation, authToken) => {
  * @param {String} teamId The team Id
  * @param {Array<String>} users The users to be removed from the team
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const removeUsersFromTeam = (teamId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
+const removeUsersFromTeam = (
+  teamId: string,
+  users: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/users/remove/`,
       {
@@ -227,13 +258,14 @@ export const removeUsersFromTeam = (teamId, users, authToken) => {
   });
 };
 
-/*
- * Set team as defualt
+/**
+ * Set team as default
  * @param {String} teamId The team Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const setDefault = (teamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const setDefault = (teamId: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.put(
       `api/v1/teams/setDefault/`,
       {
@@ -254,11 +286,16 @@ export const setDefault = (teamId, authToken) => {
 /**
  * Update team
  * @param {String} teamId The team Id
- * @param {String} data The updated name of the team
+ * @param {Object} data The updated data of the team
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const updateTeam = (teamId, data, authToken) => {
-  return new Promise(function (resolve, reject) {
+const updateTeam = (
+  teamId: string,
+  data: object,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.patch(
       `api/v1/teams/team/`,
       {
@@ -277,7 +314,7 @@ export const updateTeam = (teamId, data, authToken) => {
   });
 };
 
-const team = {
+export default {
   addUsersToTeam,
   createTeam,
   deleteTeam,
@@ -290,5 +327,3 @@ const team = {
   setDefault,
   updateTeam,
 };
-
-export default team;

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

@@ -4,11 +4,15 @@ import { client } from "./axiosClient.js";
  * Get tenant information
  * @param {String} category Tenant information category
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const getTenantInformation = (categories, token) => {
-  return new Promise(function (resolve, reject) {
+const getTenantInformation = (
+  category: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
-      categories: categories,
+      categories: category,
     };
     let request = client.post("api/v1/tenants/tenant/get", requestData, {
       headers: { authorization: token },
@@ -26,11 +30,16 @@ export const getTenantInformation = (categories, token) => {
 /**
  * Set tenant profile information
  * @param {String} category Tenant information category
- * @param {String} data New or updated tenant data information
- * @param {Object} token Authorization token
+ * @param {Object} data New or updated tenant data information
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const setTenantInformation = (category, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setTenantInformation = (
+  category: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       category: category,
       data: data,
@@ -52,6 +61,4 @@ export const setTenantInformation = (category, data, token) => {
   });
 };
 
-const tenant = { getTenantInformation, setTenantInformation };
-
-export default tenant;
+export default { getTenantInformation, setTenantInformation };

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

@@ -1,5 +1,25 @@
 import { client } from "./axiosClient.js";
 
+/**
+ * Archive the training plan
+ * @param {String} id The id of the training plan to be deleted
+ * @param {String} token Authorization token
+ */
+const archiveTrainingPlan = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const request = client.get(`api/v1/trainingplans/archive/${id}`, {
+      headers: { authorization: token },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
 /**
  * Create training plan and set information
  * @param {Object} data
@@ -7,14 +27,19 @@ import { client } from "./axiosClient.js";
  * @param {Boolean} saveAsDraft Save as draft flag
  * @param {String} token Authorization token
  */
-export const createTrainingPlan = (data, type, saveAsDraft, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
-      data: {
-        ...data,
-      },
-      saveAsDraft,
-      type,
+const createTrainingPlan = (
+  data: object,
+  type: number,
+  saveAsDraft: boolean,
+  token: string
+): Promise<void> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { version: string; includeDeleted: boolean; includeDetailedInformation: boolean; returnDefaultIfVersionNotAvailable: boolean; fields?: string[]; types?: number[]; users?: string[] } = {
+      version: "1.0",
+      includeDeleted: false,
+      includeDetailedInformation: true,
+      returnDefaultIfVersionNotAvailable: true,
+      types: [type],
     };
     let confirmationRequest = client.put("api/v1/trainingplans", requestData, {
       headers: { authorization: token },
@@ -35,9 +60,13 @@ export const createTrainingPlan = (data, type, saveAsDraft, token) => {
  * @param {String} comments The comments for approver
  * @param {String} token Authorization token
  */
-export const deleteTrainingPlan = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    const data = {
+const deleteTrainingPlan = (
+  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;
@@ -60,8 +89,11 @@ export const deleteTrainingPlan = (id, comments, token) => {
  * @param {String} id The id of the training plan to be deleted
  * @param {String} token Authorization token
  */
-export const discardTrainingPlanChanges = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const discardTrainingPlanChanges = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/trainingplans/discard/${id}`, {
       headers: { authorization: token },
     });
@@ -76,22 +108,22 @@ export const discardTrainingPlanChanges = (id, token) => {
 };
 
 /**
- * Create a new baselie
+ * Create a new baseline
  * @param {String} id The Id of the plan for which a new baseline is to be generated
  * @param {Object} data The data
  * @param {Boolean} returnMinimized If set to true just high level plan baseline information will be returned
  * @param {Boolean} saveBaseline If set to true it will save the baseline
  * @param {String} token Authorization token
  */
-export const generateNewBaseline = (
-  id,
-  data,
-  returnMinimized,
-  saveBaseline,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+const generateNewBaseline = (
+  id: string,
+  data: object,
+  returnMinimized: boolean,
+  saveBaseline: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { data: object; returnMinimized: boolean; saveBaseline: boolean; id?: string } = {
       data: data,
       returnMinimized: returnMinimized,
       saveBaseline: saveBaseline,
@@ -115,12 +147,17 @@ export const generateNewBaseline = (
 };
 
 /**
- * Get traing plan information
+ * Get training plan information
  * @param {String} id The id of the training plan
+ * @param {String} version The version of the training plan
  * @param {String} token Authorization token
  */
-export const getTrainingPlanById = (id, version, token) => {
-  return new Promise(function (resolve, reject) {
+const getTrainingPlanById = (
+  id: string,
+  version: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/trainingplans/${id}/${version}`,
       {
@@ -137,28 +174,50 @@ export const getTrainingPlanById = (id, version, token) => {
   });
 };
 
+/**
+ * Get tasks summary for a recipient across all of the training plans
+ * @param {String} token Authorization token
+ */
+const getAllTrainingPlansTasksSummary = (
+  token: string | null = null
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let confirmationRequest = client.get(`api/v1/trainingplans/taskssummary`, {
+      headers: token ? { authorization: token } : {},
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
 /**
  * Get training plans list
- * @param {Array<ObjectId>} users The list of users for which the plans should be loaded
- * @param {Array<Number>} types The types of plans to be loaded
+ * @param {Array<string>} users The list of users for which the plans should be loaded
+ * @param {Array<number>} types The types of plans to be loaded
  * @param {String} version The version of the document to be retrieved
- * @param {Array<String>} fields The fields to be selected
+ * @param {Array<string>} fields The fields to be selected
  * @param {Boolean} includeDeleted If set true it will return deleted plans too
+ * @param {Boolean} includeDetailedInformation If set true it will return detailed information
  * @param {Boolean} returnDefaultIfVersionNotAvailable If set to true it will load the draft information if the plan was never published
  * @param {String} token Authorization token
  */
-export const getListOfTrainingPlans = (
-  users,
-  types,
-  version,
-  fields,
-  includeDeleted,
-  includeDetailedInformation,
-  returnDefaultIfVersionNotAvailable,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+const getListOfTrainingPlans = (
+  users: string[],
+  types: number[],
+  version: string,
+  fields: string[],
+  includeDeleted: boolean,
+  includeDetailedInformation: boolean,
+  returnDefaultIfVersionNotAvailable: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { version: string; includeDeleted: boolean; includeDetailedInformation: boolean; returnDefaultIfVersionNotAvailable: boolean; fields?: string[]; types?: number[]; users?: string[] } = {
       version: version,
       includeDeleted: includeDeleted,
       includeDetailedInformation: includeDetailedInformation,
@@ -186,9 +245,13 @@ export const getListOfTrainingPlans = (
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-export const publishTrainingPlan = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {};
+const publishTrainingPlan = (
+  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/trainingplans/publish/${id}`,
@@ -209,12 +272,18 @@ export const publishTrainingPlan = (id, comments, token) => {
 
 /**
  * Update training plan
- * @param {String} id The ID of the training plan
+ * @param {String} planId The ID of the training plan
  * @param {Object} data The updated data
+ * @param {Boolean} saveAsDraft Save as draft flag
  * @param {String} token Authorization token
  */
-export const updateTrainingPlan = (planId, data, saveAsDraft, token) => {
-  return new Promise(function (resolve, reject) {
+const updateTrainingPlan = (
+  planId: string,
+  data: object,
+  saveAsDraft: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: planId,
@@ -237,16 +306,49 @@ export const updateTrainingPlan = (planId, data, saveAsDraft, token) => {
   });
 };
 
+/**
+ * Update training plan task status
+ * @param {String} id The ID of the training plan
+ * @param {Number} status
+ * @param {String} token
+ * @returns {Promise<Object>}
+ */
+const updateTrainingPlanTaskStatus = (
+  id: string,
+  status: number,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data = {
+      id: id,
+      status: status,
+    };
+    let confirmationRequest = client.post(`api/v1/trainingplans/task`, data, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then(() => {
+        resolve({});
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
 /**
  * Update a task
  * @param {String} planId
  * @param {Object} data Ordered array of objects containing the activity Id and the new status
- * @param {Function} successCallBack
- * @param {Function} failCallBack
- * @returns {Object} An object containing the task information
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const updateActivities = (planId, data, token) => {
-  return new Promise(function (resolve, reject) {
+const updateActivities = (
+  planId: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.post(
       `api/v1/trainingplans/${planId}/activities`,
       data,
@@ -256,7 +358,7 @@ export const updateActivities = (planId, data, token) => {
     );
     confirmationRequest
       .then(() => {
-        resolve();
+        resolve({});
       })
       .catch((error) => {
         reject(error);
@@ -264,16 +366,17 @@ export const updateActivities = (planId, data, token) => {
   });
 };
 
-const trainingPlan = {
+export default {
+  archiveTrainingPlan,
   createTrainingPlan,
   deleteTrainingPlan,
   discardTrainingPlanChanges,
   generateNewBaseline,
+  getAllTrainingPlansTasksSummary,
   getTrainingPlanById,
   getListOfTrainingPlans,
   publishTrainingPlan,
   updateTrainingPlan,
+  updateTrainingPlanTaskStatus,
   updateActivities,
 };
-
-export default trainingPlan;