@paypal/checkout-components 5.0.422 → 5.0.423

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paypal/checkout-components",
-  "version": "5.0.422",
+  "version": "5.0.423",
   "description": "PayPal Checkout components, for integrating checkout products.",
   "main": "index.js",
   "scripts": {

package/src/ui/buttons/props.js

@@ -662,6 +662,7 @@ export type ButtonProps = {|
   hideSubmitButtonForCardForm?: boolean,
   userAgent: string,
   browserContext?: string,
+  merchantDomain?: string,
   buttonColor: ButtonColor,
 |};
 

package/src/zoid/buttons/component.jsx

@@ -109,6 +109,7 @@ import {
   getModal,
   sendPostRobotMessageToButtonIframe,
   isEagerOrderCreationEnabled,
+  resolveMerchantDomain,
 } from "./util";
 
 export type ButtonsComponent = ZoidComponent<
@@ -888,6 +889,13 @@ export const getButtonsComponent: () => ButtonsComponent = memoize(() => {
         queryParam: true,
       },
 
+      merchantDomain: {
+        type: "string",
+        required: false,
+        sendToChild: true,
+        value: ({ props }) => resolveMerchantDomain(props.merchantDomain),
+      },
+
       intent: {
         type: "string",
         queryParam: true,

package/src/zoid/buttons/util.js

@@ -27,6 +27,7 @@ import {
   getFundingEligibility,
   getSDKToken,
   getIntent,
+  isPayPalDomain,
 } from "@paypal/sdk-client/src";
 import { FUNDING, FPTI_KEY, INTENT } from "@paypal/sdk-constants/src";
 import { getRefinedFundingEligibility } from "@paypal/funding-components/src";
@@ -426,3 +427,14 @@ export const isEagerOrderCreationEnabled = (
       experiment.spbEagerOrderCreation
   );
 };
+
+// merchantDomain is only accepted on PayPal-hosted flows (e.g. NCPS).
+// There the page origin resolves to a PayPal Domain, so the hosting service must supply
+// the true merchant origin. On merchant-hosted pages browser origin is alreadyy the merchant's,
+// so an explictly passed value is rejected
+export function resolveMerchantDomain(merchantDomain: ?string): ?string {
+  if (merchantDomain && !isPayPalDomain()) {
+    throw new Error("merchantDomain can only be passed on PayPal-hosted flows");
+  }
+  return merchantDomain || undefined;
+}

package/src/zoid/buttons/util.test.js

@@ -0,0 +1,40 @@
+/* @flow */
+
+import { describe, expect, it, vi } from "vitest";
+import { isPayPalDomain } from "@paypal/sdk-client/src";
+
+import { resolveMerchantDomain } from "./util";
+
+vi.mock("@paypal/sdk-client/src", () => ({
+  isPayPalDomain: vi.fn(),
+}));
+
+describe("resolveMerchantDomain", () => {
+  it("returns the merchantDomain on a PayPal-hosted page", () => {
+    vi.mocked(isPayPalDomain).mockReturnValue(true);
+
+    expect(resolveMerchantDomain("https://merchant.example.com")).toBe(
+      "https://merchant.example.com"
+    );
+  });
+
+  it("returns undefined on a PayPal-hosted page when no merchantDomain is provided", () => {
+    vi.mocked(isPayPalDomain).mockReturnValue(true);
+
+    expect(resolveMerchantDomain()).toBeUndefined();
+  });
+
+  it("returns undefined on a merchant-hosted page when no merchantDomain is provided", () => {
+    vi.mocked(isPayPalDomain).mockReturnValue(false);
+
+    expect(resolveMerchantDomain()).toBeUndefined();
+  });
+
+  it("throws when a merchantDomain is passed on a non-PayPal (merchant-hosted) page", () => {
+    vi.mocked(isPayPalDomain).mockReturnValue(false);
+
+    expect(() => resolveMerchantDomain("https://merchant.example.com")).toThrow(
+      "merchantDomain can only be passed on PayPal-hosted flows"
+    );
+  });
+});