@financial-times/cmp-client 3.1.2 → 3.2.0

package/README.md

@@ -21,21 +21,56 @@ npm install @financial-times/cmp-client
 
 ## Usage
 
+> [!Note]
+> We will be adding new properties (i.e. websites under FT group) and their configs as we start rolling out.
+>
+> Please reach out to the Ads & Privacy team if you think your domain needs a new property config
+
+### Usage on non-FT.com properties
+
+```js
+import { initSourcepointCmp, properties, debug } from "@financial-times/cmp-client";
+
+/**
+ * Optionally enable debug mode to see CMP events in the console
+ */
+debug.logCmpEvents();
+
+/**
+ * Import your domain's CMP configuration from the `properties` module:
+ * e.g. properties.MM_IGNITES_ASIA, properties.SP_THE_BANKER, etc.
+ *
+ * We will add more domains as we create new properties in Sourcepoint
+ *
+ * See below for the full list of initialisation options
+ */
+initSourcepointCmp({
+  propertyConfig: properties["YOUR_PROPERTY_CONFIG_KEY"],
+  useConsentStore: false, // Specialist Titles _must_ opt out of Single Consent Store
+});
+```
+
+### Usage on FT.com
+
 ```js
-import { initSourcepointCmp } from "@financial-times/cmp-client/client";
-import { FT_DOTCOM_TEST } from "@financial-times/cmp-client/properties";
+import { initSourcepointCmp, properties, debug } from "@financial-times/cmp-client";
 
-// we suggest using a feature flag to disable the existing cookie banner and enable the new one
+/**
+ * Optionally enable debug mode to see CMP events in the console
+ */
+debug.logCmpEvents();
+
+/**
+ * We suggest using a feature flag to disable the existing cookie banner
+ * and enable the new one
+ */
 if (flagsClient.get("adsDisableInternalCMP")) {
   initSourcepointCmp({
     propertyConfig: FT_DOTCOM_TEST,
-    // useConsentStore: false (set to false for non-FT.com properties or websites)
   });
 }
 ```
 
-We will be adding new properties (websites under FT group) and their configs as we start rolling out. Please reach out to the Ads & Privacy team if you think you need to create a new property for your domain - for example, if it is on a different domain from the `ft.com` domain.
-
 ### CMP configuration options:
 
 <table>

package/dist/index.cjs

@@ -7,7 +7,7 @@ var __publicField = (obj, key, value) => {
 };
 var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r;
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "3.1.2";
+const version = "3.2.0";
 const events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -3135,6 +3135,40 @@ const trackingEventHandlers = {
     });
   }
 };
+function getCookie(name) {
+  var _a2, _b2;
+  const value = `; ${document.cookie}`;
+  const parts = value.split(`; ${name}=`);
+  if (parts.length === 2)
+    return (_b2 = (_a2 = parts.pop()) == null ? void 0 : _a2.split(";")) == null ? void 0 : _b2.shift();
+}
+function enableNonEssentialCookiesOption() {
+  window._sp_queue ?? (window._sp_queue = []);
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    (_b2 = (_a2 = window._sp_) == null ? void 0 : _a2.addEventListener) == null ? void 0 : _b2.call(
+      _a2,
+      "onMessageChoiceSelect",
+      (_messageType, _choiceId, choiceTypeId) => {
+        if (choiceTypeId === 9) {
+          document.cookie = "sp_cw=dismissed; expires=Thu, 18 Dec 2023 12:00:00 UTC";
+        }
+      }
+    );
+  });
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    (_b2 = (_a2 = window._sp_) == null ? void 0 : _a2.addEventListener) == null ? void 0 : _b2.call(
+      _a2,
+      "onPrivacyManagerAction",
+      (_messageType, pmData) => {
+        if (pmData.purposeConsent == "none" && pmData.vendorConsent == "none") {
+          document.cookie = "sp_cw=dismissed; expires=Thu, 18 Dec 2023 12:00:00 UTC";
+        }
+      }
+    );
+  });
+}
 async function initSourcepointCmp({
   propertyConfig = FT_DOTCOM_PROD,
   userId,
@@ -3165,6 +3199,14 @@ async function initSourcepointCmp({
     );
     delete propertyConfig.events;
   }
+  propertyConfig = {
+    ...propertyConfig,
+    gdpr: {
+      targetingParams: {
+        cookiew: getCookie("cw")
+      }
+    }
+  };
   bootstrapCmp(propertyConfig);
   window._sp_queue.push(() => {
     var _a2, _b2;
@@ -3180,6 +3222,7 @@ async function initSourcepointCmp({
       })
     );
   });
+  enableNonEssentialCookiesOption();
   initTracking(trackingContext);
 }
 window.FT_CMP_CLIENT_VERSION = version;

package/dist/index.js

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => {
   return value;
 };
 var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r;
-const version = "3.1.2";
+const version = "3.2.0";
 const events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -3133,6 +3133,40 @@ const trackingEventHandlers = {
     });
   }
 };
+function getCookie(name) {
+  var _a2, _b2;
+  const value = `; ${document.cookie}`;
+  const parts = value.split(`; ${name}=`);
+  if (parts.length === 2)
+    return (_b2 = (_a2 = parts.pop()) == null ? void 0 : _a2.split(";")) == null ? void 0 : _b2.shift();
+}
+function enableNonEssentialCookiesOption() {
+  window._sp_queue ?? (window._sp_queue = []);
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    (_b2 = (_a2 = window._sp_) == null ? void 0 : _a2.addEventListener) == null ? void 0 : _b2.call(
+      _a2,
+      "onMessageChoiceSelect",
+      (_messageType, _choiceId, choiceTypeId) => {
+        if (choiceTypeId === 9) {
+          document.cookie = "sp_cw=dismissed; expires=Thu, 18 Dec 2023 12:00:00 UTC";
+        }
+      }
+    );
+  });
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    (_b2 = (_a2 = window._sp_) == null ? void 0 : _a2.addEventListener) == null ? void 0 : _b2.call(
+      _a2,
+      "onPrivacyManagerAction",
+      (_messageType, pmData) => {
+        if (pmData.purposeConsent == "none" && pmData.vendorConsent == "none") {
+          document.cookie = "sp_cw=dismissed; expires=Thu, 18 Dec 2023 12:00:00 UTC";
+        }
+      }
+    );
+  });
+}
 async function initSourcepointCmp({
   propertyConfig = FT_DOTCOM_PROD,
   userId,
@@ -3163,6 +3197,14 @@ async function initSourcepointCmp({
     );
     delete propertyConfig.events;
   }
+  propertyConfig = {
+    ...propertyConfig,
+    gdpr: {
+      targetingParams: {
+        cookiew: getCookie("cw")
+      }
+    }
+  };
   bootstrapCmp(propertyConfig);
   window._sp_queue.push(() => {
     var _a2, _b2;
@@ -3178,6 +3220,7 @@ async function initSourcepointCmp({
       })
     );
   });
+  enableNonEssentialCookiesOption();
   initTracking(trackingContext);
 }
 window.FT_CMP_CLIENT_VERSION = version;

package/dist/src/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAU5D,wBAAsB,kBAAkB,CAAC,EACvC,cAA+B,EAC/B,MAAM,EACN,YAAmB,EACnB,gBAAwC,EACxC,YAA+B,EAC/B,aAAkC,EAClC,eAAsB,EACtB,eAAoB,GACrB,GAAE,cAAmB,iBAyCrB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAY5D,wBAAsB,kBAAkB,CAAC,EACvC,cAA+B,EAC/B,MAAM,EACN,YAAmB,EACnB,gBAAwC,EACxC,YAA+B,EAC/B,aAAkC,EAClC,eAAsB,EACtB,eAAoB,GACrB,GAAE,cAAmB,iBAiDrB"}

package/dist/src/lib/enableNonEssentialCookiesOption.d.ts

@@ -0,0 +1,2 @@
+export declare function enableNonEssentialCookiesOption(): void;
+//# sourceMappingURL=enableNonEssentialCookiesOption.d.ts.map

package/dist/src/lib/enableNonEssentialCookiesOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enableNonEssentialCookiesOption.d.ts","sourceRoot":"","sources":["../../../src/lib/enableNonEssentialCookiesOption.ts"],"names":[],"mappings":"AACA,wBAAgB,+BAA+B,SAuB9C"}

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

@@ -0,0 +1,2 @@
+export declare function getCookie(name: string): string | undefined;
+//# sourceMappingURL=cookie.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../../src/utils/cookie.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,sBAIrC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/cmp-client",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "private": false,
   "type": "module",
   "files": [

package/typings/types.d.ts

@@ -16,6 +16,7 @@ export interface SPConfig {
   joinHref?: boolean;
   events?: Partial<SPLifecycleEvents>;
   authId?: string;
+  targetingParams?: Record<string, unknown>;
 }
 
 export type SPEventCallback = (