@stackfactor/client-api 1.1.128 → 1.1.130

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

@@ -1,20 +1,30 @@
 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>}
  */
 const createDepartmentTrainingPlan = (
-  name,
-  summary,
-  skill,
-  activities,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  name: string,
+  summary: string,
+  skill: string,
+  activities: Activity[],
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       name: name || "",
       summary: summary || "",
@@ -42,12 +52,15 @@ 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>}
  */
-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: {
         id: id,
       },
@@ -63,12 +76,18 @@ 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>}
  */
-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}`,
       {
@@ -87,11 +106,17 @@ const getDepartmentTrainingPlanInformationById = (id, version, token) => {
 
 /**
  * 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>}
  */
-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 || "",
       version: version,
@@ -117,9 +142,13 @@ 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>}
  */
-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}`,
       {},
@@ -142,9 +171,14 @@ 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>}
  */
-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,
     };
@@ -165,7 +199,7 @@ const setDepartmentTrainingPlanInformation = (id, data, token) => {
   });
 };
 
-const departmentTraingPlans = {
+const departmentTrainingPlans = {
   createDepartmentTrainingPlan,
   deleteDepartmentTrainingPlan,
   getDepartmentTrainingPlanInformationById,
@@ -174,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>}
  */
-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 @@ 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>}
  */
-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 @@ 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>}
  */
-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 @@ 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>}
  */
-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 @@ const deleteGroup = (groupId, defaultGroupId, authToken) => {
 /**
  * Get all permissions
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-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 @@ const getAllPermissions = (authToken) => {
  * Get group by Id
  * @param {String} groupId The group Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-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 @@ const getGroupById = (groupId, authToken) => {
 /**
  * Get groups for current tenant
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-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 @@ const getGroups = (authToken) => {
 /**
  * Get current user permissions
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-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 @@ 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>}
  */
-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 @@ 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>}
  */
-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 @@ 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>}
  */
-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 @@ 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>}
  */
-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/`,
       {

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

@@ -3,14 +3,42 @@ import axiosLib from "axios";
 import htmlParser from "node-html-parser";
 import htmlToText from "html2plaintext";
 
+interface IntegrationData {
+  data: object;
+}
+
+interface IntegrationFilter {
+  filter?: string[];
+  type?: string;
+  version: string;
+  includeSupportedCapabilities: boolean;
+}
+
+interface ContentInformation {
+  url: string;
+  verb: string;
+}
+
+interface ContentInformationResponse {
+  description: string;
+  duration: number;
+  icon: string;
+  title: string;
+  type: number;
+  internal: boolean;
+}
+
 /**
  * Create integration and set information
  * @param {Object} data The new integration information
  * @param {String} token Authorization token
  */
-export const createIntegration = (data, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+export const createIntegration = (
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: IntegrationData = {
       data: data,
     };
     let confirmationRequest = client.put("api/v1/integrations/", requestData, {
@@ -31,8 +59,11 @@ export const createIntegration = (data, token) => {
  * @param {String} id The id of the integration to be deleted
  * @param {String} token Authorization token
  */
-export const deleteIntegration = (id, token) => {
-  return new Promise(function (resolve, reject) {
+export const deleteIntegration = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`api/v1/integrations/`, {
       headers: { authorization: token },
       data: {
@@ -54,8 +85,11 @@ export const deleteIntegration = (id, token) => {
  * @param {String} id The id of the role template to be deleted
  * @param {String} token Authorization token
  */
-export const discardIntegrationChanges = (id, token) => {
-  return new Promise(function (resolve, reject) {
+export const discardIntegrationChanges = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const data = {};
     const request = client.get(`api/v1/integrations/discard/${id}`, {
       headers: { authorization: token },
@@ -77,8 +111,12 @@ export const discardIntegrationChanges = (id, token) => {
  * @param {String} version The version of the integration to be received
  * @param {String} token Authorization token
  */
-export const getIntegrationInformationById = (id, version, token) => {
-  return new Promise(function (resolve, reject) {
+export const getIntegrationInformationById = (
+  id: string,
+  version: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/integrations/${id}/${version}`,
       {
@@ -104,14 +142,14 @@ export const getIntegrationInformationById = (id, version, token) => {
  * @param {String} token Authorization token
  */
 export const getIntegrationsList = (
-  filter,
-  type,
-  version,
-  includeSupportedCapabilities,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+  filter: string[],
+  type: string,
+  version: string,
+  includeSupportedCapabilities: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: IntegrationFilter = {
       includeSupportedCapabilities: includeSupportedCapabilities,
       version: version,
     };
@@ -136,9 +174,13 @@ export const getIntegrationsList = (
  * @param {String} verb The verb
  * @param {String} token Authorization token
  */
-export const getContentInformationByUrl = (url, verb, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+export const getContentInformationByUrl = (
+  url: string,
+  verb: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: ContentInformation = {
       url: url,
       verb: verb,
     };
@@ -162,10 +204,12 @@ export const getContentInformationByUrl = (url, verb, token) => {
 /**
  * Get content information by url from the browser instead of the backend
  * @param {String} url
- * @returns {Object}
+ * @returns {Promise<ContentInformationResponse>}
  */
-export const getContentInformationByUrlFromBrowser = (url) => {
-  return new Promise(function (resolve, reject) {
+export const getContentInformationByUrlFromBrowser = (
+  url: string
+): Promise<ContentInformationResponse> => {
+  return new Promise((resolve, reject) => {
     let domain = new URL(url);
     let instance = axiosLib.create({
       baseURL: domain.origin,
@@ -175,7 +219,7 @@ export const getContentInformationByUrlFromBrowser = (url) => {
         "Access-Control-Allow-Origin": "*",
         "Access-Control-Allow-Headers":
           "Authorization, Origin, X-Requested-With, Content-Type, Accept",
-        "Accept":
+        Accept:
           "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
         "Accept-Encoding": "gzip, deflate, br",
         "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE",
@@ -185,14 +229,14 @@ export const getContentInformationByUrlFromBrowser = (url) => {
     confirmationRequest
       .then((response) => {
         //get the reading time
-        const getReadingTime = (text) => {
+        const getReadingTime = (text: string): number => {
           const wpm = 225;
           const words = text.trim().split(/\s+/).length;
           return Math.ceil(words / wpm);
         };
 
-        let document = htmlParser.parse(response.responseText);
-        let duration = getReadingTime(htmlToText(response.responseText));
+        let document = htmlParser.parse(response.data);
+        let duration = getReadingTime(htmlToText(response.data));
         let titleTag = document.querySelector("title");
         let title = titleTag ? titleTag.rawText : "";
         let description = "";
@@ -204,13 +248,14 @@ export const getContentInformationByUrlFromBrowser = (url) => {
               const descriptionChildNodes = descriptionParentNode.childNodes;
               if (descriptionChildNodes) {
                 const descriptionRawAttr = descriptionChildNodes.find((item) =>
-                  item.rawAttrs.includes("description")
+                  (item as any).rawAttrs.includes("description")
                 );
                 if (descriptionRawAttr) {
-                  const descriptionContent =
-                    descriptionRawAttr.rawAttrs.substring(
-                      descriptionRawAttr.rawAttrs.indexOf("content=") + 9
-                    );
+                  const descriptionContent = (
+                    descriptionRawAttr as any
+                  ).rawAttrs.substring(
+                    (descriptionRawAttr as any).rawAttrs.indexOf("content=") + 9
+                  );
                   description = descriptionContent.substring(
                     0,
                     descriptionContent.length - 1
@@ -238,12 +283,14 @@ export const getContentInformationByUrlFromBrowser = (url) => {
 
 /**
  * Get enabled content providers
- * @param {String} userid
- * @param {String} verb The verb
+ * @param {String} userId
  * @param {String} token Authorization token
  */
-export const getEnabledContentProviders = (userId, token) => {
-  return new Promise(function (resolve, reject) {
+export const getEnabledContentProviders = (
+  userId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/contentproviders/getenabledcontentproviders/${userId}`,
       {
@@ -265,8 +312,11 @@ export const getEnabledContentProviders = (userId, token) => {
  * @param {String} id The id of the integration to be published
  * @param {String} token Authorization token
  */
-export const publishIntegration = (id, token) => {
-  return new Promise(function (resolve, reject) {
+export const publishIntegration = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.post(
       `api/v1/integrations/publish/${id}`,
       {},
@@ -290,9 +340,13 @@ export const publishIntegration = (id, token) => {
  * @param {Object} data Data used to update the integration
  * @param {String} token Authorization token
  */
-export const setIntegrationInformation = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+export const setIntegrationInformation = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: IntegrationData = {
       data: data,
     };
     let confirmationRequest = client.post(
@@ -317,8 +371,11 @@ export const setIntegrationInformation = (id, data, token) => {
  * @param {String} id The id of the integration to be set as default
  * @param {String} token Authorization token
  */
-export const setDefaultIntegration = (id, token) => {
-  return new Promise(function (resolve, reject) {
+export const setDefaultIntegration = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.post(
       `api/v1/integrations/${id}/default`,
       "",

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

@@ -5,10 +5,15 @@ import { client } from "./axiosClient.js";
  * @param {Array<String>} ids
  * @param {Number} type
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getIntegrationsConfiguration = (ids, type, token) => {
-  return new Promise(function (resolve, reject) {
-    let requestData = { type: type };
+const getIntegrationsConfiguration = (
+  ids: string[],
+  type: number,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let requestData: { type: number; ids?: string[] } = { type: type };
     if (ids) requestData.ids = ids;
     let confirmationRequest = client.post(
       "api/v1/integrationsconfiguration",
@@ -29,13 +34,19 @@ const getIntegrationsConfiguration = (ids, type, token) => {
 
 /**
  * Save integration configuration
- * @param {String} id The id of the integration configurationto be updated
+ * @param {String} id The id of the integration configuration to be updated
  * @param {Number} type The type of configuration
  * @param {Object} configuration Data used to update the integration configuration
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const saveIntegrationConfiguration = (id, type, configuration, token) => {
-  return new Promise(function (resolve, reject) {
+const saveIntegrationConfiguration = (
+  id: string,
+  type: number,
+  configuration: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
       configuration: configuration,
@@ -64,9 +75,15 @@ const saveIntegrationConfiguration = (id, type, configuration, token) => {
  * @param {String} type The type of configuration
  * @param {Object} configuration Configuration to be tested
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const testIntegrationConfiguration = (id, type, configuration, token) => {
-  return new Promise(function (resolve, reject) {
+const testIntegrationConfiguration = (
+  id: string,
+  type: string,
+  configuration: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
       configuration: configuration,