npm - @financial-times/cmp-client - Versions diffs - 2.2.3-alpha → 3.0.0 - Mend

@financial-times/cmp-client 2.2.3-alpha → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md +84 -32
package/dist/index.cjs +65 -2
package/dist/index.js +65 -2
package/dist/src/lib/properties.d.ts +72 -0
package/dist/src/lib/properties.d.ts.map +1 -1
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -2,24 +2,23 @@
 A client-side package to help you add a CMP (currently provided by Sourcepoint) to your application.
-## Installation
+<details>
+  <summary>How it works</summary>
-Install the package from npm:
+[(Source on Confluence)](https://financialtimes.atlassian.net/wiki/spaces/ADS/pages/8151990292/New+Consent+Migration+Guide+for+teams#What-happens-when-a-user-visits-%5BinlineCard%5D--in-the-new-consent-framework%3F)
-```copy
-npm install @financial-times/cmp-client
-```
+![CMP Client Overview](docs/overview.jpg)
-There are reference implementations that you can look at in `src/examples/cmp-client`.
+</details>
-To see a demo in action in your browser, run:
+## Installation
+Install the package from npm:
 ```copy
-npm run dev -w src/examples/cmp-client
+npm install @financial-times/cmp-client
 ```
-Visit https://localhost:5173 (see setup details in `src/examples/cmp-client`) to interact with the banner and see how cookies are set accordingly
 ## Usage
 ```js
@@ -82,23 +81,6 @@ We will be adding new properties (websites under FT group) and their configs as
   </tbody>
 <table/>
-## Responding to CMP events
-If you need to do additional work in response to events emitted by the CMP Vendor module you can do so via the `window._sp_.addEventListener` method:
-```js
-window._sp_.addEventListener("onMessageReady", (messageType) => {... });
-window._sp_.addEventListener("onConsentReady", (legislation, consentUUID, consentString, consentMeta) => { ... });
-```
-> [!Note]
-> The `onConsentReady` event is fired
->
-> 1. As soon as the CMP has finished loading and the user's consent choices are available
-> 1. Subsequently, whenever the user's consent choices change
-See the [Sourcepoint docs](https://docs.sourcepoint.com/hc/en-us/articles/4412176150035-Queue-event-callbacks) for a full listing of the events you can listen for and the arguments passed to the callbacks.
 ### Available Properties (constantly being updated)
 <table>
@@ -121,12 +103,65 @@ See the [Sourcepoint docs](https://docs.sourcepoint.com/hc/en-us/articles/441217
       <td><code>FT_DOTCOM_PROD</code></td>
       <td>Configuration preset for all properties on FT.com domain operating in a production environment - <code>https://*.ft.com</code></td>
     </tr>
+    <tr>
+      <td><code>SP_THE_BANKER</code></td>
+      <td>Configuration preset for properties on thebanker.com domain</td>
+    </tr>
+    <tr>
+      <td><code>SP_PWMNET</code></td>
+      <td>Configuration preset for properties on pwmnet.com domain</td>
+    </tr>
+    <tr>
+      <td><code>SP_FDI_INTELLIGENCE</code></td>
+      <td>Configuration preset for properties on fdiintelligence.com domain</td>
+    </tr>
+    <tr>
+      <td><code>SP_BANKING_RR</code></td>
+      <td>Configuration preset for properties on bankingriskandregulation.com domain</td>
+    </tr>
+    <tr>
+      <td><code>SP_SUSTAINABLE_VIEWS</code></td>
+      <td>Configuration preset for properties on sustainableviews.com domain</td>
+    </tr>
+    <tr>
+      <td><code>SP_FT_ADVISER</code></td>
+      <td>Configuration preset for properties on ftadviser.com domain</td>
+    </tr>
+    <tr>
+      <td><code>SP_INVESTORS_CHRONICLE</code></td>
+      <td>Configuration preset for properties on investorschronicle.co.uk domain</td>
+    </tr>
+    <tr>
+      <td><code>MM_IGNITES_ASIA</code></td>
+      <td>Configuration preset for properties on ignitesasia.com domain</td>
+    </tr>
+    <tr>
+      <td><code>MM_IGNITES_EUROPE</code></td>
+      <td>Configuration preset for properties on igniteseurope.com domain</td>
+    </tr>
   </tbody>
 <table/>
+## Responding to CMP events
+If you need to do additional work in response to events emitted by the CMP Vendor module – e.g. initialising vendor packages that match the purposes granted by the user – you can do so via the `window._sp_.addEventListener` method:
+```js
+window._sp_.addEventListener("onMessageReady", (messageType) => {... });
+window._sp_.addEventListener("onConsentReady", (legislation, consentUUID, consentString, consentMeta) => { ... });
+```
+> [!Note]
+> The `onConsentReady` event is fired
+>
+> 1. As soon as the CMP has finished loading and the user's consent choices are available
+> 1. Subsequently, whenever the user's consent choices change
+See the [Sourcepoint docs](https://docs.sourcepoint.com/hc/en-us/articles/4412176150035-Queue-event-callbacks) for a full listing of the events you can listen for and the arguments passed to the callbacks.
 ## Debugging
-You can verify that the CMP is correctly configured with the `debug` module, as deomstrated in [the CMP Client example](src/examples/src/scripts/cmp-client.ts):
+You can verify that the CMP is correctly configured using the `logCmpEvents` method exported from the `debug` module:
 ```js
 import { debug } from "@financial-times/cmp-client";
@@ -134,10 +169,27 @@ import { debug } from "@financial-times/cmp-client";
 debug.logCmpEvents();
 ```
-If everything's working then when running the demo app you'll see the CMP log its lifecycle events to the console, _even if its UI isn't displayed_.
+If everything's working then you'll see the CMP Module log its lifecycle events to the console, _even if its UI isn't displayed_.
+This can easily happen when you've made a previous consent choice and the CMP is now picking it up from local storage. For this reason we recommend running in an incognito window during development.
+> [!Note]
+> Please ensure that your app always uses the latest version of the CMP Client package.
+>
+> You can check the version your live app is using by running the following in the browser console:
+>
+> ```copy
+> window.FT_CMP_CLIENT_VERSION
+> ```
+## Development
-This can easily happen when you've made a previous consent choice and the CMP is now picking it up from local storage. We recommend running in an incognito window during development.
+If you have access to the source on Github you can take a look at [the reference implementations in `src/examples/cmp-client`](https://github.com/Financial-Times/privacy/tree/main/src/examples).
-## How it works
+To see a demo in action in your browser, run:
-The overview of how the CMP client works is diagrammatically [presented here](https://financialtimes.atlassian.net/wiki/spaces/ADS/pages/8151990292/New+Consent+Migration+Guide+for+teams#What-happens-when-a-user-visits-%5BinlineCard%5D--in-the-new-consent-framework%3F)
+```copy
+npm run dev -w src/examples/cmp-client
+```
+Visit https://localhost:5173 (see setup details in `src/examples/cmp-client`) to interact with the banner and see how cookies are set accordingly

package/dist/index.cjs CHANGED Viewed

@@ -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 = "2.2.3-alpha";
+const version = "3.0.0";
 const events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -69,10 +69,73 @@ const FT_DOTCOM_PROD = {
   baseEndpoint: "https://consent-manager.ft.com",
   propertyId: 31642
 };
+const SP_PWMNET = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.pwmnet.com",
+  propertyId: 33414
+};
+const SP_FDI_INTELLIGENCE = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.fdiintelligence.com",
+  propertyId: 34061
+};
+const SP_THE_BANKER = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.thebanker.com",
+  propertyId: 34060
+};
+const SP_BANKING_RR = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.bankingriskandregulation.com",
+  propertyId: 34059
+};
+const SP_SUSTAINABLE_VIEWS = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.sustainableviews.com",
+  propertyId: 34058
+};
+const SP_FT_ADVISER = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.ftadviser.com",
+  propertyId: 33416
+};
+const SP_INVESTORS_CHRONICLE = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.investorschronicle.co.uk",
+  propertyId: 33415
+};
+const MM_IGNITES_ASIA = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://cdn.privacy-mgmt.com",
+  propertyId: 33947
+};
+const MM_IGNITES_EUROPE = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://cdn.privacy-mgmt.com",
+  propertyId: 33946
+};
 const properties = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   FT_DOTCOM_PROD,
-  FT_DOTCOM_TEST
+  FT_DOTCOM_TEST,
+  MM_IGNITES_ASIA,
+  MM_IGNITES_EUROPE,
+  SP_BANKING_RR,
+  SP_FDI_INTELLIGENCE,
+  SP_FT_ADVISER,
+  SP_INVESTORS_CHRONICLE,
+  SP_PWMNET,
+  SP_SUSTAINABLE_VIEWS,
+  SP_THE_BANKER
 }, Symbol.toStringTag, { value: "Module" }));
 function updateFooterLinkCMP() {
   const cookieLink = document.querySelector(

package/dist/index.js CHANGED Viewed

@@ -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 = "2.2.3-alpha";
+const version = "3.0.0";
 const events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -67,10 +67,73 @@ const FT_DOTCOM_PROD = {
   baseEndpoint: "https://consent-manager.ft.com",
   propertyId: 31642
 };
+const SP_PWMNET = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.pwmnet.com",
+  propertyId: 33414
+};
+const SP_FDI_INTELLIGENCE = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.fdiintelligence.com",
+  propertyId: 34061
+};
+const SP_THE_BANKER = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.thebanker.com",
+  propertyId: 34060
+};
+const SP_BANKING_RR = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.bankingriskandregulation.com",
+  propertyId: 34059
+};
+const SP_SUSTAINABLE_VIEWS = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.sustainableviews.com",
+  propertyId: 34058
+};
+const SP_FT_ADVISER = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.ftadviser.com",
+  propertyId: 33416
+};
+const SP_INVESTORS_CHRONICLE = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://consent-manager.investorschronicle.co.uk",
+  propertyId: 33415
+};
+const MM_IGNITES_ASIA = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://cdn.privacy-mgmt.com",
+  propertyId: 33947
+};
+const MM_IGNITES_EUROPE = {
+  ...defaults,
+  accountId: 1906,
+  baseEndpoint: "https://cdn.privacy-mgmt.com",
+  propertyId: 33946
+};
 const properties = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   FT_DOTCOM_PROD,
-  FT_DOTCOM_TEST
+  FT_DOTCOM_TEST,
+  MM_IGNITES_ASIA,
+  MM_IGNITES_EUROPE,
+  SP_BANKING_RR,
+  SP_FDI_INTELLIGENCE,
+  SP_FT_ADVISER,
+  SP_INVESTORS_CHRONICLE,
+  SP_PWMNET,
+  SP_SUSTAINABLE_VIEWS,
+  SP_THE_BANKER
 }, Symbol.toStringTag, { value: "Module" }));
 function updateFooterLinkCMP() {
   const cookieLink = document.querySelector(

package/dist/src/lib/properties.d.ts CHANGED Viewed

@@ -19,4 +19,76 @@ export declare const FT_DOTCOM_PROD: {
     gdpr: {};
     ccpa: {};
 };
+export declare const SP_PWMNET: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const SP_FDI_INTELLIGENCE: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const SP_THE_BANKER: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const SP_BANKING_RR: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const SP_SUSTAINABLE_VIEWS: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const SP_FT_ADVISER: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const SP_INVESTORS_CHRONICLE: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const MM_IGNITES_ASIA: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
+export declare const MM_IGNITES_EUROPE: {
+    accountId: number;
+    baseEndpoint: string;
+    propertyId: number;
+    joinHref: boolean;
+    gdpr: {};
+    ccpa: {};
+};
 //# sourceMappingURL=properties.d.ts.map

package/dist/src/lib/properties.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../../src/lib/properties.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;;;CAK1B,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;;CAK1B,CAAC"}
1	+ {"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../../src/lib/properties.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;;;CAK1B,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;;CAK1B,CAAC;AAEF,eAAO,MAAM,SAAS;;;;;;;CAKrB,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;;CAK/B,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;CAKzB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;CAKzB,CAAC;AAEF,eAAO,MAAM,oBAAoB;;;;;;;CAKhC,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;CAKzB,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;CAKlC,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;CAK3B,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;;CAK7B,CAAC"}

package/package.json CHANGED Viewed

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