@financial-times/cmp-client 4.1.0 → 5.0.0

package/dist/index.cjs

@@ -46,8 +46,7 @@ const debug = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePropert
 }, Symbol.toStringTag, { value: "Module" }));
 const defaults = {
   joinHref: true,
-  gdpr: {},
-  ccpa: {}
+  gdpr: {}
 };
 const FT_DOTCOM_TEST = {
   ...defaults,
@@ -56,7 +55,8 @@ const FT_DOTCOM_TEST = {
   propertyHref: "https://local.ft.com",
   _clientOptions: {
     privacyManagerId: 827767,
-    manageCookiesLinkOverride: "ft.com/preferences/manage-cookies"
+    manageCookiesLinkOverride: "ft.com/preferences/manage-cookies",
+    rootDomain: "ft.com"
   }
 };
 const FT_DOTCOM_PROD = {
@@ -66,6 +66,8 @@ const FT_DOTCOM_PROD = {
   propertyId: 31642,
   _clientOptions: {
     privacyManagerId: 827767,
+    usnatPrivacyManagerId: 944881,
+    ccpaPrivacyManagerId: 944882,
     manageCookiesLinkOverride: "ft.com/preferences/manage-cookies",
     rootDomain: "ft.com"
   }
@@ -175,40 +177,75 @@ const properties = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePr
   SP_SUSTAINABLE_VIEWS,
   SP_THE_BANKER
 }, Symbol.toStringTag, { value: "Module" }));
-const onDomReady = new Promise((resolve) => {
-  if (typeof document === "undefined")
-    return resolve();
-  const isReady = () => ["interactive", "complete"].includes(document.readyState);
-  function onStateChange() {
-    if (isReady()) {
-      document.removeEventListener("readystatechange", onStateChange);
-      resolve();
-    }
-  }
-  if (isReady())
-    return resolve();
-  document.addEventListener("readystatechange", onStateChange);
-});
-function findAndUpdateLinks(_clientOptions, loadPrivacyManagerModal) {
-  const { privacyManagerId, manageCookiesLinkOverride } = _clientOptions ?? {};
-  if (!privacyManagerId || !manageCookiesLinkOverride) {
-    return console.warn("_clientOptions is missing privacyManagerId or manageCookiesLinkOverride");
-  }
+function findAndUpdateLinks(fallback, regionId, regionApplies, regionConfig, linkMap, manageCookiesLinkOverride) {
+  const { text, onClick } = regionConfig[regionId];
   const anchors = document.querySelectorAll(`a[href*="${manageCookiesLinkOverride}"]`);
   for (const anchor of anchors) {
-    anchor.addEventListener("click", (event) => {
-      event.preventDefault();
-      loadPrivacyManagerModal == null ? void 0 : loadPrivacyManagerModal(+privacyManagerId);
-    });
+    if (regionApplies || fallback) {
+      if (linkMap.has(anchor)) {
+        anchor.removeEventListener("click", linkMap.get(anchor));
+      }
+      anchor.innerText = text;
+      anchor.addEventListener("click", onClick);
+      linkMap.set(anchor, onClick);
+    }
   }
 }
 function interceptManageCookiesLinks({ _clientOptions } = FT_DOTCOM_PROD) {
-  onDomReady.then(() => {
-    window._sp_queue ?? (window._sp_queue = []);
-    window._sp_queue.push(() => {
-      var _a, _b;
-      findAndUpdateLinks(_clientOptions, (_b = (_a = window._sp_) == null ? void 0 : _a.gdpr) == null ? void 0 : _b.loadPrivacyManagerModal);
-    });
+  const {
+    privacyManagerId,
+    ccpaPrivacyManagerId,
+    usnatPrivacyManagerId,
+    manageCookiesLinkOverride
+  } = _clientOptions ?? FT_DOTCOM_PROD._clientOptions;
+  const regionConfig = {
+    usnat: {
+      text: "Do not sell my data",
+      onClick: (e) => {
+        var _a;
+        e.preventDefault();
+        (_a = window._sp_["usnat"]) == null ? void 0 : _a.loadPrivacyManagerModal(usnatPrivacyManagerId);
+      }
+    },
+    ccpa: {
+      text: "Do not sell my data",
+      onClick: (e) => {
+        var _a;
+        e.preventDefault();
+        (_a = window._sp_["ccpa"]) == null ? void 0 : _a.loadPrivacyManagerModal(ccpaPrivacyManagerId);
+      }
+    },
+    gdpr: {
+      text: "Manage cookies",
+      onClick: (e) => {
+        var _a;
+        e.preventDefault();
+        (_a = window._sp_["gdpr"]) == null ? void 0 : _a.loadPrivacyManagerModal(privacyManagerId);
+      }
+    }
+  };
+  const linkMap = /* @__PURE__ */ new Map();
+  const onConsentReadyHandler = function(message_type, _uuid, _string, info) {
+    findAndUpdateLinks(
+      false,
+      message_type,
+      info.applies,
+      regionConfig,
+      linkMap,
+      manageCookiesLinkOverride
+    );
+    if (info.applies) {
+      window._sp_queue.push(() => {
+        var _a, _b;
+        (_b = (_a = window._sp_).removeEventListener) == null ? void 0 : _b.call(_a, "onConsentReady", onConsentReadyHandler);
+      });
+    }
+  };
+  findAndUpdateLinks(true, "gdpr", false, regionConfig, linkMap, manageCookiesLinkOverride);
+  window._sp_queue ?? (window._sp_queue = []);
+  window._sp_queue.push(() => {
+    var _a, _b;
+    (_b = (_a = window._sp_).addEventListener) == null ? void 0 : _b.call(_a, "onConsentReady", onConsentReadyHandler);
   });
 }
 const request = (url, { credentials = "omit" } = {}) => {
@@ -336,20 +373,34 @@ const scriptSources = {
 };
 const scriptContent = {
   tcfStub: `"use strict";function _typeof(t){return(_typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t})(t)}!function(){var t=function(){var t,e,o=[],n=window,r=n;for(;r;){try{if(r.frames.__tcfapiLocator){t=r;break}}catch(t){}if(r===n.top)break;r=r.parent}t||(!function t(){var e=n.document,o=!!n.frames.__tcfapiLocator;if(!o)if(e.body){var r=e.createElement("iframe");r.style.cssText="display:none",r.name="__tcfapiLocator",r.title = "__tcfapiLocator",e.body.appendChild(r)}else setTimeout(t,5);return!o}(),n.__tcfapi=function(){for(var t=arguments.length,n=new Array(t),r=0;r<t;r++)n[r]=arguments[r];if(!n.length)return o;"setGdprApplies"===n[0]?n.length>3&&2===parseInt(n[1],10)&&"boolean"==typeof n[3]&&(e=n[3],"function"==typeof n[2]&&n[2]("set",!0)):"ping"===n[0]?"function"==typeof n[2]&&n[2]({gdprApplies:e,cmpLoaded:!1,cmpStatus:"stub"}):o.push(n)},n.addEventListener("message",(function(t){var e="string"==typeof t.data,o={};if(e)try{o=JSON.parse(t.data)}catch(t){}else o=t.data;var n="object"===_typeof(o)&&null!==o?o.__tcfapiCall:null;n&&window.__tcfapi(n.command,n.version,(function(o,r){var a={__tcfapiReturn:{returnValue:o,success:r,callId:n.callId}};t&&t.source&&t.source.postMessage&&t.source.postMessage(e?JSON.stringify(a):a,"*")}),n.parameter)}),!1))};"undefined"!=typeof module?module.exports=t:t()}();`,
-  uspStub: `"use strict";(function () { var e = false; var c = window; var t = document; function r() { if (!c.frames["__uspapiLocator"]) { if (t.body) { var a = t.body; var e = t.createElement("iframe"); e.style.cssText = "display:none"; e.name = "__uspapiLocator"; e.title = "__uspapiLocator";a.appendChild(e) } else { setTimeout(r, 5) } } } r(); function p() { var a = arguments; __uspapi.a = __uspapi.a || []; if (!a.length) { return __uspapi.a } else if (a[0] === "ping") { a[2]({ gdprAppliesGlobally: e, cmpLoaded: false }, true) } else { __uspapi.a.push([].slice.apply(a)) } } function l(t) { var r = typeof t.data === "string"; try { var a = r ? JSON.parse(t.data) : t.data; if (a.__cmpCall) { var n = a.__cmpCall; c.__uspapi(n.command, n.parameter, function (a, e) { var c = { __cmpReturn: { returnValue: a, success: e, callId: n.callId } }; t.source.postMessage(r ? JSON.stringify(c) : c, "*") }) } } catch (a) { } } if (typeof __uspapi !== "function") { c.__uspapi = p; __uspapi.msgHandler = l; c.addEventListener("message", l, false) } })();`
+  gppStub: `window.__gpp_addFrame=function(e){if(!window.frames[e])if(document.body){var t=document.createElement("iframe");t.style.cssText="display:none",t.name=e,document.body.appendChild(t)}else window.setTimeout(window.__gpp_addFrame,10,e)},window.__gpp_stub=function(){var e=arguments;if(__gpp.queue=__gpp.queue||[],__gpp.events=__gpp.events||[],!e.length||1==e.length&&"queue"==e[0])return __gpp.queue;if(1==e.length&&"events"==e[0])return __gpp.events;var t=e[0],p=e.length>1?e[1]:null,s=e.length>2?e[2]:null;if("ping"===t)p({gppVersion:"1.1",cmpStatus:"stub",cmpDisplayStatus:"hidden",signalStatus:"not ready",supportedAPIs:["2:tcfeuv2","5:tcfcav1","6:uspv1","7:usnatv1","8:uscav1","9:usvav1","10:uscov1","11:usutv1","12:usctv1"],cmpId:0,sectionList:[],applicableSections:[],gppString:"",parsedSections:{}},!0);else if("addEventListener"===t){"lastId"in __gpp||(__gpp.lastId=0),__gpp.lastId++;var n=__gpp.lastId;__gpp.events.push({id:n,callback:p,parameter:s}),p({eventName:"listenerRegistered",listenerId:n,data:!0,pingData:{gppVersion:"1.1",cmpStatus:"stub",cmpDisplayStatus:"hidden",signalStatus:"not ready",supportedAPIs:["2:tcfeuv2","5:tcfcav1","6:uspv1","7:usnatv1","8:uscav1","9:usvav1","10:uscov1","11:usutv1","12:usctv1"],cmpId:0,sectionList:[],applicableSections:[],gppString:"",parsedSections:{}}},!0)}else if("removeEventListener"===t){for(var a=!1,i=0;i<__gpp.events.length;i++)if(__gpp.events[i].id==s){__gpp.events.splice(i,1),a=!0;break}p({eventName:"listenerRemoved",listenerId:s,data:a,pingData:{gppVersion:"1.1",cmpStatus:"stub",cmpDisplayStatus:"hidden",signalStatus:"not ready",supportedAPIs:["2:tcfeuv2","5:tcfcav1","6:uspv1","7:usnatv1","8:uscav1","9:usvav1","10:uscov1","11:usutv1","12:usctv1"],cmpId:0,sectionList:[],applicableSections:[],gppString:"",parsedSections:{}}},!0)}else"hasSection"===t?p(!1,!0):"getSection"===t||"getField"===t?p(null,!0):__gpp.queue.push([].slice.apply(e))},window.__gpp_msghandler=function(e){var t="string"==typeof e.data;try{var p=t?JSON.parse(e.data):e.data}catch(e){p=null}if("object"==typeof p&&null!==p&&"__gppCall"in p){var s=p.__gppCall;window.__gpp(s.command,(function(p,n){var a={__gppReturn:{returnValue:p,success:n,callId:s.callId}};e.source.postMessage(t?JSON.stringify(a):a,"*")}),"parameter"in s?s.parameter:null,"version"in s?s.version:"1.1")}},"__gpp"in window&&"function"==typeof window.__gpp||(window.__gpp=window.__gpp_stub,window.addEventListener("message",window.__gpp_msghandler,!1),window.__gpp_addFrame("__gppLocator"));
+  `
 };
-function getCmpScripts() {
+function getCmpScripts(options) {
   const fragment = document.createDocumentFragment();
   fragment.appendChild(createContentScript("tcf", scriptContent.tcfStub));
-  fragment.appendChild(createContentScript("usp", scriptContent.uspStub));
+  if (options.includeUsNat) {
+    fragment.appendChild(createContentScript("gpp", scriptContent.gppStub));
+  }
   fragment.appendChild(createSourceScript(scriptSources.cmpFrames));
   return fragment;
 }
-function bootstrapCmp(config) {
+function applyOptionsToConfig(propertyConfig, options) {
+  const { userId, includeUsNat } = options;
+  if (userId) {
+    propertyConfig.authId = userId;
+  }
+  if (includeUsNat) {
+    propertyConfig.usnat = propertyConfig.usnat || {};
+  }
+  return propertyConfig;
+}
+function bootstrapCmp(config, options) {
   const { _clientOptions, ...spConfig } = config;
-  window._sp_ = { config: spConfig };
+  const runtimeConfig = applyOptionsToConfig(spConfig, options);
+  window._sp_ = { config: runtimeConfig };
   window._sp_queue ?? (window._sp_queue = []);
-  document.head.appendChild(getCmpScripts());
+  document.head.appendChild(getCmpScripts(options));
 }
 function getConsentPayload(parsedConsent, updateConsentStore, { formOfWordsId, cookieDomain }) {
   const categoryNames = Object.keys(parsedConsent);
@@ -378,6 +429,89 @@ function getConsentPayload(parsedConsent, updateConsentStore, { formOfWordsId, c
   }
   return { data, cookieDomain };
 }
+const sections = {
+  CALIFORNIA: "uscav1",
+  US_NATIONAL: "usnatv1"
+};
+const sectionConfig = {
+  [sections.CALIFORNIA]: {
+    excludedCategories: {
+      personalisedMarketing: true
+    }
+  },
+  [sections.US_NATIONAL]: {
+    excludedCategories: {
+      personalisedMarketing: true
+    }
+  }
+};
+function getApplicableSection(gppData) {
+  const { applicableSections, supportedAPIs } = gppData;
+  const applicableSection = applicableSections[0];
+  if (applicableSection === -1 || typeof applicableSection === "undefined") {
+    return;
+  }
+  const sectionApi = supportedAPIs.find((api) => api.startsWith(`${applicableSection}:`));
+  const sectionKey = sectionApi == null ? void 0 : sectionApi.split(":")[1];
+  return sectionKey;
+}
+function parseCaliforniaSection(sectionData) {
+  const { SaleOptOut, SharingOptOut, Gpc } = sectionData;
+  const { excludedCategories } = sectionConfig[sections.CALIFORNIA];
+  const userHasNotOptedOut = SaleOptOut !== 1 && SharingOptOut !== 1 && !Gpc;
+  const parsedConsent = {};
+  for (const categoryName of iabCategoryNames) {
+    if (categoryName in excludedCategories) {
+      parsedConsent[categoryName] = true;
+      continue;
+    }
+    parsedConsent[categoryName] = userHasNotOptedOut;
+  }
+  return parsedConsent;
+}
+function parseUsNationalSection(sectionData) {
+  const { SaleOptOut, SharingOptOut, TargetedAdvertisingOptOut } = sectionData;
+  const { excludedCategories } = sectionConfig[sections.US_NATIONAL];
+  const userHasNotOptedOut = SaleOptOut !== 1 && SharingOptOut !== 1 && TargetedAdvertisingOptOut !== 1;
+  const parsedConsent = {};
+  for (const categoryName of iabCategoryNames) {
+    if (categoryName in excludedCategories) {
+      parsedConsent[categoryName] = true;
+      continue;
+    }
+    parsedConsent[categoryName] = userHasNotOptedOut;
+  }
+  return parsedConsent;
+}
+const sectionParsers = {
+  [sections.CALIFORNIA]: parseCaliforniaSection,
+  [sections.US_NATIONAL]: parseUsNationalSection
+};
+async function parseGPPConsent() {
+  const gppData = await new Promise((resolve, reject) => {
+    try {
+      if (window.__gpp) {
+        window.__gpp("ping", resolve);
+      } else {
+        reject(new Error("GPP API is not available on page"));
+      }
+    } catch (error) {
+      reject(error);
+    }
+  });
+  const { parsedSections } = gppData;
+  const applicableSection = getApplicableSection(gppData);
+  if (!applicableSection || !parsedSections[applicableSection]) {
+    throw new Error("GPP parser was called without an applicable section");
+  }
+  const sectionData = parsedSections[applicableSection];
+  const parseSection = sectionParsers[applicableSection];
+  if (!parseSection || typeof parseSection !== "function") {
+    throw new Error(`No parser found for applicable GPP section: ${applicableSection}`);
+  }
+  const parsedConsent = parseSection(sectionData);
+  return parsedConsent;
+}
 function checkConsentFor(categoryName, { purpose, vendor, specialFeatureOptins }) {
   const customCategory = iabCustomCategories[categoryName];
   const requiredPurposesConsented = customCategory.purposes.every(
@@ -391,19 +525,14 @@ function checkConsentFor(categoryName, { purpose, vendor, specialFeatureOptins }
   );
   return requiredPurposesConsented && requiredIabVendorsConsented && requiredSpecialFeaturesConsented;
 }
-function parseCCPAConsent(ccpa) {
-  const userHasNotOptedOut = (ccpa == null ? void 0 : ccpa[2]) === "N";
-  const parsedConsent = {};
-  for (const categoryName of iabCategoryNames) {
-    parsedConsent[categoryName] = userHasNotOptedOut;
-  }
-  return parsedConsent;
-}
 async function parseGDPRConsent() {
   const tcData = await new Promise((resolve, reject) => {
-    var _a;
     try {
-      (_a = window.__tcfapi) == null ? void 0 : _a.call(window, "addEventListener", 2, resolve);
+      if (window.__tcfapi) {
+        window.__tcfapi("addEventListener", 2, resolve);
+      } else {
+        reject(new Error("TCF API is not available on page"));
+      }
     } catch (error) {
       reject(error);
     }
@@ -414,8 +543,16 @@ async function parseGDPRConsent() {
   }
   return parsedConsent;
 }
-async function getParsedConsent(activeLegislation, consentString) {
-  return activeLegislation === "ccpa" ? parseCCPAConsent(consentString) : await parseGDPRConsent();
+async function getParsedConsent(activeLegislation) {
+  const legislationParsers = {
+    gdpr: parseGDPRConsent,
+    usnat: parseGPPConsent
+  };
+  const consentParser = legislationParsers[activeLegislation];
+  if (!consentParser) {
+    throw new Error("Unable to update user consent. Unsupported consent legislation.");
+  }
+  return consentParser();
 }
 function getConsentCookieValue() {
   const cookies = Object.fromEntries(
@@ -471,11 +608,22 @@ function consentReadyHandlerFn(props) {
     if (props.disableFTCookies) {
       return;
     }
+    if (!props.includeUsNat && legislation === "usnat") {
+      return;
+    }
     const activeLegislation = consentMeta.applies ? legislation : "gdpr";
     if (activeLegislation !== legislation || !consentString) {
       return;
     }
-    const parsedConsent = await getParsedConsent(activeLegislation, consentString);
+    let parsedConsent;
+    try {
+      parsedConsent = await getParsedConsent(activeLegislation);
+    } catch (error) {
+      console.error(error);
+    }
+    if (!parsedConsent) {
+      return;
+    }
     const consentHasChanged = hasConsentChanged(parsedConsent, getConsentCookieValue());
     if (!consentHasChanged) {
       return;
@@ -650,18 +798,19 @@ function setupPmTracking(trackingProps, cmpBaseEndpoint) {
     false
   );
 }
-const version = "4.1.0";
-async function initSourcepointCmp({
-  propertyConfig = FT_DOTCOM_PROD,
-  userId,
-  useFTSession = true,
-  consentProxyHost = FT_CONSENT_PROXY_HOST,
-  cookieDomain = FT_COOKIE_DOMAIN,
-  formOfWordsId = SOURCEPOINT_FOW_ID,
-  useConsentStore = true,
-  trackingContext = {},
-  disableFTCookies = false
-} = {}) {
+const version = "5.0.0";
+async function initSourcepointCmp(options) {
+  const {
+    useFTSession = true,
+    consentProxyHost = FT_CONSENT_PROXY_HOST,
+    cookieDomain = FT_COOKIE_DOMAIN,
+    formOfWordsId = SOURCEPOINT_FOW_ID,
+    useConsentStore = true,
+    trackingContext = {},
+    disableFTCookies = false,
+    includeUsNat = false
+  } = options || {};
+  let { propertyConfig = FT_DOTCOM_PROD, userId } = options || {};
   if (typeof window === "undefined") {
     console.error("The CMP client can only be initialised in a browser context");
     return;
@@ -675,19 +824,8 @@ async function initSourcepointCmp({
       console.error(error);
     }
   }
-  if (!(propertyConfig == null ? void 0 : propertyConfig.accountId)) {
-    throw new Error("Please pass a valid property config");
-  }
-  if (userId) {
-    propertyConfig.authId = userId;
-  }
-  if (propertyConfig.events) {
-    console.warn(
-      "[cmp-client] Passing an events map in the config is not supported and will be ignored. Please use window._sp_.addEventListener() to listen for events"
-    );
-    delete propertyConfig.events;
-  }
-  bootstrapCmp(propertyConfig);
+  propertyConfig = validateAndCleanConfig(propertyConfig);
+  bootstrapCmp(propertyConfig, { userId, includeUsNat });
   window._sp_queue.push(() => {
     var _a, _b;
     (_b = (_a = window._sp_) == null ? void 0 : _a.addEventListener) == null ? void 0 : _b.call(
@@ -699,12 +837,25 @@ async function initSourcepointCmp({
         cookieDomain,
         formOfWordsId,
         useConsentStore,
-        disableFTCookies
+        disableFTCookies,
+        includeUsNat
       })
     );
   });
   initTracking(trackingContext, propertyConfig.baseEndpoint);
 }
+function validateAndCleanConfig(propertyConfig) {
+  if (!(propertyConfig == null ? void 0 : propertyConfig.accountId)) {
+    throw new Error("Please pass a valid property config");
+  }
+  if (propertyConfig.events) {
+    console.warn(
+      "[cmp-client] Passing an events map in the config is not supported and will be ignored. Please use window._sp_.addEventListener() to listen for events"
+    );
+    delete propertyConfig.events;
+  }
+  return propertyConfig;
+}
 exports.debug = debug;
 exports.initSourcepointCmp = initSourcepointCmp;
 exports.interceptManageCookiesLinks = interceptManageCookiesLinks;