@highfivve/ad-tag 5.8.17 → 5.8.21

package/lib/ads/modules/cleanup/index.js

@@ -1,61 +1,53 @@
 import { mkPrepareRequestAdsStep, HIGH_PRIORITY, mkConfigureStepOncePerRequestAdsCycle } from 'ad-tag/ads/adPipeline';
-export class Cleanup {
-    constructor() {
-        this.name = 'cleanup';
-        this.description = 'cleanup out-of-page formats on navigation or ad-reload';
-        this.moduleType = 'creatives';
-        this.cleanupConfig = null;
-        this.cleanUp = (context, configs) => {
-            configs.forEach(config => {
-                if ('cssSelectors' in config.deleteMethod) {
-                    config.deleteMethod.cssSelectors.forEach((selector) => {
-                        const elements = context.window__.document.querySelectorAll(selector);
-                        context.logger__.debug('Cleanup Module', `Remove elements with selector ${selector} from dom`, elements);
-                        elements.forEach((element) => {
-                            try {
-                                element.remove();
-                            }
-                            catch (e) {
-                                context.logger__.error('Cleanup Module', `Error removing element with selector ${selector}`, e);
-                            }
-                        });
-                    });
-                }
-                else {
-                    config.deleteMethod.jsAsString.forEach(jsLineAsString => {
+export const createCleanup = () => {
+    const name = 'cleanup';
+    let cleanupConfig = null;
+    const config__ = () => cleanupConfig;
+    const configure__ = (modulesConfig) => {
+        if (modulesConfig?.cleanup && modulesConfig.cleanup.enabled) {
+            cleanupConfig = modulesConfig.cleanup;
+        }
+    };
+    const initSteps__ = () => [];
+    const cleanUp = (context, configs) => {
+        configs.forEach(config => {
+            if ('cssSelectors' in config.deleteMethod) {
+                config.deleteMethod.cssSelectors.forEach((selector) => {
+                    const elements = context.window__.document.querySelectorAll(selector);
+                    context.logger__.debug('Cleanup Module', `Remove elements with selector ${selector} from dom`, elements);
+                    elements.forEach((element) => {
                         try {
-                            context.logger__.debug('Cleanup Module', `Try to execute string as JS: '${jsLineAsString}'`);
-                            const jsFunction = new Function(jsLineAsString);
-                            jsFunction();
+                            element.remove();
                         }
                         catch (e) {
-                            context.logger__.error('Cleanup Module', `Error executing JS string: '${jsLineAsString}'`, e);
+                            context.logger__.error('Cleanup Module', `Error removing element with selector ${selector}`, e);
                         }
                     });
-                }
-            });
-        };
-        this.hasBidderWonLastAuction = (context, config) => {
-            const prebidWinningBids = context.window__.pbjs.getAllWinningBids();
-            const bidderThatWonLastAuctionOnSlot = prebidWinningBids
-                .filter(bid => bid.adUnitCode === config.domId)
-                .at(-1)?.bidder;
-            return bidderThatWonLastAuctionOnSlot === config.bidder;
-        };
-    }
-    configure__(modulesConfig) {
-        if (modulesConfig?.cleanup && modulesConfig.cleanup.enabled) {
-            this.cleanupConfig = modulesConfig.cleanup;
-        }
-    }
-    config__() {
-        return this.cleanupConfig;
-    }
-    initSteps__() {
-        return [];
-    }
-    configureSteps__() {
-        const config = this.cleanupConfig;
+                });
+            }
+            else {
+                config.deleteMethod.jsAsString.forEach(jsLineAsString => {
+                    try {
+                        context.logger__.debug('Cleanup Module', `Try to execute string as JS: '${jsLineAsString}'`);
+                        const jsFunction = new Function(jsLineAsString);
+                        jsFunction();
+                    }
+                    catch (e) {
+                        context.logger__.error('Cleanup Module', `Error executing JS string: '${jsLineAsString}'`, e);
+                    }
+                });
+            }
+        });
+    };
+    const hasBidderWonLastAuction = (context, config) => {
+        const prebidWinningBids = context.window__.pbjs.getAllWinningBids();
+        const bidderThatWonLastAuctionOnSlot = prebidWinningBids
+            .filter(bid => bid.adUnitCode === config.domId)
+            .at(-1)?.bidder;
+        return bidderThatWonLastAuctionOnSlot === config.bidder;
+    };
+    const configureSteps__ = () => {
+        const config = cleanupConfig;
         return config
             ? [
                 mkConfigureStepOncePerRequestAdsCycle('destroy-out-of-page-ad-format', (context) => {
@@ -63,16 +55,16 @@ export class Cleanup {
                         return Promise.resolve();
                     }
                     context.window__.pbjs.que.push(() => {
-                        const configsOfDomIdsThatNeedToBeCleaned = config.configs.filter(config => this.hasBidderWonLastAuction(context, config));
-                        this.cleanUp(context, configsOfDomIdsThatNeedToBeCleaned);
+                        const configsOfDomIdsThatNeedToBeCleaned = config.configs.filter(config => hasBidderWonLastAuction(context, config));
+                        cleanUp(context, configsOfDomIdsThatNeedToBeCleaned);
                     });
                     return Promise.resolve();
                 })
             ]
             : [];
-    }
-    prepareRequestAdsSteps__() {
-        const config = this.cleanupConfig;
+    };
+    const prepareRequestAdsSteps__ = () => {
+        const config = cleanupConfig;
         return config
             ? [
                 mkPrepareRequestAdsStep('cleanup-before-ad-reload', HIGH_PRIORITY, (context, slots) => {
@@ -82,12 +74,23 @@ export class Cleanup {
                     context.window__.pbjs.que.push(() => {
                         const configsOfDomIdsThatNeedToBeCleaned = config.configs
                             .filter(config => slots.map(slot => slot.moliSlot.domId).includes(config.domId))
-                            .filter(config => this.hasBidderWonLastAuction(context, config));
-                        this.cleanUp(context, configsOfDomIdsThatNeedToBeCleaned);
+                            .filter(config => hasBidderWonLastAuction(context, config));
+                        cleanUp(context, configsOfDomIdsThatNeedToBeCleaned);
                     });
                     return Promise.resolve();
                 })
             ]
             : [];
-    }
-}
+    };
+    return {
+        name,
+        description: 'cleanup out-of-page formats on navigation or ad-reload',
+        moduleType: 'creatives',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__,
+        prepareRequestAdsSteps__,
+        cleanUp
+    };
+};

package/lib/ads/modules/confiant/index.js

@@ -1,47 +1,47 @@
 import { AssetLoadMethod } from 'ad-tag/util/assetLoaderService';
 import { mkInitStep } from 'ad-tag/ads/adPipeline';
-export class Confiant {
-    constructor() {
-        this.name = 'confiant';
-        this.description = 'ad fraud detection and protection module';
-        this.moduleType = 'ad-fraud';
-        this.gvlid = '56';
-        this.confiantConfig = null;
-    }
-    config__() {
-        return this.confiantConfig;
-    }
-    configure__(moduleConfig) {
+export const createConfiant = () => {
+    const name = 'confiant';
+    const gvlid = '56';
+    let confiantConfig = null;
+    const config__ = () => confiantConfig;
+    const configure__ = (moduleConfig) => {
         if (moduleConfig?.confiant && moduleConfig.confiant.enabled) {
-            this.confiantConfig = moduleConfig.confiant;
+            confiantConfig = moduleConfig.confiant;
         }
-    }
-    initSteps__() {
-        const config = this.confiantConfig;
-        return config ? [mkInitStep('confiant-init', ctx => this.loadConfiant(ctx, config))] : [];
-    }
-    loadConfiant(context, config) {
+    };
+    const loadConfiant = (context, config) => {
         if (context.env__ === 'test') {
             return Promise.resolve();
         }
         if (context.tcData__.gdprApplies &&
             (!context.tcData__.purpose.consents['1'] ||
-                !(!this.confiantConfig?.checkGVLID || context.tcData__.vendor.consents[this.gvlid]))) {
+                !(!confiantConfig?.checkGVLID || context.tcData__.vendor.consents[gvlid]))) {
             return Promise.resolve();
         }
         context.assetLoaderService__
             .loadScript({
-            name: this.name,
+            name,
             loadMethod: AssetLoadMethod.TAG,
             assetUrl: config.assetUrl
         })
             .catch(error => context.logger__.error('failed to load confiant', error));
         return Promise.resolve();
-    }
-    configureSteps__() {
-        return [];
-    }
-    prepareRequestAdsSteps__() {
-        return [];
-    }
-}
+    };
+    const initSteps__ = () => {
+        const config = confiantConfig;
+        return config ? [mkInitStep('confiant-init', ctx => loadConfiant(ctx, config))] : [];
+    };
+    const configureSteps__ = () => [];
+    const prepareRequestAdsSteps__ = () => [];
+    return {
+        name,
+        description: 'ad fraud detection and protection module',
+        moduleType: 'ad-fraud',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__,
+        prepareRequestAdsSteps__
+    };
+};

package/lib/ads/modules/emetriq/index.js

@@ -2,24 +2,96 @@ import { AssetLoadMethod } from 'ad-tag/util/assetLoaderService';
 import { trackInApp } from './trackInApp';
 import { shouldTrackLoginEvent, trackLoginEvent } from './trackLoginEvent';
 import { mkConfigureStepOncePerRequestAdsCycle, mkInitStep } from 'ad-tag/ads/adPipeline';
-export class Emetriq {
-    constructor() {
-        this.name = 'emetriq';
-        this.description = 'Provides Emetriq data collection functionality to Moli.';
-        this.moduleType = 'dmp';
-        this.gvlid = '213';
-        this.emetriqConfig = null;
+export const prebidIdentifiers = (ctx) => {
+    const identifier = {};
+    const userIds = ctx.window__.pbjs.getUserIds();
+    if (userIds.amxId) {
+        identifier.id_amxid = userIds.amxId;
     }
-    config__() {
-        return this.emetriqConfig;
+    if (userIds.idl_env) {
+        identifier.id_liveramp = userIds.idl_env;
     }
-    configure__(moduleConfig) {
-        if (moduleConfig?.emetriq && moduleConfig.emetriq.enabled) {
-            this.emetriqConfig = moduleConfig.emetriq;
+    if (userIds.IDP) {
+        identifier.id_zeotap = userIds.IDP;
+    }
+    if (userIds.pubcid) {
+        identifier.id_sharedid = userIds.pubcid;
+    }
+    if (userIds.id5id) {
+        identifier.id_id5 = userIds.id5id.uid;
+    }
+    return identifier;
+};
+export const syncDelay = (ctx, delay) => {
+    if (delay) {
+        if (typeof delay === 'number') {
+            return new Promise(resolve => ctx.window__.setTimeout(() => resolve({}), delay));
+        }
+        else {
+            if (ctx.window__.pbjs) {
+                return new Promise(resolve => {
+                    ctx.window__.pbjs.que.push(() => {
+                        const listener = () => {
+                            resolve(prebidIdentifiers(ctx));
+                            ctx.window__.pbjs.offEvent('auctionEnd', listener);
+                        };
+                        ctx.window__.pbjs.onEvent('auctionEnd', listener);
+                    });
+                });
+            }
+            else {
+                ctx.logger__.error('emetriq', 'No sync delay, because window.pbjs is not defined!');
+                return Promise.resolve({});
+            }
         }
     }
-    initSteps__() {
-        const config = this.emetriqConfig;
+    return Promise.resolve({});
+};
+export const staticCustomParams = (targeting, mappings) => {
+    let additionalCustomParams = {};
+    (mappings ?? []).forEach(({ param, key }) => {
+        const value = targeting[key];
+        if (value) {
+            additionalCustomParams[param] = typeof value === 'string' ? value : value.join(',');
+        }
+    });
+    return additionalCustomParams;
+};
+export const Emetriq = { syncDelay, staticCustomParams, prebidIdentifiers };
+export const createEmetriq = () => {
+    const name = 'emetriq';
+    const gvlid = '213';
+    let emetriqConfig = null;
+    const config__ = () => emetriqConfig;
+    const configure__ = (moduleConfig) => {
+        if (moduleConfig?.emetriq && moduleConfig.emetriq.enabled) {
+            emetriqConfig = moduleConfig.emetriq;
+        }
+    };
+    const checkIfConsentIsMissing = (ctx) => {
+        if (ctx.tcData__.gdprApplies && !ctx.tcData__.vendor.consents[gvlid]) {
+            ctx.logger__.warn(name, 'missing consent');
+            return true;
+        }
+        return false;
+    };
+    const loadEmetriqScript = (context, webConfig, additionalIdentifier, additionalCustomParams) => {
+        const window = context.window__;
+        window._enqAdpParam = {
+            ...webConfig._enqAdpParam,
+            ...additionalIdentifier,
+            ...additionalCustomParams
+        };
+        return context.assetLoaderService__
+            .loadScript({
+            name,
+            loadMethod: AssetLoadMethod.TAG,
+            assetUrl: `https://ups.xplosion.de/loader/${webConfig._enqAdpParam.sid}/default.js`
+        })
+            .catch(error => context.logger__.error('failed to load emetriq', error));
+    };
+    const initSteps__ = () => {
+        const config = emetriqConfig;
         return config
             ? [
                 mkInitStep('load-emetriq', ctx => {
@@ -27,13 +99,13 @@ export class Emetriq {
                     if (ctx.env__ === 'test') {
                         return Promise.resolve();
                     }
-                    if (this.checkIfConsentIsMissing(ctx)) {
+                    if (checkIfConsentIsMissing(ctx)) {
                         return Promise.resolve();
                     }
                     Emetriq.syncDelay(ctx, config.syncDelay).then(additionalIdentifier => {
                         switch (config.os) {
                             case 'web':
-                                this.loadEmetriqScript(ctx, config, additionalIdentifier, customParams);
+                                loadEmetriqScript(ctx, config, additionalIdentifier, customParams);
                                 break;
                         }
                     });
@@ -41,9 +113,9 @@ export class Emetriq {
                 })
             ]
             : [];
-    }
-    configureSteps__() {
-        const config = this.emetriqConfig;
+    };
+    const configureSteps__ = () => {
+        const config = emetriqConfig;
         return config
             ? [
                 mkConfigureStepOncePerRequestAdsCycle('track-emetriq', ctx => {
@@ -51,7 +123,7 @@ export class Emetriq {
                     if (ctx.env__ === 'test') {
                         return Promise.resolve();
                     }
-                    if (this.checkIfConsentIsMissing(ctx)) {
+                    if (checkIfConsentIsMissing(ctx)) {
                         return Promise.resolve();
                     }
                     if (config.login &&
@@ -70,85 +142,18 @@ export class Emetriq {
                 })
             ]
             : [];
-    }
-    prepareRequestAdsSteps__() {
-        return [];
-    }
-    checkIfConsentIsMissing(ctx) {
-        if (ctx.tcData__.gdprApplies && !ctx.tcData__.vendor.consents[this.gvlid]) {
-            ctx.logger__.warn(this.name, 'missing consent');
-            return true;
-        }
-        return false;
-    }
-    loadEmetriqScript(context, webConfig, additionalIdentifier, additionalCustomParams) {
-        const window = context.window__;
-        window._enqAdpParam = {
-            ...webConfig._enqAdpParam,
-            ...additionalIdentifier,
-            ...additionalCustomParams
-        };
-        return context.assetLoaderService__
-            .loadScript({
-            name: this.name,
-            loadMethod: AssetLoadMethod.TAG,
-            assetUrl: `https://ups.xplosion.de/loader/${webConfig._enqAdpParam.sid}/default.js`
-        })
-            .catch(error => context.logger__.error('failed to load emetriq', error));
-    }
-    static syncDelay(ctx, delay) {
-        if (delay) {
-            if (typeof delay === 'number') {
-                return new Promise(resolve => ctx.window__.setTimeout(() => resolve({}), delay));
-            }
-            else {
-                if (ctx.window__.pbjs) {
-                    return new Promise(resolve => {
-                        ctx.window__.pbjs.que.push(() => {
-                            const listener = () => {
-                                resolve(Emetriq.prebidIdentifiers(ctx));
-                                ctx.window__.pbjs.offEvent('auctionEnd', listener);
-                            };
-                            ctx.window__.pbjs.onEvent('auctionEnd', listener);
-                        });
-                    });
-                }
-                else {
-                    ctx.logger__.error('emetriq', 'No sync delay, because window.pbjs is not defined!');
-                    return Promise.resolve({});
-                }
-            }
-        }
-        return Promise.resolve({});
-    }
-    static staticCustomParams(targeting, mappings) {
-        let additionalCustomParams = {};
-        (mappings ?? []).forEach(({ param, key }) => {
-            const value = targeting[key];
-            if (value) {
-                additionalCustomParams[param] = typeof value === 'string' ? value : value.join(',');
-            }
-        });
-        return additionalCustomParams;
-    }
-    static prebidIdentifiers(ctx) {
-        const identifier = {};
-        const userIds = ctx.window__.pbjs.getUserIds();
-        if (userIds.amxId) {
-            identifier.id_amxid = userIds.amxId;
-        }
-        if (userIds.idl_env) {
-            identifier.id_liveramp = userIds.idl_env;
-        }
-        if (userIds.IDP) {
-            identifier.id_zeotap = userIds.IDP;
-        }
-        if (userIds.pubcid) {
-            identifier.id_sharedid = userIds.pubcid;
-        }
-        if (userIds.id5id) {
-            identifier.id_id5 = userIds.id5id.uid;
-        }
-        return identifier;
-    }
-}
+    };
+    const prepareRequestAdsSteps__ = () => [];
+    return {
+        name,
+        description: 'Provides Emetriq data collection functionality to Moli.',
+        moduleType: 'dmp',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__,
+        prepareRequestAdsSteps__,
+        checkIfConsentIsMissing,
+        loadEmetriqScript
+    };
+};