Feat: Add PayPal Subscription Payment Session hook (#788)

* add paypal-subscriptions types and react hook

* chore: add changeset

* add tests

* update to fix console warnings

* add is pending

* update with isPending test

Author: EvanReinstein

.changeset/five-words-kick.md

@@ -0,0 +1,5 @@
+---
+"@paypal/paypal-js": minor
+---
+
+Adds paypal-subscriptions component types.

.changeset/light-goats-switch.md

@@ -0,0 +1,5 @@
+---
+"@paypal/react-paypal-js": minor
+---
+
+Adds PayPal Subscription Payment Session hook.

packages/paypal-js/types/v6/components/paypal-subscriptions.d.ts

@@ -0,0 +1,44 @@
+import {
+    OnShippingAddressChangeData,
+    OnShippingOptionsChangeData,
+} from "./paypal-payments";
+import {
+    PresentationModeOptionsForAuto,
+    PresentationModeOptionsForModal,
+    PresentationModeOptionsForPopup,
+    PresentationModeOptionsForPaymentHandler,
+    BasePaymentSessionOptions,
+    OnApproveDataOneTimePayments,
+    BasePaymentSession,
+} from "./base-component";
+
+export type PayPalSubscriptionSessionOptions = BasePaymentSessionOptions & {
+    onApprove?: (data: OnApproveDataOneTimePayments) => Promise<void>;
+    onShippingAddressChange?: (
+        data: OnShippingAddressChangeData,
+    ) => Promise<void>;
+    onShippingOptionsChange?: (
+        data: OnShippingOptionsChangeData,
+    ) => Promise<void>;
+};
+
+export type PayPalSubscriptionPaymentSession = BasePaymentSession & {
+    start: (
+        presentationModeOptions: PayPalSubscriptionPresentationModeOptions,
+        subscriptionsOptionsPromise?: Promise<{ subscriptionId: string }>,
+    ) => Promise<void | { redirectURL?: string }>;
+    hasReturned?: () => boolean;
+    resume?: () => Promise<void>;
+};
+
+export interface PayPalSubscriptionsInstance {
+    createPayPalSubscriptionPaymentSession: (
+        subscriptionSessionOptions: PayPalSubscriptionSessionOptions,
+    ) => PayPalSubscriptionPaymentSession;
+}
+
+export type PayPalSubscriptionPresentationModeOptions =
+    | PresentationModeOptionsForAuto
+    | PresentationModeOptionsForPopup
+    | PresentationModeOptionsForModal
+    | PresentationModeOptionsForPaymentHandler;

packages/paypal-js/types/v6/index.d.ts

@@ -8,6 +8,7 @@ import {
 } from "./components/find-eligible-methods";
 import { CardFieldsInstance } from "./components/card-fields";
 import { PayPalMessagesInstance } from "./components/paypal-messages";
+import { PayPalSubscriptionsInstance } from "./components/paypal-subscriptions";
 
 export interface PayPalV6Namespace {
     /**
@@ -40,6 +41,7 @@ export type Components =
     | "paypal-payments"
     | "paypal-guest-payments"
     | "paypal-messages"
+    | "paypal-subscriptions"
     | "venmo-payments"
     | "paypal-legacy-billing-agreements"
     | "card-fields";
@@ -134,7 +136,10 @@ export type SdkInstance<T extends readonly Components[]> = BaseInstance &
     ("paypal-legacy-billing-agreements" extends T[number]
         ? PayPalLegacyBillingInstance
         : unknown) &
-    ("card-fields" extends T[number] ? CardFieldsInstance : unknown);
+    ("card-fields" extends T[number] ? CardFieldsInstance : unknown) &
+    ("paypal-subscriptions" extends T[number]
+        ? PayPalSubscriptionsInstance
+        : unknown);
 
 /**
  * @internal
@@ -202,6 +207,7 @@ export * from "./components/venmo-payments";
 export * from "./components/find-eligible-methods";
 export * from "./components/card-fields";
 export * from "./components/paypal-messages";
+export * from "./components/paypal-subscriptions";
 
 // export a subset of types from base-component
 export {