|
| 1 | +'use strict'; |
| 2 | +/* global JSON */ |
| 3 | +/* eslint no-restricted-globals: [0] */ |
| 4 | + |
| 5 | +/** |
| 6 | + * Module dependencies. |
| 7 | + */ |
| 8 | + |
| 9 | +var integration = require('@segment/analytics.js-integration'); |
| 10 | +var each = require('component-each'); |
| 11 | +var is = require('is'); |
| 12 | +var extend = require('@ndhoule/extend'); |
| 13 | +var toISOString = require('@segment/to-iso-string'); |
| 14 | +var toString = Object.prototype.toString; // in case this method has been overridden by the user |
| 15 | + |
| 16 | +/** |
| 17 | + * Expose `Heap` integration. |
| 18 | + */ |
| 19 | + |
| 20 | +var Heap = module.exports = integration('Heap') |
| 21 | + .global('heap') |
| 22 | + .option('appId', '') |
| 23 | + .tag('<script src="//cdn.heapanalytics.com/js/heap-{{ appId }}.js">'); |
| 24 | + |
| 25 | +/** |
| 26 | + * Initialize. |
| 27 | + * |
| 28 | + * https://heapanalytics.com/docs/installation#web |
| 29 | + * |
| 30 | + * @api public |
| 31 | + */ |
| 32 | + |
| 33 | +Heap.prototype.initialize = function() { |
| 34 | + window.heap = window.heap || []; |
| 35 | + window.heap.load = function(appid, config) { |
| 36 | + window.heap.appid = appid; |
| 37 | + window.heap.config = config; |
| 38 | + |
| 39 | + var methodFactory = function(type) { |
| 40 | + return function() { |
| 41 | + window.heap.push([type].concat(Array.prototype.slice.call(arguments, 0))); |
| 42 | + }; |
| 43 | + }; |
| 44 | + |
| 45 | + var heapMethods = ['addEventProperties', 'addUserProperties', 'clearEventProperties', 'identify', 'removeEventProperty', 'setEventProperties', 'track', 'unsetEventProperty', 'resetIdentity']; |
| 46 | + each(heapMethods, function(method) { |
| 47 | + window.heap[method] = methodFactory(method); |
| 48 | + }); |
| 49 | + }; |
| 50 | + |
| 51 | + window.heap.load(this.options.appId); |
| 52 | + this.load(this.ready); |
| 53 | +}; |
| 54 | + |
| 55 | +/** |
| 56 | + * Loaded? |
| 57 | + * |
| 58 | + * @api private |
| 59 | + * @return {boolean} |
| 60 | + */ |
| 61 | + |
| 62 | +Heap.prototype.loaded = function() { |
| 63 | + return !!(window.heap && window.heap.appid); |
| 64 | +}; |
| 65 | + |
| 66 | +/** |
| 67 | + * Identify. |
| 68 | + * |
| 69 | + * https://heapanalytics.com/docs#identify |
| 70 | + * |
| 71 | + * @api public |
| 72 | + * @param {Identify} identify |
| 73 | + */ |
| 74 | + |
| 75 | +Heap.prototype.identify = function(identify) { |
| 76 | + var traits = identify.traits({ email: '_email' }); |
| 77 | + var id = identify.userId(); |
| 78 | + if (id) window.heap.identify(id); |
| 79 | + window.heap.addUserProperties(clean(traits)); |
| 80 | +}; |
| 81 | + |
| 82 | +/** |
| 83 | + * Track. |
| 84 | + * |
| 85 | + * https://heapanalytics.com/docs#track |
| 86 | + * |
| 87 | + * @api public |
| 88 | + * @param {Track} track |
| 89 | + */ |
| 90 | + |
| 91 | +Heap.prototype.track = function(track) { |
| 92 | + window.heap.track(track.event(), clean(track.properties())); |
| 93 | +}; |
| 94 | + |
| 95 | +/** |
| 96 | + * Clean all nested objects and arrays. |
| 97 | + * |
| 98 | + * @param {Object} obj |
| 99 | + * @return {Object} |
| 100 | + * @api private |
| 101 | + */ |
| 102 | + |
| 103 | +function clean(obj) { |
| 104 | + var ret = {}; |
| 105 | + |
| 106 | + for (var k in obj) { |
| 107 | + if (obj.hasOwnProperty(k)) { |
| 108 | + var value = obj[k]; |
| 109 | + // Heap's natively library will drop null and undefined properties anyway |
| 110 | + // so no need to send these |
| 111 | + // also prevents uncaught errors since we call .toString() on non objects |
| 112 | + if (value === null || value === undefined) continue; |
| 113 | + |
| 114 | + // date |
| 115 | + if (is.date(value)) { |
| 116 | + ret[k] = toISOString(value); |
| 117 | + continue; |
| 118 | + } |
| 119 | + |
| 120 | + // leave boolean as is |
| 121 | + if (is.bool(value)) { |
| 122 | + ret[k] = value; |
| 123 | + continue; |
| 124 | + } |
| 125 | + |
| 126 | + // leave numbers as is |
| 127 | + if (is.number(value)) { |
| 128 | + ret[k] = value; |
| 129 | + continue; |
| 130 | + } |
| 131 | + |
| 132 | + // arrays of objects (eg. `products` array) |
| 133 | + if (toString.call(value) === '[object Array]') { |
| 134 | + ret = extend(ret, trample(k, value)); |
| 135 | + continue; |
| 136 | + } |
| 137 | + |
| 138 | + // non objects |
| 139 | + if (toString.call(value) !== '[object Object]') { |
| 140 | + ret[k] = value.toString(); |
| 141 | + continue; |
| 142 | + } |
| 143 | + |
| 144 | + ret = extend(ret, trample(k, value)); |
| 145 | + } |
| 146 | + } |
| 147 | + // json |
| 148 | + // must flatten including the name of the original trait/property |
| 149 | + function trample(key, value) { |
| 150 | + var nestedObj = {}; |
| 151 | + nestedObj[key] = value; |
| 152 | + var flattenedObj = flatten(nestedObj, { safe: true }); |
| 153 | + |
| 154 | + // stringify arrays inside nested object to be consistent with top level behavior of arrays |
| 155 | + for (var k in flattenedObj) { |
| 156 | + if (is.array(flattenedObj[k])) flattenedObj[k] = JSON.stringify(flattenedObj[k]); |
| 157 | + } |
| 158 | + |
| 159 | + return flattenedObj; |
| 160 | + } |
| 161 | + |
| 162 | + return ret; |
| 163 | +} |
| 164 | + |
| 165 | +/** |
| 166 | + * Flatten nested objects |
| 167 | + * taken from https://www.npmjs.com/package/flat |
| 168 | + * @param {Object} obj |
| 169 | + * @return {Object} obj |
| 170 | + * @api public |
| 171 | + */ |
| 172 | + |
| 173 | +function flatten(target, opts) { |
| 174 | + opts = opts || {}; |
| 175 | + |
| 176 | + var delimiter = opts.delimiter || '.'; |
| 177 | + var maxDepth = opts.maxDepth; |
| 178 | + var currentDepth = 1; |
| 179 | + var output = {}; |
| 180 | + |
| 181 | + function step(object, prev) { |
| 182 | + Object.keys(object).forEach(function(key) { |
| 183 | + var value = object[key]; |
| 184 | + var isarray = opts.safe && Array.isArray(value); |
| 185 | + var type = Object.prototype.toString.call(value); |
| 186 | + var isobject = type === '[object Object]' || type === '[object Array]'; |
| 187 | + |
| 188 | + var newKey = prev |
| 189 | + ? prev + delimiter + key |
| 190 | + : key; |
| 191 | + |
| 192 | + if (!opts.maxDepth) { |
| 193 | + maxDepth = currentDepth + 1; |
| 194 | + } |
| 195 | + |
| 196 | + if (!isarray && isobject && Object.keys(value).length && currentDepth < maxDepth) { |
| 197 | + ++currentDepth; |
| 198 | + return step(value, newKey); |
| 199 | + } |
| 200 | + |
| 201 | + output[newKey] = value; |
| 202 | + }); |
| 203 | + } |
| 204 | + |
| 205 | + step(target); |
| 206 | + |
| 207 | + return output; |
| 208 | +} |
| 209 | + |
| 210 | +/** |
| 211 | + * Polyfill Object.keys |
| 212 | + * // From https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys |
| 213 | + * Note: Had to do this because for some reason, the above will not work properly without using Object.keys |
| 214 | + */ |
| 215 | + |
| 216 | +if (!Object.keys) { |
| 217 | + Object.keys = function(o) { |
| 218 | + if (o !== Object(o)) { |
| 219 | + throw new TypeError('Object.keys called on a non-object'); |
| 220 | + } |
| 221 | + var k = []; |
| 222 | + var p; |
| 223 | + for (p in o) if (Object.prototype.hasOwnProperty.call(o, p)) k.push(p); |
| 224 | + return k; |
| 225 | + }; |
| 226 | +} |
0 commit comments