dailymotion · Rapha0511 · Jun 27, 2024 · Jun 23, 2023 · Jun 23, 2023 · Jun 23, 2023
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Then import the components you need.
 
 ### VASTClient
 
-If you need to fetch and parse VAST documents, you can use the **VASTClient**:
+If you need to fetch and parse VAST documents, you can use the `get` method from the **VASTClient**:
 
 ```javascript
 import { VASTClient } from '@dailymotion/vast-client'
@@ -47,9 +47,25 @@ vastClient.get('https://www.examplevast.com/vast.xml')
 
 In addition to fetching and parsing a VAST resource, **VASTClient** provides options to filter a sequence of calls based on count and time of execution, together with the possibility to track URLs using **VASTTracker**.
 
+If you need to directly parse a VAST XML and  also follow any wrappers chain, you can use the  `parseVAST` method from the  **VASTClient** :
-If you need to directly parse a VAST XML and  also follow any wrappers chain, you can use the  `parseVAST` method from the  **VASTClient** :
+If you need to directly parse a VAST XML and also follow any wrappers chain, you can use the  `parseVAST` method from the  **VASTClient** :
-If you need to directly parse a VAST XML and  also follow any wrappers chain, you can use the  `parseVAST` method from the  **VASTClient** :
+If you need to directly parse a VAST XML and also follow any wrappers chain, you can use the  `parseVAST` method from the  **VASTClient** :
+
+```javascript
+import { VASTClient } from '@dailymotion/vast-client'
+
+const vastClient = new VASTClient();
+
+vastClient.parseVAST(vastXml)
+  .then(parsedVAST => {
+    // Do something with the parsed VAST response
+  })
+  .catch(err => {
+    // Deal with the error
+  });
+```
 ### VASTParser
 
 To directly parse a VAST XML you can use the **VASTParser**:
+The **VASTParser** will make no fetching, the final response will only contain the first VAST encountered.
 
 ```Javascript
 import { VASTParser } from '@dailymotion/vast-client'
@@ -110,18 +126,21 @@ const vastTracker = new VASTTracker();
 
 #### Browser script
 
-A pre-bundled version of VAST Client JS is available: [`vast-client-browser.min.js`](dist/vast-client-browser.min.js) [minified].
+A pre-bundled version of VAST Client JS is available: [`vast-client.min.js`](dist/vast-client.min.js) [minified].
 
-You can add the script directly to your page and access the library's components through the `VAST` object.
+If you want to use this file, download it place it your project at your prefered location.
+Then, make sure that your main file is in type module as below.
-If you want to use this file, download it place it your project at your prefered location.
-Then, make sure that your main file is in type module as below.
+To use it, either host it on your CDN or locally in your project. If you're using a script tag make sure to set the type property to module like below 
-If you want to use this file, download it place it your project at your prefered location.
-Then, make sure that your main file is in type module as below.
+To use it, either host it on your CDN or locally in your project. If you're using a script tag make sure to set the type property to module like below 
 
 ```html
-
-```html
+_your index.html_
+```html
-
-```html
+_your index.html_
+```html
-<script src="vast-client-browser.min.js"></script>
+<script type="module" src="your-main-file.js"></script>
 ```
 
 ```javascript
-
-```javascript
+_main.js_
+```javascript
-
-```javascript
+_main.js_
+```javascript
-const vastClient = new VAST.VASTClient();
-const vastParser = new VAST.VASTParser();
-const vastTracker = new VAST.VASTTracker();
+import {VASTClient, VASTParser, VASTTracker} from "vast-client.min.js"
+
+const vastClient = new VASTClient();
+const vastParser = new VASTParser();
+const vastTracker = new VASTTracker();
 ```
 
 #### Node

diff --git a/docs/api/vast-client.md b/docs/api/vast-client.md
@@ -2,6 +2,8 @@
 
 The `VASTClient` class provides a client to manage the fetching and parsing of VAST documents.
 
+`VASTClient` provides a methods to fetch a VAST resource because of his ability to resolving the wrapper chain (recursive fetch and parse) by using the `VASTParser` parsing methods.
-The `VASTClient` class provides a client to manage the fetching and parsing of VAST documents.
-
-`VASTClient` provides a methods to fetch a VAST resource because of his ability to resolving the wrapper chain (recursive fetch and parse) by using the `VASTParser` parsing methods.
+The `VASTClient` class provides a client to manage the fetching and parsing of VAST documents. It provides methods for fetching VAST resources by resolving the wrapper chain (recursive fetching and parsing) by using the `VASTParser` parsing methods.
-The `VASTClient` class provides a client to manage the fetching and parsing of VAST documents.
-
-`VASTClient` provides a methods to fetch a VAST resource because of his ability to resolving the wrapper chain (recursive fetch and parse) by using the `VASTParser` parsing methods.
+The `VASTClient` class provides a client to manage the fetching and parsing of VAST documents. It provides methods for fetching VAST resources by resolving the wrapper chain (recursive fetching and parsing) by using the `VASTParser` parsing methods.
+
 - [Constructor](#constructor)
 - [Properties](#properties)
 - [Methods](#methods)
@@ -147,6 +149,62 @@ vastClient.get('http://example.dailymotion.com/vast.xml', options)
     // Deal with the error
   });
 ```
+### parseVAST(vastXml, options)<a name="parse"></a>
+
+Parses the given xml Object into a [VASTResponse](https://github.com/dailymotion/vast-client-js/blob/master/docs/api/class-reference.md#vastresponse).
+Returns a `Promise` which either resolves with the fully parsed `VASTResponse` or rejects with an `Error`.
+
+By using this method, you will be able to perform fetching in case you want to parse a VAST document and follow a wrappers chain.
+If you just need to parse an inline VAST or you want to parse the first VAST document encountered, you should use the **parseVAST** method from the **VASTParser**.
+
+#### Parameters
+
+- **`vastXml: Object`** - An object representing an xml document
+- **`options: Object`** - An optional Object of parameters to be used in the parsing process
+  - `timeout: Number` - A custom timeout for the possible wrapper resolving requests (default `120000`)
+  - `withCredentials: Boolean` - A boolean to enable the withCredentials options for the XHR URLHandler (default `false`)
+  - `wrapperLimit: Number` - A number of Wrapper responses that can be received with no InLine response (default `10`)
+  - `urlHandler: URLHandler` - Custom urlhandler to be used instead of the default ones [`urlhandlers`](../../src/urlhandlers)
+  - `urlhandler: URLHandler` - Fulfills the same purpose as `urlHandler`, which is the preferred parameter to use
+  - `allowMultipleAds: Boolean` - A boolean value that identifies whether multiple ads are allowed in the requested VAST response. This will override any value of allowMultipleAds attribute set in the VAST
+  - `followAdditionalWrappers: Boolean` - A boolean value that identifies whether subsequent Wrappers after a requested VAST response is allowed. This will override any value of followAdditionalWrappers attribute set in the VAST
+  - `requestDuration: Number` - The fetching time of the XML in ms. Provide it with byteLength to have a more accurate estimated bitrate.
+  - `byteLength: Number`- The size of the request in bytes. Provide it with requestDuration to have a more accurate estimated bitrate.
+
+#### Events emitted
+
+- **`VAST-resolved`**
+- **`VAST-resolving`**
+- **`VAST-warning`**
+
+#### Example
+
+```Javascript
+const vastXml = (new window.DOMParser()).parseFromString(xmlStr, "text/xml");
+
+vastParser.parseVAST(vastXml)
+  .then(res => {
+    // Do something with the parsed VAST response
+  })
+  .catch(err => {
+    // Deal with the error
+  });
+
+// Or with some options
+const options = {
+  timeout: 5000,
+  withCredentials: true,
+  wrapperLimit: 7
+}
+vastParser.parseVAST(vastXml, options)
+  .then(res => {
+    // Do something with the parsed VAST response
+  })
+  .catch(err => {
+    // Deal with the error
+  });
+```
+
 
 #### How does resolveAll work
 
@@ -304,3 +362,72 @@ const vastParser = vastClient.getParser();
 // Clear the url template filters used
 vastParser.clearUrlTemplateFilters();
 ```
+
+### addURLTemplateFilter(filter)
+
+Adds a filter function to the array of filters which are called before fetching a VAST document.
+
+#### Parameters
+
+- **`filter: function`** - The filter function to be added at the end of the array
+
+#### Example
+
+```Javascript
+vastClient.addURLTemplateFilter( vastUrl => {
+    return url.replace('[DOMAIN]', 'mywebsite.com')
+});
+
+/*
+For a VASTAdTagURI defined as :
+<VASTAdTagURI>http://example.dailymotion.com/vast.php?domain=[DOMAIN]</VASTAdTagURI>
+HTTP request will be:
+http://example.dailymotion.com/vast.php?domain=mywebsite.com
+*/
+```
+
+### removeURLTemplateFilter()
+
+Removes the last element of the url templates filters array.
+
+#### Example
+
+```Javascript
+const replaceDomain = () => {
+    return url.replace('[DOMAIN]', 'mywebsite.com')
+};
+
+vastClient.addURLTemplateFilter(replaceDomain);
+// ...
+vastClient.removeURLTemplateFilter(replaceDomain);
+// [DOMAIN] placeholder is no longer replaced
+```
+### countURLTemplateFilters()
+
+Returns the number of filters of the url templates filters array.
+
+#### Example
+
+```Javascript
+vastClient.addURLTemplateFilter( vastUrl => {
+    return url.replace('[DOMAIN]', 'mywebsite.com')
+});
+
+vastClient.countUrlTemplateFilters();
+// returns 1
+```
+
+### clearURLTemplateFilters()
+
+Removes all the filter functions from the url templates filters array.
+
+#### Example
+
+```Javascript
+vastClient.addURLTemplateFilter( vastUrl => {
+    return url.replace('[DOMAIN]', 'mywebsite.com')
+});
+
+vastClient.clearUrlTemplateFilters();
+// [DOMAIN] placeholder is no longer replaced
+```
diff --git a/docs/api/vast-parser.md b/docs/api/vast-parser.md
@@ -1,13 +1,9 @@
 # VASTParser
 
-The `VASTParser` class provides a parser to manage the fetching ([`getAndParseVAST`](#getandparse) method) and direct parsing ([`parseVAST`](#parse) method) of VAST documents.
-
-The behavior of this component may be confused with the one of `VASTClient`, since they both provide a way to fetch and parse a VAST document.
+The `VASTParser` class provides a parser to manage the parsing ([`parseVAST`](#parse) method) of VAST documents.
 
 `VASTClient` has to be intended as the preferred way to manage a sequence of VAST requests on a higher level, while `VASTParser` offers a set of method to follow in more detail the parsing process.
 
-`VASTParser` provides methods to fetch a VAST resource because of his ability to resolving the wrapper chain (recursive fetch and parse).
-
 Use an instance of this class directly only if you don't need any control on multiple calls, otherwise access it through an instance of `VASTClient`.
 
 - [Constructor](#constructor)
@@ -122,89 +118,13 @@ Event is triggered when `parseVastXml` function is called, when an Ad tag has be
 - `adIndex: Number|undefined`
 
 ```Javascript
-vastParser.on('VAST-resolving', ({ url, wrapperDepth, previousUrl }) => {
+vastParser.on('VAST-ad-parsed', ({ url, wrapperDepth, type,adIndex }) => {
   // Access to the info
 });
 ```
 
-
-## Properties<a name="properties"></a>
-
-### urlHandler: URLHandler
-
-Instance of the support class `URLHandler`, is used to make the requests.
-
 ## Public Methods 💚 <a name="methods"></a>
 
-### addURLTemplateFilter(filter)
-
-Adds a filter function to the array of filters which are called before fetching a VAST document.
-
-#### Parameters
-
-- **`filter: function`** - The filter function to be added at the end of the array
-
-#### Example
-
-```Javascript
-vastParser.addURLTemplateFilter( vastUrl => {
-    return url.replace('[DOMAIN]', 'mywebsite.com')
-});
-
-/*
-For a VASTAdTagURI defined as :
-<VASTAdTagURI>http://example.dailymotion.com/vast.php?domain=[DOMAIN]</VASTAdTagURI>
-HTTP request will be:
-http://example.dailymotion.com/vast.php?domain=mywebsite.com
-*/
-```
-
-### removeURLTemplateFilter()
-
-Removes the last element of the url templates filters array.
-
-#### Example
-
-```Javascript
-const replaceDomain = () => {
-    return url.replace('[DOMAIN]', 'mywebsite.com')
-};
-
-vastParser.addURLTemplateFilter(replaceDomain);
-// ...
-vastParser.removeURLTemplateFilter(replaceDomain);
-// [DOMAIN] placeholder is no longer replaced
-```
-
-### countURLTemplateFilters()
-
-Returns the number of filters of the url templates filters array.
-
-#### Example
-
-```Javascript
-vastParser.addURLTemplateFilter( vastUrl => {
-    return url.replace('[DOMAIN]', 'mywebsite.com')
-});
-
-vastParser.countUrlTemplateFilters();
-// returns 1
-```
-
-### clearURLTemplateFilters()
-
-Removes all the filter functions from the url templates filters array.
-
-#### Example
-
-```Javascript
-vastParser.addURLTemplateFilter( vastUrl => {
-    return url.replace('[DOMAIN]', 'mywebsite.com')
-});
-
-vastParser.clearUrlTemplateFilters();
-// [DOMAIN] placeholder is no longer replaced
-```
 
 ### trackVastError(urlTemplates, errorCode, ...data)
 
@@ -232,73 +152,22 @@ Fetches a VAST document for the given url. Returns a `Promise` which resolves wi
 - **`VAST-resolved`**
 - **`VAST-resolving`**
 
-### getAndParseVAST(url, options = {})<a name="getandparse"></a>
-
-Fetches and parses a VAST for the given url.
-Returns a `Promise` which either resolves with the fully parsed [`VASTResponse`](https://github.com/dailymotion/vast-client-js/blob/master/docs/api/class-reference.md#vastresponse) or rejects with an `Error`.
-
-#### Parameters
-
-- **`url: String`** - The url to request the VAST document
-- **`options: Object`** - An optional Object of parameters to be used in the request
-  - `timeout: Number` - A custom timeout for the requests (default `120000`)
-  - `withCredentials: Boolean` - A boolean to enable the withCredentials options for the XHR URLHandler (default `false`)
-  - `wrapperLimit: Number` - A number of Wrapper responses that can be received with no InLine response (default `10`)
-  - `urlHandler: URLHandler` - Custom urlhandler to be used instead of the default ones [`urlhandlers`](../../src/urlhandlers)
-  - `urlhandler: URLHandler` - Fulfills the same purpose as `urlHandler`, which is the preferred parameter to use
-  - `allowMultipleAds: Boolean` - A boolean value that identifies whether multiple ads are allowed in the requested VAST response. This will override any value of allowMultipleAds attribute set in the VAST
-  - `followAdditionalWrappers: Boolean` - A boolean value that identifies whether subsequent Wrappers after a requested VAST response is allowed. This will override any value of followAdditionalWrappers attribute set in the VAST
-
-#### Events emitted
-
-- **`VAST-resolved`**
-- **`VAST-resolving`**
-- **`VAST-warning`**
-
-#### Example
-
-```Javascript
-vastParser.getAndParseVAST('http://example.dailymotion.com/vast.xml')
-  .then(res => {
-    // Do something with the parsed VAST response
-  })
-  .catch(err => {
-    // Deal with the error
-  });
-
-// With some options
-const options = {
-  timeout: 5000,
-  withCredentials: true,
-  wrapperLimit: 7
-}
-vastParser.getAndParseVAST('http://example.dailymotion.com/vast.xml', options)
-  .then(res => {
-    // Do something with the parsed VAST response
-  })
-  .catch(err => {
-    // Deal with the error
-  });
-```
-
 ### parseVAST(vastXml, options)<a name="parse"></a>
 
 Parses the given xml Object into a [VASTResponse](https://github.com/dailymotion/vast-client-js/blob/master/docs/api/class-reference.md#vastresponse).
 Returns a `Promise` which either resolves with the fully parsed `VASTResponse` or rejects with an `Error`.
 
+This method will not proceed to any fetching, the final response will only contain the first VAST encountered.
+If you need to parse and follow a wrappers chain, you should use the **parseVAST** method from the **VASTClient**.
+
 #### Parameters
 
 - **`vastXml: Object`** - An object representing an xml document
 - **`options: Object`** - An optional Object of parameters to be used in the parsing process
-  - `timeout: Number` - A custom timeout for the possible wrapper resolving requests (default `120000`)
-  - `withCredentials: Boolean` - A boolean to enable the withCredentials options for the XHR URLHandler (default `false`)
-  - `wrapperLimit: Number` - A number of Wrapper responses that can be received with no InLine response (default `10`)
-  - `urlHandler: URLHandler` - Custom urlhandler to be used instead of the default ones [`urlhandlers`](../../src/urlhandlers)
-  - `urlhandler: URLHandler` - Fulfills the same purpose as `urlHandler`, which is the preferred parameter to use
   - `allowMultipleAds: Boolean` - A boolean value that identifies whether multiple ads are allowed in the requested VAST response. This will override any value of allowMultipleAds attribute set in the VAST
-  - `followAdditionalWrappers: Boolean` - A boolean value that identifies whether subsequent Wrappers after a requested VAST response is allowed. This will override any value of followAdditionalWrappers attribute set in the VAST
-  - `requestDuration: Number` - The fetching time of the XML in ms. Provide it with byteLength to have a more accurate estimated bitrate.
   - `byteLength: Number`- The size of the request in bytes. Provide it with requestDuration to have a more accurate estimated bitrate.
+  - `resolveAll: Boolean` - Allows you to parse all the ads contained in the VAST or to parse them ad by ad or adPod by adPod (default `true`)
+
 
 #### Events emitted