@guardian/commercial-core 3.4.0 → 3.5.0

package/dist/cjs/event-timer.d.ts

@@ -30,6 +30,7 @@ interface EventTimerProperties {
     adSlotsInline?: number;
     adSlotsTotal?: number;
     pageHeightVH?: number;
+    gpcSignal?: number;
     lazyLoadMarginPercent?: number;
 }
 export declare class EventTimer {
@@ -71,7 +72,7 @@ export declare class EventTimer {
      * @param {string} name - the property's name
      * @param {value} number - the property's value
      */
-    setProperty(name: 'adSlotsInline' | 'adSlotsTotal' | 'pageHeightVH' | 'lazyLoadMarginPercent', value: number): void;
+    setProperty(name: 'adSlotsInline' | 'adSlotsTotal' | 'pageHeightVH' | 'gpcSignal' | 'lazyLoadMarginPercent', value: number): void;
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'

package/dist/cjs/index.d.ts

@@ -12,6 +12,7 @@ export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
 export { initTrackScrollDepth } from './track-scroll-depth';
+export { initTrackGpcSignal } from './track-gpc-signal';
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';

package/dist/cjs/index.js

@@ -2,7 +2,11 @@
 /* istanbul ignore file -- there's no point check this for test coverage */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -20,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.sizeMappings = exports.getAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = 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.initTrackGpcSignal = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.sizeMappings = exports.getAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = 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,6 +54,8 @@ Object.defineProperty(exports, "getPermutiveSegments", { enumerable: true, get:
 Object.defineProperty(exports, "getPermutivePFPSegments", { enumerable: true, get: function () { return permutive_2.getPermutivePFPSegments; } });
 var track_scroll_depth_1 = require("./track-scroll-depth");
 Object.defineProperty(exports, "initTrackScrollDepth", { enumerable: true, get: function () { return track_scroll_depth_1.initTrackScrollDepth; } });
+var track_gpc_signal_1 = require("./track-gpc-signal");
+Object.defineProperty(exports, "initTrackGpcSignal", { enumerable: true, get: function () { return track_gpc_signal_1.initTrackGpcSignal; } });
 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; } });

package/dist/cjs/track-gpc-signal.d.ts

@@ -0,0 +1,7 @@
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+/**
+ * Collect metrics on gpcSignal presence and value
+ * https://globalprivacycontrol.github.io/gpc-spec/
+ */
+declare const initTrackGpcSignal: (consentState: ConsentState) => void;
+export { initTrackGpcSignal };

package/dist/cjs/track-gpc-signal.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initTrackGpcSignal = void 0;
+const libs_1 = require("@guardian/libs");
+const event_timer_1 = require("./event-timer");
+/**
+ * Collect metrics on gpcSignal presence and value
+ * https://globalprivacycontrol.github.io/gpc-spec/
+ */
+const initTrackGpcSignal = (consentState) => {
+    // If undefined we set the property value to -1, false is 0, true is 1
+    const gpcSignal = consentState.gpcSignal === undefined ? -1 : +consentState.gpcSignal;
+    const eventTimer = event_timer_1.EventTimer.get();
+    (0, libs_1.log)('commercial', `gpcSignal ${gpcSignal}`);
+    eventTimer.setProperty('gpcSignal', gpcSignal);
+};
+exports.initTrackGpcSignal = initTrackGpcSignal;

package/dist/esm/event-timer.d.ts

@@ -30,6 +30,7 @@ interface EventTimerProperties {
     adSlotsInline?: number;
     adSlotsTotal?: number;
     pageHeightVH?: number;
+    gpcSignal?: number;
     lazyLoadMarginPercent?: number;
 }
 export declare class EventTimer {
@@ -71,7 +72,7 @@ export declare class EventTimer {
      * @param {string} name - the property's name
      * @param {value} number - the property's value
      */
-    setProperty(name: 'adSlotsInline' | 'adSlotsTotal' | 'pageHeightVH' | 'lazyLoadMarginPercent', value: number): void;
+    setProperty(name: 'adSlotsInline' | 'adSlotsTotal' | 'pageHeightVH' | 'gpcSignal' | 'lazyLoadMarginPercent', value: number): void;
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'

package/dist/esm/index.d.ts

@@ -12,6 +12,7 @@ export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
 export { initTrackScrollDepth } from './track-scroll-depth';
+export { initTrackGpcSignal } from './track-gpc-signal';
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';

package/dist/esm/index.js

@@ -11,6 +11,7 @@ export { adSizes, getAdSize, sizeMappings } from './ad-sizes';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
 export { initTrackScrollDepth } from './track-scroll-depth';
+export { initTrackGpcSignal } from './track-gpc-signal';
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 import * as constants_1 from './constants';
 export { constants_1 as constants };

package/dist/esm/track-gpc-signal.d.ts

@@ -0,0 +1,7 @@
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+/**
+ * Collect metrics on gpcSignal presence and value
+ * https://globalprivacycontrol.github.io/gpc-spec/
+ */
+declare const initTrackGpcSignal: (consentState: ConsentState) => void;
+export { initTrackGpcSignal };

package/dist/esm/track-gpc-signal.js

@@ -0,0 +1,14 @@
+import { log } from '@guardian/libs';
+import { EventTimer } from './event-timer';
+/**
+ * Collect metrics on gpcSignal presence and value
+ * https://globalprivacycontrol.github.io/gpc-spec/
+ */
+const initTrackGpcSignal = (consentState) => {
+    // If undefined we set the property value to -1, false is 0, true is 1
+    const gpcSignal = consentState.gpcSignal === undefined ? -1 : +consentState.gpcSignal;
+    const eventTimer = EventTimer.get();
+    log('commercial', `gpcSignal ${gpcSignal}`);
+    eventTimer.setProperty('gpcSignal', gpcSignal);
+};
+export { initTrackGpcSignal };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {
@@ -43,16 +43,16 @@
   "prettier": "@guardian/prettier",
   "devDependencies": {
     "@commitlint/cli": "^16.1.0",
-    "@commitlint/config-conventional": "^16.0.0",
+    "@commitlint/config-conventional": "^17.0.0",
     "@guardian/ab-core": "^2.0.0",
-    "@guardian/consent-management-platform": "^10.5.0",
+    "@guardian/consent-management-platform": "^10.6.0",
     "@guardian/eslint-config-typescript": "^1.0.0",
-    "@guardian/libs": "3.6.1",
-    "@guardian/prettier": "^0.7.0",
+    "@guardian/libs": "5.1.0",
+    "@guardian/prettier": "^1.0.0",
     "@octokit/core": "^3.5.1",
     "@semantic-release/github": "^8.0.2",
     "@types/google.analytics": "^0.0.42",
-    "@types/googletag": "^1.1.4",
+    "@types/googletag": "^2.0.0",
     "@types/jest": "^27.0.3",
     "@typescript-eslint/eslint-plugin": "^5.5.0",
     "@typescript-eslint/parser": "^5.5.0",
@@ -63,15 +63,15 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^25.3.0",
+    "eslint-plugin-jest": "^26.1.5",
     "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^7.0.4",
+    "husky": "^8.0.1",
     "jest": "^27.4.1",
     "lint-staged": "^12.1.2",
     "mockdate": "^3.0.5",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.5.0",
-    "semantic-release": "^18.0.1",
+    "semantic-release": "^19.0.2",
     "ts-jest": "^27.0.7",
     "type-fest": "^2.8.0",
     "typescript": "^4.5.2",