@stackfactor/client-api 1.1.128 → 1.1.129

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

@@ -5,8 +5,8 @@ import { client } from "./axiosClient.js";
  * @param {String} id The id of the training plan to be deleted
  * @param {String} token Authorization token
  */
-const archiveTrainingPlan = (id, token) => {
-  return new Promise(function (resolve, reject) {
+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 },
     });
@@ -27,14 +27,19 @@ const archiveTrainingPlan = (id, token) => {
  * @param {Boolean} saveAsDraft Save as draft flag
  * @param {String} token Authorization token
  */
-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 },
@@ -55,15 +60,18 @@ const createTrainingPlan = (data, type, saveAsDraft, token) => {
  * @param {String} comments The comments for approver
  * @param {String} token Authorization token
  */
-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;
     const request = client.delete(`api/v1/trainingplans/`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -81,8 +89,11 @@ const deleteTrainingPlan = (id, comments, token) => {
  * @param {String} id The id of the training plan to be deleted
  * @param {String} token Authorization token
  */
-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 },
     });
@@ -97,7 +108,7 @@ 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
@@ -105,14 +116,14 @@ const discardTrainingPlanChanges = (id, token) => {
  * @param {String} token Authorization token
  */
 const generateNewBaseline = (
-  id,
-  data,
-  returnMinimized,
-  saveBaseline,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+  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,
@@ -136,12 +147,17 @@ 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
  */
-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}`,
       {
@@ -162,8 +178,10 @@ const getTrainingPlanById = (id, version, token) => {
  * Get tasks summary for a recipient across all of the training plans
  * @param {String} token Authorization token
  */
-const getAllTrainingPlansTasksSummary = async (token = null) => {
-  return new Promise(function (resolve, reject) {
+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 } : {},
     });
@@ -176,28 +194,30 @@ const getAllTrainingPlansTasksSummary = async (token = null) => {
       });
   });
 };
+
 /**
  * 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
  */
 const getListOfTrainingPlans = (
-  users,
-  types,
-  version,
-  fields,
-  includeDeleted,
-  includeDetailedInformation,
-  returnDefaultIfVersionNotAvailable,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+  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,
@@ -225,9 +245,13 @@ const getListOfTrainingPlans = (
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-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}`,
@@ -248,12 +272,18 @@ 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
  */
-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,
@@ -283,8 +313,12 @@ const updateTrainingPlan = (planId, data, saveAsDraft, token) => {
  * @param {String} token
  * @returns {Promise<Object>}
  */
-const updateTrainingPlanTaskStatus = (id, status, token) => {
-  return new Promise(function (resolve, reject) {
+const updateTrainingPlanTaskStatus = (
+  id: string,
+  status: number,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let data = {
       id: id,
       status: status,
@@ -294,7 +328,7 @@ const updateTrainingPlanTaskStatus = (id, status, token) => {
     });
     confirmationRequest
       .then(() => {
-        resolve();
+        resolve({});
       })
       .catch((error) => {
         reject(error);
@@ -306,12 +340,15 @@ const updateTrainingPlanTaskStatus = (id, status, token) => {
  * 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>}
  */
-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,
@@ -321,7 +358,7 @@ const updateActivities = (planId, data, token) => {
     );
     confirmationRequest
       .then(() => {
-        resolve();
+        resolve({});
       })
       .catch((error) => {
         reject(error);

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

@@ -4,10 +4,13 @@ import { client } from "./axiosClient.js";
  * Get training plan proficiency level
  * @param {String} proficiencyLevelId
  * @param {String} token
- * @returns {Object} An object containing the proficiency level information
+ * @returns {Promise<Object>} An object containing the proficiency level information
  */
-const getTrainingPlanProficiencyLevel = (proficiencyLevelId, token) => {
-  return new Promise(function (resolve, reject) {
+const getTrainingPlanProficiencyLevel = (
+  proficiencyLevelId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/trainingplans/proficiencylevels/${proficiencyLevelId}`,
       {
@@ -30,14 +33,15 @@ const getTrainingPlanProficiencyLevel = (proficiencyLevelId, token) => {
  * @param {Boolean} includeDetailedInformation If set to true it will return detailed information for each plan
  * @param {Boolean} includeArchived If set to true it will return all the closed items too
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
 const getTrainingPlanProficiencyLevelList = (
-  includeDeleted,
-  includeDetailedInformation,
-  includeArchived,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  includeDeleted: boolean,
+  includeDetailedInformation: boolean,
+  includeArchived: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       includeArchived: includeArchived,
       includeDeleted: includeDeleted,
@@ -61,13 +65,16 @@ const getTrainingPlanProficiencyLevelList = (
 };
 
 /**
- * Reoder training plan proficiency levels
- * @param {Array<Object>} data
+ * Reorder training plan proficiency levels
+ * @param {Array<Object>} order
  * @param {String} token
- * @returns
+ * @returns {Promise<void>}
  */
-const reorderTrainingPlansProficiencyLevels = (order, token) => {
-  return new Promise(function (resolve, reject) {
+const reorderTrainingPlansProficiencyLevels = (
+  order: object[],
+  token: string
+): Promise<void> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.post(
       `api/v1/trainingplans/proficiencylevels/reorder`,
       { order: order },
@@ -87,18 +94,17 @@ const reorderTrainingPlansProficiencyLevels = (order, token) => {
 
 /**
  * Update a training plan proficiency level
- * @param {String} planId
+ * @param {String} proficiencyLevelId
  * @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
+ * @returns {Promise<void>}
  */
 const updateTrainingPlanProficiencyLevel = (
-  proficiencyLevelId,
-  data,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  proficiencyLevelId: string,
+  data: object,
+  token: string
+): Promise<void> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.post(
       `api/v1/trainingplans/proficiencylevel/${proficiencyLevelId}`,
       data,

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

@@ -6,9 +6,15 @@ import { client } from "./axiosClient.js";
  * @param {String} property
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const addEntryToArrayBusinessProperty = (userId, property, data, token) => {
-  return new Promise(function (resolve, reject) {
+const addEntryToArrayBusinessProperty = (
+  userId: string,
+  property: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
@@ -30,14 +36,20 @@ const addEntryToArrayBusinessProperty = (userId, property, data, token) => {
 };
 
 /**
- * Update an entry from an array type business property such as experience, education or certifications
+ * Remove an entry from an array type business property such as experience, education or certifications
  * @param {String} userId
  * @param {String} property
  * @param {String} id
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const removeEntryFromArrayBusinessProperty = (userId, property, id, token) => {
-  return new Promise(function (resolve, reject) {
+const removeEntryFromArrayBusinessProperty = (
+  userId: string,
+  property: string,
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const confirmationRequest = client.delete(
       `api/v1/user/arrayproperty/${userId}/${property}/${id}`,
       {
@@ -61,15 +73,16 @@ const removeEntryFromArrayBusinessProperty = (userId, property, id, token) => {
  * @param {String} id
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
 const updateEntryfromArrayBusinessProperty = (
-  userId,
-  property,
-  id,
-  data,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  userId: string,
+  property: string,
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };