@stackfactor/client-api 1.1.15-8.1 → 1.1.16

package/lib/integration.js

@@ -0,0 +1,352 @@
+import { client, errorToString } from "./axiosClient.js";
+import axiosLib from "axios";
+import htmlParser from "node-html-parser";
+import htmlToText from "html2plaintext";
+
+/**
+ * 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 = {
+      data: data,
+    };
+    let confirmationRequest = client.put("api/v1/integrations/", requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete integration
+ * @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) {
+    const request = client.delete(`api/v1/integrations/`, {
+      headers: { authorization: token },
+      data: {
+        id: id,
+      },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Discard the integration draft changes
+ * @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) {
+    const data = {};
+    const request = client.get(`api/v1/integrations/discard/${id}`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * 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
+ */
+export const getIntegrationInformationById = (id, version, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/integrations/${id}/${version}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * 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
+ */
+export const getIntegrationsList = (
+  filter,
+  type,
+  version,
+  includeSupportedCapabilities,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      includeSupportedCapabilities: includeSupportedCapabilities,
+      version: version,
+    };
+    if (filter) requestData.filter = filter;
+    if (type) requestData.type = type;
+    let confirmationRequest = client.post(`api/v1/integrations`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get content information by Url
+ * @param {String} url The training url
+ * @param {String} verb The verb
+ * @param {String} token Authorization token
+ */
+export const getContentInformationByUrl = (url, verb, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      url: url,
+      verb: verb,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/contentproviders/getcontentinformationbyurl`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get content information by url from the browser instead of the backend
+ * @param {String} url
+ * @returns {Object}
+ */
+export const getContentInformationByUrlFromBrowser = (url) => {
+  return new Promise(function (resolve, reject) {
+    let domain = new URL(url);
+    let instance = axiosLib.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 = htmlParser.parse(response.responseText);
+        let duration = getReadingTime(htmlToText(response.responseText));
+        let title = document.querySelector("title")?.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=${pathArray[2]}`,
+            title: title ? title.trim() : url,
+            type: 0,
+            internal: true,
+          });
+        }
+      })
+      .catch((error) => {
+        reject(new Error(errorToString(error)));
+      });
+  });
+};
+
+/**
+ * Get enabled content providers
+ * @param {String} userid
+ * @param {String} verb The verb
+ * @param {String} token Authorization token
+ */
+export const getEnabledContentProviders = (userId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/contentproviders/getenabledcontentproviders/${userId}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Publish integration
+ * @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) {
+    let confirmationRequest = client.post(
+      `api/v1/integrations/publish/${id}`,
+      {},
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * 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
+ */
+export const setIntegrationInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/integrations/${id}`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set default integration
+ * @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) {
+    let confirmationRequest = client.post(
+      `api/v1/integrations/${id}/default`,
+      "",
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const integration = {
+  createIntegration,
+  deleteIntegration,
+  discardIntegrationChanges,
+  getContentInformationByUrl,
+  getContentInformationByUrlFromBrowser,
+  getEnabledContentProviders,
+  getIntegrationInformationById,
+  getIntegrationsList,
+  publishIntegration,
+  setDefaultIntegration,
+  setIntegrationInformation,
+};
+
+export default integration;

package/lib/integrationConfiguration.js

@@ -0,0 +1,108 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Get the integration configuration
+ * @param {Array<String>} ids
+ * @param {Number} type
+ * @param {String} token Authorization token
+ */
+export const getIntegrationsConfiguration = (ids, type, token) => {
+  return new Promise(function (resolve, reject) {
+    let requestData = { type: type };
+    if (ids) requestData.ids = ids;
+    let confirmationRequest = client.post(
+      "api/v1/integrationsconfiguration",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Save integration configuration
+ * @param {String} id The id of the integration configurationto be updated
+ * @param {Number} type The type of configuration
+ * @param {Object} configuration Data used to update the integration configuration
+ * @param {String} token Authorization token
+ */
+export const saveIntegrationConfiguration = (
+  id,
+  type,
+  configuration,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      id: id,
+      configuration: configuration,
+      type: type,
+    };
+    let confirmationRequest = client.put(
+      `api/v1/integrationsconfiguration`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Test integration configuration
+ * @param {String} id The id of the integration to be updated
+ * @param {String} type The type of configuration
+ * @param {Object} configuration Configuration to be tested
+ * @param {String} token Authorization token
+ */
+export const testIntegrationConfiguration = (
+  id,
+  type,
+  configuration,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      id: id,
+      configuration: configuration,
+      type: type,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/integrationsconfiguration/testConfiguration`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const integrationConfiguration = {
+  getIntegrationsConfiguration,
+  saveIntegrationConfiguration,
+  testIntegrationConfiguration,
+};
+
+export default integrationConfiguration;

package/lib/integrations/contentGenerator.js

@@ -0,0 +1,79 @@
+import { client } from "../axiosClient.js";
+
+/**
+ * Generate content
+ * @param {Array<String>} data
+ * @param {String} contentType
+ * @param {String} integrationId
+ * @param {String} token
+ * @returns {Object}
+ */
+export const generateContent = (data, contentType, integrationId, token) => {
+  return new Promise(function (resolve, reject) {
+    let data_ = {
+      data: data,
+      contentType: contentType,
+    };
+    if (integrationId) data.integrationId = integrationId;
+    const request = client.post(`api/v1/contentgenerators/generate`, data_, {
+      headers: { authorization: token },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Generate content aync
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} contentType
+ * @param {String} elementType
+ * @param {String} integrationId
+ * @param {String} comments
+ * @param {String} token
+ * @returns {Object}
+ */
+export const generateContentAsync = (
+  id,
+  data,
+  contentType,
+  elementType,
+  integrationId,
+  comments,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    let data_ = {
+      data: data,
+      comments: comments,
+      contentType: contentType,
+      elementType: elementType,
+      id: id,
+    };
+    if (integrationId) data_.integrationId = integrationId;
+    const request = client.post(
+      `api/v1/contentgenerators/generateasync`,
+      data_,
+      {
+        headers: { authorization: token },
+      }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const contentGenerator = { generateContent, generateContentAsync };
+
+export default contentGenerator;