@paypal/checkout-components 5.0.292 → 5.0.293-alpha.11

package/src/hosted-buttons/types.js

@@ -0,0 +1,53 @@
+/* @flow */
+
+import { ZalgoPromise } from "@krakenjs/zalgo-promise/src";
+
+export type HostedButtonsComponentProps = {|
+  hostedButtonId: string,
+|};
+
+export type GetCallbackProps = {|
+  hostedButtonId: string,
+  merchantId: string,
+|};
+
+export type HostedButtonsInstance = {|
+  render: (string | HTMLElement) => void,
+|};
+
+export type HostedButtonDetailsParams =
+  (HostedButtonsComponentProps) => ZalgoPromise<{|
+    html: string,
+    htmlScript: string,
+    style: {|
+      layout: string,
+      shape: string,
+      color: string,
+      label: string,
+    |},
+  |}>;
+
+export type ButtonVariables = $ReadOnlyArray<{|
+  name: string,
+  value: string,
+|}>;
+
+export type CreateOrder = (data: {|
+  paymentSource: string,
+|}) => ZalgoPromise<string>;
+
+export type OnApprove = (data: {|
+  orderID: string,
+  paymentSource: string,
+|}) => ZalgoPromise<void>;
+
+export type CreateAccessToken = (clientID: string) => ZalgoPromise<string>;
+
+export type HostedButtonsComponent =
+  (HostedButtonsComponentProps) => HostedButtonsInstance;
+
+export type RenderForm = {|
+  html: string,
+  htmlScript: string,
+  selector: string | HTMLElement,
+|};

package/src/hosted-buttons/utils.js

@@ -0,0 +1,144 @@
+/* @flow */
+
+import { request, memoize, popup } from "@krakenjs/belter/src";
+import { getSDKHost, getClientID } from "@paypal/sdk-client/src";
+
+import { DEFAULT_POPUP_SIZE } from "../zoid/checkout";
+
+import type {
+  ButtonVariables,
+  CreateAccessToken,
+  CreateOrder,
+  GetCallbackProps,
+  HostedButtonDetailsParams,
+  OnApprove,
+  RenderForm,
+} from "./types";
+
+const entryPoint = "SDK";
+const baseUrl = `https://${getSDKHost()}`;
+const apiUrl = baseUrl.replace("www", "api");
+
+const getHeaders = (accessToken?: string) => ({
+  ...(accessToken && { Authorization: `Bearer ${accessToken}` }),
+  "Content-Type": "application/json",
+  "PayPal-Entry-Point": entryPoint,
+});
+
+export const createAccessToken: CreateAccessToken = memoize<CreateAccessToken>(
+  (clientId) => {
+    return request({
+      url: `${apiUrl}/v1/oauth2/token`,
+      method: "POST",
+      body: "grant_type=client_credentials",
+      headers: {
+        Authorization: `Basic ${btoa(clientId)}`,
+        "Content-Type": "application/json",
+      },
+    }).then((response) => response.body.access_token);
+  }
+);
+
+const getButtonVariable = (variables: ButtonVariables, key: string): string =>
+  variables?.find((variable) => variable.name === key)?.value ?? "";
+
+const getFundingSource = (paymentSource) => {
+  if (paymentSource === "credit") {
+    return `CARD`;
+  }
+  return paymentSource.toUpperCase();
+};
+
+export const getHostedButtonDetails: HostedButtonDetailsParams = ({
+  hostedButtonId,
+}) => {
+  return request({
+    url: `${baseUrl}/ncp/api/form-fields/${hostedButtonId}`,
+    headers: getHeaders(),
+  }).then(({ body }) => {
+    const variables = body.button_details.link_variables;
+    return {
+      style: {
+        layout: getButtonVariable(variables, "layout"),
+        shape: getButtonVariable(variables, "shape"),
+        color: getButtonVariable(variables, "color"),
+        label: getButtonVariable(variables, "button_text"),
+      },
+      html: body.html,
+      htmlScript: body.html_script,
+    };
+  });
+};
+
+/**
+ * Attaches form fields (html) to the given selector, and
+ * initializes window.__pp_form_fields (htmlScript).
+ */
+export const renderForm = ({
+  html,
+  htmlScript,
+  selector,
+}: RenderForm): void => {
+  const elm =
+    typeof selector === "string" ? document.querySelector(selector) : selector;
+  if (elm) {
+    elm.innerHTML = html + htmlScript;
+    const newScriptEl = document.createElement("script");
+    const oldScriptEl = elm.querySelector("script");
+    newScriptEl.innerHTML = oldScriptEl?.innerHTML ?? "";
+    oldScriptEl?.parentNode?.replaceChild(newScriptEl, oldScriptEl);
+  }
+};
+
+export const buildHostedButtonCreateOrder = ({
+  hostedButtonId,
+  merchantId,
+}: GetCallbackProps): CreateOrder => {
+  return (data) => {
+    const userInputs =
+      window[`__pp_form_fields_${hostedButtonId}`]?.getUserInputs?.() || {};
+    return createAccessToken(getClientID()).then((accessToken) => {
+      return request({
+        url: `${apiUrl}/v1/checkout/links/${hostedButtonId}/create-context`,
+        headers: getHeaders(accessToken),
+        method: "POST",
+        body: JSON.stringify({
+          entry_point: entryPoint,
+          funding_source: getFundingSource(data.paymentSource),
+          merchant_id: merchantId,
+          ...userInputs,
+        }),
+      }).then(({ body }) => {
+        return body.context_id;
+      });
+    });
+  };
+};
+
+export const buildHostedButtonOnApprove = ({
+  hostedButtonId,
+  merchantId,
+}: GetCallbackProps): OnApprove => {
+  return (data) => {
+    return createAccessToken(getClientID()).then((accessToken) => {
+      return request({
+        url: `${apiUrl}/v1/checkout/links/${hostedButtonId}/pay`,
+        headers: getHeaders(accessToken),
+        method: "POST",
+        body: JSON.stringify({
+          entry_point: entryPoint,
+          merchant_id: merchantId,
+          context_id: data.orderID,
+        }),
+      }).then(() => {
+        if (data.paymentSource === "card") {
+          const url = `${baseUrl}/ncp/payment/${hostedButtonId}/${data.orderID}`;
+          popup(url, {
+            width: DEFAULT_POPUP_SIZE.WIDTH,
+            height: DEFAULT_POPUP_SIZE.HEIGHT,
+          });
+        }
+      });
+    });
+  };
+};

package/src/hosted-buttons/utils.test.js

@@ -0,0 +1,121 @@
+/* @flow */
+
+import { test, expect, vi } from "vitest";
+import { request } from "@krakenjs/belter/src";
+import { ZalgoPromise } from "@krakenjs/zalgo-promise/src";
+
+import {
+  getHostedButtonDetails,
+  buildHostedButtonCreateOrder,
+  buildHostedButtonOnApprove,
+} from "./utils";
+
+vi.mock("@krakenjs/belter/src", async () => {
+  return {
+    ...(await vi.importActual("@krakenjs/belter/src")),
+    request: vi.fn(),
+  };
+});
+
+vi.mock("@paypal/sdk-client/src", async () => {
+  return {
+    ...(await vi.importActual("@paypal/sdk-client/src")),
+    getSDKHost: () => "example.com",
+    getClientID: () => "client_id_123",
+    getMerchantID: () => ["merchant_id_123"],
+  };
+});
+
+const getHostedButtonDetailsResponse = {
+  body: {
+    button_details: {
+      link_variables: [
+        {
+          name: "business",
+          value: "M1234567890",
+        },
+        {
+          name: "shape",
+          value: "rect",
+        },
+        {
+          name: "layout",
+          value: "vertical",
+        },
+        {
+          name: "color",
+          value: "gold",
+        },
+        {
+          name: "button_text",
+          value: "paypal",
+        },
+      ],
+    },
+  },
+};
+
+test("getHostedButtonDetails", async () => {
+  // $FlowIssue
+  request.mockImplementationOnce(() =>
+    ZalgoPromise.resolve(getHostedButtonDetailsResponse)
+  );
+  await getHostedButtonDetails({
+    hostedButtonId: "B1234567890",
+  }).then(({ style }) => {
+    expect(style).toEqual({
+      layout: "vertical",
+      shape: "rect",
+      color: "gold",
+      label: "paypal",
+    });
+  });
+  expect.assertions(1);
+});
+
+test("buildHostedButtonCreateOrder", async () => {
+  const createOrder = buildHostedButtonCreateOrder({
+    hostedButtonId: "B1234567890",
+    merchantId: "M1234567890",
+  });
+
+  // $FlowIssue
+  request.mockImplementation(() =>
+    ZalgoPromise.resolve({
+      body: {
+        link_id: "B1234567890",
+        merchant_id: "M1234567890",
+        context_id: "EC-1234567890",
+        status: "CREATED",
+      },
+    })
+  );
+  const orderID = await createOrder({ paymentSource: "paypal" });
+  expect(orderID).toBe("EC-1234567890");
+  expect.assertions(1);
+});
+
+test("buildHostedButtonOnApprove", async () => {
+  const onApprove = buildHostedButtonOnApprove({
+    hostedButtonId: "B1234567890",
+    merchantId: "M1234567890",
+  });
+
+  // $FlowIssue
+  request.mockImplementation(() =>
+    ZalgoPromise.resolve({
+      body: {},
+    })
+  );
+  await onApprove({ orderID: "EC-1234567890", paymentSource: "paypal" });
+  expect(request).toHaveBeenCalledWith(
+    expect.objectContaining({
+      body: JSON.stringify({
+        entry_point: "SDK",
+        merchant_id: "M1234567890",
+        context_id: "EC-1234567890",
+      }),
+    })
+  );
+  expect.assertions(1);
+});

package/src/interface/hosted-buttons.js

@@ -0,0 +1,29 @@
+/* @flow */
+
+import { getHostedButtonsComponent } from "../hosted-buttons";
+import type { HostedButtonsComponent } from "../hosted-buttons/types";
+import { getButtonsComponent } from "../zoid/buttons";
+import {
+  getCardFormComponent,
+  type CardFormComponent,
+} from "../zoid/card-form";
+import { getCheckoutComponent, type CheckoutComponent } from "../zoid/checkout";
+import type { LazyExport, LazyProtectedExport } from "../types";
+import { protectedExport } from "../lib";
+
+export const HostedButtons: LazyExport<HostedButtonsComponent> = {
+  __get__: () => getHostedButtonsComponent(),
+};
+
+export const Checkout: LazyProtectedExport<CheckoutComponent> = {
+  __get__: () => protectedExport(getCheckoutComponent()),
+};
+
+export const CardForm: LazyProtectedExport<CardFormComponent> = {
+  __get__: () => protectedExport(getCardFormComponent()),
+};
+
+export function setup() {
+  getButtonsComponent();
+  getCheckoutComponent();
+}

package/src/zoid/buttons/component.jsx

@@ -719,6 +719,16 @@ export const getButtonsComponent: () => ButtonsComponent = memoize(() => {
         },
       },
 
+      referrerDomain: {
+        type: "string",
+        required: false,
+        value: () => {
+          if (window.document.referrer) {
+            return new URL(window.document.referrer).host || undefined;
+          }
+        },
+      },
+
       userIDToken: {
         type: "string",
         default: getUserIDToken,
@@ -730,7 +740,12 @@ export const getButtonsComponent: () => ButtonsComponent = memoize(() => {
       clientMetadataID: {
         type: "string",
         required: false,
-        default: getClientMetadataID,
+        default: () => {
+          const clientMetadataId = getClientMetadataID();
+          const sessionID = getSessionID();
+
+          return clientMetadataId || sessionID;
+        },
         queryParam: true,
       },
 
@@ -834,6 +849,11 @@ export const getButtonsComponent: () => ButtonsComponent = memoize(() => {
         value: getExperimentation,
       },
 
+      hostedButtonId: {
+        type: "string",
+        required: false,
+      },
+
       displayOnly: {
         type: "array",
         queryParam: true,