@financial-times/o-ads/src/js/targeting.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.

import config from './config.js';
import utils from './utils/index.js';
let parameters = {};
function Targeting() {} //eslint-disable-line no-empty-function

Targeting.prototype.get = function () {
	const methods = {
		socialReferrer: this.getSocialReferrer,
		timestamp: this.timestamp,
		responsive: this.responsive,
	};
	utils.extend(parameters, this.socialFlow(), this.getVersion());
	for (const item in methods) {
		/* istanbul ignore else  */
		if (methods.hasOwnProperty(item)) {
			utils.extend(parameters, methods[item]());
		}
	}
	return parameters;
};

Targeting.prototype.add = function (obj) {
	/* istanbul ignore else  */
	if (utils.isPlainObject(obj)) {
		utils.extend(parameters, obj);
	}
};

Targeting.prototype.remove = function (key) {
	/* istanbul ignore else */
	if (parameters[key]) {
		delete parameters[key];
	}
};

Targeting.prototype.clear = function () {
	parameters = {};
};

Targeting.prototype.getVersion = function () {
	if (config('passOAdsVersion')) {
		return {
			OADS_VERSION: utils.getVersion(),
		};
	}
};

/**
 * If there is a query parameter called socialflow=xxx, we need to add it
 * as a tag
 */
Targeting.prototype.socialFlow = function () {
	const sf = utils.getQueryParamByName('socialflow');
	if (sf) {
		return {
			socialflow: sf,
		};
	}
};

Targeting.prototype.getSocialReferrer = function () {
	let codedValue;
	const referrer = utils.getReferrer();
	// TODO: add on.ft.com
	const lookup = {
		't.co': 'twi',
		'facebook.com': 'fac',
		'linkedin.com': 'lin',
		'drudgereport.com': 'dru',
		'dianomi.com': 'dia',
		google: 'goo',
	};

	Object.keys(lookup).forEach((url) => {
		const refererRegex = new RegExp(`^http(|s)://(www.)*(${url})`);
		/* istanbul ignore else  */
		if (refererRegex.test(referrer)) {
			codedValue = lookup[url];
		}
	});
	return codedValue && { socref: codedValue } || {};
};

Targeting.prototype.searchTerm = function () {
	const qs = utils.hash(utils.getQueryString(), /&|;/, '=');
	let keywords = qs.q || qs.s || qs.query || qs.queryText || qs.searchField || undefined;

	/* istanbul ignore else	*/
	if (keywords && keywords !== '') {
		keywords = unescape(keywords)
			.toLowerCase()
			.replace(/[';^+]/g, ' ')
			.replace(/\s+/g, ' ')
			.trim();
	}

	return { kw: keywords };
};

Targeting.prototype.timestamp = function () {
	return { ts: utils.getTimestamp() };
};

Targeting.prototype.responsive = function () {
	return config('responsive') ? { res: utils.responsive.getCurrent() } : {};
};

Targeting.prototype.debug = function () {
	const log = utils.log;
	const parameters = this.get();
	/* istanbul ignore else  */
	if (Object.keys(parameters).length !== 0) {
		log.start('Targeting');
		log.attributeTable(this.get());
		log.end();
	}
};

export default new Targeting();