@guardian/commercial-core 0.37.2 → 0.41.0

package/dist/cjs/EventTimer.d.ts

@@ -19,7 +19,9 @@ interface SlotEventStatus {
 }
 interface PageEventStatus {
     commercialStart: boolean;
-    commercialEnd: boolean;
+    commercialExtraModulesLoaded: boolean;
+    commercialBaseModulesLoaded: boolean;
+    commercialModulesLoaded: boolean;
 }
 export declare class EventTimer {
     private _events;

package/dist/cjs/EventTimer.js

@@ -29,7 +29,9 @@ class EventTimer {
             },
             page: {
                 commercialStart: false,
-                commercialEnd: false,
+                commercialExtraModulesLoaded: false,
+                commercialBaseModulesLoaded: false,
+                commercialModulesLoaded: false,
             },
         };
         this.gaConfig = {
@@ -45,7 +47,7 @@ class EventTimer {
                     timingLabel: 'Commercial start parse time',
                 },
                 {
-                    timingVariable: 'commercialEnd',
+                    timingVariable: 'commercialModulesLoaded',
                     timingLabel: 'Commercial end parse time',
                 },
             ],

package/dist/cjs/ad-sizes.d.ts

@@ -4,7 +4,7 @@ export declare type AdSize = Readonly<{
     height: number;
     toString: () => AdSizeString;
 }>;
-export declare type SizeKeys = 'billboard' | 'leaderboard' | 'mpu' | 'halfPage' | 'portrait' | 'skyscraper' | 'mobilesticky' | 'fluid' | 'outOfPage' | 'googleCard' | 'video' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'merchandisingHighAdFeature' | 'merchandisingHigh' | 'merchandising' | 'inlineMerchandising' | 'fabric' | 'empty' | '970x250' | '728x90' | '300x250' | '300x600' | '300x1050' | '160x600';
+export declare type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'inlineMerchandising' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'skyscraper' | 'video';
 export declare const adSizes: Record<SizeKeys, AdSize>;
 export declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {

package/dist/cjs/ad-sizes.js

@@ -12,27 +12,27 @@ const createAdSize = (width, height) => {
 const adSizesPartial = {
     // standard ad sizes
     billboard: createAdSize(970, 250),
+    halfPage: createAdSize(300, 600),
     leaderboard: createAdSize(728, 90),
+    mobilesticky: createAdSize(320, 50),
     mpu: createAdSize(300, 250),
-    halfPage: createAdSize(300, 600),
     portrait: createAdSize(300, 1050),
     skyscraper: createAdSize(160, 600),
-    mobilesticky: createAdSize(320, 50),
     // dfp proprietary ad sizes
     fluid: createAdSize(0, 0),
-    outOfPage: createAdSize(1, 1),
     googleCard: createAdSize(300, 274),
+    outOfPage: createAdSize(1, 1),
     // guardian proprietary ad sizes
-    video: createAdSize(620, 1),
+    empty: createAdSize(2, 2),
+    fabric: createAdSize(88, 71),
+    inlineMerchandising: createAdSize(88, 85),
+    merchandising: createAdSize(88, 88),
+    merchandisingHigh: createAdSize(88, 87),
+    merchandisingHighAdFeature: createAdSize(88, 89),
     outstreamDesktop: createAdSize(620, 350),
     outstreamGoogleDesktop: createAdSize(550, 310),
     outstreamMobile: createAdSize(300, 197),
-    merchandisingHighAdFeature: createAdSize(88, 89),
-    merchandisingHigh: createAdSize(88, 87),
-    merchandising: createAdSize(88, 88),
-    inlineMerchandising: createAdSize(88, 85),
-    fabric: createAdSize(88, 71),
-    empty: createAdSize(2, 2),
+    video: createAdSize(620, 1),
 };
 exports.adSizes = {
     ...adSizesPartial,

package/dist/cjs/index.d.ts

@@ -14,3 +14,14 @@ export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments,
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';
+export type { ContentTargeting } from './targeting/content';
+export { getContentTargeting } from './targeting/content';
+export type { PersonalisedTargeting } from './targeting/personalised';
+export { getPersonalisedTargeting } from './targeting/personalised';
+export type { SessionTargeting } from './targeting/session';
+export { getSessionTargeting } from './targeting/session';
+export type { SharedTargeting } from './targeting/shared';
+export { getSharedTargeting } from './targeting/shared';
+export type { ViewportTargeting } from './targeting/viewport';
+export { getViewportTargeting } from './targeting/viewport';
+export { pickTargetingValues } from './targeting/pick-targeting-values';

package/dist/cjs/index.js

@@ -20,7 +20,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.getAdSize = exports.adSizes = exports.sendCommercialMetrics = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.getAdSize = exports.adSizes = exports.sendCommercialMetrics = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
 var ias_1 = require("./third-party-tags/ias");
 Object.defineProperty(exports, "ias", { enumerable: true, get: function () { return ias_1.ias; } });
 var permutive_1 = require("./third-party-tags/permutive");
@@ -50,3 +50,15 @@ var ad_targeting_youtube_1 = require("./ad-targeting-youtube");
 Object.defineProperty(exports, "buildAdsConfigWithConsent", { enumerable: true, get: function () { return ad_targeting_youtube_1.buildAdsConfigWithConsent; } });
 Object.defineProperty(exports, "disabledAds", { enumerable: true, get: function () { return ad_targeting_youtube_1.disabledAds; } });
 exports.constants = __importStar(require("./constants"));
+var content_1 = require("./targeting/content");
+Object.defineProperty(exports, "getContentTargeting", { enumerable: true, get: function () { return content_1.getContentTargeting; } });
+var personalised_1 = require("./targeting/personalised");
+Object.defineProperty(exports, "getPersonalisedTargeting", { enumerable: true, get: function () { return personalised_1.getPersonalisedTargeting; } });
+var session_1 = require("./targeting/session");
+Object.defineProperty(exports, "getSessionTargeting", { enumerable: true, get: function () { return session_1.getSessionTargeting; } });
+var shared_1 = require("./targeting/shared");
+Object.defineProperty(exports, "getSharedTargeting", { enumerable: true, get: function () { return shared_1.getSharedTargeting; } });
+var viewport_1 = require("./targeting/viewport");
+Object.defineProperty(exports, "getViewportTargeting", { enumerable: true, get: function () { return viewport_1.getViewportTargeting; } });
+var pick_targeting_values_1 = require("./targeting/pick-targeting-values");
+Object.defineProperty(exports, "pickTargetingValues", { enumerable: true, get: function () { return pick_targeting_values_1.pickTargetingValues; } });

package/dist/cjs/targeting/viewport.d.ts

@@ -39,4 +39,9 @@ export declare type ViewportTargeting = {
      */
     skinsize: 'l' | 's';
 };
-export declare const getViewportTargeting: (viewPortWidth: number, cmpBannerWillShow: boolean) => ViewportTargeting;
+declare type Viewport = {
+    viewPortWidth: number;
+    cmpBannerWillShow: boolean;
+};
+export declare const getViewportTargeting: ({ viewPortWidth, cmpBannerWillShow, }: Viewport) => ViewportTargeting;
+export {};

package/dist/cjs/targeting/viewport.js

@@ -5,12 +5,11 @@ exports.getViewportTargeting = void 0;
 const findBreakpoint = (width) => {
     if (width >= 980)
         return 'desktop';
-    if (width >= 740)
+    if (width >= 660)
         return 'tablet';
     return 'mobile';
 };
-/* -- Targeting -- */
-const getViewportTargeting = (viewPortWidth, cmpBannerWillShow) => {
+const getViewportTargeting = ({ viewPortWidth, cmpBannerWillShow, }) => {
     // Don’t show inskin if if a privacy message will be shown
     const inskin = cmpBannerWillShow ? 'f' : 't';
     return {

package/dist/cjs/third-party-tags/facebook-pixel.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * tracking pixel
+ * https://en-gb.facebook.com/business/learn/facebook-ads-pixel
+ * @param  {} {shouldRun}
+ */
 export declare const fbPixel: GetThirdPartyTag;

package/dist/cjs/third-party-tags/facebook-pixel.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fbPixel = void 0;
+/**
+ * tracking pixel
+ * https://en-gb.facebook.com/business/learn/facebook-ads-pixel
+ * @param  {} {shouldRun}
+ */
 const fbPixel = ({ shouldRun }) => ({
     shouldRun,
     url: `https://www.facebook.com/tr?id=279880532344561&ev=PageView&noscript=1`,

package/dist/cjs/third-party-tags/ias.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * IAS script filters bad ads
+ * https://integralads.com/uk/
+ * @param  {} {shouldRun}
+ */
 export declare const ias: GetThirdPartyTag;

package/dist/cjs/third-party-tags/ias.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ias = void 0;
+/**
+ * IAS script filters bad ads
+ * https://integralads.com/uk/
+ * @param  {} {shouldRun}
+ */
 const ias = ({ shouldRun }) => ({
     shouldRun,
     url: '//cdn.adsafeprotected.com/iasPET.1.js',

package/dist/cjs/third-party-tags/inizio.d.ts

@@ -1,4 +1,9 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * Allows creatives to show survey
+ * https://trello.com/c/wHffHVF1/171-integrate-and-test-inizio
+ * @param  {} {shouldRun}
+ */
 export declare const inizio: GetThirdPartyTag;
 export declare const _: {
     onLoad: () => void;

package/dist/cjs/third-party-tags/inizio.js

@@ -21,6 +21,11 @@ const onLoad = () => {
         },
     });
 };
+/**
+ * Allows creatives to show survey
+ * https://trello.com/c/wHffHVF1/171-integrate-and-test-inizio
+ * @param  {} {shouldRun}
+ */
 const inizio = ({ shouldRun }) => ({
     shouldRun,
     url: '//cdn.brandmetrics.com/survey/script/e96d04c832084488a841a06b49b8fb2d.js',

package/dist/cjs/third-party-tags/permutive.d.ts

@@ -1,2 +1,6 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * Permutive script updates local user segmentation data
+ * @param  {} {shouldRun}
+ */
 export declare const permutive: GetThirdPartyTag;

package/dist/cjs/third-party-tags/permutive.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.permutive = void 0;
+/**
+ * Permutive script updates local user segmentation data
+ * @param  {} {shouldRun}
+ */
 const permutive = ({ shouldRun }) => ({
     shouldRun,
     url: '//cdn.permutive.com/d6691a17-6fdb-4d26-85d6-b3dd27f55f08-web.js',

package/dist/cjs/third-party-tags/remarketing.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * Google conversion tracking
+ * https://support.google.com/google-ads/answer/6095821
+ * @param  {} {shouldRun}
+ */
 export declare const remarketing: GetThirdPartyTag;

package/dist/cjs/third-party-tags/remarketing.js

@@ -8,6 +8,11 @@ const onLoad = () => {
         google_remarketing_only: true,
     });
 };
+/**
+ * Google conversion tracking
+ * https://support.google.com/google-ads/answer/6095821
+ * @param  {} {shouldRun}
+ */
 const remarketing = ({ shouldRun }) => ({
     shouldRun,
     url: '//www.googleadservices.com/pagead/conversion_async.js',

package/dist/cjs/third-party-tags/twitter-uwt.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * tracking pixel
+ * https://business.twitter.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html
+ * @param  {} {shouldRun}
+ */
 export declare const twitter: GetThirdPartyTag;

package/dist/cjs/third-party-tags/twitter-uwt.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.twitter = void 0;
 const twitter_script_1 = require("../__vendor/twitter-script");
+/**
+ * tracking pixel
+ * https://business.twitter.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html
+ * @param  {} {shouldRun}
+ */
 const twitter = ({ shouldRun }) => ({
     shouldRun,
     name: 'twitter',

package/dist/cjs/types.d.ts

@@ -1,3 +1,4 @@
+import type { VendorName } from '@guardian/consent-management-platform/dist/types';
 export declare type TagAttribute = {
     name: string;
     value: string;
@@ -10,7 +11,7 @@ export declare type ThirdPartyTag = {
     loaded?: boolean;
     onLoad?: () => void;
     shouldRun: boolean;
-    name?: string;
+    name?: VendorName;
     url?: string;
     useImage?: boolean;
 };

package/dist/esm/EventTimer.d.ts

@@ -19,7 +19,9 @@ interface SlotEventStatus {
 }
 interface PageEventStatus {
     commercialStart: boolean;
-    commercialEnd: boolean;
+    commercialExtraModulesLoaded: boolean;
+    commercialBaseModulesLoaded: boolean;
+    commercialModulesLoaded: boolean;
 }
 export declare class EventTimer {
     private _events;

package/dist/esm/EventTimer.js

@@ -26,7 +26,9 @@ export class EventTimer {
             },
             page: {
                 commercialStart: false,
-                commercialEnd: false,
+                commercialExtraModulesLoaded: false,
+                commercialBaseModulesLoaded: false,
+                commercialModulesLoaded: false,
             },
         };
         this.gaConfig = {
@@ -42,7 +44,7 @@ export class EventTimer {
                     timingLabel: 'Commercial start parse time',
                 },
                 {
-                    timingVariable: 'commercialEnd',
+                    timingVariable: 'commercialModulesLoaded',
                     timingLabel: 'Commercial end parse time',
                 },
             ],

package/dist/esm/ad-sizes.d.ts

@@ -4,7 +4,7 @@ export declare type AdSize = Readonly<{
     height: number;
     toString: () => AdSizeString;
 }>;
-export declare type SizeKeys = 'billboard' | 'leaderboard' | 'mpu' | 'halfPage' | 'portrait' | 'skyscraper' | 'mobilesticky' | 'fluid' | 'outOfPage' | 'googleCard' | 'video' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'merchandisingHighAdFeature' | 'merchandisingHigh' | 'merchandising' | 'inlineMerchandising' | 'fabric' | 'empty' | '970x250' | '728x90' | '300x250' | '300x600' | '300x1050' | '160x600';
+export declare type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'inlineMerchandising' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'skyscraper' | 'video';
 export declare const adSizes: Record<SizeKeys, AdSize>;
 export declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {

package/dist/esm/ad-sizes.js

@@ -9,27 +9,27 @@ const createAdSize = (width, height) => {
 const adSizesPartial = {
     // standard ad sizes
     billboard: createAdSize(970, 250),
+    halfPage: createAdSize(300, 600),
     leaderboard: createAdSize(728, 90),
+    mobilesticky: createAdSize(320, 50),
     mpu: createAdSize(300, 250),
-    halfPage: createAdSize(300, 600),
     portrait: createAdSize(300, 1050),
     skyscraper: createAdSize(160, 600),
-    mobilesticky: createAdSize(320, 50),
     // dfp proprietary ad sizes
     fluid: createAdSize(0, 0),
-    outOfPage: createAdSize(1, 1),
     googleCard: createAdSize(300, 274),
+    outOfPage: createAdSize(1, 1),
     // guardian proprietary ad sizes
-    video: createAdSize(620, 1),
+    empty: createAdSize(2, 2),
+    fabric: createAdSize(88, 71),
+    inlineMerchandising: createAdSize(88, 85),
+    merchandising: createAdSize(88, 88),
+    merchandisingHigh: createAdSize(88, 87),
+    merchandisingHighAdFeature: createAdSize(88, 89),
     outstreamDesktop: createAdSize(620, 350),
     outstreamGoogleDesktop: createAdSize(550, 310),
     outstreamMobile: createAdSize(300, 197),
-    merchandisingHighAdFeature: createAdSize(88, 89),
-    merchandisingHigh: createAdSize(88, 87),
-    merchandising: createAdSize(88, 88),
-    inlineMerchandising: createAdSize(88, 85),
-    fabric: createAdSize(88, 71),
-    empty: createAdSize(2, 2),
+    video: createAdSize(620, 1),
 };
 export const adSizes = {
     ...adSizesPartial,

package/dist/esm/index.d.ts

@@ -14,3 +14,14 @@ export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments,
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';
+export type { ContentTargeting } from './targeting/content';
+export { getContentTargeting } from './targeting/content';
+export type { PersonalisedTargeting } from './targeting/personalised';
+export { getPersonalisedTargeting } from './targeting/personalised';
+export type { SessionTargeting } from './targeting/session';
+export { getSessionTargeting } from './targeting/session';
+export type { SharedTargeting } from './targeting/shared';
+export { getSharedTargeting } from './targeting/shared';
+export type { ViewportTargeting } from './targeting/viewport';
+export { getViewportTargeting } from './targeting/viewport';
+export { pickTargetingValues } from './targeting/pick-targeting-values';

package/dist/esm/index.js

@@ -13,3 +13,9 @@ export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments,
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 import * as constants_1 from './constants';
 export { constants_1 as constants };
+export { getContentTargeting } from './targeting/content';
+export { getPersonalisedTargeting } from './targeting/personalised';
+export { getSessionTargeting } from './targeting/session';
+export { getSharedTargeting } from './targeting/shared';
+export { getViewportTargeting } from './targeting/viewport';
+export { pickTargetingValues } from './targeting/pick-targeting-values';

package/dist/esm/targeting/viewport.d.ts

@@ -39,4 +39,9 @@ export declare type ViewportTargeting = {
      */
     skinsize: 'l' | 's';
 };
-export declare const getViewportTargeting: (viewPortWidth: number, cmpBannerWillShow: boolean) => ViewportTargeting;
+declare type Viewport = {
+    viewPortWidth: number;
+    cmpBannerWillShow: boolean;
+};
+export declare const getViewportTargeting: ({ viewPortWidth, cmpBannerWillShow, }: Viewport) => ViewportTargeting;
+export {};

package/dist/esm/targeting/viewport.js

@@ -2,12 +2,11 @@
 const findBreakpoint = (width) => {
     if (width >= 980)
         return 'desktop';
-    if (width >= 740)
+    if (width >= 660)
         return 'tablet';
     return 'mobile';
 };
-/* -- Targeting -- */
-export const getViewportTargeting = (viewPortWidth, cmpBannerWillShow) => {
+export const getViewportTargeting = ({ viewPortWidth, cmpBannerWillShow, }) => {
     // Don’t show inskin if if a privacy message will be shown
     const inskin = cmpBannerWillShow ? 'f' : 't';
     return {

package/dist/esm/third-party-tags/facebook-pixel.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * tracking pixel
+ * https://en-gb.facebook.com/business/learn/facebook-ads-pixel
+ * @param  {} {shouldRun}
+ */
 export declare const fbPixel: GetThirdPartyTag;

package/dist/esm/third-party-tags/facebook-pixel.js

@@ -1,3 +1,8 @@
+/**
+ * tracking pixel
+ * https://en-gb.facebook.com/business/learn/facebook-ads-pixel
+ * @param  {} {shouldRun}
+ */
 export const fbPixel = ({ shouldRun }) => ({
     shouldRun,
     url: `https://www.facebook.com/tr?id=279880532344561&ev=PageView&noscript=1`,

package/dist/esm/third-party-tags/ias.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * IAS script filters bad ads
+ * https://integralads.com/uk/
+ * @param  {} {shouldRun}
+ */
 export declare const ias: GetThirdPartyTag;

package/dist/esm/third-party-tags/ias.js

@@ -1,3 +1,8 @@
+/**
+ * IAS script filters bad ads
+ * https://integralads.com/uk/
+ * @param  {} {shouldRun}
+ */
 export const ias = ({ shouldRun }) => ({
     shouldRun,
     url: '//cdn.adsafeprotected.com/iasPET.1.js',

package/dist/esm/third-party-tags/inizio.d.ts

@@ -1,4 +1,9 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * Allows creatives to show survey
+ * https://trello.com/c/wHffHVF1/171-integrate-and-test-inizio
+ * @param  {} {shouldRun}
+ */
 export declare const inizio: GetThirdPartyTag;
 export declare const _: {
     onLoad: () => void;

package/dist/esm/third-party-tags/inizio.js

@@ -18,6 +18,11 @@ const onLoad = () => {
         },
     });
 };
+/**
+ * Allows creatives to show survey
+ * https://trello.com/c/wHffHVF1/171-integrate-and-test-inizio
+ * @param  {} {shouldRun}
+ */
 export const inizio = ({ shouldRun }) => ({
     shouldRun,
     url: '//cdn.brandmetrics.com/survey/script/e96d04c832084488a841a06b49b8fb2d.js',

package/dist/esm/third-party-tags/permutive.d.ts

@@ -1,2 +1,6 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * Permutive script updates local user segmentation data
+ * @param  {} {shouldRun}
+ */
 export declare const permutive: GetThirdPartyTag;

package/dist/esm/third-party-tags/permutive.js

@@ -1,3 +1,7 @@
+/**
+ * Permutive script updates local user segmentation data
+ * @param  {} {shouldRun}
+ */
 export const permutive = ({ shouldRun }) => ({
     shouldRun,
     url: '//cdn.permutive.com/d6691a17-6fdb-4d26-85d6-b3dd27f55f08-web.js',

package/dist/esm/third-party-tags/remarketing.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * Google conversion tracking
+ * https://support.google.com/google-ads/answer/6095821
+ * @param  {} {shouldRun}
+ */
 export declare const remarketing: GetThirdPartyTag;

package/dist/esm/third-party-tags/remarketing.js

@@ -5,6 +5,11 @@ const onLoad = () => {
         google_remarketing_only: true,
     });
 };
+/**
+ * Google conversion tracking
+ * https://support.google.com/google-ads/answer/6095821
+ * @param  {} {shouldRun}
+ */
 export const remarketing = ({ shouldRun }) => ({
     shouldRun,
     url: '//www.googleadservices.com/pagead/conversion_async.js',

package/dist/esm/third-party-tags/twitter-uwt.d.ts

@@ -1,2 +1,7 @@
 import type { GetThirdPartyTag } from '../types';
+/**
+ * tracking pixel
+ * https://business.twitter.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html
+ * @param  {} {shouldRun}
+ */
 export declare const twitter: GetThirdPartyTag;

package/dist/esm/third-party-tags/twitter-uwt.js

@@ -1,4 +1,9 @@
 import { twitterScript as insertSnippet } from '../__vendor/twitter-script';
+/**
+ * tracking pixel
+ * https://business.twitter.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html
+ * @param  {} {shouldRun}
+ */
 export const twitter = ({ shouldRun }) => ({
     shouldRun,
     name: 'twitter',

package/dist/esm/types.d.ts

@@ -1,3 +1,4 @@
+import type { VendorName } from '@guardian/consent-management-platform/dist/types';
 export declare type TagAttribute = {
     name: string;
     value: string;
@@ -10,7 +11,7 @@ export declare type ThirdPartyTag = {
     loaded?: boolean;
     onLoad?: () => void;
     shouldRun: boolean;
-    name?: string;
+    name?: VendorName;
     url?: string;
     useImage?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "0.37.2",
+  "version": "0.41.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {
@@ -41,12 +41,12 @@
   },
   "prettier": "@guardian/prettier",
   "devDependencies": {
-    "@commitlint/cli": "^15.0.0",
-    "@commitlint/config-conventional": "^15.0.0",
+    "@commitlint/cli": "^16.1.0",
+    "@commitlint/config-conventional": "^16.0.0",
     "@guardian/ab-core": "^2.0.0",
-    "@guardian/consent-management-platform": "^8.0.1",
-    "@guardian/eslint-config-typescript": "^0.7.0",
-    "@guardian/libs": "3.5.1",
+    "@guardian/consent-management-platform": "^10.1.0",
+    "@guardian/eslint-config-typescript": "^1.0.0",
+    "@guardian/libs": "3.6.1",
     "@guardian/prettier": "^0.7.0",
     "@octokit/core": "^3.5.1",
     "@semantic-release/github": "^8.0.2",
@@ -56,6 +56,7 @@
     "@typescript-eslint/eslint-plugin": "^5.5.0",
     "@typescript-eslint/parser": "^5.5.0",
     "commitizen": "^4.2.4",
+    "conventional-changelog-conventionalcommits": "^4.6.3",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",