feature(Vero-web-device-mode): new Integrations Vero web device mode

integrations/Vero/browser.js

@@ -0,0 +1,166 @@
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import { NAME, CNameMapping } from "./constants";
+import logger from "../../utils/logUtil";
+import { isDefinedAndNotNull } from "../utils/commonUtils";
+import ScriptLoader from "../ScriptLoader";
+
+class Vero {
+  constructor(config) {
+    this.apiKey = config.apiKey;
+    this.name = NAME;
+  }
+
+  init() {
+    logger.debug("===In init Vero===");
+    window._veroq = window._veroq || [];
+    ScriptLoader(
+      "vero-integration",
+      "https://d3qxef4rp70elm.cloudfront.net/m.js"
+    );
+    window._veroq.push(["init", { api_key: this.apiKey }]);
+  }
+
+  isLoaded() {
+    logger.debug("===In isLoaded Vero===");
+    return !!window._veroq && typeof window._veroq === "object";
+  }
+
+  isReady() {
+    logger.debug("===In isReady Vero===");
+    return !!window._veroq && !!window._veroq.ready;
+  }
+
+  /**
+   * AddOrRemoveTags.
+   * This block handles any tag addition or removal requests.
+   * Ref - http://developers.getvero.com/?javascript#tags
+   *
+   * @param {Object} tags
+   */
+  addOrRemoveTags(message) {
+    let name;
+    const keys = Object.keys(message.integrations);
+    for (let i = 0; i < keys.length; i += 1) {
+      if (CNameMapping.indexOf(keys[i]) > -1) {
+        name = keys[i];
+        break;
+      }
+    }
+    if (name) {
+      const tags = message.integrations?.[name]?.tags;
+      if (isDefinedAndNotNull(tags)) {
+        const userId = message.userId || message.anonymousId;
+        const addTags = Array.isArray(tags.add) ? tags.add : [];
+        const removeTags = Array.isArray(tags.remove) ? tags.remove : [];
+        window._veroq.push([
+          "tags",
+          {
+            id: userId,
+            add: addTags,
+            remove: removeTags,
+          },
+        ]);
+      }
+    }
+  }
+
+  /**
+   * Identify.
+   * Ref - https://developers.getvero.com/?javascript#users-identify
+   *
+   * @param {Identify} identify
+   */
+  identify(rudderElement) {
+    const { message } = rudderElement;
+    const { traits } = message.context || message;
+    const userId = message.userId || message.anonymousId;
+    let payload = traits;
+    if (userId) {
+      payload = { id: userId, ...payload };
+    }
+    window._veroq.push(["user", payload]);
+    this.addOrRemoveTags(message);
+  }
+
+  /**
+   * Track - tracks an event for a specific user
+   * for event `unsubscribe`
+   * Ref - https://developers.getvero.com/?javascript#users-unsubscribe
+   * for event `resubscribe`
+   * Ref - https://developers.getvero.com/?javascript#users-resubscribe
+   * else
+   * Ref - https://developers.getvero.com/?javascript#events-track
+   *
+   * @param {Track} track
+   */
+  track(rudderElement) {
+    logger.debug("=== In Vero track ===");
+
+    const { message } = rudderElement;
+    const { event, properties } = message;
+    if (!event) {
+      logger.error("[Vero]: Event name from track call is missing!!===");
+      return;
+    }
+    const userId = message.userId || message.anonymousId;
+    switch (event.toLowerCase()) {
+      case "unsubscribe":
+        window._veroq.push(["unsubscribe", userId]);
+        break;
+      case "resubscribe":
+        window._veroq.push(["resubscribe", userId]);
+        break;
+      default:
+        window._veroq.push(["track", event, properties]);
+    }
+    this.addOrRemoveTags(message);
+  }
+
+  /**
+   * Page.
+   *
+   * @param {Page} page
+   */
+  page(rudderElement) {
+    logger.debug("=== In Vero Page ===");
+    const { name, category } = rudderElement.message;
+    let eventName;
+    if (!name && !category) {
+      eventName = `Viewed Page`;
+    } else if (!name && category) {
+      eventName = `Viewed ${category} Page`;
+    } else if (name && !category) {
+      eventName = `Viewed ${name} Page`;
+    } else {
+      eventName = `Viewed ${category} ${name} Page`;
+    }
+    const elemClone = { ...rudderElement };
+    elemClone.message = { ...rudderElement.message };
+    elemClone.message.event = eventName;
+    this.track(elemClone);
+  }
+
+  /**
+   * Alias.
+   * Ref - https://www.getvero.com/api/http/#users
+   *
+   * @param {Alias} alias
+   */
+  alias(rudderElement) {
+    const { message } = rudderElement;
+    const { userId, previousId } = message;
+    if (!previousId) {
+      logger.error("===Vero: previousId is required for alias call===");
+      return;
+    }
+    if (!userId) {
+      logger.error("===Vero: userId is required for alias call===");
+      return;
+    }
+    window._veroq.push(["reidentify", userId, previousId]);
+    this.addOrRemoveTags(message);
+  }
+}
+
+export default Vero;

integrations/Vero/constants.js

@@ -0,0 +1,4 @@
+const NAME = "VERO";
+const CNameMapping = [NAME, "Vero", "vero"];
+
+export { NAME, CNameMapping };

integrations/Vero/index.js

@@ -0,0 +1,3 @@
+import Vero from "./browser";
+
+export default Vero;

integrations/client_server_name.js

@@ -47,6 +47,7 @@ const clientToServerNames = {
   LAUNCHDARKLY: "LaunchDarkly",
   GA360: "Google Analytics 360",
   ADROLL: "Adroll",
+  VERO: "Vero"
 };
 
 export { clientToServerNames };

integrations/index.js

@@ -46,6 +46,7 @@ import * as LaunchDarkly from "./LaunchDarkly";
 import * as GA360 from "./GA360";
 import * as DCMFloodlight from "./DCMFloodlight";
 import * as Adroll from "./Adroll";
+import * as Vero from "./Vero";
 
 // the key names should match the destination.name value to keep partity everywhere
 // (config-plan name, native destination.name , exported integration name(this one below))
@@ -99,6 +100,7 @@ const integrations = {
   LAUNCHDARKLY: LaunchDarkly.default,
   GA360: GA360.default,
   ADROLL: Adroll.default,
+  VERO: Vero.default,
 };
 
 export { integrations };

integrations/integration_cname.js

@@ -46,6 +46,7 @@ import { CNameMapping as VWO } from "./VWO/constants";
 import { CNameMapping as GA360 } from "./GA360/constants";
 import { CNameMapping as DCMFloodlight } from "./DCMFloodlight/constants";
 import { CNameMapping as Adroll } from "./Adroll/constants";
+import { CNameMapping as Vero } from "./Vero/constants";
 
 // for sdk side native integration identification
 // add a mapping from common names to index.js exported key names as identified by Rudder
@@ -98,6 +99,7 @@ const commonNames = {
   ...Sentry,
   ...SnapPixel,
   ...TVSquared,
+  ...Vero,
   ...VWO,
 };