@suprsend/node-sdk 1.9.1 → 1.11.0

package/src/request_json/workflow_trigger.json

@@ -0,0 +1,360 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://github.com/suprsend/suprsend-node-sdk/request_json/workflow_trigger.json",
+  "title": "workflow_trigger",
+  "description": "Json schema for workflow trigger request",
+  "$comment": "Json schema for workflow trigger request",
+  "type": "object",
+  "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 255,
+      "description": "unique id provided by client for request"
+    },
+    "tenant_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "tenant id for workflow to be run in context of a tenant"
+    },
+    "workflow": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "workflow slug"
+    },
+    "actor": {
+      "oneOf": [
+        { "$ref": "#/definitions/non_empty_string" },
+        { "$ref": "#/definitions/user_setting" }
+      ],
+      "description": "actor id/object of workflow"
+    },
+    "recipients": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          { "$ref": "#/definitions/non_empty_string" },
+          { "$ref": "#/definitions/user_setting" }
+        ]
+      },
+      "minItems": 1,
+      "maxItems": 100,
+      "description": "list of recipient id/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."
+    },
+    "metadata": {
+      "type": "object",
+      "description": "metadata of request"
+    },
+    "cancellation_key": {
+      "type": ["string", "null"],
+      "maxLength": 255,
+      "description": "cancellation key for workflow"
+    }
+  },
+  "required": ["workflow", "recipients", "data"],
+  "additionalProperties": false,
+  "definitions": {
+    "non_empty_string": {
+      "type": "string",
+      "minLength": 1
+    },
+    "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"
+      }
+    },
+    "slack_setting": {
+      "type": "object",
+      "properties": {
+        "access_token": {
+          "type": "string",
+          "pattern": "^xox",
+          "description": "Bot User OAuth Access Token with prefix xoxb-"
+        },
+        "channel_id": {
+          "type": "string",
+          "pattern": "^[cC][a-zA-Z0-9]+$",
+          "description": "slack channel id. the bot must be part of it",
+          "message": {
+            "required": "",
+            "pattern": "Slack Channel id format: CXXXXXXXXX"
+          }
+        },
+        "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"
+        },
+        "incoming_webhook": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^https://hooks.slack.com/",
+              "description": "incoming webhook url. e.g https://hooks.slack.com/TXXXXX/BXXXXX/XXXXXXXXXX"
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "ms_teams_setting": {
+      "type": "object",
+      "properties": {
+        "tenant_id": {
+          "type": "string",
+          "description": "ms teams tenant id"
+        },
+        "service_url": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://smba.trafficmanager.net/",
+          "description": "service webhook url. e.g https://smba.trafficmanager.net/XXXXXXXXXX"
+        },
+        "conversation_id": {
+          "type": "string",
+          "description": "ms team conversation id"
+        },
+        "user_id": {
+          "type": "string",
+          "description": "ms team user id"
+        },
+        "incoming_webhook": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "incoming webhook url. e.g https://XXXXX.webhook.office.com/webhookb2/XXXXXXXXXX@XXXXXXXXXX/IncomingWebhook/XXXXXXXXXX/XXXXXXXXXX"
+            }
+          }
+        }
+      },
+      "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": {
+        "is_transient": {
+          "type": ["boolean", "null"],
+          "description": "indicates whether this is a transient user. Profiles are not created for such users."
+        },
+        "distinct_id": {
+          "type": ["string", "null"],
+          "description": "distinct_id: Id which uniquely identifies a user in your app"
+        },
+        "$preferred_language": {
+          "type": ["string", "null"],
+          "description": "preferred_language: 2-letter language code in ISO 639-1 Alpha-2 code format. e.g en (for English)"
+        },
+        "$timezone": {
+          "type": ["string", "null"],
+          "description": "timezone: in IANA timezone format e.g 'America/Los_Angeles'"
+        },
+        "$channels": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "androidpush",
+              "iospush",
+              "webpush",
+              "email",
+              "sms",
+              "whatsapp",
+              "slack",
+              "inbox",
+              "messenger",
+              "ms_teams"
+            ]
+          },
+          "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": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/email_pattern" }
+            }
+          ]
+        },
+        "$sms": {
+          "oneOf": [
+            { "$ref": "#/definitions/mobile_number_pattern" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+            }
+          ]
+        },
+        "$androidpush": {
+          "oneOf": [
+            { "$ref": "#/definitions/androidpush_settings" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/androidpush_settings" }
+            }
+          ]
+        },
+        "$iospush": {
+          "oneOf": [
+            { "$ref": "#/definitions/iospush_settings" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/iospush_settings" }
+            }
+          ]
+        },
+        "$whatsapp": {
+          "oneOf": [
+            { "$ref": "#/definitions/mobile_number_pattern" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+            }
+          ]
+        },
+        "$webpush": {
+          "oneOf": [
+            { "type": "object", "minProperties": 1 },
+            {
+              "type": "array",
+              "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" }
+            }
+          ]
+        },
+        "$ms_teams": {
+          "oneOf": [
+            { "$ref": "#/definitions/ms_teams_setting" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/ms_teams_setting" }
+            }
+          ]
+        },
+        "$inbox": {
+          "oneOf": [
+            { "$ref": "#/definitions/non_empty_string" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/non_empty_string" }
+            }
+          ]
+        },
+        "$messenger": {
+          "oneOf": [
+            { "$ref": "#/definitions/non_empty_string" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/non_empty_string" }
+            }
+          ]
+        }
+      },
+      "required": []
+    }
+  }
+}

package/src/subscriber.js

@@ -327,6 +327,12 @@ export class Subscriber {
     this._collect_event();
   }
 
+  set_timezone(timezone) {
+    const caller = "set_timezone";
+    this._helper._set_timezone(timezone, caller);
+    this._collect_event();
+  }
+
   add_email(email) {
     const caller = "add_email";
     this._helper._add_email(email, caller);

package/src/subscriber_helper.js

@@ -31,6 +31,7 @@ const IDENT_KEYS_ALL = [
 
 const KEY_PUSHVENDOR = "$pushvendor";
 const KEY_PREFERRED_LANGUAGE = "$preferred_language";
+const KEY_TIMEZONE = "$timezone";
 
 const OTHER_RESERVED_KEYS = [
   "$messenger",
@@ -49,6 +50,7 @@ const OTHER_RESERVED_KEYS = [
   "$anon_id",
   "$identified_id",
   KEY_PREFERRED_LANGUAGE,
+  KEY_TIMEZONE,
   "$notification_delivered",
   "$notification_dismiss",
   "$notification_clicked",
@@ -255,6 +257,10 @@ export default class _SubscriberInternalHelper {
     this.__dict_set[KEY_PREFERRED_LANGUAGE] = lang_code;
   }
 
+  _set_timezone(timezone, caller) {
+    this.__dict_set[KEY_TIMEZONE] = timezone;
+  }
+
   __add_identity(key, value, args, caller) {
     const new_caller = `${caller}:${key}`;
     switch (key) {
@@ -320,7 +326,7 @@ export default class _SubscriberInternalHelper {
   }
 
   __check_ident_val_string(value, caller) {
-    const message = "value must a string with proper value";
+    const message = "value must be a string with proper value";
     if (!is_string(value)) {
       this.__errors.push(`[${caller}] ${message}`);
       return [value, false];

package/src/utils.js

@@ -11,6 +11,7 @@ import {
 import { cloneDeep } from "lodash";
 
 const workflow_schema = require("./request_json/workflow.json");
+const workflow_trigger_schema = require("./request_json/workflow_trigger.json");
 const event_schema = require("./request_json/event.json");
 const list_broadcast_schema = require("./request_json/list_broadcast.json");
 
@@ -114,6 +115,25 @@ export function validate_workflow_body_schema(body) {
   }
 }
 
+export function validate_workflow_trigger_body_schema(body) {
+  if (!body?.data) {
+    body.data = {};
+  }
+  if (!(body.data instanceof Object)) {
+    throw new InputValueError("data must be a object");
+  }
+  const schema = workflow_trigger_schema;
+  var v = new Validator();
+  const validated_data = v.validate(body, schema);
+  if (validated_data.valid) {
+    return body;
+  } else {
+    const error_obj = validated_data.errors[0];
+    const error_msg = `${error_obj.property} ${error_obj.message}`;
+    throw new SuprsendError(error_msg);
+  }
+}
+
 export function validate_track_event_schema(body) {
   if (!body?.properties) {
     body.properties = {};

package/src/workflow.js

@@ -33,7 +33,7 @@ export default class Workflow {
     if (!(this.body["data"] instanceof Object)) {
       console.log(
         `WARNING: attachment cannot be added. please make sure body['data'] is a dictionary. Workflow ${JSON.stringify(
-          this.as_json()
+          JSON.stringify(this.as_json())
         )}`
       );
       return;

package/src/workflow_api.js

@@ -0,0 +1,71 @@
+import axios from "axios";
+import get_request_signature from "./signature";
+import { BulkWorkflowTrigger } from "./workflow_trigger_bulk";
+import WorkflowTriggerRequest from "./workflow_request";
+
+export default class WorkflowsApi {
+  constructor(config) {
+    this.config = config;
+    this.metadata = { "User-Agent": this.config.user_agent };
+  }
+
+  _get_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      Date: new Date().toUTCString(),
+      "User-Agent": this.config.user_agent,
+    };
+  }
+
+  async trigger(workflow) {
+    const is_part_of_bulk = false;
+    const [workflow_body, body_size] = workflow.get_final_json(
+      this.config,
+      is_part_of_bulk
+    );
+    try {
+      const headers = this._get_headers();
+      const content_text = JSON.stringify(workflow_body);
+      const url = `${this.config.base_url}trigger/`;
+      const signature = get_request_signature(
+        url,
+        "POST",
+        content_text,
+        headers,
+        this.config.workspace_secret
+      );
+      headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+      const resp = await axios.post(url, content_text, {
+        headers,
+        transformResponse: [(data) => data], // dont assume type of response
+      });
+      const ok_response = Math.floor(resp.status / 100) === 2;
+      return {
+        success: ok_response,
+        status: ok_response ? "success" : "fail",
+        status_code: resp.status,
+        message: resp.data,
+      };
+    } catch (err) {
+      if (err?.response) {
+        return {
+          success: false,
+          status: "fail",
+          status_code: err?.response?.status || 500,
+          message: err?.response?.data,
+        };
+      } else {
+        return {
+          success: false,
+          status: "fail",
+          status_code: 500,
+          message: err.message,
+        };
+      }
+    }
+  }
+
+  bulk_trigger_instance() {
+    return new BulkWorkflowTrigger(this.config);
+  }
+}

package/src/workflow_request.js

@@ -0,0 +1,92 @@
+import {
+  InputValueError,
+  get_apparent_workflow_body_size,
+  validate_workflow_trigger_body_schema,
+} from "./utils";
+import get_attachment_json from "./attachment";
+import {
+  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES,
+  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
+} from "./constants";
+
+export default class WorkflowTriggerRequest {
+  constructor(body, kwargs = {}) {
+    if (!(typeof body === "object" && !Array.isArray(body))) {
+      throw new InputValueError(
+        "WorkflowTriggerRequest body must be a JSON object/dictionary"
+      );
+    }
+    this.body = body;
+    this.idempotency_key = kwargs?.idempotency_key;
+    this.tenant_id = kwargs?.tenant_id;
+    this.cancellation_key = kwargs?.cancellation_key;
+  }
+
+  add_attachment(file_path = "", kwargs = {}) {
+    const file_name = kwargs?.file_name;
+    const ignore_if_error = kwargs?.ignore_if_error ?? false;
+    if (!this.body.data) {
+      this.body.data = {};
+    }
+    // If body["data"] is not a dictionary, don't raise an error while adding attachment.
+    if (typeof this.body.data !== "object") {
+      console.warn(
+        "WARNING: attachment cannot be added. Please make sure body['data'] is a dictionary. WorkflowTriggerRequest ",
+        JSON.stringify(this.as_json())
+      );
+      return;
+    }
+    const attachment = get_attachment_json(
+      file_path,
+      file_name,
+      ignore_if_error
+    );
+    if (!attachment) {
+      return;
+    }
+    if (!this.body.data.$attachments) {
+      this.body.data.$attachments = [];
+    }
+    this.body.data.$attachments.push(attachment);
+  }
+
+  get_final_json(config, is_part_of_bulk = false) {
+    if (this.idempotency_key) {
+      this.body["$idempotency_key"] = this.idempotency_key;
+    }
+    if (this.tenant_id) {
+      this.body["tenant_id"] = this.tenant_id;
+    }
+    if (this.cancellation_key) {
+      this.body.cancellation_key = this.cancellation_key;
+    }
+
+    this.body = validate_workflow_trigger_body_schema(this.body);
+
+    const apparent_size = get_apparent_workflow_body_size(
+      this.body,
+      is_part_of_bulk
+    );
+    if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+      throw new InputValueError(
+        `workflow body too big - ${apparent_size} Bytes, must not exceed ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
+      );
+    }
+
+    return [this.body, apparent_size];
+  }
+
+  as_json() {
+    const body_dict = { ...this.body };
+    if (this.idempotency_key) {
+      body_dict.$idempotency_key = this.idempotency_key;
+    }
+    if (this.tenant_id) {
+      body_dict.tenant_id = this.tenant_id;
+    }
+    if (this.cancellation_key) {
+      body_dict.cancellation_key = this.cancellation_key;
+    }
+    return body_dict;
+  }
+}