@suprsend/node-sdk 1.11.1 → 1.13.0

package/src/subscriber_helper.js

@@ -1,12 +1,4 @@
-import {
-  is_object,
-  has_special_char,
-  epoch_milliseconds,
-  uuid,
-  is_empty,
-  is_string,
-} from "./utils";
-import ALL_LANG_CODES from "./language_codes";
+import { is_empty, is_string } from "./utils";
 
 // ---------- Identity keys
 const IDENT_KEY_EMAIL = "$email";
@@ -29,55 +21,10 @@ const IDENT_KEYS_ALL = [
   IDENT_KEY_MS_TEAMS,
 ];
 
-const KEY_PUSHVENDOR = "$pushvendor";
+const KEY_ID_PROVIDER = "$id_provider";
 const KEY_PREFERRED_LANGUAGE = "$preferred_language";
 const KEY_TIMEZONE = "$timezone";
 
-const OTHER_RESERVED_KEYS = [
-  "$messenger",
-  "$inbox",
-  KEY_PUSHVENDOR,
-  "$device_id",
-  "$insert_id",
-  "$time",
-  "$set",
-  "$set_once",
-  "$add",
-  "$append",
-  "$remove",
-  "$unset",
-  "$identify",
-  "$anon_id",
-  "$identified_id",
-  KEY_PREFERRED_LANGUAGE,
-  KEY_TIMEZONE,
-  "$notification_delivered",
-  "$notification_dismiss",
-  "$notification_clicked",
-];
-
-const SUPER_PROPERTY_KEYS = [
-  "$app_version_string",
-  "$app_build_number",
-  "$brand",
-  "$carrier",
-  "$manufacturer",
-  "$model",
-  "$os",
-  "$ss_sdk_version",
-  "$insert_id",
-  "$time",
-];
-
-const ALL_RESERVED_KEYS = [
-  ...SUPER_PROPERTY_KEYS,
-  ...OTHER_RESERVED_KEYS,
-  ...IDENT_KEYS_ALL,
-];
-
-const EMAIL_REGEX = /\S+@\S+\.\S+/;
-const MOBILE_REGEX = /^\+[0-9\s]+/;
-
 export default class _SubscriberInternalHelper {
   constructor(distinct_id, workspace_key) {
     this.distinct_id = distinct_id;
@@ -159,18 +106,6 @@ export default class _SubscriberInternalHelper {
     return [key, true];
   }
 
-  __validate_key_prefix(key, caller) {
-    if (!ALL_RESERVED_KEYS.includes(key)) {
-      if (has_special_char(key)) {
-        this.__info.push(
-          `[${caller}] skipping key: ${key}. key starting with [$,ss_] are reserved`
-        );
-        return false;
-      }
-    }
-    return true;
-  }
-
   __is_identity_key(key) {
     return IDENT_KEYS_ALL.includes(key);
   }
@@ -183,10 +118,7 @@ export default class _SubscriberInternalHelper {
     if (this.__is_identity_key(validated_key)) {
       this.__add_identity(validated_key, value, args, caller);
     } else {
-      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
-      if (is_k_valid) {
-        this.__dict_append[validated_key] = value;
-      }
+      this.__dict_append[validated_key] = value;
     }
   }
 
@@ -195,10 +127,7 @@ export default class _SubscriberInternalHelper {
     if (!is_k_valid) {
       return;
     } else {
-      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
-      if (is_k_valid) {
-        this.__dict_set[validated_key] = value;
-      }
+      this.__dict_set[validated_key] = value;
     }
   }
 
@@ -207,10 +136,7 @@ export default class _SubscriberInternalHelper {
     if (!is_k_valid) {
       return;
     } else {
-      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
-      if (is_k_valid) {
-        this.__dict_set_once[validated_key] = value;
-      }
+      this.__dict_set_once[validated_key] = value;
     }
   }
 
@@ -219,10 +145,7 @@ export default class _SubscriberInternalHelper {
     if (!is_k_valid) {
       return;
     } else {
-      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
-      if (is_k_valid) {
-        this.__dict_increment[validated_key] = value;
-      }
+      this.__dict_increment[validated_key] = value;
     }
   }
 
@@ -234,10 +157,7 @@ export default class _SubscriberInternalHelper {
     if (this.__is_identity_key(validated_key)) {
       this.__remove_identity(validated_key, value, args, caller);
     } else {
-      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
-      if (is_k_valid) {
-        this.__dict_remove[validated_key] = value;
-      }
+      this.__dict_remove[validated_key] = value;
     }
   }
 
@@ -250,10 +170,6 @@ export default class _SubscriberInternalHelper {
   }
 
   _set_preferred_language(lang_code, caller) {
-    if (!ALL_LANG_CODES.includes(lang_code)) {
-      this.__info.push(`[${caller}] invalid value ${lang_code}`);
-      return;
-    }
     this.__dict_set[KEY_PREFERRED_LANGUAGE] = lang_code;
   }
 
@@ -274,13 +190,13 @@ export default class _SubscriberInternalHelper {
         this._add_whatsapp(value, new_caller);
         break;
       case IDENT_KEY_ANDROIDPUSH:
-        this._add_androidpush(value, args[KEY_PUSHVENDOR], new_caller);
+        this._add_androidpush(value, args[KEY_ID_PROVIDER], new_caller);
         break;
       case IDENT_KEY_IOSPUSH:
-        this._add_iospush(value, args[KEY_PUSHVENDOR], new_caller);
+        this._add_iospush(value, args[KEY_ID_PROVIDER], new_caller);
         break;
       case IDENT_KEY_WEBPUSH:
-        this._add_webpush(value, args[KEY_PUSHVENDOR], new_caller);
+        this._add_webpush(value, args[KEY_ID_PROVIDER], new_caller);
         break;
       case IDENT_KEY_SLACK:
         this._add_slack(value, caller);
@@ -306,13 +222,13 @@ export default class _SubscriberInternalHelper {
         this._remove_whatsapp(value, new_caller);
         break;
       case IDENT_KEY_ANDROIDPUSH:
-        this._remove_androidpush(value, args[KEY_PUSHVENDOR], new_caller);
+        this._remove_androidpush(value, args[KEY_ID_PROVIDER], new_caller);
         break;
       case IDENT_KEY_IOSPUSH:
-        this._remove_iospush(value, args[KEY_PUSHVENDOR], new_caller);
+        this._remove_iospush(value, args[KEY_ID_PROVIDER], new_caller);
         break;
       case IDENT_KEY_WEBPUSH:
-        this._remove_webpush(value, args[KEY_PUSHVENDOR], new_caller);
+        this._remove_webpush(value, args[KEY_ID_PROVIDER], new_caller);
         break;
       case IDENT_KEY_SLACK:
         this._remove_slack(val, caller);
@@ -325,313 +241,73 @@ export default class _SubscriberInternalHelper {
     }
   }
 
-  __check_ident_val_string(value, caller) {
-    const message = "value must be a string with proper value";
-    if (!is_string(value)) {
-      this.__errors.push(`[${caller}] ${message}`);
-      return [value, false];
-    }
-    value = value.trim();
-    if (!value) {
-      this.__errors.push(`[${caller}] ${message}`);
-      return [value, false];
-    }
-    return [value, true];
-  }
-
-  // email methods
-  __validate_email(value, caller) {
-    const [email, is_valid] = this.__check_ident_val_string(value, caller);
-    if (!is_valid) {
-      return [email, false];
-    }
-    const message = "value in email format required. e.g. user@example.com";
-    const min_length = 6;
-    const max_length = 127;
-    const is_valid_email = EMAIL_REGEX.test(email);
-    if (!is_valid_email) {
-      this.__errors.push(`[${caller}] invalid value ${email}. ${message}`);
-      return [email, false];
-    }
-    if (email.length < min_length || email.length > max_length) {
-      this.__errors.push(
-        `[${caller}] invalid value ${email}. must be 6 <= email.length <= 127`
-      );
-      return [email, false];
-    }
-    return [email, true];
-  }
-
   _add_email(email, caller) {
-    const [value, is_valid] = this.__validate_email(email, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_EMAIL] = value;
+    this.__dict_append[IDENT_KEY_EMAIL] = email;
   }
 
   _remove_email(email, caller) {
-    const [value, is_valid] = this.__validate_email(email, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_EMAIL] = value;
-  }
-
-  // mobile methods
-  __validate_mobile_no(value, caller) {
-    const [mobile, is_valid] = this.__check_ident_val_string(value, caller);
-    if (!is_valid) {
-      return [mobile, false];
-    }
-    const message =
-      "number must start with + and must contain country code. e.g. +41446681800";
-    const min_length = 8;
-    const is_valid_mobile = MOBILE_REGEX.test(mobile);
-    if (!is_valid_mobile) {
-      this.__errors.push(`[${caller}] invalid value ${mobile}. ${message}`);
-      return [mobile, false];
-    }
-    if (mobile.length < min_length) {
-      this.__errors.push(
-        `[${caller}] invalid value ${mobile}. mobile_no.length must be >= 8`
-      );
-      return [mobile, false];
-    }
-    return [mobile, true];
+    this.__dict_remove[IDENT_KEY_EMAIL] = email;
   }
 
   _add_sms(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_SMS] = value;
+    this.__dict_append[IDENT_KEY_SMS] = mobile_no;
   }
 
   _remove_sms(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_SMS] = value;
+    this.__dict_remove[IDENT_KEY_SMS] = mobile_no;
   }
 
   _add_whatsapp(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_WHATSAPP] = value;
+    this.__dict_append[IDENT_KEY_WHATSAPP] = mobile_no;
   }
 
   _remove_whatsapp(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_WHATSAPP] = value;
-  }
-
-  // android push methods
-  __check_androidpush_value(value, provider, caller) {
-    const [push_token, is_valid] = this.__check_ident_val_string(value, caller);
-    if (!is_valid) {
-      return [push_token, provider, false];
-    }
-    if (!provider) {
-      provider = "fcm";
-    }
-    if (typeof provider === "string") {
-      provider = provider.toLocaleLowerCase();
-    }
-    if (!["fcm", "xiaomi", "oppo"].includes(provider)) {
-      this.__errors.push(
-        `[${caller}] unsupported androidpush provider ${provider}`
-      );
-      return [push_token, provider, false];
-    }
-    return [push_token, provider, true];
-  }
-
-  _add_androidpush(push_token, provider = "fcm", caller) {
-    const [value, vendor, is_valid] = this.__check_androidpush_value(
-      push_token,
-      provider,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_ANDROIDPUSH] = value;
-    this.__dict_append[KEY_PUSHVENDOR] = vendor;
-  }
-
-  _remove_androidpush(push_token, provider = "fcm") {
-    const caller = "remove_androidpush";
-    const [value, vendor, is_valid] = this.__check_androidpush_value(
-      push_token,
-      provider,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_ANDROIDPUSH] = value;
-    this.__dict_remove[KEY_PUSHVENDOR] = vendor;
-  }
-
-  // ios push methods
-  __check_iospush_value(value, provider, caller) {
-    const [push_token, is_valid] = this.__check_ident_val_string(value, caller);
-    if (!is_valid) {
-      return [push_token, provider, false];
-    }
-    if (!provider) {
-      provider = "apns";
-    }
-    if (typeof provider === "string") {
-      provider = provider.toLocaleLowerCase();
-    }
-    if (!["apns"].includes(provider)) {
-      this.__errors.push(
-        `[${caller}] unsupported iospush provider ${provider}`
-      );
-      return [push_token, provider, false];
-    }
-    return [push_token, provider, true];
+    this.__dict_remove[IDENT_KEY_WHATSAPP] = mobile_no;
   }
 
-  _add_iospush(push_token, provider = "apns", caller) {
-    const [value, vendor, is_valid] = this.__check_iospush_value(
-      push_token,
-      provider,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_IOSPUSH] = value;
-    this.__dict_append[KEY_PUSHVENDOR] = vendor;
+  _add_androidpush(push_token, provider, caller) {
+    this.__dict_append[IDENT_KEY_ANDROIDPUSH] = push_token;
+    this.__dict_append[KEY_ID_PROVIDER] = provider;
   }
 
-  _remove_iospush(push_token, provider = "apns", caller) {
-    const [value, vendor, is_valid] = this.__check_iospush_value(
-      push_token,
-      provider,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_IOSPUSH] = value;
-    this.__dict_remove[KEY_PUSHVENDOR] = vendor;
+  _remove_androidpush(push_token, provider) {
+    this.__dict_remove[IDENT_KEY_ANDROIDPUSH] = push_token;
+    this.__dict_remove[KEY_ID_PROVIDER] = provider;
   }
 
-  // web push methods
-  __check_webpush_dict(value, provider, caller) {
-    if (!is_object(value)) {
-      this.__errors.push(
-        `[${caller}] value must be a valid dict representing webpush-token`
-      );
-      return [value, provider, false];
-    }
-    if (!provider) {
-      provider = "vapid";
-    }
-    if (typeof provider === "string") {
-      provider = provider.toLocaleLowerCase();
-    }
-    if (!["vapid"].includes(provider)) {
-      this.__errors.push(
-        `[${caller}] unsupported webpush provider ${provider}`
-      );
-      return [value, provider, false];
-    }
-    return [value, provider, true];
+  _add_iospush(push_token, provider, caller) {
+    this.__dict_append[IDENT_KEY_IOSPUSH] = push_token;
+    this.__dict_append[KEY_ID_PROVIDER] = provider;
   }
 
-  _add_webpush(push_token, provider = "vapid", caller) {
-    const [value, vendor, is_valid] = this.__check_webpush_dict(
-      push_token,
-      provider,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_WEBPUSH] = value;
-    this.__dict_append[KEY_PUSHVENDOR] = vendor;
+  _remove_iospush(push_token, provider, caller) {
+    this.__dict_remove[IDENT_KEY_IOSPUSH] = push_token;
+    this.__dict_remove[KEY_ID_PROVIDER] = provider;
   }
 
-  _remove_webpush(push_token, provider = "vapid", caller) {
-    const [value, vendor, is_valid] = this.__check_webpush_dict(
-      push_token,
-      provider,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_WEBPUSH] = value;
-    this.__dict_remove[KEY_PUSHVENDOR] = vendor;
+  _add_webpush(push_token, provider, caller) {
+    this.__dict_append[IDENT_KEY_WEBPUSH] = push_token;
+    this.__dict_append[KEY_ID_PROVIDER] = provider;
   }
 
-  __check_slack_dict(value, caller) {
-    const msg = "value must be a valid dict/json with proper keys";
-    if (!(value && value instanceof Object)) {
-      this.__errors.push(`[${caller}] ${msg}`);
-      return [value, false];
-    } else {
-      return [value, true];
-    }
+  _remove_webpush(push_token, provider, caller) {
+    this.__dict_remove[IDENT_KEY_WEBPUSH] = push_token;
+    this.__dict_remove[KEY_ID_PROVIDER] = provider;
   }
 
   _add_slack(value, caller) {
-    const [validated_value, is_valid] = this.__check_slack_dict(value, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_SLACK] = validated_value;
+    this.__dict_append[IDENT_KEY_SLACK] = value;
   }
 
   _remove_slack(value, caller) {
-    const [validated_value, is_valid] = this.__check_slack_dict(value, caller);
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_SLACK] = validated_value;
-  }
-
-  __check_ms_teams_dict(value, caller) {
-    const msg = "value must be a valid dict/json with proper keys";
-    if (!(value && value instanceof Object)) {
-      this.__errors.push(`[${caller}] ${msg}`);
-      return [value, false];
-    } else {
-      return [value, true];
-    }
+    this.__dict_remove[IDENT_KEY_SLACK] = value;
   }
 
   _add_ms_teams(value, caller) {
-    const [validated_value, is_valid] = this.__check_ms_teams_dict(
-      value,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_append[IDENT_KEY_MS_TEAMS] = validated_value;
+    this.__dict_append[IDENT_KEY_MS_TEAMS] = value;
   }
 
   _remove_ms_teams(value, caller) {
-    const [validated_value, is_valid] = this.__check_ms_teams_dict(
-      value,
-      caller
-    );
-    if (!is_valid) {
-      return;
-    }
-    this.__dict_remove[IDENT_KEY_MS_TEAMS] = validated_value;
+    this.__dict_remove[IDENT_KEY_MS_TEAMS] = value;
   }
 }

package/src/subscriber_list.js

@@ -10,8 +10,8 @@ import {
 import get_request_signature from "./signature";
 import axios from "axios";
 import {
-  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES,
-  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
+  BODY_MAX_APPARENT_SIZE_IN_BYTES,
+  BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
 } from "./constants";
 import get_attachment_json from "./attachment";
 
@@ -73,9 +73,9 @@ class SubscriberListBroadcast {
     }
     this.body = validate_list_broadcast_body_schema(this.body);
     const apparent_size = get_apparent_list_broadcast_body_size(this.body);
-    if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+    if (apparent_size > BODY_MAX_APPARENT_SIZE_IN_BYTES) {
       throw new InputValueError(
-        `SubscriberListBroadcast body too big - ${apparent_size} Bytes, must not cross ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
+        `SubscriberListBroadcast body too big - ${apparent_size} Bytes, must not cross ${BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
       );
     }
     return [this.body, apparent_size];