prebid.js 10.2.0 → 10.4.0

package/modules/userId/index.ts

@@ -11,27 +11,27 @@ import {EVENTS} from '../../src/constants.js';
 import {module, ready as hooksReady} from '../../src/hook.js';
 import {EID_CONFIG, getEids} from './eids.js';
 import {
-    discloseStorageUse,
-    getCoreStorageManager,
-    newStorageManager,
-    STORAGE_TYPE_COOKIES,
-    STORAGE_TYPE_LOCALSTORAGE,
-    type StorageManager,
-    type StorageType
+  discloseStorageUse,
+  getCoreStorageManager,
+  newStorageManager,
+  STORAGE_TYPE_COOKIES,
+  STORAGE_TYPE_LOCALSTORAGE,
+  type StorageManager,
+  type StorageType
 } from '../../src/storageManager.js';
 import {
-    deepEqual,
-    deepSetValue,
-    delayExecution,
-    isArray,
-    isEmpty,
-    isFn,
-    isGptPubadsDefined,
-    isNumber,
-    isPlainObject,
-    logError,
-    logInfo,
-    logWarn,
+  deepEqual,
+  deepSetValue,
+  delayExecution,
+  isArray,
+  isEmpty,
+  isFn,
+  isGptPubadsDefined,
+  isNumber,
+  isPlainObject,
+  logError,
+  logInfo,
+  logWarn,
 } from '../../src/utils.js';
 import {getPPID as coreGetPPID} from '../../src/adserver.js';
 import {defer, delay, PbPromise} from '../../src/utils/promise.js';
@@ -46,7 +46,12 @@ import {USERSYNC_DEFAULT_CONFIG, type UserSyncConfig} from '../../src/userSync.j
 import type {ORTBRequest} from "../../src/types/ortb/request.d.ts";
 import type {AnyFunction, Wraps} from "../../src/types/functions.d.ts";
 import type {ProviderParams, UserId, UserIdProvider, UserIdConfig, IdProviderSpec, ProviderResponse} from "./spec.ts";
-import { ACTIVITY_PARAM_COMPONENT_NAME, ACTIVITY_PARAM_COMPONENT_TYPE, ACTIVITY_PARAM_STORAGE_TYPE } from '../../src/activities/params.js';
+import {
+  ACTIVITY_PARAM_COMPONENT_NAME,
+  ACTIVITY_PARAM_COMPONENT_TYPE,
+  ACTIVITY_PARAM_STORAGE_TYPE,
+  ACTIVITY_PARAM_STORAGE_WRITE
+} from '../../src/activities/params.js';
 
 const MODULE_NAME = 'User ID';
 const COOKIE = STORAGE_TYPE_COOKIES;
@@ -58,51 +63,51 @@ export const dep = {
 }
 
 declare module '../../src/userSync' {
-    interface UserSyncConfig {
-        /**
-         * EID source to use as PPID for GAM.
-         *
-         * Publishers using Google AdManager may want to sync one of the identifiers as their Google PPID for frequency capping or reporting.
-         * The PPID in GAM (which is unrelated to the PPID UserId Submodule) has strict rules; refer to Google AdManager documentation for them.
-         * Please note, Prebid uses a GPT command to sync identifiers for publisher convenience.
-         * It doesn’t currently work for instream video requests, as Prebid typically interacts with the player,
-         * which in turn may interact with IMA. IMA does has a similar method as GPT, but IMA does not gather this ID from GPT.
-         */
-        ppid?: string;
-        /**
-         * Map from userID name (the key in the object returned by `getUserIds`) to names of modules that should be preferred
-         * as sources for that ID, in order of decreasing priority.
-         */
-        idPriority?: {
-            [idName: keyof UserId]: UserIdProvider[]
-        }
-        userIds?: (UserIdConfig<keyof ProviderParams> | UserIdConfig<UserIdProvider>)[];
-        // TODO documentation for these is either missing or inscrutable
-        encryptedSignalSources?: {
-            sources: {
-                source: string[]
-                encrypt: boolean;
-                customFunc: AnyFunction
-            }[]
-            /**
-             * The amount of time (in milliseconds) after which registering of signals will happen. Default value 0 is considered if ‘registerDelay’ is not provided.
-             */
-            registerDelay?: number;
-        }
-        /**
-         * If true (the default), updating userSync.userIds will not remove previously configured IDs.
-         */
-        retainConfig?: boolean;
-        /**
-         * If true, updating userSync.userIds will automatically refresh IDs that have not yet been fetched.
-         */
-        autoRefresh?: boolean;
-
-        /**
-         * If true, user ID modules will only be allowed to save data in the location specified in the configuration.
-         */
-        enforceStorageType?: boolean;
+  interface UserSyncConfig {
+    /**
+     * EID source to use as PPID for GAM.
+     *
+     * Publishers using Google AdManager may want to sync one of the identifiers as their Google PPID for frequency capping or reporting.
+     * The PPID in GAM (which is unrelated to the PPID UserId Submodule) has strict rules; refer to Google AdManager documentation for them.
+     * Please note, Prebid uses a GPT command to sync identifiers for publisher convenience.
+     * It doesn’t currently work for instream video requests, as Prebid typically interacts with the player,
+     * which in turn may interact with IMA. IMA does has a similar method as GPT, but IMA does not gather this ID from GPT.
+     */
+    ppid?: string;
+    /**
+     * Map from userID name (the key in the object returned by `getUserIds`) to names of modules that should be preferred
+     * as sources for that ID, in order of decreasing priority.
+     */
+    idPriority?: {
+      [idName: keyof UserId]: UserIdProvider[]
     }
+    userIds?: (UserIdConfig<keyof ProviderParams> | UserIdConfig<UserIdProvider>)[];
+    // TODO documentation for these is either missing or inscrutable
+    encryptedSignalSources?: {
+      sources: {
+        source: string[]
+        encrypt: boolean;
+        customFunc: AnyFunction
+      }[]
+      /**
+       * The amount of time (in milliseconds) after which registering of signals will happen. Default value 0 is considered if ‘registerDelay’ is not provided.
+       */
+      registerDelay?: number;
+    }
+    /**
+     * If true (the default), updating userSync.userIds will not remove previously configured IDs.
+     */
+    retainConfig?: boolean;
+    /**
+     * If true, updating userSync.userIds will automatically refresh IDs that have not yet been fetched.
+     */
+    autoRefresh?: boolean;
+
+    /**
+     * If true, user ID modules will only be allowed to save data in the location specified in the configuration.
+     */
+    enforceStorageType?: boolean;
+  }
 }
 
 let submodules: SubmoduleContainer<UserIdProvider>[] = [];
@@ -458,9 +463,9 @@ export function enrichEids(ortb2Fragments) {
 }
 
 declare module '../../src/adapterManager' {
-    interface BaseBidRequest {
-        userIdAsEids: ORTBRequest['user']['eids'];
-    }
+  interface BaseBidRequest {
+    userIdAsEids: ORTBRequest['user']['eids'];
+  }
 }
 
 export function addIdData({ortb2Fragments}) {
@@ -604,17 +609,17 @@ export const startAuctionHook = timedAuctionHook('userId', function requestBidsH
  * Do this lazily (instead of attaching a copy) so that it also shows EIDs added after the userId module runs (e.g. from RTD modules)
  */
 function aliasEidsHook(next, bidderRequests) {
-    bidderRequests.forEach(bidderRequest => {
-        bidderRequest.bids.forEach(bid =>
-            Object.defineProperty(bid, 'userIdAsEids', {
-                configurable: true,
-                get() {
-                    return bidderRequest.ortb2.user?.ext?.eids;
-                }
-            })
-        )
-    })
-    next(bidderRequests);
+  bidderRequests.forEach(bidderRequest => {
+    bidderRequest.bids.forEach(bid =>
+      Object.defineProperty(bid, 'userIdAsEids', {
+        configurable: true,
+        get() {
+          return bidderRequest.ortb2.user?.ext?.eids;
+        }
+      })
+    )
+  })
+  next(bidderRequests);
 }
 
 /**
@@ -695,17 +700,22 @@ function registerSignalSources() {
   if (!isGptPubadsDefined()) {
     return;
   }
-  window.googletag.secureSignalProviders = window.googletag.secureSignalProviders || [];
+
+  const providers: googletag.secureSignals.SecureSignalProvider[] = window.googletag.secureSignalProviders = (window.googletag.secureSignalProviders || []) as googletag.secureSignals.SecureSignalProvider[];
+  const existingIds = new Set(providers.map(p => 'id' in p ? p.id : p.networkCode));
   const encryptedSignalSources = config.getConfig('userSync.encryptedSignalSources');
   if (encryptedSignalSources) {
     const registerDelay = encryptedSignalSources.registerDelay || 0;
     setTimeout(() => {
       encryptedSignalSources['sources'] && encryptedSignalSources['sources'].forEach(({ source, encrypt, customFunc }) => {
         source.forEach((src) => {
-          window.googletag.secureSignalProviders.push({
-            id: src,
-            collectorFunction: () => getEncryptedEidsForSource(src, encrypt, customFunc)
-          });
+          if (!existingIds.has(src)) {
+            providers.push({
+              id: src,
+              collectorFunction: () => getEncryptedEidsForSource(src, encrypt, customFunc)
+            });
+            existingIds.add(src);
+          }
         });
       })
     }, registerDelay)
@@ -742,7 +752,7 @@ function retryOnCancel(initParams?) {
  * callback called when the refresh is complete
  */
 function refreshUserIds({submoduleNames}: {
-    submoduleNames?: string[]
+  submoduleNames?: string[]
 } = {}, callback?: () => void): Promise<Partial<UserId>> {
   return retryOnCancel({refresh: true, submoduleNames})
     .then((userIds) => {
@@ -776,7 +786,7 @@ export function getConsentHash() {
     bytes.push(String.fromCharCode(hash & 255));
     hash = hash >>> 8;
   }
-  return btoa(bytes.join());
+  return btoa(bytes.join(''));
 }
 
 function consentChanged(submodule) {
@@ -987,22 +997,22 @@ function populateEnabledStorageTypes(submodule: SubmoduleContainer<UserIdProvide
     switch (type) {
       case LOCAL_STORAGE:
         HTML5_SUFFIXES.forEach(suffix => {
-            discloseStorageUse('userId', {
-                type: 'web',
-                identifier: submodule.config.storage.name + suffix,
-                purposes: STORAGE_PURPOSES
-            })
+          discloseStorageUse('userId', {
+            type: 'web',
+            identifier: submodule.config.storage.name + suffix,
+            purposes: STORAGE_PURPOSES
+          })
         })
         return canUseLocalStorage(submodule);
       case COOKIE:
         COOKIE_SUFFIXES.forEach(suffix => {
-            discloseStorageUse('userId', {
-                type: 'cookie',
-                identifier: submodule.config.storage.name + suffix,
-                purposes: STORAGE_PURPOSES,
-                maxAgeSeconds: (submodule.config.storage.expires ?? 0) * 24 * 60 * 60,
-                cookieRefresh: true
-            })
+          discloseStorageUse('userId', {
+            type: 'cookie',
+            identifier: submodule.config.storage.name + suffix,
+            purposes: STORAGE_PURPOSES,
+            maxAgeSeconds: (submodule.config.storage.expires ?? 0) * 24 * 60 * 60,
+            cookieRefresh: true
+          })
         })
         return canUseCookies(submodule);
     }
@@ -1049,11 +1059,11 @@ export function generateSubmoduleContainers(options, configs, prevSubmodules = s
         callback: undefined,
         idObj: undefined,
         storageMgr: newStorageManager({
-            moduleType: MODULE_TYPE_UID,
-            moduleName: submoduleConfig.name,
-            // since this manager is only using keys provided directly by the publisher,
-            // turn off storageControl checks
-            advertiseKeys: false,
+          moduleType: MODULE_TYPE_UID,
+          moduleName: submoduleConfig.name,
+          // since this manager is only using keys provided directly by the publisher,
+          // turn off storageControl checks
+          advertiseKeys: false,
         })
       };
 
@@ -1067,13 +1077,13 @@ export function generateSubmoduleContainers(options, configs, prevSubmodules = s
 }
 
 type SubmoduleContainer<P extends UserIdProvider> = {
-    submodule: IdProviderSpec<P>;
-    enabledStorageTypes?: StorageType[];
-    config: UserIdConfig<P>;
-    callback?: ProviderResponse['callback'];
-    idObj;
-    storageMgr: StorageManager;
-    refreshIds?: boolean;
+  submodule: IdProviderSpec<P>;
+  enabledStorageTypes?: StorageType[];
+  config: UserIdConfig<P>;
+  callback?: ProviderResponse['callback'];
+  idObj;
+  storageMgr: StorageManager;
+  refreshIds?: boolean;
 }
 
 /**
@@ -1158,20 +1168,20 @@ function normalizePromise<T extends AnyFunction>(fn: T): Wraps<T> {
 }
 
 declare module '../../src/prebidGlobal' {
-    interface PrebidJS {
-        getUserIds: typeof getUserIds;
-        getUserIdsAsync: typeof getUserIdsAsync;
-        getUserIdsAsEids: typeof getUserIdsAsEids;
-        getEncryptedEidsForSource: typeof getEncryptedEidsForSource;
-        registerSignalSources: typeof registerSignalSources;
-        refreshUserIds: typeof refreshUserIds;
-        getUserIdsAsEidBySource: typeof getUserIdsAsEidBySource;
-    }
+  interface PrebidJS {
+    getUserIds: typeof getUserIds;
+    getUserIdsAsync: typeof getUserIdsAsync;
+    getUserIdsAsEids: typeof getUserIdsAsEids;
+    getEncryptedEidsForSource: typeof getEncryptedEidsForSource;
+    registerSignalSources: typeof registerSignalSources;
+    refreshUserIds: typeof refreshUserIds;
+    getUserIdsAsEidBySource: typeof getUserIdsAsEidBySource;
+  }
 }
 
 const enforceStorageTypeRule = (userIdsConfig, enforceStorageType) => {
   return (params) => {
-    if (params[ACTIVITY_PARAM_COMPONENT_TYPE] !== MODULE_TYPE_UID) return;
+    if (params[ACTIVITY_PARAM_COMPONENT_TYPE] !== MODULE_TYPE_UID || !params[ACTIVITY_PARAM_STORAGE_WRITE]) return;
 
     const matchesName = (query) => params[ACTIVITY_PARAM_COMPONENT_NAME]?.toLowerCase() === query?.toLowerCase();
     const submoduleConfig = userIdsConfig.find((configItem) => matchesName(configItem.name));

package/modules/userId/spec.ts

@@ -7,14 +7,14 @@ import type {ORTBRequest} from "../../src/types/ortb/request";
 export type UserIdProvider = string;
 
 export interface UserId {
-    [idName: string]: unknown;
+  [idName: string]: unknown;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ProvidersToId {
-    /**
-     * Map from ID provider name to the key they provide in .userId.
-     */
+  /**
+   * Map from ID provider name to the key they provide in .userId.
+   */
 }
 
 export type UserIdKeyFor<P extends UserIdProvider> = P extends keyof ProvidersToId ? ProvidersToId[P] : unknown;
@@ -22,54 +22,54 @@ export type UserIdFor<P extends UserIdProvider> = P extends keyof ProvidersToId
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ProviderParams {
-    /**
-     * Map from ID provider name to the type of their configuration params.
-     */
+  /**
+   * Map from ID provider name to the type of their configuration params.
+   */
 }
 
 export interface UserIdConfig<P extends UserIdProvider> {
-    /**
-     * User ID provider name.
-     */
-    name: P;
-    /**
-     * Module specific configuration parameters.
-     */
-    params?: P extends keyof ProviderParams ? ProviderParams[P] : Record<string, unknown>;
-    /**
-     * An array of bidder codes to which this user ID may be sent.
-     */
-    bidders?: BidderCode[];
-    /**
-     * Where the user ID will be stored.
-     */
-    storage?: {
-        /**
-         * Storage method.
-         */
-        type: StorageType | `${typeof STORAGE_TYPE_COOKIES}&${typeof STORAGE_TYPE_LOCALSTORAGE}` | `${typeof STORAGE_TYPE_LOCALSTORAGE}&${typeof STORAGE_TYPE_COOKIES}`;
-        /**
-         * The name of the cookie or html5 local storage where the user ID will be stored.
-         */
-        name: string;
-        /**
-         * How long (in days) the user ID information will be stored. If this parameter isn’t specified,
-         * session cookies are used in cookie-mode, and local storage mode will create new IDs on every page.
-         */
-        expires?: number;
-        /**
-         * The amount of time (in seconds) the user ID should be cached in storage before calling the provider again
-         * to retrieve a potentially updated value for their user ID.
-         * If set, this value should equate to a time period less than the number of days defined in storage.expires.
-         * By default the ID will not be refreshed until it expires.
-         */
-        refreshInSeconds?: number;
-    }
-    /**
-     * Used only if the page has a separate mechanism for storing a User ID.
-     * The value is an object containing the values to be sent to the adapters.
-     */
-    value?: UserIdFor<P>;
+  /**
+   * User ID provider name.
+   */
+  name: P;
+  /**
+   * Module specific configuration parameters.
+   */
+  params?: P extends keyof ProviderParams ? ProviderParams[P] : Record<string, unknown>;
+  /**
+   * An array of bidder codes to which this user ID may be sent.
+   */
+  bidders?: BidderCode[];
+  /**
+   * Where the user ID will be stored.
+   */
+  storage?: {
+    /**
+     * Storage method.
+     */
+    type: StorageType | `${typeof STORAGE_TYPE_COOKIES}&${typeof STORAGE_TYPE_LOCALSTORAGE}` | `${typeof STORAGE_TYPE_LOCALSTORAGE}&${typeof STORAGE_TYPE_COOKIES}`;
+    /**
+     * The name of the cookie or html5 local storage where the user ID will be stored.
+     */
+    name: string;
+    /**
+     * How long (in days) the user ID information will be stored. If this parameter isn’t specified,
+     * session cookies are used in cookie-mode, and local storage mode will create new IDs on every page.
+     */
+    expires?: number;
+    /**
+     * The amount of time (in seconds) the user ID should be cached in storage before calling the provider again
+     * to retrieve a potentially updated value for their user ID.
+     * If set, this value should equate to a time period less than the number of days defined in storage.expires.
+     * By default the ID will not be refreshed until it expires.
+     */
+    refreshInSeconds?: number;
+  }
+  /**
+   * Used only if the page has a separate mechanism for storing a User ID.
+   * The value is an object containing the values to be sent to the adapters.
+   */
+  value?: UserIdFor<P>;
 }
 
 type SerializableId = string | Record<string, unknown>;
@@ -81,14 +81,14 @@ type SerializableId = string | Record<string, unknown>;
  * this data is what may then get stored, passed to decode and, on later sessions, to getId or extendId as the storedId argument.
  */
 export type ProviderResponse = {
-    /**
-     * Serializable ID data. Objects will be passed through JSON.stringify
-     */
-    id?: SerializableId;
-    /**
-     * If provided, will be invoked at a later point.
-     */
-    callback?: (setId: (id: SerializableId) => void, getStoredValue: () => SerializableId) => void;
+  /**
+   * Serializable ID data. Objects will be passed through JSON.stringify
+   */
+  id?: SerializableId;
+  /**
+   * If provided, will be invoked at a later point.
+   */
+  callback?: (setId: (id: SerializableId) => void, getStoredValue: () => SerializableId) => void;
 }
 
 type DecodedId<P extends UserIdProvider> = P extends keyof ProvidersToId ? { [K in UserIdKeyFor<P>]: UserIdFor<P> } & Partial<UserId> : Partial<UserId>;
@@ -96,91 +96,91 @@ type DecodedId<P extends UserIdProvider> = P extends keyof ProvidersToId ? { [K
 type IdValue<K extends keyof UserId> = UserId[K] extends any[] ? UserId[K][number] : UserId[K];
 
 type EIDConfig<K extends keyof UserId> = {
-    /**
-     * Value for eid.source.
-     * Required if getSource is not provided.
-     */
-    source?: string;
-    /**
-     * Returns a string to use for eid.source.
-     * Required if source is not provided.
-     */
-    getSource?: (id: IdValue<K>) => string;
-    /**
-     * Returns an object to use for eid.ext
-     */
-    getEidExt?: (id: IdValue<K>) => Ext;
-    /**
-     * Returns a string to use for eid.uid.id.
-     * If not provided, IDs returned by decode must be strings, and will be used as-is
-     */
-    getValue?: (id: IdValue<K>) => string;
-    /**
-     * Value for eid.uid.atype
-     */
-    atype?: string;
-    /**
-     * Returns an object to use for eids.uid.ext
-     */
-    getUidExt?: (id: IdValue<K>) => Ext;
+  /**
+   * Value for eid.source.
+   * Required if getSource is not provided.
+   */
+  source?: string;
+  /**
+   * Returns a string to use for eid.source.
+   * Required if source is not provided.
+   */
+  getSource?: (id: IdValue<K>) => string;
+  /**
+   * Returns an object to use for eid.ext
+   */
+  getEidExt?: (id: IdValue<K>) => Ext;
+  /**
+   * Returns a string to use for eid.uid.id.
+   * If not provided, IDs returned by decode must be strings, and will be used as-is
+   */
+  getValue?: (id: IdValue<K>) => string;
+  /**
+   * Value for eid.uid.atype
+   */
+  atype?: string;
+  /**
+   * Returns an object to use for eids.uid.ext
+   */
+  getUidExt?: (id: IdValue<K>) => Ext;
 }
 
 type EIDFn<K extends keyof UserId, P extends UserIdProvider> = (ids: IdValue<K>[], config: UserIdConfig<P>) => ORTBRequest['user']['eids'] | ORTBRequest['user']['eids'][number];
 
 export type IdProviderSpec<P extends UserIdProvider> = StorageDisclosure & {
-    /**
-     * Name of your ID provider, used to match your module with the publisher’s userIds configuration
-     */
-    name: P;
-    aliasName?: UserIdProvider;
-    /**
-     * GVL ID to use for TCF. If omitted your module may be excluded when TCF is in scope.
-     */
-    gvlid?: number;
-    disclosureURL?: string;
-    /**
-     * Invoked when:
-     *  - Prebid.js did not previously store your ID, or
-     *  - your previously stored ID has expired (depending on the publisher’s expires and/or refreshInSecondsstorage configuration), or
-     *  - consent data has changed since the last time it was stored, or
-     *  - the publisher explicitly asked for a refresh using refreshUserIds.
-     * @param config Configuration for your module as provided by the publisher
-     * @param consentData available consent data (when the relevant modules are present)
-     * @param storedId Your previously stored ID data, if any, as was returned by getId or extendId
-     */
-    getId: (config: UserIdConfig<P>, consentData: AllConsentData, storedId?: SerializableId) => ProviderResponse;
-    /**
-     * If provided, it’s invoked when getId is not; namely:
-     *
-     *   - Prebid.js previously stored your ID, and
-     *   - the stored ID has not expired, and
-     *   - consent data has not changed since it was stored, and
-     *   - the publisher is not asking for a refresh.
-     *
-     * Takes the same arguments and should return an object in the same format as getId.
-     */
-    extendId?: IdProviderSpec<P>['getId'];
-    /**
-     * Decode ID data. Invoked every time data from your module is available, either from storage or getId / extendId.
-     */
-    decode: (id: SerializableId, config: UserIdConfig<P>) => DecodedId<P>;
-    onDataDeletionRequest?: (config: UserIdConfig<P>, userId: UserId[P], ...cmpArgs: any[]) => void;
-    /**
-     * Domain to use for cookie storage.
-     */
-    domainOverride?: () => string;
-    /**
-     * Return the topmost parent of `fullDomain` (which defaults to the current page) that will allow cookie writes.
-     * This method is attached by the base ID module on submodule registration.
-     */
-    findRootDomain?: (fullDomain?: string) => string;
-    eids?: {
-        [K in keyof UserId]?: K extends string ? EIDConfig<K> | EIDFn<K, P> : never;
-    }
+  /**
+   * Name of your ID provider, used to match your module with the publisher’s userIds configuration
+   */
+  name: P;
+  aliasName?: UserIdProvider;
+  /**
+   * GVL ID to use for TCF. If omitted your module may be excluded when TCF is in scope.
+   */
+  gvlid?: number;
+  disclosureURL?: string;
+  /**
+   * Invoked when:
+   *  - Prebid.js did not previously store your ID, or
+   *  - your previously stored ID has expired (depending on the publisher’s expires and/or refreshInSecondsstorage configuration), or
+   *  - consent data has changed since the last time it was stored, or
+   *  - the publisher explicitly asked for a refresh using refreshUserIds.
+   * @param config Configuration for your module as provided by the publisher
+   * @param consentData available consent data (when the relevant modules are present)
+   * @param storedId Your previously stored ID data, if any, as was returned by getId or extendId
+   */
+  getId: (config: UserIdConfig<P>, consentData: AllConsentData, storedId?: SerializableId) => ProviderResponse;
+  /**
+   * If provided, it’s invoked when getId is not; namely:
+   *
+   *   - Prebid.js previously stored your ID, and
+   *   - the stored ID has not expired, and
+   *   - consent data has not changed since it was stored, and
+   *   - the publisher is not asking for a refresh.
+   *
+   * Takes the same arguments and should return an object in the same format as getId.
+   */
+  extendId?: IdProviderSpec<P>['getId'];
+  /**
+   * Decode ID data. Invoked every time data from your module is available, either from storage or getId / extendId.
+   */
+  decode: (id: SerializableId, config: UserIdConfig<P>) => DecodedId<P>;
+  onDataDeletionRequest?: (config: UserIdConfig<P>, userId: UserId[P], ...cmpArgs: any[]) => void;
+  /**
+   * Domain to use for cookie storage.
+   */
+  domainOverride?: () => string;
+  /**
+   * Return the topmost parent of `fullDomain` (which defaults to the current page) that will allow cookie writes.
+   * This method is attached by the base ID module on submodule registration.
+   */
+  findRootDomain?: (fullDomain?: string) => string;
+  eids?: {
+    [K in keyof UserId]?: K extends string ? EIDConfig<K> | EIDFn<K, P> : never;
+  }
 }
 
 declare module '../../src/hook' {
-    interface Submodules {
-        userId: [IdProviderSpec<UserIdProvider>];
-    }
+  interface Submodules {
+    userId: [IdProviderSpec<UserIdProvider>];
+  }
 }