@suprsend/node-sdk 1.1.1 → 1.1.2

package/dist/brands.js

@@ -0,0 +1,245 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _signature = _interopRequireDefault(require("./signature"));
+
+var _utils = require("./utils");
+
+var _axios = _interopRequireDefault(require("axios"));
+
+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 BrandsApi = /*#__PURE__*/function () {
+  function BrandsApi(config) {
+    (0, _classCallCheck2["default"])(this, BrandsApi);
+    this.config = config;
+    this.list_url = this.__list_url();
+    this.__headers = this.__common_headers();
+  }
+
+  (0, _createClass2["default"])(BrandsApi, [{
+    key: "__list_url",
+    value: function __list_url() {
+      var list_uri_template = "".concat(this.config.base_url, "v1/brand/");
+      return list_uri_template;
+    }
+  }, {
+    key: "__common_headers",
+    value: function __common_headers() {
+      return {
+        "Content-Type": "application/json; charset=utf-8",
+        "User-Agent": this.config.user_agent
+      };
+    }
+  }, {
+    key: "cleaned_limit_offset",
+    value: function cleaned_limit_offset(limit, offset) {
+      var cleaned_limit = typeof limit === "number" && limit > 0 && limit <= 1000 ? limit : 20;
+      var cleaned_offset = typeof offset === "number" && offset >= 0 ? offset : 0;
+      return [cleaned_limit, cleaned_offset];
+    }
+  }, {
+    key: "__dynamic_headers",
+    value: function __dynamic_headers() {
+      return {
+        Date: new Date().toUTCString()
+      };
+    }
+  }, {
+    key: "list",
+    value: function () {
+      var _list = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+        var kwargs,
+            limit,
+            offset,
+            _this$cleaned_limit_o,
+            _this$cleaned_limit_o2,
+            cleaned_limit,
+            cleaner_offset,
+            final_url_obj,
+            final_url_string,
+            headers,
+            signature,
+            response,
+            _args = arguments;
+
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                kwargs = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+                limit = kwargs === null || kwargs === void 0 ? void 0 : kwargs.limit;
+                offset = kwargs === null || kwargs === void 0 ? void 0 : kwargs.offset;
+                _this$cleaned_limit_o = this.cleaned_limit_offset(limit, offset), _this$cleaned_limit_o2 = (0, _slicedToArray2["default"])(_this$cleaned_limit_o, 2), cleaned_limit = _this$cleaned_limit_o2[0], cleaner_offset = _this$cleaned_limit_o2[1];
+                final_url_obj = new URL(this.list_url);
+                final_url_obj.searchParams.append("limit", cleaned_limit);
+                final_url_obj.searchParams.append("offset", cleaner_offset);
+                final_url_string = final_url_obj.href;
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                signature = (0, _signature["default"])(final_url_string, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context.prev = 11;
+                _context.next = 14;
+                return _axios["default"].get(final_url_string, {
+                  headers: headers
+                });
+
+              case 14:
+                response = _context.sent;
+                return _context.abrupt("return", response.data);
+
+              case 18:
+                _context.prev = 18;
+                _context.t0 = _context["catch"](11);
+                throw new _utils.SuprsendApiError(_context.t0);
+
+              case 21:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this, [[11, 18]]);
+      }));
+
+      function list() {
+        return _list.apply(this, arguments);
+      }
+
+      return list;
+    }()
+  }, {
+    key: "detail_url",
+    value: function detail_url() {
+      var brand_id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "";
+      var cleaned_brand_id = brand_id.toString().trim();
+      var brand_id_encoded = encodeURI(cleaned_brand_id);
+      var url = "".concat(this.list_url).concat(brand_id_encoded, "/");
+      return url;
+    }
+  }, {
+    key: "get",
+    value: function () {
+      var _get = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+        var brand_id,
+            url,
+            headers,
+            signature,
+            response,
+            _args2 = arguments;
+        return _regenerator["default"].wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                brand_id = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : "";
+                url = this.detail_url(brand_id);
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                signature = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context2.prev = 5;
+                _context2.next = 8;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+
+              case 8:
+                response = _context2.sent;
+                return _context2.abrupt("return", response.data);
+
+              case 12:
+                _context2.prev = 12;
+                _context2.t0 = _context2["catch"](5);
+                throw new _utils.SuprsendApiError(_context2.t0);
+
+              case 15:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2, this, [[5, 12]]);
+      }));
+
+      function get() {
+        return _get.apply(this, arguments);
+      }
+
+      return get;
+    }()
+  }, {
+    key: "upsert",
+    value: function () {
+      var _upsert = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3() {
+        var brand_id,
+            brand_payload,
+            url,
+            headers,
+            content_text,
+            signature,
+            response,
+            _args3 = arguments;
+        return _regenerator["default"].wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                brand_id = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : "";
+                brand_payload = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+                url = this.detail_url(brand_id);
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                content_text = JSON.stringify(brand_payload);
+                signature = (0, _signature["default"])(url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context3.prev = 7;
+                _context3.next = 10;
+                return _axios["default"].post(url, content_text, {
+                  headers: headers
+                });
+
+              case 10:
+                response = _context3.sent;
+                return _context3.abrupt("return", response.data);
+
+              case 14:
+                _context3.prev = 14;
+                _context3.t0 = _context3["catch"](7);
+                throw new _utils.SuprsendApiError(_context3.t0);
+
+              case 17:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3, this, [[7, 14]]);
+      }));
+
+      function upsert() {
+        return _upsert.apply(this, arguments);
+      }
+
+      return upsert;
+    }()
+  }]);
+  return BrandsApi;
+}();
+
+var _default = BrandsApi;
+exports["default"] = _default;
+module.exports = exports.default;

package/dist/event.js

@@ -42,7 +42,8 @@ var Event = /*#__PURE__*/function () {
     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.idempotency_key = kwargs === null || kwargs === void 0 ? void 0 : kwargs.idempotency_key;
+    this.brand_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.brand_id; // --- validate
 
     this.__validate_distinct_id();
 
@@ -135,6 +136,10 @@ var Event = /*#__PURE__*/function () {
         event_dict["$idempotency_key"] = this.idempotency_key;
       }
 
+      if (this.brand_id) {
+        event_dict["brand_id"] = this.brand_id;
+      }
+
       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);
 

package/dist/index.js

@@ -41,6 +41,8 @@ var _subscriber = _interopRequireDefault(require("./subscriber"));
 
 var _subscribers_bulk = _interopRequireDefault(require("./subscribers_bulk"));
 
+var _brands = _interopRequireDefault(require("./brands"));
+
 var _constants = require("./constants");
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -66,6 +68,7 @@ var Suprsend = /*#__PURE__*/function () {
     this._bulk_events = new _events_bulk.BulkEventsFactory(this);
     this._bulk_users = new _subscribers_bulk["default"](this);
     this._user = new _subscriber["default"](this);
+    this.brands = new _brands["default"](this);
 
     this._validate();
   }

package/dist/request_json/event.json

@@ -11,6 +11,11 @@
       "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,

package/dist/request_json/workflow.json

@@ -11,6 +11,11 @@
       "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"
+    },
     "name": {
       "$ref": "#/definitions/non_empty_string",
       "description": "name of workflow"

package/dist/signature.js

@@ -15,14 +15,15 @@ function get_path(url) {
 }
 
 function get_request_signature(url, http_verb, content, headers, secret) {
-  if (http_verb === "GET") {
-    return "";
-  }
+  var content_md5 = "";
+  var content_type = headers["Content-Type"] || "";
 
-  var content_md5 = _crypto["default"].createHash("md5").update(content).digest("hex");
+  if (content) {
+    content_md5 = _crypto["default"].createHash("md5").update(content).digest("hex");
+  }
 
   var request_uri = get_path(url);
-  var sign_string = http_verb + "\n" + content_md5 + "\n" + headers["Content-Type"] + "\n" + headers["Date"] + "\n" + request_uri;
+  var sign_string = http_verb + "\n" + content_md5 + "\n" + content_type + "\n" + headers["Date"] + "\n" + request_uri;
 
   var hash = _crypto["default"].createHmac("sha256", secret).update(sign_string);
 

package/dist/utils.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SuprsendError = exports.SuprsendConfigError = void 0;
+exports.SuprsendError = exports.SuprsendConfigError = exports.SuprsendApiError = void 0;
 exports.base64Encode = base64Encode;
 exports.epoch_milliseconds = epoch_milliseconds;
 exports.get_apparent_event_size = get_apparent_event_size;
@@ -114,6 +114,33 @@ var SuprsendConfigError = /*#__PURE__*/function (_Error2) {
 
 exports.SuprsendConfigError = SuprsendConfigError;
 
+var SuprsendApiError = /*#__PURE__*/function (_Error3) {
+  (0, _inherits2["default"])(SuprsendApiError, _Error3);
+
+  var _super3 = _createSuper(SuprsendApiError);
+
+  function SuprsendApiError(error) {
+    var _this3;
+
+    (0, _classCallCheck2["default"])(this, SuprsendApiError);
+    var message;
+
+    if (error.response) {
+      message = "".concat(error.response.status, ": ").concat(error.response.data.message);
+    } else {
+      message = error.message;
+    }
+
+    _this3 = _super3.call(this, message);
+    _this3.name = "SuprsendApiError";
+    return _this3;
+  }
+
+  return SuprsendApiError;
+}( /*#__PURE__*/(0, _wrapNativeSuper2["default"])(Error));
+
+exports.SuprsendApiError = SuprsendApiError;
+
 function is_string(value) {
   return typeof value === "string";
 }

package/dist/workflow.js

@@ -38,6 +38,7 @@ var Workflow = /*#__PURE__*/function () {
 
     this.body = body;
     this.idempotency_key = kwargs === null || kwargs === void 0 ? void 0 : kwargs.idempotency_key;
+    this.brand_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.brand_id;
   }
 
   (0, _createClass2["default"])(Workflow, [{
@@ -76,6 +77,10 @@ var Workflow = /*#__PURE__*/function () {
         this.body["$idempotency_key"] = this.idempotency_key;
       }
 
+      if (this.brand_id) {
+        this.body["brand_id"] = this.brand_id;
+      }
+
       this.body = (0, _utils.validate_workflow_body_schema)(this.body);
       var apparent_size = (0, _utils.get_apparent_workflow_body_size)(this.body, is_part_of_bulk); // review
 

package/package.json

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

package/src/brands.js

@@ -0,0 +1,120 @@
+import get_request_signature from "./signature";
+import { SuprsendApiError } from "./utils";
+import axios from "axios";
+
+class BrandsApi {
+  constructor(config) {
+    this.config = config;
+    this.list_url = this.__list_url();
+    this.__headers = this.__common_headers();
+  }
+
+  __list_url() {
+    const list_uri_template = `${this.config.base_url}v1/brand/`;
+    return list_uri_template;
+  }
+
+  __common_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+    };
+  }
+
+  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];
+  }
+
+  __dynamic_headers() {
+    return {
+      Date: new Date().toUTCString(),
+    };
+  }
+
+  async list(kwargs = {}) {
+    const limit = kwargs?.limit;
+    const offset = kwargs?.offset;
+    const [cleaned_limit, cleaner_offset] = this.cleaned_limit_offset(
+      limit,
+      offset
+    );
+    const final_url_obj = new URL(this.list_url);
+    final_url_obj.searchParams.append("limit", cleaned_limit);
+    final_url_obj.searchParams.append("offset", cleaner_offset);
+    const final_url_string = final_url_obj.href;
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+
+    const signature = get_request_signature(
+      final_url_string,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(final_url_string, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  detail_url(brand_id = "") {
+    const cleaned_brand_id = brand_id.toString().trim();
+    const brand_id_encoded = encodeURI(cleaned_brand_id);
+    const url = `${this.list_url}${brand_id_encoded}/`;
+    return url;
+  }
+
+  async get(brand_id = "") {
+    const url = this.detail_url(brand_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 upsert(brand_id = "", brand_payload = {}) {
+    const url = this.detail_url(brand_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify(brand_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);
+    }
+  }
+}
+
+export default BrandsApi;

package/src/event.js

@@ -32,6 +32,7 @@ export default class Event {
     this.event_name = event_name;
     this.properties = properties;
     this.idempotency_key = kwargs?.idempotency_key;
+    this.brand_id = kwargs?.brand_id;
     // --- validate
     this.__validate_distinct_id();
     this.__validate_event_name();
@@ -107,6 +108,9 @@ export default class Event {
     if (this.idempotency_key) {
       event_dict["$idempotency_key"] = this.idempotency_key;
     }
+    if (this.brand_id) {
+      event_dict["brand_id"] = this.brand_id;
+    }
     event_dict = validate_track_event_schema(event_dict);
     const apparent_size = get_apparent_event_size(event_dict, is_part_of_bulk);
     if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {

package/src/index.js

@@ -6,6 +6,7 @@ import Event, { EventCollector } from "./event";
 import { BulkEventsFactory } from "./events_bulk";
 import SubscriberFactory from "./subscriber";
 import BulkSubscribersFactory from "./subscribers_bulk";
+import BrandsApi from "./brands";
 import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
 const package_json = require("../package.json");
@@ -31,6 +32,9 @@ class Suprsend {
     this._bulk_users = new BulkSubscribersFactory(this);
 
     this._user = new SubscriberFactory(this);
+
+    this.brands = new BrandsApi(this);
+
     this._validate();
   }
 

package/src/request_json/event.json

@@ -11,6 +11,11 @@
       "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,

package/src/request_json/workflow.json

@@ -11,6 +11,11 @@
       "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"
+    },
     "name": {
       "$ref": "#/definitions/non_empty_string",
       "description": "name of workflow"

package/src/signature.js

@@ -12,17 +12,18 @@ export default function get_request_signature(
   headers,
   secret
 ) {
-  if (http_verb === "GET") {
-    return "";
+  let content_md5 = "";
+  let content_type = headers["Content-Type"] || "";
+  if (content) {
+    content_md5 = crypto.createHash("md5").update(content).digest("hex");
   }
-  const content_md5 = crypto.createHash("md5").update(content).digest("hex");
   const request_uri = get_path(url);
   const sign_string =
     http_verb +
     "\n" +
     content_md5 +
     "\n" +
-    headers["Content-Type"] +
+    content_type +
     "\n" +
     headers["Date"] +
     "\n" +

package/src/utils.js

@@ -44,6 +44,19 @@ export class SuprsendConfigError extends Error {
   }
 }
 
+export class SuprsendApiError extends Error {
+  constructor(error) {
+    let message;
+    if (error.response) {
+      message = `${error.response.status}: ${error.response.data.message}`;
+    } else {
+      message = error.message;
+    }
+    super(message);
+    this.name = "SuprsendApiError";
+  }
+}
+
 export function is_string(value) {
   return typeof value === "string";
 }

package/src/workflow.js

@@ -18,6 +18,7 @@ export default class Workflow {
     }
     this.body = body;
     this.idempotency_key = kwargs?.idempotency_key;
+    this.brand_id = kwargs?.brand_id;
   }
 
   add_attachment(file_path = "", kwargs = {}) {
@@ -46,6 +47,9 @@ export default class Workflow {
     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_workflow_body_schema(this.body);
     const apparent_size = get_apparent_workflow_body_size(
       this.body,