@simplybusiness/services 2.0.2 → 2.2.0

package/dist/types/src/airbrake/index.d.ts

@@ -5,5 +5,5 @@ export type GetAirbrakeOptions = {
     forceSend?: boolean;
 };
 export declare function getAirbrake(options?: GetAirbrakeOptions): {
-    notify: jest.Mock<any, any, any> | ((...data: any[]) => void);
+    notify: (...data: any[]) => void;
 };

package/dist/types/src/mocks/eventDefinitions.d.ts

@@ -25,6 +25,7 @@ declare const _default: ({
             question: string;
             answer: string;
             vertical: string;
+            journey_id: string;
         };
     };
     contexts: string[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplybusiness/services",
   "license": "UNLICENSED",
-  "version": "2.0.2",
+  "version": "2.2.0",
   "description": "Internal library for services",
   "repository": {
     "type": "git",

package/src/airbrake/index.ts

@@ -12,7 +12,7 @@ const notifierInstances = new Map<number, Notifier>();
 const fakeAirbrake = {
   notify:
     globalThis.process?.env?.NODE_ENV === "test"
-      ? jest.fn()
+      ? () => {}
       : console.error.bind(console),
 };
 

package/src/mocks/eventDefinitions.ts

@@ -24,7 +24,7 @@ export default [
 
       return {
         schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3",
+          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
         data: {
           site: context.site,
           page_index: 1,
@@ -34,6 +34,7 @@ export default [
           question,
           answer,
           vertical: context.vertical,
+          journey_id: context.journeyId,
         },
       };
     },

package/src/snowplow/event-definitions/coverage-selection.test.ts

@@ -130,4 +130,42 @@ describe("coverageSelectionEventDefinitions", () => {
       expect("data" in result && result.data.vertical).toBe("");
     });
   });
+
+  describe("learnMoreModalOpened", () => {
+    it("should create correct structured event payload", () => {
+      const params = {
+        product: "general_liability",
+      };
+
+      const result = findEventByName(
+        coverageSelectionEventDefinitions,
+        "learnMoreModalOpened",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "coverage_selection",
+        action: "learn_more_modal_opened",
+        label: "general_liability",
+        property: window.location.href,
+      });
+    });
+
+    it("should handle different product IDs", () => {
+      const params = {
+        product: "business_owners_policy",
+      };
+
+      const result = findEventByName(
+        coverageSelectionEventDefinitions,
+        "learnMoreModalOpened",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "coverage_selection",
+        action: "learn_more_modal_opened",
+        label: "business_owners_policy",
+        property: window.location.href,
+      });
+    });
+  });
 });

package/src/snowplow/event-definitions/coverage-selection.ts

@@ -33,4 +33,18 @@ export const coverageSelectionEventDefinitions: EventDefinition[] = [
       };
     },
   },
+  {
+    name: "learnMoreModalOpened",
+    type: "structured",
+    makePayload: params => {
+      const { product } = params as ParamsType & { product: string };
+
+      return {
+        category: "coverage_selection",
+        action: "learn_more_modal_opened",
+        label: product,
+        property: window.location.href,
+      };
+    },
+  },
 ];

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

@@ -0,0 +1,304 @@
+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(
+        personalisedCoverEventDefinitions,
+        "seeMoreClicked",
+      ).makePayload({});
+
+      expect(result).toEqual({
+        category: "personalised_cover",
+        action: "see_more_clicked",
+        label: "page",
+        property: "personalised_cover",
+      });
+    });
+  });
+
+  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 = {
+        cover: "Public Liability",
+        question: "What is your turnover?",
+      };
+
+      const result = findEventByName(
+        personalisedCoverEventDefinitions,
+        "validationShown",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "personalised_cover",
+        action: "validation_shown",
+        label: "cover_question",
+        property: "public_liability_what_is_your_turnover?",
+      });
+    });
+  });
+
+  describe("limitLinkClicked", () => {
+    it("should create correct payload", () => {
+      const params = {
+        label: "test-label",
+      };
+
+      const result = findEventByName(
+        personalisedCoverEventDefinitions,
+        "limitLinkClicked",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "personalised_cover",
+        action: "limit_link_clicked",
+        label: "test-label",
+        property: "link_clicked",
+      });
+    });
+  });
+
+  describe("limitChanged", () => {
+    it("should create correct payload", () => {
+      const params = {
+        label: "Public Liability",
+        limit: "1000000",
+      };
+
+      const result = findEventByName(
+        personalisedCoverEventDefinitions,
+        "limitChanged",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "personalised_cover",
+        action: "limit_changed",
+        label: "Public Liability",
+        property: "1000000",
+      });
+    });
+  });
+
+  describe("coverPresented", () => {
+    it("should create correct payload", () => {
+      const params = {
+        property: "Public Liability",
+      };
+
+      const result = findEventByName(
+        personalisedCoverEventDefinitions,
+        "coverPresented",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "personalised_cover",
+        action: "cover_presented",
+        label: "cover_name",
+        property: "Public Liability",
+      });
+    });
+  });
+
+  describe("coverDetailsClicked", () => {
+    it("should create correct payload", () => {
+      const params = {
+        property: "Public Liability",
+      };
+
+      const result = findEventByName(
+        personalisedCoverEventDefinitions,
+        "coverDetailsClicked",
+      ).makePayload(params);
+
+      expect(result).toEqual({
+        category: "personalised_cover",
+        action: "cover_details_clicked",
+        label: "cover_name",
+        property: "Public Liability",
+      });
+    });
+  });
+
+  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

@@ -72,13 +72,15 @@ export const personalisedCoverEventDefinitions: EventDefinition[] = [
 
       return {
         schema:
-          "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-1",
+          "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,
         },
       };
     },

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

@@ -9,6 +9,7 @@ describe("questionnaireEventDefinitions", () => {
         context: {
           site: "uk",
           vertical: "shop",
+          journeyId: "journey-123",
         },
         question: "test-question",
         answer: "test-answer",
@@ -31,6 +32,7 @@ describe("questionnaireEventDefinitions", () => {
           question: "test-question",
           answer: "test-answer",
           vertical: "shop",
+          journey_id: "journey-123",
         },
       });
     });
@@ -41,6 +43,7 @@ describe("questionnaireEventDefinitions", () => {
         context: {
           site: "uk",
           vertical: "shop",
+          journeyId: "journey-123",
         },
         question: "test-question",
         answer: ["one", "two", "four"],
@@ -63,6 +66,7 @@ describe("questionnaireEventDefinitions", () => {
           question: "test-question",
           answer: "one|two|four",
           vertical: "shop",
+          journey_id: "journey-123",
         },
       });
     });
@@ -73,6 +77,7 @@ describe("questionnaireEventDefinitions", () => {
         context: {
           site: "uk",
           vertical: "shop",
+          journeyId: "journey-123",
         },
         question: "customer_first_name",
         answer: "Secret-Joanne",
@@ -95,6 +100,7 @@ describe("questionnaireEventDefinitions", () => {
           question: "customer_first_name",
           answer: "REDACTED",
           vertical: "shop",
+          journey_id: "journey-123",
         },
       });
     });
@@ -106,6 +112,7 @@ describe("questionnaireEventDefinitions", () => {
         context: {
           site: "us",
           vertical: "shop",
+          journeyId: "journey-123",
         },
         answer: "test-answer",
         vertical: "shop",

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

@@ -27,6 +27,7 @@ export const questionnaireEventDefinitions: EventDefinition[] = [
           question,
           answer: flatAnswer,
           vertical: context.vertical,
+          journey_id: context.journeyId,
         },
       };
     },

package/src/snowplow/index.test.ts

@@ -179,7 +179,7 @@ describe("Snowplow Analytics Class", () => {
 
         const expectedPayload = {
           schema:
-            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3",
+            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
           data: {
             site: "simplybusiness_us",
             vertical: "usa",
@@ -189,6 +189,7 @@ describe("Snowplow Analytics Class", () => {
             submitted_from: "quick_to_quote_experiment",
             question: "test-question",
             answer: "test-answer",
+            journey_id: "666ff79d90abbc3582e496da",
           },
         };
 
@@ -225,7 +226,7 @@ describe("Snowplow Analytics Class", () => {
 
         const expectedPayload = {
           schema:
-            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3",
+            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
           data: {
             site: "simplybusiness_us",
             vertical: "usa",
@@ -235,6 +236,7 @@ describe("Snowplow Analytics Class", () => {
             submitted_from: "quick_to_quote_experiment",
             question: "sof_bankrupt",
             answer: "REDACTED",
+            journey_id: "666ff79d90abbc3582e496da",
           },
         };
 
@@ -271,7 +273,7 @@ describe("Snowplow Analytics Class", () => {
 
         const expectedPayload = {
           schema:
-            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3",
+            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
           data: {
             site: "simplybusiness_us",
             vertical: "usa",
@@ -281,6 +283,7 @@ describe("Snowplow Analytics Class", () => {
             submitted_from: "quick_to_quote_experiment",
             question: "have_secondary_trade",
             answer: "Yes",
+            journey_id: "666ff79d90abbc3582e496da",
           },
         };
 
@@ -317,7 +320,7 @@ describe("Snowplow Analytics Class", () => {
 
         const expectedPayload = {
           schema:
-            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3",
+            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
           data: {
             site: "simplybusiness_us",
             vertical: "usa",
@@ -327,6 +330,7 @@ describe("Snowplow Analytics Class", () => {
             submitted_from: "quick_to_quote_experiment",
             question: "address_lookup",
             answer: "123 Test Street",
+            journey_id: "666ff79d90abbc3582e496da",
           },
         };
 
@@ -455,7 +459,7 @@ describe("Snowplow Analytics Class", () => {
 
         const expectedPayload = {
           schema:
-            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-3",
+            "iglu:com.simplybusiness/form_question_answered/jsonschema/1-0-4",
           data: {
             site: "simplybusiness_us",
             vertical: "usa",
@@ -465,6 +469,7 @@ describe("Snowplow Analytics Class", () => {
             submitted_from: "quick_to_quote_experiment",
             question: "test-question",
             answer: "test-answer",
+            journey_id: "666ff79d90abbc3582e496da",
           },
         };