@g2crowd/buyer-intent-provider-sdk 0.2.0 → 0.4.0

package/browser/sdk.js

@@ -1,468 +0,0 @@
-import { createBuyerIntentCore } from './core.js';
-
-const DEFAULT_ACTIVITY_ENDPOINT = '/activity/events';
-const DEFAULT_VIEW_NAME = '$view';
-const DEFAULT_CLICK_NAME = '$click';
-const DISTINCT_ID_STORAGE_KEY = 'buyer_intent_distinct_id';
-
-const firedViewElements = new WeakSet();
-const boundClickElements = new WeakSet();
-
-function generateId() {
-  if (typeof crypto !== 'undefined' && crypto.randomUUID) {
-    return crypto.randomUUID();
-  }
-
-  return `bi-${Date.now().toString(36)}-${Math.random().toString(36).slice(2)}`;
-}
-
-function readStoredDistinctId() {
-  if (typeof window === 'undefined') {
-    return null;
-  }
-
-  try {
-    return window.localStorage.getItem(DISTINCT_ID_STORAGE_KEY);
-  } catch (_error) {
-    return null;
-  }
-}
-
-function storeDistinctId(value) {
-  if (typeof window === 'undefined') {
-    return;
-  }
-
-  try {
-    window.localStorage.setItem(DISTINCT_ID_STORAGE_KEY, value);
-  } catch (_error) {
-    return;
-  }
-}
-
-function sendWithBeacon(url, payload) {
-  if (
-    typeof navigator !== 'undefined' &&
-    typeof navigator.sendBeacon === 'function'
-  ) {
-    const blob = new Blob([JSON.stringify(payload)], {
-      type: 'application/json',
-    });
-    const sent = navigator.sendBeacon(url, blob);
-    if (sent) {
-      return true;
-    }
-  }
-
-  if (typeof fetch !== 'undefined') {
-    fetch(url, {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify(payload),
-      keepalive: true,
-    });
-  }
-
-  return false;
-}
-
-function parseJson(value) {
-  if (!value) {
-    return undefined;
-  }
-
-  try {
-    return JSON.parse(value);
-  } catch (_error) {
-    return undefined;
-  }
-}
-
-function parseArray(value) {
-  if (!value) {
-    return undefined;
-  }
-
-  const parsed = parseJson(value);
-  if (Array.isArray(parsed)) {
-    return parsed;
-  }
-
-  if (typeof value === 'string') {
-    return value
-      .split(',')
-      .map((entry) => entry.trim())
-      .filter(Boolean);
-  }
-
-  return undefined;
-}
-
-export function createBuyerIntentSDK() {
-  const core = createBuyerIntentCore();
-  let activityEndpoint = DEFAULT_ACTIVITY_ENDPOINT;
-  let origin = null;
-  let viewName = DEFAULT_VIEW_NAME;
-  let distinctId = null;
-  let userType = 'standard';
-  let lastPageKey = null;
-  let initialLandingPage = null;
-  let initialReferrer = null;
-  let initialUtmParams = null;
-  let observerStarted = false;
-
-  function ensureDistinctId() {
-    if (distinctId) {
-      return distinctId;
-    }
-
-    const stored = readStoredDistinctId();
-    if (stored) {
-      distinctId = stored;
-      return stored;
-    }
-
-    const generated = generateId();
-    distinctId = generated;
-    storeDistinctId(generated);
-    return generated;
-  }
-
-  function readUtmParams(urlValue) {
-    if (!urlValue) {
-      return {};
-    }
-
-    const url = new URL(urlValue, window.location.origin);
-    const params = url.searchParams;
-
-    return {
-      utm_source: params.get('utm_source') || undefined,
-      utm_medium: params.get('utm_medium') || undefined,
-      utm_campaign: params.get('utm_campaign') || undefined,
-      utm_term: params.get('utm_term') || undefined,
-      utm_content: params.get('utm_content') || undefined,
-    };
-  }
-
-  function buildVisitContext() {
-    if (typeof window === 'undefined') {
-      return {};
-    }
-
-    const landingPage = initialLandingPage || window.location.href;
-    return {
-      landingPage,
-      referrer: initialReferrer || document.referrer || undefined,
-      userAgent:
-        typeof navigator !== 'undefined' ? navigator.userAgent : undefined,
-      utmParams: initialUtmParams || readUtmParams(landingPage),
-    };
-  }
-
-  function readDomTagElement(element) {
-    if (!element) {
-      return undefined;
-    }
-
-    if (element.tagName === 'SCRIPT') {
-      const parsed =
-        parseJson(element.textContent || '') ||
-        parseJson(element.getAttribute('data-buyer-intent'));
-      if (parsed && typeof parsed === 'object') {
-        return parsed;
-      }
-    }
-
-    const dataJson = parseJson(element.getAttribute('data-buyer-intent'));
-    if (dataJson && typeof dataJson === 'object') {
-      return dataJson;
-    }
-
-    const dataset = element.dataset || {};
-    return {
-      productIds: parseArray(dataset.productIds),
-      categoryIds: parseArray(dataset.categoryIds),
-      tag: dataset.tag,
-      sourceLocation: dataset.sourceLocation,
-      context: parseJson(dataset.context),
-    };
-  }
-
-  function readDomTags(elements) {
-    if (typeof document === 'undefined') {
-      return [];
-    }
-
-    const found = elements || new Set();
-    const legacy = document.getElementById('buyer-intent-tags');
-    if (legacy) {
-      found.add(legacy);
-    }
-
-    document.querySelectorAll('[data-buyer-intent]').forEach((element) => {
-      found.add(element);
-    });
-
-    return Array.from(found)
-      .map((element) => ({ element, tag: readDomTagElement(element) }))
-      .filter((entry) => entry.tag && typeof entry.tag === 'object');
-  }
-
-  function applyElementConfig(element) {
-    if (!element || !element.dataset) {
-      return;
-    }
-
-    const {
-      origin: originValue,
-      userType: userTypeValue,
-      distinctId: distinctIdValue,
-      activityEndpoint: endpointValue,
-    } = element.dataset;
-
-    if (endpointValue) {
-      setActivityEndpoint(endpointValue);
-    }
-
-    if (originValue || userTypeValue || distinctIdValue) {
-      setBaseProperties({
-        origin: originValue,
-        userType: userTypeValue,
-        distinctId: distinctIdValue,
-      });
-    }
-  }
-
-  function applyDomTags(element) {
-    const elements = element ? new Set([element]) : undefined;
-    const entries = readDomTags(elements);
-    entries.forEach(({ element: tagElement, tag }) => {
-      applyElementConfig(tagElement);
-      core.tagPage(tag);
-    });
-    return entries.length > 0;
-  }
-
-  function resolveEventName(element, fallback) {
-    if (element && element.dataset && element.dataset.eventName) {
-      return element.dataset.eventName;
-    }
-
-    return fallback;
-  }
-
-  function trackPageview(element) {
-    if (typeof window === 'undefined') {
-      return false;
-    }
-
-    const pageKey = `${window.location.pathname}${window.location.search}`;
-    if (pageKey === lastPageKey) {
-      return false;
-    }
-
-    lastPageKey = pageKey;
-    const hasTags = applyDomTags(element);
-    if (!hasTags) {
-      return false;
-    }
-
-    const eventName = resolveEventName(element, viewName);
-    const payload = core.buildPayload({
-      name: eventName,
-      url: window.location.href,
-      origin: origin || window.location.hostname,
-      distinctId: ensureDistinctId(),
-      userType,
-      visit: buildVisitContext(),
-    });
-
-    const sent = sendWithBeacon(activityEndpoint, payload);
-    core.resetPageState();
-    return sent;
-  }
-
-  function trackClick(element) {
-    if (typeof window === 'undefined' || !element) {
-      return false;
-    }
-
-    applyDomTags(element);
-    const eventName = resolveEventName(element, DEFAULT_CLICK_NAME);
-    const payload = core.buildPayload({
-      name: eventName,
-      url: window.location.href,
-      origin: origin || window.location.hostname,
-      distinctId: ensureDistinctId(),
-      userType,
-      visit: buildVisitContext(),
-    });
-
-    const sent = sendWithBeacon(activityEndpoint, payload);
-    core.resetPageState();
-    return sent;
-  }
-
-  function init(options = {}) {
-    activityEndpoint = options.activityEndpoint || activityEndpoint;
-    origin = options.origin || origin;
-    viewName = options.viewName || options.pageviewName || viewName;
-    distinctId = options.distinctId || distinctId;
-    userType = options.userType || userType;
-
-    if (typeof window !== 'undefined' && !initialLandingPage) {
-      initialLandingPage = window.location.href;
-      initialReferrer = document.referrer || undefined;
-      initialUtmParams = readUtmParams(initialLandingPage);
-    }
-
-    core.setBaseProperties({
-      origin: origin || undefined,
-      distinctId: distinctId || undefined,
-      userType,
-    });
-  }
-
-  function setActivityEndpoint(value) {
-    activityEndpoint = value || activityEndpoint;
-  }
-
-  function setBaseProperties(options = {}) {
-    if (options.origin) {
-      origin = options.origin;
-    }
-
-    if (options.distinctId) {
-      distinctId = options.distinctId;
-      storeDistinctId(options.distinctId);
-    }
-
-    if (options.userType) {
-      userType = options.userType;
-    }
-
-    core.setBaseProperties({
-      origin: origin || undefined,
-      distinctId: distinctId || undefined,
-      userType,
-    });
-  }
-
-  function tagPage(options = {}) {
-    core.tagPage(options);
-  }
-
-  function setVisitProperties(options = {}) {
-    core.setVisitProperties(options);
-  }
-
-  function trackNextRouter(nextRouter) {
-    if (!nextRouter || !nextRouter.events) {
-      return () => {};
-    }
-
-    const handler = () => trackPageview();
-    nextRouter.events.on('routeChangeComplete', handler);
-    return () => nextRouter.events.off('routeChangeComplete', handler);
-  }
-
-  function isClickTrigger(element) {
-    return element && element.dataset && element.dataset.trigger === 'click';
-  }
-
-  function bindClickElement(element) {
-    if (!element || typeof element !== 'object') {
-      return;
-    }
-
-    if (boundClickElements.has(element)) {
-      return;
-    }
-
-    boundClickElements.add(element);
-    applyElementConfig(element);
-    element.addEventListener('click', () => trackClick(element));
-  }
-
-  function trackTaggedPageview(element) {
-    if (!element || typeof element !== 'object') {
-      return false;
-    }
-
-    if (isClickTrigger(element)) {
-      bindClickElement(element);
-      return false;
-    }
-
-    if (firedViewElements.has(element)) {
-      return false;
-    }
-
-    firedViewElements.add(element);
-    return trackPageview(element);
-  }
-
-  function observeTagElements() {
-    if (
-      observerStarted ||
-      typeof document === 'undefined' ||
-      typeof MutationObserver === 'undefined'
-    ) {
-      return;
-    }
-
-    observerStarted = true;
-
-    const handleElement = (element) => {
-      if (
-        element &&
-        element.matches &&
-        element.matches('buyer-intent-tag,[data-buyer-intent]')
-      ) {
-        trackTaggedPageview(element);
-      }
-
-      if (element && element.querySelectorAll) {
-        element
-          .querySelectorAll('buyer-intent-tag,[data-buyer-intent]')
-          .forEach((nested) => trackTaggedPageview(nested));
-      }
-    };
-
-    const observer = new MutationObserver((mutations) => {
-      mutations.forEach((mutation) => {
-        mutation.addedNodes.forEach((node) => {
-          if (node.nodeType === 1) {
-            handleElement(node);
-          }
-        });
-      });
-    });
-
-    observer.observe(document.documentElement || document.body, {
-      childList: true,
-      subtree: true,
-    });
-
-    document
-      .querySelectorAll('buyer-intent-tag,[data-buyer-intent]')
-      .forEach((element) => trackTaggedPageview(element));
-  }
-
-  observeTagElements();
-
-  return {
-    init,
-    trackPageview,
-    trackClick,
-    trackTaggedPageview,
-    tagPage,
-    setBaseProperties,
-    setVisitProperties,
-    setActivityEndpoint,
-    trackNextRouter,
-  };
-}
-
-export const buyerIntent = createBuyerIntentSDK();

package/browser/tag_component.js

@@ -1,46 +0,0 @@
-import React from 'react';
-
-function trackerElement({
-  productIds,
-  categoryIds,
-  tag,
-  sourceLocation,
-  context,
-  origin,
-  activityEndpoint,
-  userType,
-  distinctId,
-  eventName,
-  trigger,
-  children,
-}) {
-  const payload = {
-    productIds,
-    categoryIds,
-    tag,
-    sourceLocation,
-    context,
-  };
-
-  return React.createElement(
-    'buyer-intent-tag',
-    {
-      'data-buyer-intent': JSON.stringify(payload),
-      'data-origin': origin,
-      'data-activity-endpoint': activityEndpoint,
-      'data-user-type': userType,
-      'data-distinct-id': distinctId,
-      'data-event-name': eventName,
-      'data-trigger': trigger,
-    },
-    children
-  );
-}
-
-export function ViewTracker(props) {
-  return trackerElement({ ...props, trigger: 'view' });
-}
-
-export function ClickTracker(props) {
-  return trackerElement({ ...props, trigger: 'click' });
-}

package/browser/trackers.js

@@ -1,42 +0,0 @@
-import React from 'react';
-import { ViewTracker, ClickTracker } from './tag_component.js';
-
-function view(tag, props) {
-  return React.createElement(ViewTracker, { ...props, tag });
-}
-
-function click(eventName, props) {
-  return React.createElement(ClickTracker, { ...props, eventName });
-}
-
-export function CompareView({ productIds, ...rest }) {
-  return view('comparisons.show', { ...rest, productIds });
-}
-
-export function CompetitorsView({ productId, ...rest }) {
-  return view('products.competitors', { ...rest, productIds: [productId] });
-}
-
-export function ProfileView({ productId, ...rest }) {
-  return view('products.show', { ...rest, productIds: [productId] });
-}
-
-export function PricingView({ productId, ...rest }) {
-  return view('products.pricing', { ...rest, productIds: [productId] });
-}
-
-export function CategoryView({ categoryId, ...rest }) {
-  return view('categories.show', { ...rest, categoryIds: [categoryId] });
-}
-
-export function WriteReviewView({ productId, ...rest }) {
-  return view('reviewers.take_survey', { ...rest, productIds: [productId] });
-}
-
-export function AdClick({ productId, ...rest }) {
-  return click('/ad/clicked', { ...rest, productIds: [productId] });
-}
-
-export function LeadCreateClick({ productId, ...rest }) {
-  return click('/leads/create', { ...rest, productIds: [productId] });
-}