Merge pull request #65 from visenze/develop

[ES-8875] Release 4.0.4

Author: Sisyphus25

.prettierrc.json

@@ -1,4 +1,4 @@
 {
   "printWidth": 120,
   "singleQuote": true
-}
+}

examples/js/snippet.js

@@ -10,7 +10,7 @@
     getStub(context, doc, element, src, objs);
   }
 
-  function insertScript (doc, element, src) {
+  function insertScript(doc, element, src) {
     // create element to load javascript async
     var el = doc.createElement(element);
     el.type = 'text/javascript';
@@ -21,7 +21,7 @@
     return el;
   }
 
-  function getStub (context, doc, element, src, obj_name) {
+  function getStub(context, doc, element, src, obj_name) {
     var __visearch_obj = context[obj_name] || {};
     context[obj_name] = __visearch_obj;
     __visearch_obj.q = __visearch_obj.q || [];

index.ts

@@ -13,4 +13,4 @@ import { ViSearchClient } from './types/shared.js';
       return client;
     };
   }
-})(typeof self !== 'undefined' ? self : this);
+})(typeof self !== 'undefined' ? self : this);

jest.config.js

@@ -5,9 +5,9 @@ const config = {
   testEnvironment: 'jsdom',
   setupFiles: ['<rootDir>/test/setup/setup.js'],
   moduleNameMapper: {
-    '(.+)\\.js': '$1'
+    '(.+)\\.js': '$1',
   },
-  extensionsToTreatAsEsm: ['.ts']
+  extensionsToTreatAsEsm: ['.ts'],
 };
 
 module.exports = config;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "visearch-javascript-sdk",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "JavaScript SDK for ViSearch of visenze.com",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -31,34 +31,31 @@
   "author": "dejun@visenze.com, rachel.ngo@visenze.com",
   "license": "MIT",
   "devDependencies": {
-    "@babel/preset-env": "^7.21.5",
-    "@babel/preset-typescript": "^7.21.5",
-    "@types/jsuri": "^1.3.31",
-    "@types/lodash.find": "^4.6.7",
-    "@types/lodash.isfunction": "^3.0.7",
-    "@types/node-fetch": "^2.6.4",
-    "@typescript-eslint/eslint-plugin": "^5.59.6",
-    "babel-core": "^6.26.3",
-    "babel-loader": "^8.3.0",
+    "@babel/preset-env": "^7.23.6",
+    "@babel/preset-typescript": "^7.23.3",
+    "@types/jsuri": "^1.3.34",
+    "@types/lodash.isfunction": "^3.0.9",
+    "@types/node-fetch": "^2.6.10",
+    "@typescript-eslint/eslint-plugin": "^6.16.0",
+    "babel-loader": "^9.1.3",
     "compression-webpack-plugin": "^10.0.0",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.40.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.56.0",
     "express": "^4.18.2",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
-    "prettier": "^2.8.8",
-    "terser-webpack-plugin": "^5.3.8",
-    "typescript": "^5.1.6",
-    "webpack": "^5.82.1",
-    "webpack-cli": "^5.1.1",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "prettier": "^3.1.1",
+    "terser-webpack-plugin": "^5.3.9",
+    "typescript": "^5.3.3",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4",
     "webpack-s3-plugin": "^1.2.0-rc.0"
   },
   "dependencies": {
-    "form-data": "^2.3.3",
+    "form-data": "^4.0.0",
     "jsuri": "^1.3.1",
-    "lodash.find": "^4.6.0",
     "lodash.isfunction": "^3.0.9",
-    "node-fetch": "^2.6.11",
+    "node-fetch": "^2.7.0",
     "visenze-tracking-javascript": "^2.0.1"
   }
-}
+}

package.json

@@ -40,7 +40,7 @@ function sendRequest(
   fetchObj: Promise<Response>,
   path: string,
   callback?: GenericCallback,
-  failure?: GenericCallback
+  failure?: GenericCallback,
 ): Promise<void> {
   const start = new Date().getTime();
   let reqid: string | null;
@@ -74,7 +74,7 @@ export const sendGetRequest = (
   path: string,
   queryParams: Record<string, unknown>,
   callback?: GenericCallback,
-  failure?: GenericCallback
+  failure?: GenericCallback,
 ): Promise<void> => {
   const url = new URI(endpoint).setPath(path);
   Object.entries(queryParams).forEach(([key, value]) => {
@@ -94,7 +94,7 @@ export const sendPostRequest = async (
   path: string,
   queryParams: Record<string, unknown>,
   callback?: GenericCallback,
-  failure?: GenericCallback
+  failure?: GenericCallback,
 ): Promise<void> => {
   const url = new URI(endpoint).setPath(path).toString();
 

src/common.ts

@@ -9,7 +9,7 @@ const PATH_REC = 'v1/product/recommendations';
 
 function getAnalyticsParams(
   queryParams: Record<string, unknown> | undefined,
-  vaParams?: Record<string, unknown>
+  vaParams?: Record<string, unknown>,
 ): Record<string, unknown> {
   const params: Record<string, unknown> = {};
   if (vaParams) {
@@ -45,7 +45,7 @@ function getEndpoint(settings: ViSearchSettings): string {
 function getQueryParams(
   params: Record<string, unknown> | undefined,
   vaParams: Record<string, unknown>,
-  settings: ViSearchSettings
+  settings: ViSearchSettings,
 ): Record<string, unknown> {
   return {
     ...(params ?? {}),
@@ -59,7 +59,7 @@ function searchByImage(
   params: Record<string, unknown>,
   vaParams: Record<string, unknown>,
   callback?: GenericCallback,
-  failure?: GenericCallback
+  failure?: GenericCallback,
 ): Promise<void> {
   const queryParams = getQueryParams(params, vaParams, settings);
   return sendPostRequest(settings, getEndpoint(settings), PATH_SEARCH, queryParams, callback, failure);
@@ -71,7 +71,7 @@ function searchById(
   params: Record<string, unknown> | undefined,
   vaParams: Record<string, unknown>,
   callback?: GenericCallback,
-  failure?: GenericCallback
+  failure?: GenericCallback,
 ): Promise<void> {
   const queryParams = getQueryParams(params, vaParams, settings);
   return sendGetRequest(settings, getEndpoint(settings), `${PATH_REC}/${productId}`, queryParams, callback, failure);
@@ -83,7 +83,7 @@ function searchByIdByPost(
   params: Record<string, unknown> | undefined,
   vaParams: Record<string, unknown>,
   callback?: GenericCallback,
-  failure?: GenericCallback
+  failure?: GenericCallback,
 ): Promise<void> {
   const queryParams = getQueryParams(params, vaParams, settings);
   return sendPostRequest(settings, getEndpoint(settings), `${PATH_REC}/${productId}`, queryParams, callback, failure);

src/productsearch.ts

@@ -3,8 +3,6 @@
  * @author dejun@visenze.com, @author rachel.ngo@visenze.com
  */
 
-import find from 'lodash.find';
-import URI from 'jsuri';
 import va, { VAClient } from 'visenze-tracking-javascript';
 import { version } from './version.js';
 
@@ -17,9 +15,6 @@ const STAGING_ENDPOINT = 'https://search-dev.visenze.com';
 const ANALYTICS_STAGING_ENDPOINT = 'https://staging-analytics.data.visenze.com/v3';
 const SDK = 'visearch js sdk';
 const SDK_VERSION = version;
-const QUERY_REQID = 'reqid';
-const QUERY_IMNAME = 'im_name';
-const QUERY_ACTION = 'action';
 const RESULT_LOAD = 'result_load';
 
 function getSdkVersion(): Record<string, string> {
@@ -29,13 +24,6 @@ function getSdkVersion(): Record<string, string> {
   };
 }
 
-/**
- * Get query parameters from url [URI] object
- */
-function getQueryParamValue(uri: URI, name: string): unknown {
-  return find([`__vi_${name}`, name], () => uri.getQueryParamValue(name));
-}
-
 export function ViSearch(configs?: Record<string, unknown>): ViSearchClient {
   const q: unknown[] = [];
   const settings: ViSearchSettings = {
@@ -149,41 +137,14 @@ export function ViSearch(configs?: Record<string, unknown>): ViSearchClient {
   function wrapCallback(
     productId: string | undefined,
     callback: ((resp: ProductSearchResponse) => void) | undefined,
-    resp: ProductSearchResponse
+    resp: ProductSearchResponse,
   ): void {
     wrapExperimentResponse(resp);
     callback?.(resp);
     saveQueryId(resp);
     sendResultLoadEvent(productId, resp);
   }
 
-  function sendRefClickEvent(): void {
-    // For browser env
-    // Check the link of current page, to check if the page is come from a previous search click.
-    let refReqId: unknown = null;
-    if (document.referrer) {
-      const refUri = new URI(document.referrer);
-      refReqId = getQueryParamValue(refUri, QUERY_REQID);
-    }
-    // Get reqid from current url or from its referrer url
-    const curUri = new URI(window.location.href);
-    const reqid = getQueryParamValue(curUri, QUERY_REQID) || refReqId;
-    const imName = getQueryParamValue(curUri, QUERY_IMNAME);
-    // If reqid, action and imName are found in current page content, send event tracking.
-    if (reqid && imName) {
-      // Get event 'action' for page will set it as 'click' action by default if not specified.
-      const action = (getQueryParamValue(curUri, QUERY_ACTION) as string) || 'click';
-      prototypes.sendEvent(action, {
-        queryId: getQueryParamValue(curUri, QUERY_REQID),
-        im_name: getQueryParamValue(curUri, QUERY_IMNAME),
-      });
-    }
-  }
-
-  if (typeof window !== 'undefined') {
-    sendRefClickEvent();
-  }
-
   const prototypes: ViSearchClient = {
     q,
     set: function (key, value) {
@@ -207,7 +168,7 @@ export function ViSearch(configs?: Record<string, unknown>): ViSearchClient {
           },
           (err) => {
             failure?.(err);
-          }
+          },
         );
       }
     },

src/visearch.ts

@@ -113,7 +113,7 @@ describe('sendEvents', () => {
       'add_to_cart',
       { sdk: 'visearch js sdk', v: version },
       expect.any(Function),
-      expect.any(Function)
+      expect.any(Function),
     );
   });
 
@@ -129,7 +129,7 @@ describe('sendEvents', () => {
       'TRANSACTION',
       { sdk: 'visearch js sdk', v: version, transId: mockUUID },
       expect.any(Function),
-      expect.any(Function)
+      expect.any(Function),
     );
   });
 
@@ -147,13 +147,13 @@ describe('sendEvents', () => {
       'transaction',
       { sdk: 'visearch js sdk', v: version, transId: mockUUID },
       expect.any(Function),
-      expect.any(Function)
+      expect.any(Function),
     );
     expect(mockTracker.sendEvent).toBeCalledWith(
       'transaction',
       { sdk: 'visearch js sdk', v: version, transId: 'sample-transId' },
       expect.any(Function),
-      expect.any(Function)
+      expect.any(Function),
     );
   });
 });