@stackfactor/client-api 1.1.12-9.1 → 1.1.12

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

@@ -1,35 +1,14 @@
 import { client } from "./axiosClient.js";
 
-interface LearningContentData {
-  data?: object;
-  id?: string;
-  comments?: string;
-  learningcontentid?: string;
-  microSkillId?: string;
-  tags?: object;
-  watch?: boolean;
-}
-
-interface GenerateLearningActivityContentData {
-  learningObjectives: string;
-  learningActivity: object;
-  microSkillId: string;
-  sections: string[];
-  otherLearningActivities?: string[];
-}
-
 /**
  * Create learning content and set information
  * @param {Object} data Learning content data
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The created learning content
  */
-const createLearningContent = (
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
+const createLearningContent = (data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       data: data,
     };
     let confirmationRequest = client.put(
@@ -56,16 +35,12 @@ const createLearningContent = (
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The response from the server
  */
-const deleteLearningContent = (
-  id: string,
-  comments: string,
-  token: string
-): Promise<object> => {
-  const data: LearningContentData = {
+export const deleteLearningContent = (id, comments, token) => {
+  const data = {
     id: id,
   };
   if (comments) data.comments = comments;
-  return new Promise((resolve, reject) => {
+  return new Promise(function (resolve, reject) {
     const request = client.delete(`api/v1/learningcontent/`, {
       headers: { authorization: token },
       data: data,
@@ -86,11 +61,8 @@ const deleteLearningContent = (
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The response from the server
  */
-const discardLearningContentChanges = (
-  id: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const discardLearningContentChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
     const data = {};
     const request = client.get(`api/v1/learningcontent/discard/${id}`, {
       headers: { authorization: token },
@@ -108,33 +80,25 @@ const discardLearningContentChanges = (
 
 /**
  * Generate the learning activity content
- * @param {String} learningObjectives
  * @param {String} skillId
  * @param {String} microSkillId
  * @param {Object} learningActivity
- * @param {List<String>} otherLearningActivities
  * @param {List<String>} sections
  * @param {String} token
  */
-const generateLearningActivityContent = (
-  learningObjectives: string,
-  skillId: string,
-  microSkillId: string,
-  learningActivity: object,
-  otherLearningActivities: string[],
-  sections: string[],
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: GenerateLearningActivityContentData = {
-      learningObjectives: learningObjectives,
+export const generateLearningActivityContent = (
+  skillId,
+  microSkillId,
+  learningActivity,
+  sections,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       learningActivity: learningActivity,
       microSkillId: microSkillId,
       sections: sections,
     };
-    if (otherLearningActivities) {
-      requestData.otherLearningActivities = otherLearningActivities;
-    }
     const request = client.post(
       `api/v1/learningcontent/generatelearningactivitycontent/${skillId}`,
       requestData,
@@ -152,37 +116,6 @@ const generateLearningActivityContent = (
   });
 };
 
-/**
- * Generate micro skill test knowledge
- * @param {String} microSkill
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const generateMicroSkillTestKnowledge = (
-  microSkill: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data = {
-      microSkill: microSkill,
-    };
-    let confirmationRequest = client.post(
-      `api/v1/learningcontent/generatemicroskilltestknowledge`,
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
 /**
  * Get the learning content information by id
  * @param {String} id The id of the learning content
@@ -190,12 +123,8 @@ const generateMicroSkillTestKnowledge = (
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The response from the server
  */
-const getLearningContentInformationById = (
-  id: string,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getLearningContentInformationById = (id, version, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/learningcontent/${id}/${version}`,
       {
@@ -220,14 +149,14 @@ const getLearningContentInformationById = (
  * @param {String} token Authorization token
  * @returns {Promise<Array<Object>>} The list of available content
  */
-const getLearningContentList = (
-  filter: string[],
-  version: string,
-  includeDeleted: boolean,
-  token: string
-): Promise<object[]> => {
-  return new Promise((resolve, reject) => {
-    const requestData: { version: string; includeDeleted: boolean; filter?: string[] } = {
+export const getLearningContentList = (
+  filter,
+  version,
+  includeDeleted,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       version: version,
       includeDeleted: includeDeleted,
     };
@@ -249,35 +178,6 @@ const getLearningContentList = (
   });
 };
 
-/**
- * Migrate learning content storage
- * @param {String} id The id of the content to be migrated
- * @param {String} token Authorization token
- * @returns {Promise<Object>} The response from the server
- */
-const migrateLearningContentStorageType = (
-  id: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data = {};
-    let confirmationRequest = client.post(
-      `api/v1/learningcontent/migratestorage/${id}`,
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
 /**
  * Publish learning content
  * @param {String} id The id of the content to be published
@@ -285,13 +185,9 @@ const migrateLearningContentStorageType = (
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The response from the server
  */
-const publishLearningContent = (
-  id: string,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: LearningContentData = {};
+export const publishLearningContent = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
     if (comments) data.comments = comments;
 
     let confirmationRequest = client.post(
@@ -318,13 +214,9 @@ const publishLearningContent = (
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The updated learning content
  */
-const setLearningContentInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
+export const setLearningContentInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       data: data,
       id: id,
     };
@@ -345,65 +237,26 @@ const setLearningContentInformation = (
   });
 };
 
-/**
- * Set partial content information
- * @param {String} id
- * @param {Object} data
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const setLearningContentPartialContentInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
-      data: data,
-      id: id,
-    };
-    let confirmationRequest = client.post(
-      `api/v1/learningcontent/updatepartialcontent/${id}`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
 /**
  * Set the content for a specific learning activity
  * @param {String} id
  * @param {String} learningcontentid
- * @param {String} microSkillId
  * @param {Object} data
  * @param {String} token
- * @returns {Promise<String>} OK word if the operation was successful
+ * @returns {Promise<String>} OK word if the operation was succesful
  */
-const setLearningContentLearningContentInformation = (
-  id: string,
-  learningcontentid: string,
-  microSkillId: string,
-  data: object,
-  token: string
-): Promise<string> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
+export const setLearningContentLearningContentInformation = (
+  id,
+  learningcontentid,
+  data,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       data: data,
-      id: id,
-      learningcontentid: learningcontentid,
-      microSkillId: microSkillId,
     };
     let confirmationRequest = client.post(
-      `api/v1/learningcontent/updatelearningcontent/`,
+      `api/v1/learningcontent/updatelearningcontent/${id}/${learningcontentid}`,
       requestData,
       {
         headers: { authorization: token },
@@ -425,16 +278,16 @@ const setLearningContentLearningContentInformation = (
  * @param {String} microskillid
  * @param {Object} data
  * @param {String} token
- * @returns {Promise<String>} OK word if the operation was successful
+ * @returns {Promise<String>} OK word if the operation was succesful
  */
-const setLearningContentLearningMicroSkillContentInformation = (
-  id: string,
-  microskillid: string,
-  data: object,
-  token: string
-): Promise<string> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
+export const setLearningContentLearningMicroSkillContentInformation = (
+  id,
+  microskillid,
+  data,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       data: data,
     };
     let confirmationRequest = client.post(
@@ -460,13 +313,9 @@ const setLearningContentLearningMicroSkillContentInformation = (
  * @param {Object} tags Updated learning content tags
  * @param {String} token Authorization token
  */
-const setLearningContentTags = (
-  id: string,
-  tags: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
+export const setLearningContentTags = (id, tags, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       tags: tags,
       id: id,
     };
@@ -493,13 +342,9 @@ const setLearningContentTags = (
  * @param {Boolean} watch Set to true or false
  * @param {String} token Authorization token
  */
-const watchLearningContent = (
-  id: string,
-  watch: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningContentData = {
+export const watchLearningContent = (id, watch, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       id: id,
       watch: watch,
     };
@@ -520,20 +365,19 @@ const watchLearningContent = (
   });
 };
 
-export default {
+const learningContent = {
   createLearningContent,
   deleteLearningContent,
   discardLearningContentChanges,
   getLearningContentInformationById,
   generateLearningActivityContent,
-  generateMicroSkillTestKnowledge,
   getLearningContentList,
-  migrateLearningContentStorageType,
   publishLearningContent,
-  setLearningContentPartialContentInformation,
   setLearningContentLearningContentInformation,
-  setLearningContentLearningMicroSkillContentInformation,
+  setMicroSkillLearningContentInformation,
   setLearningContentInformation,
   setLearningContentTags,
   watchLearningContent,
 };
+
+export default learningContent;

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

@@ -1,23 +1,12 @@
 import { client } from "./axiosClient.js";
 
-interface LearningPathData {
-  data?: object;
-  id?: string;
-  comments?: string;
-  tags?: object;
-  list?: string[];
-  version?: string;
-  includeDeleted?: boolean;
-}
-
 /**
  * Create learning path and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const createLearningPath = (data: object, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const createLearningPath = (data, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.put(
       "api/v1/learningpaths",
       { data: data },
@@ -40,11 +29,10 @@ const createLearningPath = (data: object, token: string): Promise<object> => {
  * @param {String} id The id of the template to be deleted
  * @param {String} comments The comments for approver
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const deleteLearningPath = (id: string, comments: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: LearningPathData = {
+export const deleteLearningPath = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
       id: id,
     };
     if (comments) data.comments = comments;
@@ -66,10 +54,9 @@ const deleteLearningPath = (id: string, comments: string, token: string): Promis
  * Discard the training plan draft changes
  * @param {String} id The id of the training plan to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const discardLearningPathChanges = (id: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const discardLearningPathChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
     const data = {};
     const request = client.get(`api/v1/learningpaths/discard/${id}`, {
       headers: { authorization: token },
@@ -86,14 +73,12 @@ const discardLearningPathChanges = (id: string, token: string): Promise<object>
 };
 
 /**
- * Get training plan template information
+ * Get traing plan template information
  * @param {String} id The id of the template
- * @param {String} version The version of the template
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const getLearningPathInformationById = (id: string, version: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getLearningPathInformationById = (id, version, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/learningpaths/${id}/${version}`,
       {
@@ -114,29 +99,18 @@ const getLearningPathInformationById = (id: string, version: string, token: stri
  * Get learning path list
  * @param {Array<String>} list The filter used to select the skill
  * @param {String} version The version to be retrieved
- * @param {boolean} includeDeleted When true it will return the deleted records as well
  * @param {String} token Authorization token
- * @returns {Promise<Array<Object>>} The list of available content
  */
-const getLearningPathsList = (
-  list: string[],
-  version: string,
-  includeDeleted: boolean,
-  token: string
-): Promise<object[]> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningPathData = {
+export const getLearningPathsList = (list, version, includeDeleted, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       version: version,
       includeDeleted: includeDeleted,
     };
     if (list) requestData.list = list;
-    let confirmationRequest = client.post(
-      `api/v1/learningpaths`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
+    let confirmationRequest = client.post(`api/v1/learningpaths`, requestData, {
+      headers: { authorization: token },
+    });
     confirmationRequest
       .then((response) => {
         resolve(response.data);
@@ -148,15 +122,14 @@ const getLearningPathsList = (
 };
 
 /**
- * Publish training plan template
+ * Publish training pplan template
  * @param {String} id The id of the template to be published
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const publishLearningPath = (id: string, comments: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: LearningPathData = {};
+export const publishLearningPath = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
     if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/learningpaths/publish/${id}`,
@@ -180,11 +153,10 @@ const publishLearningPath = (id: string, comments: string, token: string): Promi
  * @param {String} id The id of the template to be updated
  * @param {Object} data Data used to update the template
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const setLearningPathInformation = (id: string, data: object, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningPathData = {
+export const setLearningPathInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       data: data,
       id: id,
     };
@@ -210,11 +182,10 @@ const setLearningPathInformation = (id: string, data: object, token: string): Pr
  * @param {String} id The id of the template to be updated
  * @param {Object} tags The updated tags
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const setLearningPathTags = (id: string, tags: object, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: LearningPathData = {
+export const setLearningPathTags = (id, tags, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       tags: tags,
       id: id,
     };
@@ -235,7 +206,7 @@ const setLearningPathTags = (id: string, tags: object, token: string): Promise<o
   });
 };
 
-export default {
+const learningPath = {
   createLearningPath,
   deleteLearningPath,
   discardLearningPathChanges,
@@ -244,4 +215,6 @@ export default {
   publishLearningPath,
   setLearningPathInformation,
   setLearningPathTags,
-};
+};
+
+export default learningPath;

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

@@ -6,15 +6,9 @@ import { client } from "./axiosClient.js";
  * @param {String} elementType
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
  */
-const comments = (
-  elementId: string,
-  elementType: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const comments = (elementId, elementType, data, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.post(
       "api/v1/logger/comments/",
       {
@@ -42,16 +36,10 @@ const comments = (
  * @param {Number} page The results page
  * @param {Number} elementsPerPage The number of elements per page
  * @param {String} token
- * @returns {Promise<Object>}
  */
-const getListByElementId = (
-  elementId: string,
-  page: number | null,
-  elementsPerPage: number | null,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: { elementsPerPage?: number, page?: number } = {};
+export const getListByElementId = (elementId, page, elementsPerPage, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
     if (elementsPerPage !== null) data.elementsPerPage = elementsPerPage;
     if (page !== null) data.page = page;
     const getTokensRequest = client.post(`api/v1/logger/${elementId}`, data, {
@@ -67,4 +55,6 @@ const getListByElementId = (
   });
 };
 
-export default { comments, getListByElementId };
+const logger = { comments, getListByElementId };
+
+export default logger;