videojs-vast-vpaid - npm Package Compare versions

Comparing version 2.0.0-beta.1 to 2.0.0-beta.2

dist/demo.js

@@ -460,4 +460,4 @@ (function webpackUniversalModuleDefinition(root, factory) {
 
-  if (options.adTagUrl) {
-    pluginSettings.adTagUrl = options.adTagUrl;
+  if (options.adTag) {
+    pluginSettings.adTag = options.adTag;
   }
@@ -937,5 +937,5 @@
         if (mode === 'TAG') {
-          adPluginOpts.plugins['ads-setup'].adTagUrl = tagEl.value;
+          adPluginOpts.plugins['ads-setup'].adTag = tagEl.value;
         } else if (mode === 'XML') {
-          adPluginOpts.plugins['ads-setup'].adTagUrl = xmlEl.value;
+          adPluginOpts.plugins['ads-setup'].adTag = xmlEl.value;
         } else {
@@ -942,0 +942,0 @@ adPluginOpts.plugins['ads-setup'].adTagXML = function (done) {

package.json

 {
   "name": "videojs-vast-vpaid",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "VAST plugin to use with video.js",
@@ -26,2 +26,3 @@ "main": "./src/scripts/videojs_5.vast.vpaid.js",
     "build-demo": "npm run build && webpack --config ./webpackfile.demo.babel.js && gulp prepare-demo-statics",
+    "deploy-demo": "npm run build-demo && gulp update-gh-pages",
     "lint": "npm-run-all lint-*",
@@ -68,3 +69,2 @@ "lint-styles": "stylelint './src/**/*.{scss,sass,css}'",
     "karma-coverage": "^0.5.3",
-    "karma-firefox-launcher": "^0.1.6",
     "karma-mocha": "0.2.1",
@@ -75,2 +75,3 @@ "karma-safari-launcher": "0.1.1",
     "mocha": "^2.2.5",
+    "mol-conventional-changelog": "^1.1.0",
     "node-sass": "^3.10.1",
@@ -80,3 +81,2 @@ "npm-run-all": "^3.1.1",
     "rimraf": "^2.5.4",
-    "run-sequence": "^1.2.2",
     "sass-loader": "^4.0.2",
@@ -96,3 +96,8 @@ "semantic-release": "^4.3.5",
     ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/mol-conventional-changelog"
+    }
   }
 }

README.md

@@ -68,3 +68,3 @@ # videojs-vast-vpaid plugin
       //Media tag URL
-      adTagUrl: "http://pubads.g.doubleclick.net/gampad/ads?env=....",
+      adTag: "http://pubads.g.doubleclick.net/gampad/ads?env=....",
       playAdAlways: true,
@@ -87,3 +87,3 @@ //Note: As requested we set the preroll timeout at the same place than the adsCancelTimeout
       "vastClient": {
-        "adTagUrl": "http://pubads.g.doubleclick.net/gampad/ads?env=....",
+        "adTag": "http://pubads.g.doubleclick.net/gampad/ads?env=....",
         "adCancelTimeout": 5000,
@@ -109,3 +109,3 @@ "adsEnabled": true
 if you will still use videojs version 4 you need to
-* download the new bin folder
+* download the new dist folder
 * replace, in your pages, ```videojs-vast-vpaid.js```with  ```videojs_4.vast.vpaid.js```
@@ -122,43 +122,24 @@ *( or ```videojs-vast-vpaid.min.js``` with ```videojs_4.vast.vpaid.min.js```  if you were using the minified version)*
 
-#### adTagUrl
-Use it to pass the ad media tag, it can be a string containing the Media tag url or a function that will return the Media tag whenever called;
-On initialization, the plugin will call the function and store the returned Media tag to request the VAST/VPAID ads
+#### adTag
+Use it to pass the ad media tag.
+
 ```javascript
 // Hardcoded Media Tag
 var vastAd = player.vastClient({
-    adTagUrl: "http://pubads.g.doubleclick.net/gampad/ads?env=....",
+    adTag: "http://pubads.g.doubleclick.net/gampad/ads?env=....",
     ...
 });
 ```
-```javascript
-//Dynamic Media Tag
-var vastAd = player.vastClient({
-    adTagUrl: getAdsUrl,
-    ...
-});
 
-function getAdsUrl() {
-    return "http://pubads.g.doubleclick.net/gampad/ads?env=....";
-}
-```
-
-#### url (deprecated)
-**This option is deprecated and you should use adTagUrl instead**
-Use it to pass the ad media tag, it can be a string containing the Media tag url
+#### getAdTag
+Error-first callback function that will be called per ad request.
 ```javascript
-// Hardcoded Media Tag
-var vastAd = player.vastClient({
-    url: "http://pubads.g.doubleclick.net/gampad/ads?env=....",
-    ...
-});
-```
-```javascript
 //Dynamic Media Tag
 var vastAd = player.vastClient({
-    url: getAdsUrl,
+    getAdTag: getAdsTag,
     ...
 });
 
-function getAdsUrl() {
-    return "http://pubads.g.doubleclick.net/gampad/ads?env=....";
+function getAdsTag(cb) {
+    cb(null, "http://pubads.g.doubleclick.net/gampad/ads?env=....");
 }
@@ -239,3 +220,3 @@ ```
 var vastPlugin = player.vastClient({
-    adTagUrl: getAdsUrl,
+    getAdTag: getAdTag,
     playAdAlways: true,
@@ -281,3 +262,3 @@ //Note: As requested we set the preroll timeout at the same place than the adsCancelTimeout
 player.vastClient({
-    adTagUrl: getAdsUrl,
+    getAdTag: getAdTag,
     playAdAlways: true,
@@ -284,0 +265,0 @@ //Note: As requested we set the preroll timeout at the same place than the adsCancelTimeout

src/scripts/ads/vast/VASTClient.js

@@ -24,6 +24,6 @@ const async = require('../../utils/async');
 
-VASTClient.prototype.getVASTResponse = function getVASTResponse (adTagUrl, callback) {
+VASTClient.prototype.getVASTResponse = function getVASTResponse (adTag, callback) {
   const that = this;
 
-  const error = sanityCheck(adTagUrl, callback);
+  const error = sanityCheck(adTag, callback);
 
@@ -38,3 +38,3 @@ if (error) {
   async.waterfall([
-    this._getVASTAd.bind(this, adTagUrl),
+    this._getVASTAd.bind(this, adTag),
     buildVASTResponse
@@ -55,4 +55,4 @@ ],
 
-  function sanityCheck (adTagUrl, cb) {
-    if (!adTagUrl) {
+  function sanityCheck (adTag, cb) {
+    if (!adTag) {
       return new VASTError('on VASTClient.getVASTResponse, missing ad tag URL');
@@ -67,6 +67,6 @@ }
 
-VASTClient.prototype._getVASTAd = function (adTagUrl, callback) {
+VASTClient.prototype._getVASTAd = function (adTag, callback) {
   const that = this;
 
-  getAdWaterfall(adTagUrl, (error, vastTree) => {
+  getAdWaterfall(adTag, (error, vastTree) => {
     const waterfallAds = vastTree && utilities.isArray(vastTree.ads) ? vastTree.ads : null;
@@ -98,4 +98,4 @@
   /** * Local functions ***/
-  function getAdWaterfall (adTagUrl, callback) {
-    const requestVastXML = that._requestVASTXml.bind(that, adTagUrl);
+  function getAdWaterfall (adTag, callback) {
+    const requestVastXML = that._requestVASTXml.bind(that, adTag);
 
@@ -142,3 +142,3 @@ async.waterfall([
 
-  function getAd (adTagUrl, adChain, callback) {
+  function getAd (adTag, adChain, callback) {
     if (adChain.length >= that.WRAPPER_LIMIT) {
@@ -150,6 +150,6 @@ return callback(new VASTError('on VASTClient.getVASTAd.getAd, players wrapper limit reached (the limit is ' + that.WRAPPER_LIMIT + ')', 302), adChain);
       function (next) {
-        if (utilities.isString(adTagUrl)) {
-          requestVASTAd(adTagUrl, next);
+        if (utilities.isString(adTag)) {
+          requestVASTAd(adTag, next);
         } else {
-          next(null, adTagUrl);
+          next(null, adTag);
         }
@@ -209,4 +209,4 @@ },
 
-  function requestVASTAd (adTagUrl, callback) {
-    that._requestVASTXml(adTagUrl, (error, xmlStr) => {
+  function requestVASTAd (adTag, callback) {
+    that._requestVASTXml(adTag, (error, xmlStr) => {
       if (error) {
@@ -226,9 +226,9 @@ return callback(error);
 
-VASTClient.prototype._requestVASTXml = function requestVASTXml (adTagUrl, callback) {
+VASTClient.prototype._requestVASTXml = function requestVASTXml (adTag, callback) {
   try {
-    if (utilities.isFunction(adTagUrl)) {
-      adTagUrl(requestHandler);
+    if (utilities.isFunction(adTag)) {
+      adTag(requestHandler);
     } else {
-      logger.info('requesting adTagUrl: ' + adTagUrl);
-      http.get(adTagUrl, requestHandler, {
+      logger.info('requesting adTag: ' + adTag);
+      http.get(adTag, requestHandler, {
         withCredentials: true
@@ -235,0 +235,0 @@ });

src/scripts/plugin/videojs.vast.vpaid.js

@@ -57,10 +57,6 @@ const VASTClient = require('../ads/vast/VASTClient');
 
-  if (utilities.isUndefined(settings.adTagUrl) && utilities.isDefined(settings.url)) {
-    settings.adTagUrl = settings.url;
+  if (utilities.isUndefined(settings.getAdTag) && utilities.isDefined(settings.adTag)) {
+    settings.getAdTag = (callback) => callback(null, settings.adTag);
   }
 
-  if (utilities.isString(settings.adTagUrl)) {
-    settings.adTagUrl = utilities.echoFn(settings.adTagUrl);
-  }
-
   if (utilities.isDefined(settings.adTagXML) && !utilities.isFunction(settings.adTagXML)) {
@@ -70,4 +66,4 @@ return trackAdError(new VASTError('on VideoJS VAST plugin, the passed adTagXML option does not contain a function'));
 
-  if (!utilities.isDefined(settings.adTagUrl) && !utilities.isFunction(settings.adTagXML)) {
-    return trackAdError(new VASTError('on VideoJS VAST plugin, missing adTagUrl on options object'));
+  if (!utilities.isFunction(settings.adTagXML) && !utilities.isFunction(settings.getAdTag)) {
+    return trackAdError(new VASTError('on VideoJS VAST plugin, missing adTag on options object'));
   }
@@ -248,3 +244,13 @@
   function getVastResponse (callback) {
-    vast.getVASTResponse(settings.adTagUrl ? settings.adTagUrl() : settings.adTagXML, callback);
+    if (settings.getAdTag) {
+      return settings.getAdTag((error, adTag) => {
+        if (error) {
+          return trackAdError(error);
+        }
+
+        return vast.getVASTResponse(adTag, callback);
+      });
+    }
+
+    vast.getVASTResponse(settings.adTagXML, callback);
   }
@@ -251,0 +257,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3117915

0.01%

Dev dependency count

36

-2.7%

Lines of code

19432

0.1%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Number of lines in readme file

366

-4.94%

No dependency changes