@internetarchive/donation-form 0.5.18-alpha.1 → 0.5.19

package/dist/src/payment-flow-handlers/donation-flow-modal-manager.d.ts

@@ -1,181 +1,181 @@
-import { ModalManagerInterface } from '@internetarchive/modal-manager';
-import { UpsellModalCTAMode } from '../modals/upsell-modal-content';
-import '../modals/confirm-donation-modal-content';
-import { BraintreeManagerInterface } from '../braintree-manager/braintree-interfaces';
-import { SuccessResponse, DonationPaymentInfo, DonationType, PaymentProvider, BillingInfo, CustomerInfo, DonationResponse } from '@internetarchive/donation-form-data-models';
-import '../modals/error-modal-content';
-import { DonationControllerEventLoggerInterface } from '../@types/analytics-handler';
-/**
- * The DonationFlowModalManager is responsible for most of the high-level modal flows.
- *
- * Each of the payment providers has slightly different interactions, ie the PayPal button,
- * ApplePay popup, Venmo launching the app, etc. The modal flow is the same for all of them
- * so this class gets called by the individual payment flow handlers to take the user
- * through the modal flow.
- *
- * @export
- * @interface DonationFlowModalManagerInterface
- */
-export interface DonationFlowModalManagerInterface {
-    showConfirmationStepModal(options: {
-        amount: number;
-        donationType: DonationType;
-        currencyType: string;
-        confirmDonationCB: Function;
-        cancelDonationCB: Function;
-    }): Promise<void>;
-    /**
-     * Close the modal
-     *
-     * @memberof DonationFlowModalManagerInterface
-     */
-    closeModal(): void;
-    /**
-     * Show the processing modal
-     *
-     * @memberof DonationFlowModalManagerInterface
-     */
-    showProcessingModal(): void;
-    /**
-     * Show the Thank You modal
-     *
-     * @memberof DonationFlowModalManagerInterface
-     */
-    showThankYouModal(options: {
-        successResponse: SuccessResponse;
-        upsellSuccessResponse?: SuccessResponse;
-    }): void;
-    /**
-     * Show the Error modal
-     *
-     * @param {{
-     *     userClosedModalCallback?: () => void;
-     *   }} [options]
-     * @memberof DonationFlowModalManagerInterface
-     */
-    showErrorModal(options: {
-        message: string;
-        userClosedModalCallback?: () => void;
-    }): void;
-    /**
-     * Show the upsell modal
-     *
-     * @param {{
-     *     ctaMode?: UpsellModalCTAMode;
-     *     yesSelected?: (amount: number) => void;
-     *     noSelected?: () => void;
-     *     amountChanged?: (amount: number) => void;
-     *     userClosedModalCallback?: () => void;
-     *   }} [options]
-     * @returns {Promise<void>}
-     * @memberof DonationFlowModalManagerInterface
-     */
-    showUpsellModal(options: {
-        oneTimeAmount: number;
-        ctaMode?: UpsellModalCTAMode;
-        yesSelected?: (amount: number) => void;
-        noSelected?: () => void;
-        amountChanged?: (amount: number) => void;
-        userClosedModalCallback?: () => void;
-    }): Promise<void>;
-    /**
-     * Start the donation submission flow. This kicks off the "main" modal flow once the
-     * user authorizes the donation through their payment provider, which provides
-     * us the with the nonce used to complete the donation.
-     *
-     * @param {{
-     *     nonce: string;
-     *     paymentProvider: PaymentProvider;
-     *     donationInfo: DonationPaymentInfo;
-     *     billingInfo: BillingInfo;
-     *     customerInfo: CustomerInfo;
-     *     upsellOnetimeTransactionId?: string;
-     *     customerId?: string;
-     *     recaptchaToken?: string;
-     *     bin?: string; // first 6 digits of CC
-     *     binName?: string; // credit card bank name
-     *   }} options
-     * @returns {(Promise<DonationResponse | undefined>)}
-     * @memberof DonationFlowModalManagerInterface
-     */
-    startDonationSubmissionFlow(options: {
-        nonce: string;
-        paymentProvider: PaymentProvider;
-        donationInfo: DonationPaymentInfo;
-        billingInfo: BillingInfo;
-        customerInfo: CustomerInfo;
-        upsellOnetimeTransactionId?: string;
-        customerId?: string;
-        recaptchaToken?: string;
-        bin?: string;
-        binName?: string;
-    }): Promise<DonationResponse | undefined>;
-    /**
-     * Handle a successful donation response. This encapsulates the logic for the type of
-     * donation that was made.
-     * ie. If it was a one-time donation, show the upsell, if it was monthly do not.
-     *
-     * @param {DonationPaymentInfo} donationInfo
-     * @param {SuccessResponse} response
-     * @memberof DonationFlowModalManagerInterface
-     */
-    handleSuccessfulDonationResponse(donationInfo: DonationPaymentInfo, response: SuccessResponse): void;
-}
-export declare class DonationFlowModalManager implements DonationFlowModalManagerInterface {
-    private braintreeManager;
-    private modalManager;
-    private analytics;
-    constructor(options: {
-        braintreeManager: BraintreeManagerInterface;
-        modalManager: ModalManagerInterface;
-        analytics: DonationControllerEventLoggerInterface;
-    });
-    /** @inheritdoc */
-    closeModal(): void;
-    /** @inheritdoc */
-    showProcessingModal(): void;
-    /** @inheritdoc */
-    showThankYouModal(options: {
-        successResponse: SuccessResponse;
-        upsellSuccessResponse?: SuccessResponse;
-    }): void;
-    /** @inheritdoc */
-    showErrorModal(options: {
-        message: string;
-        userClosedModalCallback?: () => void;
-    }): void;
-    showConfirmationStepModal(options: {
-        amount: number;
-        donationType: DonationType;
-        currencyType: string;
-        confirmDonationCB: Function;
-        cancelDonationCB: Function;
-    }): Promise<void>;
-    /** @inheritdoc */
-    showUpsellModal(options: {
-        oneTimeAmount: number;
-        yesSelected?: (amount: number) => void;
-        noSelected?: () => void;
-        amountChanged?: (amount: number) => void;
-        userClosedModalCallback?: () => void;
-        ctaMode?: UpsellModalCTAMode;
-    }): Promise<void>;
-    /** @inheritdoc */
-    startDonationSubmissionFlow(options: {
-        nonce: string;
-        paymentProvider: PaymentProvider;
-        donationInfo: DonationPaymentInfo;
-        billingInfo: BillingInfo;
-        customerInfo: CustomerInfo;
-        upsellOnetimeTransactionId?: string;
-        customerId?: string;
-        recaptchaToken?: string;
-        bin?: string;
-        binName?: string;
-    }): Promise<DonationResponse | undefined>;
-    private upsellModalYesSelected;
-    private completeUpsell;
-    static getDefaultUpsellAmount(oneTimeAmount: number): number;
-    /** @inheritdoc */
-    handleSuccessfulDonationResponse(donationInfo: DonationPaymentInfo, response: SuccessResponse): void;
-}
+import { ModalManagerInterface } from '@internetarchive/modal-manager';
+import { UpsellModalCTAMode } from '../modals/upsell-modal-content';
+import '../modals/confirm-donation-modal-content';
+import { BraintreeManagerInterface } from '../braintree-manager/braintree-interfaces';
+import { SuccessResponse, DonationPaymentInfo, DonationType, PaymentProvider, BillingInfo, CustomerInfo, DonationResponse } from '@internetarchive/donation-form-data-models';
+import '../modals/error-modal-content';
+import { DonationControllerEventLoggerInterface } from '../@types/analytics-handler';
+/**
+ * The DonationFlowModalManager is responsible for most of the high-level modal flows.
+ *
+ * Each of the payment providers has slightly different interactions, ie the PayPal button,
+ * ApplePay popup, Venmo launching the app, etc. The modal flow is the same for all of them
+ * so this class gets called by the individual payment flow handlers to take the user
+ * through the modal flow.
+ *
+ * @export
+ * @interface DonationFlowModalManagerInterface
+ */
+export interface DonationFlowModalManagerInterface {
+    showConfirmationStepModal(options: {
+        amount: number;
+        donationType: DonationType;
+        currencyType: string;
+        confirmDonationCB: Function;
+        cancelDonationCB: Function;
+    }): Promise<void>;
+    /**
+     * Close the modal
+     *
+     * @memberof DonationFlowModalManagerInterface
+     */
+    closeModal(): void;
+    /**
+     * Show the processing modal
+     *
+     * @memberof DonationFlowModalManagerInterface
+     */
+    showProcessingModal(): void;
+    /**
+     * Show the Thank You modal
+     *
+     * @memberof DonationFlowModalManagerInterface
+     */
+    showThankYouModal(options: {
+        successResponse: SuccessResponse;
+        upsellSuccessResponse?: SuccessResponse;
+    }): void;
+    /**
+     * Show the Error modal
+     *
+     * @param {{
+     *     userClosedModalCallback?: () => void;
+     *   }} [options]
+     * @memberof DonationFlowModalManagerInterface
+     */
+    showErrorModal(options: {
+        message: string;
+        userClosedModalCallback?: () => void;
+    }): void;
+    /**
+     * Show the upsell modal
+     *
+     * @param {{
+     *     ctaMode?: UpsellModalCTAMode;
+     *     yesSelected?: (amount: number) => void;
+     *     noSelected?: () => void;
+     *     amountChanged?: (amount: number) => void;
+     *     userClosedModalCallback?: () => void;
+     *   }} [options]
+     * @returns {Promise<void>}
+     * @memberof DonationFlowModalManagerInterface
+     */
+    showUpsellModal(options: {
+        oneTimeAmount: number;
+        ctaMode?: UpsellModalCTAMode;
+        yesSelected?: (amount: number) => void;
+        noSelected?: () => void;
+        amountChanged?: (amount: number) => void;
+        userClosedModalCallback?: () => void;
+    }): Promise<void>;
+    /**
+     * Start the donation submission flow. This kicks off the "main" modal flow once the
+     * user authorizes the donation through their payment provider, which provides
+     * us the with the nonce used to complete the donation.
+     *
+     * @param {{
+     *     nonce: string;
+     *     paymentProvider: PaymentProvider;
+     *     donationInfo: DonationPaymentInfo;
+     *     billingInfo: BillingInfo;
+     *     customerInfo: CustomerInfo;
+     *     upsellOnetimeTransactionId?: string;
+     *     customerId?: string;
+     *     recaptchaToken?: string;
+     *     bin?: string; // first 6 digits of CC
+     *     binName?: string; // credit card bank name
+     *   }} options
+     * @returns {(Promise<DonationResponse | undefined>)}
+     * @memberof DonationFlowModalManagerInterface
+     */
+    startDonationSubmissionFlow(options: {
+        nonce: string;
+        paymentProvider: PaymentProvider;
+        donationInfo: DonationPaymentInfo;
+        billingInfo: BillingInfo;
+        customerInfo: CustomerInfo;
+        upsellOnetimeTransactionId?: string;
+        customerId?: string;
+        recaptchaToken?: string;
+        bin?: string;
+        binName?: string;
+    }): Promise<DonationResponse | undefined>;
+    /**
+     * Handle a successful donation response. This encapsulates the logic for the type of
+     * donation that was made.
+     * ie. If it was a one-time donation, show the upsell, if it was monthly do not.
+     *
+     * @param {DonationPaymentInfo} donationInfo
+     * @param {SuccessResponse} response
+     * @memberof DonationFlowModalManagerInterface
+     */
+    handleSuccessfulDonationResponse(donationInfo: DonationPaymentInfo, response: SuccessResponse): void;
+}
+export declare class DonationFlowModalManager implements DonationFlowModalManagerInterface {
+    private braintreeManager;
+    private modalManager;
+    private analytics;
+    constructor(options: {
+        braintreeManager: BraintreeManagerInterface;
+        modalManager: ModalManagerInterface;
+        analytics: DonationControllerEventLoggerInterface;
+    });
+    /** @inheritdoc */
+    closeModal(): void;
+    /** @inheritdoc */
+    showProcessingModal(): void;
+    /** @inheritdoc */
+    showThankYouModal(options: {
+        successResponse: SuccessResponse;
+        upsellSuccessResponse?: SuccessResponse;
+    }): void;
+    /** @inheritdoc */
+    showErrorModal(options: {
+        message: string;
+        userClosedModalCallback?: () => void;
+    }): void;
+    showConfirmationStepModal(options: {
+        amount: number;
+        donationType: DonationType;
+        currencyType: string;
+        confirmDonationCB: Function;
+        cancelDonationCB: Function;
+    }): Promise<void>;
+    /** @inheritdoc */
+    showUpsellModal(options: {
+        oneTimeAmount: number;
+        yesSelected?: (amount: number) => void;
+        noSelected?: () => void;
+        amountChanged?: (amount: number) => void;
+        userClosedModalCallback?: () => void;
+        ctaMode?: UpsellModalCTAMode;
+    }): Promise<void>;
+    /** @inheritdoc */
+    startDonationSubmissionFlow(options: {
+        nonce: string;
+        paymentProvider: PaymentProvider;
+        donationInfo: DonationPaymentInfo;
+        billingInfo: BillingInfo;
+        customerInfo: CustomerInfo;
+        upsellOnetimeTransactionId?: string;
+        customerId?: string;
+        recaptchaToken?: string;
+        bin?: string;
+        binName?: string;
+    }): Promise<DonationResponse | undefined>;
+    private upsellModalYesSelected;
+    private completeUpsell;
+    static getDefaultUpsellAmount(oneTimeAmount: number): number;
+    /** @inheritdoc */
+    handleSuccessfulDonationResponse(donationInfo: DonationPaymentInfo, response: SuccessResponse): void;
+}