@stackfactor/client-api 1.1.133 → 1.1.135

package/src/lib/groups.ts

@@ -1,11 +1,12 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Add permissions to group
  * @param {String} groupId The group Id
  * @param {Array<String>} permissions The permissions to be added
  * @param {String} authToken - Authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addPermissionsToGroup = (
   groupId: string,
@@ -22,10 +23,10 @@ const addPermissionsToGroup = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -36,7 +37,7 @@ const addPermissionsToGroup = (
  * @param {String} groupId The group Id
  * @param {Array<String>} users The users to be added
  * @param {String} authToken - Authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addUsersToGroup = (
   groupId: string,
@@ -53,10 +54,10 @@ const addUsersToGroup = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -67,7 +68,7 @@ const addUsersToGroup = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const createGroup = (
   name: string,
@@ -84,10 +85,10 @@ const createGroup = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -98,7 +99,7 @@ const createGroup = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const deleteGroup = (
   groupId: string,
@@ -114,10 +115,10 @@ const deleteGroup = (
       },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -126,7 +127,7 @@ const deleteGroup = (
 /**
  * Get all permissions
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getAllPermissions = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -134,10 +135,10 @@ const getAllPermissions = (authToken: string): Promise<object> => {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -147,7 +148,7 @@ const getAllPermissions = (authToken: string): Promise<object> => {
  * Get group by Id
  * @param {String} groupId The group Id
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getGroupById = (groupId: string, authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -155,10 +156,10 @@ const getGroupById = (groupId: string, authToken: string): Promise<object> => {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -167,7 +168,7 @@ const getGroupById = (groupId: string, authToken: string): Promise<object> => {
 /**
  * Get groups for current tenant
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getGroups = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -175,10 +176,10 @@ const getGroups = (authToken: string): Promise<object> => {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -187,7 +188,7 @@ const getGroups = (authToken: string): Promise<object> => {
 /**
  * Get current user permissions
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getUserPermissions = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -195,10 +196,10 @@ const getUserPermissions = (authToken: string): Promise<object> => {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -209,7 +210,7 @@ const getUserPermissions = (authToken: string): Promise<object> => {
  * @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>}
+ * @returns {Promise<object>}
  */
 const removePermissionsFromGroup = (
   groupId: string,
@@ -226,10 +227,10 @@ const removePermissionsFromGroup = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -240,7 +241,7 @@ const removePermissionsFromGroup = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const removeUsersFromGroup = (
   groupId: string,
@@ -257,10 +258,10 @@ const removeUsersFromGroup = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -270,7 +271,7 @@ const removeUsersFromGroup = (
  * Set group as default
  * @param {String} groupId The group Id
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setDefault = (groupId: string, authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -282,10 +283,10 @@ const setDefault = (groupId: string, authToken: string): Promise<object> => {
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -297,7 +298,7 @@ const setDefault = (groupId: string, authToken: string): Promise<object> => {
  * @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>}
+ * @returns {Promise<object>}
  */
 const updateGroup = (
   groupId: string,
@@ -316,10 +317,10 @@ const updateGroup = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/index.ts

@@ -1 +1,85 @@
-export * from "./exports.js";
+import actionNotifications from "./actionNotifications";
+import {
+  client,
+  errorToString,
+  getErrorInformation,
+  getErrorType,
+  shouldReturnError,
+} from "./axiosClient";
+import aiAssistant from "./aiAssistant";
+import avatar from "./avatar";
+import address from "./address";
+import config from "./config";
+import {
+  DOCUMENT_VERSION,
+  PERMISSIONS,
+  PERMISSION_DESCRIPTIONS,
+  RESPONSE_TYPE,
+} from "./constants";
+import contentGenerator from "./integrations/contentGenerator";
+import dashboard from "./dashboard";
+import departmentTraingPlans from "./departmentTrainingPlans";
+import integration from "./integration";
+import integrationConfiguration from "./integrationConfiguration";
+import groups from "./groups";
+import learningContent from "./learningContent";
+import learningPath from "./learningPath";
+import logger from "./logger";
+import microSkillsQuizes from "./microSkillsQuizes";
+import quotas from "./quotas";
+import role from "./role";
+import roleTemplate from "./roleTemplate";
+import security from "./security";
+import skill from "./skill";
+import skillAssessment from "./skillAssessments";
+import skillAssessmentTestingSession from "./skillAssessmentTestingSession";
+import skillTemplate from "./skillTemplate";
+import talentTransfromation from "./talentTransfromation";
+import team from "./teams";
+import tenant from "./tenants";
+import trainingPlan from "./trainingPlans";
+import trainingPlanProficiencyLevel from "./trainingPlansProficiencyLevels";
+import userInformation from "./userInformation";
+import users from "./users";
+
+export {
+  actionNotifications,
+  address,
+  aiAssistant,
+  avatar,
+  client,
+  config,
+  contentGenerator,
+  dashboard,
+  errorToString,
+  getErrorInformation,
+  getErrorType,
+  DOCUMENT_VERSION,
+  integration,
+  integrationConfiguration,
+  departmentTraingPlans,
+  groups,
+  learningContent,
+  learningPath,
+  logger,
+  microSkillsQuizes,
+  PERMISSIONS,
+  PERMISSION_DESCRIPTIONS,
+  quotas,
+  RESPONSE_TYPE,
+  role,
+  roleTemplate,
+  security,
+  shouldReturnError,
+  skill,
+  skillAssessment,
+  skillAssessmentTestingSession,
+  skillTemplate,
+  talentTransfromation,
+  team,
+  tenant,
+  trainingPlan,
+  trainingPlanProficiencyLevel,
+  userInformation,
+  users,
+};

package/src/lib/integration.ts

@@ -1,4 +1,5 @@
-import { client, errorToString } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client, errorToString } from "./axiosClient";
 import axiosLib from "axios";
 import htmlParser from "node-html-parser";
 import htmlToText from "html2plaintext";
@@ -41,14 +42,14 @@ export const createIntegration = (
     const requestData: IntegrationData = {
       data: data,
     };
-    let confirmationRequest = client.put("api/v1/integrations/", requestData, {
+    const confirmationRequest = client.put("api/v1/integrations/", requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -71,10 +72,10 @@ export const deleteIntegration = (
       },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -96,10 +97,10 @@ export const discardIntegrationChanges = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -117,17 +118,17 @@ export const getIntegrationInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/integrations/${id}/${version}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -155,14 +156,14 @@ export const getIntegrationsList = (
     };
     if (filter) requestData.filter = filter;
     if (type) requestData.type = type;
-    let confirmationRequest = client.post(`api/v1/integrations`, requestData, {
+    const confirmationRequest = client.post(`api/v1/integrations`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -184,7 +185,7 @@ export const getContentInformationByUrl = (
       url: url,
       verb: verb,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/contentproviders/getcontentinformationbyurl`,
       requestData,
       {
@@ -192,10 +193,10 @@ export const getContentInformationByUrl = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -210,11 +211,11 @@ export const getContentInformationByUrlFromBrowser = (
   url: string
 ): Promise<ContentInformationResponse> => {
   return new Promise((resolve, reject) => {
-    let domain = new URL(url);
-    let instance = axiosLib.create({
+    const domain = new URL(url);
+    const instance = axiosLib.create({
       baseURL: domain.origin,
     });
-    let confirmationRequest = instance.get(domain.pathname, {
+    const confirmationRequest = instance.get(domain.pathname, {
       headers: {
         "Access-Control-Allow-Origin": "*",
         "Access-Control-Allow-Headers":
@@ -227,7 +228,7 @@ export const getContentInformationByUrlFromBrowser = (
       },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         //get the reading time
         const getReadingTime = (text: string): number => {
           const wpm = 225;
@@ -235,32 +236,32 @@ export const getContentInformationByUrlFromBrowser = (
           return Math.ceil(words / wpm);
         };
 
-        let document = htmlParser.parse(response.data);
-        let duration = getReadingTime(htmlToText(response.data));
-        let titleTag = document.querySelector("title");
-        let title = titleTag ? titleTag.rawText : "";
-        let description = "";
+        const document = htmlParser.parse(response.data);
+        const duration = getReadingTime(htmlToText(response.data));
+        const titleTag = document.querySelector("title");
+        const title = titleTag ? titleTag.rawText : "";
+        const description = "";
         const descriptionEl = document.querySelector("meta");
         try {
           if (descriptionEl) {
-            const descriptionParentNode = descriptionEl.parentNode;
-            if (descriptionParentNode) {
+          const descriptionParentNode = descriptionEl.parentNode;
+            if (descriptionEl) {
               const descriptionChildNodes = descriptionParentNode.childNodes;
               if (descriptionChildNodes) {
-                const descriptionRawAttr = descriptionChildNodes.find((item) =>
-                  (item as any).rawAttrs.includes("description")
-                );
-                if (descriptionRawAttr) {
-                  const descriptionContent = (
-                    descriptionRawAttr as any
-                  ).rawAttrs.substring(
-                    (descriptionRawAttr as any).rawAttrs.indexOf("content=") + 9
-                  );
-                  description = descriptionContent.substring(
-                    0,
-                    descriptionContent.length - 1
-                  );
-                }
+                //TODO: Code needs fixing
+                // const descriptionRawAttr = descriptionChildNodes.find((element) => {
+                //   return element.rawAttrs && element.rawAttrs.includes("description");
+                // });
+                // if (descriptionRawAttr) {
+                //   const element = descriptionRawAttr as any; // Cast to any to access rawAttrs
+                //   const descriptionContent = element.rawAttrs.substring(
+                //     element.rawAttrs.indexOf("content=") + 8
+                //   );
+                //   description = descriptionContent.substring(
+                //     0,
+                //     descriptionContent.length - 1
+                //   );
+                // }
               }
             }
           }
@@ -275,7 +276,7 @@ export const getContentInformationByUrlFromBrowser = (
           });
         }
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(new Error(errorToString(error)));
       });
   });
@@ -291,17 +292,17 @@ export const getEnabledContentProviders = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/contentproviders/getenabledcontentproviders/${userId}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -317,7 +318,7 @@ export const publishIntegration = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/integrations/publish/${id}`,
       {},
       {
@@ -325,10 +326,10 @@ export const publishIntegration = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -349,7 +350,7 @@ export const setIntegrationInformation = (
     const requestData: IntegrationData = {
       data: data,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/integrations/${id}`,
       requestData,
       {
@@ -357,10 +358,10 @@ export const setIntegrationInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -376,7 +377,7 @@ export const setDefaultIntegration = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/integrations/${id}/default`,
       "",
       {
@@ -384,10 +385,10 @@ export const setDefaultIntegration = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });