@guardian/commercial-core 28.0.0 → 29.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/cjs/ad-sizes.d.ts +1 -4
  2. package/dist/cjs/ad-sizes.js +0 -3
  3. package/dist/cjs/targeting/build-page-targeting.js +1 -0
  4. package/dist/cjs/targeting/session.d.ts +6 -1
  5. package/dist/cjs/targeting/session.js +16 -3
  6. package/dist/cjs/types.d.ts +1 -0
  7. package/dist/esm/ad-sizes.d.ts +1 -4
  8. package/dist/esm/ad-sizes.js +0 -3
  9. package/dist/esm/targeting/build-page-targeting.js +1 -0
  10. package/dist/esm/targeting/session.d.ts +6 -1
  11. package/dist/esm/targeting/session.js +16 -3
  12. package/dist/esm/types.d.ts +1 -0
  13. package/package.json +9 -9
package/dist/cjs/ad-sizes.d.ts CHANGED
@@ -28,7 +28,7 @@ declare class AdSize extends Array<number> {
28
28
  get height(): number;
29
29
  }
30
30
  type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'cascade' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'portraitInterstitial' | 'pubmaticInterscroller' | 'skyscraper' | 'sponsorLogo';
31
- type SlotName = 'article-end' | 'carrot' | 'comments-expanded' | 'comments' | 'crossword-banner-mobile' | 'exclusion' | 'external' | 'fronts-banner' | 'inline' | 'liveblog-top' | 'merchandising-high' | 'merchandising' | 'mobile-sticky' | 'football-right' | 'mostpop' | 'right' | 'sponsor-logo' | 'survey' | 'top-above-nav' | 'interactive';
31
+ type SlotName = 'article-end' | 'comments-expanded' | 'comments' | 'crossword-banner-mobile' | 'exclusion' | 'external' | 'fronts-banner' | 'inline' | 'liveblog-top' | 'merchandising-high' | 'merchandising' | 'mobile-sticky' | 'football-right' | 'mostpop' | 'right' | 'sponsor-logo' | 'survey' | 'top-above-nav' | 'interactive';
32
32
  type SizeMapping = Partial<Record<Breakpoint, readonly AdSize[]>>;
33
33
  type SlotSizeMappings = Record<SlotName, SizeMapping>;
34
34
  declare const createAdSize: (width: number, height: number) => AdSize;
@@ -139,9 +139,6 @@ declare const slotSizeMappings: {
139
139
  readonly survey: {
140
140
  readonly desktop: readonly [AdSize];
141
141
  };
142
- readonly carrot: {
143
- readonly mobile: readonly [AdSize];
144
- };
145
142
  readonly 'mobile-sticky': {
146
143
  readonly mobile: readonly [AdSize, AdSize, AdSize];
147
144
  };
package/dist/cjs/ad-sizes.js CHANGED
@@ -311,9 +311,6 @@ const slotSizeMappings = {
311
311
  survey: {
312
312
  desktop: [adSizes.outOfPage],
313
313
  },
314
- carrot: {
315
- mobile: [adSizes.fluid],
316
- },
317
314
  'mobile-sticky': {
318
315
  mobile: [adSizes.mobilesticky, adSizes.empty, createAdSize(300, 50)],
319
316
  },
package/dist/cjs/targeting/build-page-targeting.js CHANGED
@@ -77,6 +77,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
77
77
  participations: {
78
78
  clientSideParticipations,
79
79
  serverSideParticipations: window.guardian.config.tests ?? {},
80
+ betaAbTestParticipations: window.guardian.modules.abTests?.getParticipations() ?? {},
80
81
  },
81
82
  referrer,
82
83
  });
package/dist/cjs/targeting/session.d.ts CHANGED
@@ -104,8 +104,13 @@ type AllParticipations = {
104
104
  [key: `${string}Control`]: 'control';
105
105
  [key: `${string}Variant`]: 'variant';
106
106
  };
107
+ betaAbTestParticipations: Record<string, string>;
107
108
  };
108
- declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting["ab"];
109
+ /**
110
+ * @todo drop old client/server side participations and rename to just `abTestsParticipations` once
111
+ * all tests have been migrated to the new AB testing platform
112
+ */
113
+ declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, betaAbTestParticipations, }: AllParticipations) => SessionTargeting["ab"];
109
114
  type Session = {
110
115
  adTest: SessionTargeting['at'];
111
116
  countryCode: CountryCode;
package/dist/cjs/targeting/session.js CHANGED
@@ -28,7 +28,11 @@ const getReferrer = (referrer) => {
28
28
  const matchedRef = referrers.find((referrerType) => referrer.includes(referrerType.match)) ?? null;
29
29
  return matchedRef ? matchedRef.id : null;
30
30
  };
31
- const experimentsTargeting = ({ clientSideParticipations, serverSideParticipations, }) => {
31
+ /**
32
+ * @todo drop old client/server side participations and rename to just `abTestsParticipations` once
33
+ * all tests have been migrated to the new AB testing platform
34
+ */
35
+ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipations, betaAbTestParticipations, }) => {
32
36
  const testToParams = (testName, variant) => {
33
37
  if (variant === 'notintest')
34
38
  return null;
@@ -44,10 +48,19 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
44
48
  const serverSideExperiments = Object.entries(serverSideParticipations)
45
49
  .map((test) => testToParams(...test))
46
50
  .filter(libs_1.isString);
47
- if (clientSideExperiment.length + serverSideExperiments.length === 0) {
51
+ const betaAbTests = Object.entries(betaAbTestParticipations)
52
+ .map((test) => {
53
+ const [name, variant] = test;
54
+ return testToParams(name, variant);
55
+ })
56
+ .filter(libs_1.isString);
57
+ if (clientSideExperiment.length +
58
+ serverSideExperiments.length +
59
+ betaAbTests.length ===
60
+ 0) {
48
61
  return null;
49
62
  }
50
- return [...clientSideExperiment, ...serverSideExperiments];
63
+ return [...clientSideExperiment, ...serverSideExperiments, ...betaAbTests];
51
64
  };
52
65
  exports.experimentsTargeting = experimentsTargeting;
53
66
  const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }) => ({
package/dist/cjs/types.d.ts CHANGED
@@ -10,6 +10,7 @@ interface Advert {
10
10
  headerBiddingSizes: HeaderBiddingSize[] | null;
11
11
  size: AdSize | 'fluid' | null;
12
12
  slot: googletag.Slot;
13
+ gpid: string | undefined;
13
14
  isEmpty: boolean | null;
14
15
  isRendered: boolean;
15
16
  shouldRefresh: boolean;
package/dist/esm/ad-sizes.d.ts CHANGED
@@ -28,7 +28,7 @@ declare class AdSize extends Array<number> {
28
28
  get height(): number;
29
29
  }
30
30
  type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'cascade' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'portraitInterstitial' | 'pubmaticInterscroller' | 'skyscraper' | 'sponsorLogo';
31
- type SlotName = 'article-end' | 'carrot' | 'comments-expanded' | 'comments' | 'crossword-banner-mobile' | 'exclusion' | 'external' | 'fronts-banner' | 'inline' | 'liveblog-top' | 'merchandising-high' | 'merchandising' | 'mobile-sticky' | 'football-right' | 'mostpop' | 'right' | 'sponsor-logo' | 'survey' | 'top-above-nav' | 'interactive';
31
+ type SlotName = 'article-end' | 'comments-expanded' | 'comments' | 'crossword-banner-mobile' | 'exclusion' | 'external' | 'fronts-banner' | 'inline' | 'liveblog-top' | 'merchandising-high' | 'merchandising' | 'mobile-sticky' | 'football-right' | 'mostpop' | 'right' | 'sponsor-logo' | 'survey' | 'top-above-nav' | 'interactive';
32
32
  type SizeMapping = Partial<Record<Breakpoint, readonly AdSize[]>>;
33
33
  type SlotSizeMappings = Record<SlotName, SizeMapping>;
34
34
  declare const createAdSize: (width: number, height: number) => AdSize;
@@ -139,9 +139,6 @@ declare const slotSizeMappings: {
139
139
  readonly survey: {
140
140
  readonly desktop: readonly [AdSize];
141
141
  };
142
- readonly carrot: {
143
- readonly mobile: readonly [AdSize];
144
- };
145
142
  readonly 'mobile-sticky': {
146
143
  readonly mobile: readonly [AdSize, AdSize, AdSize];
147
144
  };
package/dist/esm/ad-sizes.js CHANGED
@@ -303,9 +303,6 @@ const slotSizeMappings = {
303
303
  survey: {
304
304
  desktop: [adSizes.outOfPage],
305
305
  },
306
- carrot: {
307
- mobile: [adSizes.fluid],
308
- },
309
306
  'mobile-sticky': {
310
307
  mobile: [adSizes.mobilesticky, adSizes.empty, createAdSize(300, 50)],
311
308
  },
package/dist/esm/targeting/build-page-targeting.js CHANGED
@@ -72,6 +72,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, is
72
72
  participations: {
73
73
  clientSideParticipations,
74
74
  serverSideParticipations: window.guardian.config.tests ?? {},
75
+ betaAbTestParticipations: window.guardian.modules.abTests?.getParticipations() ?? {},
75
76
  },
76
77
  referrer,
77
78
  });
package/dist/esm/targeting/session.d.ts CHANGED
@@ -104,8 +104,13 @@ type AllParticipations = {
104
104
  [key: `${string}Control`]: 'control';
105
105
  [key: `${string}Variant`]: 'variant';
106
106
  };
107
+ betaAbTestParticipations: Record<string, string>;
107
108
  };
108
- declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting["ab"];
109
+ /**
110
+ * @todo drop old client/server side participations and rename to just `abTestsParticipations` once
111
+ * all tests have been migrated to the new AB testing platform
112
+ */
113
+ declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, betaAbTestParticipations, }: AllParticipations) => SessionTargeting["ab"];
109
114
  type Session = {
110
115
  adTest: SessionTargeting['at'];
111
116
  countryCode: CountryCode;
package/dist/esm/targeting/session.js CHANGED
@@ -25,7 +25,11 @@ const getReferrer = (referrer) => {
25
25
  const matchedRef = referrers.find((referrerType) => referrer.includes(referrerType.match)) ?? null;
26
26
  return matchedRef ? matchedRef.id : null;
27
27
  };
28
- const experimentsTargeting = ({ clientSideParticipations, serverSideParticipations, }) => {
28
+ /**
29
+ * @todo drop old client/server side participations and rename to just `abTestsParticipations` once
30
+ * all tests have been migrated to the new AB testing platform
31
+ */
32
+ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipations, betaAbTestParticipations, }) => {
29
33
  const testToParams = (testName, variant) => {
30
34
  if (variant === 'notintest')
31
35
  return null;
@@ -41,10 +45,19 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
41
45
  const serverSideExperiments = Object.entries(serverSideParticipations)
42
46
  .map((test) => testToParams(...test))
43
47
  .filter(isString);
44
- if (clientSideExperiment.length + serverSideExperiments.length === 0) {
48
+ const betaAbTests = Object.entries(betaAbTestParticipations)
49
+ .map((test) => {
50
+ const [name, variant] = test;
51
+ return testToParams(name, variant);
52
+ })
53
+ .filter(isString);
54
+ if (clientSideExperiment.length +
55
+ serverSideExperiments.length +
56
+ betaAbTests.length ===
57
+ 0) {
45
58
  return null;
46
59
  }
47
- return [...clientSideExperiment, ...serverSideExperiments];
60
+ return [...clientSideExperiment, ...serverSideExperiments, ...betaAbTests];
48
61
  };
49
62
  const getSessionTargeting = ({ adTest, countryCode, localHour, isSignedIn, pageViewId, participations, referrer, }) => ({
50
63
  ab: experimentsTargeting(participations),
package/dist/esm/types.d.ts CHANGED
@@ -10,6 +10,7 @@ interface Advert {
10
10
  headerBiddingSizes: HeaderBiddingSize[] | null;
11
11
  size: AdSize | 'fluid' | null;
12
12
  slot: googletag.Slot;
13
+ gpid: string | undefined;
13
14
  isEmpty: boolean | null;
14
15
  isRendered: boolean;
15
16
  shouldRefresh: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@guardian/commercial-core",
3
- "version": "28.0.0",
3
+ "version": "29.1.0",
4
4
  "description": "Guardian advertising business logic",
5
5
  "homepage": "https://github.com/guardian/commercial#readme",
6
6
  "bugs": {
@@ -31,22 +31,22 @@
31
31
  },
32
32
  "peerDependencies": {
33
33
  "@guardian/ab-core": "^8.0.1",
34
- "@guardian/libs": "^25.2.0"
34
+ "@guardian/libs": "^26.0.0"
35
35
  },
36
36
  "dependencies": {
37
37
  "@guardian/ab-core": "8.0.1",
38
- "@guardian/libs": "25.2.0",
38
+ "@guardian/libs": "26.0.0",
39
39
  "@types/googletag": "~3.3.0"
40
40
  },
41
41
  "devDependencies": {
42
- "@guardian/ophan-tracker-js": "2.4.0",
42
+ "@guardian/ophan-tracker-js": "2.6.1",
43
43
  "@types/jest": "30.0.0",
44
- "@types/node": "24.2.0",
45
- "jest": "^30.1.3",
46
- "jest-environment-jsdom": "^30.1.2",
44
+ "@types/node": "24.7.2",
45
+ "jest": "^30.2.0",
46
+ "jest-environment-jsdom": "^30.2.0",
47
47
  "jest-environment-jsdom-global": "~4.0.0",
48
- "ts-jest": "^29.4.1",
49
- "typescript": "5.8.3",
48
+ "ts-jest": "^29.4.4",
49
+ "typescript": "5.9.3",
50
50
  "type-fest": "^4.41.0"
51
51
  },
52
52
  "publishConfig": {