@guardian/commercial-core 27.1.0 → 27.2.1

package/dist/cjs/geo/country-code.js

@@ -10,7 +10,6 @@ const editionToCountryCodeMap = {
 const editionToCountryCode = (editionKey = 'UK') => editionToCountryCodeMap[editionKey];
 const countryCookieName = 'GU_geo_country';
 const countryOverrideName = 'gu.geo.override';
-let locale;
 /*
    This method can be used as a non async way of getting the country code
    after init has been called. Returning locale should cover all/most
@@ -23,8 +22,7 @@ const getCountryCode = () => {
     const countryOverride = (0, libs_1.isString)(maybeCountryOverride)
         ? maybeCountryOverride
         : null;
-    return (locale ??
-        countryOverride ??
+    return (countryOverride ??
         (0, libs_1.getCookie)({
             name: countryCookieName,
             shouldMemoize: true,

package/dist/cjs/global.d.ts

@@ -1,5 +1,5 @@
 import type { EventTimer } from './event-timer';
-import type { AdBlockers, Apstag, ArticleCounts, ComscoreGlobals, Confiant, Config, DfpEnv, FetchBidResponse, GoogleTagParams, GoogleTrackConversionObject, HeaderNotification, IasPET, NetworkInformation, NSdkInstance, Ophan, OptOutAdSlot, OptOutInitializeOptions, Permutive, SafeFrameAPI, TeadsAnalytics, Trac } from './types';
+import type { AdBlockers, Admiral, Apstag, ArticleCounts, ComscoreGlobals, Confiant, Config, DfpEnv, FetchBidResponse, GoogleTagParams, GoogleTrackConversionObject, HeaderNotification, IasPET, NetworkInformation, NSdkInstance, Ophan, OptOutAdSlot, OptOutInitializeOptions, Permutive, SafeFrameAPI, TeadsAnalytics, Trac } from './types';
 declare global {
     interface Navigator {
         readonly connection?: NetworkInformation;
@@ -67,5 +67,6 @@ declare global {
             cmd: string;
             val: Record<string, unknown>;
         }>;
+        admiral?: Admiral;
     }
 }

package/dist/cjs/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 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");

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

@@ -2,6 +2,7 @@ import type { Participations } from '@guardian/ab-core';
 import type { ConsentState, CountryCode } from '@guardian/libs';
 import type { AdManagerGroup, Frequency } from './personalised';
 import type { SharedTargeting } from './shared';
+import { getLocalHour } from './shared';
 import type { TrueOrFalse } from './types';
 type PartialWithNulls<T> = {
     [P in keyof T]?: T[P] | null;
@@ -13,6 +14,7 @@ type PageTargeting = PartialWithNulls<{
     at: string;
     bp: 'mobile' | 'tablet' | 'desktop';
     cc: CountryCode;
+    lh: string;
     cmp_interaction: string;
     consent_tcfv2: string;
     dcre: TrueOrFalse;
@@ -43,5 +45,5 @@ type BuildPageTargetingParams = {
     youtube?: boolean;
 };
 declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, }: BuildPageTargetingParams) => Record<string, string | string[]>;
-export { buildPageTargeting, filterValues };
+export { buildPageTargeting, filterValues, getLocalHour };
 export type { PageTargeting };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterValues = exports.buildPageTargeting = void 0;
+exports.getLocalHour = exports.filterValues = exports.buildPageTargeting = void 0;
 const libs_1 = require("@guardian/libs");
 const event_timer_1 = require("../event-timer");
 const get_locale_1 = require("../geo/get-locale");
@@ -8,6 +8,7 @@ const content_1 = require("./content");
 const personalised_1 = require("./personalised");
 const session_1 = require("./session");
 const shared_1 = require("./shared");
+Object.defineProperty(exports, "getLocalHour", { enumerable: true, get: function () { return shared_1.getLocalHour; } });
 const viewport_1 = require("./viewport");
 const filterValues = (pageTargets) => {
     const filtered = {};
@@ -70,6 +71,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
     const sessionTargeting = (0, session_1.getSessionTargeting)({
         adTest: (0, libs_1.getCookie)({ name: 'adtest', shouldMemoize: true }),
         countryCode: (0, get_locale_1.getLocale)(),
+        localHour: (0, shared_1.getLocalHour)(),
         isSignedIn,
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {

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

@@ -53,6 +53,14 @@ type SessionTargeting = {
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11703293
      */
     cc: CountryCode;
+    /**
+     * **L**ocal **H**our - [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=17299564
+     */
+    lh: string;
     /**
      * Ophan **P**age **V**iew id – [see on Ad Manager][gam]
      *
@@ -101,11 +109,12 @@ declare const experimentsTargeting: ({ clientSideParticipations, serverSideParti
 type Session = {
     adTest: SessionTargeting['at'];
     countryCode: CountryCode;
+    localHour: string;
     isSignedIn: boolean;
     pageViewId: SessionTargeting['pv'];
     participations: AllParticipations;
     referrer: string;
 };
-declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
+declare const getSessionTargeting: ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
 export type { SessionTargeting, AllParticipations };
 export { getSessionTargeting, experimentsTargeting };

package/dist/cjs/targeting/session.js

@@ -50,10 +50,11 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     return [...clientSideExperiment, ...serverSideExperiments];
 };
 exports.experimentsTargeting = experimentsTargeting;
-const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }) => ({
+const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }) => ({
     ab: experimentsTargeting(participations),
     at: adTest,
     cc: countryCode,
+    lh: localHour,
     pv: pageViewId,
     ref: getReferrer(referrer),
     si: isSignedIn ? 't' : 'f',

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

@@ -145,6 +145,7 @@ type SharedTargeting = {
      */
     url: `/${string}`;
 };
+declare const getLocalHour: () => string;
 /**
  * What goes in comes out
  */
@@ -153,4 +154,4 @@ export declare const _: {
     getSurgingParam: (surging: number) => SharedTargeting["su"];
 };
 export type { SharedTargeting };
-export { getSharedTargeting };
+export { getSharedTargeting, getLocalHour };

package/dist/cjs/targeting/shared.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSharedTargeting = exports._ = void 0;
+exports.getLocalHour = exports.getSharedTargeting = exports._ = void 0;
 const pick_targeting_values_1 = require("./pick-targeting-values");
 const surges = {
     0: '0',
@@ -18,6 +18,10 @@ const getSurgingParam = (surging) => {
     return thresholds.filter((n) => n <= surging).map((s) => surges[s]);
 };
 /* -- Targeting -- */
+const getLocalHour = () => {
+    return new Date().getHours().toString();
+};
+exports.getLocalHour = getLocalHour;
 /**
  * What goes in comes out
  */

package/dist/cjs/types.d.ts

@@ -1,3 +1,4 @@
+import type { EventPayload } from '@guardian/ophan-tracker-js';
 import type { AdSize, SizeMapping } from './ad-sizes';
 import type { PageTargeting } from './targeting/build-page-targeting';
 import 'googletag';
@@ -5,7 +6,6 @@ type HeaderBiddingSize = AdSize;
 interface Advert {
     id: string;
     node: HTMLElement;
-    prebidAdUnit: string;
     sizes: SizeMapping;
     headerBiddingSizes: HeaderBiddingSize[] | null;
     size: AdSize | 'fluid' | null;
@@ -41,7 +41,7 @@ interface NetworkInformation extends EventTarget {
     readonly downlink?: number;
     readonly effectiveType?: string;
 }
-type OphanRecordFunction = (event: Record<string, unknown> & {
+type OphanRecordFunction = (event: EventPayload & {
     /**
      * the experiences key will override previously set values.
      * Use `recordExperiences` instead.
@@ -424,4 +424,8 @@ type GoogleTrackConversionObject = {
     google_custom_params: GoogleTagParams;
     google_remarketing_only: boolean;
 };
-export type { Advert, DfpEnv, ConnectionType, NetworkInformation, OphanRecordFunction, Indices, Edition, AdsConfigDisabled, AdsConfigEnabled, AdsConfigBasic, AdsConfigUSNATorAus, AdsConfigTCFV2, AdsConfig, AdTargetingBuilder, Ophan, Config, AdBlockers, ArticleCounts, FetchBidResponse, HeaderNotification, OptOutInitializeOptions, OptOutAdSlot, Confiant, Permutive, Apstag, ComscoreGlobals, IasPET, TeadsAnalytics, SafeFrameAPI, NSdkInstance, Trac, GoogleTagParams, GoogleTrackConversionObject, };
+type AdmiralEvent = Record<string, unknown>;
+type AdmiralCallback = (event: AdmiralEvent) => void;
+type AdmiralArg = string | AdmiralCallback;
+type Admiral = (...args: AdmiralArg[]) => void;
+export type { Advert, DfpEnv, ConnectionType, NetworkInformation, OphanRecordFunction, Indices, Edition, AdsConfigDisabled, AdsConfigEnabled, AdsConfigBasic, AdsConfigUSNATorAus, AdsConfigTCFV2, AdsConfig, AdTargetingBuilder, Ophan, Config, AdBlockers, ArticleCounts, FetchBidResponse, HeaderNotification, OptOutInitializeOptions, OptOutAdSlot, Confiant, Permutive, Apstag, ComscoreGlobals, IasPET, TeadsAnalytics, SafeFrameAPI, NSdkInstance, Trac, GoogleTagParams, GoogleTrackConversionObject, Admiral, AdmiralEvent, };

package/dist/esm/geo/country-code.js

@@ -7,7 +7,6 @@ const editionToCountryCodeMap = {
 const editionToCountryCode = (editionKey = 'UK') => editionToCountryCodeMap[editionKey];
 const countryCookieName = 'GU_geo_country';
 const countryOverrideName = 'gu.geo.override';
-let locale;
 /*
    This method can be used as a non async way of getting the country code
    after init has been called. Returning locale should cover all/most
@@ -20,8 +19,7 @@ const getCountryCode = () => {
     const countryOverride = isString(maybeCountryOverride)
         ? maybeCountryOverride
         : null;
-    return (locale ??
-        countryOverride ??
+    return (countryOverride ??
         getCookie({
             name: countryCookieName,
             shouldMemoize: true,

package/dist/esm/global.d.ts

@@ -1,5 +1,5 @@
 import type { EventTimer } from './event-timer';
-import type { AdBlockers, Apstag, ArticleCounts, ComscoreGlobals, Confiant, Config, DfpEnv, FetchBidResponse, GoogleTagParams, GoogleTrackConversionObject, HeaderNotification, IasPET, NetworkInformation, NSdkInstance, Ophan, OptOutAdSlot, OptOutInitializeOptions, Permutive, SafeFrameAPI, TeadsAnalytics, Trac } from './types';
+import type { AdBlockers, Admiral, Apstag, ArticleCounts, ComscoreGlobals, Confiant, Config, DfpEnv, FetchBidResponse, GoogleTagParams, GoogleTrackConversionObject, HeaderNotification, IasPET, NetworkInformation, NSdkInstance, Ophan, OptOutAdSlot, OptOutInitializeOptions, Permutive, SafeFrameAPI, TeadsAnalytics, Trac } from './types';
 declare global {
     interface Navigator {
         readonly connection?: NetworkInformation;
@@ -67,5 +67,6 @@ declare global {
             cmd: string;
             val: Record<string, unknown>;
         }>;
+        admiral?: Admiral;
     }
 }

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

@@ -2,6 +2,7 @@ import type { Participations } from '@guardian/ab-core';
 import type { ConsentState, CountryCode } from '@guardian/libs';
 import type { AdManagerGroup, Frequency } from './personalised';
 import type { SharedTargeting } from './shared';
+import { getLocalHour } from './shared';
 import type { TrueOrFalse } from './types';
 type PartialWithNulls<T> = {
     [P in keyof T]?: T[P] | null;
@@ -13,6 +14,7 @@ type PageTargeting = PartialWithNulls<{
     at: string;
     bp: 'mobile' | 'tablet' | 'desktop';
     cc: CountryCode;
+    lh: string;
     cmp_interaction: string;
     consent_tcfv2: string;
     dcre: TrueOrFalse;
@@ -43,5 +45,5 @@ type BuildPageTargetingParams = {
     youtube?: boolean;
 };
 declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, }: BuildPageTargetingParams) => Record<string, string | string[]>;
-export { buildPageTargeting, filterValues };
+export { buildPageTargeting, filterValues, getLocalHour };
 export type { PageTargeting };

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

@@ -4,7 +4,7 @@ import { getLocale } from '../geo/get-locale';
 import { getContentTargeting } from './content';
 import { getPersonalisedTargeting } from './personalised';
 import { getSessionTargeting } from './session';
-import { getSharedTargeting } from './shared';
+import { getLocalHour, getSharedTargeting } from './shared';
 import { getViewportTargeting } from './viewport';
 const filterValues = (pageTargets) => {
     const filtered = {};
@@ -66,6 +66,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
     const sessionTargeting = getSessionTargeting({
         adTest: getCookie({ name: 'adtest', shouldMemoize: true }),
         countryCode: getLocale(),
+        localHour: getLocalHour(),
         isSignedIn,
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {
@@ -105,4 +106,4 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
     const pageTargeting = filterValues(pageTargets);
     return pageTargeting;
 };
-export { buildPageTargeting, filterValues };
+export { buildPageTargeting, filterValues, getLocalHour };

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

@@ -53,6 +53,14 @@ type SessionTargeting = {
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11703293
      */
     cc: CountryCode;
+    /**
+     * **L**ocal **H**our - [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=17299564
+     */
+    lh: string;
     /**
      * Ophan **P**age **V**iew id – [see on Ad Manager][gam]
      *
@@ -101,11 +109,12 @@ declare const experimentsTargeting: ({ clientSideParticipations, serverSideParti
 type Session = {
     adTest: SessionTargeting['at'];
     countryCode: CountryCode;
+    localHour: string;
     isSignedIn: boolean;
     pageViewId: SessionTargeting['pv'];
     participations: AllParticipations;
     referrer: string;
 };
-declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
+declare const getSessionTargeting: ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
 export type { SessionTargeting, AllParticipations };
 export { getSessionTargeting, experimentsTargeting };

package/dist/esm/targeting/session.js

@@ -46,10 +46,11 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
-const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }) => ({
+const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }) => ({
     ab: experimentsTargeting(participations),
     at: adTest,
     cc: countryCode,
+    lh: localHour,
     pv: pageViewId,
     ref: getReferrer(referrer),
     si: isSignedIn ? 't' : 'f',

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

@@ -145,6 +145,7 @@ type SharedTargeting = {
      */
     url: `/${string}`;
 };
+declare const getLocalHour: () => string;
 /**
  * What goes in comes out
  */
@@ -153,4 +154,4 @@ export declare const _: {
     getSurgingParam: (surging: number) => SharedTargeting["su"];
 };
 export type { SharedTargeting };
-export { getSharedTargeting };
+export { getSharedTargeting, getLocalHour };

package/dist/esm/targeting/shared.js

@@ -15,6 +15,9 @@ const getSurgingParam = (surging) => {
     return thresholds.filter((n) => n <= surging).map((s) => surges[s]);
 };
 /* -- Targeting -- */
+const getLocalHour = () => {
+    return new Date().getHours().toString();
+};
 /**
  * What goes in comes out
  */
@@ -22,4 +25,4 @@ const getSharedTargeting = (shared) => pickTargetingValues(shared);
 export const _ = {
     getSurgingParam,
 };
-export { getSharedTargeting };
+export { getSharedTargeting, getLocalHour };

package/dist/esm/types.d.ts

@@ -1,3 +1,4 @@
+import type { EventPayload } from '@guardian/ophan-tracker-js';
 import type { AdSize, SizeMapping } from './ad-sizes';
 import type { PageTargeting } from './targeting/build-page-targeting';
 import 'googletag';
@@ -5,7 +6,6 @@ type HeaderBiddingSize = AdSize;
 interface Advert {
     id: string;
     node: HTMLElement;
-    prebidAdUnit: string;
     sizes: SizeMapping;
     headerBiddingSizes: HeaderBiddingSize[] | null;
     size: AdSize | 'fluid' | null;
@@ -41,7 +41,7 @@ interface NetworkInformation extends EventTarget {
     readonly downlink?: number;
     readonly effectiveType?: string;
 }
-type OphanRecordFunction = (event: Record<string, unknown> & {
+type OphanRecordFunction = (event: EventPayload & {
     /**
      * the experiences key will override previously set values.
      * Use `recordExperiences` instead.
@@ -424,4 +424,8 @@ type GoogleTrackConversionObject = {
     google_custom_params: GoogleTagParams;
     google_remarketing_only: boolean;
 };
-export type { Advert, DfpEnv, ConnectionType, NetworkInformation, OphanRecordFunction, Indices, Edition, AdsConfigDisabled, AdsConfigEnabled, AdsConfigBasic, AdsConfigUSNATorAus, AdsConfigTCFV2, AdsConfig, AdTargetingBuilder, Ophan, Config, AdBlockers, ArticleCounts, FetchBidResponse, HeaderNotification, OptOutInitializeOptions, OptOutAdSlot, Confiant, Permutive, Apstag, ComscoreGlobals, IasPET, TeadsAnalytics, SafeFrameAPI, NSdkInstance, Trac, GoogleTagParams, GoogleTrackConversionObject, };
+type AdmiralEvent = Record<string, unknown>;
+type AdmiralCallback = (event: AdmiralEvent) => void;
+type AdmiralArg = string | AdmiralCallback;
+type Admiral = (...args: AdmiralArg[]) => void;
+export type { Advert, DfpEnv, ConnectionType, NetworkInformation, OphanRecordFunction, Indices, Edition, AdsConfigDisabled, AdsConfigEnabled, AdsConfigBasic, AdsConfigUSNATorAus, AdsConfigTCFV2, AdsConfig, AdTargetingBuilder, Ophan, Config, AdBlockers, ArticleCounts, FetchBidResponse, HeaderNotification, OptOutInitializeOptions, OptOutAdSlot, Confiant, Permutive, Apstag, ComscoreGlobals, IasPET, TeadsAnalytics, SafeFrameAPI, NSdkInstance, Trac, GoogleTagParams, GoogleTrackConversionObject, Admiral, AdmiralEvent, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "27.1.0",
+  "version": "27.2.1",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial#readme",
   "bugs": {
@@ -31,22 +31,23 @@
   },
   "peerDependencies": {
     "@guardian/ab-core": "8.0.1",
-    "@guardian/libs": "22.5.0"
+    "@guardian/libs": "25.2.0"
   },
   "dependencies": {
     "@guardian/ab-core": "8.0.1",
-    "@guardian/libs": "22.5.0",
+    "@guardian/libs": "25.2.0",
     "@types/googletag": "~3.3.0"
   },
   "devDependencies": {
-    "@types/node": "24.0.12",
-    "typescript": "5.5.4",
+    "@guardian/ophan-tracker-js": "2.4.0",
     "@types/jest": "30.0.0",
-    "jest": "^30.0.1",
-    "jest-environment-jsdom": "~29.7.0",
+    "@types/node": "24.2.0",
+    "jest": "^30.0.5",
+    "jest-environment-jsdom": "^30.0.5",
     "jest-environment-jsdom-global": "~4.0.0",
-    "ts-jest": "^29.2.5",
-    "type-fest": "^4.31.0"
+    "ts-jest": "^29.4.1",
+    "typescript": "5.8.3",
+    "type-fest": "^4.41.0"
   },
   "publishConfig": {
     "access": "public"