|
| 1 | +'use strict'; |
| 2 | + |
| 3 | +/** |
| 4 | + * Module dependencies. |
| 5 | + */ |
| 6 | + |
| 7 | +var each = require('@ndhoule/each'); |
| 8 | +var integration = require('@segment/analytics.js-integration'); |
| 9 | +var push = require('global-queue')('$CVO'); |
| 10 | + |
| 11 | +/** |
| 12 | + * Expose `Convertro` integration. |
| 13 | + */ |
| 14 | + |
| 15 | +var Convertro = module.exports = integration('Convertro') |
| 16 | + .global('$CVO') |
| 17 | + .global('__cvo') |
| 18 | + .option('account', '') |
| 19 | + .option('hybridAttributionModel', false) |
| 20 | + .mapping('events') |
| 21 | + .tag('<script src="//d1ivexoxmp59q7.cloudfront.net/{{ account }}/live.js">'); |
| 22 | + |
| 23 | +/** |
| 24 | + * Initialize. |
| 25 | + */ |
| 26 | + |
| 27 | +Convertro.prototype.initialize = function() { |
| 28 | + this.load(this.ready); |
| 29 | +}; |
| 30 | + |
| 31 | +/** |
| 32 | + * Loaded? |
| 33 | + * |
| 34 | + * @api public |
| 35 | + * @return {boolean} |
| 36 | + */ |
| 37 | + |
| 38 | +Convertro.prototype.loaded = function() { |
| 39 | + return typeof (window.$CVO && window.$CVO.trackEvent) === 'function'; |
| 40 | +}; |
| 41 | + |
| 42 | +/** |
| 43 | + * Identify. |
| 44 | + * |
| 45 | + * @api public |
| 46 | + * @param {Facade} identify |
| 47 | + */ |
| 48 | + |
| 49 | +Convertro.prototype.identify = function(identify) { |
| 50 | + if (!identify.userId()) return; |
| 51 | + push('trackUser', identify.traits()); |
| 52 | +}; |
| 53 | + |
| 54 | +/** |
| 55 | + * Track. |
| 56 | + * |
| 57 | + * @api public |
| 58 | + * @param {Track} track |
| 59 | + */ |
| 60 | + |
| 61 | +Convertro.prototype.track = function(track) { |
| 62 | + var events = this.events(track.event()); |
| 63 | + var revenue = track.revenue(); |
| 64 | + var total = track.total(); |
| 65 | + each(function(type) { |
| 66 | + push('trackEvent', { |
| 67 | + amount: total ? total : revenue, |
| 68 | + id: track.orderId(), |
| 69 | + type: type |
| 70 | + }); |
| 71 | + }, events); |
| 72 | +}; |
| 73 | + |
| 74 | +/** |
| 75 | + * Order Completed & Attribution model |
| 76 | + * - Convertro has two attribution models |
| 77 | + * - the first is for when you don't know if clients are new/repeat |
| 78 | + * - the second is for when you know if a client is new/repeat |
| 79 | + * - The hybridAttributionModel allows users to |
| 80 | + * - move between the two attribution models |
| 81 | + * |
| 82 | + * - option=hybridAttributionModel (true) |
| 83 | + * - type="sale" && "sale.new"(.repeat=false), when it's a new order. |
| 84 | + * - type="sale" && "sale.repeat"(.repeat=true), when it's repeat order |
| 85 | + * - type="sale" (.repeat=null), when you can't figure out if an order is repeat / new |
| 86 | + * |
| 87 | + * - option=hybridAttributionModel (false) |
| 88 | + * - type="sale.new"(.repeat=false), when it's a new order. |
| 89 | + * - type="sale.repeat"(.repeat=true), when it's repeat order. |
| 90 | + * - type="sale" (.repeat=null), when you can't figure out if an order is repeat / new |
| 91 | + * |
| 92 | + * |
| 93 | + * @api public |
| 94 | + * @param {Track} track |
| 95 | + */ |
| 96 | + |
| 97 | +Convertro.prototype.orderCompleted = function(track) { |
| 98 | + var repeat = track.proxy('properties.repeat'); |
| 99 | + var amount = track.total() || track.revenue(); |
| 100 | + var id = track.orderId(); |
| 101 | + |
| 102 | + if (typeof repeat === 'boolean') { |
| 103 | + push('trackEvent', { |
| 104 | + id: id, |
| 105 | + type: repeat ? 'sale.repeat' : 'sale.new', |
| 106 | + amount: amount |
| 107 | + }); |
| 108 | + } |
| 109 | + |
| 110 | + if (typeof repeat !== 'boolean' || this.options.hybridAttributionModel) { |
| 111 | + push('trackEvent', { |
| 112 | + id: id, |
| 113 | + type: 'sale', |
| 114 | + amount: amount |
| 115 | + }); |
| 116 | + } |
| 117 | +}; |
0 commit comments