@suprsend/web-sdk 0.1.25 → 0.1.28

package/dist/cjs_bundle.js.LICENSE.txt

@@ -0,0 +1 @@
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/web-sdk",
-  "version": "0.1.25",
+  "version": "0.1.28",
   "description": "This is sdk used to integrate suprsend functionality in javascript applications",
   "main": "dist/cjs_bundle.js",
   "scripts": {
@@ -23,13 +23,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "@babel/core": "^7.15.0",
-    "@babel/preset-env": "^7.15.0",
-    "babel-loader": "^8.2.2",
+    "@babel/core": "^7.18.5",
+    "@babel/preset-env": "^7.18.2",
+    "babel-loader": "^8.2.5",
     "webpack": "^5.51.1",
     "webpack-cli": "^4.8.0"
   },
   "dependencies": {
-    "libphonenumber-js": "^1.9.43"
+    "libphonenumber-js": "^1.10.7"
   }
 }

package/src/constants.js

@@ -7,6 +7,13 @@ export const constants = {
   device_id_key: "_suprsend_device_id",
 };
 
+export const internal_events = {
+  app_launched: "$app_launched",
+  user_login: "$user_login",
+  user_logout: "$user_logout",
+  purchase_made: "$purchase_made",
+};
+
 export const browser_useragent_map = {
   Edge: ["Edge"],
   "Opera Mini": ["Opera Mini"],
@@ -39,3 +46,5 @@ export const os_useragent_map = {
   Android: "Android",
   Linux: "Linux",
 };
+
+export const regex = { email: /\S+@\S+\.\S+/ };

package/src/index.js

@@ -2,21 +2,20 @@ import utils from "./utils";
 import config from "./config";
 import User from "./user";
 import WebPush from "./web_push";
-import { constants } from "./constants";
+import { constants, internal_events } from "./constants";
 import { SSConfigurationError } from "./errors";
 
 var suprSendInstance;
-export var init_at;
+export var initialisedAt;
 
 class SuprSend {
   init(ENV_API_KEY, SIGNING_KEY, config_keys = {}) {
     config_keys.env = ENV_API_KEY;
     config_keys.signing_key = SIGNING_KEY;
-    init_at = new Date();
     var distinct_id = utils.get_cookie(constants.distinct_id);
     if (!suprSendInstance) {
       suprSendInstance = {};
-      this.setCustomConfig(config_keys);
+      this._set_custom_config(config_keys);
     }
     if (!distinct_id) {
       distinct_id = utils.uuid();
@@ -26,11 +25,15 @@ class SuprSend {
     this.user = new User(suprSendInstance);
     this.web_push = new WebPush(suprSendInstance);
     this.web_push.update_subscription();
-    SuprSend.setEnvProperties();
-    utils.bulk_call_api();
+    SuprSend._set_env_properties();
+    if (!initialisedAt) {
+      utils.bulk_call_api();
+      this.track(internal_events.app_launched);
+    }
+    initialisedAt = new Date();
   }
 
-  static setEnvProperties() {
+  static _set_env_properties() {
     let device_id = utils.get_local_storage_item(constants.device_id_key);
     if (!device_id) {
       device_id = utils.uuid();
@@ -46,7 +49,7 @@ class SuprSend {
     };
   }
 
-  setCustomConfigProperty(key, value = "", mandatory = false) {
+  _set_custom_config_property(key, value = "", mandatory = false) {
     if (value) {
       config[key] = value;
     } else {
@@ -56,12 +59,16 @@ class SuprSend {
     }
   }
 
-  setCustomConfig(config_keys) {
-    this.setCustomConfigProperty("env_key", config_keys.env, true);
-    this.setCustomConfigProperty("signing_key", config_keys.signing_key, true);
-    this.setCustomConfigProperty("api_url", config_keys?.api_url);
-    this.setCustomConfigProperty("vapid_key", config_keys?.vapid_key);
-    this.setCustomConfigProperty(
+  _set_custom_config(config_keys) {
+    this._set_custom_config_property("env_key", config_keys.env, true);
+    this._set_custom_config_property(
+      "signing_key",
+      config_keys.signing_key,
+      true
+    );
+    this._set_custom_config_property("api_url", config_keys?.api_url);
+    this._set_custom_config_property("vapid_key", config_keys?.vapid_key);
+    this._set_custom_config_property(
       "service_worker_file",
       config_keys?.sw_file_name
     );
@@ -93,6 +100,8 @@ class SuprSend {
       utils.batch_or_call({
         env: config.env_key,
         event: "$identify",
+        $insert_id: utils.uuid(),
+        $time: utils.epoch_milliseconds(),
         properties: {
           $identified_id: unique_id,
           $anon_id: suprSendInstance.distinct_id,
@@ -102,12 +111,19 @@ class SuprSend {
       suprSendInstance.distinct_id = unique_id;
       suprSendInstance._user_identified = true;
       this.web_push.update_subscription();
+      this.track(internal_events.user_login);
     }
   }
 
   track(event, props = {}) {
     if (event === undefined) {
       return;
+    } else if (
+      !utils.is_internal_event(event) &&
+      utils.has_special_char(event)
+    ) {
+      console.log("Suprsend: key cannot start with $ or ss_");
+      return;
     }
     const super_props = utils.get_parsed_local_store_data(
       constants.super_properties_key
@@ -129,7 +145,19 @@ class SuprSend {
     });
   }
 
-  reset() {
+  purchase_made(props) {
+    this.track(internal_events.purchase_made, props);
+  }
+
+  async reset(options = { unsubscribe_push: true }) {
+    // unsubscribe push
+    if (options?.unsubscribe_push) {
+      const subscription = await this.web_push._get_subscription();
+      if (subscription) {
+        this.user.remove_webpush(subscription);
+      }
+    }
+    this.track(internal_events.user_logout);
     var distinct_id = utils.uuid();
     utils.set_cookie(constants.distinct_id, distinct_id);
     suprSendInstance = {
@@ -139,7 +167,7 @@ class SuprSend {
     utils.remove_local_storage_item(constants.super_properties_key);
     this.user = new User(suprSendInstance);
     this.web_push = new WebPush(suprSendInstance);
-    SuprSend.setEnvProperties();
+    SuprSend._set_env_properties();
   }
 }
 

package/src/user.js

@@ -1,5 +1,6 @@
 import utils from "./utils";
 import config from "./config";
+import { regex } from "./constants";
 import { parsePhoneNumber } from "libphonenumber-js";
 
 class User {
@@ -40,6 +41,14 @@ class User {
     return obj;
   }
 
+  _validate_email_and_send(key, email) {
+    if (regex.email.test(email)) {
+      this.append(key, email);
+    } else {
+      console.log("Suprsend: Provide valid Email ID");
+    }
+  }
+
   _validate_mobile_and_send(key, mobile) {
     try {
       const mobile_number = parsePhoneNumber(mobile);
@@ -113,7 +122,7 @@ class User {
   }
 
   add_email(email = "") {
-    this.append("$email", email);
+    this._validate_email_and_send("$email", email);
   }
 
   remove_email(email = "") {
@@ -143,6 +152,14 @@ class User {
       $pushvendor: "vapid",
     });
   }
+
+  remove_webpush(push = "") {
+    this.remove({
+      $webpush: push,
+      $device_id: this.instance?.env_properties?.$device_id,
+      $pushvendor: "vapid",
+    });
+  }
 }
 
 export default User;

package/src/utils.js

@@ -3,6 +3,7 @@ import {
   browser_version_useragent_map,
   os_useragent_map,
   constants,
+  internal_events,
 } from "./constants";
 import config from "./config";
 import create_signature from "./encryption";
@@ -207,6 +208,7 @@ function format_props({ key, value, allow_special_tags = false }) {
     for (let item in key) {
       if (key[item] !== undefined) {
         if (!allow_special_tags && has_special_char(item)) {
+          console.log("Suprsend: key cannot start with $ or ss_");
           continue;
         }
         formatted_data[String(item)] = key[item];
@@ -239,6 +241,11 @@ const has_special_char = (str) => {
   return str.startsWith("$") || str?.toLowerCase()?.startsWith("ss_");
 };
 
+const is_internal_event = (event) => {
+  const internal_events_list = Object.values(internal_events);
+  return internal_events_list.includes(event);
+};
+
 const is_empty = (value) => {
   if (Array.isArray(value)) {
     return value.length === 0;
@@ -272,4 +279,5 @@ export default {
   has_special_char,
   is_empty,
   bulk_call_api,
+  is_internal_event,
 };

package/src/web_push.js

@@ -1,7 +1,7 @@
 import utils from "./utils";
 import config from "./config";
 import User from "./user";
-import { init_at } from "./index";
+import { initialisedAt } from "./index";
 
 var notification_timer;
 class WebPush {
@@ -45,7 +45,7 @@ class WebPush {
   // this method make sure there is a given delay, as calling notification permission just after load is not good UX practice
   _subscribe_with_delay() {
     const now = new Date();
-    const delay = now - init_at;
+    const delay = now - initialisedAt;
     const has_delay = delay >= config.sw_delay;
     if (has_delay) {
       this._register_sw();