prebid.js 10.2.0 → 10.4.0

package/src/prebidGlobal.ts

@@ -1,28 +1,28 @@
 interface Command {
-    (): any;
+  (): any;
 }
 
 interface CommandQueue extends Omit<Command[], 'push'> {
-    push(cmd: Command): void;
+  push(cmd: Command): void;
 }
 
 export interface PrebidJS {
-    /**
-     * Command queue. Use cmd.push(function F() { ... }) to queue F until Prebid has loaded.
-     */
-    cmd: CommandQueue,
-    /**
-     * Alias of `cmd`
-     */
-    que: CommandQueue
-    /**
-     * Names of all installed modules.
-     */
-    installedModules: string[]
-    /**
-     * Optional scheduler used by pbYield().
-     */
-    scheduler?: { yield: () => Promise<void> }
+  /**
+   * Command queue. Use cmd.push(function F() { ... }) to queue F until Prebid has loaded.
+   */
+  cmd: CommandQueue,
+  /**
+   * Alias of `cmd`
+   */
+  que: CommandQueue
+  /**
+   * Names of all installed modules.
+   */
+  installedModules: string[]
+  /**
+   * Optional scheduler used by pbYield().
+   */
+  scheduler?: { yield: () => Promise<void> }
 }
 
 // if $$PREBID_GLOBAL$$ already exists in global document scope, use it, if not, create the object

package/src/refererDetection.ts

@@ -75,17 +75,17 @@ function getCanonicalUrl(doc) {
 }
 
 declare module './config' {
-    interface Config {
-        /**
-         * Prebid.js will loop upward through nested iframes to find the top-most referrer. T
-         * his setting limits how many iterations it will attempt before giving up and not setting referrer.
-         */
-        maxNestedIframes?: number;
-        /**
-         * Override the Prebid.js page referrer.
-         */
-        pageUrl?: string;
-    }
+  interface Config {
+    /**
+     * Prebid.js will loop upward through nested iframes to find the top-most referrer. T
+     * his setting limits how many iterations it will attempt before giving up and not setting referrer.
+     */
+    maxNestedIframes?: number;
+    /**
+     * Override the Prebid.js page referrer.
+     */
+    pageUrl?: string;
+  }
 }
 
 /**
@@ -239,53 +239,53 @@ export function detectReferer(win) {
     }
 
     return {
-        /**
-         * True if the top window is accessible.
-         */
+      /**
+       * True if the top window is accessible.
+       */
+      reachedTop,
+      isAmp: valuesFromAmp,
+      /**
+       * number of steps between window.self and window.top
+       */
+      numIframes: level - 1,
+      /**
+       * our best guess at the location for each frame, in the direction top -> self.
+       */
+      stack,
+      /**
+       * of the top-most frame for which we could guess the location. Outside of cross-origin scenarios, this is equivalent to `location`.
+       */
+      topmostLocation: bestLocation || null,
+      /**
+       * the browser's location, or null if not available (due to cross-origin restrictions)
+       */
+      location,
+      /**
+       * the site's canonical URL as set by the publisher, through setConfig({pageUrl}) or <link rel="canonical" />
+       */
+      canonicalUrl,
+      /**
+       * the best candidate for the current page URL: `canonicalUrl`, falling back to `location`
+       */
+      page,
+      /**
+       * the domain portion of `page`
+       */
+      domain: parseDomain(page) || null,
+      /**
+       * the referrer (document.referrer) to the current page, or null if not available (due to cross-origin restrictions)
+       */
+      ref: ref || null,
+      // TODO: the "legacy" refererInfo object is provided here, for now, to accommodate
+      // adapters that decided to just send it verbatim to their backend.
+      legacy: {
         reachedTop,
         isAmp: valuesFromAmp,
-        /**
-         * number of steps between window.self and window.top
-         */
         numIframes: level - 1,
-        /**
-         * our best guess at the location for each frame, in the direction top -> self.
-         */
         stack,
-        /**
-         * of the top-most frame for which we could guess the location. Outside of cross-origin scenarios, this is equivalent to `location`.
-         */
-        topmostLocation: bestLocation || null,
-        /**
-         * the browser's location, or null if not available (due to cross-origin restrictions)
-         */
-        location,
-        /**
-         * the site's canonical URL as set by the publisher, through setConfig({pageUrl}) or <link rel="canonical" />
-         */
-        canonicalUrl,
-        /**
-         * the best candidate for the current page URL: `canonicalUrl`, falling back to `location`
-         */
-        page,
-        /**
-         * the domain portion of `page`
-         */
-        domain: parseDomain(page) || null,
-        /**
-         * the referrer (document.referrer) to the current page, or null if not available (due to cross-origin restrictions)
-         */
-        ref: ref || null,
-        // TODO: the "legacy" refererInfo object is provided here, for now, to accommodate
-        // adapters that decided to just send it verbatim to their backend.
-        legacy: {
-            reachedTop,
-            isAmp: valuesFromAmp,
-            numIframes: level - 1,
-            stack,
-            referer: bestLocation || null,
-            canonicalUrl
-        }
+        referer: bestLocation || null,
+        canonicalUrl
+      }
     };
   }
 

package/src/storageManager.ts

@@ -3,9 +3,11 @@ import {bidderSettings} from './bidderSettings.js';
 import {MODULE_TYPE_BIDDER, MODULE_TYPE_PREBID, type ModuleType} from './activities/modules.js';
 import {isActivityAllowed, registerActivityControl} from './activities/rules.js';
 import {
-    ACTIVITY_PARAM_ADAPTER_CODE,
-    ACTIVITY_PARAM_COMPONENT_TYPE, ACTIVITY_PARAM_STORAGE_KEY,
-    ACTIVITY_PARAM_STORAGE_TYPE
+  ACTIVITY_PARAM_ADAPTER_CODE,
+  ACTIVITY_PARAM_COMPONENT_TYPE,
+  ACTIVITY_PARAM_STORAGE_KEY,
+  ACTIVITY_PARAM_STORAGE_TYPE,
+  ACTIVITY_PARAM_STORAGE_WRITE
 } from './activities/params.js';
 
 import {ACTIVITY_ACCESS_DEVICE, ACTIVITY_ACCESS_REQUEST_CREDENTIALS} from './activities/activities.js';
@@ -26,54 +28,55 @@ export let storageCallbacks = [];
 /* eslint-disable no-restricted-properties */
 
 interface AcceptsCallback<FN extends AnyFunction> {
-    (...args: Parameters<FN>): ReturnType<FN>;
-    (...args: [...Parameters<FN>, (result: ReturnType<FN>) => void]): void;
+  (...args: Parameters<FN>): ReturnType<FN>;
+  (...args: [...Parameters<FN>, (result: ReturnType<FN>) => void]): void;
 }
 
 type BrowserStorage = 'localStorage' | 'sessionStorage';
 
 export type StorageManager = {
-    [M in BrowserStorage as `has${Capitalize<M>}`]: AcceptsCallback<() => boolean>;
+  [M in BrowserStorage as `has${Capitalize<M>}`]: AcceptsCallback<() => boolean>;
 } & {
-    [M in BrowserStorage as `${M}IsEnabled`]: AcceptsCallback<() => boolean>;
+  [M in BrowserStorage as `${M}IsEnabled`]: AcceptsCallback<() => boolean>;
 } & {
-    // eslint-disable-next-line no-restricted-globals
-    [M in BrowserStorage as `setDataIn${Capitalize<M>}`]: AcceptsCallback<typeof localStorage.setItem>;
+  // eslint-disable-next-line no-restricted-globals
+  [M in BrowserStorage as `setDataIn${Capitalize<M>}`]: AcceptsCallback<typeof localStorage.setItem>;
 } & {
-    // eslint-disable-next-line no-restricted-globals
-    [M in BrowserStorage as `getDataFrom${Capitalize<M>}`]: AcceptsCallback<typeof localStorage.getItem>;
+  // eslint-disable-next-line no-restricted-globals
+  [M in BrowserStorage as `getDataFrom${Capitalize<M>}`]: AcceptsCallback<typeof localStorage.getItem>;
 } & {
-    // eslint-disable-next-line no-restricted-globals
-    [M in BrowserStorage as `removeDataFrom${Capitalize<M>}`]: AcceptsCallback<typeof localStorage.removeItem>
+  // eslint-disable-next-line no-restricted-globals
+  [M in BrowserStorage as `removeDataFrom${Capitalize<M>}`]: AcceptsCallback<typeof localStorage.removeItem>
 } & {
-    setCookie: AcceptsCallback<(name: string, value: string, expires?: string, sameSite?: string, domain?: string) => void>;
-    getCookie: AcceptsCallback<(name: string) => string>;
-    cookiesAreEnabled: AcceptsCallback<() => boolean>;
-    findSimilarCookies: AcceptsCallback<(contains: string) => string[]>
+  setCookie: AcceptsCallback<(name: string, value: string, expires?: string, sameSite?: string, domain?: string) => void>;
+  getCookie: AcceptsCallback<(name: string) => string>;
+  cookiesAreEnabled: AcceptsCallback<() => boolean>;
+  findSimilarCookies: AcceptsCallback<(contains: string) => string[]>
 }
 
 /*
  *  Storage manager constructor. Consumers should prefer one of `getStorageManager` or `getCoreStorageManager`.
  */
 export function newStorageManager({moduleName, moduleType, advertiseKeys = true}: {
-    moduleName: string;
-    moduleType: ModuleType;
-    /**
-     * If false, do not pass the 'storageKey' to activity checks - turning off storageControl for this manager.
-     */
-    advertiseKeys?: boolean;
+  moduleName: string;
+  moduleType: ModuleType;
+  /**
+   * If false, do not pass the 'storageKey' to activity checks - turning off storageControl for this manager.
+   */
+  advertiseKeys?: boolean;
 } = {} as any, {isAllowed = isActivityAllowed} = {}) {
-  function isValid(cb, storageType, storageKey) {
+  function isValid(cb, storageType, storageKey, isWrite) {
     let mod = moduleName;
     const curBidder = config.getCurrentBidder();
     if (curBidder && moduleType === MODULE_TYPE_BIDDER && adapterManager.aliasRegistry[curBidder] === moduleName) {
       mod = curBidder;
     }
     const params = {
-        [ACTIVITY_PARAM_STORAGE_TYPE]: storageType,
+      [ACTIVITY_PARAM_STORAGE_TYPE]: storageType,
+      [ACTIVITY_PARAM_STORAGE_WRITE]: isWrite,
     };
     if (advertiseKeys && storageKey != null) {
-        params[ACTIVITY_PARAM_STORAGE_KEY] = storageKey;
+      params[ACTIVITY_PARAM_STORAGE_KEY] = storageKey;
     }
     const result = {
       valid: isAllowed(ACTIVITY_ACCESS_DEVICE, activityParams(moduleType, mod, params))
@@ -82,14 +85,14 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
     return cb(result);
   }
 
-  function schedule(operation, storageType, storageKey, done) {
+  function schedule(operation, storageType, storageKey, isWrite, done) {
     if (done && typeof done === 'function') {
       storageCallbacks.push(function() {
-        const result = isValid(operation, storageType, storageKey);
+        let result = isValid(operation, storageType, storageKey, isWrite);
         done(result);
       });
     } else {
-      return isValid(operation, storageType, storageKey);
+      return isValid(operation, storageType, storageKey, isWrite);
     }
   }
 
@@ -105,7 +108,7 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
    * @param {function} [done]
    */
   const setCookie = function (key, value, expires, sameSite, domain, done) {
-    const cb = function (result) {
+    let cb = function (result) {
       if (result && result.valid) {
         const domainPortion = (domain && domain !== '') ? ` ;domain=${encodeURIComponent(domain)}` : '';
         const expiresPortion = (expires && expires !== '') ? ` ;expires=${expires}` : '';
@@ -114,7 +117,7 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
         document.cookie = `${key}=${encodeURIComponent(value)}${expiresPortion}; path=/${domainPortion}${sameSite ? `; SameSite=${sameSite}` : ''}${secure}`;
       }
     }
-    return schedule(cb, STORAGE_TYPE_COOKIES, key, done);
+    return schedule(cb, STORAGE_TYPE_COOKIES, key, true, done);
   };
 
   /**
@@ -123,14 +126,14 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
    * @returns {(string|null)}
    */
   const getCookie = function(name, done) {
-    const cb = function (result) {
+    let cb = function (result) {
       if (result && result.valid) {
-        const m = window.document.cookie.match('(^|;)\\s*' + name + '\\s*=\\s*([^;]*)\\s*(;|$)');
+        let m = window.document.cookie.match('(^|;)\\s*' + name + '\\s*=\\s*([^;]*)\\s*(;|$)');
         return m ? decodeURIComponent(m[2]) : null;
       }
       return null;
     }
-    return schedule(cb, STORAGE_TYPE_COOKIES, name, done);
+    return schedule(cb, STORAGE_TYPE_COOKIES, name, false, done);
   };
 
   /**
@@ -138,13 +141,13 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
    * @returns {boolean}
    */
   const cookiesAreEnabled = function (done) {
-    const cb = function (result) {
+    let cb = function (result) {
       if (result && result.valid) {
         return checkCookieSupport();
       }
       return false;
     }
-    return schedule(cb, STORAGE_TYPE_COOKIES, null, done);
+    return schedule(cb, STORAGE_TYPE_COOKIES, null, false, done);
   }
 
   function storageMethods(name) {
@@ -152,7 +155,7 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
     const backend = () => window[name] as any;
 
     const hasStorage: AcceptsCallback<() => boolean> = function (done) {
-      const cb = function (result) {
+      let cb = function (result) {
         if (result && result.valid) {
           try {
             return !!backend();
@@ -162,13 +165,13 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
         }
         return false;
       }
-      return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, null, done);
+      return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, null, false, done);
     } as any;
 
     return {
       [`has${capName}`]: hasStorage,
       [`${name}IsEnabled`](done) {
-        const cb = function (result) {
+        let cb = function (result) {
           if (result && result.valid) {
             try {
               backend().setItem('prebid.cookieTest', '1');
@@ -182,32 +185,32 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
           }
           return false;
         }
-        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, null, done);
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, null, false, done);
       },
       [`setDataIn${capName}`](key, value, done) {
-        const cb = function (result) {
+        let cb = function (result) {
           if (result && result.valid && hasStorage()) {
             backend().setItem(key, value);
           }
         }
-        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, key, done);
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, key, true, done);
       },
       [`getDataFrom${capName}`](key, done) {
-        const cb = function (result) {
+        let cb = function (result) {
           if (result && result.valid && hasStorage()) {
             return backend().getItem(key);
           }
           return null;
         }
-        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, key, done);
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, key, false, done);
       },
       [`removeDataFrom${capName}`](key, done) {
-        const cb = function (result) {
+        let cb = function (result) {
           if (result && result.valid && hasStorage()) {
             backend().removeItem(key);
           }
         }
-        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, key, done);
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, key, true, done);
       }
     }
   }
@@ -220,7 +223,7 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
    * @returns {string[]}
    */
   const findSimilarCookies = function(keyLike, done) {
-    const cb = function (result) {
+    let cb = function (result) {
       if (result && result.valid) {
         const all = [];
         if (hasDeviceAccess()) {
@@ -239,7 +242,7 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
       }
     }
 
-    return schedule(cb, STORAGE_TYPE_COOKIES, keyLike, done);
+    return schedule(cb, STORAGE_TYPE_COOKIES, keyLike, false, done);
   }
 
   return {
@@ -260,9 +263,9 @@ export function newStorageManager({moduleName, moduleType, advertiseKeys = true}
  *
  */
 export function getStorageManager({moduleType, moduleName, bidderCode}: {
-    moduleType?: ModuleType;
-    moduleName?: string;
-    bidderCode?: BidderCode;
+  moduleType?: ModuleType;
+  moduleName?: string;
+  bidderCode?: BidderCode;
 } = {}) {
   function err() {
     throw new Error(`Invalid invocation for getStorageManager: must set either bidderCode, or moduleType + moduleName`)
@@ -327,20 +330,20 @@ export function resetData() {
 }
 
 type CookieStorageDisclosure = {
-    type: 'cookie',
-    /**
-     * The number, in seconds, of the duration for storage on a device, as set when using cookie storage.
-     */
-    maxAgeSeconds: number;
-    /**
-     * Indicates the vendor is refreshing a cookie.
-     */
-    cookieRefresh: boolean;
+  type: 'cookie',
+  /**
+   * The number, in seconds, of the duration for storage on a device, as set when using cookie storage.
+   */
+  maxAgeSeconds: number;
+  /**
+   * Indicates the vendor is refreshing a cookie.
+   */
+  cookieRefresh: boolean;
 }
 type HTML5StorageDisclosure = {
-    type: 'web'
-    maxAgeSeconds?: null;
-    cookieRefresh?: null;
+  type: 'web'
+  maxAgeSeconds?: null;
+  cookieRefresh?: null;
 }
 
 /**
@@ -349,16 +352,16 @@ type HTML5StorageDisclosure = {
  * except that `domain` is omitted.
  */
 export type StorageDisclosure = (CookieStorageDisclosure | HTML5StorageDisclosure) & {
-    /**
-     * Key or object name, depending on type, for the storage item.
-     * Wildcards '*' are permitted. For example, "id*" or "*id" describes multiple prefixed or suffixed identifiers,
-     * all having the same purpose(s).
-     */
-    identifier: string;
-    /**
-     * The purpose ID or purpose IDs from the Global Vendor List (GVL) for which the storage is used.
-     */
-    purposes: number[];
+  /**
+   * Key or object name, depending on type, for the storage item.
+   * Wildcards '*' are permitted. For example, "id*" or "*id" describes multiple prefixed or suffixed identifiers,
+   * all having the same purpose(s).
+   */
+  identifier: string;
+  /**
+   * The purpose ID or purpose IDs from the Global Vendor List (GVL) for which the storage is used.
+   */
+  purposes: number[];
 }
 
 /**