saasco-sdk 0.1.4 → 0.1.6

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`
@@ -202,6 +201,7 @@ Any property that starts with `$` is a property that has been generated by the S
 | $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 most recent preferred language of the user.                                        |
 | $screenHeight           | Screen Height               | The most recent height of the device screen in pixels                                  |
 | $screenWidth            | Screen Width                | The most recent width of the device screen in pixels                                   |
 | $screenDpi              | Screen DPI                  | The most recent Pixel density of the device screen.                                    |
@@ -247,14 +247,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

@@ -523,8 +523,8 @@ class Saasco {
       this.log('Saasco is already initialized. Please check your code to ensure that init() is not being called multiple times.');
       return;
     }
-    this.initiAutoPageTracking();
     this.log('Saasco initialized', this.config);
+    this.initiAutoPageTracking();
     this.isInitialized = true;
   }
   debug(value) {
@@ -546,7 +546,10 @@ class Saasco {
     var _a;
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
-      if (!isBrowser) return;
+      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;
@@ -554,52 +557,38 @@ class Saasco {
     setSessionId();
     setAnonmousId();
     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;
+    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 = 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 $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 $href = isBrowser ? window.location.href : undefined;
+    const $pathname = isBrowser ? window.location.pathname : undefined;
+    const $referrer = isBrowser ? document.referrer : undefined;
+    const $screenDPI = isBrowser ? window.devicePixelRatio : 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 $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 $title = isBrowser ? document.title : undefined;
+    const $userAgent = isBrowser ? window.navigator.userAgent : 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': userAgent,
-        locale,
-        location,
-        title,
-        pathname,
-        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 || {}
       })
     };
@@ -640,7 +629,7 @@ class Saasco {
       projectId: this.config.projectId,
       distinctId,
       anonymousId,
-      version: '1',
+      version: '2',
       payload: properties || {},
       options: options || {}
     };

package/index.esm.js

@@ -519,8 +519,8 @@ class Saasco {
       this.log('Saasco is already initialized. Please check your code to ensure that init() is not being called multiple times.');
       return;
     }
-    this.initiAutoPageTracking();
     this.log('Saasco initialized', this.config);
+    this.initiAutoPageTracking();
     this.isInitialized = true;
   }
   debug(value) {
@@ -542,7 +542,10 @@ class Saasco {
     var _a;
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
-      if (!isBrowser) return;
+      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;
@@ -550,52 +553,38 @@ class Saasco {
     setSessionId();
     setAnonmousId();
     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;
+    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 = 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 $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 $href = isBrowser ? window.location.href : undefined;
+    const $pathname = isBrowser ? window.location.pathname : undefined;
+    const $referrer = isBrowser ? document.referrer : undefined;
+    const $screenDPI = isBrowser ? window.devicePixelRatio : 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 $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 $title = isBrowser ? document.title : undefined;
+    const $userAgent = isBrowser ? window.navigator.userAgent : 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': userAgent,
-        locale,
-        location,
-        title,
-        pathname,
-        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 || {}
       })
     };
@@ -636,7 +625,7 @@ class Saasco {
       projectId: this.config.projectId,
       distinctId,
       anonymousId,
-      version: '1',
+      version: '2',
       payload: properties || {},
       options: options || {}
     };

package/package.json

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