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

package/dist/index.d.ts

@@ -3,6 +3,23 @@ import { PaymentRequest as PaymentRequest_2 } from '@stripe/stripe-js';
 import { Subject } from 'rxjs';
 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;
@@ -26,6 +43,9 @@ declare type AllFieldNames = z.infer<typeof AllFieldNames>;
  */
 declare const Amount = z.object({
     amountAtom: z.number(),
+    /**
+     * The three-letter ISO 4217 currency code for the payment.
+     */
     currency: RequiredString,
 });
 
@@ -92,6 +112,8 @@ declare type CustomInitParams = {
     };
 };
 
+declare type DefaultFieldValues = Partial<Record<FieldNameEnum, string>>;
+
 declare type ElementProps<PlaceholderType extends z.ZodTypeAny = z.ZodString> = {
     styles?: ElementsStyle<z.ZodOptional<PlaceholderType>>;
 };
@@ -159,6 +181,10 @@ export declare enum FieldName {
     PROMOTION_CODE = 'promotionCode',
 }
 
+declare const FieldNameEnum = z.nativeEnum(FieldName);
+
+declare type FieldNameEnum = z.infer<typeof FieldNameEnum>;
+
 declare class FormCallbacks {
     private static readonly NOOP = () => {};
     private _callbacks: Required<AllCallbacks>;
@@ -203,22 +229,16 @@ declare class FormCallbacks {
     }
 }
 
-declare type InitApplePayFlowResult =
-| {
-    isAvailable: true;
-    startFlow: () => Promise<void>;
-}
-| {
-    isAvailable: false;
+declare type InitAirwallexApplePayFlowResult = {
+    isAvailable: boolean;
+    isLoading: boolean;
+    startFlow: (customParams?: AirwallexApplePayFlowCustomParams) => Promise<void>;
 };
 
-declare type InitGooglePayFlowResult =
-| {
-    isAvailable: true;
-    startFlow: () => Promise<void>;
-}
-| {
-    isAvailable: false;
+declare type InitAirwallexGooglePayFlowResult = {
+    isAvailable: boolean;
+    isLoading: boolean;
+    startFlow: (customParams?: AirwallexGooglePayFlowCustomParams) => Promise<void>;
 };
 
 declare type InitialStatus = {
@@ -525,11 +545,11 @@ export declare class OpenPayForm {
             initialize: (initParams: InitOjsFlowParams) => Promise<void>;
         };
         readonly airwallexGooglePay: {
-            publisher: LoadedOncePublisher<InitGooglePayFlowResult>;
+            publisher: LoadedOncePublisher<InitAirwallexGooglePayFlowResult>;
             initialize: (initParams: InitOjsFlowParams) => Promise<void>;
         };
         readonly airwallexApplePay: {
-            publisher: LoadedOncePublisher<InitApplePayFlowResult>;
+            publisher: LoadedOncePublisher<InitAirwallexApplePayFlowResult>;
             initialize: (initParams: InitOjsFlowParams) => Promise<void>;
         };
     };
@@ -563,7 +583,7 @@ export declare class OpenPayForm {
      * Runs the common credit card flow
      */
     submitCard: () => void;
-    generalSubmit: (method: SubmitMethod) => void | Promise<void>;
+    generalSubmit: (method: SubmitMethod, settings?: SubmitSettings) => void | Promise<void>;
     /**
      * Alias for submitCard
      */
@@ -613,6 +633,10 @@ declare type StripeLinkController = {
 
 declare type SubmitMethod = 'pockyt-paypal' | 'airwallex-google-pay' | 'airwallex-apple-pay';
 
+declare type SubmitSettings = {
+    defaultFieldValues?: DefaultFieldValues;
+};
+
 declare type SuccessStatus<T> = {
     status: 'success';
     isSuccess: true;