@highfivve/ad-tag 5.11.9 → 5.12.0

package/lib/ads/modules/inline-ai/index.js

@@ -0,0 +1,114 @@
+import { AssetLoadMethod } from 'ad-tag/util/assetLoaderService';
+import { mkConfigureStepOncePerRequestAdsCycle, mkInitStep } from 'ad-tag/ads/adPipeline';
+const name = 'inline-ai';
+export const createInlineAi = () => {
+    let inlineAiConfig = null;
+    let scriptLoaded = false;
+    const config__ = () => inlineAiConfig;
+    const configure__ = (moduleConfig) => {
+        if (moduleConfig?.inlineAi?.enabled) {
+            inlineAiConfig = moduleConfig.inlineAi;
+        }
+    };
+    const hasConsent = (context) => !context.tcData__.gdprApplies || !!context.tcData__.purpose.consents['1'];
+    const isPlacementActive = (context, placement) => !placement.labelCondition ||
+        context.labelConfigService__.isLabelConditionMet(placement.labelCondition);
+    const mountCommand = (placement) => {
+        switch (placement.type) {
+            case 'widget':
+                return ['mount', placement.type];
+            case 'search-fab':
+                return placement.options
+                    ? ['mount', placement.type, undefined, placement.options]
+                    : ['mount', placement.type];
+            case 'search-embed':
+            case 'search-icon':
+                return placement.options
+                    ? ['mount', placement.type, placement.target, placement.options]
+                    : ['mount', placement.type, placement.target];
+            case 'key-takeaways':
+            case 'single-question':
+            case 'basic-embed':
+                return ['mount', placement.type, placement.target];
+        }
+    };
+    const mountPlacements = (context, cmd, config) => {
+        (config.placements ?? [])
+            .filter(placement => isPlacementActive(context, placement))
+            .forEach(placement => cmd.push(mountCommand(placement)));
+    };
+    const applyMode = (context, cmd, config) => {
+        switch (config.mode) {
+            case 'auto':
+                return;
+            case 'programmatic':
+                cmd.push(['init', { publisherId: config.publisherId }]);
+                mountPlacements(context, cmd, config);
+                return;
+            case 'hybrid':
+                mountPlacements(context, cmd, config);
+                return;
+        }
+    };
+    const loadScript = (context, config) => {
+        if (scriptLoaded) {
+            return;
+        }
+        scriptLoaded = true;
+        context.assetLoaderService__
+            .loadScript({
+            name,
+            loadMethod: AssetLoadMethod.TAG,
+            assetUrl: `${config.scriptUrl}?key=${config.publisherId}`,
+            type: 'module'
+        })
+            .catch(error => context.logger__.error(name, 'failed to load InlineAI script', error));
+    };
+    const isFirstRun = (context) => context.requestAdsCalls__ === 1;
+    const runInlineAi = (context, config) => {
+        if (context.env__ === 'test') {
+            return Promise.resolve();
+        }
+        if (!hasConsent(context)) {
+            context.logger__.warn(name, 'no gdpr consent, InlineAI will not be loaded');
+            return Promise.resolve();
+        }
+        if (config.mode !== 'auto') {
+            context.window__.InlineAI = context.window__.InlineAI || { cmd: [] };
+            const cmd = context.window__.InlineAI.cmd;
+            if (!isFirstRun(context)) {
+                cmd.push(['destroy']);
+            }
+            applyMode(context, cmd, config);
+        }
+        loadScript(context, config);
+        return Promise.resolve();
+    };
+    const initSteps__ = () => {
+        const config = inlineAiConfig;
+        return config
+            ? [
+                mkInitStep('inline-ai-init', context => context.config__.spa?.enabled ? Promise.resolve() : runInlineAi(context, config))
+            ]
+            : [];
+    };
+    const configureSteps__ = () => {
+        const config = inlineAiConfig;
+        return config
+            ? [
+                mkConfigureStepOncePerRequestAdsCycle('inline-ai-configure', context => context.config__.spa?.enabled ? runInlineAi(context, config) : Promise.resolve())
+            ]
+            : [];
+    };
+    return {
+        name,
+        configKey: 'inlineAi',
+        description: 'loads the InlineAI SDK and drives placement rendering',
+        moduleType: 'engagement',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__,
+        prepareRequestAdsSteps__: () => []
+    };
+};

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

@@ -0,0 +1,34 @@
+import { mkInitStep } from 'ad-tag/ads/adPipeline';
+const name = 'styles loader';
+export const createStylesLoader = () => {
+    let stylesConfig = null;
+    const config__ = () => stylesConfig;
+    const configure__ = (moduleConfig) => {
+        if (moduleConfig?.styles?.enabled) {
+            stylesConfig = moduleConfig.styles;
+        }
+    };
+    const loadStylesheet = (context, config) => {
+        const link = context.window__.document.createElement('link');
+        link.rel = 'stylesheet';
+        link.href = config.href;
+        link.addEventListener('error', () => context.logger__.error(name, `failed to load stylesheet ${config.href}`));
+        context.window__.document.head.prepend(link);
+        return Promise.resolve();
+    };
+    const initSteps__ = () => {
+        const config = stylesConfig;
+        return config ? [mkInitStep('styles-init', ctx => loadStylesheet(ctx, config))] : [];
+    };
+    return {
+        name,
+        configKey: 'styles',
+        description: "injects the publisher's stylesheet as a base layer in <head>",
+        moduleType: 'creatives',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__: () => [],
+        prepareRequestAdsSteps__: () => []
+    };
+};

package/lib/bundle/inline-ai.js

@@ -0,0 +1,2 @@
+import { createInlineAi } from '../ads/modules/inline-ai';
+window.moli.registerModule(createInlineAi());

package/lib/bundle/styles.js

@@ -0,0 +1,2 @@
+import { createStylesLoader } from '../ads/modules/styles';
+window.moli.registerModule(createStylesLoader());

package/lib/console/components/moduleConfigs.js

@@ -321,6 +321,17 @@ const MoliAnalyticsModule = ({ config }) => (React.createElement(React.Fragment,
             "delay: ",
             config.batchDelay ?? 100,
             "ms"))));
+const StylesModule = ({ config }) => (React.createElement(Row, { label: "Stylesheet" },
+    React.createElement(Tag, null, config.href)));
+const InlineAiModule = ({ config }) => (React.createElement(React.Fragment, null,
+    React.createElement(Row, { label: "Publisher ID" },
+        React.createElement(Tag, null, config.publisherId)),
+    React.createElement(Row, { label: "Mode" },
+        React.createElement(Tag, null, config.mode)),
+    React.createElement(Row, { label: "Script URL" },
+        React.createElement(Tag, { variant: "grey" }, config.scriptUrl)),
+    React.createElement(Row, { label: "Placements" },
+        React.createElement(ListTags, { values: config.placements?.map(placement => placement.name) }))));
 const GenericModule = ({ config, subEntry }) => (React.createElement(React.Fragment, null, Object.entries(config)
     .filter(([key]) => key !== 'enabled')
     .map(([key, value]) => (React.createElement(TagContainer, { key: key, subEntry: subEntry },
@@ -336,8 +347,10 @@ const moduleComponents = {
     emetriq: EmetriqModule,
     geoedge: GeoEdgeModule,
     identitylink: IdentityLinkModule,
+    inlineAi: InlineAiModule,
     pubstack: PubstackModule,
     skin: SkinModule,
+    styles: StylesModule,
     stickyHeaderAd: StickyHeaderAdModule,
     utiq: UtiqModule,
     prebidFirstPartyData: PrebidFirstPartyDataModule,

package/lib/gen/packageJson.js

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

package/package.json

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