saasco-sdk 0.1.10 → 0.1.11

package/README.md

@@ -4,7 +4,7 @@
 
 - [Privacy](#privacy)
 - [Getting Started](#initiate-the-lib)
-- [Automatic Page View Tracking](#automatic-page-view-tracking)
+- [Init Automatic Page View Tracking](#init-automatic-page-view-tracking)
 - [Tracking Events](#tracking-events)
 - [Identifying Users](#identifying-users)
 - [Debugging and Dev](#debugging-and-dev)
@@ -27,22 +27,25 @@ Copy your Project ID from the project settings page in Saasco:
 Then import Saasco and initiate the lib with your Project ID.
 
 ```ts
-
 // lib/saasco.ts
 import { Saasco } from 'saasco-sdk';
 
-// Initiate the lib
-const saasco = new Saasco({ projectId: "YOUR-PROJECT-ID" });
-saasco.init();
-
-export saasco;
+export const saasco = new Saasco({ projectId: 'YOUR-PROJECT-ID' });
 ```
 
-## Automatic Page View Tracking
+## Init Automatic Page View Tracking
 
-When you initial the lib live above Saasco will automatically start tracking all page views in your app. There is no other configuration. It will automatically track url changes, even for SPAs like NextJs and Vue.
+When you initial the lib Saasco will automatically start tracking all page views in your app. There is no other configuration. It will automatically track url changes, even for SPAs like NextJs and Vue.
 You can also [manually track pages](https://www.notion.so/Manual-Page-Tracking-in-SPAs-2442fc7586dc4208ae8f669eb7561b1a?pvs=21) by opting our of automatic page tracking. For most use cases you don't need to do this.
 
+```ts
+// ./app/index
+import saasco from './lib/saasco';
+
+// This should be called once in your app and will start auto page tracking if you have it enabled.
+saasco.init();
+```
+
 ## Tracking Events
 
 With events you can track custom actions users are taking on your site with event properties.

package/index.cjs.js

@@ -434,7 +434,7 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
-var version = "0.1.10";
+var version = "0.1.11";
 
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
@@ -555,13 +555,21 @@ class Saasco {
       this.log('Saasco is already initialized. Please check your code to ensure that init() is not being called multiple times.');
       return;
     }
+    // Export Saasco to the window object for easy access and debugging
+    if (isBrowser) {
+      window.saasco = this;
+    }
     this.log('Saasco initialized', this.config);
     this.initiAutoPageTracking();
     this.isInitialized = true;
   }
-  debug(value) {
-    this.config.debug = value;
-    this.log(`Debug mode ${value ? 'activated' : 'deactivated'}.`);
+  disableDebug() {
+    this.log('Debug mode deactivated.');
+    this.config.debug = false;
+  }
+  enableDebug() {
+    this.config.debug = true;
+    this.log('Debug mode activated.');
   }
   /**
    * The track method lets you record the actions your users perform.

package/index.esm.js

@@ -430,7 +430,7 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
-var version = "0.1.10";
+var version = "0.1.11";
 
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
@@ -551,13 +551,21 @@ class Saasco {
       this.log('Saasco is already initialized. Please check your code to ensure that init() is not being called multiple times.');
       return;
     }
+    // Export Saasco to the window object for easy access and debugging
+    if (isBrowser) {
+      window.saasco = this;
+    }
     this.log('Saasco initialized', this.config);
     this.initiAutoPageTracking();
     this.isInitialized = true;
   }
-  debug(value) {
-    this.config.debug = value;
-    this.log(`Debug mode ${value ? 'activated' : 'deactivated'}.`);
+  disableDebug() {
+    this.log('Debug mode deactivated.');
+    this.config.debug = false;
+  }
+  enableDebug() {
+    this.config.debug = true;
+    this.log('Debug mode activated.');
   }
   /**
    * The track method lets you record the actions your users perform.

package/package.json

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

package/src/lib/analytics.d.ts

@@ -24,7 +24,8 @@ export declare class Saasco {
         debug?: boolean;
     });
     init(): void;
-    debug(value: boolean): void;
+    disableDebug(): void;
+    enableDebug(): void;
     /**
      * The track method lets you record the actions your users perform.
      * Its good to keep a conistent naming convention for your events.