Merge pull request #42 from AddSearch/accept-personalization-token-or-use-cookie

Accept personalization token or use cookie

Author: haoAddsearch

README.md

@@ -335,13 +335,46 @@ client.setAnalyticsTag('Navigation search');
 
 ### Personalization
 
-#### Set user token (for personalized search results)
+#### Enable personalization tracking
+Enable personalization tracking, user token will be included in every stat events as "session ID". <br/>
+
+Set stats session ID if user token is generated by your site.
+```js
+client.setStatsSessionId(userToken);
+```
+
+If session is not set, a UUID is generated and stored in a cookie named 'addsearchUserToken`.
+Specify the expiration date of the cookie. Default is 180.
+```js
+// Defaults - isEnabled: false, expirationDates: 180
+client.enablePersonalizationTracking(isEnabled, expirationDates);
+```
+
+
+#### Allow storing AddSearch's user token in cookie
+By default, the value is true. Set it to false when users reject cookie (AddSearch's cookie can be categorized as functional/analytics cookie).
+```js
+// Default: true
+client.consentAddSearchCookie(false);
+```
+
+
+#### Set user token to search query (for personalized search results)
 ```js
 // Add a user token to the search request (if personalization in use)
-client.setUserToken('uuid');
+client.setUserToken(userToken);
 ```
 
-#### Send personalization events with search query
+
+#### Get user token from AddSearch cookie
+Get the user token which is stored in AddSearch cookie (if available).
+```js
+// Get a user token
+client.getUserTokenInPersonalization();
+```
+
+
+#### Send personalization events with search query - deprecated
 In personalized search, user events are typically sent to AddSearch via API and a user token
 is passed with the search query (see setUserToken function). 
 An alternative way is to send user events needed for personalization with the search query.
@@ -358,6 +391,8 @@ var events = [
 client.setPersonalizationEvents(events);
 ```
 
+
+
 ### Other
 
 #### Set JSON Web Token (for authentication)

dist/addsearch-js-client.min.js

@@ -38,15 +38,16 @@
   "dependencies": {
     "axios": "^0.27.2",
     "es6-promise": "^4.2.8",
-    "js-base64": "^3.6.0"
+    "js-base64": "^3.6.0",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.20.7",
+    "@babel/cli": "^7.21.0",
     "@babel/core": "^7.12.9",
     "@babel/preset-env": "^7.12.7",
     "@babel/register": "^7.12.1",
     "axios-mock-adapter": "^1.21.2",
-    "babel-loader": "^8.2.1",
+    "babel-loader": "^9.1.2",
     "buffer": "^6.0.3",
     "eslint": "^8.13.0",
     "eslint-webpack-plugin": "^3.1.1",

package-lock.json

@@ -0,0 +1,32 @@
+const setCookie = function(cookieName, cookieValue, expireDays) {
+  const date = new Date();
+  date.setTime(date.getTime() + (expireDays * 24 * 60 * 60 * 1000));
+  let expires = "expires="+ date.toUTCString();
+  document.cookie = cookieName + "=" + cookieValue + ";" + expires + ";path=/";
+}
+
+const getCookie = function(cookieName) {
+  let name = cookieName + "=";
+  let decodedCookie = decodeURIComponent(document.cookie);
+  let cookieArray = decodedCookie.split(';');
+  for(let i = 0; i < cookieArray.length; i++) {
+    let cookie = cookieArray[i];
+    while (cookie.charAt(0) === ' ') {
+      cookie = cookie.substring(1);
+    }
+    if (cookie.indexOf(name) === 0) {
+      return cookie.substring(name.length, cookie.length);
+    }
+  }
+  return undefined;
+}
+
+const deleteCookie = function(name) {
+  document.cookie = name +'=; Path=/; Expires=Thu, 01 Jan 2000 00:00:01 GMT;';
+}
+
+module.exports = {
+  setCookie,
+  getCookie,
+  deleteCookie
+}