change terminology to "userToken", prevent storing customer's statsSessionId in cookie

Author: haoAddsearch

README.md

@@ -336,42 +336,41 @@ client.setAnalyticsTag('Navigation search');
 ### Personalization
 
 #### Enable personalization tracking
-Enable personalization tracking, personalization token will be included in every stat events as "session ID". <br/>
+Enable personalization tracking, user token will be included in every stat events as "session ID". <br/>
 
-Set stats session ID if personalization token is generated by your site.
+Set stats session ID if user token is generated by your site.
 ```js
-client.setStatsSessionId(id);
+client.setStatsSessionId(userToken);
 ```
 
-If session ID is not set, a UUID is generated and stored in AddSearch's cookie. Cookie's name: addsearchPersonalizationToken
-Specify how many days personalization token stay in cookie. By default, it's 180 days.
+If session ID is not set, a UUID is generated and stored in AddSearch's cookie. Cookie's name: addsearchUserToken
+Specify how many dates user token stay in cookie. Default is 180 dates.
 ```js
-// Defaults - isEnabled: false, expirationDays: 180
-client.enablePersonalizationTracking(isEnabled, expirationDays);
+// Defaults - isEnabled: false, expirationDates: 180
+client.enablePersonalizationTracking(isEnabled, expirationDates);
 ```
 
 
-#### Allow storing personalization token in cookie
-By default, the value is true. Set it to false when users disallow usage of functional/analytics cookie. <br/>
-This method is used when you have a cookie consent popup, and a function handler in case users rejects usage of personalization cookie.
+#### 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 (for personalized search results)
+#### 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('Personalization token');
+client.setUserToken(userToken);
 ```
 
 
-#### Get personalization token from AddSearch cookie
-Get the personalization token which is stored in AddSearch cookie (if available).
+#### Get user token from AddSearch cookie
+Get the user token which is stored in AddSearch cookie (if available).
 ```js
-// Get a personalization token
-client.getPersonalizationToken();
+// Get a user token
+client.getUserTokenInPersonalization();
 ```
 
 

src/index.js

@@ -9,15 +9,15 @@ var throttle = require('./throttle');
 var cookie = require('./cookie');
 
 var API_HOSTNAME = 'api.addsearch.com';
-var PERSONALIZATION_TOKEN_COOKIE_NAME = 'addsearchPersonalizationToken';
+var USER_TOKEN_COOKIE_NAME = 'addsearchUserToken';
 
 var client = function(sitekey, privatekey) {
   this.sitekey = sitekey;
   this.privatekey = privatekey;
   this.apiHostname = API_HOSTNAME;
   this.settings = new Settings();
   this.sessionId = ('a-' + (Math.random() * 100000000)).substring(0, 10);
-  this.personalizationToken = cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME) || util.generateUUID();
+  this.userTokenInPersonalization = cookie.getCookie(USER_TOKEN_COOKIE_NAME) || util.generateUUID();
 
   /**
    * Fetch search results
@@ -205,23 +205,23 @@ var client = function(sitekey, privatekey) {
   this.setThrottleTime = function(delay) {this.settings.setThrottleTime(delay);}
   this.setStatsSessionId = function(id) {
     this.sessionId = id;
-    this.personalizationToken = id;
+    this.userTokenInPersonalization = null;
   }
   this.getStatsSessionId = function() {return this.sessionId;}
   this.enableLogicalOperators = function(enableLogicalOperators) {this.settings.enableLogicalOperators(enableLogicalOperators)};
   this.setSearchOperator = function(operator) {this.settings.setSearchOperator(operator)};
 
   this.sendStatsEvent = function(type, keyword, data) {
 
-    var usePersonalizationToken = isPersonalizationTrackingEnabled && isAddSearchCookieConsented;
-    if (usePersonalizationToken && !cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME)) {
-      cookie.setCookie(PERSONALIZATION_TOKEN_COOKIE_NAME, this.personalizationToken, personalizationCookieExpireDays);
+    var useUserTokenInCookie = this.userTokenInPersonalization && isPersonalizationTrackingEnabled && isAddSearchCookieConsented;
+    if (useUserTokenInCookie && !cookie.getCookie(USER_TOKEN_COOKIE_NAME)) {
+      cookie.setCookie(USER_TOKEN_COOKIE_NAME, this.userTokenInPersonalization, personalizationCookieExpireDays);
     }
 
     if (type === 'search') {
       let payload = {
         action: 'search',
-        session: usePersonalizationToken ? this.personalizationToken : this.sessionId,
+        session: useUserTokenInCookie ? this.userTokenInPersonalization : this.sessionId,
         keyword: keyword,
         numberOfResults: data.numberOfResults,
         analyticsTag: this.getSettings().analyticsTag
@@ -232,7 +232,7 @@ var client = function(sitekey, privatekey) {
     else if (type === 'click') {
       let payload = {
         action: 'click',
-        session: usePersonalizationToken ? this.personalizationToken : this.sessionId,
+        session: useUserTokenInCookie ? this.userTokenInPersonalization : this.sessionId,
         keyword: keyword,
         docid: data.documentId,
         position: data.position,
@@ -253,8 +253,8 @@ var client = function(sitekey, privatekey) {
   var isAddSearchCookieConsented = true;
   var personalizationCookieExpireDays = 180;
 
-  this.getPersonalizationToken = function() {
-    return this.personalizationToken;
+  this.getUserTokenInPersonalization = function() {
+    return this.userTokenInPersonalization;
   };
 
   this.enablePersonalizationTracking = function(isEnabled, cookieExpireDays) {