@simplybusiness/services 0.2.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.3.0
+
+### Minor Changes
+
+- c801be9: **Breaking change** - Rename all `ThankYou` components to `Referral`
+
+### Patch Changes
+
+- 45e9667: Add `<EditLimits>` to `<HeadlineExperimentIteratedQCP>`
+- Updated dependencies [d1d1631]
+- Updated dependencies [5979683]
+- Updated dependencies [45e9667]
+  - @simplybusiness/mobius@4.16.0
+
 ## 0.2.1
 
 ### Patch Changes

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/base.ts"],"sourcesContent":["import { EventDefinition } from \"../types\";\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 * import { Snowplow } from \"./Snowplow\";\n * import { eventDefinitions } from \"./event-definitions\";\n *\n * const snowplow = new Snowplow();\n * snowplow.addEventHandlers(eventDefinitions);\n */\n\n// Base page events\nexport const baseEventDefinitions: EventDefinition[] = [\n  // Mobile link in header\n  {\n    name: \"mobileLinkClick\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"marketing\",\n      action: \"link-click\",\n      label: \"mobile_call_button\",\n      property: window.location.href,\n    }),\n  },\n  // Operating hours link in footer\n  {\n    name: \"operatingHoursClick\",\n    type: \"unstructured\",\n    makePayload: () => ({\n      schema:\n        \"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0\",\n      data: {\n        schema:\n          \"iglu:com.simplybusiness/operating_hours_clicked/jsonschema/1-0-2\",\n        data: {},\n      },\n    }),\n  },\n];\n"],"names":["baseEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","schema","data"],"mappings":";;;;+BAoBaA;;;eAAAA;;;AAAN,MAAMA,uBAA0C;IACrD,wBAAwB;IACxB;QACEC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA,iCAAiC;IACjC;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBQ,QACE;gBACFC,MAAM;oBACJD,QACE;oBACFC,MAAM,CAAC;gBACT;YACF,CAAA;IACF;CACD"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/base.ts"],"sourcesContent":["import { EventDefinition } from \"../types\";\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\n// Base page events\nexport const baseEventDefinitions: EventDefinition[] = [\n  // Mobile link in header\n  {\n    name: \"mobileLinkClick\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"marketing\",\n      action: \"link-click\",\n      label: \"mobile_call_button\",\n      property: window.location.href,\n    }),\n  },\n  // Operating hours link in footer\n  {\n    name: \"operatingHoursClick\",\n    type: \"unstructured\",\n    makePayload: () => ({\n      schema:\n        \"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0\",\n      data: {\n        schema:\n          \"iglu:com.simplybusiness/operating_hours_clicked/jsonschema/1-0-2\",\n        data: {},\n      },\n    }),\n  },\n];\n"],"names":["baseEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","schema","data"],"mappings":";;;;+BAwBaA;;;eAAAA;;;AAAN,MAAMA,uBAA0C;IACrD,wBAAwB;IACxB;QACEC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA,iCAAiC;IACjC;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBQ,QACE;gBACFC,MAAM;oBACJD,QACE;oBACFC,MAAM,CAAC;gBACT;YACF,CAAA;IACF;CACD"}

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

@@ -15,25 +15,25 @@ _export(exports, {
     qcpPageEvents: function() {
         return qcpPageEvents;
     },
-    thankYouPageEvents: function() {
-        return thankYouPageEvents;
+    referralPageEvents: function() {
+        return referralPageEvents;
     }
 });
 const _base = require("./base");
 const _qcp = require("./qcp");
-const _thankYou = require("./thankYou");
+const _referral = require("./referral");
 const eventDefinitions = [
     ..._base.baseEventDefinitions,
     ..._qcp.qcpEventDefinitions,
-    ..._thankYou.thankYouEventDefinitions
+    ..._referral.referralEventDefinitions
 ];
 const qcpPageEvents = [
     ..._base.baseEventDefinitions,
     ..._qcp.qcpEventDefinitions
 ];
-const thankYouPageEvents = [
+const referralPageEvents = [
     ..._base.baseEventDefinitions,
-    ..._thankYou.thankYouEventDefinitions
+    ..._referral.referralEventDefinitions
 ]; // Create a new export for each kind of page below
  // containing just the subset needed for that page
 

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 { thankYouEventDefinitions } from \"./thankYou\";\n\n// All events (keep up to date with new files)\nexport const eventDefinitions = [\n  ...baseEventDefinitions,\n  ...qcpEventDefinitions,\n  ...thankYouEventDefinitions,\n];\n\nexport const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];\n\nexport const thankYouPageEvents = [\n  ...baseEventDefinitions,\n  ...thankYouEventDefinitions,\n];\n\n// Create a new export for each kind of page below\n// containing just the subset needed for that page\n"],"names":["eventDefinitions","qcpPageEvents","thankYouPageEvents","baseEventDefinitions","qcpEventDefinitions","thankYouEventDefinitions"],"mappings":";;;;;;;;;;;IAKaA,gBAAgB;eAAhBA;;IAMAC,aAAa;eAAbA;;IAEAC,kBAAkB;eAAlBA;;;sBAbwB;qBACD;0BACK;AAGlC,MAAMF,mBAAmB;OAC3BG,0BAAoB;OACpBC,wBAAmB;OACnBC,kCAAwB;CAC5B;AAEM,MAAMJ,gBAAgB;OAAIE,0BAAoB;OAAKC,wBAAmB;CAAC;AAEvE,MAAMF,qBAAqB;OAC7BC,0BAAoB;OACpBE,kCAAwB;CAC5B,EAED,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\";\n\n// All events (keep up to date with new files)\nexport const eventDefinitions = [\n  ...baseEventDefinitions,\n  ...qcpEventDefinitions,\n  ...referralEventDefinitions,\n];\n\nexport const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];\n\nexport const referralPageEvents = [\n  ...baseEventDefinitions,\n  ...referralEventDefinitions,\n];\n\n// Create a new export for each kind of page below\n// containing just the subset needed for that page\n"],"names":["eventDefinitions","qcpPageEvents","referralPageEvents","baseEventDefinitions","qcpEventDefinitions","referralEventDefinitions"],"mappings":";;;;;;;;;;;IAKaA,gBAAgB;eAAhBA;;IAMAC,aAAa;eAAbA;;IAEAC,kBAAkB;eAAlBA;;;sBAbwB;qBACD;0BACK;AAGlC,MAAMF,mBAAmB;OAC3BG,0BAAoB;OACpBC,wBAAmB;OACnBC,kCAAwB;CAC5B;AAEM,MAAMJ,gBAAgB;OAAIE,0BAAoB;OAAKC,wBAAmB;CAAC;AAEvE,MAAMF,qBAAqB;OAC7BC,0BAAoB;OACpBE,kCAAwB;CAC5B,EAED,kDAAkD;CAClD,kDAAkD"}

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/qcp.ts"],"sourcesContent":["import { snakeCase } from \"../../utils\";\nimport { EventDefinition, ParamsType } from \"../types\";\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 * import { Snowplow } from \"./Snowplow\";\n * import { eventDefinitions } from \"./event-definitions\";\n *\n * const snowplow = new Snowplow();\n * snowplow.addEventHandlers(eventDefinitions);\n */\n\n// QCP page events\nexport const qcpEventDefinitions: EventDefinition[] = [\n  {\n    // QDP details button\n    name: \"detailsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Details\",\n    }),\n  },\n  {\n    // Buy button\n    name: \"selectClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Select\",\n    }),\n  },\n  {\n    // Quote Details Slider Next steps button\n    name: \"nextStepsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_next_step_cta\",\n      action: \"link_click\",\n      label: \"Next steps\",\n    }),\n  },\n  {\n    // Toggle deductibles accordion\n    name: \"deductiblesClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"us-qcp-react\",\n      action: \"view_deductables_clicked\",\n      label: \"view_deductables_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"deductiblesClickedUk\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label, deviceType } = params as ParamsType;\n      const urlFriendlyLabel = label.replace(/ /g, \"-\").toLowerCase();\n\n      return {\n        category: `uk-qcp-react-${deviceType}-${urlFriendlyLabel}-view-excess-toggle`,\n        action: \"view_excess_clicked\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Quote Details Slider opened\n    name: \"sliderOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label } = params as ParamsType;\n\n      return {\n        category: \"comparison_cta\",\n        action: \"quote_details_slider_opened\",\n        label,\n      };\n    },\n  },\n  {\n    // Coverage modal opened\n    name: \"coverageModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const {\n        category,\n        product = \"extra_coverage\",\n        title,\n      } = params as ParamsType;\n      const productLabel = snakeCase(product);\n\n      return {\n        category,\n        action: `${productLabel}_${snakeCase(title)}_popup_opened`,\n        label: productLabel,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Toggle cover select\n    name: \"coverChanged\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { name = \"\", fromValue = \"\", toValue = \"\" } = params as ParamsType;\n      // Derive data\n      let action = \"change\";\n\n      // This logic is taken directly from Chopin without documentation:\n      // If a cover has zero value, then change the action to add or remove\n      if (fromValue === \"0\") {\n        action = \"add\";\n      }\n      if (toValue === \"0\") {\n        action = \"remove\";\n      }\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/comparison_page_cover_changed/jsonschema/1-0-0\",\n        data: {\n          name,\n          action,\n          from_value: fromValue,\n          to_value: toValue,\n        },\n      };\n    },\n  },\n  {\n    name: \"ratingsModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"insurer_rating_help_popup_triggered\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"coverToggleOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"qcp_limit_interaction\",\n      label: \"limit_interaction\",\n      action: \"limit_interaction_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"paymentToggleClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"button_click\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"insurerDetailsAccordionClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_insurer_details_description\",\n      action: \"accordion_clicked\",\n      label: \"accordion_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"priceDetailsPopUpOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"price_details\",\n      action: \"price_details_popup_opened\",\n      label: \"Price details\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"editLimitButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"edit_limit_button_clicked\",\n      label: \"Edit Limit\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"applyButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"apply_button_clicked\",\n      label: \"Apply Button Clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"coverageInfoClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { deviceType } = params as ParamsType;\n\n      return {\n        action: \"show_coverage_info_clicked\",\n        category: `uk-qcp-react-${deviceType}-show-coverage-info-toggle`,\n        label: \"show_coverage_info_clicked\",\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"backToApplication\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { journeyId, vertical } = params as ParamsType;\n\n      return {\n        schema: \"iglu:com.simplybusiness/back_to_application/jsonschema/1-0-0\",\n        data: {\n          journey_id: journeyId,\n          vertical,\n        },\n      };\n    },\n  },\n];\n"],"names":["qcpEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","params","deviceType","urlFriendlyLabel","replace","toLowerCase","product","title","productLabel","snakeCase","fromValue","toValue","schema","data","from_value","to_value","journeyId","vertical","journey_id"],"mappings":";;;;+BAqBaA;;;eAAAA;;;uBArBa;AAqBnB,MAAMA,sBAAyC;IACpD;QACE,qBAAqB;QACrBC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,aAAa;QACbL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,yCAAyC;QACzCL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,+BAA+B;QAC/BL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAEM,UAAU,EAAE,GAAGD;YAC9B,MAAME,mBAAmBP,MAAMQ,OAAO,CAAC,MAAM,KAAKC,WAAW;YAE7D,OAAO;gBACLX,UAAU,CAAC,aAAa,EAAEQ,WAAW,CAAC,EAAEC,iBAAiB,mBAAmB,CAAC;gBAC7ER,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,8BAA8B;QAC9BT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAE,GAAGK;YAElB,OAAO;gBACLP,UAAU;gBACVC,QAAQ;gBACRC;YACF;QACF;IACF;IACA;QACE,wBAAwB;QACxBL,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EACJP,QAAQ,EACRY,UAAU,gBAAgB,EAC1BC,KAAK,EACN,GAAGN;YACJ,MAAMO,eAAeC,IAAAA,gBAAS,EAACH;YAE/B,OAAO;gBACLZ;gBACAC,QAAQ,CAAC,EAAEa,aAAa,CAAC,EAAEC,IAAAA,gBAAS,EAACF,OAAO,aAAa,CAAC;gBAC1DX,OAAOY;gBACPX,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,sBAAsB;QACtBT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEV,OAAO,EAAE,EAAEmB,YAAY,EAAE,EAAEC,UAAU,EAAE,EAAE,GAAGV;YACpD,cAAc;YACd,IAAIN,SAAS;YAEb,kEAAkE;YAClE,qEAAqE;YACrE,IAAIe,cAAc,KAAK;gBACrBf,SAAS;YACX;YACA,IAAIgB,YAAY,KAAK;gBACnBhB,SAAS;YACX;YAEA,OAAO;gBACLiB,QACE;gBACFC,MAAM;oBACJtB;oBACAI;oBACAmB,YAAYJ;oBACZK,UAAUJ;gBACZ;YACF;QACF;IACF;IACA;QACEpB,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVE,OAAO;gBACPD,QAAQ;gBACRE,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEC,UAAU,EAAE,GAAGD;YAEvB,OAAO;gBACLN,QAAQ;gBACRD,UAAU,CAAC,aAAa,EAAEQ,WAAW,0BAA0B,CAAC;gBAChEN,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEe,SAAS,EAAEC,QAAQ,EAAE,GAAGhB;YAEhC,OAAO;gBACLW,QAAQ;gBACRC,MAAM;oBACJK,YAAYF;oBACZC;gBACF;YACF;QACF;IACF;CACD"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/qcp.ts"],"sourcesContent":["import { snakeCase } from \"../../utils\";\nimport { EventDefinition, ParamsType } from \"../types\";\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\n// QCP page events\nexport const qcpEventDefinitions: EventDefinition[] = [\n  {\n    // QDP details button\n    name: \"detailsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Details\",\n    }),\n  },\n  {\n    // Buy button\n    name: \"selectClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Select\",\n    }),\n  },\n  {\n    // Quote Details Slider Next steps button\n    name: \"nextStepsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_next_step_cta\",\n      action: \"link_click\",\n      label: \"Next steps\",\n    }),\n  },\n  {\n    // Toggle deductibles accordion\n    name: \"deductiblesClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"us-qcp-react\",\n      action: \"view_deductables_clicked\",\n      label: \"view_deductables_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"deductiblesClickedUk\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label, deviceType } = params as ParamsType;\n      const urlFriendlyLabel = label.replace(/ /g, \"-\").toLowerCase();\n\n      return {\n        category: `uk-qcp-react-${deviceType}-${urlFriendlyLabel}-view-excess-toggle`,\n        action: \"view_excess_clicked\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Quote Details Slider opened\n    name: \"sliderOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label } = params as ParamsType;\n\n      return {\n        category: \"comparison_cta\",\n        action: \"quote_details_slider_opened\",\n        label,\n      };\n    },\n  },\n  {\n    // Coverage modal opened\n    name: \"coverageModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const {\n        category,\n        product = \"extra_coverage\",\n        title,\n      } = params as ParamsType;\n      const productLabel = snakeCase(product);\n\n      return {\n        category,\n        action: `${productLabel}_${snakeCase(title)}_popup_opened`,\n        label: productLabel,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Toggle cover select\n    name: \"coverChanged\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { name = \"\", fromValue = \"\", toValue = \"\" } = params as ParamsType;\n      // Derive data\n      let action = \"change\";\n\n      // This logic is taken directly from Chopin without documentation:\n      // If a cover has zero value, then change the action to add or remove\n      if (fromValue === \"0\") {\n        action = \"add\";\n      }\n      if (toValue === \"0\") {\n        action = \"remove\";\n      }\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/comparison_page_cover_changed/jsonschema/1-0-0\",\n        data: {\n          name,\n          action,\n          from_value: fromValue,\n          to_value: toValue,\n        },\n      };\n    },\n  },\n  {\n    name: \"ratingsModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"insurer_rating_help_popup_triggered\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"coverToggleOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"qcp_limit_interaction\",\n      label: \"limit_interaction\",\n      action: \"limit_interaction_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"paymentToggleClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"button_click\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"insurerDetailsAccordionClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_insurer_details_description\",\n      action: \"accordion_clicked\",\n      label: \"accordion_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"priceDetailsPopUpOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"price_details\",\n      action: \"price_details_popup_opened\",\n      label: \"Price details\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"editLimitButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"edit_limit_button_clicked\",\n      label: \"Edit Limit\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"applyButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"apply_button_clicked\",\n      label: \"Apply Button Clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"coverageInfoClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { deviceType } = params as ParamsType;\n\n      return {\n        action: \"show_coverage_info_clicked\",\n        category: `uk-qcp-react-${deviceType}-show-coverage-info-toggle`,\n        label: \"show_coverage_info_clicked\",\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"backToApplication\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { journeyId, vertical } = params as ParamsType;\n\n      return {\n        schema: \"iglu:com.simplybusiness/back_to_application/jsonschema/1-0-0\",\n        data: {\n          journey_id: journeyId,\n          vertical,\n        },\n      };\n    },\n  },\n];\n"],"names":["qcpEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","params","deviceType","urlFriendlyLabel","replace","toLowerCase","product","title","productLabel","snakeCase","fromValue","toValue","schema","data","from_value","to_value","journeyId","vertical","journey_id"],"mappings":";;;;+BAyBaA;;;eAAAA;;;uBAzBa;AAyBnB,MAAMA,sBAAyC;IACpD;QACE,qBAAqB;QACrBC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,aAAa;QACbL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,yCAAyC;QACzCL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,+BAA+B;QAC/BL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAEM,UAAU,EAAE,GAAGD;YAC9B,MAAME,mBAAmBP,MAAMQ,OAAO,CAAC,MAAM,KAAKC,WAAW;YAE7D,OAAO;gBACLX,UAAU,CAAC,aAAa,EAAEQ,WAAW,CAAC,EAAEC,iBAAiB,mBAAmB,CAAC;gBAC7ER,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,8BAA8B;QAC9BT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAE,GAAGK;YAElB,OAAO;gBACLP,UAAU;gBACVC,QAAQ;gBACRC;YACF;QACF;IACF;IACA;QACE,wBAAwB;QACxBL,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EACJP,QAAQ,EACRY,UAAU,gBAAgB,EAC1BC,KAAK,EACN,GAAGN;YACJ,MAAMO,eAAeC,IAAAA,gBAAS,EAACH;YAE/B,OAAO;gBACLZ;gBACAC,QAAQ,CAAC,EAAEa,aAAa,CAAC,EAAEC,IAAAA,gBAAS,EAACF,OAAO,aAAa,CAAC;gBAC1DX,OAAOY;gBACPX,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,sBAAsB;QACtBT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEV,OAAO,EAAE,EAAEmB,YAAY,EAAE,EAAEC,UAAU,EAAE,EAAE,GAAGV;YACpD,cAAc;YACd,IAAIN,SAAS;YAEb,kEAAkE;YAClE,qEAAqE;YACrE,IAAIe,cAAc,KAAK;gBACrBf,SAAS;YACX;YACA,IAAIgB,YAAY,KAAK;gBACnBhB,SAAS;YACX;YAEA,OAAO;gBACLiB,QACE;gBACFC,MAAM;oBACJtB;oBACAI;oBACAmB,YAAYJ;oBACZK,UAAUJ;gBACZ;YACF;QACF;IACF;IACA;QACEpB,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVE,OAAO;gBACPD,QAAQ;gBACRE,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEC,UAAU,EAAE,GAAGD;YAEvB,OAAO;gBACLN,QAAQ;gBACRD,UAAU,CAAC,aAAa,EAAEQ,WAAW,0BAA0B,CAAC;gBAChEN,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEe,SAAS,EAAEC,QAAQ,EAAE,GAAGhB;YAEhC,OAAO;gBACLW,QAAQ;gBACRC,MAAM;oBACJK,YAAYF;oBACZC;gBACF;YACF;QACF;IACF;CACD"}

package/dist/cjs/snowplow/event-definitions/{thankYou.js → referral.js}

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "thankYouEventDefinitions", {
+Object.defineProperty(exports, "referralEventDefinitions", {
     enumerable: true,
     get: function() {
-        return thankYouEventDefinitions;
+        return referralEventDefinitions;
     }
 });
-const thankYouEventDefinitions = [
+const referralEventDefinitions = [
     {
         name: "nextCoverageClicked",
         type: "structured",
@@ -25,4 +25,4 @@ const thankYouEventDefinitions = [
     }
 ];
 
-//# sourceMappingURL=thankYou.js.map
+//# sourceMappingURL=referral.js.map

package/dist/cjs/snowplow/event-definitions/{thankYou.js.map → referral.js.map}

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/thankYou.ts"],"sourcesContent":["import { EventDefinition, ParamsType } from \"../types\";\n\n// ThankYou page events\nexport const thankYouEventDefinitions: EventDefinition[] = [\n  {\n    name: \"nextCoverageClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { url } = params as ParamsType;\n      const eventName = \"post_referral_workers_compensation_continuation_link\";\n\n      return {\n        category: eventName,\n        action: \"link_click\",\n        label: eventName,\n        property: url,\n      };\n    },\n  },\n];\n"],"names":["thankYouEventDefinitions","name","type","makePayload","params","url","eventName","category","action","label","property"],"mappings":";;;;+BAGaA;;;eAAAA;;;AAAN,MAAMA,2BAA8C;IACzD;QACEC,MAAM;QACNC,MAAM;QACNC,aAAaC,CAAAA;YACX,MAAM,EAAEC,GAAG,EAAE,GAAGD;YAChB,MAAME,YAAY;YAElB,OAAO;gBACLC,UAAUD;gBACVE,QAAQ;gBACRC,OAAOH;gBACPI,UAAUL;YACZ;QACF;IACF;CACD"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/referral.ts"],"sourcesContent":["import { EventDefinition, ParamsType } from \"../types\";\n\n// Referral page events\nexport const referralEventDefinitions: EventDefinition[] = [\n  {\n    name: \"nextCoverageClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { url } = params as ParamsType;\n      const eventName = \"post_referral_workers_compensation_continuation_link\";\n\n      return {\n        category: eventName,\n        action: \"link_click\",\n        label: eventName,\n        property: url,\n      };\n    },\n  },\n];\n"],"names":["referralEventDefinitions","name","type","makePayload","params","url","eventName","category","action","label","property"],"mappings":";;;;+BAGaA;;;eAAAA;;;AAAN,MAAMA,2BAA8C;IACzD;QACEC,MAAM;QACNC,MAAM;QACNC,aAAaC,CAAAA;YACX,MAAM,EAAEC,GAAG,EAAE,GAAGD;YAChB,MAAME,YAAY;YAElB,OAAO;gBACLC,UAAUD;gBACVE,QAAQ;gBACRC,OAAOH;gBACPI,UAAUL;YACZ;QACF;IACF;CACD"}

package/dist/esm/snowplow/event-definitions/base.js

@@ -8,11 +8,15 @@
  *   - Allows optional params object to be passed in
  *
  * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
+ * Parent
+ * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
+ * const snowplowProps = getSnowplowConfig(pageData);
+ * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
  *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
+ * Child
+ * import { useSnowplowContext } from "@simplybusiness/services";
+ * const { snowplow } = useSnowplowContext();
+ * const handlerFunction = () => snowplow?.trigger("eventNameHere");
  */ // Base page events
 export const baseEventDefinitions = [
     // Mobile link in header

package/dist/esm/snowplow/event-definitions/base.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/base.ts"],"sourcesContent":["import { EventDefinition } from \"../types\";\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 * import { Snowplow } from \"./Snowplow\";\n * import { eventDefinitions } from \"./event-definitions\";\n *\n * const snowplow = new Snowplow();\n * snowplow.addEventHandlers(eventDefinitions);\n */\n\n// Base page events\nexport const baseEventDefinitions: EventDefinition[] = [\n  // Mobile link in header\n  {\n    name: \"mobileLinkClick\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"marketing\",\n      action: \"link-click\",\n      label: \"mobile_call_button\",\n      property: window.location.href,\n    }),\n  },\n  // Operating hours link in footer\n  {\n    name: \"operatingHoursClick\",\n    type: \"unstructured\",\n    makePayload: () => ({\n      schema:\n        \"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0\",\n      data: {\n        schema:\n          \"iglu:com.simplybusiness/operating_hours_clicked/jsonschema/1-0-2\",\n        data: {},\n      },\n    }),\n  },\n];\n"],"names":["baseEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","schema","data"],"mappings":"AAEA;;;;;;;;;;;;;;;CAeC,GAED,mBAAmB;AACnB,OAAO,MAAMA,uBAA0C;IACrD,wBAAwB;IACxB;QACEC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA,iCAAiC;IACjC;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBQ,QACE;gBACFC,MAAM;oBACJD,QACE;oBACFC,MAAM,CAAC;gBACT;YACF,CAAA;IACF;CACD,CAAC"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/base.ts"],"sourcesContent":["import { EventDefinition } from \"../types\";\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\n// Base page events\nexport const baseEventDefinitions: EventDefinition[] = [\n  // Mobile link in header\n  {\n    name: \"mobileLinkClick\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"marketing\",\n      action: \"link-click\",\n      label: \"mobile_call_button\",\n      property: window.location.href,\n    }),\n  },\n  // Operating hours link in footer\n  {\n    name: \"operatingHoursClick\",\n    type: \"unstructured\",\n    makePayload: () => ({\n      schema:\n        \"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0\",\n      data: {\n        schema:\n          \"iglu:com.simplybusiness/operating_hours_clicked/jsonschema/1-0-2\",\n        data: {},\n      },\n    }),\n  },\n];\n"],"names":["baseEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","schema","data"],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;CAmBC,GAED,mBAAmB;AACnB,OAAO,MAAMA,uBAA0C;IACrD,wBAAwB;IACxB;QACEC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA,iCAAiC;IACjC;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBQ,QACE;gBACFC,MAAM;oBACJD,QACE;oBACFC,MAAM,CAAC;gBACT;YACF,CAAA;IACF;CACD,CAAC"}

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

@@ -1,19 +1,19 @@
 import { baseEventDefinitions } from "./base";
 import { qcpEventDefinitions } from "./qcp";
-import { thankYouEventDefinitions } from "./thankYou";
+import { referralEventDefinitions } from "./referral";
 // All events (keep up to date with new files)
 export const eventDefinitions = [
     ...baseEventDefinitions,
     ...qcpEventDefinitions,
-    ...thankYouEventDefinitions
+    ...referralEventDefinitions
 ];
 export const qcpPageEvents = [
     ...baseEventDefinitions,
     ...qcpEventDefinitions
 ];
-export const thankYouPageEvents = [
+export const referralPageEvents = [
     ...baseEventDefinitions,
-    ...thankYouEventDefinitions
+    ...referralEventDefinitions
 ]; // Create a new export for each kind of page below
  // containing just the subset needed for that page
 

package/dist/esm/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 { thankYouEventDefinitions } from \"./thankYou\";\n\n// All events (keep up to date with new files)\nexport const eventDefinitions = [\n  ...baseEventDefinitions,\n  ...qcpEventDefinitions,\n  ...thankYouEventDefinitions,\n];\n\nexport const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];\n\nexport const thankYouPageEvents = [\n  ...baseEventDefinitions,\n  ...thankYouEventDefinitions,\n];\n\n// Create a new export for each kind of page below\n// containing just the subset needed for that page\n"],"names":["baseEventDefinitions","qcpEventDefinitions","thankYouEventDefinitions","eventDefinitions","qcpPageEvents","thankYouPageEvents"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,SAAS;AAC9C,SAASC,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,wBAAwB,QAAQ,aAAa;AAEtD,8CAA8C;AAC9C,OAAO,MAAMC,mBAAmB;OAC3BH;OACAC;OACAC;CACJ,CAAC;AAEF,OAAO,MAAME,gBAAgB;OAAIJ;OAAyBC;CAAoB,CAAC;AAE/E,OAAO,MAAMI,qBAAqB;OAC7BL;OACAE;CACJ,CAAC,CAEF,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\";\n\n// All events (keep up to date with new files)\nexport const eventDefinitions = [\n  ...baseEventDefinitions,\n  ...qcpEventDefinitions,\n  ...referralEventDefinitions,\n];\n\nexport const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];\n\nexport const referralPageEvents = [\n  ...baseEventDefinitions,\n  ...referralEventDefinitions,\n];\n\n// Create a new export for each kind of page below\n// containing just the subset needed for that page\n"],"names":["baseEventDefinitions","qcpEventDefinitions","referralEventDefinitions","eventDefinitions","qcpPageEvents","referralPageEvents"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,SAAS;AAC9C,SAASC,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,wBAAwB,QAAQ,aAAa;AAEtD,8CAA8C;AAC9C,OAAO,MAAMC,mBAAmB;OAC3BH;OACAC;OACAC;CACJ,CAAC;AAEF,OAAO,MAAME,gBAAgB;OAAIJ;OAAyBC;CAAoB,CAAC;AAE/E,OAAO,MAAMI,qBAAqB;OAC7BL;OACAE;CACJ,CAAC,CAEF,kDAAkD;CAClD,kDAAkD"}

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

@@ -9,11 +9,15 @@ import { snakeCase } from "../../utils";
  *   - Allows optional params object to be passed in
  *
  * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
+ * Parent
+ * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
+ * const snowplowProps = getSnowplowConfig(pageData);
+ * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
  *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
+ * Child
+ * import { useSnowplowContext } from "@simplybusiness/services";
+ * const { snowplow } = useSnowplowContext();
+ * const handlerFunction = () => snowplow?.trigger("eventNameHere");
  */ // QCP page events
 export const qcpEventDefinitions = [
     {

package/dist/esm/snowplow/event-definitions/qcp.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/qcp.ts"],"sourcesContent":["import { snakeCase } from \"../../utils\";\nimport { EventDefinition, ParamsType } from \"../types\";\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 * import { Snowplow } from \"./Snowplow\";\n * import { eventDefinitions } from \"./event-definitions\";\n *\n * const snowplow = new Snowplow();\n * snowplow.addEventHandlers(eventDefinitions);\n */\n\n// QCP page events\nexport const qcpEventDefinitions: EventDefinition[] = [\n  {\n    // QDP details button\n    name: \"detailsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Details\",\n    }),\n  },\n  {\n    // Buy button\n    name: \"selectClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Select\",\n    }),\n  },\n  {\n    // Quote Details Slider Next steps button\n    name: \"nextStepsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_next_step_cta\",\n      action: \"link_click\",\n      label: \"Next steps\",\n    }),\n  },\n  {\n    // Toggle deductibles accordion\n    name: \"deductiblesClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"us-qcp-react\",\n      action: \"view_deductables_clicked\",\n      label: \"view_deductables_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"deductiblesClickedUk\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label, deviceType } = params as ParamsType;\n      const urlFriendlyLabel = label.replace(/ /g, \"-\").toLowerCase();\n\n      return {\n        category: `uk-qcp-react-${deviceType}-${urlFriendlyLabel}-view-excess-toggle`,\n        action: \"view_excess_clicked\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Quote Details Slider opened\n    name: \"sliderOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label } = params as ParamsType;\n\n      return {\n        category: \"comparison_cta\",\n        action: \"quote_details_slider_opened\",\n        label,\n      };\n    },\n  },\n  {\n    // Coverage modal opened\n    name: \"coverageModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const {\n        category,\n        product = \"extra_coverage\",\n        title,\n      } = params as ParamsType;\n      const productLabel = snakeCase(product);\n\n      return {\n        category,\n        action: `${productLabel}_${snakeCase(title)}_popup_opened`,\n        label: productLabel,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Toggle cover select\n    name: \"coverChanged\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { name = \"\", fromValue = \"\", toValue = \"\" } = params as ParamsType;\n      // Derive data\n      let action = \"change\";\n\n      // This logic is taken directly from Chopin without documentation:\n      // If a cover has zero value, then change the action to add or remove\n      if (fromValue === \"0\") {\n        action = \"add\";\n      }\n      if (toValue === \"0\") {\n        action = \"remove\";\n      }\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/comparison_page_cover_changed/jsonschema/1-0-0\",\n        data: {\n          name,\n          action,\n          from_value: fromValue,\n          to_value: toValue,\n        },\n      };\n    },\n  },\n  {\n    name: \"ratingsModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"insurer_rating_help_popup_triggered\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"coverToggleOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"qcp_limit_interaction\",\n      label: \"limit_interaction\",\n      action: \"limit_interaction_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"paymentToggleClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"button_click\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"insurerDetailsAccordionClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_insurer_details_description\",\n      action: \"accordion_clicked\",\n      label: \"accordion_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"priceDetailsPopUpOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"price_details\",\n      action: \"price_details_popup_opened\",\n      label: \"Price details\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"editLimitButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"edit_limit_button_clicked\",\n      label: \"Edit Limit\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"applyButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"apply_button_clicked\",\n      label: \"Apply Button Clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"coverageInfoClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { deviceType } = params as ParamsType;\n\n      return {\n        action: \"show_coverage_info_clicked\",\n        category: `uk-qcp-react-${deviceType}-show-coverage-info-toggle`,\n        label: \"show_coverage_info_clicked\",\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"backToApplication\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { journeyId, vertical } = params as ParamsType;\n\n      return {\n        schema: \"iglu:com.simplybusiness/back_to_application/jsonschema/1-0-0\",\n        data: {\n          journey_id: journeyId,\n          vertical,\n        },\n      };\n    },\n  },\n];\n"],"names":["snakeCase","qcpEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","params","deviceType","urlFriendlyLabel","replace","toLowerCase","product","title","productLabel","fromValue","toValue","schema","data","from_value","to_value","journeyId","vertical","journey_id"],"mappings":"AAAA,SAASA,SAAS,QAAQ,cAAc;AAGxC;;;;;;;;;;;;;;;CAeC,GAED,kBAAkB;AAClB,OAAO,MAAMC,sBAAyC;IACpD;QACE,qBAAqB;QACrBC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,aAAa;QACbL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,yCAAyC;QACzCL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,+BAA+B;QAC/BL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAEM,UAAU,EAAE,GAAGD;YAC9B,MAAME,mBAAmBP,MAAMQ,OAAO,CAAC,MAAM,KAAKC,WAAW;YAE7D,OAAO;gBACLX,UAAU,CAAC,aAAa,EAAEQ,WAAW,CAAC,EAAEC,iBAAiB,mBAAmB,CAAC;gBAC7ER,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,8BAA8B;QAC9BT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAE,GAAGK;YAElB,OAAO;gBACLP,UAAU;gBACVC,QAAQ;gBACRC;YACF;QACF;IACF;IACA;QACE,wBAAwB;QACxBL,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EACJP,QAAQ,EACRY,UAAU,gBAAgB,EAC1BC,KAAK,EACN,GAAGN;YACJ,MAAMO,eAAenB,UAAUiB;YAE/B,OAAO;gBACLZ;gBACAC,QAAQ,CAAC,EAAEa,aAAa,CAAC,EAAEnB,UAAUkB,OAAO,aAAa,CAAC;gBAC1DX,OAAOY;gBACPX,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,sBAAsB;QACtBT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEV,OAAO,EAAE,EAAEkB,YAAY,EAAE,EAAEC,UAAU,EAAE,EAAE,GAAGT;YACpD,cAAc;YACd,IAAIN,SAAS;YAEb,kEAAkE;YAClE,qEAAqE;YACrE,IAAIc,cAAc,KAAK;gBACrBd,SAAS;YACX;YACA,IAAIe,YAAY,KAAK;gBACnBf,SAAS;YACX;YAEA,OAAO;gBACLgB,QACE;gBACFC,MAAM;oBACJrB;oBACAI;oBACAkB,YAAYJ;oBACZK,UAAUJ;gBACZ;YACF;QACF;IACF;IACA;QACEnB,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVE,OAAO;gBACPD,QAAQ;gBACRE,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEC,UAAU,EAAE,GAAGD;YAEvB,OAAO;gBACLN,QAAQ;gBACRD,UAAU,CAAC,aAAa,EAAEQ,WAAW,0BAA0B,CAAC;gBAChEN,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEc,SAAS,EAAEC,QAAQ,EAAE,GAAGf;YAEhC,OAAO;gBACLU,QAAQ;gBACRC,MAAM;oBACJK,YAAYF;oBACZC;gBACF;YACF;QACF;IACF;CACD,CAAC"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/qcp.ts"],"sourcesContent":["import { snakeCase } from \"../../utils\";\nimport { EventDefinition, ParamsType } from \"../types\";\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\n// QCP page events\nexport const qcpEventDefinitions: EventDefinition[] = [\n  {\n    // QDP details button\n    name: \"detailsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Details\",\n    }),\n  },\n  {\n    // Buy button\n    name: \"selectClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"comparison_cta\",\n      action: \"link_click\",\n      label: \"Select\",\n    }),\n  },\n  {\n    // Quote Details Slider Next steps button\n    name: \"nextStepsClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_next_step_cta\",\n      action: \"link_click\",\n      label: \"Next steps\",\n    }),\n  },\n  {\n    // Toggle deductibles accordion\n    name: \"deductiblesClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"us-qcp-react\",\n      action: \"view_deductables_clicked\",\n      label: \"view_deductables_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"deductiblesClickedUk\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label, deviceType } = params as ParamsType;\n      const urlFriendlyLabel = label.replace(/ /g, \"-\").toLowerCase();\n\n      return {\n        category: `uk-qcp-react-${deviceType}-${urlFriendlyLabel}-view-excess-toggle`,\n        action: \"view_excess_clicked\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Quote Details Slider opened\n    name: \"sliderOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label } = params as ParamsType;\n\n      return {\n        category: \"comparison_cta\",\n        action: \"quote_details_slider_opened\",\n        label,\n      };\n    },\n  },\n  {\n    // Coverage modal opened\n    name: \"coverageModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const {\n        category,\n        product = \"extra_coverage\",\n        title,\n      } = params as ParamsType;\n      const productLabel = snakeCase(product);\n\n      return {\n        category,\n        action: `${productLabel}_${snakeCase(title)}_popup_opened`,\n        label: productLabel,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    // Toggle cover select\n    name: \"coverChanged\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { name = \"\", fromValue = \"\", toValue = \"\" } = params as ParamsType;\n      // Derive data\n      let action = \"change\";\n\n      // This logic is taken directly from Chopin without documentation:\n      // If a cover has zero value, then change the action to add or remove\n      if (fromValue === \"0\") {\n        action = \"add\";\n      }\n      if (toValue === \"0\") {\n        action = \"remove\";\n      }\n\n      return {\n        schema:\n          \"iglu:com.simplybusiness/comparison_page_cover_changed/jsonschema/1-0-0\",\n        data: {\n          name,\n          action,\n          from_value: fromValue,\n          to_value: toValue,\n        },\n      };\n    },\n  },\n  {\n    name: \"ratingsModalOpened\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"insurer_rating_help_popup_triggered\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"coverToggleOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"qcp_limit_interaction\",\n      label: \"limit_interaction\",\n      action: \"limit_interaction_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"paymentToggleClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { category, label } = params as ParamsType;\n\n      return {\n        category,\n        action: \"button_click\",\n        label,\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"insurerDetailsAccordionClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"quote_details_slider_insurer_details_description\",\n      action: \"accordion_clicked\",\n      label: \"accordion_clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"priceDetailsPopUpOpened\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"price_details\",\n      action: \"price_details_popup_opened\",\n      label: \"Price details\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"editLimitButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"edit_limit_button_clicked\",\n      label: \"Edit Limit\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"applyButtonClicked\",\n    type: \"structured\",\n    makePayload: () => ({\n      category: \"cover_limit_changes\",\n      action: \"apply_button_clicked\",\n      label: \"Apply Button Clicked\",\n      property: window.location.href,\n    }),\n  },\n  {\n    name: \"coverageInfoClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { deviceType } = params as ParamsType;\n\n      return {\n        action: \"show_coverage_info_clicked\",\n        category: `uk-qcp-react-${deviceType}-show-coverage-info-toggle`,\n        label: \"show_coverage_info_clicked\",\n        property: window.location.href,\n      };\n    },\n  },\n  {\n    name: \"backToApplication\",\n    type: \"unstructured\",\n    makePayload: params => {\n      const { journeyId, vertical } = params as ParamsType;\n\n      return {\n        schema: \"iglu:com.simplybusiness/back_to_application/jsonschema/1-0-0\",\n        data: {\n          journey_id: journeyId,\n          vertical,\n        },\n      };\n    },\n  },\n];\n"],"names":["snakeCase","qcpEventDefinitions","name","type","makePayload","category","action","label","property","window","location","href","params","deviceType","urlFriendlyLabel","replace","toLowerCase","product","title","productLabel","fromValue","toValue","schema","data","from_value","to_value","journeyId","vertical","journey_id"],"mappings":"AAAA,SAASA,SAAS,QAAQ,cAAc;AAGxC;;;;;;;;;;;;;;;;;;;CAmBC,GAED,kBAAkB;AAClB,OAAO,MAAMC,sBAAyC;IACpD;QACE,qBAAqB;QACrBC,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,aAAa;QACbL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,yCAAyC;QACzCL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;YACT,CAAA;IACF;IACA;QACE,+BAA+B;QAC/BL,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAEM,UAAU,EAAE,GAAGD;YAC9B,MAAME,mBAAmBP,MAAMQ,OAAO,CAAC,MAAM,KAAKC,WAAW;YAE7D,OAAO;gBACLX,UAAU,CAAC,aAAa,EAAEQ,WAAW,CAAC,EAAEC,iBAAiB,mBAAmB,CAAC;gBAC7ER,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,8BAA8B;QAC9BT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEL,KAAK,EAAE,GAAGK;YAElB,OAAO;gBACLP,UAAU;gBACVC,QAAQ;gBACRC;YACF;QACF;IACF;IACA;QACE,wBAAwB;QACxBL,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EACJP,QAAQ,EACRY,UAAU,gBAAgB,EAC1BC,KAAK,EACN,GAAGN;YACJ,MAAMO,eAAenB,UAAUiB;YAE/B,OAAO;gBACLZ;gBACAC,QAAQ,CAAC,EAAEa,aAAa,CAAC,EAAEnB,UAAUkB,OAAO,aAAa,CAAC;gBAC1DX,OAAOY;gBACPX,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACE,sBAAsB;QACtBT,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEV,OAAO,EAAE,EAAEkB,YAAY,EAAE,EAAEC,UAAU,EAAE,EAAE,GAAGT;YACpD,cAAc;YACd,IAAIN,SAAS;YAEb,kEAAkE;YAClE,qEAAqE;YACrE,IAAIc,cAAc,KAAK;gBACrBd,SAAS;YACX;YACA,IAAIe,YAAY,KAAK;gBACnBf,SAAS;YACX;YAEA,OAAO;gBACLgB,QACE;gBACFC,MAAM;oBACJrB;oBACAI;oBACAkB,YAAYJ;oBACZK,UAAUJ;gBACZ;YACF;QACF;IACF;IACA;QACEnB,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVE,OAAO;gBACPD,QAAQ;gBACRE,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEP,QAAQ,EAAEE,KAAK,EAAE,GAAGK;YAE5B,OAAO;gBACLP;gBACAC,QAAQ;gBACRC;gBACAC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAa,IAAO,CAAA;gBAClBC,UAAU;gBACVC,QAAQ;gBACRC,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC,CAAA;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEC,UAAU,EAAE,GAAGD;YAEvB,OAAO;gBACLN,QAAQ;gBACRD,UAAU,CAAC,aAAa,EAAEQ,WAAW,0BAA0B,CAAC;gBAChEN,OAAO;gBACPC,UAAUC,OAAOC,QAAQ,CAACC,IAAI;YAChC;QACF;IACF;IACA;QACET,MAAM;QACNC,MAAM;QACNC,aAAaQ,CAAAA;YACX,MAAM,EAAEc,SAAS,EAAEC,QAAQ,EAAE,GAAGf;YAEhC,OAAO;gBACLU,QAAQ;gBACRC,MAAM;oBACJK,YAAYF;oBACZC;gBACF;YACF;QACF;IACF;CACD,CAAC"}

package/dist/esm/snowplow/event-definitions/{thankYou.js → referral.js}

@@ -1,5 +1,5 @@
-// ThankYou page events
-export const thankYouEventDefinitions = [
+// Referral page events
+export const referralEventDefinitions = [
     {
         name: "nextCoverageClicked",
         type: "structured",
@@ -16,4 +16,4 @@ export const thankYouEventDefinitions = [
     }
 ];
 
-//# sourceMappingURL=thankYou.js.map
+//# sourceMappingURL=referral.js.map

package/dist/esm/snowplow/event-definitions/{thankYou.js.map → referral.js.map}

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snowplow/event-definitions/thankYou.ts"],"sourcesContent":["import { EventDefinition, ParamsType } from \"../types\";\n\n// ThankYou page events\nexport const thankYouEventDefinitions: EventDefinition[] = [\n  {\n    name: \"nextCoverageClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { url } = params as ParamsType;\n      const eventName = \"post_referral_workers_compensation_continuation_link\";\n\n      return {\n        category: eventName,\n        action: \"link_click\",\n        label: eventName,\n        property: url,\n      };\n    },\n  },\n];\n"],"names":["thankYouEventDefinitions","name","type","makePayload","params","url","eventName","category","action","label","property"],"mappings":"AAEA,uBAAuB;AACvB,OAAO,MAAMA,2BAA8C;IACzD;QACEC,MAAM;QACNC,MAAM;QACNC,aAAaC,CAAAA;YACX,MAAM,EAAEC,GAAG,EAAE,GAAGD;YAChB,MAAME,YAAY;YAElB,OAAO;gBACLC,UAAUD;gBACVE,QAAQ;gBACRC,OAAOH;gBACPI,UAAUL;YACZ;QACF;IACF;CACD,CAAC"}
+{"version":3,"sources":["../../../../src/snowplow/event-definitions/referral.ts"],"sourcesContent":["import { EventDefinition, ParamsType } from \"../types\";\n\n// Referral page events\nexport const referralEventDefinitions: EventDefinition[] = [\n  {\n    name: \"nextCoverageClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { url } = params as ParamsType;\n      const eventName = \"post_referral_workers_compensation_continuation_link\";\n\n      return {\n        category: eventName,\n        action: \"link_click\",\n        label: eventName,\n        property: url,\n      };\n    },\n  },\n];\n"],"names":["referralEventDefinitions","name","type","makePayload","params","url","eventName","category","action","label","property"],"mappings":"AAEA,uBAAuB;AACvB,OAAO,MAAMA,2BAA8C;IACzD;QACEC,MAAM;QACNC,MAAM;QACNC,aAAaC,CAAAA;YACX,MAAM,EAAEC,GAAG,EAAE,GAAGD;YAChB,MAAME,YAAY;YAElB,OAAO;gBACLC,UAAUD;gBACVE,QAAQ;gBACRC,OAAOH;gBACPI,UAAUL;YACZ;QACF;IACF;CACD,CAAC"}

package/dist/types/snowplow/event-definitions/base.d.ts

@@ -9,10 +9,14 @@ import { EventDefinition } from "../types";
  *   - Allows optional params object to be passed in
  *
  * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
+ * Parent
+ * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
+ * const snowplowProps = getSnowplowConfig(pageData);
+ * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
  *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
+ * Child
+ * import { useSnowplowContext } from "@simplybusiness/services";
+ * const { snowplow } = useSnowplowContext();
+ * const handlerFunction = () => snowplow?.trigger("eventNameHere");
  */
 export declare const baseEventDefinitions: EventDefinition[];

package/dist/types/snowplow/event-definitions/index.d.ts

@@ -1,3 +1,3 @@
 export declare const eventDefinitions: import("..").EventDefinition[];
 export declare const qcpPageEvents: import("..").EventDefinition[];
-export declare const thankYouPageEvents: import("..").EventDefinition[];
+export declare const referralPageEvents: import("..").EventDefinition[];

package/dist/types/snowplow/event-definitions/qcp.d.ts

@@ -9,10 +9,14 @@ import { EventDefinition } from "../types";
  *   - Allows optional params object to be passed in
  *
  * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
+ * Parent
+ * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
+ * const snowplowProps = getSnowplowConfig(pageData);
+ * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
  *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
+ * Child
+ * import { useSnowplowContext } from "@simplybusiness/services";
+ * const { snowplow } = useSnowplowContext();
+ * const handlerFunction = () => snowplow?.trigger("eventNameHere");
  */
 export declare const qcpEventDefinitions: EventDefinition[];

package/dist/types/snowplow/event-definitions/referral.d.ts

@@ -0,0 +1,2 @@
+import { EventDefinition } from "../types";
+export declare const referralEventDefinitions: EventDefinition[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplybusiness/services",
   "license": "UNLICENSED",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Internal library for services",
   "repository": {
     "type": "git",
@@ -76,7 +76,7 @@
   },
   "dependencies": {
     "@airbrake/browser": "^2.1.8",
-    "@simplybusiness/mobius": "^4.15.1",
+    "@simplybusiness/mobius": "^4.16.0",
     "@snowplow/browser-tracker": "^3.24.2",
     "classnames": "^2.5.1"
   },

package/src/snowplow/event-definitions/base.ts

@@ -10,11 +10,15 @@ import { EventDefinition } from "../types";
  *   - Allows optional params object to be passed in
  *
  * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
+ * Parent
+ * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
+ * const snowplowProps = getSnowplowConfig(pageData);
+ * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
  *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
+ * Child
+ * import { useSnowplowContext } from "@simplybusiness/services";
+ * const { snowplow } = useSnowplowContext();
+ * const handlerFunction = () => snowplow?.trigger("eventNameHere");
  */
 
 // Base page events

package/src/snowplow/event-definitions/index.ts

@@ -1,19 +1,19 @@
 import { baseEventDefinitions } from "./base";
 import { qcpEventDefinitions } from "./qcp";
-import { thankYouEventDefinitions } from "./thankYou";
+import { referralEventDefinitions } from "./referral";
 
 // All events (keep up to date with new files)
 export const eventDefinitions = [
   ...baseEventDefinitions,
   ...qcpEventDefinitions,
-  ...thankYouEventDefinitions,
+  ...referralEventDefinitions,
 ];
 
 export const qcpPageEvents = [...baseEventDefinitions, ...qcpEventDefinitions];
 
-export const thankYouPageEvents = [
+export const referralPageEvents = [
   ...baseEventDefinitions,
-  ...thankYouEventDefinitions,
+  ...referralEventDefinitions,
 ];
 
 // Create a new export for each kind of page below

package/src/snowplow/event-definitions/qcp.ts

@@ -11,11 +11,15 @@ import { EventDefinition, ParamsType } from "../types";
  *   - Allows optional params object to be passed in
  *
  * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
+ * Parent
+ * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
+ * const snowplowProps = getSnowplowConfig(pageData);
+ * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
  *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
+ * Child
+ * import { useSnowplowContext } from "@simplybusiness/services";
+ * const { snowplow } = useSnowplowContext();
+ * const handlerFunction = () => snowplow?.trigger("eventNameHere");
  */
 
 // QCP page events

package/src/snowplow/event-definitions/{thankYou.ts → referral.ts}

@@ -1,7 +1,7 @@
 import { EventDefinition, ParamsType } from "../types";
 
-// ThankYou page events
-export const thankYouEventDefinitions: EventDefinition[] = [
+// Referral page events
+export const referralEventDefinitions: EventDefinition[] = [
   {
     name: "nextCoverageClicked",
     type: "structured",

package/dist/types/snowplow/event-definitions/thankYou.d.ts

@@ -1,2 +0,0 @@
-import { EventDefinition } from "../types";
-export declare const thankYouEventDefinitions: EventDefinition[];