@simplybusiness/services 2.7.7 → 2.9.0

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

@@ -927,4 +927,82 @@ describe("questionnaireEventDefinitions", () => {
       });
     });
   });
+
+  describe("interstitialUsPhoneNumberSmsConsentSkipped", () => {
+    it("should create correct payload", () => {
+      const result = findEventByName(
+        questionnaireEventDefinitions,
+        "interstitialUsPhoneNumberSmsConsentSkipped",
+      ).makePayload({});
+
+      expect(result).toEqual({
+        category: "us_phone_number_modal",
+        action: "interstitial_us_phone_number_sms_consent_skipped",
+        property: window?.location?.href ?? "",
+      });
+    });
+  });
+
+  describe("interstitialUsPhoneNumberSubmitted", () => {
+    it("should create correct payload with consent label and view name", () => {
+      const result = findEventByName(
+        questionnaireEventDefinitions,
+        "interstitialUsPhoneNumberSubmitted",
+      ).makePayload({
+        consentLabel: "Yes, I agree",
+        viewName: "smsConsent",
+      });
+
+      expect(result).toEqual({
+        category: "us_phone_number_modal",
+        action: "interstitial_us_phone_number_submitted",
+        label: "consent_given_from_smsConsent",
+        property: window?.location?.href ?? "",
+      });
+    });
+
+    it("should handle empty consent label and view name", () => {
+      const result = findEventByName(
+        questionnaireEventDefinitions,
+        "interstitialUsPhoneNumberSubmitted",
+      ).makePayload({});
+
+      expect(result).toEqual({
+        category: "us_phone_number_modal",
+        action: "interstitial_us_phone_number_submitted",
+        label: "no_consent_from_no_view",
+        property: window?.location?.href ?? "",
+      });
+    });
+  });
+
+  describe("interstitialUsPhoneNumberInvalidPhoneNumber", () => {
+    it("should create correct payload", () => {
+      const result = findEventByName(
+        questionnaireEventDefinitions,
+        "interstitialUsPhoneNumberInvalidPhoneNumber",
+      ).makePayload({});
+
+      expect(result).toEqual({
+        category: "us_phone_number_modal",
+        action: "interstitial_us_invalid_phone_number_submitted",
+        label: "invalid_phone_number_submitted_from_no_view",
+        property: window?.location?.href ?? "",
+      });
+    });
+
+    it("should include viewName in label when provided", () => {
+      const result = findEventByName(
+        questionnaireEventDefinitions,
+        "interstitialUsPhoneNumberInvalidPhoneNumber",
+      ).makePayload({ viewName: "smsConsent" });
+
+      expect(result).toEqual({
+        category: "us_phone_number_modal",
+        action: "interstitial_us_invalid_phone_number_submitted",
+        label: "invalid_phone_number_submitted_from_smsConsent",
+        property: window?.location?.href ?? "",
+      });
+    });
+  });
 });

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

@@ -359,4 +359,47 @@ export const questionnaireEventDefinitions: EventDefinition[] = [
       };
     },
   },
+  {
+    name: "interstitialUsPhoneNumberSmsConsentSkipped",
+    type: "structured",
+    makePayload: () => {
+      return {
+        category: "us_phone_number_modal",
+        action: "interstitial_us_phone_number_sms_consent_skipped",
+        property: window?.location?.href ?? "",
+      };
+    },
+  },
+  {
+    name: "interstitialUsPhoneNumberSubmitted",
+    type: "structured",
+    makePayload: params => {
+      const { consentLabel, viewName } = params as ParamsType;
+      const consent = consentLabel?.trim();
+      const consentName =
+        consent === "Yes, I agree" ? "consent_given" : consent || "no_consent";
+      const name = viewName?.trim() || "no_view";
+
+      return {
+        category: "us_phone_number_modal",
+        action: "interstitial_us_phone_number_submitted",
+        label: `${consentName}_from_${name}`,
+        property: window?.location?.href ?? "",
+      };
+    },
+  },
+  {
+    name: "interstitialUsPhoneNumberInvalidPhoneNumber",
+    type: "structured",
+    makePayload: params => {
+      const { viewName } = params as ParamsType;
+      const name = viewName?.trim() || "no_view";
+      return {
+        category: "us_phone_number_modal",
+        action: "interstitial_us_invalid_phone_number_submitted",
+        label: `invalid_phone_number_submitted_from_${name}`,
+        property: window?.location?.href ?? "",
+      };
+    },
+  },
 ];

package/src/snowplow/index.test.ts

@@ -5,13 +5,13 @@ import { pageData } from "../mocks/scripts-mock";
 import { getContexts, makeContexts } from "./contexts";
 import { getSnowplowConfig } from "./getSnowplowConfig";
 import { Snowplow } from "./Snowplow";
-import type { EventDefinition, PageDataProps, TrackingProps } from "./types";
+import type { EventDefinition, TrackingProps } from "./types";
 
-const snowplowProps = getSnowplowConfig(pageData as PageDataProps);
+const snowplowProps = getSnowplowConfig(pageData);
 const contexts = getContexts(snowplowProps as TrackingProps);
 const fqaContext = makeContexts(["distributionChannelContext"], contexts);
 
-let testSnowplow = new Snowplow(snowplowProps as TrackingProps);
+let testSnowplow = new Snowplow(snowplowProps);
 testSnowplow.setContexts(contexts);
 
 describe("Snowplow Analytics Class", () => {
@@ -24,14 +24,14 @@ describe("Snowplow Analytics Class", () => {
 
   describe("given snowplowProps exist", () => {
     beforeEach(() => {
-      testSnowplow = new Snowplow(snowplowProps as TrackingProps);
+      testSnowplow = new Snowplow(snowplowProps);
       testSnowplow.setContexts(contexts);
       vi.clearAllMocks();
       vi.resetModules();
     });
 
     it("exports a Singleton instance with static properties", () => {
-      const secondInstance = new Snowplow(snowplowProps as TrackingProps);
+      const secondInstance = new Snowplow(snowplowProps);
       secondInstance.setContexts(contexts);
 
       expect(testSnowplow).toEqual(secondInstance);

package/src/utils/testUtils.tsx

@@ -4,10 +4,9 @@ import type { ReactElement, ReactNode } from "react";
 import { pageData } from "../mocks/scripts-mock";
 import { SnowplowProvider } from "../snowplow/SnowplowContext";
 import { getSnowplowConfig } from "../snowplow/getSnowplowConfig";
-import type { PageDataProps } from "../snowplow/types";
 
 // Snowplow analytics
-const snowplowProps = getSnowplowConfig(pageData as PageDataProps);
+const snowplowProps = getSnowplowConfig(pageData);
 
 const ProvidersMock = ({ children }: { children: ReactNode }) => (
   <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>