@miso.ai/client-sdk-core 1.5.1 → 1.6.0-beta.1

package/dist/cjs/plugin/units/tracker.js

@@ -1,365 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _commons = require("@miso.ai/commons");
-
-var _constants = require("./constants");
-
-var _utils = require("../../utils");
-
-const _excluded = ["impression", "viewable", "click"];
-
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-
-function mergeOptions(def, opt) {
-  // if opt is falsy then return false, merge otherwise
-  return !!opt && Object.assign({}, def, opt);
-}
-
-const DEFAULT_TRACKING_OPTIONS = {
-  watchElements: false,
-  viewable: {
-    area: 0.5,
-    duration: 1000
-  },
-  click: {
-    lenient: false
-  }
-};
-const STATE = {
-  INITIAL: 0,
-  TRACKING: 1,
-  TRIGGERED: 2
-};
-
-class Tracker {
-  constructor(unit) {
-    this._unit = unit;
-    this._eventStates = new Map();
-    this._sentEvents = {
-      impression: new Set(),
-      viewable: new Set(),
-      click: new Set()
-    };
-    this._handleClick = this._handleClick.bind(this);
-  }
-
-  start(options) {
-    const root = this._unit.element;
-
-    if (!root) {
-      throw new Error(`The unit has no bound element. Call unit.bind(element) to associated the unit to an element.`);
-    }
-
-    if (this._options) {
-      // throw, for the options could be different and this won't be idempotent
-      throw new Error(`Already tracking events.`);
-    } // settle tracking options
-
-
-    this._options = this._normalizeOptions(options);
-
-    this._watchElements();
-
-    this._trackClicks();
-
-    this.sync();
-  }
-
-  sync() {
-    const {
-      impression,
-      viewable
-    } = this._options;
-
-    if (!impression && !viewable) {
-      return;
-    } // scan all descendants for product item elements
-
-
-    const elements = this._unit.element.querySelectorAll(`[${_constants.ATTR_PRODUCT_ID}]`);
-
-    this._trackImpressions(elements);
-
-    this._trackViewables(elements);
-  }
-
-  interceptEventPayload(callback) {
-    this._eventPayloadPass = callback;
-  }
-
-  impression(productIds) {
-    this._sendEvent('impression', productIds, true);
-  }
-
-  viewable(productIds) {
-    this._sendEvent('viewable', productIds, true);
-  }
-
-  click(productIds) {
-    this._sendEvent('click', productIds, true);
-  }
-
-  _normalizeOptions() {
-    let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-    let {
-      impression = {},
-      viewable = {},
-      click = {}
-    } = _ref,
-        options = _objectWithoutPropertiesLoose(_ref, _excluded);
-
-    return (0, _commons.trimObj)(Object.assign({}, DEFAULT_TRACKING_OPTIONS, options, {
-      impression: mergeOptions(DEFAULT_TRACKING_OPTIONS.impression, impression),
-      viewable: mergeOptions(DEFAULT_TRACKING_OPTIONS.viewable, viewable),
-      click: mergeOptions(DEFAULT_TRACKING_OPTIONS.click, click)
-    }));
-  }
-
-  _watchElements() {
-    const {
-      watchElements,
-      impression,
-      viewable
-    } = this._options;
-
-    if (!watchElements || !impression && !viewable) {
-      return;
-    }
-
-    const observer = this._mutationObserver = new MutationObserver(mutations => {
-      let hasAddedElements = false;
-      let removedElements = [];
-
-      for (const {
-        addedNodes,
-        removedNodes
-      } of mutations) {
-        hasAddedElements = hasAddedElements || addedNodes.length > 0;
-        addedElements = [...addedElements, ...addedNodes];
-        removedElements = [...removedElements, ...removedNodes];
-      }
-
-      if (hasAddedElements) {
-        this.sync();
-      }
-
-      this._untrackViewables(removedElements);
-    });
-    observer.observe(this._element, {
-      childList: true,
-      subtree: true
-    });
-  }
-
-  _unwatchElements() {
-    this._mutationObserver && this._mutationObserver.disconnect();
-  }
-
-  _trackImpressions(elements) {
-    const options = this._options.impression;
-
-    if (!options) {
-      return;
-    }
-
-    const productIds = [];
-
-    for (const element of elements) {
-      const productId = element.getAttribute(_constants.ATTR_PRODUCT_ID);
-
-      if (!productId) {
-        continue;
-      }
-
-      const state = this._getEventState(productId);
-
-      if (state.impression !== STATE.TRIGGERED) {
-        state.impression = STATE.TRIGGERED;
-        productIds.push(productId);
-      }
-    }
-
-    this._sendEvent('impression', productIds);
-  }
-
-  _trackViewables(elements) {
-    const options = this._options.viewable;
-
-    if (!options) {
-      return;
-    }
-
-    for (const element of elements) {
-      this._trackViewableOnElement(element);
-    }
-  }
-
-  async _trackViewableOnElement(element) {
-    if (!(0, _commons.isElement)(element)) {
-      return;
-    }
-
-    const productId = element.getAttribute(_constants.ATTR_PRODUCT_ID);
-
-    if (!productId) {
-      return;
-    } // TODO: when element is replaced without proper unload...
-
-
-    const state = this._getEventState(productId);
-
-    if (state.viewable !== STATE.INITIAL) {
-      return;
-    }
-
-    state.viewable = STATE.TRACKING;
-    const {
-      area,
-      duration
-    } = this._options.viewable;
-    await (0, _utils.viewable)(element, {
-      area,
-      duration
-    });
-    state.viewable = STATE.TRIGGERED;
-
-    this._sendEvent('viewable', [productId]);
-  }
-
-  _untrackAllViewables() {// TODO
-  }
-
-  _untrackViewables(elements) {// we need to scan through all descendants to scavenge detached product items
-    // TODO
-  }
-
-  _trackClicks() {
-    this._unit.element.addEventListener('click', this._handleClick);
-  }
-
-  _untrackClicks() {
-    this._unit.element.removeEventListener('click', this._handleClick);
-  }
-
-  _destroy() {
-    this._unwatchElements();
-
-    this._untrackClicks();
-  }
-
-  _getEventState(productId) {
-    let state = this._eventStates.get(productId);
-
-    if (!state) {
-      this._eventStates.set(productId, state = {
-        impression: STATE.INITIAL,
-        viewable: STATE.INITIAL,
-        click: STATE.INITIAL
-      });
-    }
-
-    return state;
-  }
-
-  _handleClick(event) {
-    const options = this._options && this._options.click;
-
-    if (!options) {
-      return;
-    }
-
-    let productId;
-
-    for (let element = event.target; !productId && element && element !== document; element = element.parentElement) {
-      productId = element.getAttribute(_constants.ATTR_PRODUCT_ID);
-    }
-
-    if (!productId) {
-      return;
-    }
-
-    const state = this._getEventState(productId);
-
-    if (state.click === STATE.TRIGGERED) {
-      return;
-    }
-
-    if (!options.lenient) {// only left click counts
-      // event isPreventDefault
-      // go through a real link
-      // TODO
-    }
-
-    state.click = STATE.TRIGGERED;
-
-    this._sendEvent('click', [productId]);
-  }
-
-  _sendEvent(type, productIds, manual) {
-    if (type !== 'impression' && type !== 'viewable' && type !== 'click') {
-      throw new Error(`Unrecognized event type: ${type}`);
-    }
-
-    productIds = (0, _commons.asArray)(productIds); // dedupe
-
-    const sentEvents = this._sentEvents[type];
-    productIds = productIds.filter(id => {
-      const sent = sentEvents.has(id);
-
-      if (!sent) {
-        sentEvents.add(id);
-      }
-
-      return !sent;
-    });
-
-    if (productIds.length === 0) {
-      return;
-    } // TODO: emit
-    // we want to queue the event for a while so we can merge them and save requests
-    // TODO
-
-
-    const client = this._unit._context._client;
-
-    const payloads = this._buildPayloads(type, productIds, manual);
-
-    if (payloads.length > 0) {
-      client.api.interactions.upload(payloads);
-    }
-  }
-
-  _buildPayloads(type, productIds, manual) {
-    const {
-      id,
-      uuid
-    } = this._unit;
-    let payload = {
-      type: type === 'viewable' ? 'viewable_impression' : type,
-      product_ids: productIds,
-      context: {
-        custom_context: {
-          unit_id: id,
-          unit_instance_uuid: uuid,
-          trigger: manual ? 'manual' : 'auto'
-        }
-      }
-    };
-
-    if (this._eventPayloadPass) {
-      // TODO: handle error
-      payload = this._eventPayloadPass(payload);
-    }
-
-    return (0, _commons.asArray)(payload);
-  }
-
-}
-
-exports.default = Tracker;

package/dist/cjs/plugin/units/unit.js

@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _commons = require("@miso.ai/commons");
-
-var _tracker = _interopRequireDefault(require("./tracker"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class Unit {
-  constructor(context, id) {
-    this._context = context;
-    Object.defineProperties(this, {
-      uuid: {
-        value: (0, _commons.uuidv4)()
-      },
-      id: {
-        value: id
-      }
-    });
-
-    context._units.set(id, this);
-  }
-
-  get element() {
-    return this._element;
-  }
-
-  get tracker() {
-    return this._tracker || (this._tracker = new _tracker.default(this));
-  }
-
-  bind(element) {
-    if (this._element === element) {
-      return;
-    } else if (this._element) {
-      throw new Error(`Element has already been set.`);
-    }
-
-    this._element = element;
-
-    this._context._e2u.set(element, this);
-
-    return this;
-  }
-
-  destroy() {
-    this._tracker && this._tracker._destroy();
-
-    this._context._e2u.delete(this._element);
-
-    this._context._units.delete(this.id);
-
-    this._element = undefined;
-  }
-
-}
-
-exports.default = Unit;

package/dist/cjs/plugin/units/units.js

@@ -1,70 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _commons = require("@miso.ai/commons");
-
-var _constants = require("./constants");
-
-var _unit = _interopRequireDefault(require("./unit"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class UnitsContext {
-  constructor(plugin, client) {
-    this._plugin = plugin;
-    this._client = client;
-    this._units = new Map();
-    this._e2u = new WeakMap();
-    this.interface = new Units(this);
-  }
-
-  list() {
-    return [...this._units.values()];
-  }
-
-  create() {
-    let id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'default';
-
-    if (this._units.has(id)) {
-      throw new Error(`Unit already exists: ${id}`);
-    }
-
-    return new _unit.default(this, id);
-  }
-
-  has() {
-    let ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'default';
-    return typeof ref === 'string' ? this._units.has(ref) : (0, _commons.isElement)(ref) && this._e2u.has(ref);
-  }
-
-  get() {
-    let ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'default';
-
-    if (typeof ref === 'string') {
-      return this._units.get(ref) || new _unit.default(this, ref);
-    } else if ((0, _commons.isElement)(ref)) {
-      if (this._e2u.has(ref)) {
-        return this._e2u.get(ref);
-      } else {
-        const id = ref.getAttribute(_constants.ATTR_UNIT_ID) || 'default';
-        return new _unit.default(this, id).bind(ref);
-      }
-    } else {
-      throw new Error(`Required input to be either a string unit ID or an element: ${ref}`);
-    }
-  }
-
-}
-
-exports.default = UnitsContext;
-
-class Units {
-  constructor(context) {
-    (0, _commons.delegateGetters)(this, context, ['list', 'has', 'create', 'get']);
-  }
-
-}

package/dist/es/plugin/units/constants.js

@@ -1,2 +0,0 @@
-export const ATTR_UNIT_ID = 'data-miso-unit-id';
-export const ATTR_PRODUCT_ID = 'data-miso-product-id';

package/dist/es/plugin/units/index.js

@@ -1,27 +0,0 @@
-import { Component } from '@miso.ai/commons';
-import UnitsContext from './units';
-const PLUGIN_ID = 'std:units';
-export default class UnitsPlugin extends Component {
-  static get id() {
-    return PLUGIN_ID;
-  }
-
-  constructor() {
-    super('units');
-    this._contexts = new WeakMap();
-  }
-
-  install(MisoClient, context) {
-    context.addSubtree(this);
-    MisoClient.on('create', this._injectClient.bind(this));
-  }
-
-  _injectClient(client) {
-    const context = new UnitsContext(this, client);
-
-    this._contexts.set(client, context);
-
-    client.units = context.interface;
-  }
-
-}