@guardian/commercial-core 4.14.0 → 4.15.0

package/dist/cjs/index.d.ts

@@ -35,4 +35,5 @@ export { init as initMessenger } from './messenger';
 export type { RegisterListener, RegisterPersistentListener, RespondProxy, } from './messenger';
 export { postMessage } from './messenger/post-message';
 export { buildPageTargeting } from './targeting/build-page-targeting';
+export { buildPageTargetingConsentless } from './targeting/build-page-targeting-consentless';
 export type { PageTargeting } from './targeting/build-page-targeting';

package/dist/cjs/index.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildPageTargeting = exports.postMessage = exports.initMessenger = exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.concatSizeMappings = exports.createAdSlot = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackLabsContainer = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.isBreakpoint = exports.createAdSize = exports.slotSizeMappings = exports.getAdSize = exports.standardAdSizes = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+exports.buildPageTargetingConsentless = exports.buildPageTargeting = exports.postMessage = exports.initMessenger = exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.concatSizeMappings = exports.createAdSlot = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackLabsContainer = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.isBreakpoint = exports.createAdSize = exports.slotSizeMappings = exports.getAdSize = exports.standardAdSizes = 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");
@@ -87,3 +87,5 @@ var post_message_1 = require("./messenger/post-message");
 Object.defineProperty(exports, "postMessage", { enumerable: true, get: function () { return post_message_1.postMessage; } });
 var build_page_targeting_1 = require("./targeting/build-page-targeting");
 Object.defineProperty(exports, "buildPageTargeting", { enumerable: true, get: function () { return build_page_targeting_1.buildPageTargeting; } });
+var build_page_targeting_consentless_1 = require("./targeting/build-page-targeting-consentless");
+Object.defineProperty(exports, "buildPageTargetingConsentless", { enumerable: true, get: function () { return build_page_targeting_consentless_1.buildPageTargetingConsentless; } });

package/dist/cjs/targeting/build-page-targeting-consentless.d.ts

@@ -0,0 +1,19 @@
+import type { Participations } from '@guardian/ab-core';
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+import type { CountryCode } from '@guardian/libs';
+import type { PageTargeting } from './build-page-targeting';
+declare const consentlessTargetingKeys: readonly ["ab", "at", "bl", "bp", "br", "cc", "ct", "dcre", "edition", "k", "rp", "s", "se", "sens", "sh", "si", "skinsize", "su", "tn", "url", "urlkw"];
+declare type ConsentlessTargetingKeys = typeof consentlessTargetingKeys[number];
+declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessTargetingKeys>>;
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+export { buildPageTargetingConsentless };

package/dist/cjs/targeting/build-page-targeting-consentless.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPageTargetingConsentless = void 0;
+const build_page_targeting_1 = require("./build-page-targeting");
+const consentlessTargetingKeys = [
+    'ab',
+    'at',
+    'bl',
+    'bp',
+    'br',
+    'cc',
+    'ct',
+    'dcre',
+    'edition',
+    'k',
+    'rp',
+    's',
+    'se',
+    'sens',
+    'sh',
+    'si',
+    'skinsize',
+    'su',
+    'tn',
+    'url',
+    'urlkw',
+];
+const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+const buildPageTargetingConsentless = (consentState, adFree, countryCode, clientSideParticipations) => {
+    const consentedPageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, adFree, countryCode, clientSideParticipations);
+    return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
+};
+exports.buildPageTargetingConsentless = buildPageTargetingConsentless;

package/dist/esm/index.d.ts

@@ -35,4 +35,5 @@ export { init as initMessenger } from './messenger';
 export type { RegisterListener, RegisterPersistentListener, RespondProxy, } from './messenger';
 export { postMessage } from './messenger/post-message';
 export { buildPageTargeting } from './targeting/build-page-targeting';
+export { buildPageTargetingConsentless } from './targeting/build-page-targeting-consentless';
 export type { PageTargeting } from './targeting/build-page-targeting';

package/dist/esm/index.js

@@ -27,3 +27,4 @@ export { pickTargetingValues } from './targeting/pick-targeting-values';
 export { init as initMessenger } from './messenger';
 export { postMessage } from './messenger/post-message';
 export { buildPageTargeting } from './targeting/build-page-targeting';
+export { buildPageTargetingConsentless } from './targeting/build-page-targeting-consentless';

package/dist/esm/targeting/build-page-targeting-consentless.d.ts

@@ -0,0 +1,19 @@
+import type { Participations } from '@guardian/ab-core';
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+import type { CountryCode } from '@guardian/libs';
+import type { PageTargeting } from './build-page-targeting';
+declare const consentlessTargetingKeys: readonly ["ab", "at", "bl", "bp", "br", "cc", "ct", "dcre", "edition", "k", "rp", "s", "se", "sens", "sh", "si", "skinsize", "su", "tn", "url", "urlkw"];
+declare type ConsentlessTargetingKeys = typeof consentlessTargetingKeys[number];
+declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessTargetingKeys>>;
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+export { buildPageTargetingConsentless };

package/dist/esm/targeting/build-page-targeting-consentless.js

@@ -0,0 +1,40 @@
+import { buildPageTargeting } from './build-page-targeting';
+const consentlessTargetingKeys = [
+    'ab',
+    'at',
+    'bl',
+    'bp',
+    'br',
+    'cc',
+    'ct',
+    'dcre',
+    'edition',
+    'k',
+    'rp',
+    's',
+    'se',
+    'sens',
+    'sh',
+    'si',
+    'skinsize',
+    'su',
+    'tn',
+    'url',
+    'urlkw',
+];
+const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+const buildPageTargetingConsentless = (consentState, adFree, countryCode, clientSideParticipations) => {
+    const consentedPageTargeting = buildPageTargeting(consentState, adFree, countryCode, clientSideParticipations);
+    return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
+};
+export { buildPageTargetingConsentless };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "4.14.0",
+  "version": "4.15.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {