@smoud/playable-sdk 1.0.1 → 1.0.2

package/README.md

@@ -1,7 +1,10 @@
 # @smoud/playable-sdk
 
-[![npm version](https://badgen.net/npm/v/@smoud/playable-sdk)](https://npm.im/@smoud/playable-sdk)
-[![npm downloads](https://badgen.net/npm/dm/@smoud/playable-sdk)](https://npm.im/@smoud/playable-sdk)
+[![npm version](https://badgen.net/npm/v/@smoud/playable-sdk)](https://www.npmjs.com/package/@smoud/playable-sdk)
+[![npm downloads](https://badgen.net/npm/dm/@smoud/playable-sdk)](https://www.npmjs.com/package/@smoud/playable-sdk)
+[![build size](https://badgen.net/bundlephobia/min/@smoud/playable-sdk)](https://www.npmjs.com/package/@smoud/playable-sdk)
+[![DeepScan grade](https://deepscan.io/api/teams/19616/projects/29066/branches/935410/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=19616&pid=29066&bid=935410)
+[![License](https://img.shields.io/npm/l/@smoud/playable-sdk)](https://opensource.org/license/MIT)
 
 It's powerful, unified SDK that seamlessly integrates multiple ad network SDKs, including MRAID, Google, Facebook, Vungle, and many more. Designed for effortless playable ad development, it provides a standardized interface, ensuring compatibility, optimization, and easy deployment across various platforms. With @smoud/playable-sdk, you can streamline your workflow, maximize reach, and focus on crafting engaging interactive ads without worrying about SDK fragmentation. 🚀
 
@@ -51,20 +54,61 @@ The SDK automatically detects and adapts to the appropriate ad network protocol:
 npm install @smoud/playable-sdk
 ```
 
+## Quick Start
+
+```javascript
+import { sdk } from '@smoud/playable-sdk';
+
+// Initialize the SDK as early as possible
+sdk.init((width, height) => {
+  // Initialize your game/app with container dimensions
+  new Game(width, height);
+});
+```
+
+```javascript
+// Listen for events
+sdk.on('resize', (width, height) => {
+  game.resize(width, height);
+});
+
+sdk.on('pause', game.pause, game);
+sdk.on('resume', game.resume, game);
+sdk.on('volume', game.volume, game);
+sdk.on('finish', game.finish, game);
+
+sdk.on('interaction', (count) => {
+  console.log(`User interaction count: ${count}`);
+});
+```
+
+```javascript
+// Start the playable when resources are loaded
+sdk.start();
+```
+
+```javascript
+// Mark playable as complete
+sdk.finish();
+
+// Handle install/download action
+installButton.onclick = () => sdk.install();
+```
+
 ## Build
 
-### Introduction: @smoud/playable-scripts
+### @smoud/playable-scripts
 
-`@smoud/playable-sdk` works best with the **@smoud/playable-scripts** package, which helps you prepare **playable ad builds** that are ready for multiple ad networks. Using `playable-scripts` provides key benefits:
+`@smoud/playable-sdk` works best with the [`@smoud/playable-scripts`](https://www.npmjs.com/package/@smoud/playable-scripts) package, which helps you prepare **playable ad builds** that are ready for multiple ad networks. Using `playable-scripts` provides key benefits:
 
 - 🚀 **One-Command Build Process** – Easily generate builds for different ad networks.
 - ⚡ **Automatic Optimizations** – Includes minification, tree-shaking, and dead code elimination.
-- 🎯 **Pre-configured for Major Ad Networks** – Works out of the box with **Google Ads, Meta (Facebook), AppLovin, Unity, IronSource, Vungle, Mintegral, and more**.
+- 🎯 **Pre-configured for Major Ad Networks** – Works out of the box with **Google Ads, Meta (Facebook), AppLovin, Unity, IronSource, Vungle, Mintegral, and many more**.
 - 🛠️ **Customizable** – Extend the default build pipeline as needed.
 
 ### 🔧 Quick Start
 
-#### 1️⃣ Install **@smoud/playable-scripts**
+#### 1️⃣ Install `@smoud/playable-scripts`
 
 Install the package in your project:
 
@@ -100,6 +144,7 @@ npm run build <ad-network>
 ```
 
 ##### Examples:
+
 To build for **Applovin**, run:
 
 ```sh
@@ -109,7 +154,7 @@ npm run build applovin
 To build for **IronSource DAPI**, run:
 
 ```sh
-npm run build ironsource -- --dapi
+npm run build ironsource -- --protocol dapi
 ```
 
 Supported **Ad Networks**:
@@ -120,6 +165,7 @@ Supported **Ad Networks**:
 - `ironsource`
 - `facebook`
 - `moloco`
+- `adcolony`
 - `mintegral`
 - `vungle`
 - `tapjoy`
@@ -133,11 +179,12 @@ Supported **Ad Networks**:
 
 ## Custom Build Pipeline
 
-Before setting up a custom pipeline, consider using **@smoud/playable-scripts**. It provides an API to extend the standard build function and simplifies the process.
+Before setting up a custom pipeline, consider using `@smoud/playable-scripts`. It provides an API to extend the standard build function and simplifies the process. See details [here](https://github.com/smoudjs/playable-scripts).
 
 If you still prefer a fully custom build, you need to manage the following aspects yourself:
 
 ### 1️⃣ Define Required Variables
+
 Your build script should replace or define these variables within the `window` object before the rest of your code executes:
 
 ```ts
@@ -149,61 +196,23 @@ BUILD_HASH = 'random-build-hash';
 ```
 
 ### 2️ Applying Ad-Specific Adjustments
+
 Certain networks use different ad protocols. Ensure that your build includes or removes code based on the network.
 
 Check [Ad Network Resources & Requirements](#Ad-Network-Resources-&-Requirements) for more details.
 
 ### 3️⃣ Minification & Optimization
-To ensure the best performance, your build should include a **JavaScript minimizer** to remove unnecessary code. 
+
+To ensure the best performance, your build should include a **JavaScript minimizer** to remove unnecessary code.
 
 #### Recommended Tools:
+
 - [Terser](https://github.com/terser/terser) – Best for JS minification.
 - [UglifyJS](https://github.com/mishoo/UglifyJS) – Alternative for JS compression.
 
-## Quick Start
-
-```javascript
-import { sdk } from '@smoud/playable-sdk';
-
-// Initialize the SDK as early as possible
-sdk.init((width, height) => {
-  // Initialize your game/app with container dimensions
-  new Game(width, height);
-});
-```
-
-```javascript
-// Listen for events
-sdk.on('resize', (width, height) => {
-  game.resize(width, height);
-});
-
-sdk.on('pause', game.pause, game);
-sdk.on('resume', game.resume, game);
-sdk.on('volume', game.volume, game);
-sdk.on('finish', game.finish, game);
-
-sdk.on('interaction', (count) => {
-  console.log(`User interaction count: ${count}`);
-});
-```
-
-```javascript
-// Start the playable when resources are loaded
-sdk.start();
-```
-
-```javascript
-// Mark playable as complete
-sdk.finish();
-
-// Handle install/download action
-installButton.onclick = () => sdk.install();
-```
-
 ## SDK API Reference
 
-### Lifecycle Management & typical usage
+### Lifecycle management & typical usage
 
 The SDK provides a comprehensive set of functions to manage the playable ad lifecycle. Functions should be called in the following order:
 
@@ -214,9 +223,6 @@ The SDK provides a comprehensive set of functions to manage the playable ad life
    sdk.init((width, height) => {
      // Setup your app with container dimensions
    });
-
-   // Start playable after resources are loaded
-   sdk.start();
    ```
 
 2. **Listen for needed events**
@@ -257,7 +263,9 @@ The SDK provides a comprehensive set of functions to manage the playable ad life
      ui.showEndScreen();
    });
    ```
+
    #### Optional events
+
    ```javascript
    sdk.on('init', () => {
      // Show loading screen while SDK initializes
@@ -310,7 +318,9 @@ The SDK provides a comprehensive set of functions to manage the playable ad life
    ```javascript
    // Mark playable as complete
    sdk.finish();
+   ```
 
+   ```javascript
    // Trigger install/store redirect
    sdk.install();
    ```

package/dist/esm/index.js

@@ -254,16 +254,12 @@ function startDefaultProtocol() {
     }
     document.addEventListener("visibilitychange", () => {
       if (document.visibilityState === "visible") {
-        if (sdk.isReady) {
-          handleResume();
-        } else {
-          bootAd();
-        }
+        handleResume();
       } else {
         handlePause();
       }
     });
-    if (document.readyState === "complete" || document.visibilityState === "visible") {
+    if (document.readyState === "complete") {
       bootAd();
     } else {
       window.addEventListener("load", () => {

package/dist/iife/index.js

@@ -256,16 +256,12 @@
       }
       document.addEventListener("visibilitychange", () => {
         if (document.visibilityState === "visible") {
-          if (sdk.isReady) {
-            handleResume();
-          } else {
-            bootAd();
-          }
+          handleResume();
         } else {
           handlePause();
         }
       });
-      if (document.readyState === "complete" || document.visibilityState === "visible") {
+      if (document.readyState === "complete") {
         bootAd();
       } else {
         window.addEventListener("load", () => {

package/dist/index.js

@@ -281,16 +281,12 @@ function startDefaultProtocol() {
     }
     document.addEventListener("visibilitychange", () => {
       if (document.visibilityState === "visible") {
-        if (sdk.isReady) {
-          handleResume();
-        } else {
-          bootAd();
-        }
+        handleResume();
       } else {
         handlePause();
       }
     });
-    if (document.readyState === "complete" || document.visibilityState === "visible") {
+    if (document.readyState === "complete") {
       bootAd();
     } else {
       window.addEventListener("load", () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smoud/playable-sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "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",
@@ -22,7 +22,7 @@
   "scripts": {
     "build": "npx tsup src/index.ts --format esm,cjs,iife --out-dir dist --legacy-output --dts --clean",
     "test": "jest",
-    "publish": "npm run test && npm run build && npm publish --access public"
+    "deploy": "npm run test && npm run build && npm publish --access public"
   },
   "author": "Smoud",
   "license": "MIT",