Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create new types for createOrder and creatVaultToken #605

Merged
merged 5 commits into from
Jan 22, 2025
Merged

create new types for createOrder and creatVaultToken #605

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5748656
create new types for createOrder and creatVaultToken
Jan 15, 2025
37ef35d
Merge branch 'main' into feature/update-createOrder
ravishekhar Jan 17, 2025
25fa9d1
add onCancel to card-field
Jan 17, 2025
35591cd
fix naming for the test and update changeset
Jan 22, 2025
393e35f
remove old changeset
Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions packages/paypal-js/types/components/card-fields.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,16 +127,31 @@ 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>;
inputEvents?: PayPalCardFieldsInputEvents;
style?: Record<string, PayPalCardFieldsStyleOptions>;
}

export interface PayPalCardFieldsComponent {
export interface PayPalCardFieldsComponentCreateOrder
extends PayPalCardFieldsComponentBasics {
createOrder: () => Promise<string>;
createVaultSetupToken?: never;
}

export interface PayPalCardFieldsComponentCreateVaultSetupToken
extends PayPalCardFieldsComponentBasics {
createOrder?: never;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets revisit if we need createOrder?: never;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if createOrder?: never add any value, so i feel like we can remove that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be value in future clarity.

createVaultSetupToken: () => Promise<string>;
}

export type PayPalCardFieldsComponentOptions =
| PayPalCardFieldsComponentCreateOrder
| PayPalCardFieldsComponentCreateVaultSetupToken;

export interface PayPalCardFieldsComponent
extends PayPalCardFieldsComponentOptions {
getState: () => Promise<PayPalCardFieldsStateObject>;
isEligible: () => boolean;
submit: () => Promise<void>;
Expand Down
48 changes: 48 additions & 0 deletions packages/paypal-js/types/tests/card-fields.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { test, vi, describe, expect } from "vitest";

import { PayPalCardFieldsComponentOptions } from "../components/card-fields";

describe("testing", () => {
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", () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these test still supposed to be skipped?

Copy link
Contributor Author

@hnguyen510 hnguyen510 Jan 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It still need to be skip right now because there is assertionError. Not sure what assertion call I should do instead.

// @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 have both", () => {
// @ts-expect-error: should throw error if neither createOrder or createVaultSetuptoken called
const callback: PayPalCardFieldsComponentOptions = {
onApprove: vi.fn(),
onError: vi.fn(),
};

expect(callback).toThrowError();
});
});
Loading