@guardian/commercial-core 30.0.0 → 30.1.0

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

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

package/dist/cjs/email-hash.js

@@ -21,6 +21,7 @@ async function hashEmailForClient(email, 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/esm/email-hash.d.ts

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

package/dist/esm/email-hash.js

@@ -18,6 +18,7 @@ async function hashEmailForClient(email, client) {
         case 'id5':
             return toHex(hashBuffer);
         case 'uid2':
+        case 'euid':
             return toBase64(hashBuffer);
     }
 }

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/package.json

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