@financial-times/cmp-client 2.0.4-alpha → 2.0.5-beta.2

package/dist/lib/constants.d.ts

@@ -0,0 +1,13 @@
+import type { IabCustomCategory } from "../../typings/types.d.ts";
+export declare const SOURCEPOINT_CONSENT_SOURCE = "sourcepoint-cmp";
+export declare const SOURCEPOINT_FOW_SCOPE = "FTPINK";
+export declare const CONSENT_COOKIE_NAME = "FTConsent";
+export declare const SOURCEPOINT_FOW_ID = "sourcepointCmp/VngD.XycZut.595cp9fWdp5XYP9vlFvk";
+export declare const FT_COOKIE_DOMAIN = ".ft.com";
+export declare const FT_CONSENT_PROXY_HOST = "https://consent.ft.com";
+export declare const legislation: {
+    CCPA: string;
+    GDPR: string;
+};
+export declare const iabCustomCategories: Record<string, IabCustomCategory>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/lib/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,eAAO,MAAM,0BAA0B,oBAAoB,CAAC;AAC5D,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAC9C,eAAO,MAAM,mBAAmB,cAAc,CAAC;AAE/C,eAAO,MAAM,kBAAkB,oDAAoD,CAAC;AACpF,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAC1C,eAAO,MAAM,qBAAqB,2BAA2B,CAAC;AAE9D,eAAO,MAAM,WAAW;;;CAGvB,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAajE,CAAC"}

package/dist/{debug.d.ts → lib/debug.d.ts}

@@ -1,13 +1,12 @@
-export declare const events: {
-    onMessageChoiceSelect: (...args: unknown[]) => void;
-    onMessageReady: (...args: unknown[]) => void;
-    onMessageChoiceError: (...args: unknown[]) => void;
-    onPrivacyManagerAction: (...args: unknown[]) => void;
-    onPMCancel: (...args: unknown[]) => void;
-    onMessageReceiveData: (...args: unknown[]) => void;
-    onSPPMObjectReady: (...args: unknown[]) => void;
-    onConsentReady: (...args: unknown[]) => void;
-    onError: (...args: unknown[]) => void;
-};
-
-export { }
+export declare const events: {
+    onMessageChoiceSelect: (...args: unknown[]) => void;
+    onMessageReady: (...args: unknown[]) => void;
+    onMessageChoiceError: (...args: unknown[]) => void;
+    onPrivacyManagerAction: (...args: unknown[]) => void;
+    onPMCancel: (...args: unknown[]) => void;
+    onMessageReceiveData: (...args: unknown[]) => void;
+    onSPPMObjectReady: (...args: unknown[]) => void;
+    onConsentReady: (...args: unknown[]) => void;
+    onError: (...args: unknown[]) => void;
+};
+//# sourceMappingURL=debug.d.ts.map

package/dist/lib/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/lib/debug.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;qCACgB,OAAO,EAAE;8BAGhB,OAAO,EAAE;oCAGH,OAAO,EAAE;sCAGP,OAAO,EAAE;0BAGrB,OAAO,EAAE;oCAGC,OAAO,EAAE;iCAGZ,OAAO,EAAE;8BAGZ,OAAO,EAAE;uBAGhB,OAAO,EAAE;CAG7B,CAAC"}

package/dist/{properties.d.ts → lib/properties.d.ts}

@@ -1,19 +1,17 @@
-export declare const FT_DOTCOM_LOCAL: {
-    accountId: number;
-    baseEndpoint: string;
-    propertyHref: string;
-    joinHref: boolean;
-    gdpr: {};
-    ccpa: {};
-};
-
-export declare const FT_DOTCOM_PROD: {
-    accountId: number;
-    baseEndpoint: string;
-    propertyId: number;
-    joinHref: boolean;
-    gdpr: {};
-    ccpa: {};
-};
-
-export { }
+export declare const FT_DOTCOM_LOCAL: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyHref: string;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const FT_DOTCOM_PROD: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+//# sourceMappingURL=properties.d.ts.map

package/dist/lib/properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../src/lib/properties.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,eAAe;;;;;;;CAK3B,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;;CAK1B,CAAC"}

package/dist/utils/dom.d.ts

@@ -0,0 +1,3 @@
+export declare function createContentScript(content: string): HTMLScriptElement;
+export declare function createSourceScript(src: string): HTMLScriptElement;
+//# sourceMappingURL=dom.d.ts.map

package/dist/utils/dom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../src/utils/dom.ts"],"names":[],"mappings":"AAAA,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,qBAIlD;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,qBAI7C"}

package/package.json

@@ -1,50 +1,40 @@
 {
   "name": "@financial-times/cmp-client",
-  "version": "2.0.4-alpha",
+  "version": "2.0.5-beta.2",
   "private": false,
   "type": "module",
-  "types": "./dist/types.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "typings"
   ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
   "exports": {
-    "./client": {
-      "import": "./dist/client.js",
-      "require": "./dist/client.cjs"
-    },
-    "./ssr": {
-      "import": "./dist/ssr.js",
-      "require": "./dist/ssr.cjs"
-    },
-    "./properties": {
-      "import": "./dist/properties.js",
-      "require": "./dist/properties.cjs"
-    },
-    "./debug": {
-      "import": "./dist/debug.js",
-      "require": "./dist/debug.cjs"
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "dependencies": {
-    "@financial-times/privacy-utils": "^2.0.4-alpha",
-    "next-session-client": "^5.0.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "@iabtechlabtcf/core": "^1.5.10",
+    "next-session-client": "^5.0.0"
   },
   "devDependencies": {
-    "@types/react": "^18.2.29",
-    "@types/react-dom": "^18.2.13",
-    "@vitejs/plugin-react": "^4.1.0",
     "eslint": "^8.51.0",
-    "express": "^4.18.2",
+    "npm-run-all": "^4.1.5",
     "typescript": "^5.2.2",
     "vite": "^4.5.0",
-    "vite-plugin-dts": "^3.6.0",
     "vitest": "^0.34.6"
   },
   "scripts": {
-    "lint": "eslint . --ext js,jsx",
-    "build": "vite build",
-    "test": "echo 'noop'"
+    "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",
+    "build:types": "tsc",
+    "build": "run-s build:*",
+    "test": "vitest"
   }
 }

package/typings/globals.d.ts

@@ -0,0 +1,20 @@
+export {};
+
+declare global {
+  interface Window {
+    _sp_: {
+      addEventListener: (
+        e: string,
+        callback: (
+          legislation: string,
+          _: string,
+          consentString: string,
+          consentMeta: Record<string, unknown>,
+        ) => Promise<void>,
+      ) => void;
+    };
+    _sp_queue: {
+      push: (f: () => void) => void;
+    };
+  }
+}

package/typings/modules.d.ts

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

package/typings/types.d.ts

@@ -0,0 +1,88 @@
+import type { events } from "../src/lib/debug.ts";
+
+import { iabCustomCategories } from "../src/iab.ts";
+
+export type SPLifecycleEvents = Partial<typeof events>;
+
+export interface SPConfig {
+  accountId: number;
+  baseEndpoint: string;
+  gdpr: Record<string, unknown>;
+  ccpa: Record<string, unknown>;
+  propertyHref?: string;
+  propertyId?: number;
+  joinHref?: boolean;
+  events?: SPLifecycleEvents;
+  authId?: string;
+}
+
+export type CMPInitOptions = Partial<{
+  propertyConfig: SPConfig;
+  userId?: string;
+  useFTSession: boolean;
+  consentProxyHost: string;
+  cookieDomain: string;
+  formOfWordsId: string;
+  useConsentStore: 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" | "ccpa";
+
+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;
+}

package/dist/debug.cjs

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const events = {
-  onMessageChoiceSelect: function(...args) {
-    console.log("[event] onMessageChoiceSelect", args);
-  },
-  onMessageReady: function(...args) {
-    console.log("[event] onMessageReady", args);
-  },
-  onMessageChoiceError: function(...args) {
-    console.log("[event] onMessageChoiceError", args);
-  },
-  onPrivacyManagerAction: function(...args) {
-    console.log("[event] onPrivacyManagerAction", args);
-  },
-  onPMCancel: function(...args) {
-    console.log("[event] onPMCancel", args);
-  },
-  onMessageReceiveData: function(...args) {
-    console.log("[event] onMessageReceiveData", args);
-  },
-  onSPPMObjectReady: function(...args) {
-    console.log("[event] onSPPMObjectReady", args);
-  },
-  onConsentReady: function(...args) {
-    console.log("[event] onConsentReady", args);
-  },
-  onError: function(...args) {
-    console.log("[event] onError", args);
-  }
-};
-exports.events = events;

package/dist/debug.js

@@ -1,32 +0,0 @@
-const events = {
-  onMessageChoiceSelect: function(...args) {
-    console.log("[event] onMessageChoiceSelect", args);
-  },
-  onMessageReady: function(...args) {
-    console.log("[event] onMessageReady", args);
-  },
-  onMessageChoiceError: function(...args) {
-    console.log("[event] onMessageChoiceError", args);
-  },
-  onPrivacyManagerAction: function(...args) {
-    console.log("[event] onPrivacyManagerAction", args);
-  },
-  onPMCancel: function(...args) {
-    console.log("[event] onPMCancel", args);
-  },
-  onMessageReceiveData: function(...args) {
-    console.log("[event] onMessageReceiveData", args);
-  },
-  onSPPMObjectReady: function(...args) {
-    console.log("[event] onSPPMObjectReady", args);
-  },
-  onConsentReady: function(...args) {
-    console.log("[event] onConsentReady", args);
-  },
-  onError: function(...args) {
-    console.log("[event] onError", args);
-  }
-};
-export {
-  events
-};

package/dist/properties.cjs

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const defaults = {
-  joinHref: true,
-  gdpr: {},
-  ccpa: {}
-};
-const FT_DOTCOM_LOCAL = {
-  ...defaults,
-  accountId: 1906,
-  baseEndpoint: "https://cdn.privacy-mgmt.com",
-  propertyHref: "https://local.ft.com"
-};
-const FT_DOTCOM_PROD = {
-  ...defaults,
-  accountId: 1906,
-  baseEndpoint: "https://cdn.privacy-mgmt.com",
-  propertyId: 31642
-};
-exports.FT_DOTCOM_LOCAL = FT_DOTCOM_LOCAL;
-exports.FT_DOTCOM_PROD = FT_DOTCOM_PROD;

package/dist/properties.js

@@ -1,21 +0,0 @@
-const defaults = {
-  joinHref: true,
-  gdpr: {},
-  ccpa: {}
-};
-const FT_DOTCOM_LOCAL = {
-  ...defaults,
-  accountId: 1906,
-  baseEndpoint: "https://cdn.privacy-mgmt.com",
-  propertyHref: "https://local.ft.com"
-};
-const FT_DOTCOM_PROD = {
-  ...defaults,
-  accountId: 1906,
-  baseEndpoint: "https://cdn.privacy-mgmt.com",
-  propertyId: 31642
-};
-export {
-  FT_DOTCOM_LOCAL,
-  FT_DOTCOM_PROD
-};