Merge pull request #79 from AddSearch/sc-11365/convert-library-to-typescript

[sc-11365] add types, setup linting

Author: haoAddsearch

.eslintrc

@@ -4,13 +4,30 @@
     "commonjs": true,
     "es2021": true
   },
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "ecmaVersion": "latest"
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "project": "./tsconfig.json"
   },
-  "extends": "eslint:recommended",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:prettier/recommended"
+  ],
+  "plugins": ["@typescript-eslint"],
   "rules": {
     "no-eval": ["error"],
     "no-trailing-spaces": "error",
-    "no-irregular-whitespace": "off"
-  }
+    "no-irregular-whitespace": "off",
+    "@typescript-eslint/no-unused-vars": ["warn"],
+    "@typescript-eslint/explicit-function-return-type": "off"
+  },
+  "ignorePatterns": [
+    "dist/",
+    "node_modules/",
+    "webpack.config.js",
+    "test/"
+  ]
 }

index.js

@@ -1,6 +1,6 @@
 {
   "name": "addsearch-js-client",
-  "version": "0.9.0",
+  "version": "1.0.0",
   "description": "AddSearch API JavaScript client",
   "repository": {
     "type": "git",
@@ -28,41 +28,54 @@
       "url": "https://www.addsearch.com"
     }
   ],
-  "main": "index.js",
+  "main": "dist/index.js",
   "jsdelivr": "./dist/addsearch-js-client.min.js",
-  "types": "index.d.ts",
+  "types": "dist/types/index.d.ts",
   "files": [
     "dist",
-    "index.d.ts",
-    "src"
+    "index.d.ts"
   ],
   "scripts": {
-    "build": "npm run test && ./node_modules/webpack-cli/bin/cli.js",
+    "build": "npm run test && webpack && tsc",
+    "watch": "webpack --watch",
+    "watch:tsc": "tsc --watch",
     "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
-    "test": "./node_modules/mocha/bin/mocha.js --recursive --require @babel/register",
-    "watch": "./node_modules/webpack-cli/bin/cli.js --watch"
+    "test": "mocha --recursive --require ts-node/register 'test/**/*.test.ts'",
+    "lint": "eslint . --ext .ts,.js",
+    "lint:fix": "eslint . --ext .ts,.js --fix",
+    "lint:watch": "nodemon --exec 'npm run lint' --watch src --ext ts"
   },
   "dependencies": {
     "axios": "^1.7.2",
     "buffer": "^6.0.3",
     "es6-promise": "^4.2.8",
     "js-base64": "^3.6.0",
-    "uuid": "^9.0.0"
+    "uuid": "^11.0.3"
   },
   "devDependencies": {
     "@babel/cli": "^7.23.9",
     "@babel/core": "^7.23.9",
     "@babel/preset-env": "^7.23.9",
+    "@babel/preset-typescript": "^7.26.0",
     "@babel/register": "^7.12.1",
+    "@types/mocha": "^10.0.10",
+    "@typescript-eslint/parser": "^8.18.1",
     "axios-mock-adapter": "^1.21.2",
     "babel-loader": "^9.1.2",
     "eslint": "^8.45.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
     "eslint-webpack-plugin": "^3.1.1",
     "esm": "^3.2.25",
     "fetch-mock": "^12.1.0",
-    "mocha": "^10.0.0",
+    "mocha": "^10.8.2",
+    "nodemon": "^3.1.9",
     "prettier": "^3.3.3",
     "terser-webpack-plugin": "^5.3.1",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.1",
     "uglify-js": "^3.12.0",
     "webpack": "^5.76.1",
     "webpack-cli": "^4.10.0"

package-lock.json

@@ -0,0 +1,45 @@
+import axios, { AxiosInstance, InternalAxiosRequestConfig } from 'axios';
+
+const apiInstance: AxiosInstance = axios.create();
+const statsInstance: AxiosInstance = axios.create();
+const conversationalSearchInteractionsInstance: AxiosInstance = axios.create();
+
+const RESPONSE_BAD_REQUEST = 400;
+const RESPONSE_SERVER_ERROR = 500;
+
+export type RequestInterceptorCallback = (config: {
+  url?: string;
+  headers?: Record<string, string>;
+}) => Partial<InternalAxiosRequestConfig>;
+
+type RequestType = 'searchApi' | 'statsApi';
+
+const setRequestInterceptor = (
+  callback: RequestInterceptorCallback,
+  requestType: RequestType
+): void => {
+  const axiosInstance = requestType === 'searchApi' ? apiInstance : statsInstance;
+
+  axiosInstance.interceptors.request.use(
+    (config: InternalAxiosRequestConfig) => {
+      const updatedConfig = callback({
+        url: config.url,
+        headers: config.headers as Record<string, string>
+      });
+      config = { ...config, ...updatedConfig };
+      return config;
+    },
+    (error) => {
+      return Promise.reject(new Error(JSON.stringify(error)));
+    }
+  );
+};
+
+export {
+  apiInstance,
+  statsInstance,
+  conversationalSearchInteractionsInstance,
+  setRequestInterceptor,
+  RESPONSE_BAD_REQUEST,
+  RESPONSE_SERVER_ERROR
+};