@financial-times/cmp-client 3.0.1 → 3.1.1

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.0.1";
+const version = "3.1.1";
 const events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -2929,6 +2929,212 @@ function consentReadyHandlerFn(props) {
     document.dispatchEvent(new CustomEvent("oCookieMessage.act", { bubbles: true }));
   };
 }
+let getRandomValues;
+const rnds8 = new Uint8Array(16);
+function rng() {
+  if (!getRandomValues) {
+    getRandomValues = typeof crypto !== "undefined" && crypto.getRandomValues && crypto.getRandomValues.bind(crypto);
+    if (!getRandomValues) {
+      throw new Error("crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported");
+    }
+  }
+  return getRandomValues(rnds8);
+}
+const byteToHex = [];
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 256).toString(16).slice(1));
+}
+function unsafeStringify(arr, offset = 0) {
+  return byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + "-" + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + "-" + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + "-" + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + "-" + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]];
+}
+const randomUUID = typeof crypto !== "undefined" && crypto.randomUUID && crypto.randomUUID.bind(crypto);
+const native = {
+  randomUUID
+};
+function v4(options, buf, offset) {
+  if (native.randomUUID && !buf && !options) {
+    return native.randomUUID();
+  }
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)();
+  rnds[6] = rnds[6] & 15 | 64;
+  rnds[8] = rnds[8] & 63 | 128;
+  if (buf) {
+    offset = offset || 0;
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+    return buf;
+  }
+  return unsafeStringify(rnds);
+}
+const COOKIE_MESSAGE = "cookie-message";
+const PRIVACY_MANAGER = "manage-cookies";
+const INITIAL_STATE = Object.freeze({
+  activeComponent: COOKIE_MESSAGE
+});
+let privateState = INITIAL_STATE;
+function isPlainObject(obj) {
+  return typeof obj === "object" && obj !== null && obj.constructor === Object && Object.prototype.toString.call(obj) === "[object Object]";
+}
+const getState = () => ({ ...privateState });
+const setState = (newState) => {
+  if (!isPlainObject(newState)) {
+    console.error("Invalid state changes");
+    return;
+  }
+  privateState = { ...privateState, ...newState };
+};
+const ACCEPT_ALL_CHOICE = 11;
+const MANAGE_PREFS_CHOICE = 12;
+const REJECT_ALL_CHOICE = 13;
+const cookieToggleFlags = ["adsDisableInternalCMP", "pwm.cmp", "messageSlotBottom"];
+function initTracking(context) {
+  const componentId = v4();
+  const flags = extractRelevantFlags(context.flags);
+  window._sp_queue = window._sp_queue ?? [];
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    for (const [eventId, eventHandler] of Object.entries(trackingEventHandlers)) {
+      (_b2 = (_a2 = window._sp_).addEventListener) == null ? void 0 : _b2.call(_a2, eventId, eventHandler({ ...context, flags, componentId }));
+    }
+  });
+}
+function extractRelevantFlags(flags) {
+  const output = {};
+  if (typeof flags === "object") {
+    cookieToggleFlags.forEach((flagName) => {
+      if (Object.prototype.hasOwnProperty.call(flags, flagName)) {
+        output[flagName] = flags[flagName];
+      }
+    });
+  }
+  return output;
+}
+function track(payload) {
+  if (!payload)
+    return;
+  const rootEl = document.body;
+  const event = new CustomEvent("oTracking.event", {
+    bubbles: true,
+    cancelable: true,
+    detail: payload.detail
+  });
+  rootEl.dispatchEvent(event);
+}
+function dispatchComponentEvent({
+  trackingProps,
+  action,
+  triggerAction,
+  messageType
+}) {
+  const state = getState();
+  const { componentId, product, app, flags } = trackingProps;
+  const event = {
+    detail: {
+      component: {
+        id: componentId,
+        name: state.activeComponent,
+        type: "overlay",
+        subtype: "cmp",
+        componentContentId: state[messageType]
+      },
+      category: "component",
+      action,
+      ...triggerAction && { trigger_action: triggerAction },
+      ...product && { product },
+      ...app && { app },
+      custom: [
+        {
+          cookie_toggle_flag: flags
+        }
+      ]
+    }
+  };
+  track(event);
+}
+const trackingEventHandlers = {
+  onMessageChoiceSelect: (trackingProps) => (messageType, _choiceId, choiceTypeId) => {
+    if (choiceTypeId === ACCEPT_ALL_CHOICE) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "accept_all",
+        messageType
+      });
+    }
+    if (choiceTypeId === MANAGE_PREFS_CHOICE) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "manage_cookies",
+        messageType
+      });
+      setState({
+        activeComponent: PRIVACY_MANAGER
+      });
+    }
+    if (choiceTypeId === REJECT_ALL_CHOICE) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "reject_all",
+        messageType
+      });
+    }
+  },
+  onMessageReady: (trackingProps) => (messageType) => {
+    dispatchComponentEvent({
+      trackingProps,
+      action: "view",
+      messageType
+    });
+  },
+  onPrivacyManagerAction: (trackingProps) => (messageType, pmData) => {
+    const { purposeConsent, vendorConsent } = pmData;
+    const isAcceptAll = purposeConsent === "all" && vendorConsent === "all";
+    const isRejectAll = purposeConsent === "none" && vendorConsent === "none";
+    setState({
+      activeComponent: PRIVACY_MANAGER
+    });
+    if (isAcceptAll) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "accept_all",
+        messageType
+      });
+    } else if (isRejectAll) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "reject_all",
+        messageType
+      });
+    } else {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "save_and_close",
+        messageType
+      });
+    }
+  },
+  onMessageReceiveData: () => (messageType, data) => {
+    const { messageId } = data;
+    setState({
+      [messageType]: messageId
+    });
+  },
+  onError: (trackingProps) => (messageType, errorCode) => {
+    dispatchComponentEvent({
+      trackingProps,
+      action: "error",
+      triggerAction: errorCode,
+      messageType
+    });
+  }
+};
 async function initSourcepointCmp({
   propertyConfig = FT_DOTCOM_PROD,
   userId,
@@ -2936,9 +3142,9 @@ async function initSourcepointCmp({
   consentProxyHost = FT_CONSENT_PROXY_HOST,
   cookieDomain = FT_COOKIE_DOMAIN,
   formOfWordsId = SOURCEPOINT_FOW_ID,
-  useConsentStore = true
+  useConsentStore = true,
+  trackingContext = {}
 } = {}) {
-  var _a2;
   if (!userId && useFTSession) {
     try {
       const response = await getUuid();
@@ -2953,20 +3159,28 @@ async function initSourcepointCmp({
   if (userId) {
     propertyConfig.authId = userId;
   }
-  if ((_a2 = propertyConfig.events) == null ? void 0 : _a2.onConsentReady) {
-    console.warn("[cmp-client] The supplied 'onConsentReady' event handler will be overwritten.");
+  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;
   }
-  const events2 = {
-    ...propertyConfig.events ?? {},
-    onConsentReady: consentReadyHandlerFn({
-      userId,
-      consentProxyHost,
-      cookieDomain,
-      formOfWordsId,
-      useConsentStore
-    })
-  };
-  bootstrapCmp({ ...propertyConfig, events: events2 });
+  bootstrapCmp(propertyConfig);
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    (_b2 = (_a2 = window._sp_) == null ? void 0 : _a2.addEventListener) == null ? void 0 : _b2.call(
+      _a2,
+      "onConsentReady",
+      consentReadyHandlerFn({
+        userId,
+        consentProxyHost,
+        cookieDomain,
+        formOfWordsId,
+        useConsentStore
+      })
+    );
+  });
+  initTracking(trackingContext);
 }
 window.FT_CMP_CLIENT_VERSION = version;
 exports.debug = debug;

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.0.1";
+const version = "3.1.1";
 const events = {
   onMessageChoiceSelect: (...args) => {
     console.log("[debug] onMessageChoiceSelect", args);
@@ -2927,6 +2927,212 @@ function consentReadyHandlerFn(props) {
     document.dispatchEvent(new CustomEvent("oCookieMessage.act", { bubbles: true }));
   };
 }
+let getRandomValues;
+const rnds8 = new Uint8Array(16);
+function rng() {
+  if (!getRandomValues) {
+    getRandomValues = typeof crypto !== "undefined" && crypto.getRandomValues && crypto.getRandomValues.bind(crypto);
+    if (!getRandomValues) {
+      throw new Error("crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported");
+    }
+  }
+  return getRandomValues(rnds8);
+}
+const byteToHex = [];
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 256).toString(16).slice(1));
+}
+function unsafeStringify(arr, offset = 0) {
+  return byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + "-" + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + "-" + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + "-" + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + "-" + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]];
+}
+const randomUUID = typeof crypto !== "undefined" && crypto.randomUUID && crypto.randomUUID.bind(crypto);
+const native = {
+  randomUUID
+};
+function v4(options, buf, offset) {
+  if (native.randomUUID && !buf && !options) {
+    return native.randomUUID();
+  }
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)();
+  rnds[6] = rnds[6] & 15 | 64;
+  rnds[8] = rnds[8] & 63 | 128;
+  if (buf) {
+    offset = offset || 0;
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+    return buf;
+  }
+  return unsafeStringify(rnds);
+}
+const COOKIE_MESSAGE = "cookie-message";
+const PRIVACY_MANAGER = "manage-cookies";
+const INITIAL_STATE = Object.freeze({
+  activeComponent: COOKIE_MESSAGE
+});
+let privateState = INITIAL_STATE;
+function isPlainObject(obj) {
+  return typeof obj === "object" && obj !== null && obj.constructor === Object && Object.prototype.toString.call(obj) === "[object Object]";
+}
+const getState = () => ({ ...privateState });
+const setState = (newState) => {
+  if (!isPlainObject(newState)) {
+    console.error("Invalid state changes");
+    return;
+  }
+  privateState = { ...privateState, ...newState };
+};
+const ACCEPT_ALL_CHOICE = 11;
+const MANAGE_PREFS_CHOICE = 12;
+const REJECT_ALL_CHOICE = 13;
+const cookieToggleFlags = ["adsDisableInternalCMP", "pwm.cmp", "messageSlotBottom"];
+function initTracking(context) {
+  const componentId = v4();
+  const flags = extractRelevantFlags(context.flags);
+  window._sp_queue = window._sp_queue ?? [];
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    for (const [eventId, eventHandler] of Object.entries(trackingEventHandlers)) {
+      (_b2 = (_a2 = window._sp_).addEventListener) == null ? void 0 : _b2.call(_a2, eventId, eventHandler({ ...context, flags, componentId }));
+    }
+  });
+}
+function extractRelevantFlags(flags) {
+  const output = {};
+  if (typeof flags === "object") {
+    cookieToggleFlags.forEach((flagName) => {
+      if (Object.prototype.hasOwnProperty.call(flags, flagName)) {
+        output[flagName] = flags[flagName];
+      }
+    });
+  }
+  return output;
+}
+function track(payload) {
+  if (!payload)
+    return;
+  const rootEl = document.body;
+  const event = new CustomEvent("oTracking.event", {
+    bubbles: true,
+    cancelable: true,
+    detail: payload.detail
+  });
+  rootEl.dispatchEvent(event);
+}
+function dispatchComponentEvent({
+  trackingProps,
+  action,
+  triggerAction,
+  messageType
+}) {
+  const state = getState();
+  const { componentId, product, app, flags } = trackingProps;
+  const event = {
+    detail: {
+      component: {
+        id: componentId,
+        name: state.activeComponent,
+        type: "overlay",
+        subtype: "cmp",
+        componentContentId: state[messageType]
+      },
+      category: "component",
+      action,
+      ...triggerAction && { trigger_action: triggerAction },
+      ...product && { product },
+      ...app && { app },
+      custom: [
+        {
+          cookie_toggle_flag: flags
+        }
+      ]
+    }
+  };
+  track(event);
+}
+const trackingEventHandlers = {
+  onMessageChoiceSelect: (trackingProps) => (messageType, _choiceId, choiceTypeId) => {
+    if (choiceTypeId === ACCEPT_ALL_CHOICE) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "accept_all",
+        messageType
+      });
+    }
+    if (choiceTypeId === MANAGE_PREFS_CHOICE) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "manage_cookies",
+        messageType
+      });
+      setState({
+        activeComponent: PRIVACY_MANAGER
+      });
+    }
+    if (choiceTypeId === REJECT_ALL_CHOICE) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "reject_all",
+        messageType
+      });
+    }
+  },
+  onMessageReady: (trackingProps) => (messageType) => {
+    dispatchComponentEvent({
+      trackingProps,
+      action: "view",
+      messageType
+    });
+  },
+  onPrivacyManagerAction: (trackingProps) => (messageType, pmData) => {
+    const { purposeConsent, vendorConsent } = pmData;
+    const isAcceptAll = purposeConsent === "all" && vendorConsent === "all";
+    const isRejectAll = purposeConsent === "none" && vendorConsent === "none";
+    setState({
+      activeComponent: PRIVACY_MANAGER
+    });
+    if (isAcceptAll) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "accept_all",
+        messageType
+      });
+    } else if (isRejectAll) {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "reject_all",
+        messageType
+      });
+    } else {
+      dispatchComponentEvent({
+        trackingProps,
+        action: "click",
+        triggerAction: "save_and_close",
+        messageType
+      });
+    }
+  },
+  onMessageReceiveData: () => (messageType, data) => {
+    const { messageId } = data;
+    setState({
+      [messageType]: messageId
+    });
+  },
+  onError: (trackingProps) => (messageType, errorCode) => {
+    dispatchComponentEvent({
+      trackingProps,
+      action: "error",
+      triggerAction: errorCode,
+      messageType
+    });
+  }
+};
 async function initSourcepointCmp({
   propertyConfig = FT_DOTCOM_PROD,
   userId,
@@ -2934,9 +3140,9 @@ async function initSourcepointCmp({
   consentProxyHost = FT_CONSENT_PROXY_HOST,
   cookieDomain = FT_COOKIE_DOMAIN,
   formOfWordsId = SOURCEPOINT_FOW_ID,
-  useConsentStore = true
+  useConsentStore = true,
+  trackingContext = {}
 } = {}) {
-  var _a2;
   if (!userId && useFTSession) {
     try {
       const response = await getUuid();
@@ -2951,20 +3157,28 @@ async function initSourcepointCmp({
   if (userId) {
     propertyConfig.authId = userId;
   }
-  if ((_a2 = propertyConfig.events) == null ? void 0 : _a2.onConsentReady) {
-    console.warn("[cmp-client] The supplied 'onConsentReady' event handler will be overwritten.");
+  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;
   }
-  const events2 = {
-    ...propertyConfig.events ?? {},
-    onConsentReady: consentReadyHandlerFn({
-      userId,
-      consentProxyHost,
-      cookieDomain,
-      formOfWordsId,
-      useConsentStore
-    })
-  };
-  bootstrapCmp({ ...propertyConfig, events: events2 });
+  bootstrapCmp(propertyConfig);
+  window._sp_queue.push(() => {
+    var _a2, _b2;
+    (_b2 = (_a2 = window._sp_) == null ? void 0 : _a2.addEventListener) == null ? void 0 : _b2.call(
+      _a2,
+      "onConsentReady",
+      consentReadyHandlerFn({
+        userId,
+        consentProxyHost,
+        cookieDomain,
+        formOfWordsId,
+        useConsentStore
+      })
+    );
+  });
+  initTracking(trackingContext);
 }
 window.FT_CMP_CLIENT_VERSION = version;
 export {

package/dist/src/client.d.ts

@@ -1,3 +1,3 @@
 import type { CMPInitOptions } from "../typings/types.d.ts";
-export declare function initSourcepointCmp({ propertyConfig, userId, useFTSession, consentProxyHost, cookieDomain, formOfWordsId, useConsentStore, }?: CMPInitOptions): Promise<void>;
+export declare function initSourcepointCmp({ propertyConfig, userId, useFTSession, consentProxyHost, cookieDomain, formOfWordsId, useConsentStore, trackingContext, }?: CMPInitOptions): Promise<void>;
 //# sourceMappingURL=client.d.ts.map

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;AAS5D,wBAAsB,kBAAkB,CAAC,EACvC,cAA+B,EAC/B,MAAM,EACN,YAAmB,EACnB,gBAAwC,EACxC,YAA+B,EAC/B,aAAkC,EAClC,eAAsB,GACvB,GAAE,cAAmB,iBAkCrB"}
+{"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"}

package/dist/src/tracking/__tests__/state.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=state.test.d.ts.map

package/dist/src/tracking/__tests__/state.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.test.d.ts","sourceRoot":"","sources":["../../../../src/tracking/__tests__/state.test.ts"],"names":[],"mappings":""}

package/dist/src/tracking/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const COOKIE_MESSAGE = "cookie-message";
+export declare const PRIVACY_MANAGER = "manage-cookies";
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/tracking/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/tracking/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAC/C,eAAO,MAAM,eAAe,mBAAmB,CAAC"}

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

@@ -0,0 +1,3 @@
+import type { TrackingContext } from "../../typings/types.d.ts";
+export declare function initTracking(context: TrackingContext): void;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tracking/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,eAAe,EAEhB,MAAM,0BAA0B,CAAC;AAUlC,wBAAgB,YAAY,CAAC,OAAO,EAAE,eAAe,QASpD"}

package/dist/src/tracking/state.d.ts

@@ -0,0 +1,9 @@
+export declare const INITIAL_STATE: Readonly<{
+    activeComponent: "cookie-message";
+}>;
+export declare function isPlainObject(obj: unknown): obj is object;
+export declare const getState: () => {
+    [x: string]: string | number | boolean | null | undefined;
+};
+export declare const setState: (newState: unknown) => void;
+//# sourceMappingURL=state.d.ts.map

package/dist/src/tracking/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../src/tracking/state.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa;;EAExB,CAAC;AAIH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAOzD;AAGD,eAAO,MAAM,QAAQ;;CAA8B,CAAC;AAEpD,eAAO,MAAM,QAAQ,aAAc,OAAO,SAOzC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/cmp-client",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "private": false,
   "type": "module",
   "files": [
@@ -17,9 +17,11 @@
   },
   "dependencies": {
     "@iabtechlabtcf/core": "^1.5.10",
-    "next-session-client": "^5.0.0"
+    "next-session-client": "^5.0.0",
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
+    "@types/uuid": "^9.0.7",
     "eslint": "^8.53.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.2.2",

package/typings/types.d.ts

@@ -33,7 +33,7 @@ export type CMPInitOptions = Partial<{
   cookieDomain: string;
   formOfWordsId: string;
   useConsentStore: boolean;
-  spEventHandlers: [eventId: SPEventId, eventHandler: SPEventCallback][];
+  trackingContext?: TrackingContext;
 }>;
 
 export interface ConsentPayloadOptions {
@@ -96,3 +96,39 @@ export interface ConsentState {
   raw: RawConsentState;
   parsed: ParsedConsentState;
 }
+
+export type TrackingProps = {
+  product?: string;
+  app?: string;
+  flags: FlagsObject;
+  componentId: string;
+};
+
+export type TrackingContext = {
+  product?: string;
+  app?: string;
+  flags?: FlagsObject;
+};
+
+export type TrackingEvent = {
+  detail: {
+    component: {
+      id: string;
+      name: string;
+      type: string;
+      subtype: string;
+      componentContentId: string | number;
+    };
+    category: string;
+    action: string;
+    custom?: Array<Record<string, unknown>>;
+  };
+};
+export type SPMessageType = "gdpr" | "ccpa" | "ios14" | "custom";
+
+export type SPPMData = {
+  purposeConsent: "all" | "none" | "some";
+  vendorConsent: "all" | "none" | "some";
+};
+
+export type FlagsObject = Record<string, string | boolean>;