@stackfactor/client-api 1.1.11 → 1.1.12-9.2

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

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

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

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

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

@@ -5,9 +5,14 @@ import { client } from "./axiosClient.js";
  * @param {String} groupId The group Id
  * @param {Array<String>} permissions The permissions to be added
  * @param {String} authToken - Authentication token
+ * @returns {Promise<Object>}
  */
-export const addPermissionsToGroup = (groupId, permissions, authToken) => {
-  return new Promise(function (resolve, reject) {
+const addPermissionsToGroup = (
+  groupId: string,
+  permissions: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/groups/permissions/add`,
       {
@@ -31,9 +36,14 @@ export const addPermissionsToGroup = (groupId, permissions, authToken) => {
  * @param {String} groupId The group Id
  * @param {Array<String>} users The users to be added
  * @param {String} authToken - Authentication token
+ * @returns {Promise<Object>}
  */
-export const addUsersToGroup = (groupId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
+const addUsersToGroup = (
+  groupId: string,
+  users: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/groups/users/add`,
       {
@@ -57,9 +67,14 @@ export const addUsersToGroup = (groupId, users, authToken) => {
  * @param {String} name The name of the group
  * @param {String} description The description of the group
  * @param {String} authToken The authorization token
+ * @returns {Promise<Object>}
  */
-export const createGroup = (name, description, authToken) => {
-  return new Promise(function (resolve, reject) {
+const createGroup = (
+  name: string,
+  description: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/groups/group`,
       {
@@ -83,9 +98,14 @@ export const createGroup = (name, description, authToken) => {
  * @param {String} groupId The group to be deleted
  * @param {String} defaultGroupId The default group all the users will be moved to
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const deleteGroup = (groupId, defaultGroupId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const deleteGroup = (
+  groupId: string,
+  defaultGroupId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`api/v1/groups/delete`, {
       headers: { authorization: authToken },
       data: {
@@ -106,9 +126,10 @@ export const deleteGroup = (groupId, defaultGroupId, authToken) => {
 /**
  * Get all permissions
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getAllPermissions = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getAllPermissions = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/groups/permissions/getAllPermissions`, {
       headers: { authorization: authToken },
     });
@@ -126,9 +147,10 @@ export const getAllPermissions = (authToken) => {
  * Get group by Id
  * @param {String} groupId The group Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getGroupById = (groupId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getGroupById = (groupId: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/groups/group/${groupId}`, {
       headers: { authorization: authToken },
     });
@@ -145,9 +167,10 @@ export const getGroupById = (groupId, authToken) => {
 /**
  * Get groups for current tenant
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getGroups = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getGroups = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/groups/`, {
       headers: { authorization: authToken },
     });
@@ -164,9 +187,10 @@ export const getGroups = (authToken) => {
 /**
  * Get current user permissions
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const getUserPermissions = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getUserPermissions = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/groups/users/getuserpermissions`, {
       headers: { authorization: authToken },
     });
@@ -185,9 +209,14 @@ export const getUserPermissions = (authToken) => {
  * @param {String} groupId The group Id
  * @param {Array<String>} permissions The permissions to be removed from the group
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const removePermissionsFromGroup = (groupId, permissions, authToken) => {
-  return new Promise(function (resolve, reject) {
+const removePermissionsFromGroup = (
+  groupId: string,
+  permissions: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/groups/permissions/remove/`,
       {
@@ -211,9 +240,14 @@ export const removePermissionsFromGroup = (groupId, permissions, authToken) => {
  * @param {String} groupId The group Id
  * @param {Array<String>} users The users to be removed from the group
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const removeUsersFromGroup = (groupId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
+const removeUsersFromGroup = (
+  groupId: string,
+  users: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/groups/users/remove/`,
       {
@@ -232,13 +266,14 @@ export const removeUsersFromGroup = (groupId, users, authToken) => {
   });
 };
 
-/*
- * Set group as defualt
+/**
+ * Set group as default
  * @param {String} groupId The group Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const setDefault = (groupId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const setDefault = (groupId: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.put(
       `api/v1/groups/setDefault/`,
       {
@@ -262,9 +297,15 @@ export const setDefault = (groupId, authToken) => {
  * @param {String} name The updated name of the group
  * @param {String} description The updated description of the group
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-export const updateGroup = (groupId, name, description, authToken) => {
-  return new Promise(function (resolve, reject) {
+const updateGroup = (
+  groupId: string,
+  name: string,
+  description: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.patch(
       `api/v1/groups/group/`,
       {
@@ -284,7 +325,7 @@ export const updateGroup = (groupId, name, description, authToken) => {
   });
 };
 
-const groups = {
+export default {
   addPermissionsToGroup,
   addUsersToGroup,
   createGroup,
@@ -298,5 +339,3 @@ const groups = {
   setDefault,
   updateGroup,
 };
-
-export default groups;