@stackfactor/client-api 1.1.11 → 1.1.12-9.2

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,
@@ -185,15 +229,16 @@ 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 title = document.querySelector("title")?.rawText;
+        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 descriptionEl = document.querySelector("meta");
         try {
@@ -203,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
@@ -222,7 +268,7 @@ export const getContentInformationByUrlFromBrowser = (url) => {
           resolve({
             description: description,
             duration: duration,
-            icon: `http://www.google.com/s2/favicons?sz=128&domain_url=${pathArray[2]}`,
+            icon: `http://www.google.com/s2/favicons?sz=128&domain_url=${domain.hostname}`,
             title: title ? title.trim() : url,
             type: 0,
             internal: true,
@@ -237,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}`,
       {
@@ -264,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}`,
       {},
@@ -289,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(
@@ -316,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`,
       "",
@@ -335,7 +393,7 @@ export const setDefaultIntegration = (id, token) => {
   });
 };
 
-const integration = {
+export default {
   createIntegration,
   deleteIntegration,
   discardIntegrationChanges,
@@ -348,5 +406,3 @@ const integration = {
   setDefaultIntegration,
   setIntegrationInformation,
 };
-
-export default integration;

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

@@ -3,12 +3,17 @@ import { client } from "./axiosClient.js";
 /**
  * Get the integration configuration
  * @param {Array<String>} ids
- * @param {Number} type
+ * @param {Array<Number>} types
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const getIntegrationsConfiguration = (ids, type, token) => {
-  return new Promise(function (resolve, reject) {
-    let requestData = { type: type };
+const getIntegrationsConfiguration = (
+  ids: string[],
+  types: number[],
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let requestData: { types: number[]; ids?: string[] } = { types: types };
     if (ids) requestData.ids = ids;
     let confirmationRequest = client.post(
       "api/v1/integrationsconfiguration",
@@ -29,18 +34,19 @@ export 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>}
  */
-export 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,
@@ -69,14 +75,15 @@ export const saveIntegrationConfiguration = (
  * @param {String} type The type of configuration
  * @param {Object} configuration Configuration to be tested
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export 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,
@@ -99,10 +106,8 @@ export const testIntegrationConfiguration = (
   });
 };
 
-const integrationConfiguration = {
+export default {
   getIntegrationsConfiguration,
   saveIntegrationConfiguration,
   testIntegrationConfiguration,
 };
-
-export default integrationConfiguration;

package/lib/integrations/{contentGenerator.js → contentGenerator.ts}

@@ -1,20 +1,40 @@
 import { client } from "../axiosClient.js";
 
+interface GenerateContentData {
+  data: string[];
+  contentType: string;
+  integrationId?: string;
+}
+
+interface GenerateContentAsyncData {
+  id: string;
+  data: object;
+  contentType: string;
+  elementType: string;
+  integrationId?: string;
+  comments: string;
+}
+
 /**
  * Generate content
  * @param {Array<String>} data
  * @param {String} contentType
  * @param {String} integrationId
  * @param {String} token
- * @returns {Object}
+ * @returns {Promise<Object>}
  */
-export const generateContent = (data, contentType, integrationId, token) => {
-  return new Promise(function (resolve, reject) {
-    let data_ = {
+export const generateContent = (
+  data: string[],
+  contentType: string,
+  integrationId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data_: GenerateContentData = {
       data: data,
       contentType: contentType,
     };
-    if (integrationId) data.integrationId = integrationId;
+    if (integrationId) data_.integrationId = integrationId;
     const request = client.post(`api/v1/contentgenerators/generate`, data_, {
       headers: { authorization: token },
     });
@@ -29,7 +49,7 @@ export const generateContent = (data, contentType, integrationId, token) => {
 };
 
 /**
- * Generate content aync
+ * Generate content async
  * @param {String} id
  * @param {Object} data
  * @param {String} contentType
@@ -37,24 +57,24 @@ export const generateContent = (data, contentType, integrationId, token) => {
  * @param {String} integrationId
  * @param {String} comments
  * @param {String} token
- * @returns {Object}
+ * @returns {Promise<Object>}
  */
 export const generateContentAsync = (
-  id,
-  data,
-  contentType,
-  elementType,
-  integrationId,
-  comments,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    let data_ = {
+  id: string,
+  data: object,
+  contentType: string,
+  elementType: string,
+  integrationId: string,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data_: GenerateContentAsyncData = {
+      id: id,
       data: data,
       comments: comments,
       contentType: contentType,
       elementType: elementType,
-      id: id,
     };
     if (integrationId) data_.integrationId = integrationId;
     const request = client.post(