@stackfactor/client-api 1.1.140 → 1.1.143

package/dist/esm/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns the backend base API URL
+ * @returns {String}
+ */
+export declare const getBaseUrl: () => string;
+/**
+ * Remove null properties
+ * @param {Object} object
+ * @returns {Object}
+ */
+export declare const removeNullProperties: (object: {
+    [key: string]: any;
+}) => object;
+//# sourceMappingURL=utils.d.ts.map

package/dist/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,eAAO,MAAM,UAAU,QAAO,MAqB7B,CAAC;AAEF;;;;GAIG;AAEH,eAAO,MAAM,oBAAoB,WAAY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,KAAG,MAWrE,CAAC"}

package/dist/esm/utils.js

@@ -0,0 +1,50 @@
+import dotenv from "dotenv";
+// Load environment variables from .env file
+dotenv.config();
+/**
+ * Returns the backend base API URL
+ * @returns {String}
+ */
+export const getBaseUrl = () => {
+    if (process.env.REACT_APP_BACKEND_URL) {
+        return process.env.REACT_APP_BACKEND_URL;
+    }
+    else {
+        switch (process.env.REACT_APP_NODE_ENV) {
+            case "development":
+            case null:
+            case undefined:
+                return "https://localhost/";
+            case "testing":
+                return "https://qaapi.stackfactor.ai/";
+            case "nonprod":
+                return "https://apiqa.stackfactor.ai/";
+            case "production":
+                return "https://api.stackfactor.ai/";
+            case "security":
+                return "https://csapi.stackfactor.ai/";
+            default:
+                throw new Error("Invalid environment");
+        }
+    }
+};
+/**
+ * Remove null properties
+ * @param {Object} object
+ * @returns {Object}
+ */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export const removeNullProperties = (object) => {
+    Object.keys(object).forEach((key) => {
+        const value = object[key];
+        const hasProperties = value && Object.keys(value).length > 0;
+        if (value === null) {
+            delete object[key];
+        }
+        else if (typeof value !== "string" && hasProperties) {
+            removeNullProperties(value);
+        }
+    });
+    return object;
+};
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,4CAA4C;AAC5C,MAAM,CAAC,MAAM,EAAE,CAAC;AAIhB;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAW,EAAE;IACrC,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;QACtC,OAAO,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,QAAQ,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YACvC,KAAK,aAAa,CAAC;YACnB,KAAK,IAAI,CAAC;YACV,KAAK,SAAS;gBACZ,OAAO,oBAAoB,CAAC;YAC9B,KAAK,SAAS;gBACZ,OAAO,+BAA+B,CAAC;YACzC,KAAK,SAAS;gBACZ,OAAO,+BAA+B,CAAC;YACzC,KAAK,YAAY;gBACf,OAAO,6BAA6B,CAAC;YACvC,KAAK,UAAU;gBACb,OAAO,+BAA+B,CAAC;YACzC;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,uDAAuD;AACvD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,MAA8B,EAAU,EAAE;IAC7E,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,MAAM,aAAa,GAAG,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,EAAE,CAAC;YACtD,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.1.140",
+  "version": "1.1.143",
   "description": "Node.js library for the StackFactor API",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -11,6 +11,13 @@
       "require": "./dist/cjs/index.js"
     }
   },
+  "files": [
+    "declarations",
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
   "type": "module",
   "scripts": {
     "build": "npm run build:esm && npm run build:cjs",
@@ -34,7 +41,7 @@
     "axios": "^1.8.1",
     "dotenv": "^16.4.7",
     "html2plaintext": "^2.1.4",
-    "https": "^1.0.0",
+    "https": "latest",
     "node-html-parser": "^7.0.1"
   },
   "devDependencies": {

package/. npmignore

@@ -1,11 +0,0 @@
-# Ignore everything
-
--
-
-# Except the following
-
-!declarations
-!dist
-!package.json
-!README.md
-!LICENSE

package/.eslintrc.json

@@ -1,14 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module"
-  },
-  "plugins": [],
-  "rules": { "@typescript-eslint/no-explicit-any": "error" }
-}

package/src/lib/actionNotifications.ts

@@ -1,87 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-/**
- * Get all permissions
- * @param {String} token The authentication token
- * @returns {Promise<object>}
- */
-export const getAllUserNotifications = (token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`api/v1/actionnotifications`, {
-      headers: { authorization: token },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Mark notifications as open or viewed
- * @param {Array<String>} ids The id of the notifications to be marked
- * @param {String} status The new status
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const markNotifications = (
-  ids: string[],
-  status: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.put(
-      `api/v1/actionnotifications/mark`,
-      {
-        ids: ids,
-        status: status,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Process a notification
- * @param {String} id The notification id
- * @param {String} action The action to be executed
- * @param {String} comments The comments to be saved in the notification
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const processNotification = (
-  id: string,
-  action: string,
-  comments: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.put(
-      `api/v1/actionnotifications/process`,
-      {
-        id: id,
-        action: action,
-        comments: comments,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};

package/src/lib/address.ts

@@ -1,25 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-/**
- * Validate Address
- * @param {String} input - the address in raw format
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const autoComplete = (input: string, authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const getAddressesRequest = client.post(
-      `api/v1/address/autocomplete/`,
-      { input: input },
-      { headers: { authorization: authToken } }
-    );
-    getAddressesRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};

package/src/lib/aiAssistant.ts

@@ -1,190 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-interface AskQuestionData {
-  conversationId: string;
-  question: string;
-  updatedContext: string;
-}
-
-interface EndConversationData {
-  conversationId: string;
-}
-
-interface StartConversationData {
-  autoContextRefresh: boolean;
-  context: string;
-  question: string;
-  elementId: string;
-  elementType: string;
-  conversationId?: string | null;
-}
-
-/**
- * Ask Question to the AI
- * @param {String} conversationId
- * @param {String} question
- * @param {String} updatedContext
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const askQuestion = (
-  conversationId: string,
-  question: string,
-  updatedContext: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: AskQuestionData = {
-      conversationId: conversationId,
-      question: question,
-      updatedContext: updatedContext,
-    };
-    const confirmationRequest = client.post(
-      "/api/v1/aiassistant/askquestion",
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * End conversation with the AI
- * @param {String} conversationId
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const endConversation = (
-  conversationId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: EndConversationData = {
-      conversationId: conversationId,
-    };
-    const confirmationRequest = client.post(
-      "/api/v1/aiassistant/endconversation",
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get conversation by elementId
- * @param {String} elementId
- * @param {String} token
- * @returns {Promise<object>}
- */
-export const getConversationByElementId = (
-  elementId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `/api/v1/aiassistant/getconversation/${elementId}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get the voice assistant URL
- * @param {String} language
- * @param {String} token
- * @returns {Promise<object>}
- */
-export const getVoiceAssistantUrl = (
-  language: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `/api/v1/aiassistant/getvoiceassistanturl/${language}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Start conversation with the AI
- * @param {String} elementId
- * @param {String} elementType
- * @param {String} context
- * @param {Boolean} autoContextRefresh
- * @param {String} token
- * @param {String} conversationId Optional
- * @returns {Promise<object>}
- */
-export const startConversation = (
-  elementId: string,
-  elementType: string,
-  question: string,
-  context: string,
-  autoContextRefresh: boolean,
-  token: string,
-  conversationId: string | null = null
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: StartConversationData = {
-      autoContextRefresh: autoContextRefresh,
-      context: context,
-      question: question,
-      elementId: elementId,
-      elementType: elementType,
-    };
-    if (conversationId) {
-      data.conversationId = conversationId;
-    }
-    const confirmationRequest = client.post(
-      "/api/v1/aiassistant/startconversation",
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};

package/src/lib/avatar.ts

@@ -1,38 +0,0 @@
-import { AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-/**
- * Get avatar for an elementId
- * @param {String} elementId
- * @param {String} type
- * @param {Number} width
- * @param {Number} height
- * @param {String} token
- * @returns {Promise<Blob>}
- */
-export const getAvatar = (
-  elementId: string,
-  type: string,
-  width: number,
-  height: number,
-  token: string
-): Promise<Blob> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `/api/v1/avatar/getavatar/${elementId}/${type}/${width}/${height}`,
-      {
-        headers: {
-          authorization: token,
-        },
-        responseType: "blob",
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch(() => {
-        reject("Error getting avatar");
-      });
-  });
-};

package/src/lib/axiosClient.ts

@@ -1,97 +0,0 @@
-import axios, { AxiosError, AxiosResponse } from "axios";
-import { RESPONSE_TYPE } from "./constants";
-import * as utils from "./utils";
-
-interface ErrorResponse {
-  msg: string;
-  param: string;
-  value: string;
-  toString: () => string;
-}
-
-interface CustomAxiosResponse extends AxiosResponse {
-  errors?: ErrorResponse[];
-  toString: () => string;
-}
-
-const baseUrl = utils.getBaseUrl();
-
-export const client = axios.create({
-  baseURL: baseUrl,
-  withCredentials: true,
-});
-
-/**
- * Returns the error as a string
- * @param {AxiosError} error
- * @returns {string}
- */
-export const errorToString = (error: AxiosError): string => {
-  if (error != null) {
-    if (error.response?.data) {
-      let asString = "";
-      const responseData = error.response.data as CustomAxiosResponse;
-      if (Array.isArray(responseData.errors)) {
-        responseData.errors.forEach(
-          (item: ErrorResponse, index: number) => {
-            asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
-              item.param
-            } ${item.value ? `value ${item.value.toString()}` : ""}`;
-          }
-        );
-        return asString;
-      } else if (responseData.errors) {
-        return JSON.stringify(responseData.errors);
-      } else if (error.response.statusText) {
-        return error.response.statusText.toString();
-      } else {
-        return responseData.toString();
-      }
-    } else {
-      return error.message ? error.message : "Unknown error";
-    }
-  }
-  return "Unknown error";
-};
-
-/**
- * Returns the code of the error as a number
- * @param {AxiosError} error
- * @returns {number} The error code
- */
-export const getErrorType = (error: AxiosError): number => {
-  if (error.response?.status) {
-    return error.response.status;
-  } else return RESPONSE_TYPE.SERVICE_UNAVAILABLE;
-};
-
-/**
- * Return the error information to include just the status and the message
- * @param {AxiosError} error
- * @returns {Object}
- */
-export const getErrorInformation = (
-  error: AxiosError
-): { status: number; message: string } => {
-  return {
-    status: getErrorType(error),
-    message: errorToString(error),
-  };
-};
-
-/**
- * Returns true if an exception should be handled to the business and presentation layer
- * @param {boolean} returnAllExceptions - If set true all exceptions will be passed
- * @param {AxiosError} error - The error returned by the server
- * @returns {boolean}
- */
-export const shouldReturnError = (
-  returnAllExceptions: boolean,
-  error: AxiosError
-): boolean => {
-  if (getErrorType(error) === RESPONSE_TYPE.UNAUTHORIZED) {
-    return returnAllExceptions;
-  } else {
-    return true;
-  }
-};

package/src/lib/config.ts

@@ -1,80 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-/**
- * Get the specified configuration by Id. It returns a promise
- * @param {String} id - the id of the configuration element
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const getConfigurationById = (
-  id: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const getConfigInformationRequest = client.get(
-      `api/v1/configurations/configuration/id/${id}`,
-      { headers: { authorization: authToken } }
-    );
-    getConfigInformationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get the specified configuration by type. It returns a promise
- * @param {String} type - the id of the configuration element
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const getConfigurationByType = (
-  type: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const getConfigInformationRequest = client.get(
-      `api/v1/configurations/configuration/type/${type}`,
-      { headers: { authorization: authToken } }
-    );
-    getConfigInformationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Set the specified configuration by Id. It returns a promise
- * @param {String} id - the id of the configuration element
- * @param {Object} data - the object containing the updated configuration element
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const setConfigurationById = (
-  id: string,
-  data: object,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const getConfigInformationRequest = client.post(
-      `api/v1/configurations/configuration/${id}`,
-      { data: data },
-      { headers: { authorization: authToken } }
-    );
-    getConfigInformationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};