Update remote repo

.eslintrc.js

@@ -11,12 +11,25 @@ module.exports = {
       node: {
         moduleDirectory: ['node_modules', './']
       }
+    },
+    'jsdoc': {
+      mode: 'typescript',
+      tagNamePreference: {
+        'tag constructor': 'constructor',
+        extends: 'extends',
+        method: 'method',
+        return: 'return',
+      }
     }
   },
-  extends: 'standard',
+  extends: [
+    'standard',
+    'plugin:jsdoc/recommended'
+  ],
   plugins: [
     'prebid',
-    'import'
+    'import',
+    'jsdoc'
   ],
   globals: {
     'BROWSERSTACK_USERNAME': false,
@@ -46,6 +59,24 @@ module.exports = {
     'no-undef': 2,
     'no-useless-escape': 'off',
     'no-console': 'error',
+    'jsdoc/check-types': 'off',
+    'jsdoc/newline-after-description': 'off',
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-param': 'off',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-param-name': 'off',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-property': 'off',
+    'jsdoc/require-property-description': 'off',
+    'jsdoc/require-property-name': 'off',
+    'jsdoc/require-property-type': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/require-returns-check': 'off',
+    'jsdoc/require-returns-description': 'off',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/require-yields': 'off',
+    'jsdoc/require-yields-check': 'off',
+    'jsdoc/tag-lines': 'off'
   },
   overrides: Object.keys(allowedModules).map((key) => ({
     files: key + '/**/*.js',

.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         config-file: ./.github/codeql/codeql-config.yml
@@ -57,7 +57,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -70,4 +70,4 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

gulpfile.js

@@ -158,6 +158,20 @@ function makeWebpackPkg(extraConfig = {}) {
   }
 }
 
+function buildCreative() {
+  return gulp.src(['**/*'])
+    .pipe(webpackStream(require('./webpack.creative.js')))
+    .pipe(gulp.dest('build/creative'))
+}
+
+function updateCreativeExample(cb) {
+  const CREATIVE_EXAMPLE = 'integrationExamples/gpt/x-domain/creative.html';
+  const root = require('node-html-parser').parse(fs.readFileSync(CREATIVE_EXAMPLE));
+  root.querySelectorAll('script')[0].textContent = fs.readFileSync('build/creative/creative.js')
+  fs.writeFileSync(CREATIVE_EXAMPLE, root.toString())
+  cb();
+}
+
 function getModulesListToAddInBanner(modules) {
   if (!modules || modules.length === helpers.getModuleNames().length) {
     return 'All available modules for this version.'
@@ -405,6 +419,7 @@ function watchTaskMaker(options = {}) {
   return function watch(done) {
     var mainWatcher = gulp.watch([
       'src/**/*.js',
+      'libraries/**/*.js',
       'modules/**/*.js',
     ].concat(options.alsoWatch));
 
@@ -415,8 +430,8 @@ function watchTaskMaker(options = {}) {
   }
 }
 
-const watch = watchTaskMaker({alsoWatch: ['test/**/*.js'], task: () => gulp.series(clean, gulp.parallel(lint, 'build-bundle-dev', test))});
-const watchFast = watchTaskMaker({livereload: false, task: () => gulp.series('build-bundle-dev')});
+const watch = watchTaskMaker({alsoWatch: ['test/**/*.js'], task: () => gulp.series(clean, gulp.parallel(lint, 'build-bundle-dev', test, buildCreative))});
+const watchFast = watchTaskMaker({livereload: false, task: () => gulp.parallel('build-bundle-dev', buildCreative)});
 
 // support tasks
 gulp.task(lint);
@@ -447,21 +462,23 @@ gulp.task('build-bundle-verbose', gulp.series(makeWebpackPkg({
   }
 }), gulpBundle.bind(null, false)));
 
+gulp.task('build-creative', gulp.series(buildCreative, updateCreativeExample));
+
 // public tasks (dependencies are needed for each task since they can be ran on their own)
 gulp.task('test-only', test);
 gulp.task('test-all-features-disabled', testTaskMaker({disableFeatures: require('./features.json'), oneBrowser: 'chrome', watch: false}));
-gulp.task('test', gulp.series(clean, lint, gulp.series('test-all-features-disabled', 'test-only')));
+gulp.task('test', gulp.series(clean, lint, gulp.parallel('build-creative', gulp.series('test-all-features-disabled', 'test-only'))));
 
 gulp.task('test-coverage', gulp.series(clean, testCoverage));
 gulp.task(viewCoverage);
 
 gulp.task('coveralls', gulp.series('test-coverage', coveralls));
 
-gulp.task('build', gulp.series(clean, 'build-bundle-prod'));
+gulp.task('build', gulp.series(clean, 'build-bundle-prod', 'build-creative'));
 gulp.task('build-postbid', gulp.series(escapePostbidConfig, buildPostbid));
 
 gulp.task('serve', gulp.series(clean, lint, gulp.parallel('build-bundle-dev', watch, test)));
-gulp.task('serve-fast', gulp.series(clean, gulp.parallel('build-bundle-dev', watchFast)));
+gulp.task('serve-fast', gulp.series(clean, gulp.parallel('build-bundle-dev', buildCreative, watchFast)));
 gulp.task('serve-prod', gulp.series(clean, gulp.parallel('build-bundle-prod', startLocalServer)));
 gulp.task('serve-and-test', gulp.series(clean, gulp.parallel('build-bundle-dev', watchFast, testTaskMaker({watch: true}))));
 gulp.task('serve-e2e', gulp.series(clean, 'build-bundle-prod', gulp.parallel(() => startIntegServer(), startLocalServer)));

integrationExamples/gpt/tpmn_example.html

@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Prebid.js Banner Example</title>
+    <!-- Prebid.js -->
+    <!-- <script async src="prebid.js"></script> -->
+    <script async src="../../build/dev/prebid.js"></script>
+    <!-- Google Publisher Tag -->
+    <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
+    <script>
+        var pbjs = pbjs || {};
+        pbjs.que = pbjs.que || [];
+        const customConfigObject = {
+            "buckets": [{
+                "max": 40,
+                "increment": 0.5
+            }]
+        };
+        // Prebid Banner Ad Unit
+        var adUnits = [
+        {
+            // Banner adUnit
+            code: 'banner-div-0',
+            mediaTypes: {
+                banner: {
+                    sizes: [[300, 250]], 
+                    battr: [] 
+                }
+            },
+            bids: [{
+                bidder: 'tpmn',
+                params: {
+                    inventoryId: 2, 
+                    bidFloor: 0.1, 
+                }
+            }]
+        },
+        {
+            // Video adUnit
+            code: 'video-div-1',
+            mediaTypes: {
+                video: {
+                    context: 'outstream',
+                    playerSize: [640, 480],
+                    mimes: ['video/mp4'],
+                    //playbackmethod: [2, 4, 6],
+                    api: [1, 2, 4, 6],
+                    protocols: [3, 4, 7, 8, 10],
+                    placement: 1,
+                    minduration: 0,
+                    maxduration: 60,
+                    startdelay: 0,
+                    skip: 1
+                },
+            },
+            bids: [{
+                bidder: 'tpmn',
+                params: {
+                    inventoryId: 2,
+                    bidFloor: 2.0,
+                }
+            }],
+            renderer: {
+                options: {
+                    adText : "TPMN Ad",
+                    disableCollapse : true
+                }
+            }
+        }
+        ];
+    </script>
+    <script>
+        var googletag = googletag || {};
+        googletag.cmd = googletag.cmd || [];
+        googletag.cmd.push(function () {
+            googletag.pubads().disableInitialLoad();
+        });
+
+        pbjs.que.push(function () {
+            pbjs.setConfig({
+                debug: true,
+                enableSendAllBids: false,
+                priceGranularity: customConfigObject,
+                userSync: {
+                    userIds: [{
+                        name: "pubCommonId",
+                        storage: {
+                            name: "pubcid",
+                            type: "cookie",
+                            days: 30
+                        }
+                    },{
+                        name: "unifiedId",
+                        storage: {
+                            type: "cookie",
+                            name: "unifiedid",
+                            expires: 60
+                        }
+                    }],
+                    userIdAsEids: true
+                }
+            });
+            pbjs.addAdUnits(adUnits);
+            pbjs.requestBids({ bidsBackHandler: sendAdServerRequest });
+        });
+
+        function sendAdServerRequest() {
+            if (pbjs.adserverRequestSent) return;
+
+            //Google Ad Server Use Banner
+            googletag.cmd.push(() => {
+            googletag
+                .defineSlot('/19968336/header-bid-tag-0', [300, 250], 'banner-div-0')
+                .addService(googletag.pubads());
+            googletag.pubads().enableSingleRequest();
+            googletag.enableServices();
+            });
+
+            //Direct Rendering Video
+            var highestCpmBids = pbjs.getHighestCpmBids('video-div-1');
+            console.log("highestCpmBids", highestCpmBids);
+            if (highestCpmBids.length) {
+                var doc = document.getElementById('video-div-1');
+                console.log("highestCpmBids[0].adId", highestCpmBids[0].adId);
+                pbjs.renderAd(doc, highestCpmBids[0].adId);
+            }
+
+            // googletag.cmd.push(() => {
+            // googletag
+            //     .defineSlot('/19968336/header-bid-tag-0', [640, 480], 'video-div-1')
+            //     .addService(googletag.pubads());
+            // googletag.pubads().enableSingleRequest();
+            // googletag.enableServices();
+            // });
+
+            googletag.cmd.push(function () {
+                pbjs.que.push(function () {
+                    const adUnitCodes = adUnits.map(adUnit => adUnit.code);
+                    pbjs.setTargetingForGPTAsync(adUnitCodes);
+                    googletag.pubads().refresh();
+                });
+            });
+        }
+    </script>
+
+</head>
+<body>
+    <h2>Prebid.js TPMN Banner Example</h2>
+    <div id='banner-div-0'>
+        <script>
+            googletag.cmd.push(function () {
+                googletag.display('banner-div-0');
+            });
+        </script>
+    </div>
+    <br>
+    <h2>Prebid.js TPMN Video Example</h2>
+    <div id='video-div-1' style="width: 640px; height: 480px;">
+        <script>
+             googletag.cmd.push(function () {
+                googletag.display('video-div-1');
+            });
+        </script>
+    </div>
+    <br>
+    <div id="targeting-keys"></div>
+</body>