@stackfactor/client-api 1.1.12-9.2 → 1.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.1.129.2",
+  "version": "1.1.13",
   "description": "Node.js library for the StackFactor API",
   "main": "index.js",
   "exports": {
@@ -12,11 +12,6 @@
   },
   "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": {
@@ -35,11 +30,5 @@
     "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/.eslintrc.json

@@ -1,13 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
-  "extends": ["eslint:recommended", "plugin:react/recommended"],
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
-  "plugins": [],
-  "rules": {}
-}

package/index.ts

@@ -1 +0,0 @@
-export * from "./exports.js";

package/lib/aiAssistant.ts

@@ -1,197 +0,0 @@
-import { client } from "./axiosClient.js";
-
-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>}
- */
-const askQuestion = (
-  conversationId: string,
-  question: string,
-  updatedContext: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: AskQuestionData = {
-      conversationId: conversationId,
-      question: question,
-      updatedContext: updatedContext,
-    };
-    let confirmationRequest = client.post(
-      "/api/v1/aiassistant/askquestion",
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * End conversation with the AI
- * @param {String} conversationId
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
- */
-const endConversation = (
-  conversationId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: EndConversationData = {
-      conversationId: conversationId,
-    };
-    let confirmationRequest = client.post(
-      "/api/v1/aiassistant/endconversation",
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get conversation by elementId
- * @param {String} elementId
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const getConversationByElementId = (
-  elementId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
-      `/api/v1/aiassistant/getconversation/${elementId}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get the voice assistant URL
- * @param {String} language
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const getVoiceAssistantUrl = (
-  language: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
-      `/api/v1/aiassistant/getvoiceassistanturl/${language}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        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>}
- */
-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) => {
-    let data: StartConversationData = {
-      autoContextRefresh: autoContextRefresh,
-      context: context,
-      question: question,
-      elementId: elementId,
-      elementType: elementType,
-    };
-    if (conversationId) {
-      data.conversationId = conversationId;
-    }
-    let confirmationRequest = client.post(
-      "/api/v1/aiassistant/startconversation",
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-export default {
-  askQuestion,
-  endConversation,
-  getConversationByElementId,
-  getVoiceAssistantUrl,
-  startConversation,
-};

package/lib/avatar.ts

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

package/lib/axiosClient.ts

@@ -1,92 +0,0 @@
-import axios, { AxiosError } from "axios";
-import { RESPONSE_TYPE } from "./constants.js";
-import utils from "./utils.js";
-
-const baseUrl = utils.getBaseUrl();
-
-const client = axios.create({
-  baseURL: baseUrl,
-  withCredentials: true,
-});
-
-/**
- * Returns the error as a string
- * @param {AxiosError} error
- * @returns {string}
- */
-const errorToString = (error: AxiosError): string => {
-  if (error != null) {
-    if (error.response?.data) {
-      let asString = "";
-      if (Array.isArray((error.response.data as any).errors)) {
-        (error.response.data as any).errors.forEach(
-          (item: any, index: number) => {
-            asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
-              item.param
-            } ${item.value ? `value ${item.value.toString()}` : ""}`;
-          }
-        );
-        return asString;
-      } else if ((error.response.data as any).error) {
-        return (error.response.data as any).error.toString();
-      } else if (error.response.statusText) {
-        return error.response.statusText.toString();
-      } else {
-        return (error.response.data as any).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
- */
-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}
- */
-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}
- */
-const shouldReturnError = (
-  returnAllExceptions: boolean,
-  error: AxiosError
-): boolean => {
-  if (getErrorType(error) === RESPONSE_TYPE.UNAUTHORIZED) {
-    return returnAllExceptions;
-  } else {
-    return true;
-  }
-};
-
-export {
-  client,
-  errorToString,
-  getErrorType,
-  getErrorInformation,
-  shouldReturnError,
-};

package/lib/microSkillsQuizes.ts

@@ -1,70 +0,0 @@
-import { client } from "./axiosClient.js";
-
-/**
- * Get responses for a microskill quiz
- * @param {String} learningContentId
- * @param {String} microSkillId
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const getResponses = (
-  learningContentId: string,
-  microSkillId: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
-      `api/v1/microskillsresponses/${learningContentId}/${microSkillId}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Save responses for a microskill quiz
- * @param {String} learningContentId
- * @param {String} microSkillId
- * @param {Array<Object>} responses
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
- */
-const saveResponses = (
-  learningContentId: string,
-  microSkillId: string,
-  responses: object[],
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data = {
-      responses: responses,
-    };
-    let confirmationRequest = client.post(
-      `api/v1/microskillsresponses/${learningContentId}/${microSkillId}`,
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-export default {
-  getResponses,
-  saveResponses,
-};

package/lib/quotas.ts

@@ -1,59 +0,0 @@
-import { client } from "./axiosClient.js";
-
-/**
- * Get the current quota for the user and tenant
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const getAllQuota = (token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`/api/v1/quotas/getallquota`, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Increase quota utilization
- * @param {String} quotaId
- * @param {Number} value
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const increaseQuotaUtilization = (
-  quotaId: string,
-  value: number,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
-      `/api/v1/quotas/increaseutilization`,
-      {
-        id: quotaId,
-        value: value,
-      },
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-export default {
-  getAllQuota,
-  increaseQuotaUtilization,
-};

package/lib/security.ts

@@ -1,99 +0,0 @@
-import { client } from "./axiosClient.js";
-
-/**
- * Get the enabled authentication connections for current organization.
- * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
- */
-const getAuthConnections = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const getConfigInformationRequest = client.get(
-      `api/v1/security/authconnections`,
-      { headers: { authorization: authToken } }
-    );
-    getConfigInformationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Set the enabled authentication connections for current organization.
- * @param {Object} data - the object containing the updated configuration
- * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
- */
-const setAuthConnections = (
-  data: object,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const setConfigInformationRequest = client.post(
-      `api/v1/security/authconnections`,
-      { data: data },
-      { headers: { authorization: authToken } }
-    );
-    setConfigInformationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Reset the MFA for the user.
- * @param {String} userId
- * @param {String} authToken
- * @returns {Promise<Object>}
- */
-const resetMFA = (userId: string, authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const resetMFARequest = client.post(
-      `api/v1/security/resetmfa`,
-      userId ? {} : { userId: userId },
-      { headers: { authorization: authToken } }
-    );
-    resetMFARequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Synchronize the authentication connections with Auth0.
- * @param {String} authToken
- * @returns {Promise<Object>}
- */
-const synchronizeWithAuth0 = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const synchronizeRequest = client.get(
-      `api/v1/security/synchronizewithauth0`,
-      { headers: { authorization: authToken } }
-    );
-    synchronizeRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-export default {
-  getAuthConnections,
-  resetMFA,
-  setAuthConnections,
-  synchronizeWithAuth0,
-};