@simplybusiness/services 0.20.1 → 0.21.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.21.1
+
+### Patch Changes
+
+- 9acf157: Upgrade dependencies
+- Updated dependencies [9acf157]
+- Updated dependencies [a5c2fbd]
+  - @simplybusiness/mobius@5.24.3
+
+## 0.21.0
+
+### Minor Changes
+
+- bbbe357: Correctly set event contexts based on definitions
+
 ## 0.20.1
 
 ### Patch Changes

package/dist/cjs/mocks/eventDefinitions.js

@@ -23,25 +23,6 @@ const _default = [
             };
         }
     },
-    {
-        name: "questionAnswered",
-        type: "unstructured",
-        makePayload: (params)=>{
-            const { vertical, question, answer } = params;
-            return {
-                schema: "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-1",
-                data: {
-                    site: "",
-                    vertical: vertical || "business",
-                    page_index: 1,
-                    page_name: "Coverage diagnosis questionnaire",
-                    section_name: "Coverage diagnosis questionnaire",
-                    question,
-                    answer
-                }
-            };
-        }
-    },
     {
         name: "questionAnswered",
         type: "unstructured",
@@ -61,7 +42,10 @@ const _default = [
                     vertical: context.vertical
                 }
             };
-        }
+        },
+        contexts: [
+            "distributionChannelContext"
+        ]
     },
     {
         name: "primaryDetailSelected",
@@ -69,7 +53,7 @@ const _default = [
         makePayload: (params)=>{
             const { context, answer, vertical } = params;
             const { site } = context;
-            let verticalName = vertical ? vertical : context.vertical;
+            let verticalName = vertical || context.vertical;
             if (verticalName.toLowerCase().indexOf("landlord") > -1) {
                 verticalName = answer === "residential" ? "Landlord" : "Commercial landlord";
             }

package/dist/cjs/mocks/eventDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/mocks/eventDefinitions.ts"],"sourcesContent":["import { ParamsType } from \"../snowplow\";\nimport { redact } from \"../snowplow/event-definitions/redaction\";\n\nexport default [\n  {\n    name: \"navButtonClicked\",\n    type: \"structured\",\n    makePayload: (params: { label: \"next\" | \"back\" | \"redirect\" }) => {\n      const { label } = params;\n      return {\n        category: \"navigation\",\n        action: \"thankyou_navigation_button_click\",\n        label,\n        property: \"test-property\",\n      };\n    },\n  },\n  {\n    name: \"questionAnswered\",\n    type: \"unstructured\",\n    makePayload: (params: {\n      vertical?: string;\n      question: string;\n      answer?: string;\n    }) => {\n      const { vertical, question, answer } = params;\n      return {\n        schema:\n          \"iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-1\",\n        data: {\n          site: \"\",\n          vertical: vertical || \"business\",\n          page_index: 1,\n          page_name: \"Coverage diagnosis questionnaire\",\n          section_name: \"Coverage diagnosis questionnaire\",\n          question,\n          answer,\n        },\n      };\n    },\n  },\n  {\n    name: \"questionAnswered\",\n    type: \"unstructured\",\n    makePayload: (params: ParamsType) => {\n      const { section, context } = params as ParamsType;\n      const { question, answer } = redact(params as ParamsType);\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3\",\n        data: {\n          site: context.site,\n          page_index: 1,\n          page_name: \"quick_to_quote\",\n          submitted_from: \"quick_to_quote_experiment\",\n          section_name: section,\n          question,\n          answer,\n          vertical: context.vertical,\n        },\n      };\n    },\n  },\n  {\n    name: \"primaryDetailSelected\",\n    type: \"unstructured\",\n    makePayload: (params: ParamsType) => {\n      const { context, answer, vertical } = params as ParamsType;\n      const { site } = context;\n      let verticalName = vertical ? vertical : context.vertical;\n\n      if (verticalName.toLowerCase().indexOf(\"landlord\") > -1) {\n        verticalName =\n          answer === \"residential\" ? \"Landlord\" : \"Commercial landlord\";\n      }\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-3-0\",\n        data: {\n          site,\n          vertical: verticalName,\n          primary_detail: answer,\n        },\n      };\n    },\n  },\n  {\n    name: \"helpTextOpened\",\n    type: \"unstructured\",\n    makePayload: (params: ParamsType) => {\n      const { primaryText, label, context, helpText } = params as ParamsType;\n\n      return {\n        schema: \"iglu:com.simplybusiness/help_text_opened/jsonschema/1-1-0\",\n        data: {\n          vertical: context.vertical,\n          site: context.site,\n          help_text: helpText,\n          primary_text: primaryText,\n          label,\n          page_name: \"quick_to_quote\",\n        },\n      };\n    },\n  },\n];\n"],"names":["name","type","makePayload","params","label","category","action","property","vertical","question","answer","schema","data","site","page_index","page_name","section_name","section","context","redact","submitted_from","verticalName","toLowerCase","indexOf","primary_detail","primaryText","helpText","help_text","primary_text"],"mappings":";;;;+BAGA;;;eAAA;;;2BAFuB;MAEvB,WAAe;IACb;QACEA,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEC,KAAK,EAAE,GAAGD;YAClB,OAAO;gBACLE,UAAU;gBACVC,QAAQ;gBACRF;gBACAG,UAAU;YACZ;QACF;IACF;IACA;QACEP,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YAKZ,MAAM,EAAEK,QAAQ,EAAEC,QAAQ,EAAEC,MAAM,EAAE,GAAGP;YACvC,OAAO;gBACLQ,QACE;gBACFC,MAAM;oBACJC,MAAM;oBACNL,UAAUA,YAAY;oBACtBM,YAAY;oBACZC,WAAW;oBACXC,cAAc;oBACdP;oBACAC;gBACF;YACF;QACF;IACF;IACA;QACEV,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEc,OAAO,EAAEC,OAAO,EAAE,GAAGf;YAC7B,MAAM,EAAEM,QAAQ,EAAEC,MAAM,EAAE,GAAGS,IAAAA,iBAAM,EAAChB;YAEpC,OAAO;gBACLQ,QACE;gBACFC,MAAM;oBACJC,MAAMK,QAAQL,IAAI;oBAClBC,YAAY;oBACZC,WAAW;oBACXK,gBAAgB;oBAChBJ,cAAcC;oBACdR;oBACAC;oBACAF,UAAUU,QAAQV,QAAQ;gBAC5B;YACF;QACF;IACF;IACA;QACER,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEe,OAAO,EAAER,MAAM,EAAEF,QAAQ,EAAE,GAAGL;YACtC,MAAM,EAAEU,IAAI,EAAE,GAAGK;YACjB,IAAIG,eAAeb,WAAWA,WAAWU,QAAQV,QAAQ;YAEzD,IAAIa,aAAaC,WAAW,GAAGC,OAAO,CAAC,cAAc,CAAC,GAAG;gBACvDF,eACEX,WAAW,gBAAgB,aAAa;YAC5C;YAEA,OAAO;gBACLC,QACE;gBACFC,MAAM;oBACJC;oBACAL,UAAUa;oBACVG,gBAAgBd;gBAClB;YACF;QACF;IACF;IACA;QACEV,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEsB,WAAW,EAAErB,KAAK,EAAEc,OAAO,EAAEQ,QAAQ,EAAE,GAAGvB;YAElD,OAAO;gBACLQ,QAAQ;gBACRC,MAAM;oBACJJ,UAAUU,QAAQV,QAAQ;oBAC1BK,MAAMK,QAAQL,IAAI;oBAClBc,WAAWD;oBACXE,cAAcH;oBACdrB;oBACAW,WAAW;gBACb;YACF;QACF;IACF;CACD"}
+{"version":3,"sources":["../../../src/mocks/eventDefinitions.ts"],"sourcesContent":["import { ParamsType } from \"../snowplow\";\nimport { redact } from \"../snowplow/event-definitions/redaction\";\n\nexport default [\n  {\n    name: \"navButtonClicked\",\n    type: \"structured\",\n    makePayload: (params: { label: \"next\" | \"back\" | \"redirect\" }) => {\n      const { label } = params;\n      return {\n        category: \"navigation\",\n        action: \"thankyou_navigation_button_click\",\n        label,\n        property: \"test-property\",\n      };\n    },\n  },\n  {\n    name: \"questionAnswered\",\n    type: \"unstructured\",\n    makePayload: (params: ParamsType) => {\n      const { section, context } = params as ParamsType;\n      const { question, answer } = redact(params as ParamsType);\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3\",\n        data: {\n          site: context.site,\n          page_index: 1,\n          page_name: \"quick_to_quote\",\n          submitted_from: \"quick_to_quote_experiment\",\n          section_name: section,\n          question,\n          answer,\n          vertical: context.vertical,\n        },\n      };\n    },\n    contexts: [\"distributionChannelContext\"],\n  },\n  {\n    name: \"primaryDetailSelected\",\n    type: \"unstructured\",\n    makePayload: (params: ParamsType) => {\n      const { context, answer, vertical } = params as ParamsType;\n      const { site } = context;\n      let verticalName = vertical || context.vertical;\n\n      if (verticalName.toLowerCase().indexOf(\"landlord\") > -1) {\n        verticalName =\n          answer === \"residential\" ? \"Landlord\" : \"Commercial landlord\";\n      }\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-3-0\",\n        data: {\n          site,\n          vertical: verticalName,\n          primary_detail: answer,\n        },\n      };\n    },\n  },\n  {\n    name: \"helpTextOpened\",\n    type: \"unstructured\",\n    makePayload: (params: ParamsType) => {\n      const { primaryText, label, context, helpText } = params as ParamsType;\n\n      return {\n        schema: \"iglu:com.simplybusiness/help_text_opened/jsonschema/1-1-0\",\n        data: {\n          vertical: context.vertical,\n          site: context.site,\n          help_text: helpText,\n          primary_text: primaryText,\n          label,\n          page_name: \"quick_to_quote\",\n        },\n      };\n    },\n  },\n];\n"],"names":["name","type","makePayload","params","label","category","action","property","section","context","question","answer","redact","schema","data","site","page_index","page_name","submitted_from","section_name","vertical","contexts","verticalName","toLowerCase","indexOf","primary_detail","primaryText","helpText","help_text","primary_text"],"mappings":";;;;+BAGA;;;eAAA;;;2BAFuB;MAEvB,WAAe;IACb;QACEA,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEC,KAAK,EAAE,GAAGD;YAClB,OAAO;gBACLE,UAAU;gBACVC,QAAQ;gBACRF;gBACAG,UAAU;YACZ;QACF;IACF;IACA;QACEP,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEK,OAAO,EAAEC,OAAO,EAAE,GAAGN;YAC7B,MAAM,EAAEO,QAAQ,EAAEC,MAAM,EAAE,GAAGC,IAAAA,iBAAM,EAACT;YAEpC,OAAO;gBACLU,QACE;gBACFC,MAAM;oBACJC,MAAMN,QAAQM,IAAI;oBAClBC,YAAY;oBACZC,WAAW;oBACXC,gBAAgB;oBAChBC,cAAcX;oBACdE;oBACAC;oBACAS,UAAUX,QAAQW,QAAQ;gBAC5B;YACF;QACF;QACAC,UAAU;YAAC;SAA6B;IAC1C;IACA;QACErB,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEM,OAAO,EAAEE,MAAM,EAAES,QAAQ,EAAE,GAAGjB;YACtC,MAAM,EAAEY,IAAI,EAAE,GAAGN;YACjB,IAAIa,eAAeF,YAAYX,QAAQW,QAAQ;YAE/C,IAAIE,aAAaC,WAAW,GAAGC,OAAO,CAAC,cAAc,CAAC,GAAG;gBACvDF,eACEX,WAAW,gBAAgB,aAAa;YAC5C;YAEA,OAAO;gBACLE,QACE;gBACFC,MAAM;oBACJC;oBACAK,UAAUE;oBACVG,gBAAgBd;gBAClB;YACF;QACF;IACF;IACA;QACEX,MAAM;QACNC,MAAM;QACNC,aAAa,CAACC;YACZ,MAAM,EAAEuB,WAAW,EAAEtB,KAAK,EAAEK,OAAO,EAAEkB,QAAQ,EAAE,GAAGxB;YAElD,OAAO;gBACLU,QAAQ;gBACRC,MAAM;oBACJM,UAAUX,QAAQW,QAAQ;oBAC1BL,MAAMN,QAAQM,IAAI;oBAClBa,WAAWD;oBACXE,cAAcH;oBACdtB;oBACAa,WAAW;gBACb;YACF;QACF;IACF;CACD"}

package/dist/cjs/snowplow/Snowplow.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "Snowplow", {
     }
 });
 const _browsertracker = require("@snowplow/browser-tracker");
+const _contexts = require("./contexts");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -24,16 +25,12 @@ function _define_property(obj, key, value) {
 }
 class Snowplow {
     setContexts(contexts) {
-        var _this_contexts;
-        this.contexts = contexts;
-        // Update identity context
-        const index = (_this_contexts = this.contexts) === null || _this_contexts === void 0 ? void 0 : _this_contexts.findIndex((ctx)=>{
-            var _ctx_schema;
-            return (_ctx_schema = ctx.schema) === null || _ctx_schema === void 0 ? void 0 : _ctx_schema.includes("identity_context");
-        });
-        if (index > -1) {
-            this.contexts[index].data.domain_userid = this.uid;
-        }
+        this.contexts = (0, _contexts.updateIdentityContext)(contexts, this.uid);
+        this.pvContext = Object.values(this.contexts);
+        this.structContext = (0, _contexts.makeContexts)([
+            "distributionChannelContext",
+            "serviceChannelContext"
+        ], this.contexts);
         return this;
     }
     // Send a page view event
@@ -41,7 +38,7 @@ class Snowplow {
         if (this.trackPageView) {
             await (0, _browsertracker.trackPageView)({
                 ...event,
-                context: this.contexts
+                context: this.pvContext
             }, [
                 this.avalancheTrackerName
             ]);
@@ -52,29 +49,39 @@ class Snowplow {
     async trackEvent(event) {
         await (0, _browsertracker.trackStructEvent)({
             ...event,
-            context: this.contexts
+            context: this.structContext
         }, [
             this.bronzeAvalancheTrackerName
         ]);
         return this;
     }
     // Send a custom event with defined schema and optional contexts
-    async trackUnstructEvent(event) {
+    async trackUnstructEvent(event, contexts) {
         if (!event) {
             return this;
         }
-        await (0, _browsertracker.trackSelfDescribingEvent)({
-            event,
-            context: this.contexts
-        }, [
-            this.avalancheTrackerName
-        ]);
+        if (contexts && Array.isArray(contexts) && contexts.length > 0) {
+            // Add context to the event
+            const context = (0, _contexts.makeContexts)(contexts, this.contexts);
+            await (0, _browsertracker.trackSelfDescribingEvent)({
+                event,
+                context
+            }, [
+                this.avalancheTrackerName
+            ]);
+        } else {
+            await (0, _browsertracker.trackSelfDescribingEvent)({
+                event
+            }, [
+                this.avalancheTrackerName
+            ]);
+        }
         return this;
     }
     addEventHandlers(eventDefinitions) {
         // Add server context to makePayload functions
         const context = this.serverData;
-        eventDefinitions.forEach(({ name, type, makePayload })=>{
+        eventDefinitions.forEach(({ name, type, makePayload, contexts })=>{
             // Convert type into relevant function
             if (type === "structured") {
                 this.addEventHandler(name, (params)=>{
@@ -85,10 +92,15 @@ class Snowplow {
                 });
             } else {
                 this.addEventHandler(name, (params)=>{
-                    this.trackUnstructEvent(makePayload({
+                    const payload = makePayload({
                         ...params,
                         context
-                    }));
+                    });
+                    if (contexts && Array.isArray(contexts) && contexts.length > 0) {
+                        this.trackUnstructEvent(payload, contexts);
+                    } else {
+                        this.trackUnstructEvent(payload);
+                    }
                 });
             }
         });
@@ -103,8 +115,9 @@ class Snowplow {
         return this;
     }
     trigger(name, params) {
-        if (this.eventHandlers[name]) {
-            this.eventHandlers[name](params);
+        const handler = this.eventHandlers[name];
+        if (Object.prototype.hasOwnProperty.call(this.eventHandlers, name) && typeof handler === "function") {
+            handler(params);
         }
         return this;
     }
@@ -121,13 +134,13 @@ class Snowplow {
         _define_property(this, "pvAvalancheTrackerName", "sb-ava-pv");
         _define_property(this, "uid", "");
         _define_property(this, "trackPageView", false);
-        _define_property(this, "contexts", []);
+        _define_property(this, "contexts", {});
+        _define_property(this, "pvContext", []);
+        _define_property(this, "structContext", []);
         _define_property(this, "serverData", {});
         _define_property(this, "eventHandlers", {});
         if (!props) return;
-        const { appId, cookieDomain, avalancheCollector, eventMethod, uid, postPath, // includeGAContext,
-        // trackActivity,
-        trackPageView: tpv } = props;
+        const { appId, cookieDomain, avalancheCollector, eventMethod, uid, postPath, trackPageView: tpv } = props;
         this.uid = uid;
         this.trackPageView = tpv;
         this.serverData = (props === null || props === void 0 ? void 0 : (_props_pageViewContext = props.pageViewContext) === null || _props_pageViewContext === void 0 ? void 0 : _props_pageViewContext.data) || {};

package/dist/cjs/snowplow/Snowplow.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/snowplow/Snowplow.ts"],"sourcesContent":["import {\n  SelfDescribingJson,\n  StructuredEvent,\n  TrackerConfiguration,\n  newTracker,\n  setCookiePath,\n  setUserId,\n  trackPageView,\n  trackSelfDescribingEvent,\n  trackStructEvent,\n  PageViewEvent,\n} from \"@snowplow/browser-tracker\";\nimport { EventDefinition, TrackingProps } from \"./types\";\n\nexport type FrontOfficeStructuredEvent = StructuredEvent & {\n  serviceChannelIdentifier: string;\n};\n\n/**\n * This class is an abstraction which wraps Snowplow\n * and exposes common methods with other services:\n * - trackEvent            : sends a standard payload\n * - trackUnstructEvent    : sends a payload for custom schema\n */\nexport class Snowplow {\n  avalancheTrackerName = \"sb-ava\";\n\n  bronzeAvalancheTrackerName = \"sb-ava-br\";\n\n  pvAvalancheTrackerName = \"sb-ava-pv\";\n\n  uid: unknown = \"\";\n\n  trackPageView: boolean = false;\n\n  contexts: SelfDescribingJson<Record<string, unknown>>[] = [];\n\n  serverData: Record<string, unknown> = {};\n\n  eventHandlers: Record<string, (params?: Record<string, unknown>) => void> =\n    {};\n\n  static instance: Snowplow | undefined;\n\n  constructor(props?: TrackingProps) {\n    if (!props) return;\n\n    const {\n      appId,\n      cookieDomain,\n      avalancheCollector,\n      eventMethod,\n      uid,\n      postPath,\n      // includeGAContext,\n      // trackActivity,\n      trackPageView: tpv,\n    } = props;\n    this.uid = uid;\n    this.trackPageView = tpv;\n    this.serverData = props?.pageViewContext?.data || {};\n\n    // Set options\n    const stateStorageStrategy = \"cookieAndLocalStorage\";\n    const baseOptions: TrackerConfiguration = {\n      appId,\n      cookieDomain,\n      eventMethod,\n      stateStorageStrategy,\n      postPath,\n    };\n    // Initialize trackers\n    newTracker(this.avalancheTrackerName, avalancheCollector, baseOptions);\n\n    newTracker(\n      this.bronzeAvalancheTrackerName,\n      avalancheCollector,\n      baseOptions,\n    );\n\n    // Page view tracker\n    newTracker(this.pvAvalancheTrackerName, avalancheCollector, {\n      ...baseOptions,\n      eventMethod: eventMethod === \"post\" ? \"beacon\" : eventMethod,\n    });\n\n    setCookiePath(\"/\");\n    if (uid) {\n      setUserId(uid);\n    }\n    // Create a singleton instance\n    Snowplow.instance = this;\n  }\n\n  setContexts(contexts: SelfDescribingJson<Record<string, unknown>>[]) {\n    this.contexts = contexts;\n    // Update identity context\n    const index = this.contexts?.findIndex(ctx =>\n      ctx.schema?.includes(\"identity_context\"),\n    );\n    if (index > -1) {\n      this.contexts[index].data.domain_userid = this.uid;\n    }\n    return this;\n  }\n\n  // Send a page view event\n  async trackView(event?: PageViewEvent) {\n    if (this.trackPageView) {\n      await trackPageView({ ...event, context: this.contexts }, [\n        this.avalancheTrackerName,\n      ]);\n    }\n    return this;\n  }\n\n  // Send a structured event with contexts\n  async trackEvent(event: StructuredEvent) {\n    await trackStructEvent({ ...event, context: this.contexts }, [\n      this.bronzeAvalancheTrackerName,\n    ]);\n    return this;\n  }\n\n  // Send a custom event with defined schema and optional contexts\n  async trackUnstructEvent(event: SelfDescribingJson<Record<string, unknown>>) {\n    if (!event) {\n      return this;\n    }\n    await trackSelfDescribingEvent({ event, context: this.contexts }, [\n      this.avalancheTrackerName,\n    ]);\n    return this;\n  }\n\n  addEventHandlers(eventDefinitions: EventDefinition[]) {\n    // Add server context to makePayload functions\n    const context = this.serverData;\n\n    eventDefinitions.forEach(({ name, type, makePayload }) => {\n      // Convert type into relevant function\n      if (type === \"structured\") {\n        this.addEventHandler(name, (params?: Record<string, unknown>) => {\n          this.trackEvent(\n            makePayload({\n              ...params,\n              context,\n            }) as StructuredEvent,\n          );\n        });\n      } else {\n        this.addEventHandler(name, (params?: Record<string, unknown>) => {\n          this.trackUnstructEvent(\n            makePayload({\n              ...params,\n              context,\n            }) as SelfDescribingJson<Record<string, unknown>>,\n          );\n        });\n      }\n    });\n    return this;\n  }\n\n  private addEventHandler(\n    name: string,\n    handler: (params?: Record<string, unknown>) => void,\n  ) {\n    this.eventHandlers[name] = handler;\n    return this;\n  }\n\n  private removeEventHandler(name: string) {\n    delete this.eventHandlers[name];\n    return this;\n  }\n\n  trigger(name: string, params?: Record<string, unknown>) {\n    if (this.eventHandlers[name]) {\n      this.eventHandlers[name](params);\n    }\n    return this;\n  }\n\n  static getInstance(props?: TrackingProps) {\n    if (!Snowplow.instance) {\n      Snowplow.instance = new Snowplow(props);\n    }\n    return Snowplow.instance;\n  }\n}\n"],"names":["Snowplow","setContexts","contexts","index","findIndex","ctx","schema","includes","data","domain_userid","uid","trackView","event","trackPageView","context","avalancheTrackerName","trackEvent","trackStructEvent","bronzeAvalancheTrackerName","trackUnstructEvent","trackSelfDescribingEvent","addEventHandlers","eventDefinitions","serverData","forEach","name","type","makePayload","addEventHandler","params","handler","eventHandlers","removeEventHandler","trigger","getInstance","props","instance","constructor","pvAvalancheTrackerName","appId","cookieDomain","avalancheCollector","eventMethod","postPath","tpv","pageViewContext","stateStorageStrategy","baseOptions","newTracker","setCookiePath","setUserId"],"mappings":";;;;+BAwBaA;;;eAAAA;;;gCAbN;;;;;;;;;;;;;;AAaA,MAAMA;IAsEXC,YAAYC,QAAuD,EAAE;YAGrD;QAFd,IAAI,CAACA,QAAQ,GAAGA;QAChB,0BAA0B;QAC1B,MAAMC,SAAQ,iBAAA,IAAI,CAACD,QAAQ,cAAb,qCAAA,eAAeE,SAAS,CAACC,CAAAA;gBACrCA;oBAAAA,cAAAA,IAAIC,MAAM,cAAVD,kCAAAA,YAAYE,QAAQ,CAAC;;QAEvB,IAAIJ,QAAQ,CAAC,GAAG;YACd,IAAI,CAACD,QAAQ,CAACC,MAAM,CAACK,IAAI,CAACC,aAAa,GAAG,IAAI,CAACC,GAAG;QACpD;QACA,OAAO,IAAI;IACb;IAEA,yBAAyB;IACzB,MAAMC,UAAUC,KAAqB,EAAE;QACrC,IAAI,IAAI,CAACC,aAAa,EAAE;YACtB,MAAMA,IAAAA,6BAAa,EAAC;gBAAE,GAAGD,KAAK;gBAAEE,SAAS,IAAI,CAACZ,QAAQ;YAAC,GAAG;gBACxD,IAAI,CAACa,oBAAoB;aAC1B;QACH;QACA,OAAO,IAAI;IACb;IAEA,wCAAwC;IACxC,MAAMC,WAAWJ,KAAsB,EAAE;QACvC,MAAMK,IAAAA,gCAAgB,EAAC;YAAE,GAAGL,KAAK;YAAEE,SAAS,IAAI,CAACZ,QAAQ;QAAC,GAAG;YAC3D,IAAI,CAACgB,0BAA0B;SAChC;QACD,OAAO,IAAI;IACb;IAEA,gEAAgE;IAChE,MAAMC,mBAAmBP,KAAkD,EAAE;QAC3E,IAAI,CAACA,OAAO;YACV,OAAO,IAAI;QACb;QACA,MAAMQ,IAAAA,wCAAwB,EAAC;YAAER;YAAOE,SAAS,IAAI,CAACZ,QAAQ;QAAC,GAAG;YAChE,IAAI,CAACa,oBAAoB;SAC1B;QACD,OAAO,IAAI;IACb;IAEAM,iBAAiBC,gBAAmC,EAAE;QACpD,8CAA8C;QAC9C,MAAMR,UAAU,IAAI,CAACS,UAAU;QAE/BD,iBAAiBE,OAAO,CAAC,CAAC,EAAEC,IAAI,EAAEC,IAAI,EAAEC,WAAW,EAAE;YACnD,sCAAsC;YACtC,IAAID,SAAS,cAAc;gBACzB,IAAI,CAACE,eAAe,CAACH,MAAM,CAACI;oBAC1B,IAAI,CAACb,UAAU,CACbW,YAAY;wBACV,GAAGE,MAAM;wBACTf;oBACF;gBAEJ;YACF,OAAO;gBACL,IAAI,CAACc,eAAe,CAACH,MAAM,CAACI;oBAC1B,IAAI,CAACV,kBAAkB,CACrBQ,YAAY;wBACV,GAAGE,MAAM;wBACTf;oBACF;gBAEJ;YACF;QACF;QACA,OAAO,IAAI;IACb;IAEQc,gBACNH,IAAY,EACZK,OAAmD,EACnD;QACA,IAAI,CAACC,aAAa,CAACN,KAAK,GAAGK;QAC3B,OAAO,IAAI;IACb;IAEQE,mBAAmBP,IAAY,EAAE;QACvC,OAAO,IAAI,CAACM,aAAa,CAACN,KAAK;QAC/B,OAAO,IAAI;IACb;IAEAQ,QAAQR,IAAY,EAAEI,MAAgC,EAAE;QACtD,IAAI,IAAI,CAACE,aAAa,CAACN,KAAK,EAAE;YAC5B,IAAI,CAACM,aAAa,CAACN,KAAK,CAACI;QAC3B;QACA,OAAO,IAAI;IACb;IAEA,OAAOK,YAAYC,KAAqB,EAAE;QACxC,IAAI,CAACnC,SAASoC,QAAQ,EAAE;YACtBpC,SAASoC,QAAQ,GAAG,IAAIpC,SAASmC;QACnC;QACA,OAAOnC,SAASoC,QAAQ;IAC1B;IAjJAC,YAAYF,KAAqB,CAAE;YAgBfA;QAnCpBpB,uBAAAA,wBAAuB;QAEvBG,uBAAAA,8BAA6B;QAE7BoB,uBAAAA,0BAAyB;QAEzB5B,uBAAAA,OAAe;QAEfG,uBAAAA,iBAAyB;QAEzBX,uBAAAA,YAA0D,EAAE;QAE5DqB,uBAAAA,cAAsC,CAAC;QAEvCQ,uBAAAA,iBACE,CAAC;QAKD,IAAI,CAACI,OAAO;QAEZ,MAAM,EACJI,KAAK,EACLC,YAAY,EACZC,kBAAkB,EAClBC,WAAW,EACXhC,GAAG,EACHiC,QAAQ,EACR,oBAAoB;QACpB,iBAAiB;QACjB9B,eAAe+B,GAAG,EACnB,GAAGT;QACJ,IAAI,CAACzB,GAAG,GAAGA;QACX,IAAI,CAACG,aAAa,GAAG+B;QACrB,IAAI,CAACrB,UAAU,GAAGY,CAAAA,kBAAAA,6BAAAA,yBAAAA,MAAOU,eAAe,cAAtBV,6CAAAA,uBAAwB3B,IAAI,KAAI,CAAC;QAEnD,cAAc;QACd,MAAMsC,uBAAuB;QAC7B,MAAMC,cAAoC;YACxCR;YACAC;YACAE;YACAI;YACAH;QACF;QACA,sBAAsB;QACtBK,IAAAA,0BAAU,EAAC,IAAI,CAACjC,oBAAoB,EAAE0B,oBAAoBM;QAE1DC,IAAAA,0BAAU,EACR,IAAI,CAAC9B,0BAA0B,EAC/BuB,oBACAM;QAGF,oBAAoB;QACpBC,IAAAA,0BAAU,EAAC,IAAI,CAACV,sBAAsB,EAAEG,oBAAoB;YAC1D,GAAGM,WAAW;YACdL,aAAaA,gBAAgB,SAAS,WAAWA;QACnD;QAEAO,IAAAA,6BAAa,EAAC;QACd,IAAIvC,KAAK;YACPwC,IAAAA,yBAAS,EAACxC;QACZ;QACA,8BAA8B;QAC9BV,SAASoC,QAAQ,GAAG,IAAI;IAC1B;AAkGF;AApJE,iBAlBWpC,UAkBJoC,YAAP,KAAA"}
+{"version":3,"sources":["../../../src/snowplow/Snowplow.ts"],"sourcesContent":["import {\n  PageViewEvent,\n  StructuredEvent,\n  TrackerConfiguration,\n  newTracker,\n  setCookiePath,\n  setUserId,\n  trackPageView,\n  trackSelfDescribingEvent,\n  trackStructEvent,\n} from \"@snowplow/browser-tracker\";\nimport { makeContexts, updateIdentityContext } from \"./contexts\";\nimport { EventDefinition, SerialisedEvent, TrackingProps } from \"./types\";\n\nexport type FrontOfficeStructuredEvent = StructuredEvent & {\n  serviceChannelIdentifier: string;\n};\n\n/**\n * This class is an abstraction which wraps Snowplow\n * and exposes common methods with other services:\n * - trackEvent            : sends a standard payload\n * - trackUnstructEvent    : sends a payload for custom schema\n */\nexport class Snowplow {\n  avalancheTrackerName = \"sb-ava\";\n\n  bronzeAvalancheTrackerName = \"sb-ava-br\";\n\n  pvAvalancheTrackerName = \"sb-ava-pv\";\n\n  uid: unknown = \"\";\n\n  trackPageView: boolean = false;\n\n  contexts: Record<string, SerialisedEvent> = {};\n\n  pvContext: SerialisedEvent[] = [];\n\n  structContext: SerialisedEvent[] = [];\n\n  serverData: Record<string, unknown> = {};\n\n  eventHandlers: Record<string, (params?: Record<string, unknown>) => void> =\n    {};\n\n  static instance: Snowplow | undefined;\n\n  constructor(props?: TrackingProps) {\n    if (!props) return;\n\n    const {\n      appId,\n      cookieDomain,\n      avalancheCollector,\n      eventMethod,\n      uid,\n      postPath,\n      trackPageView: tpv,\n    } = props;\n    this.uid = uid;\n    this.trackPageView = tpv;\n    this.serverData = props?.pageViewContext?.data || {};\n\n    // Set options\n    const stateStorageStrategy = \"cookieAndLocalStorage\";\n    const baseOptions: TrackerConfiguration = {\n      appId,\n      cookieDomain,\n      eventMethod,\n      stateStorageStrategy,\n      postPath,\n    };\n    // Initialize trackers\n    newTracker(this.avalancheTrackerName, avalancheCollector, baseOptions);\n\n    newTracker(\n      this.bronzeAvalancheTrackerName,\n      avalancheCollector,\n      baseOptions,\n    );\n\n    // Page view tracker\n    newTracker(this.pvAvalancheTrackerName, avalancheCollector, {\n      ...baseOptions,\n      eventMethod: eventMethod === \"post\" ? \"beacon\" : eventMethod,\n    });\n\n    setCookiePath(\"/\");\n    if (uid) {\n      setUserId(uid);\n    }\n    // Create a singleton instance\n    Snowplow.instance = this;\n  }\n\n  setContexts(contexts: Record<string, SerialisedEvent>) {\n    this.contexts = updateIdentityContext(contexts, this.uid);\n    this.pvContext = Object.values(this.contexts);\n    this.structContext = makeContexts(\n      [\"distributionChannelContext\", \"serviceChannelContext\"],\n      this.contexts,\n    );\n    return this;\n  }\n\n  // Send a page view event\n  async trackView(event?: PageViewEvent) {\n    if (this.trackPageView) {\n      await trackPageView({ ...event, context: this.pvContext }, [\n        this.avalancheTrackerName,\n      ]);\n    }\n    return this;\n  }\n\n  // Send a structured event with contexts\n  async trackEvent(event: StructuredEvent) {\n    await trackStructEvent({ ...event, context: this.structContext }, [\n      this.bronzeAvalancheTrackerName,\n    ]);\n    return this;\n  }\n\n  // Send a custom event with defined schema and optional contexts\n  async trackUnstructEvent(event: SerialisedEvent, contexts?: string[]) {\n    if (!event) {\n      return this;\n    }\n\n    if (contexts && Array.isArray(contexts) && contexts.length > 0) {\n      // Add context to the event\n      const context = makeContexts(contexts!, this.contexts);\n\n      await trackSelfDescribingEvent({ event, context }, [\n        this.avalancheTrackerName,\n      ]);\n    } else {\n      await trackSelfDescribingEvent({ event }, [this.avalancheTrackerName]);\n    }\n    return this;\n  }\n\n  addEventHandlers(eventDefinitions: EventDefinition[]) {\n    // Add server context to makePayload functions\n    const context = this.serverData;\n\n    eventDefinitions.forEach(({ name, type, makePayload, contexts }) => {\n      // Convert type into relevant function\n      if (type === \"structured\") {\n        this.addEventHandler(name, (params?: Record<string, unknown>) => {\n          this.trackEvent(\n            makePayload({\n              ...params,\n              context,\n            }) as StructuredEvent,\n          );\n        });\n      } else {\n        this.addEventHandler(name, (params?: Record<string, unknown>) => {\n          const payload = makePayload({\n            ...params,\n            context,\n          }) as SerialisedEvent;\n\n          if (contexts && Array.isArray(contexts) && contexts.length > 0) {\n            this.trackUnstructEvent(payload, contexts);\n          } else {\n            this.trackUnstructEvent(payload);\n          }\n        });\n      }\n    });\n    return this;\n  }\n\n  private addEventHandler(\n    name: string,\n    handler: (params?: Record<string, unknown>) => void,\n  ) {\n    this.eventHandlers[name] = handler;\n    return this;\n  }\n\n  private removeEventHandler(name: string) {\n    delete this.eventHandlers[name];\n    return this;\n  }\n\n  trigger(name: string, params?: Record<string, unknown>) {\n    const handler = this.eventHandlers[name];\n\n    if (\n      Object.prototype.hasOwnProperty.call(this.eventHandlers, name) &&\n      typeof handler === \"function\"\n    ) {\n      handler(params);\n    }\n    return this;\n  }\n\n  static getInstance(props?: TrackingProps) {\n    if (!Snowplow.instance) {\n      Snowplow.instance = new Snowplow(props);\n    }\n    return Snowplow.instance;\n  }\n}\n"],"names":["Snowplow","setContexts","contexts","updateIdentityContext","uid","pvContext","Object","values","structContext","makeContexts","trackView","event","trackPageView","context","avalancheTrackerName","trackEvent","trackStructEvent","bronzeAvalancheTrackerName","trackUnstructEvent","Array","isArray","length","trackSelfDescribingEvent","addEventHandlers","eventDefinitions","serverData","forEach","name","type","makePayload","addEventHandler","params","payload","handler","eventHandlers","removeEventHandler","trigger","prototype","hasOwnProperty","call","getInstance","props","instance","constructor","pvAvalancheTrackerName","appId","cookieDomain","avalancheCollector","eventMethod","postPath","tpv","pageViewContext","data","stateStorageStrategy","baseOptions","newTracker","setCookiePath","setUserId"],"mappings":";;;;+BAwBaA;;;eAAAA;;;gCAdN;0BAC6C;;;;;;;;;;;;;;AAa7C,MAAMA;IAwEXC,YAAYC,QAAyC,EAAE;QACrD,IAAI,CAACA,QAAQ,GAAGC,IAAAA,+BAAqB,EAACD,UAAU,IAAI,CAACE,GAAG;QACxD,IAAI,CAACC,SAAS,GAAGC,OAAOC,MAAM,CAAC,IAAI,CAACL,QAAQ;QAC5C,IAAI,CAACM,aAAa,GAAGC,IAAAA,sBAAY,EAC/B;YAAC;YAA8B;SAAwB,EACvD,IAAI,CAACP,QAAQ;QAEf,OAAO,IAAI;IACb;IAEA,yBAAyB;IACzB,MAAMQ,UAAUC,KAAqB,EAAE;QACrC,IAAI,IAAI,CAACC,aAAa,EAAE;YACtB,MAAMA,IAAAA,6BAAa,EAAC;gBAAE,GAAGD,KAAK;gBAAEE,SAAS,IAAI,CAACR,SAAS;YAAC,GAAG;gBACzD,IAAI,CAACS,oBAAoB;aAC1B;QACH;QACA,OAAO,IAAI;IACb;IAEA,wCAAwC;IACxC,MAAMC,WAAWJ,KAAsB,EAAE;QACvC,MAAMK,IAAAA,gCAAgB,EAAC;YAAE,GAAGL,KAAK;YAAEE,SAAS,IAAI,CAACL,aAAa;QAAC,GAAG;YAChE,IAAI,CAACS,0BAA0B;SAChC;QACD,OAAO,IAAI;IACb;IAEA,gEAAgE;IAChE,MAAMC,mBAAmBP,KAAsB,EAAET,QAAmB,EAAE;QACpE,IAAI,CAACS,OAAO;YACV,OAAO,IAAI;QACb;QAEA,IAAIT,YAAYiB,MAAMC,OAAO,CAAClB,aAAaA,SAASmB,MAAM,GAAG,GAAG;YAC9D,2BAA2B;YAC3B,MAAMR,UAAUJ,IAAAA,sBAAY,EAACP,UAAW,IAAI,CAACA,QAAQ;YAErD,MAAMoB,IAAAA,wCAAwB,EAAC;gBAAEX;gBAAOE;YAAQ,GAAG;gBACjD,IAAI,CAACC,oBAAoB;aAC1B;QACH,OAAO;YACL,MAAMQ,IAAAA,wCAAwB,EAAC;gBAAEX;YAAM,GAAG;gBAAC,IAAI,CAACG,oBAAoB;aAAC;QACvE;QACA,OAAO,IAAI;IACb;IAEAS,iBAAiBC,gBAAmC,EAAE;QACpD,8CAA8C;QAC9C,MAAMX,UAAU,IAAI,CAACY,UAAU;QAE/BD,iBAAiBE,OAAO,CAAC,CAAC,EAAEC,IAAI,EAAEC,IAAI,EAAEC,WAAW,EAAE3B,QAAQ,EAAE;YAC7D,sCAAsC;YACtC,IAAI0B,SAAS,cAAc;gBACzB,IAAI,CAACE,eAAe,CAACH,MAAM,CAACI;oBAC1B,IAAI,CAAChB,UAAU,CACbc,YAAY;wBACV,GAAGE,MAAM;wBACTlB;oBACF;gBAEJ;YACF,OAAO;gBACL,IAAI,CAACiB,eAAe,CAACH,MAAM,CAACI;oBAC1B,MAAMC,UAAUH,YAAY;wBAC1B,GAAGE,MAAM;wBACTlB;oBACF;oBAEA,IAAIX,YAAYiB,MAAMC,OAAO,CAAClB,aAAaA,SAASmB,MAAM,GAAG,GAAG;wBAC9D,IAAI,CAACH,kBAAkB,CAACc,SAAS9B;oBACnC,OAAO;wBACL,IAAI,CAACgB,kBAAkB,CAACc;oBAC1B;gBACF;YACF;QACF;QACA,OAAO,IAAI;IACb;IAEQF,gBACNH,IAAY,EACZM,OAAmD,EACnD;QACA,IAAI,CAACC,aAAa,CAACP,KAAK,GAAGM;QAC3B,OAAO,IAAI;IACb;IAEQE,mBAAmBR,IAAY,EAAE;QACvC,OAAO,IAAI,CAACO,aAAa,CAACP,KAAK;QAC/B,OAAO,IAAI;IACb;IAEAS,QAAQT,IAAY,EAAEI,MAAgC,EAAE;QACtD,MAAME,UAAU,IAAI,CAACC,aAAa,CAACP,KAAK;QAExC,IACErB,OAAO+B,SAAS,CAACC,cAAc,CAACC,IAAI,CAAC,IAAI,CAACL,aAAa,EAAEP,SACzD,OAAOM,YAAY,YACnB;YACAA,QAAQF;QACV;QACA,OAAO,IAAI;IACb;IAEA,OAAOS,YAAYC,KAAqB,EAAE;QACxC,IAAI,CAACzC,SAAS0C,QAAQ,EAAE;YACtB1C,SAAS0C,QAAQ,GAAG,IAAI1C,SAASyC;QACnC;QACA,OAAOzC,SAAS0C,QAAQ;IAC1B;IA9JAC,YAAYF,KAAqB,CAAE;YAcfA;QArCpB3B,uBAAAA,wBAAuB;QAEvBG,uBAAAA,8BAA6B;QAE7B2B,uBAAAA,0BAAyB;QAEzBxC,uBAAAA,OAAe;QAEfQ,uBAAAA,iBAAyB;QAEzBV,uBAAAA,YAA4C,CAAC;QAE7CG,uBAAAA,aAA+B,EAAE;QAEjCG,uBAAAA,iBAAmC,EAAE;QAErCiB,uBAAAA,cAAsC,CAAC;QAEvCS,uBAAAA,iBACE,CAAC;QAKD,IAAI,CAACO,OAAO;QAEZ,MAAM,EACJI,KAAK,EACLC,YAAY,EACZC,kBAAkB,EAClBC,WAAW,EACX5C,GAAG,EACH6C,QAAQ,EACRrC,eAAesC,GAAG,EACnB,GAAGT;QACJ,IAAI,CAACrC,GAAG,GAAGA;QACX,IAAI,CAACQ,aAAa,GAAGsC;QACrB,IAAI,CAACzB,UAAU,GAAGgB,CAAAA,kBAAAA,6BAAAA,yBAAAA,MAAOU,eAAe,cAAtBV,6CAAAA,uBAAwBW,IAAI,KAAI,CAAC;QAEnD,cAAc;QACd,MAAMC,uBAAuB;QAC7B,MAAMC,cAAoC;YACxCT;YACAC;YACAE;YACAK;YACAJ;QACF;QACA,sBAAsB;QACtBM,IAAAA,0BAAU,EAAC,IAAI,CAACzC,oBAAoB,EAAEiC,oBAAoBO;QAE1DC,IAAAA,0BAAU,EACR,IAAI,CAACtC,0BAA0B,EAC/B8B,oBACAO;QAGF,oBAAoB;QACpBC,IAAAA,0BAAU,EAAC,IAAI,CAACX,sBAAsB,EAAEG,oBAAoB;YAC1D,GAAGO,WAAW;YACdN,aAAaA,gBAAgB,SAAS,WAAWA;QACnD;QAEAQ,IAAAA,6BAAa,EAAC;QACd,IAAIpD,KAAK;YACPqD,IAAAA,yBAAS,EAACrD;QACZ;QACA,8BAA8B;QAC9BJ,SAAS0C,QAAQ,GAAG,IAAI;IAC1B;AAiHF;AAjKE,iBAtBW1C,UAsBJ0C,YAAP,KAAA"}

package/dist/cjs/snowplow/contexts.js

@@ -2,27 +2,67 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "getContexts", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    getContexts: function() {
         return getContexts;
+    },
+    makeContexts: function() {
+        return makeContexts;
+    },
+    updateIdentityContext: function() {
+        return updateIdentityContext;
     }
 });
 const _utils = require("../utils");
 const getContexts = (config)=>{
-    const contexts = config && Object.entries(config).filter(([key])=>key.includes("Context") && key !== "includeGAContext").map(([_key, value])=>{
+    // Create an object that only contains Context keys
+    // and snake_case the keys
+    const contextEntries = Object.entries(config || {}).filter(([key])=>key.includes("Context") && key !== "includeGAContext").reduce((acc, [key, value])=>{
         if (typeof value === "object") {
-            return (0, _utils.snakeCaseKeys)({
-                ...value
-            });
+            return {
+                ...acc,
+                [key]: (0, _utils.snakeCaseKeys)({
+                    ...value
+                })
+            };
         }
-        return (0, _utils.snakeCaseKeys)({
-            data: {
-                service_channel_identifier: value
-            }
-        });
+        return {
+            ...acc,
+            [key]: (0, _utils.snakeCaseKeys)({
+                data: {
+                    service_channel_identifier: value
+                }
+            })
+        };
+    }, {});
+    return contextEntries;
+};
+const updateIdentityContext = (contexts, uid)=>{
+    const index = Object.keys(contexts).findIndex((ctx)=>{
+        var _contexts_ctx_schema;
+        return (_contexts_ctx_schema = contexts[ctx].schema) === null || _contexts_ctx_schema === void 0 ? void 0 : _contexts_ctx_schema.includes("identity_context");
     });
+    if (index > -1) {
+        const key = Object.keys(contexts)[index];
+        return {
+            ...contexts,
+            [key]: {
+                ...contexts[key],
+                data: {
+                    ...contexts[key].data,
+                    domain_userid: uid
+                }
+            }
+        };
+    }
     return contexts;
 };
+const makeContexts = (keys, config)=>(keys || []).map((key)=>config[key]);
 
 //# sourceMappingURL=contexts.js.map

package/dist/cjs/snowplow/contexts.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/snowplow/contexts.ts"],"sourcesContent":["import { SelfDescribingJson } from \"@snowplow/browser-tracker\";\nimport { TrackingProps } from \"./types\";\nimport { snakeCaseKeys } from \"../utils\";\n\nexport const getContexts = (\n  config: TrackingProps,\n): SelfDescribingJson<Record<string, unknown>>[] => {\n  const contexts =\n    config &&\n    Object.entries(config)\n      .filter(([key]) => key.includes(\"Context\") && key !== \"includeGAContext\")\n      .map(([_key, value]) => {\n        if (typeof value === \"object\") {\n          return snakeCaseKeys(({ ...value }));\n        }\n        return snakeCaseKeys({ data: { service_channel_identifier: value } });\n      });\n\n  return contexts as unknown as SelfDescribingJson<Record<string, unknown>>[];\n};\n"],"names":["getContexts","config","contexts","Object","entries","filter","key","includes","map","_key","value","snakeCaseKeys","data","service_channel_identifier"],"mappings":";;;;+BAIaA;;;eAAAA;;;uBAFiB;AAEvB,MAAMA,cAAc,CACzBC;IAEA,MAAMC,WACJD,UACAE,OAAOC,OAAO,CAACH,QACZI,MAAM,CAAC,CAAC,CAACC,IAAI,GAAKA,IAAIC,QAAQ,CAAC,cAAcD,QAAQ,oBACrDE,GAAG,CAAC,CAAC,CAACC,MAAMC,MAAM;QACjB,IAAI,OAAOA,UAAU,UAAU;YAC7B,OAAOC,IAAAA,oBAAa,EAAE;gBAAE,GAAGD,KAAK;YAAC;QACnC;QACA,OAAOC,IAAAA,oBAAa,EAAC;YAAEC,MAAM;gBAAEC,4BAA4BH;YAAM;QAAE;IACrE;IAEJ,OAAOR;AACT"}
+{"version":3,"sources":["../../../src/snowplow/contexts.ts"],"sourcesContent":["import { snakeCaseKeys } from \"../utils\";\nimport { SerialisedEvent, TrackingProps } from \"./types\";\n\nexport const getContexts = (\n  config: TrackingProps,\n): Record<string, SerialisedEvent> => {\n  // Create an object that only contains Context keys\n  // and snake_case the keys\n  const contextEntries = Object.entries(config || {})\n    .filter(([key]) => key.includes(\"Context\") && key !== \"includeGAContext\")\n    .reduce((acc, [key, value]) => {\n      if (typeof value === \"object\") {\n        return { ...acc, [key]: snakeCaseKeys({ ...value }) };\n      }\n      return {\n        ...acc,\n        [key]: snakeCaseKeys({ data: { service_channel_identifier: value } }),\n      };\n    }, {});\n\n  return contextEntries as Record<string, SerialisedEvent>;\n};\n\nexport const updateIdentityContext = (\n  contexts: Record<string, SerialisedEvent>,\n  uid: unknown,\n): Record<string, SerialisedEvent> => {\n  const index = Object.keys(contexts).findIndex(ctx =>\n    contexts[ctx].schema?.includes(\"identity_context\"),\n  );\n  if (index > -1) {\n    const key = Object.keys(contexts)[index];\n    return {\n      ...contexts,\n      [key]: {\n        ...contexts[key],\n        data: {\n          ...contexts[key].data,\n          domain_userid: uid,\n        },\n      },\n    };\n  }\n  return contexts;\n};\n\nexport const makeContexts = (\n  keys: string[],\n  config: Record<string, SerialisedEvent>,\n): SerialisedEvent[] => (keys || []).map(key => config[key]);\n"],"names":["getContexts","makeContexts","updateIdentityContext","config","contextEntries","Object","entries","filter","key","includes","reduce","acc","value","snakeCaseKeys","data","service_channel_identifier","contexts","uid","index","keys","findIndex","ctx","schema","domain_userid","map"],"mappings":";;;;;;;;;;;IAGaA,WAAW;eAAXA;;IA2CAC,YAAY;eAAZA;;IAvBAC,qBAAqB;eAArBA;;;uBAvBiB;AAGvB,MAAMF,cAAc,CACzBG;IAEA,mDAAmD;IACnD,0BAA0B;IAC1B,MAAMC,iBAAiBC,OAAOC,OAAO,CAACH,UAAU,CAAC,GAC9CI,MAAM,CAAC,CAAC,CAACC,IAAI,GAAKA,IAAIC,QAAQ,CAAC,cAAcD,QAAQ,oBACrDE,MAAM,CAAC,CAACC,KAAK,CAACH,KAAKI,MAAM;QACxB,IAAI,OAAOA,UAAU,UAAU;YAC7B,OAAO;gBAAE,GAAGD,GAAG;gBAAE,CAACH,IAAI,EAAEK,IAAAA,oBAAa,EAAC;oBAAE,GAAGD,KAAK;gBAAC;YAAG;QACtD;QACA,OAAO;YACL,GAAGD,GAAG;YACN,CAACH,IAAI,EAAEK,IAAAA,oBAAa,EAAC;gBAAEC,MAAM;oBAAEC,4BAA4BH;gBAAM;YAAE;QACrE;IACF,GAAG,CAAC;IAEN,OAAOR;AACT;AAEO,MAAMF,wBAAwB,CACnCc,UACAC;IAEA,MAAMC,QAAQb,OAAOc,IAAI,CAACH,UAAUI,SAAS,CAACC,CAAAA;YAC5CL;gBAAAA,uBAAAA,QAAQ,CAACK,IAAI,CAACC,MAAM,cAApBN,2CAAAA,qBAAsBP,QAAQ,CAAC;;IAEjC,IAAIS,QAAQ,CAAC,GAAG;QACd,MAAMV,MAAMH,OAAOc,IAAI,CAACH,SAAS,CAACE,MAAM;QACxC,OAAO;YACL,GAAGF,QAAQ;YACX,CAACR,IAAI,EAAE;gBACL,GAAGQ,QAAQ,CAACR,IAAI;gBAChBM,MAAM;oBACJ,GAAGE,QAAQ,CAACR,IAAI,CAACM,IAAI;oBACrBS,eAAeN;gBACjB;YACF;QACF;IACF;IACA,OAAOD;AACT;AAEO,MAAMf,eAAe,CAC1BkB,MACAhB,SACsB,AAACgB,CAAAA,QAAQ,EAAE,AAAD,EAAGK,GAAG,CAAChB,CAAAA,MAAOL,MAAM,CAACK,IAAI"}

package/dist/cjs/snowplow/event-definitions/index.js

@@ -15,6 +15,9 @@ _export(exports, {
     interventionPageEvents: function() {
         return interventionPageEvents;
     },
+    personalisedCoverPageEvents: function() {
+        return personalisedCoverPageEvents;
+    },
     qcpPageEvents: function() {
         return qcpPageEvents;
     },
@@ -30,12 +33,14 @@ const _qcp = require("./qcp");
 const _referral = require("./referral");
 const _intervention = require("./intervention");
 const _questionnaire = require("./questionnaire");
+const _personalised_cover = require("./personalised_cover");
 const eventDefinitions = [
     ..._base.baseEventDefinitions,
     ..._qcp.qcpEventDefinitions,
     ..._referral.referralEventDefinitions,
     ..._intervention.interventionEventDefinitions,
-    ..._questionnaire.questionnaireEventDefinitions
+    ..._questionnaire.questionnaireEventDefinitions,
+    ..._personalised_cover.personalisedCoverEventDefinitions
 ];
 const qcpPageEvents = [
     ..._base.baseEventDefinitions,
@@ -45,6 +50,10 @@ const referralPageEvents = [
     ..._base.baseEventDefinitions,
     ..._referral.referralEventDefinitions
 ];
+const personalisedCoverPageEvents = [
+    ..._base.baseEventDefinitions,
+    ..._personalised_cover.personalisedCoverEventDefinitions
+];
 const interventionPageEvents = [
     ..._intervention.interventionEventDefinitions
 ];

package/dist/cjs/snowplow/event-definitions/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/index.ts"],"sourcesContent":["import { baseEventDefinitions } from \"./base\";\nimport { qcpEventDefinitions } from \"./qcp\";\nimport { referralEventDefinitions } from \"./referral\";\nimport { interventionEventDefinitions } from \"./intervention\";\nimport { questionnaireEventDefinitions } from \"./questionnaire\";\n\n// All events (keep up to date with new files)\nexport const eventDefinitions = [\n  ...baseEventDefinitions,\n  ...qcpEventDefinitions,\n  ...referralEventDefinitions,\n  ...interventionEventDefinitions,\n  ...questionnaireEventDefinitions,\n];\n\nexport const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];\n\nexport const referralPageEvents = [\n  ...baseEventDefinitions,\n  ...referralEventDefinitions,\n];\n\nexport const interventionPageEvents = [...interventionEventDefinitions];\n\nexport type { InterventionPayload } from \"./intervention\";\n\nexport const questionnairePageEvents = [...questionnaireEventDefinitions];\n\n// Create a new export for each kind of page below\n// containing just the subset needed for that page\n"],"names":["eventDefinitions","interventionPageEvents","qcpPageEvents","questionnairePageEvents","referralPageEvents","baseEventDefinitions","qcpEventDefinitions","referralEventDefinitions","interventionEventDefinitions","questionnaireEventDefinitions"],"mappings":";;;;;;;;;;;IAOaA,gBAAgB;eAAhBA;;IAeAC,sBAAsB;eAAtBA;;IAPAC,aAAa;eAAbA;;IAWAC,uBAAuB;eAAvBA;;IATAC,kBAAkB;eAAlBA;;;sBAjBwB;qBACD;0BACK;8BACI;+BACC;AAGvC,MAAMJ,mBAAmB;OAC3BK,0BAAoB;OACpBC,wBAAmB;OACnBC,kCAAwB;OACxBC,0CAA4B;OAC5BC,4CAA6B;CACjC;AAEM,MAAMP,gBAAgB;OAAIG,0BAAoB;OAAKC,wBAAmB;CAAC;AAEvE,MAAMF,qBAAqB;OAC7BC,0BAAoB;OACpBE,kCAAwB;CAC5B;AAEM,MAAMN,yBAAyB;OAAIO,0CAA4B;CAAC;AAIhE,MAAML,0BAA0B;OAAIM,4CAA6B;CAAC,EAEzE,kDAAkD;CAClD,kDAAkD"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/index.ts"],"sourcesContent":["import { baseEventDefinitions } from \"./base\";\nimport { qcpEventDefinitions } from \"./qcp\";\nimport { referralEventDefinitions } from \"./referral\";\nimport { interventionEventDefinitions } from \"./intervention\";\nimport { questionnaireEventDefinitions } from \"./questionnaire\";\nimport { personalisedCoverEventDefinitions } from \"./personalised_cover\";\n\n// All events (keep up to date with new files)\nexport const eventDefinitions = [\n  ...baseEventDefinitions,\n  ...qcpEventDefinitions,\n  ...referralEventDefinitions,\n  ...interventionEventDefinitions,\n  ...questionnaireEventDefinitions,\n  ...personalisedCoverEventDefinitions,\n];\n\nexport const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];\n\nexport const referralPageEvents = [\n  ...baseEventDefinitions,\n  ...referralEventDefinitions,\n];\n\nexport const personalisedCoverPageEvents = [\n  ...baseEventDefinitions,\n  ...personalisedCoverEventDefinitions,\n];\n\nexport const interventionPageEvents = [...interventionEventDefinitions];\n\nexport type { InterventionPayload } from \"./intervention\";\n\nexport const questionnairePageEvents = [...questionnaireEventDefinitions];\n\n// Create a new export for each kind of page below\n// containing just the subset needed for that page\n"],"names":["eventDefinitions","interventionPageEvents","personalisedCoverPageEvents","qcpPageEvents","questionnairePageEvents","referralPageEvents","baseEventDefinitions","qcpEventDefinitions","referralEventDefinitions","interventionEventDefinitions","questionnaireEventDefinitions","personalisedCoverEventDefinitions"],"mappings":";;;;;;;;;;;IAQaA,gBAAgB;eAAhBA;;IAqBAC,sBAAsB;eAAtBA;;IALAC,2BAA2B;eAA3BA;;IAPAC,aAAa;eAAbA;;IAgBAC,uBAAuB;eAAvBA;;IAdAC,kBAAkB;eAAlBA;;;sBAnBwB;qBACD;0BACK;8BACI;+BACC;oCACI;AAG3C,MAAML,mBAAmB;OAC3BM,0BAAoB;OACpBC,wBAAmB;OACnBC,kCAAwB;OACxBC,0CAA4B;OAC5BC,4CAA6B;OAC7BC,qDAAiC;CACrC;AAEM,MAAMR,gBAAgB;OAAIG,0BAAoB;OAAKC,wBAAmB;CAAC;AAEvE,MAAMF,qBAAqB;OAC7BC,0BAAoB;OACpBE,kCAAwB;CAC5B;AAEM,MAAMN,8BAA8B;OACtCI,0BAAoB;OACpBK,qDAAiC;CACrC;AAEM,MAAMV,yBAAyB;OAAIQ,0CAA4B;CAAC;AAIhE,MAAML,0BAA0B;OAAIM,4CAA6B;CAAC,EAEzE,kDAAkD;CAClD,kDAAkD"}

package/dist/cjs/snowplow/event-definitions/personalised_cover.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "personalisedCoverEventDefinitions", {
+    enumerable: true,
+    get: function() {
+        return personalisedCoverEventDefinitions;
+    }
+});
+const _redaction = require("./redaction");
+const _constants = require("../constants");
+const _utils = require("../../utils");
+const personalisedCoverEventDefinitions = [
+    {
+        name: "seeMoreClicked",
+        type: "structured",
+        makePayload: (_)=>({
+                category: "personalised_cover",
+                action: "see_more_clicked",
+                label: "page",
+                property: "personalised_cover"
+            })
+    },
+    {
+        name: "selectPackageClicked",
+        type: "structured",
+        makePayload: (_)=>({
+                category: "personalised_cover",
+                action: "select_package_clicked",
+                label: "page",
+                property: "personalised_cover"
+            })
+    },
+    {
+        name: "validationShown",
+        type: "structured",
+        makePayload: (params)=>{
+            const { cover, question } = params;
+            return {
+                category: "personalised_cover",
+                action: "validation_shown",
+                label: "cover_question",
+                property: `${(0, _utils.snakeCase)(cover)}_${(0, _utils.snakeCase)(question)}`
+            };
+        }
+    },
+    {
+        name: "coverQuestionAnswered",
+        type: "unstructured",
+        makePayload: (params)=>{
+            const { context } = params;
+            const { question, answer } = (0, _redaction.redact)(params);
+            // Flatten the answer to a delimited string
+            const flatAnswer = Array.isArray(answer) ? answer.join(_constants.DELIMITER) : answer;
+            return {
+                schema: "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-1",
+                data: {
+                    site: context.site,
+                    page_name: "personalised_cover",
+                    section_name: "Personalised Cover Questions",
+                    question,
+                    answer: flatAnswer
+                }
+            };
+        }
+    },
+    {
+        name: "limitLinkClicked",
+        type: "structured",
+        makePayload: (params)=>{
+            const { label } = params;
+            return {
+                category: "personalised_cover",
+                action: "limit_link_clicked",
+                label,
+                property: "link_clicked"
+            };
+        }
+    },
+    {
+        name: "limitChanged",
+        type: "structured",
+        makePayload: (params)=>{
+            const { label, limit } = params;
+            return {
+                category: "personalised_cover",
+                action: "limit_changed",
+                label,
+                property: limit
+            };
+        }
+    },
+    {
+        name: "coverPresented",
+        type: "structured",
+        makePayload: (params)=>{
+            const { property } = params;
+            return {
+                category: "personalised_cover",
+                action: "cover_presented",
+                label: "cover_name",
+                property
+            };
+        }
+    },
+    {
+        name: "moreInfoClicked",
+        type: "structured",
+        makePayload: (params)=>{
+            const { property } = params;
+            return {
+                category: "personalised_cover",
+                action: "more_info_clicked",
+                label: "cover_name",
+                property
+            };
+        }
+    }
+];
+
+//# sourceMappingURL=personalised_cover.js.map

package/dist/cjs/snowplow/event-definitions/personalised_cover.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/personalised_cover.ts"],"sourcesContent":["import { EventDefinition, ParamsType } from \"../types\";\nimport { redact } from \"./redaction\";\nimport { DELIMITER } from \"../constants\";\nimport { snakeCase } from \"../../utils\";\n\n/**\n * Event definitions for Snowplow\n * @type {EventDefinition[]}\n * @property {string} name - The name of the event, to use when triggering\n * @property {string} type - The type of the event (structured | unstructured)\n * @property {makePayload} makePayload\n *   - Function that creates the payload for the event;\n *   - Allows optional params object to be passed in\n *\n * @example\n * Parent\n * import { getSnowplowConfig, SnowplowProvider } from \"@simplybusiness/services\";\n * const snowplowProps = getSnowplowConfig(pageData);\n * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>\n *\n * Child\n * import { useSnowplowContext } from \"@simplybusiness/services\";\n * const { snowplow } = useSnowplowContext();\n * const handlerFunction = () => snowplow?.trigger(\"eventNameHere\");\n */\n\nexport const personalisedCoverEventDefinitions: EventDefinition[] = [\n  {\n    name: \"seeMoreClicked\",\n    type: \"structured\",\n    makePayload: _ => ({\n      category: \"personalised_cover\",\n      action: \"see_more_clicked\",\n      label: \"page\",\n      property: \"personalised_cover\",\n    }),\n  },\n  {\n    name: \"selectPackageClicked\",\n    type: \"structured\",\n    makePayload: _ => ({\n      category: \"personalised_cover\",\n      action: \"select_package_clicked\",\n      label: \"page\",\n      property: \"personalised_cover\",\n    }),\n  },\n  {\n    name: \"validationShown\",\n    type: \"structured\",\n    makePayload: params => {\n      const { cover, question } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"validation_shown\",\n        label: \"cover_question\",\n        property: `${snakeCase(cover)}_${snakeCase(question)}`,\n      };\n    },\n  },\n  {\n    name: \"coverQuestionAnswered\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { context } = params as ParamsType;\n      const { question, answer } = redact(params as ParamsType);\n      // Flatten the answer to a delimited string\n      const flatAnswer = Array.isArray(answer)\n        ? answer.join(DELIMITER)\n        : answer;\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-1\",\n        data: {\n          site: context.site,\n          page_name: \"personalised_cover\",\n          section_name: \"Personalised Cover Questions\",\n          question,\n          answer: flatAnswer,\n        },\n      };\n    },\n  },\n  {\n    name: \"limitLinkClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"limit_link_clicked\",\n        label,\n        property: \"link_clicked\",\n      };\n    },\n  },\n  {\n    name: \"limitChanged\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label, limit } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"limit_changed\",\n        label,\n        property: limit,\n      };\n    },\n  },\n  {\n    name: \"coverPresented\",\n    type: \"structured\",\n    makePayload: params => {\n      const { property } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"cover_presented\",\n        label: \"cover_name\",\n        property,\n      };\n    },\n  },\n  {\n    name: \"moreInfoClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { property } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"more_info_clicked\",\n        label: \"cover_name\",\n        property,\n      };\n    },\n  },\n];\n"],"names":["personalisedCoverEventDefinitions","name","type","makePayload","_","category","action","label","property","params","cover","question","snakeCase","context","answer","redact","flatAnswer","Array","isArray","join","DELIMITER","schema","data","site","page_name","section_name","limit"],"mappings":";;;;+BA0BaA;;;eAAAA;;;2BAzBU;2BACG;uBACA;AAuBnB,MAAMA,oCAAuD;IAClE;QACEC,MAAM;QACNC,MAAM;QACNC,aAAaC,CAAAA,IAAM,CAAA;gBACjBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAU;YACZ,CAAA;IACF;IACA;QACEP,MAAM;QACNC,MAAM;QACNC,aAAaC,CAAAA,IAAM,CAAA;gBACjBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAU;YACZ,CAAA;IACF;IACA;QACEP,MAAM;QACNC,MAAM;QACNC,aAAaM,CAAAA;YACX,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAE,GAAGF;YAE5B,OAAO;gBACLJ,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAU,GAAGI,IAAAA,gBAAS,EAACF,OAAO,CAAC,EAAEE,IAAAA,gBAAS,EAACD,WAAW;YACxD;QACF;IACF;IACA;QACEV,MAAM;QACNC,MAAM;QACNC,aAAaM,CAAAA;YACX,MAAM,EAAEI,OAAO,EAAE,GAAGJ;YACpB,MAAM,EAAEE,QAAQ,EAAEG,MAAM,EAAE,GAAGC,IAAAA,iBAAM,EAACN;YACpC,2CAA2C;YAC3C,MAAMO,aAAaC,MAAMC,OAAO,CAACJ,UAC7BA,OAAOK,IAAI,CAACC,oBAAS,IACrBN;YAEJ,OAAO;gBACLO,QACE;gBACFC,MAAM;oBACJC,MAAMV,QAAQU,IAAI;oBAClBC,WAAW;oBACXC,cAAc;oBACdd;oBACAG,QAAQE;gBACV;YACF;QACF;IACF;IACA;QACEf,MAAM;QACNC,MAAM;QACNC,aAAaM,CAAAA;YACX,MAAM,EAAEF,KAAK,EAAE,GAAGE;YAElB,OAAO;gBACLJ,UAAU;gBACVC,QAAQ;gBACRC;gBACAC,UAAU;YACZ;QACF;IACF;IACA;QACEP,MAAM;QACNC,MAAM;QACNC,aAAaM,CAAAA;YACX,MAAM,EAAEF,KAAK,EAAEmB,KAAK,EAAE,GAAGjB;YAEzB,OAAO;gBACLJ,UAAU;gBACVC,QAAQ;gBACRC;gBACAC,UAAUkB;YACZ;QACF;IACF;IACA;QACEzB,MAAM;QACNC,MAAM;QACNC,aAAaM,CAAAA;YACX,MAAM,EAAED,QAAQ,EAAE,GAAGC;YAErB,OAAO;gBACLJ,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC;YACF;QACF;IACF;IACA;QACEP,MAAM;QACNC,MAAM;QACNC,aAAaM,CAAAA;YACX,MAAM,EAAED,QAAQ,EAAE,GAAGC;YAErB,OAAO;gBACLJ,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC;YACF;QACF;IACF;CACD"}

package/dist/cjs/snowplow/event-definitions/qcp.js

@@ -118,7 +118,10 @@ const qcpEventDefinitions = [
                     to_value: toValue
                 }
             };
-        }
+        },
+        contexts: [
+            "distributionChannelContext"
+        ]
     },
     {
         name: "ratingsModalOpened",
@@ -221,7 +224,10 @@ const qcpEventDefinitions = [
                     vertical
                 }
             };
-        }
+        },
+        contexts: [
+            "serviceChannelContext"
+        ]
     },
     {
         name: "helpChatLinkClicked",