From 864fdb30b5deca34d556050072c58b061e9003ff Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 06:44:39 -0700 Subject: [PATCH 01/29] update jsdoc --- test/spec/modules/sovrnAnalyticsAdapter_spec.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/spec/modules/sovrnAnalyticsAdapter_spec.js b/test/spec/modules/sovrnAnalyticsAdapter_spec.js index 973e90abd5a..d0363eab144 100644 --- a/test/spec/modules/sovrnAnalyticsAdapter_spec.js +++ b/test/spec/modules/sovrnAnalyticsAdapter_spec.js @@ -12,8 +12,8 @@ let constants = require('src/constants.json'); /** * Emit analytics events - * @param {Array} eventArr - array of objects to define the events that will fire - * @param {object} eventObj - key is eventType, value is event + * @param {Array} eventType - array of objects to define the events that will fire + * @param {object} event - key is eventType, value is event * @param {string} auctionId - the auction id to attached to the events */ function emitEvent(eventType, event, auctionId) { From 06120e77da72b7c7623674891a0c9e948f3ffd31 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 06:48:35 -0700 Subject: [PATCH 02/29] add typedef --- test/spec/modules/rubiconBidAdapter_spec.js | 1 + 1 file changed, 1 insertion(+) diff --git a/test/spec/modules/rubiconBidAdapter_spec.js b/test/spec/modules/rubiconBidAdapter_spec.js index 62e494ea295..f49f2d79809 100644 --- a/test/spec/modules/rubiconBidAdapter_spec.js +++ b/test/spec/modules/rubiconBidAdapter_spec.js @@ -34,6 +34,7 @@ describe('the rubicon adapter', function () { logErrorSpy; /** + * @typedef {import('../../../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {Object} sizeMapConverted * @property {string} sizeId * @property {string} size From 977196cd695a39d87374d7a7f3fe7019fd25827a Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 06:55:22 -0700 Subject: [PATCH 03/29] update typedef --- test/spec/auctionmanager_spec.js | 5 +++++ test/spec/modules/cointrafficBidAdapter_spec.js | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/test/spec/auctionmanager_spec.js b/test/spec/auctionmanager_spec.js index c78a5e51f17..06d3d538596 100644 --- a/test/spec/auctionmanager_spec.js +++ b/test/spec/auctionmanager_spec.js @@ -25,6 +25,11 @@ import {deepClone} from '../../src/utils.js'; import { IMAGE as ortbNativeRequest } from 'src/native.js'; import {PrebidServer} from '../../modules/prebidServerBidAdapter/index.js'; +/** + * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest + * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + */ + var assert = require('assert'); /* use this method to test individual files instead of the whole prebid.js project */ diff --git a/test/spec/modules/cointrafficBidAdapter_spec.js b/test/spec/modules/cointrafficBidAdapter_spec.js index 79775f7b135..21f02b4f8ef 100644 --- a/test/spec/modules/cointrafficBidAdapter_spec.js +++ b/test/spec/modules/cointrafficBidAdapter_spec.js @@ -4,6 +4,11 @@ import { spec } from 'modules/cointrafficBidAdapter.js'; import { config } from 'src/config.js' import * as utils from 'src/utils.js' +/** + * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + */ + const ENDPOINT_URL = 'https://apps-pbd.ctraffic.io/pb/tmp'; describe('cointrafficBidAdapter', function () { From fe4a31ca1814a46342fbdaa6c7c1cb11f54cde5a Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 06:57:42 -0700 Subject: [PATCH 04/29] fix typo --- test/fake-server/fake-responder.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/fake-server/fake-responder.js b/test/fake-server/fake-responder.js index a44d02260e7..13bf3bc816f 100644 --- a/test/fake-server/fake-responder.js +++ b/test/fake-server/fake-responder.js @@ -9,7 +9,7 @@ const fixturesPath = path.join(__dirname, 'fixtures'); /** * Matches 'req.body' with the responseBody pair * @param {object} requestBody - `req.body` of incoming request hitting middleware 'fakeResponder'. - * @returns {objct} responseBody + * @returns {object} responseBody */ const matchResponse = function (requestBody) { let actualUuids = []; From b9a6dac865ee85a5e23b8610ab54a7944b15315d Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 07:08:49 -0700 Subject: [PATCH 05/29] update jsdoc objectguard --- libraries/objectGuard/objectGuard.js | 2 ++ libraries/objectGuard/ortbGuard.js | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/libraries/objectGuard/objectGuard.js b/libraries/objectGuard/objectGuard.js index cf3d2f38256..784c3f1444d 100644 --- a/libraries/objectGuard/objectGuard.js +++ b/libraries/objectGuard/objectGuard.js @@ -2,6 +2,8 @@ import {isData, objectTransformer, sessionedApplies} from '../../src/activities/ import {deepAccess, deepClone, deepEqual, deepSetValue} from '../../src/utils.js'; /** + * @typedef {import('../src/activities/redactor.js').TransformationRuleDef} TransformationRuleDef + * @typedef {import('../src/adapters/bidderFactory.js').TransformationRule} TransformationRule * @typedef {Object} ObjectGuard * @property {*} obj a view on the guarded object * @property {function(): void} verify a function that checks for and rolls back disallowed changes to the guarded object diff --git a/libraries/objectGuard/ortbGuard.js b/libraries/objectGuard/ortbGuard.js index 7911b378c3d..62918d55548 100644 --- a/libraries/objectGuard/ortbGuard.js +++ b/libraries/objectGuard/ortbGuard.js @@ -9,6 +9,10 @@ import { import {objectGuard, writeProtectRule} from './objectGuard.js'; import {mergeDeep} from '../../src/utils.js'; +/** + * @typedef {import('./objectGuard.js').ObjectGuard} ObjectGuard + */ + function ortb2EnrichRules(isAllowed = isActivityAllowed) { return [ { From 7429a90e7e6ac003df374b026ce152ed58f34b21 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 07:15:18 -0700 Subject: [PATCH 06/29] fix colon issue --- libraries/appnexusUtils/anKeywords.js | 2 +- libraries/keywords/keywords.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/libraries/appnexusUtils/anKeywords.js b/libraries/appnexusUtils/anKeywords.js index d6714dacc21..a6fa8d7a21e 100644 --- a/libraries/appnexusUtils/anKeywords.js +++ b/libraries/appnexusUtils/anKeywords.js @@ -78,7 +78,7 @@ export function convertKeywordStringToANMap(keyStr) { } /** - * @param {Array} kwarray: keywords as an array of strings + * @param {Array} kwarray keywords as an array of strings * @return {{}} appnexus-style keyword map */ function convertKeywordsToANMap(kwarray) { diff --git a/libraries/keywords/keywords.js b/libraries/keywords/keywords.js index 645c9c8d38f..b317bcf0c6b 100644 --- a/libraries/keywords/keywords.js +++ b/libraries/keywords/keywords.js @@ -6,7 +6,7 @@ const ORTB_KEYWORDS_PATHS = ['user.keywords'].concat( ); /** - * @param commaSeparatedKeywords: any number of either keyword arrays, or comma-separated keyword strings + * @param commaSeparatedKeywords any number of either keyword arrays, or comma-separated keyword strings * @returns an array with all unique keywords contained across all inputs */ export function mergeKeywords(...commaSeparatedKeywords) { From e4eda3eac7c8b7523be2d512be101cebf1b1f0b0 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 07:21:59 -0700 Subject: [PATCH 07/29] add typdef --- libraries/video/shared/parentModule.js | 1 + 1 file changed, 1 insertion(+) diff --git a/libraries/video/shared/parentModule.js b/libraries/video/shared/parentModule.js index 06c71ebd75b..b040f39bcb8 100644 --- a/libraries/video/shared/parentModule.js +++ b/libraries/video/shared/parentModule.js @@ -47,6 +47,7 @@ export function ParentModule(submoduleBuilder_) { } /** + * @typedef {import('../../../modules/videoModule/coreVideo.js').vendorSubmoduleDirectory} vendorSubmoduleDirectory * @typedef {Object} SubmoduleBuilder * @summary Instantiates submodules * @param {vendorSubmoduleDirectory} submoduleDirectory_ From a6a4674b12db5c1afec978401789e31eae2642b7 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 07:40:27 -0700 Subject: [PATCH 08/29] fix rtdmodule doc --- modules/rtdModule/index.js | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/modules/rtdModule/index.js b/modules/rtdModule/index.js index 8968d4c795a..c5308c91e18 100644 --- a/modules/rtdModule/index.js +++ b/modules/rtdModule/index.js @@ -1,6 +1,7 @@ /** * This module adds Real time data support to prebid.js * @module modules/realTimeData + * @typedef {import('../../modules/rtdModule/index.js').SubmoduleConfig} SubmoduleConfig */ /** @@ -30,7 +31,7 @@ */ /** - * @function? + * @function * @summary return real time data * @name RtdSubmodule#getTargetingData * @param {string[]} adUnitsCodes @@ -40,7 +41,7 @@ */ /** - * @function? + * @function * @summary modify bid request data * @name RtdSubmodule#getBidRequestData * @param {Object} reqBidsConfigObj @@ -73,7 +74,7 @@ */ /** - * @function? + * @function * @summary on auction init event * @name RtdSubmodule#onAuctionInitEvent * @param {Object} data @@ -82,7 +83,7 @@ */ /** - * @function? + * @function * @summary on auction end event * @name RtdSubmodule#onAuctionEndEvent * @param {Object} data @@ -91,7 +92,7 @@ */ /** - * @function? + * @function * @summary on bid response event * @name RtdSubmodule#onBidResponseEvent * @param {Object} data @@ -100,7 +101,7 @@ */ /** - * @function? + * @function * @summary on bid requested event * @name RtdSubmodule#onBidRequestEvent * @param {Object} data @@ -109,7 +110,7 @@ */ /** - * @function? + * @function * @summary on data deletion request * @name RtdSubmodule#onDataDeletionRequest * @param {SubmoduleConfig} config From 6a1ad3db17ee6ede61ccd7e8e1db67a27487feff Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 07:52:22 -0700 Subject: [PATCH 09/29] fix a few adapters --- modules/yieldmoBidAdapter.js | 17 +++++++++-------- modules/zetaBidAdapter.js | 2 ++ modules/zeta_global_sspBidAdapter.js | 2 ++ modules/zmaticooBidAdapter.js | 8 ++++++++ 4 files changed, 21 insertions(+), 8 deletions(-) diff --git a/modules/yieldmoBidAdapter.js b/modules/yieldmoBidAdapter.js index 7fee4af422c..216eb06ed95 100644 --- a/modules/yieldmoBidAdapter.js +++ b/modules/yieldmoBidAdapter.js @@ -21,6 +21,7 @@ import {find, includes} from '../src/polyfill.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest */ @@ -52,8 +53,8 @@ export const spec = { gvlid: GVLID, /** * Determines whether or not the given bid request is valid. - * @param {object} bid, bid to validate - * @return boolean, true if valid, otherwise false + * @param {object} bid bid to validate + * @return {boolean} true if valid, otherwise false */ isBidRequestValid: function (bid) { return !!(bid && bid.adUnitCode && bid.bidId && (hasBannerMediaType(bid) || hasVideoMediaType(bid)) && @@ -583,8 +584,8 @@ function populateOpenRtbGdpr(openRtbRequest, bidderRequest) { /** * Determines whether or not the given video bid request is valid. If it's not a video bid, returns true. - * @param {object} bid, bid to validate - * @return boolean, true if valid, otherwise false + * @param {object} bid bid to validate + * @return {boolean} true if valid, otherwise false */ function validateVideoParams(bid) { if (!hasVideoMediaType(bid)) { @@ -689,9 +690,9 @@ function validateVideoParams(bid) { /** * Shortcut object property and check if required characters count was deleted * - * @param {number} extraCharacters, count of characters to remove - * @param {object} target, object on which string property length should be reduced - * @param {string} propertyName, name of property to reduce + * @param {number} extraCharacters count of characters to remove + * @param {object} target object on which string property length should be reduced + * @param {string} propertyName name of property to reduce * @return {number} 0 if required characters count was removed otherwise count of how many left */ function shortcutProperty(extraCharacters, target, propertyName) { @@ -710,7 +711,7 @@ function shortcutProperty(extraCharacters, target, propertyName) { /** * Creates and returnes eids arr using createEidsArray from './userId/eids.js' module; - * @param {Object} openRtbRequest OpenRTB's request as a cource of userId. + * @param {Object} bidRequest OpenRTB's request as a cource of userId. * @return array of eids objects */ function getEids(bidRequest) { diff --git a/modules/zetaBidAdapter.js b/modules/zetaBidAdapter.js index cc77d53d30d..658d3198df0 100644 --- a/modules/zetaBidAdapter.js +++ b/modules/zetaBidAdapter.js @@ -5,6 +5,8 @@ import {BANNER} from '../src/mediaTypes.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').Bids} Bids + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync diff --git a/modules/zeta_global_sspBidAdapter.js b/modules/zeta_global_sspBidAdapter.js index 295108f31b4..b8db88619cb 100644 --- a/modules/zeta_global_sspBidAdapter.js +++ b/modules/zeta_global_sspBidAdapter.js @@ -9,6 +9,8 @@ import {ajax} from '../src/ajax.js'; * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse + * @typedef {import('../src/adapters/bidderFactory.js').Bids} Bids + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest */ const BIDDER_CODE = 'zeta_global_ssp'; diff --git a/modules/zmaticooBidAdapter.js b/modules/zmaticooBidAdapter.js index eeb130af7d5..7c6bfb982ce 100644 --- a/modules/zmaticooBidAdapter.js +++ b/modules/zmaticooBidAdapter.js @@ -2,6 +2,14 @@ import {deepAccess, isArray, isBoolean, isNumber, isStr, logWarn} from '../src/u import {registerBidder} from '../src/adapters/bidderFactory.js'; import {BANNER, VIDEO} from '../src/mediaTypes.js'; +/** + * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest + * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').Bids} Bids + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse + */ + const BIDDER_CODE = 'zmaticoo'; const ENDPOINT_URL = 'https://bid.zmaticoo.com/prebid/bid'; const DEFAULT_CUR = 'USD'; From a8aa5757a39a7700c01be97f0b52ff7722c7d2a1 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:00:05 -0700 Subject: [PATCH 10/29] fix bid adapters --- modules/pilotxBidAdapter.js | 4 ++-- modules/smilewantedBidAdapter.js | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/modules/pilotxBidAdapter.js b/modules/pilotxBidAdapter.js index 0fb39e19076..417c1f0c089 100644 --- a/modules/pilotxBidAdapter.js +++ b/modules/pilotxBidAdapter.js @@ -45,7 +45,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { @@ -143,7 +143,7 @@ export const spec = { /** * Formats placement ids for adserver ingestion purposes - * @param {string[]} The placement ID/s in an array + * @param {string[]} placementId the placement ID/s in an array */ setPlacementID: function (placementId) { if (Array.isArray(placementId)) { diff --git a/modules/smilewantedBidAdapter.js b/modules/smilewantedBidAdapter.js index 515aae0e092..7d4a4bca615 100644 --- a/modules/smilewantedBidAdapter.js +++ b/modules/smilewantedBidAdapter.js @@ -11,6 +11,10 @@ const BIDDER_CODE = 'smilewanted'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse + * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions + * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync */ const GVL_ID = 639; From 2d2d5317d128068c33f16863ca1a436742a757de Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:01:08 -0700 Subject: [PATCH 11/29] fix prisma --- modules/prismaBidAdapter.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/prismaBidAdapter.js b/modules/prismaBidAdapter.js index 4b4b5677cb3..b42c4b8af3f 100644 --- a/modules/prismaBidAdapter.js +++ b/modules/prismaBidAdapter.js @@ -64,7 +64,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function(validBidRequests, bidderRequest) { @@ -189,7 +189,7 @@ export const spec = { /** * Register bidder specific code, which will execute if a bid from this bidder won the auction - * @param {Bid} The bid that won the auction + * @param {Bid} bid the bid that won the auction */ onBidWon: function(bid) { // fires a pixel to confirm a winning bid From eb79b63aad16e470a221fe111886774d4c2561dd Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:03:08 -0700 Subject: [PATCH 12/29] remove array syntax --- modules/pubmaticBidAdapter.js | 2 +- modules/pubwiseBidAdapter.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/pubmaticBidAdapter.js b/modules/pubmaticBidAdapter.js index d25627a7b90..68431bcc383 100644 --- a/modules/pubmaticBidAdapter.js +++ b/modules/pubmaticBidAdapter.js @@ -1070,7 +1070,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: (validBidRequests, bidderRequest) => { diff --git a/modules/pubwiseBidAdapter.js b/modules/pubwiseBidAdapter.js index 507df4a2bb0..eca0c971050 100644 --- a/modules/pubwiseBidAdapter.js +++ b/modules/pubwiseBidAdapter.js @@ -180,7 +180,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { From e46e36646d5b76f2ecbf9bef80e1e937b25051c2 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:13:20 -0700 Subject: [PATCH 13/29] fix adot --- modules/adotBidAdapter.js | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/modules/adotBidAdapter.js b/modules/adotBidAdapter.js index b48a7ec43b0..f17b55f7822 100644 --- a/modules/adotBidAdapter.js +++ b/modules/adotBidAdapter.js @@ -7,6 +7,23 @@ import {config} from '../src/config.js'; import {OUTSTREAM} from '../src/video.js'; import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; +/** + * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest + * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse + * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions + * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync + * @typedef {import('../src/adapters/bidderFactory.js').MediaType} MediaType + * @typedef {import('../src/adapters/bidderFactory.js').Site} Site + * @typedef {import('../src/adapters/bidderFactory.js').Device} Device + * @typedef {import('../src/adapters/bidderFactory.js').User} User + * @typedef {import('../src/adapters/bidderFactory.js').Banner} Banner + * @typedef {import('../src/adapters/bidderFactory.js').Video} Video + * @typedef {import('../src/adapters/bidderFactory.js').AdUnit} AdUnit + * @typedef {import('../src/adapters/bidderFactory.js').Imp} Imp + */ + const BIDDER_CODE = 'adot'; const ADAPTER_VERSION = 'v2.0.0'; const GVLID = 272; From 38d60a31eab6a50c2d2426d2d7b5f909d33d93b9 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:18:03 -0700 Subject: [PATCH 14/29] update jsdoc --- modules/adyoulikeBidAdapter.js | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/adyoulikeBidAdapter.js b/modules/adyoulikeBidAdapter.js index 9bc24b11ac3..dcdd1da0d70 100644 --- a/modules/adyoulikeBidAdapter.js +++ b/modules/adyoulikeBidAdapter.js @@ -8,6 +8,7 @@ import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').bidRequests} bidRequests */ const VERSION = '1.0'; From 77e6daf5ad1d81a4ae00d4e01b2117b219e955b0 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:27:19 -0700 Subject: [PATCH 15/29] update jsdoc colon --- modules/adyoulikeBidAdapter.js | 3 +-- modules/astraoneBidAdapter.js | 3 ++- modules/beopBidAdapter.js | 12 +++++++++--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/modules/adyoulikeBidAdapter.js b/modules/adyoulikeBidAdapter.js index dcdd1da0d70..a10b0950631 100644 --- a/modules/adyoulikeBidAdapter.js +++ b/modules/adyoulikeBidAdapter.js @@ -8,7 +8,6 @@ import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid - * @typedef {import('../src/adapters/bidderFactory.js').bidRequests} bidRequests */ const VERSION = '1.0'; @@ -63,7 +62,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {bidRequests} - bidRequests.bids[] is an array of AdUnits and bids + * @param {bidRequests} bidRequests.bids[] is an array of AdUnits and bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function (bidRequests, bidderRequest) { diff --git a/modules/astraoneBidAdapter.js b/modules/astraoneBidAdapter.js index 9645b8e68bd..293431a2991 100644 --- a/modules/astraoneBidAdapter.js +++ b/modules/astraoneBidAdapter.js @@ -6,6 +6,7 @@ import { BANNER } from '../src/mediaTypes.js' * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests */ const BIDDER_CODE = 'astraone'; @@ -100,7 +101,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests(validBidRequests, bidderRequest) { diff --git a/modules/beopBidAdapter.js b/modules/beopBidAdapter.js index 89289654b32..c87a1e4f6e8 100644 --- a/modules/beopBidAdapter.js +++ b/modules/beopBidAdapter.js @@ -12,6 +12,12 @@ import {registerBidder} from '../src/adapters/bidderFactory.js'; import {config} from '../src/config.js'; import {getAllOrtbKeywords} from '../libraries/keywords/keywords.js'; +/** + * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests + * @typedef {import('../src/adapters/bidderFactory.js').bidderRequest} bidderRequest + */ + const BIDDER_CODE = 'beop'; const ENDPOINT_URL = 'https://hb.beop.io/bid'; const TCF_VENDOR_ID = 666; @@ -25,7 +31,7 @@ export const spec = { /** * Test if the bid request is valid. * - * @param {bid} : The Bid params + * @param {bid} - The Bid params * @return boolean true if the bid request is valid (aka contains a valid accountId or networkId and is open for BANNER), false otherwise. */ isBidRequestValid: function(bid) { @@ -41,8 +47,8 @@ export const spec = { /** * Create a BeOp server request from a list of BidRequest * - * @param {validBidRequests[], ...} : The array of validated bidRequests - * @param {... , bidderRequest} : Common params for each bidRequests + * @param {validBidRequests.} : The array of validated bidRequests + * @param {bidderRequest} : Common params for each bidRequests * @return ServerRequest Info describing the request to the BeOp's server */ buildRequests: function(validBidRequests, bidderRequest) { From d28596598f4307bc06525f568a30e4889628f3bc Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:38:49 -0700 Subject: [PATCH 16/29] fix errors --- modules/adotBidAdapter.js | 2 +- modules/astraoneBidAdapter.js | 4 ++-- modules/beopBidAdapter.js | 8 ++++---- modules/betweenBidAdapter.js | 3 ++- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/modules/adotBidAdapter.js b/modules/adotBidAdapter.js index f17b55f7822..9f2810e13df 100644 --- a/modules/adotBidAdapter.js +++ b/modules/adotBidAdapter.js @@ -21,7 +21,7 @@ import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; * @typedef {import('../src/adapters/bidderFactory.js').Banner} Banner * @typedef {import('../src/adapters/bidderFactory.js').Video} Video * @typedef {import('../src/adapters/bidderFactory.js').AdUnit} AdUnit - * @typedef {import('../src/adapters/bidderFactory.js').Imp} Imp + * @typedef {import('../src/adapters/bidderFactory.js').Imp} Imp */ const BIDDER_CODE = 'adot'; diff --git a/modules/astraoneBidAdapter.js b/modules/astraoneBidAdapter.js index 293431a2991..216257fb7bc 100644 --- a/modules/astraoneBidAdapter.js +++ b/modules/astraoneBidAdapter.js @@ -6,7 +6,7 @@ import { BANNER } from '../src/mediaTypes.js' * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse - * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests */ const BIDDER_CODE = 'astraone'; @@ -101,7 +101,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests} - an array of bids + * @param {validBidRequests} validBidRequests an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests(validBidRequests, bidderRequest) { diff --git a/modules/beopBidAdapter.js b/modules/beopBidAdapter.js index c87a1e4f6e8..0b2a965448b 100644 --- a/modules/beopBidAdapter.js +++ b/modules/beopBidAdapter.js @@ -15,7 +15,7 @@ import {getAllOrtbKeywords} from '../libraries/keywords/keywords.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests - * @typedef {import('../src/adapters/bidderFactory.js').bidderRequest} bidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest */ const BIDDER_CODE = 'beop'; @@ -31,7 +31,7 @@ export const spec = { /** * Test if the bid request is valid. * - * @param {bid} - The Bid params + * @param {Bid} bid The Bid params * @return boolean true if the bid request is valid (aka contains a valid accountId or networkId and is open for BANNER), false otherwise. */ isBidRequestValid: function(bid) { @@ -47,8 +47,8 @@ export const spec = { /** * Create a BeOp server request from a list of BidRequest * - * @param {validBidRequests.} : The array of validated bidRequests - * @param {bidderRequest} : Common params for each bidRequests + * @param {validBidRequests} validBidRequests The array of validated bidRequests + * @param {BidderRequest} bidderRequest Common params for each bidRequests * @return ServerRequest Info describing the request to the BeOp's server */ buildRequests: function(validBidRequests, bidderRequest) { diff --git a/modules/betweenBidAdapter.js b/modules/betweenBidAdapter.js index 4a953875d99..d2010f22e1a 100644 --- a/modules/betweenBidAdapter.js +++ b/modules/betweenBidAdapter.js @@ -6,6 +6,7 @@ import {getAdUnitSizes} from '../libraries/sizeUtils/sizeUtils.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync @@ -31,7 +32,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequest?pbjs_debug=trues[]} - an array of bids + * @param {validBidRequests} validBidRequests an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function(validBidRequests, bidderRequest) { From 0cec5b9ae570c2b979d74a19eadd7f77bc5b507f Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:44:01 -0700 Subject: [PATCH 17/29] fix params --- modules/bidglassBidAdapter.js | 5 ++++- modules/blueconicRtdProvider.js | 5 ++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/modules/bidglassBidAdapter.js b/modules/bidglassBidAdapter.js index 6074d1a0e4c..231dfe9fc77 100644 --- a/modules/bidglassBidAdapter.js +++ b/modules/bidglassBidAdapter.js @@ -4,6 +4,8 @@ import {registerBidder} from '../src/adapters/bidderFactory.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse */ @@ -24,7 +26,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} validBidRequests an array of bids + * @param {BidderRequest} bidderRequest request by bidder * @return ServerRequest Info describing the request to the server. */ buildRequests: function(validBidRequests, bidderRequest) { diff --git a/modules/blueconicRtdProvider.js b/modules/blueconicRtdProvider.js index 6b10e79b94c..c09fc6ee34c 100644 --- a/modules/blueconicRtdProvider.js +++ b/modules/blueconicRtdProvider.js @@ -37,9 +37,8 @@ function parseJson(data) { /** * Add real-time data & merge segments. - * @param {Object} bidConfig + * @param {Object} ortb2 * @param {Object} rtd - * @param {Object} rtdConfig */ export function addRealTimeData(ortb2, rtd) { if (isPlainObject(rtd.ortb2)) { @@ -82,7 +81,7 @@ export function getRealTimeData(reqBidsConfigObj, onDone, rtdConfig, userConsent /** * Module init * @param {Object} provider - * @param {Objkect} userConsent + * @param {Object} userConsent * @return {boolean} */ function init(provider, userConsent) { From f85bcbc3b2012f9b99e91cac9ea4438bdde08fec Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:46:45 -0700 Subject: [PATCH 18/29] fix jsdoc --- modules/britepoolIdSystem.js | 2 +- modules/browsiRtdProvider.js | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/britepoolIdSystem.js b/modules/britepoolIdSystem.js index 37ace544dc7..dcc365faaac 100644 --- a/modules/britepoolIdSystem.js +++ b/modules/britepoolIdSystem.js @@ -38,7 +38,7 @@ export const britepoolIdSubmodule = { * @function * @param {SubmoduleConfig} [submoduleConfig] * @param {ConsentData|undefined} consentData - * @returns {function(callback:function)} + * @returns {function} */ getId(submoduleConfig, consentData) { const submoduleConfigParams = (submoduleConfig && submoduleConfig.params) || {}; diff --git a/modules/browsiRtdProvider.js b/modules/browsiRtdProvider.js index 5281274616a..ab3db2a5d20 100644 --- a/modules/browsiRtdProvider.js +++ b/modules/browsiRtdProvider.js @@ -191,7 +191,6 @@ function getAllSlots() { /** * get prediction and return valid object for key value set * @param {number} p - * @param {string?} keyName * @return {Object} key:value */ function getKVObject(p) { From e4833cc2edc6cdf64a2c812035cce685720c3816 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 08:57:50 -0700 Subject: [PATCH 19/29] add typedef --- modules/dsp_genieeBidAdapter.js | 16 +++++++++++++--- modules/dspxBidAdapter.js | 4 ++-- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/modules/dsp_genieeBidAdapter.js b/modules/dsp_genieeBidAdapter.js index 17865e6793a..681e64a9efe 100644 --- a/modules/dsp_genieeBidAdapter.js +++ b/modules/dsp_genieeBidAdapter.js @@ -3,6 +3,16 @@ import { BANNER } from '../src/mediaTypes.js'; import { ortbConverter } from '../libraries/ortbConverter/converter.js'; import { deepAccess, deepSetValue } from '../src/utils.js'; import { config } from '../src/config.js'; + +/** + * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse + * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions + * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync + */ + const BIDDER_CODE = 'dsp_geniee'; const ENDPOINT_URL = 'https://rt.gsspat.jp/prebid_auction'; const ENDPOINT_URL_UNCOMFORTABLE = 'https://rt.gsspat.jp/prebid_uncomfortable'; @@ -44,7 +54,7 @@ export const spec = { /** * Determines whether or not the given bid request is valid. * - * @param {BidRequest} - The bid params to validate. + * @param {BidRequest} _ The bid params to validate. * @return boolean True if this is a valid bid, and false otherwise. */ isBidRequestValid: function (_) { @@ -53,8 +63,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids - * @param {bidderRequest} - the master bidRequest object + * @param {validBidRequests} validBidRequests - an array of bids + * @param {BidderRequest} bidderRequest - the master bidRequest object * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { diff --git a/modules/dspxBidAdapter.js b/modules/dspxBidAdapter.js index b4490095894..ea47c64094d 100644 --- a/modules/dspxBidAdapter.js +++ b/modules/dspxBidAdapter.js @@ -331,8 +331,8 @@ function getBannerSizes(bid) { /** * Parse size - * @param sizes - * @returns {width: number, h: height} + * @param size + * @returns {object} sizeObj */ function parseSize(size) { let sizeObj = {} From 45f2c2e484b870107adc562956cf42111492814a Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 09:01:15 -0700 Subject: [PATCH 20/29] add typedef and fix --- modules/dxkultureBidAdapter.js | 6 +++--- modules/dynamicAdBoostRtdProvider.js | 4 ++++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/modules/dxkultureBidAdapter.js b/modules/dxkultureBidAdapter.js index c167baef6ea..d803c476b6d 100644 --- a/modules/dxkultureBidAdapter.js +++ b/modules/dxkultureBidAdapter.js @@ -96,7 +96,7 @@ export const spec = { /** * Determines whether or not the given bid request is valid. * - * @param {BidRequest} bidRequest The bid params to validate. + * @param {BidRequest} bid The bid params to validate. * @return boolean True if this is a valid bid, and false otherwise. */ isBidRequestValid: function (bid) { @@ -269,7 +269,7 @@ function _validateParams(bidRequest) { /** * Validates banner bid request. If it is not banner media type returns true. - * @param {object} bid, bid to validate + * @param {BidRequest} bidRequest bid to validate * @return boolean, true if valid, otherwise false */ function _validateBanner(bidRequest) { @@ -287,7 +287,7 @@ function _validateBanner(bidRequest) { /** * Validates video bid request. If it is not video media type returns true. - * @param {object} bid, bid to validate + * @param {BidRequest} bidRequest, bid to validate * @return boolean, true if valid, otherwise false */ function _validateVideo(bidRequest) { diff --git a/modules/dynamicAdBoostRtdProvider.js b/modules/dynamicAdBoostRtdProvider.js index fe08795f313..697bd7340d3 100644 --- a/modules/dynamicAdBoostRtdProvider.js +++ b/modules/dynamicAdBoostRtdProvider.js @@ -9,6 +9,10 @@ import { loadExternalScript } from '../src/adloader.js'; import { getGlobal } from '../src/prebidGlobal.js'; import { deepAccess, deepSetValue, isEmptyStr } from '../src/utils.js'; +/** + * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule + */ + const MODULE_NAME = 'dynamicAdBoost'; const SCRIPT_URL = 'https://adxbid.info'; const CLIENT_SUPPORTS_IO = window.IntersectionObserver && window.IntersectionObserverEntry && window.IntersectionObserverEntry.prototype && From e7ee0b7cdeef46b53b0fce7cb5ccfb30892c74db Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 09:04:06 -0700 Subject: [PATCH 21/29] fix errors --- modules/bidglassBidAdapter.js | 2 +- modules/dsp_genieeBidAdapter.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/bidglassBidAdapter.js b/modules/bidglassBidAdapter.js index 231dfe9fc77..7ae1ccf9217 100644 --- a/modules/bidglassBidAdapter.js +++ b/modules/bidglassBidAdapter.js @@ -5,7 +5,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js'; * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest - * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse */ diff --git a/modules/dsp_genieeBidAdapter.js b/modules/dsp_genieeBidAdapter.js index 681e64a9efe..57aafd47fc8 100644 --- a/modules/dsp_genieeBidAdapter.js +++ b/modules/dsp_genieeBidAdapter.js @@ -6,7 +6,7 @@ import { config } from '../src/config.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest - * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions From eb368730b06f1abb7a7dbb1e62acbf5404123211 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 09:07:29 -0700 Subject: [PATCH 22/29] import types --- modules/feedadBidAdapter.js | 2 +- modules/flippBidAdapter.js | 4 +++- modules/fluctBidAdapter.js | 5 +++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/modules/feedadBidAdapter.js b/modules/feedadBidAdapter.js index e68a932b726..5ee9906b5df 100644 --- a/modules/feedadBidAdapter.js +++ b/modules/feedadBidAdapter.js @@ -9,7 +9,7 @@ import {ajax} from '../src/ajax.js'; * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions * @typedef {import('../src/adapters/bidderFactory.js').BidderSpec} BidderSpec - * @typedef {import('../src/adapters/bidderFactory.js').MediaTypes} MediaTypes + * @typedef {import('../src/adapters/bidderFactory.js').MediaType} MediaType */ /** diff --git a/modules/flippBidAdapter.js b/modules/flippBidAdapter.js index 0708c90ac0d..f9c424d9da5 100644 --- a/modules/flippBidAdapter.js +++ b/modules/flippBidAdapter.js @@ -6,6 +6,8 @@ import {getStorageManager} from '../src/storageManager.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync @@ -105,7 +107,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {BidRequest[]} validBidRequests[] an array of bids + * @param {validBidRequests} validBidRequests an array of bids * @param {BidderRequest} bidderRequest master bidRequest object * @return ServerRequest Info describing the request to the server. */ diff --git a/modules/fluctBidAdapter.js b/modules/fluctBidAdapter.js index f6d97fa7cd8..c0ae55efc89 100644 --- a/modules/fluctBidAdapter.js +++ b/modules/fluctBidAdapter.js @@ -4,6 +4,7 @@ import { registerBidder } from '../src/adapters/bidderFactory.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests */ @@ -30,8 +31,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids. - * @param {bidderRequest} bidderRequest bidder request object. + * @param {validBidRequests} validBidRequests an array of bids. + * @param {BidderRequest} bidderRequest bidder request object. * @return ServerRequest Info describing the request to the server. */ buildRequests: (validBidRequests, bidderRequest) => { From 4dfc6636e0418e62f6a959319044fec4b861c915 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 09:09:37 -0700 Subject: [PATCH 23/29] fix jsdoc warnings --- modules/freewheel-sspBidAdapter.js | 2 +- modules/geoedgeRtdProvider.js | 2 +- modules/getintentBidAdapter.js | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/freewheel-sspBidAdapter.js b/modules/freewheel-sspBidAdapter.js index c4653181fd0..e11aa3f8fb7 100644 --- a/modules/freewheel-sspBidAdapter.js +++ b/modules/freewheel-sspBidAdapter.js @@ -482,7 +482,7 @@ export const spec = { * Unpack the response from the server into a list of bids. * * @param {*} serverResponse A successful response from the server. - * @param {object} request: the built request object containing the initial bidRequest. + * @param {object} request the built request object containing the initial bidRequest. * @return {Bid[]} An array of bids which were nested inside the server. */ interpretResponse: function(serverResponse, request) { diff --git a/modules/geoedgeRtdProvider.js b/modules/geoedgeRtdProvider.js index a2ed71a898c..0b0d9027c03 100644 --- a/modules/geoedgeRtdProvider.js +++ b/modules/geoedgeRtdProvider.js @@ -56,7 +56,7 @@ let preloaded; /** * fetches the creative wrapper - * @param {function} sucess - success callback + * @param {function} success - success callback */ export function fetchWrapper(success) { if (wrapperReady) { diff --git a/modules/getintentBidAdapter.js b/modules/getintentBidAdapter.js index 7353a1c1f67..a8888893333 100644 --- a/modules/getintentBidAdapter.js +++ b/modules/getintentBidAdapter.js @@ -111,8 +111,8 @@ function buildUrl(bid) { /** * Builds GI bid request from BidRequest. * - * @param {BidRequest} bidRequest. - * @return {object} GI bid request. + * @param {BidRequest} bidRequest + * @return {object} GI bid request */ function buildGiBidRequest(bidRequest) { let giBidRequest = { From 06cd13c6b14f9acac56b1daf3d166215c5b681c2 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 09:13:20 -0700 Subject: [PATCH 24/29] fix warnings --- modules/gjirafaBidAdapter.js | 4 +++- modules/gmosspBidAdapter.js | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/modules/gjirafaBidAdapter.js b/modules/gjirafaBidAdapter.js index 9259010ac78..ef19a097062 100644 --- a/modules/gjirafaBidAdapter.js +++ b/modules/gjirafaBidAdapter.js @@ -5,6 +5,7 @@ import { BANNER, VIDEO } from '../src/mediaTypes.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests */ @@ -33,7 +34,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} validBidRequests an array of bids + * @param {BidderRequest} bidderRequest * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { diff --git a/modules/gmosspBidAdapter.js b/modules/gmosspBidAdapter.js index c4b8cd819e0..d7af51f7312 100644 --- a/modules/gmosspBidAdapter.js +++ b/modules/gmosspBidAdapter.js @@ -15,6 +15,7 @@ import {tryAppendQueryString} from '../libraries/urlUtils/urlUtils.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync @@ -41,7 +42,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} validBidRequests an array of bids + * @param {BidderRequest} bidderRequest * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { From 5a5420f9f8d0a766d500decd8fc3c78adf807fb0 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 09:15:37 -0700 Subject: [PATCH 25/29] add typedef --- modules/gnetBidAdapter.js | 4 +++- modules/growthCodeIdSystem.js | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/modules/gnetBidAdapter.js b/modules/gnetBidAdapter.js index 4718438b9bb..1bcc774e351 100644 --- a/modules/gnetBidAdapter.js +++ b/modules/gnetBidAdapter.js @@ -7,6 +7,7 @@ import {ajax} from '../src/ajax.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests */ @@ -31,7 +32,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} validBidRequests an array of bids + * @param {BidderRequest} bidderRequest * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { diff --git a/modules/growthCodeIdSystem.js b/modules/growthCodeIdSystem.js index cf72e2e5133..be20ab89130 100644 --- a/modules/growthCodeIdSystem.js +++ b/modules/growthCodeIdSystem.js @@ -9,6 +9,12 @@ import { submodule } from '../src/hook.js' import {getStorageManager} from '../src/storageManager.js'; import {MODULE_TYPE_UID} from '../src/activities/modules.js'; +/** + * @typedef {import('../modules/userId/index.js').Submodule} Submodule + * @typedef {import('../modules/userId/index.js').SubmoduleConfig} SubmoduleConfig + * @typedef {import('../modules/userId/index.js').IdResponse} IdResponse + */ + const MODULE_NAME = 'growthCodeId'; const GCID_KEY = 'gcid'; From a3645099ebfb0deb1532620b1cda7897c8a56f93 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 11:21:53 -0700 Subject: [PATCH 26/29] jsdoc fixes --- modules/adriverIdSystem.js | 1 - modules/adtelligentBidAdapter.js | 3 ++- modules/adyoulikeBidAdapter.js | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/adriverIdSystem.js b/modules/adriverIdSystem.js index 1da75f2063d..2dab76b7862 100644 --- a/modules/adriverIdSystem.js +++ b/modules/adriverIdSystem.js @@ -42,7 +42,6 @@ export const adriverIdSubmodule = { * performs action to obtain id and return a value in the callback's response argument * @function * @param {SubmoduleConfig} [config] - * @param {ConsentData} [consentData] * @returns {IdResponse|undefined} */ getId(config) { diff --git a/modules/adtelligentBidAdapter.js b/modules/adtelligentBidAdapter.js index cadba499b5c..a95b9ed5652 100644 --- a/modules/adtelligentBidAdapter.js +++ b/modules/adtelligentBidAdapter.js @@ -9,6 +9,7 @@ import {chunk} from '../libraries/chunk/chunk.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest */ const subdomainSuffixes = ['', 1, 2]; @@ -119,7 +120,7 @@ export const spec = { /** * Unpack the response from the server into a list of bids * @param serverResponse - * @param bidderRequest + * @param adapterRequest * @return {Bid[]} An array of bids which were nested inside the server */ interpretResponse: function (serverResponse, { adapterRequest }) { diff --git a/modules/adyoulikeBidAdapter.js b/modules/adyoulikeBidAdapter.js index a10b0950631..ad1c0af039e 100644 --- a/modules/adyoulikeBidAdapter.js +++ b/modules/adyoulikeBidAdapter.js @@ -8,6 +8,7 @@ import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').BidderRequest} BidderRequest */ const VERSION = '1.0'; @@ -62,7 +63,8 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {bidRequests} bidRequests.bids[] is an array of AdUnits and bids + * @param {BidRequest} bidRequests is an array of AdUnits and bids + * @param {BidderRequest} bidderRequest * @return ServerRequest Info describing the request to the server. */ buildRequests: function (bidRequests, bidderRequest) { From 1da9448d7a51c93b54fb5060a186a26dcfe4702c Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 11:29:54 -0700 Subject: [PATCH 27/29] jsdoc fixes --- modules/airgridRtdProvider.js | 2 +- modules/akamaiDapRtdProvider.js | 9 ++++++--- modules/apacdexBidAdapter.js | 2 +- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/modules/airgridRtdProvider.js b/modules/airgridRtdProvider.js index 2184544807e..079628c88fc 100644 --- a/modules/airgridRtdProvider.js +++ b/modules/airgridRtdProvider.js @@ -105,7 +105,7 @@ function init(rtdConfig, userConsent) { /** * Real-time data retrieval from AirGrid - * @param {Object} reqBidsConfigObj + * @param {Object} bidConfig * @param {function} onDone * @param {Object} rtdConfig * @param {Object} userConsent diff --git a/modules/akamaiDapRtdProvider.js b/modules/akamaiDapRtdProvider.js index f0bb7eb3a6c..0bd53b2a91f 100644 --- a/modules/akamaiDapRtdProvider.js +++ b/modules/akamaiDapRtdProvider.js @@ -12,6 +12,10 @@ import {isPlainObject, mergeDeep, logMessage, logInfo, logError} from '../src/ut import { loadExternalScript } from '../src/adloader.js'; import {MODULE_TYPE_RTD} from '../src/activities/modules.js'; +/** + * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule + */ + const MODULE_NAME = 'realTimeData'; const SUBMODULE_NAME = 'dap'; const MODULE_CODE = 'akamaidap'; @@ -44,9 +48,8 @@ function mergeLazy(target, source) { /** * Add real-time data & merge segments. - * @param {Object} ortb2 destionation object to merge RTD into + * @param {Object} ortb2 destination object to merge RTD into * @param {Object} rtd - * @param {Object} rtdConfig */ export function addRealTimeData(ortb2, rtd) { logInfo('DEBUG(addRealTimeData) - ENTER'); @@ -60,7 +63,7 @@ export function addRealTimeData(ortb2, rtd) { /** * Real-time data retrieval from Audigent - * @param {Object} reqBidsConfigObj + * @param {Object} bidConfig * @param {function} onDone * @param {Object} rtdConfig * @param {Object} userConsent diff --git a/modules/apacdexBidAdapter.js b/modules/apacdexBidAdapter.js index 834df134c2e..dadbdb72e95 100644 --- a/modules/apacdexBidAdapter.js +++ b/modules/apacdexBidAdapter.js @@ -327,7 +327,7 @@ export function validateGeoObject(geo) { * Get bid floor from Price Floors Module * * @param {Object} bid - * @returns {float||null} + * @returns {?number} */ function getBidFloor(bid) { if (!isFn(bid.getFloor)) { From ea4033eed7d26a9c010494f569649f672e610f34 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 11:41:09 -0700 Subject: [PATCH 28/29] fix warnings --- modules/appierBidAdapter.js | 2 +- modules/bliinkBidAdapter.js | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/appierBidAdapter.js b/modules/appierBidAdapter.js index fa314f0bd5f..cf89aeefffa 100644 --- a/modules/appierBidAdapter.js +++ b/modules/appierBidAdapter.js @@ -37,7 +37,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {bidRequests[]} - an array of bids + * @param {object} bidRequests - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function (bidRequests, bidderRequest) { diff --git a/modules/bliinkBidAdapter.js b/modules/bliinkBidAdapter.js index debe956d7eb..37c99878d68 100644 --- a/modules/bliinkBidAdapter.js +++ b/modules/bliinkBidAdapter.js @@ -153,7 +153,7 @@ export function getDomLoadingDuration() { } /** - * @param bidRequest + * @param bidResponse * @return {({cpm, netRevenue: boolean, requestId, width: number, currency, ttl: number, creativeId, height: number}&{mediaType: string, vastXml})|null} */ export const buildBid = (bidResponse) => { @@ -285,7 +285,6 @@ export const buildRequests = (validBidRequests, bidderRequest) => { * @description Parse the response (from buildRequests) and generate one or more bid objects. * * @param serverResponse - * @param request * @return */ const interpretResponse = (serverResponse) => { From ed86b9b00aa935feba7297844ed9d9a57dbf6347 Mon Sep 17 00:00:00 2001 From: Chris Huie Date: Thu, 15 Feb 2024 11:45:34 -0700 Subject: [PATCH 29/29] fix warnings --- modules/brandmetricsRtdProvider.js | 2 ++ modules/buzzoolaBidAdapter.js | 1 - modules/codefuelBidAdapter.js | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/brandmetricsRtdProvider.js b/modules/brandmetricsRtdProvider.js index 17336baa76c..2d9dcdfdf48 100644 --- a/modules/brandmetricsRtdProvider.js +++ b/modules/brandmetricsRtdProvider.js @@ -78,6 +78,7 @@ function checkConsent (userConsent) { /** * Add event- listeners to hook in to brandmetrics events * @param {Object} reqBidsConfigObj + * @param {Object} moduleConfig * @param {function} callback */ function processBrandmetricsEvents (reqBidsConfigObj, moduleConfig, callback) { @@ -114,6 +115,7 @@ function processBrandmetricsEvents (reqBidsConfigObj, moduleConfig, callback) { /** * Sets bid targeting of specific bidders * @param {Object} reqBidsConfigObj + * @param {Object} moduleConfig * @param {string} key Targeting key * @param {string} val Targeting value */ diff --git a/modules/buzzoolaBidAdapter.js b/modules/buzzoolaBidAdapter.js index 14a26203484..ae77ee159bc 100644 --- a/modules/buzzoolaBidAdapter.js +++ b/modules/buzzoolaBidAdapter.js @@ -53,7 +53,6 @@ export const spec = { * Unpack the response from the server into a list of bids. * * @param {ServerResponse} serverResponse A successful response from the server. - * @param bidderRequest * @return {Bid[]} An array of bids which were nested inside the server. */ interpretResponse: function ({body}, {data}) { diff --git a/modules/codefuelBidAdapter.js b/modules/codefuelBidAdapter.js index a289e29bd19..a4accee3ce0 100644 --- a/modules/codefuelBidAdapter.js +++ b/modules/codefuelBidAdapter.js @@ -5,6 +5,7 @@ import {BANNER} from '../src/mediaTypes.js'; /** * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid + * @typedef {import('../src/adapters/bidderFactory.js').validBidRequests} validBidRequests * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync @@ -32,7 +33,7 @@ export const spec = { /** * Make a server request from the list of BidRequests. * - * @param {validBidRequests[]} - an array of bids + * @param {validBidRequests} validBidRequests - an array of bids * @return ServerRequest Info describing the request to the server. */ buildRequests: function(validBidRequests, bidderRequest) {