@suprsend/node-sdk 1.11.1 → 1.12.0

package/src/objects_api.js

@@ -0,0 +1,316 @@
+import { is_string, InputValueError, SuprsendApiError } from "./utils";
+import get_request_signature from "./signature";
+import axios from "axios";
+import ObjectEdit from "./object_edit";
+
+export default class ObjectsApi {
+  constructor(config) {
+    this.config = config;
+    this.list_url = `${this.config.base_url}v1/object/`;
+  }
+
+  get_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+      Date: new Date().toISOString(), // Adjust to your header date format
+    };
+  }
+
+  validate_object_type(object_type) {
+    if (!is_string(object_type)) {
+      throw new InputValueError("object_type must be a string");
+    }
+    object_type = object_type.trim();
+    if (!object_type) {
+      throw new InputValueError("missing object_type");
+    }
+    return object_type;
+  }
+
+  validate_object_id(object_id) {
+    if (!is_string(object_id)) {
+      throw new InputValueError("object_id must be a string");
+    }
+    object_id = object_id.trim();
+    if (!object_id) {
+      throw new InputValueError("missing object_id");
+    }
+    return object_id;
+  }
+
+  async list(object_type, options = {}) {
+    const params = new URLSearchParams(options).toString();
+    const validated_type = this.validate_object_type(object_type);
+    const encoded_type = encodeURIComponent(validated_type);
+    const url = `${this.list_url}${encoded_type}/?${params}`;
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  detail_url(object_type, object_id) {
+    const validated_type = this.validate_object_type(object_type);
+    const encoded_type = encodeURIComponent(validated_type);
+
+    const validated_id = this.validate_object_id(object_id);
+    const encoded_id = encodeURIComponent(validated_id);
+
+    return `${this.list_url}${encoded_type}/${encoded_id}/`;
+  }
+
+  async get(object_type, object_id) {
+    const url = this.detail_url(object_type, object_id);
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async upsert(object_type, object_id, object_payload = {}) {
+    const url = this.detail_url(object_type, object_id);
+    const headers = this.get_headers();
+    const content_text = JSON.stringify(object_payload || {});
+    const signature = get_request_signature(
+      url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(url, content_text, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async edit(object_type, object_id, edit_payload = {}) {
+    let url, payload;
+
+    if (object_type instanceof ObjectEdit) {
+      const edit_instance = object_type;
+      edit_instance.validate_body();
+      url = this.detail_url(
+        edit_instance.get_object_type(),
+        edit_instance.get_object_id()
+      );
+      payload = edit_instance.get_payload();
+    } else {
+      url = this.detail_url(object_type, object_id);
+      payload = edit_payload;
+    }
+
+    const content_text = JSON.stringify(payload || {});
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      url,
+      "PATCH",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.patch(url, content_text, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async delete(object_type, object_id) {
+    const url = this.detail_url(object_type, object_id);
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      url,
+      "DELETE",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.delete(url, { headers });
+      if (response.status >= 200 && response.status < 300) {
+        return { success: true, status_code: response.status };
+      } else {
+        throw new SuprsendApiError(response.statusText);
+      }
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async bulk_ops_url(object_type) {
+    const validatedType = this.validate_object_type(object_type);
+    const encodedType = encodeURIComponent(validatedType);
+
+    return `${this.config.base_url}v1/bulk/object/${encodedType}/`;
+  }
+
+  async bulk_delete(object_type, payload) {
+    const url = await this.bulk_ops_url(object_type);
+    const headers = this.get_headers();
+    payload = payload || {};
+    const content_text = JSON.stringify(payload);
+    const signature = get_request_signature(
+      url,
+      "DELETE",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.delete(url, {
+        headers: headers,
+        data: payload,
+      });
+      if (response.status >= 200 && response.status < 300) {
+        return { success: true, status_code: response.status };
+      } else {
+        throw new SuprsendApiError(response.statusText);
+      }
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async get_subscriptions(object_type, object_id, options = {}) {
+    const params = new URLSearchParams(options).toString();
+    const url = this.detail_url(object_type, object_id);
+    const subscription_url = `${url}subscription/?${params}`;
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      subscription_url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(subscription_url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async create_subscriptions(object_type, object_id, subscriptions) {
+    const url = this.detail_url(object_type, object_id);
+    const subscription_url = `${url}subscription/`;
+    const headers = this.get_headers();
+    subscriptions = subscriptions || {};
+    const content_text = JSON.stringify(subscriptions);
+    const signature = get_request_signature(
+      subscription_url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(subscription_url, content_text, {
+        headers,
+      });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async delete_subscriptions(object_type, object_id, subscriptions) {
+    const url = this.detail_url(object_type, object_id);
+    const subscription_url = `${url}subscription/`;
+    const headers = this.get_headers();
+    subscriptions = subscriptions || {};
+    const content_text = JSON.stringify(subscriptions);
+    const signature = get_request_signature(
+      subscription_url,
+      "DELETE",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.delete(subscription_url, {
+        headers: headers,
+        data: subscriptions,
+      });
+      if (response.status >= 200 && response.status < 300) {
+        return { success: true, status_code: response.status };
+      } else {
+        throw new SuprsendApiError(response.statusText);
+      }
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async get_objects_subscribed_to(object_type, object_id, options = {}) {
+    const params = new URLSearchParams(options).toString();
+    const url = this.detail_url(object_type, object_id);
+    const subscription_url = `${url}subscribed_to/object/?${params}`;
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      subscription_url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(subscription_url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  get_instance(object_type, object_id) {
+    const validated_type = this.validate_object_type(object_type);
+    const validated_id = this.validate_object_id(object_id);
+
+    return new ObjectEdit(this.config, validated_type, validated_id);
+  }
+}

package/src/subscriber.js

@@ -120,7 +120,8 @@ export class Subscriber {
       if (is_part_of_bulk) {
         console.log(err_msg);
       } else {
-        throw new InputValueError(err_msg);
+        // throw new InputValueError(err_msg);
+        console.log(err_msg);
       }
     }
     return this.__warnings_list;

package/src/subscriber_helper.js

@@ -1,11 +1,4 @@
-import {
-  is_object,
-  has_special_char,
-  epoch_milliseconds,
-  uuid,
-  is_empty,
-  is_string,
-} from "./utils";
+import { is_object, has_special_char, is_empty, is_string } from "./utils";
 import ALL_LANG_CODES from "./language_codes";
 
 // ---------- Identity keys
@@ -29,14 +22,14 @@ 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,
+  KEY_ID_PROVIDER,
   "$device_id",
   "$insert_id",
   "$time",
@@ -75,9 +68,6 @@ const ALL_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;
@@ -274,13 +264,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 +296,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);
@@ -339,31 +329,8 @@ export default class _SubscriberInternalHelper {
     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);
+    const [value, is_valid] = this.__check_ident_val_string(email, caller);
     if (!is_valid) {
       return;
     }
@@ -371,38 +338,15 @@ export default class _SubscriberInternalHelper {
   }
 
   _remove_email(email, caller) {
-    const [value, is_valid] = this.__validate_email(email, caller);
+    const [value, is_valid] = this.__check_ident_val_string(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];
-  }
-
   _add_sms(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
+    const [value, is_valid] = this.__check_ident_val_string(mobile_no, caller);
     if (!is_valid) {
       return;
     }
@@ -410,7 +354,7 @@ export default class _SubscriberInternalHelper {
   }
 
   _remove_sms(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
+    const [value, is_valid] = this.__check_ident_val_string(mobile_no, caller);
     if (!is_valid) {
       return;
     }
@@ -418,7 +362,7 @@ export default class _SubscriberInternalHelper {
   }
 
   _add_whatsapp(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
+    const [value, is_valid] = this.__check_ident_val_string(mobile_no, caller);
     if (!is_valid) {
       return;
     }
@@ -426,7 +370,7 @@ export default class _SubscriberInternalHelper {
   }
 
   _remove_whatsapp(mobile_no, caller) {
-    const [value, is_valid] = this.__validate_mobile_no(mobile_no, caller);
+    const [value, is_valid] = this.__check_ident_val_string(mobile_no, caller);
     if (!is_valid) {
       return;
     }
@@ -440,17 +384,11 @@ export default class _SubscriberInternalHelper {
       return [push_token, provider, false];
     }
     if (!provider) {
-      provider = "fcm";
+      provider = "";
     }
     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];
   }
 
@@ -464,7 +402,7 @@ export default class _SubscriberInternalHelper {
       return;
     }
     this.__dict_append[IDENT_KEY_ANDROIDPUSH] = value;
-    this.__dict_append[KEY_PUSHVENDOR] = vendor;
+    this.__dict_append[KEY_ID_PROVIDER] = vendor;
   }
 
   _remove_androidpush(push_token, provider = "fcm") {
@@ -478,7 +416,7 @@ export default class _SubscriberInternalHelper {
       return;
     }
     this.__dict_remove[IDENT_KEY_ANDROIDPUSH] = value;
-    this.__dict_remove[KEY_PUSHVENDOR] = vendor;
+    this.__dict_remove[KEY_ID_PROVIDER] = vendor;
   }
 
   // ios push methods
@@ -488,17 +426,11 @@ export default class _SubscriberInternalHelper {
       return [push_token, provider, false];
     }
     if (!provider) {
-      provider = "apns";
+      provider = "";
     }
     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];
   }
 
@@ -512,7 +444,7 @@ export default class _SubscriberInternalHelper {
       return;
     }
     this.__dict_append[IDENT_KEY_IOSPUSH] = value;
-    this.__dict_append[KEY_PUSHVENDOR] = vendor;
+    this.__dict_append[KEY_ID_PROVIDER] = vendor;
   }
 
   _remove_iospush(push_token, provider = "apns", caller) {
@@ -525,7 +457,7 @@ export default class _SubscriberInternalHelper {
       return;
     }
     this.__dict_remove[IDENT_KEY_IOSPUSH] = value;
-    this.__dict_remove[KEY_PUSHVENDOR] = vendor;
+    this.__dict_remove[KEY_ID_PROVIDER] = vendor;
   }
 
   // web push methods
@@ -537,17 +469,11 @@ export default class _SubscriberInternalHelper {
       return [value, provider, false];
     }
     if (!provider) {
-      provider = "vapid";
+      provider = "";
     }
     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];
   }
 
@@ -561,7 +487,7 @@ export default class _SubscriberInternalHelper {
       return;
     }
     this.__dict_append[IDENT_KEY_WEBPUSH] = value;
-    this.__dict_append[KEY_PUSHVENDOR] = vendor;
+    this.__dict_append[KEY_ID_PROVIDER] = vendor;
   }
 
   _remove_webpush(push_token, provider = "vapid", caller) {
@@ -574,7 +500,7 @@ export default class _SubscriberInternalHelper {
       return;
     }
     this.__dict_remove[IDENT_KEY_WEBPUSH] = value;
-    this.__dict_remove[KEY_PUSHVENDOR] = vendor;
+    this.__dict_remove[KEY_ID_PROVIDER] = vendor;
   }
 
   __check_slack_dict(value, caller) {