saasco-sdk 0.1.10 → 0.1.12

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.12";
 
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
@@ -547,21 +547,36 @@ class Saasco {
     this.config = config;
     this.lastPageViewHref = '';
     this.isInitialized = false;
+    if (!config.projectId) {
+      this.error("Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+      return;
+    }
     // default enabled to true
     this.config.enabled = this.config.enabled === undefined ? true : this.config.enabled;
   }
   init() {
+    if (!this.config.projectId) {
+      return this.error("Unable to initialize Saasco. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+    }
     if (this.isInitialized) {
       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.
@@ -575,6 +590,9 @@ class Saasco {
   track(name,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   properties, context) {
+    if (!this.config.projectId) {
+      return this.error("Unable to track event. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+    }
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
       if (!isBrowser) {
@@ -614,6 +632,9 @@ class Saasco {
     return this.track('Page View');
   }
   identify(distinctIdOrProperties, propertiesOrContext, contextOrNothing) {
+    if (!this.config.projectId) {
+      return this.error("Unable to identify user. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+    }
     const hasId = typeof distinctIdOrProperties === 'string' || typeof distinctIdOrProperties === 'number' || distinctIdOrProperties === null;
     const distinctId = hasId ? distinctIdOrProperties === null || distinctIdOrProperties === void 0 ? void 0 : distinctIdOrProperties.toString() : `soft_${uuid.v4()}`;
     const properties = hasId ? propertiesOrContext : distinctIdOrProperties;
@@ -690,6 +711,15 @@ class Saasco {
     // Message highlighted for easy finding
     ...args]);
   }
+  /**
+   * @param args Arguments to be logged
+   */
+  error(...args) {
+    const message = '◍ Saasco Error';
+    console.error(...[`\x1b[41m\x1b[37m ${message} \x1b[0m`,
+    // Message highlighted for easy finding
+    ...args]);
+  }
   /**
    * If autoPageTracking is enabled, this will automatically track page views
    * It listens to url changes to track new pages every time the url changes

package/index.esm.js

@@ -430,7 +430,7 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
-var version = "0.1.10";
+var version = "0.1.12";
 
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
@@ -543,21 +543,36 @@ class Saasco {
     this.config = config;
     this.lastPageViewHref = '';
     this.isInitialized = false;
+    if (!config.projectId) {
+      this.error("Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+      return;
+    }
     // default enabled to true
     this.config.enabled = this.config.enabled === undefined ? true : this.config.enabled;
   }
   init() {
+    if (!this.config.projectId) {
+      return this.error("Unable to initialize Saasco. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+    }
     if (this.isInitialized) {
       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.
@@ -571,6 +586,9 @@ class Saasco {
   track(name,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   properties, context) {
+    if (!this.config.projectId) {
+      return this.error("Unable to track event. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+    }
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
       if (!isBrowser) {
@@ -610,6 +628,9 @@ class Saasco {
     return this.track('Page View');
   }
   identify(distinctIdOrProperties, propertiesOrContext, contextOrNothing) {
+    if (!this.config.projectId) {
+      return this.error("Unable to identify user. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
+    }
     const hasId = typeof distinctIdOrProperties === 'string' || typeof distinctIdOrProperties === 'number' || distinctIdOrProperties === null;
     const distinctId = hasId ? distinctIdOrProperties === null || distinctIdOrProperties === void 0 ? void 0 : distinctIdOrProperties.toString() : `soft_${v4()}`;
     const properties = hasId ? propertiesOrContext : distinctIdOrProperties;
@@ -686,6 +707,15 @@ class Saasco {
     // Message highlighted for easy finding
     ...args]);
   }
+  /**
+   * @param args Arguments to be logged
+   */
+  error(...args) {
+    const message = '◍ Saasco Error';
+    console.error(...[`\x1b[41m\x1b[37m ${message} \x1b[0m`,
+    // Message highlighted for easy finding
+    ...args]);
+  }
   /**
    * If autoPageTracking is enabled, this will automatically track page views
    * It listens to url changes to track new pages every time the url changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "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.
@@ -36,14 +37,14 @@ export declare class Saasco {
      */
     track(name: string, properties?: Record<string, any>, context?: {
         active?: boolean;
-    }): Promise<string | Response | undefined> | undefined;
+    }): void | Promise<string | Response | undefined>;
     /**
      * The page method lets you record page views on your website
      * This records the page title and path and names the event useing the reserved property "Page Viewed"
      *
      * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
      */
-    page(): Promise<string | Response | undefined> | undefined;
+    page(): void | Promise<string | Response | undefined>;
     /**
      * The identify method lets you tie a user to their actions and record traits about them.
      * We recommend you call this when the user logs in and when any traits get updated.
@@ -70,6 +71,10 @@ export declare class Saasco {
      * @param args Arguments to be logged
      */
     private log;
+    /**
+     * @param args Arguments to be logged
+     */
+    private error;
     /**
      * If autoPageTracking is enabled, this will automatically track page views
      * It listens to url changes to track new pages every time the url changes