@guardian/commercial-core 0.27.0 → 0.31.0

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

@@ -0,0 +1,98 @@
+import type { Participations } from '@guardian/ab-core';
+import type { CountryCode } from '@guardian/libs';
+import type { False, True } from '../types';
+declare const referrers: readonly [{
+    readonly id: "facebook";
+    readonly match: "facebook.com";
+}, {
+    readonly id: "google";
+    readonly match: "www.google";
+}, {
+    readonly id: "twitter";
+    readonly match: "/t.co/";
+}, {
+    readonly id: "reddit";
+    readonly match: "reddit.com";
+}];
+/**
+ * Session Targeting is based on the browser session
+ *
+ * Includes information such as the country of origin, referrer, page view ID.
+ *
+ * These values identify a browser session are either generated client-side,
+ * read from a cookie or passed down from the server.
+ */
+export declare type SessionTargeting = {
+    /**
+     * **AB** Tests – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * Values: typically start with `ab`
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=186327
+     */
+    ab: string[] | null;
+    /**
+     * **A**d **T**est – [see on Ad Manager][gam]
+     *
+     * Used for testing purposes, based on query param and/or cookie.
+     *
+     * Type: _Dynamic_
+     *
+     * [See Current values](https://frontend.gutools.co.uk/commercial/adtests)
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=177567
+     */
+    at: string | null;
+    /**
+     * **C**ountry **C**ode – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11703293
+     */
+    cc: CountryCode;
+    /**
+     * Ophan **P**age **V**iew id – [see on Ad Manager][gam]
+     *
+     * ID Generated client-side, usually available on
+     * `guardian.config.ophan.pageViewId`
+     *
+     * Used mainly for internal reporting
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=206127
+     */
+    pv: string;
+    /**
+     * **Ref**errer – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * Sample values:
+     * - `facebook`
+     * - `google`
+     * - `googleplus`
+     * - `reddit`
+     * - `twitter`
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=228567
+     */
+    ref: typeof referrers[number]['id'] | null;
+    /**
+     * **S**igned **I**n – [see on Ad Manager][gam]
+     *
+     *Whether a user is signed in. Based on presence of a cookie.
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=215727
+     */
+    si: True | False;
+};
+export declare type AllParticipations = {
+    clientSideParticipations: Participations;
+    serverSideParticipations: Record<string, 'control' | 'variant'>;
+};
+export declare const getSessionTargeting: (referrer: string, participations: AllParticipations, targeting: Omit<SessionTargeting, 'ab' | 'ref'>) => SessionTargeting;
+export {};

package/dist/esm/targeting/session.js

@@ -0,0 +1,53 @@
+import { isString } from '@guardian/libs';
+/* -- Types -- */
+const referrers = [
+    {
+        id: 'facebook',
+        match: 'facebook.com',
+    },
+    {
+        id: 'google',
+        match: 'www.google',
+    },
+    {
+        id: 'twitter',
+        match: '/t.co/',
+    },
+    {
+        id: 'reddit',
+        match: 'reddit.com',
+    },
+];
+/* -- Methods -- */
+const getReferrer = (referrer) => {
+    if (referrer === '')
+        return null;
+    const matchedRef = referrers.find((referrerType) => referrer.includes(referrerType.match)) ?? null;
+    return matchedRef ? matchedRef.id : null;
+};
+const experimentsTargeting = ({ clientSideParticipations, serverSideParticipations, }) => {
+    const testToParams = (testName, variant) => {
+        if (variant === 'notintest')
+            return null;
+        // GAM key-value pairs accept value strings up to 40 characters long
+        return `${testName}-${variant}`.substring(0, 40);
+    };
+    const clientSideExperiment = Object.entries(clientSideParticipations)
+        .map((test) => {
+        const [name, variant] = test;
+        return testToParams(name, variant.variant);
+    })
+        .filter(isString);
+    const serverSideExperiments = Object.entries(serverSideParticipations)
+        .map((test) => testToParams(...test))
+        .filter(isString);
+    if (clientSideExperiment.length + serverSideExperiments.length === 0)
+        return null;
+    return [...clientSideExperiment, ...serverSideExperiments];
+};
+/* -- Targeting -- */
+export const getSessionTargeting = (referrer, participations, targeting) => ({
+    ref: getReferrer(referrer),
+    ab: experimentsTargeting(participations),
+    ...targeting,
+});

package/dist/esm/types.d.ts

@@ -1,13 +1,10 @@
-export declare type TagAtrribute = {
+export declare type TagAttribute = {
     name: string;
     value: string;
 };
-export declare type GetThirdPartyTag = (arg0: {
-    shouldRun: boolean;
-}) => ThirdPartyTag;
 export declare type ThirdPartyTag = {
     async?: boolean;
-    attrs?: TagAtrribute[];
+    attrs?: TagAttribute[];
     beforeLoad?: () => void;
     insertSnippet?: () => void;
     loaded?: boolean;
@@ -17,6 +14,9 @@ export declare type ThirdPartyTag = {
     url?: string;
     useImage?: boolean;
 };
+export declare type GetThirdPartyTag = (arg0: {
+    shouldRun: boolean;
+}) => ThirdPartyTag;
 export declare type GuardianAnalyticsConfig = {
     trackers: Record<string, string>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "0.27.0",
+  "version": "0.31.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {
@@ -41,42 +41,44 @@
   },
   "prettier": "@guardian/prettier",
   "devDependencies": {
-    "@commitlint/cli": "^13",
-    "@commitlint/config-conventional": "^14",
-    "@guardian/consent-management-platform": "^8",
-    "@guardian/eslint-config-typescript": "^0.7",
-    "@guardian/libs": "3.3.0",
-    "@guardian/prettier": "^0.7",
-    "@octokit/core": "^3",
-    "@semantic-release/github": "^8",
-    "@types/googletag": "^1.1.3",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "@guardian/ab-core": "^2.0.0",
+    "@guardian/consent-management-platform": "^8.0.1",
+    "@guardian/eslint-config-typescript": "^0.7.0",
+    "@guardian/libs": "3.5.1",
+    "@guardian/prettier": "^0.7.0",
+    "@octokit/core": "^3.5.1",
+    "@semantic-release/github": "^8.0.2",
     "@types/google.analytics": "^0.0.42",
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
+    "@types/googletag": "^1.1.4",
+    "@types/jest": "^27.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.5.0",
+    "@typescript-eslint/parser": "^5.5.0",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.3.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-jest": "^25.2.2",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^25.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",
-    "jest": "^27.3.1",
-    "lint-staged": "^11.2.6",
+    "jest": "^27.4.1",
+    "lint-staged": "^12.1.2",
     "mockdate": "^3.0.5",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.4.1",
-    "semantic-release": "^18.0.0",
+    "prettier": "^2.5.0",
+    "semantic-release": "^18.0.1",
     "ts-jest": "^27.0.7",
-    "typescript": "^4.4.4",
+    "typescript": "^4.5.2",
     "web-vitals": "^2.1.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
+    "@guardian/ab-core": "^2.0.0",
     "@guardian/libs": "^3.3.0"
   }
 }