@usermaven/sdk-js 1.0.2 → 1.0.5

package/README.md

@@ -5,6 +5,7 @@ Usermaven.js is a JavaScript SDK for [Usermaven](https://usermaven.com).
 ## Capabilities
 
 - Session Capability via `persistence` and `persistence_name` options.
+- Cross sub-domain compatibility added 
 
 ## Maintainers Guide
 
@@ -31,6 +32,20 @@ npmjs account beforehand (make sure you have access to Usermaven team)
     * `npm link @usermaven/sdk-js` --- use npm package locally whose symlink is just published
     * `npm start` --- start the application and monitor events
 
+### Checking Cross Domain Session locally
+Setup a custom domain and sub-domain locally to test cross domain session persistence.
+
+```bash
+sudo nano /etc/hosts
+```
+Add the following lines in the hosts file
+```bash
+127.0.0.1       localhost.com
+127.0.0.1       app.localhost.com
+```
+
+You will be able to access the domains at [localhost domain](http://localhost.com:8081/test-case/embed.html) and [localhost sub-domain](http://app.localhost.com:8081/test-case/embed.html)
+
 ### Publishing new version
 
  * Login with your *personal* credentials with `npm login`

package/dist/npm/usermaven.cjs.js

@@ -38,8 +38,41 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
+// Courtesy: https://stackoverflow.com/a/23945027
+function extractHostname(url) {
+    var hostname;
+    //find & remove protocol (http, ftp, etc.) and get hostname
+    if (url.indexOf("//") > -1) {
+        hostname = url.split('/')[2];
+    }
+    else {
+        hostname = url.split('/')[0];
+    }
+    //find & remove port number
+    hostname = hostname.split(':')[0];
+    //find & remove "?"
+    hostname = hostname.split('?')[0];
+    return hostname;
+}
+// Warning: you can use this function to extract the "root" domain, but it will not be as accurate as using the psl package. 
+// https://www.npmjs.com/package/psl
+var extractRootDomain = function (url) {
+    var domain = extractHostname(url), splitArr = domain.split('.'), arrLen = splitArr.length;
+    //extracting the root domain here
+    //if there is a subdomain
+    if (arrLen > 2) {
+        domain = splitArr[arrLen - 2] + '.' + splitArr[arrLen - 1];
+        //check to see if it's using a Country Code Top Level Domain (ccTLD) (i.e. ".me.uk")
+        if (splitArr[arrLen - 2].length == 2 && splitArr[arrLen - 1].length == 2) {
+            //this is using a ccTLD
+            domain = splitArr[arrLen - 3] + '.' + domain;
+        }
+    }
+    return domain;
+};
 var getCookieDomain = function () {
-    return location.hostname.replace('www.', '');
+    return ".".concat(extractRootDomain(location.hostname)); // .localhost
+    // return location.hostname.replace('www.', '');
 };
 var cookieParsingCache;
 var getCookies = function (useCache) {
@@ -1719,8 +1752,8 @@ class SessionIdManager {
 
 var VERSION_INFO = {
     env: 'production',
-    date: '2022-01-29T08:33:18.619Z',
-    version: '1.0.2'
+    date: '2022-03-29T11:24:13.204Z',
+    version: '1.0.5'
 };
 var USERMAVEN_VERSION = "".concat(VERSION_INFO.version, "/").concat(VERSION_INFO.env, "@").concat(VERSION_INFO.date);
 var beaconTransport = function (url, json) {
@@ -1898,14 +1931,14 @@ var UsermavenClientImpl = /** @class */ (function () {
     UsermavenClientImpl.prototype.getCtx = function () {
         var now = new Date();
         var _a = this.sessionManager.getSessionAndWindowId(), sessionId = _a.sessionId, windowId = _a.windowId;
-        // extract account details from identity payload
+        // extract company details from identity payload
         var user = __assign({ anonymous_id: this.anonymousId }, this.userProperties);
-        var account = user['account'] || {};
-        delete user['account'];
+        var company = user['company'] || {};
+        delete user['company'];
         var payload = __assign({ event_id: '', session_id: sessionId, window_id: windowId, user: user, ids: this._getIds(), user_agent: navigator.userAgent, utc_time: reformatDate(now.toISOString()), local_tz_offset: now.getTimezoneOffset(), referer: document.referrer, url: window.location.href, page_title: document.title, doc_path: document.location.pathname, doc_host: document.location.hostname, doc_search: window.location.search, screen_resolution: screen.width + 'x' + screen.height, vp_size: Math.max(document.documentElement.clientWidth || 0, window.innerWidth || 0) + 'x' + Math.max(document.documentElement.clientHeight || 0, window.innerHeight || 0), user_language: navigator.language, doc_encoding: document.characterSet }, getDataFromParams(parseQuery()));
         // id and name attributes will be checked on backend
-        if (Object.keys(account).length) {
-            payload['account'] = account;
+        if (Object.keys(company).length) {
+            payload['company'] = company;
         }
         return payload;
     };
@@ -2090,10 +2123,13 @@ var UsermavenClientImpl = /** @class */ (function () {
      * @param options
      */
     UsermavenClientImpl.prototype.manageSession = function (options) {
+        options = options || {};
         getLogger().debug('Options', options);
+        // cross_subdomain_cookie: whether to keep cookie across domains and subdomains
         var defaultConfig = {
-            persistence: options ? options.persistence || 'cookie' : 'cookie',
-            persistence_name: options ? options.persistence_name || 'session' : 'session',
+            persistence: options.persistence || 'cookie',
+            persistence_name: options.persistence_name || 'session',
+            cross_subdomain_cookie: options.cross_subdomain_cookie || true
         };
         // TODO: Default session name would be session_
         this.config = _.extend(defaultConfig, this.config || {}, {

package/dist/npm/usermaven.d.ts

@@ -27,7 +27,7 @@ export type UsermavenClient = {
   rawTrack: (payload: any) => void
 
   /**
-   * Sets a user data including organization/account data
+   * Sets a user data including organization/company data
    * @param userData user data (as map id_type --> value, such as "email": "a@bcd.com"
    * @param doNotSendEvent if true (false by default), separate "id" event won't be sent to server
    * @return Promise, see _send3p documentation
@@ -198,15 +198,28 @@ export type UsermavenOptions = {
    */
    persistence_name?: string;
 
+  /**
+   * Persistent connection version
+   */
+  project_id?: string;
+
+  /**
+   * Enable cookie across subdomain
+   * Default value: true
+   */
+  cross_subdomain_cookie?: boolean;
+
   //NOTE: If any property is added here, please make sure it's added to browser.ts usermavenProps as well
+  
 };
 
 /**
- * Account Attributes
+ * Company Attributes
  */
-export interface AccountProps {
-  id: string; // Account ID
-  name: string; // Account Name
+export interface CompanyProps {
+  id: string; // Company ID
+  name: string; // Company Name
+  created_at: string; // Company creation date
   custom: any; // Optional attributes such as industry, website, employee count etc.
 }
 
@@ -218,7 +231,7 @@ export interface UserProps {
   id?: string                       //user id (non anonymous). If not set, first known id (from propName below) will be used
   email?: string                    //user id (non anonymous). If not set, first known id (from propName below) will be used
   [propName: string]: any           //any other forms of ids
-  account?: AccountProps
+  company?: CompanyProps
 }
 
 /**
@@ -247,7 +260,7 @@ export type Conversion = {
 export type EventCtx = {
   event_id: string                 //unique event id or empty string for generating id on the backend side
   user: UserProps                  //user properties
-  account?: AccountProps           //account properties
+  company?: CompanyProps           //company properties
   ids?: ThirdpartyIds              //user ids from external systems
   user_agent: string               //user
   utc_time: string                 //current UTC time in ISO 8601

package/dist/npm/usermaven.es.js

@@ -34,8 +34,41 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
+// Courtesy: https://stackoverflow.com/a/23945027
+function extractHostname(url) {
+    var hostname;
+    //find & remove protocol (http, ftp, etc.) and get hostname
+    if (url.indexOf("//") > -1) {
+        hostname = url.split('/')[2];
+    }
+    else {
+        hostname = url.split('/')[0];
+    }
+    //find & remove port number
+    hostname = hostname.split(':')[0];
+    //find & remove "?"
+    hostname = hostname.split('?')[0];
+    return hostname;
+}
+// Warning: you can use this function to extract the "root" domain, but it will not be as accurate as using the psl package. 
+// https://www.npmjs.com/package/psl
+var extractRootDomain = function (url) {
+    var domain = extractHostname(url), splitArr = domain.split('.'), arrLen = splitArr.length;
+    //extracting the root domain here
+    //if there is a subdomain
+    if (arrLen > 2) {
+        domain = splitArr[arrLen - 2] + '.' + splitArr[arrLen - 1];
+        //check to see if it's using a Country Code Top Level Domain (ccTLD) (i.e. ".me.uk")
+        if (splitArr[arrLen - 2].length == 2 && splitArr[arrLen - 1].length == 2) {
+            //this is using a ccTLD
+            domain = splitArr[arrLen - 3] + '.' + domain;
+        }
+    }
+    return domain;
+};
 var getCookieDomain = function () {
-    return location.hostname.replace('www.', '');
+    return ".".concat(extractRootDomain(location.hostname)); // .localhost
+    // return location.hostname.replace('www.', '');
 };
 var cookieParsingCache;
 var getCookies = function (useCache) {
@@ -1715,8 +1748,8 @@ class SessionIdManager {
 
 var VERSION_INFO = {
     env: 'production',
-    date: '2022-01-29T08:33:18.619Z',
-    version: '1.0.2'
+    date: '2022-03-29T11:24:13.204Z',
+    version: '1.0.5'
 };
 var USERMAVEN_VERSION = "".concat(VERSION_INFO.version, "/").concat(VERSION_INFO.env, "@").concat(VERSION_INFO.date);
 var beaconTransport = function (url, json) {
@@ -1894,14 +1927,14 @@ var UsermavenClientImpl = /** @class */ (function () {
     UsermavenClientImpl.prototype.getCtx = function () {
         var now = new Date();
         var _a = this.sessionManager.getSessionAndWindowId(), sessionId = _a.sessionId, windowId = _a.windowId;
-        // extract account details from identity payload
+        // extract company details from identity payload
         var user = __assign({ anonymous_id: this.anonymousId }, this.userProperties);
-        var account = user['account'] || {};
-        delete user['account'];
+        var company = user['company'] || {};
+        delete user['company'];
         var payload = __assign({ event_id: '', session_id: sessionId, window_id: windowId, user: user, ids: this._getIds(), user_agent: navigator.userAgent, utc_time: reformatDate(now.toISOString()), local_tz_offset: now.getTimezoneOffset(), referer: document.referrer, url: window.location.href, page_title: document.title, doc_path: document.location.pathname, doc_host: document.location.hostname, doc_search: window.location.search, screen_resolution: screen.width + 'x' + screen.height, vp_size: Math.max(document.documentElement.clientWidth || 0, window.innerWidth || 0) + 'x' + Math.max(document.documentElement.clientHeight || 0, window.innerHeight || 0), user_language: navigator.language, doc_encoding: document.characterSet }, getDataFromParams(parseQuery()));
         // id and name attributes will be checked on backend
-        if (Object.keys(account).length) {
-            payload['account'] = account;
+        if (Object.keys(company).length) {
+            payload['company'] = company;
         }
         return payload;
     };
@@ -2086,10 +2119,13 @@ var UsermavenClientImpl = /** @class */ (function () {
      * @param options
      */
     UsermavenClientImpl.prototype.manageSession = function (options) {
+        options = options || {};
         getLogger().debug('Options', options);
+        // cross_subdomain_cookie: whether to keep cookie across domains and subdomains
         var defaultConfig = {
-            persistence: options ? options.persistence || 'cookie' : 'cookie',
-            persistence_name: options ? options.persistence_name || 'session' : 'session',
+            persistence: options.persistence || 'cookie',
+            persistence_name: options.persistence_name || 'session',
+            cross_subdomain_cookie: options.cross_subdomain_cookie || true
         };
         // TODO: Default session name would be session_
         this.config = _.extend(defaultConfig, this.config || {}, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usermaven/sdk-js",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "Usermaven JavaScript SDK.",
   "main": "dist/npm/usermaven.cjs.js",
   "module": "dist/npm/dist/usermaven.esm.js",