@financial-times/o-ads/dist/js/utils/events.js

This package contains the core functionality used by the FT in providing ads across all of its sites. This includes ft.com, howtospendit.com, ftadviser.com and other specialist titles.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.buildPerfmarkSuffix = buildPerfmarkSuffix;
exports.broadcast = broadcast;
exports.on = on;
exports.off = off;
exports.once = once;
exports.perfMark = void 0;

/**
 * Utility methods for o-ads events. Methods defined here are added to the utils object not the utils.event object.
 * @author Origami Advertising, origami.advertising@ft.com
 * @module utils/events
 * @see utils
 */
// Creates a timestamp in the browser's performance entry buffer
// for later use
var perfMark = name => {
  /* istanbul ignore next */
  var performance = window.LUX || window.performance || window.msPerformance || window.webkitPerformance || window.mozPerformance;

  if (performance && performance.mark) {
    performance.clearMarks(name);
    performance.mark(name);
  }
}; // Creates a suffix for an event's performance mark based on some of the attributes on
// the event payload which help identify unequivocally the slot that originated the event


exports.perfMark = perfMark;

function buildPerfmarkSuffix(eventDetailsObj) {
  var suffix = '';

  if (eventDetailsObj && typeof eventDetailsObj === 'object' && 'pos' in eventDetailsObj && 'name' in eventDetailsObj) {
    suffix = '__' + [eventDetailsObj.pos, eventDetailsObj.name, eventDetailsObj.size, eventDetailsObj.creativeId].join('__');
  }

  return suffix;
}
/**
* Broadscasts an o-ads event
* @param {string} name The name of the event
* @param {object} data The data to send as event detail
* @param {HTMLElement} target The element to attach the event listener to
*/


function broadcast(eventName, data, target) {
  /* istanbul ignore next: ignore the final fallback as hard trigger */
  target = target || document.body || document.documentElement;
  eventName = "oAds.".concat(eventName);
  var opts = {
    bubbles: true,
    cancelable: true,
    detail: data
  };
  var isSlotEvent = typeof data === 'object' && 'pos' in data;
  var evDetails = isSlotEvent ? {
    pos: data.pos,
    name: data.name,
    size: data.size && data.size.length ? data.size.toString() : '',
    creativeId: data.creativeId
  } : {};
  var suffix = buildPerfmarkSuffix(evDetails);
  var markName = eventName + suffix;
  perfMark(markName);
  target.dispatchEvent(new CustomEvent(eventName, opts));
}
/**
* Sets an event listener for an oAds event
* @param {string} name The name of the event
* @param {function} callback The function to execute on the event
* @param {HTMLElement} target The element to attach the event listener to
*/


function on(name, callback, target) {
  name = "oAds.".concat(name);
  /* istanbul ignore next: ignore the final fallback as hard trigger */

  target = target || document.body || document.documentElement;
  target.addEventListener(name, callback);
}
/**
* Removes an event listener for an oAds event
* @param {string} name The name of the event
* @param {function} callback The function on the event to be removed
* @param {HTMLElement} target The element the event listener is attached to
*/


function off(name, callback, target) {
  name = "oAds.".concat(name);
  /* istanbul ignore next: ignore the final fallback as hard trigger */

  target = target || document.body || document.documentElement;
  target.removeEventListener(name, callback);
}
/**
* Sets a one time event listener for an oAds event
* @param {string} name The name of the event
* @param {function} callback The function to execute on the event
* @param {HTMLElement} target The element to attach the event listener to
*/


function once(name, callback, target) {
  var handler = function handler(event) {
    /* istanbul ignore next: ignore the final fallback as hard trigger */
    var targ = event.target || event.srcElement;
    targ.removeEventListener(name = "oAds.".concat(name), callback);

    if (callback) {
      callback(event); // we set callback to null so if for some reason the listener isn't removed the callback will still only be called once

      callback = null;
    }
  };

  on(name, handler, target);
}