prebid.js 10.2.0 → 10.4.0

package/src/bidderSettings.ts

@@ -8,55 +8,55 @@ import type {StorageType} from "./storageManager.ts";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export interface BidderSettings<B extends BidderCode> {
-    /**
-     * If true, allow bids with CPM 0to be accepted by Prebid.js and sent to the ad server.
-     */
-    allowZeroCpmBids?: boolean;
-    /**
-     * Optionally allow alternate bidder codes to use an adapter’s bidCpmAdjustment function by default instead of
-     * the standard bidCpmAdjustment function if present (note: if a bidCpmAdjustment function exists for the alternate
-     * bidder code within bidderSettings, then this will be used instead of falling back to the adapter’s bidCpmAdjustment function).
-     */
-    adjustAlternateBids?: boolean;
-    /**
-     * If adapter-specific targeting is specified, can be used to suppress the standard targeting for that adapter.
-     */
-    sendStandardTargeting?: boolean;
-    /**
-     * If custom adserverTargeting functions are specified that may generate empty keys, this can be used to suppress them.
-     */
-    suppressEmptyKeys?: boolean;
-    /**
-     * Allow use of cookies and/or local storage.
-     */
-    storageAllowed?: boolean | StorageType[];
-    /**
-     * Allow adapters to bid with alternate bidder codes.
-     */
-    allowAlternateBidderCodes?: boolean;
-    /**
-     * Array of bidder codes for which an adapter can bid.
-     * undefined or ['*'] will allow adapter to bid with any bidder code.
-     */
-    allowedAlternateBidderCodes?: ['*'] | BidderCode[];
-    /**
-     * If true (the default), allow the `Sec-Browsing-Topics` header in requests to their exchange.
-     */
-    topicsHeader?: boolean;
+  /**
+   * If true, allow bids with CPM 0to be accepted by Prebid.js and sent to the ad server.
+   */
+  allowZeroCpmBids?: boolean;
+  /**
+   * Optionally allow alternate bidder codes to use an adapter’s bidCpmAdjustment function by default instead of
+   * the standard bidCpmAdjustment function if present (note: if a bidCpmAdjustment function exists for the alternate
+   * bidder code within bidderSettings, then this will be used instead of falling back to the adapter’s bidCpmAdjustment function).
+   */
+  adjustAlternateBids?: boolean;
+  /**
+   * If adapter-specific targeting is specified, can be used to suppress the standard targeting for that adapter.
+   */
+  sendStandardTargeting?: boolean;
+  /**
+   * If custom adserverTargeting functions are specified that may generate empty keys, this can be used to suppress them.
+   */
+  suppressEmptyKeys?: boolean;
+  /**
+   * Allow use of cookies and/or local storage.
+   */
+  storageAllowed?: boolean | StorageType[];
+  /**
+   * Allow adapters to bid with alternate bidder codes.
+   */
+  allowAlternateBidderCodes?: boolean;
+  /**
+   * Array of bidder codes for which an adapter can bid.
+   * undefined or ['*'] will allow adapter to bid with any bidder code.
+   */
+  allowedAlternateBidderCodes?: ['*'] | BidderCode[];
+  /**
+   * If true (the default), allow the `Sec-Browsing-Topics` header in requests to their exchange.
+   */
+  topicsHeader?: boolean;
 }
 
 export interface BidderScopedSettings<B extends BidderCode> extends BidderSettings<B> {
-    /**
-     * Custom CPM adjustment function. Could, for example, adjust a bidder’s gross-price bid to net price.
-     */
-    bidCpmAdjustment?: (cpm: number, bid: Bid, bidRequest: BidRequest<B>) => number;
-    /**
-     * Define which key/value pairs are sent to the ad server.
-     */
-    adserverTargeting?: ({
-        key: string;
-        val(bid: Bid, bidRequest: BidRequest<B>): string;
-    })[];
+  /**
+   * Custom CPM adjustment function. Could, for example, adjust a bidder’s gross-price bid to net price.
+   */
+  bidCpmAdjustment?: (cpm: number, bid: Bid, bidRequest: BidRequest<B>) => number;
+  /**
+   * Define which key/value pairs are sent to the ad server.
+   */
+  adserverTargeting?: ({
+    key: string;
+    val(bid: Bid, bidRequest: BidRequest<B>): string;
+  })[];
 }
 
 export class ScopedSettings<SETTINGS extends Record<string, any>, SCOPED extends SETTINGS> {

package/src/bidfactory.ts

@@ -9,92 +9,92 @@ import {type BID_STATUS} from "./constants.ts";
 import type {DemandChain} from "./types/ortb/ext/dchain.d.ts";
 
 type BidIdentifiers = ContextIdentifiers & {
-    src: BidSource;
-    bidder: BidderCode;
-    bidId: Identifier;
+  src: BidSource;
+  bidder: BidderCode;
+  bidId: Identifier;
 };
 
 /**
  * Bid metadata.
  */
 export interface BidMeta {
-    [key: string]: unknown;
-    /**
-     * Advertiser domains (corresponds to ORTB `bid.adomain`).
-     */
-    advertiserDomains?: string[];
-    /**
-     * Primary category ID (corresponds to ORTB `bid.cat[0]`).
-     */
-    primaryCatId?: string;
-    /**
-     * IDs of all other categories (corresponds to ORTB `bid.cat.slice(1)`).
-     */
-    secondaryCatIds?: string[];
-    /**
-     * Creative attributes (corresponds to ORTB `bid.attr`).
-     */
-    attr?: number[];
-    /**
-     * DSA transparency information.
-     */
-    dsa?: DSAResponse;
-    /**
-     * Demand chain object.
-     */
-    dchain?: DemandChain
-    /**
-     * DSP network name.
-     */
-    networkName?: string;
-    /**
-     * DSP network ID.
-     */
-    networkId?: string | number;
+  [key: string]: unknown;
+  /**
+   * Advertiser domains (corresponds to ORTB `bid.adomain`).
+   */
+  advertiserDomains?: string[];
+  /**
+   * Primary category ID (corresponds to ORTB `bid.cat[0]`).
+   */
+  primaryCatId?: string;
+  /**
+   * IDs of all other categories (corresponds to ORTB `bid.cat.slice(1)`).
+   */
+  secondaryCatIds?: string[];
+  /**
+   * Creative attributes (corresponds to ORTB `bid.attr`).
+   */
+  attr?: number[];
+  /**
+   * DSA transparency information.
+   */
+  dsa?: DSAResponse;
+  /**
+   * Demand chain object.
+   */
+  dchain?: DemandChain
+  /**
+   * DSP network name.
+   */
+  networkName?: string;
+  /**
+   * DSP network ID.
+   */
+  networkId?: string | number;
 }
 
 /**
  * Bid responses as provided by adapters; core then transforms these into `Bid`s
  */
 export interface BaseBidResponse {
-    bidderCode?: BidderCode;
-    /**
-     * This bid's BidRequest's `.bidId`.
-     */
-    requestId: Identifier;
-    mediaType: MediaType;
-    cpm: number;
-    currency: Currency;
-    /**
-     * The time to live for this bid response in seconds
-     */
-    ttl: number;
-    creativeId: string;
-    /**
-     * True if the CPM is the one this bidder will pay
-     */
-    netRevenue: boolean;
-    /**
-     * If the bid is associated with a Deal, this field contains the deal ID.
-     * @see https://docs.prebid.org/adops/deals.html
-     */
-    dealId?: string;
-    meta?: BidMeta;
-    /**
-     * If true, and deferred billing was requested for this bid, its creative will not be rendered
-     * until billing is explicitly triggered with `pbjs.triggerBilling()`.
-     * Useful to avoid premature firing of trackers embedded in the creative.
-     */
-    deferRendering?: boolean;
-    /**
-     * Event trackers for this bid.
-     */
-    eventtrackers?: EventTrackerResponse[];
-    renderer?: Renderer;
-    /**
-     * Billing tracker URL.
-     */
-    burl?: string;
+  bidderCode?: BidderCode;
+  /**
+   * This bid's BidRequest's `.bidId`.
+   */
+  requestId: Identifier;
+  mediaType: MediaType;
+  cpm: number;
+  currency: Currency;
+  /**
+   * The time to live for this bid response in seconds
+   */
+  ttl: number;
+  creativeId: string;
+  /**
+   * True if the CPM is the one this bidder will pay
+   */
+  netRevenue: boolean;
+  /**
+   * If the bid is associated with a Deal, this field contains the deal ID.
+   * @see https://docs.prebid.org/adops/deals.html
+   */
+  dealId?: string;
+  meta?: BidMeta;
+  /**
+   * If true, and deferred billing was requested for this bid, its creative will not be rendered
+   * until billing is explicitly triggered with `pbjs.triggerBilling()`.
+   * Useful to avoid premature firing of trackers embedded in the creative.
+   */
+  deferRendering?: boolean;
+  /**
+   * Event trackers for this bid.
+   */
+  eventtrackers?: EventTrackerResponse[];
+  renderer?: Renderer;
+  /**
+   * Billing tracker URL.
+   */
+  burl?: string;
 }
 
 // <format>BidResponesProperties - adapter interpretResponse properties specific to the format.
@@ -102,15 +102,15 @@ export interface BaseBidResponse {
 // Here we have only "naked" declarations, extended in banner/video/native.ts as well as modules.
 
 export interface BannerBidResponseProperties {
-    mediaType: 'banner';
+  mediaType: 'banner';
 }
 
 export interface VideoBidResponseProperties {
-    mediaType: 'video';
+  mediaType: 'video';
 }
 
 export interface NativeBidResponseProperties {
-    mediaType: 'native';
+  mediaType: 'native';
 }
 
 export type BannerBidResponse = BaseBidResponse & BannerBidResponseProperties;
@@ -120,33 +120,33 @@ export type NativeBidResponse = BaseBidResponse & NativeBidResponseProperties;
 export type BidResponse = BannerBidResponse | VideoBidResponse | NativeBidResponse;
 
 export interface BaseBid extends ContextIdentifiers, Required<Pick<BaseBidResponse, 'meta' | 'deferRendering'>> {
-    /**
-     * This bid's BidRequest's `.bidId`. Can be null in some `allowUnknownBidderCodes` scenarios.
-     */
-    requestId: Identifier | null;
-    metrics: Metrics;
-    source: BidSource;
-    width: number;
-    height: number;
-    adId: Identifier;
-    getSize(): string;
-    getStatusCode(): number;
-    status?: (typeof BID_STATUS)[keyof typeof BID_STATUS]
-    bidderCode: BidderCode;
-    adapterCode?: BidderCode;
-    /**
-     * CPM of this bid before currency conversions or adjustments.
-     */
-    originalCpm?: number;
-    /**
-     * Currency for `originalCpm`.
-     */
-    originalCurrency?: Currency;
-    /**
-     * If true, this bid will not fire billing trackers until they are explicitly
-     * triggered with `pbjs.triggerBilling()`.
-     */
-    deferBilling: boolean;
+  /**
+   * This bid's BidRequest's `.bidId`. Can be null in some `allowUnknownBidderCodes` scenarios.
+   */
+  requestId: Identifier | null;
+  metrics: Metrics;
+  source: BidSource;
+  width: number;
+  height: number;
+  adId: Identifier;
+  getSize(): string;
+  getStatusCode(): number;
+  status?: (typeof BID_STATUS)[keyof typeof BID_STATUS]
+  bidderCode: BidderCode;
+  adapterCode?: BidderCode;
+  /**
+   * CPM of this bid before currency conversions or adjustments.
+   */
+  originalCpm?: number;
+  /**
+   * Currency for `originalCpm`.
+   */
+  originalCurrency?: Currency;
+  /**
+   * If true, this bid will not fire billing trackers until they are explicitly
+   * triggered with `pbjs.triggerBilling()`.
+   */
+  deferBilling: boolean;
 }
 
 // <format>BidProperties - format specific properties of Bid objects generated by Prebid, but not in
@@ -154,15 +154,15 @@ export interface BaseBid extends ContextIdentifiers, Required<Pick<BaseBidRespon
 // use.
 
 export interface BannerBidProperties {
-    mediaType: 'banner';
+  mediaType: 'banner';
 }
 
 export interface NativeBidProperties {
-    mediaType: 'native';
+  mediaType: 'native';
 }
 
 export interface VideoBidProperties {
-    mediaType: 'video';
+  mediaType: 'video';
 }
 
 type BidFrom<RESP, PROPS> = BaseBid & Omit<RESP, keyof BaseBid | keyof PROPS> & PROPS;

package/src/config.ts

@@ -196,79 +196,79 @@ function attachProperties(config, useDefaultValues = true) {
 }
 
 export interface Config {
-    /**
-     * Enable debug mode. In debug mode, Prebid.js will post additional messages to the browser console and cause
-     * Prebid Server to return additional information in its response.
-     */
-    debug?: boolean;
-    /**
-     * Global bidder timeout.
-     */
-    bidderTimeout?: number;
-    /**
-     * When true, the page will send keywords for all bidders to your ad server.
-     */
-    enableSendAllBids?: boolean;
-    /**
-     * Prebid.js currently allows for caching and reusing bids in a very narrowly defined scope.
-     * However, if you’d like, you can disable this feature and prevent Prebid.js from using anything but the latest bids for a given auction.
-     */
-    useBidCache?: boolean;
-    /**
-     * You can prevent Prebid.js from reading or writing cookies or HTML localstorage by setting this to false.
-     */
-    deviceAccess?: boolean;
-    /**
-     * Prebid core adds a timeout on XMLHttpRequest request to terminate the request once auction is timed out.
-     * Since Prebid is ignoring all the bids after timeout it does not make sense to continue the request after timeout.
-     * However, you have the option to disable this by using disableAjaxTimeout.
-     */
-    disableAjaxTimeout?: boolean;
-    /**
-     * Prebid ensures that the bid response price doesn’t exceed the maximum bid.
-     * If the CPM (after currency conversion) is higher than the maxBid, the bid is rejected.
-     * The default maxBid value is 5000.
-     */
-    maxBid?: number;
-    userSync?: UserSyncConfig;
-    /**
-     * Set the order in which bidders are called.
-     */
-    bidderSequence?: typeof RANDOM | typeof FIXED;
-    /**
-     * When a page is prerendered, by default Prebid will delay auctions until it is activated.
-     * Set this to `true` to allow auctions to run during prerendering.
-     */
-    allowPrerendering?: boolean;
-    /**
-     * If set to `private`, remove public access to Prebid's alias registry
-     */
-    aliasRegistry?: 'private'
-    /**
-     * ORTB-formatted first party data.
-     * https://docs.prebid.org/features/firstPartyData.html
-     */
-    ortb2?: DeepPartial<ORTBRequest>;
+  /**
+   * Enable debug mode. In debug mode, Prebid.js will post additional messages to the browser console and cause
+   * Prebid Server to return additional information in its response.
+   */
+  debug?: boolean;
+  /**
+   * Global bidder timeout.
+   */
+  bidderTimeout?: number;
+  /**
+   * When true, the page will send keywords for all bidders to your ad server.
+   */
+  enableSendAllBids?: boolean;
+  /**
+   * Prebid.js currently allows for caching and reusing bids in a very narrowly defined scope.
+   * However, if you’d like, you can disable this feature and prevent Prebid.js from using anything but the latest bids for a given auction.
+   */
+  useBidCache?: boolean;
+  /**
+   * You can prevent Prebid.js from reading or writing cookies or HTML localstorage by setting this to false.
+   */
+  deviceAccess?: boolean;
+  /**
+   * Prebid core adds a timeout on XMLHttpRequest request to terminate the request once auction is timed out.
+   * Since Prebid is ignoring all the bids after timeout it does not make sense to continue the request after timeout.
+   * However, you have the option to disable this by using disableAjaxTimeout.
+   */
+  disableAjaxTimeout?: boolean;
+  /**
+   * Prebid ensures that the bid response price doesn’t exceed the maximum bid.
+   * If the CPM (after currency conversion) is higher than the maxBid, the bid is rejected.
+   * The default maxBid value is 5000.
+   */
+  maxBid?: number;
+  userSync?: UserSyncConfig;
+  /**
+   * Set the order in which bidders are called.
+   */
+  bidderSequence?: typeof RANDOM | typeof FIXED;
+  /**
+   * When a page is prerendered, by default Prebid will delay auctions until it is activated.
+   * Set this to `true` to allow auctions to run during prerendering.
+   */
+  allowPrerendering?: boolean;
+  /**
+   * If set to `private`, remove public access to Prebid's alias registry
+   */
+  aliasRegistry?: 'private'
+  /**
+   * ORTB-formatted first party data.
+   * https://docs.prebid.org/features/firstPartyData.html
+   */
+  ortb2?: DeepPartial<ORTBRequest>;
 }
 
 type PartialConfig = Partial<Config> & { [setting: string]: unknown };
 type BidderConfig = {
-    bidders: BidderCode[];
-    config: PartialConfig;
+  bidders: BidderCode[];
+  config: PartialConfig;
 }
 
 type TopicalConfig<S extends string> = {[K in DeepPropertyName<S>]: S extends DeepProperty<Config> ? TypeOfDeepProperty<Config, S> : unknown};
 type UnregistrationFn = () => void;
 
 type GetConfigOptions = {
-    /**
-     * If true, the listener will be called immediately (instead of only on the next configuration change).
-     */
-    init?: boolean;
+  /**
+   * If true, the listener will be called immediately (instead of only on the next configuration change).
+   */
+  init?: boolean;
 }
 
 interface GetConfig {
-    (): Config;
+  (): Config;
     <S extends DeepProperty<Config> | string>(setting: S): S extends DeepProperty<Config> ? TypeOfDeepProperty<Config, S> : unknown;
     (topic: typeof ALL_TOPICS, listener: (config: Config) => void, options?: GetConfigOptions): UnregistrationFn;
     <S extends DeepProperty<Config> | string>(topic: S, listener: (config: TopicalConfig<S>) => void, options?: GetConfigOptions): UnregistrationFn;
@@ -340,8 +340,8 @@ export function newConfig() {
         const override = curr[topic];
         merged[topic] = override === undefined ? base
           : base === undefined ? override
-          : isPlainObject(override) ? mergeDeep({}, base, override)
-          : override;
+            : isPlainObject(override) ? mergeDeep({}, base, override)
+              : override;
       }
       return merged;
     }
@@ -547,13 +547,13 @@ export function newConfig() {
 
     function check(obj) {
       if (!isPlainObject(obj)) {
-        throw 'setBidderConfig bidder options must be an object';
+        throw new Error('setBidderConfig bidder options must be an object');
       }
       if (!(Array.isArray(obj.bidders) && obj.bidders.length)) {
-        throw 'setBidderConfig bidder options must contain a bidders list with at least 1 bidder';
+        throw new Error('setBidderConfig bidder options must contain a bidders list with at least 1 bidder');
       }
       if (!isPlainObject(obj.config)) {
-        throw 'setBidderConfig bidder options must contain a config object';
+        throw new Error('setBidderConfig bidder options must contain a config object');
       }
     }
   }

package/src/consentHandler.ts

@@ -17,22 +17,22 @@ export const CONSENT_COPPA = 'coppa';
 export type ConsentType = typeof CONSENT_GDPR | typeof CONSENT_GPP | typeof CONSENT_USP | typeof CONSENT_COPPA;
 
 export interface ConsentData {
-    // with just core, only coppa is defined - everything else will be null.
-    // importing consent modules also imports the type definitions.
-    [CONSENT_COPPA]: boolean;
+  // with just core, only coppa is defined - everything else will be null.
+  // importing consent modules also imports the type definitions.
+  [CONSENT_COPPA]: boolean;
 }
 
 type ConsentDataFor<T extends ConsentType> = T extends keyof ConsentData ? ConsentData[T] : null;
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ConsentManagementConfig {
-    // consentManagement config - extended in consent management modules
+  // consentManagement config - extended in consent management modules
 }
 
 declare module './config' {
-    interface Config {
-        consentManagement?: ConsentManagementConfig;
-    }
+  interface Config {
+    consentManagement?: ConsentManagementConfig;
+  }
 }
 
 export class ConsentHandler<T> {
@@ -160,16 +160,16 @@ class GppConsentHandler extends ConsentHandler<ConsentDataFor<typeof CONSENT_GPP
 
 export type GVLID = number | typeof VENDORLESS_GVLID;
 type GVLIDResult = {
-    /**
-     * A map from module type to that module's GVL ID.
-     */
-    modules: {
-        [moduleType: string]: GVLID;
-    };
-    /**
-     * The single GVL ID for this family of modules (only defined if all modules with this name declared the same ID).
-     */
-    gvlid?: GVLID;
+  /**
+   * A map from module type to that module's GVL ID.
+   */
+  modules: {
+    [moduleType: string]: GVLID;
+  };
+  /**
+   * The single GVL ID for this family of modules (only defined if all modules with this name declared the same ID).
+   */
+  gvlid?: GVLID;
 }
 
 export function gvlidRegistry() {
@@ -217,12 +217,12 @@ export const uspDataHandler = new UspConsentHandler();
 export const gppDataHandler = new GppConsentHandler();
 
 declare module './config' {
-    interface Config {
-        /**
-         * Child Online Privacy Protection Act (COPPA) flag.
-         */
-        coppa?: boolean;
-    }
+  interface Config {
+    /**
+     * Child Online Privacy Protection Act (COPPA) flag.
+     */
+    coppa?: boolean;
+  }
 }
 
 export const coppaDataHandler = (() => {
@@ -253,11 +253,11 @@ const ALL_HANDLERS = {
 } as const;
 
 export type AllConsentData = {
-    [K in keyof typeof ALL_HANDLERS]: ReturnType<(typeof ALL_HANDLERS)[K]['getConsentData']>
+  [K in keyof typeof ALL_HANDLERS]: ReturnType<(typeof ALL_HANDLERS)[K]['getConsentData']>
 }
 
 interface MultiHandler extends Pick<ConsentHandler<AllConsentData>, 'promise' | 'hash' | 'getConsentData' | 'reset'> {
-    getConsentMeta(): {[K in keyof typeof ALL_HANDLERS]: ReturnType<(typeof ALL_HANDLERS)[K]['getConsentMeta']>}
+  getConsentMeta(): {[K in keyof typeof ALL_HANDLERS]: ReturnType<(typeof ALL_HANDLERS)[K]['getConsentMeta']>}
 }
 
 export function multiHandler(handlers = ALL_HANDLERS): MultiHandler {

package/src/constants.ts

@@ -75,20 +75,20 @@ export const GRANULARITY_OPTIONS = {
 } as const;
 
 export const TARGETING_KEYS = {
-    BIDDER: 'hb_bidder',
-    AD_ID: 'hb_adid',
-    PRICE_BUCKET: 'hb_pb',
-    SIZE: 'hb_size',
-    DEAL: 'hb_deal',
-    SOURCE: 'hb_source',
-    FORMAT: 'hb_format',
-    UUID: 'hb_uuid',
-    CACHE_ID: 'hb_cache_id',
-    CACHE_HOST: 'hb_cache_host',
-    ADOMAIN: 'hb_adomain',
-    ACAT: 'hb_acat',
-    CRID: 'hb_crid',
-    DSP: 'hb_dsp'
+  BIDDER: 'hb_bidder',
+  AD_ID: 'hb_adid',
+  PRICE_BUCKET: 'hb_pb',
+  SIZE: 'hb_size',
+  DEAL: 'hb_deal',
+  SOURCE: 'hb_source',
+  FORMAT: 'hb_format',
+  UUID: 'hb_uuid',
+  CACHE_ID: 'hb_cache_id',
+  CACHE_HOST: 'hb_cache_host',
+  ADOMAIN: 'hb_adomain',
+  ACAT: 'hb_acat',
+  CRID: 'hb_crid',
+  DSP: 'hb_dsp'
 } as const;
 
 export const DEFAULT_TARGETING_KEYS = {