saasco-sdk 0.1.16 → 0.1.18

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.16";
+var version = "0.1.18";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -603,7 +603,8 @@ class Saasco {
   // 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.");
+      const response = 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.");
+      return Promise.resolve(response);
     }
     setSessionId();
     setAnonmousId();
@@ -653,7 +654,8 @@ class Saasco {
   }
   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 response = 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.");
+      return Promise.resolve(response);
     }
     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()}`;
@@ -663,7 +665,7 @@ class Saasco {
     // This should only be called when distinctId is null and there is an existing userId.
     // This means the user has logged out and we should reset the session and anonymous IDs
     const userIdChangedToNull = distinctId === null && !!getUserId();
-    if (userIdChangedToNull) this.log('User ID change to null. Session reset');
+    if (userIdChangedToNull) this.log('User logged out');
     const reset = userIdChangedToNull;
     setSessionId({
       reset
@@ -674,7 +676,10 @@ class Saasco {
     // set the distinct Id to the userId
     setUserId(distinctId);
     // No distinctId provided so we don't track the user
-    if (!distinctId) return;
+    if (!distinctId) return Promise.resolve({
+      success: true,
+      message: 'No distinctId provided'
+    });
     const data = {
       id: uuid.v4(),
       timestamp: new Date().toISOString(),
@@ -687,6 +692,16 @@ class Saasco {
     };
     return this.doRequest('identify', data);
   }
+  /**
+   * This should only be called when the user logs out
+   * It will reset the session, anonymous id, and user id
+   *
+   * All events after calling reset will be tracked as a new user
+   *
+   */
+  logout() {
+    this.identify(null);
+  }
   /**
    * Handles sending data to the Saasco API
    * If you have a proxy set up, it will send the data to the proxy and you can handle forawrding the data to the Saasco events API
@@ -701,7 +716,10 @@ class Saasco {
       : data.action || path;
       this.log(logMessage, data);
       // If analytics is disabled, don't send the request
-      if (this.config.enabled === false) return;
+      if (this.config.enabled === false) return {
+        success: false,
+        message: 'Analytics is disabled'
+      };
       try {
         const response = yield fetch(url, {
           method: 'POST',
@@ -710,14 +728,20 @@ class Saasco {
           },
           body: JSON.stringify(data)
         });
+        const responseBody = yield response.json();
         if (!response.ok) {
-          const errorBody = yield response.json();
-          throw new Error(`${errorBody.message}: ${errorBody.errors ? `[${errorBody.errors.join(', ')}]` : ''}` || JSON.stringify(errorBody));
+          throw new Error(`${responseBody.message}: ${responseBody.errors ? `[${responseBody.errors.join(', ')}]` : ''}` || JSON.stringify(responseBody));
         }
-        return response;
+        return {
+          success: true,
+          message: responseBody.message
+        };
       } catch (error) {
         this.error(`\nError Message: "${error.message}"`, `\nPath: "/${path}"`, `\nRequest Data: ${JSON.stringify(data, null, 2)}`);
-        return error.message;
+        return {
+          success: false,
+          message: error.message
+        };
       }
     });
   }
@@ -739,6 +763,10 @@ class Saasco {
     console.error(...[`\x1b[41m\x1b[37m ${message} \x1b[0m`,
     // Message highlighted for easy finding
     ...args]);
+    return {
+      success: false,
+      message: args.join(' ')
+    };
   }
   /**
    * If autoPageTracking is enabled, this will automatically track page views

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.16";
+var version = "0.1.18";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -599,7 +599,8 @@ class Saasco {
   // 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.");
+      const response = 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.");
+      return Promise.resolve(response);
     }
     setSessionId();
     setAnonmousId();
@@ -649,7 +650,8 @@ class Saasco {
   }
   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 response = 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.");
+      return Promise.resolve(response);
     }
     const hasId = typeof distinctIdOrProperties === 'string' || typeof distinctIdOrProperties === 'number' || distinctIdOrProperties === null;
     const distinctId = hasId ? distinctIdOrProperties === null || distinctIdOrProperties === void 0 ? void 0 : distinctIdOrProperties.toString() : `soft_${v4()}`;
@@ -659,7 +661,7 @@ class Saasco {
     // This should only be called when distinctId is null and there is an existing userId.
     // This means the user has logged out and we should reset the session and anonymous IDs
     const userIdChangedToNull = distinctId === null && !!getUserId();
-    if (userIdChangedToNull) this.log('User ID change to null. Session reset');
+    if (userIdChangedToNull) this.log('User logged out');
     const reset = userIdChangedToNull;
     setSessionId({
       reset
@@ -670,7 +672,10 @@ class Saasco {
     // set the distinct Id to the userId
     setUserId(distinctId);
     // No distinctId provided so we don't track the user
-    if (!distinctId) return;
+    if (!distinctId) return Promise.resolve({
+      success: true,
+      message: 'No distinctId provided'
+    });
     const data = {
       id: v4(),
       timestamp: new Date().toISOString(),
@@ -683,6 +688,16 @@ class Saasco {
     };
     return this.doRequest('identify', data);
   }
+  /**
+   * This should only be called when the user logs out
+   * It will reset the session, anonymous id, and user id
+   *
+   * All events after calling reset will be tracked as a new user
+   *
+   */
+  logout() {
+    this.identify(null);
+  }
   /**
    * Handles sending data to the Saasco API
    * If you have a proxy set up, it will send the data to the proxy and you can handle forawrding the data to the Saasco events API
@@ -697,7 +712,10 @@ class Saasco {
       : data.action || path;
       this.log(logMessage, data);
       // If analytics is disabled, don't send the request
-      if (this.config.enabled === false) return;
+      if (this.config.enabled === false) return {
+        success: false,
+        message: 'Analytics is disabled'
+      };
       try {
         const response = yield fetch(url, {
           method: 'POST',
@@ -706,14 +724,20 @@ class Saasco {
           },
           body: JSON.stringify(data)
         });
+        const responseBody = yield response.json();
         if (!response.ok) {
-          const errorBody = yield response.json();
-          throw new Error(`${errorBody.message}: ${errorBody.errors ? `[${errorBody.errors.join(', ')}]` : ''}` || JSON.stringify(errorBody));
+          throw new Error(`${responseBody.message}: ${responseBody.errors ? `[${responseBody.errors.join(', ')}]` : ''}` || JSON.stringify(responseBody));
         }
-        return response;
+        return {
+          success: true,
+          message: responseBody.message
+        };
       } catch (error) {
         this.error(`\nError Message: "${error.message}"`, `\nPath: "/${path}"`, `\nRequest Data: ${JSON.stringify(data, null, 2)}`);
-        return error.message;
+        return {
+          success: false,
+          message: error.message
+        };
       }
     });
   }
@@ -735,6 +759,10 @@ class Saasco {
     console.error(...[`\x1b[41m\x1b[37m ${message} \x1b[0m`,
     // Message highlighted for easy finding
     ...args]);
+    return {
+      success: false,
+      message: args.join(' ')
+    };
   }
   /**
    * If autoPageTracking is enabled, this will automatically track page views

package/package.json

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

package/src/lib/analytics.d.ts

@@ -4,6 +4,10 @@ declare global {
         saasco: Saasco;
     }
 }
+type DoRequestResponse = {
+    success: boolean;
+    message: string;
+};
 export declare class Saasco {
     private config;
     private lastPageViewPath;
@@ -44,14 +48,14 @@ export declare class Saasco {
      */
     track(name: string, properties?: Record<string, any>, context?: {
         active?: boolean;
-    }): void | Promise<any>;
+    }): Promise<DoRequestResponse>;
     /**
      * 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(): void | Promise<any>;
+    page(): Promise<DoRequestResponse> | 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.
@@ -63,10 +67,18 @@ export declare class Saasco {
      */
     identify(properties: Record<string, any>, context?: {
         active?: boolean;
-    }): void;
+    }): Promise<DoRequestResponse>;
     identify(distinctId: string | number | null, properties?: Record<string, any>, context?: {
         active?: boolean;
-    }): void;
+    }): Promise<DoRequestResponse>;
+    /**
+     * This should only be called when the user logs out
+     * It will reset the session, anonymous id, and user id
+     *
+     * All events after calling reset will be tracked as a new user
+     *
+     */
+    logout(): void;
     /**
      * Handles sending data to the Saasco API
      * If you have a proxy set up, it will send the data to the proxy and you can handle forawrding the data to the Saasco events API
@@ -89,3 +101,4 @@ export declare class Saasco {
      */
     private initiAutoPageTracking;
 }
+export {};