@suprsend/node-sdk 0.1.1 → 1.1.0

package/src/index.js

@@ -1,36 +1,62 @@
-import config from "./config";
-import Workflow from "./workflow";
-import path from "path";
-import mime from "mime-types";
-import { base64Encode, resolveTilde, SuprsendError } from "./utils";
-import UserIdentityFactory from "./identity";
-import EventCollector from "./event";
+import { SuprsendError, SuprsendConfigError } from "./utils";
+import get_attachment_json from "./attachment";
+import Workflow, { _WorkflowTrigger } from "./workflow";
+import { BulkWorkflowsFactory } from "./workflows_bulk";
+import Event, { EventCollector } from "./event";
+import { BulkEventsFactory } from "./events_bulk";
+import SubscriberFactory from "./subscriber";
+import BulkSubscribersFactory from "./subscribers_bulk";
+import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
 const package_json = require("../package.json");
 
 class Suprsend {
-  constructor(workspace_env, workspace_secret, config = {}) {
-    this.env_key = workspace_env;
-    this.env_secret = workspace_secret;
+  constructor(workspace_key, workspace_secret, config = {}) {
+    this.workspace_key = workspace_key;
+    this.workspace_secret = workspace_secret;
     this.config = config;
+
     this.base_url = this._get_url(config.base_url);
     this.auth_enabled = config.auth_enabled !== false;
     this.include_signature_param = config.include_signature_param !== false;
     this.user_agent = `suprsend/${
       package_json.version
     };node/${process.version.slice(1)}`;
-    this.user = new UserIdentityFactory(this);
+
+    this._workflow_trigger = new _WorkflowTrigger(this);
     this._eventcollector = new EventCollector(this);
+
+    this._bulk_workflows = new BulkWorkflowsFactory(this);
+    this._bulk_events = new BulkEventsFactory(this);
+    this._bulk_users = new BulkSubscribersFactory(this);
+
+    this._user = new SubscriberFactory(this);
     this._validate();
   }
 
+  get bulk_workflows() {
+    return this._bulk_workflows;
+  }
+
+  get bulk_events() {
+    return this._bulk_events;
+  }
+
+  get bulk_users() {
+    return this._bulk_users;
+  }
+
+  get user() {
+    return this._user;
+  }
+
   _validate() {
-    if (!this.env_key) {
-      throw new SuprsendError("Missing Mandatory WORKSPACE_ENVIRONEMENT");
-    } else if (!this.env_secret) {
-      throw new SuprsendError("Missing Mandatory WORKSPACE_SECRET");
+    if (!this.workspace_key) {
+      throw new SuprsendConfigError("Missing workspace_key");
+    } else if (!this.workspace_secret) {
+      throw new SuprsendConfigError("Missing workspace_secret");
     } else if (!this.base_url) {
-      throw new SuprsendError("Missing Mandatory base url");
+      throw new SuprsendConfigError("Missing base_url");
     }
   }
 
@@ -40,9 +66,9 @@ class Suprsend {
     }
     if (!base_url) {
       if (this.config.is_staging) {
-        base_url = config.staging;
+        base_url = DEFAULT_UAT_URL;
       } else {
-        base_url = config.prod;
+        base_url = DEFAULT_URL;
       }
     }
     base_url = base_url.trim();
@@ -52,14 +78,20 @@ class Suprsend {
     return base_url;
   }
 
-  add_attachment(body, file_path) {
+  add_attachment(body, file_path, kwargs = {}) {
+    const file_name = kwargs?.file_name;
+    const ignore_if_error = kwargs?.ignore_if_error ?? false;
     if (!body.data) {
       body.data = {};
     }
     if (!body.data instanceof Object) {
       throw new SuprsendError("data must be an object");
     }
-    const attachment = this._get_attachment_json_for_file(file_path);
+    const attachment = get_attachment_json(
+      file_path,
+      file_name,
+      ignore_if_error
+    );
     if (!body.data["$attachments"]) {
       body["data"]["$attachments"] = [];
     }
@@ -67,24 +99,27 @@ class Suprsend {
     return body;
   }
 
-  _get_attachment_json_for_file(file_path) {
-    const abs_path = path.resolve(resolveTilde(file_path));
-    return {
-      filename: path.basename(abs_path),
-      contentType: mime.lookup(abs_path),
-      data: base64Encode(abs_path),
-    };
+  trigger_workflow(data) {
+    let wf_ins;
+    if (data instanceof Workflow) {
+      wf_ins = data;
+    } else {
+      wf_ins = new Workflow(data);
+    }
+    return this._workflow_trigger.trigger(wf_ins);
   }
 
-  trigger_workflow(data) {
-    const wf = new Workflow(this, data);
-    wf.validate_data();
-    return wf.execute_workflow();
+  track(distinct_id, event_name, properties = {}, kwargs = {}) {
+    const event = new Event(distinct_id, event_name, properties, kwargs);
+    return this._eventcollector.collect(event);
   }
 
-  track(distinct_id, event_name, properties = {}) {
-    return this._eventcollector.collect(distinct_id, event_name, properties);
+  track_event(event) {
+    if (!(event instanceof Event)) {
+      throw new SuprsendError("argument must be an instance of suprsend.Event");
+    }
+    return this._eventcollector.collect(event);
   }
 }
 
-export default Suprsend;
+export { Suprsend, Event, Workflow };

package/src/request_json/event.json

@@ -6,6 +6,11 @@
   "$comment": "Json schema for Track event",
   "type": "object",
   "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "unique id provided by client for request"
+    },
     "$insert_id": {
       "type": "string",
       "minLength": 36,

package/src/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/src/{identity.js → subscriber.js}

@@ -5,17 +5,27 @@ import {
   uuid,
   is_empty,
   is_string,
+  get_apparent_identity_event_size,
 } from "./utils";
 import get_request_signature from "./signature";
 import axios from "axios";
-import _IdentityEventInternalHelper from "./identity_helper";
+import _IdentityEventInternalHelper from "./subscriber_helper";
+import {
+  IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES,
+  IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
+} from "./constants";
+import _SubscriberInternalHelper from "./subscriber_helper";
 
-export default class UserIdentityFactory {
+export default class SubscriberFactory {
   constructor(config) {
     this.config = config;
   }
 
   new_user(distinct_id) {
+    return this.get_instance(distinct_id);
+  }
+
+  get_instance(distinct_id) {
     if (!is_string(distinct_id)) {
       throw new SuprsendError(
         "distinct_id must be a string. an Id which uniquely identify a user in your app"
@@ -25,11 +35,11 @@ export default class UserIdentityFactory {
     if (!distinct_id) {
       throw new SuprsendError("distinct_id must be passed");
     }
-    return new UserIdentity(this.config, distinct_id);
+    return new Subscriber(this.config, distinct_id);
   }
 }
 
-class UserIdentity {
+export class Subscriber {
   constructor(config, distinct_id) {
     this.config = config;
     this.distinct_id = distinct_id;
@@ -40,10 +50,11 @@ class UserIdentity {
     this.__info = [];
     this._append_count = 0;
     this._remove_count = 0;
+    this._unset_count = 0;
     this._events = [];
-    this._helper = new _IdentityEventInternalHelper(
+    this._helper = new _SubscriberInternalHelper(
       distinct_id,
-      config.env_key
+      config.workspace_key
     );
   }
 
@@ -73,47 +84,69 @@ class UserIdentity {
     };
   }
 
-  __get_events() {
-    let all_events = this._events;
+  events() {
+    let all_events = [...this._events];
     for (let e of all_events) {
       e["properties"] = this.__supr_props;
     }
 
-    if (this._append_count > 0) {
+    if (all_events.length === 0 || this._append_count > 0) {
       const user_identify_event = {
         $insert_id: uuid(),
         $time: epoch_milliseconds(),
-        env: this.config.env_key,
+        env: this.config.workspace_key,
         event: "$identify",
         properties: {
-          $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, ...all_events];
     }
     return all_events;
   }
 
-  __validate_body() {
+  validate_event_size(event_dict) {
+    const apparent_size = get_apparent_identity_event_size(event_dict);
+    if (apparent_size > IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+      throw new SuprsendError(
+        `User Event size too big - ${apparent_size} Bytes, must not cross ${IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
+      );
+    }
+    return [event_dict, apparent_size];
+  }
+
+  validate_body(is_part_of_bulk = false) {
+    const warnings_list = [];
     if (!is_empty(this.__info)) {
-      console.log("WARNING: " + this.__info.join("\n"));
+      const msg = `[distinct_id: ${this.distinct_id}]${this.__info.join("\n")}`;
+      warnings_list.push(msg);
+      console.log(`WARNING: ${msg}`);
     }
     if (!is_empty(this.__errors)) {
-      throw new SuprsendError("ERROR: " + this.__errors.join("\n"));
-    }
-    if (is_empty(this._events)) {
-      throw new SuprsendError(
-        "ERROR: no user properties have been edited. Use user.append/remove/unset method to update user properties"
-      );
+      const msg = `[distinct_id: ${this.distinct_id}] ${this.__errors.join(
+        "\n"
+      )}`;
+      warnings_list.push(msg);
+      const err_msg = `ERROR: ${msg}`;
+      if (is_part_of_bulk) {
+        console.log(err_msg);
+      } else {
+        throw new SuprsendError(err_msg);
+      }
     }
+    return warnings_list;
   }
 
   async save() {
-    this.__validate_body();
+    const is_part_of_bulk = false;
+    this.validate_body(is_part_of_bulk);
     const headers = this.__get_headers();
-    const events = this.__get_events();
+    const events = this.events();
+    for (let ev of events) {
+      const [validated_ev, size] = this.validate_event_size(ev);
+    }
+
     const content_text = JSON.stringify(events);
     if (this.config.auth_enabled) {
       const signature = get_request_signature(
@@ -121,23 +154,33 @@ class UserIdentity {
         "POST",
         content_text,
         headers,
-        this.config.env_secret
+        this.config.workspace_secret
       );
-      headers["Authorization"] = `${this.config.env_key}:${signature}`;
+      headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
     }
     try {
-      const response = await axios.post(this.__url, content_text, {
-        headers,
-      });
-      return {
-        status_code: response.status,
-        success: true,
-        message: response.statusText,
-      };
+      const response = await axios.post(this.__url, content_text, { headers });
+      const ok_response = Math.floor(response.status / 100) == 2;
+      if (ok_response) {
+        return {
+          success: true,
+          status: "success",
+          status_code: response.status,
+          message: response.statusText,
+        };
+      } else {
+        return {
+          success: false,
+          status: "fail",
+          status_code: response.status,
+          message: response.statusText,
+        };
+      }
     } catch (err) {
       return {
-        status_code: 400,
         success: false,
+        status: "fail",
+        status_code: err.status || 500,
         message: err.message,
       };
     }
@@ -207,6 +250,23 @@ class UserIdentity {
     }
   }
 
+  unset(key) {
+    const caller = "unset";
+    if (!is_string(key) && !Array.isArray(key)) {
+      this.__errors.push(`[${caller}] key must be either string or array`);
+      return;
+    }
+    if (is_string(key)) {
+      this._helper._unset_k(key, caller);
+      this._collect_event();
+    } else {
+      for (let item of key) {
+        this._helper._unset_k(item, caller);
+      }
+      this._collect_event();
+    }
+  }
+
   add_email(email) {
     const caller = "add_email";
     this._helper._add_email(email, caller);
@@ -278,4 +338,28 @@ class UserIdentity {
     this._helper._remove_webpush(push_token, provider, caller);
     this._collect_event();
   }
+
+  add_slack_email(value) {
+    const caller = "add_slack_email";
+    this._helper._add_slack({ email: value }, caller);
+    this._collect_event();
+  }
+
+  remove_slack_email(value) {
+    const caller = "remove_slack_email";
+    this._helper._remove_slack({ email: value }, caller);
+    this._collect_event();
+  }
+
+  add_slack_userid(value) {
+    const caller = "add_slack_userid";
+    this._helper._add_slack({ user_id: value }, caller);
+    this._collect_event();
+  }
+
+  remove_slack_userid(value) {
+    const caller = "remove_slack_userid";
+    this._helper._remove_slack({ user_id: value }, caller);
+    this._collect_event();
+  }
 }