@suprsend/web-sdk 1.5.0 → 2.0.0

package/dist/cjs_bundle.js.LICENSE.txt

@@ -1,11 +0,0 @@
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
-
-/**
- * [js-md5]{@link https://github.com/emn178/js-md5}
- *
- * @namespace md5
- * @version 0.8.3
- * @author Chen, Yi-Cyuan [emn178@gmail.com]
- * @copyright Chen, Yi-Cyuan 2014-2023
- * @license MIT
- */

package/serviceworker/serviceworker.js

@@ -1,152 +0,0 @@
-function uuid() {
-  var dt = new Date().getTime();
-  var uuid = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(
-    /[xy]/g,
-    function (c) {
-      var r = (dt + Math.random() * 16) % 16 | 0;
-      dt = Math.floor(dt / 16);
-      return (c == "x" ? r : (r & 0x3) | 0x8).toString(16);
-    }
-  );
-  return uuid;
-}
-
-function epoch_milliseconds() {
-  return Math.round(Date.now());
-}
-
-function safe_get(cb, default_value) {
-  var resp;
-  try {
-    resp = cb();
-  } catch (err) {
-    resp = default_value;
-  }
-  return resp;
-}
-
-var suprsend_config = {
-  api_url: "https://hub.suprsend.com",
-  imgkit_root: "https://ik.imagekit.io/l0quatz6utm/",
-  api_events_route: "event/",
-  workspace_key: "",
-};
-
-var valid_notification_params = [
-  "title",
-  "body",
-  "icon",
-  "image",
-  "badge",
-  "vibrate",
-  "sound",
-  "dir",
-  "tag",
-  "data",
-  "requireInteraction",
-  "renotify",
-  "silent",
-  "timestamp",
-  "actions",
-];
-
-var url_fields = ["image", "icon", "badge"];
-
-function init_workspace(key, url) {
-  suprsend_config.workspace_key = key;
-  if (url) {
-    suprsend_config.api_url = url;
-  }
-}
-
-function validate_notification(notification_obj) {
-  var validated_notification_obj = {};
-  for (var item in notification_obj) {
-    if (valid_notification_params.includes(item)) {
-      if (
-        url_fields.includes(item) &&
-        notification_obj[item] &&
-        !notification_obj[item].startsWith("http")
-      ) {
-        validated_notification_obj[
-          item
-        ] = `${suprsend_config.imgkit_root}${notification_obj[item]}`;
-      } else {
-        validated_notification_obj[item] = notification_obj[item];
-      }
-    }
-  }
-  if (!(validated_notification_obj["actions"] instanceof Array)) {
-    delete validated_notification_obj["actions"];
-  }
-  return validated_notification_obj;
-}
-
-function call_ss_api(body, method = "post") {
-  var requested_date = new Date().toGMTString();
-  var authorization = suprsend_config.workspace_key + ":";
-  return fetch(
-    `${suprsend_config.api_url}/${suprsend_config.api_events_route}`,
-    {
-      method: method,
-      body: JSON.stringify(body),
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: authorization,
-        "x-amz-date": requested_date,
-      },
-    }
-  );
-}
-
-function send_notification_event(event_name, event_properties) {
-  call_ss_api({
-    event: event_name,
-    env: suprsend_config.workspace_key,
-    $insert_id: uuid(),
-    $time: epoch_milliseconds(),
-    properties: event_properties,
-  });
-}
-
-self.addEventListener("push", function (e) {
-  var notification = e.data.json();
-  var validated_notification = validate_notification(notification);
-  send_notification_event("$notification_delivered", {
-    id: safe_get(() => validated_notification.data.notification_id),
-  });
-  e.waitUntil(
-    self.registration.showNotification(
-      validated_notification.title || "",
-      validated_notification
-    )
-  );
-});
-
-self.addEventListener("notificationclose", function (e) {
-  var notification = e.notification;
-  send_notification_event("$notification_dismiss", {
-    id: safe_get(() => notification.data.notification_id),
-  });
-});
-
-self.addEventListener("notificationclick", function (e) {
-  e.notification.close();
-  var notification = e.notification;
-  send_notification_event("$notification_clicked", {
-    id: safe_get(() => notification.data.notification_id),
-    label_id: e.action,
-  });
-  var launch_url_obj = safe_get(() => notification.data.launch_urls);
-  var redirect_url = "/";
-  if (launch_url_obj) {
-    if (e.action && launch_url_obj[e.action]) {
-      redirect_url = launch_url_obj[e.action];
-    } else if (launch_url_obj["default"]) {
-      redirect_url = launch_url_obj["default"];
-    }
-  } else {
-    redirect_url = "/";
-  }
-  clients.openWindow(redirect_url);
-});

package/src/config.js

@@ -1,13 +0,0 @@
-const package_data = require("../package.json");
-
-const config = {
-  api_url: "https://hub.suprsend.com",
-  sdk_version: package_data.version,
-  batch_size: 20,
-  flush_interval: 3000, // in ms
-  service_worker_file: "serviceworker.js",
-  sw_delay: 5000, // in ms,
-  preference_debounce: 1000, // in ms
-};
-
-export default config;

package/src/constants.js

@@ -1,50 +0,0 @@
-// suprsend sdk related constants
-export const constants = {
-  distinct_id: "_suprsend_dist_id",
-  bulk_events_key: "_bulk_api_call",
-  api_events_route: "event/",
-  super_properties_key: "_suprsend_super_props",
-  device_id_key: "_suprsend_device_id",
-};
-
-export const internal_events = {
-  app_launched: "$app_launched",
-  user_login: "$user_login",
-  user_logout: "$user_logout",
-  purchase_made: "$purchase_made",
-};
-
-export const browser_useragent_map = {
-  Edge: ["Edge"],
-  "Opera Mini": ["Opera Mini"],
-  "Opera Mobile": ["Opera Mobi"],
-  Opera: ["Opera"],
-  "Internet Explorer": ["Trident", "MSIE"],
-  Chrome: ["Chrome", "CriOS"],
-  Firefox: ["Firefox"],
-  Safari: ["Safari"],
-  Mozilla: ["Mozilla"],
-};
-
-export const browser_version_useragent_map = {
-  Edge: [/Edge\/([0-9]+(\.[0-9]+)?)/],
-  "Opera Mini": [/Opera Mini\/([0-9]+(\.[0-9]+)?)/],
-  "Opera Mobile": [/Version\/([0-9]+(\.[0-9]+)?)/],
-  Opera: [/Version\/([0-9]+(\.[0-9]+)?)/],
-  "Internet Explorer": ["rv:"],
-  Chrome: [/Chrome\/([0-9]+(\.[0-9]+)?)/, /CriOS\/([0-9]+(\.[0-9]+)?)/],
-  Firefox: [/rv:([0-9]+(\.[0-9]+)?)/],
-  Safari: [/Version\/([0-9]+(\.[0-9]+)?)/],
-  Mozilla: [/rv:([0-9]+(\.[0-9]+)?)/],
-};
-
-export const os_useragent_map = {
-  "Chrome OS": "CrOS",
-  "Mac OS": "Macintosh",
-  Windows: "Windows",
-  iOS: "like Mac",
-  Android: "Android",
-  Linux: "Linux",
-};
-
-export const regex = { email: /\S+@\S+\.\S+/, mobile: /^\+[1-9]\d{1,14}$/ };

package/src/encryption.js

@@ -1,44 +0,0 @@
-import config from "./config";
-import { constants } from "./constants";
-import { md5 } from "js-md5";
-
-const getUtf8Bytes = (str) =>
-  new Uint8Array(
-    [...unescape(encodeURIComponent(str))].map((c) => c.charCodeAt(0))
-  );
-
-export default async function create_signature(
-  str,
-  date,
-  method,
-  route = `/${constants.api_events_route}`
-) {
-  if (!window.crypto) {
-    return;
-  }
-  const key = config.signing_key;
-  const content_type = "application/json";
-  let md5_str = "";
-  if (str) {
-    md5_str = md5(str);
-  }
-  const message = `${method}\n${md5_str}\n${content_type}\n${date}\n${route}`;
-  const keyBytes = getUtf8Bytes(key);
-  const messageBytes = getUtf8Bytes(message);
-
-  const cryptoKey = await crypto.subtle.importKey(
-    "raw",
-    keyBytes,
-    { name: "HMAC", hash: "SHA-256" },
-    true,
-    ["sign"]
-  );
-
-  const sig = await crypto.subtle.sign("HMAC", cryptoKey, messageBytes);
-
-  // to lowercase hexits
-  [...new Uint8Array(sig)].map((b) => b.toString(16).padStart(2, "0")).join("");
-
-  // to base64
-  return window.btoa(String.fromCharCode(...new Uint8Array(sig)));
-}

package/src/errors.js

@@ -1,20 +0,0 @@
-export class SuprsendError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "SuprsendError";
-  }
-}
-
-export class SSConfigurationError extends SuprsendError {
-  constructor(message) {
-    super(message);
-    this.name = "SuprsendConfigurationError";
-  }
-}
-
-export class SSValidationError extends SuprsendError {
-  constructor(message) {
-    super(message);
-    this.name = "SuprsendValidationError";
-  }
-}

package/src/index.d.ts

@@ -1,180 +0,0 @@
-import { Emitter } from "mitt";
-
-interface Dictionary {
-  [key: string]: any;
-}
-
-export enum PreferenceOptions {
-  OPT_IN = "opt_in",
-  OPT_OUT = "opt_out",
-}
-
-export enum ChannelLevelPreferenceOptions {
-  ALL = "all",
-  REQUIRED = "required",
-}
-
-type EmitterEvents = {
-  preferences_updated: PreferenceData;
-  preferences_error: PreferenceErrorData;
-};
-
-interface CategoryChannel {
-  channel: string;
-  preference: PreferenceOptions;
-  is_editable: boolean;
-}
-
-interface Category {
-  name: string;
-  category: string;
-  description?: string | null;
-  preference: PreferenceOptions;
-  is_editable: boolean;
-  channels?: CategoryChannel[] | null;
-}
-
-interface Section {
-  name?: string | null;
-  description?: string | null;
-  subcategories?: Category[] | null;
-}
-
-interface ChannelPreference {
-  channel: string;
-  is_restricted: boolean;
-}
-
-interface PreferenceData {
-  sections: Section[] | null;
-  channel_preferences: ChannelPreference[] | null;
-}
-
-interface PreferenceErrorData {
-  error: boolean;
-  api_error?: boolean;
-  message: string;
-  status_code?: number | null;
-  error_obj?: Error | null;
-}
-
-interface PreferencesResponse extends PreferenceData, PreferenceErrorData {}
-
-interface GetCategoriesResponse extends PreferenceErrorData {
-  meta: { count: number; limit: number; offset: number };
-  results: Category[] | null;
-}
-
-interface GetOverAllChannelPreferencesResponse extends PreferenceErrorData {
-  channel_preferences: ChannelPreference[] | null;
-}
-
-interface Preferences {
-  data: PreferenceData;
-
-  get_preferences(args?: {
-    tenant_id?: string;
-    show_opt_out_channels?: boolean;
-  }): Promise<PreferencesResponse>;
-
-  get_categories(args?: {
-    tenant_id?: string;
-    limit?: number;
-    offset?: number;
-    show_opt_out_channels?: boolean;
-  }): Promise<GetCategoriesResponse>;
-
-  get_category(
-    category: string,
-    args?: { tenant_id?: string; show_opt_out_channels?: boolean }
-  ): Promise<Category>;
-
-  get_overall_channel_preferences(): Promise<GetOverAllChannelPreferencesResponse>;
-
-  update_category_preference(
-    category: string,
-    preference: PreferenceOptions,
-    args?: {
-      tenant_id?: string;
-      show_opt_out_channels?: boolean;
-    }
-  ): PreferencesResponse;
-
-  update_channel_preference_in_category(
-    channel: string,
-    preference: PreferenceOptions,
-    category: string,
-    args?: {
-      tenant_id?: string;
-      show_opt_out_channels?: boolean;
-    }
-  ): PreferencesResponse;
-
-  update_overall_channel_preference(
-    channel: string,
-    preference: ChannelLevelPreferenceOptions
-  ): PreferencesResponse;
-}
-
-interface User {
-  preferences: Preferences;
-
-  set(key: string, value: any): void;
-  set(prop: Dictionary): void;
-
-  set_once(key: string, value: any): void;
-  set_once(prop: Dictionary): void;
-
-  increment(key: string, value: number): void;
-  increment(prop: Dictionary): void;
-
-  append(key: string, value: any): void;
-  append(prop: Dictionary): void;
-
-  remove(key: string, value: any): void;
-  remove(prop: Dictionary): void;
-
-  unset(key: string): void;
-  unset(keys: string[]): void;
-
-  add_email(email: string): void;
-  remove_email(email: string): void;
-
-  add_sms(mobile: string): void;
-  remove_sms(mobile: string): void;
-
-  add_whatsapp(mobile: string): void;
-  remove_whatsapp(mobile: string): void;
-
-  add_webpush(push: Dictionary): void;
-  remove_webpush(push: Dictionary): void;
-}
-
-export interface WebPush {
-  register_push(): void;
-  notification_permission(): NotificationPermission;
-}
-
-export interface SuprSend {
-  init(
-    ENV_API_KEY: string,
-    SIGNING_KEY: string,
-    config_keys?: {
-      api_url?: string;
-      vapid_key?: string;
-      service_worker_file?: string;
-    }
-  ): void;
-  identify(unique_id: any): void;
-  track(event: string, properties?: Dictionary): void;
-  purchase_made(properties: Dictionary): void;
-  reset(options?: { unsubscribe_push?: boolean }): void;
-  set_super_properties(properties: Dictionary): void;
-
-  user: User;
-  web_push: WebPush;
-  emitter: Emitter<EmitterEvents>;
-}
-
-declare const suprsend: SuprSend;
-export default suprsend;

package/src/index.js

@@ -1,182 +0,0 @@
-import utils from "./utils";
-import config from "./config";
-import User from "./user";
-import WebPush from "./web_push";
-import { constants, internal_events } from "./constants";
-import { SSConfigurationError } from "./errors";
-import mitt from "mitt";
-export {
-  PreferenceOptions,
-  ChannelLevelPreferenceOptions,
-} from "./preferences";
-
-var suprSendInstance;
-export var initialisedAt;
-
-class SuprSend {
-  init(ENV_API_KEY, SIGNING_KEY, config_keys = {}) {
-    config_keys.env = ENV_API_KEY;
-    config_keys.signing_key = SIGNING_KEY;
-    var distinct_id = utils.get_cookie(constants.distinct_id);
-    if (!suprSendInstance) {
-      suprSendInstance = {};
-      this._set_custom_config(config_keys);
-    }
-    if (!distinct_id) {
-      distinct_id = utils.uuid();
-      utils.set_cookie(constants.distinct_id, distinct_id);
-    }
-    suprSendInstance.distinct_id = distinct_id;
-
-    this.emitter = mitt();
-    this.user = new User(suprSendInstance, this.emitter);
-    this.web_push = new WebPush(suprSendInstance);
-
-    this.web_push.update_subscription();
-    SuprSend._set_env_properties();
-    if (!initialisedAt) {
-      utils.bulk_call_api();
-      this.track(internal_events.app_launched);
-    }
-    initialisedAt = new Date();
-  }
-
-  static _set_env_properties() {
-    let device_id = utils.get_local_storage_item(constants.device_id_key);
-    if (!device_id) {
-      device_id = utils.uuid();
-      utils.set_local_storage_item(constants.device_id_key, device_id);
-    }
-    suprSendInstance.env_properties = {
-      $os: utils.os(),
-      $browser: utils.browser(),
-      $browser_version: utils.browser_version(),
-      $sdk_type: "Browser",
-      $device_id: device_id,
-      $sdk_version: config.sdk_version,
-    };
-  }
-
-  _set_custom_config_property(key, value = "", mandatory = false) {
-    if (value) {
-      config[key] = value;
-    } else {
-      if (mandatory) {
-        throw new SSConfigurationError(`Mandatory Key Missing: ${key}`);
-      }
-    }
-  }
-
-  _set_custom_config(config_keys) {
-    this._set_custom_config_property("env_key", config_keys.env, true);
-    this._set_custom_config_property(
-      "signing_key",
-      config_keys.signing_key,
-      true
-    );
-    this._set_custom_config_property("api_url", config_keys?.api_url);
-    this._set_custom_config_property("vapid_key", config_keys?.vapid_key);
-    this._set_custom_config_property(
-      "service_worker_file",
-      config_keys?.sw_file_name
-    );
-  }
-
-  set_super_properties(props = {}) {
-    let existing_super_properties = utils.get_parsed_local_store_data(
-      constants.super_properties_key
-    );
-    let new_super_props = { ...existing_super_properties, ...props };
-    let formatted_super_props = {};
-    for (let key in new_super_props) {
-      if (!utils.has_special_char(key)) {
-        formatted_super_props[key] = new_super_props[key];
-      }
-    }
-    utils.set_local_storage_item(
-      constants.super_properties_key,
-      JSON.stringify(formatted_super_props)
-    );
-    suprSendInstance.env_properties = {
-      ...suprSendInstance.env_properties,
-      ...formatted_super_props,
-    };
-  }
-
-  identify(unique_id) {
-    if (!suprSendInstance._user_identified) {
-      utils.batch_or_call({
-        env: config.env_key,
-        event: "$identify",
-        $insert_id: utils.uuid(),
-        $time: utils.epoch_milliseconds(),
-        properties: {
-          $identified_id: unique_id,
-          $anon_id: suprSendInstance.distinct_id,
-        },
-      });
-      utils.set_cookie(constants.distinct_id, unique_id);
-      suprSendInstance.distinct_id = unique_id;
-      suprSendInstance._user_identified = true;
-      this.web_push.update_subscription();
-      this.track(internal_events.user_login);
-    }
-  }
-
-  track(event, props = {}) {
-    if (event === undefined) {
-      return;
-    } else if (
-      !utils.is_internal_event(event) &&
-      utils.has_special_char(event)
-    ) {
-      console.log("SuprSend: key cannot start with $ or ss_");
-      return;
-    }
-    const super_props = utils.get_parsed_local_store_data(
-      constants.super_properties_key
-    );
-    const formatted_data = utils.format_props({ key: props });
-    const final_data = {
-      ...formatted_data,
-      ...suprSendInstance.env_properties,
-      ...super_props,
-      $current_url: window.location.href,
-    };
-    utils.batch_or_call({
-      event: String(event),
-      distinct_id: suprSendInstance.distinct_id,
-      env: config.env_key,
-      properties: final_data,
-      $insert_id: utils.uuid(),
-      $time: utils.epoch_milliseconds(),
-    });
-  }
-
-  purchase_made(props) {
-    this.track(internal_events.purchase_made, props);
-  }
-
-  async reset(options = { unsubscribe_push: true }) {
-    // unsubscribe push
-    if (options?.unsubscribe_push) {
-      const subscription = await this.web_push._get_subscription_without_wait();
-      if (subscription) {
-        this.user.remove_webpush(subscription);
-      }
-    }
-    this.track(internal_events.user_logout);
-    var distinct_id = utils.uuid();
-    utils.set_cookie(constants.distinct_id, distinct_id);
-    suprSendInstance = {
-      distinct_id: distinct_id,
-      _user_identified: false,
-    };
-    utils.remove_local_storage_item(constants.super_properties_key);
-    this.user = new User(suprSendInstance, this.emitter);
-    this.web_push = new WebPush(suprSendInstance);
-    SuprSend._set_env_properties();
-  }
-}
-
-export default new SuprSend();