@suprsend/node-sdk 1.1.2 → 1.3.0

package/dist/workflows_bulk.js

@@ -75,18 +75,7 @@ var _BulkWorkflowsChunk = /*#__PURE__*/function () {
   (0, _createClass2["default"])(_BulkWorkflowsChunk, [{
     key: "__get_url",
     value: function __get_url() {
-      var 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";
-        }
-      }
-
-      var url_formatted = "".concat(this.config.base_url).concat(this.config.workspace_key).concat(url_template);
-      return url_formatted;
+      return "".concat(this.config.base_url).concat(this.config.workspace_key, "/trigger/");
     }
   }, {
     key: "__common_headers",
@@ -159,20 +148,16 @@ var _BulkWorkflowsChunk = /*#__PURE__*/function () {
             switch (_context.prev = _context.next) {
               case 0:
                 headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
-                content_text = JSON.stringify(this.__chunk); // Based on whether signature is required or not, add Authorization header
-
-                if (this.config.auth_enabled) {
-                  signature = (0, _signature["default"])(this.__url, "POST", content_text, headers, this.config.workspace_secret);
-                  headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
-                }
-
-                _context.prev = 3;
-                _context.next = 6;
+                content_text = JSON.stringify(this.__chunk);
+                signature = (0, _signature["default"])(this.__url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context.prev = 4;
+                _context.next = 7;
                 return _axios["default"].post(this.__url, content_text, {
                   headers: headers
                 });
 
-              case 6:
+              case 7:
                 response = _context.sent;
                 ok_response = Math.floor(response.status / 100) == 2;
 
@@ -202,12 +187,12 @@ var _BulkWorkflowsChunk = /*#__PURE__*/function () {
                   };
                 }
 
-                _context.next = 15;
+                _context.next = 16;
                 break;
 
-              case 11:
-                _context.prev = 11;
-                _context.t0 = _context["catch"](3);
+              case 12:
+                _context.prev = 12;
+                _context.t0 = _context["catch"](4);
                 error_status = _context.t0.status || 500;
                 return _context.abrupt("return", {
                   status: "fail",
@@ -225,12 +210,12 @@ var _BulkWorkflowsChunk = /*#__PURE__*/function () {
                   })
                 });
 
-              case 15:
+              case 16:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, this, [[3, 11]]);
+        }, _callee, this, [[4, 12]]);
       }));
 
       function trigger() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/node-sdk",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "Suprsend Node SDK to trigger workflow from backend",
   "main": "dist/index.js",
   "scripts": {

package/src/constants.js

@@ -26,7 +26,7 @@ export const ALLOW_ATTACHMENTS_IN_BULK_API = true;
 export const ATTACHMENT_UPLOAD_ENABLED = false;
 
 // -- single Identity event limit
-export const IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = 2 * 1024;
-export const IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = "2KB";
+export const IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = 10 * 1024;
+export const IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = "10KB";
 
 export const MAX_IDENTITY_EVENTS_IN_BULK_API = 400;

package/src/event.js

@@ -1,5 +1,4 @@
 import {
-  is_object,
   is_string,
   SuprsendError,
   has_special_char,
@@ -130,15 +129,7 @@ export class EventCollector {
   }
 
   __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";
-      }
-    }
-    return `${this.config.base_url}${url_template}`;
+    return `${this.config.base_url}event/`;
   }
 
   __common_headers() {
@@ -161,16 +152,15 @@ export class EventCollector {
   async send(event) {
     const headers = { ...this.__headers, ...this.__dynamic_headers() };
     const content_text = JSON.stringify(event);
-    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;

package/src/events_bulk.js

@@ -36,15 +36,7 @@ class _BulkEventsChunk {
   }
 
   __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}`;
+    const url_formatted = `${this.config.base_url}event/`;
     return url_formatted;
   }
 
@@ -105,17 +97,16 @@ class _BulkEventsChunk {
   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;

package/src/index.js

@@ -6,6 +6,10 @@ import Event, { EventCollector } from "./event";
 import { BulkEventsFactory } from "./events_bulk";
 import SubscriberFactory from "./subscriber";
 import BulkSubscribersFactory from "./subscribers_bulk";
+import {
+  SubscribersListApi,
+  SubscribersListBroadcast,
+} from "./subscribers_list";
 import BrandsApi from "./brands";
 import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
@@ -18,8 +22,6 @@ class Suprsend {
     this.config = config;
 
     this.base_url = this._get_url(config.base_url);
-    this.auth_enabled = config.auth_enabled !== false;
-    this.include_signature_param = config.include_signature_param !== false;
     this.user_agent = `suprsend/${
       package_json.version
     };node/${process.version.slice(1)}`;
@@ -34,6 +36,7 @@ class Suprsend {
     this._user = new SubscriberFactory(this);
 
     this.brands = new BrandsApi(this);
+    this.subscribers_list = new SubscribersListApi(this);
 
     this._validate();
   }
@@ -126,4 +129,4 @@ class Suprsend {
   }
 }
 
-export { Suprsend, Event, Workflow };
+export { Suprsend, Event, Workflow, SubscribersListBroadcast };

package/src/request_json/list_broadcast.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://github.com/suprsend/suprsend-node-sdk/request_json/list_broadcast.json",
+  "title": "list_broadcast_request",
+  "description": "Json schema for list_broadcast request",
+  "$comment": "Json schema for list_broadcast request",
+  "type": "object",
+  "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "unique id provided by client for request"
+    },
+    "brand_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "brand id for workflow to be run in context of a brand"
+    },
+    "$insert_id": {
+      "type": "string",
+      "minLength": 36,
+      "description": "unique uuid generated per request"
+    },
+    "$time": {
+      "type": "integer",
+      "minimum": 1640995200000,
+      "description": "Timestamp: unix epoch in milliseconds"
+    },
+    "list_id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SubscriberList id"
+    },
+    "template": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Template"
+    },
+    "notification_category": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Notification category"
+    },
+    "delay": {
+      "type": ["string", "integer"],
+      "minimum": 0,
+      "description": "If string: format [XX]d[XX]h[XX]m[XX]s e.g 1d2h30m10s(for 1day 2hours 30minutes 10sec). If integer: value in number of seconds"
+    },
+    "trigger_at": {
+      "type": "string",
+      "description": "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
+    },
+    "data": {
+      "type": "object",
+      "description": "variables to be used in workflow. e.g replacing templates variables."
+    }
+  },
+  "required": [
+    "$insert_id",
+    "$time",
+    "list_id",
+    "template",
+    "notification_category",
+    "data"
+  ],
+  "definitions": {
+    "non_empty_string": {
+      "type": "string",
+      "minLength": 2
+    }
+  }
+}

package/src/subscriber.js

@@ -44,31 +44,16 @@ export class Subscriber {
     this.config = config;
     this.distinct_id = distinct_id;
     this.__url = this.__get_url();
-    this.__supr_props = this.__super_properties();
+    this.__super_props = this.__super_properties();
 
     this.__errors = [];
     this.__info = [];
-    this._append_count = 0;
-    this._remove_count = 0;
-    this._set_count = 0;
-    this._unset_count = 0;
-    this._events = [];
-    this._helper = new _SubscriberInternalHelper(
-      distinct_id,
-      config.workspace_key
-    );
+    this.user_operations = [];
+    this._helper = new _SubscriberInternalHelper();
   }
 
   __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";
-      }
-    }
-    return `${this.config.base_url}${url_template}`;
+    return `${this.config.base_url}event/`;
   }
 
   __get_headers() {
@@ -85,30 +70,16 @@ export class Subscriber {
     };
   }
 
-  events() {
-    let all_events = [...this._events];
-    for (let e of all_events) {
-      e["properties"] = this.__supr_props;
-    }
-
-    if (
-      all_events.length === 0 ||
-      this._append_count > 0 ||
-      this._set_count > 0
-    ) {
-      const user_identify_event = {
-        $insert_id: uuid(),
-        $time: epoch_milliseconds(),
-        env: this.config.workspace_key,
-        event: "$identify",
-        properties: {
-          $identified_id: this.distinct_id,
-          ...this.__supr_props,
-        },
-      };
-      all_events = [user_identify_event, ...all_events];
-    }
-    return all_events;
+  get_events() {
+    return {
+      $schema: "2",
+      $insert_id: uuid(),
+      $time: epoch_milliseconds(),
+      env: this.config.workspace_key,
+      distinct_id: this.distinct_id,
+      $user_operations: this.user_operations,
+      properties: this.__super_props,
+    };
   }
 
   validate_event_size(event_dict) {
@@ -147,22 +118,19 @@ export class Subscriber {
     const is_part_of_bulk = false;
     this.validate_body(is_part_of_bulk);
     const headers = this.__get_headers();
-    const events = this.events();
-    for (let ev of events) {
-      const [validated_ev, size] = this.validate_event_size(ev);
-    }
+    const event = this.get_events();
+    const [validated_ev, size] = this.validate_event_size(event);
+    const content_text = JSON.stringify(validated_ev);
+
+    const signature = get_request_signature(
+      this.__url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
 
-    const content_text = JSON.stringify(events);
-    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}`;
-    }
     try {
       const response = await axios.post(this.__url, content_text, { headers });
       const ok_response = Math.floor(response.status / 100) == 2;
@@ -200,11 +168,7 @@ export class Subscriber {
       this.__info = [...this.__info, ...resp["info"]];
     }
     if (!is_empty(resp["event"])) {
-      this._events.push(resp["event"]);
-      this._set_count += resp["set"];
-      this._append_count += resp["append"];
-      this._remove_count += resp["remove"];
-      this._unset_count += resp["unset"];
+      this.user_operations.push(resp["event"]);
     }
   }
 

package/src/subscriber_helper.js

@@ -80,16 +80,12 @@ export default class _SubscriberInternalHelper {
     this.workspace_key = workspace_key;
 
     this.__dict_set = {};
-    this.__set_count = 0;
 
     this.__dict_append = {};
-    this.__append_count = 0;
 
     this.__dict_remove = {};
-    this.__remove_count = 0;
 
     this.__list_unset = [];
-    this.__unset_count = 0;
 
     this.__errors = [];
     this.__info = [];
@@ -97,17 +93,9 @@ export default class _SubscriberInternalHelper {
 
   reset() {
     this.__dict_set = {};
-    this.__set_count = 0;
-
     this.__dict_append = {};
-    this.__append_count = 0;
-
     this.__dict_remove = {};
-    this.__remove_count = 0;
-
     this.__list_unset = [];
-    this.__unset_count = 0;
-
     this.__errors = [];
     this.__info = [];
   }
@@ -118,48 +106,26 @@ export default class _SubscriberInternalHelper {
       errors: this.__errors,
       info: this.__info,
       event: evt,
-      set: this.__set_count,
-      append: this.__append_count,
-      remove: this.__remove_count,
-      unset: this.__unset_count,
     };
     this.reset();
     return ret_val;
   }
 
   __form_event() {
-    if (
-      !is_empty(this.__dict_set) ||
-      !is_empty(this.__dict_append) ||
-      !is_empty(this.__dict_remove) ||
-      !is_empty(this.__list_unset)
-    ) {
-      let event = {
-        $insert_id: uuid(),
-        $time: epoch_milliseconds(),
-        env: this.workspace_key,
-        distinct_id: this.distinct_id,
-      };
-      if (!is_empty(this.__dict_set)) {
-        event["$set"] = this.__dict_set;
-        this.__set_count += 1;
-      }
-      if (!is_empty(this.__dict_append)) {
-        event["$append"] = this.__dict_append;
-        this.__append_count += 1;
-      }
-      if (!is_empty(this.__dict_remove)) {
-        event["$remove"] = this.__dict_remove;
-        this.__remove_count += 1;
-      }
-      if (!is_empty(this.__list_unset)) {
-        event["$unset"] = this.__list_unset;
-        this.__unset_count += 1;
-      }
-      return event;
-    } else {
-      return;
+    const event = {};
+    if (!is_empty(this.__dict_set)) {
+      event["$set"] = this.__dict_set;
+    }
+    if (!is_empty(this.__dict_append)) {
+      event["$append"] = this.__dict_append;
+    }
+    if (!is_empty(this.__dict_remove)) {
+      event["$remove"] = this.__dict_remove;
     }
+    if (!is_empty(this.__list_unset)) {
+      event["$unset"] = this.__list_unset;
+    }
+    return event;
   }
 
   __validate_key_basic(key, caller) {
@@ -240,33 +206,25 @@ export default class _SubscriberInternalHelper {
   }
 
   __add_identity(key, value, args, caller) {
+    const new_caller = `${caller}:${key}`;
     switch (key) {
       case IDENT_KEY_EMAIL:
-        this._add_email(value, caller);
+        this._add_email(value, new_caller);
         break;
       case IDENT_KEY_SMS:
-        this._add_sms(value, caller);
+        this._add_sms(value, new_caller);
         break;
       case IDENT_KEY_WHATSAPP:
-        this._add_whatsapp(value, caller);
+        this._add_whatsapp(value, new_caller);
         break;
       case IDENT_KEY_ANDROIDPUSH:
-        this._add_androidpush(value, args[KEY_PUSHVENDOR], caller);
-        if (this.__dict_append[KEY_PUSHVENDOR]) {
-          args[KEY_PUSHVENDOR] = this.__dict_append[KEY_PUSHVENDOR];
-        }
+        this._add_androidpush(value, args[KEY_PUSHVENDOR], new_caller);
         break;
       case IDENT_KEY_IOSPUSH:
-        this._add_iospush(value, args[KEY_PUSHVENDOR], caller);
-        if (this.__dict_append[KEY_PUSHVENDOR]) {
-          args[KEY_PUSHVENDOR] = this.__dict_append[KEY_PUSHVENDOR];
-        }
+        this._add_iospush(value, args[KEY_PUSHVENDOR], new_caller);
         break;
       case IDENT_KEY_WEBPUSH:
-        this._add_webpush(value, args[KEY_PUSHVENDOR], caller);
-        if (this.__dict_append[KEY_PUSHVENDOR]) {
-          args[KEY_PUSHVENDOR] = this.__dict_append[KEY_PUSHVENDOR];
-        }
+        this._add_webpush(value, args[KEY_PUSHVENDOR], new_caller);
         break;
       case IDENT_KEY_SLACK:
         this._add_slack(value, caller);
@@ -277,33 +235,25 @@ export default class _SubscriberInternalHelper {
   }
 
   __remove_identity(key, value, args, caller) {
+    const new_caller = `${caller}:${key}`;
     switch (key) {
       case IDENT_KEY_EMAIL:
-        this._remove_email(value, caller);
+        this._remove_email(value, new_caller);
         break;
       case IDENT_KEY_SMS:
-        this._remove_sms(value, caller);
+        this._remove_sms(value, new_caller);
         break;
       case IDENT_KEY_WHATSAPP:
-        this._remove_whatsapp(value, caller);
+        this._remove_whatsapp(value, new_caller);
         break;
       case IDENT_KEY_ANDROIDPUSH:
-        this._remove_androidpush(value, args[KEY_PUSHVENDOR], caller);
-        if (this.__dict_remove[KEY_PUSHVENDOR]) {
-          args[KEY_PUSHVENDOR] = this.__dict_remove[KEY_PUSHVENDOR];
-        }
+        this._remove_androidpush(value, args[KEY_PUSHVENDOR], new_caller);
         break;
       case IDENT_KEY_IOSPUSH:
-        this._remove_iospush(value, args[KEY_PUSHVENDOR], caller);
-        if (this.__dict_remove[KEY_PUSHVENDOR]) {
-          args[KEY_PUSHVENDOR] = this.__dict_remove[KEY_PUSHVENDOR];
-        }
+        this._remove_iospush(value, args[KEY_PUSHVENDOR], new_caller);
         break;
       case IDENT_KEY_WEBPUSH:
-        this._remove_webpush(value, args[KEY_PUSHVENDOR], caller);
-        if (this.__dict_remove[KEY_PUSHVENDOR]) {
-          args[KEY_PUSHVENDOR] = this.__dict_remove[KEY_PUSHVENDOR];
-        }
+        this._remove_webpush(value, args[KEY_PUSHVENDOR], new_caller);
         break;
       case IDENT_KEY_SLACK:
         this._remove_slack(val, caller);
@@ -430,6 +380,9 @@ export default class _SubscriberInternalHelper {
     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}`
@@ -475,6 +428,9 @@ export default class _SubscriberInternalHelper {
     if (!provider) {
       provider = "apns";
     }
+    if (typeof provider === "string") {
+      provider = provider.toLocaleLowerCase();
+    }
     if (!["apns"].includes(provider)) {
       this.__errors.push(
         `[${caller}] unsupported iospush provider ${provider}`
@@ -521,6 +477,9 @@ export default class _SubscriberInternalHelper {
     if (!provider) {
       provider = "vapid";
     }
+    if (typeof provider === "string") {
+      provider = provider.toLocaleLowerCase();
+    }
     if (!["vapid"].includes(provider)) {
       this.__errors.push(
         `[${caller}] unsupported webpush provider ${provider}`