JSdoc Linting Fixes for Multiiple RTD Modules (prebid#10973)

* fix rtd jsdoc * jsdoc lint fixes * import jsdoc types * rtd jsdoc fixes
dailymotion-oss · Mar 1, 2024 · 8111c54 · 8111c54
1 parent a8e5c0f
commit 8111c54
Show file tree

Hide file tree

Showing 23 changed files with 95 additions and 0 deletions.
diff --git a/modules/a1MediaRtdProvider.js b/modules/a1MediaRtdProvider.js
@@ -4,6 +4,10 @@ import { submodule } from '../src/hook.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { isEmptyStr, mergeDeep } from '../src/utils.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const REAL_TIME_MODULE = 'realTimeData';
 const MODULE_NAME = 'a1Media';
 const SCRIPT_URL = 'https://linkback.contentsfeed.com/src';

diff --git a/modules/adnuntiusRtdProvider.js b/modules/adnuntiusRtdProvider.js
@@ -5,6 +5,10 @@ import { ajax } from '../src/ajax.js';
 
 import { config as sourceConfig } from '../src/config.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const GVLID = 855;
 
 function init(config, userConsent) {

diff --git a/modules/airgridRtdProvider.js b/modules/airgridRtdProvider.js
@@ -11,6 +11,10 @@ import {getStorageManager} from '../src/storageManager.js';
 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 = 'airgrid';
 const AG_TCF_ID = 782;

diff --git a/modules/arcspanRtdProvider.js b/modules/arcspanRtdProvider.js
@@ -2,6 +2,10 @@ import { submodule } from '../src/hook.js';
 import { mergeDeep } from '../src/utils.js';
 import {loadExternalScript} from '../src/adloader.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'arcspan';

diff --git a/modules/blueconicRtdProvider.js b/modules/blueconicRtdProvider.js
@@ -11,6 +11,10 @@ import {submodule} from '../src/hook.js';
 import {mergeDeep, isPlainObject, logMessage, logError} from '../src/utils.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 = 'blueconic';
 

diff --git a/modules/brandmetricsRtdProvider.js b/modules/brandmetricsRtdProvider.js
@@ -11,6 +11,10 @@ import {loadExternalScript} from '../src/adloader.js';
 import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const MODULE_NAME = 'brandmetrics'
 const MODULE_CODE = MODULE_NAME
 const RECEIVED_EVENTS = []

diff --git a/modules/browsiRtdProvider.js b/modules/browsiRtdProvider.js
@@ -25,6 +25,11 @@ import {getGlobal} from '../src/prebidGlobal.js';
 import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
+
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const MODULE_NAME = 'browsi';
 
 const storage = getStorageManager({moduleType: MODULE_TYPE_RTD, moduleName: MODULE_NAME});

diff --git a/modules/cleanioRtdProvider.js b/modules/cleanioRtdProvider.js
@@ -12,6 +12,10 @@ import { logError, generateUUID, insertElement } from '../src/utils.js';
 import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 // ============================ MODULE STATE ===============================
 
 /**

diff --git a/modules/dgkeywordRtdProvider.js b/modules/dgkeywordRtdProvider.js
@@ -11,6 +11,10 @@ import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 /**
  * get keywords from api server. and set keywords.
  * @param {Object} reqBidsConfigObj

diff --git a/modules/experianRtdProvider.js b/modules/experianRtdProvider.js
@@ -12,6 +12,12 @@ import {
 } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ * @typedef {import('../modules/rtdModule/index.js').SubmoduleConfig} SubmoduleConfig
+ * @typedef {import('../modules/rtdModule/index.js').UserConsentData} UserConsentData
+ */
+
 export const SUBMODULE_NAME = 'experian_rtid';
 export const EXPERIAN_RTID_DATA_KEY = 'experian_rtid_data';
 export const EXPERIAN_RTID_EXPIRATION_KEY = 'experian_rtid_expiration';

diff --git a/modules/geoedgeRtdProvider.js b/modules/geoedgeRtdProvider.js
@@ -24,6 +24,10 @@ import { loadExternalScript } from '../src/adloader.js';
 import { auctionManager } from '../src/auctionManager.js';
 import { getRefererInfo } from '../src/refererDetection.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 /** @type {string} */
 const SUBMODULE_NAME = 'geoedge';
 /** @type {string} */

diff --git a/modules/goldfishAdsRtdProvider.js b/modules/goldfishAdsRtdProvider.js
@@ -3,6 +3,10 @@ import { submodule } from '../src/hook.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { deepAccess } from '../src/utils.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 export const MODULE_NAME = 'goldfishAdsRtd';
 export const MODULE_TYPE = 'realTimeData';
 export const ENDPOINT_URL = 'https://prebid.goldfishads.com/iab-segments';

diff --git a/modules/hadronRtdProvider.js b/modules/hadronRtdProvider.js
@@ -14,6 +14,10 @@ import {isFn, isStr, isArray, deepEqual, isPlainObject, logError, logInfo} from
 import {loadExternalScript} from '../src/adloader.js';
 import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const LOG_PREFIX = 'User ID - HadronRtdProvider submodule: ';
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'hadron';

diff --git a/modules/idWardRtdProvider.js b/modules/idWardRtdProvider.js
@@ -9,6 +9,9 @@ import {getStorageManager} from '../src/storageManager.js';
 import {submodule} from '../src/hook.js';
 import {isPlainObject, mergeDeep, logMessage, logError} from '../src/utils.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 = 'idWard';

diff --git a/modules/imRtdProvider.js b/modules/imRtdProvider.js
@@ -20,6 +20,10 @@ import {
 import {submodule} from '../src/hook.js';
 import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 export const imUidLocalName = '__im_uid';
 export const imVidCookieName = '_im_vid';
 export const imRtdLocalName = '__im_sids';

diff --git a/modules/jwplayerRtdProvider.js b/modules/jwplayerRtdProvider.js
@@ -16,6 +16,11 @@ import {deepAccess, logError} from '../src/utils.js';
 import {find} from '../src/polyfill.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ * @typedef {import('../modules/rtdModule/index.js').adUnit} adUnit
+ */
+
 const SUBMODULE_NAME = 'jwplayer';
 const JWPLAYER_DOMAIN = SUBMODULE_NAME + '.com';
 const segCache = {};

diff --git a/modules/mgidRtdProvider.js b/modules/mgidRtdProvider.js
@@ -5,6 +5,10 @@ import {getStorageManager} from '../src/storageManager.js';
 import {getRefererInfo} from '../src/refererDetection.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 = 'mgid';
 const MGID_RTD_API_URL = 'https://servicer.mgid.com/sda';

diff --git a/modules/oneKeyRtdProvider.js b/modules/oneKeyRtdProvider.js
@@ -3,6 +3,10 @@ import { submodule } from '../src/hook.js';
 import { mergeDeep, logError, logMessage, deepSetValue, generateUUID } from '../src/utils.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const SUBMODULE_NAME = 'oneKey';
 const prefixLog = 'OneKey.RTD-module'
 

diff --git a/modules/optimeraRtdProvider.js b/modules/optimeraRtdProvider.js
@@ -23,6 +23,10 @@ import { logInfo, logError } from '../src/utils.js';
 import { submodule } from '../src/hook.js';
 import { ajaxBuilder } from '../src/ajax.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 /** @type {ModuleParams} */
 let _moduleParams = {};
 

diff --git a/modules/oxxionRtdProvider.js b/modules/oxxionRtdProvider.js
@@ -3,6 +3,10 @@ import { logInfo, logError } from '../src/utils.js'
 import { ajax } from '../src/ajax.js';
 import adapterManager from '../src/adapterManager.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const LOG_PREFIX = 'oxxionRtdProvider submodule: ';
 
 const bidderAliasRegistry = adapterManager.aliasRegistry || {};

diff --git a/modules/permutiveRtdProvider.js b/modules/permutiveRtdProvider.js
@@ -12,6 +12,10 @@ import {deepAccess, deepSetValue, isFn, logError, mergeDeep, isPlainObject, safe
 import {includes} from '../src/polyfill.js';
 import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const MODULE_NAME = 'permutive'
 
 const logger = prefixLog('[PermutiveRTD]')

diff --git a/modules/reconciliationRtdProvider.js b/modules/reconciliationRtdProvider.js
@@ -21,6 +21,10 @@ import {ajaxBuilder} from '../src/ajax.js';
 import {generateUUID, isGptPubadsDefined, logError, timestamp} from '../src/utils.js';
 import {find} from '../src/polyfill.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 /** @type {Object} */
 const MessageType = {
   IMPRESSION_REQUEST: 'rsdk:impression:req',

diff --git a/modules/timeoutRtdProvider.js b/modules/timeoutRtdProvider.js
@@ -4,6 +4,10 @@ import * as ajax from '../src/ajax.js';
 import { logInfo, deepAccess, logError } from '../src/utils.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const SUBMODULE_NAME = 'timeout';
 
 // this allows the stubbing of functions during testing