Pull from main

packages/paypal-js/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 8.2.0
+
+### Minor Changes
+
+-   6f339f6: Adding test for card-fields.test.ts
+
 ## 8.1.3
 
 ### Patch Changes

packages/paypal-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@paypal/paypal-js",
-    "version": "8.1.3",
+    "version": "8.2.0",
     "description": "Loading wrapper and TypeScript types for the PayPal JS SDK",
     "main": "index.js",
     "module": "dist/esm/paypal-js.js",

packages/paypal-js/types/components/card-fields.d.ts

@@ -132,21 +132,39 @@ export interface PayPalCardFieldsIndividualField {
     close: () => Promise<void>;
 }
 
-export interface PayPalCardFieldsComponentOptions {
-    createOrder?: () => Promise<string>;
+export interface PayPalCardFieldsComponentBasics {
     onApprove: (data: CardFieldsOnApproveData) => void;
     onError: (err: Record<string, unknown>) => void;
-    createVaultSetupToken?: () => Promise<string>;
+    onCancel?: () => Promise<void> | void;
     inputEvents?: PayPalCardFieldsInputEvents;
     style?: Record<string, PayPalCardFieldsStyleOptions>;
-    /**
-     * createSubscription is newly added for Fullstack Subscription.
-     * Because of this, we have marked createOrder as optional.
-     * @alpha
-     */
-    createSubscription?: () => Promise<string>;
 }
 
+export interface PayPalCardFieldsComponentCreateOrder
+    extends PayPalCardFieldsComponentBasics {
+    createOrder: () => Promise<string>;
+    createVaultSetupToken?: never;
+    createSubscription?: never;
+}
+
+export interface PayPalCardFieldsComponentCreateVaultSetupToken
+    extends PayPalCardFieldsComponentBasics {
+    createOrder?: never;
+    createVaultSetupToken: () => Promise<string>;
+    createSubscription?: never;
+}
+export interface PayPalCardFieldsComponentCreateSubscription
+    extends PayPalCardFieldsComponentBasics {
+    createOrder?: never;
+    createVaultSetupToken?: never;
+    createSubscription: () => Promise<string>;
+}
+
+export type PayPalCardFieldsComponentOptions =
+    | PayPalCardFieldsComponentCreateOrder
+    | PayPalCardFieldsComponentCreateVaultSetupToken
+    | PayPalCardFieldsComponentCreateSubscription;
+
 export interface PayPalCardFieldsComponent {
     getState: () => Promise<PayPalCardFieldsStateObject>;
     isEligible: () => boolean;

packages/paypal-js/types/tests/card-fields.test.ts

@@ -0,0 +1,48 @@
+import { test, vi, describe, expect } from "vitest";
+
+import { PayPalCardFieldsComponentOptions } from "../components/card-fields";
+
+describe.only("testing createOrder and createVaultToken types", () => {
+    test("only creatOrder", () => {
+        const createOrderCallback: PayPalCardFieldsComponentOptions = {
+            createOrder: vi.fn(),
+            onApprove: vi.fn(),
+            onError: vi.fn(),
+        };
+
+        expect(createOrderCallback.createVaultSetupToken).toBeUndefined();
+    });
+
+    test("only createVaultSetupToken", () => {
+        const createVaultSetupTokenCallback: PayPalCardFieldsComponentOptions =
+            {
+                createVaultSetupToken: vi.fn(),
+                onApprove: vi.fn(),
+                onError: vi.fn(),
+            };
+
+        expect(createVaultSetupTokenCallback.createOrder).toBeUndefined();
+    });
+
+    test.skip("Can't have both createOrdre and createVaultSetupToken", () => {
+        // @ts-expect-error : should throw error if both createOrder and createVaultSetupToken called
+        const callback: PayPalCardFieldsComponentOptions = {
+            createOrder: vi.fn(),
+            createVaultSetupToken: vi.fn(),
+            onApprove: vi.fn(),
+            onError: vi.fn(),
+        };
+
+        expect(callback).toThrowError();
+    });
+
+    test.skip("Can't implement neither", () => {
+        // @ts-expect-error: should throw error if neither createOrder or createVaultSetuptoken called
+        const callback: PayPalCardFieldsComponentOptions = {
+            onApprove: vi.fn(),
+            onError: vi.fn(),
+        };
+
+        expect(callback).toThrowError();
+    });
+});