@suprsend/node-sdk 0.1.1 → 1.1.0

package/dist/attachment.js

@@ -0,0 +1,59 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = get_attachment_json;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _mimeTypes = _interopRequireDefault(require("mime-types"));
+
+var _utils = require("./utils");
+
+function check_is_web_url() {
+  var file_path = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "";
+  return file_path.startsWith("http://") || file_path.startsWith("https://");
+}
+
+function get_attachment_json_for_file(file_path, file_name, ignore_if_error) {
+  var abs_path = _path["default"].resolve((0, _utils.resolveTilde)(file_path));
+
+  var final_file_name = _path["default"].basename(abs_path);
+
+  if (file_name && file_name.trim()) {
+    final_file_name = file_name.trim();
+  }
+
+  return {
+    filename: final_file_name,
+    contentType: _mimeTypes["default"].lookup(abs_path),
+    data: (0, _utils.base64Encode)(abs_path),
+    url: null,
+    ignore_if_error: ignore_if_error
+  };
+}
+
+function get_attachment_json_for_url(file_url, file_name, ignore_if_error) {
+  return {
+    filename: file_name,
+    contentType: null,
+    data: null,
+    url: file_url,
+    ignore_if_error: ignore_if_error
+  };
+}
+
+function get_attachment_json(file_path, file_name) {
+  var ignore_if_error = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+
+  if (check_is_web_url(file_path)) {
+    return get_attachment_json_for_url(file_path, file_name, ignore_if_error);
+  } else {
+    return get_attachment_json_for_file(file_path, file_name, ignore_if_error);
+  }
+}
+
+module.exports = exports.default;

package/dist/bulk_response.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var BulkResponse = /*#__PURE__*/function () {
+  function BulkResponse() {
+    (0, _classCallCheck2["default"])(this, BulkResponse);
+    this.status;
+    this.failed_records = [];
+    this.total = 0;
+    this.success = 0;
+    this.failure = 0;
+    this.warnings = [];
+  }
+
+  (0, _createClass2["default"])(BulkResponse, [{
+    key: "merge_chunk_response",
+    value: function merge_chunk_response(ch_resp) {
+      if (!ch_resp) {
+        return;
+      } // possible status: success/partial/fail
+
+
+      if (!this.status) {
+        this.status = ch_resp["status"];
+      } else {
+        if (this.status === "success") {
+          if (ch_resp.status === "fail") {
+            this.status = "partial";
+          }
+        } else if (this.status === "fail") {
+          if (ch_resp.status === "success") {
+            this.status = "partial";
+          }
+        }
+      }
+
+      this.total += ch_resp.total || 0;
+      this.success += ch_resp.success || 0;
+      this.failure += ch_resp.failure || 0;
+      var failed_recs = ch_resp.failed_records || [];
+      this.failed_records = [].concat((0, _toConsumableArray2["default"])(this.failed_records), (0, _toConsumableArray2["default"])(failed_recs));
+    }
+  }]);
+  return BulkResponse;
+}();
+
+exports["default"] = BulkResponse;
+module.exports = exports.default;

package/dist/constants.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES = exports.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = exports.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = exports.MAX_WORKFLOWS_IN_BULK_API = exports.MAX_IDENTITY_EVENTS_IN_BULK_API = exports.MAX_EVENTS_IN_BULK_API = exports.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = exports.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = exports.DEFAULT_URL = exports.DEFAULT_UAT_URL = exports.BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE = exports.BODY_MAX_APPARENT_SIZE_IN_BYTES = exports.ATTACHMENT_URL_POTENTIAL_SIZE_IN_BYTES = exports.ATTACHMENT_UPLOAD_ENABLED = exports.ALLOW_ATTACHMENTS_IN_BULK_API = void 0;
+//  Default urls
+var DEFAULT_URL = "https://hub.suprsend.com/";
+exports.DEFAULT_URL = DEFAULT_URL;
+var DEFAULT_UAT_URL = "https://collector-staging.suprsend.workers.dev/"; //  an Event should not have apparent body size of more than 100KB
+
+exports.DEFAULT_UAT_URL = DEFAULT_UAT_URL;
+var SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = 100 * 1024; // 100 * 1024
+
+exports.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES;
+var SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = "100KB"; // a API call should not have apparent body size of more than 800KB
+
+exports.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE;
+var BODY_MAX_APPARENT_SIZE_IN_BYTES = 800 * 1024; // 800 * 1024
+
+exports.BODY_MAX_APPARENT_SIZE_IN_BYTES = BODY_MAX_APPARENT_SIZE_IN_BYTES;
+var BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE = "800KB"; // in general url-size wont exceed 2048 chars or 2048 utf-8 bytes
+
+exports.BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE = BODY_MAX_APPARENT_SIZE_IN_BYTES_READABLE;
+var ATTACHMENT_URL_POTENTIAL_SIZE_IN_BYTES = 2100; // few keys added in-flight, amounting to almost 200 bytes increase per workflow-body
+
+exports.ATTACHMENT_URL_POTENTIAL_SIZE_IN_BYTES = ATTACHMENT_URL_POTENTIAL_SIZE_IN_BYTES;
+var WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES = 200; // max workflow-records in one bulk api call.
+
+exports.WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES = WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES;
+var MAX_WORKFLOWS_IN_BULK_API = 100; // max event-records in one bulk api call
+
+exports.MAX_WORKFLOWS_IN_BULK_API = MAX_WORKFLOWS_IN_BULK_API;
+var MAX_EVENTS_IN_BULK_API = 100;
+exports.MAX_EVENTS_IN_BULK_API = MAX_EVENTS_IN_BULK_API;
+var ALLOW_ATTACHMENTS_IN_BULK_API = true;
+exports.ALLOW_ATTACHMENTS_IN_BULK_API = ALLOW_ATTACHMENTS_IN_BULK_API;
+var ATTACHMENT_UPLOAD_ENABLED = false; // -- single Identity event limit
+
+exports.ATTACHMENT_UPLOAD_ENABLED = ATTACHMENT_UPLOAD_ENABLED;
+var IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = 2 * 1024;
+exports.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES = IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES;
+var IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = "2KB";
+exports.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE = IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE;
+var MAX_IDENTITY_EVENTS_IN_BULK_API = 400;
+exports.MAX_IDENTITY_EVENTS_IN_BULK_API = MAX_IDENTITY_EVENTS_IN_BULK_API;

package/dist/event.js

@@ -5,12 +5,14 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
+exports["default"] = exports.EventCollector = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -21,25 +23,139 @@ var _utils = require("./utils");
 
 var _signature = _interopRequireDefault(require("./signature"));
 
-var _jsonschema = require("jsonschema");
-
 var _axios = _interopRequireDefault(require("axios"));
 
+var _attachment = _interopRequireDefault(require("./attachment"));
+
+var _constants = require("./constants");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-var event_schema = require("./request_json/event.json");
-
 var RESERVED_EVENT_NAMES = ["$identify", "$notification_delivered", "$notification_dismiss", "$notification_clicked", "$app_launched", "$user_login", "$user_logout"];
 
+var Event = /*#__PURE__*/function () {
+  function Event(distinct_id, event_name, properties) {
+    var kwargs = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+    (0, _classCallCheck2["default"])(this, Event);
+    this.distinct_id = distinct_id;
+    this.event_name = event_name;
+    this.properties = properties;
+    this.idempotency_key = kwargs === null || kwargs === void 0 ? void 0 : kwargs.idempotency_key; // --- validate
+
+    this.__validate_distinct_id();
+
+    this.__validate_event_name();
+
+    this.__validate_properties();
+  }
+
+  (0, _createClass2["default"])(Event, [{
+    key: "__validate_distinct_id",
+    value: function __validate_distinct_id() {
+      if (this.distinct_id instanceof String) {
+        throw new _utils.SuprsendError("distinct_id must be a string. an Id which uniquely identify a user in your app");
+      }
+
+      var distinct_id = this.distinct_id.trim();
+
+      if (!distinct_id) {
+        throw new _utils.SuprsendError("distinct_id missing");
+      }
+
+      this.distinct_id = distinct_id;
+    }
+  }, {
+    key: "__validate_properties",
+    value: function __validate_properties() {
+      if (!this.properties) {
+        this.properties = {};
+      }
+
+      if (!(this.properties instanceof Object)) {
+        throw new _utils.SuprsendError("properties must be a dictionary");
+      }
+    }
+  }, {
+    key: "__check_event_prefix",
+    value: function __check_event_prefix(event_name) {
+      if (!RESERVED_EVENT_NAMES.includes(event_name)) {
+        if ((0, _utils.has_special_char)(event_name)) {
+          throw new _utils.SuprsendError("event_names starting with [$,ss_] are reserved by SuprSend");
+        }
+      }
+    }
+  }, {
+    key: "__validate_event_name",
+    value: function __validate_event_name() {
+      if (!(0, _utils.is_string)(this.event_name)) {
+        throw new _utils.SuprsendError("event_name must be a string");
+      }
+
+      var event_name = this.event_name.trim();
+
+      this.__check_event_prefix(event_name);
+
+      this.event_name = event_name;
+    }
+  }, {
+    key: "add_attachment",
+    value: function add_attachment(file_path) {
+      var _kwargs$ignore_if_err;
+
+      var kwargs = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var file_name = kwargs === null || kwargs === void 0 ? void 0 : kwargs.file_name;
+      var ignore_if_error = (_kwargs$ignore_if_err = kwargs === null || kwargs === void 0 ? void 0 : kwargs.ignore_if_error) !== null && _kwargs$ignore_if_err !== void 0 ? _kwargs$ignore_if_err : false;
+      var attachment = (0, _attachment["default"])(file_path, file_name, ignore_if_error); // --- add the attachment to properties->$attachments
+
+      if (!this.properties["$attachments"]) {
+        this.properties["$attachments"] = [];
+      }
+
+      this.properties["$attachments"].push(attachment);
+    }
+  }, {
+    key: "get_final_json",
+    value: function get_final_json(config) {
+      var is_part_of_bulk = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+      var super_props = {
+        $ss_sdk_version: config.user_agent
+      };
+      var event_dict = {
+        $insert_id: (0, _utils.uuid)(),
+        $time: (0, _utils.epoch_milliseconds)(),
+        event: this.event_name,
+        env: config.workspace_key,
+        distinct_id: this.distinct_id,
+        properties: _objectSpread(_objectSpread({}, this.properties), super_props)
+      };
+
+      if (this.idempotency_key) {
+        event_dict["$idempotency_key"] = this.idempotency_key;
+      }
+
+      event_dict = (0, _utils.validate_track_event_schema)(event_dict);
+      var apparent_size = (0, _utils.get_apparent_event_size)(event_dict, is_part_of_bulk);
+
+      if (apparent_size > _constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+        throw new _utils.SuprsendError("Event size too big - ".concat(apparent_size, " Bytes,must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
+      }
+
+      return [event_dict, apparent_size];
+    }
+  }]);
+  return Event;
+}();
+
+exports["default"] = Event;
+
 var EventCollector = /*#__PURE__*/function () {
   function EventCollector(config) {
     (0, _classCallCheck2["default"])(this, EventCollector);
     this.config = config;
     this.__url = this.__get_url();
     this.__headers = this.__common_headers();
-    this.__supr_props = this.__super_properties();
   }
 
   (0, _createClass2["default"])(EventCollector, [{
@@ -72,81 +188,21 @@ var EventCollector = /*#__PURE__*/function () {
         Date: new Date().toUTCString()
       };
     }
-  }, {
-    key: "__super_properties",
-    value: function __super_properties() {
-      return {
-        $ss_sdk_version: this.config.user_agent
-      };
-    }
-  }, {
-    key: "__check_event_prefix",
-    value: function __check_event_prefix(event_name) {
-      if (!RESERVED_EVENT_NAMES.includes(event_name)) {
-        if ((0, _utils.has_special_char)(event_name)) {
-          throw new _utils.SuprsendError("event_names starting with [$,ss_] are reserved");
-        }
-      }
-    }
-  }, {
-    key: "__validate_event_name",
-    value: function __validate_event_name(event_name) {
-      if (!(0, _utils.is_string)(event_name)) {
-        throw new _utils.SuprsendError("event_name must be a string");
-      }
-
-      event_name = event_name.trim();
-
-      this.__check_event_prefix(event_name);
-
-      return event_name;
-    }
-  }, {
-    key: "validate_track_event_schema",
-    value: function validate_track_event_schema(data) {
-      if (!data["properties"]) {
-        data["properties"] = {};
-      }
-
-      var schema = event_schema;
-      var v = new _jsonschema.Validator();
-      var validated_data = v.validate(data, schema);
-
-      if (validated_data.valid) {
-        return data;
-      } else {
-        var error_obj = validated_data.errors[0];
-        var error_msg = "".concat(error_obj.property, " ").concat(error_obj.message);
-        throw new _utils.SuprsendError(error_msg);
-      }
-    }
   }, {
     key: "collect",
-    value: function collect(distinct_id, event_name) {
-      var properties = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-      event_name = this.__validate_event_name(event_name);
+    value: function collect(event) {
+      var _event$get_final_json = event.get_final_json(this.config, false),
+          _event$get_final_json2 = (0, _slicedToArray2["default"])(_event$get_final_json, 2),
+          event_dict = _event$get_final_json2[0],
+          event_size = _event$get_final_json2[1];
 
-      if (!(0, _utils.is_object)(properties)) {
-        throw new _utils.SuprsendError("properties must be a dictionary");
-      }
-
-      properties = _objectSpread(_objectSpread({}, properties), this.__supr_props);
-      var event = {
-        $insert_id: (0, _utils.uuid)(),
-        $time: (0, _utils.epoch_milliseconds)(),
-        event: event_name,
-        env: this.config.env_key,
-        distinct_id: distinct_id,
-        properties: properties
-      };
-      event = this.validate_track_event_schema(event);
-      return this.send(event);
+      return this.send(event_dict);
     }
   }, {
     key: "send",
     value: function () {
       var _send = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(event) {
-        var headers, content_text, signature, response;
+        var headers, content_text, signature, response, ok_response;
         return _regenerator["default"].wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
@@ -155,8 +211,8 @@ var EventCollector = /*#__PURE__*/function () {
                 content_text = JSON.stringify(event);
 
                 if (this.config.auth_enabled) {
-                  signature = (0, _signature["default"])(this.__url, "POST", content_text, headers, this.config.env_secret);
-                  headers["Authorization"] = "".concat(this.config.env_key, ":").concat(signature);
+                  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;
@@ -167,27 +223,48 @@ var EventCollector = /*#__PURE__*/function () {
 
               case 6:
                 response = _context.sent;
+                ok_response = Math.floor(response.status / 100) == 2;
+
+                if (!ok_response) {
+                  _context.next = 12;
+                  break;
+                }
+
                 return _context.abrupt("return", {
-                  status_code: response.status,
                   success: true,
+                  status: "success",
+                  status_code: response.status,
                   message: response.statusText
                 });
 
-              case 10:
-                _context.prev = 10;
+              case 12:
+                return _context.abrupt("return", {
+                  success: false,
+                  status: "fail",
+                  status_code: response.status,
+                  message: response.statusText
+                });
+
+              case 13:
+                _context.next = 18;
+                break;
+
+              case 15:
+                _context.prev = 15;
                 _context.t0 = _context["catch"](3);
                 return _context.abrupt("return", {
-                  status_code: 400,
                   success: false,
+                  status: "fail",
+                  status_code: _context.t0.status || 500,
                   message: _context.t0.message
                 });
 
-              case 13:
+              case 18:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, this, [[3, 10]]);
+        }, _callee, this, [[3, 15]]);
       }));
 
       function send(_x) {
@@ -200,6 +277,4 @@ var EventCollector = /*#__PURE__*/function () {
   return EventCollector;
 }();
 
-var _default = EventCollector;
-exports["default"] = _default;
-module.exports = exports.default;
+exports.EventCollector = EventCollector;