@simplybusiness/services 2.5.2 → 2.6.1

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

@@ -24,11 +24,6 @@ export const referralPageEvents = [
   ...referralEventDefinitions,
 ];
 
-export const personalisedCoverPageEvents = [
-  ...baseEventDefinitions,
-  ...personalisedCoverEventDefinitions,
-];
-
 export const interventionPageEvents = [...interventionEventDefinitions];
 
 export type { InterventionPayload } from "./intervention";

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

@@ -37,12 +37,4 @@ export const interventionEventDefinitions: EventDefinition[] = [
       };
     },
   },
-  {
-    name: "iaLiveChatInterventionClosed",
-    type: "structured",
-    makePayload: _ => ({
-      category: "insurance_assistant",
-      action: "ia_live_chat_intervention_closed",
-    }),
-  },
 ];

package/src/snowplow/event-definitions/personalised_cover.test.ts

@@ -2,131 +2,6 @@ import { personalisedCoverEventDefinitions } from "./personalised_cover";
 import { findEventByName } from "./test-utils";
 
 describe("personalisedCoverEventDefinitions", () => {
-  describe("coverQuestionAnswered", () => {
-    it("should create correct payload", () => {
-      const params = {
-        context: {
-          site: "uk",
-          vertical: "shop",
-          journeyId: "journey-123",
-        },
-        question: "test-question",
-        answer: "test-answer",
-      };
-
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "coverQuestionAnswered",
-      ).makePayload(params);
-
-      expect(result).toEqual({
-        schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
-        data: {
-          site: "uk",
-          page_name: "personalised_cover",
-          section_name: "Personalised Cover Questions",
-          question: "test-question",
-          answer: "test-answer",
-          vertical: "shop",
-          journey_id: "journey-123",
-        },
-      });
-    });
-
-    it("should flatten array answers", () => {
-      const params = {
-        context: {
-          site: "uk",
-          vertical: "shop",
-          journeyId: "journey-456",
-        },
-        question: "test-question",
-        answer: ["one", "two", "three"],
-      };
-
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "coverQuestionAnswered",
-      ).makePayload(params);
-
-      expect(result).toEqual({
-        schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
-        data: {
-          site: "uk",
-          page_name: "personalised_cover",
-          section_name: "Personalised Cover Questions",
-          question: "test-question",
-          answer: "one|two|three",
-          vertical: "shop",
-          journey_id: "journey-456",
-        },
-      });
-    });
-
-    it("should redact answers", () => {
-      const params = {
-        context: {
-          site: "uk",
-          vertical: "shop",
-          journeyId: "journey-789",
-        },
-        question: "customer_first_name",
-        answer: "Secret-John",
-      };
-
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "coverQuestionAnswered",
-      ).makePayload(params);
-
-      expect(result).toEqual({
-        schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
-        data: {
-          site: "uk",
-          page_name: "personalised_cover",
-          section_name: "Personalised Cover Questions",
-          question: "customer_first_name",
-          answer: "REDACTED",
-          vertical: "shop",
-          journey_id: "journey-789",
-        },
-      });
-    });
-
-    it("should handle undefined journeyId", () => {
-      const params = {
-        context: {
-          site: "uk",
-          vertical: "shop",
-        },
-        question: "test-question",
-        answer: "test-answer",
-      };
-
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "coverQuestionAnswered",
-      ).makePayload(params);
-
-      expect(result).toEqual({
-        schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
-        data: {
-          site: "uk",
-          page_name: "personalised_cover",
-          section_name: "Personalised Cover Questions",
-          question: "test-question",
-          answer: "test-answer",
-          vertical: "shop",
-          journey_id: undefined,
-        },
-      });
-    });
-  });
-
   describe("seeMoreClicked", () => {
     it("should create correct payload", () => {
       const result = findEventByName(
@@ -143,22 +18,6 @@ describe("personalisedCoverEventDefinitions", () => {
     });
   });
 
-  describe("selectPackageClicked", () => {
-    it("should create correct payload", () => {
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "selectPackageClicked",
-      ).makePayload({});
-
-      expect(result).toEqual({
-        category: "personalised_cover",
-        action: "select_package_clicked",
-        label: "page",
-        property: "personalised_cover",
-      });
-    });
-  });
-
   describe("validationShown", () => {
     it("should create correct payload", () => {
       const params = {
@@ -260,45 +119,4 @@ describe("personalisedCoverEventDefinitions", () => {
       });
     });
   });
-
-  describe("additionalQuestionsClicked", () => {
-    it("should create correct payload", () => {
-      const params = {
-        property: "Public Liability",
-      };
-
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "additionalQuestionsClicked",
-      ).makePayload(params);
-
-      expect(result).toEqual({
-        category: "personalised_cover",
-        action: "cover_details_clicked",
-        label: "cover_name",
-        property: "Public Liability",
-      });
-    });
-  });
-
-  describe("chatbotPromptClicked", () => {
-    it("should create correct payload", () => {
-      const params = {
-        label: "test-label",
-        property: "test-property",
-      };
-
-      const result = findEventByName(
-        personalisedCoverEventDefinitions,
-        "chatbotPromptClicked",
-      ).makePayload(params);
-
-      expect(result).toEqual({
-        category: "personalised_cover",
-        action: "chatbot_prompt_clicked",
-        label: "test-property",
-        property: "test-label",
-      });
-    });
-  });
 });

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

@@ -1,7 +1,5 @@
 import { snakeCase } from "../../utils";
-import { DELIMITER } from "../constants";
 import type { EventDefinition, ParamsType } from "../types";
-import { redact } from "./questionnaire/redaction";
 
 /**
  * Event definitions for Snowplow
@@ -35,16 +33,6 @@ export const personalisedCoverEventDefinitions: EventDefinition[] = [
       property: "personalised_cover",
     }),
   },
-  {
-    name: "selectPackageClicked",
-    type: "structured",
-    makePayload: _ => ({
-      category: "personalised_cover",
-      action: "select_package_clicked",
-      label: "page",
-      property: "personalised_cover",
-    }),
-  },
   {
     name: "validationShown",
     type: "structured",
@@ -59,32 +47,6 @@ export const personalisedCoverEventDefinitions: EventDefinition[] = [
       };
     },
   },
-  {
-    name: "coverQuestionAnswered",
-    type: "unstructured",
-    makePayload: params => {
-      const { context } = params as ParamsType;
-      const { question, answer } = redact(params as ParamsType);
-      // Flatten the answer to a delimited string
-      const flatAnswer = Array.isArray(answer)
-        ? answer.join(DELIMITER)
-        : answer;
-
-      return {
-        schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
-        data: {
-          site: context.site,
-          page_name: "personalised_cover",
-          section_name: "Personalised Cover Questions",
-          question,
-          answer: flatAnswer,
-          vertical: context.vertical,
-          journey_id: context.journeyId,
-        },
-      };
-    },
-  },
   {
     name: "limitLinkClicked",
     type: "structured",
@@ -141,32 +103,4 @@ export const personalisedCoverEventDefinitions: EventDefinition[] = [
       };
     },
   },
-  {
-    name: "additionalQuestionsClicked",
-    type: "structured",
-    makePayload: params => {
-      const { property } = params as ParamsType;
-
-      return {
-        category: "personalised_cover",
-        action: "cover_details_clicked",
-        label: "cover_name",
-        property,
-      };
-    },
-  },
-  {
-    name: "chatbotPromptClicked",
-    type: "structured",
-    makePayload: params => {
-      const { label, property } = params as ParamsType;
-
-      return {
-        category: "personalised_cover",
-        action: "chatbot_prompt_clicked",
-        label: property,
-        property: label,
-      };
-    },
-  },
 ];

package/dist/esm/chunk-3SO3SL37.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/snowplow/event-definitions/personalised_cover.ts"],
-  "sourcesContent": ["import { snakeCase } from \"../../utils\";\nimport { DELIMITER } from \"../constants\";\nimport type { EventDefinition, ParamsType } from \"../types\";\nimport { redact } from \"./questionnaire/redaction\";\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-4\",\n        data: {\n          site: context.site,\n          page_name: \"personalised_cover\",\n          section_name: \"Personalised Cover Questions\",\n          question,\n          answer: flatAnswer,\n          vertical: context.vertical,\n          journey_id: context.journeyId,\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: \"coverDetailsClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { property } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"cover_details_clicked\",\n        label: \"cover_name\",\n        property,\n      };\n    },\n  },\n  {\n    name: \"additionalQuestionsClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { property } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"cover_details_clicked\",\n        label: \"cover_name\",\n        property,\n      };\n    },\n  },\n  {\n    name: \"chatbotPromptClicked\",\n    type: \"structured\",\n    makePayload: params => {\n      const { label, property } = params as ParamsType;\n\n      return {\n        category: \"personalised_cover\",\n        action: \"chatbot_prompt_clicked\",\n        label: property,\n        property: label,\n      };\n    },\n  },\n];\n"],
-  "mappings": ";;;;;;;;;;;AA0BO,IAAM,oCAAuD;AAAA,EAClE;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,QAAM;AAAA,MACjB,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,OAAO;AAAA,MACP,UAAU;AAAA,IACZ;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,QAAM;AAAA,MACjB,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,OAAO;AAAA,MACP,UAAU;AAAA,IACZ;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,OAAO,SAAS,IAAI;AAE5B,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,UAAU,GAAG,UAAU,KAAK,CAAC,IAAI,UAAU,QAAQ,CAAC;AAAA,MACtD;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,QAAQ,IAAI;AACpB,YAAM,EAAE,UAAU,OAAO,IAAI,OAAO,MAAoB;AAExD,YAAM,aAAa,MAAM,QAAQ,MAAM,IACnC,OAAO,KAAK,SAAS,IACrB;AAEJ,aAAO;AAAA,QACL,QACE;AAAA,QACF,MAAM;AAAA,UACJ,MAAM,QAAQ;AAAA,UACd,WAAW;AAAA,UACX,cAAc;AAAA,UACd;AAAA,UACA,QAAQ;AAAA,UACR,UAAU,QAAQ;AAAA,UAClB,YAAY,QAAQ;AAAA,QACtB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,MAAM,IAAI;AAElB,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR;AAAA,QACA,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,OAAO,MAAM,IAAI;AAEzB,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR;AAAA,QACA,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,SAAS,IAAI;AAErB,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,SAAS,IAAI;AAErB,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,SAAS,IAAI;AAErB,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,aAAa,YAAU;AACrB,YAAM,EAAE,OAAO,SAAS,IAAI;AAE5B,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AACF;",
-  "names": []
-}