@guardian/commercial-core 30.0.0 → 30.2.0

package/README.md

@@ -22,6 +22,15 @@ pnpm build
 
 This will build the package into the `dist` directory, which is what is published to npm.
 
+### Testing
+
+To run the unit tests:
+
+`pnpm test`
+
+This might fail if the base test coverage hasn't been met. This is set in jest.config.js. Ensure you add sufficient tests to meet the threshold if you can. If this is not possible for whatever reason, you can decrease the set thresholds but this should be considered a last resort
+
+
 #### 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.
 

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

@@ -1,3 +1,5 @@
-type HashClient = 'id5' | 'uid2';
+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 };
+export { hashEmailForClient, normaliseEmail };

package/dist/cjs/email-hash.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hashEmailForClient = hashEmailForClient;
+exports.normaliseEmail = normaliseEmail;
 function toHex(hashBuffer) {
     const hashArray = Array.from(new Uint8Array(hashBuffer));
     const hashHex = hashArray
@@ -13,14 +14,24 @@ function toBase64(hashBuffer) {
     const base64Hash = btoa(String.fromCharCode(...hashBytes));
     return base64Hash;
 }
-async function hashEmailForClient(email, client) {
+function normaliseEmail(email) {
     const normalisedEmail = email.trim().toLowerCase();
+    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/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/types.d.ts

@@ -1,7 +1,7 @@
 import type { EventPayload } from '@guardian/ophan-tracker-js';
 import type { AdSize, SizeMapping } from './ad-sizes.js';
 import type { PageTargeting } from './targeting/build-page-targeting.js';
-import 'googletag';
+import '@types/google-publisher-tag';
 type HeaderBiddingSize = AdSize;
 interface Advert {
     id: string;

package/dist/cjs/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-require("googletag");
+require("@types/google-publisher-tag");
 var BlockingType;
 (function (BlockingType) {
     BlockingType[BlockingType["Manual"] = 1] = "Manual";

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

@@ -1,3 +1,5 @@
-type HashClient = 'id5' | 'uid2';
+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 };
+export { hashEmailForClient, normaliseEmail };

package/dist/esm/email-hash.js

@@ -10,15 +10,25 @@ function toBase64(hashBuffer) {
     const base64Hash = btoa(String.fromCharCode(...hashBytes));
     return base64Hash;
 }
-async function hashEmailForClient(email, client) {
+function normaliseEmail(email) {
     const normalisedEmail = email.trim().toLowerCase();
+    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 };
+export { hashEmailForClient, normaliseEmail };

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/types.d.ts

@@ -1,7 +1,7 @@
 import type { EventPayload } from '@guardian/ophan-tracker-js';
 import type { AdSize, SizeMapping } from './ad-sizes.js';
 import type { PageTargeting } from './targeting/build-page-targeting.js';
-import 'googletag';
+import '@types/google-publisher-tag';
 type HeaderBiddingSize = AdSize;
 interface Advert {
     id: string;

package/dist/esm/types.js

@@ -1,4 +1,4 @@
-import 'googletag';
+import '@types/google-publisher-tag';
 var BlockingType;
 (function (BlockingType) {
     BlockingType[BlockingType["Manual"] = 1] = "Manual";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "30.0.0",
+  "version": "30.2.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial#readme",
   "bugs": {
@@ -37,11 +37,11 @@
   },
   "dependencies": {
     "@guardian/ab-core": "9.0.0",
-    "@guardian/libs": "27.0.0"
+    "@guardian/libs": "27.0.0",
+    "@types/google-publisher-tag": "~1.20251117.0"
   },
   "devDependencies": {
     "@guardian/ophan-tracker-js": "2.6.3",
-    "@types/google-publisher-tag": "~1.20251117.0",
     "@types/jest": "30.0.0",
     "@types/node": "24.10.1",
     "jest": "^30.2.0",
@@ -64,6 +64,7 @@
     "prettier:check": "prettier . --check --cache",
     "prettier:fix": "prettier . --write --cache",
     "test": "jest",
+    "test-cov": "jest --coverage",
     "tsc": "tsc --noEmit"
   }
 }