@suprsend/node-sdk 0.1.1 → 1.0.0

package/dist/{identity_helper.js → subscriber_helper.js}

@@ -15,24 +15,25 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 
 var _utils = require("./utils");
 
+// ---------- Identity keys
+var IDENT_KEY_EMAIL = "$email";
+var IDENT_KEY_SMS = "$sms";
+var IDENT_KEY_ANDROIDPUSH = "$androidpush";
+var IDENT_KEY_IOSPUSH = "$iospush";
+var IDENT_KEY_WHATSAPP = "$whatsapp";
+var IDENT_KEY_WEBPUSH = "$webpush";
+var IDENT_KEY_SLACK = "$slack";
+var IDENT_KEYS_ALL = [IDENT_KEY_EMAIL, IDENT_KEY_SMS, IDENT_KEY_ANDROIDPUSH, IDENT_KEY_IOSPUSH, IDENT_KEY_WHATSAPP, IDENT_KEY_WEBPUSH, IDENT_KEY_SLACK];
+var KEY_PUSHVENDOR = "$pushvendor";
+var OTHER_RESERVED_KEYS = ["$messenger", "$inbox", KEY_PUSHVENDOR, "$device_id", "$insert_id", "$time", "$set", "$set_once", "$add", "$append", "$remove", "$unset", "$identify", "$anon_id", "$identified_id", "$notification_delivered", "$notification_dismiss", "$notification_clicked"];
+var SUPER_PROPERTY_KEYS = ["$app_version_string", "$app_build_number", "$brand", "$carrier", "$manufacturer", "$model", "$os", "$ss_sdk_version", "$insert_id", "$time"];
+var ALL_RESERVED_KEYS = [].concat(SUPER_PROPERTY_KEYS, OTHER_RESERVED_KEYS, IDENT_KEYS_ALL);
 var EMAIL_REGEX = /\S+@\S+\.\S+/;
 var MOBILE_REGEX = /^\+[0-9\s]+/;
-var KEY_PUSHVENDOR = "$pushvendor";
-var CHANNEL_MAP = {
-  EMAIL: "$email",
-  SMS: "$sms",
-  WHATSAPP: "$whatsapp",
-  ANDROID_PUSH: "$androidpush",
-  IOS_PUSH: "$iospush",
-  WEB_PUSH: "$webpush"
-};
-var ANDROID_PUSH_VENDORS = ["fcm", "xiaomi", "oppo"];
-var IOS_PUSH_VENDORS = ["apns"];
-var WEB_PUSH_VENDORS = ["vapid"];
-
-var _IdentityEventInternalHelper = /*#__PURE__*/function () {
-  function _IdentityEventInternalHelper(distinct_id, workspace_key) {
-    (0, _classCallCheck2["default"])(this, _IdentityEventInternalHelper);
+
+var _SubscriberInternalHelper = /*#__PURE__*/function () {
+  function _SubscriberInternalHelper(distinct_id, workspace_key) {
+    (0, _classCallCheck2["default"])(this, _SubscriberInternalHelper);
     this.distinct_id = distinct_id;
     this.workspace_key = workspace_key;
     this.__dict_append = {};
@@ -45,7 +46,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
     this.__info = [];
   }
 
-  (0, _createClass2["default"])(_IdentityEventInternalHelper, [{
+  (0, _createClass2["default"])(_SubscriberInternalHelper, [{
     key: "reset",
     value: function reset() {
       this.__dict_append = {};
@@ -76,7 +77,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
   }, {
     key: "__form_event",
     value: function __form_event() {
-      if (!(0, _utils.is_empty)(this.__dict_append) || !(0, _utils.is_empty)(this.__dict_remove)) {
+      if (!(0, _utils.is_empty)(this.__dict_append) || !(0, _utils.is_empty)(this.__dict_remove) || !(0, _utils.is_empty)(this.__list_unset)) {
         var event = {
           $insert_id: (0, _utils.uuid)(),
           $time: (0, _utils.epoch_milliseconds)(),
@@ -94,10 +95,15 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
           this.__remove_count += 1;
         }
 
+        if (!(0, _utils.is_empty)(this.__list_unset)) {
+          event["$unset"] = this.__list_unset;
+          this.__unset_count += 1;
+        }
+
         return event;
+      } else {
+        return;
       }
-
-      return;
     }
   }, {
     key: "__validate_key_basic",
@@ -121,7 +127,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
   }, {
     key: "__validate_key_prefix",
     value: function __validate_key_prefix(key, caller) {
-      if (!this.__is_identity_key(key)) {
+      if (!ALL_RESERVED_KEYS.includes(key)) {
         if ((0, _utils.has_special_char)(key)) {
           this.__info.push("[".concat(caller, "] skipping key: ").concat(key, ". key starting with [$,ss_] are reserved"));
 
@@ -134,7 +140,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
   }, {
     key: "__is_identity_key",
     value: function __is_identity_key(key) {
-      return Object.values(CHANNEL_MAP).includes(key);
+      return IDENT_KEYS_ALL.includes(key);
     }
   }, {
     key: "_append_kv",
@@ -145,18 +151,18 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
       var _this$__validate_key_ = this.__validate_key_basic(key, caller),
           _this$__validate_key_2 = (0, _slicedToArray2["default"])(_this$__validate_key_, 2),
           validated_key = _this$__validate_key_2[0],
-          is_valid = _this$__validate_key_2[1];
+          is_k_valid = _this$__validate_key_2[1];
 
-      if (!is_valid) {
+      if (!is_k_valid) {
         return;
       }
 
       if (this.__is_identity_key(validated_key)) {
         this.__add_identity(validated_key, value, args, caller);
       } else {
-        var _is_valid = this.__validate_key_prefix(validated_key, caller);
+        var _is_k_valid = this.__validate_key_prefix(validated_key, caller);
 
-        if (_is_valid) {
+        if (_is_k_valid) {
           this.__dict_append[validated_key] = value;
         }
       }
@@ -170,42 +176,58 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
       var _this$__validate_key_3 = this.__validate_key_basic(key, caller),
           _this$__validate_key_4 = (0, _slicedToArray2["default"])(_this$__validate_key_3, 2),
           validated_key = _this$__validate_key_4[0],
-          is_valid = _this$__validate_key_4[1];
+          is_k_valid = _this$__validate_key_4[1];
 
-      if (!is_valid) {
+      if (!is_k_valid) {
         return;
       }
 
       if (this.__is_identity_key(validated_key)) {
         this.__remove_identity(validated_key, value, args, caller);
       } else {
-        var _is_valid2 = this.__validate_key_prefix(validated_key, caller);
+        var _is_k_valid2 = this.__validate_key_prefix(validated_key, caller);
 
-        if (_is_valid2) {
+        if (_is_k_valid2) {
           this.__dict_remove[validated_key] = value;
         }
       }
     }
+  }, {
+    key: "_unset_k",
+    value: function _unset_k(key) {
+      var caller = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unset";
+
+      var _this$__validate_key_5 = this.__validate_key_basic(key, caller),
+          _this$__validate_key_6 = (0, _slicedToArray2["default"])(_this$__validate_key_5, 2),
+          validated_key = _this$__validate_key_6[0],
+          is_k_valid = _this$__validate_key_6[1];
+
+      if (!is_k_valid) {
+        return;
+      }
+
+      this.__list_unset.push(validated_key);
+    }
   }, {
     key: "__add_identity",
     value: function __add_identity(key, value, args, caller) {
       switch (key) {
-        case CHANNEL_MAP.EMAIL:
+        case IDENT_KEY_EMAIL:
           this._add_email(value, caller);
 
           break;
 
-        case CHANNEL_MAP.SMS:
+        case IDENT_KEY_SMS:
           this._add_sms(value, caller);
 
           break;
 
-        case CHANNEL_MAP.WHATSAPP:
+        case IDENT_KEY_WHATSAPP:
           this._add_whatsapp(value, caller);
 
           break;
 
-        case CHANNEL_MAP.ANDROID_PUSH:
+        case IDENT_KEY_ANDROIDPUSH:
           this._add_androidpush(value, args[KEY_PUSHVENDOR], caller);
 
           if (this.__dict_append[KEY_PUSHVENDOR]) {
@@ -214,7 +236,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
 
           break;
 
-        case CHANNEL_MAP.IOS_PUSH:
+        case IDENT_KEY_IOSPUSH:
           this._add_iospush(value, args[KEY_PUSHVENDOR], caller);
 
           if (this.__dict_append[KEY_PUSHVENDOR]) {
@@ -223,7 +245,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
 
           break;
 
-        case CHANNEL_MAP.WEB_PUSH:
+        case IDENT_KEY_WEBPUSH:
           this._add_webpush(value, args[KEY_PUSHVENDOR], caller);
 
           if (this.__dict_append[KEY_PUSHVENDOR]) {
@@ -232,6 +254,11 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
 
           break;
 
+        case IDENT_KEY_SLACK:
+          this._add_slack(value, caller);
+
+          break;
+
         default:
           break;
       }
@@ -240,22 +267,22 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
     key: "__remove_identity",
     value: function __remove_identity(key, value, args, caller) {
       switch (key) {
-        case CHANNEL_MAP.EMAIL:
+        case IDENT_KEY_EMAIL:
           this._remove_email(value, caller);
 
           break;
 
-        case CHANNEL_MAP.SMS:
+        case IDENT_KEY_SMS:
           this._remove_sms(value, caller);
 
           break;
 
-        case CHANNEL_MAP.WHATSAPP:
+        case IDENT_KEY_WHATSAPP:
           this._remove_whatsapp(value, caller);
 
           break;
 
-        case CHANNEL_MAP.ANDROID_PUSH:
+        case IDENT_KEY_ANDROIDPUSH:
           this._remove_androidpush(value, args[KEY_PUSHVENDOR], caller);
 
           if (this.__dict_remove[KEY_PUSHVENDOR]) {
@@ -264,7 +291,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
 
           break;
 
-        case CHANNEL_MAP.IOS_PUSH:
+        case IDENT_KEY_IOSPUSH:
           this._remove_iospush(value, args[KEY_PUSHVENDOR], caller);
 
           if (this.__dict_remove[KEY_PUSHVENDOR]) {
@@ -273,7 +300,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
 
           break;
 
-        case CHANNEL_MAP.WEB_PUSH:
+        case IDENT_KEY_WEBPUSH:
           this._remove_webpush(value, args[KEY_PUSHVENDOR], caller);
 
           if (this.__dict_remove[KEY_PUSHVENDOR]) {
@@ -282,6 +309,11 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
 
           break;
 
+        case IDENT_KEY_SLACK:
+          this._remove_slack(val, caller);
+
+          break;
+
         default:
           break;
       }
@@ -351,7 +383,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_append[CHANNEL_MAP.EMAIL] = value;
+      this.__dict_append[IDENT_KEY_EMAIL] = value;
     }
   }, {
     key: "_remove_email",
@@ -365,7 +397,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_remove[CHANNEL_MAP.EMAIL] = value;
+      this.__dict_remove[IDENT_KEY_EMAIL] = value;
     } // mobile methods
 
   }, {
@@ -410,7 +442,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_append[CHANNEL_MAP.SMS] = value;
+      this.__dict_append[IDENT_KEY_SMS] = value;
     }
   }, {
     key: "_remove_sms",
@@ -424,7 +456,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_remove[CHANNEL_MAP.SMS] = value;
+      this.__dict_remove[IDENT_KEY_SMS] = value;
     }
   }, {
     key: "_add_whatsapp",
@@ -438,7 +470,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_append[CHANNEL_MAP.WHATSAPP] = value;
+      this.__dict_append[IDENT_KEY_WHATSAPP] = value;
     }
   }, {
     key: "_remove_whatsapp",
@@ -452,7 +484,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_remove[CHANNEL_MAP.WHATSAPP] = value;
+      this.__dict_remove[IDENT_KEY_WHATSAPP] = value;
     } // android push methods
 
   }, {
@@ -471,7 +503,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         provider = "fcm";
       }
 
-      if (!ANDROID_PUSH_VENDORS.includes(provider)) {
+      if (!["fcm", "xiaomi", "oppo"].includes(provider)) {
         this.__errors.push("[".concat(caller, "] unsupported androidpush provider ").concat(provider));
 
         return [push_token, provider, false];
@@ -495,7 +527,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_append[CHANNEL_MAP.ANDROID_PUSH] = value;
+      this.__dict_append[IDENT_KEY_ANDROIDPUSH] = value;
       this.__dict_append[KEY_PUSHVENDOR] = vendor;
     }
   }, {
@@ -514,7 +546,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_remove[CHANNEL_MAP.ANDROID_PUSH] = value;
+      this.__dict_remove[IDENT_KEY_ANDROIDPUSH] = value;
       this.__dict_remove[KEY_PUSHVENDOR] = vendor;
     } // ios push methods
 
@@ -534,7 +566,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         provider = "apns";
       }
 
-      if (!IOS_PUSH_VENDORS.includes(provider)) {
+      if (!["apns"].includes(provider)) {
         this.__errors.push("[".concat(caller, "] unsupported iospush provider ").concat(provider));
 
         return [push_token, provider, false];
@@ -558,7 +590,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_append[CHANNEL_MAP.IOS_PUSH] = value;
+      this.__dict_append[IDENT_KEY_IOSPUSH] = value;
       this.__dict_append[KEY_PUSHVENDOR] = vendor;
     }
   }, {
@@ -577,7 +609,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_remove[CHANNEL_MAP.IOS_PUSH] = value;
+      this.__dict_remove[IDENT_KEY_IOSPUSH] = value;
       this.__dict_remove[KEY_PUSHVENDOR] = vendor;
     } // web push methods
 
@@ -594,7 +626,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         provider = "vapid";
       }
 
-      if (!WEB_PUSH_VENDORS.includes(provider)) {
+      if (!["vapid"].includes(provider)) {
         this.__errors.push("[".concat(caller, "] unsupported webpush provider ").concat(provider));
 
         return [value, provider, false];
@@ -618,7 +650,7 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_append[CHANNEL_MAP.WEB_PUSH] = value;
+      this.__dict_append[IDENT_KEY_WEBPUSH] = value;
       this.__dict_append[KEY_PUSHVENDOR] = vendor;
     }
   }, {
@@ -637,12 +669,112 @@ var _IdentityEventInternalHelper = /*#__PURE__*/function () {
         return;
       }
 
-      this.__dict_remove[CHANNEL_MAP.WEB_PUSH] = value;
+      this.__dict_remove[IDENT_KEY_WEBPUSH] = value;
       this.__dict_remove[KEY_PUSHVENDOR] = vendor;
     }
+  }, {
+    key: "__validate_slack_userid",
+    value: function __validate_slack_userid(userid, caller) {
+      var _this$__check_ident_v9 = this.__check_ident_val_string(userid, caller),
+          _this$__check_ident_v10 = (0, _slicedToArray2["default"])(_this$__check_ident_v9, 2),
+          validated_userid = _this$__check_ident_v10[0],
+          is_valid = _this$__check_ident_v10[1];
+
+      if (!is_valid) {
+        return [validated_userid, false];
+      }
+
+      validated_userid = validated_userid.toUpperCase();
+
+      if (!validated_userid.startsWith("U") && !validated_userid.startsWith("W")) {
+        this.__errors.push("[".concat(caller, "] invalid value ").concat(validated_userid, ". Slack user/member_id starts with a U or W"));
+
+        return [validated_userid, false];
+      }
+
+      return [validated_userid, true];
+    }
+  }, {
+    key: "__check_slack_dict",
+    value: function __check_slack_dict(value, caller) {
+      var msg = "value must be a valid dict/json with one of these keys: [email, user_id]";
+
+      if (!(value && value instanceof Object)) {
+        this.__errors.push("[".concat(caller, "] ").concat(msg));
+
+        return [value, false];
+      }
+
+      var user_id = value.user_id;
+      var email = value.email;
+
+      if (user_id && user_id.trim()) {
+        user_id = user_id.trim();
+
+        var _this$__validate_slac = this.__validate_slack_userid(user_id, caller),
+            _this$__validate_slac2 = (0, _slicedToArray2["default"])(_this$__validate_slac, 2),
+            validated_user_id = _this$__validate_slac2[0],
+            is_valid = _this$__validate_slac2[1];
+
+        if (!is_valid) {
+          return [value, false];
+        } else {
+          return [{
+            user_id: validated_user_id
+          }, true];
+        }
+      } else if (email && email.trim()) {
+        email = email.trim();
+
+        var _this$__validate_emai5 = this.__validate_email(email, caller),
+            _this$__validate_emai6 = (0, _slicedToArray2["default"])(_this$__validate_emai5, 2),
+            validated_email = _this$__validate_emai6[0],
+            _is_valid = _this$__validate_emai6[1];
+
+        if (!_is_valid) {
+          return [value, false];
+        } else {
+          return [{
+            email: validated_email
+          }, true];
+        }
+      } else {
+        this.__errors.push("[".concat(caller, "] ").concat(msg));
+
+        return [value, false];
+      }
+    }
+  }, {
+    key: "_add_slack",
+    value: function _add_slack(value, caller) {
+      var _this$__check_slack_d = this.__check_slack_dict(value, caller),
+          _this$__check_slack_d2 = (0, _slicedToArray2["default"])(_this$__check_slack_d, 2),
+          validated_value = _this$__check_slack_d2[0],
+          is_valid = _this$__check_slack_d2[1];
+
+      if (!is_valid) {
+        return;
+      }
+
+      this.__dict_append[IDENT_KEY_SLACK] = validated_value;
+    }
+  }, {
+    key: "_remove_slack",
+    value: function _remove_slack(value, caller) {
+      var _this$__check_slack_d3 = this.__check_slack_dict(value, caller),
+          _this$__check_slack_d4 = (0, _slicedToArray2["default"])(_this$__check_slack_d3, 2),
+          validated_value = _this$__check_slack_d4[0],
+          is_valid = _this$__check_slack_d4[1];
+
+      if (!is_valid) {
+        return;
+      }
+
+      this.__dict_remove[IDENT_KEY_SLACK] = validated_value;
+    }
   }]);
-  return _IdentityEventInternalHelper;
+  return _SubscriberInternalHelper;
 }();
 
-exports["default"] = _IdentityEventInternalHelper;
+exports["default"] = _SubscriberInternalHelper;
 module.exports = exports.default;