@guardian/commercial-core 4.16.0 → 4.17.0

package/dist/cjs/lib/get-locale.d.ts

@@ -0,0 +1,8 @@
+import type { CountryCode } from '@guardian/libs';
+export declare const __resetCachedValue: () => void;
+/**
+ * Fetches the user's current location as an ISO 3166-1 alpha-2 string e.g. 'GB', 'AU' etc
+ * Note: This has been copied from guardian-libs and made syncronous by ommiting the call to
+ * the geolocation API
+ */
+export declare const getLocale: () => CountryCode;

package/dist/cjs/lib/get-locale.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLocale = exports.__resetCachedValue = void 0;
+const libs_1 = require("@guardian/libs");
+const KEY = 'GU_geo_country';
+const KEY_OVERRIDE = 'gu.geo.override';
+const COUNTRY_REGEX = /^[A-Z]{2}$/;
+// best guess that we have a valid code, without actually shipping the entire list
+const isValidCountryCode = (country) => (0, libs_1.isString)(country) && COUNTRY_REGEX.test(country);
+// we'll cache any successful lookups so we only have to do this once
+let locale;
+const editionToGeolocationMap = {
+    UK: 'GB',
+    US: 'US',
+    AU: 'AU',
+};
+const editionToGeolocation = (editionKey) => editionToGeolocationMap[editionKey];
+// just used for tests
+const __resetCachedValue = () => (locale = undefined);
+exports.__resetCachedValue = __resetCachedValue;
+/**
+ * Fetches the user's current location as an ISO 3166-1 alpha-2 string e.g. 'GB', 'AU' etc
+ * Note: This has been copied from guardian-libs and made syncronous by ommiting the call to
+ * the geolocation API
+ */
+const getLocale = () => {
+    if (locale)
+        return locale;
+    // return overridden geo from localStorage, used for changing geo only for development purposes
+    const geoOverride = libs_1.storage.local.get(KEY_OVERRIDE);
+    if (isValidCountryCode(geoOverride)) {
+        return (locale = geoOverride);
+    }
+    // return locale from cookie if it exists
+    const stored = (0, libs_1.getCookie)({ name: KEY });
+    if (stored && isValidCountryCode(stored)) {
+        return (locale = stored);
+    }
+    // return locale from edition
+    const editionCountryCode = editionToGeolocation(window.guardian.config.page.edition);
+    return (locale = editionCountryCode);
+};
+exports.getLocale = getLocale;

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

@@ -1,6 +1,5 @@
 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 { 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"];
 declare type ConsentlessTargetingKeys = typeof consentlessTargetingKeys[number];
@@ -11,9 +10,8 @@ declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessT
  *
  * @param  {ConsentState} consentState
  * @param  {boolean} adFree
- * @param  {CountryCode} countryCode
  * @param  {Participations} clientSideParticipations
  * @returns ConsentlessPageTargeting
  */
-declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => ConsentlessPageTargeting;
 export { buildPageTargetingConsentless };

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

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

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

@@ -34,6 +34,6 @@ declare type PageTargeting = PartialWithNulls<{
     vl: string;
     [_: string]: string | string[];
 } & SharedTargeting>;
-declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => PageTargeting;
+declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => 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 get_locale_1 = require("../lib/get-locale");
 const content_1 = require("./content");
 const personalised_1 = require("./personalised");
 const session_1 = require("./session");
@@ -23,7 +24,7 @@ const filterEmptyValues = (pageTargets) => {
     }
     return filtered;
 };
-const buildPageTargeting = (consentState, adFree, countryCode, clientSideParticipations) => {
+const buildPageTargeting = (consentState, adFree, clientSideParticipations) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const contentTargeting = (0, content_1.getContentTargeting)({
@@ -39,7 +40,7 @@ const buildPageTargeting = (consentState, adFree, countryCode, clientSidePartici
     const getReferrer = () => document.referrer || '';
     const sessionTargeting = (0, session_1.getSessionTargeting)({
         adTest: (0, libs_1.getCookie)({ name: 'adtest', shouldMemoize: true }),
-        countryCode,
+        countryCode: (0, get_locale_1.getLocale)(),
         isSignedIn: !!(0, libs_1.getCookie)({ name: 'GU_U' }),
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {

package/dist/cjs/types.d.ts

@@ -21,6 +21,7 @@ export declare type GetThirdPartyTag = (arg0: {
 export declare type GuardianAnalyticsConfig = {
     trackers: Record<string, string>;
 };
+export declare type Edition = 'UK' | 'AU' | 'US';
 export declare type GuardianWindowConfig = {
     googleAnalytics?: GuardianAnalyticsConfig;
     isDotcomRendering: boolean;
@@ -30,11 +31,11 @@ export declare type GuardianWindowConfig = {
     };
     page: {
         sharedAdTargeting?: Record<string, string | string[]>;
-        pageAdTargeting?: Record<string, string | string[]>;
         isSensitive: boolean;
         pageId: string;
         section: string;
         videoDuration: number;
+        edition: Edition;
     };
     tests?: {
         [key: `${string}Control`]: 'control';

package/dist/esm/lib/get-locale.d.ts

@@ -0,0 +1,8 @@
+import type { CountryCode } from '@guardian/libs';
+export declare const __resetCachedValue: () => void;
+/**
+ * Fetches the user's current location as an ISO 3166-1 alpha-2 string e.g. 'GB', 'AU' etc
+ * Note: This has been copied from guardian-libs and made syncronous by ommiting the call to
+ * the geolocation API
+ */
+export declare const getLocale: () => CountryCode;

package/dist/esm/lib/get-locale.js

@@ -0,0 +1,38 @@
+import { getCookie, isString, storage } from '@guardian/libs';
+const KEY = 'GU_geo_country';
+const KEY_OVERRIDE = 'gu.geo.override';
+const COUNTRY_REGEX = /^[A-Z]{2}$/;
+// best guess that we have a valid code, without actually shipping the entire list
+const isValidCountryCode = (country) => isString(country) && COUNTRY_REGEX.test(country);
+// we'll cache any successful lookups so we only have to do this once
+let locale;
+const editionToGeolocationMap = {
+    UK: 'GB',
+    US: 'US',
+    AU: 'AU',
+};
+const editionToGeolocation = (editionKey) => editionToGeolocationMap[editionKey];
+// just used for tests
+export const __resetCachedValue = () => (locale = undefined);
+/**
+ * Fetches the user's current location as an ISO 3166-1 alpha-2 string e.g. 'GB', 'AU' etc
+ * Note: This has been copied from guardian-libs and made syncronous by ommiting the call to
+ * the geolocation API
+ */
+export const getLocale = () => {
+    if (locale)
+        return locale;
+    // return overridden geo from localStorage, used for changing geo only for development purposes
+    const geoOverride = storage.local.get(KEY_OVERRIDE);
+    if (isValidCountryCode(geoOverride)) {
+        return (locale = geoOverride);
+    }
+    // return locale from cookie if it exists
+    const stored = getCookie({ name: KEY });
+    if (stored && isValidCountryCode(stored)) {
+        return (locale = stored);
+    }
+    // return locale from edition
+    const editionCountryCode = editionToGeolocation(window.guardian.config.page.edition);
+    return (locale = editionCountryCode);
+};

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

@@ -1,6 +1,5 @@
 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 { 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"];
 declare type ConsentlessTargetingKeys = typeof consentlessTargetingKeys[number];
@@ -11,9 +10,8 @@ declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessT
  *
  * @param  {ConsentState} consentState
  * @param  {boolean} adFree
- * @param  {CountryCode} countryCode
  * @param  {Participations} clientSideParticipations
  * @returns ConsentlessPageTargeting
  */
-declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => ConsentlessPageTargeting;
 export { buildPageTargetingConsentless };

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

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

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

@@ -34,6 +34,6 @@ declare type PageTargeting = PartialWithNulls<{
     vl: string;
     [_: string]: string | string[];
 } & SharedTargeting>;
-declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => PageTargeting;
+declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, clientSideParticipations: Participations) => 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 { getLocale } from '../lib/get-locale';
 import { getContentTargeting } from './content';
 import { getPersonalisedTargeting } from './personalised';
 import { getSessionTargeting } from './session';
@@ -20,7 +21,7 @@ const filterEmptyValues = (pageTargets) => {
     }
     return filtered;
 };
-const buildPageTargeting = (consentState, adFree, countryCode, clientSideParticipations) => {
+const buildPageTargeting = (consentState, adFree, clientSideParticipations) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const contentTargeting = getContentTargeting({
@@ -36,7 +37,7 @@ const buildPageTargeting = (consentState, adFree, countryCode, clientSidePartici
     const getReferrer = () => document.referrer || '';
     const sessionTargeting = getSessionTargeting({
         adTest: getCookie({ name: 'adtest', shouldMemoize: true }),
-        countryCode,
+        countryCode: getLocale(),
         isSignedIn: !!getCookie({ name: 'GU_U' }),
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {

package/dist/esm/types.d.ts

@@ -21,6 +21,7 @@ export declare type GetThirdPartyTag = (arg0: {
 export declare type GuardianAnalyticsConfig = {
     trackers: Record<string, string>;
 };
+export declare type Edition = 'UK' | 'AU' | 'US';
 export declare type GuardianWindowConfig = {
     googleAnalytics?: GuardianAnalyticsConfig;
     isDotcomRendering: boolean;
@@ -30,11 +31,11 @@ export declare type GuardianWindowConfig = {
     };
     page: {
         sharedAdTargeting?: Record<string, string | string[]>;
-        pageAdTargeting?: Record<string, string | string[]>;
         isSensitive: boolean;
         pageId: string;
         section: string;
         videoDuration: number;
+        edition: Edition;
     };
     tests?: {
         [key: `${string}Control`]: 'control';

package/package.json

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