@getopenpay/openpay-js 0.1.7 → 0.1.8-alpha.8cf0044

package/dist/index.d.ts

@@ -46,6 +46,25 @@ declare class ConnectionManager {
     getAllConnections(): Map<ElementType, CdeConnection>;
 }
 
+declare type CustomInitParams = {
+    stripeLink?: {
+        /**
+         * The height of the Stripe Link button. By default, the height of the buttons are 44px.
+         * You can override this to specify a custom button height in the range of 40px-55px.
+         *
+         * See more: https://docs.stripe.com/js/elements_object/create_express_checkout_element#express_checkout_element_create-options-buttonHeight
+         */
+        buttonHeight?: number;
+
+        /**
+         * If this function returns false, the stripe link submit process is aborted.
+         * This can be used for additional pre-submit checks (e.g. additional form validation).
+         * Note that this function must complete within 1 second, or the submission will fail.
+         */
+        overrideLinkSubmit?: () => Promise<boolean>;
+    };
+};
+
 declare type ElementProps<PlaceholderType extends z.ZodTypeAny = z.ZodString> = {
     styles?: ElementsStyle<z.ZodOptional<PlaceholderType>>;
 };
@@ -66,6 +85,7 @@ export declare type ElementsFormProps = {
     baseUrl?: string;
     formTarget?: string;
     onPaymentRequestLoad?: (paymentRequests: Record<PaymentRequestProvider, PaymentRequestStatus>) => void;
+    customInitParams?: CustomInitParams;
 };
 
 declare const ElementsStyle = <T extends z.ZodTypeAny>(placeholderType: T) =>
@@ -124,6 +144,11 @@ declare type InitOjsFlowParams = {
      * Ideally this only contains "background" context (OJS-level objects), and not flow-level objects.
      */
     context: OjsContext;
+
+    /**
+     * Lifecycle callbacks for OJS flows.
+     */
+    flowCallbacks: OjsFlowCallbacks;
 };
 
 declare type InitOjsFlowResult = {
@@ -192,6 +217,11 @@ declare type OjsContext = {
      */
     cdeConnections: Map<ElementType, CdeConnection>;
 
+    /**
+     * Custom init params for init flows.
+     */
+    customInitParams: CustomInitParams;
+
     /**
      * The base URL of the CDE iframe.
      */
@@ -247,14 +277,20 @@ declare type OjsFlowParams<T_PARAMS = void, T_INIT_RESULT = void> = {
 declare const OjsFlows = {
     // ✋ Note: For flows that require initialization, please add them to `init-flows.ts`
 
-    // Stripe
+    // Common
     commonCC: {
         run: runCommonCcFlow,
     },
+
+    // Stripe
     stripePR: {
         init: initStripePrFlow,
         run: runStripePrFlow,
     },
+    stripeLink: {
+        init: initStripeLinkFlow,
+        run: runStripeLinkFlow,
+    },
 
     // 👉 Add more flows here
 
@@ -277,6 +313,7 @@ export declare class OpenPayForm {
     formTarget: string;
     checkoutFired: boolean;
     ojsVersion: string;
+    ojsReleaseVersion: string;
     private referer;
     private eventHandler;
     private formProperties;
@@ -310,7 +347,6 @@ export declare class OpenPayForm {
     private connectToElement;
     private getFormDiv;
     private createOjsFlowContext;
-    private getNonCdeFormInputs;
     private createOjsFlowCallbacks;
     submit(): void;
     submitPaymentRequest: (provider: PaymentRequestProvider, initResult: InitStripePrFlowSuccess, params?: PaymentRequestStartParams) => Promise<void>;