Releases: dailymotion/vast-client-js
Version 6.0.1
Fixes
- #475 - Fix issue where ads where merged if the first ad was empty
Version 6.0.0
Breaking change
- #458 Modularize VAST Client by @Rapha0511
⚠️ parseVAST
method from theVASTParser
class, will only parse the first VAST encountered. To follow a wrappers chain please useparseVAST
method from "VASTClient" class.⚠️ TheIIFE
built format is no longer generated as it is now possible to import ES modules format by specifying thetype="module"
.⚠️ TheUMD
format is no longer generated because it is obsolete, please use ES modules instead.
Enhancements:
- #458 Modularize VAST Client by @Rapha0511
- New VASTClient class method
parseVAST
to parse VAST XML document and follow any wrappers chain. - All VASTClient class methods related to URLTemplateFilter are now public method of VASTClient class.
- Remaining Mocha have been migrated to Jest. VASTClient project is now only using Jest for unit tests.
- New VASTClient class method
- #467 Upgraded fetching method, added error logging, and code refactoring by @Rapha0511.
- Added a new VASTTracker class event
TRACKER-error
that can be listen to retreive any error related to trackers. - The VASTClient class now uses
fetch
API for browser and node environment instead ofXMLHttpRequest
.
- Added a new VASTTracker class event
- #461 add trackOnce parameter to VASTTracker
setProgress
by @rs-guian. - #470 VASTClient integration example by @Rapha0511.
- VASTClient integration and usage example is now available in the example folder.
Fixes
- #466 Fix a bug where fallback was not working if the first ad element was empty by @Rapha0511.
New Contributors
Full Changelog: 5.0.0...6.0.0
Version 5.0.0
Breaking changes
- #444 Add missing nodes to the parsing
⚠️ TheadSlotID
attribute ofCompanionAd
object has been modified toadSlotId
to follow the VAST specs.⚠️ Thetype
attribute of the<Survey>
node is now parsed. The parsed<Survey>
node is now an Object{value: String, type: String}
.⚠️ xmlEncoded
is now considered as an attribute of the<adParameters>
node, instead of a node by itself. The value of is now an Object{value: String, xmlEncoded: String}
.<IconClickFallbackImages>
node is now parsed.- Now,
<Icon>
wrapper elements will be merged with the final Inline.- The
parseDuration
function is now exposed publicly as a VASTParser method to allow users to convert timecode to seconds.
- #454 Methods to trigger viewable impression trackers
⚠️ The attributesviewable
,notviewable
andviewundetermined
have been modified toviewable
,notViewable
andviewUndetermined
.- 3 public methods are now available to track viewable impression URI
trackViewableImpression()
to report all<Viewable>
URItrackNotViewableImpression()
to report all<notViewable>
URItrackUndeterminedImpression()
to report all<ViewableUndetermined>
URI
Enhancements
Fixes
- #443 Add muted argument to constructor
The
setMuted
method assumes thatmuted
property is false by default. Thus, theunmute
tracking event will not fire if the player was in a muted state.
- #452 Handle duplicate VASTAdTagURI in AdPod
Wrappers within an AdPod can now reference the same
VASTAdTagURI
.
Full Changelog: 4.0.1...5.0.0
Version 4.0.1
Enhancements
- #432 Update VASTTracker documentation
Fixes
- #431 Add safeguards to public methods
Full Changelog: 4.0.0...4.0.1
Version 4.0.0
Breaking changes
- #377 Allow parsing of multiple UniversalAdID.
⚠️ The final ad object parsed will no longer contain theuniversalAdId
property but theuniversalAdIds
property which will contain an array ofuniversalAdId
.
- #395 Merge wrapper ViewableImpression with the inline one.
⚠️ The propertyViewableImpression
is now an array of object instead of a single object.
Enhancements
- #420 Add ad data to VAST-resolving events
- #383 Add new public error method to vastTracker API documentation.
- #419 Update dependencies
Fixes
- #414 Fix typo in the documentation
Full Changelog: 3.3.0...4.0.0
Version 3.3.0
Enhancements
#411 Update master branch to 3.X to benefit latest fixes
Version 3.2.0
Version 3.1.1
Fixes
- #381 - Fix rollup config for node_url_handler
Version 3.1.0
Version 3.0.0
Breaking changes
The release of the 3.0 version of the library introduced many breaking changes in the API.
For a list of breaking changes please refer to the migration document https://github.com/dailymotion/vast-client-js/blob/master/docs/api/3.0-migration.md and to the list of merged Pull Requests below.
Fixes
- #358 - Remove CONTENTPLAYHEAD and MEDIAPLAYHEAD macro and fix timecode generation
- #363 - Keep wrapper sequence value when containing only one final ad
- #365 - Fix percentage tracker bug
- #367 - Fix missing macros in trackImpression and add VAST 4.2 macros
- #355 - Fix missing default value for optional parameter on track method
- #354 - Fix missing slash in the url for file path
- #347 - Fix node_url_handler bad import
Enhancements
- #368 - Update dependencies
- #361 - Improve 3.0-version documentation
- #337 - Add 3.0-version migration docs
- #345 - Autofill ADTYPE, ADSERVINGID & ADCATEGORIES macros when set
- #343 - Implement missing attributes and sub elements of Wrapper
- #340 - Add performance test for parsing time
- #351 - Merge Wrapper adVerification with current unwrapped adVerification
- #342 - Add missing VAST 4 Macros
- #341 - Implement missing attributes and sub elements of Ad/Inline
- #307 - Send warning event on missing required fields
- #313 - Migrate event emitter unit tests from mocha to jest
- #315 - Add missing tracker to docs
- #326 - Add id attribute to missing elements
- #327 - Replaced classes with objects
- #328 - Add tool to compare bundle sizes
- #329 - Implement missing attributes for Companion ads and Icons
- #330 - Implement missing sub elements for Creative
- #332 - Add more info on fetching/parsing
- #333 - Implement missing VAST 4 trackers
- #335 - Implement missing attributes and sub elements for MediaFile
- #339 - Implement missing sub elements of AdVerification
- #304 - Support Mezzanine for VAST 4
- #303 - Support Ad Verification for VAST 4
- #296 - Support Linear ads events and Player Operation events for VAST 4
- #290 - Parse vast version
- #289 - Add companion creatives in wrapper to parsed creatives
- #280 - Support VAST 3.0 Companion ads
- #267 - Refactor extentions parser to handle nested xml
- #279 - Update to babel 7 and add jest
- #274 - Replace NodeJS EventEmitter by custom one