@stackfactor/client-api 1.1.148 → 1.1.150

package/dist/groups.js

@@ -0,0 +1,273 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const axiosClient_1 = require("./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>}
+ */
+const addPermissionsToGroup = (groupId, permissions, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_1.client.post(`api/v1/groups/permissions/add`, {
+            groupId: groupId,
+            permissions: permissions,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Add users to group
+ * @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((resolve, reject) => {
+        const request = axiosClient_1.client.post(`api/v1/groups/users/add`, {
+            groupId: groupId,
+            users: users,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Create group
+ * @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((resolve, reject) => {
+        const request = axiosClient_1.client.post(`api/v1/groups/group`, {
+            name: name,
+            description: description,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Delete group
+ * @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((resolve, reject) => {
+        const request = axiosClient_1.client.delete(`api/v1/groups/delete`, {
+            headers: { authorization: authToken },
+            data: {
+                id: groupId,
+                defaultGroupId: defaultGroupId,
+            },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Get all permissions
+ * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
+ */
+const getAllPermissions = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_1.client.get(`api/v1/groups/permissions/getAllPermissions`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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((resolve, reject) => {
+        const request = axiosClient_1.client.get(`api/v1/groups/group/${groupId}`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Get groups for current tenant
+ * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
+ */
+const getGroups = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_1.client.get(`api/v1/groups/`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Get current user permissions
+ * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
+ */
+const getUserPermissions = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_1.client.get(`api/v1/groups/users/getuserpermissions`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Remove permissions from group
+ * @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((resolve, reject) => {
+        const request = axiosClient_1.client.post(`api/v1/groups/permissions/remove/`, {
+            groupId: groupId,
+            permissions: permissions,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Remove users from group
+ * @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((resolve, reject) => {
+        const request = axiosClient_1.client.post(`api/v1/groups/users/remove/`, {
+            groupId: groupId,
+            users: users,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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((resolve, reject) => {
+        const request = axiosClient_1.client.put(`api/v1/groups/setDefault/`, {
+            id: groupId,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Update group
+ * @param {String} groupId The group Id
+ * @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((resolve, reject) => {
+        const request = axiosClient_1.client.patch(`api/v1/groups/group/`, {
+            id: groupId,
+            name: name,
+            description: description,
+        }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.default = {
+    addPermissionsToGroup,
+    addUsersToGroup,
+    createGroup,
+    deleteGroup,
+    getAllPermissions,
+    getGroupById,
+    getGroups,
+    getUserPermissions,
+    removePermissionsFromGroup,
+    removeUsersFromGroup,
+    setDefault,
+    updateGroup,
+};

package/dist/index.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.users = exports.userInformation = exports.trainingPlanProficiencyLevel = exports.trainingPlan = exports.tenant = exports.team = exports.talentTransfromation = exports.skillTemplate = exports.skillAssessmentTestingSession = exports.skillAssessment = exports.skill = exports.shouldReturnError = exports.security = exports.roleTemplate = exports.role = exports.RESPONSE_TYPE = exports.quotas = exports.PERMISSION_DESCRIPTIONS = exports.PERMISSIONS = exports.microSkillsQuizes = exports.logger = exports.learningPath = exports.learningContent = exports.groups = exports.departmentTraingPlans = exports.integrationConfiguration = exports.integration = exports.DOCUMENT_VERSION = exports.getErrorType = exports.getErrorInformation = exports.errorToString = exports.dashboard = exports.contentGenerator = exports.config = exports.client = exports.avatar = exports.aiAssistant = exports.address = exports.actionNotifications = void 0;
+const actionNotifications_1 = __importDefault(require("./actionNotifications"));
+exports.actionNotifications = actionNotifications_1.default;
+const axiosClient_1 = require("./axiosClient");
+Object.defineProperty(exports, "client", { enumerable: true, get: function () { return axiosClient_1.client; } });
+Object.defineProperty(exports, "errorToString", { enumerable: true, get: function () { return axiosClient_1.errorToString; } });
+Object.defineProperty(exports, "getErrorInformation", { enumerable: true, get: function () { return axiosClient_1.getErrorInformation; } });
+Object.defineProperty(exports, "getErrorType", { enumerable: true, get: function () { return axiosClient_1.getErrorType; } });
+Object.defineProperty(exports, "shouldReturnError", { enumerable: true, get: function () { return axiosClient_1.shouldReturnError; } });
+const aiAssistant_1 = __importDefault(require("./aiAssistant"));
+exports.aiAssistant = aiAssistant_1.default;
+const avatar_1 = __importDefault(require("./avatar"));
+exports.avatar = avatar_1.default;
+const address_1 = __importDefault(require("./address"));
+exports.address = address_1.default;
+const config_1 = __importDefault(require("./config"));
+exports.config = config_1.default;
+const constants_1 = require("./constants");
+Object.defineProperty(exports, "DOCUMENT_VERSION", { enumerable: true, get: function () { return constants_1.DOCUMENT_VERSION; } });
+Object.defineProperty(exports, "PERMISSIONS", { enumerable: true, get: function () { return constants_1.PERMISSIONS; } });
+Object.defineProperty(exports, "PERMISSION_DESCRIPTIONS", { enumerable: true, get: function () { return constants_1.PERMISSION_DESCRIPTIONS; } });
+Object.defineProperty(exports, "RESPONSE_TYPE", { enumerable: true, get: function () { return constants_1.RESPONSE_TYPE; } });
+const contentGenerator_1 = __importDefault(require("./integrations/contentGenerator"));
+exports.contentGenerator = contentGenerator_1.default;
+const dashboard_1 = __importDefault(require("./dashboard"));
+exports.dashboard = dashboard_1.default;
+const departmentTrainingPlans_1 = __importDefault(require("./departmentTrainingPlans"));
+exports.departmentTraingPlans = departmentTrainingPlans_1.default;
+const integration_1 = __importDefault(require("./integration"));
+exports.integration = integration_1.default;
+const integrationConfiguration_1 = __importDefault(require("./integrationConfiguration"));
+exports.integrationConfiguration = integrationConfiguration_1.default;
+const groups_1 = __importDefault(require("./groups"));
+exports.groups = groups_1.default;
+const learningContent_1 = __importDefault(require("./learningContent"));
+exports.learningContent = learningContent_1.default;
+const learningPath_1 = __importDefault(require("./learningPath"));
+exports.learningPath = learningPath_1.default;
+const logger_1 = __importDefault(require("./logger"));
+exports.logger = logger_1.default;
+const microSkillsQuizes_1 = __importDefault(require("./microSkillsQuizes"));
+exports.microSkillsQuizes = microSkillsQuizes_1.default;
+const quotas_1 = __importDefault(require("./quotas"));
+exports.quotas = quotas_1.default;
+const role_1 = __importDefault(require("./role"));
+exports.role = role_1.default;
+const roleTemplate_1 = __importDefault(require("./roleTemplate"));
+exports.roleTemplate = roleTemplate_1.default;
+const security_1 = __importDefault(require("./security"));
+exports.security = security_1.default;
+const skill_1 = __importDefault(require("./skill"));
+exports.skill = skill_1.default;
+const skillAssessments_1 = __importDefault(require("./skillAssessments"));
+exports.skillAssessment = skillAssessments_1.default;
+const skillAssessmentTestingSession_1 = __importDefault(require("./skillAssessmentTestingSession"));
+exports.skillAssessmentTestingSession = skillAssessmentTestingSession_1.default;
+const skillTemplate_1 = __importDefault(require("./skillTemplate"));
+exports.skillTemplate = skillTemplate_1.default;
+const talentTransfromation_1 = __importDefault(require("./talentTransfromation"));
+exports.talentTransfromation = talentTransfromation_1.default;
+const teams_1 = __importDefault(require("./teams"));
+exports.team = teams_1.default;
+const tenants_1 = __importDefault(require("./tenants"));
+exports.tenant = tenants_1.default;
+const trainingPlans_1 = __importDefault(require("./trainingPlans"));
+exports.trainingPlan = trainingPlans_1.default;
+const trainingPlansProficiencyLevels_1 = __importDefault(require("./trainingPlansProficiencyLevels"));
+exports.trainingPlanProficiencyLevel = trainingPlansProficiencyLevels_1.default;
+const userInformation_1 = __importDefault(require("./userInformation"));
+exports.userInformation = userInformation_1.default;
+const users_1 = __importDefault(require("./users"));
+exports.users = users_1.default;

package/dist/integration.js

@@ -0,0 +1,319 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setDefaultIntegration = exports.setIntegrationInformation = exports.publishIntegration = exports.getEnabledContentProviders = exports.getContentInformationByUrlFromBrowser = exports.getContentInformationByUrl = exports.getIntegrationsList = exports.getIntegrationInformationById = exports.discardIntegrationChanges = exports.deleteIntegration = exports.createIntegration = void 0;
+const axiosClient_1 = require("./axiosClient");
+const axios_1 = __importDefault(require("axios"));
+const node_html_parser_1 = __importDefault(require("node-html-parser"));
+const html2plaintext_1 = __importDefault(require("html2plaintext"));
+/**
+ * Create integration and set information
+ * @param {Object} data The new integration information
+ * @param {String} token Authorization token
+ */
+const createIntegration = (data, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            data: data,
+        };
+        let confirmationRequest = axiosClient_1.client.put("api/v1/integrations/", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.createIntegration = createIntegration;
+/**
+ * Delete integration
+ * @param {String} id The id of the integration to be deleted
+ * @param {String} token Authorization token
+ */
+const deleteIntegration = (id, token) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_1.client.delete(`api/v1/integrations/`, {
+            headers: { authorization: token },
+            data: {
+                id: id,
+            },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.deleteIntegration = deleteIntegration;
+/**
+ * Discard the integration draft changes
+ * @param {String} id The id of the role template to be deleted
+ * @param {String} token Authorization token
+ */
+const discardIntegrationChanges = (id, token) => {
+    return new Promise((resolve, reject) => {
+        const data = {};
+        const request = axiosClient_1.client.get(`api/v1/integrations/discard/${id}`, {
+            headers: { authorization: token },
+            data: data,
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.discardIntegrationChanges = discardIntegrationChanges;
+/**
+ * Get integration information
+ * @param {String} id The id of the integration
+ * @param {String} version The version of the integration to be received
+ * @param {String} token Authorization token
+ */
+const getIntegrationInformationById = (id, version, token) => {
+    return new Promise((resolve, reject) => {
+        let confirmationRequest = axiosClient_1.client.get(`api/v1/integrations/${id}/${version}`, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getIntegrationInformationById = getIntegrationInformationById;
+/**
+ * Get integrations list
+ * @param {Array<String>} filter The filter used to select the integration
+ * @param {String} type The type of the integration
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeSupportedCapabilities If true, the supported capabilities will be included in the response
+ * @param {String} token Authorization token
+ */
+const getIntegrationsList = (filter, type, version, includeSupportedCapabilities, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            includeSupportedCapabilities: includeSupportedCapabilities,
+            version: version,
+        };
+        if (filter)
+            requestData.filter = filter;
+        if (type)
+            requestData.type = type;
+        let confirmationRequest = axiosClient_1.client.post(`api/v1/integrations`, requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getIntegrationsList = getIntegrationsList;
+/**
+ * Get content information by Url
+ * @param {String} url The training url
+ * @param {String} verb The verb
+ * @param {String} token Authorization token
+ */
+const getContentInformationByUrl = (url, verb, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            url: url,
+            verb: verb,
+        };
+        let confirmationRequest = axiosClient_1.client.post(`api/v1/contentproviders/getcontentinformationbyurl`, requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getContentInformationByUrl = getContentInformationByUrl;
+/**
+ * Get content information by url from the browser instead of the backend
+ * @param {String} url
+ * @returns {Promise<ContentInformationResponse>}
+ */
+const getContentInformationByUrlFromBrowser = (url) => {
+    return new Promise((resolve, reject) => {
+        let domain = new URL(url);
+        let instance = axios_1.default.create({
+            baseURL: domain.origin,
+        });
+        let confirmationRequest = instance.get(domain.pathname, {
+            headers: {
+                "Access-Control-Allow-Origin": "*",
+                "Access-Control-Allow-Headers": "Authorization, Origin, X-Requested-With, Content-Type, 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",
+                "User-Agent": "Mozilla/5.0",
+            },
+        });
+        confirmationRequest
+            .then((response) => {
+            //get the reading time
+            const getReadingTime = (text) => {
+                const wpm = 225;
+                const words = text.trim().split(/\s+/).length;
+                return Math.ceil(words / wpm);
+            };
+            let document = node_html_parser_1.default.parse(response.data);
+            let duration = getReadingTime((0, html2plaintext_1.default)(response.data));
+            let titleTag = document.querySelector("title");
+            let title = titleTag ? titleTag.rawText : "";
+            let description = "";
+            const descriptionEl = document.querySelector("meta");
+            try {
+                if (descriptionEl) {
+                    const descriptionParentNode = descriptionEl.parentNode;
+                    if (descriptionParentNode) {
+                        const descriptionChildNodes = descriptionParentNode.childNodes;
+                        if (descriptionChildNodes) {
+                            const descriptionRawAttr = descriptionChildNodes.find((item) => item.rawAttrs.includes("description"));
+                            if (descriptionRawAttr) {
+                                const descriptionContent = descriptionRawAttr.rawAttrs.substring(descriptionRawAttr.rawAttrs.indexOf("content=") + 9);
+                                description = descriptionContent.substring(0, descriptionContent.length - 1);
+                            }
+                        }
+                    }
+                }
+            }
+            finally {
+                resolve({
+                    description: description,
+                    duration: duration,
+                    icon: `http://www.google.com/s2/favicons?sz=128&domain_url=${domain.hostname}`,
+                    title: title ? title.trim() : url,
+                    type: 0,
+                    internal: true,
+                });
+            }
+        })
+            .catch((error) => {
+            reject(new Error((0, axiosClient_1.errorToString)(error)));
+        });
+    });
+};
+exports.getContentInformationByUrlFromBrowser = getContentInformationByUrlFromBrowser;
+/**
+ * Get enabled content providers
+ * @param {String} userId
+ * @param {String} token Authorization token
+ */
+const getEnabledContentProviders = (userId, token) => {
+    return new Promise((resolve, reject) => {
+        let confirmationRequest = axiosClient_1.client.get(`api/v1/contentproviders/getenabledcontentproviders/${userId}`, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getEnabledContentProviders = getEnabledContentProviders;
+/**
+ * Publish integration
+ * @param {String} id The id of the integration to be published
+ * @param {String} token Authorization token
+ */
+const publishIntegration = (id, token) => {
+    return new Promise((resolve, reject) => {
+        let confirmationRequest = axiosClient_1.client.post(`api/v1/integrations/publish/${id}`, {}, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.publishIntegration = publishIntegration;
+/**
+ * Set integration information
+ * @param {String} id The id of the integration to be updated
+ * @param {Object} data Data used to update the integration
+ * @param {String} token Authorization token
+ */
+const setIntegrationInformation = (id, data, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            data: data,
+        };
+        let confirmationRequest = axiosClient_1.client.post(`api/v1/integrations/${id}`, requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.setIntegrationInformation = setIntegrationInformation;
+/**
+ * Set default integration
+ * @param {String} id The id of the integration to be set as default
+ * @param {String} token Authorization token
+ */
+const setDefaultIntegration = (id, token) => {
+    return new Promise((resolve, reject) => {
+        let confirmationRequest = axiosClient_1.client.post(`api/v1/integrations/${id}/default`, "", {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.setDefaultIntegration = setDefaultIntegration;
+exports.default = {
+    createIntegration: exports.createIntegration,
+    deleteIntegration: exports.deleteIntegration,
+    discardIntegrationChanges: exports.discardIntegrationChanges,
+    getContentInformationByUrl: exports.getContentInformationByUrl,
+    getContentInformationByUrlFromBrowser: exports.getContentInformationByUrlFromBrowser,
+    getEnabledContentProviders: exports.getEnabledContentProviders,
+    getIntegrationInformationById: exports.getIntegrationInformationById,
+    getIntegrationsList: exports.getIntegrationsList,
+    publishIntegration: exports.publishIntegration,
+    setDefaultIntegration: exports.setDefaultIntegration,
+    setIntegrationInformation: exports.setIntegrationInformation,
+};