@simplybusiness/services 0.26.3 → 0.27.0

package/src/address-lookup/index.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   AddressError,
   AddressLookupConfig,
   FindAddressResponse,
@@ -31,46 +31,47 @@ export class AddressLookup {
     this.apiKey = apiKey;
     this.limit = limit || LIMIT;
     this.countries = countries || COUNTRIES;
-    this.findUrl = `${FIND_URL}?Key=${this.apiKey}&Limit=${this.limit}&Countries=${this.countries}`;
+    const countriesParam = this.countries.join(",");
+    this.findUrl = `${FIND_URL}?Key=${this.apiKey}&Limit=${this.limit}&Countries=${countriesParam}`;
     this.retrieveUrl = `${RETRIEVE_URL}?Key=${this.apiKey}`;
   }
 
-  private static async fetchFromApi(
+  private static async fetchFromApi<RespType>(
     url: string,
-    handleResponse: Function,
+    handleResponse: (data: RespType) => unknown,
   ): Promise<unknown> {
     return new Promise((resolve, reject) => {
       fetch(url)
-        .then(response => response.json())
+        .then(response => response.json() as Promise<RespType>)
         .then(data => resolve(handleResponse(data)))
-        .catch(error => reject(Error(error)));
+        .catch(error => reject(Error(String(error))));
     });
   }
 
   public find(partialAddress: string): Promise<Options> {
     return new Promise((resolve, reject) => {
       fetch(`${this.findUrl}&Text=${partialAddress}`)
-        .then(response => response.json())
+        .then(response => response.json() as Promise<FindAddressResponse>)
         .then(data => resolve(this.formatItems(data)))
-        .catch(error => reject(Error(error)));
+        .catch(error => reject(Error(String(error))));
     });
   }
 
   public findById(id: string): Promise<Options> {
     return new Promise((resolve, reject) => {
       fetch(`${this.findUrl}&Container=${id}`)
-        .then(response => response.json())
+        .then(response => response.json() as Promise<FindAddressResponse>)
         .then(data => resolve(this.formatItems(data)))
-        .catch(error => reject(Error(error)));
+        .catch(error => reject(Error(String(error))));
     });
   }
 
   public get(id: string): Promise<Record<string, string>> {
     return new Promise((resolve, reject) => {
       fetch(`${this.retrieveUrl}&Id=${id}`)
-        .then(response => response.json())
+        .then(response => response.json() as Promise<RetrieveAddressResponse>)
         .then(data => resolve(AddressLookup.formatUkAddress(data)))
-        .catch(error => reject(Error(error)));
+        .catch(error => reject(Error(String(error))));
     });
   }
 

package/src/airbrake/index.ts

@@ -11,7 +11,7 @@ const fakeNotify = () => {
   if (process.env.NODE_ENV === "test") {
     return jest.fn();
   }
-  // eslint-disable-next-line no-console
+
   return console.error;
 };
 

package/src/mocks/eventDefinitions.ts

@@ -1,4 +1,4 @@
-import { ParamsType } from "../snowplow";
+import type { ParamsType } from "../snowplow";
 import { redact } from "../snowplow/event-definitions/redaction";
 
 export default [
@@ -19,8 +19,8 @@ export default [
     name: "questionAnswered",
     type: "unstructured",
     makePayload: (params: ParamsType) => {
-      const { section, context } = params as ParamsType;
-      const { question, answer } = redact(params as ParamsType);
+      const { section, context } = params;
+      const { question, answer } = redact(params);
 
       return {
         schema:
@@ -43,7 +43,7 @@ export default [
     name: "primaryDetailSelected",
     type: "unstructured",
     makePayload: (params: ParamsType) => {
-      const { context, answer, vertical } = params as ParamsType;
+      const { context, answer, vertical } = params;
       const { site } = context;
       let verticalName = vertical || context.vertical;
 
@@ -59,7 +59,7 @@ export default [
           site,
           vertical: verticalName,
           primary_detail: answer,
-          selected_type: 'trade_selector',
+          selected_type: "trade_selector",
         },
       };
     },
@@ -68,7 +68,7 @@ export default [
     name: "helpTextOpened",
     type: "unstructured",
     makePayload: (params: ParamsType) => {
-      const { primaryText, label, context, helpText } = params as ParamsType;
+      const { primaryText, label, context, helpText } = params;
 
       return {
         schema: "iglu:com.simplybusiness/help_text_opened/jsonschema/1-1-0",

package/src/mocks/snowplowBrowserTrackerMock.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-undef */
 /**
  * Mocking this module prevents requests being sent to
  * Snowplow which causes CORS errors in the test enviornment.

package/src/snowplow/Snowplow.ts

@@ -1,7 +1,9 @@
-import {
+import type {
   PageViewEvent,
   StructuredEvent,
   TrackerConfiguration,
+} from "@snowplow/browser-tracker";
+import {
   newTracker,
   setCookiePath,
   setUserId,
@@ -10,7 +12,7 @@ import {
   trackStructEvent,
 } from "@snowplow/browser-tracker";
 import { makeContexts, updateIdentityContext } from "./contexts";
-import { EventDefinition, SerialisedEvent, TrackingProps } from "./types";
+import type { EventDefinition, SerialisedEvent, TrackingProps } from "./types";
 
 export type FrontOfficeStructuredEvent = StructuredEvent & {
   serviceChannelIdentifier: string;
@@ -105,9 +107,9 @@ export class Snowplow {
   }
 
   // Send a page view event
-  async trackView(event?: PageViewEvent) {
+  trackView(event?: PageViewEvent) {
     if (this.trackPageView) {
-      await trackPageView({ ...event, context: this.pvContext }, [
+      trackPageView({ ...event, context: this.pvContext }, [
         this.avalancheTrackerName,
       ]);
     }
@@ -115,28 +117,25 @@ export class Snowplow {
   }
 
   // Send a structured event with contexts
-  async trackEvent(event: StructuredEvent) {
-    await trackStructEvent({ ...event, context: this.structContext }, [
+  trackEvent(event: StructuredEvent) {
+    trackStructEvent({ ...event, context: this.structContext }, [
       this.bronzeAvalancheTrackerName,
     ]);
     return this;
   }
 
   // Send a custom event with defined schema and optional contexts
-  async trackUnstructEvent(event: SerialisedEvent, contexts?: string[]) {
+  trackUnstructEvent(event: SerialisedEvent, contexts?: string[]) {
     if (!event) {
       return this;
     }
 
     if (contexts && Array.isArray(contexts) && contexts.length > 0) {
       // Add context to the event
-      const context = makeContexts(contexts!, this.contexts);
-
-      await trackSelfDescribingEvent({ event, context }, [
-        this.avalancheTrackerName,
-      ]);
+      const context = makeContexts(contexts, this.contexts);
+      trackSelfDescribingEvent({ event, context }, [this.avalancheTrackerName]);
     } else {
-      await trackSelfDescribingEvent({ event }, [this.avalancheTrackerName]);
+      trackSelfDescribingEvent({ event }, [this.avalancheTrackerName]);
     }
     return this;
   }
@@ -149,7 +148,7 @@ export class Snowplow {
       // Convert type into relevant function
       if (type === "structured") {
         this.addEventHandler(name, (params?: Record<string, unknown>) => {
-          this.trackEvent(
+          void this.trackEvent(
             makePayload({
               ...params,
               context,
@@ -164,9 +163,9 @@ export class Snowplow {
           }) as SerialisedEvent;
 
           if (contexts && Array.isArray(contexts) && contexts.length > 0) {
-            this.trackUnstructEvent(payload, contexts);
+            void this.trackUnstructEvent(payload, contexts);
           } else {
-            this.trackUnstructEvent(payload);
+            void this.trackUnstructEvent(payload);
           }
         });
       }

package/src/snowplow/SnowplowContext.test.tsx

@@ -2,7 +2,7 @@ import { render, screen } from "@testing-library/react";
 import { pageData } from "../mocks/scripts-mock";
 import { getSnowplowConfig } from "./getSnowplowConfig";
 import { SnowplowProvider } from "./SnowplowContext";
-import { PageDataProps } from "./types";
+import type { PageDataProps } from "./types";
 
 const pageDataWithoutScripts = {
   ...pageData,

package/src/snowplow/SnowplowContext.tsx

@@ -11,7 +11,7 @@ import {
 import { getContexts } from "./contexts";
 import { eventDefinitions } from "./event-definitions";
 import { Snowplow } from "./Snowplow";
-import { EventDefinition, TrackingProps } from "./types";
+import type { EventDefinition, TrackingProps } from "./types";
 
 export interface SnowplowContextInterface {
   config: TrackingProps;
@@ -34,11 +34,11 @@ export const SnowplowProvider = ({ scripts, children }: ProviderProps) => {
     if (snowplow.current && scripts) {
       const contexts = getContexts(config);
 
-      snowplow.current
-        .setContexts(contexts)
-        .addEventHandlers(eventDefinitions as EventDefinition[]);
+      snowplow.current.setContexts(contexts).addEventHandlers(eventDefinitions);
       // Send page view event
-      if (config.trackPageView) snowplow.current.trackView();
+      if (config.trackPageView) {
+        void snowplow.current.trackView();
+      }
     }
   }, [config, snowplow, scripts]);
 

package/src/snowplow/contexts.test.ts

@@ -1,7 +1,7 @@
 import { pageData } from "../mocks/scripts-mock";
 import { getContexts, makeContexts, updateIdentityContext } from "./contexts";
 import { getSnowplowConfig } from "./getSnowplowConfig";
-import { PageDataProps, TrackingProps } from "./types";
+import type { PageDataProps, TrackingProps } from "./types";
 
 describe("Snowplow Contexts", () => {
   it("should extract all context records from snowplow props", () => {

package/src/snowplow/contexts.ts

@@ -1,5 +1,5 @@
 import { snakeCaseKeys } from "../utils";
-import { SerialisedEvent, TrackingProps } from "./types";
+import type { SerialisedEvent, TrackingProps } from "./types";
 
 export const getContexts = (
   config: TrackingProps,

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

@@ -1,4 +1,4 @@
-import { EventDefinition, ParamsType } from "../types";
+import type { EventDefinition, ParamsType } from "../types";
 /**
  * Event definitions for Snowplow
  * @type {EventDefinition[]}

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

@@ -1,4 +1,4 @@
-import { EventDefinition } from "../types";
+import type { EventDefinition } from "../types";
 
 type InterventionIdTypes = "duid"; // Add more values as needed
 

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

@@ -1,4 +1,4 @@
-import { EventDefinition, ParamsType } from "../types";
+import type { EventDefinition, ParamsType } from "../types";
 import { redact } from "./redaction";
 import { DELIMITER } from "../constants";
 import { snakeCase } from "../../utils";

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

@@ -1,5 +1,5 @@
 import { snakeCase } from "../../utils";
-import { EventDefinition, LinkType, ParamsType } from "../types";
+import type { EventDefinition, LinkType, ParamsType } from "../types";
 
 // QCP page events
 export const qcpEventDefinitions: EventDefinition[] = [

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

@@ -1,5 +1,5 @@
 import { DELIMITER } from "../constants";
-import { EventDefinition, ParamsType } from "../types";
+import type { EventDefinition, ParamsType } from "../types";
 import { redact } from "./redaction";
 
 // Questionnaire events

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

@@ -1,4 +1,4 @@
-import { ParamsType } from "../types";
+import type { ParamsType } from "../types";
 
 const PII_ANSWER = [
   "customer_title",
@@ -131,7 +131,7 @@ const RADIO_ANSWER_FROM_QUESTIONS = [
 const ANSWER_SUFFIX_PATTERN = /_(yes|no)$/;
 
 export const redact = (params: ParamsType) => {
-  let { question, answer } = params as ParamsType;
+  let { question, answer } = params;
 
   const piiAnswer = new Set(PII_ANSWER);
   const radioAnswerFromQuestions = new Set(RADIO_ANSWER_FROM_QUESTIONS);

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

@@ -1,4 +1,4 @@
-import { EventDefinition, ParamsType } from "../types";
+import type { EventDefinition, ParamsType } from "../types";
 
 // Referral page events
 export const referralEventDefinitions: EventDefinition[] = [

package/src/snowplow/index.test.ts

@@ -1,11 +1,11 @@
 import * as SnowplowLib from "@snowplow/browser-tracker";
-import { waitFor } from "@testing-library/dom";
+import { waitFor } from "@testing-library/react";
 import eventDefinitions from "../mocks/eventDefinitions";
 import { pageData } from "../mocks/scripts-mock";
 import { getContexts, makeContexts } from "./contexts";
 import { getSnowplowConfig } from "./getSnowplowConfig";
 import { Snowplow } from "./Snowplow";
-import { EventDefinition, PageDataProps, TrackingProps } from "./types";
+import type { EventDefinition, PageDataProps, TrackingProps } from "./types";
 
 const snowplowProps = getSnowplowConfig(pageData as PageDataProps);
 const contexts = getContexts(snowplowProps as TrackingProps);
@@ -49,17 +49,26 @@ describe("Snowplow Analytics Class", () => {
         .spyOn(SnowplowLib, "trackPageView")
         .mockImplementation(() => {});
 
-      await testSnowplow.trackView();
+      testSnowplow.trackView();
 
-      waitFor(() => {
+      await waitFor(() => {
         expect(trackViewSpy).toHaveBeenCalledTimes(1);
+      });
+      await waitFor(() => {
         expect(trackViewSpy).toHaveBeenCalledWith();
+      });
+      await waitFor(() => {
         expect(innerSpy).toHaveBeenCalledTimes(1);
-        expect(innerSpy).toHaveBeenCalledWith({});
+      });
+      await waitFor(() => {
+        expect(innerSpy).toHaveBeenCalledWith(
+          { context: testSnowplow.pvContext },
+          ["sb-ava"],
+        );
       });
     });
 
-    it("tracks structured event and adds contexts", async () => {
+    it("tracks structured event and adds contexts", () => {
       const trackStructEventSpy = jest.spyOn(testSnowplow, "trackEvent");
       const innerSpy = jest
         .spyOn(SnowplowLib, "trackStructEvent")
@@ -71,7 +80,7 @@ describe("Snowplow Analytics Class", () => {
         label: "test-label",
       };
 
-      await testSnowplow.trackEvent(payload);
+      testSnowplow.trackEvent(payload);
 
       expect(trackStructEventSpy).toHaveBeenCalledTimes(1);
       expect(trackStructEventSpy).toHaveBeenCalledWith(payload);
@@ -82,7 +91,7 @@ describe("Snowplow Analytics Class", () => {
       );
     });
 
-    it("tracks self-describing event and adds contexts", async () => {
+    it("tracks self-describing event and adds contexts", () => {
       const trackUnstructEventSpy = jest.spyOn(
         testSnowplow,
         "trackUnstructEvent",
@@ -102,7 +111,7 @@ describe("Snowplow Analytics Class", () => {
         },
       };
 
-      await testSnowplow.trackUnstructEvent(testEvent);
+      testSnowplow.trackUnstructEvent(testEvent);
       expect(trackUnstructEventSpy).toHaveBeenCalledTimes(1);
       expect(trackUnstructEventSpy).toHaveBeenCalledWith(testEvent);
       expect(innerSpy).toHaveBeenCalledTimes(1);
@@ -125,7 +134,7 @@ describe("Snowplow Analytics Class", () => {
         ]);
       });
 
-      it("triggers an added structured event", async () => {
+      it("triggers an added structured event", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackStructEventSpy = jest.spyOn(testSnowplow, "trackEvent");
@@ -133,7 +142,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackStructEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("navButtonClicked", { label: "test-label" });
+        testSnowplow.trigger("navButtonClicked", { label: "test-label" });
 
         const expectedPayload = {
           category: "navigation",
@@ -151,7 +160,7 @@ describe("Snowplow Analytics Class", () => {
         );
       });
 
-      it("triggers an added unstructured event", async () => {
+      it("triggers an added unstructured event", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackUnstructEventSpy = jest.spyOn(
@@ -162,7 +171,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackSelfDescribingEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("questionAnswered", {
+        testSnowplow.trigger("questionAnswered", {
           question: "test-question",
           section: "test-section",
           answer: "test-answer",
@@ -197,7 +206,7 @@ describe("Snowplow Analytics Class", () => {
         );
       });
 
-      it("triggers an added unstructured event and readact the pii information and replace question name", async () => {
+      it("triggers an added unstructured event and readact the pii information and replace question name", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackUnstructEventSpy = jest.spyOn(
@@ -208,7 +217,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackSelfDescribingEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("questionAnswered", {
+        testSnowplow.trigger("questionAnswered", {
           question: "sof_bankrupt_yes",
           section: "agreements",
           answer: "Yes",
@@ -243,7 +252,7 @@ describe("Snowplow Analytics Class", () => {
         );
       });
 
-      it("triggers an added unstructured event and replace radio answer from questions", async () => {
+      it("triggers an added unstructured event and replace radio answer from questions", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackUnstructEventSpy = jest.spyOn(
@@ -254,7 +263,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackSelfDescribingEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("questionAnswered", {
+        testSnowplow.trigger("questionAnswered", {
           question: "have_secondary_trade_yes",
           section: "about_your_business",
           answer: "Yes",
@@ -289,7 +298,7 @@ describe("Snowplow Analytics Class", () => {
         );
       });
 
-      it("triggers an added unstructured event for address lookup type questions", async () => {
+      it("triggers an added unstructured event for address lookup type questions", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackUnstructEventSpy = jest.spyOn(
@@ -300,7 +309,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackSelfDescribingEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("questionAnswered", {
+        testSnowplow.trigger("questionAnswered", {
           question: "address_lookup",
           section: "about_your_business",
           answer: "123 Test Street",
@@ -348,7 +357,7 @@ describe("Snowplow Analytics Class", () => {
         ["Anything", "test", "Anything"],
       ])(
         "triggers an primary_detail_selected event %s",
-        async (initialVertical, answer, vertical) => {
+        (initialVertical, answer, vertical) => {
           testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
           const trackUnstructEventSpy = jest.spyOn(
@@ -359,7 +368,7 @@ describe("Snowplow Analytics Class", () => {
             .spyOn(SnowplowLib, "trackSelfDescribingEvent")
             .mockImplementation(() => {});
 
-          await testSnowplow.trigger("primaryDetailSelected", {
+          testSnowplow.trigger("primaryDetailSelected", {
             answer,
             vertical: initialVertical,
           });
@@ -371,7 +380,7 @@ describe("Snowplow Analytics Class", () => {
               vertical,
               primary_detail: answer,
               site: "simplybusiness_us",
-              selected_type: "trade_selector"
+              selected_type: "trade_selector",
             },
           };
 
@@ -387,7 +396,7 @@ describe("Snowplow Analytics Class", () => {
         },
       );
 
-      it("triggers an added unstructured help_text_opened event", async () => {
+      it("triggers an added unstructured help_text_opened event", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackUnstructEventSpy = jest.spyOn(
@@ -398,7 +407,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackSelfDescribingEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("helpTextOpened", {
+        testSnowplow.trigger("helpTextOpened", {
           primaryText: "Sample text",
           label: "Sample label",
           helpText: "Sample help text",
@@ -427,7 +436,7 @@ describe("Snowplow Analytics Class", () => {
         );
       });
 
-      it("uses server-supplied context in events", async () => {
+      it("uses server-supplied context in events", () => {
         testSnowplow.addEventHandlers(eventDefinitions as EventDefinition[]);
 
         const trackUnstructEventSpy = jest.spyOn(
@@ -438,7 +447,7 @@ describe("Snowplow Analytics Class", () => {
           .spyOn(SnowplowLib, "trackSelfDescribingEvent")
           .mockImplementation(() => {});
 
-        await testSnowplow.trigger("questionAnswered", {
+        testSnowplow.trigger("questionAnswered", {
           question: "test-question",
           section: "test-section",
           answer: "test-answer",

package/src/snowplow/types.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   EventMethod,
   SelfDescribingJson,
   StructuredEvent,

package/src/utils/isObject.test.tsx

@@ -29,6 +29,7 @@ describe("isObject", () => {
   });
 
   it("should return false for objects with different prototypes", () => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const obj = Object.create(null);
     expect(isObject(obj)).toBeFalsy();
   });

package/src/utils/isObject.tsx

@@ -1,8 +1,8 @@
 export function isObject(value: unknown): value is Record<string, unknown> {
-    return (
-      typeof value === "object" &&
-      value !== null &&
-      !Array.isArray(value) &&
-      Object.getPrototypeOf(value) === Object.prototype
-    );
-  }
+  return (
+    typeof value === "object" &&
+    value !== null &&
+    !Array.isArray(value) &&
+    Object.getPrototypeOf(value) === Object.prototype
+  );
+}

package/src/utils/testUtils.tsx

@@ -1,10 +1,10 @@
-/* eslint-disable import/no-extraneous-dependencies */
-import { RenderOptions, render } from "@testing-library/react";
-import { ReactElement, ReactNode } from "react";
+import type { RenderOptions } from "@testing-library/react";
+import { render } from "@testing-library/react";
+import type { ReactElement, ReactNode } from "react";
 import { pageData } from "../mocks/scripts-mock";
 import { SnowplowProvider } from "../snowplow/SnowplowContext";
 import { getSnowplowConfig } from "../snowplow/getSnowplowConfig";
-import { PageDataProps } from "../snowplow/types";
+import type { PageDataProps } from "../snowplow/types";
 
 // Snowplow analytics
 const snowplowProps = getSnowplowConfig(pageData as PageDataProps);

package/src/utils/text.test.ts

@@ -1,8 +1,4 @@
-import {
-  camelToSnakeCase,
-  snakeCase,
-  snakeCaseKeys,
-} from "./text";
+import { camelToSnakeCase, snakeCase, snakeCaseKeys } from "./text";
 
 describe("text utils", () => {
   test("snakeCase", () => {

package/src/utils/text.ts

@@ -38,4 +38,3 @@ export const camelToSnakeCase = (text: string) =>
     .replace(/(\[.*?\])|[A-Z]/g, (match, group) =>
       group ? match : `_${match.toLowerCase()}`,
     );
-