@suprsend/node-sdk 0.1.1 → 1.1.0

package/dist/request_json/workflow.json

@@ -6,6 +6,11 @@
   "$comment": "Json schema for workflow request",
   "type": "object",
   "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "unique id provided by client for request"
+    },
     "name": {
       "$ref": "#/definitions/non_empty_string",
       "description": "name of workflow"
@@ -71,6 +76,58 @@
         "pattern": "value in email format required. e.g. user@example.com"
       }
     },
+    "slack_setting": {
+      "type": "object",
+      "properties": {
+        "user_id": {
+          "type": "string",
+          "pattern": "^[uUwW][a-zA-Z0-9]+$",
+          "description": "slack member id of user",
+          "message": {
+            "required": "",
+            "pattern": "Slack Member id format: [U|W]XXXXXXXXX"
+          }
+        },
+        "email": { "$ref": "#/definitions/email_pattern" }
+      },
+      "additionalProperties": false
+    },
+    "androidpush_settings": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string",
+          "minLength": 1,
+          "description": "androidpush token"
+        },
+        "provider": {
+          "type": "string",
+          "enum": ["fcm", "xiaomi", "oppo"],
+          "description": "androidpush token provider(fcm/xiaomi)"
+        },
+        "device_id": { "type": ["string", "null"] }
+      },
+      "required": ["token", "provider"],
+      "additionalProperties": false
+    },
+    "iospush_settings": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string",
+          "minLength": 1,
+          "description": "iospush token"
+        },
+        "provider": {
+          "type": "string",
+          "enum": ["apns"],
+          "description": "iospush token provider(apns)"
+        },
+        "device_id": { "type": ["string", "null"] }
+      },
+      "required": ["token", "provider"],
+      "additionalProperties": false
+    },
     "user_setting": {
       "type": "object",
       "properties": {
@@ -79,12 +136,31 @@
           "minLength": 1,
           "description": "distinct_id: Id which uniquely identify a user in your app"
         },
+        "$channels": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "androidpush",
+              "iospush",
+              "webpush",
+              "email",
+              "sms",
+              "whatsapp",
+              "slack",
+              "inbox",
+              "messenger"
+            ]
+          },
+          "minItems": 0,
+          "description": "user preferred channels. notification will be tried only on specified channels e.g ['email', 'sms']"
+        },
         "$email": {
           "oneOf": [
             { "$ref": "#/definitions/email_pattern" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/email_pattern" }
@@ -96,7 +172,7 @@
             { "$ref": "#/definitions/mobile_number_pattern" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/mobile_number_pattern" }
@@ -105,10 +181,18 @@
         },
         "$androidpush": {
           "oneOf": [
+            { "$ref": "#/definitions/androidpush_settings" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/androidpush_settings" }
+            },
             { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/non_empty_string" }
@@ -117,10 +201,18 @@
         },
         "$iospush": {
           "oneOf": [
+            { "$ref": "#/definitions/iospush_settings" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/iospush_settings" }
+            },
             { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/non_empty_string" }
@@ -132,7 +224,7 @@
             { "$ref": "#/definitions/mobile_number_pattern" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/mobile_number_pattern" }
@@ -144,19 +236,31 @@
             { "type": "object", "minProperties": 1 },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "type": "object", "minProperties": 1 }
             }
           ]
         },
+        "$slack": {
+          "oneOf": [
+            { "$ref": "#/definitions/slack_setting" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/slack_setting" }
+            }
+          ]
+        },
         "$inbox": {
           "oneOf": [
             { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/non_empty_string" }
@@ -168,7 +272,7 @@
             { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
-              "uniqueItems": true,
+              "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
               "items": { "$ref": "#/definitions/non_empty_string" }
@@ -207,7 +311,10 @@
               "webpush",
               "email",
               "sms",
-              "whatsapp"
+              "whatsapp",
+              "slack",
+              "inbox",
+              "messenger"
             ]
           },
           "minItems": 0,

package/dist/{identity.js → subscriber.js}

@@ -5,16 +5,18 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
+exports["default"] = exports.Subscriber = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -25,7 +27,9 @@ var _signature = _interopRequireDefault(require("./signature"));
 
 var _axios = _interopRequireDefault(require("axios"));
 
-var _identity_helper = _interopRequireDefault(require("./identity_helper"));
+var _subscriber_helper = _interopRequireDefault(require("./subscriber_helper"));
+
+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; }
 
@@ -37,15 +41,20 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
-var UserIdentityFactory = /*#__PURE__*/function () {
-  function UserIdentityFactory(config) {
-    (0, _classCallCheck2["default"])(this, UserIdentityFactory);
+var SubscriberFactory = /*#__PURE__*/function () {
+  function SubscriberFactory(config) {
+    (0, _classCallCheck2["default"])(this, SubscriberFactory);
     this.config = config;
   }
 
-  (0, _createClass2["default"])(UserIdentityFactory, [{
+  (0, _createClass2["default"])(SubscriberFactory, [{
     key: "new_user",
     value: function new_user(distinct_id) {
+      return this.get_instance(distinct_id);
+    }
+  }, {
+    key: "get_instance",
+    value: function get_instance(distinct_id) {
       if (!(0, _utils.is_string)(distinct_id)) {
         throw new _utils.SuprsendError("distinct_id must be a string. an Id which uniquely identify a user in your app");
       }
@@ -56,17 +65,17 @@ var UserIdentityFactory = /*#__PURE__*/function () {
         throw new _utils.SuprsendError("distinct_id must be passed");
       }
 
-      return new UserIdentity(this.config, distinct_id);
+      return new Subscriber(this.config, distinct_id);
     }
   }]);
-  return UserIdentityFactory;
+  return SubscriberFactory;
 }();
 
-exports["default"] = UserIdentityFactory;
+exports["default"] = SubscriberFactory;
 
-var UserIdentity = /*#__PURE__*/function () {
-  function UserIdentity(config, distinct_id) {
-    (0, _classCallCheck2["default"])(this, UserIdentity);
+var Subscriber = /*#__PURE__*/function () {
+  function Subscriber(config, distinct_id) {
+    (0, _classCallCheck2["default"])(this, Subscriber);
     this.config = config;
     this.distinct_id = distinct_id;
     this.__url = this.__get_url();
@@ -75,11 +84,12 @@ var UserIdentity = /*#__PURE__*/function () {
     this.__info = [];
     this._append_count = 0;
     this._remove_count = 0;
+    this._unset_count = 0;
     this._events = [];
-    this._helper = new _identity_helper["default"](distinct_id, config.env_key);
+    this._helper = new _subscriber_helper["default"](distinct_id, config.workspace_key);
   }
 
-  (0, _createClass2["default"])(UserIdentity, [{
+  (0, _createClass2["default"])(Subscriber, [{
     key: "__get_url",
     value: function __get_url() {
       var url_template = "event/";
@@ -111,9 +121,9 @@ var UserIdentity = /*#__PURE__*/function () {
       };
     }
   }, {
-    key: "__get_events",
-    value: function __get_events() {
-      var all_events = this._events;
+    key: "events",
+    value: function events() {
+      var all_events = (0, _toConsumableArray2["default"])(this._events);
 
       var _iterator = _createForOfIteratorHelper(all_events),
           _step;
@@ -129,86 +139,143 @@ var UserIdentity = /*#__PURE__*/function () {
         _iterator.f();
       }
 
-      if (this._append_count > 0) {
+      if (all_events.length === 0 || this._append_count > 0) {
         var user_identify_event = {
           $insert_id: (0, _utils.uuid)(),
           $time: (0, _utils.epoch_milliseconds)(),
-          env: this.config.env_key,
+          env: this.config.workspace_key,
           event: "$identify",
           properties: _objectSpread({
-            $anon_id: this.distinct_id,
             $identified_id: this.distinct_id
-          }, this.__super_properties)
+          }, this.__supr_props)
         };
-        all_events.push(user_identify_event);
+        all_events = [user_identify_event].concat((0, _toConsumableArray2["default"])(all_events));
       }
 
       return all_events;
     }
   }, {
-    key: "__validate_body",
-    value: function __validate_body() {
+    key: "validate_event_size",
+    value: function validate_event_size(event_dict) {
+      var apparent_size = (0, _utils.get_apparent_identity_event_size)(event_dict);
+
+      if (apparent_size > _constants.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+        throw new _utils.SuprsendError("User Event size too big - ".concat(apparent_size, " Bytes, must not cross ").concat(_constants.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
+      }
+
+      return [event_dict, apparent_size];
+    }
+  }, {
+    key: "validate_body",
+    value: function validate_body() {
+      var is_part_of_bulk = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+      var warnings_list = [];
+
       if (!(0, _utils.is_empty)(this.__info)) {
-        console.log("WARNING: " + this.__info.join("\n"));
+        var msg = "[distinct_id: ".concat(this.distinct_id, "]").concat(this.__info.join("\n"));
+        warnings_list.push(msg);
+        console.log("WARNING: ".concat(msg));
       }
 
       if (!(0, _utils.is_empty)(this.__errors)) {
-        throw new _utils.SuprsendError("ERROR: " + this.__errors.join("\n"));
-      }
+        var _msg = "[distinct_id: ".concat(this.distinct_id, "] ").concat(this.__errors.join("\n"));
+
+        warnings_list.push(_msg);
+        var err_msg = "ERROR: ".concat(_msg);
 
-      if ((0, _utils.is_empty)(this._events)) {
-        throw new _utils.SuprsendError("ERROR: no user properties have been edited. Use user.append/remove/unset method to update user properties");
+        if (is_part_of_bulk) {
+          console.log(err_msg);
+        } else {
+          throw new _utils.SuprsendError(err_msg);
+        }
       }
+
+      return warnings_list;
     }
   }, {
     key: "save",
     value: function () {
       var _save = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
-        var headers, events, content_text, signature, response;
+        var is_part_of_bulk, headers, events, _iterator2, _step2, ev, _this$validate_event_, _this$validate_event_2, validated_ev, size, content_text, signature, response, ok_response;
+
         return _regenerator["default"].wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                this.__validate_body();
-
+                is_part_of_bulk = false;
+                this.validate_body(is_part_of_bulk);
                 headers = this.__get_headers();
-                events = this.__get_events();
+                events = this.events();
+                _iterator2 = _createForOfIteratorHelper(events);
+
+                try {
+                  for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+                    ev = _step2.value;
+                    _this$validate_event_ = this.validate_event_size(ev), _this$validate_event_2 = (0, _slicedToArray2["default"])(_this$validate_event_, 2), validated_ev = _this$validate_event_2[0], size = _this$validate_event_2[1];
+                  }
+                } catch (err) {
+                  _iterator2.e(err);
+                } finally {
+                  _iterator2.f();
+                }
+
                 content_text = JSON.stringify(events);
 
                 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 = 5;
-                _context.next = 8;
+                _context.prev = 8;
+                _context.next = 11;
                 return _axios["default"].post(this.__url, content_text, {
                   headers: headers
                 });
 
-              case 8:
+              case 11:
                 response = _context.sent;
+                ok_response = Math.floor(response.status / 100) == 2;
+
+                if (!ok_response) {
+                  _context.next = 17;
+                  break;
+                }
+
                 return _context.abrupt("return", {
-                  status_code: response.status,
                   success: true,
+                  status: "success",
+                  status_code: response.status,
+                  message: response.statusText
+                });
+
+              case 17:
+                return _context.abrupt("return", {
+                  success: false,
+                  status: "fail",
+                  status_code: response.status,
                   message: response.statusText
                 });
 
-              case 12:
-                _context.prev = 12;
-                _context.t0 = _context["catch"](5);
+              case 18:
+                _context.next = 23;
+                break;
+
+              case 20:
+                _context.prev = 20;
+                _context.t0 = _context["catch"](8);
                 return _context.abrupt("return", {
-                  status_code: 400,
                   success: false,
+                  status: "fail",
+                  status_code: _context.t0.status || 500,
                   message: _context.t0.message
                 });
 
-              case 15:
+              case 23:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, this, [[5, 12]]);
+        }, _callee, this, [[8, 20]]);
       }));
 
       function save() {
@@ -297,6 +364,40 @@ var UserIdentity = /*#__PURE__*/function () {
       }
     }
   }, {
+    key: "unset",
+    value: function unset(key) {
+      var caller = "unset";
+
+      if (!(0, _utils.is_string)(key) && !Array.isArray(key)) {
+        this.__errors.push("[".concat(caller, "] key must be either string or array"));
+
+        return;
+      }
+
+      if ((0, _utils.is_string)(key)) {
+        this._helper._unset_k(key, caller);
+
+        this._collect_event();
+      } else {
+        var _iterator3 = _createForOfIteratorHelper(key),
+            _step3;
+
+        try {
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var item = _step3.value;
+
+            this._helper._unset_k(item, caller);
+          }
+        } catch (err) {
+          _iterator3.e(err);
+        } finally {
+          _iterator3.f();
+        }
+
+        this._collect_event();
+      }
+    }
+  }, {
     key: "add_email",
     value: function add_email(email) {
       var caller = "add_email";
@@ -408,10 +509,54 @@ var UserIdentity = /*#__PURE__*/function () {
 
       this._helper._remove_webpush(push_token, provider, caller);
 
+      this._collect_event();
+    }
+  }, {
+    key: "add_slack_email",
+    value: function add_slack_email(value) {
+      var caller = "add_slack_email";
+
+      this._helper._add_slack({
+        email: value
+      }, caller);
+
+      this._collect_event();
+    }
+  }, {
+    key: "remove_slack_email",
+    value: function remove_slack_email(value) {
+      var caller = "remove_slack_email";
+
+      this._helper._remove_slack({
+        email: value
+      }, caller);
+
+      this._collect_event();
+    }
+  }, {
+    key: "add_slack_userid",
+    value: function add_slack_userid(value) {
+      var caller = "add_slack_userid";
+
+      this._helper._add_slack({
+        user_id: value
+      }, caller);
+
+      this._collect_event();
+    }
+  }, {
+    key: "remove_slack_userid",
+    value: function remove_slack_userid(value) {
+      var caller = "remove_slack_userid";
+
+      this._helper._remove_slack({
+        user_id: value
+      }, caller);
+
       this._collect_event();
     }
   }]);
-  return UserIdentity;
+  return Subscriber;
 }();
 
-module.exports = exports.default;
+exports.Subscriber = Subscriber;