fix(types): export v6 types for callback arguments (#691)

Author: gregjopa

.changeset/witty-hornets-smoke.md

@@ -0,0 +1,5 @@
+---
+"@paypal/paypal-js": patch
+---
+
+Export v6 types for all callbacks

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

@@ -101,3 +101,10 @@ export * from "./components/paypal-payments";
 export * from "./components/paypal-legacy-billing-agreements";
 export * from "./components/venmo-payments";
 export * from "./components/find-eligible-methods";
+
+// export a subset of types from base-component
+export {
+    OnApproveDataOneTimePayments,
+    OnCompleteData,
+    OnErrorData,
+} from "./components/base-component";

packages/paypal-js/types/v6/tests/paypal-legacy-billing-agreements.test.ts

@@ -1,5 +1,8 @@
 import { loadCoreSdkScript } from "../../../src/v6";
-import type { PayPalV6Namespace } from "../index";
+import type {
+    OnApproveDataBillingAgreements,
+    PayPalV6Namespace,
+} from "../index";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 async function main() {
@@ -31,9 +34,20 @@ async function main() {
         return;
     }
 
+    function onApproveCallback({
+        billingToken,
+        payerId,
+    }: OnApproveDataBillingAgreements) {
+        console.log({
+            billingToken,
+            payerId,
+        });
+        return Promise.resolve();
+    }
+
     const paypalPaymentSession =
         sdkInstance.createPayPalBillingAgreementWithoutPurchase({
-            onApprove: () => Promise.resolve(),
+            onApprove: onApproveCallback,
         });
 
     const createBillingToken = () =>

packages/paypal-js/types/v6/tests/paypal-payments.test.ts

@@ -1,5 +1,5 @@
 import { loadCoreSdkScript } from "../../../src/v6";
-import type { PayPalV6Namespace } from "../index";
+import type { OnApproveDataOneTimePayments, PayPalV6Namespace } from "../index";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 async function main() {
@@ -31,8 +31,19 @@ async function main() {
         return;
     }
 
+    function onApproveCallback({
+        orderId,
+        payerId,
+    }: OnApproveDataOneTimePayments) {
+        console.log({
+            orderId,
+            payerId,
+        });
+        return Promise.resolve();
+    }
+
     const paypalPaymentSession = sdkInstance.createPayPalOneTimePaymentSession({
-        onApprove: () => Promise.resolve(),
+        onApprove: onApproveCallback,
     });
 
     const createOrder = () => Promise.resolve({ orderId: "ABC123" });

packages/paypal-js/types/v6/tests/venmo-payments.test.ts

@@ -1,5 +1,5 @@
 import { loadCoreSdkScript } from "../../../src/v6";
-import type { PayPalV6Namespace } from "../index";
+import type { OnApproveDataOneTimePayments, PayPalV6Namespace } from "../index";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 async function main() {
@@ -31,8 +31,19 @@ async function main() {
         return;
     }
 
+    function onApproveCallback({
+        orderId,
+        payerId,
+    }: OnApproveDataOneTimePayments) {
+        console.log({
+            orderId,
+            payerId,
+        });
+        return Promise.resolve();
+    }
+
     const venmoPaymentSession = sdkInstance.createVenmoOneTimePaymentSession({
-        onApprove: () => Promise.resolve(),
+        onApprove: onApproveCallback,
     });
 
     const createOrder = () => Promise.resolve({ orderId: "ABC123" });

packages/react-paypal-js/src/components/braintree/BraintreePayPalButtons.test.tsx

@@ -372,20 +372,18 @@ describe("render Braintree PayPal button component", () => {
             dataClientToken: CLIENT_TOKEN,
         };
         render(
-            <PayPalScriptProvider options={ options }>
-                <BraintreePayPalButtons
-                    message={{ amount: "100" }}
-                />
-            </PayPalScriptProvider>
+            <PayPalScriptProvider options={options}>
+                <BraintreePayPalButtons message={{ amount: "100" }} />
+            </PayPalScriptProvider>,
         );
 
         await waitFor(() => {
-        const mockButtons = (window.paypal &&
-            window.paypal.Buttons) as jest.Mock;
-        expect(mockButtons).toBeCalledWith({
+            const mockButtons = (window.paypal &&
+                window.paypal.Buttons) as jest.Mock;
+            expect(mockButtons).toBeCalledWith({
                 message: { amount: "100" },
                 onInit: expect.any(Function),
-            })
+            });
         });
     });
 });