@guardian/commercial-core 6.0.0 → 6.2.0

package/dist/cjs/create-ad-slot.d.ts

@@ -1,5 +1,5 @@
 import type { SizeMapping } from './ad-sizes';
-type SlotName = 'carrot' | 'comments-expanded' | 'comments' | 'epic' | 'high-merch-lucky' | 'high-merch-paid' | 'high-merch' | 'im' | 'inline' | 'mobile-sticky' | 'mostpop' | 'top-above-nav';
+type SlotName = 'carrot' | 'comments-expanded' | 'comments' | 'epic' | 'exclusion' | 'high-merch-lucky' | 'high-merch-paid' | 'high-merch' | 'im' | 'inline' | 'mobile-sticky' | 'mostpop' | 'top-above-nav';
 type CreateSlotOptions = {
     classes?: string;
     name?: string;

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

@@ -33,6 +33,7 @@ type PageTargeting = PartialWithNulls<{
     skinsize: 'l' | 's';
     urlkw: string[];
     vl: string;
+    allkw: string[];
     [_: string]: string | string[];
 } & SharedTargeting>;
 declare const filterValues: (pageTargets: Record<string, unknown>) => Record<string, string | string[]>;

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

@@ -28,6 +28,9 @@ exports.filterValues = filterValues;
 const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, youtube = false, }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
+    const sharedAdTargeting = page.sharedAdTargeting
+        ? (0, shared_1.getSharedTargeting)(page.sharedAdTargeting)
+        : {};
     const contentTargeting = (0, content_1.getContentTargeting)({
         webPublicationDate: page.webPublicationDate,
         eligibleForDCR: page.dcrCouldRender,
@@ -38,6 +41,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         section: page.section,
         sensitive: page.isSensitive,
         videoLength: page.videoDuration,
+        keywords: sharedAdTargeting.k ?? [],
     });
     const getReferrer = () => document.referrer || '';
     const sessionTargeting = (0, session_1.getSessionTargeting)({
@@ -61,9 +65,6 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         viewPortWidth: getViewport().width,
         cmpBannerWillShow: !consent_management_platform_1.cmp.hasInitialised() || consent_management_platform_1.cmp.willShowPrivacyMessageSync(),
     });
-    const sharedAdTargeting = page.sharedAdTargeting
-        ? (0, shared_1.getSharedTargeting)(page.sharedAdTargeting)
-        : {};
     const personalisedTargeting = (0, personalised_1.getPersonalisedTargeting)({
         state: consentState,
         youtube,

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

@@ -63,6 +63,14 @@ type ContentTargeting = {
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=195087
      */
     vl: null | (typeof videoLengths)[number];
+    /**
+     * **All** **K**ey**w**ords - [see on Ad Manager][gam]
+     * This is a list of all keywords on the page, including the section and the URL keywords
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=13995840
+     */
+    allkw: string[];
 };
 type Content = {
     eligibleForDCR: boolean;
@@ -72,7 +80,8 @@ type Content = {
     sensitive: boolean;
     videoLength?: number;
     webPublicationDate: number;
+    keywords: string[];
 };
-declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, }: Content) => ContentTargeting;
+declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, keywords, }: Content) => ContentTargeting;
 export { getContentTargeting };
 export type { ContentTargeting };

package/dist/cjs/targeting/content.js

@@ -28,6 +28,9 @@ const getUrlKeywords = (url) => {
         .slice(-1)[0];
     return (0, libs_1.isString)(lastSegment) ? lastSegment.split('-').filter(Boolean) : [];
 };
+const concatUnique = (a, b) => [
+    ...new Set([...a, ...b]),
+];
 // "0" means content < 2 hours old
 // "1" means content between 2 hours and 24 hours old.
 // "2" means content between 24 hours and 3 days old
@@ -57,15 +60,17 @@ const calculateRecentlyPublishedBucket = (webPublicationDate) => {
         return '6';
     return '7';
 };
-const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, }) => {
+const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, keywords, }) => {
+    const urlkw = getUrlKeywords(path);
     return {
         dcre: eligibleForDCR ? 't' : 'f',
         rc: calculateRecentlyPublishedBucket(webPublicationDate),
         rp: renderingPlatform,
         s: section,
         sens: sensitive ? 't' : 'f',
-        urlkw: getUrlKeywords(path),
+        urlkw,
         vl: videoLength ? getVideoLength(videoLength) : null,
+        allkw: concatUnique(urlkw, keywords),
     };
 };
 exports.getContentTargeting = getContentTargeting;

package/dist/esm/create-ad-slot.d.ts

@@ -1,5 +1,5 @@
 import type { SizeMapping } from './ad-sizes';
-type SlotName = 'carrot' | 'comments-expanded' | 'comments' | 'epic' | 'high-merch-lucky' | 'high-merch-paid' | 'high-merch' | 'im' | 'inline' | 'mobile-sticky' | 'mostpop' | 'top-above-nav';
+type SlotName = 'carrot' | 'comments-expanded' | 'comments' | 'epic' | 'exclusion' | 'high-merch-lucky' | 'high-merch-paid' | 'high-merch' | 'im' | 'inline' | 'mobile-sticky' | 'mostpop' | 'top-above-nav';
 type CreateSlotOptions = {
     classes?: string;
     name?: string;

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

@@ -33,6 +33,7 @@ type PageTargeting = PartialWithNulls<{
     skinsize: 'l' | 's';
     urlkw: string[];
     vl: string;
+    allkw: string[];
     [_: string]: string | string[];
 } & SharedTargeting>;
 declare const filterValues: (pageTargets: Record<string, unknown>) => Record<string, string | string[]>;

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

@@ -24,6 +24,9 @@ const filterValues = (pageTargets) => {
 const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, youtube = false, }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
+    const sharedAdTargeting = page.sharedAdTargeting
+        ? getSharedTargeting(page.sharedAdTargeting)
+        : {};
     const contentTargeting = getContentTargeting({
         webPublicationDate: page.webPublicationDate,
         eligibleForDCR: page.dcrCouldRender,
@@ -34,6 +37,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         section: page.section,
         sensitive: page.isSensitive,
         videoLength: page.videoDuration,
+        keywords: sharedAdTargeting.k ?? [],
     });
     const getReferrer = () => document.referrer || '';
     const sessionTargeting = getSessionTargeting({
@@ -57,9 +61,6 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         viewPortWidth: getViewport().width,
         cmpBannerWillShow: !cmp.hasInitialised() || cmp.willShowPrivacyMessageSync(),
     });
-    const sharedAdTargeting = page.sharedAdTargeting
-        ? getSharedTargeting(page.sharedAdTargeting)
-        : {};
     const personalisedTargeting = getPersonalisedTargeting({
         state: consentState,
         youtube,

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

@@ -63,6 +63,14 @@ type ContentTargeting = {
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=195087
      */
     vl: null | (typeof videoLengths)[number];
+    /**
+     * **All** **K**ey**w**ords - [see on Ad Manager][gam]
+     * This is a list of all keywords on the page, including the section and the URL keywords
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=13995840
+     */
+    allkw: string[];
 };
 type Content = {
     eligibleForDCR: boolean;
@@ -72,7 +80,8 @@ type Content = {
     sensitive: boolean;
     videoLength?: number;
     webPublicationDate: number;
+    keywords: string[];
 };
-declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, }: Content) => ContentTargeting;
+declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, keywords, }: Content) => ContentTargeting;
 export { getContentTargeting };
 export type { ContentTargeting };

package/dist/esm/targeting/content.js

@@ -25,6 +25,9 @@ const getUrlKeywords = (url) => {
         .slice(-1)[0];
     return isString(lastSegment) ? lastSegment.split('-').filter(Boolean) : [];
 };
+const concatUnique = (a, b) => [
+    ...new Set([...a, ...b]),
+];
 // "0" means content < 2 hours old
 // "1" means content between 2 hours and 24 hours old.
 // "2" means content between 24 hours and 3 days old
@@ -54,15 +57,17 @@ const calculateRecentlyPublishedBucket = (webPublicationDate) => {
         return '6';
     return '7';
 };
-const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, }) => {
+const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, webPublicationDate, keywords, }) => {
+    const urlkw = getUrlKeywords(path);
     return {
         dcre: eligibleForDCR ? 't' : 'f',
         rc: calculateRecentlyPublishedBucket(webPublicationDate),
         rp: renderingPlatform,
         s: section,
         sens: sensitive ? 't' : 'f',
-        urlkw: getUrlKeywords(path),
+        urlkw,
         vl: videoLength ? getVideoLength(videoLength) : null,
+        allkw: concatUnique(urlkw, keywords),
     };
 };
 export { getContentTargeting };

package/package.json

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