voyagegroup · toshi17 · Jan 29, 2024 · Nov 30, 2023 · Dec 1, 2023 · Dec 1, 2023
diff --git a/.eslintrc.js b/.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',

diff --git a/.github/workflows/codeql-analysis.yml b/.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
diff --git a/integrationExamples/gpt/contxtfulRtdProvider_example.html b/integrationExamples/gpt/contxtfulRtdProvider_example.html
@@ -0,0 +1,91 @@
+<html>
+
+<head>
+  <script src="http://localhost:9999/build/dev/prebid.js" async></script>
+  <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
+  <script async>
+    const FAILSAFE_TIMEOUT = 8000;
+    const PREBID_TIMEOUT = 5000;
+
+    const bidders = [
+      {
+        bidder: 'appnexus',
+        params: {
+          placementId: 13144370
+        }
+      }
+    ];
+
+    var adUnits = [
+      {
+        code: 'div-gpt-ad-1460505748561-0',
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250], [300, 600]],
+          }
+        },
+        bids: bidders,
+      }
+    ];
+
+
+    var pbjs = pbjs || {};
+    pbjs.que = pbjs.que || [];
+    var googletag = googletag || {};
+    googletag.cmd = googletag.cmd || [];
+    googletag.cmd.push(function () {
+      googletag.pubads().disableInitialLoad();
+      googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0').addService(googletag.pubads());
+      googletag.pubads().enableSingleRequest();
+      googletag.enableServices();
+    });
+
+    pbjs.que.push(function () {
+      pbjs.setConfig({
+        debug: true,
+        realTimeData: {
+          auctionDelay: 100,
+          dataProviders: [
+            {
+              name: "contxtful",
+              waitForIt: true,
+              params: {
+                version: "Contact [email protected] for the API version",
+                customer: "Contact [email protected] for the customer ID"
+              }
+            }
+          ]
+        }
+      });
+      pbjs.addAdUnits(adUnits);
+      pbjs.requestBids({
+        bidsBackHandler: sendAdserverRequest,
+        timeout: PREBID_TIMEOUT
+      });
+    });
+
+    function sendAdserverRequest() {
+      if (pbjs.adserverRequestSent) return;
+      pbjs.adserverRequestSent = true;
+      googletag.cmd.push(function () {
+        pbjs.que.push(function () {
+          pbjs.setTargetingForGPTAsync();
+          googletag.pubads().refresh();
+        });
+      });
+    }
+
+    setTimeout(function () {
+      sendAdserverRequest();
+    }, FAILSAFE_TIMEOUT);
+
+  </script>
+</head>
+
+<body>
+  <h2>Contxtful RTD Provider</h2>
+  <div id='div-gpt-ad-1460505748561-0'></div>
+  </div>
+</body>
+
+</html>
diff --git a/libraries/cmp/cmpClient.js b/libraries/cmp/cmpClient.js
@@ -4,46 +4,46 @@ import {GreedyPromise} from '../../src/utils/promise.js';
  * @typedef {function} CMPClient
  *
  * @param {{}} params CMP parameters. Currently this is a subset of {command, callback, parameter, version}.
- * @param {bool} once if true, discard cross-frame event listeners once a reply message is received.
+ * @param {boolean} once if true, discard cross-frame event listeners once a reply message is received.
  * @returns {Promise<*>} a promise to the API's "result" - see the `mode` argument to `cmpClient` on how that's determined.
  * @property {boolean} isDirect true if the CMP is directly accessible (no postMessage required)
  * @property {() => void} close close the client; currently, this just stops listening for cross-frame messages.
  */
 
+export const MODE_MIXED = 0;
+export const MODE_RETURN = 1;
+export const MODE_CALLBACK = 2;
+
 /**
  * Returns a client function that can interface with a CMP regardless of where it's located.
  *
- * @param apiName name of the CMP api, e.g. "__gpp"
- * @param apiVersion? CMP API version
- * @param apiArgs? names of the arguments taken by the api function, in order.
- * @param callbackArgs? names of the cross-frame response payload properties that should be passed as callback arguments, in order
- * @param mode? controls the callbacks passed to the underlying API, and how the promises returned by the client are resolved.
+ * @param {object} obj
+ * @param obj.apiName name of the CMP api, e.g. "__gpp"
+ * @param [obj.apiVersion] CMP API version
+ * @param [obj.apiArgs] names of the arguments taken by the api function, in order.
+ * @param [obj.callbackArgs] names of the cross-frame response payload properties that should be passed as callback arguments, in order
+ * @param [obj.mode] controls the callbacks passed to the underlying API, and how the promises returned by the client are resolved.
  *
- *  The client behaves differently when it's provided a `callback` argument vs when it's not - for short, let's name these
- *  cases "subscriptions" and "one-shot calls" respectively:
+ * The client behaves differently when it's provided a `callback` argument vs when it's not - for short, let's name these
+ * cases "subscriptions" and "one-shot calls" respectively:
  *
- *  With `mode: MODE_MIXED` (the default), promises returned on subscriptions are resolved to undefined when the callback
- *  is first run (that is, the promise resolves when the CMP replies, but what it replies with is discarded and
- *  left for the callback to deal with). For one-shot calls, the returned promise is resolved to the API's
- *  return value when it's directly accessible, or with the result from the first (and, presumably, the only)
- *  cross-frame reply when it's not;
+ * With `mode: MODE_MIXED` (the default), promises returned on subscriptions are resolved to undefined when the callback
+ * is first run (that is, the promise resolves when the CMP replies, but what it replies with is discarded and
+ * left for the callback to deal with). For one-shot calls, the returned promise is resolved to the API's
+ * return value when it's directly accessible, or with the result from the first (and, presumably, the only)
+ * cross-frame reply when it's not;
  *
- *  With `mode: MODE_RETURN`, the returned promise always resolves to the API's return value - which is taken to be undefined
- *  when cross-frame;
+ * With `mode: MODE_RETURN`, the returned promise always resolves to the API's return value - which is taken to be undefined
+ * when cross-frame;
  *
- *  With `mode: MODE_CALLBACK`, the underlying API is expected to never directly return anything significant; instead,
- *  it should always accept a callback and - for one-shot calls - invoke it only once with the result. The client will
- *  automatically generate an appropriate callback for one-shot calls and use the result it's given to resolve
- *  the returned promise. Subscriptions are treated in the same way as MODE_MIXED.
+ * With `mode: MODE_CALLBACK`, the underlying API is expected to never directly return anything significant; instead,
+ * it should always accept a callback and - for one-shot calls - invoke it only once with the result. The client will
+ * automatically generate an appropriate callback for one-shot calls and use the result it's given to resolve
+ * the returned promise. Subscriptions are treated in the same way as MODE_MIXED.
  *
  * @param win
  * @returns {CMPClient} CMP invocation function (or null if no CMP was found).
  */
-
-export const MODE_MIXED = 0;
-export const MODE_RETURN = 1;
-export const MODE_CALLBACK = 2;
-
 export function cmpClient(
   {
     apiName,

diff --git a/libraries/ortbConverter/README.md b/libraries/ortbConverter/README.md
@@ -80,8 +80,7 @@ However, there are two restrictions (to avoid them, use the [other customization
     )   
     ```
 
-<a id="fine-customization" />
-### Fine grained customization - imp, request, bidResponse, response
+### <a id="fine-customization" /> Fine grained customization - imp, request, bidResponse, response
 
 When invoked, `toORTB({bidRequests, bidderRequest})` first loops through each request in `bidRequests`, converting them into ORTB `imp` objects.
 It then packages them into a single ORTB request, adding other parameters that are not imp-specific (such as for example `request.tmax`).
@@ -91,7 +90,7 @@ a single return value.
 
 You can customize each of these steps using the `ortbConverter` arguments `imp`, `request`, `bidResponse` and `response`:
 
-### <a id="imp" />Customizing imps: `imp(buildImp, bidRequest, context)`
+### <a id="imp" /> Customizing imps: `imp(buildImp, bidRequest, context)`
 
 Invoked once for each input `bidRequest`; should return the ORTB `imp` object to include in the request.
 The arguments are:
@@ -101,7 +100,7 @@ The arguments are:
 - `context`: a [context object](#context) that contains at least:
    - `bidderRequest`: the `bidderRequest` argument passed to `toORTB`.
 
-#### <a id="params" />Example: attaching custom bid params
+#### <a id="params" /> Example: attaching custom bid params
 
 ```javascript
 const converter = ortbConverter({
@@ -351,7 +350,7 @@ const converter = ortbConverter({
 - the `context` argument of `ortbConverter`: e.g. `ortbConverter({context: {ttl: 30}})`. This will set `context.ttl = 30` globally for the converter.
 - the `context` argument of `toORTB`: e.g. `converter.toORTB({bidRequests, bidderRequest, context: {ttl: 30}})`. This will set `context.ttl = 30` only for this request.
 
-### <a id="special-context"/> Special `context` properties
+### <a id="special-context" /> Special `context` properties
 
 For ease of use, the conversion logic gives special meaning to some context properties:
 

diff --git a/modules/.submodules.json b/modules/.submodules.json
@@ -47,7 +47,8 @@
       "adqueryIdSystem",
       "gravitoIdSystem",
       "freepassIdSystem",
-      "operaadsIdSystem"
+      "operaadsIdSystem",
+      "mygaruIdSystem"
     ],
     "adpod": [
       "freeWheelAdserverVideo",

diff --git a/modules/ad2ictionBidAdapter.js b/modules/ad2ictionBidAdapter.js
@@ -0,0 +1,59 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+
+export const BIDDER_CODE = 'ad2iction';
+export const SUPPORTED_AD_TYPES = [BANNER];
+export const API_ENDPOINT = 'https://ads.ad2iction.com/html/prebid/';
+export const API_VERSION_NUMBER = 3;
+export const COOKIE_NAME = 'ad2udid';
+
+export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
+
+export const spec = {
+  code: BIDDER_CODE,
+  aliases: ['ad2'],
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+  isBidRequestValid: (bid) => {
+    return !!bid.params.id && typeof bid.params.id === 'string';
+  },
+  buildRequests: (validBidRequests, bidderRequest) => {
+    const ids = validBidRequests.map((bid) => {
+      return { bannerId: bid.params.id, bidId: bid.bidId };
+    });
+
+    const options = {
+      contentType: 'application/json',
+      withCredentials: false,
+    };
+
+    const udid = storage.cookiesAreEnabled() && storage.getCookie(COOKIE_NAME);
+
+    const data = {
+      ids: JSON.stringify(ids),
+      ortb2: bidderRequest.ortb2,
+      refererInfo: bidderRequest.refererInfo,
+      v: API_VERSION_NUMBER,
+      udid: udid || '',
+      _: Math.round(new Date().getTime()),
+    };
+
+    return {
+      method: 'POST',
+      url: API_ENDPOINT,
+      data,
+      options,
+    };
+  },
+  interpretResponse: (serverResponse, bidRequest) => {
+    if (!Array.isArray(serverResponse.body)) {
+      return [];
+    }
+
+    const bidResponses = serverResponse.body;
+
+    return bidResponses;
+  },
+};
+
+registerBidder(spec);
diff --git a/modules/ad2ictionBidAdapter.md b/modules/ad2ictionBidAdapter.md
@@ -0,0 +1,30 @@
+# Overview
+
+**Module Name**: Ad2iction Bidder Adapter
+**Module Type**: Bidder Adapter
+**Maintainer**: [email protected]
+
+# Description
+
+The Ad2iction Bidding adapter requires setup before beginning. Please contact us on https://www.ad2iction.com.
+
+# Sample Ad Unit Config
+```
+var adUnits = [
+   // Banner adUnit
+   {
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [336, 280]]
+        }
+      },
+      bids: [{
+         bidder: 'ad2iction',
+         params: {
+           id: 'accepted-uuid'
+         }
+       }]
+   }
+];
+```