@guardian/commercial-core 0.0.0-beta-20251113115216 → 0.0.0-beta-20260119180836

package/README.md

@@ -23,7 +23,6 @@ pnpm build
 This will build the package into the `dist` directory, which is what is published to npm.
 
 #### Beta Releases
-
 You can add the [beta] @guardian/commercial-core label to your pull request, this will release a beta version of the bundle to NPM, the exact version will be commented on your PR.
 
 In order to do this, run `pnpm changeset`. This will create a new changeset file in the .changeset directory. Commit this file with your PR.
@@ -31,7 +30,6 @@ In order to do this, run `pnpm changeset`. This will create a new changeset file
 Note: Once the beta version is released, the label will be removed from the PR, so you will need to add it again if you want to release subsequent new versions.
 
 ## Releasing to NPM
-
 This repository uses changesets for version management.
 
 To release a new version with your changes, run:

package/dist/cjs/email-hash.d.ts

@@ -1 +1,5 @@
-export declare function hashEmail(email: string): Promise<string>;
+type HashClient = 'id5' | 'uid2' | 'euid';
+type Email = `${string}@${string}`;
+declare function normaliseEmail(email: string): Email;
+declare function hashEmailForClient(email: string, client: HashClient): Promise<string>;
+export { hashEmailForClient, normaliseEmail };

package/dist/cjs/email-hash.js

@@ -1,16 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hashEmail = hashEmail;
-async function sha256(string) {
-    const utf8 = new TextEncoder().encode(string);
-    const hashBuffer = await crypto.subtle.digest('SHA-256', utf8);
+exports.hashEmailForClient = hashEmailForClient;
+exports.normaliseEmail = normaliseEmail;
+function toHex(hashBuffer) {
     const hashArray = Array.from(new Uint8Array(hashBuffer));
     const hashHex = hashArray
         .map((bytes) => bytes.toString(16).padStart(2, '0'))
         .join('');
     return hashHex;
 }
-function hashEmail(email) {
+function toBase64(hashBuffer) {
+    const hashBytes = new Uint8Array(hashBuffer);
+    const base64Hash = btoa(String.fromCharCode(...hashBytes));
+    return base64Hash;
+}
+function normaliseEmail(email) {
     const normalisedEmail = email.trim().toLowerCase();
-    return sha256(normalisedEmail);
+    const [name, domain] = normalisedEmail.split('@');
+    if (domain !== 'gmail.com') {
+        return `${name}@${domain}`;
+    }
+    const strippedLocal = name?.replaceAll('.', '');
+    return `${strippedLocal}@${domain}`;
+}
+async function hashEmailForClient(email, client) {
+    const normalisedEmail = normaliseEmail(email);
+    const utf8 = new TextEncoder().encode(normalisedEmail);
+    const hashBuffer = await crypto.subtle.digest('SHA-256', utf8);
+    switch (client) {
+        case 'id5':
+            return toHex(hashBuffer);
+        case 'uid2':
+        case 'euid':
+            return toBase64(hashBuffer);
+    }
 }

package/dist/cjs/index.d.ts

@@ -8,7 +8,7 @@ export { postMessage } from './messenger/post-message.js';
 export { buildImaAdTagUrl } from './targeting/youtube-ima.js';
 export { getPermutivePFPSegments } from './permutive.js';
 export { isEligibleForTeads } from './targeting/teads-eligibility.js';
-export { hashEmail } from './email-hash.js';
+export { hashEmailForClient } from './email-hash.js';
 export type { AdSize, SizeMapping, SlotName } from './ad-sizes.js';
 export type { PageTargeting } from './targeting/build-page-targeting.js';
 export type { AdsConfigDisabled, AdsConfigUSNATorAus, AdsConfigTCFV2, } from './types.js';

package/dist/cjs/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hashEmail = exports.isEligibleForTeads = exports.getPermutivePFPSegments = exports.buildImaAdTagUrl = exports.buildPageTargeting = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.constants = exports.adSizes = exports.EventTimer = exports.isAdBlockInUse = void 0;
+exports.hashEmailForClient = exports.isEligibleForTeads = exports.getPermutivePFPSegments = exports.buildImaAdTagUrl = exports.buildPageTargeting = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.constants = exports.adSizes = exports.EventTimer = exports.isAdBlockInUse = void 0;
 var detect_ad_blocker_1 = require("./detect-ad-blocker.js");
 Object.defineProperty(exports, "isAdBlockInUse", { enumerable: true, get: function () { return detect_ad_blocker_1.isAdBlockInUse; } });
 var event_timer_1 = require("./event-timer.js");
@@ -55,4 +55,4 @@ Object.defineProperty(exports, "getPermutivePFPSegments", { enumerable: true, ge
 var teads_eligibility_1 = require("./targeting/teads-eligibility.js");
 Object.defineProperty(exports, "isEligibleForTeads", { enumerable: true, get: function () { return teads_eligibility_1.isEligibleForTeads; } });
 var email_hash_1 = require("./email-hash.js");
-Object.defineProperty(exports, "hashEmail", { enumerable: true, get: function () { return email_hash_1.hashEmail; } });
+Object.defineProperty(exports, "hashEmailForClient", { enumerable: true, get: function () { return email_hash_1.hashEmailForClient; } });

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

@@ -30,6 +30,7 @@ type PageTargeting = PartialWithNulls<{
     s: string;
     sens: TrueOrFalse;
     si: TrueOrFalse;
+    idp: string[];
     skinsize: 'l' | 's';
     urlkw: string[];
     vl: string;
@@ -37,13 +38,24 @@ type PageTargeting = PartialWithNulls<{
     [_: string]: string | string[];
 } & SharedTargeting>;
 declare const filterValues: (pageTargets: Record<string, unknown>) => Record<string, string | string[]>;
+type UserId = {
+    name: string;
+    params?: Record<string, string | number>;
+    storage?: {
+        type: 'cookie' | 'html5';
+        name: string;
+        expires: number;
+        refreshInSeconds?: number;
+    };
+};
 type BuildPageTargetingParams = {
     adFree: boolean;
     clientSideParticipations: Participations;
     consentState: ConsentState;
     isSignedIn?: boolean;
     youtube?: boolean;
+    idProviders?: UserId[];
 };
-declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, }: BuildPageTargetingParams) => Record<string, string | string[]>;
+declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, idProviders, }: BuildPageTargetingParams) => Record<string, string | string[]>;
 export { buildPageTargeting, filterValues, getLocalHour };
-export type { PageTargeting };
+export type { UserId, PageTargeting };

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

@@ -49,7 +49,7 @@ const isFirstVisit = (referrer) => {
     }
     return !referrerMatchesHost(referrer);
 };
-const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, isSignedIn = false, youtube = false, }) => {
+const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, isSignedIn = false, youtube = false, idProviders = [], }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const sharedAdTargeting = page.sharedAdTargeting
@@ -80,6 +80,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
             betaAbTestParticipations: window.guardian.modules.abTests?.getParticipations() ?? {},
         },
         referrer,
+        idProviders,
     });
     const getViewport = () => {
         return {

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

@@ -1,5 +1,6 @@
 import type { Participations } from '@guardian/ab-core';
 import type { CountryCode } from '@guardian/libs';
+import type { UserId } from '../targeting/build-page-targeting.js';
 import type { False, True } from './types.js';
 declare const referrers: readonly [{
     readonly id: "facebook";
@@ -97,6 +98,14 @@ type SessionTargeting = {
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=215727
      */
     si: True | False;
+    /**
+     * **I**d **P**roviders – [see on Ad Manager][gam]
+     *
+     * Denote which id providers have been integrated.
+     *
+     * [gam]: To be added
+     */
+    idp: string[] | null;
 };
 type AllParticipations = {
     clientSideParticipations: Participations;
@@ -119,7 +128,8 @@ type Session = {
     pageViewId: SessionTargeting['pv'];
     participations: AllParticipations;
     referrer: string;
+    idProviders: UserId[];
 };
-declare const getSessionTargeting: ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
+declare const getSessionTargeting: ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, idProviders, }: Session) => SessionTargeting;
 export type { SessionTargeting, AllParticipations };
 export { getSessionTargeting, experimentsTargeting };

package/dist/cjs/targeting/session.js

@@ -63,7 +63,10 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     return [...clientSideExperiment, ...serverSideExperiments, ...betaAbTests];
 };
 exports.experimentsTargeting = experimentsTargeting;
-const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }) => ({
+const getIdProviders = (userIds) => {
+    return userIds.map((id) => id.name);
+};
+const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, idProviders, }) => ({
     ab: experimentsTargeting(participations),
     at: adTest,
     cc: countryCode,
@@ -71,5 +74,6 @@ const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageV
     pv: pageViewId,
     ref: getReferrer(referrer),
     si: isSignedIn ? 't' : 'f',
+    idp: getIdProviders(idProviders),
 });
 exports.getSessionTargeting = getSessionTargeting;

package/dist/cjs/targeting/teads-eligibility.js

@@ -5,7 +5,9 @@ const allowedContentTypes = ['Article', 'LiveBlog'];
 const isEligibleForTeads = (slotId) => {
     const { contentType, isSensitive } = window.guardian.config.page;
     // This IAS value is returned when a page is thought to contain content which is not brand safe
-    const iasKw = window.googletag.getConfig('targeting').targeting?.['ias-kw'];
+    const iasKw = 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- the googletag.getConfig function may not exist if googletag has been shimmed by an adblocker
+    window.googletag.getConfig?.('targeting').targeting?.['ias-kw'];
     const iasKwArray = Array.isArray(iasKw) ? iasKw : iasKw ? [iasKw] : [];
     const isBrandSafe = !iasKwArray.includes('IAS_16425_KW');
     if (slotId === 'dfp-ad--inline1' &&

package/dist/cjs/types.d.ts

@@ -326,6 +326,7 @@ type ApstagInitConfig = {
     adServer?: string;
     bidTimeout?: number;
     blockedBidders?: string[];
+    useSafeFrames?: boolean;
 };
 interface A9AdUnitInterface {
     slotID: string;

package/dist/esm/email-hash.d.ts

@@ -1 +1,5 @@
-export declare function hashEmail(email: string): Promise<string>;
+type HashClient = 'id5' | 'uid2' | 'euid';
+type Email = `${string}@${string}`;
+declare function normaliseEmail(email: string): Email;
+declare function hashEmailForClient(email: string, client: HashClient): Promise<string>;
+export { hashEmailForClient, normaliseEmail };

package/dist/esm/email-hash.js

@@ -1,13 +1,34 @@
-async function sha256(string) {
-    const utf8 = new TextEncoder().encode(string);
-    const hashBuffer = await crypto.subtle.digest('SHA-256', utf8);
+function toHex(hashBuffer) {
     const hashArray = Array.from(new Uint8Array(hashBuffer));
     const hashHex = hashArray
         .map((bytes) => bytes.toString(16).padStart(2, '0'))
         .join('');
     return hashHex;
 }
-export function hashEmail(email) {
+function toBase64(hashBuffer) {
+    const hashBytes = new Uint8Array(hashBuffer);
+    const base64Hash = btoa(String.fromCharCode(...hashBytes));
+    return base64Hash;
+}
+function normaliseEmail(email) {
     const normalisedEmail = email.trim().toLowerCase();
-    return sha256(normalisedEmail);
+    const [name, domain] = normalisedEmail.split('@');
+    if (domain !== 'gmail.com') {
+        return `${name}@${domain}`;
+    }
+    const strippedLocal = name?.replaceAll('.', '');
+    return `${strippedLocal}@${domain}`;
+}
+async function hashEmailForClient(email, client) {
+    const normalisedEmail = normaliseEmail(email);
+    const utf8 = new TextEncoder().encode(normalisedEmail);
+    const hashBuffer = await crypto.subtle.digest('SHA-256', utf8);
+    switch (client) {
+        case 'id5':
+            return toHex(hashBuffer);
+        case 'uid2':
+        case 'euid':
+            return toBase64(hashBuffer);
+    }
 }
+export { hashEmailForClient, normaliseEmail };

package/dist/esm/global.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/index.d.ts

@@ -8,7 +8,7 @@ export { postMessage } from './messenger/post-message.js';
 export { buildImaAdTagUrl } from './targeting/youtube-ima.js';
 export { getPermutivePFPSegments } from './permutive.js';
 export { isEligibleForTeads } from './targeting/teads-eligibility.js';
-export { hashEmail } from './email-hash.js';
+export { hashEmailForClient } from './email-hash.js';
 export type { AdSize, SizeMapping, SlotName } from './ad-sizes.js';
 export type { PageTargeting } from './targeting/build-page-targeting.js';
 export type { AdsConfigDisabled, AdsConfigUSNATorAus, AdsConfigTCFV2, } from './types.js';

package/dist/esm/index.js

@@ -8,4 +8,4 @@ export { postMessage } from './messenger/post-message.js';
 export { buildImaAdTagUrl } from './targeting/youtube-ima.js';
 export { getPermutivePFPSegments } from './permutive.js';
 export { isEligibleForTeads } from './targeting/teads-eligibility.js';
-export { hashEmail } from './email-hash.js';
+export { hashEmailForClient } from './email-hash.js';

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

@@ -30,6 +30,7 @@ type PageTargeting = PartialWithNulls<{
     s: string;
     sens: TrueOrFalse;
     si: TrueOrFalse;
+    idp: string[];
     skinsize: 'l' | 's';
     urlkw: string[];
     vl: string;
@@ -37,13 +38,24 @@ type PageTargeting = PartialWithNulls<{
     [_: string]: string | string[];
 } & SharedTargeting>;
 declare const filterValues: (pageTargets: Record<string, unknown>) => Record<string, string | string[]>;
+type UserId = {
+    name: string;
+    params?: Record<string, string | number>;
+    storage?: {
+        type: 'cookie' | 'html5';
+        name: string;
+        expires: number;
+        refreshInSeconds?: number;
+    };
+};
 type BuildPageTargetingParams = {
     adFree: boolean;
     clientSideParticipations: Participations;
     consentState: ConsentState;
     isSignedIn?: boolean;
     youtube?: boolean;
+    idProviders?: UserId[];
 };
-declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, }: BuildPageTargetingParams) => Record<string, string | string[]>;
+declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, idProviders, }: BuildPageTargetingParams) => Record<string, string | string[]>;
 export { buildPageTargeting, filterValues, getLocalHour };
-export type { PageTargeting };
+export type { UserId, PageTargeting };

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

@@ -44,7 +44,7 @@ const isFirstVisit = (referrer) => {
     }
     return !referrerMatchesHost(referrer);
 };
-const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, isSignedIn = false, youtube = false, }) => {
+const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, isSignedIn = false, youtube = false, idProviders = [], }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const sharedAdTargeting = page.sharedAdTargeting
@@ -75,6 +75,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
             betaAbTestParticipations: window.guardian.modules.abTests?.getParticipations() ?? {},
         },
         referrer,
+        idProviders,
     });
     const getViewport = () => {
         return {

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

@@ -1,5 +1,6 @@
 import type { Participations } from '@guardian/ab-core';
 import type { CountryCode } from '@guardian/libs';
+import type { UserId } from '../targeting/build-page-targeting.js';
 import type { False, True } from './types.js';
 declare const referrers: readonly [{
     readonly id: "facebook";
@@ -97,6 +98,14 @@ type SessionTargeting = {
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=215727
      */
     si: True | False;
+    /**
+     * **I**d **P**roviders – [see on Ad Manager][gam]
+     *
+     * Denote which id providers have been integrated.
+     *
+     * [gam]: To be added
+     */
+    idp: string[] | null;
 };
 type AllParticipations = {
     clientSideParticipations: Participations;
@@ -119,7 +128,8 @@ type Session = {
     pageViewId: SessionTargeting['pv'];
     participations: AllParticipations;
     referrer: string;
+    idProviders: UserId[];
 };
-declare const getSessionTargeting: ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
+declare const getSessionTargeting: ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, idProviders, }: Session) => SessionTargeting;
 export type { SessionTargeting, AllParticipations };
 export { getSessionTargeting, experimentsTargeting };

package/dist/esm/targeting/session.js

@@ -59,7 +59,10 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     }
     return [...clientSideExperiment, ...serverSideExperiments, ...betaAbTests];
 };
-const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }) => ({
+const getIdProviders = (userIds) => {
+    return userIds.map((id) => id.name);
+};
+const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, idProviders, }) => ({
     ab: experimentsTargeting(participations),
     at: adTest,
     cc: countryCode,
@@ -67,5 +70,6 @@ const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageV
     pv: pageViewId,
     ref: getReferrer(referrer),
     si: isSignedIn ? 't' : 'f',
+    idp: getIdProviders(idProviders),
 });
 export { getSessionTargeting, experimentsTargeting };

package/dist/esm/targeting/teads-eligibility.js

@@ -2,7 +2,9 @@ const allowedContentTypes = ['Article', 'LiveBlog'];
 const isEligibleForTeads = (slotId) => {
     const { contentType, isSensitive } = window.guardian.config.page;
     // This IAS value is returned when a page is thought to contain content which is not brand safe
-    const iasKw = window.googletag.getConfig('targeting').targeting?.['ias-kw'];
+    const iasKw = 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- the googletag.getConfig function may not exist if googletag has been shimmed by an adblocker
+    window.googletag.getConfig?.('targeting').targeting?.['ias-kw'];
     const iasKwArray = Array.isArray(iasKw) ? iasKw : iasKw ? [iasKw] : [];
     const isBrandSafe = !iasKwArray.includes('IAS_16425_KW');
     if (slotId === 'dfp-ad--inline1' &&

package/dist/esm/targeting/types.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types.d.ts

@@ -326,6 +326,7 @@ type ApstagInitConfig = {
     adServer?: string;
     bidTimeout?: number;
     blockedBidders?: string[];
+    useSafeFrames?: boolean;
 };
 interface A9AdUnitInterface {
     slotID: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "0.0.0-beta-20251113115216",
+  "version": "0.0.0-beta-20260119180836",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial#readme",
   "bugs": {
@@ -32,22 +32,22 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "@guardian/ab-core": "^8.0.1",
-    "@guardian/libs": "^26.0.0"
+    "@guardian/ab-core": "^9.0.0",
+    "@guardian/libs": "^27.0.0"
   },
   "dependencies": {
-    "@guardian/ab-core": "8.0.1",
-    "@guardian/libs": "26.0.1"
+    "@guardian/ab-core": "9.0.0",
+    "@guardian/libs": "27.0.0",
+    "@types/google-publisher-tag": "~1.20251117.0"
   },
   "devDependencies": {
-    "@guardian/ophan-tracker-js": "2.6.1",
-    "@types/google-publisher-tag": "~1.20250811.1",
+    "@guardian/ophan-tracker-js": "2.6.3",
     "@types/jest": "30.0.0",
-    "@types/node": "24.7.2",
+    "@types/node": "24.10.1",
     "jest": "^30.2.0",
     "jest-environment-jsdom": "^30.2.0",
     "jest-environment-jsdom-global": "~4.0.0",
-    "ts-jest": "^29.4.4",
+    "ts-jest": "^29.4.6",
     "tsc-alias": "1.8.16",
     "type-fest": "^4.41.0",
     "typescript": "5.9.3"