@guardian/commercial-core 7.1.0 → 27.0.0

package/dist/esm/types.d.ts

@@ -1,87 +1,423 @@
-import type { VendorName } from '@guardian/consent-management-platform/dist/types';
-export type ConnectionType = 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi';
-export interface NetworkInformation extends EventTarget {
+import type { AdSize, SizeMapping } from './ad-sizes';
+import type { PageTargeting } from './targeting/build-page-targeting';
+type HeaderBiddingSize = AdSize;
+interface Advert {
+    id: string;
+    node: HTMLElement;
+    prebidAdUnit: string;
+    sizes: SizeMapping;
+    headerBiddingSizes: HeaderBiddingSize[] | null;
+    size: AdSize | 'fluid' | null;
+    slot: googletag.Slot;
+    isEmpty: boolean | null;
+    isRendered: boolean;
+    shouldRefresh: boolean;
+    whenSlotReady: Promise<void>;
+    extraNodeClasses: string[];
+    hasPrebidSize: boolean;
+    headerBiddingBidRequest: Promise<unknown> | null;
+    lineItemId: number | null;
+    creativeId: number | null;
+    creativeTemplateId: number | null;
+    testgroup: string | undefined;
+    finishedRendering(isRendered: boolean): void;
+    updateExtraSlotClasses(...newClasses: string[]): Promise<void>;
+    generateSizeMapping(additionalSizeMapping: SizeMapping): SizeMapping;
+    updateSizeMapping(additionalSizeMapping: SizeMapping): void;
+}
+interface DfpEnv {
+    renderStartTime: number;
+    adSlotSelector: string;
+    lazyLoadEnabled: boolean;
+    lazyLoadObserve: boolean;
+    advertsToLoad: Advert[];
+    adverts: Map<Advert['id'], Advert>;
+    shouldLazyLoad: () => boolean;
+}
+type ConnectionType = 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi';
+interface NetworkInformation extends EventTarget {
     readonly type?: ConnectionType;
     readonly downlink?: number;
     readonly effectiveType?: string;
 }
-export type TagAttribute = {
-    name: string;
-    value: string;
+type OphanRecordFunction = (event: Record<string, unknown> & {
+    /**
+     * the experiences key will override previously set values.
+     * Use `recordExperiences` instead.
+     */
+    experiences?: never;
+}, callback?: () => void) => void;
+/**
+ * Generates a type which represents possible indices of this array
+ *
+ * Example usage:
+ * const list = ['foo', 'bar', 'baz'] as const;
+ * type Test = Indices<typeof list>
+ */
+type Indices<T extends readonly unknown[]> = Exclude<Partial<T>['length'], T['length']>;
+type Edition = 'UK' | 'AU' | 'US';
+type AdsConfigDisabled = {
+    disableAds: true;
+};
+type AdsConfigBasic = {
+    adTagParameters: {
+        iu: string;
+        cust_params: string;
+    };
+};
+type AdsConfigUSNATorAus = AdsConfigBasic & {
+    restrictedDataProcessor: boolean;
 };
-export type ThirdPartyTag = {
-    async?: boolean;
-    attrs?: TagAttribute[];
-    beforeLoad?: () => void;
-    insertSnippet?: () => void;
-    loaded?: boolean;
-    onLoad?: () => void;
-    shouldRun: boolean;
-    name?: VendorName;
-    url?: string;
-    useImage?: boolean;
+type AdsConfigTCFV2 = AdsConfigBasic & {
+    adTagParameters: {
+        cmpGdpr: number;
+        cmpVcd: string;
+        cmpGvcd: string;
+    };
+    nonPersonalizedAd: boolean;
 };
-export type GetThirdPartyTag = (arg0: {
-    shouldRun: boolean;
-}) => ThirdPartyTag;
-export type GuardianAnalyticsConfig = {
-    trackers: Record<string, string>;
+interface Ophan {
+    trackComponentAttention: (name: string, el: Element, visiblityThreshold: number) => void;
+    record: OphanRecordFunction;
+    viewId: string;
+    pageViewId: string;
+}
+type PrebidBreakpoint = 'D' | 'T' | 'M';
+type PrebidIndexSite = {
+    bp: PrebidBreakpoint;
+    id: number;
 };
-export type Edition = 'UK' | 'AU' | 'US';
-export type GuardianWindowConfig = {
-    googleAnalytics?: GuardianAnalyticsConfig;
+interface CommercialPageConfig {
+    pbIndexSites: PrebidIndexSite[];
+    adUnit: string;
+    appNexusPageTargeting?: string;
+    sharedAdTargeting?: Record<string, string | string[]>;
+    shouldHideAdverts: boolean;
+    pageAdTargeting?: PageTargeting;
+    dfpAccountId: string;
+    ipsosTag?: string;
+    a9PublisherId: string;
+    libs?: {
+        googletag?: string;
+    };
+}
+interface PageConfig extends CommercialPageConfig {
+    ajaxUrl?: string;
+    assetsPath: string;
+    author: string;
+    authorIds: string;
+    blogIds: string;
+    commentable: boolean;
+    contentType: string;
+    dcrCouldRender: boolean;
+    edition: Edition;
+    frontendAssetsFullURL?: string;
+    hasPageSkin: boolean;
+    hasShowcaseMainElement: boolean;
+    hasYouTubeAtom: boolean;
+    headline: string;
+    host: string;
+    idApiUrl?: string;
+    idUrl?: string;
+    isbn?: string;
+    isDev: boolean;
+    isFront: boolean;
+    isHosted: boolean;
+    isImmersive?: boolean;
+    isLiveBlog?: boolean;
+    isPaidContent: boolean;
+    isPreview: boolean;
+    isProd: boolean;
+    isSensitive: boolean;
+    isMinuteArticle: boolean;
+    keywordIds: string;
+    keywords: string;
+    lightboxImages?: {
+        images: Array<{
+            src: string;
+        }>;
+    };
+    pageId: string;
+    publication: string;
+    revisionNumber: string;
+    section: string;
+    sectionName: string;
+    sentryHost: string;
+    sentryPublicApiKey: string;
+    series: string;
+    seriesId: string;
+    sharedAdTargeting?: Record<string, string | string[]>;
+    shouldHideReaderRevenue?: boolean;
+    showNewRecipeDesign?: boolean;
+    showRelatedContent?: boolean;
+    source: string;
+    sponsorshipType: string;
+    toneIds: string;
+    tones: string;
+    videoDuration: number;
+    webPublicationDate: number;
+    userAttributesApiUrl?: string;
+}
+type Stage = 'DEV' | 'CODE' | 'PROD';
+interface UserConfig {
+    accountCreatedDate: number;
+    displayName: string;
+    emailVerified: boolean;
+    id: string;
+    rawResponse: string;
+}
+interface Config {
+    commercialMetricsInitialised?: boolean;
+    frontendAssetsFullURL?: string;
     isDotcomRendering: boolean;
     ophan: {
         browserId?: string;
         pageViewId: string;
     };
-    page: {
-        dcrCouldRender: boolean;
-        edition: Edition;
-        isPreview: boolean;
-        isSensitive: boolean;
-        pageId: string;
-        section: string;
-        sharedAdTargeting?: Record<string, string | string[]>;
-        videoDuration: number;
-        webPublicationDate: number;
-    };
+    page: PageConfig;
+    shouldSendCommercialMetrics?: boolean;
+    stage: Stage;
+    switches: Record<string, boolean | undefined>;
     tests?: {
         [key: `${string}Control`]: 'control';
         [key: `${string}Variant`]: 'variant';
     };
+    user?: UserConfig;
+}
+type AdBlockers = {
+    active: boolean | undefined;
+    onDetect: Array<(value: boolean | PromiseLike<boolean>) => void>;
 };
-export type GoogleTagParams = unknown;
-export type GoogleTrackConversionObject = {
-    google_conversion_id: number;
-    google_custom_params: GoogleTagParams;
-    google_remarketing_only: boolean;
+type TagCounts = Record<string, number>;
+type WeeklyArticleLog = {
+    week: number;
+    count: number;
+    tags?: TagCounts;
 };
-export type MaybeArray<T> = T | T[];
-export type CustomParams = Record<string, MaybeArray<string | number | boolean>>;
-export type AdsConfigDisabled = {
-    disableAds: true;
+type WeeklyArticleHistory = WeeklyArticleLog[];
+interface DailyArticleCount {
+    day: number;
+    count: number;
+}
+type DailyArticleHistory = DailyArticleCount[];
+interface ArticleCounts {
+    weeklyArticleHistory: WeeklyArticleHistory;
+    dailyArticleHistory: DailyArticleHistory;
+}
+type FetchBidSizes = {
+    adSizes: `${number}x${number}`;
 };
-export type AdsConfigBasic = {
-    adTagParameters: {
-        iu: string;
-        cust_params: string;
+type FetchBidResponse = {
+    amznbid: string;
+    amzniid: string;
+    amznp: string;
+    amznsz: FetchBidSizes;
+    size: FetchBidSizes;
+    slotID: string;
+};
+interface HeaderNotification {
+    id: string;
+    target: string;
+    message: string;
+    ophanLabel: string;
+    logImpression: () => void;
+}
+interface OptOutInitializeOptions {
+    publisher: number;
+    onlyNoConsent?: 0 | 1;
+    alwaysNoConsent?: 0 | 1;
+    consentTimeOutMS?: 5000;
+    noLogging?: 0 | 1;
+    lazyLoading?: {
+        fractionInView?: number;
+        viewPortMargin?: string;
     };
+    noRequestsOnPageLoad?: 0 | 1;
+    frequencyScript?: string;
+    timeoutFrequencyCappingMS?: number;
+    debug_forceCap?: number;
+}
+interface OptOutResponse {
+    adSlot: string;
+    width: number;
+    height: number;
+    ad: string;
+    creativeId: string;
+    meta: {
+        networkId: string;
+        networkName: string;
+        agencyId: string;
+        agencyName: string;
+        advertiserId: string;
+        advertiserName: string;
+        advertiserDomains: string[];
+    };
+    optOutExt: {
+        noSafeFrame: boolean;
+        tags: string[];
+    };
+}
+type OptOutFilledCallback = (adSlot: OptOutAdSlot, response: OptOutResponse) => void;
+interface OptOutAdSlot {
+    adSlot: string;
+    targetId: string;
+    id: string;
+    filledCallback?: OptOutFilledCallback;
+    emptyCallback?: (adSlot: OptOutAdSlot) => void;
+    adShownCallback?: (adSlot: OptOutAdSlot, response: OptOutResponse) => void;
+}
+interface ImpressionsDfpObject {
+    s: string;
+    ad: string;
+    c: string;
+    I: string;
+    o: string;
+    A: string;
+    y: string;
+    co: string;
+}
+declare enum BlockingType {
+    Manual = 1,// Deprecated
+    Creative = 2,// Creative-based detection
+    ProviderSecurity = 3,// Domain-based detection for unsafe domains
+    BannedDomain = 4,// Domain-based detection for banned domains
+    ProviderIbv = 5,// Domain-based detection for in-banner-video
+    UnsafeJS = 6,// JavaScript-based detection for unsafe ads
+    Hrap = 7
+}
+type ConfiantCallback = (blockingType: BlockingType, blockingId: string, isBlocked: boolean, wrapperId: string, tagId: string, impressionsData?: {
+    prebid?: {
+        adId?: string | null;
+        cpm?: number | null;
+        s?: string;
+    };
+    dfp?: ImpressionsDfpObject;
+}) => void;
+interface Confiant extends Record<string, unknown> {
+    settings: {
+        callback: ConfiantCallback;
+        [key: string]: unknown;
+    };
+}
+interface Permutive {
+    config?: {
+        projectId?: string;
+        apiKey?: string;
+        environment?: string;
+    };
+    q?: Array<{
+        functionName: string;
+        arguments: unknown[];
+    }>;
+    addon?: (name: string, props: Record<string, unknown>) => void;
+    identify?: (user: Array<{
+        id: string;
+        tag: string;
+    }>) => void;
+    track?: (name: string, props: Record<string, unknown>) => void;
+}
+type ApstagInitConfig = {
+    pubID: string;
+    adServer?: string;
+    bidTimeout?: number;
+    blockedBidders?: string[];
 };
-export type AdsConfigCCPAorAus = AdsConfigBasic & {
-    restrictedDataProcessor: boolean;
+interface A9AdUnitInterface {
+    slotID: string;
+    slotName?: string;
+    sizes: number[][];
+}
+type FetchBidsBidConfig = {
+    slots: A9AdUnitInterface[];
 };
-export type AdsConfigTCFV2 = AdsConfigBasic & {
-    adTagParameters: {
-        cmpGdpr: number;
-        cmpVcd: string;
-        cmpGvcd: string;
+type Apstag = {
+    init: (arg0: ApstagInitConfig) => void;
+    fetchBids: (arg0: FetchBidsBidConfig, callback: (res: FetchBidResponse[]) => void) => void;
+    setDisplayBids: () => void;
+};
+type ComscoreGlobals = {
+    c1: string;
+    c2: string;
+    cs_ucfr: string;
+    comscorekw?: string;
+    options?: {
+        enableFirstPartyCookie?: boolean;
     };
-    nonPersonalizedAd: boolean;
 };
-export type AdsConfigEnabled = AdsConfigBasic | AdsConfigCCPAorAus | AdsConfigTCFV2;
-export type AdsConfig = AdsConfigEnabled | AdsConfigDisabled;
-export type AdTargetingBuilder = () => Promise<AdsConfig>;
-export type True = 't';
-export type False = 'f';
-export type NotApplicable = 'na';
+interface IasPETSlot {
+    adSlotId: string;
+    size: Array<[number, number]>;
+    adUnitPath: string;
+}
+interface IasPET {
+    queue?: Array<{
+        adSlots: IasPETSlot[];
+        dataHandler: (targetingJSON: string) => void;
+    }>;
+    pubId?: string;
+}
+interface TeadsAnalytics {
+    analytics_tag_id?: string;
+    share?: () => void;
+    shared_data?: unknown[];
+}
+/**
+ * Types for the IAB Safeframe API
+ *
+ * Note this type definition is incomplete.
+ * These types can be refined as/when they are required
+ */
+interface SafeFrameAPI {
+    ver: string;
+    specVersion: string;
+    lib: {
+        lang: Record<string, unknown>;
+        dom: {
+            iframes: Record<string, unknown>;
+            msghost: Record<string, unknown>;
+        };
+        logger: Record<string, unknown>;
+    };
+    env: {
+        isIE: boolean;
+        ua: Record<string, unknown>;
+    };
+    info: {
+        errs: unknown[];
+        list: unknown[];
+    };
+    host: {
+        Config: {
+            new (o: {
+                renderFile: string;
+                positions: Record<string, unknown>;
+            }): unknown;
+        };
+    };
+}
+/**
+ * Types for IMR Worldwide
+ */
+interface NSdkInstance {
+    ggPM: (type: string, dcrStaticMetadata: {
+        type: string;
+        assetid: unknown;
+        section: string;
+    }) => void;
+    ggInitialize: (nolggGlobalParams: {
+        sfcode: string;
+        apid: string;
+        apn: string;
+    }) => void;
+}
+interface Trac {
+    record: () => this;
+    post: () => this;
+}
+type GoogleTagParams = unknown;
+type GoogleTrackConversionObject = {
+    google_conversion_id: number;
+    google_custom_params: GoogleTagParams;
+    google_remarketing_only: boolean;
+};
+export type { Advert, DfpEnv, ConnectionType, NetworkInformation, OphanRecordFunction, Indices, Edition, AdsConfigDisabled, AdsConfigBasic, AdsConfigUSNATorAus, AdsConfigTCFV2, Ophan, Config, AdBlockers, ArticleCounts, FetchBidResponse, HeaderNotification, OptOutInitializeOptions, OptOutAdSlot, Confiant, Permutive, Apstag, ComscoreGlobals, IasPET, TeadsAnalytics, SafeFrameAPI, NSdkInstance, Trac, GoogleTagParams, GoogleTrackConversionObject, };

package/dist/esm/types.js

@@ -1 +1,10 @@
-export {};
+var BlockingType;
+(function (BlockingType) {
+    BlockingType[BlockingType["Manual"] = 1] = "Manual";
+    BlockingType[BlockingType["Creative"] = 2] = "Creative";
+    BlockingType[BlockingType["ProviderSecurity"] = 3] = "ProviderSecurity";
+    BlockingType[BlockingType["BannedDomain"] = 4] = "BannedDomain";
+    BlockingType[BlockingType["ProviderIbv"] = 5] = "ProviderIbv";
+    BlockingType[BlockingType["UnsafeJS"] = 6] = "UnsafeJS";
+    BlockingType[BlockingType["Hrap"] = 7] = "Hrap";
+})(BlockingType || (BlockingType = {}));

package/package.json

@@ -1,84 +1,65 @@
 {
-	"name": "@guardian/commercial-core",
-	"version": "7.1.0",
-	"description": "Guardian advertising business logic",
-	"homepage": "https://github.com/guardian/commercial-core#readme",
-	"bugs": {
-		"url": "https://github.com/guardian/commercial-core/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/guardian/commercial-core.git"
-	},
-	"license": "Apache-2.0",
-	"main": "dist/cjs/index.js",
-	"module": "dist/esm/index.js",
-	"files": [
-		"dist"
-	],
-	"scripts": {
-		"build": "npm-run-all clean --parallel compile:*",
-		"clean": "rm -rf dist",
-		"commit": "cz",
-		"compile:common": "tsc --project ./tsconfig.build.json --outDir ./dist/cjs --module CommonJS",
-		"compile:esm": "tsc --project ./tsconfig.build.json --outDir ./dist/esm",
-		"lint": "eslint .",
-		"prettier:check": "prettier . --check --cache",
-		"prettier:fix": "prettier . --write --cache",
-		"precommit:lint": "lint-staged",
-		"prepush:test": "jest --verbose --runInBand --onlyChanged",
-		"test": "jest",
-		"test:watch": "jest --watch",
-		"test:ci": "jest --coverage --ci",
-		"tsc": "tsc --noEmit",
-		"validate": "npm-run-all tsc lint test build"
-	},
-	"prettier": "@guardian/prettier",
-	"devDependencies": {
-		"@commitlint/cli": "^17.0.3",
-		"@commitlint/config-conventional": "^17.0.0",
-		"@guardian/ab-core": "4.0.0",
-		"@guardian/consent-management-platform": "^13.0.2",
-		"@guardian/eslint-config-typescript": "^5.0.0",
-		"@guardian/libs": "14.0.0",
-		"@guardian/prettier": "^3.0.0",
-		"@octokit/core": "^4.0.5",
-		"@semantic-release/github": "^8.0.2",
-		"@types/google.analytics": "^0.0.42",
-		"@types/googletag": "^3.0.1",
-		"@types/jest": "^29.0.3",
-		"@types/node": "^18.11.9",
-		"@typescript-eslint/eslint-plugin": "^5.5.0",
-		"@typescript-eslint/parser": "^5.5.0",
-		"commitizen": "^4.2.4",
-		"conventional-changelog-conventionalcommits": "^5.0.0",
-		"cz-conventional-changelog": "^3.3.0",
-		"eslint": "^8.4.1",
-		"eslint-config-prettier": "^8.3.0",
-		"eslint-plugin-eslint-comments": "^3.2.0",
-		"eslint-plugin-import": "^2.25.3",
-		"eslint-plugin-jest": "^27.2.1",
-		"eslint-plugin-prettier": "^4.0.0",
-		"jest": "^29.4.1",
-		"mockdate": "^3.0.5",
-		"npm-run-all": "^4.1.5",
-		"prettier": "^2.5.0",
-		"semantic-release": "^19.0.2",
-		"semantic-release-monorepo": "^7.0.5",
-		"ts-jest": "^29.0.5",
-		"tslib": "^2.4.1",
-		"type-fest": "2.12.2",
-		"typescript": "~4.9.5"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"peerDependencies": {
-		"@guardian/ab-core": "^4.0.0",
-		"@guardian/consent-management-platform": "^13.0.2",
-		"@guardian/libs": "^14.0.0"
-	},
-	"resolutions": {
-		"typescript": "~4.9.5"
-	}
-}
+  "name": "@guardian/commercial-core",
+  "version": "27.0.0",
+  "description": "Guardian advertising business logic",
+  "homepage": "https://github.com/guardian/commercial#readme",
+  "bugs": {
+    "url": "https://github.com/guardian/commercial/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guardian/commercial.git"
+  },
+  "license": "Apache-2.0",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "workspace": "./src/index.ts"
+    },
+    "./*": {
+      "import": "./dist/esm/*.js",
+      "require": "./dist/cjs/*.js",
+      "workspace": "./src/*.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@guardian/ab-core": "8.0.1",
+    "@guardian/libs": "22.5.0"
+  },
+  "dependencies": {
+    "@guardian/ab-core": "8.0.1",
+    "@guardian/libs": "22.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "24.0.12",
+    "@types/googletag": "~3.3.0",
+    "typescript": "5.5.4",
+    "@types/jest": "30.0.0",
+    "jest": "^30.0.1",
+    "jest-environment-jsdom": "~29.7.0",
+    "jest-environment-jsdom-global": "~4.0.0",
+    "ts-jest": "^29.2.5",
+    "type-fest": "^4.31.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run --parallel --aggregate-output /^build:.*/",
+    "clean": "rm -rf dist",
+    "build:esm": "tsc --outDir ./dist/esm --project ./tsconfig.esm.json",
+    "build:cjs": "tsc --outDir ./dist/cjs --project ./tsconfig.cjs.json",
+    "lint": "eslint .",
+    "prettier:check": "prettier . --check --cache",
+    "prettier:fix": "prettier . --write --cache",
+    "test": "jest",
+    "tsc": "tsc --noEmit"
+  }
+}

package/dist/cjs/__vendor/a9-apstag.d.ts

@@ -1 +0,0 @@
-export function a9Apstag(): void;