rudder-sdk-js 2.3.8 → 2.4.0

package/index.d.ts

@@ -49,6 +49,16 @@ declare module "rudder-sdk-js" {
     };
   }
 
+  /**
+   * Represents the options parameter for anonymousId
+   */
+  interface anonymousIdOptions {
+    autoCapture?: {
+      enabled?: boolean;
+      source?: string;
+    };
+  }
+
   /**
    * Represents the options parameter in the load API
    */
@@ -74,6 +84,7 @@ declare module "rudder-sdk-js" {
     useBeacon?: boolean; // Defaults to false
     beaconQueueOptions?: beaconQueueOptions;
     cookieConsentManager?: cookieConsentManager;
+    anonymousIdOptions?: anonymousIdOptions;
   }
 
   /**
@@ -399,7 +410,7 @@ declare module "rudder-sdk-js" {
   /**
    * To get anonymousId set in the SDK
    */
-  function getAnonymousId(): string;
+  function getAnonymousId(options?: anonymousIdOptions): string;
 
   /**
    * To set anonymousId
@@ -429,6 +440,7 @@ declare module "rudder-sdk-js" {
     queueOptions,
     apiObject,
     apiCallback,
+    anonymousIdOptions,
     load,
     ready,
     reset,

package/index.js

@@ -4371,6 +4371,126 @@
     }
   })(componentUrl);
 
+  var isobject = function isObject(val) {
+    return val != null && _typeof(val) === 'object' && Array.isArray(val) === false;
+  };
+
+  /*!
+   * get-value <https://github.com/jonschlinkert/get-value>
+   *
+   * Copyright (c) 2014-2018, Jon Schlinkert.
+   * Released under the MIT License.
+   */
+  var isObject$1 = isobject;
+
+  var getValue = function getValue(target, path, options) {
+    if (!isObject$1(options)) {
+      options = {
+        default: options
+      };
+    }
+
+    if (!isValidObject(target)) {
+      return typeof options.default !== 'undefined' ? options.default : target;
+    }
+
+    if (typeof path === 'number') {
+      path = String(path);
+    }
+
+    var isArray = Array.isArray(path);
+    var isString = typeof path === 'string';
+    var splitChar = options.separator || '.';
+    var joinChar = options.joinChar || (typeof splitChar === 'string' ? splitChar : '.');
+
+    if (!isString && !isArray) {
+      return target;
+    }
+
+    if (isString && path in target) {
+      return isValid(path, target, options) ? target[path] : options.default;
+    }
+
+    var segs = isArray ? path : split(path, splitChar, options);
+    var len = segs.length;
+    var idx = 0;
+
+    do {
+      var prop = segs[idx];
+
+      if (typeof prop === 'number') {
+        prop = String(prop);
+      }
+
+      while (prop && prop.slice(-1) === '\\') {
+        prop = join([prop.slice(0, -1), segs[++idx] || ''], joinChar, options);
+      }
+
+      if (prop in target) {
+        if (!isValid(prop, target, options)) {
+          return options.default;
+        }
+
+        target = target[prop];
+      } else {
+        var hasProp = false;
+        var n = idx + 1;
+
+        while (n < len) {
+          prop = join([prop, segs[n++]], joinChar, options);
+
+          if (hasProp = prop in target) {
+            if (!isValid(prop, target, options)) {
+              return options.default;
+            }
+
+            target = target[prop];
+            idx = n - 1;
+            break;
+          }
+        }
+
+        if (!hasProp) {
+          return options.default;
+        }
+      }
+    } while (++idx < len && isValidObject(target));
+
+    if (idx === len) {
+      return target;
+    }
+
+    return options.default;
+  };
+
+  function join(segs, joinChar, options) {
+    if (typeof options.join === 'function') {
+      return options.join(segs);
+    }
+
+    return segs[0] + joinChar + segs[1];
+  }
+
+  function split(path, splitChar, options) {
+    if (typeof options.split === 'function') {
+      return options.split(path);
+    }
+
+    return path.split(splitChar);
+  }
+
+  function isValid(key, target, options) {
+    if (typeof options.isValid === 'function') {
+      return options.isValid(key, target);
+    }
+
+    return true;
+  }
+
+  function isValidObject(val) {
+    return isObject$1(val) || Array.isArray(val) || typeof val === 'function';
+  }
+
   var LOG_LEVEL_INFO = 1;
   var LOG_LEVEL_DEBUG = 2;
   var LOG_LEVEL_WARN = 3;
@@ -4709,7 +4829,7 @@
 
   // Reserved Keywords for properties/traits
   var ReservedPropertyKeywords = ["anonymous_id", "id", "sent_at", "received_at", "timestamp", "original_timestamp", "event_text", "event"]; // ECommerce Parameter Names Enumeration
-  var CONFIG_URL = "https://api.rudderlabs.com/sourceConfig/?p=npm&v=2.3.8";
+  var CONFIG_URL = "https://api.rudderlabs.com/sourceConfig/?p=npm&v=2.4.0";
   var CDN_INT_DIR = "js-integrations";
   var DEST_SDK_BASE_URL = "https://cdn.rudderlabs.com/v1.1/".concat(CDN_INT_DIR);
   var MAX_WAIT_FOR_INTEGRATION_LOAD = 10000;
@@ -9230,6 +9350,7 @@
 
       this._options = {};
       this.options(options);
+      this.isSupportAvailable = this.checkSupportAvailability();
     }
     /**
      *
@@ -9251,15 +9372,7 @@
           path: "/",
           domain: domain,
           samesite: "Lax"
-        }); // try setting a cookie first
-
-        this.set("test_rudder", true);
-
-        if (!this.get("test_rudder")) {
-          this._options.domain = null;
-        }
-
-        this.remove("test_rudder");
+        });
       }
       /**
        *
@@ -9303,6 +9416,24 @@
           return false;
         }
       }
+      /**
+       * Function to check cookie support exists or not
+       * @returns boolean
+       */
+
+    }, {
+      key: "checkSupportAvailability",
+      value: function checkSupportAvailability() {
+        var name = "test_rudder_cookie";
+        this.set(name, true);
+
+        if (this.get(name)) {
+          this.remove(name);
+          return true;
+        }
+
+        return false;
+      }
     }]);
 
     return CookieLocal;
@@ -10647,6 +10778,9 @@
     prefix: "RudderEncrypt:",
     key: "Rudder"
   };
+  var anonymousIdKeyMap = {
+    segment: "ajs_anonymous_id"
+  };
   /**
    * Json stringify the given value
    * @param {*} value
@@ -10720,10 +10854,7 @@
       _classCallCheck(this, Storage);
 
       // First try setting the storage to cookie else to localstorage
-      Cookie.set("rudder_cookies", true);
-
-      if (Cookie.get("rudder_cookies")) {
-        Cookie.remove("rudder_cookies");
+      if (Cookie.isSupportAvailable) {
         this.storage = Cookie;
         return;
       } // localStorage is enabled.
@@ -10886,14 +11017,103 @@
       value: function getGroupTraits() {
         return this.getItem(defaults$1.group_storage_trait);
       }
+      /**
+       * Function to fetch anonymousId from external source
+       * @param {string} key source of the anonymousId
+       * @returns string
+       */
+
+    }, {
+      key: "fetchExternalAnonymousId",
+      value: function fetchExternalAnonymousId(source) {
+        var anonId;
+        var key = source.toLowerCase();
+
+        if (!Object.keys(anonymousIdKeyMap).includes(key)) {
+          return anonId;
+        }
+
+        switch (key) {
+          case "segment":
+            /**
+             * First check the local storage for anonymousId
+             * Ref: https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#identify
+             */
+            if (Store$2.enabled) {
+              anonId = Store$2.get(anonymousIdKeyMap[key]);
+            } // If anonymousId is not present in local storage and check cookie support exists
+            // fetch it from cookie
+
+
+            if (!anonId && Cookie.IsCookieSupported()) {
+              anonId = Cookie.get(anonymousIdKeyMap[key]);
+            }
+
+            return anonId;
+
+          default:
+            return anonId;
+        }
+      }
       /**
        * get stored anonymous id
+       *
+       * Use cases:
+       * 1. getAnonymousId() ->  anonymousIdOptions is undefined this function will return rl_anonymous_id
+       * if present otherwise undefined
+       *
+       * 2. getAnonymousId(anonymousIdOptions) -> In case anonymousIdOptions is present this function will check
+       * if rl_anonymous_id is present then it will return that
+       *
+       * otherwise it will validate the anonymousIdOptions and try to fetch the anonymous Id from the provided source.
+       * Finally if no anonymous Id is present in the source it will return undefined.
+       *
+       * anonymousIdOptions example:
+       *  {
+            autoCapture: {
+              enabled: true,
+              source: "segment",
+            },
+          }
+       *
        */
 
     }, {
       key: "getAnonymousId",
-      value: function getAnonymousId() {
-        return this.getItem(defaults$1.user_storage_anonymousId);
+      value: function getAnonymousId(anonymousIdOptions) {
+        // fetch the rl_anonymous_id from storage
+        var rlAnonymousId = parse(decryptValue(this.storage.get(defaults$1.user_storage_anonymousId)));
+        /**
+         * If RS's anonymous ID is available, return from here.
+         *
+         * The user, while migrating from a different analytics SDK,
+         * will only need to auto-capture the anonymous ID when the RS SDK
+         * loads for the first time.
+         *
+         * The captured anonymous ID would be available in RS's persistent storage
+         * for all the subsequent SDK runs.
+         * So, instead of always grabbing the ID from the migration source when
+         * the options are specified, it is first checked in the RS's persistent storage.
+         *
+         * Moreover, the user can also clear the anonymous ID from the storage via
+         * the 'reset' API, which renders the migration source's data useless.
+         */
+
+        if (rlAnonymousId) {
+          return rlAnonymousId;
+        } // validate the provided anonymousIdOptions argument
+
+
+        var source = getValue(anonymousIdOptions, "autoCapture.source");
+
+        if (getValue(anonymousIdOptions, "autoCapture.enabled") === true && typeof source === "string") {
+          // fetch the anonymousId from the external source
+          // ex - segment
+          var anonId = this.fetchExternalAnonymousId(source);
+          if (anonId) return anonId; // return anonymousId if present
+        }
+
+        return rlAnonymousId; // return undefined
       }
       /**
        * get stored initial referrer
@@ -11306,7 +11526,7 @@
     this.build = "1.0.0";
     this.name = "RudderLabs JavaScript SDK";
     this.namespace = "com.rudderlabs.javascript";
-    this.version = "2.3.8";
+    this.version = "2.4.0";
   });
 
   /* eslint-disable max-classes-per-file */
@@ -11315,7 +11535,7 @@
     _classCallCheck(this, RudderLibraryInfo);
 
     this.name = "RudderLabs JavaScript SDK";
-    this.version = "2.3.8";
+    this.version = "2.4.0";
   }); // Operating System information class
 
 
@@ -13594,7 +13814,7 @@
 
     _createClass(Analytics, [{
       key: "initializeUser",
-      value: function initializeUser() {
+      value: function initializeUser(anonymousIdOptions) {
         // save once for storing older values to encrypted
         this.userId = this.storage.getUserId() || "";
         this.storage.setUserId(this.userId);
@@ -13604,7 +13824,7 @@
         this.storage.setGroupId(this.groupId);
         this.groupTraits = this.storage.getGroupTraits() || {};
         this.storage.setGroupTraits(this.groupTraits);
-        this.anonymousId = this.getAnonymousId();
+        this.anonymousId = this.getAnonymousId(anonymousIdOptions);
         this.storage.setAnonymousId(this.anonymousId);
       }
     }, {
@@ -14282,9 +14502,9 @@
       }
     }, {
       key: "getAnonymousId",
-      value: function getAnonymousId() {
+      value: function getAnonymousId(anonymousIdOptions) {
         // if (!this.loaded) return;
-        this.anonymousId = this.storage.getAnonymousId();
+        this.anonymousId = this.storage.getAnonymousId(anonymousIdOptions);
 
         if (!this.anonymousId) {
           this.setAnonymousId();
@@ -14423,7 +14643,7 @@
         }
 
         this.eventRepository.initialize(writeKey, serverUrl, options);
-        this.initializeUser();
+        this.initializeUser(options ? options.anonymousIdOptions : undefined);
         this.setInitialPageProperties();
         this.loaded = true;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rudder-sdk-js",
-  "version": "2.3.8",
+  "version": "2.4.0",
   "description": "RudderStack Javascript SDK",
   "main": "index.js",
   "types": "index.d.ts",