@financial-times/cmp-client 0.0.0-backup.1

package/dist/src/utils/url.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Function to check if a provided hostname contains a particular root domain
+ * This will help us determine the correct property config for the current window.location
+ * @param hostname Current hostname
+ * @param rootDomain Root domain to validate against
+ */
+export declare function containsRootDomain(hostname: string, rootDomain: string): boolean;
+/**
+ * Function to get property config based on the hostname of window.location
+ * @param hostname - window.location.href hostname
+ */
+export declare function getPropertyConfigByHostname(hostname: string): {
+    accountId: number;
+    baseEndpoint: string;
+    propertyHref: string;
+    _clientOptions: {
+        privacyManagerId: number;
+        manageCookiesLinkOverride: string;
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        privacyManagerId: number;
+        usnatPrivacyManagerId: number;
+        ccpaPrivacyManagerId: number;
+        manageCookiesLinkOverride: string;
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+} | {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    _clientOptions: {
+        rootDomain: string;
+    };
+    joinHref: boolean;
+    gdpr: {};
+};
+//# sourceMappingURL=url.d.ts.map

package/dist/src/utils/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/utils/url.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAWtE;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiB3D"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@financial-times/cmp-client",
+  "version": "0.0.0-backup.1",
+  "private": false,
+  "type": "module",
+  "files": [
+    "dist",
+    "typings"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "next-session-client": "^5.0.1"
+  },
+  "devDependencies": {
+    "@types/uuid": "^9.0.8",
+    "eslint": "^8.56.0",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.1",
+    "vitest": "^1.2.2"
+  },
+  "scripts": {
+    "lint": "eslint ./src ./typings --ext .ts",
+    "checks:lint": "npm run lint",
+    "checks:unit": "npm t -- --run",
+    "checks:types": "tsc",
+    "checks": "run-s checks:*",
+    "build:lib": "vite build --config vite.config.lib.ts",
+    "build:static": "vite build --config vite.config.static.ts",
+    "build:types": "tsc",
+    "build": "rimraf ./dist && run-s build:*",
+    "test": "vitest"
+  }
+}

package/typings/globals.d.ts

@@ -0,0 +1,20 @@
+import { GPP, TCData } from "./types";
+
+export {};
+
+declare global {
+  interface Window {
+    FT_CMP_CLIENT_VERSION: string;
+    _sp_: {
+      config: SPConfig;
+      addEventListener?: (e: string, callback: SPEventCallback) => void;
+      removeEventListener?: (e: string, callback: SPEventCallback) => void;
+      gdpr?: { loadPrivacyManagerModal: (id: number | undefined) => void };
+      ccpa?: { loadPrivacyManagerModal: (id: number | undefined) => void };
+      usnat?: { loadPrivacyManagerModal: (id: number | undefined) => void };
+    };
+    _sp_queue: (() => void)[];
+    __tcfapi: (key: string, n: number, callback: (resp: TCData) => void) => void;
+    __gpp: (key: string, callback: (resp: GPP.PingData) => void) => void;
+  }
+}

package/typings/modules.d.ts

@@ -0,0 +1 @@
+declare module "next-session-client";

package/typings/types.d.ts

@@ -0,0 +1,280 @@
+import type { events } from "../src/lib/debug.ts";
+
+import { iabCustomCategories } from "../src/lib/constants.ts";
+
+export type SPLifecycleEvents = Partial<typeof events>;
+
+export type SPEventId = keyof SPLifecycleEvents;
+
+export type SPConfigClientOptions = {
+  privacyManagerId?: number;
+  usnatPrivacyManagerId?: number;
+  ccpaPrivacyManagerId?: number;
+  manageCookiesLinkOverride?: string;
+  rootDomain?: string;
+  includeUsNat?: boolean;
+};
+
+export interface SPConfig {
+  accountId: number;
+  baseEndpoint: string;
+  gdpr: Record<string, unknown>;
+  usnat?: Record<string, unknown>;
+  propertyHref?: string;
+  propertyId?: number;
+  joinHref?: boolean;
+  events?: Partial<SPLifecycleEvents>;
+  authId?: string;
+  _clientOptions?: SPConfigClientOptions;
+}
+
+export type SPEventCallback = (
+  legislation: string,
+  _: string,
+  consentString: string,
+  consentMeta: Record<string, unknown>,
+) => Promise<void>;
+
+export type CMPInitOptions = Partial<{
+  propertyConfig: SPConfig;
+  userId: string;
+  useFTSession: boolean;
+  consentProxyHost: string;
+  cookieDomain: string;
+  formOfWordsId: string;
+  useConsentStore: boolean;
+  trackingContext: TrackingContext;
+  disableFTCookies: boolean;
+  includeUsNat: boolean;
+}>;
+
+export interface ConsentPayloadOptions {
+  shouldUpdateConsentStore: boolean;
+  formOfWordsId: string;
+  cookieDomain: string;
+}
+
+export interface ConsentCategoryPayload {
+  onsite: {
+    status: boolean;
+    lbi: false;
+    source: "sourcepoint-cmp";
+    fow?: string;
+  };
+}
+
+export type ConsentReadyProps = Omit<CMPInitOptions, "propertyConfig" | "useFTSession">;
+
+export interface ConsentPayloadOptions {
+  shouldUpdateConsentStore: boolean;
+  formOfWordsId: string;
+  cookieDomain: string;
+}
+
+export interface ConsentCategoryPayload {
+  onsite: {
+    status: boolean;
+    lbi: false;
+    source: "sourcepoint-cmp";
+    fow?: string;
+  };
+}
+
+export interface IabCustomCategory {
+  purposes: number[];
+  iabVendors: number[];
+  customVendors: number[];
+  specialFeatures: number[];
+  fowId?: string;
+  isLbi?: boolean;
+}
+
+export type IabCustomCategoryName = keyof typeof iabCustomCategories;
+
+export type Legislation = "gdpr" | "usnat";
+
+export interface RawConsentState {
+  gdpr: string | null;
+  ccpa: string | null;
+  activeLegislation: Legislation;
+  tcfCustomVendors?: string;
+}
+
+export type IabCustomCategories = Record<IabCustomCategoryName, IabCustomCategory>;
+
+export type ParsedConsentState = Record<IabCustomCategoryName, boolean>;
+
+export interface ConsentState {
+  raw: RawConsentState;
+  parsed: ParsedConsentState;
+}
+
+export type TrackingProps = {
+  product?: string;
+  app?: string;
+  flags: FlagsObject;
+};
+
+export type TrackingContext = {
+  product?: string;
+  app?: string;
+  flags?: FlagsObject;
+};
+
+export type TrackingEvent = {
+  detail: {
+    component: {
+      id: number;
+      name: string;
+      type: string;
+      subtype: string;
+    };
+    category: string;
+    action: string;
+    custom?: Array<Record<string, unknown>>;
+    url: string | null;
+  };
+};
+export type SPMessageType = "gdpr" | "ccpa" | "ios14" | "custom";
+
+export type SPPMData = {
+  purposeConsent: "all" | "none" | "some";
+  vendorConsent: "all" | "none" | "some";
+};
+
+export type FlagsObject = Record<string, string | boolean>;
+
+export type SPFrameMessageEvent = {
+  fromPM: boolean;
+  actionType: number;
+  messageId: string;
+};
+
+/**
+ * @see https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20CMP%20API%20v2.md#tcdata
+ */
+export type TCData = {
+  tcString: string;
+  tcfPolicyVersion: number;
+  cmpId: 1000;
+  cmpVersion: 1000;
+  gdprApplies: boolean | undefined;
+  eventStatus: string;
+  cmpStatus: string;
+  listenerId: number | undefined;
+  isServiceSpecific: boolean;
+  useNonStandardTexts: boolean;
+  publisherCC: string;
+  purposeOneTreatment: boolean;
+
+  purpose: {
+    consents: Record<string, boolean>;
+    legitimateInterests: Record<string, boolean>;
+  };
+
+  vendor: {
+    consents: Record<string, boolean>;
+    legitimateInterests: Record<string, boolean>;
+  };
+
+  specialFeatureOptins: Record<string, boolean>;
+
+  publisher: {
+    consents: Record<string, boolean>;
+    legitimateInterests: Record<string, boolean>;
+    customPurpose: {
+      consents: Record<string, boolean>;
+      legitimateInterests: Record<string, boolean>;
+    };
+    restrictions: Record<string, Record<string, 0 | 1 | 2>>;
+  };
+};
+
+export interface LinkOnClickFunction {
+  (e: MouseEvent): void;
+}
+
+export interface PrivacyManagerRegionId {
+  text: string;
+  onClick: LinkOnClickFunction;
+}
+
+export interface regionConfig {
+  [key: string]: PrivacyManagerRegionId;
+}
+
+export namespace GPP {
+  /**
+   * https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/US-National/IAB%20Privacy%E2%80%99s%20National%20Privacy%20Technical%20Specification.md#section-encoding
+   */
+  export interface UsNatSection {
+    Version: number;
+    SharingNotice: 0 | 1 | 2;
+    SaleOptOutNotice: 0 | 1 | 2;
+    SharingOptOutNotice: 0 | 1 | 2;
+    TargetedAdvertisingOptOutNotice: 0 | 1 | 2;
+    SensitiveDataProcessingOptOutNotice: 0 | 1 | 2;
+    SensitiveDataLimitUseNotice: 0 | 1 | 2;
+    SaleOptOut: 0 | 1 | 2;
+    SharingOptOut: 0 | 1 | 2;
+    TargetedAdvertisingOptOut: 0 | 1 | 2;
+    SensitiveDataProcessing: Array<0 | 1 | 2>;
+    KnownChildSensitiveDataConsents: Array<0 | 1 | 2>;
+    PersonalDataConsents: 0 | 1 | 2;
+    MspaCoveredTransaction: 1 | 2;
+    MspaOptOutOptionMode: 0 | 1 | 2;
+    MspaServiceProviderMode: 0 | 1 | 2;
+    Gpc: boolean;
+  }
+
+  /**
+   * https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/US-States/CA/GPP%20Extension%3A%20IAB%20Privacy%E2%80%99s%20California%20Privacy%20Technical%20Specification.md
+   */
+  export interface CaliforniaSection {
+    Version: number;
+    SaleOptOutNotice: 0 | 1 | 2;
+    SharingOptOutNotice: 0 | 1 | 2;
+    SensitiveDataLimitUseNotice: 0 | 1 | 2;
+    SaleOptOut: 0 | 1 | 2;
+    SharingOptOut: 0 | 1 | 2;
+    SensitiveDataProcessing: Array<0 | 1 | 2>;
+    KnownChildSensitiveDataConsents: Array<0 | 1 | 2>;
+    PersonalDataConsents: 0 | 1 | 2;
+    MspaCoveredTransaction: 1 | 2;
+    MspaOptOutOptionMode: 0 | 1 | 2;
+    MspaServiceProviderMode: 0 | 1 | 2;
+    Gpc: boolean;
+  }
+
+  export interface ParsedSections {
+    uscav1: CaliforniaSection;
+    usnatv1: UsNatSection;
+  }
+
+  export type PingData = {
+    gppVersion: string;
+    cmpStatus: string;
+    cmpDisplayStatus: string;
+    signalStatus: string;
+    supportedAPIs: string[];
+    cmpId: number;
+    sectionList: number[];
+    applicableSections: number[];
+    gppString: string;
+    parsedSections: ParsedSections;
+  };
+
+  export type ParsedSectionKey = keyof ParsedSections;
+
+  export type ParsedSection = ParsedSections[ParsedSectionKey];
+
+  export interface ParseFunction {
+    (sectionData: ParsedSections[ParsedSectionKey]): ParsedConsentState;
+  }
+}
+
+export type DeepPartial<T> = T extends object
+  ? {
+      [P in keyof T]?: DeepPartial<T[P]>;
+    }
+  : T;