@suprsend/web-sdk 1.5.1 → 2.0.0

package/src/preferences.js

@@ -1,505 +0,0 @@
-import create_signature from "./encryption";
-import config from "./config";
-import utils from "./utils";
-
-export const PreferenceOptions = { OPT_IN: "opt_in", OPT_OUT: "opt_out" };
-export const ChannelLevelPreferenceOptions = {
-  ALL: "all",
-  REQUIRED: "required",
-};
-
-class Preferences {
-  constructor(instance, emitter) {
-    this.ss_instance = instance;
-    this._preference_data;
-    this._preference_args; // used internally after over_all_channel_preferences update
-    this._emitter = emitter;
-
-    this._debounced_update_category_preferences = utils.debounce_by_type(
-      this._update_category_preferences,
-      config.preference_debounce
-    );
-    this._debounced_update_channel_preferences = utils.debounce_by_type(
-      this._update_channel_preferences,
-      config.preference_debounce
-    );
-  }
-
-  _validate_query_params(query_params = {}) {
-    let validated_params = {};
-    for (let key in query_params) {
-      if (query_params[key]) {
-        validated_params[key] = query_params[key];
-      }
-    }
-    return validated_params;
-  }
-
-  async _get_request(route = "", query_params = {}) {
-    const preference_base_url = `/v1/subscriber/${this.ss_instance.distinct_id}`;
-    const validated_query_params = this._validate_query_params(query_params);
-    const query_params_string = new URLSearchParams(
-      validated_query_params
-    ).toString();
-
-    const full_url_path = query_params_string
-      ? `${preference_base_url}/${route}/?${query_params_string}`
-      : `${preference_base_url}/${route}`;
-
-    const requested_date = new Date().toGMTString();
-    const signature = await create_signature(
-      "",
-      requested_date,
-      "GET",
-      full_url_path
-    );
-    const authorization = signature
-      ? `${config.env_key}:${signature}`
-      : config.env_key;
-
-    try {
-      const resp = await fetch(`${config.api_url}${full_url_path}`, {
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: authorization,
-          "x-amz-date": requested_date,
-        },
-      });
-      if (resp.ok) {
-        const respData = resp.json();
-        return respData;
-      }
-      return {
-        error: true,
-        api_error: true,
-        status_code: resp.status,
-        message: resp.statusText,
-        error_obj: null,
-      };
-    } catch (e) {
-      return {
-        error: true,
-        api_error: false,
-        status_code: null,
-        message: e.message,
-        error_obj: e,
-      };
-    }
-  }
-
-  async _update_request(body, route, query_params) {
-    const preference_base_url = `/v1/subscriber/${this.ss_instance.distinct_id}`;
-    const validated_query_params = this._validate_query_params(query_params);
-    const query_params_string = new URLSearchParams(
-      validated_query_params
-    ).toString();
-
-    const full_url_path = query_params_string
-      ? `${preference_base_url}/${route}/?${query_params_string}`
-      : `${preference_base_url}/${route}`;
-
-    const requested_date = new Date().toGMTString();
-    const bodyString = JSON.stringify(body);
-    const signature = await create_signature(
-      bodyString,
-      requested_date,
-      "POST",
-      full_url_path
-    );
-    const authorization = signature
-      ? `${config.env_key}:${signature}`
-      : config.env_key;
-
-    try {
-      const resp = await fetch(`${config.api_url}${full_url_path}`, {
-        method: "POST",
-        body: bodyString,
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: authorization,
-          "x-amz-date": requested_date,
-        },
-      });
-      if (resp.ok) {
-        const respData = resp.json();
-        return respData;
-      }
-      return {
-        error: true,
-        api_error: true,
-        status_code: resp.status,
-        message: resp.statusText,
-        error_obj: null,
-      };
-    } catch (e) {
-      return {
-        error: true,
-        api_error: false,
-        status_code: null,
-        message: e.message,
-        error_obj: e,
-      };
-    }
-  }
-
-  _update_category_preferences = async (
-    category = "",
-    body = {},
-    subcategory,
-    args = {}
-  ) => {
-    let url_path = `category/${category}`;
-    const response = await this._update_request(body, url_path, args);
-    if (response?.error) {
-      this._emitter.emit("preferences_error", response);
-    } else {
-      Object.assign(subcategory, response);
-      this._emitter.emit("preferences_updated", this.data);
-    }
-    return response;
-  };
-
-  _update_channel_preferences = async (body = {}) => {
-    let url_path = "channel_preference";
-    const response = await this._update_request(body, url_path);
-    if (response?.error) {
-      this._emitter.emit("preferences_error", response);
-    } else {
-      await this.get_preferences(this._preference_args);
-      this._emitter.emit("preferences_updated", this.data);
-    }
-    return response;
-  };
-
-  set data(value) {
-    this._preference_data = value;
-  }
-
-  get data() {
-    return this._preference_data;
-  }
-
-  async get_preferences(args = {}) {
-    let url_path = "full_preference";
-    this._preference_args = args;
-    let query_params = {
-      tenant_id: args?.tenant_id,
-      show_opt_out_channels: args?.show_opt_out_channels,
-    };
-
-    const response = await this._get_request(url_path, query_params);
-    if (!response?.error) {
-      this.data = response;
-    }
-    return response;
-  }
-
-  async get_categories(args = {}) {
-    let url_path = "category";
-    const query_params = {
-      tenant_id: args?.tenant_id,
-      show_opt_out_channels: args?.show_opt_out_channels,
-      limit: args?.limit,
-      offset: args?.offset,
-    };
-
-    const response = await this._get_request(url_path, query_params);
-    return response;
-  }
-
-  async get_category(category = "", args = {}) {
-    if (!category) {
-      return {
-        error: true,
-        message: "Category parameter is missing",
-      };
-    }
-
-    let url_path = `category/${category}`;
-    let query_params = {
-      tenant_id: args?.tenant_id,
-      show_opt_out_channels: args?.show_opt_out_channels,
-    };
-
-    const response = await this._get_request(url_path, query_params);
-    return response;
-  }
-
-  async get_overall_channel_preferences() {
-    let url_path = `channel_preference`;
-    const response = await this._get_request(url_path);
-    return response;
-  }
-
-  update_category_preference(category = "", preference = "", args = {}) {
-    if (
-      !category ||
-      ![PreferenceOptions.OPT_IN, PreferenceOptions.OPT_OUT].includes(
-        preference
-      )
-    ) {
-      return {
-        error: true,
-        message: !category
-          ? "Category parameter is missing"
-          : "Preference parameter is invalid",
-      };
-    }
-
-    if (!this.data) {
-      return {
-        error: true,
-        message: "Call get_preferences method before performing action",
-      };
-    }
-
-    let category_data;
-    let data_updated = false;
-    let show_opt_out_channels = args?.show_opt_out_channels;
-
-    // optimistic update in local store
-    for (let section of this.data.sections) {
-      let abort = false;
-      for (let subcategory of section.subcategories) {
-        if (subcategory.category === category) {
-          category_data = subcategory;
-          if (subcategory.is_editable) {
-            if (subcategory.preference !== preference) {
-              subcategory.preference = preference;
-              data_updated = true;
-              abort = true;
-              break;
-            } else {
-              // console.log(`category is already ${status}ed`);
-            }
-          } else {
-            return {
-              error: true,
-              message: "Category preference is not editable",
-            };
-          }
-        }
-      }
-      if (abort) break;
-    }
-
-    if (!category_data) {
-      return {
-        error: true,
-        message: "Category is not found",
-      };
-    }
-
-    if (!data_updated) {
-      return this.data;
-    }
-
-    const opt_out_channels = [];
-    category_data.channels.forEach((channel) => {
-      if (channel.preference === PreferenceOptions.OPT_OUT) {
-        opt_out_channels.push(channel.channel);
-      }
-    });
-
-    const request_payload = {
-      preference: category_data.preference,
-      opt_out_channels:
-        show_opt_out_channels && preference === PreferenceOptions.OPT_IN
-          ? null
-          : opt_out_channels,
-    };
-
-    this._debounced_update_category_preferences(
-      category,
-      category,
-      request_payload,
-      category_data,
-      {
-        tenant_id: args?.tenant_id,
-        show_opt_out_channels: args?.show_opt_out_channels,
-      }
-    );
-
-    return this.data;
-  }
-
-  update_channel_preference_in_category(
-    channel = "",
-    preference = "",
-    category = "",
-    args = {}
-  ) {
-    if (!channel || !category) {
-      return {
-        error: true,
-        message: !channel
-          ? "Channel parameter is missing"
-          : "Category parameter is missing",
-      };
-    } else if (
-      ![PreferenceOptions.OPT_IN, PreferenceOptions.OPT_OUT].includes(
-        preference
-      )
-    ) {
-      return {
-        error: true,
-        message: "Preference parameter is invalid",
-      };
-    }
-
-    if (!this.data) {
-      return {
-        error: true,
-        message: "Call get_preferences method before performing action",
-      };
-    }
-
-    let category_data;
-    let selected_channel_data;
-    let data_updated = false;
-
-    // optimistic update in local store
-    for (let section of this.data.sections) {
-      let abort = false;
-      for (let subcategory of section.subcategories) {
-        if (subcategory.category === category) {
-          category_data = subcategory;
-          for (let channel_data of subcategory.channels) {
-            if (channel_data.channel === channel) {
-              selected_channel_data = channel_data;
-              if (channel_data.is_editable) {
-                if (channel_data.preference !== preference) {
-                  channel_data.preference = preference;
-                  if (preference === PreferenceOptions.OPT_IN) {
-                    subcategory.preference = PreferenceOptions.OPT_IN;
-                  }
-                  data_updated = true;
-                  abort = true;
-                  break;
-                } else {
-                  //  console.log(`channel is already ${preference}`);
-                }
-              } else {
-                return {
-                  error: true,
-                  message: "Channel preference is not editable",
-                };
-              }
-            }
-          }
-        }
-        if (abort) break;
-      }
-      if (abort) break;
-    }
-
-    if (!category_data) {
-      return {
-        error: true,
-        message: "Category not found",
-      };
-    }
-
-    if (!selected_channel_data) {
-      return {
-        error: true,
-        message: "Category's Channel not found",
-      };
-    }
-
-    if (!data_updated) {
-      return this.data;
-    }
-
-    const opt_out_channels = [];
-    category_data.channels.forEach((channel) => {
-      if (channel.preference === PreferenceOptions.OPT_OUT) {
-        opt_out_channels.push(channel.channel);
-      }
-    });
-
-    const category_preference =
-      args?.show_opt_out_channels &&
-      category_data.preference === PreferenceOptions.OPT_OUT &&
-      preference === PreferenceOptions.OPT_IN
-        ? PreferenceOptions.OPT_IN
-        : category_data.preference;
-
-    const request_payload = {
-      preference: category_preference,
-      opt_out_channels,
-    };
-
-    this._debounced_update_category_preferences(
-      category,
-      category,
-      request_payload,
-      category_data,
-      {
-        tenant_id: args?.tenant_id,
-        show_opt_out_channels: args?.show_opt_out_channels,
-      }
-    );
-
-    return this.data;
-  }
-
-  update_overall_channel_preference(channel = "", preference = "") {
-    if (
-      !channel ||
-      ![
-        ChannelLevelPreferenceOptions.ALL,
-        ChannelLevelPreferenceOptions.REQUIRED,
-      ].includes(preference)
-    ) {
-      return {
-        error: true,
-        message: !channel
-          ? "Channel parameter is missing"
-          : "Preference parameter is invalid",
-      };
-    }
-
-    if (!this.data) {
-      return {
-        error: true,
-        message: "Call get_preferences method before performing action",
-      };
-    }
-
-    let channel_data;
-    let data_updated = false;
-    const preference_restricted =
-      preference === ChannelLevelPreferenceOptions.REQUIRED;
-
-    for (let channel_item of this.data.channel_preferences) {
-      if (channel_item.channel === channel) {
-        channel_data = channel_item;
-        if (channel_item.is_restricted !== preference_restricted) {
-          channel_item.is_restricted = preference_restricted;
-          data_updated = true;
-          break;
-        }
-      }
-    }
-
-    if (!channel_data) {
-      return {
-        error: true,
-        message: "Channel data not found",
-      };
-    }
-
-    if (!data_updated) {
-      return this.data;
-    }
-
-    this._debounced_update_channel_preferences(channel_data.channel, {
-      channel_preferences: [channel_data],
-    });
-
-    return this.data;
-  }
-}
-
-export default Preferences;

package/src/user.js

@@ -1,196 +0,0 @@
-import utils from "./utils";
-import config from "./config";
-import { regex, constants } from "./constants";
-import Preferences from "./preferences";
-
-class User {
-  constructor(instance, emitter) {
-    this.instance = instance;
-    this.preferences = new Preferences(this.instance, emitter);
-  }
-
-  _call_indentity(properties) {
-    utils.batch_or_call({
-      env: config.env_key,
-      distinct_id: this.instance.distinct_id,
-      $insert_id: utils.uuid(),
-      $time: utils.epoch_milliseconds(),
-      ...properties,
-    });
-  }
-
-  _call_flush_immediately(properties) {
-    utils
-      .api(constants.api_events_route, {
-        env: config.env_key,
-        distinct_id: this.instance.distinct_id,
-        $insert_id: utils.uuid(),
-        $time: utils.epoch_milliseconds(),
-        ...properties,
-      })
-      .then((res) => {
-        if (!res.ok) {
-          throw new Error("Error in Fetch");
-        }
-      })
-      .catch(() => {
-        this._call_indentity(properties);
-      });
-  }
-
-  _allow_special_char_events = (key) => {
-    return (
-      key === "$email" ||
-      key === "$whatsapp" ||
-      key === "$sms" ||
-      key?.["$webpush"]
-    );
-  };
-
-  _convert_to_number(obj) {
-    if (!utils.is_empty(obj)) {
-      for (let key in obj) {
-        const number = Number(obj[key]);
-        if (!number) {
-          delete obj[key];
-        } else {
-          obj[key] = number;
-        }
-      }
-    }
-    return obj;
-  }
-
-  _validate_email_and_send(key, email) {
-    if (regex.email.test(email)) {
-      this.append(key, email);
-    } else {
-      console.log("SuprSend: Provide valid Email ID");
-    }
-  }
-
-  _validate_mobile_and_send(key, mobile) {
-    try {
-      if (regex.mobile.test(mobile)) {
-        this.append(key, mobile);
-      } else {
-        console.log(
-          "SuprSend: Provide valid Mobile number as per E.164 standard"
-        );
-      }
-    } catch (err) {
-      console.log(
-        "SuprSend: Provide valid Mobile number as per E.164 standard"
-      );
-    }
-  }
-
-  set(key, value) {
-    const data = utils.format_props({ key, value });
-    if (!utils.is_empty(data)) {
-      this._call_indentity({ $set: data });
-    }
-  }
-
-  set_once(key, value) {
-    const data = utils.format_props({ key, value });
-    if (!utils.is_empty(data)) {
-      this._call_indentity({ $set_once: data });
-    }
-  }
-
-  increment(key, value = 1) {
-    const data = utils.format_props({ key, value });
-    const formatted_data = this._convert_to_number(data);
-    if (!utils.is_empty(formatted_data)) {
-      this._call_indentity({ $add: formatted_data });
-    }
-  }
-
-  append(key, value) {
-    const allow_special_tags = this._allow_special_char_events(key);
-    const data = utils.format_props({ key, value, allow_special_tags });
-    if (!utils.is_empty(data)) {
-      this._call_indentity({ $append: data });
-    }
-  }
-
-  remove(key, value, config = {}) {
-    const allow_special_tags = this._allow_special_char_events(key);
-    const data = utils.format_props({ key, value, allow_special_tags });
-    if (!utils.is_empty(data)) {
-      if (config?.flush_immediately) {
-        this._call_flush_immediately({ $remove: data });
-      } else {
-        this._call_indentity({ $remove: data });
-      }
-    }
-  }
-
-  unset(key) {
-    let formatted_data;
-    if (typeof key === "string") {
-      if (!utils.has_special_char(key)) {
-        formatted_data = [key];
-      } else {
-        console.log("SuprSend: key cannot start with $ or ss_");
-      }
-    } else if (Array.isArray(key)) {
-      formatted_data = [];
-      key.forEach((item) => {
-        if (!utils.has_special_char(String(item))) {
-          formatted_data.push(String(item));
-        }
-      });
-    }
-    if (!utils.is_empty(formatted_data)) {
-      this._call_indentity({ $unset: formatted_data });
-    }
-  }
-
-  add_email(email = "") {
-    this._validate_email_and_send("$email", email);
-  }
-
-  remove_email(email = "") {
-    this.remove("$email", email);
-  }
-
-  add_sms(mobile = "") {
-    this._validate_mobile_and_send("$sms", mobile);
-  }
-
-  remove_sms(mobile = "") {
-    this.remove("$sms", mobile);
-  }
-
-  add_whatsapp(mobile = "") {
-    this._validate_mobile_and_send("$whatsapp", mobile);
-  }
-
-  remove_whatsapp(mobile = "") {
-    this.remove("$whatsapp", mobile);
-  }
-
-  add_webpush(push = "") {
-    this.append({
-      $webpush: push,
-      $device_id: this.instance?.env_properties?.$device_id,
-      $pushvendor: "vapid",
-    });
-  }
-
-  remove_webpush(push = "") {
-    this.remove(
-      {
-        $webpush: push,
-        $device_id: this.instance?.env_properties?.$device_id,
-        $pushvendor: "vapid",
-      },
-      null,
-      { flush_immediately: true }
-    );
-  }
-}
-
-export default User;