@smoud/playable-sdk 1.0.12 → 1.0.14

package/README.md

@@ -377,8 +377,9 @@ Get started quickly with our template projects:
 #### MRAID Networks
 
 - [MRAID 3.0](https://www.iab.com/wp-content/uploads/2017/07/MRAID_3.0_FINAL.pdf)
-- [IronSource - MRAID requirements](https://developers.is.com/ironsource-mobile/general/mraid-requirements/#step-1)
 - [IronSource - Interactive ad creative requirements](https://developers.is.com/ironsource-mobile/general/interactive-requirements/#step-1)
+- [IronSource - MRAID requirements](https://developers.is.com/ironsource-mobile/general/mraid-requirements/#step-1)
+- [IronSource - DAPI requirements](https://developers.is.com/ironsource-mobile/general/dapi-requirements/#step-1)
 - [Unity Ads Documentation](https://docs.unity.com/acquire/en-us/manual/playable-ads-specifications)
 - [Chartboost Integration](https://docs.chartboost.com/en/advertising/creatives/creative-assets/)
 
@@ -397,7 +398,7 @@ Get started quickly with our template projects:
 - [Vungle Creative QA](https://vungle.com/creative-verifier/)
 - [Facebook Playable Preview Tool](https://developers.facebook.com/tools/playable-preview/)
 - [Google HTML5 Validator](https://h5validator.appspot.com/adwords/asset)
-- [IronSource Integration Validation](https://developers.is.com/ironsource-mobile/general/test-suite/)
+- [IronSource - Submit an HTML asset for review](https://developers.is.com/ironsource-mobile/general/html-upload/)
 - [Mintegral Testing Tool](https://www.playturbo.com/review)
 
 ## Issues

package/defines.d.ts

@@ -13,6 +13,7 @@ declare const mraid: {
   getMaxSize: () => { width: number; height: number };
   openStoreUrl: () => void;
   open: (url: string) => void;
+  getAudioVolume: () => number;
   preloadStore?: () => void;
 };
 

package/dist/esm/index.js

@@ -12,7 +12,7 @@ function onEvent(event, fn, context, once) {
 function offEvent(event, fn, context) {
   const listeners = registeredEvents[event];
   if (!listeners) return;
-  var fnArray = listeners.list;
+  const fnArray = listeners.list;
   if (!fn) {
     fnArray.length = 0;
   } else {
@@ -29,12 +29,12 @@ function offEvent(event, fn, context) {
   }
 }
 function emitEvent(event, a1, a2, a3) {
-  var listeners = registeredEvents[event];
+  const listeners = registeredEvents[event];
   if (!listeners) return;
   const fnArray = listeners.list;
   const len = arguments.length;
   let fn, ctx;
-  for (var i = 0; i < fnArray.length; i += 3) {
+  for (let i = 0; i < fnArray.length; i += 3) {
     fn = fnArray[i];
     ctx = fnArray[i + 1];
     if (fnArray[i + 2]) {
@@ -125,6 +125,7 @@ var isSDKInitialized = false;
 var isProtocolInitialized = false;
 var isForcePaused = false;
 var isInstallClicked = false;
+var actualVolume = 1;
 var initCallback = () => {
 };
 function bootAd() {
@@ -137,9 +138,17 @@ function bootAd() {
   emitEvent("ready");
   sdk.isReady = true;
 }
-function changeVolume(value) {
+function fireVolumeChange(value) {
   emitEvent("volume", value);
 }
+function changeVolume(value) {
+  sdk.volume = value;
+  fireVolumeChange(value);
+}
+function handleVolumeChange(value) {
+  actualVolume = value;
+  if (!sdk.isPaused) changeVolume(actualVolume);
+}
 function handlePause() {
   changeVolume(0);
   sdk.isPaused = true;
@@ -147,7 +156,7 @@ function handlePause() {
 }
 function handleResume() {
   if (isForcePaused) return;
-  changeVolume(sdk.volume);
+  changeVolume(actualVolume);
   sdk.isPaused = false;
   emitEvent("resume");
 }
@@ -174,7 +183,7 @@ function dapiIsViewable(event) {
     if (sdk.isReady) {
       handleResume();
     } else {
-      var screenSize = dapi.getScreenSize();
+      const screenSize = dapi.getScreenSize();
       screenSize.width = Math.floor(screenSize.width);
       screenSize.height = Math.floor(screenSize.height);
       bootAd();
@@ -191,18 +200,26 @@ function startMraidProtocol() {
   if (!isProtocolInitialized) {
     mraid.removeEventListener("ready", startMraidProtocol);
     mraid.addEventListener("viewableChange", function() {
-      var isViewable = mraid.isViewable();
+      const isViewable = mraid.isViewable();
       mraidIsViewable(isViewable);
     });
     if (mraid.isViewable() || AD_NETWORK == "adcolony") {
       mraidIsViewable(true);
     }
+    if (mraid.getAudioVolume) {
+      const isAudioEnabled = mraid.getAudioVolume();
+      if (isAudioEnabled) {
+        handleVolumeChange(1);
+      } else {
+        handleVolumeChange(0);
+      }
+    }
     mraid.addEventListener("audioVolumeChange", function(newVolume) {
       if (newVolume !== null) {
         if (newVolume > 0) {
-          changeVolume(sdk.volume);
+          handleVolumeChange(1);
         } else {
-          changeVolume(0);
+          handleVolumeChange(0);
         }
       }
     });
@@ -210,7 +227,7 @@ function startMraidProtocol() {
       console.log("mraid error: " + t + "   action: " + e);
     });
     mraid.addEventListener("sizeChange", function() {
-      var maxSize = mraid.getMaxSize();
+      const maxSize = mraid.getMaxSize();
       fireResizeEvent(maxSize.width, maxSize.height);
     });
     isProtocolInitialized = true;
@@ -220,17 +237,22 @@ function startDapiProtocol() {
   if ("dapi" !== AD_PROTOCOL) return;
   if (!isProtocolInitialized) {
     dapi.removeEventListener("ready", startDapiProtocol);
-    dapi.getAudioVolume();
+    const isAudioEnabled = dapi.getAudioVolume();
+    if (isAudioEnabled) {
+      handleVolumeChange(1);
+    } else {
+      handleVolumeChange(0);
+    }
     dapi.addEventListener("audioVolumeChange", function(volume) {
-      var isAudioEnabled = !!volume;
-      if (isAudioEnabled) {
-        changeVolume(sdk.volume);
+      const isAudioEnabled2 = !!volume;
+      if (isAudioEnabled2) {
+        handleVolumeChange(1);
       } else {
-        changeVolume(0);
+        handleVolumeChange(0);
       }
     });
     dapi.addEventListener("adResized", function(event) {
-      var maxSize = dapi.getScreenSize();
+      const maxSize = dapi.getScreenSize();
       fireResizeEvent(event.width || maxSize.width, event.height || maxSize.height);
     });
     if (dapi.isViewable()) {
@@ -269,7 +291,7 @@ function startDefaultProtocol() {
       handleResize();
     });
     if ("tapjoy" === AD_NETWORK && isTapjoy()) {
-      var tapjoyApi = {
+      const tapjoyApi = {
         skipAd: function() {
           try {
             sdk.finish();
@@ -378,6 +400,7 @@ var _sdk = class _sdk {
           buildID: BUILD_HASH
         });
       }
+      fireVolumeChange(_sdk.volume);
       _sdk.resize();
     }
   }
@@ -572,7 +595,7 @@ var _sdk = class _sdk {
   }
 };
 /** Current version of the SDK */
-_sdk.version = "1.0.12";
+_sdk.version = "1.0.14";
 /** Current maximum width of the playable ad container in pixels */
 _sdk.maxWidth = Math.floor(window.innerWidth);
 /** Current maximum height of the playable ad container in pixels */
@@ -588,7 +611,7 @@ _sdk.isPaused = false;
 /** Indicates if the playable ad has finished */
 _sdk.isFinished = false;
 /** Current volume level (0-1) */
-_sdk.volume = 1;
+_sdk.volume = actualVolume;
 /** Number of user interactions with the playable ad */
 _sdk.interactions = 0;
 var sdk = _sdk;

package/dist/iife/index.js

@@ -14,7 +14,7 @@
   function offEvent(event, fn, context) {
     const listeners = registeredEvents[event];
     if (!listeners) return;
-    var fnArray = listeners.list;
+    const fnArray = listeners.list;
     if (!fn) {
       fnArray.length = 0;
     } else {
@@ -31,12 +31,12 @@
     }
   }
   function emitEvent(event, a1, a2, a3) {
-    var listeners = registeredEvents[event];
+    const listeners = registeredEvents[event];
     if (!listeners) return;
     const fnArray = listeners.list;
     const len = arguments.length;
     let fn, ctx;
-    for (var i = 0; i < fnArray.length; i += 3) {
+    for (let i = 0; i < fnArray.length; i += 3) {
       fn = fnArray[i];
       ctx = fnArray[i + 1];
       if (fnArray[i + 2]) {
@@ -127,6 +127,7 @@
   var isProtocolInitialized = false;
   var isForcePaused = false;
   var isInstallClicked = false;
+  var actualVolume = 1;
   var initCallback = () => {
   };
   function bootAd() {
@@ -139,9 +140,17 @@
     emitEvent("ready");
     sdk.isReady = true;
   }
-  function changeVolume(value) {
+  function fireVolumeChange(value) {
     emitEvent("volume", value);
   }
+  function changeVolume(value) {
+    sdk.volume = value;
+    fireVolumeChange(value);
+  }
+  function handleVolumeChange(value) {
+    actualVolume = value;
+    if (!sdk.isPaused) changeVolume(actualVolume);
+  }
   function handlePause() {
     changeVolume(0);
     sdk.isPaused = true;
@@ -149,7 +158,7 @@
   }
   function handleResume() {
     if (isForcePaused) return;
-    changeVolume(sdk.volume);
+    changeVolume(actualVolume);
     sdk.isPaused = false;
     emitEvent("resume");
   }
@@ -176,7 +185,7 @@
       if (sdk.isReady) {
         handleResume();
       } else {
-        var screenSize = dapi.getScreenSize();
+        const screenSize = dapi.getScreenSize();
         screenSize.width = Math.floor(screenSize.width);
         screenSize.height = Math.floor(screenSize.height);
         bootAd();
@@ -193,18 +202,26 @@
     if (!isProtocolInitialized) {
       mraid.removeEventListener("ready", startMraidProtocol);
       mraid.addEventListener("viewableChange", function() {
-        var isViewable = mraid.isViewable();
+        const isViewable = mraid.isViewable();
         mraidIsViewable(isViewable);
       });
       if (mraid.isViewable() || AD_NETWORK == "adcolony") {
         mraidIsViewable(true);
       }
+      if (mraid.getAudioVolume) {
+        const isAudioEnabled = mraid.getAudioVolume();
+        if (isAudioEnabled) {
+          handleVolumeChange(1);
+        } else {
+          handleVolumeChange(0);
+        }
+      }
       mraid.addEventListener("audioVolumeChange", function(newVolume) {
         if (newVolume !== null) {
           if (newVolume > 0) {
-            changeVolume(sdk.volume);
+            handleVolumeChange(1);
           } else {
-            changeVolume(0);
+            handleVolumeChange(0);
           }
         }
       });
@@ -212,7 +229,7 @@
         console.log("mraid error: " + t + "   action: " + e);
       });
       mraid.addEventListener("sizeChange", function() {
-        var maxSize = mraid.getMaxSize();
+        const maxSize = mraid.getMaxSize();
         fireResizeEvent(maxSize.width, maxSize.height);
       });
       isProtocolInitialized = true;
@@ -222,17 +239,22 @@
     if ("dapi" !== AD_PROTOCOL) return;
     if (!isProtocolInitialized) {
       dapi.removeEventListener("ready", startDapiProtocol);
-      dapi.getAudioVolume();
+      const isAudioEnabled = dapi.getAudioVolume();
+      if (isAudioEnabled) {
+        handleVolumeChange(1);
+      } else {
+        handleVolumeChange(0);
+      }
       dapi.addEventListener("audioVolumeChange", function(volume) {
-        var isAudioEnabled = !!volume;
-        if (isAudioEnabled) {
-          changeVolume(sdk.volume);
+        const isAudioEnabled2 = !!volume;
+        if (isAudioEnabled2) {
+          handleVolumeChange(1);
         } else {
-          changeVolume(0);
+          handleVolumeChange(0);
         }
       });
       dapi.addEventListener("adResized", function(event) {
-        var maxSize = dapi.getScreenSize();
+        const maxSize = dapi.getScreenSize();
         fireResizeEvent(event.width || maxSize.width, event.height || maxSize.height);
       });
       if (dapi.isViewable()) {
@@ -271,7 +293,7 @@
         handleResize();
       });
       if ("tapjoy" === AD_NETWORK && isTapjoy()) {
-        var tapjoyApi = {
+        const tapjoyApi = {
           skipAd: function() {
             try {
               sdk.finish();
@@ -380,6 +402,7 @@
             buildID: BUILD_HASH
           });
         }
+        fireVolumeChange(_sdk.volume);
         _sdk.resize();
       }
     }
@@ -574,7 +597,7 @@
     }
   };
   /** Current version of the SDK */
-  _sdk.version = "1.0.12";
+  _sdk.version = "1.0.14";
   /** Current maximum width of the playable ad container in pixels */
   _sdk.maxWidth = Math.floor(window.innerWidth);
   /** Current maximum height of the playable ad container in pixels */
@@ -590,7 +613,7 @@
   /** Indicates if the playable ad has finished */
   _sdk.isFinished = false;
   /** Current volume level (0-1) */
-  _sdk.volume = 1;
+  _sdk.volume = actualVolume;
   /** Number of user interactions with the playable ad */
   _sdk.interactions = 0;
   var sdk = _sdk;

package/dist/index.js

@@ -39,7 +39,7 @@ function onEvent(event, fn, context, once) {
 function offEvent(event, fn, context) {
   const listeners = registeredEvents[event];
   if (!listeners) return;
-  var fnArray = listeners.list;
+  const fnArray = listeners.list;
   if (!fn) {
     fnArray.length = 0;
   } else {
@@ -56,12 +56,12 @@ function offEvent(event, fn, context) {
   }
 }
 function emitEvent(event, a1, a2, a3) {
-  var listeners = registeredEvents[event];
+  const listeners = registeredEvents[event];
   if (!listeners) return;
   const fnArray = listeners.list;
   const len = arguments.length;
   let fn, ctx;
-  for (var i = 0; i < fnArray.length; i += 3) {
+  for (let i = 0; i < fnArray.length; i += 3) {
     fn = fnArray[i];
     ctx = fnArray[i + 1];
     if (fnArray[i + 2]) {
@@ -152,6 +152,7 @@ var isSDKInitialized = false;
 var isProtocolInitialized = false;
 var isForcePaused = false;
 var isInstallClicked = false;
+var actualVolume = 1;
 var initCallback = () => {
 };
 function bootAd() {
@@ -164,9 +165,17 @@ function bootAd() {
   emitEvent("ready");
   sdk.isReady = true;
 }
-function changeVolume(value) {
+function fireVolumeChange(value) {
   emitEvent("volume", value);
 }
+function changeVolume(value) {
+  sdk.volume = value;
+  fireVolumeChange(value);
+}
+function handleVolumeChange(value) {
+  actualVolume = value;
+  if (!sdk.isPaused) changeVolume(actualVolume);
+}
 function handlePause() {
   changeVolume(0);
   sdk.isPaused = true;
@@ -174,7 +183,7 @@ function handlePause() {
 }
 function handleResume() {
   if (isForcePaused) return;
-  changeVolume(sdk.volume);
+  changeVolume(actualVolume);
   sdk.isPaused = false;
   emitEvent("resume");
 }
@@ -201,7 +210,7 @@ function dapiIsViewable(event) {
     if (sdk.isReady) {
       handleResume();
     } else {
-      var screenSize = dapi.getScreenSize();
+      const screenSize = dapi.getScreenSize();
       screenSize.width = Math.floor(screenSize.width);
       screenSize.height = Math.floor(screenSize.height);
       bootAd();
@@ -218,18 +227,26 @@ function startMraidProtocol() {
   if (!isProtocolInitialized) {
     mraid.removeEventListener("ready", startMraidProtocol);
     mraid.addEventListener("viewableChange", function() {
-      var isViewable = mraid.isViewable();
+      const isViewable = mraid.isViewable();
       mraidIsViewable(isViewable);
     });
     if (mraid.isViewable() || AD_NETWORK == "adcolony") {
       mraidIsViewable(true);
     }
+    if (mraid.getAudioVolume) {
+      const isAudioEnabled = mraid.getAudioVolume();
+      if (isAudioEnabled) {
+        handleVolumeChange(1);
+      } else {
+        handleVolumeChange(0);
+      }
+    }
     mraid.addEventListener("audioVolumeChange", function(newVolume) {
       if (newVolume !== null) {
         if (newVolume > 0) {
-          changeVolume(sdk.volume);
+          handleVolumeChange(1);
         } else {
-          changeVolume(0);
+          handleVolumeChange(0);
         }
       }
     });
@@ -237,7 +254,7 @@ function startMraidProtocol() {
       console.log("mraid error: " + t + "   action: " + e);
     });
     mraid.addEventListener("sizeChange", function() {
-      var maxSize = mraid.getMaxSize();
+      const maxSize = mraid.getMaxSize();
       fireResizeEvent(maxSize.width, maxSize.height);
     });
     isProtocolInitialized = true;
@@ -247,17 +264,22 @@ function startDapiProtocol() {
   if ("dapi" !== AD_PROTOCOL) return;
   if (!isProtocolInitialized) {
     dapi.removeEventListener("ready", startDapiProtocol);
-    dapi.getAudioVolume();
+    const isAudioEnabled = dapi.getAudioVolume();
+    if (isAudioEnabled) {
+      handleVolumeChange(1);
+    } else {
+      handleVolumeChange(0);
+    }
     dapi.addEventListener("audioVolumeChange", function(volume) {
-      var isAudioEnabled = !!volume;
-      if (isAudioEnabled) {
-        changeVolume(sdk.volume);
+      const isAudioEnabled2 = !!volume;
+      if (isAudioEnabled2) {
+        handleVolumeChange(1);
       } else {
-        changeVolume(0);
+        handleVolumeChange(0);
       }
     });
     dapi.addEventListener("adResized", function(event) {
-      var maxSize = dapi.getScreenSize();
+      const maxSize = dapi.getScreenSize();
       fireResizeEvent(event.width || maxSize.width, event.height || maxSize.height);
     });
     if (dapi.isViewable()) {
@@ -296,7 +318,7 @@ function startDefaultProtocol() {
       handleResize();
     });
     if ("tapjoy" === AD_NETWORK && isTapjoy()) {
-      var tapjoyApi = {
+      const tapjoyApi = {
         skipAd: function() {
           try {
             sdk.finish();
@@ -405,6 +427,7 @@ var _sdk = class _sdk {
           buildID: BUILD_HASH
         });
       }
+      fireVolumeChange(_sdk.volume);
       _sdk.resize();
     }
   }
@@ -599,7 +622,7 @@ var _sdk = class _sdk {
   }
 };
 /** Current version of the SDK */
-_sdk.version = "1.0.12";
+_sdk.version = "1.0.14";
 /** Current maximum width of the playable ad container in pixels */
 _sdk.maxWidth = Math.floor(window.innerWidth);
 /** Current maximum height of the playable ad container in pixels */
@@ -615,7 +638,7 @@ _sdk.isPaused = false;
 /** Indicates if the playable ad has finished */
 _sdk.isFinished = false;
 /** Current volume level (0-1) */
-_sdk.volume = 1;
+_sdk.volume = actualVolume;
 /** Number of user interactions with the playable ad */
 _sdk.interactions = 0;
 var sdk = _sdk;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smoud/playable-sdk",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "It's unified Playable SDK that supports MRAID, Google, Facebook, Vungle, and many more Ad Networks, simplifying playable ad development with a standardized interface for seamless cross-network compatibility.",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",