@stackfactor/client-api 1.1.11 → 1.1.12-9.2

package/lib/utils.ts

@@ -0,0 +1,64 @@
+/* eslint-disable no-undef */
+//import dotenv from "dotenv";
+// Load environment variables from .env file
+//dotenv.config();
+
+/**
+ * Convert object to array
+ * @param {Object} data
+ * @returns {Array}
+ */
+const objectToArray = (data: object): any[] => {
+  if (typeof data === "object") {
+    return [...Object.values(data)];
+  } else throw new Error("Invalid type");
+};
+
+/**
+ * Returns the backend base API URL
+ * @returns {String}
+ */
+const getBaseUrl = (): string => {
+  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}
+ */
+const removeNullProperties = (object: { [key: string]: any }): object => {
+  Object.keys(object).forEach((key) => {
+    let value = object[key];
+    let hasProperties = value && Object.keys(value).length > 0;
+    if (value === null) {
+      delete object[key];
+    } else if (typeof value !== "string" && hasProperties) {
+      removeNullProperties(value);
+    }
+  });
+  return object;
+};
+
+const utils = { getBaseUrl, objectToArray, removeNullProperties };
+
+export default utils;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.1.11",
+  "version": "1.1.129.2",
   "description": "Node.js library for the StackFactor API",
   "main": "index.js",
   "exports": {
@@ -12,6 +12,11 @@
   },
   "type": "module",
   "scripts": {
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:watch": "tsc --watch",
+    "lint": "eslint lib/**/*.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -30,5 +35,11 @@
     "html2plaintext": "^2.1.4",
     "https": "^1.0.0",
     "node-html-parser": "^6.1.5"
+  },
+  "devDependencies": {
+    "@types/axios": "^0.14.4",
+    "@types/node": "^22.13.5",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.34.0"
   }
 }

package/index.js

@@ -1,3 +0,0 @@
-import * as api from "./exports.js";
-export * from "./exports.js";
-export default api;

package/lib/axiosClient.js

@@ -1,85 +0,0 @@
-import axios from "axios";
-import { RESPONSE_TYPE } from "./constants.js";
-import https from "https";
-import utils from "./utils.js";
-
-const baseUrl = utils.getBaseUrl();
-
-const client = axios.create({
-  baseURL: baseUrl,
-  httpsAgent: new https.Agent({
-    rejectUnauthorized: false,
-  }),
-});
-
-/**
- * Returns the error as a string
- * @param {Object} error
- */
-const errorToString = (error) => {
-  if (error != null) {
-    if (error?.response?.data) {
-      let asString = "";
-      if (Array.isArray(error.response.data.errors)) {
-        error.response.data.errors.forEach((item, index) => {
-          asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
-            item.param
-          } ${item.value ? `value ${item.value.toString()}` : ""}`;
-        });
-        return asString;
-      } else if (error.response.data.error) {
-        return error.response.data.error.toString();
-      } else if (error.response.statusText) {
-        return error.response.statusText.toString();
-      } else {
-        return error.response.data.toString();
-      }
-    } else {
-      return error.message ? error.message : "Unknown error";
-    }
-  }
-};
-
-/**
- * Returns the code of the error as a number
- * @param {Object} error
- * @returns {Number} The error code
- */
-const getErrorType = (error) => {
-  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 {Object} error
- * @returns Object
- */
-const getErrorInformation = (error) => {
-  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 {Object} error - The error returned by the server
- */
-const shouldReturnError = (returnAllExceptions, error) => {
-  if (getErrorType(error) === RESPONSE_TYPE.UNAUTHORIZED) {
-    return returnAllExceptions;
-  } else {
-    return true;
-  }
-};
-
-export {
-  client,
-  errorToString,
-  getErrorType,
-  getErrorInformation,
-  shouldReturnError,
-};

package/lib/skillAssessmentTestingSession.js

@@ -1,148 +0,0 @@
-import { client } from "./axiosClient.js";
-
-/**
- * End an existing testing session
- * @param {String} testingSessionId
- * @param {String} token Authorization token
- */
-export const endSession = (testingSessionId, token) => {
-  return new Promise(function (resolve, reject) {
-    let confirmationRequest = client.put(
-      "api/v1/skillassessmenttestingsession/endsession",
-      { id: testingSessionId },
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * End an existing testing session
- * @param {String} testingSessionId
- * @param {Array<String>} selectedAnswers
- * @param {String} token Authorization token
- */
-export const getNextStep = (testingSessionId, selectedAnswers, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {
-      id: testingSessionId,
-    };
-    if (selectedAnswers) data.selectedAnswers = selectedAnswers;
-    let confirmationRequest = client.post(
-      `api/v1/skillassessmenttestingsession/getnextstep`,
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get skill assessment by user and skill
- * @param {String} userId
- * @param {String} skillId
- * @param {String} token
- * @returns
- */
-export const getSkillTestAssessment = (userId, skillId, token) => {
-  return new Promise(function (resolve, reject) {
-    let confirmationRequest = client.post(
-      `api/v1/skillassessmenttestingsession/getbyuserandskill`,
-      {
-        userId: userId,
-        skillId: skillId,
-      },
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Pause skill assessment
- * @param {String} testingSessionId
- * @param {String} token
- * @returns
- */
-export const pause = (testingSessionId, token) => {
-  return new Promise(function (resolve, reject) {
-    let confirmationRequest = client.post(
-      `api/v1/skillassessmenttestingsession/pausesession`,
-      {
-        id: testingSessionId,
-      },
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Start a new test skill test assessment session
- * @param {String} skillId
- * @param {Boolean} saveSession
- * @param {String} token
- */
-export const startSession = (skillId, saveSession, token) => {
-  return new Promise(function (resolve, reject) {
-    let confirmationRequest = client.post(
-      "api/v1/skillassessmenttestingsession/startsession",
-      {
-        saveSession: saveSession,
-        skillId: skillId,
-      },
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-const skillAessementTestingSession = {
-  endSession,
-  getNextStep,
-  getSkillTestAssessment,
-  pause,
-  startSession,
-};
-
-export default skillAessementTestingSession;

package/lib/utils.js

@@ -1,48 +0,0 @@
-import dotenv from "dotenv";
-// Load environment variables from .env file
-dotenv.config();
-
-/**
- * Convert object to array
- * @param {Object} data
- * @returns {Array}
- */
-export const objectToArray = (data) => {
-  if (typeof data === "object") {
-    return [...data];
-  } else throw new Error("Invalid type");
-};
-
-/**
- * Returns the backend base API URL
- * @returns {String}
- */
-export const getBaseUrl = () => {
-  if (!process.env.NODE_ENV || process.env.NODE_ENV === "production") {
-    return "https://api.stackfactor.io/";
-  } else {
-    return "http://localhost:3100/";
-  }
-};
-
-/**
- * Remove null properties
- * @param {Object} object
- * @returns {Object}
- */
-export const removeNullProperties = (object) => {
-  Object.keys(object).forEach((key) => {
-    let value = object[key.toString()];
-    let hasProperties = value && Object.keys(value).length > 0;
-    if (value === null) {
-      delete object[key.toString()];
-    } else if (typeof value !== "string" && hasProperties) {
-      removeNullProperties(value);
-    }
-  });
-  return object;
-};
-
-const utils = { getBaseUrl, objectToArray, removeNullProperties };
-
-export default utils;