@guardian/commercial-core 4.18.0 → 4.20.0

package/README.md

@@ -27,12 +27,6 @@
 yarn add @guardian/commercial-core
 ```
 
-or
-
-```bash
-npm install @guardian/commercial-core
-```
-
 ### Bundling
 
 This package uses `ES2020`.

package/dist/cjs/index.d.ts

@@ -1,6 +1,5 @@
 export { ias } from './third-party-tags/ias';
 export { permutive } from './third-party-tags/permutive';
-export { fbPixel } from './third-party-tags/facebook-pixel';
 export { twitter } from './third-party-tags/twitter-uwt';
 export { inizio } from './third-party-tags/inizio';
 export { remarketing } from './third-party-tags/remarketing';

package/dist/cjs/index.js

@@ -24,13 +24,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pubmatic = exports.launchpad = exports.ipsosMoriStub = exports.a9Apstag = 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.standardAdSizes = exports.slotSizeMappings = exports.outstreamSizes = exports.getAdSize = exports.createAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+exports.pubmatic = exports.launchpad = exports.ipsosMoriStub = exports.a9Apstag = 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.standardAdSizes = exports.slotSizeMappings = exports.outstreamSizes = exports.getAdSize = exports.createAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = 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");
 Object.defineProperty(exports, "permutive", { enumerable: true, get: function () { return permutive_1.permutive; } });
-var facebook_pixel_1 = require("./third-party-tags/facebook-pixel");
-Object.defineProperty(exports, "fbPixel", { enumerable: true, get: function () { return facebook_pixel_1.fbPixel; } });
 var twitter_uwt_1 = require("./third-party-tags/twitter-uwt");
 Object.defineProperty(exports, "twitter", { enumerable: true, get: function () { return twitter_uwt_1.twitter; } });
 var inizio_1 = require("./third-party-tags/inizio");

package/dist/cjs/lib/ab-localstorage.d.ts

@@ -0,0 +1,2 @@
+import type { Participations } from '@guardian/ab-core';
+export declare const getParticipationsFromLocalStorage: () => Participations;

package/dist/cjs/lib/ab-localstorage.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParticipationsFromLocalStorage = void 0;
+const libs_1 = require("@guardian/libs");
+const participationsKey = 'gu.ab.participations';
+const isParticipations = (participations) => {
+    return ((0, libs_1.isObject)(participations) &&
+        Object.values(participations).every((participation) => (0, libs_1.isObject)(participation) && (0, libs_1.isString)(participation.variant)));
+};
+const getParticipationsFromLocalStorage = () => {
+    const participations = libs_1.storage.local.get(participationsKey);
+    return isParticipations(participations) ? participations : {};
+};
+exports.getParticipationsFromLocalStorage = getParticipationsFromLocalStorage;

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

@@ -1,4 +1,3 @@
-import type { Participations } from '@guardian/ab-core';
 import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
 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"];
@@ -10,8 +9,7 @@ declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessT
  *
  * @param  {ConsentState} consentState
  * @param  {boolean} adFree
- * @param  {Participations} clientSideParticipations
  * @returns ConsentlessPageTargeting
  */
-declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean) => ConsentlessPageTargeting;
 export { buildPageTargetingConsentless };

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

@@ -32,11 +32,10 @@ const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
  *
  * @param  {ConsentState} consentState
  * @param  {boolean} adFree
- * @param  {Participations} clientSideParticipations
  * @returns ConsentlessPageTargeting
  */
-const buildPageTargetingConsentless = (consentState, adFree, clientSideParticipations) => {
-    const consentedPageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, adFree, clientSideParticipations);
+const buildPageTargetingConsentless = (consentState, adFree) => {
+    const consentedPageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, adFree);
     return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
 };
 exports.buildPageTargetingConsentless = buildPageTargetingConsentless;

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

@@ -1,4 +1,3 @@
-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 { False, True } from '../types';
@@ -34,6 +33,6 @@ declare type PageTargeting = PartialWithNulls<{
     vl: string;
     [_: string]: string | string[];
 } & SharedTargeting>;
-declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => PageTargeting;
+declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean) => PageTargeting;
 export { buildPageTargeting };
 export type { PageTargeting };

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildPageTargeting = void 0;
 const consent_management_platform_1 = require("@guardian/consent-management-platform");
 const libs_1 = require("@guardian/libs");
+const ab_localstorage_1 = require("../lib/ab-localstorage");
 const get_locale_1 = require("../lib/get-locale");
 const content_1 = require("./content");
 const personalised_1 = require("./personalised");
@@ -24,7 +25,7 @@ const filterEmptyValues = (pageTargets) => {
     }
     return filtered;
 };
-const buildPageTargeting = (consentState, adFree, clientSideParticipations) => {
+const buildPageTargeting = (consentState, adFree) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const contentTargeting = (0, content_1.getContentTargeting)({
@@ -44,7 +45,7 @@ const buildPageTargeting = (consentState, adFree, clientSideParticipations) => {
         isSignedIn: !!(0, libs_1.getCookie)({ name: 'GU_U' }),
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {
-            clientSideParticipations,
+            clientSideParticipations: (0, ab_localstorage_1.getParticipationsFromLocalStorage)(),
             serverSideParticipations: window.guardian.config.tests ?? {},
         },
         referrer: getReferrer(),

package/dist/esm/index.d.ts

@@ -1,6 +1,5 @@
 export { ias } from './third-party-tags/ias';
 export { permutive } from './third-party-tags/permutive';
-export { fbPixel } from './third-party-tags/facebook-pixel';
 export { twitter } from './third-party-tags/twitter-uwt';
 export { inizio } from './third-party-tags/inizio';
 export { remarketing } from './third-party-tags/remarketing';

package/dist/esm/index.js

@@ -1,7 +1,6 @@
 /* istanbul ignore file -- there's no point check this for test coverage */
 export { ias } from './third-party-tags/ias';
 export { permutive } from './third-party-tags/permutive';
-export { fbPixel } from './third-party-tags/facebook-pixel';
 export { twitter } from './third-party-tags/twitter-uwt';
 export { inizio } from './third-party-tags/inizio';
 export { remarketing } from './third-party-tags/remarketing';

package/dist/esm/lib/ab-localstorage.d.ts

@@ -0,0 +1,2 @@
+import type { Participations } from '@guardian/ab-core';
+export declare const getParticipationsFromLocalStorage: () => Participations;

package/dist/esm/lib/ab-localstorage.js

@@ -0,0 +1,10 @@
+import { isObject, isString, storage } from '@guardian/libs';
+const participationsKey = 'gu.ab.participations';
+const isParticipations = (participations) => {
+    return (isObject(participations) &&
+        Object.values(participations).every((participation) => isObject(participation) && isString(participation.variant)));
+};
+export const getParticipationsFromLocalStorage = () => {
+    const participations = storage.local.get(participationsKey);
+    return isParticipations(participations) ? participations : {};
+};

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

@@ -1,4 +1,3 @@
-import type { Participations } from '@guardian/ab-core';
 import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
 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"];
@@ -10,8 +9,7 @@ declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessT
  *
  * @param  {ConsentState} consentState
  * @param  {boolean} adFree
- * @param  {Participations} clientSideParticipations
  * @returns ConsentlessPageTargeting
  */
-declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean) => ConsentlessPageTargeting;
 export { buildPageTargetingConsentless };

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

@@ -29,11 +29,10 @@ const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
  *
  * @param  {ConsentState} consentState
  * @param  {boolean} adFree
- * @param  {Participations} clientSideParticipations
  * @returns ConsentlessPageTargeting
  */
-const buildPageTargetingConsentless = (consentState, adFree, clientSideParticipations) => {
-    const consentedPageTargeting = buildPageTargeting(consentState, adFree, clientSideParticipations);
+const buildPageTargetingConsentless = (consentState, adFree) => {
+    const consentedPageTargeting = buildPageTargeting(consentState, adFree);
     return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
 };
 export { buildPageTargetingConsentless };

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

@@ -1,4 +1,3 @@
-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 { False, True } from '../types';
@@ -34,6 +33,6 @@ declare type PageTargeting = PartialWithNulls<{
     vl: string;
     [_: string]: string | string[];
 } & SharedTargeting>;
-declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => PageTargeting;
+declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean) => PageTargeting;
 export { buildPageTargeting };
 export type { PageTargeting };

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

@@ -1,5 +1,6 @@
 import { cmp } from '@guardian/consent-management-platform';
 import { getCookie, isString } from '@guardian/libs';
+import { getParticipationsFromLocalStorage } from '../lib/ab-localstorage';
 import { getLocale } from '../lib/get-locale';
 import { getContentTargeting } from './content';
 import { getPersonalisedTargeting } from './personalised';
@@ -21,7 +22,7 @@ const filterEmptyValues = (pageTargets) => {
     }
     return filtered;
 };
-const buildPageTargeting = (consentState, adFree, clientSideParticipations) => {
+const buildPageTargeting = (consentState, adFree) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const contentTargeting = getContentTargeting({
@@ -41,7 +42,7 @@ const buildPageTargeting = (consentState, adFree, clientSideParticipations) => {
         isSignedIn: !!getCookie({ name: 'GU_U' }),
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {
-            clientSideParticipations,
+            clientSideParticipations: getParticipationsFromLocalStorage(),
             serverSideParticipations: window.guardian.config.tests ?? {},
         },
         referrer: getReferrer(),

package/package.json

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

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

@@ -1,7 +0,0 @@
-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,15 +0,0 @@
-"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`,
-    name: 'fb',
-    useImage: true,
-});
-exports.fbPixel = fbPixel;

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

@@ -1,7 +0,0 @@
-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,11 +0,0 @@
-/**
- * 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`,
-    name: 'fb',
-    useImage: true,
-});