saasco-sdk 0.1.15 → 0.1.16

package/README.md

@@ -35,22 +35,23 @@ export const saasco = new Saasco({ projectId: 'YOUR-PROJECT-ID' });
 
 ## Automatic Page View Tracking
 
-When you initiate the lib Saasco will automatically start tracking all page views in your app. By default, it tracks all URL changes, including query parameters and hash changes. You can customize this behavior using the configuration options:
-
-- `autoPageTracking` (default: `true`): When set to `false`, will not automatically track any `Page View` events.
-- `trackUrlParams` (default: `true`): When set to `false`, changes to URL query parameters won't trigger a new page view
-- `trackHashChanges` (default: `true`): When set to `false`, changes to URL hash won't trigger a new page view
-
-You can also [manually track pages](https://www.notion.so/Manual-Page-Tracking-in-SPAs-2442fc7586dc4208ae8f669eb7561b1a?pvs=21) by opting out of automatic page tracking. For most use cases you don't need to do this.
-
-```ts
-// ./app/index
-import saasco from './lib/saasco';
+When you initiate the lib Saasco will automatically start tracking all page views in your app. By default, it tracks all URL changes, including query parameters and hash changes. You can customize this behavior using the `autoPageTracking` configuration object:
+
+```typescript
+const analytics = new Saasco({
+  projectId: 'your-project-id',
+  autoPageTracking: {
+    enabled: true, // Set to false to disable automatic page tracking
+    trackQueryParams: true, // Set to false to ignore URL query parameter changes
+    trackHash: true, // Set to false to ignore URL hash changes
+  },
+});
 
-// This should be called once in your app and will start auto page tracking if you have it enabled.
-saasco.init();
+analytics.init();
 ```
 
+You can also [manually track pages](https://www.notion.so/Manual-Page-Tracking-in-SPAs-2442fc7586dc4208ae8f669eb7561b1a?pvs=21) by disabling automatic page tracking (`enabled: false`). For most use cases you don't need to do this.
+
 ## Tracking Events
 
 With events you can track custom actions users are taking on your site with event properties.

package/index.cjs.js

@@ -6,7 +6,7 @@ var tslib = require('tslib');
 var uuid = require('@lukeed/uuid');
 var zod = require('zod');
 
-var version = "0.1.15";
+var version = "0.1.16";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -562,9 +562,12 @@ class Saasco {
     }
     // default enabled to true
     this.config.enabled = this.config.enabled === undefined ? true : this.config.enabled;
-    // default URL tracking options
-    this.config.trackUrlParams = this.config.trackUrlParams === undefined ? true : this.config.trackUrlParams;
-    this.config.trackHashChanges = this.config.trackHashChanges === undefined ? true : this.config.trackHashChanges;
+    // Set default auto page tracking config
+    this.config.autoPageTracking = Object.assign({
+      enabled: true,
+      trackQueryParams: true,
+      trackHash: true
+    }, this.config.autoPageTracking);
   }
   init() {
     if (this.isInitialized) {
@@ -628,6 +631,7 @@ class Saasco {
    * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
    */
   page() {
+    var _a, _b;
     if (!isBrowser) {
       console.warn('Saasco page tracking is only available in the browser');
       return;
@@ -635,11 +639,11 @@ class Saasco {
     const url = new URL(window.location.href);
     let pathToCompare = url.pathname;
     // Include search params if configured
-    if (this.config.trackUrlParams) {
+    if ((_a = this.config.autoPageTracking) === null || _a === void 0 ? void 0 : _a.trackQueryParams) {
       pathToCompare += url.search;
     }
     // Include hash if configured
-    if (this.config.trackHashChanges) {
+    if ((_b = this.config.autoPageTracking) === null || _b === void 0 ? void 0 : _b.trackHash) {
       pathToCompare += url.hash;
     }
     // Only track if the path has changed
@@ -742,9 +746,9 @@ class Saasco {
    * @returns
    */
   initiAutoPageTracking() {
+    var _a, _b;
     // Disable auto page tracking if the config is set to false
-    // Will run if undefined or true
-    if (this.config.autoPageTracking === false) return;
+    if (!((_a = this.config.autoPageTracking) === null || _a === void 0 ? void 0 : _a.enabled)) return;
     // Prevent running on the server
     if (!isBrowser) return console.warn('Saasco auto page tracking is only available in the browser');
     // Prevent intitializing auto page tracking more than once
@@ -756,8 +760,10 @@ class Saasco {
     this.log('Auto Page Tracking enabled');
     // Track initial page load
     this.page();
-    // Listen for hash changes
-    window.addEventListener('hashchange', () => this.page());
+    // Listen for hash changes if hash tracking is enabled
+    if ((_b = this.config.autoPageTracking) === null || _b === void 0 ? void 0 : _b.trackHash) {
+      window.addEventListener('hashchange', () => this.page());
+    }
     // Listen to popstate for back and forward navigation
     window.addEventListener('popstate', () => this.page());
     // Wrap history push state to listen for URL changes

package/index.esm.js

@@ -2,7 +2,7 @@ import { __awaiter } from 'tslib';
 import { v4 } from '@lukeed/uuid';
 import { z } from 'zod';
 
-var version = "0.1.15";
+var version = "0.1.16";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -558,9 +558,12 @@ class Saasco {
     }
     // default enabled to true
     this.config.enabled = this.config.enabled === undefined ? true : this.config.enabled;
-    // default URL tracking options
-    this.config.trackUrlParams = this.config.trackUrlParams === undefined ? true : this.config.trackUrlParams;
-    this.config.trackHashChanges = this.config.trackHashChanges === undefined ? true : this.config.trackHashChanges;
+    // Set default auto page tracking config
+    this.config.autoPageTracking = Object.assign({
+      enabled: true,
+      trackQueryParams: true,
+      trackHash: true
+    }, this.config.autoPageTracking);
   }
   init() {
     if (this.isInitialized) {
@@ -624,6 +627,7 @@ class Saasco {
    * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
    */
   page() {
+    var _a, _b;
     if (!isBrowser) {
       console.warn('Saasco page tracking is only available in the browser');
       return;
@@ -631,11 +635,11 @@ class Saasco {
     const url = new URL(window.location.href);
     let pathToCompare = url.pathname;
     // Include search params if configured
-    if (this.config.trackUrlParams) {
+    if ((_a = this.config.autoPageTracking) === null || _a === void 0 ? void 0 : _a.trackQueryParams) {
       pathToCompare += url.search;
     }
     // Include hash if configured
-    if (this.config.trackHashChanges) {
+    if ((_b = this.config.autoPageTracking) === null || _b === void 0 ? void 0 : _b.trackHash) {
       pathToCompare += url.hash;
     }
     // Only track if the path has changed
@@ -738,9 +742,9 @@ class Saasco {
    * @returns
    */
   initiAutoPageTracking() {
+    var _a, _b;
     // Disable auto page tracking if the config is set to false
-    // Will run if undefined or true
-    if (this.config.autoPageTracking === false) return;
+    if (!((_a = this.config.autoPageTracking) === null || _a === void 0 ? void 0 : _a.enabled)) return;
     // Prevent running on the server
     if (!isBrowser) return console.warn('Saasco auto page tracking is only available in the browser');
     // Prevent intitializing auto page tracking more than once
@@ -752,8 +756,10 @@ class Saasco {
     this.log('Auto Page Tracking enabled');
     // Track initial page load
     this.page();
-    // Listen for hash changes
-    window.addEventListener('hashchange', () => this.page());
+    // Listen for hash changes if hash tracking is enabled
+    if ((_b = this.config.autoPageTracking) === null || _b === void 0 ? void 0 : _b.trackHash) {
+      window.addEventListener('hashchange', () => this.page());
+    }
     // Listen to popstate for back and forward navigation
     window.addEventListener('popstate', () => this.page());
     // Wrap history push state to listen for URL changes

package/package.json

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

package/src/lib/analytics.d.ts

@@ -22,11 +22,13 @@ export declare class Saasco {
     constructor(config: {
         projectId: string;
         proxy?: string;
-        autoPageTracking?: boolean;
+        autoPageTracking?: {
+            enabled: boolean;
+            trackQueryParams?: boolean;
+            trackHash?: boolean;
+        };
         enabled?: boolean;
         debug?: boolean;
-        trackUrlParams?: boolean;
-        trackHashChanges?: boolean;
     });
     init(): void;
     disableDebug(): void;