@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

package/sdk/common/Clickstream.js

@@ -1,464 +0,0 @@
-const Clickstream = require("@gofynd/flick");
-const { Logger } = require("../common/Logger");
-
-/**
- * Safely extracts a value from an Object of n-depth
- *
- * @author Nikhil Kakade
- * @param {function} fn
- * @param {any} [defaultValue] - Null
- * @returns {any}
- */
-const sg = function safeGet(fn, defaultValue = null) {
-  try {
-    return fn();
-  } catch (err) {
-    return defaultValue;
-  }
-};
-/**
- * Safely extracts search query and click position
- *
- * @author Hitendra Singh
- * @property {string | null} query - Extracted search query if available, otherwise null
- * @property {string | null} position - Click position from the decoded UTM
- *   content, otherwise null
- * @property {string | null} utm_medium - The medium of the UTM (e.g.,
- *   'product_recommendation'), otherwise null
- * @property {string | null} utm_source - The source of the UTM (e.g.,
- *   'product_page'), otherwise null
- * @property {string | null} utm_campaign - The campaign of the UTM (e.g.,
- *   'trending_products'), otherwise null
- * @param {Object} [utm_params] - Object containing UTM parameters (utm_medium,
- *   utm_source, utm_campaign, utm_content)
- * @returns {Object} - An object with the following properties:
- */
-const fetchPositionAndQuery = function (utm_params) {
-  if (!utm_params || !Object.keys(utm_params).length) {
-    return {
-      query: null,
-      position: null,
-      utm_medium: null,
-      utm_source: null,
-      utm_campaign: null,
-    };
-  }
-
-  const {
-    utm_medium = null,
-    utm_source = null,
-    utm_campaign = null,
-  } = utm_params;
-  let query = null;
-  let position = null;
-  const queryResult = {
-    query,
-    position,
-    utm_medium,
-    utm_source,
-    utm_campaign,
-  };
-  if (utm_medium === "search") {
-    try {
-      const decodedUri = utm_params.utm_content
-        ? atob(utm_params.utm_content)
-        : null;
-      if (decodedUri) {
-        const parts = decodedUri.split(":::");
-        queryResult.query = parts[0] || null;
-        queryResult.position = parts[1] || null;
-      }
-    } catch (err) {
-      return queryResult;
-    }
-  }
-  return queryResult;
-};
-/**
- * Safely extracts company details from window object
- *
- * @author Hitendra Singh
- * @returns {Object} - Company_id, company_mode and company_created_on
- */
-const fetchCompanyDetails = function () {
-  //getting the current date in UTC
-  const now = new Date();
-  const formattedDate = now.toISOString();
-  const application = sg(() => window.config.application, null);
-  if (application && Object.keys(application).length) {
-    return {
-      company_id: sg(() => application.company_id, 0),
-      company_mode: sg(() => application.mode, "live"),
-      company_created_on: sg(
-        () => application.company_created_on,
-        formattedDate
-      ),
-    };
-  }
-  return {
-    company_id: 0,
-    company_mode: "live",
-    company_created_on: formattedDate,
-  };
-};
-
-if (typeof window != "undefined") {
-  window.FPI.event.on("user.login", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.identify(eventData["user_id"], {
-      event_type: "identity",
-      email: sg(() => eventData["email"]),
-      phone: sg(() => eventData["phone_number"]),
-      login_value: sg(() => eventData["login_value"]),
-      method: sg(() => eventData["method"]),
-      ...fetchCompanyDetails(),
-    }).catch((err) => {
-      Logger({ level: "ERROR", message: err });
-    });
-  });
-
-  window.FPI.event.on("user.update", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.identify(eventData["used_id"], {
-      event_type: "identity",
-      email: sg(() => eventData["email"]),
-      phone: sg(() => eventData["phone_number"]),
-      method: sg(() => eventData["method"]),
-      ...fetchCompanyDetails(),
-    }).catch((err) => {
-      Logger({ level: "ERROR", message: err });
-    });
-  });
-
-  window.FPI.event.on("user.logout", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("user_logout", {
-      event_type: "identity",
-      ...fetchCompanyDetails(),
-    }).catch((err) => {
-      Logger({ level: "ERROR", message: err });
-    });
-    Clickstream.reset().catch((err) => {
-      Logger({ level: "ERROR", message: err });
-    });
-  });
-
-  window.FPI.event.on("wishlist.add", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    const payload = {
-      wishlist_name: "TODO",
-      wishlist_id: "TODO",
-      event_type: "engagement",
-      product_id: sg(() => eventData.item["uid"]),
-      brand: sg(() => eventData.item.brand["name"]),
-      l3_category: sg(() => eventData.item.categories[0]["name"]),
-      mrp: sg(() => eventData.item.price.marked.max),
-      quantity: "TODO",
-      esp: sg(() => eventData.item.price.effective.min),
-      currency: sg(() => eventData.item.price.effective.currency_code),
-      value: "TODO",
-      source_url: "TODO",
-      ...fetchCompanyDetails(),
-    };
-    const queryResult = fetchPositionAndQuery(eventData.utm_params);
-    Clickstream.sendEvent("product_wishlist_add", {
-      ...payload,
-      ...queryResult,
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("wishlist.remove", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("product_wishlist_remove", {
-      wishlist_name: "TODO",
-      wishlist_id: "TODO",
-      event_type: "engagement",
-      product_id: sg(() => eventData.item["uid"]),
-      brand: sg(() => eventData.item.brand["name"]),
-      l3_category: sg(() => eventData.item.categories[0]["name"]),
-      mrp: sg(() => eventData.item.price.marked.max),
-      quantity: "TODO",
-      esp: sg(() => eventData.item.price.effective.min),
-      currency: sg(() => eventData.item.price.effective.currency_code),
-      value: "TODO",
-      source_url: "TODO",
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("cart.newProduct", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    const payload = {
-      cart_id: eventData.cart_id,
-      event_type: "engagement",
-      product_id: sg(() => eventData.products[0]["uid"]),
-      article_id: sg(() => eventData.products[0]["article"]["uid"]),
-      brand: sg(() => eventData.products[0]["brand"]["name"]),
-      l3_category: sg(() => eventData.products[0]["category"]["name"]),
-      l1_category: "TODO",
-      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
-      price: sg(() => eventData.products[0]["price"]["selling"]),
-      quantity: sg(() => eventData.products[0]["quantity"]["current"]),
-      source_url: "TODO",
-      position: null,
-      query: null,
-      value: "TODO",
-      ...fetchCompanyDetails(),
-    };
-    const queryResult = fetchPositionAndQuery(eventData.utm_params);
-    Clickstream.sendEvent("add_to_cart", { ...payload, ...queryResult })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("cart.remove", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("remove_from_cart", {
-      cart_id: eventData.cart_id,
-      event_type: "engagement",
-      product_id: sg(() => eventData.products[0]["uid"]),
-      brand: sg(() => eventData.products[0]["brand"]["name"]),
-      l3_category: sg(() => eventData.products[0]["category"]["name"]),
-      l1_category: "TODO",
-      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
-      price: sg(() => eventData.products[0]["price"]["selling"]),
-      quantity: sg(() => eventData.products[0]["quantity"]["current"]),
-      source_url: "TODO",
-      position: null,
-      value: "TODO",
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("order.processed", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("order_complete", {
-      event_type: "conversion",
-      ...eventData,
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("refund.success", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("order_refunded", {
-      event_type: "conversion",
-      ...eventData,
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("order.checkout", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("order_checkout", {
-      event_type: "conversion",
-      cart_id: eventData.cart_id,
-      cart_total: sg(() => eventData.breakup_values_raw["mrp_total"]),
-      items: sg(() => eventData.products.lenght),
-      shipping: sg(() => eventData.breakup_values_raw["delivery_charge"]),
-      tax: sg(() => eventData.breakup_values_raw["gst_charges"]),
-      order_total: sg(() => eventData.breakup_values_raw["total"]),
-      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
-      products: eventData.products.map((p) => {
-        return {
-          product_id: p.uid,
-          l3_category: sg(() => p.category["name"]),
-          l1_category: "TODO",
-          quantity: sg(() => p.quantity["current"]),
-          price: sg(() => p.price["marked"]),
-          value: sg(() => p.price["effective"]),
-          currency: sg(() => p.price["currency_code"]),
-          article_id: sg(() => p.article["uid"]),
-        };
-      }),
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-  window.FPI.event.on("order.checkedout", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("order_checkedout", {
-      event_type: "conversion",
-      cart_id: eventData.cart_id,
-      cart_total: sg(() => eventData.breakup_values_raw["mrp_total"]),
-      item_total: sg(() => eventData.products.length),
-      shipping: sg(() => eventData.breakup_values_raw["delivery_charge"]),
-      tax: sg(() => eventData.breakup_values_raw["gst_charges"]),
-      order_total: sg(() => eventData.breakup_values_raw["total"]),
-      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
-      order_id: sg(() => eventData.order_id),
-      products: eventData.products.map((p) => {
-        return {
-          product_id: p.uid,
-          l3_category: sg(() => p.category["name"]),
-          l1_category: "TODO",
-          quantity: sg(() => p.quantity["current"]),
-          price: sg(() => p.price["marked"]),
-          value: sg(() => p.price["effective"]),
-          currency: sg(() => p.price["currency_code"]),
-          article_id: sg(() => p.article["uid"]),
-        };
-      }),
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("product_list.view", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    if (eventData.user && eventData.user.user_id) {
-      //re identify user if the payload contains user id
-      Clickstream.identify(eventData.user.user_id, {}, false);
-    }
-    Clickstream.sendEvent("product_listing", {
-      event_type: "impression",
-      query: sg(() => eventData.slug["q"]),
-      products: eventData.items.map((p) => {
-        return {
-          product_id: p.uid,
-          name: p.name,
-          currency: sg(() => p.price["effective"]["currency_code"]),
-          mrp: sg(() => p.price["effective"]["max"]),
-          esp: sg(() => p.price["effective"]["min"]),
-          source_url: p.url,
-          brand: sg(() => p.brand["name"]),
-        };
-      }),
-
-      item_total: sg(() => eventData["page"]["item_total"]),
-      ...fetchCompanyDetails(),
-    });
-  });
-
-  window.FPI.event.on("product.view", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    if (eventData.user && eventData.user.user_id) {
-      //re identify user if the payload contains user id
-      Clickstream.identify(eventData.user.user_id, {}, false);
-    }
-    const payload = {
-      event_type: "click",
-      product_id: sg(() => eventData.product["uid"]),
-      currency: sg(() => eventData.product.price["currency_code"]),
-      brand: sg(() => eventData.product.brand["name"]),
-      l3_category: sg(() => eventData.product.l3_category),
-      mrp: sg(() => eventData.product.price.max),
-      esp: sg(() => eventData.product.price.min),
-      l1_category: sg(() => eventData.product.l1_category),
-      source_url: sg(() => eventData.product.source_url),
-      quantity: sg(() => eventData.product.sizes[0]["quantity"]),
-      position: null,
-      query: null,
-    };
-    const queryResult = fetchPositionAndQuery(eventData.utm_params);
-    Clickstream.sendEvent("product_view", {
-      ...payload,
-      ...queryResult,
-      ...fetchCompanyDetails(),
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
-      })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
-      });
-  });
-
-  window.FPI.event.on("search.products", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    const payload = {
-      event_type: "search",
-      query: eventData.search_text,
-      products: [],
-      item_total: null,
-    };
-    //filter eventData.data to find the products array and item total
-    let products = [];
-    if (eventData.user && eventData.user.user_id) {
-      //re identify user if the payload contains user id
-      Clickstream.identify(eventData.user.user_id, {}, false);
-    }
-    if (eventData.data && eventData.data.length > 0) {
-      products = eventData.data
-        .filter((item) => {
-          if ((item["type"] === "product" && item.categories) || item.product)
-            return true;
-        })
-        .map((product) => {
-          return product.display || product.name;
-        });
-    }
-
-    const item_total = sg(() =>
-      eventData.page["item_total"] ? eventData.page["item_total"] : 0
-    );
-    if (payload.query) {
-      //only if query is present
-      Clickstream.sendEvent("product_search", {
-        ...payload,
-        products,
-        item_total,
-        ...fetchCompanyDetails(),
-      })
-        .then((resp) => {
-          Logger({ level: "DEBUG", message: "Click event sent" });
-        })
-        .catch((err) => {
-          Logger({ level: "ERROR", message: err });
-        });
-    }
-  });
-
-  window.FPI.event.on("product_list.filter", (eventData) => {
-    Logger({ level: "DEBUG", message: eventData });
-    // Clickstream.sendEvent("add_to_cart", { event_type: "conversion", product_uid: eventData.products[0]['uid'], user_id: eventData.user['user_id'], brand: eventData.products[0]['brand']['name'], category: eventData.products[0]['category']['name'], currency: eventData.products[0]['price']['currency_code'], price: eventData.products[0]['price']['selling'], quantity: eventData.products[0]['quantity']['current'], cart: [] }).then((resp) => {
-    //   console.log("Event sent succesfully")
-    // }).catch(err => {
-    //   console.error(err)
-    // })
-  });
-}