@paypal/checkout-components 5.0.291 → 5.0.292

package/src/api/shopper-insights/validation.test.js

@@ -0,0 +1,155 @@
+/* @flow */
+import { vi, describe, expect } from "vitest";
+
+import { validateMerchantConfig, validateMerchantPayload } from "./validation";
+
+vi.mock("@paypal/sdk-client/src", () => {
+  return {
+    sendCountMetric: vi.fn(),
+  };
+});
+
+describe("shopper insights merchant SDK config validation", () => {
+  test("should throw if sdk token is not passed", () => {
+    expect(() =>
+      validateMerchantConfig({
+        sdkToken: "",
+        pageType: "",
+        userIDToken: "",
+        clientToken: "",
+      })
+    ).toThrowError(
+      "script data attribute sdk-client-token is required but was not passed"
+    );
+  });
+
+  test("should throw if page type is not passed", () => {
+    expect(() =>
+      validateMerchantConfig({
+        sdkToken: "sdk-token",
+        pageType: "",
+        userIDToken: "",
+        clientToken: "",
+      })
+    ).toThrowError(
+      "script data attribute page-type is required but was not passed"
+    );
+  });
+
+  test("should throw if ID token is passed", () => {
+    expect(() =>
+      validateMerchantConfig({
+        sdkToken: "sdk-token",
+        pageType: "product-listing",
+        userIDToken: "id-token",
+        clientToken: "",
+      })
+    ).toThrowError(
+      "use script data attribute sdk-client-token instead of user-id-token"
+    );
+  });
+});
+
+describe("shopper insights merchant payload validation", () => {
+  test("should have successful validation if email is only passed", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: {
+          email: "email@test.com",
+        },
+      })
+    ).not.toThrowError();
+  });
+
+  test("should have successful validation if phone is only passed", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: {
+          phone: {
+            countryCode: "1",
+            nationalNumber: "2345678901",
+          },
+        },
+      })
+    ).not.toThrowError();
+  });
+
+  test("should have successful validation if email and phone is passed", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: {
+          email: "email@test.com",
+          phone: {
+            countryCode: "1",
+            nationalNumber: "2345678901",
+          },
+        },
+      })
+    ).not.toThrowError();
+  });
+
+  test("should throw if email or phone is not passed", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: {},
+      })
+    ).toThrowError(
+      "Expected shopper information to include an email or phone number"
+    );
+  });
+
+  test("should throw if countryCode or nationalNumber in phone is not passed or is empty", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: {
+          phone: {
+            nationalNumber: "",
+            countryCode: "",
+          },
+        },
+      })
+    ).toThrowError(
+      "Expected shopper information to include an email or phone number"
+    );
+
+    expect(() =>
+      validateMerchantPayload(
+        // $FlowFixMe
+        { customer: { phone: {} } }
+      )
+    ).toThrowError(
+      "Expected shopper information to include an email or phone number"
+    );
+    expect.assertions(2);
+  });
+
+  test("should throw if phone is in an invalid format", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: { phone: { countryCode: "1", nationalNumber: "2.354" } },
+      })
+    ).toThrowError(
+      "Expected shopper information to a valid phone number format"
+    );
+    expect(() =>
+      validateMerchantPayload({
+        customer: { phone: { countryCode: "1", nationalNumber: "2-354" } },
+      })
+    ).toThrowError(
+      "Expected shopper information to a valid phone number format"
+    );
+    expect.assertions(2);
+  });
+
+  test("should throw if email is in an invalid format", () => {
+    expect(() =>
+      validateMerchantPayload({
+        customer: {
+          email: "123",
+        },
+      })
+    ).toThrowError(
+      "Expected shopper information to include a valid email format"
+    );
+  });
+});

package/src/constants/api.js

@@ -0,0 +1,29 @@
+/* @flow */
+
+export const HEADERS = {
+  AUTHORIZATION: "authorization",
+  CONTENT_TYPE: "content-type",
+  PARTNER_ATTRIBUTION_ID: "paypal-partner-attribution-id",
+  CLIENT_METADATA_ID: "paypal-client-metadata-id",
+};
+
+export const ELIGIBLE_PAYMENT_METHODS = "v2/payments/find-eligible-methods";
+
+export const FPTI_TRANSITION = {
+  SHOPPER_INSIGHTS_API_INIT: "sdk_shopper_insights_recommended_init",
+  SHOPPER_INSIGHTS_API_SUCCESS: "sdk_shopper_insights_recommended_success",
+  SHOPPER_INSIGHTS_API_ERROR: "sdk_shopper_insights_recommended_error",
+};
+
+export const SHOPPER_INSIGHTS_METRIC_NAME =
+  "pp.app.paypal_sdk.api.shopper_insights.count";
+
+export type MerchantPayloadData = {|
+  customer: {|
+    email?: string,
+    phone?: {|
+      countryCode?: string,
+      nationalNumber?: string,
+    |},
+  |},
+|};