@suprsend/node-sdk 1.1.2 → 1.3.0

package/src/subscribers_bulk.js

@@ -2,7 +2,6 @@ import {
   IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES,
   IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
   BODY_MAX_APPARENT_SIZE_IN_BYTES,
-  BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
   MAX_IDENTITY_EVENTS_IN_BULK_API,
 } from "./constants";
 import get_request_signature from "./signature";
@@ -34,16 +33,7 @@ class _BulkSubscribersChunk {
   }
 
   __get_url() {
-    let url_template = "event/";
-    if (this.config.include_signature_param) {
-      if (this.config.auth_enabled) {
-        url_template = url_template + "?verify=true";
-      } else {
-        url_template = url_template + "?verify=false";
-      }
-    }
-    const url_formatted = `${this.config.base_url}${url_template}`;
-    return url_formatted;
+    return `${this.config.base_url}event/`;
   }
 
   __common_headers() {
@@ -100,17 +90,16 @@ class _BulkSubscribersChunk {
   async trigger() {
     const headers = { ...this.__headers, ...this.__dynamic_headers() };
     const content_text = JSON.stringify(this.__chunk);
-    // Based on whether signature is required or not, add Authorization header
-    if (this.config.auth_enabled) {
-      const signature = get_request_signature(
-        this.__url,
-        "POST",
-        content_text,
-        headers,
-        this.config.workspace_secret
-      );
-      headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
-    }
+
+    const signature = get_request_signature(
+      this.__url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
     try {
       const response = await axios.post(this.__url, content_text, { headers });
       const ok_response = Math.floor(response.status / 100) == 2;
@@ -175,11 +164,9 @@ class BulkSubscribers {
       if (warnings_list) {
         this.response.warnings = [...this.response.warnings, ...warnings_list];
       }
-      const ev_arr = sub.events();
-      for (let ev of ev_arr) {
-        const [ev_json, body_size] = sub.validate_event_size(ev);
-        this.__pending_records.push([ev_json, body_size]);
-      }
+      const ev = sub.get_events();
+      const [ev_json, body_size] = sub.validate_event_size(ev);
+      this.__pending_records.push([ev_json, body_size]);
     }
   }
 
@@ -204,7 +191,7 @@ class BulkSubscribers {
     }
     for (let sub of subscribers) {
       if (!sub) {
-        throw new SuprsendError("null/empty element found in bulk instance");
+        continue;
       }
       if (!(sub instanceof Subscriber)) {
         throw new SuprsendError(

package/src/subscribers_list.js

@@ -0,0 +1,296 @@
+import {
+  SuprsendError,
+  SuprsendApiError,
+  validate_list_broadcast_body_schema,
+  get_apparent_list_broadcast_body_size,
+  uuid,
+  epoch_milliseconds,
+} from "./utils";
+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,
+} from "./constants";
+
+class SubscribersListBroadcast {
+  constructor(body, kwargs = {}) {
+    if (!(body instanceof Object)) {
+      throw new SuprsendError("broadcast body must be a json/dictionary");
+    }
+    this.body = body;
+    this.idempotency_key = kwargs?.idempotency_key;
+    this.brand_id = kwargs?.brand_id;
+  }
+
+  get_final_json() {
+    this.body["$insert_id"] = uuid();
+    this.body["$time"] = epoch_milliseconds();
+    if (this.idempotency_key) {
+      this.body["$idempotency_key"] = this.idempotency_key;
+    }
+    if (this.brand_id) {
+      this.body["brand_id"] = this.brand_id;
+    }
+    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) {
+      throw new SuprsendError(
+        `SubscriberListBroadcast body too big - ${apparent_size} Bytes, must not cross ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
+      );
+    }
+    return [this.body, apparent_size];
+  }
+}
+
+class SubscribersListApi {
+  constructor(config) {
+    this.config = config;
+    this.subscriber_list_url = `${this.config.base_url}v1/subscriber_list/`;
+    this.broadcast_url = `${this.config.base_url}${this.config.workspace_key}/broadcast/`;
+    this.__headers = this.__common_headers();
+    this.non_error_default_response = { success: true };
+  }
+
+  __common_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+    };
+  }
+
+  __dynamic_headers() {
+    return {
+      Date: new Date().toUTCString(),
+    };
+  }
+
+  _validate_list_id(list_id) {
+    if (typeof list_id != "string") {
+      throw new SuprsendError("list_id must be a string");
+    }
+    let cleaned_list_id = list_id.trim();
+    if (!cleaned_list_id) {
+      throw new SuprsendError("missing list_id");
+    }
+    return list_id;
+  }
+
+  async create(payload) {
+    if (!payload) {
+      throw new SuprsendError("missing payload");
+    }
+    let list_id = payload["list_id"];
+    if (!list_id) {
+      throw new SuprsendError("missing list_id in payload");
+    }
+    list_id = this._validate_list_id(list_id);
+    payload["list_id"] = list_id;
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify(payload);
+
+    const signature = get_request_signature(
+      this.subscriber_list_url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(
+        this.subscriber_list_url,
+        content_text,
+        { headers }
+      );
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  cleaned_limit_offset(limit, offset) {
+    let cleaned_limit =
+      typeof limit === "number" && limit > 0 && limit <= 1000 ? limit : 20;
+    let cleaned_offset = typeof offset === "number" && offset >= 0 ? offset : 0;
+    return [cleaned_limit, cleaned_offset];
+  }
+
+  async get_all(kwargs = {}) {
+    let limit = kwargs?.limit;
+    let offset = kwargs?.offset;
+    const [cleaned_limit, cleaner_offset] = this.cleaned_limit_offset(
+      limit,
+      offset
+    );
+    const final_url_obj = new URL(`${this.config.base_url}v1/subscriber_list`);
+    final_url_obj.searchParams.append("limit", cleaned_limit);
+    final_url_obj.searchParams.append("offset", cleaner_offset);
+    const url = final_url_obj.href;
+
+    const headers = { ...this.__headers, ...this.__dynamic_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);
+    }
+  }
+
+  __subscriber_list_detail_url(list_id) {
+    return `${this.config.base_url}v1/subscriber_list/${list_id}/`;
+  }
+
+  async get(list_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+
+    const url = this.__subscriber_list_detail_url(cleaned_list_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_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 add(list_id, distinct_ids) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    if (!Array.isArray(distinct_ids)) {
+      throw new SuprsendError("distinct_ids must be list of strings");
+    }
+    if (distinct_ids.length === 0) {
+      return this.non_error_default_response;
+    }
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}subscriber/add`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({ distinct_ids: distinct_ids });
+
+    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 remove(list_id, distinct_ids = []) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    if (!Array.isArray(distinct_ids)) {
+      throw new SuprsendError("distinct_ids must be list of strings");
+    }
+    if (distinct_ids.length === 0) {
+      return this.non_error_default_response;
+    }
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}subscriber/remove`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({ distinct_ids: distinct_ids });
+
+    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 broadcast(broadcast_instance) {
+  //   if (!(broadcast_instance instanceof SubscribersListBroadcast)) {
+  //     throw new SuprsendError(
+  //       "argument must be an instance of suprsend.SubscriberListBroadcast"
+  //     );
+  //   }
+  //   const [broadcast_body, body_size] = broadcast_instance.get_final_json(
+  //     this.config
+  //   );
+  //   const headers = { ...this.__headers, ...this.__dynamic_headers() };
+  //   const content_text = JSON.stringify(broadcast_body);
+
+  //   const signature = get_request_signature(
+  //     this.broadcast_url,
+  //     "POST",
+  //     content_text,
+  //     headers,
+  //     this.config.workspace_secret
+  //   );
+  //   headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+  //   try {
+  //     const response = await axios.post(this.broadcast_url, content_text, {
+  //       headers,
+  //     });
+  //     const ok_response = Math.floor(response.status / 100) == 2;
+  //     if (ok_response) {
+  //       return {
+  //         success: true,
+  //         status: "success",
+  //         status_code: response.status,
+  //         message: response.statusText,
+  //       };
+  //     } else {
+  //       return {
+  //         success: false,
+  //         status: "fail",
+  //         status_code: response.status,
+  //         message: response.statusText,
+  //       };
+  //     }
+  //   } catch (err) {
+  //     return {
+  //       success: false,
+  //       status: "fail",
+  //       status_code: err.status || 500,
+  //       message: err.message,
+  //     };
+  //   }
+  // }
+}
+
+export { SubscribersListApi, SubscribersListBroadcast };

package/src/utils.js

@@ -12,6 +12,7 @@ import { cloneDeep } from "lodash";
 
 const workflow_schema = require("./request_json/workflow.json");
 const event_schema = require("./request_json/event.json");
+const list_broadcast_schema = require("./request_json/list_broadcast.json");
 
 export function base64Encode(file) {
   var body = fs.readFileSync(file);
@@ -122,6 +123,25 @@ export function validate_track_event_schema(body) {
   }
 }
 
+export function validate_list_broadcast_body_schema(body) {
+  if (!body?.data) {
+    body.data = {};
+  }
+  if (!(body.data instanceof Object)) {
+    throw new SuprsendError("data must be a object");
+  }
+  const schema = list_broadcast_schema;
+  var v = new Validator();
+  const validated_data = v.validate(body, schema);
+  if (validated_data.valid) {
+    return body;
+  } else {
+    const error_obj = validated_data.errors[0];
+    const error_msg = `${error_obj.property} ${error_obj.message}`;
+    throw new SuprsendError(error_msg);
+  }
+}
+
 export function get_apparent_workflow_body_size(body, is_part_of_bulk) {
   let extra_bytes = WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES;
   let apparent_body = body;
@@ -199,6 +219,11 @@ export function get_apparent_event_size(event, is_part_of_bulk) {
 }
 
 export function get_apparent_identity_event_size(event) {
-  const body_size = JSON.stringify(event);
+  const body_size = JSON.stringify(event).length;
+  return body_size;
+}
+
+export function get_apparent_list_broadcast_body_size(body) {
+  const body_size = JSON.stringify(body).length;
   return body_size;
 }

package/src/workflow.js

@@ -71,16 +71,7 @@ export class _WorkflowTrigger {
   }
 
   _get_url() {
-    let url_template = "/trigger/";
-    if (this.config.include_signature_param) {
-      if (this.config.auth_enabled) {
-        url_template = url_template + "?verify=true";
-      } else {
-        url_template = url_template + "?verify=false";
-      }
-    }
-    const url_formatted = `${this.config.base_url}${this.config.workspace_key}${url_template}`;
-    return url_formatted;
+    return `${this.config.base_url}${this.config.workspace_key}/trigger/`;
   }
 
   _get_headers() {
@@ -103,16 +94,15 @@ export class _WorkflowTrigger {
   async send(workflow_body) {
     const headers = this._get_headers();
     const content_text = JSON.stringify(workflow_body);
-    if (this.config.auth_enabled) {
-      const signature = get_request_signature(
-        this.url,
-        "POST",
-        content_text,
-        headers,
-        this.config.workspace_secret
-      );
-      headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
-    }
+
+    const signature = get_request_signature(
+      this.url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
 
     try {
       const response = await axios.post(this.url, content_text, { headers });

package/src/workflows_bulk.js

@@ -36,16 +36,7 @@ class _BulkWorkflowsChunk {
   }
 
   __get_url() {
-    let url_template = "/trigger/";
-    if (this.config.include_signature_param) {
-      if (this.config.auth_enabled) {
-        url_template = url_template + "?verify=true";
-      } else {
-        url_template = url_template + "?verify=false";
-      }
-    }
-    const url_formatted = `${this.config.base_url}${this.config.workspace_key}${url_template}`;
-    return url_formatted;
+    return `${this.config.base_url}${this.config.workspace_key}/trigger/`;
   }
 
   __common_headers() {
@@ -105,17 +96,16 @@ class _BulkWorkflowsChunk {
   async trigger() {
     const headers = { ...this.__headers, ...this.__dynamic_headers() };
     const content_text = JSON.stringify(this.__chunk);
-    // Based on whether signature is required or not, add Authorization header
-    if (this.config.auth_enabled) {
-      const signature = get_request_signature(
-        this.__url,
-        "POST",
-        content_text,
-        headers,
-        this.config.workspace_secret
-      );
-      headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
-    }
+
+    const signature = get_request_signature(
+      this.__url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
     try {
       const response = await axios.post(this.__url, content_text, { headers });
       const ok_response = Math.floor(response.status / 100) == 2;