@highfivve/ad-tag 5.13.2 → 5.13.4

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

@@ -0,0 +1,107 @@
+import { mkConfigureStepOncePerRequestAdsCycle, mkInitStep } from 'ad-tag/ads/adPipeline';
+import { AssetLoadMethod } from 'ad-tag/util/assetLoaderService';
+const gvlid = '1323';
+const name = 'intentiq';
+export const createIntentIq = () => {
+    let intentIqConfig = null;
+    const hasVendorConsent = (context) => !context.tcData__.gdprApplies || Boolean(context.tcData__.vendor.consents[gvlid]);
+    const loadIntentIqScript = (config, context) => {
+        if (context.env__ === 'test' || !config.scriptUrl) {
+            return Promise.resolve();
+        }
+        if (!hasVendorConsent(context)) {
+            context.logger__.debug('IntentIQ', 'no vendor consent. Skipping script loading');
+            return Promise.resolve();
+        }
+        return context.assetLoaderService__
+            .loadScript({
+            name,
+            assetUrl: config.scriptUrl,
+            loadMethod: AssetLoadMethod.TAG
+        })
+            .catch(error => context.logger__.error('failed to load intentiq', error));
+    };
+    const mkUserIdProvider = (config, context) => ({
+        name: 'intentIqId',
+        storage: {
+            type: 'html5',
+            name: 'intentIqId',
+            expires: config.storage?.expires ?? 0,
+            refreshInSeconds: config.storage?.refreshInSeconds ?? 0
+        },
+        params: {
+            partner: config.partner,
+            region: 'gdpr',
+            ...(context.adUnitPathVariables__.domain
+                ? { domainName: context.adUnitPathVariables__.domain }
+                : {}),
+            ...(config.browserBlackList ? { browserBlackList: config.browserBlackList } : {}),
+            ...(config.abPercentage === undefined ? {} : { abPercentage: config.abPercentage }),
+            ...(config.ABTestingConfigurationSource
+                ? { ABTestingConfigurationSource: config.ABTestingConfigurationSource }
+                : {}),
+            ...(config.group ? { group: config.group } : {}),
+            ...(config.gamParameterName
+                ? {
+                    gamParameterName: config.gamParameterName,
+                    gamObjectReference: context.window__.googletag
+                }
+                : {})
+        }
+    });
+    const configureUserId = (config, context) => {
+        if (context.env__ === 'test' || !context.config__.prebid) {
+            return Promise.resolve();
+        }
+        if (!context.adUnitPathVariables__.domain) {
+            context.logger__.warn('IntentIQ', 'no domain ad unit path variable set. The intentIqId provider will be configured without a domainName');
+        }
+        context.window__.pbjs.que.push(() => {
+            const userIds = context.window__.pbjs.getConfig().userSync?.userIds;
+            if (userIds?.some(userId => userId.name === 'intentIqId')) {
+                context.logger__.debug('IntentIQ', 'intentIqId userId provider already configured');
+                return;
+            }
+            context.window__.pbjs.mergeConfig({
+                userSync: { userIds: [mkUserIdProvider(config, context)] }
+            });
+        });
+        return Promise.resolve();
+    };
+    return {
+        name,
+        configKey: 'intentiq',
+        description: 'Configures the IntentIQ prebid userId submodule',
+        moduleType: 'identity',
+        config__() {
+            return intentIqConfig;
+        },
+        configure__(moduleConfig) {
+            if (moduleConfig?.intentiq && moduleConfig.intentiq.enabled) {
+                intentIqConfig = moduleConfig.intentiq;
+            }
+        },
+        initSteps__() {
+            const config = intentIqConfig;
+            return config
+                ? [
+                    mkInitStep(name, ctx => {
+                        loadIntentIqScript(config, ctx);
+                        return Promise.resolve();
+                    })
+                ]
+                : [];
+        },
+        configureSteps__() {
+            const config = intentIqConfig;
+            return config
+                ? [
+                    mkConfigureStepOncePerRequestAdsCycle(`${name}-configure`, ctx => configureUserId(config, ctx))
+                ]
+                : [];
+        },
+        prepareRequestAdsSteps__() {
+            return [];
+        }
+    };
+};

package/lib/ads/modules/sticky-footer-ad-v2/footerStickyAd.js

@@ -1,13 +1,16 @@
 import { isAdvertiserIncluded } from 'ad-tag/ads/isAdvertiserIncluded';
+import { isGamAnchor } from 'ad-tag/ads/auctions/anchorContext';
 const adStickyContainerDataRef = '[data-ref=h5v-sticky-ad]';
 const adStickyCloseButtonDataRef = '[data-ref=h5v-sticky-ad-close]';
 const adStickyCloseButtonContent = '.h5v-closeButtonContent';
 const adStickyHidingClass = 'h5v-footerAd--hidden';
 const desktopInitialHidingClass = 'h5v-footerAd--hidden-d';
 const mobileInitialHidingClass = 'h5v-footerAd--hidden-m';
-const stickyRenderedEvent = (mobileStickyDomId, disallowedAdvertiserIds, channel, window) => new Promise(resolve => {
+const isStickySlotEvent = (slot, mobileStickyDomId, resolvedAdUnitPath, channel, window) => slot.getSlotElementId() === mobileStickyDomId ||
+    (channel === 'gam' && isGamAnchor(slot, window) && slot.getAdUnitPath() === resolvedAdUnitPath);
+const stickyRenderedEvent = (mobileStickyDomId, resolvedAdUnitPath, disallowedAdvertiserIds, channel, window) => new Promise(resolve => {
     const listener = (event) => {
-        if (event.slot.getSlotElementId() !== mobileStickyDomId) {
+        if (!isStickySlotEvent(event.slot, mobileStickyDomId, resolvedAdUnitPath, channel, window)) {
             return;
         }
         if (channel === 'gam') {
@@ -44,7 +47,7 @@ const hideAdSlot = (element) => {
 const showAdSlot = (element) => {
     element.classList.remove(adStickyHidingClass, desktopInitialHidingClass, mobileInitialHidingClass);
 };
-export const initAdSticky = (window, env, log, footerStickyDomId, disallowedAdvertiserIds, channel, closingButtonText) => {
+export const initAdSticky = (window, env, log, footerStickyDomId, resolvedAdUnitPath, disallowedAdvertiserIds, channel, closingButtonText) => {
     const stickyAd = 'sticky-ad';
     const adSticky = window.document.querySelector(adStickyContainerDataRef);
     const closeButton = window.document.querySelector(adStickyCloseButtonDataRef);
@@ -91,7 +94,7 @@ export const initAdSticky = (window, env, log, footerStickyDomId, disallowedAdve
             else if (renderResult === 'standard') {
                 showAdSlot(adSticky);
                 const stickyOnLoadEventPromise = stickyOnLoadEvent(footerStickyDomId, window);
-                return stickyRenderedEvent(footerStickyDomId, disallowedAdvertiserIds, channel, window)
+                return stickyRenderedEvent(footerStickyDomId, resolvedAdUnitPath, disallowedAdvertiserIds, channel, window)
                     .then(result => result === 'empty' || result === 'disallowed'
                     ? Promise.resolve(result)
                     : stickyOnLoadEventPromise.then(() => result))
@@ -102,7 +105,7 @@ export const initAdSticky = (window, env, log, footerStickyDomId, disallowedAdve
         if (env === 'production') {
             if (footerStickyDomId) {
                 const stickyOnLoadEventPromise = stickyOnLoadEvent(footerStickyDomId, window);
-                stickyRenderedEvent(footerStickyDomId, disallowedAdvertiserIds, channel, window)
+                stickyRenderedEvent(footerStickyDomId, resolvedAdUnitPath, disallowedAdvertiserIds, channel, window)
                     .then(result => result === 'empty' || result === 'disallowed'
                     ? Promise.resolve(result)
                     : stickyOnLoadEventPromise.then(() => result))

package/lib/ads/modules/sticky-footer-ad-v2/index.js

@@ -1,4 +1,5 @@
 import { LOW_PRIORITY, mkPrepareRequestAdsStep } from 'ad-tag/ads/adPipeline';
+import { resolveAdUnitPath } from 'ad-tag/ads/adUnitPath';
 import { initAdSticky } from './footerStickyAd';
 export const createStickyFooterAdsV2 = () => {
     const name = 'sticky-footer-ads-v2';
@@ -22,7 +23,7 @@ export const createStickyFooterAdsV2 = () => {
                     }
                     if (footerAdSlot) {
                         const channel = ctx.auction__.anchorBottomChannel(footerAdSlot.moliSlot.domId);
-                        initAdSticky(ctx.window__, ctx.env__, ctx.logger__, footerAdSlot.moliSlot.domId, config.disallowedAdvertiserIds, channel, config.closingButtonText);
+                        initAdSticky(ctx.window__, ctx.env__, ctx.logger__, footerAdSlot.moliSlot.domId, resolveAdUnitPath(footerAdSlot.moliSlot.adUnitPath, ctx.adUnitPathVariables__), config.disallowedAdvertiserIds, channel, config.closingButtonText);
                     }
                     return Promise.resolve();
                 })

package/lib/ads/modules/sticky-header-ad/renderResult.js

@@ -1,11 +1,20 @@
 import { isAdvertiserIncluded } from 'ad-tag/ads/isAdvertiserIncluded';
+import { resolveAdUnitPath } from 'ad-tag/ads/adUnitPath';
+import { isGamAnchor } from 'ad-tag/ads/auctions/anchorContext';
 export const adRenderResult = (ctx, headerSlot, disallowedAdvertiserIds, channel, minVisibleDuration) => new Promise(resolve => {
     if (ctx.env__ === 'test') {
         resolve('standard');
         return;
     }
+    const resolvedAdUnitPath = channel === 'gam'
+        ? resolveAdUnitPath(headerSlot.adUnitPath, ctx.adUnitPathVariables__)
+        : null;
+    const isHeaderSlotEvent = (slot) => slot.getSlotElementId() === headerSlot.domId ||
+        (resolvedAdUnitPath !== null &&
+            isGamAnchor(slot, ctx.window__) &&
+            slot.getAdUnitPath() === resolvedAdUnitPath);
     const listener = event => {
-        if (event.slot.getSlotElementId() !== headerSlot.domId) {
+        if (!isHeaderSlotEvent(event.slot)) {
             return;
         }
         if (channel === 'gam') {

package/lib/bundle/intentIq.js

@@ -0,0 +1,2 @@
+import { createIntentIq } from 'ad-tag/ads/modules/intentiq';
+window.moli.registerModule(createIntentIq());

package/lib/console/components/moduleConfigs.js

@@ -167,6 +167,23 @@ const IdentityLinkModule = ({ config }) => (React.createElement(React.Fragment,
         React.createElement(Tag, { variant: config.hashedEmailAddresses.length > 0 ? 'green' : 'grey' },
             config.hashedEmailAddresses.length,
             " provided"))));
+const IntentIqModule = ({ config }) => (React.createElement(React.Fragment, null,
+    React.createElement(Row, { label: "Partner" },
+        React.createElement(Tag, null, config.partner)),
+    config.gamParameterName && (React.createElement(Row, { label: "GAM parameter" },
+        React.createElement(Tag, null, config.gamParameterName))),
+    (config.ABTestingConfigurationSource || config.group || config.abPercentage !== undefined) && (React.createElement(Row, { label: "A/B testing" },
+        config.ABTestingConfigurationSource && (React.createElement(Tag, { variant: "blue" }, config.ABTestingConfigurationSource)),
+        config.group && React.createElement(Tag, { variant: "grey" },
+            "group ",
+            config.group),
+        config.abPercentage !== undefined && React.createElement(Tag, { variant: "grey" },
+            config.abPercentage,
+            "%"))),
+    config.browserBlackList && (React.createElement(Row, { label: "Browser blacklist" },
+        React.createElement(ListTags, { values: config.browserBlackList.split(','), variant: "grey" }))),
+    config.scriptUrl && (React.createElement(Row, { label: "Script URL" },
+        React.createElement(Tag, null, config.scriptUrl)))));
 const PubstackModule = ({ config }) => (React.createElement(Row, { label: "Tag ID" },
     React.createElement(Tag, null, config.tagId)));
 const SkinModule = ({ config }) => (React.createElement(React.Fragment, null, config.configs.map((skinConfig, index) => (React.createElement(Fragment, { key: index },
@@ -348,6 +365,7 @@ const moduleComponents = {
     geoedge: GeoEdgeModule,
     identitylink: IdentityLinkModule,
     inlineAi: InlineAiModule,
+    intentiq: IntentIqModule,
     pubstack: PubstackModule,
     skin: SkinModule,
     styles: StylesModule,

package/lib/gen/packageJson.js

@@ -1,3 +1,3 @@
 export const packageJson = {
-    version: '5.13.2'
+    version: '5.13.4'
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@highfivve/ad-tag",
-  "version": "5.13.2",
+  "version": "5.13.4",
   "license": "Apache-2.0",
   "description": "An ad tag implementation called moli",
   "main": "./lib/index.js",