@suprsend/node-sdk 0.0.3 → 0.0.6

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/utils.js

@@ -30,6 +30,198 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 
 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; } }
 
+var schema = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  $id: "http://github.com/suprsend/suprsend-node-sdk/request_json/workflow.json",
+  title: "workflow_request",
+  description: "Json schema for workflow request",
+  $comment: "Json schema for workflow request",
+  type: "object",
+  properties: {
+    name: {
+      $ref: "#/definitions/non_empty_string",
+      description: "name of workflow"
+    },
+    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: {
+      $ref: "#/definitions/non_empty_string",
+      description: "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
+    },
+    priority_algorithm: {
+      type: "boolean"
+    },
+    users: {
+      type: "array",
+      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",
+      description: "variables to be used in workflow. e.g replacing templates variables."
+    }
+  },
+  required: ["name", "template", "notification_category", "users", "data"],
+  definitions: {
+    non_empty_string: {
+      type: "string",
+      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"
+        },
+        $email: {
+          oneOf: [{
+            $ref: "#/definitions/email_pattern"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/email_pattern"
+            }
+          }]
+        },
+        $sms: {
+          oneOf: [{
+            $ref: "#/definitions/mobile_number_pattern"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/mobile_number_pattern"
+            }
+          }]
+        },
+        $androidpush: {
+          oneOf: [{
+            $ref: "#/definitions/non_empty_string"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/non_empty_string"
+            }
+          }]
+        },
+        $iospush: {
+          oneOf: [{
+            $ref: "#/definitions/non_empty_string"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/non_empty_string"
+            }
+          }]
+        },
+        $whatsapp: {
+          oneOf: [{
+            $ref: "#/definitions/mobile_number_pattern"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/mobile_number_pattern"
+            }
+          }]
+        },
+        $webpush: {
+          oneOf: [{
+            type: "object",
+            minProperties: 1
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              type: "object",
+              minProperties: 1
+            }
+          }]
+        },
+        $inbox: {
+          oneOf: [{
+            $ref: "#/definitions/non_empty_string"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/non_empty_string"
+            }
+          }]
+        },
+        $messenger: {
+          oneOf: [{
+            $ref: "#/definitions/non_empty_string"
+          }, {
+            type: "array",
+            uniqueItems: true,
+            maxItems: 10,
+            minItems: 1,
+            items: {
+              $ref: "#/definitions/non_empty_string"
+            }
+          }]
+        }
+      },
+      required: ["distinct_id"],
+      additionalProperties: false
+    }
+  }
+};
+
 function base64Encode(file) {
   var body = _fs["default"].readFileSync(file);
 
@@ -54,7 +246,7 @@ function _get_schema(schema_name) {
   var schema_body = __JSON_SCHEMAS[schema_name];
 
   if (!schema_body) {
-    schema_body = _load_json_schema(schema_name);
+    schema_body = schema;
     __JSON_SCHEMAS[schema_name] = schema_body;
   }
 

package/dist/workflow.js

@@ -130,7 +130,8 @@ var Workflow = /*#__PURE__*/function () {
       if (validated_data.valid) {
         return this.data;
       } else {
-        var error_msg = validated_data.errors[0].message;
+        var error_obj = validated_data.errors[0];
+        var error_msg = "".concat(error_obj.property, " ").concat(error_obj.message);
         throw new _utils.SuprsendError(error_msg);
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/node-sdk",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "Suprsend Node SDK to trigger workflow from backend",
   "main": "dist/index.js",
   "scripts": {
@@ -12,7 +12,7 @@
     "workflow"
   ],
   "author": "Sivaram Katta",
-  "license": "ISC",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/suprsend/suprsend-node-sdk.git"

package/src/utils.js

@@ -2,6 +2,187 @@ import os from "os";
 import fs from "fs";
 import path from "path";
 
+const schema = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  $id: "http://github.com/suprsend/suprsend-node-sdk/request_json/workflow.json",
+  title: "workflow_request",
+  description: "Json schema for workflow request",
+  $comment: "Json schema for workflow request",
+  type: "object",
+  properties: {
+    name: {
+      $ref: "#/definitions/non_empty_string",
+      description: "name of workflow",
+    },
+    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: {
+      $ref: "#/definitions/non_empty_string",
+      description: "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z",
+    },
+    priority_algorithm: { type: "boolean" },
+    users: {
+      type: "array",
+      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",
+      description:
+        "variables to be used in workflow. e.g replacing templates variables.",
+    },
+  },
+  required: ["name", "template", "notification_category", "users", "data"],
+  definitions: {
+    non_empty_string: {
+      type: "string",
+      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" },
+        $email: {
+          oneOf: [
+            { $ref: "#/definitions/email_pattern" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/email_pattern" },
+            },
+          ],
+        },
+        $sms: {
+          oneOf: [
+            { $ref: "#/definitions/mobile_number_pattern" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/mobile_number_pattern" },
+            },
+          ],
+        },
+        $androidpush: {
+          oneOf: [
+            { $ref: "#/definitions/non_empty_string" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/non_empty_string" },
+            },
+          ],
+        },
+        $iospush: {
+          oneOf: [
+            { $ref: "#/definitions/non_empty_string" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/non_empty_string" },
+            },
+          ],
+        },
+        $whatsapp: {
+          oneOf: [
+            { $ref: "#/definitions/mobile_number_pattern" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/mobile_number_pattern" },
+            },
+          ],
+        },
+        $webpush: {
+          oneOf: [
+            { type: "object", minProperties: 1 },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { type: "object", minProperties: 1 },
+            },
+          ],
+        },
+        $inbox: {
+          oneOf: [
+            { $ref: "#/definitions/non_empty_string" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/non_empty_string" },
+            },
+          ],
+        },
+        $messenger: {
+          oneOf: [
+            { $ref: "#/definitions/non_empty_string" },
+            {
+              type: "array",
+              uniqueItems: true,
+              maxItems: 10,
+              minItems: 1,
+              items: { $ref: "#/definitions/non_empty_string" },
+            },
+          ],
+        },
+      },
+      required: ["distinct_id"],
+      additionalProperties: false,
+    },
+  },
+};
+
 export function base64Encode(file) {
   var body = fs.readFileSync(file);
   return body.toString("base64");
@@ -24,7 +205,7 @@ let __JSON_SCHEMAS = {};
 export function _get_schema(schema_name) {
   var schema_body = __JSON_SCHEMAS[schema_name];
   if (!schema_body) {
-    schema_body = _load_json_schema(schema_name);
+    schema_body = schema;
     __JSON_SCHEMAS[schema_name] = schema_body;
   }
   return schema_body;

package/src/workflow.js

@@ -73,7 +73,8 @@ class Workflow {
     if (validated_data.valid) {
       return this.data;
     } else {
-      const error_msg = validated_data.errors[0].message;
+      const error_obj = validated_data.errors[0];
+      const error_msg = `${error_obj.property} ${error_obj.message}`;
       throw new SuprsendError(error_msg);
     }
   }