saasco-sdk 0.1.3 → 0.1.5

package/README.md

@@ -4,7 +4,6 @@
 
 - [Privacy](#privacy)
 - [Getting Started](#initiate-the-lib)
-- [Naming Conflict](#naming-conflict)
 - [Automatic Page View Tracking](#automatic-page-view-tracking)
 - [Tracking Events](#tracking-events)
 - [Identifying Users](#identifying-users)
@@ -17,7 +16,7 @@
 
 By default Saasco is privacy friendly, using no cookies and obscuring all activity behind Anonymous IDs. However if you want to power more complex user tracking you can identify users and then all events they do will be attributed to them in your CRM. This can assist with customer support but also for things like drip campaigns and other marketing activities.
 
-## Getting Started:
+## Getting Started
 
 Install by running:
 `npm install saasco-sdk`
@@ -247,14 +246,18 @@ Our SDKs automatically collect certain properties on every event or user profile
 | $latitude        | Latitude                    | Latitude of the user's IP location.                                              |
 | $longitude       | Longitude                   | Longitude of the user's IP location.                                             |
 | $timezone        | Timezone                    | Timezone of the user parsed from the IP.                                         |
+| $locale          | Locale                      | The preferred language of the user.                                              |
+| $pathname        | Pathname                    | The path of the page on which the event was tracked.                             |
+| $title           | Page Title                  | The title of the page on which the event was tracked.                            |
+| $userAgent       | User Agent                  | The user agent string of the browser.                                            |
 | $screenHeight    | Screen Height               | The height of the device screen in pixels                                        |
 | $screenWidth     | Screen Width                | The width of the device screen in pixels                                         |
 | $screenDpi       | Screen DPI                  | Pixel density of the device screen.                                              |
 | $currentUrl      | Current URL                 | The URL of the page on which the event was tracked.                              |
 | $os              | Operating System            | The most recent OS of the user.                                                  |
 | $browser         | Browser                     | The most recent browser of the user.                                             |
-| $browserVersion  | Browser Version             | The most recent bowser version of the user.                                      |
-| $device          | Device Type                 | The most recent bowser version of the user. eg `Mobile`, `Tablet`, `Desktop`     |
+| $browserVersion  | Browser Version             | The most recent browser version of the user.                                     |
+| $device          | Device Type                 | The most recent device type of the user. eg `Mobile`, `Tablet`, `Desktop`        |
 | $referrer        | Last Touch Referrer         | Referring URL when the user last interacted with your site. Defaults to "direct" |
 | $referringDomain | Last Touch Referring Domain | Referring domain at the user's last interaction. Defaults to "direct"            |
 | $utmSource       | UTM Source                  | The UTM source tag from the URL a customer clicked to arrive at your domain.     |

package/index.cjs.js

@@ -434,19 +434,37 @@ const timezones = {
 };
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
+const isBrowser = typeof window !== 'undefined';
 let userId = null;
 const PREF = 'saasco-sdk';
+const data = {};
 function storeData(key, value, ttl) {
-  const fullKey = `${PREF}-${key}`;
-  if (value === undefined) return window.localStorage.removeItem(fullKey);
-  const now = new Date();
   const item = {
     value,
-    expiry: now.getTime() + ttl
+    expiry: new Date().getTime() + ttl
   };
+  if (!isBrowser) {
+    if (value === undefined) {
+      delete data[key];
+      return;
+    }
+    data[key] = item;
+    return;
+  }
+  const fullKey = `${PREF}-${key}`;
+  if (value === undefined) return window.localStorage.removeItem(fullKey);
   localStorage.setItem(fullKey, JSON.stringify(item));
 }
 function retrieveData(key) {
+  if (!isBrowser) {
+    const item = data[key];
+    if (!item) return null;
+    if (Date.now() > item.expiry) {
+      delete data[key];
+      return null;
+    }
+    return item.value;
+  }
   const fullKey = `${PREF}-${key}`;
   const itemStr = localStorage.getItem(fullKey);
   if (!itemStr) {
@@ -528,55 +546,49 @@ class Saasco {
     var _a;
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
+      if (!isBrowser) {
+        console.warn('Saasco page tracking is only available in the browser');
+        return;
+      }
       const pageViewHref = window.location.href;
       if (pageViewHref === this.lastPageViewHref) return;
       this.lastPageViewHref = pageViewHref;
     }
     setSessionId();
     setAnonmousId();
-    const customNavigator = navigator;
-    const locale = customNavigator.languages && customNavigator.languages.length ? customNavigator.languages[0] : customNavigator.userLanguage || customNavigator.language || customNavigator.browserLanguage || 'en';
+    const customNavigator = isBrowser ? navigator : undefined;
+    const $locale = isBrowser ? (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages) && (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages.length) ? customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages[0] : (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.userLanguage) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.language) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.browserLanguage) || 'en' : undefined;
     // https://caniuse.com/?search=Intl.DateTimeFormat().resolvedOptions().timeZone
     // Only has 96.63% global support, so we need to check for undefined
     const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-    const location = timezones[timezone] || ((_a = locale === null || locale === void 0 ? void 0 : locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined';
-    const $screenHeight = screen.height;
-    const $screenWidth = screen.width;
-    const $screenDPI = window.devicePixelRatio;
-    const $referrer = document.referrer;
-    const $utm_source = this.getSearchParam('utm_source');
-    const $utm_medium = this.getSearchParam('utm_medium');
-    const $utm_campaign = this.getSearchParam('utm_campaign');
-    const $utm_content = this.getSearchParam('utm_content');
-    const $utm_term = this.getSearchParam('utm_term');
-    const $gclid = this.getSearchParam('gclid');
-    const $fbclid = this.getSearchParam('fbclid');
+    const $location = isBrowser ? timezones[timezone] || ((_a = $locale === null || $locale === void 0 ? void 0 : $locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined' : undefined;
+    const $userAgent = isBrowser ? window.navigator.userAgent : undefined;
+    const $title = isBrowser ? document.title : undefined;
+    const $pathname = isBrowser ? window.location.pathname : undefined;
+    const $href = isBrowser ? window.location.href : undefined;
+    const $screenHeight = isBrowser ? screen.height : undefined;
+    const $screenWidth = isBrowser ? screen.width : undefined;
+    const $screenDPI = isBrowser ? window.devicePixelRatio : undefined;
+    const $referrer = isBrowser ? document.referrer : undefined;
     const data = {
       id: uuid.v4(),
       timestamp: new Date().toISOString(),
       action: name,
-      version: '1',
+      version: '2',
       sessionId: getSessionId(),
       anonymousId: getAnonymousId(),
       projectId: this.config.projectId,
       payload: JSON.stringify({
-        'user-agent': window.navigator.userAgent,
-        locale,
-        location,
-        title: document.title,
-        pathname: window.location.pathname,
-        href: window.location.href,
+        $href,
+        $locale,
+        $location,
+        $pathname,
+        $referrer,
+        $screenDPI,
         $screenHeight,
         $screenWidth,
-        $screenDPI,
-        $referrer,
-        $utm_source,
-        $utm_medium,
-        $utm_campaign,
-        $utm_content,
-        $utm_term,
-        $gclid,
-        $fbclid,
+        $title,
+        $userAgent,
         properties: properties || {}
       })
     };
@@ -617,7 +629,7 @@ class Saasco {
       projectId: this.config.projectId,
       distinctId,
       anonymousId,
-      version: '1',
+      version: '2',
       payload: properties || {},
       options: options || {}
     };
@@ -662,6 +674,7 @@ class Saasco {
     ...args]);
   }
   getSearchParam(param) {
+    if (typeof window === 'undefined') return undefined;
     return new URLSearchParams(window.location.search).get(param);
   }
   /**
@@ -674,7 +687,7 @@ class Saasco {
     // Will run if undefined or true
     if (this.config.autoPageTracking === false) return;
     // Prevent running on the server
-    if (typeof window === 'undefined') return;
+    if (!isBrowser) return console.warn('Saasco auto page tracking is only available in the browser');
     // Prevent intitializing auto page tracking more than once
     if (window.saascoAutoPageTrackingActive) {
       this.log('Auto Page Tracking already enabled');

package/index.esm.js

@@ -430,19 +430,37 @@ const timezones = {
 };
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
+const isBrowser = typeof window !== 'undefined';
 let userId = null;
 const PREF = 'saasco-sdk';
+const data = {};
 function storeData(key, value, ttl) {
-  const fullKey = `${PREF}-${key}`;
-  if (value === undefined) return window.localStorage.removeItem(fullKey);
-  const now = new Date();
   const item = {
     value,
-    expiry: now.getTime() + ttl
+    expiry: new Date().getTime() + ttl
   };
+  if (!isBrowser) {
+    if (value === undefined) {
+      delete data[key];
+      return;
+    }
+    data[key] = item;
+    return;
+  }
+  const fullKey = `${PREF}-${key}`;
+  if (value === undefined) return window.localStorage.removeItem(fullKey);
   localStorage.setItem(fullKey, JSON.stringify(item));
 }
 function retrieveData(key) {
+  if (!isBrowser) {
+    const item = data[key];
+    if (!item) return null;
+    if (Date.now() > item.expiry) {
+      delete data[key];
+      return null;
+    }
+    return item.value;
+  }
   const fullKey = `${PREF}-${key}`;
   const itemStr = localStorage.getItem(fullKey);
   if (!itemStr) {
@@ -524,55 +542,49 @@ class Saasco {
     var _a;
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
+      if (!isBrowser) {
+        console.warn('Saasco page tracking is only available in the browser');
+        return;
+      }
       const pageViewHref = window.location.href;
       if (pageViewHref === this.lastPageViewHref) return;
       this.lastPageViewHref = pageViewHref;
     }
     setSessionId();
     setAnonmousId();
-    const customNavigator = navigator;
-    const locale = customNavigator.languages && customNavigator.languages.length ? customNavigator.languages[0] : customNavigator.userLanguage || customNavigator.language || customNavigator.browserLanguage || 'en';
+    const customNavigator = isBrowser ? navigator : undefined;
+    const $locale = isBrowser ? (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages) && (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages.length) ? customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages[0] : (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.userLanguage) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.language) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.browserLanguage) || 'en' : undefined;
     // https://caniuse.com/?search=Intl.DateTimeFormat().resolvedOptions().timeZone
     // Only has 96.63% global support, so we need to check for undefined
     const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-    const location = timezones[timezone] || ((_a = locale === null || locale === void 0 ? void 0 : locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined';
-    const $screenHeight = screen.height;
-    const $screenWidth = screen.width;
-    const $screenDPI = window.devicePixelRatio;
-    const $referrer = document.referrer;
-    const $utm_source = this.getSearchParam('utm_source');
-    const $utm_medium = this.getSearchParam('utm_medium');
-    const $utm_campaign = this.getSearchParam('utm_campaign');
-    const $utm_content = this.getSearchParam('utm_content');
-    const $utm_term = this.getSearchParam('utm_term');
-    const $gclid = this.getSearchParam('gclid');
-    const $fbclid = this.getSearchParam('fbclid');
+    const $location = isBrowser ? timezones[timezone] || ((_a = $locale === null || $locale === void 0 ? void 0 : $locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined' : undefined;
+    const $userAgent = isBrowser ? window.navigator.userAgent : undefined;
+    const $title = isBrowser ? document.title : undefined;
+    const $pathname = isBrowser ? window.location.pathname : undefined;
+    const $href = isBrowser ? window.location.href : undefined;
+    const $screenHeight = isBrowser ? screen.height : undefined;
+    const $screenWidth = isBrowser ? screen.width : undefined;
+    const $screenDPI = isBrowser ? window.devicePixelRatio : undefined;
+    const $referrer = isBrowser ? document.referrer : undefined;
     const data = {
       id: v4(),
       timestamp: new Date().toISOString(),
       action: name,
-      version: '1',
+      version: '2',
       sessionId: getSessionId(),
       anonymousId: getAnonymousId(),
       projectId: this.config.projectId,
       payload: JSON.stringify({
-        'user-agent': window.navigator.userAgent,
-        locale,
-        location,
-        title: document.title,
-        pathname: window.location.pathname,
-        href: window.location.href,
+        $href,
+        $locale,
+        $location,
+        $pathname,
+        $referrer,
+        $screenDPI,
         $screenHeight,
         $screenWidth,
-        $screenDPI,
-        $referrer,
-        $utm_source,
-        $utm_medium,
-        $utm_campaign,
-        $utm_content,
-        $utm_term,
-        $gclid,
-        $fbclid,
+        $title,
+        $userAgent,
         properties: properties || {}
       })
     };
@@ -613,7 +625,7 @@ class Saasco {
       projectId: this.config.projectId,
       distinctId,
       anonymousId,
-      version: '1',
+      version: '2',
       payload: properties || {},
       options: options || {}
     };
@@ -658,6 +670,7 @@ class Saasco {
     ...args]);
   }
   getSearchParam(param) {
+    if (typeof window === 'undefined') return undefined;
     return new URLSearchParams(window.location.search).get(param);
   }
   /**
@@ -670,7 +683,7 @@ class Saasco {
     // Will run if undefined or true
     if (this.config.autoPageTracking === false) return;
     // Prevent running on the server
-    if (typeof window === 'undefined') return;
+    if (!isBrowser) return console.warn('Saasco auto page tracking is only available in the browser');
     // Prevent intitializing auto page tracking more than once
     if (window.saascoAutoPageTrackingActive) {
       this.log('Auto Page Tracking already enabled');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "dependencies": {
     "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",