├── .babelrc
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitattributes
├── .github
    ├── pull_request_template.md
    └── workflows
    │   └── CI.yml
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc
├── .travis.yml
├── LICENSE
├── README.md
├── bundle_size.js
├── deployment-scripts
    └── deploy-release.sh
├── dist
    ├── chunks
    │   ├── xmldom-623c1b6b.min.js
    │   ├── xmldom-8a748e0b.min.js
    │   ├── xmldom-a624052b.js
    │   └── xmldom-ac2d7d04.js
    ├── vast-client-node.js
    ├── vast-client-node.min.js
    ├── vast-client.js
    └── vast-client.min.js
├── docs
    ├── CODE_OF_CONDUCT.md
    ├── CONTRIBUTING.md
    ├── RELEASE-TASKS.md
    └── api
    │   ├── 1.x
    │       ├── client.md
    │       ├── parser.md
    │       └── tracker.md
    │   ├── 2.0-migration.md
    │   ├── 3.0-migration.md
    │   ├── class-reference.md
    │   ├── event-emitter.md
    │   ├── img
    │       └── adpods.jpg
    │   ├── vast-client.md
    │   ├── vast-parser.md
    │   └── vast-tracker.md
├── examples
    ├── node
    │   ├── index.js
    │   ├── package-lock.json
    │   └── package.json
    └── web
    │   ├── package-lock.json
    │   ├── package.json
    │   └── src
    │       ├── index.html
    │       ├── index.js
    │       ├── styles.css
    │       └── utils.js
├── jest.config.js
├── package-lock.json
├── package.json
├── performance
    ├── get_time.js
    ├── parse_time.js
    └── performance_test.js
├── rollup.config.js
├── spec
    ├── ad_parser.spec.js
    ├── bitrate.spec.js
    ├── creative_companion_parser.spec.js
    ├── creatives_parser.spec.js
    ├── event_emitter.spec.js
    ├── extensions_parser.spec.js
    ├── fetcher.spec.js
    ├── parser_utils.spec.js
    ├── samples
    │   ├── ad_verification_extension_and_node.js
    │   ├── ad_verification_extentions.js
    │   ├── companion_ads.js
    │   ├── creatives.js
    │   ├── empty-no-ad.xml
    │   ├── empty-no-creative.xml
    │   ├── extensions.js
    │   ├── inline-linear.xml
    │   ├── inline_missing_values.js
    │   ├── inline_trackers.js
    │   ├── invalid-xmlfile.xml
    │   ├── linear_ads.js
    │   ├── outdated-vast.xml
    │   ├── sample.xml
    │   ├── viewable_impression.js
    │   ├── vpaid.xml
    │   ├── vpaid2.xml
    │   ├── wrapper-a.xml
    │   ├── wrapper-attributes-multiple-ads.xml
    │   ├── wrapper-b.xml
    │   ├── wrapper-empty-no-creative.xml
    │   ├── wrapper-empty.xml
    │   ├── wrapper-legacy.xml
    │   ├── wrapper-multiple-ads.xml
    │   ├── wrapper-unavailable-url.xml
    │   └── wrapper_missing_values.js
    ├── util.spec.js
    ├── utils
    │   └── utils.js
    ├── vast_client.spec.js
    ├── vast_parser.spec.js
    ├── vast_tracker.spec.js
    └── vast_verification.spec.js
└── src
    ├── ad.js
    ├── ad_verification.js
    ├── closed_caption_file.js
    ├── companion_ad.js
    ├── creative
        ├── creative.js
        ├── creative_companion.js
        ├── creative_linear.js
        └── creative_non_linear.js
    ├── extension.js
    ├── fetcher
        ├── consts.js
        ├── fetcher.js
        └── url_handler.js
    ├── icon.js
    ├── index.js
    ├── interactive_creative_file.js
    ├── media_file.js
    ├── mezzanine.js
    ├── non_linear_ad.js
    ├── parser
        ├── ad_parser.js
        ├── bitrate.js
        ├── creative_companion_parser.js
        ├── creative_linear_parser.js
        ├── creative_non_linear_parser.js
        ├── creatives_parser.js
        ├── extensions_parser.js
        ├── parser_utils.js
        ├── parser_verification.js
        └── vast_parser.js
    ├── util
        ├── event_emitter.js
        ├── macros.js
        ├── requiredValues.js
        ├── storage.js
        └── util.js
    ├── vast_client.js
    ├── vast_response.js
    └── vast_tracker.js


/.babelrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "presets": [
 3 |     [
 4 |       "@babel/preset-env",
 5 |       {
 6 |         "targets": {
 7 |           "ie": "9",
 8 |           "safari": "8"
 9 |         },
10 |         "useBuiltIns": false
11 |       }
12 |     ]
13 |   ],
14 |   "exclude": ["node_modules/**"]
15 | }
16 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | # editorconfig.org
 2 | 
 3 | # This allow you to have a ~/.editorconfig that defines missing properties (e.g. indent_size)
 4 | root = true
 5 | 
 6 | [*]
 7 | indent_style = space
 8 | indent_size = 2
 9 | end_of_line = lf
10 | charset = utf-8
11 | 
12 | # On save, removes trailing whitespace
13 | trim_trailing_whitespace = true
14 | 
15 | # On save, adds the final newline character.
16 | # It's required for some unix command to work:
17 | # % echo 'toto' | wc -l
18 | # 1
19 | # % echo -n 'toto' | wc -l
20 | # 0
21 | # In a git diff, no final newline generates the "No newline at end of file" message
22 | # This is not a bug, just a message by git.
23 | insert_final_newline = true
24 | 
25 | [*.md]
26 | indent_style = space
27 | 


--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
 1 | dist/
 2 | dist_old/
 3 | !.eslintrc.js
 4 | rollup.config.js
 5 | node_modules/
 6 | test/
 7 | spec/
 8 | jest.config.js
 9 | performance/
10 | 


--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   env: {
 3 |     browser: true,
 4 |     es6: true,
 5 |     node: true,
 6 |   },
 7 |   extends: 'eslint:recommended',
 8 |   parser: 'babel-eslint',
 9 |   parserOptions: {
10 |     ecmaVersion: 2015,
11 |     sourceType: 'module',
12 |   },
13 |   plugins: ['import'],
14 |   rules: {
15 |     'array-callback-return': ['error'],
16 |     camelcase: ['warn'],
17 |     eqeqeq: ['error'],
18 |     'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
19 |     'import/named': ['error'],
20 |     'import/newline-after-import': ['warn'],
21 |     'import/no-unresolved': ['error'],
22 |     'linebreak-style': ['warn', 'unix'],
23 |     'max-classes-per-file': ['error', 1],
24 |     'no-alert': ['error'],
25 |     'no-console': ['error'],
26 |     'no-const-assign': ['error'],
27 |     'no-debugger': ['error'],
28 |     'no-duplicate-imports': ['error'],
29 |     'no-else-return': ['error'],
30 |     'no-extra-bind': ['error'],
31 |     'no-invalid-this': ['error'],
32 |     'no-multiple-empty-lines': ['warn'],
33 |     'no-multi-spaces': [
34 |       'warn',
35 |       { exceptions: { VariableDeclarator: true, ImportDeclaration: true } },
36 |     ],
37 |     'no-restricted-globals': ['error', 'fdescribe', 'fit'],
38 |     'no-shadow': ['error'],
39 |     'no-trailing-spaces': ['warn'],
40 |     'no-undef': ['error'],
41 |     'no-unreachable': ['error'],
42 |     'no-unused-vars': [
43 |       'error',
44 |       { argsIgnorePattern: '^_', ignoreRestSiblings: true, args: 'after-used' },
45 |     ],
46 |     'no-prototype-builtins': ['off'],
47 |     'no-var': ['error'],
48 |     'object-shorthand': ['warn'],
49 |     'prefer-const': ['error'],
50 |     'prefer-rest-params': ['error'],
51 |     'prefer-spread': ['warn'],
52 |     'prefer-template': ['warn'],
53 |   },
54 | };
55 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
 1 | * text=auto
 2 | 
 3 | *.jpg       binary
 4 | 
 5 | *.js        eol=lf
 6 | *.json      eol=lf
 7 | *.md        eol=lf
 8 | *.xml       eol=lf
 9 | *.yml       eol=lf
10 | 


--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
 1 | ### Description
 2 | 
 3 | Provide a description of the changes introduced in the PR.
 4 | 
 5 | ### Issue
 6 | 
 7 | Issue Link [Optional]
 8 | 
 9 | ### Type
10 | - [ ] Breaking change
11 | - [ ] Enhancement
12 | - [ ] Fix
13 | - [ ] Documentation
14 | - [ ] Tooling
15 | 


--------------------------------------------------------------------------------
/.github/workflows/CI.yml:
--------------------------------------------------------------------------------
 1 | # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests on node
 2 | 
 3 | name: CI
 4 | 
 5 | on:
 6 |   pull_request:
 7 |     branches: [ "master" ]
 8 | 
 9 | jobs:
10 |   validation:
11 | 
12 |     runs-on: ubuntu-latest
13 | 
14 |     steps:
15 |     - uses: actions/checkout@v3
16 |     - name: Use Node.js
17 |       uses: actions/setup-node@v3
18 |       with:
19 |         node-version: '16.x'
20 |         cache: 'npm'
21 |     - run: npm ci
22 |     - name: Lint
23 |       run: npm run lint
24 |     - name: Unit tests
25 |       run: npm test
26 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | .idea
3 | node_modules/*
4 | npm-debug.log
5 | dist_old
6 | examples/node_modules/*
7 | examples/.parcel-cache/*
8 | examples/dist/*


--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | tag-version-prefix = ""
2 | registry = https://registry.npmjs.org
3 | 


--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
 1 | node_modules
 2 | *.md
 3 | *.json
 4 | .travis.yml
 5 | .babelrc
 6 | .prettierrc
 7 | .gitignore
 8 | test/*.xml
 9 | dist/*
10 | dist_old/*
11 | performance/*
12 | 


--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 |     "printWidth": 80,
3 |     "tabWidth": 2,
4 |     "semi": true,
5 |     "singleQuote": true,
6 |     "parser": "flow"
7 | }
8 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 |   - 10.15.0
4 | script:
5 |   - npm run lint
6 |   - npm test
7 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2013 Olivier Poitrey <rs@dailymotion.com>
 2 |  
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is furnished
 8 | to do so, subject to the following conditions:
 9 |  
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 |  
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | THE SOFTWARE.
20 | 
21 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [![npm version](https://badgen.net/npm/v/vast-client)](https://badgen.net/npm/v/vast-client)
  2 | [![downloads per week](https://badgen.net/npm/dw/vast-client)](https://badgen.net/npm/dw/vast-client)
  3 | [![license](https://badgen.net/npm/license/vast-client)](https://badgen.net/npm/license/vast-client)
  4 | 
  5 | # VAST Client JS
  6 | 
  7 | Vast Client JS is a JavaScript library to fetch and parse Digital Video Ad Serving Template (VAST) documents.
  8 | 
  9 | This library provides three components:
 10 | 
 11 | * A **VAST Client** to fetch and parse VAST XML resources into JavaScript Objects.
 12 | * A **VAST Parser** to directly parse a VAST XML.
 13 | * A **VAST Tracker** to batch and call tracking URLs.
 14 | 
 15 | For the full API documentation go [here](#api).
 16 | For the full Class reference go [here](https://github.com/dailymotion/vast-client-js/blob/master/docs/api/class-reference.md)
 17 | 
 18 | To explore a practical example of how the VAST client can be implemented in web applications please visit this [link](https://githubbox.com/dailymotion/vast-client-js/tree/master/examples/web). Additionally, use this [link](https://githubbox.com/dailymotion/vast-client-js/tree/master/examples/node) to learn how to use the VAST client in a basic Node application.
 19 | 
 20 | Complies with the [VAST 4.3 specification](https://iabtechlab.com/wp-content/uploads/2022/09/VAST_4.3.pdf) provided by the [Interactive Advertising Bureau (IAB)](https://www.iab.com/).
 21 | 
 22 | ## Get Started
 23 | 
 24 | VAST Client JS is available as an NPM package and can be easily installed with:
 25 | 
 26 | ```Bash
 27 | npm i @dailymotion/vast-client
 28 | ```
 29 | 
 30 | Then import the components you need.
 31 | 
 32 | ### VASTClient
 33 | 
 34 | If you need to fetch and parse VAST documents, you can use the `get` method from the **VASTClient**:
 35 | 
 36 | ```javascript
 37 | import { VASTClient } from '@dailymotion/vast-client'
 38 | 
 39 | const vastClient = new VASTClient();
 40 | 
 41 | vastClient.get('https://www.examplevast.com/vast.xml')
 42 |   .then(parsedVAST => {
 43 |     // Do something with the parsed VAST response
 44 |   })
 45 |   .catch(err => {
 46 |     // Deal with the error
 47 |   });
 48 | ```
 49 | 
 50 | 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**.
 51 | 
 52 | If you need to directly parse a VAST XML and also follow any wrappers chain, you can use the  `parseVAST` method from the  **VASTClient** :
 53 | 
 54 | ```javascript
 55 | import { VASTClient } from '@dailymotion/vast-client'
 56 | 
 57 | const vastClient = new VASTClient();
 58 | 
 59 | vastClient.parseVAST(vastXml)
 60 |   .then(parsedVAST => {
 61 |     // Do something with the parsed VAST response
 62 |   })
 63 |   .catch(err => {
 64 |     // Deal with the error
 65 |   });
 66 | ```
 67 | ### VASTParser
 68 | 
 69 | To directly parse a VAST XML you can use the **VASTParser**:
 70 | The **VASTParser** will make no fetching, the final response will only contain the first VAST encountered.
 71 | 
 72 | ```Javascript
 73 | import { VASTParser } from '@dailymotion/vast-client'
 74 | 
 75 | const vastParser = new VASTParser();
 76 | 
 77 | vastParser.parseVAST(vastXml)
 78 |   .then(parsedVAST => {
 79 |     // Do something with the parsed VAST response
 80 |   })
 81 |   .catch(err => {
 82 |     // Deal with the error
 83 |   });
 84 | ```
 85 | 
 86 | ### VASTTracker
 87 | 
 88 | To track the execution of an ad, create a **VASTTracker** instance and use the dedicated [methods](docs/api/vast-tracker.md) to calls [VAST tracking elements](https://iabtechlab.com/wp-content/uploads/2019/06/VAST_4.2_final_june26.pdf#page=28).
 89 | 
 90 | ```Javascript
 91 | import { VASTTracker } from '@dailymotion/vast-client'
 92 | 
 93 | const vastTracker = new VASTTracker(vastClient, ad, creative);
 94 | 
 95 | // Track an impression for the given ad. Will call any <Impression> URI from the <InLine> and <Wrapper> tracking elements.
 96 | vastTracker.trackImpression();
 97 | ```
 98 | 
 99 | ## API Documentation<a name="api"></a>
100 | 
101 | The API documentation is organized by components:
102 | 
103 | * [VASTClient](docs/api/vast-client.md)
104 | * [VASTParser](docs/api/vast-parser.md)
105 | * [VASTTracker](docs/api/vast-tracker.md)
106 | 
107 | Changelog and migration guides can be found in the [release notes](https://github.com/dailymotion/vast-client-js/releases).
108 | 
109 | ### Pre-bundled versions
110 | 
111 | We provide several pre-bundled versions of the client (see [`dist` directory](dist/))
112 | 
113 | #### Bundlers
114 | 
115 | A version for js bundlers (like webpack or rollup) is available by default when adding the lib using a package manager (like npm or yarn): [`vast-client.js`](dist/vast-client.js) or [`vast-client.min.js`](dist/vast-client.min.js) [minified].
116 | 
117 | ```javascript
118 | const import {
119 |   VASTClient,
120 |   VASTParser,
121 |   VASTTracker
122 | } from '@dailymotion/vast-client'
123 | 
124 | const vastClient = new VASTClient();
125 | const vastParser = new VASTParser();
126 | const vastTracker = new VASTTracker();
127 | ```
128 | 
129 | #### Browser script
130 | 
131 | A pre-bundled version of VAST Client JS is available: [`vast-client.min.js`](dist/vast-client.min.js) [minified].
132 | 
133 | 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.
134 | 
135 | _your index.html_
136 | ```html
137 | <script type="module" src="your-main-file.js"></script>
138 | ```
139 | _main.js_
140 | ```javascript
141 | import {VASTClient, VASTParser, VASTTracker} from "vast-client.min.js"
142 | 
143 | const vastClient = new VASTClient();
144 | const vastParser = new VASTParser();
145 | const vastTracker = new VASTTracker();
146 | ```
147 | 
148 | #### Node
149 | 
150 | A pre-bundled version for node is available too: [`vast-client-node.js`](dist/vast-client-node.js) or [`vast-client-node.min.js`](dist/vast-client-node.min.js) [minified].
151 | 
152 | ```javascript
153 | // Method 1: From npm
154 | const VAST = require('@dailymotion/vast-client')
155 | 
156 | // Method 2: For pre-bundled you must copy first the file inside your project
157 | // then you will be able to require it without the need of npm
158 | const VAST = require('your/path/vast-client-node.min.js')
159 | 
160 | const vastClient = new VAST.VASTClient();
161 | const vastParser = new VAST.VASTParser();
162 | const vastTracker = new VAST.VASTTracker();
163 | ```
164 | 
165 | ## Build / Contribute
166 | 
167 | See [CONTRIBUTING](docs/CONTRIBUTING.md)
168 | 


--------------------------------------------------------------------------------
/bundle_size.js:
--------------------------------------------------------------------------------
 1 | const fs = require('fs');
 2 | 
 3 | const newDistPath = './dist';
 4 | const oldDistPath = './dist_old';
 5 | 
 6 | const getFileSizes = (folderPath) => {
 7 |   return fs.readdirSync(folderPath).reduce((res, fileName) => {
 8 |     const stats = fs.statSync(`${folderPath}/${fileName}`);
 9 |     if (stats.isFile()) {
10 |       res[fileName] = stats.size;
11 |     }
12 |     return res;
13 |   }, {});
14 | };
15 | 
16 | const oldValues = getFileSizes(oldDistPath);
17 | const newValues = getFileSizes(newDistPath);
18 | 
19 | Object.entries(oldValues).forEach(([name, size]) => {
20 |   const newSize = newValues[name];
21 |   const delta = newSize - size;
22 |   const sizeColorFg = delta <= 0 ? '\x1b[32m' : '\x1b[31m';
23 |   const resetColorFg = '\x1b[0m';
24 |   const nameColorFg = '\x1b[36m';
25 |   // eslint-disable-next-line no-console
26 |   console.log(
27 |     `${nameColorFg}%s${resetColorFg}%s${sizeColorFg}%s${resetColorFg}`,
28 |     `${name}:`,
29 |     ` ${size} B -> ${newSize} B `,
30 |     `(${delta >= 0 ? '+' : ''}${delta} B)`
31 |   );
32 | });
33 | 


--------------------------------------------------------------------------------
/deployment-scripts/deploy-release.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | set -e
 4 | 
 5 | RELEASE_VERSION=$1
 6 | VERSION_TYPE=$2
 7 | 
 8 |   if [[ -z "$RELEASE_VERSION" || -z "$VERSION_TYPE" ]]; then
 9 |     echo "Error: Missing version number or version type."
10 |     echo "Usage: npm run deploy -- <version> <major|minor|patch>"
11 |     exit 1
12 |   fi
13 | 
14 | git checkout master
15 | 
16 | echo "Pulling latest changes from master branch..."
17 | git pull
18 | 
19 | echo "Running lint checks..."
20 | npm run lint
21 | 
22 | echo "Running unit tests..."
23 | npm test
24 | 
25 | echo "Building project..."
26 | npm run build
27 | 
28 | git status --short
29 | 
30 | echo "Do you want to proceed with staging these files? (yes/no)"
31 | read CONFIRMATION
32 | 
33 | if [[ "$CONFIRMATION" == "yes" ]]; then
34 |   echo "Staging changes..."
35 |   git add .
36 | 
37 |   git commit -m "Bundle release $RELEASE_VERSION"
38 | 
39 |   echo "Bumping version..."
40 |   npm version $VERSION_TYPE
41 | 
42 |   echo "Publishing to npm..."
43 |   npm publish --access public
44 | 
45 |   echo "Pushing changes to repository..."
46 |   git push --tags origin master
47 | 
48 |   echo "Deployment complete!"
49 | else
50 |   echo "Staging aborted. No changes committed. Deployment aborted."
51 | fi
52 | 


--------------------------------------------------------------------------------
/dist/chunks/xmldom-623c1b6b.min.js:
--------------------------------------------------------------------------------
1 | "use strict";var e=require("./dom");exports.DOMImplementation=e.DOMImplementation,exports.XMLSerializer=e.XMLSerializer,exports.DOMParser=require("./dom-parser").DOMParser;
2 | 


--------------------------------------------------------------------------------
/dist/chunks/xmldom-ac2d7d04.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | 
3 | var dom = require('./dom');
4 | exports.DOMImplementation = dom.DOMImplementation;
5 | exports.XMLSerializer = dom.XMLSerializer;
6 | exports.DOMParser = require('./dom-parser').DOMParser;
7 | 


--------------------------------------------------------------------------------
/docs/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Contributor Covenant Code of Conduct
 2 | 
 3 | ### Our Pledge
 4 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 5 | 
 6 | ### Our Standards
 7 | Examples of behavior that contributes to creating a positive environment include:
 8 | 
 9 | * Using welcoming and inclusive language
10 | * Being respectful of differing viewpoints and experiences
11 | * Gracefully accepting constructive criticism
12 | * Focusing on what is best for the community
13 | * Showing empathy towards other community members
14 | 
15 | Examples of unacceptable behavior by participants include:
16 | 
17 | * Trolling, insulting/derogatory comments, and personal or political attacks
18 | * Public or private harassment
19 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
20 | * Other conduct which could reasonably be considered inappropriate in a professional setting
21 | 
22 | ### Our Responsibilities
23 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
24 | 
25 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
26 | 
27 | ### Scope
28 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
29 | 
30 | ### Enforcement
31 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at vast-client@dailymotion.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
32 | 
33 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
34 | 
35 | ### Attribution
36 | This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
37 | 
38 | For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
39 | 


--------------------------------------------------------------------------------
/docs/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | :tada: Thanks for being here :tada:
 4 | 
 5 | We appreciate any kind of contribution: bug reports, feature requests and pull requests.
 6 | 
 7 | Please read the following sections before making your contribution.
 8 | 
 9 | ## Report a bug / Request a feature
10 | To report a bug or request a feature, please [create an issue on GitHub](https://github.com/dailymotion/vast-client-js/issues/new) and follow the guidelines below.
11 | 
12 | ### Report a bug
13 |  * Explain the expected behaviour with a simple sentence
14 |  * Label the issue as a `bug`
15 |  * Provide the **steps** to reproduce your problem (if possible) or a simple **example** of code
16 |  * Report the **version** of the library you are using
17 |  * Is it a regression from a previous version?
18 | 
19 | ### Request a feature or suggest an enhancement
20 | If you see something that's missing or can be improved, please let us know!
21 | 
22 |  * Explain which feature/improvement you would like to be added to the library.
23 |  * Label the issue as `feature`, `enhancement` or `discussion`
24 |  * If you can, suggest how you would do that :sunglasses:
25 |  * If you already coded it, feel free to open and link a pull request :man_technologist: :woman_technologist:
26 | 
27 | ## Pull requests
28 | Pull requests are welcome. Here is a quick guide on how to start.
29 | 
30 |  * Develop in a dedicated branch, not directly on master
31 |  * If you add some logic, add some tests too
32 |  * Make sure test are passing (`npm test`)
33 |  * If you bundle the project, please don't commit the updated `vast-client.js` file in your PR. We'll take care of generating an updated build right before releasing a new tagged version.
34 |  * Follow the commit guidelines below 👇
35 |  * Label your PR with one of these three tags (Maintainers will then make the right release according to that)
36 |     * `breaking-change`
37 |     * `enhancement`
38 |     * `fix`
39 | 
40 | ## Commit messages
41 | In order to keep a clean and clear commit history, please commit to the repo following these guidelines:
42 | 
43 |  * Mark each commit with one of the following tags:
44 |     * `[client]` for commits involving `VASTClient` logic
45 |     * `[parser]` for commits involving `VASTParser` logic
46 |     * `[tracker]` for commits involving `VASTTracker` logic
47 |     * `[util]` for commits involving utility components logic
48 |     * `[test]` for commits adding or fixing tests
49 |     * `[docs]` for commits involving documentation
50 |     * `[tools]` for commits involving tooling
51 |  * Add a short description of the changes made in the commit
52 |  * If needed add a longer description in the following lines
53 | 
54 | Example:
55 | ```
56 | [tag][subtag] short commit message
57 | optional longer description of
58 | what happens in this commit
59 | ```
60 | ```
61 | [client][test] add tests for new get method parameters
62 | This commit adds some tests for some new optional parameter
63 | which have been added to the get method of the VASTClient component
64 | ```
65 | 
66 | ## Setup the project
67 | 
68 | Clone the repository :
69 | ```Bash
70 | git clone git@github.com:dailymotion/vast-client-js.git
71 | ```
72 | 
73 | Setup your environment :
74 | ```Bash
75 | cd vast-client-js
76 | 
77 | npm install
78 | ```
79 | 
80 | Run the tests :
81 | ```Bash
82 | npm test
83 | ```
84 | 
85 | ### Bundle
86 | 
87 | The project uses rollup to bundle the assets (output will be in `dist` folder):
88 | ```Bash
89 | npm run build
90 | ```
91 | 


--------------------------------------------------------------------------------
/docs/RELEASE-TASKS.md:
--------------------------------------------------------------------------------
 1 | # Release tasks
 2 | 
 3 | This document describes release tasks used during the project life-cycle.
 4 | We might want to automate some of them in a near future (e.g via Travis).
 5 | For now, let's use this document to make sure everyone is on the same page.
 6 | 
 7 | ## Release a new version
 8 | 
 9 | ``` Bash
10 | git checkout master
11 | npm test
12 | npm run build
13 | git add . && git commit -m "Bundle release [release version number]"
14 | npm version <major|minor|patch> # depending on the changes
15 | npm publish
16 | git push --tags origin master
17 | ```
18 | 


--------------------------------------------------------------------------------
/docs/api/1.x/client.md:
--------------------------------------------------------------------------------
 1 | # VAST Client
 2 | The VAST Client is accessed through *DMVAST.client* object.
 3 | 
 4 | ## Properties
 5 | 
 6 | ### `Number` cappingFreeLunch (default: `0`)
 7 | Used for ignoring the first `n` calls. Automatically reset 1 hour after the 1st ignored call. Free Lunch capping is disable if sets to `0`.
 8 | 
 9 | ``` javascript
10 | // Ignore the first 2 calls
11 | DMVAST.client.cappingFreeLunch = 2;
12 | 
13 | // The following DMVAST.client.get calls won't be done
14 | DMVAST.client.get(VASTUrl, cb);
15 | DMVAST.client.get(VASTUrl, cb);
16 | 
17 | // VASTUrl will be called
18 | DMVAST.client.get(VASTUrl, cb);
19 | ```
20 | 
21 | ### `Number` cappingMinimumTimeInterval (default: `0`)
22 | Used for ignoring calls that happen `n` ms after the previous call. Minimum time interval is disabled if sets to `0`.
23 | 
24 | ``` javascript
25 | // Ignore any call made 5 minutes or less after one.
26 | DMVAST.client.cappingMinimumTimeInterval = 5 * 60 * 1000;
27 | 
28 | // Work
29 | DMVAST.client.get(VASTUrl, cb);
30 | 
31 | // ...
32 | // 2 minutes later
33 | 
34 | // Ignored
35 | DMVAST.client.get(VASTUrl, cb);
36 | 
37 | // ...
38 | // 4 minutes later
39 | 
40 | // Work
41 | DMVAST.client.get(VASTUrl, cb);
42 | ```
43 | 
44 | ## Method
45 | 
46 | ### get( url [, options ], done )
47 | Fetch a URL and parse the response into a valid VAST object.
48 | 
49 | * `String` *url* – Contains the URL for fetching the VAST XML document.
50 | 
51 | * `Object` *options* – An optional set of key/value to configure the Ajax request:
52 |   * `String` *response* – A VAST XML document. When *response* is provided, no Ajax request is made and thus the *url* parameter is ignored.
53 |   * `Object` *urlhandler* – A URL handler module, used to fetch the VAST document instead of the [default ones](https://github.com/dailymotion/vast-client-js/tree/master/src/urlhandlers).
54 |   * `Boolean` *withCredentials* – A boolean to enable the *withCredentials* options for the XHR and FLASH URLHandlers.
55 |   * `Number` *wrapperLimit* – A number of available *Wrapper* responses that can be received with no InLine response.
56 | 
57 | * `Function` *done* – Method to be called once the VAST document is parsed. The VAST JS object is passed as the 1st parameter. If null, an error is provided as a 2nd parameter.
58 | 
59 | ``` javascript
60 | DMVAST.client.get('http://example.dailymotion.com/vast.xml', function(response, error)
61 | {
62 |   // process the VAST response
63 | });
64 | ```
65 | 


--------------------------------------------------------------------------------
/docs/api/1.x/parser.md:
--------------------------------------------------------------------------------
  1 | # VAST Parser
  2 | The VAST Parser is accessed through *DMVAST.parser* object.
  3 | 
  4 | Whenever an error occurs during the VAST parsing, the parser will call on his own all related tracking error URLs. Reported errors are:
  5 | 
  6 | * `no_ad`: The VAST document is empty
  7 | 
  8 | * VAST error `101`: VAST schema validation error.
  9 | 
 10 | * VAST error `301`: Timeout of VAST URI provided in Wrapper element.
 11 | 
 12 | * VAST error `302`: Wrapper limit reached.
 13 | 
 14 | * VAST error `303`: No VAST response after one or more Wrappers.
 15 | 
 16 | Once the VAST document parsed, a callback method is called with an array [`VASTAd`](https://github.com/dailymotion/vast-client-js/tree/master/src/ad.coffee) instances.
 17 | 
 18 | ## Methods
 19 | 
 20 | ### addURLTemplateFilter( replace )
 21 | Add the *replace* function at the end of the `URLTemplateFilters` array. All functions in `URLTemplateFilters`  will be called with the VAST URL as parameter before fetching the VAST URL document.
 22 | 
 23 | ``` javascript
 24 | DMVAST.parser.addURLTemplateFilter(function(vastUrl) {
 25 |     return url.replace('[DOMAIN]', 'mywebsite.com')
 26 | });
 27 | // For a VASTAdTagURI defined as :
 28 | // <VASTAdTagURI>http://example.dailymotion.com/vast.php?domain=[DOMAIN]</VASTAdTagURI>
 29 | // HTTP request will be:
 30 | // http://example.dailymotion.com/vast.php?domain=mywebsite.com
 31 | ```
 32 | 
 33 | ### clearUrlTemplateFilters()
 34 | Reset `URLTemplateFilters` to empty, previous *replace* function set with `addURLTemplateFilter()` are no longer called.
 35 | 
 36 | ``` javascript
 37 | DMVAST.parser.addURLTemplateFilter(function(vastUrl) {
 38 |     return url.replace('[DOMAIN]', 'mywebsite.com')
 39 | });
 40 | 
 41 | DMVAST.parser.clearUrlTemplateFilters();
 42 | // [DOMAIN] placeholder is no longer replaced
 43 | ```
 44 | 
 45 | ### countURLTemplateFilters()
 46 | Returns how many *replace* function are set (ie: `URLTemplateFilters` length)
 47 | 
 48 | ``` javascript
 49 | DMVAST.parser.addURLTemplateFilter(function(vastUrl) {
 50 |     return url.replace('[DOMAIN]', 'mywebsite.com')
 51 | });
 52 | 
 53 | DMVAST.parser.clearUrlTemplateFilters();
 54 | // return 1
 55 | ```
 56 | 
 57 | ### load( xml [, options ], done )
 58 | Parse an VAST xml, resolve any wrappers and execute callback function `done`
 59 | 
 60 | * `String` *XMLDocument* – A VAST XML document.
 61 | 
 62 | * `Object` *options* – An optional set of key/value to configure the Ajax request:
 63 |   * `Object` *urlhandler* – A URL handler module, used to fetch `VASTAdTagURI` URL. If defined, will be used instead of the [default ones](https://github.com/dailymotion/vast-client-js/tree/master/src/urlhandlers).
 64 |   * `Boolean` *withCredentials* – A boolean to enable the *withCredentials* options for the XHR and FLASH URLHandlers.
 65 |   * `Number` *wrapperLimit* – A number of available *Wrapper* responses that can be received with no InLine response.
 66 | 
 67 | * `Function` *done* – Callback function to be called once the VAST document is parsed. When at least 1 valid `<inline>` has been found, the 2nd parameter will be an array of [`VASTAd`](https://github.com/dailymotion/vast-client-js/tree/master/src/ad.coffee) instances. Otherwise, in case of no ads, it will be `null`, and an error as a 1st parameter is provided.
 68 |   * `Error` *error*
 69 |   * `[VASTAd]` *response*
 70 | 
 71 | ``` javascript
 72 | var xml = (new window.DOMParser()).parseFromString(xmlStr, "text/xml");
 73 | var options = {
 74 |     withCredentials : true,
 75 |     wrapperLimit : 5
 76 | };
 77 | 
 78 | DMVAST.parser.load(xml, options, function(error, response) {
 79 |   // process the VAST response
 80 | });
 81 | ```
 82 | 
 83 | ### on( eventName, listener)
 84 | Add the *listener* function for the event named *eventName*. *eventName* value can be :
 85 | * `String` *VAST-error* – emitted when the parser encountered a VAST error (ie: no ads, warapper timeout...). The VAST error code is passed to the *listener* function as a parameter.
 86 | ``` javascript
 87 | DMVAST.parser.on(`VAST-error`, function(error) {
 88 |     console.log('error:', error)
 89 | });
 90 | 
 91 | // Parsing a no ad VAST xml document
 92 | DMVAST.parser.load(xmlNoAds, options, function(error, response) {});
 93 | // Will log => "error: {ERRORCODE: 303}""
 94 | ```
 95 | 
 96 | ### once( eventName, listener)
 97 | Add a **one time** *listener* function for the event named *eventName*.
 98 | 
 99 | ### parse( url [, options ], done )
100 | Fetch a URL and parse the response into a valid VAST object.
101 | 
102 | * `String` *url* – The VAST XML document URL to fetch.
103 | 
104 | * `Object` *options* – An optional set of key/value to configure the Ajax request:
105 |   * `Object` *urlhandler* – A URL handler module, used to fetch the VAST document instead of the [default ones](https://github.com/dailymotion/vast-client-js/tree/master/src/urlhandlers).
106 |   * `Boolean` *withCredentials* – A boolean to enable the *withCredentials* options for the XHR and FLASH URLHandlers.
107 |   * `Number` *wrapperLimit* – A number of available *Wrapper* responses that can be received with no InLine response.
108 | 
109 | * `Function` *done* – Callback function to be called once the VAST document is parsed. When at least 1 valid `<inline>` has been found, the 1st parameter will be an array of [`VASTAd`](https://github.com/dailymotion/vast-client-js/tree/master/src/ad.coffee) instances. Hoverwise, in case of no ads, it will be `null`, and an error as a 2nd parameter is provided.
110 | 
111 | ``` javascript
112 | var url = 'http://example.dailymotion.com/vast.xml';
113 | var options = {
114 |     withCredentials : true,
115 |     wrapperLimit : 5
116 | };
117 | 
118 | DMVAST.parser.parse(url, options, function(response, error) {
119 |   // process the VAST response
120 | });
121 | ```
122 | 
123 | ### off( eventName, listener )
124 | Remove the specified *listener* for the event named *eventName*.
125 | 
126 | ### removeURLTemplateFilter( replace )
127 | Remove *replace* function from  `URLTemplateFilters` array. *replace* function won't be called on the next VAST URL encountred by the parser.
128 | 
129 | ``` javascript
130 | var replaceDomain = function() {
131 |     return url.replace('[DOMAIN]', 'mywebsite.com')
132 | };
133 | 
134 | DMVAST.parser.addURLTemplateFilter(replaceDomain);
135 | // ...
136 | DMVAST.parser.removeURLTemplateFilter(replaceDomain);
137 | // [DOMAIN] placeholder is no longer replaced
138 | ```
139 | 


--------------------------------------------------------------------------------
/docs/api/2.0-migration.md:
--------------------------------------------------------------------------------
  1 | # 1.x to 2.x migration guide
  2 | 
  3 | The release of the `2.0` version of the library introduced many breaking changes in the API.
  4 | 
  5 | This document is provided to support migration from a `1.x` to a `2.x` version of the library.
  6 | 
  7 | This guide covers the three components exposed by the library's API:
  8 |  * `VASTClient`
  9 |  * `VASTParser`
 10 |  * `VASTTracker`
 11 | 
 12 | ## No more static methods and properties
 13 | 
 14 | Vast Client JS `1.x` made strong use of static methods and properties. The `2.0` version removes all the static components in favor of a non-static access through an instance of the class.
 15 | 
 16 | `1.x` - Direct access to static components of the classes (without getting any instance of them):
 17 | ```Javascript
 18 | import DMVAST from 'vast-client'
 19 | 
 20 | const vastUrl = 'http://example.dailymotion.com/vast.xml';
 21 | 
 22 | DMVAST.client.get(VASTUrl, cb);
 23 | DMVAST.parser.parse(VASTUrl, options, function(response, error) {
 24 |   // process the VAST response
 25 | });
 26 | 
 27 | // Only the tracker component had already to be accessed through an instance of the class
 28 | var vastTracker = new DMVAST.tracker(ad, creative);
 29 | ```
 30 | 
 31 | `2.x` - To access any property or method of a class you first need to get an instance of the class using the constructor:
 32 | ```Javascript
 33 | import {
 34 |   VASTClient,
 35 |   VASTParser,
 36 |   VASTTracker
 37 | } from 'vast-client'
 38 | 
 39 | const vastUrl = 'http://example.dailymotion.com/vast.xml';
 40 | 
 41 | const client = new VASTClient();
 42 | const parser = new VASTParser();
 43 | const tracker = new VASTTracker(client, ad, creative);
 44 | 
 45 | // This would cause an error since methods are not static anymore
 46 | VASTClient.get(vastUrl, cb);
 47 | // Call get from the instance
 48 | client.get(vastUrl, cb);
 49 | ```
 50 | 
 51 | Another major impact of this change is that an action made on a component will now affect only the istance of that component on which the action has been made.
 52 | 
 53 | `1.x` - Adding an url template filter to the `VASTParser` class will affect the static properties of the class. Meaning that any class using the `VASTParser` will use this url template filter now:
 54 | ```Javascript
 55 | import DMVAST from 'vast-client'
 56 | 
 57 | DMVAST.parser.addURLTemplateFilter( function(vastUrl) {
 58 |     return url.replace('[DOMAIN]', 'mywebsite.com');
 59 | });
 60 | 
 61 | // Calling the get method of the client (which uses DMVAST.parser internally)
 62 | // will be affected by the above call to DMVAST.parser.addURLTemplateFilter
 63 | DMVAST.client.get(vastUrl, options, cb);
 64 | ```
 65 | 
 66 | `2.x` - Adding an url template filter to an instance of `VASTParser` will affect only the behavior of that instance:
 67 | ```Javascript
 68 | import {
 69 |   VASTClient,
 70 |   VASTParser
 71 | } from 'vast-client'
 72 | 
 73 | const client = new VASTClient();
 74 | const parser = new VASTParser();
 75 | 
 76 | parser.addURLTemplateFilter( vastUrl => url.replace('[DOMAIN]', 'mywebsite.com') );
 77 | 
 78 | // Calling the get method of the client (which uses an instance of VASTParser internally)
 79 | // will not be affected by the above call to parser.addURLTemplateFilter
 80 | // since the internal instance is a different one
 81 | client.get(vastUrl, options, cb);
 82 | 
 83 | // To have an effect on the client get behavior you need to call
 84 | // addURLTemplateFilter from the istance of VASTParser used by the client
 85 | client.vastParser.addURLTemplateFilter( vastUrl => url.replace('[DOMAIN]', 'mywebsite.com') );
 86 | 
 87 | // This call will now use the new template filter
 88 | client.get(vastUrl, options, cb);
 89 | ```
 90 | 
 91 | ## Promises over callback
 92 | Every callback function has been replaced with an es6 `Promise`.
 93 | ```Javascript
 94 | // before
 95 | vastClient.get('https://www.examplevast.com/vast.xml', (err, res) => {
 96 |   if (err) {
 97 |     // Deal with the error
 98 |   }
 99 | 
100 |   // Deal with the result
101 | }
102 | 
103 | // after
104 | vastClient.get('https://www.examplevast.com/vast.xml')
105 |   .then(res => {
106 |     // Do something with the parsed VAST response
107 |   })
108 |   .catch(err => {
109 |     // Deal with the error
110 |   })
111 | });
112 | ```
113 | 
114 | ## Changes in Client API
115 | 
116 | ### Constructor and properties
117 | As mentioned in the first section, now you can use the client only through an instance. Documentation for the constructor is available in the `VASTClient` API docs.
118 | 
119 | The constructor is now the preferred way to set the class properties. Direct access to properties should be avoided when possible.
120 | 
121 | ### Breaking changes in method signatures
122 |  * `get(url, [options,] cb)` becomes `get(url, options)`
123 | 
124 | ## Changes in Parser API
125 | 
126 | ### Constructor and properties
127 | As mentioned in the first section, you can now only use the parser through an instance. Documentation for the constructor is available in the `VASTParser` API docs.
128 | 
129 | ### Breaking changes in methods signatures
130 | These changes are mostly due to the semantic meaning of methods names.
131 | 
132 |  * `parse(url, [options,] cb)` becomes `getAndParseVAST(url, options)`
133 |  * `load(vastXml, [options,] cb)` becomes `parseVAST(vastXml, options)`
134 | 
135 | `1.x` - Fetch and parse a VAST or simply parse a VAST:
136 | ```Javascript
137 | // To fetch and parse a VAST
138 | var vastUrl = 'http://example.dailymotion.com/vast.xml';
139 | 
140 | DMVAST.parser.parse(vastUrl, options, cb);
141 | 
142 | // To parse an already fetched VAST xml
143 | var vastXml = (new window.DOMParser()).parseFromString(xmlStr, "text/xml");
144 | 
145 | DMVAST.parser.load(vastXml, options, cb);
146 | ```
147 | 
148 | `2.x` - Fetch and parse a VAST or simply parse a VAST:
149 | ```Javascript
150 | // To fetch and parse a VAST
151 | const vastUrl = 'http://example.dailymotion.com/vast.xml';
152 | 
153 | // A Promise is returned
154 | vastParser.getAndParseVAST(vastUrl, options);
155 | 
156 | // To parse an already fetched VAST xml
157 | const vastXml = (new window.DOMParser()).parseFromString(xmlStr, "text/xml");
158 | 
159 | // A Promise is returned
160 | vastParser.parseVAST(vastXml, options);
161 | ```
162 | 
163 | ### Breaking changes in events
164 | 
165 |  * `resolved` becomes `VAST-resolved`
166 |  * `resolving` becomes `VAST-resolving`
167 | 
168 | ## Changes in Tracker API
169 | 
170 | ### Constructor and properties
171 | The constructor now accepts a `VASTClient` instance as first parameter if you need your istance of `VASTClient` to be updated by the `VASTTracker`.
172 | 
173 | If you don't need that, simply pass `null` as first parameter to the constructor.
174 | 
175 | ### Breaking changes in methods signatures
176 | These changes are mostly due to the semantic meaning of methods names.
177 | 
178 |  * `load()` becomes `trackImpression()`
179 | 
180 | `1.x` - Track an ad impression:
181 | ```Javascript
182 | player.on('canplay', function() {
183 |   vastTracker.load();
184 | });
185 | ```
186 | 
187 | `2.x` - Track an ad impression:
188 | ```Javascript
189 | player.on('canplay', () => {
190 |   vastTracker.trackImpression();
191 | });
192 | ```
193 | 
194 | ### Breaking changes in events
195 | No breaking changes in `VASTTracker` events.
196 | 


--------------------------------------------------------------------------------
/docs/api/class-reference.md:
--------------------------------------------------------------------------------
  1 | # Object reference
  2 | 
  3 | ## VASTResponse
  4 | 
  5 | This object represents a parsed VAST response.
  6 | 
  7 | - `ads: Array<Object>` [go to object](#ad)
  8 | - `errorURLTemplates: Array<String>`
  9 | - `version: String`
 10 | 
 11 | ## Ad<a name="ad"></a>
 12 | 
 13 | This object represents a single parsed Ad
 14 | 
 15 | - `id: String|null`
 16 | - `sequence: Number|null`
 17 | - `adType: 'video'` An optional string that identifies the type of ad. Default value = video
 18 | - `adServingId: String`
 19 | - `categories: Array<Object>` [go to object](#category)
 20 | - `expires: Number|null`
 21 | - `viewableImpression: Array<Object>` [go to object](#viewable-impression)
 22 | - `system: String|null`
 23 | - `title: String|null`
 24 | - `description: String|null`
 25 | - `advertiser: Object|null`
 26 | - `pricing: String|null`
 27 | - `survey: Object|null` [go to object](#survey)
 28 | - `errorURLTemplates: Array<String>`
 29 | - `impressionURLTemplates: Array<Object>`
 30 | - `creatives: Array<Object>` [go to object](#creative)
 31 | - `extensions: Array<Object>` [go to object](#extension)
 32 | - `adVerifications: Array<Object>` [go to object](#ad-verification)
 33 | 
 34 | ## Creative<a name="creative"></a>
 35 | 
 36 | This object represents a generic Creative. It's used as a parent object for more specific creative implementations.
 37 | 
 38 | - `id: String|null`
 39 | - `adId: String|null`
 40 | - `sequence: Number|null`
 41 | - `apiFramework: String|null`
 42 | - `universalAdIds: Array<Object>` [go to object](#universaladid)
 43 | - `creativeExtensions: Array<Object>` [go to object](#extension)
 44 | 
 45 | ## CreativeLinear *extends* Creative<a name="creative-linear"></a>
 46 | 
 47 | - `type: String`
 48 | - `duration: Number`
 49 | - `skipDelay: Number|null`
 50 | - `mediaFiles: Array<Object>` [go to object](#mediafile)
 51 | - `mezzanine: Object<Object>` [go to object](#mezzanine)
 52 | - `interactiveCreativeFile: Object` [go to object](#interactivecreativefile)
 53 | - `closedCaptionFiles: Array<Object>` [go to object](#closedcaptionfile)
 54 | - `videoClickThroughURLTemplate: String|null`
 55 | - `videoClickTrackingURLTemplates: Array<String>`
 56 | - `videoCustomClickURLTemplates: Array<String>`
 57 | - `adParameters: Object|null` [go to object](#adparameters)
 58 | - `icons: Array<Object>` [go to object](#icon)
 59 | - `trackingEvents: Object`
 60 | 
 61 | ## CreativeNonLinear *extends* Creative<a name="creative-non-linear"></a>
 62 | 
 63 | - `type: String`
 64 | - `variations: Array<Object>` [go to object](#non-linear-ad)
 65 | - `trackingEvents: Object`
 66 | 
 67 | ## CreativeCompanion *extends* Creative<a name="creative-companion"></a>
 68 | 
 69 | - `type: String`
 70 | - `required: String|null`
 71 | - `variations: Array<Object>` [go to object](#companion-ad)
 72 | 
 73 | ## MediaFile<a name="mediafile"></a>
 74 | 
 75 | - `id: String|null`
 76 | - `fileURL: String|null`
 77 | - `deliveryType: String`
 78 | - `mimeType: String|null`
 79 | - `code: String|null`
 80 | - `bitrate: Number`
 81 | - `minBitrate: Number`
 82 | - `maxBitrate: Number`
 83 | - `width: Number`
 84 | - `height: Number`
 85 | - `fileSize: Number|null`
 86 | - `mediaType: String|null` Type of media file (3D / 360 / etc). Optional. Default value = 2D
 87 | - `apiFramework: String|null`
 88 | - `scalable: Boolean|null`
 89 | - `maintainAspectRatio: Boolean|null`
 90 | 
 91 | ## Mezzanine<a name="mezzanine"></a>
 92 | 
 93 | - `delivery: String` Either "progressive" for progressive download protocols (such as HTTP) or "streaming" for streaming protocols
 94 | - `type: String` MIME type for the file container. Popular MIME types include, but are not limited to "video/mp4" for MP4, "audio/mpeg" and "audio/aac" for audio ads
 95 | - `width: Number`
 96 | - `height: Number`
 97 | - `codec: String|null` The codec used to encode the file which can take values as specified by RFC 4281: http://tools.ietf.org/html/rfc4281
 98 | - `id: String|null`
 99 | - `fileSize: Number|null`
100 | - `mediaType: String|null` Type of media file (3D / 360 / etc). Optional. Default value = 2D
101 | - `fileURL: String|null`
102 | 
103 | ## InteractiveCreativeFile<a name="interactivecreativefile"></a>
104 | 
105 | - `type: String|null` MIME type for the file provided
106 | - `apiFramework: String|null` Identifies the API needed to execute the resource file, if applicable
107 | - `variableDuration: Boolean|null`  Identifies whether the ad always drops when the duration is reached, or if it can potentially extend the duration by pausing the underlying video or delaying the adStopped call after adVideoComplete
108 | - `fileURL: String|null`
109 | 
110 | ## ClosedCaptionFile<a name="closedcaptionfile"></a>
111 | 
112 | - `type: String|null` MIME type for the file provided
113 | - `language: String|null` Language of the Closed Caption File using ISO 631-1 codes
114 | - `fileURL: String|null`
115 | 
116 | ## NonLinearAd<a name="non-linear-ad"></a>
117 | 
118 | - `id: String|null`
119 | - `width: Number`
120 | - `height: Number`
121 | - `expandedWidth: Number`
122 | - `expandedHeight: Number`
123 | - `scalable: Boolean`
124 | - `maintainAspectRatio: Boolean`
125 | - `minSuggestedDuration: Number`
126 | - `apiFramework: String`
127 | - `type: String|null`
128 | - `staticResource: String|null`
129 | - `htmlResource: String|null`
130 | - `iframeResource: String|null`
131 | - `nonlinearClickThroughURLTemplate: String|null`
132 | - `nonlinearClickTrackingURLTemplates: Array<Object>`
133 | - `adParameters: Object|null` [go to object](#adparameters)
134 | 
135 | ## CompanionAd<a name="companion-ad"></a>
136 | 
137 | - `id: String|null`
138 | - `width: Number`
139 | - `height: Number`
140 | - `assetWidth: Number|null`
141 | - `assetHeight: Number|null`
142 | - `expandedWidth: Number|null`
143 | - `expandedHeight: Number|null`
144 | - `apiFramework: String|null`
145 | - `adSlotId: String|null`
146 | - `pxratio: String|'1'` The pixel ratio for which the companion creative is intended. Default value = 1
147 | - `renderingMode: String|'default'` Used to indicate when and where to use this companion ad. Default value = default
148 | - `staticResources: Array<{ url: String, creativeType: String|null }>`
149 | - `htmlResources: Array<String>`
150 | - `iframeResources: Array<String>`
151 | - `altText: String|null`
152 | - `companionClickThroughURLTemplate: String|null`
153 | - `companionClickTrackingURLTemplates: Array<Object>`
154 | - `trackingEvents: Object`
155 | - `adParameters: Object|null` [go to object](#adparameters)
156 | 
157 | ## Icon<a name="icon"></a>
158 | 
159 | - `program: String|null`
160 | - `height: Number`
161 | - `width: Number`
162 | - `xPosition: Number`
163 | - `yPosition: Number`
164 | - `apiFramework: String|null`
165 | - `offset: String|null`
166 | - `duration: Number`
167 | - `type: String|null`
168 | - `pxratio: String|'1'` The pixel ratio for which the icon creative is intended. Default value = 1
169 | - `staticResource: String|null`
170 | - `htmlResource: String|null`
171 | - `iframeResource: String|null`
172 | - `iconClickThroughURLTemplate: String|null`
173 | - `iconClickTrackingURLTemplates: Array<Object>`
174 | - `iconViewTrackingURLTemplate: String|null`
175 | - `iconClickFallbackImages: Array<object>` [go to object](#iconclickfallbackimage)
176 | - `altText: String|null`
177 | - `hoverText: String|null`
178 | 
179 | ## Extension<a name="extension"></a>
180 | 
181 | - `name: String|null`
182 | - `value: any`
183 | - `attributes: Object`
184 | - `children: Array<Extension>`
185 | 
186 | ## UniversalAdId<a name="universaladid"></a>
187 | 
188 | - `idRegistry: String|'unknown'` A string used to identify the URL for the registry website where the unique creative ID is cataloged. Default value is “unknown”.
189 | - `value: any`
190 | 
191 | ## AdVerification<a name="ad-verification"></a>
192 | 
193 | - `apiFramework: String|null` The name of the API framework used to execute the AdVerification code
194 | - `browserOptional: Boolean` If *true*, this resource is optimized and able to execute in an environment without DOM and other browser built-ins (e.g. iOS' JavaScriptCore).
195 | - `resource: String|null` URI to the JavaScript file used to collect verification data
196 | - `vendor: String|null` An identifier for the verification vendor
197 | - `type: String|null` The type of executable resource provided
198 | - `parameters: String|null`  String intended for bootstrapping the verification code and providing metadata about the current impression
199 | - `trackingEvents: Object`
200 | 
201 | ## Category<a name="category"></a>
202 | 
203 | - `authority: String` A URL for the organizational authority that produced the list being used to identify ad content category
204 | - `value: String` A category code or label that identifies the ad content category
205 | 
206 | ## ViewableImpression<a name="viewable-impression"></a>
207 | 
208 | - `id: String|null`
209 | - `viewable: Array<String>`
210 | - `notViewable: Array<String>`
211 | - `viewUndetermined: Array<String>`
212 | 
213 | ## BlockedAdCategories<a name="blocked-ad-categories"></a>
214 | 
215 | - `authority: String`
216 | - `value: String`
217 | 
218 | ## AdParameters<a name="adparameters"></a>
219 | 
220 | - `value: String`
221 | - `xmlEncoded: String|null`
222 | 
223 | ## Survey<a name="survey"></a>
224 | 
225 | - `value: String`
226 | - `type: String|null`
227 | 
228 | ## IconClickFallbackImage <a name="iconclickfallbackimage"></a>
229 | 
230 | - `url: String|null`,
231 | - `width: String|null`,
232 | - `height: String|null`


--------------------------------------------------------------------------------
/docs/api/event-emitter.md:
--------------------------------------------------------------------------------
  1 | # EventEmitter
  2 | 
  3 | This is a custom lightweight EventEmitter, based on Nodejs [`EventEmitter`](https://nodejs.org/api/events.html#events_class_eventemitter).
  4 | 
  5 | ## Public Methods 💚
  6 | 
  7 | ### on(event, handler)
  8 | 
  9 | Adds the event name and handler function to the end of the handlers array. No checks are made to see if the handler has already been added. Multiple calls passing the same combination of event name and handler will result in the handler being added, and called, multiple times.
 10 | 
 11 | #### Parameters
 12 | 
 13 | - **`event: String`** - The name of the event
 14 | - **`handler: Function`** - The callback function
 15 | 
 16 | #### Returns
 17 | 
 18 | - **`EventEmitter`**
 19 | 
 20 | ### once(event, handler)
 21 | 
 22 | Adds a one-time handler function for the named event. The next time event is triggered, this handler is removed and then invoked.
 23 | 
 24 | #### Parameters
 25 | 
 26 | - **`event: String`** - The name of the event
 27 | - **`handler: Function`** - The callback function
 28 | 
 29 | #### Returns
 30 | 
 31 | - **`EventEmitter`**
 32 | 
 33 | ### off(event, handler)
 34 | 
 35 | Removes all instances for the specified handler from the handler array for the named event.
 36 | 
 37 | #### Parameters
 38 | 
 39 | - **`event: String`** - The name of the event
 40 | - **`handler: Function`** - The callback function
 41 | 
 42 | #### Returns
 43 | 
 44 | - **`EventEmitter`**
 45 | 
 46 | ### emit(event[, ...args])
 47 | 
 48 | Synchronously calls each of the handlers registered for the named event, in the order they were registered, passing the supplied arguments to each.
 49 | 
 50 | #### Parameters
 51 | 
 52 | - **`event: String`** - The name of the event
 53 | - **`...args: any[]`** - arguments to pass to the event
 54 | 
 55 | #### Returns
 56 | 
 57 | - **`Boolean`** - returns true if the event had listeners, false otherwise.
 58 | 
 59 | ### removeAllListeners(event)
 60 | 
 61 | Removes all listeners, or those of the specified named event.
 62 | 
 63 | #### Parameters
 64 | 
 65 | - **`event: String`** - The name of the event. Optional
 66 | 
 67 | #### Returns
 68 | 
 69 | - **`EventEmitter`**
 70 | 
 71 | ### listenerCount(event)
 72 | 
 73 | Returns the number of listeners listening to the named event.
 74 | 
 75 | #### Parameters
 76 | 
 77 | - **`event: String`** - The name of the event
 78 | 
 79 | #### Returns
 80 | 
 81 | - **`Number`** - number of listeners registered to the named event
 82 | 
 83 | ### listeners(event)
 84 | 
 85 | Returns a copy of the array of listeners for the named event including those created by .once().
 86 | 
 87 | #### Parameters
 88 | 
 89 | - **`event: String`** - The name of the event
 90 | 
 91 | #### Returns
 92 | 
 93 | - **`Function[]`** - array of listeners registered to the named event
 94 | 
 95 | ### eventNames()
 96 | 
 97 | Returns an array listing the events for which the emitter has registered handlers.
 98 | 
 99 | #### Returns
100 | 
101 | - **`String[]`** - array of named events that are registered
102 | 


--------------------------------------------------------------------------------
/docs/api/img/adpods.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dailymotion/vast-client-js/125fb7bf3fc4f7567b1af1ae7176dc4b50545dcb/docs/api/img/adpods.jpg


--------------------------------------------------------------------------------
/examples/node/index.js:
--------------------------------------------------------------------------------
 1 | import { VASTClient } from '../../dist/vast-client-node.js';
 2 | 
 3 | const vastClient = new VASTClient();
 4 | 
 5 | async function parseSimpleInline() {
 6 |     const parsedVast = await vastClient.get("https://statics.dmcdn.net/h/html/vast/simple-inline.xml");
 7 |     // eslint-disable-next-line no-console
 8 |     console.log(parsedVast);
 9 | }
10 | 
11 | await parseSimpleInline();
12 | 


--------------------------------------------------------------------------------
/examples/node/package-lock.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "test-node",
 3 |   "version": "1.0.0",
 4 |   "lockfileVersion": 3,
 5 |   "requires": true,
 6 |   "packages": {
 7 |     "": {
 8 |       "name": "test-node",
 9 |       "version": "1.0.0",
10 |       "license": "ISC"
11 |     }
12 |   }
13 | }
14 | 


--------------------------------------------------------------------------------
/examples/node/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "VASTClient-node-example",
 3 |   "version": "1.0.0",
 4 |   "main": "index.js",
 5 |   "type": "module",
 6 |   "scripts": {
 7 |     "start": "node index.js",
 8 |     "test": "echo \"Error: no test specified\" && exit 1"
 9 |   },
10 |   "author": "Dailymotion <vast-client@dailymotion.com> (https://developer.dailymotion.com/)",
11 |   "license": "MIT",
12 |   "description": "VAST Client node usage example"
13 | }
14 | 


--------------------------------------------------------------------------------
/examples/web/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "javascript",
 3 |     "version": "1.0.0",
 4 |     "description": "The JavaScript template",
 5 |     "scripts": {
 6 |       "start": "parcel ./src/index.html",
 7 |       "build": "parcel build ./src/index.html"
 8 |     },
 9 |     "devDependencies": {
10 |       "parcel": "^2.0.0",
11 |       "babel-eslint": "^10.1.0",
12 |       "eslint": "^7.2.0"
13 |     },
14 |     "keywords": [
15 |       "css",
16 |       "javascript"
17 |     ],
18 |     "dependencies": {
19 |       "@dailymotion/vast-client": "5.0.0"
20 |     }
21 |   }
22 |   


--------------------------------------------------------------------------------
/examples/web/src/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="UTF-8" />
 5 |     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 7 |     <link rel="stylesheet" type="text/css" href="./styles.css" />
 8 |     <title>Demonstrating Vast-client.js Library and Implementing Preroll</title>
 9 |   </head>
10 |   <body>
11 |     <main role="main" id="main">
12 |       <h1>vast-client.js use case</h1>
13 |       <p>This page aim to demonstrate how to use the vast-client.js library and implement a simple preroll using a html5 video tag.</p>
14 |       <div class="video-container">
15 |         <video
16 |           id="myVideo"
17 |           src="https://dmplayer.storage.googleapis.com/tech_test/midnight_sun_720p.mp4"
18 |           width="480"
19 |           height="360"
20 |           controls
21 |         ></video>
22 |       </div>
23 |       <p>Companion ad slot</p>
24 |       <div id ="variationContainer">
25 |         <img src="#" alt="IAB companion ad image" id="variationImg" />  
26 |       </div>
27 |     </main>   
28 |     <script type="module" src="index.js" type="text/javascript"></script>
29 |   </body>
30 | </html>
31 | 


--------------------------------------------------------------------------------
/examples/web/src/index.js:
--------------------------------------------------------------------------------
1 | import { playPreroll } from './utils';
2 | 
3 | const videoPlayer = document.getElementById('myVideo');
4 | 
5 | videoPlayer.addEventListener('play', playPreroll, { once: true });
6 | 


--------------------------------------------------------------------------------
/examples/web/src/styles.css:
--------------------------------------------------------------------------------
 1 | main {
 2 |   display: flex;
 3 |   align-items: center;
 4 |   flex-direction: column;
 5 | }
 6 | 
 7 | h1 {
 8 |   font-size: 25px;
 9 | }
10 | 
11 | #variationContainer {
12 |   display: none;
13 | }
14 | 


--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
1 | // For a detailed explanation regarding each configuration property, visit:
2 | // https://jestjs.io/docs/en/configuration.html
3 | 
4 | module.exports = {
5 |   clearMocks: true,
6 | };
7 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "@dailymotion/vast-client",
 3 |   "author": "Dailymotion <vast-client@dailymotion.com> (https://developer.dailymotion.com/)",
 4 |   "version": "6.3.1",
 5 |   "description": "JavaScript VAST Client",
 6 |   "keywords": [
 7 |     "vast",
 8 |     "ad",
 9 |     "advertising",
10 |     "iab",
11 |     "in-stream",
12 |     "video"
13 |   ],
14 |   "repository": {
15 |     "type": "git",
16 |     "url": "https://github.com/dailymotion/vast-client-js"
17 |   },
18 |   "license": "MIT",
19 |   "engines": {
20 |     "node": ">=12.22.1"
21 |   },
22 |   "browserslist": [
23 |     "chrome >= 63",
24 |     "firefox >= 67",
25 |     "edge >= 79",
26 |     "safari >= 12.1"
27 |   ],
28 |   "publishConfig": {
29 |     "registry": "https://registry.npmjs.org"
30 |   },
31 |   "main": "dist/vast-client-node.min.js",
32 |   "browser": "dist/vast-client.min.js",
33 |   "scripts": {
34 |     "performance": "node performance/performance_test.js",
35 |     "prebuild": "rm -rf dist_old && mkdir dist_old && cp -a dist/. dist_old/",
36 |     "build": "rollup -c",
37 |     "watch": "rollup -c --watch",
38 |     "postbuild": "node bundle_size.js",
39 |     "deploy": "bash deployment-scripts/deploy-release.sh",
40 |     "lint": "eslint .",
41 |     "precommit": "eslint . --max-warnings 0 && pretty-quick --staged",
42 |     "test": "jest"
43 |   },
44 |   "devDependencies": {
45 |     "@babel/core": "^7.16.12",
46 |     "@babel/preset-env": "^7.16.11",
47 |     "@babel/register": "^7.16.9",
48 |     "@rollup/plugin-alias": "^3.1.9",
49 |     "@rollup/plugin-babel": "^5.3.0",
50 |     "@rollup/plugin-commonjs": "^15.1.0",
51 |     "@rollup/plugin-node-resolve": "^9.0.0",
52 |     "babel-eslint": "^10.1.0",
53 |     "babel-preset-env": "^1.7.0",
54 |     "babel-register": "^6.26.0",
55 |     "canvas": "^2.9.0",
56 |     "eslint": "^7.32.0",
57 |     "eslint-plugin-import": "^2.25.4",
58 |     "husky": "^8.0.3",
59 |     "jest": "^26.6.3",
60 |     "path": "^0.12.7",
61 |     "prettier": "^2.5.1",
62 |     "pretty-quick": "^3.1.3",
63 |     "rollup": "^2.66.1",
64 |     "rollup-plugin-terser": "^7.0.2",
65 |     "should": "^13.2.3",
66 |     "sinon": "^2.4.1"
67 |   },
68 |   "dependencies": {
69 |     "@xmldom/xmldom": "^0.8.3"
70 |   }
71 | }
72 | 


--------------------------------------------------------------------------------
/performance/get_time.js:
--------------------------------------------------------------------------------
 1 | const { pathToFileURL } = require('url');
 2 | const process = require('process');
 3 | const { VASTClient } = require('../dist/vast-client-node.min.js');
 4 | 
 5 | const url = pathToFileURL('spec/samples/inline-linear.xml').toString();
 6 | 
 7 | const VastClient = new VASTClient();
 8 | 
 9 | const timeBefore = process.hrtime();
10 | VastClient.get(url)
11 |   .then(() => {
12 |     const res = process.hrtime(timeBefore);
13 |     console.log(res[0] * 1000 + res[1] * 0.000001);
14 |   })
15 |   .catch((e) => {
16 |     console.error(e)
17 |   });
18 | 


--------------------------------------------------------------------------------
/performance/parse_time.js:
--------------------------------------------------------------------------------
 1 | const xmldom = require('@xmldom/xmldom');
 2 | const fs = require('fs');
 3 | const process = require('process');
 4 | const { VASTParser } = require('../dist/vast-client-node.min.js');
 5 | 
 6 | const stringifiedXml = fs.readFileSync('spec/samples/inline-linear.xml').toString();
 7 | const inlineXml = new xmldom.DOMParser().parseFromString(stringifiedXml, 'text/xml');
 8 | 
 9 | const VastParser = new VASTParser();
10 | 
11 | const timeBefore = process.hrtime();
12 | VastParser.parseVAST(inlineXml)
13 |   .then(() => {
14 |     const res = process.hrtime(timeBefore);
15 |     console.log(res[0] * 1000 + res[1] * 0.000001);
16 |   })
17 |   .catch((e) => {
18 |     console.error(e)
19 |   });
20 | 


--------------------------------------------------------------------------------
/performance/performance_test.js:
--------------------------------------------------------------------------------
 1 | const { spawn } = require('child_process');
 2 | 
 3 | const numberOfRuns = 100;
 4 | 
 5 | const getAverage = list => {
 6 |   return list.reduce((res, value) => (res += value), 0) / list.length;
 7 | };
 8 | 
 9 | /**
10 |  * Calculates the average time taken of the given async test by running it multiple times.
11 |  * Each run is executed in a child process, to not share resources between test runs.
12 |  * The given async test must pass the time taken in a console log, for the performance test to work.
13 |  * @param {String} name - name of the test for the console log
14 |  * @param {String} testFilePath - absolute path to the test file
15 |  */
16 | const runAsyncTimeAverageTest = async (name, testFilePath) => {
17 |   const times = [];
18 | 
19 |   for (let i = 0; i < numberOfRuns; i++) {
20 |     try {
21 |       const time = await new Promise((resolve, reject) => {
22 |         const proc = spawn("node", [testFilePath]);
23 | 
24 |         proc.stdout.on("data", (data) => {
25 |           const dataString = data.toString()
26 |           if (dataString.match(/^\d+|\d+\.\d+$/g)) {
27 |             resolve(parseInt(dataString, 10))
28 |           }
29 |         })
30 |         proc.stderr.on("data", (error) => {
31 |           reject(error.toString());
32 |         })
33 |       })
34 | 
35 |       times.push(time)
36 |     } catch(e) {
37 |       console.error(e);
38 |       process.exit(1);
39 |     }
40 |   }
41 | 
42 |   console.log(`${name} - Average parsing time:`, getAverage(times), 'ms');
43 | }
44 | 
45 | runAsyncTimeAverageTest('VASTClient', 'performance/get_time.js')
46 | runAsyncTimeAverageTest('VASTParser', 'performance/parse_time.js')
47 | 


--------------------------------------------------------------------------------
/rollup.config.js:
--------------------------------------------------------------------------------
 1 | import babel from '@rollup/plugin-babel';
 2 | import { terser } from 'rollup-plugin-terser';
 3 | import resolve from '@rollup/plugin-node-resolve';
 4 | import commonjs from '@rollup/plugin-commonjs';
 5 | 
 6 | const babelPlugin = babel({
 7 |   babelrc: false,
 8 |   presets: [['@babel/preset-env', { modules: false }]],
 9 |   exclude: ['node_modules/**'],
10 | });
11 | 
12 | function onwarn(warning) {
13 |   if (warning.code !== 'CIRCULAR_DEPENDENCY') {
14 |     console.error(`(!) ${warning.message}`);
15 |   }
16 | }
17 | 
18 | const createNodeConfig = (filePath, minifiedOutput, notMinifiedOutput) => {
19 |   const baseConfig = {
20 |     input: filePath,
21 |     output: {
22 |       format: 'cjs',
23 |       dir: 'dist',
24 |       manualChunks: {
25 |         xmldom: ['@xmldom/xmldom'],
26 |       },
27 |     },
28 |     plugins: [
29 |       resolve({
30 |         preferBuiltins: true,
31 |       }),
32 |       babelPlugin,
33 |       // We need commonjs for xmldom: https://github.com/xmldom/xmldom/issues/316
34 |       commonjs({
35 |         include: ["./node_modules/@xmldom/xmldom/lib/*.js"]
36 |     })
37 |     ],
38 |     onwarn,
39 |   };
40 | 
41 |   const nonMinifiedConfig = {
42 |     ...baseConfig,
43 |     output: {
44 |       ...baseConfig.output,
45 |       entryFileNames: notMinifiedOutput,
46 |       chunkFileNames: 'chunks/[name]-[hash].js',
47 |     },
48 |   };
49 | 
50 |   const minifiedConfig = {
51 |     ...baseConfig,
52 |     output: {
53 |       ...baseConfig.output,
54 |       entryFileNames: minifiedOutput,
55 |       chunkFileNames: 'chunks/[name]-[hash].min.js',
56 |     },
57 |     plugins: [...baseConfig.plugins, terser()],
58 |   };
59 | 
60 |   return [nonMinifiedConfig, minifiedConfig];
61 | };
62 | 
63 | const createBrowserConfig = (filePath, minifiedOutput, notMinifiedOutput) => {
64 |   let config = {
65 |     input: filePath,
66 |     output: [
67 |       {
68 |         format: 'es',
69 |         dir: 'dist',
70 |         entryFileNames: notMinifiedOutput,
71 |       },
72 |       {
73 |         format: 'es',
74 |         dir: 'dist',
75 |         entryFileNames: minifiedOutput,
76 |         plugins: [terser()],
77 |       },
78 |     ],
79 |     plugins: [babelPlugin],
80 |   };
81 | 
82 |   return config;
83 | };
84 | 
85 | export default [
86 |   // Browser-friendly build [package.json "browser"]
87 |   createBrowserConfig('src/index.js', 'vast-client.min.js', 'vast-client.js'),
88 |   // CommonJS build for Node usage [package.json "main"]
89 |   ...createNodeConfig(
90 |     'src/index.js',
91 |     'vast-client-node.min.js',
92 |     'vast-client-node.js'
93 |   ),
94 | ];
95 | 


--------------------------------------------------------------------------------
/spec/bitrate.spec.js:
--------------------------------------------------------------------------------
 1 | import * as Bitrate from '../src/parser/bitrate';
 2 | 
 3 | describe('updateEstimatedBitrate', () => {
 4 |   beforeEach(() => {
 5 |     Bitrate.estimatedBitrate = 0;
 6 |   });
 7 | 
 8 |   it('does not update estimated bitrate if one value is missing', () => {
 9 |     Bitrate.updateEstimatedBitrate(1000, null);
10 |     expect(Bitrate.estimatedBitrate).toEqual(0);
11 |     Bitrate.updateEstimatedBitrate(null, 1234);
12 |     expect(Bitrate.estimatedBitrate).toEqual(0);
13 |   });
14 | 
15 |   it('does not update estimated bitrate if one value is negative', () => {
16 |     Bitrate.updateEstimatedBitrate(1000, -12);
17 |     expect(Bitrate.estimatedBitrate).toEqual(0);
18 |     Bitrate.updateEstimatedBitrate(-243, 1234);
19 |     expect(Bitrate.estimatedBitrate).toEqual(0);
20 |   });
21 | 
22 |   it('updates estimated bitrate if values are both positive and make the average from cumulated values', () => {
23 |     Bitrate.updateEstimatedBitrate(1000, 200);
24 |     expect(Bitrate.estimatedBitrate).toEqual(40);
25 |     Bitrate.updateEstimatedBitrate(100, 200);
26 |     expect(Bitrate.estimatedBitrate).toEqual(22);
27 |     Bitrate.updateEstimatedBitrate(2050, 200);
28 |     expect(Bitrate.estimatedBitrate).toEqual(42);
29 |   });
30 | });
31 | 


--------------------------------------------------------------------------------
/spec/creative_companion_parser.spec.js:
--------------------------------------------------------------------------------
  1 | import { parseCreativeCompanion } from '../src/parser/creative_companion_parser';
  2 | import { getNodesFromXml } from './utils/utils';
  3 | import { companionAds } from './samples/companion_ads';
  4 | 
  5 | describe('parseCreativeCompanion', function () {
  6 |   const creativeElement = getNodesFromXml(companionAds);
  7 |   const creativeAttributes = {
  8 |     id: '1',
  9 |     adId: '1234',
 10 |     sequence: '1',
 11 |     apiFramework: null,
 12 |   };
 13 |   let creative = null;
 14 | 
 15 |   beforeEach(() => {
 16 |     creative = parseCreativeCompanion(creativeElement, creativeAttributes);
 17 |   });
 18 | 
 19 |   it('has type companion', () => {
 20 |     expect(creative.type).toBe('companion');
 21 |   });
 22 | 
 23 |   it('contains the attributes of the creative', () => {
 24 |     expect(creative).toMatchObject({
 25 |       id: '1',
 26 |       adId: '1234',
 27 |       sequence: '1',
 28 |       apiFramework: null,
 29 |     });
 30 |   });
 31 | 
 32 |   it('contains the required attribute', () => {
 33 |     expect(creative.required).toBe('any');
 34 |   });
 35 | 
 36 |   it('returns 3 companion ads', () => {
 37 |     expect(creative.variations).toHaveLength(3);
 38 |   });
 39 | 
 40 |   describe('first companion', () => {
 41 |     let companion = null;
 42 |     beforeEach(() => {
 43 |       companion = creative.variations[0];
 44 |     });
 45 | 
 46 |     it('contains the attributes of the companion', () => {
 47 |       expect(companion).toMatchObject({
 48 |         id: '1',
 49 |         width: '300',
 50 |         height: '250',
 51 |         assetWidth: '250',
 52 |         assetHeight: '200',
 53 |         expandedWidth: '350',
 54 |         expandedHeight: '250',
 55 |         apiFramework: 'VPAID',
 56 |         adSlotId: '1',
 57 |         pxratio: '2',
 58 |         renderingMode: 'end-card',
 59 |       });
 60 |     });
 61 | 
 62 |     it('gets the static resources and their creative types', () => {
 63 |       expect(companion.staticResources).toEqual([
 64 |         {
 65 |           url: 'http://example.com/companion1-static-resource1',
 66 |           creativeType: 'image/jpeg',
 67 |         },
 68 |         {
 69 |           url: 'http://example.com/companion1-static-resource2',
 70 |           creativeType: 'image/jpeg',
 71 |         },
 72 |       ]);
 73 |       expect(companion.iframeResources).toEqual([]);
 74 |       expect(companion.htmlResources).toEqual([]);
 75 |     });
 76 | 
 77 |     it('gets altText', () => {
 78 |       expect(companion.altText).toBe('Sample Alt Text Content');
 79 |     });
 80 | 
 81 |     it('gets tracking events', () => {
 82 |       expect(companion.trackingEvents).toEqual({
 83 |         creativeView: ['http://example.com/companion1-creativeview'],
 84 |       });
 85 |     });
 86 | 
 87 |     it('gets companionClickThroughURLTemplate', () => {
 88 |       expect(companion.companionClickThroughURLTemplate).toBe(
 89 |         'http://example.com/companion1-clickthrough'
 90 |       );
 91 |     });
 92 | 
 93 |     it('gets companionClickTrackingURLTemplates', () => {
 94 |       expect(companion.companionClickTrackingURLTemplates).toEqual([
 95 |         {
 96 |           id: '1',
 97 |           url: 'http://example.com/companion1-clicktracking-first',
 98 |         },
 99 |         {
100 |           id: '2',
101 |           url: 'http://example.com/companion1-clicktracking-second',
102 |         },
103 |       ]);
104 |     });
105 | 
106 |     describe('adParameters', () => {
107 |       it('gets adParameters', () => {
108 |         expect(companion.adParameters).toMatchObject({
109 |           value: 'campaign_id=1',
110 |           xmlEncoded: 'false',
111 |         });
112 |       });
113 |     });
114 |   });
115 | 
116 |   describe('second companion', () => {
117 |     let companion = null;
118 |     beforeEach(() => {
119 |       companion = creative.variations[1];
120 |     });
121 | 
122 |     it('contains the attributes of the companion', () => {
123 |       expect(companion).toMatchObject({
124 |         id: '2',
125 |         width: '300',
126 |         height: '60',
127 |         assetWidth: '250',
128 |         assetHeight: '200',
129 |         expandedWidth: '350',
130 |         expandedHeight: '250',
131 |         apiFramework: 'VPAID',
132 |         adSlotId: '2',
133 |         pxratio: '1',
134 |         renderingMode: 'concurrent',
135 |       });
136 |     });
137 | 
138 |     it('gets the iframe resources', () => {
139 |       expect(companion.staticResources).toEqual([]);
140 |       expect(companion.iframeResources).toEqual([
141 |         'http://www.example.com/companion2-example.php',
142 |       ]);
143 |       expect(companion.htmlResources).toEqual([]);
144 |     });
145 | 
146 |     it('gets altText', () => {
147 |       expect(companion.altText).toBe('Sample Alt Text Content');
148 |     });
149 | 
150 |     it('gets tracking events', () => {
151 |       expect(companion.trackingEvents).toEqual({
152 |         creativeView: ['http://example.com/companion2-creativeview'],
153 |       });
154 |     });
155 | 
156 |     it('gets companionClickThroughURLTemplate', () => {
157 |       expect(companion.companionClickThroughURLTemplate).toBe(
158 |         'http://www.example.com/companion2-clickthrough'
159 |       );
160 |     });
161 | 
162 |     it('has no companionClickTrackingURLTemplates', () => {
163 |       expect(companion.companionClickTrackingURLTemplates).toEqual([]);
164 |     });
165 | 
166 |     describe('adParameters', () => {
167 |       it('gets adParameters', () => {
168 |         expect(companion.adParameters).toMatchObject({
169 |           value: 'campaign_id=2',
170 |           xmlEncoded: null,
171 |         });
172 |       });
173 |     });
174 |   });
175 | 
176 |   describe('third companion', () => {
177 |     let companion = null;
178 |     beforeEach(() => {
179 |       companion = creative.variations[2];
180 |     });
181 | 
182 |     it('contains the attributes of the companion', () => {
183 |       expect(companion).toMatchObject({
184 |         id: '3',
185 |         width: '300',
186 |         height: '60',
187 |         assetWidth: '250',
188 |         assetHeight: '200',
189 |         expandedWidth: '350',
190 |         expandedHeight: '250',
191 |         apiFramework: 'VPAID',
192 |         adSlotId: '3',
193 |         pxratio: '1',
194 |         renderingMode: 'default',
195 |       });
196 |     });
197 | 
198 |     it('gets the html resources', () => {
199 |       expect(companion.staticResources).toEqual([]);
200 |       expect(companion.iframeResources).toEqual([]);
201 |       expect(companion.htmlResources).toEqual([
202 |         '<a href="http://www.example.com" target="_blank">Some call to action HTML!</a>',
203 |       ]);
204 |     });
205 | 
206 |     it('gets altText', () => {
207 |       expect(companion.altText).toBe('Sample Alt Text Content');
208 |     });
209 | 
210 |     it('gets tracking events', () => {
211 |       expect(companion.trackingEvents).toEqual({
212 |         creativeView: ['http://example.com/companion3-creativeview'],
213 |       });
214 |     });
215 | 
216 |     it('gets companionClickThroughURLTemplate', () => {
217 |       expect(companion.companionClickThroughURLTemplate).toBe(
218 |         'http://www.example.com/companion3-clickthrough'
219 |       );
220 |     });
221 | 
222 |     it('has no companionClickTrackingURLTemplates', () => {
223 |       expect(companion.companionClickTrackingURLTemplates).toEqual([]);
224 |     });
225 | 
226 |     describe('adParameters', () => {
227 |       it('gets adParameters', () => {
228 |         expect(companion.adParameters).toMatchObject({
229 |           value: 'campaign_id=3',
230 |           xmlEncoded: null,
231 |         });
232 |       });
233 |     });
234 |   });
235 | });
236 | 


--------------------------------------------------------------------------------
/spec/creatives_parser.spec.js:
--------------------------------------------------------------------------------
  1 | import { parseCreatives } from '../src/parser/creatives_parser';
  2 | import { parserUtils } from '../src/parser/parser_utils';
  3 | import { getNodesFromXml } from './utils/utils';
  4 | import { creatives } from './samples/creatives';
  5 | 
  6 | describe('CreativesParser', function () {
  7 |   describe('ParseCreatives', function () {
  8 |     let parsedCreatives;
  9 | 
 10 |     beforeAll(() => {
 11 |       const creativeNodes = parserUtils.childrenByName(
 12 |         getNodesFromXml(creatives),
 13 |         'Creative'
 14 |       );
 15 |       parsedCreatives = parseCreatives(creativeNodes);
 16 |     });
 17 | 
 18 |     it('validate parsedCreatives has length 3', () => {
 19 |       expect(parsedCreatives.length).toEqual(3);
 20 |     });
 21 | 
 22 |     it('validate first parsedCreative', () => {
 23 |       const creative = parsedCreatives[0];
 24 |       expect(creative.id).toEqual('id130984');
 25 |       expect(creative.adId).toEqual('adId345690');
 26 |       expect(creative.universalAdIds[0].idRegistry).toEqual('daily-motion-L1');
 27 |       expect(creative.universalAdIds[0].value).toEqual('Linear-12345');
 28 |       expect(creative.universalAdIds[1].idRegistry).toEqual('daily-motion-L2');
 29 |       expect(creative.universalAdIds[1].value).toEqual('Linear-5678');
 30 |       expect(creative.type).toEqual('linear');
 31 |       expect(creative.mediaFiles.length).toEqual(2);
 32 |       expect(creative.adParameters).toEqual({
 33 |         value: '{"key":"value"}',
 34 |         xmlEncoded: 'false',
 35 |       });
 36 |     });
 37 | 
 38 |     it('parse icon attributes', () => {
 39 |       const icon = parsedCreatives[0].icons[0];
 40 |       expect(icon.program).toEqual('ad1');
 41 |       expect(icon.height).toEqual(20);
 42 |       expect(icon.width).toEqual(60);
 43 |       expect(icon.xPosition).toEqual('left');
 44 |       expect(icon.yPosition).toEqual('bottom');
 45 |       expect(icon.apiFramework).toEqual('VPAID');
 46 |       expect(icon.offset).toEqual(15);
 47 |       expect(icon.duration).toEqual(90);
 48 |       expect(icon.altText).toEqual("AltText");
 49 |       expect(icon.hoverText).toEqual("HoverText");
 50 |       expect(icon.type).toEqual('image/gif');
 51 |       expect(icon.staticResource).toEqual('http://example.com/linear-icon.gif');
 52 |       expect(icon.htmlResource).toBeNull();
 53 |       expect(icon.iframeResource).toBeNull();
 54 |       expect(icon.pxratio).toEqual('2');
 55 |       expect(icon.iconClickThroughURLTemplate).toEqual(
 56 |         'http://example.com/linear-clickthrough'
 57 |       );
 58 |       expect(icon.iconClickTrackingURLTemplates).toHaveLength(2);
 59 |       expect(icon.iconClickTrackingURLTemplates).toEqual([
 60 |         {
 61 |           id: 'icon-click-1',
 62 |           url: 'http://example.com/linear-clicktracking1',
 63 |         },
 64 |         {
 65 |           id: 'icon-click-2',
 66 |           url: 'http://example.com/linear-clicktracking2',
 67 |         },
 68 |       ]);
 69 |       expect(icon.iconViewTrackingURLTemplate).toEqual(
 70 |         'http://example.com/linear-viewtracking'
 71 |       );
 72 |       expect(icon.iconClickFallbackImages).toEqual([
 73 |         {
 74 |           url: 'http://adserver.com/fallback.png',
 75 |           width: '10px',
 76 |           height: '10px',
 77 |         },
 78 |         {
 79 |           url: null,
 80 |           width: '10px',
 81 |           height: '10px',
 82 |         },
 83 |         {
 84 |           url: 'http://adserver.com/fallback.png',
 85 |           width: null,
 86 |           height: '10px',
 87 |         },
 88 |         {
 89 |           url: 'http://adserver.com/fallback.png',
 90 |           width: '10px',
 91 |           height: null,
 92 |         },
 93 |       ]);
 94 |     });
 95 | 
 96 |     it('validate second parsedCreative', () => {
 97 |       const creative = parsedCreatives[1];
 98 |       expect(creative.id).toEqual('id130985');
 99 |       expect(creative.adId).toEqual('adId345691');
100 |       expect(creative.universalAdIds).toEqual([]);
101 |       expect(creative.type).toEqual('companion');
102 |       expect(creative.variations.length).toEqual(3);
103 |     });
104 | 
105 |     describe('validate third parsedCreative', function () {
106 |       it('validate NonLinearAds', () => {
107 |         const creative = parsedCreatives[2];
108 |         expect(creative.id).toEqual('id130986');
109 |         expect(creative.adId).toBeNull();
110 |         expect(creative.sequence).toBeNull();
111 |         expect(creative.universalAdIds[0].idRegistry).toEqual(
112 |           'daily-motion-NL'
113 |         );
114 |         expect(creative.universalAdIds[0].value).toEqual('NonLinear-12345');
115 |         expect(creative.type).toEqual('nonlinear');
116 |         expect(creative.variations.length).toEqual(1);
117 |       });
118 | 
119 |       describe('validate NonLinear', function () {
120 |         it('validate variation attributes', () => {
121 |           const variation = parsedCreatives[2].variations[0];
122 |           expect(variation.id).toEqual('nonlinear1');
123 |           expect(variation.width).toEqual('300');
124 |           expect(variation.height).toEqual('200');
125 |           expect(variation.expandedWidth).toEqual('600');
126 |           expect(variation.expandedHeight).toEqual('400');
127 |           expect(variation.scalable).toEqual(false);
128 |           expect(variation.maintainAspectRatio).toEqual(true);
129 |           expect(variation.minSuggestedDuration).toEqual(100);
130 |           expect(variation.apiFramework).toEqual('someAPI');
131 |           expect(variation.adType).toEqual('nonLinearAd');
132 |           expect(variation.type).toEqual('image/jpeg');
133 |           expect(variation.staticResource).toEqual(
134 |             'http://example.com/nonlinear-static-resource'
135 |           );
136 |           expect(variation.htmlResource).toBeNull();
137 |           expect(variation.iframeResource).toBeNull();
138 |           expect(variation.nonlinearClickThroughURLTemplate).toEqual(
139 |             'http://example.com/nonlinear-clickthrough'
140 |           );
141 |           expect(variation.nonlinearClickTrackingURLTemplates).toHaveLength(2);
142 |           expect(variation.nonlinearClickTrackingURLTemplates).toContainEqual(
143 |             {
144 |               id: 'nonlinear-click-1',
145 |               url: 'http://example.com/nonlinear-clicktracking-1',
146 |             },
147 |             { id: null, url: 'http://example.com/nonlinear-clicktracking-2' }
148 |           );
149 |           expect(variation.adParameters).toEqual({
150 |             value: '{"key":"value"}',
151 |             xmlEncoded: 'false',
152 |           });
153 |         });
154 |       });
155 | 
156 |       describe('validate tracking Events', function () {
157 |         let trackingEvents;
158 |         beforeAll(() => {
159 |           trackingEvents = parsedCreatives[2].trackingEvents;
160 |         });
161 |         it('should contain properties', function () {
162 |           expect(trackingEvents).toHaveProperty(
163 |             'start',
164 |             'close',
165 |             'midpoint',
166 |             'complete',
167 |             'firstQuartile',
168 |             'thirdQuartile'
169 |           );
170 |         });
171 |         it('validate properties', () => {
172 |           expect(trackingEvents.start).toHaveLength(1);
173 |           expect(trackingEvents.start).toContain(
174 |             'http://example.com/nonlinear-start'
175 |           );
176 |           expect(trackingEvents.midpoint).toHaveLength(1);
177 |           expect(trackingEvents.midpoint).toContain(
178 |             'http://example.com/nonlinear-midpoint'
179 |           );
180 |           expect(trackingEvents.complete).toHaveLength(1);
181 |           expect(trackingEvents.complete).toContain(
182 |             'http://example.com/nonlinear-complete'
183 |           );
184 |           expect(trackingEvents.firstQuartile).toHaveLength(1);
185 |           expect(trackingEvents.firstQuartile).toContain(
186 |             'http://example.com/nonlinear-firstQuartile'
187 |           );
188 | 
189 |           expect(trackingEvents.close).toHaveLength(1);
190 |           expect(trackingEvents.close).toContain(
191 |             'http://example.com/nonlinear-close'
192 |           );
193 | 
194 |           expect(trackingEvents.thirdQuartile).toHaveLength(1);
195 |           expect(trackingEvents.thirdQuartile).toContain(
196 |             'http://example.com/nonlinear-thirdQuartile'
197 |           );
198 |         });
199 |       });
200 |     });
201 |   });
202 | });
203 | 


--------------------------------------------------------------------------------
/spec/event_emitter.spec.js:
--------------------------------------------------------------------------------
  1 | import { EventEmitter } from '../src/util/event_emitter';
  2 | 
  3 | describe('EventEmitter', function () {
  4 |   let emitter;
  5 |   let response = [];
  6 |   const handler = (...args) => {
  7 |     response.push(args);
  8 |   };
  9 |   const handler2 = () => 2;
 10 | 
 11 |   beforeEach(function () {
 12 |     response = [];
 13 |     emitter = new EventEmitter();
 14 |   });
 15 | 
 16 |   describe('function on', function () {
 17 |     beforeEach(function () {
 18 |       emitter.on('test-event', handler);
 19 |       emitter.on('test-event', handler);
 20 |       emitter.on('test-event', handler2);
 21 |     });
 22 | 
 23 |     it('adds multiple instances', function () {
 24 |       expect(emitter._handlers).toHaveLength(3);
 25 |     });
 26 | 
 27 |     it('adds the given handler to the handlers list', function () {
 28 |       const handlerObj = emitter._handlers[0];
 29 | 
 30 |       expect(handlerObj.event).toBe('test-event');
 31 |       expect(handlerObj.handler).toEqual(handler);
 32 |     });
 33 |   });
 34 | 
 35 |   describe('function once', function () {
 36 |     beforeEach(function () {
 37 |       emitter.once('test-event', handler);
 38 |       emitter.on('*', handler);
 39 |     });
 40 | 
 41 |     it('adds the given handler to the handlers list', function () {
 42 |       expect(emitter._handlers[0].event).toBe('test-event');
 43 |       expect(typeof emitter._handlers[0].handler).toBe('function');
 44 |     });
 45 | 
 46 |     describe('after event is emitted', function () {
 47 |       beforeEach(function () {
 48 |         emitter.emit('test-event', 'data');
 49 |       });
 50 | 
 51 |       it('removes handler from handlers array', function () {
 52 |         expect(emitter._handlers).toHaveLength(1);
 53 |         expect(emitter._handlers[0].event).toBe('*');
 54 |       });
 55 | 
 56 |       it('calls handler function', function () {
 57 |         expect(response[0][0]).toBe('data');
 58 |         expect(response[1][0]).toBe('test-event');
 59 |         expect(response[1][1]).toBe('data');
 60 |       });
 61 |     });
 62 |   });
 63 | 
 64 |   describe('function off', function () {
 65 |     beforeEach(function () {
 66 |       emitter.on('test-event', handler);
 67 |       emitter.on('test-event', handler);
 68 |       emitter.on('test-event', handler2);
 69 |       emitter.off('test-event', handler);
 70 |     });
 71 | 
 72 |     it('removes the given handler from the handlers list', function () {
 73 |       expect(emitter._handlers).toHaveLength(1);
 74 |       expect(emitter._handlers[0].event).toBe('test-event');
 75 |       expect(emitter._handlers[0].handler).toEqual(handler2);
 76 |     });
 77 |   });
 78 | 
 79 |   describe('function emit', function () {
 80 |     beforeEach(function () {
 81 |       emitter.on('test-event', handler);
 82 |       emitter.on('test-event', handler);
 83 |       emitter.on('foo', handler);
 84 |     });
 85 | 
 86 |     describe('handler is called', function () {
 87 |       it('calls correct handlers', function () {
 88 |         emitter.on('*', handler);
 89 |         const called = emitter.emit('test-event', 'data');
 90 |         expect(response).toEqual([['data'], ['data'], ['test-event', 'data']]);
 91 |         expect(called).toBeTruthy();
 92 |       });
 93 |     });
 94 | 
 95 |     describe('handler is not called', function () {
 96 |       it('calls correct handlers', function () {
 97 |         const called = emitter.emit('bar', 'data');
 98 |         expect(response).toEqual([]);
 99 |         expect(called).toBeFalsy();
100 |       });
101 |     });
102 |   });
103 | 
104 |   describe('function removeAllListeners', function () {
105 |     beforeEach(function () {
106 |       emitter.on('foo', handler);
107 |       emitter.on('bar', handler);
108 |       emitter.on('bar', handler2);
109 |     });
110 | 
111 |     describe('with event arg', function () {
112 |       it('removes all instances of the event in handlers array', function () {
113 |         emitter.removeAllListeners('bar');
114 |         expect(emitter._handlers).toHaveLength(1);
115 |         expect(emitter._handlers[0].event).toBe('foo');
116 |         expect(emitter._handlers[0].handler).toEqual(handler);
117 |       });
118 |     });
119 | 
120 |     describe('with no event arg', function () {
121 |       it('removes all instances of the event in handlers array', function () {
122 |         emitter.removeAllListeners();
123 |         expect(emitter._handlers).toHaveLength(0);
124 |       });
125 |     });
126 |   });
127 | 
128 |   describe('function listenerCount', function () {
129 |     beforeEach(function () {
130 |       emitter.on('foo', handler);
131 |       emitter.on('bar', handler);
132 |       emitter.on('bar', handler2);
133 |     });
134 | 
135 |     it('counts all the listeners', function () {
136 |       expect(emitter.listenerCount('bar')).toBe(2);
137 |     });
138 |   });
139 | 
140 |   describe('function listeners', function () {
141 |     beforeEach(function () {
142 |       emitter.on('foo', handler);
143 |       emitter.on('bar', handler);
144 |       emitter.on('bar', handler2);
145 |     });
146 | 
147 |     it('returns all the listeners from the named event', function () {
148 |       const res = emitter.listeners('bar');
149 |       expect(res).toHaveLength(2);
150 |       expect(res[0]).toEqual(handler);
151 |       expect(res[1]).toEqual(handler2);
152 |     });
153 |   });
154 | 
155 |   describe('function eventNames', function () {
156 |     beforeEach(function () {
157 |       emitter.on('foo', handler);
158 |       emitter.on('bar', handler);
159 |       emitter.on('bar', handler2);
160 |     });
161 | 
162 |     it('returns all event names from registered handlers', function () {
163 |       const res = emitter.eventNames();
164 |       expect(res).toHaveLength(3);
165 |       expect(res[0]).toBe('foo');
166 |       expect(res[1]).toBe('bar');
167 |       expect(res[2]).toBe('bar');
168 |     });
169 |   });
170 | });
171 | 


--------------------------------------------------------------------------------
/spec/extensions_parser.spec.js:
--------------------------------------------------------------------------------
  1 | import { parseExtensions } from '../src/parser/extensions_parser';
  2 | import { parserUtils } from '../src/parser/parser_utils';
  3 | import { getNodesFromXml } from './utils/utils';
  4 | import { adExtensions, creativeExtensions } from './samples/extensions';
  5 | 
  6 | describe('ExtensionsParser', function () {
  7 |   describe('AdExtensions', function () {
  8 |     let parsedAdExts;
  9 | 
 10 |     beforeAll(() => {
 11 |       const extensionNodes = parserUtils.childrenByName(
 12 |         getNodesFromXml(adExtensions),
 13 |         'Extension'
 14 |       );
 15 |       parsedAdExts = parseExtensions(extensionNodes);
 16 |     });
 17 | 
 18 |     it('validate WrapperExtension', () => {
 19 |       const ext = parsedAdExts[0];
 20 |       expect(ext.attributes['type']).toEqual('WrapperExtension');
 21 |       expect(ext.children.length).toEqual(1);
 22 |       expect(ext.children[0].name).toEqual('extension_tag');
 23 |       expect(ext.children[0].value).toEqual('extension_value');
 24 |     });
 25 | 
 26 |     it('validate Count extension', () => {
 27 |       const ext = parsedAdExts[1];
 28 |       expect(ext.attributes['type']).toEqual('Count');
 29 |       expect(ext.children.length).toEqual(0);
 30 |       expect(ext.name).toEqual('Extension');
 31 |       expect(ext.value).toEqual('4');
 32 |     });
 33 | 
 34 |     it('validate simple JSON on cdata extension', () => {
 35 |       const ext = parsedAdExts[2];
 36 |       expect(ext.attributes).toEqual({});
 37 |       expect(ext.children.length).toEqual(0);
 38 |       expect(ext.name).toEqual('Extension');
 39 |       expect(ext.value).toEqual('{ foo: bar }');
 40 |     });
 41 | 
 42 |     it('validate Pricing extension', () => {
 43 |       const ext = parsedAdExts[3];
 44 |       expect(ext.attributes['type']).toEqual('Pricing');
 45 |       expect(ext.children.length).toEqual(2);
 46 |       const prices = ext.children[0];
 47 |       expect(prices.name).toEqual('Prices');
 48 |       expect(prices.children.length).toEqual(4);
 49 |       expect(prices.children[0].name).toEqual('Price');
 50 |       expect(prices.children[0].attributes['model']).toEqual('CPM');
 51 |       expect(prices.children[1].attributes['source']).toEqual('someone_else');
 52 |       expect(prices.children[2].attributes['model']).toEqual('CPL');
 53 |       expect(prices.children[3].attributes['currency']).toEqual('USD');
 54 |       expect(prices.children[0].value).toEqual('0');
 55 |       expect(prices.children[1].value).toEqual('42');
 56 |       expect(prices.children[2].value).toEqual('69');
 57 |       expect(prices.children[3].value).toEqual('234.5');
 58 |       expect(ext.children[1].name).toEqual('PricingPolicy');
 59 |       expect(ext.children[1].value).toEqual(
 60 |         'http://example.com/pricing-policy.html'
 61 |       );
 62 |     });
 63 | 
 64 |     it('validate an overly nested extension', () => {
 65 |       const ext = parsedAdExts[4];
 66 |       expect(ext.attributes['type']).toEqual('OverlyNestedExtension');
 67 |       expect(ext.children.length).toEqual(1);
 68 |       const greatFather = ext.children[0];
 69 |       expect(greatFather.name).toEqual('GreatFather');
 70 |       expect(greatFather.attributes['age']).toEqual('70');
 71 |       expect(greatFather.children.length).toEqual(1);
 72 |       const father = greatFather.children[0];
 73 |       expect(father.name).toEqual('Father');
 74 |       expect(father.attributes['age']).toEqual('40');
 75 |       expect(father.attributes['alive']).toEqual('false');
 76 |       expect(father.children.length).toEqual(3);
 77 |       expect(father.children[0].name).toEqual('Daughter');
 78 |       expect(father.children[0].attributes['age']).toEqual('20');
 79 |       expect(father.children[0].value).toEqual('Maria');
 80 |       expect(father.children[1].name).toEqual('Daughter');
 81 |       expect(father.children[1].attributes['age']).toEqual('20');
 82 |       expect(father.children[1].value).toEqual('Lola');
 83 |       expect(father.children[2].name).toEqual('Son');
 84 |       expect(father.children[2].attributes['age']).toEqual('25');
 85 |       expect(father.children[2].value).toEqual('Paul');
 86 |     });
 87 |   });
 88 | 
 89 |   describe('CreativeExtensions', function () {
 90 |     let parsedCreativeExts;
 91 | 
 92 |     beforeAll(() => {
 93 |       const creativeExtensionNodes = parserUtils.childrenByName(
 94 |         getNodesFromXml(creativeExtensions),
 95 |         'CreativeExtension'
 96 |       );
 97 |       parsedCreativeExts = parseExtensions(creativeExtensionNodes);
 98 |     });
 99 | 
100 |     it('validate creativeExtension has length 4', () => {
101 |       expect(parsedCreativeExts.length).toEqual(4);
102 |     });
103 | 
104 |     it('validate Count extension', () => {
105 |       const ext = parsedCreativeExts[0];
106 |       expect(ext.attributes['type']).toEqual('Count');
107 |       expect(ext.children.length).toEqual(0);
108 |       expect(ext.name).toEqual('CreativeExtension');
109 |       expect(ext.value).toEqual('4');
110 |     });
111 | 
112 |     it('validate simple JSON in cdata extension', () => {
113 |       const ext = parsedCreativeExts[1];
114 |       expect(ext.attributes).toEqual({});
115 |       expect(ext.children.length).toEqual(0);
116 |       expect(ext.name).toEqual('CreativeExtension');
117 |       expect(ext.value).toEqual('{ foo: bar }');
118 |     });
119 |   });
120 | });
121 | 


--------------------------------------------------------------------------------
/spec/fetcher.spec.js:
--------------------------------------------------------------------------------
  1 | import { Fetcher } from '../src/fetcher/fetcher';
  2 | import { VASTParser } from '../src/parser/vast_parser';
  3 | import * as Bitrate from '../src/parser/bitrate';
  4 | import { urlHandler } from '../src/fetcher/url_handler';
  5 | import { expect } from '@jest/globals';
  6 | import { getNodesFromXml } from './utils/utils';
  7 | 
  8 | describe('Fetcher', () => {
  9 |   let fetcher, mockEmit;
 10 |   const xml = getNodesFromXml('<VAST></VAST>');
 11 |   const urlHandlerSuccess = {
 12 |     get: (url, option) =>
 13 |       new Promise((resolve, _) =>
 14 |         resolve({ xml, details: { byteLength: 1234, statusCode: 200 } })
 15 |       ),
 16 |   };
 17 | 
 18 |   const urlHandlerFailure = {
 19 |     get: (url, option) =>
 20 |       new Promise((_, reject) =>
 21 |         reject({ error: new Error('AbortError'), statusCode: 408 })
 22 |       ),
 23 |   };
 24 | 
 25 |   beforeEach(() => {
 26 |     fetcher = new Fetcher();
 27 |     mockEmit = jest.fn();
 28 |   });
 29 | 
 30 |   describe('fetchVAST', () => {
 31 |     const url = 'www.foo.foo';
 32 | 
 33 |     describe('on resolved', () => {
 34 |       beforeEach(() => {
 35 |         fetcher.setOptions({
 36 |           wrapperLimit: 8,
 37 |           urlHandler: urlHandlerSuccess,
 38 |         });
 39 |       });
 40 | 
 41 |       it('should applies url filters', () => {
 42 |         fetcher.URLTemplateFilters = [(url) => url.replace('foo', 'bar')];
 43 |         let urlHandlerSpy = jest.spyOn(fetcher.urlHandler, 'get');
 44 |         const expectedUrl = 'www.bar.foo';
 45 | 
 46 |         fetcher
 47 |           .fetchVAST({ url: url, maxWrapperDepth: 5, emitter: () => {} })
 48 |           .then(() => {
 49 |             expect(urlHandlerSpy).toHaveBeenCalledWith(
 50 |               expectedUrl,
 51 |               expect.any(Object)
 52 |             );
 53 |           });
 54 |       });
 55 | 
 56 |       it('should emits VAST-resolving and VAST-resolved events with a filtered url', () => {
 57 |         fetcher.URLTemplateFilters = [(url) => url.replace('foo', 'bar')];
 58 |         const expectedUrl = 'www.bar.foo';
 59 |         fetcher
 60 |           .fetchVAST({
 61 |             url: url,
 62 |             maxWrapperDepth: 4,
 63 |             emitter: mockEmit,
 64 |           })
 65 |           .then(() => {
 66 |             expect(mockEmit).toHaveBeenNthCalledWith(1, 'VAST-resolving', {
 67 |               url: expectedUrl,
 68 |               previousUrl: null,
 69 |               wrapperDepth: 0,
 70 |               maxWrapperDepth: 4,
 71 |               timeout: 120000,
 72 |               wrapperAd: null,
 73 |             });
 74 | 
 75 |             expect(mockEmit).toHaveBeenNthCalledWith(2, 'VAST-resolved', {
 76 |               url: expectedUrl,
 77 |               byteLength: 1234,
 78 |               duration: expect.any(Number),
 79 |               error: null,
 80 |               statusCode: 200,
 81 |               previousUrl: null,
 82 |               wrapperDepth: 0,
 83 |             });
 84 |           });
 85 |       });
 86 | 
 87 |       it('should updates the estimated bitrate', () => {
 88 |         jest.spyOn(Bitrate, 'updateEstimatedBitrate');
 89 |         fetcher
 90 |           .fetchVAST({ url: url, maxWrapperDepth: 5, emitter: () => {} })
 91 |           .then(() => {
 92 |             expect(Bitrate.updateEstimatedBitrate).toHaveBeenCalledWith(
 93 |               1234,
 94 |               expect.any(Number)
 95 |             );
 96 |           });
 97 |       });
 98 | 
 99 |       it('should resolves with xml', () => {
100 |         let result = fetcher.fetchVAST({
101 |           url: url,
102 |           maxWrapperDepth: 5,
103 |           emitter: () => {},
104 |         });
105 |         return expect(result).resolves.toEqual(xml);
106 |       });
107 |     });
108 | 
109 |     describe('on rejected', () => {
110 |       beforeEach(() => {
111 |         fetcher.setOptions({
112 |           wrapperLimit: 5,
113 |           urlHandler: urlHandlerFailure,
114 |         });
115 |       });
116 | 
117 |       it('should applies url filters', () => {
118 |         fetcher.URLTemplateFilters = [(url) => url.replace('foo', 'bar')];
119 |         let urlHandlerSpy = jest.spyOn(fetcher.urlHandler, 'get');
120 |         const expectedUrl = 'www.bar.foo';
121 | 
122 |         fetcher
123 |           .fetchVAST({ url: url, maxWrapperDepth: 5, emitter: () => {} })
124 |           .catch(() => {
125 |             expect(urlHandlerSpy).toHaveBeenCalledWith(
126 |               expectedUrl,
127 |               expect.anything()
128 |             );
129 |           });
130 |       });
131 | 
132 |       it('should emits VAST-resolving and VAST-resolved events with a filtered url', () => {
133 |         fetcher.setOptions({});
134 | 
135 |         // We need to mock global.fetch since jest does not handle it.
136 |         global.fetch = jest.fn().mockResolvedValue({
137 |           ok: false,
138 |           status: 500,
139 |           statusText: 'internal server error',
140 |         });
141 | 
142 |         fetcher.URLTemplateFilters = [(url) => url.replace('foo', 'bar')];
143 |         const expectedUrl = 'www.bar.foo';
144 | 
145 |         fetcher
146 |           .fetchVAST({
147 |             url: url,
148 |             maxWrapperDepth: 4,
149 |             emitter: mockEmit,
150 |           })
151 |           .catch(() => {
152 |             expect(mockEmit).toHaveBeenNthCalledWith(1, 'VAST-resolving', {
153 |               url: expectedUrl,
154 |               previousUrl: null,
155 |               wrapperDepth: 0,
156 |               maxWrapperDepth: 4,
157 |               timeout: 120000,
158 |               wrapperAd: null,
159 |             });
160 | 
161 |             expect(mockEmit).toHaveBeenNthCalledWith(2, 'VAST-resolved', {
162 |               url: expectedUrl,
163 |               duration: expect.any(Number),
164 |               error: expect.any(Error),
165 |               statusCode: 500,
166 |               previousUrl: null,
167 |               wrapperDepth: 0,
168 |             });
169 |           });
170 |       });
171 | 
172 |       it('should rejects with error', () => {
173 |         let result = fetcher.fetchVAST({
174 |           url: url,
175 |           maxWrapperDepth: 5,
176 |           emitter: () => {},
177 |         });
178 |         return expect(result).rejects.toEqual({
179 |           error: new Error('AbortError'),
180 |           statusCode: 408,
181 |         });
182 |       });
183 |     });
184 |   });
185 | 
186 |   describe('setOptions', () => {
187 |     it('should assign options to properties', () => {
188 |       const customUrlHandler = jest.fn();
189 |       fetcher.setOptions({
190 |         urlHandler: customUrlHandler,
191 |         timeout: 50000,
192 |         withCredentials: true,
193 |       });
194 |       expect(fetcher.urlHandler).toEqual(customUrlHandler);
195 |       expect(fetcher.fetchingOptions.timeout).toEqual(50000);
196 |       expect(fetcher.fetchingOptions.withCredentials).toEqual(true);
197 |     });
198 | 
199 |     it('should assign default option when no options are given', () => {
200 |       fetcher.setOptions();
201 |       expect(fetcher.urlHandler).toEqual(urlHandler);
202 |       expect(fetcher.fetchingOptions.timeout).toEqual(120000);
203 |       expect(fetcher.fetchingOptions.withCredentials).toEqual(false);
204 |     });
205 |   });
206 | 
207 |   describe('URLtemplatefilter modifications', () => {
208 |     let filter = jest.fn();
209 |     beforeEach(() => {
210 |       fetcher.URLTemplateFilters = [filter];
211 |     });
212 |     describe('addURLTemplateFilter', () => {
213 |       it('add given urlTemplateFilters to the fetcher instance', () => {
214 |         const myFilter = jest.fn();
215 |         const anotherFilter = jest.fn();
216 |         fetcher.addURLTemplateFilter(myFilter);
217 |         fetcher.addURLTemplateFilter(anotherFilter);
218 |         expect(fetcher.URLTemplateFilters).toEqual([
219 |           filter,
220 |           myFilter,
221 |           anotherFilter,
222 |         ]);
223 |       });
224 |       it('does not add given urlTemplateFilters when wrong type', () => {
225 |         fetcher.addURLTemplateFilter(1);
226 |         fetcher.addURLTemplateFilter('2');
227 |         fetcher.addURLTemplateFilter(true);
228 |         fetcher.addURLTemplateFilter();
229 |         expect(fetcher.URLTemplateFilters.length).toBe(1);
230 |       });
231 |     });
232 |     describe('clearURLTemplateFilters', () => {
233 |       it('should clear URLTemplateFilters array', () => {
234 |         fetcher.clearURLTemplateFilters();
235 |         expect(fetcher.URLTemplateFilters).toEqual([]);
236 |       });
237 |     });
238 | 
239 |     describe('countURLTemplateFilters', () => {
240 |       it('should return the length of URLTemplateFilters array', () => {
241 |         let result = fetcher.countURLTemplateFilters();
242 |         expect(result).toBe(1);
243 |       });
244 |     });
245 | 
246 |     describe('removeLastUrlTemplateFilter', () => {
247 |       it('remove the last element of the URLTemplateFilters array', () => {
248 |         fetcher.removeLastURLTemplateFilter();
249 |         expect(fetcher.URLTemplateFilters.length).toBe(0);
250 |       });
251 |     });
252 |   });
253 | });
254 | 


--------------------------------------------------------------------------------
/spec/samples/ad_verification_extension_and_node.js:
--------------------------------------------------------------------------------
 1 | export const adVerificationsInDedicatedNodeAndInExtensionsNode = `
 2 | <Ad id="20001" sequence="1" conditionalAd="false">
 3 |    <InLine>
 4 |       <Extensions>
 5 |          <Extension type="iab">
 6 |             <AdVerifications>
 7 |                <Verification>
 8 |                   <JavaScriptResource><![CDATA[https://verificationcompany.com/extentionAdVerification1.js]]></JavaScriptResource>
 9 |                </Verification>
10 |                <Verification>
11 |                   <JavaScriptResource><![CDATA[https://verificationcompany.com/extentionAdVerification2.js]]></JavaScriptResource>
12 |                </Verification>
13 |             </AdVerifications>
14 |          </Extension>
15 |       </Extensions>
16 |       <AdSystem version="4.0">iabtechlab</AdSystem>
17 |       <AdTitle>Inline Simple Ad</AdTitle>
18 |       <AdVerifications>
19 |          <Verification>
20 |             <JavaScriptResource><![CDATA[https://verificationcompany.com/dedicatedNodeAdVerification1.js]]></JavaScriptResource>
21 |          </Verification>
22 |          <Verification>
23 |             <JavaScriptResource><![CDATA[https://verificationcompany.com/dedicatedNodeAdVerification2.js]]></JavaScriptResource>
24 |          </Verification>
25 |       </AdVerifications>
26 |       <Advertiser>IAB Sample Company</Advertiser>
27 |       <Category authority="http://www.iabtechlab.com/categoryauthority">AD CONTENT description category</Category>
28 |       <Creatives>
29 |          <Creative id="5480" sequence="1" adId="2447226">
30 |             <UniversalAdId idRegistry="Ad-ID" idValue="8465">8465</UniversalAdId>
31 |             <Linear>
32 |                <Duration>00:00:16</Duration>
33 |                <MediaFiles>
34 |                   <MediaFile id="5241" delivery="progressive" type="video/mp4" bitrate="2000" width="1280" height="720" minBitrate="1500" maxBitrate="2500" scalable="1" maintainAspectRatio="1" codec="H.264"><![CDATA[https://iab-publicfiles.s3.amazonaws.com/vast/VAST-4.0-Short-Intro.mp4]]></MediaFile>
35 |                   <MediaFile id="5244" delivery="progressive" type="video/mp4" bitrate="1000" width="854" height="480" minBitrate="700" maxBitrate="1500" scalable="1" maintainAspectRatio="1" codec="H.264"><![CDATA[https://iab-publicfiles.s3.amazonaws.com/vast/VAST-4.0-Short-Intro-mid-resolution.mp4]]></MediaFile>
36 |                   <MediaFile id="5246" delivery="progressive" type="video/mp4" bitrate="600" width="640" height="360" minBitrate="500" maxBitrate="700" scalable="1" maintainAspectRatio="1" codec="H.264"><![CDATA[https://iab-publicfiles.s3.amazonaws.com/vast/VAST-4.0-Short-Intro-low-resolution.mp4]]></MediaFile>
37 |                </MediaFiles>
38 |             </Linear>
39 |          </Creative>
40 |       </Creatives>
41 |    </InLine>
42 | </Ad>
43 | `;
44 | 


--------------------------------------------------------------------------------
/spec/samples/ad_verification_extentions.js:
--------------------------------------------------------------------------------
 1 | export const adVerificationExtensions = `<Ad id="ad_id_0001" sequence="1" adType="video">
 2 |   <InLine>
 3 |     <AdSystem version="2.0" ><![CDATA[AdServer]]></AdSystem>
 4 |     <AdTitle><![CDATA[Ad title]]></AdTitle>
 5 |     <Description><![CDATA[Description text]]></Description>
 6 |     <Error><![CDATA[http://example.com/error_[ERRORCODE]]]></Error>
 7 |     <Impression id="sample-impression1"><![CDATA[http://example.com/impression1_asset:[ASSETURI]_[CACHEBUSTING]]]></Impression>
 8 |     <Creatives>
 9 |       <Creative id="id130984" adId="adId345690" sequence="1" >
10 |         <Linear>
11 |           <Duration>00:01:30.123</Duration>
12 |           <MediaFiles>
13 |             <MediaFile delivery="progressive" type="video/mp4" bitrate="849" width="512" height="288" scalable="true" fileSize="345670"><![CDATA[http://example.com/linear-asset.mp4]]></MediaFile>
14 |           </MediaFiles>
15 |         </Linear>
16 |       </Creative>
17 |     </Creatives>
18 |     <Extensions>
19 |       <Extension type="Pricing">
20 |         <Price model="CPM" currency="USD" source="someone">
21 |           <![CDATA[ 0 ]]>
22 |         </Price>
23 |       </Extension>
24 |       <Extension type="Count">
25 |         <!-- -->
26 |         <![CDATA[ 4 ]]>
27 |       </Extension>
28 |       <Extension>
29 |           { foo: bar }
30 |       </Extension>
31 |       <Extension type="AdVerifications">
32 |         <AdVerifications>
33 |           <Verification vendor="abc.com-omid">
34 |             <JavaScriptResource apiFramework="omid" browserOptional="true">
35 |               <![CDATA[https://abc.com/omid.js]]>
36 |             </JavaScriptResource>
37 |             <VerificationParameters><![CDATA[...]]></VerificationParameters>
38 |             <TrackingEvents>
39 |               <Tracking event="verificationNotExecuted">
40 |                 <![CDATA[https://abc.com/omid_reject?r=[REASON]]]>
41 |               </Tracking>
42 |             </TrackingEvents>
43 |           </Verification>
44 |           <Verification vendor="xyz.com-omidpub">
45 |             <JavaScriptResource apiFramework="omid" browserOptional="true">
46 |               <![CDATA[https://xyz.com/omid-verify.js]]>
47 |             </JavaScriptResource>
48 |             <VerificationParameters><![CDATA[...]]></VerificationParameters>
49 |           </Verification>
50 |         </AdVerifications>
51 |       </Extension>
52 |     </Extensions>
53 |   </InLine>
54 | </Ad>`;
55 | 


--------------------------------------------------------------------------------
/spec/samples/companion_ads.js:
--------------------------------------------------------------------------------
 1 | export const companionAds = `<CompanionAds required="any">
 2 |   <Companion id="1" width="300" height="250" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250" apiFramework="VPAID" adSlotId="1" pxratio="2" renderingMode="end-card">
 3 |     <StaticResource creativeType="image/jpeg"><![CDATA[http://example.com/companion1-static-resource1]]></StaticResource>
 4 |     <StaticResource creativeType="image/jpeg"><![CDATA[http://example.com/companion1-static-resource2]]></StaticResource>
 5 |     <AltText><![CDATA[Sample Alt Text Content]]></AltText>
 6 |     <TrackingEvents>
 7 |       <Tracking event="creativeView"><![CDATA[http://example.com/companion1-creativeview]]></Tracking>
 8 |     </TrackingEvents>
 9 |     <AdParameters xmlEncoded="false"><![CDATA[campaign_id=1]]></AdParameters>
10 |     <CompanionClickThrough><![CDATA[http://example.com/companion1-clickthrough]]></CompanionClickThrough>
11 |     <CompanionClickTracking id="1"><![CDATA[http://example.com/companion1-clicktracking-first]]></CompanionClickTracking>
12 |     <CompanionClickTracking id="2"><![CDATA[http://example.com/companion1-clicktracking-second]]></CompanionClickTracking>
13 |   </Companion>
14 |   <Companion id="2" width="300" height="60" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250" apiFramework="VPAID" adSlotId="2" renderingMode="concurrent">
15 |     <IFrameResource><![CDATA[http://www.example.com/companion2-example.php]]></IFrameResource>
16 |     <AltText><![CDATA[Sample Alt Text Content]]></AltText>
17 |     <TrackingEvents>
18 |       <Tracking event="creativeView"><![CDATA[http://example.com/companion2-creativeview]]></Tracking>
19 |     </TrackingEvents>
20 |     <AdParameters><![CDATA[campaign_id=2]]></AdParameters>
21 |     <CompanionClickThrough><![CDATA[http://www.example.com/companion2-clickthrough]]></CompanionClickThrough>
22 |   </Companion>
23 |   <Companion id="3" width="300" height="60" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250" apiFramework="VPAID" adSlotId="3">
24 |     <HTMLResource>
25 |       <![CDATA[
26 |         <a href="http://www.example.com" target="_blank">Some call to action HTML!</a>
27 |       ]]>
28 |     </HTMLResource>
29 |     <AltText><![CDATA[Sample Alt Text Content]]></AltText>
30 |     <TrackingEvents>
31 |       <Tracking event="creativeView"><![CDATA[http://example.com/companion3-creativeview]]></Tracking>
32 |     </TrackingEvents>
33 |     <AdParameters><![CDATA[campaign_id=3]]></AdParameters>
34 |     <CompanionClickThrough><![CDATA[http://www.example.com/companion3-clickthrough]]></CompanionClickThrough>
35 |   </Companion>
36 | </CompanionAds>`;
37 | 


--------------------------------------------------------------------------------
/spec/samples/creatives.js:
--------------------------------------------------------------------------------
  1 | export const creatives = `<Creatives>
  2 |   <Creative id="id130984" adId="adId345690" sequence="1" >
  3 |     <UniversalAdId idRegistry="daily-motion-L1">Linear-12345</UniversalAdId>
  4 |     <UniversalAdId idRegistry="daily-motion-L2">Linear-5678</UniversalAdId>
  5 |     <CreativeExtensions>
  6 |       <CreativeExtension type="creativeExt1">
  7 |         <CreativeExecution model="CPM" currency="USD" source="someone">
  8 |           <![CDATA[ 10.0 ]]>
  9 |         </CreativeExecution>
 10 |       </CreativeExtension>
 11 |       <CreativeExtension type="Count">
 12 |         <![CDATA[ 10 ]]>
 13 |       </CreativeExtension>
 14 |       <CreativeExtension>
 15 |           { key: value }
 16 |       </CreativeExtension>
 17 |     </CreativeExtensions>
 18 |     <Linear>
 19 |       <Duration>00:01:30.123</Duration>
 20 |       <AdParameters xmlEncoded="false">
 21 |           <![CDATA[{"key":"value"}]]>
 22 |       </AdParameters>
 23 |       <TrackingEvents>
 24 |         <Tracking event="midpoint"><![CDATA[http://example.com/linear-midpoint]]></Tracking>
 25 |         <Tracking event="complete"><![CDATA[http://example.com/linear-complete]]></Tracking>
 26 |         <Tracking event="start"><![CDATA[http://example.com/linear-start]]></Tracking>
 27 |         <Tracking event="firstQuartile"><![CDATA[http://example.com/linear-firstQuartile]]></Tracking>
 28 |         <Tracking event="close"><![CDATA[http://example.com/linear-close]]></Tracking>
 29 |         <Tracking event="thirdQuartile"><![CDATA[http://example.com/linear-thirdQuartile]]></Tracking>
 30 |         <Tracking event="progress" offset="00:00:30.000"><![CDATA[http://example.com/linear-progress-30sec]]></Tracking>
 31 |         <Tracking event="progress" offset="60%"><![CDATA[http://example.com/linear-progress-60%]]></Tracking>
 32 |       </TrackingEvents>
 33 |       <VideoClicks>
 34 |         <ClickTracking id='video-click-1'><![CDATA[http://example.com/linear-clicktracking1_ts:[TIMESTAMP]]]></ClickTracking>
 35 |         <ClickTracking id='video-click-2'><![CDATA[http://example.com/linear-clicktracking2]]></ClickTracking>
 36 |         <ClickThrough id='click-through'><![CDATA[http://example.com/linear-clickthrough]]></ClickThrough>
 37 |         <CustomClick id='custom-click-1'><![CDATA[http://example.com/linear-customclick]]></CustomClick>
 38 |       </VideoClicks>
 39 |       <MediaFiles>
 40 |         <MediaFile delivery="progressive" type="video/mp4" bitrate="849" width="512" height="288" scalable="true"><![CDATA[http://example.com/linear-asset.mp4]]></MediaFile>
 41 |         <MediaFile apiFramework="VPAID" type="application/javascript" width="512" height="288" delivery="progressive"><![CDATA[parser.js?adData=http%3A%2F%2Fad.com%2F%3Fcb%3D%5Btime%5D]]></MediaFile>
 42 |         <Mezzanine id="mezzanine-id-165468451" type="video/mp4" width="1080" height="720" delivery="progressive" codec="h264" fileSize="700"><![CDATA[http://example.com/linear-mezzanine.mp4]]></Mezzanine>
 43 |       </MediaFiles>
 44 |       <Icons>
 45 |         <Icon altText="AltText" hoverText="HoverText" program="ad1" width="60" height="20" xPosition="left" yPosition="bottom" duration="00:01:30.000" offset="00:00:15.000" apiFramework="VPAID" pxratio="2">
 46 |           <StaticResource creativeType="image/gif"><![CDATA[http://example.com/linear-icon.gif]]></StaticResource>
 47 |           <IconViewTracking><![CDATA[http://example.com/linear-viewtracking]]></IconViewTracking>
 48 |           <IconClicks>
 49 |             <IconClickThrough><![CDATA[http://example.com/linear-clickthrough]]></IconClickThrough>
 50 |             <IconClickTracking id='icon-click-1'><![CDATA[http://example.com/linear-clicktracking1]]></IconClickTracking>
 51 |             <IconClickTracking id='icon-click-2'><![CDATA[http://example.com/linear-clicktracking2]]></IconClickTracking>
 52 |             <IconClickFallbackImages>
 53 |               <IconClickFallbackImage width="10px" height="10px">
 54 |                 <![CDATA[http://adserver.com/fallback.png]]>
 55 |               </IconClickFallbackImage>
 56 |               <IconClickFallbackImage width="10px" height="10px">
 57 |               </IconClickFallbackImage>
 58 |               <IconClickFallbackImage  height="10px">
 59 |                 <![CDATA[http://adserver.com/fallback.png]]>
 60 |               </IconClickFallbackImage>
 61 |               <IconClickFallbackImage width="10px">
 62 |                 <![CDATA[http://adserver.com/fallback.png]]>
 63 |               </IconClickFallbackImage>
 64 |             </IconClickFallbackImages>
 65 |           </IconClicks>
 66 |         </Icon>
 67 |       </Icons>
 68 |     </Linear>
 69 |   </Creative>
 70 |   <Creative id="id130985" AdID="adId345691" sequence="2" >
 71 |     <CompanionAds>
 72 |       <Companion width="300" height="60">
 73 |         <StaticResource creativeType="image/jpeg"><![CDATA[http://example.com/companion1-static-resource]]></StaticResource>
 74 |         <AltText><![CDATA[Sample Alt Text Content!!!!]]></AltText>
 75 |         <TrackingEvents>
 76 |           <Tracking event="creativeView"><![CDATA[http://example.com/companion1-creativeview]]></Tracking>
 77 |         </TrackingEvents>
 78 |         <CompanionClickThrough><![CDATA[http://example.com/companion1-clickthrough]]></CompanionClickThrough>
 79 |         <CompanionClickTracking id="123"><![CDATA[http://example.com/companion1-clicktracking-first]]></CompanionClickTracking>
 80 |         <CompanionClickTracking><![CDATA[http://example.com/companion1-clicktracking-second]]></CompanionClickTracking>
 81 |       </Companion>
 82 |       <Companion width="300" height="60">
 83 |         <IFrameResource>
 84 |           <![CDATA[http://www.example.com/companion2-example.php]]>
 85 |         </IFrameResource>
 86 |         <CompanionClickThrough>
 87 |           http://www.example.com/companion2-clickthrough
 88 |         </CompanionClickThrough>
 89 |       </Companion>
 90 |       <Companion width="300" height="60">
 91 |         <HTMLResource>
 92 |           <![CDATA[
 93 |           <a href="http://www.example.com" target="_blank">Some call to action HTML!</a>
 94 |           ]]>
 95 |         </HTMLResource>
 96 |         <CompanionClickThrough>
 97 |           http://www.example.com/companion3-clickthrough
 98 |         </CompanionClickThrough>
 99 |       </Companion>
100 |     </CompanionAds>
101 |   </Creative>
102 |   <Creative id="id130986">
103 |     <UniversalAdId idRegistry="daily-motion-NL">NonLinear-12345</UniversalAdId>
104 |     <NonLinearAds>
105 |       <NonLinear id="nonlinear1" width="300" height="200" expandedWidth="600" expandedHeight="400" scalable="false" maintainAspectRatio="true" minSuggestedDuration="00:01:40" apiFramework="someAPI" >
106 |         <StaticResource creativeType="image/jpeg"><![CDATA[http://example.com/nonlinear-static-resource]]></StaticResource>
107 |         <AdParameters xmlEncoded="false">
108 |           <![CDATA[{"key":"value"}]]>
109 |         </AdParameters>
110 |         <NonLinearClickThrough><![CDATA[http://example.com/nonlinear-clickthrough]]></NonLinearClickThrough>
111 |         <NonLinearClickTracking id='nonlinear-click-1'><![CDATA[http://example.com/nonlinear-clicktracking-1]]></NonLinearClickTracking>
112 |         <NonLinearClickTracking><![CDATA[http://example.com/nonlinear-clicktracking-2]]></NonLinearClickTracking>
113 |       </NonLinear>
114 |       <TrackingEvents>
115 |         <Tracking event="midpoint"><![CDATA[http://example.com/nonlinear-midpoint]]></Tracking>
116 |         <Tracking event="complete"><![CDATA[http://example.com/nonlinear-complete]]></Tracking>
117 |         <Tracking event="start"><![CDATA[http://example.com/nonlinear-start]]></Tracking>
118 |         <Tracking event="firstQuartile"><![CDATA[http://example.com/nonlinear-firstQuartile]]></Tracking>
119 |         <Tracking event="close"><![CDATA[http://example.com/nonlinear-close]]></Tracking>
120 |         <Tracking event="thirdQuartile"><![CDATA[http://example.com/nonlinear-thirdQuartile]]></Tracking>
121 |       </TrackingEvents>
122 |     </NonLinearAds>
123 |   </Creative>
124 | </Creatives>`;
125 | 


--------------------------------------------------------------------------------
/spec/samples/empty-no-ad.xml:
--------------------------------------------------------------------------------
1 | <VAST version="4.3">
2 |     <Error>
3 |         <![CDATA[http://example.com/empty-no-ad]]>
4 |     </Error>
5 | </VAST>
6 | 


--------------------------------------------------------------------------------
/spec/samples/empty-no-creative.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <VAST version="4.3">
 3 |     <Ad>
 4 |         <InLine>
 5 |             <AdSystem>No Ad Server</AdSystem>
 6 |             <AdTitle>NO AD</AdTitle>
 7 |             <Error>
 8 |                 <![CDATA[http://example.com/empty-no-creative_inline-error]]>
 9 |             </Error>
10 |             <Creatives>
11 |             </Creatives>
12 |             <Extensions>
13 |                 <Extension>
14 |                     <paramEmptyNoCreative><![CDATA[valueEmptyNoCreative]]></paramEmptyNoCreative>
15 |                 </Extension>
16 |             </Extensions>
17 |         </InLine>
18 |     </Ad>
19 | </VAST>
20 | 


--------------------------------------------------------------------------------
/spec/samples/extensions.js:
--------------------------------------------------------------------------------
 1 | export const adExtensions = `<Extensions>
 2 |   <Extension type="WrapperExtension">
 3 |     <extension_tag>
 4 |       <![CDATA[ extension_value ]]>
 5 |     </extension_tag>
 6 |   </Extension>
 7 |   <Extension type="Count">
 8 |     <!-- -->
 9 |     <![CDATA[ 4 ]]>
10 |   </Extension>
11 |   <Extension>
12 |       { foo: bar }
13 |   </Extension>
14 |   <Extension type="Pricing">
15 |     <Prices>
16 |       <Price model="CPM" currency="USD" source="someone">
17 |         <![CDATA[ 0 ]]>
18 |       </Price>
19 |       <Price model="CPL" currency="EUR" source="someone_else">
20 |         <![CDATA[ 42 ]]>
21 |       </Price>
22 |       <Price model="CPL" currency="EUR" source="someone">
23 |         <![CDATA[ 69 ]]>
24 |       </Price>
25 |       <Price model="CPM" currency="USD" source="someone">
26 |         <![CDATA[ 234.5 ]]>
27 |       </Price>
28 |     </Prices>
29 |     <PricingPolicy>
30 |       <!-- Test of comment -->
31 |       <![CDATA[http://example.com/pricing-policy.html]]>
32 |     </PricingPolicy>
33 |   </Extension>
34 |   <Extension type="OverlyNestedExtension">
35 |     <GreatFather age="70">
36 |         <Father age="40" alive="false">
37 |           <Daughter age="20">Maria</Daughter>
38 |           <Daughter age="20">Lola</Daughter>
39 |           <Son age="25">Paul</Son>
40 |         </Father>
41 |     </GreatFather>
42 |   </Extension>
43 | </Extensions>
44 | `;
45 | 
46 | export const creativeExtensions = `<CreativeExtensions>
47 |   <CreativeExtension type="Count">
48 |     <![CDATA[ 4 ]]>
49 |   </CreativeExtension>
50 |   <CreativeExtension>
51 |       { foo: bar }
52 |   </CreativeExtension>
53 |   <CreativeExtension type="Pricing">
54 |     <Prices>
55 |       <Price model="CPM" currency="USD" source="someone">
56 |         <![CDATA[ 0 ]]>
57 |       </Price>
58 |       <Price model="CPL" currency="EUR" source="someone_else">
59 |         <![CDATA[ 42 ]]>
60 |       </Price>
61 |       <Price model="CPL" currency="EUR" source="someone">
62 |         <![CDATA[ 69 ]]>
63 |       </Price>
64 |       <Price model="CPM" currency="USD" source="someone">
65 |         <![CDATA[ 234.5 ]]>
66 |       </Price>
67 |     </Prices>
68 |     <PricingPolicy>
69 |       <!-- Test of comment -->
70 |       <![CDATA[http://example.com/pricing-policy.html]]>
71 |     </PricingPolicy>
72 |   </CreativeExtension>
73 |   <CreativeExtension type="OverlyNestedExtension">
74 |     <GreatFather age="70">
75 |         <Father age="40" alive="false">
76 |           <Daughter age="20">Maria</Daughter>
77 |           <Daughter age="20">Lola</Daughter>
78 |           <Son age="25">Paul</Son>
79 |         </Father>
80 |     </GreatFather>
81 |   </CreativeExtension>
82 | </CreativeExtensions>
83 | `;
84 | 


--------------------------------------------------------------------------------
/spec/samples/inline-linear.xml:
--------------------------------------------------------------------------------
 1 | <VAST version="4.3"
 2 |     xmlns:xs="http://www.w3.org/2001/XMLSchema">
 3 |     <Ad id="20001">
 4 |         <InLine>
 5 |             <AdSystem version="4.0">iabtechlab</AdSystem>
 6 |             <AdTitle>iabtechlab video ad</AdTitle>
 7 | 
 8 |             <Pricing model="cpm" currency="USD">
 9 |                 <![CDATA[ 25.00 ]]>
10 |             </Pricing>
11 | 
12 |             <Error>http://example.com/error</Error>
13 | 
14 |             <Impression id="Impression-ID">http://example.com/track/impression</Impression>
15 | 
16 |             <Creatives>
17 |                 <Creative id="5480" sequence="1">
18 |                     <Linear>
19 |                         <Duration>00:00:16</Duration>
20 |                         <TrackingEvents>
21 |                             <Tracking event="start" offset="09:15:23">http://example.com/tracking/start</Tracking>
22 |                             <Tracking event="firstQuartile">http://example.com/tracking/firstQuartile</Tracking>
23 |                             <Tracking event="midpoint">http://example.com/tracking/midpoint</Tracking>
24 |                             <Tracking event="thirdQuartile">http://example.com/tracking/thirdQuartile</Tracking>
25 |                             <Tracking event="complete">http://example.com/tracking/complete</Tracking>
26 |                         </TrackingEvents>
27 | 
28 |                         <VideoClicks>
29 |                             <ClickTracking id="blog">
30 |                                 <![CDATA[https://iabtechlab.com]]>
31 |                             </ClickTracking>
32 |                             <CustomClick>http://iabtechlab.com</CustomClick>
33 |                         </VideoClicks>
34 | 
35 |                         <MediaFiles>
36 |                             <MediaFile id="5241" delivery="progressive" type="video/mp4" bitrate="500" width="400" height="300" minBitrate="360" maxBitrate="1080" scalable="1" maintainAspectRatio="1" codec="0">
37 |                                 <![CDATA[https://iabtechlab.com/wp-content/uploads/2016/07/VAST-4.0-Short-Intro.mp4]]>
38 |                             </MediaFile>
39 |                         </MediaFiles>
40 | 
41 | 
42 |                     </Linear>
43 |                 </Creative>
44 |             </Creatives>
45 |             <Extensions>
46 |                 <Extension type="iab-Count">
47 |                     <total_available>
48 |                         <![CDATA[ 2 ]]>
49 |                     </total_available>
50 |                 </Extension>
51 |             </Extensions>
52 |         </InLine>
53 |     </Ad>
54 | </VAST>
55 | 


--------------------------------------------------------------------------------
/spec/samples/invalid-xmlfile.xml:
--------------------------------------------------------------------------------
1 | { vast: null }
2 | 


--------------------------------------------------------------------------------
/spec/samples/linear_ads.js:
--------------------------------------------------------------------------------
  1 | export const linearAd = `<Ad id="ad_id_0001" sequence="1" adType="video">
  2 |   <InLine>
  3 |     <AdSystem version="2.0" ><![CDATA[AdServer]]></AdSystem>
  4 |     <AdTitle><![CDATA[Ad title]]></AdTitle>
  5 |     <AdServingId><![CDATA[Ad_serving_id_12345]]></AdServingId>
  6 |     <Category authority="iabtechlab.com">232</Category>
  7 |     <Category authority="google.com">245</Category>
  8 |     <Expires>4567890</Expires>
  9 |     <Advertiser id='advertiser-desc'><![CDATA[Advertiser name]]></Advertiser>
 10 |     <Description><![CDATA[Description text]]></Description>
 11 |     <Pricing model="CPM" currency="USD" ><![CDATA[1.09]]></Pricing>
 12 |     <Survey type="text/javascript"><![CDATA[http://example.com/survey]]></Survey>
 13 |     <Error><![CDATA[http://example.com/error_[ERRORCODE]]]></Error>
 14 |     <Impression id="sample-impression1"><![CDATA[http://example.com/impression1_asset:[ASSETURI]_[CACHEBUSTING]]]></Impression>
 15 |     <Impression id="sample-impression2"><![CDATA[http://example.com/impression2_[random]]]></Impression>
 16 |     <Impression id="sample-impression3"><![CDATA[http://example.com/impression3_[RANDOM]]]></Impression>
 17 |     <ViewableImpression id="viewable_impression_id">
 18 |       <Viewable>
 19 |         <![CDATA[http://www.example.com/viewable_impression_1]]>
 20 |       </Viewable>
 21 |       <Viewable>
 22 |         <![CDATA[http://www.sample.com/viewable_impression_2]]>
 23 |       </Viewable>
 24 |       <NotViewable>
 25 |         <![CDATA[http://www.example.com/not_viewable_1]]>
 26 |       </NotViewable>
 27 |       <NotViewable>
 28 |         <![CDATA[http://www.sample.com/not_viewable_2]]>
 29 |       </NotViewable>
 30 |       <NotViewable>
 31 |         <![CDATA[http://www.sample.com/not_viewable_3]]>
 32 |       </NotViewable>
 33 |       <ViewUndetermined>
 34 |         <![CDATA[http://www.example.com/view_undetermined_1]]>
 35 |       </ViewUndetermined>
 36 |     </ViewableImpression>
 37 |     <AdVerifications>
 38 |       <Verification vendor="company.com-omid">
 39 |         <JavaScriptResource apiFramework="omid" browserOptional="true">
 40 |           <![CDATA[http://example.com/omid1]]>
 41 |         </JavaScriptResource>
 42 |       </Verification>
 43 |       <Verification vendor="company2.com-omid">
 44 |         <JavaScriptResource apiFramework="omid" browserOptional="false">
 45 |           <![CDATA[http://example.com/omid2]]>
 46 |         </JavaScriptResource>
 47 |         <VerificationParameters>
 48 |           <![CDATA[test-verification-parameter]]>
 49 |         </VerificationParameters>
 50 |         <TrackingEvents>
 51 |           <Tracking event="verificationNotExecuted"><![CDATA[http://example.com/verification-not-executed-JS]]></Tracking>
 52 |         </TrackingEvents>
 53 |       </Verification>
 54 |       <Verification vendor="company.daily.com-omid">
 55 |         <ExecutableResource apiFramework="omid-sdk" type="executable">
 56 |           <![CDATA[http://example.com/omid1.exe]]>
 57 |         </ExecutableResource>
 58 |         <TrackingEvents>
 59 |           <Tracking event="verificationNotExecuted"><![CDATA[http://example.com/verification-not-executed-EXE]]></Tracking>
 60 |           <Tracking event="verificationNotExecuted"><![CDATA[http://sample.com/verification-not-executed-EXE]]></Tracking>
 61 |         </TrackingEvents>
 62 |       </Verification>
 63 |     </AdVerifications>
 64 |     <Creatives>
 65 |       <Creative id="id130984" adId="adId345690" sequence="1" >
 66 |         <UniversalAdId idRegistry="daily-motion-L">Linear-12345</UniversalAdId>
 67 |         <CreativeExtensions>
 68 |           <CreativeExtension type="creativeExt1">
 69 |             <CreativeExecution model="CPM" currency="USD" source="someone">
 70 |               <![CDATA[ 10.0 ]]>
 71 |             </CreativeExecution>
 72 |           </CreativeExtension>
 73 |           <CreativeExtension type="Count">
 74 |             <![CDATA[ 10 ]]>
 75 |           </CreativeExtension>
 76 |           <CreativeExtension>
 77 |               { key: value }
 78 |           </CreativeExtension>
 79 |         </CreativeExtensions>
 80 |         <Linear>
 81 |           <Duration>00:01:30.123</Duration>
 82 |           <TrackingEvents>
 83 |             <Tracking event="midpoint"><![CDATA[http://example.com/linear-midpoint]]></Tracking>
 84 |             <Tracking event="complete"><![CDATA[http://example.com/linear-complete]]></Tracking>
 85 |             <Tracking event="start"><![CDATA[http://example.com/linear-start]]></Tracking>
 86 |             <Tracking event="firstQuartile"><![CDATA[http://example.com/linear-firstQuartile]]></Tracking>
 87 |             <Tracking event="close"><![CDATA[http://example.com/linear-close]]></Tracking>
 88 |             <Tracking event="thirdQuartile"><![CDATA[http://example.com/linear-thirdQuartile]]></Tracking>
 89 |             <Tracking event="progress" offset="00:00:30.000"><![CDATA[http://example.com/linear-progress-30sec]]></Tracking>
 90 |             <Tracking event="progress" offset="60%"><![CDATA[http://example.com/linear-progress-60%]]></Tracking>
 91 |           </TrackingEvents>
 92 |           <VideoClicks>
 93 |             <ClickTracking id='video-click-1'><![CDATA[http://example.com/linear-clicktracking1_ts:[TIMESTAMP]]]></ClickTracking>
 94 |             <ClickTracking id='video-click-2'><![CDATA[http://example.com/linear-clicktracking2]]></ClickTracking>
 95 |             <ClickThrough id='click-through'><![CDATA[http://example.com/linear-clickthrough]]></ClickThrough>
 96 |             <CustomClick id='custom-click-1'><![CDATA[http://example.com/linear-customclick]]></CustomClick>
 97 |           </VideoClicks>
 98 |           <MediaFiles>
 99 |             <MediaFile delivery="progressive" type="video/mp4" bitrate="849" width="512" height="288" scalable="true" fileSize="345670"><![CDATA[http://example.com/linear-asset.mp4]]></MediaFile>
100 |             <MediaFile apiFramework="VPAID" type="application/javascript" width="512" height="288" delivery="progressive" mediaType="3D"><![CDATA[parser.js?adData=http%3A%2F%2Fad.com%2F%3Fcb%3D%5Btime%5D]]></MediaFile>
101 |             <Mezzanine id="mezzanine-id-165468451" type="video/mp4" width="1080" height="720" delivery="progressive" codec="h264" fileSize="700"><![CDATA[http://example.com/linear-mezzanine.mp4]]></Mezzanine>
102 |             <InteractiveCreativeFile type="application/javascript" apiFramework="simpleApp" variableDuration="true"><![CDATA[http://example.com/linear-interactive-creative.js]]></InteractiveCreativeFile>
103 |             <ClosedCaptionFiles>
104 |               <ClosedCaptionFile type="text/srt" language="en">
105 |                 <![CDATA[https://mycdn.example.com/creatives/creative001.srt]]>
106 |               </ClosedCaptionFile>
107 |               <ClosedCaptionFile type="text/srt" language="fr">
108 |                 <![CDATA[https://mycdn.example.com/creatives/creative001-1.srt]]>
109 |               </ClosedCaptionFile>
110 |               <ClosedCaptionFile type="text/vtt" language="zh-TW">
111 |                 <![CDATA[https://mycdn.example.com/creatives/creative001.vtt]]>
112 |               </ClosedCaptionFile>
113 |               <ClosedCaptionFile type="application/ttml+xml" language="zh-CH">
114 |                 <![CDATA[https://mycdn.example.com/creatives/creative001.ttml]]>
115 |               </ClosedCaptionFile>
116 |             </ClosedCaptionFiles>
117 |           </MediaFiles>
118 |           <Icons>
119 |             <Icon program="ad1" width="60" height="20" xPosition="left" yPosition="bottom" duration="00:01:30.000" offset="00:00:15.000" apiFramework="VPAID" pxratio="2">
120 |               <StaticResource creativeType="image/gif"><![CDATA[http://example.com/linear-icon.gif]]></StaticResource>
121 |               <IconViewTracking><![CDATA[http://example.com/linear-viewtracking]]></IconViewTracking>
122 |               <IconClicks>
123 |                 <IconClickThrough><![CDATA[http://example.com/linear-clickthrough]]></IconClickThrough>
124 |                 <IconClickTracking id='icon-click-1'><![CDATA[http://example.com/linear-clicktracking1]]></IconClickTracking>
125 |                 <IconClickTracking id='icon-click-2'><![CDATA[http://example.com/linear-clicktracking2]]></IconClickTracking>
126 |               </IconClicks>
127 |             </Icon>
128 |           </Icons>
129 |         </Linear>
130 |       </Creative>
131 |     </Creatives>
132 |     <Extensions>
133 |       <Extension type="Pricing">
134 |         <Price model="CPM" currency="USD" source="someone">
135 |           <![CDATA[ 0 ]]>
136 |         </Price>
137 |       </Extension>
138 |       <Extension type="Count">
139 |         <!-- -->
140 |         <![CDATA[ 4 ]]>
141 |       </Extension>
142 |       <Extension>
143 |           { foo: bar }
144 |       </Extension>
145 |     </Extensions>
146 |   </InLine>
147 | </Ad>`;
148 | 


--------------------------------------------------------------------------------
/spec/samples/outdated-vast.xml:
--------------------------------------------------------------------------------
 1 | <VideoAdServingTemplate>
 2 |     <Ad id="preroll-1">
 3 |         <InLine>
 4 |             <AdSystem>example-1</AdSystem>
 5 |             <AdTitle>123456</AdTitle>
 6 |             <Video>
 7 |                 <Duration>00:00:15</Duration>
 8 |                 <AdID>preroll-1</AdID>
 9 |                 <MediaFiles>
10 |                     <MediaFile width="600" type="video/x-flv" height="396" delivery="progressive"
11 |                         bitrate="496">
12 |                         <URL><![CDATA[http://example.com/ads/mediafile1.flv]]></URL>
13 |                     </MediaFile>
14 |                 </MediaFiles>
15 |             </Video>
16 |         </InLine>
17 |     </Ad>
18 | </VideoAdServingTemplate>
19 | 


--------------------------------------------------------------------------------
/spec/samples/viewable_impression.js:
--------------------------------------------------------------------------------
 1 | export const viewableImpression = `<InLine>
 2 |   <ViewableImpression id="viewable_impression">
 3 |     <Viewable>
 4 |       <![CDATA[http://www.example.com/viewable_impression_1]]>
 5 |     </Viewable>
 6 |     <Viewable>
 7 |       <![CDATA[http://www.sample.com/viewable_impression_2]]>
 8 |     </Viewable>
 9 |     <NotViewable>
10 |       <![CDATA[http://www.example.com/not_viewable_1]]>
11 |     </NotViewable>
12 |     <NotViewable>
13 |       <![CDATA[http://www.sample.com/not_viewable_2]]>
14 |     </NotViewable>
15 |     <NotViewable>
16 |       <![CDATA[http://www.sample.com/not_viewable_3]]>
17 |     </NotViewable>
18 |     <ViewUndetermined>
19 |       <![CDATA[http://www.example.com/view_undetermined_1]]>
20 |     </ViewUndetermined>
21 |   </ViewableImpression>
22 | </InLine>
23 | `;
24 | 
25 | export const viewableImpressionPartial = `<InLine>
26 |   <ViewableImpression>
27 |     <Viewable>
28 |       <![CDATA[http://www.example.com/viewable_impression_1]]>
29 |     </Viewable>
30 |     <NotViewable>
31 |       <![CDATA[]]>
32 |     </NotViewable>
33 |   </ViewableImpression>
34 | </InLine>
35 | `;
36 | 


--------------------------------------------------------------------------------
/spec/samples/vpaid.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <VAST version="4.3">
 3 |     <Ad id="VPAID">
 4 |         <InLine>
 5 |             <AdSystem version="3.1">LiveRail</AdSystem>
 6 |             <AdTitle>VPAID Ad Manager</AdTitle>
 7 |             <Impression></Impression>
 8 |             <Creatives>
 9 |                 <Creative sequence="1">
10 |                     <Linear>
11 |                         <MediaFiles>
12 |                             <MediaFile delivery="progressive" width="640" height="480" scalable="1" type="application/javascript" apiFramework="VPAID"><![CDATA[http://cdn-static.liverail.com/js/LiveRail.AdManager-1.0.js?LR_PUBLISHER_ID=1331&LR_AUTOPLAY=0&LR_CONTENT=1&LR_TITLE=Foo&LR_VIDEO_ID=1234&LR_VERTICALS=international_news&LR_FORMAT=application/javascript]]></MediaFile>
13 |                         </MediaFiles>
14 |                     </Linear>
15 |                 </Creative>
16 | 
17 |                 <Creative sequence="1">
18 |                     <CompanionAds>
19 |                         <Companion width="300" height="250">
20 |                             <HTMLResource><![CDATA[<div id="lr_comp_300x250" style=" width: 300px; height: 250px; display: none;"></div>]]></HTMLResource>
21 |                         </Companion>
22 |                         <Companion width="300" height="60">
23 |                             <HTMLResource><![CDATA[<div id="lr_comp_300x60" style=" width: 300px; height: 60px; display: none;"></div>]]></HTMLResource>
24 |                         </Companion>
25 |                         <Companion width="728" height="90">
26 |                             <HTMLResource><![CDATA[<div id="lr_comp_728x90" style=" width: 728px; height: 90px; display: none;"></div>]]></HTMLResource>
27 |                         </Companion>
28 |                     </CompanionAds>
29 |                 </Creative>
30 |             </Creatives>
31 |         </InLine>
32 |     </Ad>
33 | </VAST>


--------------------------------------------------------------------------------
/spec/samples/vpaid2.xml:
--------------------------------------------------------------------------------
 1 | <VAST version="4.3">
 2 |   <Ad id="preroll-1">
 3 |     <InLine>
 4 |       <AdSystem>2.0</AdSystem>
 5 |       <AdTitle>5773100</AdTitle>
 6 |       <Creatives>
 7 |         <Creative>
 8 |           <Linear>
 9 |             <Duration>00:00:01</Duration>
10 |             <MediaFiles>
11 |               <MediaFile height="270" width="370" type="application/x-shockwave-flash">
12 |                 <![CDATA[http://static.scanscout.com/ads/vpaidad3.swf?adData=http%3A//app.scanscout.com/ssframework/adStreamJSController.xml%3Fa%3Dgetadscheduleforcontent%26PI%3D567%26scheduleVersion%3Dnull%26HI%3D567|preroll|7496075541100999745%26AI%3D0]]>
13 |               </MediaFile>
14 |             </MediaFiles>
15 |           </Linear>
16 |         </Creative>
17 |         <Creative>
18 |           <CompanionAds>
19 |             <Companion height="250" width="300" id="573242">
20 |               <HTMLResource>
21 |                 <![CDATA[<A onClick="var i= new Image(1,1); i.src='http://app.scanscout.com/ssframework/log/log.png?a=logitemaction&RI=573242&CbC=1&CbF=true&EC=0&RC=0&SmC=2&CbM=1.0E-5&VI=44cfc3b2382300cb751ba129fe51f46a&admode=preroll&PRI=7496075541100999745&RprC=5&ADsn=20&VcaI=192,197&RrC=1&VgI=44cfc3b2382300cb751ba129fe51f46a&AVI=142&Ust=ma&Uctry=us&CI=1247549&AC=4&PI=567&Udma=506&ADI=5773100&VclF=true';" HREF="http://vaseline.com" target="_blank"> <IMG SRC="http://media.scanscout.com/ads/vaseline300x250Companion.jpg" BORDER=0 WIDTH=300 HEIGHT=250 ALT="Click Here"> </A> <img src="http://app.scanscout.com/ssframework/log/log.png?a=logitemaction&RI=573242&CbC=1&CbF=true&EC=1&RC=0&SmC=2&CbM=1.0E-5&VI=44cfc3b2382300cb751ba129fe51f46a&admode=preroll&PRI=7496075541100999745&RprC=5&ADsn=20&VcaI=192,197&RrC=1&VgI=44cfc3b2382300cb751ba129fe51f46a&AVI=142&Ust=ma&Uctry=us&CI=1247549&AC=4&PI=567&Udma=506&ADI=5773100&VclF=true" height="1" width="1">]]>
22 |               </HTMLResource>
23 |             </Companion>
24 |           </CompanionAds>
25 |         </Creative>
26 |       </Creatives>
27 |     </InLine>
28 |   </Ad>
29 | </VAST>
30 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-a.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <VAST version="4.3">
  3 |   <Ad id="4321">
  4 |     <Wrapper>
  5 |       <AdSystem>VAST</AdSystem>
  6 |       <VASTAdTagURI><![CDATA[wrapper-b.xml]]></VASTAdTagURI>
  7 |       <Error><![CDATA[http://example.com/wrapperA-error]]></Error>
  8 |       <Impression id="wrapper-a-impression"><![CDATA[http://example.com/wrapperA-impression]]></Impression>
  9 |       <Creatives>
 10 |         <Creative id="a:ca1">
 11 |           <CompanionAds>
 12 |             <Companion id="urn:a2:287461:103" width="0" height="0">
 13 |               <CompanionClickThrough><![CDATA[http://example.com/wrapperA-companion1-click-thru]]></CompanionClickThrough>
 14 |               <CompanionClickTracking><![CDATA[http://example.com/wrapperA-companion1-click-tracking]]></CompanionClickTracking>
 15 |               <AdParameters><![CDATA[campaign_id=10446]]></AdParameters>
 16 |             </Companion>
 17 |             <Companion width="300" height="60">
 18 |               <IFrameResource>
 19 |                 <![CDATA[http://www.example.com/wrapperA-companion2-example.php]]>
 20 |               </IFrameResource>
 21 |               <CompanionClickThrough>
 22 |                 http://example.com/wrapperA-companion2-click-thru
 23 |               </CompanionClickThrough>
 24 |             </Companion>
 25 |           </CompanionAds>
 26 |         </Creative>
 27 |         <Creative id="a:na1">
 28 |           <NonLinearAds>
 29 |             <TrackingEvents>
 30 |               <Tracking event="start"><![CDATA[http://example.com/wrapperA-nonlinear-start]]></Tracking>
 31 |               <Tracking event="complete"><![CDATA[http://example.com/wrapperA-nonlinear-complete]]></Tracking>
 32 |             </TrackingEvents>
 33 |             <NonLinearClickThrough>
 34 |               http://www.example.com/wrapperA-nonlinear-click-thru
 35 |             </NonLinearClickThrough>
 36 |             <NonLinear>
 37 |               <StaticResource>
 38 |                 <![CDATA[http://www.example.com/wrapperA-nonlinear-example.gif]]>
 39 |               </StaticResource>
 40 |             </NonLinear>
 41 |           </NonLinearAds>
 42 |         </Creative>
 43 |         <Creative id="a:la1">
 44 |           <Linear>
 45 |             <TrackingEvents>
 46 |               <Tracking event="start"><![CDATA[http://example.com/wrapperA-linear-start1]]></Tracking>
 47 |               <Tracking event="progress" offset="00:00:30"><![CDATA[http://example.com/wrapperA-linear-progress-30sec]]></Tracking>
 48 |               <Tracking event="progress" offset="60%"><![CDATA[http://example.com/wrapperA-linear-progress-60%]]></Tracking>
 49 |               <Tracking event="complete"><![CDATA[http://example.com/wrapperA-linear-complete]]></Tracking>
 50 |             </TrackingEvents>
 51 |             <VideoClicks>
 52 |               <ClickTracking id='wrapper-video-click-1'><![CDATA[http://example.com/wrapperA-linear-clicktracking1]]></ClickTracking>
 53 |               <ClickTracking><![CDATA[http://example.com/wrapperA-linear-clicktracking2]]></ClickTracking>
 54 |               <CustomClick id='123'><![CDATA[http://example.com/wrapperA-linear-customclick]]></CustomClick>
 55 |             </VideoClicks>
 56 |           </Linear>
 57 |         </Creative>
 58 |         <Creative id="a:la2">
 59 |           <Linear>
 60 |             <TrackingEvents>
 61 |               <Tracking event="start"><![CDATA[http://example.com/wrapperA-linear-start2]]></Tracking>
 62 |               <Tracking event="progress" offset="90%"><![CDATA[http://example.com/wrapperA-linear-progress-90%]]></Tracking>
 63 |             </TrackingEvents>
 64 |             <VideoClicks>
 65 |               <ClickTracking id='wrapper-video-click-3'><![CDATA[http://example.com/wrapperA-linear-clicktracking3]]></ClickTracking>
 66 |             </VideoClicks>
 67 |           </Linear>
 68 |         </Creative>
 69 |       </Creatives>
 70 |       <Extensions>
 71 |         <Extension type="WrapperExtension">
 72 |           <extension_tag>
 73 |             <![CDATA[ extension_value ]]>
 74 |           </extension_tag>
 75 |         </Extension>
 76 |       </Extensions>
 77 |     </Wrapper>
 78 |   </Ad>
 79 |   <Ad id="2032">
 80 |     <Wrapper>
 81 |       <AdSystem version="4.0">iabtechlab</AdSystem>
 82 |       <VASTAdTagURI><![CDATA[vpaid.xml]]></VASTAdTagURI>
 83 | 
 84 |       <Error>http://example.com/error</Error>
 85 | 
 86 |       <Impression>http://example.com/track/impression</Impression>
 87 |       <Creatives>
 88 |         <Creative id="5480" sequence="1">
 89 |           <CompanionAds>
 90 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
 91 |               <StaticResource creativeType="image/png">
 92 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
 93 |               </StaticResource>
 94 |               <CompanionClickThrough>
 95 |                 <![CDATA[https://iabtechlab.com]]>
 96 |               </CompanionClickThrough>
 97 |             </Companion>
 98 |           </CompanionAds>
 99 |         </Creative>
100 |       </Creatives>
101 |     </Wrapper>
102 |   </Ad>
103 | </VAST>
104 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-attributes-multiple-ads.xml:
--------------------------------------------------------------------------------
 1 | <VAST version="4.3">
 2 |   <Ad id="201">
 3 |     <Wrapper>
 4 |       <AdSystem version="4.0">iabtechlab</AdSystem>
 5 |       <VASTAdTagURI><![CDATA[sample.xml]]></VASTAdTagURI>
 6 |       <Error>http://example.com/error</Error>
 7 |       <Impression>http://example.com/track/impression</Impression>
 8 |       <Creatives>
 9 |         <Creative id="5480" sequence="1">
10 |           <CompanionAds>
11 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
12 |               <StaticResource creativeType="image/png">
13 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
14 |               </StaticResource>
15 |               <CompanionClickThrough>
16 |                 <![CDATA[https://iabtechlab.com]]>
17 |               </CompanionClickThrough>
18 |             </Companion>
19 |           </CompanionAds>
20 |         </Creative>
21 |       </Creatives>
22 |     </Wrapper>
23 |   </Ad>
24 |   <Ad id="202">
25 |     <Wrapper allowMultipleAds="false" followAdditionalWrappers="false">
26 |       <AdSystem version="4.0">iabtechlab</AdSystem>
27 |       <VASTAdTagURI><![CDATA[wrapper-b.xml]]></VASTAdTagURI>
28 |       <Error>http://example.com/error</Error>
29 |       <Impression>http://example.com/track/impression</Impression>
30 |       <Creatives>
31 |         <Creative id="5480" sequence="1">
32 |           <CompanionAds>
33 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
34 |               <StaticResource creativeType="image/png">
35 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
36 |               </StaticResource>
37 |               <CompanionClickThrough>
38 |                 <![CDATA[https://iabtechlab.com]]>
39 |               </CompanionClickThrough>
40 |             </Companion>
41 |           </CompanionAds>
42 |         </Creative>
43 |       </Creatives>
44 |     </Wrapper>
45 |   </Ad>
46 |   <Ad id="203">
47 |     <Wrapper allowMultipleAds="1" followAdditionalWrappers="True">
48 |       <AdSystem version="4.0">iabtechlab</AdSystem>
49 |       <VASTAdTagURI><![CDATA[wrapper-b.xml]]></VASTAdTagURI>
50 |       <Error>http://example.com/error</Error>
51 |       <Impression>http://example.com/track/impression</Impression>
52 |       <Creatives>
53 |         <Creative id="5480" sequence="1">
54 |           <CompanionAds>
55 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
56 |               <StaticResource creativeType="image/png">
57 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
58 |               </StaticResource>
59 |               <CompanionClickThrough>
60 |                 <![CDATA[https://iabtechlab.com]]>
61 |               </CompanionClickThrough>
62 |             </Companion>
63 |           </CompanionAds>
64 |         </Creative>
65 |       </Creatives>
66 |     </Wrapper>
67 |   </Ad>
68 |   <Ad id="204">
69 |     <Wrapper allowMultipleAds="true" followAdditionalWrappers="false">
70 |       <AdSystem version="4.0">iabtechlab</AdSystem>
71 |       <VASTAdTagURI><![CDATA[sample.xml]]></VASTAdTagURI>
72 |       <Error>http://example.com/error</Error>
73 |       <Impression>http://example.com/track/impression</Impression>
74 |       <Creatives>
75 |         <Creative id="5480" sequence="1">
76 |           <CompanionAds>
77 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
78 |               <StaticResource creativeType="image/png">
79 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
80 |               </StaticResource>
81 |               <CompanionClickThrough>
82 |                 <![CDATA[https://iabtechlab.com]]>
83 |               </CompanionClickThrough>
84 |             </Companion>
85 |           </CompanionAds>
86 |         </Creative>
87 |       </Creatives>
88 |     </Wrapper>
89 |   </Ad>
90 | </VAST>
91 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-b.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <VAST version="4.3">
 3 |   <Ad id="1234">
 4 |     <Wrapper>
 5 |       <AdSystem>VAST</AdSystem>
 6 |       <VASTAdTagURI><![CDATA[sample.xml]]></VASTAdTagURI>
 7 |       <Error><![CDATA[http://example.com/wrapperB-error]]></Error>
 8 |       <Impression id="wrapper-b-impression1"><![CDATA[http://example.com/wrapperB-impression1]]></Impression>
 9 |       <Impression id="wrapper-b-impression2"><![CDATA[http://example.com/wrapperB-impression2]]></Impression>
10 |       <Creatives>
11 |         <Creative id="b:ca1">
12 |           <CompanionAds>
13 |             <Companion id="urn:a2:287461:103" width="0" height="0">
14 |               <CompanionClickThrough><![CDATA[http://example.com/wrapperB-companion1-click-thru]]></CompanionClickThrough>
15 |               <CompanionClickTracking><![CDATA[http://example.com/wrapperB-companion1-click-tracking]]></CompanionClickTracking>
16 |               <AdParameters><![CDATA[campaign_id=10446]]></AdParameters>
17 |             </Companion>
18 |             <Companion width="300" height="60">
19 |               <IFrameResource>
20 |                 <![CDATA[http://www.example.com/wrapperB-companion2-example.php]]>
21 |               </IFrameResource>
22 |               <CompanionClickThrough>
23 |                 http://example.com/wrapperB-companion2-click-thru
24 |               </CompanionClickThrough>
25 |             </Companion>
26 |           </CompanionAds>
27 |         </Creative>
28 |         <Creative id="b:na1">
29 |           <NonLinearAds>
30 |             <TrackingEvents>
31 |               <Tracking event="start"><![CDATA[http://example.com/wrapperB-nonlinear-start]]></Tracking>
32 |               <Tracking event="complete"><![CDATA[http://example.com/wrapperB-nonlinear-complete]]></Tracking>
33 |             </TrackingEvents>
34 |             <NonLinearClickThrough>
35 |               http://www.example.com/wrapperB-nonlinear-click-thru
36 |             </NonLinearClickThrough>
37 |             <NonLinear>
38 |               <StaticResource>
39 |                 <![CDATA[http://www.example.com/wrapperB-nonlinear-example.gif]]>
40 |               </StaticResource>
41 |             </NonLinear>
42 |           </NonLinearAds>
43 |         </Creative>
44 |         <Creative id="b:la1">
45 |           <Linear>
46 |             <TrackingEvents>
47 |               <Tracking event="start"><![CDATA[http://example.com/wrapperB-linear-start]]></Tracking>
48 |               <Tracking event="progress" offset="00:00:30"><![CDATA[http://example.com/wrapperB-linear-progress-30sec]]></Tracking>
49 |               <Tracking event="progress" offset="60%"><![CDATA[http://example.com/wrapperB-linear-progress-60%]]></Tracking>
50 |               <Tracking event="complete"><![CDATA[http://example.com/wrapperB-linear-complete]]></Tracking>
51 |             </TrackingEvents>
52 |             <VideoClicks>
53 |               <ClickThrough><![CDATA[http://example.com/wrapperB-linear-clickthrough]]></ClickThrough>
54 |               <ClickTracking id="WRAP"><![CDATA[http://example.com/wrapperB-linear-clicktracking]]></ClickTracking>
55 |             </VideoClicks>
56 |           </Linear>
57 |         </Creative>
58 |       </Creatives>
59 |     </Wrapper>
60 |   </Ad>
61 | </VAST>
62 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-empty-no-creative.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <VAST version="4.3">
 3 |   <Ad>
 4 |     <Wrapper>
 5 |       <AdSystem>VAST</AdSystem>
 6 |       <VASTAdTagURI>empty-no-creative.xml</VASTAdTagURI>
 7 |       <Error>http://example.com/wrapper-no-creative_wrapper-error</Error>
 8 |       <Impression>http://example.com/wrapper-impression</Impression>
 9 |       <Creatives>
10 |         <Creative>
11 |           <Linear>
12 |             <TrackingEvents>
13 |               <Tracking event="start"><![CDATA[http://example.com/wrapper-start]]></Tracking>
14 |               <Tracking event="complete"><![CDATA[http://example.com/wrapper-complete]]></Tracking>
15 |             </TrackingEvents>
16 |             <VideoClicks>
17 |               <ClickTracking><![CDATA[http://example.com/wrapper-clicktracking]]></ClickTracking>
18 |             </VideoClicks>
19 |           </Linear>
20 |         </Creative>
21 |       </Creatives>
22 |       <Extensions>
23 |         <Extension>
24 |           <paramWrapperEmptyNoCreative><![CDATA[valueWrapperEmptyNoCreative]]></paramWrapperEmptyNoCreative>
25 |         </Extension>
26 |       </Extensions>
27 |     </Wrapper>
28 |   </Ad>
29 | </VAST>
30 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-empty.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <VAST version="4.3">
 3 |   <Ad>
 4 |     <Wrapper>
 5 |       <AdSystem>VAST</AdSystem>
 6 |       <VASTAdTagURI>empty-no-ad.xml</VASTAdTagURI>
 7 |       <Error>http://example.com/wrapper-empty_wrapper-error</Error>
 8 |       <Impression>http://example.com/wrapper-impression</Impression>
 9 |       <Creatives>
10 |         <Creative>
11 |           <CompanionAds>
12 |             <Companion id="urn:a2:287461:103" width="0" height="0">
13 |               <CompanionClickThrough><![CDATA[http://example.com/companion-click-thru]]></CompanionClickThrough>
14 |               <CompanionClickTracking><![CDATA[http://example.com/companion-click-tracking]]></CompanionClickTracking>
15 |               <AdParameters><![CDATA[campaign_id=10446]]></AdParameters>
16 |             </Companion>
17 |           </CompanionAds>
18 |         </Creative>
19 |         <Creative>
20 |           <Linear>
21 |             <TrackingEvents>
22 |               <Tracking event="start"><![CDATA[http://example.com/wrapper-start]]></Tracking>
23 |               <Tracking event="complete"><![CDATA[http://example.com/wrapper-complete]]></Tracking>
24 |             </TrackingEvents>
25 |             <VideoClicks>
26 |               <ClickTracking><![CDATA[http://example.com/wrapper-clicktracking]]></ClickTracking>
27 |             </VideoClicks>
28 |           </Linear>
29 |         </Creative>
30 |       </Creatives>
31 |       <Extensions>
32 |         <Extension>
33 |           <paramWrapperEmptyNoAd><![CDATA[valueWrapperEmptyNoAd]]></paramWrapperEmptyNoAd>
34 |         </Extension>
35 |       </Extensions>
36 |     </Wrapper>
37 |   </Ad>
38 | </VAST>
39 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-legacy.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <VAST version="2.0">
 3 |   <Error><![CDATA[http://example.com/wrapper-error]]></Error>
 4 |   <Ad>
 5 |     <Wrapper>
 6 |       <AdSystem>VAST</AdSystem>
 7 |       <VASTAdTagURL>
 8 |         <URL><![CDATA[inline-linear.xml]]></URL>
 9 |       </VASTAdTagURL>
10 |       <Error>http://example.com/wrapper-error</Error>
11 |       <Impression>http://example.com/wrapper-impression</Impression>
12 |       <Creatives>
13 |         <Creative>
14 |           <CompanionAds>
15 |             <Companion id="urn:a2:287461:103" width="0" height="0">
16 |               <CompanionClickThrough><![CDATA[http://example.com/companion-click-thru]]></CompanionClickThrough>
17 |               <CompanionClickTracking><![CDATA[http://example.com/companion-click-tracking]]></CompanionClickTracking>
18 |               <AdParameters><![CDATA[campaign_id=10446]]></AdParameters>
19 |             </Companion>
20 |           </CompanionAds>
21 |         </Creative>
22 |         <Creative>
23 |           <Linear>
24 |             <TrackingEvents>
25 |               <Tracking event="start"><![CDATA[http://example.com/wrapper-start]]></Tracking>
26 |               <Tracking event="complete"><![CDATA[http://example.com/wrapper-complete]]></Tracking>
27 |             </TrackingEvents>
28 |             <VideoClicks>
29 |               <ClickTracking><![CDATA[http://example.com/wrapper-clicktracking]]></ClickTracking>
30 |             </VideoClicks>
31 |           </Linear>
32 |         </Creative>
33 |       </Creatives>
34 |     </Wrapper>
35 |   </Ad>
36 | </VAST>
37 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-multiple-ads.xml:
--------------------------------------------------------------------------------
 1 | <VAST version="4.3">
 2 |   <Ad id="201">
 3 |     <Wrapper allowMultipleAds="true">
 4 |       <AdSystem version="4.0">iabtechlab</AdSystem>
 5 |       <VASTAdTagURI><![CDATA[sample.xml]]></VASTAdTagURI>
 6 |       <Error>http://example.com/error</Error>
 7 |       <Impression>http://example.com/track/impression</Impression>
 8 |       <Creatives>
 9 |         <Creative id="5480" sequence="1">
10 |           <CompanionAds>
11 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
12 |               <StaticResource creativeType="image/png">
13 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
14 |               </StaticResource>
15 |               <CompanionClickThrough>
16 |                 <![CDATA[https://iabtechlab.com]]>
17 |               </CompanionClickThrough>
18 |             </Companion>
19 |           </CompanionAds>
20 |         </Creative>
21 |       </Creatives>
22 |     </Wrapper>
23 |   </Ad>
24 |   <Ad id="20011" sequence="1">
25 |     <Wrapper allowMultipleAds="true">
26 |       <AdSystem version="4.0">iabtechlab</AdSystem>
27 |       <VASTAdTagURI><![CDATA[vpaid.xml]]></VASTAdTagURI>
28 |       <Error>http://example.com/error</Error>
29 |       <Impression>http://example.com/track/impression</Impression>
30 |       <Creatives>
31 |         <Creative id="5480" sequence="1">
32 |           <CompanionAds>
33 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
34 |               <StaticResource creativeType="image/png">
35 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
36 |               </StaticResource>
37 |               <CompanionClickThrough>
38 |                 <![CDATA[https://iabtechlab.com]]>
39 |               </CompanionClickThrough>
40 |             </Companion>
41 |           </CompanionAds>
42 |         </Creative>
43 |       </Creatives>
44 |     </Wrapper>
45 |   </Ad>
46 |   <Ad id="20012" sequence="2">
47 |     <Wrapper allowMultipleAds="true">
48 |       <AdSystem version="4.0">iabtechlab</AdSystem>
49 |       <VASTAdTagURI><![CDATA[inline-linear.xml]]></VASTAdTagURI>
50 |       <Error>http://example.com/error</Error>
51 |       <Impression>http://example.com/track/impression</Impression>
52 |       <Creatives>
53 |         <Creative id="5480" sequence="1">
54 |           <CompanionAds>
55 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
56 |               <StaticResource creativeType="image/png">
57 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
58 |               </StaticResource>
59 |               <CompanionClickThrough>
60 |                 <![CDATA[https://iabtechlab.com]]>
61 |               </CompanionClickThrough>
62 |             </Companion>
63 |           </CompanionAds>
64 |         </Creative>
65 |       </Creatives>
66 |     </Wrapper>
67 |   </Ad>
68 |   <Ad id="2032">
69 |     <Wrapper allowMultipleAds="true">
70 |       <AdSystem version="4.0">iabtechlab</AdSystem>
71 |       <VASTAdTagURI><![CDATA[vpaid2.xml]]></VASTAdTagURI>
72 |       <Error>http://example.com/error</Error>
73 |       <Impression>http://example.com/track/impression</Impression>
74 |       <Creatives>
75 |         <Creative id="5480" sequence="1">
76 |           <CompanionAds>
77 |             <Companion id="1232" width="100" height="150" assetWidth="250" assetHeight="200" expandedWidth="350" expandedHeight="250">
78 |               <StaticResource creativeType="image/png">
79 |                 <![CDATA[https://www.iab.com/wp-content/uploads/2014/09/iab-tech-lab-6-644x290.png]]>
80 |               </StaticResource>
81 |               <CompanionClickThrough>
82 |                 <![CDATA[https://iabtechlab.com]]>
83 |               </CompanionClickThrough>
84 |             </Companion>
85 |           </CompanionAds>
86 |         </Creative>
87 |       </Creatives>
88 |     </Wrapper>
89 |   </Ad>
90 | </VAST>
91 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper-unavailable-url.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <VAST version="4.3">
 3 |   <Ad>
 4 |     <Wrapper>
 5 |       <AdSystem>VAST</AdSystem>
 6 |       <VASTAdTagURI>invalid-url</VASTAdTagURI>
 7 |       <Error>http://example.com/wrapper-invalid-xmlfile_wrapper-error</Error>
 8 |       <Impression>http://example.com/wrapper-invalid-xmlfile_impression</Impression>
 9 |       <Creatives>
10 |         <Creative>
11 |           <CompanionAds>
12 |             <Companion id="urn:a2:287461:103" width="0" height="0">
13 |               <CompanionClickThrough><![CDATA[http://example.com/wrapper-invalid-xmlfile_companion_click-thru]]></CompanionClickThrough>
14 |               <CompanionClickTracking><![CDATA[http://example.com/wrapper-invalid-xmlfile_companion_click-tracking]]></CompanionClickTracking>
15 |               <AdParameters><![CDATA[campaign_id=10446]]></AdParameters>
16 |             </Companion>
17 |           </CompanionAds>
18 |         </Creative>
19 |         <Creative>
20 |           <Linear>
21 |             <TrackingEvents>
22 |               <Tracking event="start"><![CDATA[http://example.com/wrapper-invalid-xmlfile_linear_start]]></Tracking>
23 |               <Tracking event="complete"><![CDATA[http://example.com/wrapper-invalid-xmlfile_linear_complete]]></Tracking>
24 |             </TrackingEvents>
25 |             <VideoClicks>
26 |               <ClickTracking><![CDATA[http://example.com/wrapper-invalid-xmlfile_linear_clicktracking]]></ClickTracking>
27 |             </VideoClicks>
28 |           </Linear>
29 |         </Creative>
30 |       </Creatives>
31 |       <Extensions>
32 |         <Extension>
33 |           <paramWrapperInvalidXmlfile><![CDATA[valueWrapperInvalidXmlfile]]></paramWrapperInvalidXmlfile>
34 |         </Extension>
35 |       </Extensions>
36 |     </Wrapper>
37 |   </Ad>
38 | </VAST>
39 | 


--------------------------------------------------------------------------------
/spec/samples/wrapper_missing_values.js:
--------------------------------------------------------------------------------
 1 | export const vastMissingWrapperValues = `
 2 | <VAST version="4.3" xmlns="http://www.iab.com/VAST">
 3 |   <Ad id="20011" sequence="1" conditionalAd="false">
 4 |   <Wrapper>
 5 |       <AdSystem>VAST</AdSystem>
 6 |       <Error>http://example.com/wrapper-invalid-xmlfile_wrapper-error</Error>
 7 |       <BlockedAdCategories>001,002,003</BlockedAdCategories>
 8 |       <Creatives>
 9 |         <Creative>
10 |           <CompanionAds>
11 |             <Companion id="urn:a2:287461:103" width="0" height="0">
12 |               <CompanionClickThrough><![CDATA[http://example.com/wrapper-invalid-xmlfile_companion_click-thru]]></CompanionClickThrough>
13 |               <CompanionClickTracking><![CDATA[http://example.com/wrapper-invalid-xmlfile_companion_click-tracking]]></CompanionClickTracking>
14 |             </Companion>
15 |           </CompanionAds>
16 |         </Creative>
17 |         <Creative>
18 |           <Linear>
19 |             <TrackingEvents>
20 |               <Tracking event="start"><![CDATA[http://example.com/wrapper-invalid-xmlfile_linear_start]]></Tracking>
21 |               <Tracking event="complete"><![CDATA[http://example.com/wrapper-invalid-xmlfile_linear_complete]]></Tracking>
22 |             </TrackingEvents>
23 |             <VideoClicks>
24 |               <ClickTracking><![CDATA[http://example.com/wrapper-invalid-xmlfile_linear_clicktracking]]></ClickTracking>
25 |             </VideoClicks>
26 |           </Linear>
27 |         </Creative>
28 |       </Creatives>
29 |       <Extensions>
30 |         <Extension>
31 |             <paramWrapperInvalidXmlfile><![CDATA[valueWrapperInvalidXmlfile]]></paramWrapperInvalidXmlfile>
32 |         </Extension>
33 |       </Extensions>
34 |     </Wrapper>
35 |   </Ad>
36 | </VAST>
37 | `;
38 | 


--------------------------------------------------------------------------------
/spec/utils/utils.js:
--------------------------------------------------------------------------------
 1 | import path from 'path';
 2 | 
 3 | export const getNodesFromXml = (xmlString) => {
 4 |   const parser = new DOMParser();
 5 |   return parser.parseFromString(xmlString, 'text/xml').childNodes[0];
 6 | };
 7 | 
 8 | export const urlFor = (fileName) => {
 9 |   const filePath = path
10 |     .resolve(path.join('spec', 'samples', fileName))
11 |     .replace(/\\/g, '/');
12 |   return `file:///${filePath}`;
13 | };
14 | 


--------------------------------------------------------------------------------
/spec/vast_client.spec.js:
--------------------------------------------------------------------------------
  1 | import { VASTClient } from '../src/vast_client';
  2 | import { readFile } from 'fs/promises';
  3 | 
  4 | const wrapperMultipleAdsVastUrl = './spec/samples/wrapper-multiple-ads.xml';
  5 | const emptyVastUrl = './spec/samples/empty-no-ad.xml';
  6 | 
  7 | const nodeUrlHandler = {
  8 |   get: async (file) => {
  9 |     try {
 10 |       const response = await readFile(file, 'utf-8');
 11 |       return {
 12 |         xml: new DOMParser().parseFromString(response, 'text/xml'),
 13 |         details: { byteLength: 1234, statusCode: 200 },
 14 |       };
 15 |     } catch (err) {
 16 |       return { error: err, statusCode: 400 };
 17 |     }
 18 |   },
 19 | };
 20 | 
 21 | const options = {
 22 |   urlHandler: nodeUrlHandler,
 23 |   withCredentials: true,
 24 | };
 25 | 
 26 | describe('VASTClient', () => {
 27 |   describe('when cappingFreeLunch is set to 1', () => {
 28 |     const VastClient = new VASTClient(1, undefined, undefined);
 29 | 
 30 |     afterAll(() => {
 31 |       VastClient.storage.clear();
 32 |     });
 33 | 
 34 |     it('ignores the first call and updates total calls', () => {
 35 |       return expect(
 36 |         VastClient.get(wrapperMultipleAdsVastUrl, options)
 37 |       ).rejects.toEqual(
 38 |         new Error(`VAST call canceled – FreeLunch capping not reached yet 1/1`)
 39 |       );
 40 |     });
 41 | 
 42 |     it('succeeds with the second call and updates total calls', async () => {
 43 |       const res = await VastClient.get(wrapperMultipleAdsVastUrl, options);
 44 |       expect(res).toEqual({
 45 |         ads: expect.any(Array),
 46 |         errorURLTemplates: [],
 47 |         version: '4.3',
 48 |       });
 49 |       expect(VastClient.totalCalls).toBe('2');
 50 |     });
 51 |   });
 52 | 
 53 |   describe('when cappingMinimumTimeInterval is set to 30 seconds', () => {
 54 |     const VastClient = new VASTClient(0, 30000, undefined);
 55 | 
 56 |     it('succeeds with the first call and updates total calls', async () => {
 57 |       const res = await VastClient.get(wrapperMultipleAdsVastUrl, options);
 58 |       expect(res).toEqual({
 59 |         ads: expect.any(Array),
 60 |         errorURLTemplates: [],
 61 |         version: '4.3',
 62 |       });
 63 |       expect(VastClient.totalCalls).toBe('1');
 64 |     });
 65 | 
 66 |     it('should ignore the second call sent under 30 seconds', async () => {
 67 |       try {
 68 |         await VastClient.get(wrapperMultipleAdsVastUrl, options);
 69 |         jest.spyOn(Date, 'now').mockImplementation(() => 0);
 70 |         await VastClient.get(wrapperMultipleAdsVastUrl, options);
 71 |       } catch (error) {
 72 |         expect(error).toEqual(
 73 |           new Error('VAST call canceled – (30000)ms minimum interval reached')
 74 |         );
 75 |       }
 76 |     });
 77 |   });
 78 | 
 79 |   describe('when custom storage is provided', () => {
 80 |     let getCount = 0;
 81 |     let setCount = 0;
 82 |     const customStorage = {
 83 |       getItem() {
 84 |         getCount++;
 85 |       },
 86 |       setItem() {
 87 |         setCount++;
 88 |       },
 89 |     };
 90 |     const VastClient = new VASTClient(0, 0, customStorage);
 91 | 
 92 |     it('uses the custom storage', () => {
 93 |       expect(getCount).toBe(3);
 94 |       expect(setCount).toBe(3);
 95 | 
 96 |       VastClient.lastSuccessfulAd;
 97 | 
 98 |       expect(getCount).toBe(4);
 99 |     });
100 |   });
101 | 
102 |   describe('get', () => {
103 |     let VastClient;
104 | 
105 |     beforeEach(() => {
106 |       VastClient = new VASTClient();
107 |     });
108 | 
109 |     describe('with resolveAll set to false', () => {
110 |       const optionsWithNoResolveAll = {
111 |         ...options,
112 |         resolveAll: false,
113 |       };
114 |       let res;
115 |       beforeEach(async () => {
116 |         res = await VastClient.get(
117 |           wrapperMultipleAdsVastUrl,
118 |           optionsWithNoResolveAll
119 |         );
120 |       });
121 |       it('returns ad pod parsed', () => {
122 |         expect(res.ads).toHaveLength(2);
123 |         expect(res.ads[0].sequence).toBe('1');
124 |         expect(res.ads[1].sequence).toBe('2');
125 |       });
126 | 
127 |       it('should return stand alone ads in the remaining ads', () => {
128 |         const remainingAds = VastClient.getParser().remainingAds;
129 |         expect(remainingAds[0].id).toBe('201');
130 |         expect(remainingAds[1].id).toBe('2032');
131 |         expect(remainingAds.length).toBe(2);
132 |       });
133 | 
134 |       it('returns true for hasRemainingAds', () => {
135 |         expect(VastClient.hasRemainingAds()).toBeTruthy();
136 |       });
137 |       describe('getNextAds', () => {
138 |         it('resolves all next ads if requested', async () => {
139 |           const res = await VastClient.getNextAds(true);
140 |           expect(res).toEqual({
141 |             ads: expect.any(Array),
142 |             errorURLTemplates: [],
143 |             version: '4.3',
144 |           });
145 |           expect(res.ads).toHaveLength(3);
146 |         });
147 | 
148 |         it('resolves only next ad if requested', async () => {
149 |           await VastClient.get(
150 |             wrapperMultipleAdsVastUrl,
151 |             optionsWithNoResolveAll
152 |           );
153 |           const response = await VastClient.getNextAds(false);
154 |           expect(response).toEqual({
155 |             ads: expect.any(Array),
156 |             errorURLTemplates: [],
157 |             version: '4.3',
158 |           });
159 |           expect(response.ads).toHaveLength(2);
160 |         });
161 |       });
162 | 
163 |       it('handles empty ads correctly', async () => {
164 |         const response = await VastClient.get(
165 |           emptyVastUrl,
166 |           optionsWithNoResolveAll
167 |         );
168 |         expect(response).toEqual({
169 |           ads: [],
170 |           errorURLTemplates: ['http://example.com/empty-no-ad'],
171 |           version: '4.3',
172 |         });
173 |       });
174 |     });
175 | 
176 |     describe('with resolveAll set to true', () => {
177 |       const optionsWithResolveAll = { ...options, resolveAll: true };
178 |       let res;
179 |       beforeEach(async () => {
180 |         res = await VastClient.get(
181 |           wrapperMultipleAdsVastUrl,
182 |           optionsWithResolveAll
183 |         );
184 |       });
185 |       it('returns all ads parsed', () => {
186 |         expect(res).toEqual({
187 |           ads: expect.any(Array),
188 |           errorURLTemplates: [],
189 |           version: '4.3',
190 |         });
191 |         expect(res.ads).toHaveLength(5);
192 |       });
193 | 
194 |       it('will not have remaining ads', () => {
195 |         expect(VastClient.hasRemainingAds()).toBeFalsy();
196 |       });
197 |     });
198 |   });
199 | });
200 | 


--------------------------------------------------------------------------------
/src/ad.js:
--------------------------------------------------------------------------------
 1 | export function createAd(adAttributes = {}) {
 2 |   return {
 3 |     id: adAttributes.id || null,
 4 |     sequence: adAttributes.sequence || null,
 5 |     adType: adAttributes.adType || null,
 6 |     adServingId: null,
 7 |     categories: [],
 8 |     expires: null,
 9 |     viewableImpression: [],
10 |     system: null,
11 |     title: null,
12 |     description: null,
13 |     advertiser: null,
14 |     pricing: null,
15 |     survey: null, // @deprecated in VAST 4.1
16 |     errorURLTemplates: [],
17 |     impressionURLTemplates: [],
18 |     creatives: [],
19 |     extensions: [],
20 |     adVerifications: [],
21 |     blockedAdCategories: [],
22 |     followAdditionalWrappers: true,
23 |     allowMultipleAds: false,
24 |     fallbackOnNoAd: null,
25 |   };
26 | }
27 | 


--------------------------------------------------------------------------------
/src/ad_verification.js:
--------------------------------------------------------------------------------
 1 | export function createAdVerification() {
 2 |   return {
 3 |     resource: null,
 4 |     vendor: null,
 5 |     browserOptional: false,
 6 |     apiFramework: null,
 7 |     type: null,
 8 |     parameters: null,
 9 |     trackingEvents: {},
10 |   };
11 | }
12 | 


--------------------------------------------------------------------------------
/src/closed_caption_file.js:
--------------------------------------------------------------------------------
1 | export function createClosedCaptionFile(closedCaptionAttributes = {}) {
2 |   return {
3 |     type: closedCaptionAttributes.type || null,
4 |     language: closedCaptionAttributes.language || null,
5 |     fileURL: null,
6 |   };
7 | }
8 | 


--------------------------------------------------------------------------------
/src/companion_ad.js:
--------------------------------------------------------------------------------
 1 | export function createCompanionAd(creativeAttributes = {}) {
 2 |   return {
 3 |     id: creativeAttributes.id || null,
 4 |     adType: 'companionAd',
 5 |     width: creativeAttributes.width || 0,
 6 |     height: creativeAttributes.height || 0,
 7 |     assetWidth: creativeAttributes.assetWidth || null,
 8 |     assetHeight: creativeAttributes.assetHeight || null,
 9 |     expandedWidth: creativeAttributes.expandedWidth || null,
10 |     expandedHeight: creativeAttributes.expandedHeight || null,
11 |     apiFramework: creativeAttributes.apiFramework || null,
12 |     adSlotId: creativeAttributes.adSlotId || null,
13 |     pxratio: creativeAttributes.pxratio || '1',
14 |     renderingMode: creativeAttributes.renderingMode || 'default',
15 |     staticResources: [],
16 |     htmlResources: [],
17 |     iframeResources: [],
18 |     adParameters: null,
19 |     altText: null,
20 |     companionClickThroughURLTemplate: null,
21 |     companionClickTrackingURLTemplates: [],
22 |     trackingEvents: {},
23 |   };
24 | }
25 | 
26 | export function isCompanionAd(ad) {
27 |   return ad.adType === 'companionAd';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/creative/creative.js:
--------------------------------------------------------------------------------
 1 | export function createCreative(creativeAttributes = {}) {
 2 |   return {
 3 |     id: creativeAttributes.id || null,
 4 |     adId: creativeAttributes.adId || null,
 5 |     sequence: creativeAttributes.sequence || null,
 6 |     apiFramework: creativeAttributes.apiFramework || null,
 7 |     universalAdIds: [],
 8 |     creativeExtensions: [],
 9 |   };
10 | }
11 | 


--------------------------------------------------------------------------------
/src/creative/creative_companion.js:
--------------------------------------------------------------------------------
 1 | import { createCreative } from './creative';
 2 | 
 3 | export function createCreativeCompanion(creativeAttributes = {}) {
 4 |   const { id, adId, sequence, apiFramework } =
 5 |     createCreative(creativeAttributes);
 6 |   return {
 7 |     id,
 8 |     adId,
 9 |     sequence,
10 |     apiFramework,
11 |     type: 'companion',
12 |     required: null,
13 |     variations: [],
14 |   };
15 | }
16 | 


--------------------------------------------------------------------------------
/src/creative/creative_linear.js:
--------------------------------------------------------------------------------
 1 | import { createCreative } from './creative';
 2 | 
 3 | export function createCreativeLinear(creativeAttributes = {}) {
 4 |   const { id, adId, sequence, apiFramework } =
 5 |     createCreative(creativeAttributes);
 6 |   return {
 7 |     id,
 8 |     adId,
 9 |     sequence,
10 |     apiFramework,
11 |     type: 'linear',
12 |     duration: 0,
13 |     skipDelay: null,
14 |     mediaFiles: [],
15 |     mezzanine: null,
16 |     interactiveCreativeFile: null,
17 |     closedCaptionFiles: [],
18 |     videoClickThroughURLTemplate: null,
19 |     videoClickTrackingURLTemplates: [],
20 |     videoCustomClickURLTemplates: [],
21 |     adParameters: null,
22 |     icons: [],
23 |     trackingEvents: {},
24 |   };
25 | }
26 | 
27 | export function isCreativeLinear(ad) {
28 |   return ad.type === 'linear';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/creative/creative_non_linear.js:
--------------------------------------------------------------------------------
 1 | import { createCreative } from './creative';
 2 | 
 3 | export function createCreativeNonLinear(creativeAttributes = {}) {
 4 |   const { id, adId, sequence, apiFramework } =
 5 |     createCreative(creativeAttributes);
 6 |   return {
 7 |     id,
 8 |     adId,
 9 |     sequence,
10 |     apiFramework,
11 |     type: 'nonlinear',
12 |     variations: [],
13 |     trackingEvents: {},
14 |   };
15 | }
16 | 


--------------------------------------------------------------------------------
/src/extension.js:
--------------------------------------------------------------------------------
 1 | export function createExtension() {
 2 |   return {
 3 |     name: null,
 4 |     value: null,
 5 |     attributes: {},
 6 |     children: [],
 7 |   };
 8 | }
 9 | 
10 | export function isEmptyExtension(extension) {
11 |   return (
12 |     extension.value === null &&
13 |     Object.keys(extension.attributes).length === 0 &&
14 |     extension.children.length === 0
15 |   );
16 | }
17 | 


--------------------------------------------------------------------------------
/src/fetcher/consts.js:
--------------------------------------------------------------------------------
1 | export const DEFAULT_TIMEOUT = 120000;
2 | 


--------------------------------------------------------------------------------
/src/fetcher/fetcher.js:
--------------------------------------------------------------------------------
  1 | import { updateEstimatedBitrate } from '../parser/bitrate';
  2 | import { urlHandler } from './url_handler';
  3 | import { DEFAULT_TIMEOUT } from './consts';
  4 | 
  5 | /**
  6 |  * This class provides a method to fetch a VAST document
  7 |  * @exports
  8 |  * @class Fetcher
  9 |  */
 10 | 
 11 | export class Fetcher {
 12 |   constructor() {
 13 |     this.URLTemplateFilters = [];
 14 |   }
 15 | 
 16 |   /**
 17 |    * Inits the fetching properties of the class with the custom values provided as options
 18 |    * @param {Object} options - The options to initialize before fetching
 19 |    */
 20 |   setOptions(options = {}) {
 21 |     this.urlHandler = options.urlHandler || options.urlhandler || urlHandler;
 22 |     this.fetchingOptions = {
 23 |       timeout: options.timeout || DEFAULT_TIMEOUT,
 24 |       withCredentials: Boolean(options.withCredentials),
 25 |     };
 26 |   }
 27 | 
 28 |   /**
 29 |    * Adds a filter function to the array of filters which are called before fetching a VAST document.
 30 |    * @param  {function} filter - The filter function to be added at the end of the array.
 31 |    */
 32 |   addURLTemplateFilter(filter) {
 33 |     if (typeof filter === 'function') {
 34 |       this.URLTemplateFilters.push(filter);
 35 |     }
 36 |   }
 37 | 
 38 |   /**
 39 |    * Removes the latest URL template filter added.
 40 |    */
 41 |   removeLastURLTemplateFilter() {
 42 |     this.URLTemplateFilters.pop();
 43 |   }
 44 | 
 45 |   /**
 46 |    * Returns the number of URL template filters added.
 47 |    * @return {Number}
 48 |    */
 49 |   countURLTemplateFilters() {
 50 |     return this.URLTemplateFilters.length;
 51 |   }
 52 | 
 53 |   /**
 54 |    * Removes all the URL template filters added.
 55 |    */
 56 |   clearURLTemplateFilters() {
 57 |     this.URLTemplateFilters = [];
 58 |   }
 59 | 
 60 |   /**
 61 |    * Fetches a VAST document for the given url.
 62 |    * @param {Object} params
 63 |    * @param {String} params.url - The url to request the VAST document.
 64 |    * @param {Number} params.wrapperDepth - How many times the current url has been wrapped.
 65 |    * @param {(String | null)} params.previousUrl - Url of the previous VAST.
 66 |    * @param {Object} params.wrapperAd - Previously parsed ad node (Wrapper) related to this fetching.
 67 |    * @param {Number} params.maxWrapperDepth - The maximum number of Wrapper that can be fetch
 68 |    * @param {Function} params.emitter - The function used to Emit event
 69 |    * @emits  VASTParser#VAST-resolving
 70 |    * @emits  VASTParser#VAST-resolved
 71 |    * @return {Promise}
 72 |    */
 73 |   async fetchVAST({
 74 |     url,
 75 |     maxWrapperDepth,
 76 |     emitter,
 77 |     wrapperDepth = 0,
 78 |     previousUrl = null,
 79 |     wrapperAd = null,
 80 |   }) {
 81 |     const timeBeforeGet = Date.now();
 82 | 
 83 |     // Process url with defined filter
 84 |     this.URLTemplateFilters.forEach((filter) => {
 85 |       url = filter(url);
 86 |     });
 87 | 
 88 |     emitter('VAST-resolving', {
 89 |       url,
 90 |       previousUrl,
 91 |       wrapperDepth,
 92 |       maxWrapperDepth,
 93 |       timeout: this.fetchingOptions.timeout,
 94 |       wrapperAd,
 95 |     });
 96 | 
 97 |     const data = await this.urlHandler.get(url, this.fetchingOptions);
 98 |     const requestDuration = Math.round(Date.now() - timeBeforeGet);
 99 | 
100 |     emitter('VAST-resolved', {
101 |       url,
102 |       previousUrl,
103 |       wrapperDepth,
104 |       error: data?.error || null,
105 |       duration: requestDuration,
106 |       statusCode: data?.statusCode || null,
107 |       ...data?.details,
108 |     });
109 |     updateEstimatedBitrate(data?.details?.byteLength, requestDuration);
110 | 
111 |     if (data.error) {
112 |       throw new Error(data.error);
113 |     } else {
114 |       return data.xml;
115 |     }
116 |   }
117 | }
118 | 


--------------------------------------------------------------------------------
/src/fetcher/url_handler.js:
--------------------------------------------------------------------------------
 1 | import { DEFAULT_TIMEOUT } from './consts';
 2 | import { util } from '../util/util';
 3 | 
 4 | /**
 5 |  * Return an object containing an XML document.
 6 |  * in addition to the byteLength and the statusCode of the response.
 7 |  * @param {Object} response the response of the fetch request.
 8 |  * @returns {Object}
 9 |  */
10 | async function handleResponse(response) {
11 |   const textXml = await response.text();
12 |   let parser;
13 | 
14 |   if (!util.isBrowserEnvironment()) {
15 |     const xmlDom = await import('@xmldom/xmldom');
16 |     parser = new xmlDom.DOMParser();
17 |   } else {
18 |     parser = new DOMParser();
19 |   }
20 | 
21 |   const xml = parser.parseFromString(textXml, 'text/xml');
22 |   return {
23 |     xml,
24 |     details: {
25 |       byteLength: textXml.length,
26 |       statusCode: response.status,
27 |       rawXml: textXml,
28 |     },
29 |   };
30 | }
31 | 
32 | /**
33 |  * Return a custom message if an error occured
34 |  * @param {Object} response The response of fetch request
35 |  * @returns {String | null}
36 |  */
37 | function handleError(response) {
38 |   if (
39 |     util.isBrowserEnvironment() &&
40 |     window.location.protocol === 'https:' &&
41 |     response.url.includes('http://')
42 |   ) {
43 |     return 'URLHandler: Cannot go from HTTPS to HTTP.';
44 |   }
45 | 
46 |   if (response.status !== 200 || !response.ok) {
47 |     return `URLHandler: ${response.statusText} (${response.status})`;
48 |   }
49 |   return null;
50 | }
51 | 
52 | async function get(url, options) {
53 |   try {
54 |     // fetch does not have "timeout" option, we are using AbortController
55 |     // to abort the request if it reach the timeout.
56 |     const controller = new AbortController();
57 |     const timer = setTimeout(() => {
58 |       controller.abort();
59 |       throw new Error(
60 |         `URLHandler: Request timed out after ${
61 |           options.timeout || DEFAULT_TIMEOUT
62 |         } ms (408)`
63 |       );
64 |     }, options.timeout || DEFAULT_TIMEOUT);
65 | 
66 |     const response = await fetch(url, {
67 |       ...options,
68 |       signal: controller.signal,
69 |       credentials: options.withCredentials ? 'include' : 'omit',
70 |     }).finally(() => {
71 |       clearTimeout(timer);
72 |     });
73 | 
74 |     const error = handleError(response);
75 |     if (error) {
76 |       return { error: new Error(error), statusCode: response.status };
77 |     }
78 |     return handleResponse(response);
79 |   } catch (error) {
80 |     return {
81 |       error,
82 |       statusCode: error.name === 'AbortError' ? 408 : null,
83 |     };
84 |   }
85 | }
86 | 
87 | export const urlHandler = {
88 |   get,
89 | };
90 | 


--------------------------------------------------------------------------------
/src/icon.js:
--------------------------------------------------------------------------------
 1 | export function createIcon() {
 2 |   return {
 3 |     program: null,
 4 |     height: 0,
 5 |     width: 0,
 6 |     xPosition: 0,
 7 |     yPosition: 0,
 8 |     apiFramework: null,
 9 |     offset: null,
10 |     duration: 0,
11 |     type: null,
12 |     staticResource: null,
13 |     htmlResource: null,
14 |     iframeResource: null,
15 |     pxratio: '1',
16 |     iconClickThroughURLTemplate: null,
17 |     iconClickTrackingURLTemplates: [],
18 |     iconViewTrackingURLTemplate: null,
19 |     iconClickFallbackImages: [],
20 |     altText: null,
21 |     hoverText: null,
22 |   };
23 | }
24 | 


--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
1 | import { VASTParser } from './parser/vast_parser.js';
2 | import { VASTClient } from './vast_client.js';
3 | import { VASTTracker } from './vast_tracker.js';
4 | import { parseDuration } from './parser/parser_utils.js';
5 | 
6 | export { VASTClient, VASTParser, VASTTracker, parseDuration };
7 | 


--------------------------------------------------------------------------------
/src/interactive_creative_file.js:
--------------------------------------------------------------------------------
 1 | import { parserUtils } from './parser/parser_utils';
 2 | 
 3 | export function createInteractiveCreativeFile(
 4 |   interactiveCreativeAttributes = {}
 5 | ) {
 6 |   return {
 7 |     type: interactiveCreativeAttributes.type || null,
 8 |     apiFramework: interactiveCreativeAttributes.apiFramework || null,
 9 |     variableDuration: parserUtils.parseBoolean(
10 |       interactiveCreativeAttributes.variableDuration
11 |     ),
12 |     fileURL: null,
13 |   };
14 | }
15 | 


--------------------------------------------------------------------------------
/src/media_file.js:
--------------------------------------------------------------------------------
 1 | export function createMediaFile() {
 2 |   return {
 3 |     id: null,
 4 |     fileURL: null,
 5 |     fileSize: 0,
 6 |     deliveryType: 'progressive',
 7 |     mimeType: null,
 8 |     mediaType: null,
 9 |     codec: null,
10 |     bitrate: 0,
11 |     minBitrate: 0,
12 |     maxBitrate: 0,
13 |     width: 0,
14 |     height: 0,
15 |     apiFramework: null, // @deprecated in VAST 4.1. <InteractiveCreativeFile> should be used instead.
16 |     scalable: null,
17 |     maintainAspectRatio: null,
18 |   };
19 | }
20 | 


--------------------------------------------------------------------------------
/src/mezzanine.js:
--------------------------------------------------------------------------------
 1 | export function createMezzanine() {
 2 |   return {
 3 |     id: null,
 4 |     fileURL: null,
 5 |     delivery: null,
 6 |     codec: null,
 7 |     type: null,
 8 |     width: 0,
 9 |     height: 0,
10 |     fileSize: 0,
11 |     mediaType: '2D',
12 |   };
13 | }
14 | 


--------------------------------------------------------------------------------
/src/non_linear_ad.js:
--------------------------------------------------------------------------------
 1 | export function createNonLinearAd() {
 2 |   return {
 3 |     id: null,
 4 |     width: 0,
 5 |     height: 0,
 6 |     expandedWidth: 0,
 7 |     expandedHeight: 0,
 8 |     scalable: true,
 9 |     maintainAspectRatio: true,
10 |     minSuggestedDuration: 0,
11 |     apiFramework: 'static',
12 |     adType: 'nonLinearAd',
13 |     type: null,
14 |     staticResource: null,
15 |     htmlResource: null,
16 |     iframeResource: null,
17 |     nonlinearClickThroughURLTemplate: null,
18 |     nonlinearClickTrackingURLTemplates: [],
19 |     adParameters: null,
20 |   };
21 | }
22 | 
23 | export function isNonLinearAd(ad) {
24 |   return ad.adType === 'nonLinearAd';
25 | }
26 | 


--------------------------------------------------------------------------------
/src/parser/bitrate.js:
--------------------------------------------------------------------------------
 1 | /*
 2 |   We decided to put the estimated bitrate separated from classes to persist it between different instances of vast client/parser
 3 | */
 4 | 
 5 | let estimatedBitrateCount = 0;
 6 | export let estimatedBitrate = 0;
 7 | 
 8 | /**
 9 |  * Calculate average estimated bitrate from the previous values and new entries
10 |  * @param {Number} byteLength - The length of the response in bytes.
11 |  * @param {Number} duration - The duration of the request in ms.
12 |  */
13 | export const updateEstimatedBitrate = (byteLength, duration) => {
14 |   if (!byteLength || !duration || byteLength <= 0 || duration <= 0) {
15 |     return;
16 |   }
17 | 
18 |   // We want the bitrate in kb/s, byteLength are in bytes and duration in ms, just need to convert the byteLength because kb/s = b/ms
19 |   const bitrate = (byteLength * 8) / duration;
20 |   estimatedBitrate =
21 |     (estimatedBitrate * estimatedBitrateCount + bitrate) /
22 |     ++estimatedBitrateCount;
23 | };
24 | 


--------------------------------------------------------------------------------
/src/parser/creative_companion_parser.js:
--------------------------------------------------------------------------------
  1 | import { createCompanionAd } from '../companion_ad';
  2 | import { createCreativeCompanion } from '../creative/creative_companion';
  3 | import { parserUtils } from './parser_utils';
  4 | 
  5 | /**
  6 |  * This module provides methods to parse a VAST CompanionAd Element.
  7 |  */
  8 | 
  9 | /**
 10 |  * Parses a CompanionAd.
 11 |  * @param  {Object} creativeElement - The VAST CompanionAd element to parse.
 12 |  * @param  {Object} creativeAttributes - The attributes of the CompanionAd (optional).
 13 |  * @return {Object} creative - The creative object.
 14 |  */
 15 | export function parseCreativeCompanion(creativeElement, creativeAttributes) {
 16 |   const creative = createCreativeCompanion(creativeAttributes);
 17 |   creative.required = creativeElement.getAttribute('required') || null;
 18 | 
 19 |   creative.variations = parserUtils
 20 |     .childrenByName(creativeElement, 'Companion')
 21 |     .map((companionResource) => {
 22 |       const companionAd = createCompanionAd(
 23 |         parserUtils.parseAttributes(companionResource)
 24 |       );
 25 | 
 26 |       companionAd.htmlResources = parserUtils
 27 |         .childrenByName(companionResource, 'HTMLResource')
 28 |         .reduce((urls, resource) => {
 29 |           const url = parserUtils.parseNodeText(resource);
 30 |           return url ? urls.concat(url) : urls;
 31 |         }, []);
 32 | 
 33 |       companionAd.iframeResources = parserUtils
 34 |         .childrenByName(companionResource, 'IFrameResource')
 35 |         .reduce((urls, resource) => {
 36 |           const url = parserUtils.parseNodeText(resource);
 37 |           return url ? urls.concat(url) : urls;
 38 |         }, []);
 39 | 
 40 |       companionAd.staticResources = parserUtils
 41 |         .childrenByName(companionResource, 'StaticResource')
 42 |         .reduce((urls, resource) => {
 43 |           const url = parserUtils.parseNodeText(resource);
 44 |           return url
 45 |             ? urls.concat({
 46 |                 url,
 47 |                 creativeType: resource.getAttribute('creativeType') || null,
 48 |               })
 49 |             : urls;
 50 |         }, []);
 51 | 
 52 |       companionAd.altText =
 53 |         parserUtils.parseNodeText(
 54 |           parserUtils.childByName(companionResource, 'AltText')
 55 |         ) || null;
 56 | 
 57 |       const trackingEventsElement = parserUtils.childByName(
 58 |         companionResource,
 59 |         'TrackingEvents'
 60 |       );
 61 |       if (trackingEventsElement) {
 62 |         parserUtils
 63 |           .childrenByName(trackingEventsElement, 'Tracking')
 64 |           .forEach((trackingElement) => {
 65 |             const eventName = trackingElement.getAttribute('event');
 66 |             const trackingURLTemplate =
 67 |               parserUtils.parseNodeText(trackingElement);
 68 |             if (eventName && trackingURLTemplate) {
 69 |               if (!Array.isArray(companionAd.trackingEvents[eventName])) {
 70 |                 companionAd.trackingEvents[eventName] = [];
 71 |               }
 72 |               companionAd.trackingEvents[eventName].push(trackingURLTemplate);
 73 |             }
 74 |           });
 75 |       }
 76 | 
 77 |       companionAd.companionClickTrackingURLTemplates = parserUtils
 78 |         .childrenByName(companionResource, 'CompanionClickTracking')
 79 |         .map((clickTrackingElement) => {
 80 |           return {
 81 |             id: clickTrackingElement.getAttribute('id') || null,
 82 |             url: parserUtils.parseNodeText(clickTrackingElement),
 83 |           };
 84 |         });
 85 | 
 86 |       companionAd.companionClickThroughURLTemplate =
 87 |         parserUtils.parseNodeText(
 88 |           parserUtils.childByName(companionResource, 'CompanionClickThrough')
 89 |         ) || null;
 90 | 
 91 |       const adParametersElement = parserUtils.childByName(
 92 |         companionResource,
 93 |         'AdParameters'
 94 |       );
 95 |       if (adParametersElement) {
 96 |         companionAd.adParameters = {
 97 |           value: parserUtils.parseNodeText(adParametersElement),
 98 |           xmlEncoded: adParametersElement.getAttribute('xmlEncoded') || null,
 99 |         };
100 |       }
101 | 
102 |       return companionAd;
103 |     });
104 | 
105 |   return creative;
106 | }
107 | 


--------------------------------------------------------------------------------
/src/parser/creative_non_linear_parser.js:
--------------------------------------------------------------------------------
  1 | import { createCreativeNonLinear } from '../creative/creative_non_linear';
  2 | import { createNonLinearAd } from '../non_linear_ad';
  3 | import { parserUtils } from './parser_utils';
  4 | 
  5 | /**
  6 |  * This module provides methods to parse a VAST NonLinear Element.
  7 |  */
  8 | 
  9 | /**
 10 |  * Parses a NonLinear element.
 11 |  * @param  {any} creativeElement - The VAST NonLinear element to parse.
 12 |  * @param  {any} creativeAttributes - The attributes of the NonLinear (optional).
 13 |  * @return {Object} creative - The CreativeNonLinear object.
 14 |  */
 15 | export function parseCreativeNonLinear(creativeElement, creativeAttributes) {
 16 |   const creative = createCreativeNonLinear(creativeAttributes);
 17 |   parserUtils
 18 |     .childrenByName(creativeElement, 'TrackingEvents')
 19 |     .forEach((trackingEventsElement) => {
 20 |       let eventName, trackingURLTemplate;
 21 |       parserUtils
 22 |         .childrenByName(trackingEventsElement, 'Tracking')
 23 |         .forEach((trackingElement) => {
 24 |           eventName = trackingElement.getAttribute('event');
 25 |           trackingURLTemplate = parserUtils.parseNodeText(trackingElement);
 26 | 
 27 |           if (eventName && trackingURLTemplate) {
 28 |             if (!Array.isArray(creative.trackingEvents[eventName])) {
 29 |               creative.trackingEvents[eventName] = [];
 30 |             }
 31 |             creative.trackingEvents[eventName].push(trackingURLTemplate);
 32 |           }
 33 |         });
 34 |     });
 35 | 
 36 |   parserUtils
 37 |     .childrenByName(creativeElement, 'NonLinear')
 38 |     .forEach((nonlinearResource) => {
 39 |       const nonlinearAd = createNonLinearAd();
 40 |       nonlinearAd.id = nonlinearResource.getAttribute('id') || null;
 41 |       nonlinearAd.width = nonlinearResource.getAttribute('width');
 42 |       nonlinearAd.height = nonlinearResource.getAttribute('height');
 43 |       nonlinearAd.expandedWidth =
 44 |         nonlinearResource.getAttribute('expandedWidth');
 45 |       nonlinearAd.expandedHeight =
 46 |         nonlinearResource.getAttribute('expandedHeight');
 47 |       nonlinearAd.scalable = parserUtils.parseBoolean(
 48 |         nonlinearResource.getAttribute('scalable')
 49 |       );
 50 |       nonlinearAd.maintainAspectRatio = parserUtils.parseBoolean(
 51 |         nonlinearResource.getAttribute('maintainAspectRatio')
 52 |       );
 53 |       nonlinearAd.minSuggestedDuration = parserUtils.parseDuration(
 54 |         nonlinearResource.getAttribute('minSuggestedDuration')
 55 |       );
 56 |       nonlinearAd.apiFramework = nonlinearResource.getAttribute('apiFramework');
 57 | 
 58 |       parserUtils
 59 |         .childrenByName(nonlinearResource, 'HTMLResource')
 60 |         .forEach((htmlElement) => {
 61 |           nonlinearAd.type =
 62 |             htmlElement.getAttribute('creativeType') || 'text/html';
 63 |           nonlinearAd.htmlResource = parserUtils.parseNodeText(htmlElement);
 64 |         });
 65 | 
 66 |       parserUtils
 67 |         .childrenByName(nonlinearResource, 'IFrameResource')
 68 |         .forEach((iframeElement) => {
 69 |           nonlinearAd.type = iframeElement.getAttribute('creativeType') || 0;
 70 |           nonlinearAd.iframeResource = parserUtils.parseNodeText(iframeElement);
 71 |         });
 72 | 
 73 |       parserUtils
 74 |         .childrenByName(nonlinearResource, 'StaticResource')
 75 |         .forEach((staticElement) => {
 76 |           nonlinearAd.type = staticElement.getAttribute('creativeType') || 0;
 77 |           nonlinearAd.staticResource = parserUtils.parseNodeText(staticElement);
 78 |         });
 79 | 
 80 |       const adParamsElement = parserUtils.childByName(
 81 |         nonlinearResource,
 82 |         'AdParameters'
 83 |       );
 84 |       if (adParamsElement) {
 85 |         nonlinearAd.adParameters = {
 86 |           value: parserUtils.parseNodeText(adParamsElement),
 87 |           xmlEncoded: adParamsElement.getAttribute('xmlEncoded') || null,
 88 |         };
 89 |       }
 90 | 
 91 |       nonlinearAd.nonlinearClickThroughURLTemplate = parserUtils.parseNodeText(
 92 |         parserUtils.childByName(nonlinearResource, 'NonLinearClickThrough')
 93 |       );
 94 |       parserUtils
 95 |         .childrenByName(nonlinearResource, 'NonLinearClickTracking')
 96 |         .forEach((clickTrackingElement) => {
 97 |           nonlinearAd.nonlinearClickTrackingURLTemplates.push({
 98 |             id: clickTrackingElement.getAttribute('id') || null,
 99 |             url: parserUtils.parseNodeText(clickTrackingElement),
100 |           });
101 |         });
102 | 
103 |       creative.variations.push(nonlinearAd);
104 |     });
105 | 
106 |   return creative;
107 | }
108 | 


--------------------------------------------------------------------------------
/src/parser/creatives_parser.js:
--------------------------------------------------------------------------------
  1 | import { parseCreativeCompanion } from './creative_companion_parser';
  2 | import { parseCreativeLinear } from './creative_linear_parser';
  3 | import { parseCreativeNonLinear } from './creative_non_linear_parser';
  4 | import { parseExtensions } from './extensions_parser';
  5 | import { parserUtils } from './parser_utils';
  6 | 
  7 | /**
  8 |  * Parses the creatives from the Creatives Node.
  9 |  * @param  {any} creativeNodes - The creative nodes to parse.
 10 |  * @return {Array<Creative>} - An array of Creative objects.
 11 |  */
 12 | export function parseCreatives(creativeNodes) {
 13 |   const creatives = [];
 14 | 
 15 |   creativeNodes.forEach((creativeElement) => {
 16 |     const creativeAttributes = {
 17 |       id: creativeElement.getAttribute('id') || null,
 18 |       adId: parseCreativeAdIdAttribute(creativeElement),
 19 |       sequence: creativeElement.getAttribute('sequence') || null,
 20 |       apiFramework: creativeElement.getAttribute('apiFramework') || null,
 21 |     };
 22 | 
 23 |     const universalAdIds = [];
 24 |     const universalAdIdElements = parserUtils.childrenByName(
 25 |       creativeElement,
 26 |       'UniversalAdId'
 27 |     );
 28 |     universalAdIdElements.forEach((universalAdIdElement) => {
 29 |       const universalAdId = {
 30 |         idRegistry:
 31 |           universalAdIdElement.getAttribute('idRegistry') || 'unknown',
 32 |         value: parserUtils.parseNodeText(universalAdIdElement),
 33 |       };
 34 |       universalAdIds.push(universalAdId);
 35 |     });
 36 | 
 37 |     let creativeExtensions;
 38 |     const creativeExtensionsElement = parserUtils.childByName(
 39 |       creativeElement,
 40 |       'CreativeExtensions'
 41 |     );
 42 |     if (creativeExtensionsElement) {
 43 |       creativeExtensions = parseExtensions(
 44 |         parserUtils.childrenByName(
 45 |           creativeExtensionsElement,
 46 |           'CreativeExtension'
 47 |         )
 48 |       );
 49 |     }
 50 | 
 51 |     for (const creativeTypeElementKey in creativeElement.childNodes) {
 52 |       const creativeTypeElement =
 53 |         creativeElement.childNodes[creativeTypeElementKey];
 54 |       let parsedCreative;
 55 | 
 56 |       switch (creativeTypeElement.nodeName) {
 57 |         case 'Linear':
 58 |           parsedCreative = parseCreativeLinear(
 59 |             creativeTypeElement,
 60 |             creativeAttributes
 61 |           );
 62 |           break;
 63 |         case 'NonLinearAds':
 64 |           parsedCreative = parseCreativeNonLinear(
 65 |             creativeTypeElement,
 66 |             creativeAttributes
 67 |           );
 68 |           break;
 69 |         case 'CompanionAds':
 70 |           parsedCreative = parseCreativeCompanion(
 71 |             creativeTypeElement,
 72 |             creativeAttributes
 73 |           );
 74 |           break;
 75 |       }
 76 | 
 77 |       if (parsedCreative) {
 78 |         if (universalAdIds) {
 79 |           parsedCreative.universalAdIds = universalAdIds;
 80 |         }
 81 | 
 82 |         if (creativeExtensions) {
 83 |           parsedCreative.creativeExtensions = creativeExtensions;
 84 |         }
 85 |         creatives.push(parsedCreative);
 86 |       }
 87 |     }
 88 |   });
 89 |   return creatives;
 90 | }
 91 | 
 92 | /**
 93 |  * Parses the creative adId Attribute.
 94 |  * @param  {any} creativeElement - The creative element to retrieve the adId from.
 95 |  * @return {String|null}
 96 |  */
 97 | function parseCreativeAdIdAttribute(creativeElement) {
 98 |   return (
 99 |     creativeElement.getAttribute('AdID') || // VAST 2 spec
100 |     creativeElement.getAttribute('adID') || // VAST 3 spec
101 |     creativeElement.getAttribute('adId') || // VAST 4 spec
102 |     null
103 |   );
104 | }
105 | 


--------------------------------------------------------------------------------
/src/parser/extensions_parser.js:
--------------------------------------------------------------------------------
 1 | import { createExtension, isEmptyExtension } from '../extension';
 2 | import { parserUtils } from './parser_utils';
 3 | 
 4 | /**
 5 |  * Parses an array of Extension elements.
 6 |  * @param  {Node[]} extensions - The array of extensions to parse.
 7 |  * @param  {String} type - The type of extensions to parse.(Ad|Creative)
 8 |  * @return {AdExtension[]|CreativeExtension[]} - The nodes parsed to extensions
 9 |  */
10 | export function parseExtensions(extensions) {
11 |   const exts = [];
12 |   extensions.forEach((extNode) => {
13 |     const ext = _parseExtension(extNode);
14 | 
15 |     if (ext) {
16 |       exts.push(ext);
17 |     }
18 |   });
19 |   return exts;
20 | }
21 | 
22 | /**
23 |  * Parses an extension child node
24 |  * @param {Node} extNode - The extension node to parse
25 |  * @return {AdExtension|CreativeExtension|null} - The node parsed to extension
26 |  */
27 | function _parseExtension(extNode) {
28 |   // Ignore comments
29 |   if (extNode.nodeName === '#comment') return null;
30 | 
31 |   const ext = createExtension();
32 | 
33 |   const extNodeAttrs = extNode.attributes;
34 |   const childNodes = extNode.childNodes;
35 | 
36 |   ext.name = extNode.nodeName;
37 | 
38 |   // Parse attributes
39 |   if (extNode.attributes) {
40 |     for (const extNodeAttrKey in extNodeAttrs) {
41 |       if (extNodeAttrs.hasOwnProperty(extNodeAttrKey)) {
42 |         const extNodeAttr = extNodeAttrs[extNodeAttrKey];
43 | 
44 |         if (extNodeAttr.nodeName && extNodeAttr.nodeValue) {
45 |           ext.attributes[extNodeAttr.nodeName] = extNodeAttr.nodeValue;
46 |         }
47 |       }
48 |     }
49 |   }
50 | 
51 |   // Parse all children
52 |   for (const childNodeKey in childNodes) {
53 |     if (childNodes.hasOwnProperty(childNodeKey)) {
54 |       const parsedChild = _parseExtension(childNodes[childNodeKey]);
55 |       if (parsedChild) {
56 |         ext.children.push(parsedChild);
57 |       }
58 |     }
59 |   }
60 | 
61 |   /*
62 |     Only parse value of Nodes with only eather no children or only a cdata or text
63 |     to avoid useless parsing that would result to a concatenation of all children
64 |   */
65 |   if (
66 |     ext.children.length === 0 ||
67 |     (ext.children.length === 1 &&
68 |       ['#cdata-section', '#text'].indexOf(ext.children[0].name) >= 0)
69 |   ) {
70 |     const txt = parserUtils.parseNodeText(extNode);
71 | 
72 |     if (txt !== '') {
73 |       ext.value = txt;
74 |     }
75 | 
76 |     // Remove the children if it's a cdata or simply text to avoid useless children
77 |     ext.children = [];
78 |   }
79 | 
80 |   // Only return not empty objects to not pollute extentions
81 |   return isEmptyExtension(ext) ? null : ext;
82 | }
83 | 


--------------------------------------------------------------------------------
/src/parser/parser_verification.js:
--------------------------------------------------------------------------------
  1 | import { requiredValues } from '../util/requiredValues';
  2 | import { parserUtils } from './parser_utils';
  3 | 
  4 | /**
  5 |  * Verify node required values and also verify recursively all his child nodes.
  6 |  * Trigger warnings if a node required value is missing.
  7 |  * @param  {Node} node - The node element.
  8 |  * @param  {Function} emit - Emit function used to trigger Warning event.
  9 |  * @emits  VASTParser#VAST-warning
 10 |  * @param  {undefined|Boolean} [isAdInline] - Passed recursively to itself. True if the node is contained inside a inLine tag.
 11 |  */
 12 | function verifyRequiredValues(node, emit, isAdInline) {
 13 |   if (!node || !node.nodeName) {
 14 |     return;
 15 |   }
 16 |   if (node.nodeName === 'InLine') {
 17 |     isAdInline = true;
 18 |   }
 19 |   verifyRequiredAttributes(node, emit);
 20 | 
 21 |   if (hasSubElements(node)) {
 22 |     verifyRequiredSubElements(node, emit, isAdInline);
 23 |     for (let i = 0; i < node.children.length; i++) {
 24 |       verifyRequiredValues(node.children[i], emit, isAdInline);
 25 |     }
 26 |   } else if (parserUtils.parseNodeText(node).length === 0) {
 27 |     emitMissingValueWarning(
 28 |       { name: node.nodeName, parentName: node.parentNode.nodeName },
 29 |       emit
 30 |     );
 31 |   }
 32 | }
 33 | 
 34 | /**
 35 |  * Verify and trigger warnings if node required attributes are not set.
 36 |  * @param  {Node} node - The node element.
 37 |  * @param  {Function} emit - Emit function used to trigger Warning event.
 38 |  * @emits  VASTParser#VAST-warning
 39 |  */
 40 | function verifyRequiredAttributes(node, emit) {
 41 |   if (
 42 |     !requiredValues[node.nodeName] ||
 43 |     !requiredValues[node.nodeName].attributes
 44 |   ) {
 45 |     return;
 46 |   }
 47 |   const requiredAttributes = requiredValues[node.nodeName].attributes;
 48 |   const missingAttributes = requiredAttributes.filter(
 49 |     (attributeName) => !node.getAttribute(attributeName)
 50 |   );
 51 |   if (missingAttributes.length > 0) {
 52 |     emitMissingValueWarning(
 53 |       {
 54 |         name: node.nodeName,
 55 |         parentName: node.parentNode.nodeName,
 56 |         attributes: missingAttributes,
 57 |       },
 58 |       emit
 59 |     );
 60 |   }
 61 | }
 62 | 
 63 | /**
 64 |  * Verify and trigger warnings if node required sub element are not set.
 65 |  * @param  {Node} node - The node element
 66 |  * @param  {Boolean} isAdInline - True if node is contained in a inline
 67 |  * @param  {Function} emit - Emit function used to trigger Warning event.
 68 |  * @emits  VASTParser#VAST-warning
 69 |  */
 70 | function verifyRequiredSubElements(node, emit, isAdInline) {
 71 |   const required = requiredValues[node.nodeName];
 72 |   // Do not verify subelement if node is a child of wrapper, but verify it if node is the Wrapper itself
 73 |   // Wrapper child have no required subElement. (Only InLine does)
 74 |   const isInWrapperButNotWrapperItself =
 75 |     !isAdInline && node.nodeName !== 'Wrapper';
 76 |   if (!required || isInWrapperButNotWrapperItself) {
 77 |     return;
 78 |   }
 79 | 
 80 |   if (required.subElements) {
 81 |     const requiredSubElements = required.subElements;
 82 |     const missingSubElements = requiredSubElements.filter(
 83 |       (subElementName) => !parserUtils.childByName(node, subElementName)
 84 |     );
 85 | 
 86 |     if (missingSubElements.length > 0) {
 87 |       emitMissingValueWarning(
 88 |         {
 89 |           name: node.nodeName,
 90 |           parentName: node.parentNode.nodeName,
 91 |           subElements: missingSubElements,
 92 |         },
 93 |         emit
 94 |       );
 95 |     }
 96 |   }
 97 | 
 98 |   // When InLine format is used some nodes (i.e <NonLinear>, <Companion>, or <Icon>)
 99 |   // require at least one of the following resources: StaticResource, IFrameResource, HTMLResource
100 |   if (!isAdInline || !required.oneOfinLineResources) {
101 |     return;
102 |   }
103 | 
104 |   const resourceFound = required.oneOfinLineResources.some((resource) => {
105 |     return parserUtils.childByName(node, resource);
106 |   });
107 |   if (!resourceFound) {
108 |     emitMissingValueWarning(
109 |       {
110 |         name: node.nodeName,
111 |         parentName: node.parentNode.nodeName,
112 |         oneOfResources: required.oneOfinLineResources,
113 |       },
114 |       emit
115 |     );
116 |   }
117 | }
118 | 
119 | /**
120 |  * Check if a node has sub elements.
121 |  * @param  {Node} node - The node element.
122 |  * @returns {Boolean}
123 |  */
124 | function hasSubElements(node) {
125 |   return node.children && node.children.length !== 0;
126 | }
127 | 
128 | /**
129 |  * Trigger Warning if a element is empty or has missing attributes/subelements/resources
130 |  * @param  {Object} missingElement - Object containing missing elements and values
131 |  * @param  {String} missingElement.name - The name of element containing missing values
132 |  * @param  {String} missingElement.parentName - The parent name of element containing missing values
133 |  * @param  {Array} missingElement.attributes - The array of missing attributes
134 |  * @param  {Array} missingElement.subElements - The array of missing sub elements
135 |  * @param  {Array} missingElement.oneOfResources - The array of resources in which at least one must be provided by the element
136 |  * @param  {Function} emit - Emit function used to trigger Warning event.
137 |  * @emits  VastParser#VAST-warning
138 |  */
139 | function emitMissingValueWarning(
140 |   { name, parentName, attributes, subElements, oneOfResources },
141 |   emit
142 | ) {
143 |   let message = `Element '${name}'`;
144 |   if (attributes) {
145 |     message += ` missing required attribute(s) '${attributes.join(', ')}' `;
146 |   } else if (subElements) {
147 |     message += ` missing required sub element(s) '${subElements.join(', ')}' `;
148 |   } else if (oneOfResources) {
149 |     message += ` must provide one of the following '${oneOfResources.join(
150 |       ', '
151 |     )}' `;
152 |   } else {
153 |     message += ` is empty`;
154 |   }
155 | 
156 |   emit('VAST-warning', {
157 |     message,
158 |     parentElement: parentName,
159 |     specVersion: 4.1,
160 |   });
161 | }
162 | 
163 | export const parserVerification = {
164 |   verifyRequiredValues,
165 |   hasSubElements,
166 |   emitMissingValueWarning,
167 |   verifyRequiredAttributes,
168 |   verifyRequiredSubElements,
169 | };
170 | 


--------------------------------------------------------------------------------
/src/util/event_emitter.js:
--------------------------------------------------------------------------------
  1 | export class EventEmitter {
  2 |   constructor() {
  3 |     this._handlers = [];
  4 |   }
  5 | 
  6 |   /**
  7 |    * Adds the event name and handler function to the end of the handlers array.
  8 |    * No checks are made to see if the handler has already been added.
  9 |    * Multiple calls passing the same combination of event name and handler will result in the handler being added,
 10 |    * and called, multiple times.
 11 |    * @param {String} event
 12 |    * @param {Function} handler
 13 |    * @returns {EventEmitter}
 14 |    */
 15 |   on(event, handler) {
 16 |     if (typeof handler !== 'function') {
 17 |       throw new TypeError(
 18 |         `The handler argument must be of type Function. Received type ${typeof handler}`
 19 |       );
 20 |     }
 21 |     if (!event) {
 22 |       throw new TypeError(
 23 |         `The event argument must be of type String. Received type ${typeof event}`
 24 |       );
 25 |     }
 26 |     this._handlers.push({
 27 |       event,
 28 |       handler,
 29 |     });
 30 | 
 31 |     return this;
 32 |   }
 33 | 
 34 |   /**
 35 |    * Adds a one-time handler function for the named event.
 36 |    * The next time event is triggered, this handler is removed and then invoked.
 37 |    * @param {String} event
 38 |    * @param {Function} handler
 39 |    * @returns {EventEmitter}
 40 |    */
 41 |   once(event, handler) {
 42 |     return this.on(event, onceWrap(this, event, handler));
 43 |   }
 44 | 
 45 |   /**
 46 |    * Removes all instances for the specified handler from the handler array for the named event.
 47 |    * @param {String} event
 48 |    * @param {Function} handler
 49 |    * @returns {EventEmitter}
 50 |    */
 51 |   off(event, handler) {
 52 |     this._handlers = this._handlers.filter((item) => {
 53 |       return item.event !== event || item.handler !== handler;
 54 |     });
 55 | 
 56 |     return this;
 57 |   }
 58 | 
 59 |   /**
 60 |    * Synchronously calls each of the handlers registered for the named event,
 61 |    * in the order they were registered, passing the supplied arguments to each.
 62 |    * @param {String} event
 63 |    * @param  {...any} args list of arguments that will be used by the event handler
 64 |    * @returns {Boolean} true if the event had handlers, false otherwise.
 65 |    */
 66 |   emit(event, ...args) {
 67 |     let called = false;
 68 |     this._handlers.forEach((item) => {
 69 |       if (item.event === '*') {
 70 |         called = true;
 71 |         item.handler(event, ...args);
 72 |       }
 73 |       if (item.event === event) {
 74 |         called = true;
 75 |         item.handler(...args);
 76 |       }
 77 |     });
 78 |     return called;
 79 |   }
 80 | 
 81 |   /**
 82 |    * Removes all listeners, or those of the specified named event.
 83 |    * @param {String} event
 84 |    * @returns {EventEmitter}
 85 |    */
 86 |   removeAllListeners(event) {
 87 |     if (!event) {
 88 |       this._handlers = [];
 89 |       return this;
 90 |     }
 91 | 
 92 |     this._handlers = this._handlers.filter((item) => item.event !== event);
 93 |     return this;
 94 |   }
 95 | 
 96 |   /**
 97 |    * Returns the number of listeners listening to the named event.
 98 |    * @param {String} event
 99 |    * @returns {Number}
100 |    */
101 |   listenerCount(event) {
102 |     return this._handlers.filter((item) => item.event === event).length;
103 |   }
104 | 
105 |   /**
106 |    * Returns a copy of the array of listeners for the named event including those created by .once().
107 |    * @param {String} event
108 |    * @returns {Function[]}
109 |    */
110 |   listeners(event) {
111 |     return this._handlers.reduce((listeners, item) => {
112 |       if (item.event === event) {
113 |         listeners.push(item.handler);
114 |       }
115 |       return listeners;
116 |     }, []);
117 |   }
118 | 
119 |   /**
120 |    * Returns an array listing the events for which the emitter has registered handlers.
121 |    * @returns {String[]}
122 |    */
123 |   eventNames() {
124 |     return this._handlers.map((item) => item.event);
125 |   }
126 | }
127 | 
128 | function onceWrap(target, event, handler) {
129 |   const state = {
130 |     fired: false,
131 |     wrapFn: undefined,
132 |   };
133 | 
134 |   function onceWrapper(...args) {
135 |     if (!state.fired) {
136 |       target.off(event, state.wrapFn);
137 |       state.fired = true;
138 |       handler.bind(target)(...args);
139 |     }
140 |   }
141 |   state.wrapFn = onceWrapper;
142 |   return onceWrapper;
143 | }
144 | 


--------------------------------------------------------------------------------
/src/util/macros.js:
--------------------------------------------------------------------------------
 1 | export const supportedMacros = [
 2 |   'ADCATEGORIES',
 3 |   'ADCOUNT',
 4 |   'ADPLAYHEAD',
 5 |   'ADSERVINGID',
 6 |   'ADTYPE',
 7 |   'APIFRAMEWORKS',
 8 |   'APPBUNDLE',
 9 |   'ASSETURI',
10 |   'BLOCKEDADCATEGORIES',
11 |   'BREAKMAXADLENGTH',
12 |   'BREAKMAXADS',
13 |   'BREAKMAXDURATION',
14 |   'BREAKMINADLENGTH',
15 |   'BREAKMINDURATION',
16 |   'BREAKPOSITION',
17 |   'CLICKPOS',
18 |   'CLICKTYPE',
19 |   'CLIENTUA',
20 |   'CONTENTID',
21 |   'CONTENTPLAYHEAD', // @deprecated VAST 4.1
22 |   'CONTENTURI',
23 |   'DEVICEIP',
24 |   'DEVICEUA',
25 |   'DOMAIN',
26 |   'EXTENSIONS',
27 |   'GDPRCONSENT',
28 |   'IFA',
29 |   'IFATYPE',
30 |   'INVENTORYSTATE',
31 |   'LATLONG',
32 |   'LIMITADTRACKING',
33 |   'MEDIAMIME',
34 |   'MEDIAPLAYHEAD',
35 |   'OMIDPARTNER',
36 |   'PAGEURL',
37 |   'PLACEMENTTYPE',
38 |   'PLAYERCAPABILITIES',
39 |   'PLAYERSIZE',
40 |   'PLAYERSTATE',
41 |   'PODSEQUENCE',
42 |   'REGULATIONS',
43 |   'SERVERSIDE',
44 |   'SERVERUA',
45 |   'TRANSACTIONID',
46 |   'UNIVERSALADID',
47 |   'VASTVERSIONS',
48 |   'VERIFICATIONVENDORS',
49 | ];
50 | 


--------------------------------------------------------------------------------
/src/util/requiredValues.js:
--------------------------------------------------------------------------------
 1 | export const requiredValues = {
 2 |   Wrapper: {
 3 |     subElements: ['VASTAdTagURI', 'Impression'],
 4 |   },
 5 |   BlockedAdCategories: {
 6 |     attributes: ['authority'],
 7 |   },
 8 |   InLine: {
 9 |     subElements: [
10 |       'AdSystem',
11 |       'AdTitle',
12 |       'Impression',
13 |       'AdServingId',
14 |       'Creatives',
15 |     ],
16 |   },
17 |   Category: {
18 |     attributes: ['authority'],
19 |   },
20 |   Pricing: {
21 |     attributes: ['model', 'currency'],
22 |   },
23 |   Verification: {
24 |     oneOfinLineResources: ['JavaScriptResource', 'ExecutableResource'],
25 |     attributes: ['vendor'],
26 |   },
27 |   UniversalAdId: {
28 |     attributes: ['idRegistry'],
29 |   },
30 |   JavaScriptResource: {
31 |     attributes: ['apiFramework', 'browserOptional'],
32 |   },
33 |   ExecutableResource: {
34 |     attributes: ['apiFramework', 'type'],
35 |   },
36 |   Tracking: {
37 |     attributes: ['event'],
38 |   },
39 |   Creatives: {
40 |     subElements: ['Creative'],
41 |   },
42 |   Creative: {
43 |     subElements: ['UniversalAdId'],
44 |   },
45 |   Linear: {
46 |     subElements: ['MediaFiles', 'Duration'],
47 |   },
48 |   MediaFiles: {
49 |     subElements: ['MediaFile'],
50 |   },
51 |   MediaFile: {
52 |     attributes: ['delivery', 'type', 'width', 'height'],
53 |   },
54 |   Mezzanine: {
55 |     attributes: ['delivery', 'type', 'width', 'height'],
56 |   },
57 |   NonLinear: {
58 |     oneOfinLineResources: ['StaticResource', 'IFrameResource', 'HTMLResource'],
59 |     attributes: ['width', 'height'],
60 |   },
61 |   Companion: {
62 |     oneOfinLineResources: ['StaticResource', 'IFrameResource', 'HTMLResource'],
63 |     attributes: ['width', 'height'],
64 |   },
65 |   StaticResource: {
66 |     attributes: ['creativeType'],
67 |   },
68 |   Icons: {
69 |     subElements: ['Icon'],
70 |   },
71 |   Icon: {
72 |     oneOfinLineResources: ['StaticResource', 'IFrameResource', 'HTMLResource'],
73 |   },
74 | };
75 | 


--------------------------------------------------------------------------------
/src/util/storage.js:
--------------------------------------------------------------------------------
  1 | let storage = null;
  2 | 
  3 | /**
  4 |  * This Object represents a default storage to be used in case no other storage is available.
  5 |  * @constant
  6 |  * @type {Object}
  7 |  */
  8 | const DEFAULT_STORAGE = {
  9 |   data: {},
 10 |   length: 0,
 11 |   getItem(key) {
 12 |     return this.data[key];
 13 |   },
 14 |   setItem(key, value) {
 15 |     this.data[key] = value;
 16 |     this.length = Object.keys(this.data).length;
 17 |   },
 18 |   removeItem(key) {
 19 |     delete this.data[key];
 20 |     this.length = Object.keys(this.data).length;
 21 |   },
 22 |   clear() {
 23 |     this.data = {};
 24 |     this.length = 0;
 25 |   },
 26 | };
 27 | 
 28 | /**
 29 |  * This class provides an wrapper interface to the a key-value storage.
 30 |  * It uses localStorage, sessionStorage or a custom storage if none of the two is available.
 31 |  * @export
 32 |  * @class Storage
 33 |  */
 34 | export class Storage {
 35 |   /**
 36 |    * Creates an instance of Storage.
 37 |    * @constructor
 38 |    */
 39 |   constructor() {
 40 |     this.storage = this.initStorage();
 41 |   }
 42 | 
 43 |   /**
 44 |    * Provides a singleton instance of the wrapped storage.
 45 |    * @return {Object}
 46 |    */
 47 |   initStorage() {
 48 |     if (storage) {
 49 |       return storage;
 50 |     }
 51 | 
 52 |     try {
 53 |       storage =
 54 |         typeof window !== 'undefined' && window !== null
 55 |           ? window.localStorage || window.sessionStorage
 56 |           : null;
 57 |     } catch (storageError) {
 58 |       storage = null;
 59 |     }
 60 | 
 61 |     if (!storage || this.isStorageDisabled(storage)) {
 62 |       storage = DEFAULT_STORAGE;
 63 |       storage.clear();
 64 |     }
 65 | 
 66 |     return storage;
 67 |   }
 68 | 
 69 |   /**
 70 |    * Check if storage is disabled (like in certain cases with private browsing).
 71 |    * In Safari (Mac + iOS) when private browsing is ON, localStorage is read only
 72 |    * http://spin.atomicobject.com/2013/01/23/ios-private-browsing-localstorage/
 73 |    * @param {Object} testStorage - The storage to check.
 74 |    * @return {Boolean}
 75 |    */
 76 |   isStorageDisabled(testStorage) {
 77 |     const testValue = '__VASTStorage__';
 78 | 
 79 |     try {
 80 |       testStorage.setItem(testValue, testValue);
 81 |       if (testStorage.getItem(testValue) !== testValue) {
 82 |         testStorage.removeItem(testValue);
 83 |         return true;
 84 |       }
 85 |     } catch (e) {
 86 |       return true;
 87 |     }
 88 | 
 89 |     testStorage.removeItem(testValue);
 90 |     return false;
 91 |   }
 92 | 
 93 |   /**
 94 |    * Returns the value for the given key. If the key does not exist, null is returned.
 95 |    * @param  {String} key - The key to retrieve the value.
 96 |    * @return {any}
 97 |    */
 98 |   getItem(key) {
 99 |     return this.storage.getItem(key);
100 |   }
101 | 
102 |   /**
103 |    * Adds or updates the value for the given key.
104 |    * @param  {String} key - The key to modify the value.
105 |    * @param  {any} value - The value to be associated with the key.
106 |    * @return {any}
107 |    */
108 |   setItem(key, value) {
109 |     return this.storage.setItem(key, value);
110 |   }
111 | 
112 |   /**
113 |    * Removes an item for the given key.
114 |    * @param  {String} key - The key to remove the value.
115 |    * @return {any}
116 |    */
117 |   removeItem(key) {
118 |     return this.storage.removeItem(key);
119 |   }
120 | 
121 |   /**
122 |    * Removes all the items from the storage.
123 |    */
124 |   clear() {
125 |     return this.storage.clear();
126 |   }
127 | }
128 | 


--------------------------------------------------------------------------------
/src/vast_client.js:
--------------------------------------------------------------------------------
  1 | import { Storage } from './util/storage';
  2 | import { VASTParser } from './parser/vast_parser';
  3 | import { Fetcher } from './fetcher/fetcher.js';
  4 | 
  5 | /**
  6 |  * This class provides methods to fetch and parse a VAST document using VASTParser.
  7 |  * In addition it provides options to skip consecutive calls based on constraints.
  8 |  * @export
  9 |  * @class VASTClient
 10 |  */
 11 | export class VASTClient {
 12 |   /**
 13 |    * Creates an instance of VASTClient.
 14 |    * @param  {Number} cappingFreeLunch - The number of first calls to skip.
 15 |    * @param  {Number} cappingMinimumTimeInterval - The minimum time interval between two consecutive calls.
 16 |    * @param  {Storage} customStorage - A custom storage to use instead of the default one.
 17 |    * @constructor
 18 |    */
 19 |   constructor(
 20 |     cappingFreeLunch = 0,
 21 |     cappingMinimumTimeInterval = 0,
 22 |     customStorage = new Storage()
 23 |   ) {
 24 |     this.cappingFreeLunch = cappingFreeLunch;
 25 |     this.cappingMinimumTimeInterval = cappingMinimumTimeInterval;
 26 |     this.fetcher = new Fetcher();
 27 |     this.vastParser = new VASTParser({ fetcher: this.fetcher });
 28 |     this.storage = customStorage;
 29 |     // Init values if not already set
 30 |     if (this.lastSuccessfulAd === undefined) {
 31 |       this.lastSuccessfulAd = 0;
 32 |     }
 33 | 
 34 |     if (this.totalCalls === undefined) {
 35 |       this.totalCalls = 0;
 36 |     }
 37 |     if (this.totalCallsTimeout === undefined) {
 38 |       this.totalCallsTimeout = 0;
 39 |     }
 40 |   }
 41 | 
 42 |   /**
 43 |    * Adds a filter function to the array of filters which are called before fetching a VAST document.
 44 |    * @param  {function} filter - The filter function to be added at the end of the array.
 45 |    * @return {void}
 46 |    */
 47 |   addURLTemplateFilter(filter) {
 48 |     this.fetcher.addURLTemplateFilter(filter);
 49 |   }
 50 | 
 51 |   /**
 52 |    * Removes the last element of the url templates filters array.
 53 |    * @return {void}
 54 |    */
 55 |   removeLastURLTemplateFilter() {
 56 |     this.fetcher.removeLastURLTemplateFilter();
 57 |   }
 58 | 
 59 |   /**
 60 |    * Returns the number of filters of the url templates filters array.
 61 |    * @return {Number}
 62 |    */
 63 |   countURLTemplateFilters() {
 64 |     return this.fetcher.countURLTemplateFilters();
 65 |   }
 66 | 
 67 |   /**
 68 |    * Removes all the filter functions from the url templates filters array.
 69 |    * @return {void}
 70 |    */
 71 |   clearURLTemplateFilters() {
 72 |     this.fetcher.clearURLTemplateFilters();
 73 |   }
 74 | 
 75 |   getParser() {
 76 |     return this.vastParser;
 77 |   }
 78 | 
 79 |   get lastSuccessfulAd() {
 80 |     return this.storage.getItem('vast-client-last-successful-ad');
 81 |   }
 82 | 
 83 |   set lastSuccessfulAd(value) {
 84 |     this.storage.setItem('vast-client-last-successful-ad', value);
 85 |   }
 86 | 
 87 |   get totalCalls() {
 88 |     return this.storage.getItem('vast-client-total-calls');
 89 |   }
 90 | 
 91 |   set totalCalls(value) {
 92 |     this.storage.setItem('vast-client-total-calls', value);
 93 |   }
 94 | 
 95 |   get totalCallsTimeout() {
 96 |     return this.storage.getItem('vast-client-total-calls-timeout');
 97 |   }
 98 | 
 99 |   set totalCallsTimeout(value) {
100 |     this.storage.setItem('vast-client-total-calls-timeout', value);
101 |   }
102 | 
103 |   /**
104 |    * Returns a boolean indicating if there are more ads to resolve for the current parsing.
105 |    * @return {Boolean}
106 |    */
107 |   hasRemainingAds() {
108 |     return this.vastParser.remainingAds.length > 0;
109 |   }
110 | 
111 |   /**
112 |    * Resolves the next group of ads. If all is true resolves all the remaining ads.
113 |    * @param  {Boolean} all - If true all the remaining ads are resolved
114 |    * @return {Promise}
115 |    */
116 |   getNextAds(all) {
117 |     return this.vastParser.getRemainingAds(all);
118 |   }
119 | 
120 |   /**
121 |    * Parses the given xml Object into a VASTResponse.
122 |    * Returns a Promise which resolves with a fully parsed VASTResponse or rejects with an Error.
123 |    * @param {Object} xml - An object representing a vast xml document.
124 |    * @param {Object} options - An optional Object of parameters to be used in the parsing and fetching process.
125 |    * @returns {Promise}
126 |    */
127 |   parseVAST(xml, options = {}) {
128 |     this.fetcher.setOptions(options);
129 |     return this.vastParser.parseVAST(xml, options);
130 |   }
131 |   /**
132 |    * Gets a parsed VAST document for the given url, applying the skipping rules defined.
133 |    * Returns a Promise which resolves with a fully parsed VASTResponse or rejects with an Error.
134 |    * @param  {String} url - The url to use to fecth the VAST document.
135 |    * @param  {Object} options - An optional Object of parameters to be applied in the process.
136 |    * @return {Promise}
137 |    */
138 |   get(url, options = {}) {
139 |     const now = Date.now();
140 | 
141 |     // By default the client resolves only the first Ad or AdPod
142 |     if (!options.hasOwnProperty('resolveAll')) {
143 |       options.resolveAll = false;
144 |     }
145 | 
146 |     // Check totalCallsTimeout (first call + 1 hour), if older than now,
147 |     // reset totalCalls number, by this way the client will be eligible again
148 |     // for freelunch capping
149 |     if (this.totalCallsTimeout < now) {
150 |       this.totalCalls = 1;
151 |       this.totalCallsTimeout = now + 60 * 60 * 1000;
152 |     } else {
153 |       this.totalCalls++;
154 |     }
155 | 
156 |     return new Promise((resolve, reject) => {
157 |       if (this.cappingFreeLunch >= this.totalCalls) {
158 |         return reject(
159 |           new Error(
160 |             `VAST call canceled – FreeLunch capping not reached yet ${this.totalCalls}/${this.cappingFreeLunch}`
161 |           )
162 |         );
163 |       }
164 | 
165 |       const timeSinceLastCall = now - this.lastSuccessfulAd;
166 | 
167 |       // Check timeSinceLastCall to be a positive number. If not, this mean the
168 |       // previous was made in the future. We reset lastSuccessfulAd value
169 |       if (timeSinceLastCall < 0) {
170 |         this.lastSuccessfulAd = 0;
171 |       } else if (timeSinceLastCall < this.cappingMinimumTimeInterval) {
172 |         return reject(
173 |           new Error(
174 |             `VAST call canceled – (${this.cappingMinimumTimeInterval})ms minimum interval reached`
175 |           )
176 |         );
177 |       }
178 | 
179 |       this.vastParser.initParsingStatus(options);
180 |       this.fetcher.setOptions(options);
181 |       this.vastParser.rootURL = url;
182 | 
183 |       this.fetcher
184 |         .fetchVAST({
185 |           url,
186 |           emitter: this.vastParser.emit.bind(this.vastParser),
187 |           maxWrapperDepth: this.vastParser.maxWrapperDepth,
188 |         })
189 |         .then((xml) => {
190 |           options.previousUrl = url;
191 |           options.isRootVAST = true;
192 |           options.url = url;
193 |           return this.vastParser.parse(xml, options).then((resolvedAd) => {
194 |             const vastResponse = this.vastParser.buildVASTResponse(resolvedAd);
195 |             resolve(vastResponse);
196 |           });
197 |         })
198 |         .catch((err) => reject(err));
199 |     });
200 |   }
201 | }
202 | 


--------------------------------------------------------------------------------
/src/vast_response.js:
--------------------------------------------------------------------------------
1 | export function createVASTResponse({ ads, errorURLTemplates, version }) {
2 |   return {
3 |     ads: ads || [],
4 |     errorURLTemplates: errorURLTemplates || [],
5 |     version: version || null,
6 |   };
7 | }
8 | 


--------------------------------------------------------------------------------