@suprsend/node-sdk 0.0.1 → 0.0.5

package/.babelrc

@@ -1,4 +1,4 @@
 {
   "presets": ["@babel/preset-env"],
-  "plugins": [["@babel/transform-runtime"]]
+  "plugins": ["@babel/transform-runtime", "add-module-exports"]
 }

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, SuprSend
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+# suprsend-node-sdk
+This package can be included in a node project to easily integrate with `Suprsend` platform.
+
+Refer full documentation [here](https://docs.suprsend.com/docs/node)
+
+We're working towards creating SDK in other languages as well.
+
+### Suprsend SDKs available in following languages
+* node (`suprsend-node-sdk`)
+* python3 >= 3.7 (`suprsend-py-sdk`)
+
+### Installation
+`suprsend-node-sdk` is available as npm package. You can install using npm or yarn.
+
+Using npm:
+```bash
+npm install @suprsend/node-sdk
+```
+Using yarn:
+```bash
+yarn add @suprsend/node-sdk
+```
+
+### Usage
+Initialize the Suprsend SDK
+```node
+const Suprsend = require("@suprsend/node-sdk");
+
+// Initialize SDK
+const supr_client = new Suprsend("env_key", "env_secret");
+```
+
+Following example shows a sample request for triggering a workflow.
+It triggers a notification to a user with id: `distinct_id`,
+email: `user@example.com` & androidpush-token: `__android_push_token__`
+using template `purchase-made` and notification_category `system`
+
+```node
+// Prepare Workflow body
+const workflow_body = {
+    "name": "Purchase Workflow",
+    "template": "purchase-made",
+    "notification_category": "system",
+    "delay": "15m",
+    "users": [
+        {
+            "distinct_id": "0f988f74-6982-41c5-8752-facb6911fb08",
+            "$email": ["user@example.com"],
+            "$androidpush": ["__android_push_token__"],
+        }
+    ],
+    "data": {
+        "template": {
+            "first_name": "User",
+            "spend_amount": "$10"
+        },
+    }
+}
+
+// Trigger workflow
+const response = supr_client.trigger_workflow(workflow_body); // returns promise
+response.then((res) => console.log("response", res));
+```
+
+When you call `supr_client.trigger_workflow`, the SDK internally makes an HTTP call to SuprSend
+Platform to register this request, and you'll receive a promise which resolve to response indicating
+the acceptance status.
+
+Note: The actual processing/execution of workflow happens asynchronously.
+
+```node
+// If the call succeeds, response will looks like:
+{
+    "success": true,
+    "status_code": 202,
+    "message": "Accepted",
+}
+
+// In case the call fails. You will receive a response with success=false
+{
+    "success": false,
+    "status": 400,
+    "message": "error message",
+}
+```
+
+### Add attachments
+
+To add one or more Attachments to a Notification (viz. Email, Whatsapp),
+call `supr_client.add_attachment(...)` for each file.
+Ensure that file_path is proper, otherwise it will raise error.
+```node
+// this snippet can be used to add attachment to workflow_body.
+const file_path = "/home/user/billing.pdf"
+supr_client.add_attachment(workflow_body, file_path);
+```
+
+#### Attachment structure
+The `add_attachment(...)` call appends below structure to `data->'$attachments'`
+
+```json
+{
+    "filename": "billing.pdf",
+    "contentType": "application/pdf",
+    "data": "Q29uZ3JhdHVsYXRpb25zLCB5b3UgY2FuIGJhc2U2NCBkZWNvZGUh",
+}
+```
+Where
+* `filename` - name of file.
+* `contentType` - MIME-type of file content.
+* `data` - base64-encoded content of file.

package/dist/config.js

@@ -9,4 +9,5 @@ var config = {
   prod: "https://hub.suprsend.com/"
 };
 var _default = config;
-exports["default"] = _default;
+exports["default"] = _default;
+module.exports = exports.default;

package/dist/index.js

@@ -42,11 +42,11 @@ var Suprsend = /*#__PURE__*/function () {
     key: "_validate",
     value: function _validate() {
       if (!this.env_key) {
-        throw new Error("SuprsendError: Missing Mandatory WORKSPACE_ENVIRONEMENT");
+        throw new _utils.SuprsendError("Missing Mandatory WORKSPACE_ENVIRONEMENT");
       } else if (!this.env_secret) {
-        throw new Error("SuprsendError: Missing Mandatory WORKSPACE_SECRET");
+        throw new _utils.SuprsendError("Missing Mandatory WORKSPACE_SECRET");
       } else if (!this.base_url) {
-        throw new Error("SuprsendError: Missing Mandatory base url");
+        throw new _utils.SuprsendError("Missing Mandatory base url");
       }
     }
   }, {
@@ -80,7 +80,7 @@ var Suprsend = /*#__PURE__*/function () {
       }
 
       if (!body.data instanceof Object) {
-        throw new Error("SuprsendError: data must be an object");
+        throw new _utils.SuprsendError("data must be an object");
       }
 
       var attachment = this._get_attachment_json_for_file(file_path);
@@ -115,4 +115,5 @@ var Suprsend = /*#__PURE__*/function () {
 }();
 
 var _default = Suprsend;
-exports["default"] = _default;
+exports["default"] = _default;
+module.exports = exports.default;

package/dist/request_json/workflow.json

@@ -27,15 +27,13 @@
       "$ref": "#/definitions/non_empty_string",
       "description": "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
     },
-    "priority_algorithm": {
-      "type": "boolean"
-    },
+    "priority_algorithm": { "type": "boolean" },
     "users": {
       "type": "array",
-      "items": {
-        "$ref": "#/definitions/user_setting"
-      },
-      "description": "user object to run workflow for"
+      "items": { "$ref": "#/definitions/user_setting" },
+      "minItems": 1,
+      "maxItems": 100,
+      "description": "user object to run workflow for. At least 1 user is required"
     },
     "data": {
       "type": "object",
@@ -46,141 +44,126 @@
   "definitions": {
     "non_empty_string": {
       "type": "string",
-      "minLength": 1
+      "minLength": 2
+    },
+    "mobile_number_pattern": {
+      "type": "string",
+      "minLength": 8,
+      "pattern": "^\\+[0-9\\s]+",
+      "message": {
+        "required": "Either a mobile-number or an array of mobile-numbers. e.g [\"41446681800\"]",
+        "pattern": "number must start with + and must contain country code. e.g. +41446681800"
+      }
+    },
+    "email_pattern": {
+      "type": "string",
+      "format": "email",
+      "pattern": "^\\S+@\\S+\\.\\S+$",
+      "description": "email of an user",
+      "minLength": 6,
+      "maxLength": 127,
+      "message": {
+        "required": "",
+        "pattern": "value in email format required. e.g. user@example.com"
+      }
     },
     "user_setting": {
       "type": "object",
       "properties": {
-        "distinct_id": {
-          "$ref": "#/definitions/non_empty_string"
-        },
+        "distinct_id": { "$ref": "#/definitions/non_empty_string" },
         "$email": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/email_pattern" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/email_pattern" }
             }
           ]
         },
         "$sms": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/mobile_number_pattern" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/mobile_number_pattern" }
             }
           ]
         },
         "$androidpush": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$iospush": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$whatsapp": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/mobile_number_pattern" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/mobile_number_pattern" }
             }
           ]
         },
         "$webpush": {
           "oneOf": [
-            {
-              "type": "object",
-              "minProperties": 1
-            },
+            { "type": "object", "minProperties": 1 },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "type": "object",
-                "minProperties": 1
-              }
+              "items": { "type": "object", "minProperties": 1 }
             }
           ]
         },
         "$inbox": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$messenger": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         }

package/dist/signature.js

@@ -27,4 +27,6 @@ function get_request_signature(url, http_verb, content, headers, secret) {
   var hash = _crypto["default"].createHmac("sha256", secret).update(sign_string);
 
   return hash.digest("base64");
-}
+}
+
+module.exports = exports.default;

package/dist/utils.js

@@ -5,16 +5,31 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.SuprsendError = void 0;
 exports._get_schema = _get_schema;
 exports.base64Encode = base64Encode;
 exports.resolveTilde = resolveTilde;
 
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+
+var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
+
 var _os = _interopRequireDefault(require("os"));
 
 var _fs = _interopRequireDefault(require("fs"));
 
 var _path = _interopRequireDefault(require("path"));
 
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2["default"])(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2["default"])(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2["default"])(this, result); }; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
 function base64Encode(file) {
   var body = _fs["default"].readFileSync(file);
 
@@ -56,8 +71,27 @@ function _load_json_schema(schema_name) {
 
     json_schema = JSON.parse(schema_string);
   } catch (e) {
-    throw new Error("SuprsendError: Missing Schema");
+    throw new SuprsendError("Missing Schema");
   }
 
   return json_schema;
-}
+}
+
+var SuprsendError = /*#__PURE__*/function (_Error) {
+  (0, _inherits2["default"])(SuprsendError, _Error);
+
+  var _super = _createSuper(SuprsendError);
+
+  function SuprsendError(message) {
+    var _this;
+
+    (0, _classCallCheck2["default"])(this, SuprsendError);
+    _this = _super.call(this, message);
+    _this.name = "SuprsendError";
+    return _this;
+  }
+
+  return SuprsendError;
+}( /*#__PURE__*/(0, _wrapNativeSuper2["default"])(Error));
+
+exports.SuprsendError = SuprsendError;

package/dist/workflow.js

@@ -17,8 +17,6 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 
 var _signature = _interopRequireDefault(require("./signature"));
 
-var _https = _interopRequireDefault(require("https"));
-
 var _jsonschema = require("jsonschema");
 
 var _utils = require("./utils");
@@ -122,27 +120,25 @@ var Workflow = /*#__PURE__*/function () {
       }
 
       if (!(this.data.data instanceof Object)) {
-        throw new Error("SuprsendError: data must be a object");
+        throw new _utils.SuprsendError("data must be a object");
       }
 
       var schema = (0, _utils._get_schema)("workflow");
-
-      try {
-        var v = new _jsonschema.Validator();
-        v.validate(this.data, schema);
-      } catch (e) {
-        if (e instanceof _jsonschema.SchemaError) {
-          throw new Error("SuprsendSchemaError:".concat(e.message));
-        } else if (e instanceof _jsonschema.ValidationError) {
-          throw new Error("SuprsendValidationError:".concat(e.message));
-        }
+      var v = new _jsonschema.Validator();
+      var validated_data = v.validate(this.data, schema);
+
+      if (validated_data.valid) {
+        return this.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);
       }
-
-      return this.data;
     }
   }]);
   return Workflow;
 }();
 
 var _default = Workflow;
-exports["default"] = _default;
+exports["default"] = _default;
+module.exports = exports.default;

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@suprsend/node-sdk",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "Suprsend Node SDK to trigger workflow from backend",
   "main": "dist/index.js",
   "scripts": {
-    "build": "rm -rf dist && babel ./src --out-dir dist && mkdir ./dist/request_json && cp ./src/request_json/workflow.json ./dist/request_json/"
+    "build": "rm -rf dist && babel ./src --out-dir dist && mkdir ./dist/request_json && cp ./src/request_json/workflow.json ./dist/request_json/",
+    "publish_sdk": "npm run build && npm publish"
   },
   "keywords": [
     "suprsend-node-sdk",
     "workflow"
   ],
   "author": "Sivaram Katta",
-  "license": "ISC",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/suprsend/suprsend-node-sdk.git"
@@ -29,6 +30,7 @@
     "@babel/cli": "^7.16.0",
     "@babel/core": "^7.16.0",
     "@babel/plugin-transform-runtime": "^7.16.4",
-    "@babel/preset-env": "^7.16.4"
+    "@babel/preset-env": "^7.16.4",
+    "babel-plugin-add-module-exports": "^1.0.4"
   }
 }

package/src/index.js

@@ -2,7 +2,7 @@ import config from "./config";
 import Workflow from "./workflow";
 import path from "path";
 import mime from "mime-types";
-import { base64Encode, resolveTilde } from "./utils";
+import { base64Encode, resolveTilde, SuprsendError } from "./utils";
 
 const package_json = require("../package.json");
 
@@ -22,13 +22,11 @@ class Suprsend {
 
   _validate() {
     if (!this.env_key) {
-      throw new Error(
-        "SuprsendError: Missing Mandatory WORKSPACE_ENVIRONEMENT"
-      );
+      throw new SuprsendError("Missing Mandatory WORKSPACE_ENVIRONEMENT");
     } else if (!this.env_secret) {
-      throw new Error("SuprsendError: Missing Mandatory WORKSPACE_SECRET");
+      throw new SuprsendError("Missing Mandatory WORKSPACE_SECRET");
     } else if (!this.base_url) {
-      throw new Error("SuprsendError: Missing Mandatory base url");
+      throw new SuprsendError("Missing Mandatory base url");
     }
   }
 
@@ -55,7 +53,7 @@ class Suprsend {
       body.data = {};
     }
     if (!body.data instanceof Object) {
-      throw new Error("SuprsendError: data must be an object");
+      throw new SuprsendError("data must be an object");
     }
     const attachment = this._get_attachment_json_for_file(file_path);
     if (!body.data["$attachments"]) {

package/src/request_json/workflow.json

@@ -27,15 +27,13 @@
       "$ref": "#/definitions/non_empty_string",
       "description": "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
     },
-    "priority_algorithm": {
-      "type": "boolean"
-    },
+    "priority_algorithm": { "type": "boolean" },
     "users": {
       "type": "array",
-      "items": {
-        "$ref": "#/definitions/user_setting"
-      },
-      "description": "user object to run workflow for"
+      "items": { "$ref": "#/definitions/user_setting" },
+      "minItems": 1,
+      "maxItems": 100,
+      "description": "user object to run workflow for. At least 1 user is required"
     },
     "data": {
       "type": "object",
@@ -46,141 +44,126 @@
   "definitions": {
     "non_empty_string": {
       "type": "string",
-      "minLength": 1
+      "minLength": 2
+    },
+    "mobile_number_pattern": {
+      "type": "string",
+      "minLength": 8,
+      "pattern": "^\\+[0-9\\s]+",
+      "message": {
+        "required": "Either a mobile-number or an array of mobile-numbers. e.g [\"41446681800\"]",
+        "pattern": "number must start with + and must contain country code. e.g. +41446681800"
+      }
+    },
+    "email_pattern": {
+      "type": "string",
+      "format": "email",
+      "pattern": "^\\S+@\\S+\\.\\S+$",
+      "description": "email of an user",
+      "minLength": 6,
+      "maxLength": 127,
+      "message": {
+        "required": "",
+        "pattern": "value in email format required. e.g. user@example.com"
+      }
     },
     "user_setting": {
       "type": "object",
       "properties": {
-        "distinct_id": {
-          "$ref": "#/definitions/non_empty_string"
-        },
+        "distinct_id": { "$ref": "#/definitions/non_empty_string" },
         "$email": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/email_pattern" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/email_pattern" }
             }
           ]
         },
         "$sms": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/mobile_number_pattern" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/mobile_number_pattern" }
             }
           ]
         },
         "$androidpush": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$iospush": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$whatsapp": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/mobile_number_pattern" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/mobile_number_pattern" }
             }
           ]
         },
         "$webpush": {
           "oneOf": [
-            {
-              "type": "object",
-              "minProperties": 1
-            },
+            { "type": "object", "minProperties": 1 },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "type": "object",
-                "minProperties": 1
-              }
+              "items": { "type": "object", "minProperties": 1 }
             }
           ]
         },
         "$inbox": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$messenger": {
           "oneOf": [
-            {
-              "$ref": "#/definitions/non_empty_string"
-            },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": true,
               "maxItems": 10,
               "minItems": 1,
-              "items": {
-                "$ref": "#/definitions/non_empty_string"
-              }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         }

package/src/utils.js

@@ -37,7 +37,14 @@ function _load_json_schema(schema_name) {
     var schema_string = fs.readFileSync(file_path, "utf8");
     json_schema = JSON.parse(schema_string);
   } catch (e) {
-    throw new Error("SuprsendError: Missing Schema");
+    throw new SuprsendError("Missing Schema");
   }
   return json_schema;
 }
+
+export class SuprsendError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "SuprsendError";
+  }
+}

package/src/workflow.js

@@ -1,7 +1,6 @@
 import get_request_signature from "./signature";
-import https from "https";
-import { Validator, SchemaError, ValidationError } from "jsonschema";
-import { _get_schema } from "./utils";
+import { Validator } from "jsonschema";
+import { _get_schema, SuprsendError } from "./utils";
 import axios from "axios";
 
 class Workflow {
@@ -66,20 +65,18 @@ class Workflow {
       this.data.data = {};
     }
     if (!(this.data.data instanceof Object)) {
-      throw new Error("SuprsendError: data must be a object");
+      throw new SuprsendError("data must be a object");
     }
     const schema = _get_schema("workflow");
-    try {
-      var v = new Validator();
-      v.validate(this.data, schema);
-    } catch (e) {
-      if (e instanceof SchemaError) {
-        throw new Error(`SuprsendSchemaError:${e.message}`);
-      } else if (e instanceof ValidationError) {
-        throw new Error(`SuprsendValidationError:${e.message}`);
-      }
+    var v = new Validator();
+    const validated_data = v.validate(this.data, schema);
+    if (validated_data.valid) {
+      return this.data;
+    } else {
+      const error_obj = validated_data.errors[0];
+      const error_msg = `${error_obj.property} ${error_obj.message}`;
+      throw new SuprsendError(error_msg);
     }
-    return this.data;
   }
 }