-
Notifications
You must be signed in to change notification settings - Fork 213
/
vast-client.js
4101 lines (3904 loc) · 154 KB
/
vast-client.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
typeof define === 'function' && define.amd ? define(['exports'], factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.VAST = {}));
})(this, (function (exports) { 'use strict';
function ownKeys(object, enumerableOnly) {
var keys = Object.keys(object);
if (Object.getOwnPropertySymbols) {
var symbols = Object.getOwnPropertySymbols(object);
enumerableOnly && (symbols = symbols.filter(function (sym) {
return Object.getOwnPropertyDescriptor(object, sym).enumerable;
})), keys.push.apply(keys, symbols);
}
return keys;
}
function _objectSpread2(target) {
for (var i = 1; i < arguments.length; i++) {
var source = null != arguments[i] ? arguments[i] : {};
i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
_defineProperty(target, key, source[key]);
}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
});
}
return target;
}
function _typeof(obj) {
"@babel/helpers - typeof";
return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
return typeof obj;
} : function (obj) {
return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
}, _typeof(obj);
}
function _classCallCheck(instance, Constructor) {
if (!(instance instanceof Constructor)) {
throw new TypeError("Cannot call a class as a function");
}
}
function _defineProperties(target, props) {
for (var i = 0; i < props.length; i++) {
var descriptor = props[i];
descriptor.enumerable = descriptor.enumerable || false;
descriptor.configurable = true;
if ("value" in descriptor) descriptor.writable = true;
Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor);
}
}
function _createClass(Constructor, protoProps, staticProps) {
if (protoProps) _defineProperties(Constructor.prototype, protoProps);
if (staticProps) _defineProperties(Constructor, staticProps);
Object.defineProperty(Constructor, "prototype", {
writable: false
});
return Constructor;
}
function _defineProperty(obj, key, value) {
key = _toPropertyKey(key);
if (key in obj) {
Object.defineProperty(obj, key, {
value: value,
enumerable: true,
configurable: true,
writable: true
});
} else {
obj[key] = value;
}
return obj;
}
function _inherits(subClass, superClass) {
if (typeof superClass !== "function" && superClass !== null) {
throw new TypeError("Super expression must either be null or a function");
}
subClass.prototype = Object.create(superClass && superClass.prototype, {
constructor: {
value: subClass,
writable: true,
configurable: true
}
});
Object.defineProperty(subClass, "prototype", {
writable: false
});
if (superClass) _setPrototypeOf(subClass, superClass);
}
function _getPrototypeOf(o) {
_getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) {
return o.__proto__ || Object.getPrototypeOf(o);
};
return _getPrototypeOf(o);
}
function _setPrototypeOf(o, p) {
_setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) {
o.__proto__ = p;
return o;
};
return _setPrototypeOf(o, p);
}
function _isNativeReflectConstruct() {
if (typeof Reflect === "undefined" || !Reflect.construct) return false;
if (Reflect.construct.sham) return false;
if (typeof Proxy === "function") return true;
try {
Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {}));
return true;
} catch (e) {
return false;
}
}
function _assertThisInitialized(self) {
if (self === void 0) {
throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
}
return self;
}
function _possibleConstructorReturn(self, call) {
if (call && (typeof call === "object" || typeof call === "function")) {
return call;
} else if (call !== void 0) {
throw new TypeError("Derived constructors may only return object or undefined");
}
return _assertThisInitialized(self);
}
function _createSuper(Derived) {
var hasNativeReflectConstruct = _isNativeReflectConstruct();
return function _createSuperInternal() {
var Super = _getPrototypeOf(Derived),
result;
if (hasNativeReflectConstruct) {
var NewTarget = _getPrototypeOf(this).constructor;
result = Reflect.construct(Super, arguments, NewTarget);
} else {
result = Super.apply(this, arguments);
}
return _possibleConstructorReturn(this, result);
};
}
function _toConsumableArray(arr) {
return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
}
function _arrayWithoutHoles(arr) {
if (Array.isArray(arr)) return _arrayLikeToArray(arr);
}
function _iterableToArray(iter) {
if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
}
function _unsupportedIterableToArray(o, minLen) {
if (!o) return;
if (typeof o === "string") return _arrayLikeToArray(o, minLen);
var n = Object.prototype.toString.call(o).slice(8, -1);
if (n === "Object" && o.constructor) n = o.constructor.name;
if (n === "Map" || n === "Set") return Array.from(o);
if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
}
function _arrayLikeToArray(arr, len) {
if (len == null || len > arr.length) len = arr.length;
for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
return arr2;
}
function _nonIterableSpread() {
throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
}
function _toPrimitive(input, hint) {
if (typeof input !== "object" || input === null) return input;
var prim = input[Symbol.toPrimitive];
if (prim !== undefined) {
var res = prim.call(input, hint || "default");
if (typeof res !== "object") return res;
throw new TypeError("@@toPrimitive must return a primitive value.");
}
return (hint === "string" ? String : Number)(input);
}
function _toPropertyKey(arg) {
var key = _toPrimitive(arg, "string");
return typeof key === "symbol" ? key : String(key);
}
function createAd() {
var adAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
return {
id: adAttributes.id || null,
sequence: adAttributes.sequence || null,
adType: adAttributes.adType || null,
adServingId: null,
categories: [],
expires: null,
viewableImpression: [],
system: null,
title: null,
description: null,
advertiser: null,
pricing: null,
survey: null,
// @deprecated in VAST 4.1
errorURLTemplates: [],
impressionURLTemplates: [],
creatives: [],
extensions: [],
adVerifications: [],
blockedAdCategories: [],
followAdditionalWrappers: true,
allowMultipleAds: false,
fallbackOnNoAd: null
};
}
function createAdVerification() {
return {
resource: null,
vendor: null,
browserOptional: false,
apiFramework: null,
type: null,
parameters: null,
trackingEvents: {}
};
}
function createCompanionAd() {
var creativeAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
return {
id: creativeAttributes.id || null,
adType: 'companionAd',
width: creativeAttributes.width || 0,
height: creativeAttributes.height || 0,
assetWidth: creativeAttributes.assetWidth || null,
assetHeight: creativeAttributes.assetHeight || null,
expandedWidth: creativeAttributes.expandedWidth || null,
expandedHeight: creativeAttributes.expandedHeight || null,
apiFramework: creativeAttributes.apiFramework || null,
adSlotId: creativeAttributes.adSlotId || null,
pxratio: creativeAttributes.pxratio || '1',
renderingMode: creativeAttributes.renderingMode || 'default',
staticResources: [],
htmlResources: [],
iframeResources: [],
adParameters: null,
altText: null,
companionClickThroughURLTemplate: null,
companionClickTrackingURLTemplates: [],
trackingEvents: {}
};
}
function isCompanionAd(ad) {
return ad.adType === 'companionAd';
}
function createCreative() {
var creativeAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
return {
id: creativeAttributes.id || null,
adId: creativeAttributes.adId || null,
sequence: creativeAttributes.sequence || null,
apiFramework: creativeAttributes.apiFramework || null,
universalAdIds: [],
creativeExtensions: []
};
}
function createCreativeCompanion() {
var creativeAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
var _createCreative = createCreative(creativeAttributes),
id = _createCreative.id,
adId = _createCreative.adId,
sequence = _createCreative.sequence,
apiFramework = _createCreative.apiFramework;
return {
id: id,
adId: adId,
sequence: sequence,
apiFramework: apiFramework,
type: 'companion',
required: null,
variations: []
};
}
var supportedMacros = ['ADCATEGORIES', 'ADCOUNT', 'ADPLAYHEAD', 'ADSERVINGID', 'ADTYPE', 'APIFRAMEWORKS', 'APPBUNDLE', 'ASSETURI', 'BLOCKEDADCATEGORIES', 'BREAKMAXADLENGTH', 'BREAKMAXADS', 'BREAKMAXDURATION', 'BREAKMINADLENGTH', 'BREAKMINDURATION', 'BREAKPOSITION', 'CLICKPOS', 'CLICKTYPE', 'CLIENTUA', 'CONTENTID', 'CONTENTPLAYHEAD',
// @deprecated VAST 4.1
'CONTENTURI', 'DEVICEIP', 'DEVICEUA', 'DOMAIN', 'EXTENSIONS', 'GDPRCONSENT', 'IFA', 'IFATYPE', 'INVENTORYSTATE', 'LATLONG', 'LIMITADTRACKING', 'MEDIAMIME', 'MEDIAPLAYHEAD', 'OMIDPARTNER', 'PAGEURL', 'PLACEMENTTYPE', 'PLAYERCAPABILITIES', 'PLAYERSIZE', 'PLAYERSTATE', 'PODSEQUENCE', 'REGULATIONS', 'SERVERSIDE', 'SERVERUA', 'TRANSACTIONID', 'UNIVERSALADID', 'VASTVERSIONS', 'VERIFICATIONVENDORS'];
function track(URLTemplates, macros, options) {
var URLs = resolveURLTemplates(URLTemplates, macros, options);
URLs.forEach(function (URL) {
if (typeof window !== 'undefined' && window !== null) {
var i = new Image();
i.src = URL;
}
});
}
/**
* Replace the provided URLTemplates with the given values
*
* @param {Array} URLTemplates - An array of tracking url templates.
* @param {Object} [macros={}] - An optional Object of parameters to be used in the tracking calls.
* @param {Object} [options={}] - An optional Object of options to be used in the tracking calls.
*/
function resolveURLTemplates(URLTemplates) {
var macros = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
var resolvedURLs = [];
var URLArray = extractURLsFromTemplates(URLTemplates);
// Set default value for invalid ERRORCODE
if (macros['ERRORCODE'] && !options.isCustomCode && !/^[0-9]{3}$/.test(macros['ERRORCODE'])) {
macros['ERRORCODE'] = 900;
}
// Calc random/time based macros
macros['CACHEBUSTING'] = addLeadingZeros(Math.round(Math.random() * 1.0e8));
macros['TIMESTAMP'] = new Date().toISOString();
// RANDOM/random is not defined in VAST 3/4 as a valid macro tho it's used by some adServer (Auditude)
macros['RANDOM'] = macros['random'] = macros['CACHEBUSTING'];
for (var macro in macros) {
macros[macro] = encodeURIComponentRFC3986(macros[macro]);
}
for (var URLTemplateKey in URLArray) {
var resolveURL = URLArray[URLTemplateKey];
if (typeof resolveURL !== 'string') {
continue;
}
resolvedURLs.push(replaceUrlMacros(resolveURL, macros));
}
return resolvedURLs;
}
/**
* Replace the macros tracking url with their value.
* If no value is provided for a supported macro and it exists in the url,
* it will be replaced by -1 as described by the VAST 4.1 iab specifications
*
* @param {String} url - Tracking url.
* @param {Object} macros - Object of macros to be replaced in the tracking calls
*/
function replaceUrlMacros(url, macros) {
url = replaceMacrosValues(url, macros);
// match any macros from the url that was not replaced
var remainingMacros = url.match(/[^[\]]+(?=])/g);
if (!remainingMacros) {
return url;
}
var supportedRemainingMacros = remainingMacros.filter(function (macro) {
return supportedMacros.indexOf(macro) > -1;
});
if (supportedRemainingMacros.length === 0) {
return url;
}
supportedRemainingMacros = supportedRemainingMacros.reduce(function (accumulator, macro) {
accumulator[macro] = -1;
return accumulator;
}, {});
return replaceMacrosValues(url, supportedRemainingMacros);
}
/**
* Replace the macros tracking url with their value.
*
* @param {String} url - Tracking url.
* @param {Object} macros - Object of macros to be replaced in the tracking calls
*/
function replaceMacrosValues(url, macros) {
var replacedMacrosUrl = url;
for (var key in macros) {
var value = macros[key];
// this will match [${key}] and %%${key}%% and replace it
replacedMacrosUrl = replacedMacrosUrl.replace(new RegExp("(?:\\[|%%)(".concat(key, ")(?:\\]|%%)"), 'g'), value);
}
return replacedMacrosUrl;
}
/**
* Extract the url/s from the URLTemplates.
* If the URLTemplates is an array of urls
* If the URLTemplates object has a url property
* If the URLTemplates is a single string
*
* @param {Array|String} URLTemplates - An array|string of url templates.
*/
function extractURLsFromTemplates(URLTemplates) {
if (Array.isArray(URLTemplates)) {
return URLTemplates.map(function (URLTemplate) {
return URLTemplate && URLTemplate.hasOwnProperty('url') ? URLTemplate.url : URLTemplate;
});
}
return URLTemplates;
}
/**
* Filter URLTemplates elements to keep only valid and safe URL templates.
* To be valid, urls should:
* - have the same protocol as the client
* or
* - be protocol-relative urls
*
* @param {Array} URLTemplates - A Array of string/object containing urls templates.
*/
function filterValidUrlTemplates(URLTemplates) {
if (Array.isArray(URLTemplates)) {
return URLTemplates.filter(function (urlTemplate) {
var url = urlTemplate.hasOwnProperty('url') ? urlTemplate.url : urlTemplate;
return isValidUrl(url);
});
}
return isValidUrl(URLTemplates);
}
function isValidUrl(url) {
var regex = /^(https?:\/\/|\/\/)/;
return regex.test(url);
}
/**
* Returns a boolean after checking if the object exists in the array.
* true - if the object exists, false otherwise
*
* @param {Object} obj - The object who existence is to be checked.
* @param {Array} list - List of objects.
*/
function containsTemplateObject(obj, list) {
for (var i = 0; i < list.length; i++) {
if (isTemplateObjectEqual(list[i], obj)) {
return true;
}
}
return false;
}
/**
* Returns a boolean after comparing two Template objects.
* true - if the objects are equivalent, false otherwise
*
* @param {Object} obj1
* @param {Object} obj2
*/
function isTemplateObjectEqual(obj1, obj2) {
if (obj1 && obj2) {
var obj1Properties = Object.getOwnPropertyNames(obj1);
var obj2Properties = Object.getOwnPropertyNames(obj2);
// If number of properties is different, objects are not equivalent
if (obj1Properties.length !== obj2Properties.length) {
return false;
}
if (obj1.id !== obj2.id || obj1.url !== obj2.url) {
return false;
}
return true;
}
return false;
}
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
function encodeURIComponentRFC3986(str) {
return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
return "%".concat(c.charCodeAt(0).toString(16));
});
}
/**
* Return a string of the input number with leading zeros defined by the length param
*
* @param {Number} input - number to convert
* @param {Number} length - length of the desired string
*
* @return {String}
*/
function addLeadingZeros(input) {
var length = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 8;
return input.toString().padStart(length, '0');
}
function isNumeric(n) {
return !isNaN(parseFloat(n)) && isFinite(n);
}
function flatten(arr) {
return arr.reduce(function (flat, toFlatten) {
return flat.concat(Array.isArray(toFlatten) ? flatten(toFlatten) : toFlatten);
}, []);
}
/**
* Joins two arrays of objects without duplicates
*
* @param {Array} arr1
* @param {Array} arr2
*
* @return {Array}
*/
function joinArrayOfUniqueTemplateObjs() {
var arr1 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
var arr2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
var firstArr = Array.isArray(arr1) ? arr1 : [];
var secondArr = Array.isArray(arr2) ? arr2 : [];
var arr = firstArr.concat(secondArr);
return arr.reduce(function (res, val) {
if (!containsTemplateObject(val, res)) {
res.push(val);
}
return res;
}, []);
}
/**
* Check if a provided value is a valid time value according to the IAB definition
* Check if a provided value is a valid time value according to the IAB definition: Must be a positive number or -1.
* if not implemented by ad unit or -2 if value is unknown.
* @param {Number} time
*
* @return {Boolean}
*/
function isValidTimeValue(time) {
return Number.isFinite(time) && time >= -2;
}
var util = {
track: track,
resolveURLTemplates: resolveURLTemplates,
extractURLsFromTemplates: extractURLsFromTemplates,
filterValidUrlTemplates: filterValidUrlTemplates,
containsTemplateObject: containsTemplateObject,
isTemplateObjectEqual: isTemplateObjectEqual,
encodeURIComponentRFC3986: encodeURIComponentRFC3986,
replaceUrlMacros: replaceUrlMacros,
isNumeric: isNumeric,
flatten: flatten,
joinArrayOfUniqueTemplateObjs: joinArrayOfUniqueTemplateObjs,
isValidTimeValue: isValidTimeValue,
addLeadingZeros: addLeadingZeros
};
/**
* This module provides support methods to the parsing classes.
*/
/**
* Returns the first element of the given node which nodeName matches the given name.
* @param {Node} node - The node to use to find a match.
* @param {String} name - The name to look for.
* @return {Object|undefined}
*/
function childByName(node, name) {
var childNodes = node.childNodes;
for (var childKey in childNodes) {
var child = childNodes[childKey];
if (child.nodeName === name) {
return child;
}
}
}
/**
* Returns all the elements of the given node which nodeName match the given name.
* @param {Node} node - The node to use to find the matches.
* @param {String} name - The name to look for.
* @return {Array}
*/
function childrenByName(node, name) {
var children = [];
var childNodes = node.childNodes;
for (var childKey in childNodes) {
var child = childNodes[childKey];
if (child.nodeName === name) {
children.push(child);
}
}
return children;
}
/**
* Converts relative vastAdTagUri.
* @param {String} vastAdTagUrl - The url to resolve.
* @param {String} originalUrl - The original url.
* @return {String}
*/
function resolveVastAdTagURI(vastAdTagUrl, originalUrl) {
if (!originalUrl) {
return vastAdTagUrl;
}
if (vastAdTagUrl.indexOf('//') === 0) {
var _location = location,
protocol = _location.protocol;
return "".concat(protocol).concat(vastAdTagUrl);
}
if (vastAdTagUrl.indexOf('://') === -1) {
// Resolve relative URLs (mainly for unit testing)
var baseURL = originalUrl.slice(0, originalUrl.lastIndexOf('/'));
return "".concat(baseURL, "/").concat(vastAdTagUrl);
}
return vastAdTagUrl;
}
/**
* Converts a boolean string into a Boolean.
* @param {String} booleanString - The boolean string to convert.
* @return {Boolean}
*/
function parseBoolean(booleanString) {
return ['true', 'TRUE', 'True', '1'].indexOf(booleanString) !== -1;
}
/**
* Parses a node text (for legacy support).
* @param {Object} node - The node to parse the text from.
* @return {String}
*/
function parseNodeText(node) {
return node && (node.textContent || node.text || '').trim();
}
/**
* Copies an attribute from a node to another.
* @param {String} attributeName - The name of the attribute to clone.
* @param {Object} nodeSource - The source node to copy the attribute from.
* @param {Object} nodeDestination - The destination node to copy the attribute at.
*/
function copyNodeAttribute(attributeName, nodeSource, nodeDestination) {
var attributeValue = nodeSource.getAttribute(attributeName);
if (attributeValue) {
nodeDestination.setAttribute(attributeName, attributeValue);
}
}
/**
* Converts element attributes into an object, where object key is attribute name
* and object value is attribute value
* @param {Element} element
* @returns {Object}
*/
function parseAttributes(element) {
var nodeAttributes = element.attributes;
var attributes = {};
for (var i = 0; i < nodeAttributes.length; i++) {
attributes[nodeAttributes[i].nodeName] = nodeAttributes[i].nodeValue;
}
return attributes;
}
/**
* Parses a String duration into a Number.
* @param {String} durationString - The dureation represented as a string.
* @return {Number}
*/
function parseDuration(durationString) {
if (durationString === null || typeof durationString === 'undefined') {
return -1;
}
// Some VAST doesn't have an HH:MM:SS duration format but instead jus the number of seconds
if (util.isNumeric(durationString)) {
return parseInt(durationString);
}
var durationComponents = durationString.split(':');
if (durationComponents.length !== 3) {
return -1;
}
var secondsAndMS = durationComponents[2].split('.');
var seconds = parseInt(secondsAndMS[0]);
if (secondsAndMS.length === 2) {
seconds += parseFloat("0.".concat(secondsAndMS[1]));
}
var minutes = parseInt(durationComponents[1] * 60);
var hours = parseInt(durationComponents[0] * 60 * 60);
if (isNaN(hours) || isNaN(minutes) || isNaN(seconds) || minutes > 60 * 60 || seconds > 60) {
return -1;
}
return hours + minutes + seconds;
}
/**
* Splits an Array of ads into an Array of Arrays of ads.
* Each subarray contains either one ad or multiple ads (an AdPod)
* @param {Array} ads - An Array of ads to split
* @return {Array}
*/
function splitVAST(ads) {
var splittedVAST = [];
var lastAdPod = null;
ads.forEach(function (ad, i) {
if (ad.sequence) {
ad.sequence = parseInt(ad.sequence, 10);
}
// The current Ad may be the next Ad of an AdPod
if (ad.sequence > 1) {
var lastAd = ads[i - 1];
// check if the current Ad is exactly the next one in the AdPod
if (lastAd && lastAd.sequence === ad.sequence - 1) {
lastAdPod && lastAdPod.push(ad);
return;
}
// If the ad had a sequence attribute but it was not part of a correctly formed
// AdPod, let's remove the sequence attribute
delete ad.sequence;
}
lastAdPod = [ad];
splittedVAST.push(lastAdPod);
});
return splittedVAST;
}
/**
* Parses the attributes and assign them to object
* @param {Object} attributes attribute
* @param {Object} verificationObject with properties which can be assigned
*/
function assignAttributes(attributes, verificationObject) {
if (attributes) {
for (var attrKey in attributes) {
var attribute = attributes[attrKey];
if (attribute.nodeName && attribute.nodeValue && verificationObject.hasOwnProperty(attribute.nodeName)) {
var value = attribute.nodeValue;
if (typeof verificationObject[attribute.nodeName] === 'boolean') {
value = parseBoolean(value);
}
verificationObject[attribute.nodeName] = value;
}
}
}
}
/**
* Merges the data between an unwrapped ad and his wrapper.
* @param {Ad} unwrappedAd - The 'unwrapped' Ad.
* @param {Ad} wrapper - The wrapper Ad.
* @return {void}
*/
function mergeWrapperAdData(unwrappedAd, wrapper) {
var _wrapper$creatives;
unwrappedAd.errorURLTemplates = wrapper.errorURLTemplates.concat(unwrappedAd.errorURLTemplates);
unwrappedAd.impressionURLTemplates = wrapper.impressionURLTemplates.concat(unwrappedAd.impressionURLTemplates);
unwrappedAd.extensions = wrapper.extensions.concat(unwrappedAd.extensions);
if (wrapper.viewableImpression.length > 0) {
unwrappedAd.viewableImpression = [].concat(_toConsumableArray(unwrappedAd.viewableImpression), _toConsumableArray(wrapper.viewableImpression));
}
// values from the child wrapper will be overridden
unwrappedAd.followAdditionalWrappers = wrapper.followAdditionalWrappers;
unwrappedAd.allowMultipleAds = wrapper.allowMultipleAds;
unwrappedAd.fallbackOnNoAd = wrapper.fallbackOnNoAd;
var wrapperCompanions = (wrapper.creatives || []).filter(function (creative) {
return creative && creative.type === 'companion';
});
var wrapperCompanionClickTracking = wrapperCompanions.reduce(function (result, creative) {
(creative.variations || []).forEach(function (variation) {
(variation.companionClickTrackingURLTemplates || []).forEach(function (companionClickTrackingURLTemplate) {
if (!util.containsTemplateObject(companionClickTrackingURLTemplate, result)) {
result.push(companionClickTrackingURLTemplate);
}
});
});
return result;
}, []);
unwrappedAd.creatives = wrapperCompanions.concat(unwrappedAd.creatives);
var wrapperHasVideoClickTracking = wrapper.videoClickTrackingURLTemplates && wrapper.videoClickTrackingURLTemplates.length;
var wrapperHasVideoCustomClick = wrapper.videoCustomClickURLTemplates && wrapper.videoCustomClickURLTemplates.length;
unwrappedAd.creatives.forEach(function (creative) {
// merge tracking events
if (wrapper.trackingEvents && wrapper.trackingEvents[creative.type]) {
for (var eventName in wrapper.trackingEvents[creative.type]) {
var urls = wrapper.trackingEvents[creative.type][eventName];
if (!Array.isArray(creative.trackingEvents[eventName])) {
creative.trackingEvents[eventName] = [];
}
creative.trackingEvents[eventName] = creative.trackingEvents[eventName].concat(urls);
}
}
if (creative.type === 'linear') {
// merge video click tracking url
if (wrapperHasVideoClickTracking) {
creative.videoClickTrackingURLTemplates = creative.videoClickTrackingURLTemplates.concat(wrapper.videoClickTrackingURLTemplates);
}
// merge video custom click url
if (wrapperHasVideoCustomClick) {
creative.videoCustomClickURLTemplates = creative.videoCustomClickURLTemplates.concat(wrapper.videoCustomClickURLTemplates);
}
// VAST 2.0 support - Use Wrapper/linear/clickThrough when Inline/Linear/clickThrough is null
if (wrapper.videoClickThroughURLTemplate && (creative.videoClickThroughURLTemplate === null || typeof creative.videoClickThroughURLTemplate === 'undefined')) {
creative.videoClickThroughURLTemplate = wrapper.videoClickThroughURLTemplate;
}
}
// pass wrapper companion trackers to all companions
if (creative.type === 'companion' && wrapperCompanionClickTracking.length) {
(creative.variations || []).forEach(function (variation) {
variation.companionClickTrackingURLTemplates = util.joinArrayOfUniqueTemplateObjs(variation.companionClickTrackingURLTemplates, wrapperCompanionClickTracking);
});
}
});
if (wrapper.adVerifications) {
// As specified by VAST specs unwrapped ads should contains wrapper adVerification script
unwrappedAd.adVerifications = unwrappedAd.adVerifications.concat(wrapper.adVerifications);
}
if (wrapper.blockedAdCategories) {
unwrappedAd.blockedAdCategories = unwrappedAd.blockedAdCategories.concat(wrapper.blockedAdCategories);
}
// Merge Wrapper's creatives containing icon elements
if ((_wrapper$creatives = wrapper.creatives) !== null && _wrapper$creatives !== void 0 && _wrapper$creatives.length) {
// As specified by VAST specs, wrapper should not contain any mediafiles
var wrapperCreativesWithIconsNode = wrapper.creatives.filter(function (creative) {
var _creative$icons;
return ((_creative$icons = creative.icons) === null || _creative$icons === void 0 ? void 0 : _creative$icons.length) && !creative.mediaFiles.length;
});
if (wrapperCreativesWithIconsNode.length) {
unwrappedAd.creatives = unwrappedAd.creatives.concat(wrapperCreativesWithIconsNode);
}
}
}
var parserUtils = {
childByName: childByName,
childrenByName: childrenByName,
resolveVastAdTagURI: resolveVastAdTagURI,
parseBoolean: parseBoolean,
parseNodeText: parseNodeText,
copyNodeAttribute: copyNodeAttribute,
parseAttributes: parseAttributes,
parseDuration: parseDuration,
splitVAST: splitVAST,
assignAttributes: assignAttributes,
mergeWrapperAdData: mergeWrapperAdData
};
/**
* This module provides methods to parse a VAST CompanionAd Element.
*/
/**
* Parses a CompanionAd.
* @param {Object} creativeElement - The VAST CompanionAd element to parse.
* @param {Object} creativeAttributes - The attributes of the CompanionAd (optional).
* @return {Object} creative - The creative object.
*/
function parseCreativeCompanion(creativeElement, creativeAttributes) {
var creative = createCreativeCompanion(creativeAttributes);
creative.required = creativeElement.getAttribute('required') || null;
creative.variations = parserUtils.childrenByName(creativeElement, 'Companion').map(function (companionResource) {
var companionAd = createCompanionAd(parserUtils.parseAttributes(companionResource));
companionAd.htmlResources = parserUtils.childrenByName(companionResource, 'HTMLResource').reduce(function (urls, resource) {
var url = parserUtils.parseNodeText(resource);
return url ? urls.concat(url) : urls;
}, []);
companionAd.iframeResources = parserUtils.childrenByName(companionResource, 'IFrameResource').reduce(function (urls, resource) {
var url = parserUtils.parseNodeText(resource);
return url ? urls.concat(url) : urls;
}, []);
companionAd.staticResources = parserUtils.childrenByName(companionResource, 'StaticResource').reduce(function (urls, resource) {
var url = parserUtils.parseNodeText(resource);
return url ? urls.concat({
url: url,
creativeType: resource.getAttribute('creativeType') || null
}) : urls;
}, []);
companionAd.altText = parserUtils.parseNodeText(parserUtils.childByName(companionResource, 'AltText')) || null;
var trackingEventsElement = parserUtils.childByName(companionResource, 'TrackingEvents');
if (trackingEventsElement) {
parserUtils.childrenByName(trackingEventsElement, 'Tracking').forEach(function (trackingElement) {
var eventName = trackingElement.getAttribute('event');
var trackingURLTemplate = parserUtils.parseNodeText(trackingElement);
if (eventName && trackingURLTemplate) {
if (!Array.isArray(companionAd.trackingEvents[eventName])) {
companionAd.trackingEvents[eventName] = [];
}
companionAd.trackingEvents[eventName].push(trackingURLTemplate);
}
});
}
companionAd.companionClickTrackingURLTemplates = parserUtils.childrenByName(companionResource, 'CompanionClickTracking').map(function (clickTrackingElement) {
return {
id: clickTrackingElement.getAttribute('id') || null,
url: parserUtils.parseNodeText(clickTrackingElement)
};
});
companionAd.companionClickThroughURLTemplate = parserUtils.parseNodeText(parserUtils.childByName(companionResource, 'CompanionClickThrough')) || null;
var adParametersElement = parserUtils.childByName(companionResource, 'AdParameters');
if (adParametersElement) {
companionAd.adParameters = {
value: parserUtils.parseNodeText(adParametersElement),
xmlEncoded: adParametersElement.getAttribute('xmlEncoded') || null
};
}
return companionAd;
});
return creative;
}
function createCreativeLinear() {
var creativeAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
var _createCreative = createCreative(creativeAttributes),
id = _createCreative.id,
adId = _createCreative.adId,
sequence = _createCreative.sequence,
apiFramework = _createCreative.apiFramework;
return {
id: id,
adId: adId,
sequence: sequence,
apiFramework: apiFramework,
type: 'linear',
duration: 0,
skipDelay: null,
mediaFiles: [],
mezzanine: null,
interactiveCreativeFile: null,
closedCaptionFiles: [],
videoClickThroughURLTemplate: null,
videoClickTrackingURLTemplates: [],
videoCustomClickURLTemplates: [],
adParameters: null,
icons: [],
trackingEvents: {}
};
}
function isCreativeLinear(ad) {
return ad.type === 'linear';
}
function createClosedCaptionFile() {
var closedCaptionAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
return {
type: closedCaptionAttributes.type || null,
language: closedCaptionAttributes.language || null,
fileURL: null
};
}
function createIcon() {
return {
program: null,
height: 0,
width: 0,
xPosition: 0,
yPosition: 0,
apiFramework: null,
offset: null,
duration: 0,
type: null,
staticResource: null,
htmlResource: null,
iframeResource: null,
pxratio: '1',
iconClickThroughURLTemplate: null,
iconClickTrackingURLTemplates: [],
iconViewTrackingURLTemplate: null,
iconClickFallbackImages: []
};
}
function createInteractiveCreativeFile() {
var interactiveCreativeAttributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
return {
type: interactiveCreativeAttributes.type || null,
apiFramework: interactiveCreativeAttributes.apiFramework || null,
variableDuration: parserUtils.parseBoolean(interactiveCreativeAttributes.variableDuration),
fileURL: null
};
}
function createMediaFile() {
return {
id: null,
fileURL: null,
fileSize: 0,
deliveryType: 'progressive',
mimeType: null,
mediaType: null,
codec: null,
bitrate: 0,
minBitrate: 0,
maxBitrate: 0,
width: 0,
height: 0,
apiFramework: null,
// @deprecated in VAST 4.1. <InteractiveCreativeFile> should be used instead.
scalable: null,
maintainAspectRatio: null
};
}
function createMezzanine() {
return {
id: null,
fileURL: null,
delivery: null,
codec: null,
type: null,
width: 0,
height: 0,
fileSize: 0,
mediaType: '2D'
};
}
/**
* This module provides methods to parse a VAST Linear Element.
*/
/**
* Parses a Linear element.