[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

@@ -0,0 +1,2 @@
+import Client from './src/index';
+export default Client;

index.ts

@@ -30,39 +30,50 @@
   ],
   "main": "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"
   ],
   "scripts": {
     "build": "npm run test && ./node_modules/webpack-cli/bin/cli.js",
+    "build:new": "webpack",
     "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"
+    "watch": "./node_modules/webpack-cli/bin/cli.js --watch",
+    "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",
+    "@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",
+    "nodemon": "^3.1.9",
     "prettier": "^3.3.3",
     "terser-webpack-plugin": "^5.3.1",
+    "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
+};

package.json

@@ -1,13 +1,59 @@
-'use strict';
-require('es6-promise').polyfill();
-const apiInstance = require('./api').apiInstance;
-const RESPONSE_BAD_REQUEST = require('./api').RESPONSE_BAD_REQUEST;
-const RESPONSE_SERVER_ERROR = require('./api').RESPONSE_SERVER_ERROR;
+import 'es6-promise/auto';
+import { apiInstance, RESPONSE_BAD_REQUEST, RESPONSE_SERVER_ERROR } from './api';
+import { Settings } from './settings';
+import { AxiosResponse } from 'axios';
+
+interface RecommendOptions {
+  type: 'RELATED_ITEMS' | 'FREQUENTLY_BOUGHT_TOGETHER';
+  itemId?: string;
+  blockId?: string;
+  configurationKey?: string;
+}
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface Callback {
+  (response: any): void;
+}
+/* eslint-enable @typescript-eslint/no-explicit-any */
+
+interface SourceDocuments {
+  page: number;
+  hits: Document[];
+  total_hits: number;
+}
+
+interface GenericApiResponse {
+  total_hits?: number;
+}
+
+interface ConversationsApiResponse {
+  response: {
+    conversation_id: string;
+    answer: string;
+    ids: string[];
+    source_documents: SourceDocuments;
+  };
+  errors: string[];
+  status: number;
+}
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export type ExecuteApiFetch = (
+  apiHostname: string,
+  sitekey: string,
+  type: string,
+  settings: Settings,
+  cb: Callback,
+  fuzzyRetry?: boolean,
+  customFilterObject?: Record<string, any>,
+  recommendOptions?: RecommendOptions
+) => void;
+/* eslint-enable @typescript-eslint/no-explicit-any */
 
 /**
  * Fetch search results of search suggestions from the Addsearch API
  */
-var executeApiFetch = function (
+const executeApiFetch: ExecuteApiFetch = function (
   apiHostname,
   sitekey,
   type,
@@ -17,12 +63,14 @@ var executeApiFetch = function (
   customFilterObject,
   recommendOptions
 ) {
-  var settingToQueryParam = function (setting, key) {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  const settingToQueryParam = function (setting: any, key: string) {
     if (setting || setting === false) {
       return '&' + key + '=' + setting;
     }
     return '';
   };
+  /* eslint-enable @typescript-eslint/no-explicit-any */
 
   // Validate query type
   if (
@@ -38,12 +86,12 @@ var executeApiFetch = function (
     return;
   }
 
-  var keyword = '';
-  var queryParamsString = '';
+  let keyword = '';
+  let queryParamsString = '';
 
   // API Path (eq. /search, /suggest, /autocomplete/document-field)
-  var apiEndpoint = null;
-  var apiPath = null;
+  let apiEndpoint: string | null = null;
+  let apiPath = null;
 
   // Search
   if (type === 'search') {
@@ -62,7 +110,7 @@ var executeApiFetch = function (
     keyword = encodeURIComponent(keyword);
 
     // Fuzzy
-    var fuzzy = settings.fuzzy;
+    let fuzzy = settings.fuzzy;
     if (fuzzy === 'retry') {
       // First call, non fuzzy
       if (fuzzyRetry !== true) {
@@ -142,16 +190,16 @@ var executeApiFetch = function (
 
     // Stats fields
     if (settings.statsFields) {
-      for (var i = 0; i < settings.statsFields.length; i++) {
+      for (let i = 0; i < settings.statsFields.length; i++) {
         queryParamsString = queryParamsString + '&fieldStat=' + settings.statsFields[i];
       }
     }
 
     // Personalization events
     if (settings.personalizationEvents && Array.isArray(settings.personalizationEvents)) {
       for (let i = 0; i < settings.personalizationEvents.length; i++) {
-        var obj = settings.personalizationEvents[i];
-        var key = Object.keys(obj);
+        const obj = settings.personalizationEvents[i];
+        const key = Object.keys(obj)[0];
         queryParamsString =
           queryParamsString + '&personalizationEvent=' + encodeURIComponent(key + '=' + obj[key]);
       }
@@ -185,7 +233,7 @@ var executeApiFetch = function (
       .post(`https://api.addsearch.com/v2/indices/${sitekey}/conversations`, {
         question: settings.keyword
       })
-      .then(function (response) {
+      .then(function (response: AxiosResponse<ConversationsApiResponse>) {
         if (response.data.response) {
           cb(response.data.response);
         } else {
@@ -269,8 +317,8 @@ var executeApiFetch = function (
   if (type !== 'conversational-search') {
     apiInstance
       .get(apiEndpoint)
-      .then(function (response) {
-        var json = response.data;
+      .then(function (response: AxiosResponse<GenericApiResponse>) {
+        const json = response.data;
 
         // Search again with fuzzy=true if no hits
         if (
@@ -285,7 +333,7 @@ var executeApiFetch = function (
         else {
           // Cap fuzzy results to one page as quality decreases quickly
           if (fuzzyRetry === true) {
-            var pageSize = settings.paging.pageSize;
+            const pageSize = settings.paging.pageSize;
             if (json.total_hits >= pageSize) {
               json.total_hits = pageSize;
             }
@@ -307,4 +355,5 @@ var executeApiFetch = function (
       });
   }
 };
-module.exports = executeApiFetch;
+
+export default executeApiFetch;