@getopenpay/openpay-js-react 0.2.2 → 0.2.4-alpha.4cdb512

package/dist/index.d.ts

@@ -2,6 +2,23 @@ import { ApplePayOption } from '@stripe/stripe-js/dist/stripe-js/elements/apple-
 import { FC } from 'react';
 import { z } from 'zod';
 
+declare type AirwallexApplePayFlowCustomParams = {
+    overridePaymentRequest?: {
+        amount: Amount;
+        pending?: boolean;
+        label?: string;
+        applePayPaymentRequest?: ApplePayJS.ApplePayPaymentRequest;
+    };
+};
+
+declare type AirwallexGooglePayFlowCustomParams = {
+    overridePaymentRequest?: {
+        amount: Amount;
+        pending?: boolean;
+        googlePayPaymentRequest?: google.payments.api.PaymentDataRequest;
+    };
+};
+
 declare type AllCallbacks = {
     onFocus?: (elementId: string, field: AllFieldNames) => void;
     onBlur?: (elementId: string, field: AllFieldNames) => void;
@@ -25,6 +42,9 @@ declare type AllFieldNames = z.infer<typeof AllFieldNames>;
  */
 export declare const Amount = z.object({
     amountAtom: z.number(),
+    /**
+     * The three-letter ISO 4217 currency code for the payment.
+     */
     currency: RequiredString,
 });
 
@@ -84,6 +104,8 @@ declare type CustomInitParams = {
     };
 };
 
+declare type DefaultFieldValues = Partial<Record<FieldNameEnum, string>>;
+
 export declare type DynamicPreview = {
     amount: Amount | null;
     isLoading: boolean;
@@ -107,13 +129,13 @@ export declare const ElementsForm: FC<ElementsFormPropsReact>;
 
 export declare type ElementsFormChildrenProps = {
     submit: () => void;
-    submitWith: (method: SubmitMethod) => void;
+    submitWith: (method: SubmitMethod, settings?: SubmitSettings) => void;
     applePay: PaymentRequestStatus;
     googlePay: PaymentRequestStatus;
     stripeLink: StripeLinkController | null;
     airwallex: {
-        googlePay: InitGooglePayFlowResult | null;
-        applePay: InitApplePayFlowResult | null;
+        googlePay: InitAirwallexGooglePayFlowResult;
+        applePay: InitAirwallexApplePayFlowResult;
     };
     loaded: boolean;
     preview: DynamicPreview;
@@ -189,22 +211,20 @@ export declare enum FieldName {
     PROMOTION_CODE = 'promotionCode',
 }
 
-declare type InitApplePayFlowResult =
-| {
-    isAvailable: true;
-    startFlow: () => Promise<void>;
-}
-| {
-    isAvailable: false;
+declare const FieldNameEnum = z.nativeEnum(FieldName);
+
+declare type FieldNameEnum = z.infer<typeof FieldNameEnum>;
+
+export declare type InitAirwallexApplePayFlowResult = {
+    isAvailable: boolean;
+    isLoading: boolean;
+    startFlow: (customParams?: AirwallexApplePayFlowCustomParams) => Promise<void>;
 };
 
-declare type InitGooglePayFlowResult =
-| {
-    isAvailable: true;
-    startFlow: () => Promise<void>;
-}
-| {
-    isAvailable: false;
+export declare type InitAirwallexGooglePayFlowResult = {
+    isAvailable: boolean;
+    isLoading: boolean;
+    startFlow: (customParams?: AirwallexGooglePayFlowCustomParams) => Promise<void>;
 };
 
 declare type OnCheckoutError = (message: string) => void;
@@ -245,6 +265,10 @@ declare type StripeLinkController = {
 
 declare type SubmitMethod = 'pockyt-paypal' | 'airwallex-google-pay' | 'airwallex-apple-pay';
 
+declare type SubmitSettings = {
+    defaultFieldValues?: DefaultFieldValues;
+};
+
 export declare const useOpenPayElements: () => ElementsContextValue;
 
 export { }