@financial-times/cmp-client 3.1.2 → 3.1.4

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,6 @@ 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 events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -3135,6 +3134,7 @@ const trackingEventHandlers = {
     });
   }
 };
+const version = "3.1.4";
 async function initSourcepointCmp({
   propertyConfig = FT_DOTCOM_PROD,
   userId,
@@ -3145,6 +3145,11 @@ async function initSourcepointCmp({
   useConsentStore = true,
   trackingContext = {}
 } = {}) {
+  if (typeof window === "undefined") {
+    console.error("The CMP client can only be initialised in a browser context");
+    return;
+  }
+  window.FT_CMP_CLIENT_VERSION = version;
   if (!userId && useFTSession) {
     try {
       const response = await getUuid();
@@ -3182,7 +3187,6 @@ async function initSourcepointCmp({
   });
   initTracking(trackingContext);
 }
-window.FT_CMP_CLIENT_VERSION = version;
 exports.debug = debug;
 exports.initSourcepointCmp = initSourcepointCmp;
 exports.properties = properties;

package/dist/index.js

@@ -5,7 +5,6 @@ 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 events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -3133,6 +3132,7 @@ const trackingEventHandlers = {
     });
   }
 };
+const version = "3.1.4";
 async function initSourcepointCmp({
   propertyConfig = FT_DOTCOM_PROD,
   userId,
@@ -3143,6 +3143,11 @@ async function initSourcepointCmp({
   useConsentStore = true,
   trackingContext = {}
 } = {}) {
+  if (typeof window === "undefined") {
+    console.error("The CMP client can only be initialised in a browser context");
+    return;
+  }
+  window.FT_CMP_CLIENT_VERSION = version;
   if (!userId && useFTSession) {
     try {
       const response = await getUuid();
@@ -3180,7 +3185,6 @@ async function initSourcepointCmp({
   });
   initTracking(trackingContext);
 }
-window.FT_CMP_CLIENT_VERSION = version;
 export {
   debug,
   initSourcepointCmp,

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;AAW5D,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,iBAgDrB"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC"}

package/package.json

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